123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- /*
- 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 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 Lesser General Public License for more details.
- 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.
- */
- #include "porting.h"
- #include "debug.h"
- #include "exceptions.h"
- #include "threads.h"
- #include <stdio.h>
- #include <stdlib.h>
- #include <cstring>
- #include <map>
- #include "jthread/jmutex.h"
- #include "jthread/jmutexautolock.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)
- {
- #ifdef __ANDROID__
- __android_log_print(ANDROID_LOG_VERBOSE, PROJECT_NAME, "%s", s);
- #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
- */
- void assert_fail(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(g_debugstreams[1])
- fclose(g_debugstreams[1]);
- 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)
- {
- 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(i < stack_i)
- os<<"#"<<i<<" "<<stack[i]<<std::endl;
- else
- os<<"(Leftover data: #"<<i<<" "<<stack[i]<<")"<<std::endl;
- }
- if(stack_i == DEBUG_STACK_SIZE)
- os<<"Probably overflown."<<std::endl;
- }
- std::map<threadid_t, DebugStack*> g_debug_stacks;
- JMutex g_debug_stacks_mutex;
- void debug_stacks_init()
- {
- }
- void debug_stacks_print_to(std::ostream &os)
- {
- JMutexAutoLock lock(g_debug_stacks_mutex);
- 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);
- }
- }
- void debug_stacks_print()
- {
- JMutexAutoLock 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);
- }
- }
- }
- DebugStacker::DebugStacker(const char *text)
- {
- threadid_t threadid = get_current_thread_id();
- JMutexAutoLock lock(g_debug_stacks_mutex);
- 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;
- }
- if(m_stack->stack_i >= DEBUG_STACK_SIZE)
- {
- m_overflowed = true;
- }
- 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;
- }
- }
- 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);
- }
- }
- #ifdef _MSC_VER
- #if CATCH_UNHANDLED_EXCEPTIONS == 1
- void se_trans_func(unsigned int u, EXCEPTION_POINTERS* pExp)
- {
- 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
- #endif
|