ntoskrnl/include/internal/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  * NOTES: Define DBG in configuration file for "checked" version
  13  *        Define NDEBUG before including this header to disable debugging
  14  *        macros
  15  *        Define NASSERT before including this header to disable assertions
  16  */
  17
  18 #ifndef __INTERNAL_DEBUG
  19 #define __INTERNAL_DEBUG
  20
  21 #include <internal/ntoskrnl.h>
  22 #include <internal/dbg.h>
  23 #include <roscfg.h>
  24
  25 #define UNIMPLEMENTED do {DbgPrint("%s at %s:%d is unimplemented, have a nice day\n",__FUNCTION__,__FILE__,__LINE__); for(;;);  } while(0);
  26
  27
  28 #ifdef DBG
  29
  30 /* Assert only on "checked" version */
  31 #ifndef NASSERT
  32 #define assert(x) if (!(x)) {DbgPrint("Assertion "#x" failed at %s:%d\n", __FILE__,__LINE__); KeBugCheck(0); }
  33
  34 #define assertmsg(_c_, _m_) \
  35   if (!(_c_)) { \
  36       DbgPrint("(%s:%d)(%s) ", __FILE__, __LINE__, __FUNCTION__); \
  37       DbgPrint _m_ ; \
  38       KeBugCheck(0); \
  39   }
  40
  41 #else
  42
  43 #define assert(x)
  44 #define assertmsg(_c_, _m_)
  45
  46 #endif
  47
  48 /* Print if using a "checked" version */
  49 #define CPRINT(args...) do { DbgPrint("(%s:%d) ",__FILE__,__LINE__); DbgPrint(args); } while(0);
  50
  51 #else /* DBG */
  52
  53 #define CPRINT(args...)
  54 #define assert(x)
  55 #define assertmsg(_c_, _m_)
  56
  57 #endif /* DBG */
  58
  59 #define DPRINT1(args...) do { DbgPrint("(%s:%d) ",__FILE__,__LINE__); DbgPrint(args); } while(0);
  60 #define CHECKPOINT1 do { DbgPrint("%s:%d\n",__FILE__,__LINE__); } while(0);
  61
  62 #if defined(KDBG) && defined(NDEBUG) && defined(__NTOSKRNL__)
  63
  64 #define DPRINT(args...) do { \
  65   if (DbgShouldPrint(__FILE__)) { \
  66     DbgPrint("(%s:%d) ",__FILE__,__LINE__); \
  67     DbgPrint(args); \
  68   } \
  69 } while(0);
  70
  71 #define CHECKPOINT
  72
  73 #else /* KDBG && NDEBUG && __NTOSKRNL__ */
  74
  75 #ifndef NDEBUG
  76 #define DPRINT(args...) do { DbgPrint("(%s:%d) ",__FILE__,__LINE__); DbgPrint(args); } while(0);
  77 #define CHECKPOINT do { DbgPrint("%s:%d\n",__FILE__,__LINE__); ExAllocatePool(NonPagedPool,0); } while(0);
  78 #else /* NDEBUG */
  79 #define DPRINT(args...)
  80 #define CHECKPOINT
  81 #endif /* NDEBUG */
  82
  83 #endif /* KDBG && NDEBUG */
  84
  85 /*
  86  * FUNCTION: Assert a maximum value for the current irql
  87  * ARGUMENTS:
  88  *        x = Maximum irql
  89  */
  90 #define ASSERT_IRQL(x) assert(KeGetCurrentIrql()<=(x))
  91 #define assert_irql(x) assert(KeGetCurrentIrql()<=(x))
  92
  93 #endif /* __INTERNAL_DEBUG */