]> git.lizzy.rs Git - minetest.git/blobdiff - src/debug.cpp
Revise bump_version.sh script to address shortcomings (#12789)
[minetest.git] / src / debug.cpp
index 278902a081b7fa2836063ace205771cbbcd4c871..3c82ed9e1c23ec62e51fb5bc3e91d0c7608efa23 100644 (file)
@@ -18,314 +18,180 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 */
 
 
+#include "porting.h"
 #include "debug.h"
 #include "exceptions.h"
-#include "threads.h"
-#include <stdio.h>
-#include <stdlib.h>
+#include <cstdio>
+#include <cstdlib>
 #include <cstring>
 #include <map>
-#include "jthread/jmutex.h"
-#include "jthread/jmutexautolock.h"
+#include <sstream>
+#include <thread>
+#include "threading/mutex_auto_lock.h"
+#include "config.h"
 
-/*
-       Debug output
-*/
-
-#define DEBUGSTREAM_COUNT 2
-
-FILE *g_debugstreams[DEBUGSTREAM_COUNT] = {stderr, NULL};
-
-#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]);\
-               }\
-       }\
-}
-
-void debugstreams_init(bool disable_stderr, const char *filename)
-{
-       if(disable_stderr)
-               g_debugstreams[0] = NULL;
-       else
-               g_debugstreams[0] = stderr;
-
-       if(filename)
-               g_debugstreams[1] = fopen(filename, "a");
-               
-       if(g_debugstreams[1])
-       {
-               fprintf(g_debugstreams[1], "\n\n-------------\n");
-               fprintf(g_debugstreams[1],     "  Separator  \n");
-               fprintf(g_debugstreams[1],     "-------------\n\n");
-       }
-}
-
-void debugstreams_deinit()
-{
-       if(g_debugstreams[1] != NULL)
-               fclose(g_debugstreams[1]);
-}
-
-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]);
-               }
-
-               return n;
-       }
-       
-private:
-       bool m_disable_stderr;
-};
+#ifdef _MSC_VER
+       #include <dbghelp.h>
+       #include "version.h"
+       #include "filesys.h"
+#endif
 
-Debugbuf debugbuf(false);
-std::ostream dstream(&debugbuf);
-Debugbuf debugbuf_no_stderr(true);
-std::ostream dstream_no_stderr(&debugbuf_no_stderr);
-Nullstream dummyout;
+#if USE_CURSES
+       #include "terminal_chat_console.h"
+#endif
 
 /*
        Assert
 */
 
-void assert_fail(const char *assertion, const char *file,
+void sanity_check_fn(const char *assertion, const char *file,
                unsigned int line, const char *function)
 {
-       DEBUGPRINT("\nIn thread %lx:\n"
-                       "%s:%d: %s: Assertion '%s' failed.\n",
-                       (unsigned long)get_current_thread_id(),
-                       file, line, function, assertion);
-       
-       debug_stacks_print();
+#if USE_CURSES
+       g_term_console.stopAndWaitforThread();
+#endif
 
-       if(g_debugstreams[1])
-               fclose(g_debugstreams[1]);
+       errorstream << std::endl << "In thread " << std::hex
+               << std::this_thread::get_id() << ":" << std::endl;
+       errorstream << file << ":" << line << ": " << function
+               << ": An engine assumption '" << assertion << "' failed." << std::endl;
 
        abort();
 }
 
-/*
-       DebugStack
-*/
-
-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
-};
-
-DebugStack::DebugStack(threadid_t id)
-{
-       threadid = id;
-       stack_i = 0;
-       stack_max_i = 0;
-       memset(stack, 0, DEBUG_STACK_SIZE*DEBUG_STACK_TEXT_SIZE);
-}
-
-void DebugStack::print(FILE *file, bool everything)
-{
-       fprintf(file, "DEBUG STACK FOR THREAD %lx:\n",
-                       (unsigned long)threadid);
-
-       for(int i=0; i<stack_max_i; i++)
-       {
-               if(i == stack_i && everything == false)
-                       break;
-
-               if(i < stack_i)
-                       fprintf(file, "#%d  %s\n", i, stack[i]);
-               else
-                       fprintf(file, "(Leftover data: #%d  %s)\n", i, stack[i]);
-       }
-
-       if(stack_i == DEBUG_STACK_SIZE)
-               fprintf(file, "Probably overflown.\n");
-}
-
-void DebugStack::print(std::ostream &os, bool everything)
+void fatal_error_fn(const char *msg, const char *file,
+               unsigned int line, const char *function)
 {
-       os<<"DEBUG STACK FOR THREAD "<<(unsigned long)threadid<<": "<<std::endl;
-
-       for(int i=0; i<stack_max_i; i++)
-       {
-               if(i == stack_i && everything == false)
-                       break;
+#if USE_CURSES
+       g_term_console.stopAndWaitforThread();
+#endif
 
-               if(i < stack_i)
-                       os<<"#"<<i<<"  "<<stack[i]<<std::endl;
-               else
-                       os<<"(Leftover data: #"<<i<<"  "<<stack[i]<<")"<<std::endl;
-       }
+       errorstream << std::endl << "In thread " << std::hex
+               << std::this_thread::get_id() << ":" << std::endl;
+       errorstream << file << ":" << line << ": " << function
+               << ": A fatal error occurred: " << msg << std::endl;
 
-       if(stack_i == DEBUG_STACK_SIZE)
-               os<<"Probably overflown."<<std::endl;
+       abort();
 }
 
