include/llvm/Support/Debug.h

   1 //===- llvm/Support/Debug.h - Easy way to add debug output ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a handy way of adding debugging information to your
  11 // code, without it being enabled all of the time, and without having to add
  12 // command line options to enable it.
  13 //
  14 // In particular, just wrap your code with the DEBUG() macro, and it will be
  15 // enabled automatically if you specify '-debug' on the command-line.
  16 // DEBUG() requires the DEBUG_TYPE macro to be defined. Set it to "foo" specify
  17 // that your debug code belongs to class "foo". Be careful that you only do
  18 // this after including Debug.h and not around any #include of headers. Headers
  19 // should define and undef the macro acround the code that needs to use the
  20 // DEBUG() macro. Then, on the command line, you can specify '-debug-only=foo'
  21 // to enable JUST the debug information for the foo class.
  22 //
  23 // When compiling without assertions, the -debug-* options and all code in
  24 // DEBUG() statements disappears, so it does not affect the runtime of the code.
  25 //
  26 //===----------------------------------------------------------------------===//
  27
  28 #ifndef LLVM_SUPPORT_DEBUG_H
  29 #define LLVM_SUPPORT_DEBUG_H
  30
  31 namespace llvm {
  32
  33 class raw_ostream;
  34
  35 #ifndef NDEBUG
  36
  37 /// isCurrentDebugType - Return true if the specified string is the debug type
  38 /// specified on the command line, or if none was specified on the command line
  39 /// with the -debug-only=X option.
  40 ///
  41 bool isCurrentDebugType(const char *Type);
  42
  43 /// setCurrentDebugType - Set the current debug type, as if the -debug-only=X
  44 /// option were specified.  Note that DebugFlag also needs to be set to true for
  45 /// debug output to be produced.
  46 ///
  47 void setCurrentDebugType(const char *Type);
  48
  49 /// setCurrentDebugTypes - Set the current debug type, as if the
  50 /// -debug-only=X,Y,Z option were specified. Note that DebugFlag
  51 /// also needs to be set to true for debug output to be produced.
  52 ///
  53 void setCurrentDebugTypes(const char **Types, unsigned Count);
  54
  55 /// DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug
  56 /// information.  In the '-debug' option is specified on the commandline, and if
  57 /// this is a debug build, then the code specified as the option to the macro
  58 /// will be executed.  Otherwise it will not be.  Example:
  59 ///
  60 /// DEBUG_WITH_TYPE("bitset", dbgs() << "Bitset contains: " << Bitset << "\n");
  61 ///
  62 /// This will emit the debug information if -debug is present, and -debug-only
  63 /// is not specified, or is specified as "bitset".
  64 #define DEBUG_WITH_TYPE(TYPE, X)                                        \
  65   do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType(TYPE)) { X; } \
  66   } while (false)
  67
  68 #else
  69 #define isCurrentDebugType(X) (false)
  70 #define setCurrentDebugType(X)
  71 #define setCurrentDebugTypes(X, N)
  72 #define DEBUG_WITH_TYPE(TYPE, X) do { } while (false)
  73 #endif
  74
  75 /// This boolean is set to true if the '-debug' command line option
  76 /// is specified.  This should probably not be referenced directly, instead, use
  77 /// the DEBUG macro below.
  78 ///
  79 extern bool DebugFlag;
  80
  81 /// \name Verification flags.
  82 ///
  83 /// These flags turns on/off that are expensive and are turned off by default,
  84 /// unless macro EXPENSIVE_CHECKS is defined. The flags allow selectively
  85 /// turning the checks on without need to recompile.
  86 /// \{
  87
  88 /// Enables verification of dominator trees.
  89 ///
  90 extern bool VerifyDomInfo;
  91
  92 /// Enables verification of loop info.
  93 ///
  94 extern bool VerifyLoopInfo;
  95
  96 ///\}
  97
  98 /// EnableDebugBuffering - This defaults to false.  If true, the debug
  99 /// stream will install signal handlers to dump any buffered debug
 100 /// output.  It allows clients to selectively allow the debug stream
 101 /// to install signal handlers if they are certain there will be no
 102 /// conflict.
 103 ///
 104 extern bool EnableDebugBuffering;
 105
 106 /// dbgs() - This returns a reference to a raw_ostream for debugging
 107 /// messages.  If debugging is disabled it returns errs().  Use it
 108 /// like: dbgs() << "foo" << "bar";
 109 raw_ostream &dbgs();
 110
 111 // DEBUG macro - This macro should be used by passes to emit debug information.
 112 // In the '-debug' option is specified on the commandline, and if this is a
 113 // debug build, then the code specified as the option to the macro will be
 114 // executed.  Otherwise it will not be.  Example:
 115 //
 116 // DEBUG(dbgs() << "Bitset contains: " << Bitset << "\n");
 117 //
 118 #define DEBUG(X) DEBUG_WITH_TYPE(DEBUG_TYPE, X)
 119
 120 } // end namespace llvm
 121
 122 #endif // LLVM_SUPPORT_DEBUG_H