/*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef DEBUG_HEADER
-#define DEBUG_HEADER
+#pragma once
-#include <stdio.h>
-#include <jmutex.h>
-#include <jmutexautolock.h>
#include <iostream>
-#include "common_irrlicht.h"
-#include "threads.h"
+#include <exception>
+#include <cassert>
#include "gettime.h"
-#include "constants.h"
-#include "exceptions.h"
+#include "log.h"
#ifdef _WIN32
- #define WIN32_LEAN_AND_MEAN
+ #ifndef _WIN32_WINNT
+ #define _WIN32_WINNT 0x0501
+ #endif
#include <windows.h>
#ifdef _MSC_VER
#include <eh.h>
#endif
+ #define NORETURN __declspec(noreturn)
+ #define FUNCTION_NAME __FUNCTION__
#else
+ #define NORETURN __attribute__ ((__noreturn__))
+ #define FUNCTION_NAME __PRETTY_FUNCTION__
#endif
-/*
- Debug output
-*/
-
-#define DTIME (getTimestamp()+": ")
-
-#define DEBUGSTREAM_COUNT 2
-
-extern FILE *g_debugstreams[DEBUGSTREAM_COUNT];
-
-extern void debugstreams_init(bool disable_stderr, const char *filename);
-extern void debugstreams_deinit();
-
-#define DEBUGPRINT(...)\
-{\
- for(int i=0; i<DEBUGSTREAM_COUNT; i++)\
- {\
- if(g_debugstreams[i] != NULL){\
- fprintf(g_debugstreams[i], __VA_ARGS__);\
- fflush(g_debugstreams[i]);\
- }\
- }\
-}
-
-class Debugbuf : public std::streambuf
-{
-public:
- Debugbuf(bool disable_stderr)
- {
- m_disable_stderr = disable_stderr;
- }
-
- int overflow(int c)
- {
- for(int i=0; i<DEBUGSTREAM_COUNT; i++)
- {
- if(g_debugstreams[i] == stderr && m_disable_stderr)
- continue;
- if(g_debugstreams[i] != NULL)
- (void)fwrite(&c, 1, 1, g_debugstreams[i]);
- //TODO: Is this slow?
- fflush(g_debugstreams[i]);
- }
-
- return c;
- }
- std::streamsize xsputn(const char *s, std::streamsize n)
- {
- for(int i=0; i<DEBUGSTREAM_COUNT; i++)
- {
- if(g_debugstreams[i] == stderr && m_disable_stderr)
- continue;
- if(g_debugstreams[i] != NULL)
- (void)fwrite(s, 1, n, g_debugstreams[i]);
- //TODO: Is this slow?
- fflush(g_debugstreams[i]);
- }
+// Whether to catch all std::exceptions.
+// When "catching", the program will abort with an error message.
+// In debug mode, leave these for the debugger and don't catch them.
+#ifdef NDEBUG
+ #define CATCH_UNHANDLED_EXCEPTIONS 1
+#else
+ #define CATCH_UNHANDLED_EXCEPTIONS 0
+#endif
- return n;
- }
-
-private:
- bool m_disable_stderr;
-};
+/* Abort program execution immediately
+ */
+NORETURN extern void fatal_error_fn(
+ const char *msg, const char *file,
+ unsigned int line, const char *function);
-// This is used to redirect output to /dev/null
-class Nullstream : public std::ostream {
-public:
- Nullstream():
- std::ostream(0)
- {
- }
-private:
-};
+#define FATAL_ERROR(msg) \
+ fatal_error_fn((msg), __FILE__, __LINE__, FUNCTION_NAME)
-extern Debugbuf debugbuf;
-extern std::ostream dstream;
-extern std::ostream dstream_no_stderr;
-extern Nullstream dummyout;
+#define FATAL_ERROR_IF(expr, msg) \
+ ((expr) \
+ ? fatal_error_fn((msg), __FILE__, __LINE__, FUNCTION_NAME) \
+ : (void)(0))
/*
- Assert
+ sanity_check()
+ Equivalent to assert() but persists in Release builds (i.e. when NDEBUG is
+ defined)
*/
-__NORETURN extern void assert_fail(
+NORETURN extern void sanity_check_fn(
const char *assertion, const char *file,
unsigned int line, const char *function);
-#define ASSERT(expr)\
- ((expr)\
- ? (void)(0)\
- : assert_fail(#expr, __FILE__, __LINE__, __FUNCTION_NAME))
-
-#define assert(expr) ASSERT(expr)
-
-/*
- DebugStack
-*/
-
-#define DEBUG_STACK_SIZE 50
-#define DEBUG_STACK_TEXT_SIZE 300
-
-struct DebugStack
-{
- DebugStack(threadid_t id);
- void print(FILE *file, bool everything);
- void print(std::ostream &os, bool everything);
-
- threadid_t threadid;
- char stack[DEBUG_STACK_SIZE][DEBUG_STACK_TEXT_SIZE];
- int stack_i; // Points to the lowest empty position
- int stack_max_i; // Highest i that was seen
-};
+#define SANITY_CHECK(expr) \
+ ((expr) \
+ ? (void)(0) \
+ : sanity_check_fn(#expr, __FILE__, __LINE__, FUNCTION_NAME))
-extern core::map<threadid_t, DebugStack*> g_debug_stacks;
-extern JMutex g_debug_stacks_mutex;
+#define sanity_check(expr) SANITY_CHECK(expr)
-extern void debug_stacks_init();
-extern void debug_stacks_print_to(std::ostream &os);
-extern void debug_stacks_print();
-class DebugStacker
-{
-public:
- DebugStacker(const char *text);
- ~DebugStacker();
-
-private:
- DebugStack *m_stack;
- bool m_overflowed;
-};
-
-#define DSTACK(msg)\
- DebugStacker __debug_stacker(msg);
-
-#define DSTACKF(...)\
- char __buf[DEBUG_STACK_TEXT_SIZE];\
- snprintf(__buf,\
- DEBUG_STACK_TEXT_SIZE, __VA_ARGS__);\
- DebugStacker __debug_stacker(__buf);
-
-/*
- Packet counter
-*/
-
-class PacketCounter
-{
-public:
- PacketCounter()
- {
- }
-
- void add(u16 command)
- {
- core::map<u16, u16>::Node *n = m_packets.find(command);
- if(n == NULL)
- {
- m_packets[command] = 1;
- }
- else
- {
- n->setValue(n->getValue()+1);
- }
- }
-
- void clear()
- {
- for(core::map<u16, u16>::Iterator
- i = m_packets.getIterator();
- i.atEnd() == false; i++)
- {
- i.getNode()->setValue(0);
- }
- }
-
- void print(std::ostream &o)
- {
- for(core::map<u16, u16>::Iterator
- i = m_packets.getIterator();
- i.atEnd() == false; i++)
- {
- o<<"cmd "<<i.getNode()->getKey()
- <<" count "<<i.getNode()->getValue()
- <<std::endl;
- }
- }
-
-private:
- // command, count
- core::map<u16, u16> m_packets;
-};
+void debug_set_exception_handler();
/*
These should be put into every thread
*/
#if CATCH_UNHANDLED_EXCEPTIONS == 1
- #define BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER try{
- #define END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)\
- }catch(std::exception &e){\
- logstream<<"ERROR: An unhandled exception occurred: "\
- <<e.what()<<std::endl;\
- assert(0);\
+ #define BEGIN_DEBUG_EXCEPTION_HANDLER try {
+ #define END_DEBUG_EXCEPTION_HANDLER \
+ } catch (std::exception &e) { \
+ errorstream << "An unhandled exception occurred: " \
+ << e.what() << std::endl; \
+ FATAL_ERROR(e.what()); \
}
- #ifdef _WIN32 // Windows
- #ifdef _MSC_VER // MSVC
-void se_trans_func(unsigned int, EXCEPTION_POINTERS*);
-
-class FatalSystemException : public BaseException
-{
-public:
- FatalSystemException(const char *s):
- BaseException(s)
- {}
-};
- #define BEGIN_DEBUG_EXCEPTION_HANDLER \
- BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER\
- _set_se_translator(se_trans_func);
-
- #define END_DEBUG_EXCEPTION_HANDLER(logstream) \
- END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
- #else // Probably mingw
- #define BEGIN_DEBUG_EXCEPTION_HANDLER\
- BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER
- #define END_DEBUG_EXCEPTION_HANDLER(logstream)\
- END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
- #endif
- #else // Posix
- #define BEGIN_DEBUG_EXCEPTION_HANDLER\
- BEGIN_PORTABLE_DEBUG_EXCEPTION_HANDLER
- #define END_DEBUG_EXCEPTION_HANDLER(logstream)\
- END_PORTABLE_DEBUG_EXCEPTION_HANDLER(logstream)
- #endif
#else
// Dummy ones
#define BEGIN_DEBUG_EXCEPTION_HANDLER
- #define END_DEBUG_EXCEPTION_HANDLER(logstream)
+ #define END_DEBUG_EXCEPTION_HANDLER
#endif
-
-#endif // DEBUG_HEADER
-
-
projects / minetest.git / blobdiff