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 // Alternatively, you can also use the SET_DEBUG_TYPE("foo") macro to specify
  17 // that your debug code belongs to class "foo".  Then, on the command line, you
  18 // can specify '-debug-only=foo' to enable JUST the debug information for the
  19 // foo class.
  20 //
  21 // When compiling without assertions, the -debug-* options and all code in
  22 // DEBUG() statements disappears, so it does not effect the runtime of the code.
  23 //
  24 //===----------------------------------------------------------------------===//
  25
  26 #ifndef LLVM_SUPPORT_DEBUG_H
  27 #define LLVM_SUPPORT_DEBUG_H
  28
  29 namespace llvm {
  30
  31 /// DEBUG_TYPE macro - Files can specify a DEBUG_TYPE as a string, which causes
  32 /// all of their DEBUG statements to be activatable with -debug-only=thatstring.
  33 #ifndef DEBUG_TYPE
  34 #define DEBUG_TYPE ""
  35 #endif
  36
  37 #ifndef NDEBUG
  38 /// DebugFlag - This boolean is set to true if the '-debug' command line option
  39 /// is specified.  This should probably not be referenced directly, instead, use
  40 /// the DEBUG macro below.
  41 ///
  42 extern bool DebugFlag;
  43
  44 /// isCurrentDebugType - Return true if the specified string is the debug type
  45 /// specified on the command line, or if none was specified on the command line
  46 /// with the -debug-only=X option.
  47 ///
  48 bool isCurrentDebugType(const char *Type);
  49
  50 /// SetCurrentDebugType - Set the current debug type, as if the -debug-only=X
  51 /// option were specified.  Note that DebugFlag also needs to be set to true for
  52 /// debug output to be produced.
  53 ///
  54 void SetCurrentDebugType(const char *Type);
  55
  56 /// DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug
  57 /// information.  In the '-debug' option is specified on the commandline, and if
  58 /// this is a debug build, then the code specified as the option to the macro
  59 /// will be executed.  Otherwise it will not be.  Example:
  60 ///
  61 /// DEBUG_WITH_TYPE("bitset", errs() << "Bitset contains: " << Bitset << "\n");
  62 ///
  63 /// This will emit the debug information if -debug is present, and -debug-only
  64 /// is not specified, or is specified as "bitset".
  65 #define DEBUG_WITH_TYPE(TYPE, X)                                        \
  66   do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType(TYPE)) { X; } \
  67   } while (0)
  68
  69 #else
  70 #define isCurrentDebugType(X) (false)
  71 #define SetCurrentDebugType(X)
  72 #define DEBUG_WITH_TYPE(TYPE, X) do { } while (0)
  73 #endif
  74
  75 // DEBUG macro - This macro should be used by passes to emit debug information.
  76 // In the '-debug' option is specified on the commandline, and if this is a
  77 // debug build, then the code specified as the option to the macro will be
  78 // executed.  Otherwise it will not be.  Example:
  79 //
  80 // DEBUG(errs() << "Bitset contains: " << Bitset << "\n");
  81 //
  82 #define DEBUG(X) DEBUG_WITH_TYPE(DEBUG_TYPE, X)
  83
  84 } // End llvm namespace
  85
  86 #endif