src/debug.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef DEBUG_HEADER
  21 #define DEBUG_HEADER
  22
  23 #include <stdio.h>
  24 #include <jmutex.h>
  25 #include <jmutexautolock.h>
  26 #include <iostream>
  27 #include "common_irrlicht.h"
  28 #include "threads.h"
  29 #include "gettime.h"
  30 #include "constants.h"
  31 #include "exceptions.h"
  32
  33 #ifdef _WIN32
  34         #define WIN32_LEAN_AND_MEAN
  35         #include <windows.h>
  36         #ifdef _MSC_VER
  37                 #include <eh.h>
  38         #endif
  39 #else
  40 #endif
  41
  42 /*
  43         Debug output
  44 */
  45
  46 #define DTIME (getTimestamp()+": ")
  47
  48 #define DEBUGSTREAM_COUNT 2
  49
  50 extern FILE *g_debugstreams[DEBUGSTREAM_COUNT];
  51
  52 extern void debugstreams_init(bool disable_stderr, const char *filename);
  53 extern void debugstreams_deinit();
  54
  55 #define DEBUGPRINT(...)\
  56 {\
  57         for(int i=0; i<DEBUGSTREAM_COUNT; i++)\
  58         {\
  59                 if(g_debugstreams[i] != NULL){\
  60                         fprintf(g_debugstreams[i], __VA_ARGS__);\
  61                         fflush(g_debugstreams[i]);\
  62                 }\
  63         }\
  64 }
  65
  66 class Debugbuf : public std::streambuf
  67 {
  68 public:
  69         Debugbuf(bool disable_stderr)
  70         {
  71                 m_disable_stderr = disable_stderr;
  72         }
  73
  74         int overflow(int c)
  75         {
  76                 for(int i=0; i<DEBUGSTREAM_COUNT; i++)
  77                 {
  78                         if(g_debugstreams[i] == stderr && m_disable_stderr)
  79                                 continue;
  80                         if(g_debugstreams[i] != NULL)
  81                                 (void)fwrite(&c, 1, 1, g_debugstreams[i]);
  82                         //TODO: Is this slow?
  83                         fflush(g_debugstreams[i]);
  84                 }
  85
  86                 return c;
  87         }
  88         std::streamsize xsputn(const char *s, std::streamsize n)
  89         {
  90                 for(int i=0; i<DEBUGSTREAM_COUNT; i++)
  91                 {
  92                         if(g_debugstreams[i] == stderr && m_disable_stderr)
  93                                 continue;
  94                         if(g_debugstreams[i] != NULL)
  95                                 (void)fwrite(s, 1, n, g_debugstreams[i]);
  96                         //TODO: Is this slow?
  97                         fflush(g_debugstreams[i]);
  98                 }
  99
 100                 return n;
 101         }
 102
 103 private:
 104         bool m_disable_stderr;
 105 };
 106
 107 // This is used to redirect output to /dev/null
 108 class Nullstream : public std::ostream {
 109 public:
 110         Nullstream():
 111                 std::ostream(0)
 112         {
 113         }
 114 private:
 115 };
 116
 117 extern Debugbuf debugbuf;
 118 extern std::ostream dstream;
 119 extern std::ostream dstream_no_stderr;
 120 extern Nullstream dummyout;
 121
 122 /*
 123         Assert
 124 */
 125
 126 __NORETURN extern void assert_fail(
 127                 const char *assertion, const char *file,
 128                 unsigned int line, const char *function);
 129
 130 #define ASSERT(expr)\
 131         ((expr)\
 132         ? (void)(0)\
 133         : assert_fail(#expr, __FILE__, __LINE__, __FUNCTION_NAME))
 134
 135 #define assert(expr) ASSERT(expr)
 136
 137 /*
 138         DebugStack
 139 */
 140
 141 #define DEBUG_STACK_SIZE 50
 142 #define DEBUG_STACK_TEXT_SIZE 300
 143
 144 struct DebugStack
 145 {
 146         DebugStack(threadid_t id);
 147         void print(FILE *file, bool everything);
 148
 149         threadid_t threadid;
 150         char stack[DEBUG_STACK_SIZE][DEBUG_STACK_TEXT_SIZE];
 151         int stack_i; // Points to the lowest empty position
 152         int stack_max_i; // Highest i that was seen
 153 };
 154
 155 extern core::map<threadid_t, DebugStack*> g_debug_stacks;
 156 extern JMutex g_debug_stacks_mutex;
 157
 158 extern void debug_stacks_init();
 159 extern void debug_stacks_print();
 160
 161 class DebugStacker
 162 {
 163 public:
 164         DebugStacker(const char *text);
 165         ~DebugStacker();
 166
 167 private:
 168         DebugStack *m_stack;
 169         bool m_overflowed;
 170 };
 171
 172 #define DSTACK(msg)\
 173         DebugStacker __debug_stacker(msg);
 174
 175 #define DSTACKF(...)\
 176         char __buf[DEBUG_STACK_TEXT_SIZE];\
 177         snprintf(__buf,\
 178                         DEBUG_STACK_TEXT_SIZE, __VA_ARGS__);\
 179         DebugStacker __debug_stacker(__buf);
 180
 181 /*
 182         Packet counter
 183 */
 184
 185 class PacketCounter
 186 {
 187 public:
 188         PacketCounter()
 189         {
 190         }
 191
 192         void add(u16 command)
 193         {
 194                 core::map<u16, u16>::Node *n = m_packets.find(command);
 195                 if(n == NULL)
 196                 {
 197                         m_packets[command] = 1;
 198                 }
 199                 else
 200                 {
 201                         n->setValue(n->getValue()+1);
 202                 }
 203         }
 204
 205         void clear()
 206         {
 207                 for(core::map<u16, u16>::Iterator
 208                                 i = m_packets.getIterator();
 209                                 i.atEnd() == false; i++)
 210                 {
 211                         i.getNode()->setValue(0);
 212                 }
 213         }
 214
 215         void print(std::ostream &o)
 216         {
 217                 for(core::map<u16, u16>::Iterator
 218                                 i = m_packets.getIterator();
 219                                 i.atEnd() == false; i++)
 220                 {
 221                         o<<"cmd "<<i.getNode()->getKey()
 222                                         <<" count "<<i.getNode()->getValue()
 223                                         <<std::endl;
 224                 }
 225         }
 226
 227 private:
 228         // command, count
 229         core::map<u16, u16> m_packets;
 230 };
 231
 232 /*
 233         These should be put into every thread
 234 */
 235
 236 #if CATCH_UNHANDLED_EXCEPTIONS == 1
 237         #define BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER try{
 238         #define END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)\
 239                 }catch(std::exception &e){\
 240                         logstream<<"ERROR: An unhandled exception occurred: "\
 241                                         <<e.what()<<std::endl;\
 242                         assert(0);\
 243                 }
 244         #ifdef _WIN32 // Windows
 245                 #ifdef _MSC_VER // MSVC
 246 void se_trans_func(unsigned int, EXCEPTION_POINTERS*);
 247
 248 class FatalSystemException : public BaseException
 249 {
 250 public:
 251         FatalSystemException(const char *s):
 252                 BaseException(s)
 253         {}
 254 };
 255                         #define BEGIN_DEBUG_EXCEPTION_HANDLER \
 256                                 BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER\
 257                                 _set_se_translator(se_trans_func);
 258
 259                         #define END_DEBUG_EXCEPTION_HANDLER(logstream) \
 260                                 END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
 261                 #else // Probably mingw
 262                         #define BEGIN_DEBUG_EXCEPTION_HANDLER\
 263                                 BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER
 264                         #define END_DEBUG_EXCEPTION_HANDLER(logstream)\
 265                                 END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
 266                 #endif
 267         #else // Posix
 268                 #define BEGIN_DEBUG_EXCEPTION_HANDLER\
 269                         BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER
 270                 #define END_DEBUG_EXCEPTION_HANDLER(logstream)\
 271                         END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
 272         #endif
 273 #else
 274         // Dummy ones
 275         #define BEGIN_DEBUG_EXCEPTION_HANDLER
 276         #define END_DEBUG_EXCEPTION_HANDLER(logstream)
 277 #endif
 278
 279 #endif // DEBUG_HEADER
 280
 281