include/debug.h

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS kernel
   4  * FILE:            include/internal/debug.h
   5  * PURPOSE:         Useful debugging macros
   6  * PROGRAMMER:      David Welch (welch@mcmail.com)
   7  * UPDATE HISTORY:
   8  *                28/05/98: Created
   9  */
  10
  11 /*
  12  * NOTE: Define NDEBUG before including this header to disable debugging
  13  * macros
  14  */
  15
  16 #ifndef __INTERNAL_DEBUG
  17 #define __INTERNAL_DEBUG
  18
  19 #define UNIMPLEMENTED do {DbgPrint("%s at %s:%d is unimplemented, have a nice day\n",__FUNCTION__,__FILE__,__LINE__); for(;;);  } while(0);
  20
  21 /*  FIXME: should probably remove this later  */
  22 #if !defined(CHECKED) && !defined(NDEBUG)
  23 #define CHECKED
  24 #endif
  25
  26 #ifndef assert
  27 #ifndef NASSERT
  28 #define assert(x) if (!(x)) {RtlAssert("#x",__FILE__,__LINE__, ""); }
  29 #else
  30 #define assert(x)
  31 #endif
  32 #endif
  33
  34 #define DPRINT1(args...) do { DbgPrint("(%s:%d) ",__FILE__,__LINE__); DbgPrint(args); } while(0);
  35 #define CHECKPOINT1 do { DbgPrint("%s:%d\n",__FILE__,__LINE__); } while(0);
  36
  37
  38 #ifndef NDEBUG
  39 #define DPRINT(args...) do { DbgPrint("(%s:%d) ",__FILE__,__LINE__); DbgPrint(args); } while(0);
  40 #define CHECKPOINT do { DbgPrint("%s:%d\n",__FILE__,__LINE__); } while(0);
  41 #else
  42 #define DPRINT(args...)
  43 #define CHECKPOINT
  44 #endif /* NDEBUG */
  45
  46 /*
  47  * FUNCTION: Assert a maximum value for the current irql
  48  * ARGUMENTS:
  49  *        x = Maximum irql
  50  */
  51 #define ASSERT_IRQL(x) assert(KeGetCurrentIrql()<=(x))
  52 #define assert_irql(x) assert(KeGetCurrentIrql()<=(x))
  53
  54 /* Macros expanding to the appropriate inline assembly to raise a breakpoint */
  55 #if defined(_M_IX86)
  56 #define ASM_BREAKPOINT "\nint $3\n"
  57 #elif defined(_M_ALPHA)
  58 #define ASM_BREAKPOINT "\ncall_pal bpt\n"
  59 #elif defined(_M_MIPS)
  60 #define ASM_BREAKPOINT "\nbreak\n"
  61 #else
  62 #error Unsupported architecture.
  63 #endif
  64
  65 #endif /* __INTERNAL_DEBUG */