janwas
f911bdc4b1
major cleanup+documenting in debug.h; added breakpoint interface. sysdep: moved debug_out definition to udbg.cpp This was SVN commit r2287.
151 lines
4.0 KiB
C
Executable File
151 lines
4.0 KiB
C
Executable File
// platform-independent debug interface
|
|
// Copyright (c) 2002-2005 Jan Wassenberg
|
|
//
|
|
// 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 (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.
|
|
//
|
|
// Contact info:
|
|
// Jan.Wassenberg@stud.uni-karlsruhe.de
|
|
// http://www.stud.uni-karlsruhe.de/~urkt/
|
|
|
|
#ifndef DEBUG_H_INCLUDED
|
|
#define DEBUG_H_INCLUDED
|
|
|
|
#ifdef _WIN32
|
|
# include "win/wdbg.h"
|
|
#else
|
|
# include "unix/udbg.h"
|
|
#endif
|
|
|
|
|
|
//
|
|
// assert
|
|
//
|
|
|
|
enum FailedAssertUserChoice
|
|
{
|
|
// ignore, continue as if nothing happened.
|
|
ASSERT_CONTINUE,
|
|
|
|
// ignore and do not report again for this assert.
|
|
ASSERT_SUPPRESS,
|
|
// note: non-persistent; only applicable during this program run.
|
|
|
|
// trigger breakpoint, i.e. enter debugger.
|
|
ASSERT_BREAK,
|
|
|
|
// exit the program immediately.
|
|
ASSERT_EXIT
|
|
// note: carried out by debug_assert_failed;
|
|
// testing for it in assert2 would bloat code.
|
|
};
|
|
|
|
// notify the user that an assertion failed; displays a
|
|
// stack trace with local variables.
|
|
// returns one of FailedAssertUserChoice or exits the program.
|
|
extern int debug_assert_failed(const char* source_file, int line, const char* assert_expr);
|
|
|
|
// recommended use: assert2(expr && "descriptive string")
|
|
#define assert2(expr)\
|
|
STMT(\
|
|
static int suppress__ = 0;\
|
|
if(!suppress__ && !(expr))\
|
|
switch(debug_assert_failed(__FILE__, __LINE__, #expr))\
|
|
{\
|
|
case ASSERT_SUPPRESS:\
|
|
suppress__ = 1;\
|
|
break;\
|
|
case ASSERT_BREAK:\
|
|
debug_break();\
|
|
break;\
|
|
}\
|
|
)
|
|
|
|
|
|
//
|
|
// output
|
|
//
|
|
|
|
// write to the debugger output window (may take ~1 ms!)
|
|
extern void debug_printf(const char* fmt, ...);
|
|
|
|
// write to memory buffer (fast)
|
|
extern void debug_wprintf_mem(const wchar_t* fmt, ...);
|
|
|
|
// warn of unexpected state. less error-prone than assert(!"text");
|
|
#define debug_warn(str) assert2(0 && (str))
|
|
|
|
|
|
//
|
|
// breakpoints
|
|
//
|
|
|
|
// trigger a breakpoint when reached/"called".
|
|
// defined as a macro by the platform-specific header above; this allows
|
|
// breaking directly into the target function, instead of one frame
|
|
// below it as with a conventional call-based implementation.
|
|
//#define debug_break()
|
|
|
|
|
|
// sometimes mmgr's 'fences' (making sure padding before and after the
|
|
// allocation remains intact) aren't enough to catch hard-to-find
|
|
// memory corruption bugs. another tool is to trigger a debug exception
|
|
// when the later to be corrupted variable is accessed; the problem should
|
|
// then become apparent.
|
|
// the VC++ IDE provides such 'breakpoints', but can only detect write access.
|
|
// additionally, it can't resolve symbols in Release mode (where this would
|
|
// be most useful), so we provide direct access to hardware breakpoints.
|
|
|
|
// values chosen to match IA-32 bit defs, so compiler can optimize.
|
|
// this isn't required, it'll work regardless.
|
|
enum DbgBreakType
|
|
{
|
|
DBG_BREAK_CODE = 0, // execute
|
|
DBG_BREAK_DATA_WRITE = 1, // write
|
|
DBG_BREAK_DATA = 3 // read or write
|
|
};
|
|
|
|
// arrange for a debug exception to be raised when <addr> is accessed
|
|
// according to <type>.
|
|
// for simplicity, the length (range of bytes to be checked) is derived
|
|
// from addr's alignment, and is typically 1 machine word.
|
|
extern int debug_set_break(void* addr, DbgBreakType type);
|
|
|
|
|
|
//
|
|
// memory
|
|
//
|
|
|
|
// check heap integrity (independently of mmgr).
|
|
// errors are reported by the CRT, e.g. via assert.
|
|
extern void debug_check_heap(void);
|
|
|
|
|
|
//
|
|
// symbol access
|
|
//
|
|
|
|
const size_t DBG_SYMBOL_LEN = 1000;
|
|
const size_t DBG_FILE_LEN = 100;
|
|
|
|
extern void* debug_get_nth_caller(uint n);
|
|
|
|
extern int debug_resolve_symbol(void* ptr_of_interest, char* sym_name, char* file, int* line);
|
|
|
|
|
|
//
|
|
// crash notification
|
|
//
|
|
|
|
extern int debug_write_crashlog(const char* file, const wchar_t* header, void* context);
|
|
|
|
|
|
#endif // #ifndef DEBUG_H_INCLUDED
|