Debug.h

Go to the documentation of this file.

//==============================================================================
// Project: uLib - User mode utility library.
//==============================================================================
//==============================================================================

#ifndef _Debug_h_incl_
#define _Debug_h_incl_

#include <uLib/Common.h>

#ifdef __GNUC__
// NOTE: If you're debugging in CodeBlocks, you will not see output from DPrint
// in the IDE, since it doesn't capture OutputDebugString strings, so run an
// instance of e.g Mark Russinovitch's DbgView on the side to see your trace.
#endif

//==============================================================================
//==============================================================================

BEGIN_EXTERN_C

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

#ifdef _MSC_VER // MSVC allows concatenation of the __FUNCTION__ value.
 #define _F(s)   _T("[") _T(__FUNCTION__) _T("] ") _T(s)
#else //__GNUC__ does not.
 #if 911 // NOTE: This one only works in var-arg param list..
  // Emit __func__ as the first parameter in the arg list, since GCC defines
  // __func__ as an implicit variable, not a string literal as MSVC does.
  #define _F(s) _T("[%s] ") _T(s), __func__
 #else
  #define _F(s) _T(s) /* If it doesn't work, use this degenerate def */
  // TODO: Find a GCC definition of _F that works like the MSVC version.
 #endif
#endif

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

void __cdecl DPrint( int Level, CSTR Fmt, ... );

#define DP_DISABLE -1  
#define DP_ALWAYS   0  
#define DP_FATAL    1  
#define DP_SEVERE   2  
#define DP_ERROR    3  
#define DP_WARNING  4  
#define DP_INFO     5  
#define DP_DEBUG    6  
#define DP_VERBOSE  7  
#define DP_EXTREME  8  

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

CSTR SysErrorMsg( DWORD Err DEF_(0), TSTR Buf DEF_(NULL), UINT Length DEF_(0) );

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

CSTR NtErrorMsg( NTSTATUS Status DEF_(0), TSTR Buf DEF_(NULL), UINT Size DEF_(0) );

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

bool SetLastErrorFromNtStatus( NTSTATUS Status );

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

ACSTR GetWinMsgName( WORD msgId ); // MsgTbl.cpp

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

ACSTR GetExceptionName( DWORD xCode ); // MsgTbl.cpp

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

int SetDebugLevel( int Level );

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

HANDLE OpenLogFile( CSTR Name, bool Append );

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

CSTR DefaultLogFileName( HMODULE hModule );

//==---------------------------------------------------------------------------
extern CSTR     dbg_Name;    
extern int      dbg_Level;   
extern HANDLE   dbg_LogFile; 
extern bool     dbg_Flush;   

#ifdef _DEBUG 
extern volatile ULONG nDPrintSkipped; // Nr of skipped (due to re-entry) DPrint calls.
#endif
//==---------------------------------------------------------------------------


#define DP_StdFailMsg( What ) \
    DPrint( DP_ERROR, What _T(" failed: %s\n"), SysErrorMsg() )

#ifdef _DEBUG //----------------------------------------------------------------

  // Sadly, MSVC does *not* allow inline assembly for _WIN64 :/
  // That's a *huge step backward* for advanced/high perfomance programming!
  // (This particular little trinket notwithstanding..)
  //
  // I thought we were supposed to go forward and evolve, not de-evolve.
  // What's next ?
  // - "We think you don't need a steering wheel in your car,
  //    since we believe you don't know where you're going" ??

  #ifdef _WIN64
    #ifdef _MSC_VER // Later on, an intrinsic came along..
      #define _BREAK  __debugbreak() /* asm int 3 */
    #else
      #define _BREAK  DebugBreak()
    #endif
  #else // Break *here*, not in DebugBreak()
    #ifdef __GNUC__
      // FIXME: Replace this hack with a proper GCC inline asm statement.
      #define _BREAK  DebugBreak()
    #else
      #define _BREAK  __asm Int 3 /* The original, circa 1996? */
    #endif
  #endif

  #define BREAK_IF( cond ) if (cond) _BREAK


  #define BREAK() \
    if (IsDebuggerPresent()) _BREAK; \
    else MessageBox( NULL, \
        _T("Debugging Breakpoint:\nNo debugger present.. You may want to attach one now."), \
        dbg_Name, MB_OK| MB_ICONSTOP )

  #define DBGBREAK( Msg ) OutputDebugString( Msg ); BREAK()

  #define TRACE(_lvl,...) DPrint(_lvl,__VA_ARGS__) 
  #define _TRACE(_va_)    DPrint##_va_ 

  //( TRACEX produces a trace that's fairly compatible w std ReactOS traces. )

  #define TRACEX(_lvl,_fmt,...) DPrint(_lvl,_F(_fmt" (%s:%u)\n"),__VA_ARGS__,__FILE__,__LINE__)

  #define TRACE_IF(cond,...)  if (cond) DPrint( __VA_ARGS__ )
  #define TRACEX_IF(_cond,_lvl,_fmt,...) if (_cond) DPrint(_lvl,_fmt" (%s:%u)\n",__VA_ARGS__,__FILE__,__LINE__)

  //#define ERROR_TRACE(What)  DPrint( DP_ERROR, _T("%s failed: %s\n"), What, SysErrorMsg() )
  #define ERROR_TRACE(What)  DP_StdFailMsg( What )

  #define IF_DEBUG( code )  code

#else // NDEBUG //--------------------------------------------------------------

  #define _BREAK
  #define BREAK_IF(cond)
  #define BREAK()
  #define DBGBREAK(msg)
  #define _TRACE(_va_)
  #define TRACE(...)
  #define TRACEX(...)
  #define TRACE_IF(cond,...)
  #define TRACEX_IF(...)
  #define ERROR_TRACE(what)
  #ifdef NO_DPRINT
    #define DPrint(...)
  #endif
  #define IF_DEBUG( code )

#endif //-----------------------------------------------------------------------

END_EXTERN_C
#endif //ndef _Debug_h_incl_
// EOF