]> git.lizzy.rs Git - minetest.git/blobdiff - src/debug.cpp
Fix a formspec crash triggered by ae9b5e00989756bb676429530dfe81039009001c
[minetest.git] / src / debug.cpp
index 3608f42d2315254f829a105ee22766332d30a3ce..bdd4146cab253e9c57fcf1da3a5e867884c7478a 100644 (file)
@@ -21,12 +21,12 @@ 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 "threading/mutex.h"
+#include <sstream>
+#include <thread>
 #include "threading/mutex_auto_lock.h"
 #include "config.h"
 
@@ -36,98 +36,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        #include "filesys.h"
 #endif
 
-/*
-       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)
-       {
-#ifdef __ANDROID__
-               __android_log_print(ANDROID_LOG_VERBOSE, PROJECT_NAME, "%s", s);
+#if USE_CURSES
+       #include "terminal_chat_console.h"
 #endif
-               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;
-};
-
-Debugbuf debugbuf(false);
-std::ostream dstream(&debugbuf);
-Debugbuf debugbuf_no_stderr(true);
-std::ostream dstream_no_stderr(&debugbuf_no_stderr);
-Nullstream dummyout;
 
 /*
        Assert
@@ -136,15 +47,16 @@ Nullstream dummyout;
 void sanity_check_fn(const char *assertion, const char *file,
                unsigned int line, const char *function)
 {
-       DEBUGPRINT("\nIn thread %lx:\n"
-                       "%s:%u: %s: An engine assumption '%s' failed.\n",
-                       (unsigned long)get_current_thread_id(),
-                       file, line, function, assertion);
+#if USE_CURSES
+       g_term_console.stopAndWaitforThread();
+#endif
 
-       debug_stacks_print();
+       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;
 
-       if(g_debugstreams[1])
-               fclose(g_debugstreams[1]);
+       debug_stacks_print_to(errorstream);
 
        abort();
 }
@@ -152,15 +64,16 @@ void sanity_check_fn(const char *assertion, const char *file,
 void fatal_error_fn(const char *msg, const char *file,
                unsigned int line, const char *function)
 {
-       DEBUGPRINT("\nIn thread %lx:\n"
-                       "%s:%u: %s: A fatal error occurred: %s\n",
-                       (unsigned long)get_current_thread_id(),
-                       file, line, function, msg);
+#if USE_CURSES
+       g_term_console.stopAndWaitforThread();
+#endif
 
-       debug_stacks_print();
+       errorstream << std::endl << "In thread " << std::hex
+               << std::this_thread::get_id() << ":" << std::endl;
+       errorstream << file << ":" << line << ": " << function
+               << ": A fatal error occured: " << msg << std::endl;
 
-       if(g_debugstreams[1])
-               fclose(g_debugstreams[1]);
+       debug_stacks_print_to(errorstream);
 
        abort();
 }
@@ -171,19 +84,19 @@ void fatal_error_fn(const char *msg, const char *file,
 
 struct DebugStack
 {
-       DebugStack(threadid_t id);
+       DebugStack(std::thread::id id);
        void print(FILE *file, bool everything);
        void print(std::ostream &os, bool everything);
 
-       threadid_t threadid;
+       std::thread::id thread_id;
        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)
+DebugStack::DebugStack(std::thread::id id)
 {
-       threadid = id;
+       thread_id = id;
        stack_i = 0;
        stack_max_i = 0;
        memset(stack, 0, DEBUG_STACK_SIZE*DEBUG_STACK_TEXT_SIZE);
@@ -191,49 +104,45 @@ DebugStack::DebugStack(threadid_t id)
 
 void DebugStack::print(FILE *file, bool everything)
 {
-       fprintf(file, "DEBUG STACK FOR THREAD %lx:\n",
-                       (unsigned long)threadid);
+       std::ostringstream os;
+       os << thread_id;
+       fprintf(file, "DEBUG STACK FOR THREAD %s:\n",
+               os.str().c_str());
 
-       for(int i=0; i<stack_max_i; i++)
-       {
-               if(i == stack_i && everything == false)
+       for (int i = 0; i < stack_max_i; i++) {
+               if (i == stack_i && !everything)
                        break;
 
-               if(i < stack_i)
+               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)
+       if (stack_i == DEBUG_STACK_SIZE)
                fprintf(file, "Probably overflown.\n");
 }
 
 void DebugStack::print(std::ostream &os, bool everything)
 {
-       os<<"DEBUG STACK FOR THREAD "<<(unsigned long)threadid<<": "<<std::endl;
+       os<<"DEBUG STACK FOR THREAD "<<thread_id<<": "<<std::endl;
 
-       for(int i=0; i<stack_max_i; i++)
-       {
-               if(i == stack_i && everything == false)
+       for(int i = 0; i < stack_max_i; i++) {
+               if(i == stack_i && !everything)
                        break;
 
-               if(i < stack_i)
+               if (i < stack_i)
                        os<<"#"<<i<<"  "<<stack[i]<<std::endl;
                else
                        os<<"(Leftover data: #"<<i<<"  "<<stack[i]<<")"<<std::endl;
        }
 
-       if(stack_i == DEBUG_STACK_SIZE)
+       if (stack_i == DEBUG_STACK_SIZE)
                os<<"Probably overflown."<<std::endl;
 }
 
-std::map<threadid_t, DebugStack*> g_debug_stacks;
-Mutex g_debug_stacks_mutex;
-
-void debug_stacks_init()
-{
-}
+std::map<std::thread::id, DebugStack*> g_debug_stacks;
+std::mutex g_debug_stacks_mutex;
 
 void debug_stacks_print_to(std::ostream &os)
 {
@@ -241,66 +150,41 @@ void debug_stacks_print_to(std::ostream &os)
 
        os<<"Debug stacks:"<<std::endl;
 
-       for(std::map<threadid_t, DebugStack*>::iterator
-                       i = g_debug_stacks.begin();
-                       i != g_debug_stacks.end(); ++i)
-       {
-               i->second->print(os, false);
+       for (auto it : g_debug_stacks) {
+               it.second->print(os, false);
        }
 }
 
 void debug_stacks_print()
 {
-       MutexAutoLock lock(g_debug_stacks_mutex);
-
-       DEBUGPRINT("Debug stacks:\n");
-
-       for(std::map<threadid_t, DebugStack*>::iterator
-                       i = g_debug_stacks.begin();
-                       i != g_debug_stacks.end(); ++i)
-       {
-               DebugStack *stack = i->second;
-
-               for(int i=0; i<DEBUGSTREAM_COUNT; i++)
-               {
-                       if(g_debugstreams[i] != NULL)
-                               stack->print(g_debugstreams[i], true);
-               }
-       }
+       debug_stacks_print_to(errorstream);
 }
 
 DebugStacker::DebugStacker(const char *text)
 {
-       threadid_t threadid = get_current_thread_id();
+       std::thread::id thread_id = std::this_thread::get_id();
 
        MutexAutoLock lock(g_debug_stacks_mutex);
 
-       std::map<threadid_t, DebugStack*>::iterator n;
-       n = g_debug_stacks.find(threadid);
-       if(n != g_debug_stacks.end())
-       {
+       auto n = g_debug_stacks.find(thread_id);
+       if (n != g_debug_stacks.end()) {
                m_stack = n->second;
-       }
-       else
-       {
+       } else {
                /*DEBUGPRINT("Creating new debug stack for thread %x\n",
-                               (unsigned int)threadid);*/
-               m_stack = new DebugStack(threadid);
-               g_debug_stacks[threadid] = m_stack;
+                               (unsigned int)thread_id);*/
+               m_stack = new DebugStack(thread_id);
+               g_debug_stacks[thread_id] = m_stack;
        }
 
-       if(m_stack->stack_i >= DEBUG_STACK_SIZE)
-       {
+       if (m_stack->stack_i >= DEBUG_STACK_SIZE) {
                m_overflowed = true;
-       }
-       else
-       {
+       } 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)
+               if (m_stack->stack_i > m_stack->stack_max_i)
                        m_stack->stack_max_i = m_stack->stack_i;
        }
 }
@@ -309,18 +193,17 @@ DebugStacker::~DebugStacker()
 {
        MutexAutoLock lock(g_debug_stacks_mutex);
 
-       if(m_overflowed == true)
+       if (m_overflowed)
                return;
 
        m_stack->stack_i--;
 
-       if(m_stack->stack_i == 0)
-       {
-               threadid_t threadid = m_stack->threadid;
+       if (m_stack->stack_i == 0) {
+               std::thread::id thread_id = m_stack->thread_id;
                /*DEBUGPRINT("Deleting debug stack for thread %x\n",
-                               (unsigned int)threadid);*/
+                               (unsigned int)thread_id);*/
                delete m_stack;
-               g_debug_stacks.erase(threadid);
+               g_debug_stacks.erase(thread_id);
        }
 }