X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=src%2Fdebug.h;h=2098942db7ec17e457fa72fb8e88d50f5e3c9d40;hb=f8408398f56b19ea277cb5921f0843ba06002574;hp=9a2e282f5c2d7eba4c5f69c670aa5f5b272aa89e;hpb=0604f3f2eedb93d75ac20422849e4e710427621a;p=minetest.git

diff --git a/src/debug.h b/src/debug.h
index 9a2e282f5..2098942db 100644
--- a/src/debug.h
+++ b/src/debug.h
@@ -1,151 +1,89 @@
 /*
-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.
 */
 
-
-/*
-	Debug stuff
-*/
-
 #ifndef DEBUG_HEADER
 #define DEBUG_HEADER
 
-#include <stdio.h>
-#include <jmutex.h>
-#include <jmutexautolock.h>
 #include <iostream>
-#include "common_irrlicht.h"
-
-/*
-	Compatibility stuff
-*/
+#include <exception>
+#include <assert.h>
+#include "gettime.h"
+#include "log.h"
 
 #if (defined(WIN32) || defined(_WIN32_WCE))
-typedef DWORD threadid_t;
-#define __NORETURN __declspec(noreturn)
-#define __FUNCTION_NAME __FUNCTION__
+	#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
-typedef pthread_t threadid_t;
-#define __NORETURN __attribute__ ((__noreturn__))
-#define __FUNCTION_NAME __PRETTY_FUNCTION__
+	#define NORETURN __attribute__ ((__noreturn__))
+	#define FUNCTION_NAME __PRETTY_FUNCTION__
 #endif
 
-inline threadid_t get_current_thread_id()
-{
-#if (defined(WIN32) || defined(_WIN32_WCE))
-	return GetCurrentThreadId();
+// 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
-	return pthread_self();
+	#define CATCH_UNHANDLED_EXCEPTIONS 0
 #endif
-}
-
-/*
-	Debug output
-*/
 
-#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)
-				fwrite(&c, 1, 1, g_debugstreams[i]);
-			//TODO: Is this slow?
-			fflush(g_debugstreams[i]);
-		}
-		
-		return c;
-	}
-	int xsputn(const char *s, int n)
-	{
-		for(int i=0; i<DEBUGSTREAM_COUNT; i++)
-		{
-			if(g_debugstreams[i] == stderr && m_disable_stderr)
-				continue;
-			if(g_debugstreams[i] != NULL)
-				fwrite(s, 1, n, g_debugstreams[i]);
-			//TODO: Is this slow?
-			fflush(g_debugstreams[i]);
-		}
-
-		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 SANITY_CHECK(expr) \
+	((expr) \
+	? (void)(0) \
+	: sanity_check_fn(#expr, __FILE__, __LINE__, FUNCTION_NAME))
+
+#define sanity_check(expr) SANITY_CHECK(expr)
+
 
-#define assert(expr) ASSERT(expr)
+void debug_set_exception_handler();
 
 /*
 	DebugStack
@@ -154,23 +92,11 @@ __NORETURN extern void assert_fail(
 #define DEBUG_STACK_SIZE 50
 #define DEBUG_STACK_TEXT_SIZE 300
 
-struct DebugStack
-{
-	DebugStack(threadid_t id);
-	void print(FILE *file, 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
-};
-
-extern core::map<threadid_t, DebugStack*> g_debug_stacks;
-extern JMutex g_debug_stacks_mutex;
-
 extern void debug_stacks_init();
+extern void debug_stacks_print_to(std::ostream &os);
 extern void debug_stacks_print();
 
+struct DebugStack;
 class DebugStacker
 {
 public:
@@ -182,63 +108,31 @@ class DebugStacker
 	bool m_overflowed;
 };
 
-#define DSTACK(...)\
-	char __buf[DEBUG_STACK_TEXT_SIZE];\
-	snprintf(__buf,\
-			DEBUG_STACK_TEXT_SIZE, __VA_ARGS__);\
+#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
+	These should be put into every thread
 */
 
-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);
+#if CATCH_UNHANDLED_EXCEPTIONS == 1
+	#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());                             \
 		}
-	}
-
-	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;
-};
-
+#else
+	// Dummy ones
+	#define BEGIN_DEBUG_EXCEPTION_HANDLER
+	#define END_DEBUG_EXCEPTION_HANDLER
+#endif
 
 #endif // DEBUG_HEADER