-std::map<threadid_t, DebugStack*> g_debug_stacks;
-JMutex g_debug_stacks_mutex;
+#ifdef _MSC_VER
 
-void debug_stacks_init()
+const char *Win32ExceptionCodeToString(DWORD exception_code)
 {
+       switch (exception_code) {
+       case EXCEPTION_ACCESS_VIOLATION:
+               return "Access violation";
+       case EXCEPTION_DATATYPE_MISALIGNMENT:
+               return "Misaligned data access";
+       case EXCEPTION_BREAKPOINT:
+               return "Breakpoint reached";
+       case EXCEPTION_SINGLE_STEP:
+               return "Single debug step";
+       case EXCEPTION_ARRAY_BOUNDS_EXCEEDED:
+               return "Array access out of bounds";
+       case EXCEPTION_FLT_DENORMAL_OPERAND:
+               return "Denormal floating point operand";
+       case EXCEPTION_FLT_DIVIDE_BY_ZERO:
+               return "Floating point division by zero";
+       case EXCEPTION_FLT_INEXACT_RESULT:
+               return "Inaccurate floating point result";
+       case EXCEPTION_FLT_INVALID_OPERATION:
+               return "Invalid floating point operation";
+       case EXCEPTION_FLT_OVERFLOW:
+               return "Floating point exponent overflow";
+       case EXCEPTION_FLT_STACK_CHECK:
+               return "Floating point stack overflow or underflow";
+       case EXCEPTION_FLT_UNDERFLOW:
+               return "Floating point exponent underflow";
+       case EXCEPTION_INT_DIVIDE_BY_ZERO:
+               return "Integer division by zero";
+       case EXCEPTION_INT_OVERFLOW:
+               return "Integer overflow";
+       case EXCEPTION_PRIV_INSTRUCTION:
+               return "Privileged instruction executed";
+       case EXCEPTION_IN_PAGE_ERROR:
+               return "Could not access or load page";
+       case EXCEPTION_ILLEGAL_INSTRUCTION:
+               return "Illegal instruction encountered";
+       case EXCEPTION_NONCONTINUABLE_EXCEPTION:
+               return "Attempted to continue after fatal exception";
+       case EXCEPTION_STACK_OVERFLOW:
+               return "Stack overflow";
+       case EXCEPTION_INVALID_DISPOSITION:
+               return "Invalid disposition returned to the exception dispatcher";
+       case EXCEPTION_GUARD_PAGE:
+               return "Attempted guard page access";
+       case EXCEPTION_INVALID_HANDLE:
+               return "Invalid handle";
+       }
+
+       return "Unknown exception";
 }
 
-void debug_stacks_print_to(std::ostream &os)
+long WINAPI Win32ExceptionHandler(struct _EXCEPTION_POINTERS *pExceptInfo)
 {
-       JMutexAutoLock lock(g_debug_stacks_mutex);
+       char buf[512];
+       MINIDUMP_EXCEPTION_INFORMATION mdei;
+       MINIDUMP_USER_STREAM_INFORMATION mdusi;
+       MINIDUMP_USER_STREAM mdus;
+       bool minidump_created = false;
 
-       os<<"Debug stacks:"<<std::endl;
+       std::string dumpfile = porting::path_user + DIR_DELIM PROJECT_NAME ".dmp";
 
-       for(std::map<threadid_t, DebugStack*>::iterator
-                       i = g_debug_stacks.begin();
-                       i != g_debug_stacks.end(); ++i)
-       {
-               i->second->print(os, false);
-       }
-}
+       std::string version_str(PROJECT_NAME " ");
+       version_str += g_version_hash;
 
-void debug_stacks_print()
-{
-       JMutexAutoLock lock(g_debug_stacks_mutex);
+       HANDLE hFile = CreateFileA(dumpfile.c_str(), GENERIC_WRITE,
+               FILE_SHARE_WRITE, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
+       if (hFile == INVALID_HANDLE_VALUE)
+               goto minidump_failed;
 
-       DEBUGPRINT("Debug stacks:\n");
+       if (SetEndOfFile(hFile) == FALSE)
+               goto minidump_failed;
 
-       for(std::map<threadid_t, DebugStack*>::iterator
-                       i = g_debug_stacks.begin();
-                       i != g_debug_stacks.end(); ++i)
-       {
-               DebugStack *stack = i->second;
+       mdei.ClientPointers        = NULL;
+       mdei.ExceptionPointers = pExceptInfo;
+       mdei.ThreadId              = GetCurrentThreadId();
 
-               for(int i=0; i<DEBUGSTREAM_COUNT; i++)
-               {
-                       if(g_debugstreams[i] != NULL)
-                               stack->print(g_debugstreams[i], true);
-               }
-       }
-}
+       mdus.Type       = CommentStreamA;
+       mdus.BufferSize = version_str.size();
+       mdus.Buffer     = (PVOID)version_str.c_str();
 
-DebugStacker::DebugStacker(const char *text)
-{
-       threadid_t threadid = get_current_thread_id();
+       mdusi.UserStreamArray = &mdus;
+       mdusi.UserStreamCount = 1;
 
-       JMutexAutoLock lock(g_debug_stacks_mutex);
+       if (MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), hFile,
+                       MiniDumpNormal, &mdei, &mdusi, NULL) == FALSE)
+               goto minidump_failed;
 
-       std::map<threadid_t, DebugStack*>::iterator n;
-       n = g_debug_stacks.find(threadid);
-       if(n != g_debug_stacks.end())
-       {
-               m_stack = n->second;
-       }
-       else
-       {
-               /*DEBUGPRINT("Creating new debug stack for thread %x\n",
-                               (unsigned int)threadid);*/
-               m_stack = new DebugStack(threadid);
-               g_debug_stacks[threadid] = m_stack;
-       }
+       minidump_created = true;
 
-       if(m_stack->stack_i >= DEBUG_STACK_SIZE)
-       {
-               m_overflowed = true;
-       }
+minidump_failed:
+
+       CloseHandle(hFile);
+
+       DWORD excode = pExceptInfo->ExceptionRecord->ExceptionCode;
+       _snprintf(buf, sizeof(buf),
+               " >> === FATAL ERROR ===\n"
+               " >> %s (Exception 0x%08X) at 0x%p\n",
+               Win32ExceptionCodeToString(excode), excode,
+               pExceptInfo->ExceptionRecord->ExceptionAddress);
+       dstream << buf;
+
+       if (minidump_created)
+               dstream << " >> Saved dump to " << dumpfile << std::endl;
        else
-       {
-               m_overflowed = false;
-
-               snprintf(m_stack->stack[m_stack->stack_i],
-                               DEBUG_STACK_TEXT_SIZE, "%s", text);
-               m_stack->stack_i++;
-               if(m_stack->stack_i > m_stack->stack_max_i)
-                       m_stack->stack_max_i = m_stack->stack_i;
-       }
-}
+               dstream << " >> Failed to save dump" << std::endl;
 
-DebugStacker::~DebugStacker()
-{
-       JMutexAutoLock lock(g_debug_stacks_mutex);
-       
-       if(m_overflowed == true)
-               return;
-       
-       m_stack->stack_i--;
-
-       if(m_stack->stack_i == 0)
-       {
-               threadid_t threadid = m_stack->threadid;
-               /*DEBUGPRINT("Deleting debug stack for thread %x\n",
-                               (unsigned int)threadid);*/
-               delete m_stack;
-               g_debug_stacks.erase(threadid);
-       }
+       return EXCEPTION_EXECUTE_HANDLER;
 }
 
+#endif
 
-#ifdef _MSC_VER
-#if CATCH_UNHANDLED_EXCEPTIONS == 1
-void se_trans_func(unsigned int u, EXCEPTION_POINTERS* pExp)
+void debug_set_exception_handler()
 {
-       dstream<<"In trans_func.\n";
-       if(u == EXCEPTION_ACCESS_VIOLATION)
-       {
-               PEXCEPTION_RECORD r = pExp->ExceptionRecord;
-               dstream<<"Access violation at "<<r->ExceptionAddress
-                               <<" write?="<<r->ExceptionInformation[0]
-                               <<" address="<<r->ExceptionInformation[1]
-                               <<std::endl;
-               throw FatalSystemException
-               ("Access violation");
-       }
-       if(u == EXCEPTION_STACK_OVERFLOW)
-       {
-               throw FatalSystemException
-               ("Stack overflow");
-       }
-       if(u == EXCEPTION_ILLEGAL_INSTRUCTION)
-       {
-               throw FatalSystemException
-               ("Illegal instruction");
-       }
-}
-#endif
+#ifdef _MSC_VER
+       SetUnhandledExceptionFilter(Win32ExceptionHandler);
 #endif
-
-
+}