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 // DebugFlag - This boolean is set to true if the '-debug' command line option
  32 // is specified.  This should probably not be referenced directly, instead, use
  33 // the DEBUG macro below.
  34 //
  35 #ifndef NDEBUG
  36 extern bool DebugFlag;
  37 #endif
  38
  39 // isCurrentDebugType - Return true if the specified string is the debug type
  40 // specified on the command line, or if none was specified on the command line
  41 // with the -debug-only=X option.
  42 //
  43 #ifndef NDEBUG
  44 bool isCurrentDebugType(const char *Type);
  45 #else
  46 #define isCurrentDebugType(X) (false)
  47 #endif
  48
  49 // DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug
  50 // information.  In the '-debug' option is specified on the commandline, and if
  51 // this is a debug build, then the code specified as the option to the macro
  52 // will be executed.  Otherwise it will not be.  Example:
  53 //
  54 // DEBUG_WITH_TYPE("bitset", errs() << "Bitset contains: " << Bitset << "\n");
  55 //
  56 // This will emit the debug information if -debug is present, and -debug-only is
  57 // not specified, or is specified as "bitset".
  58
  59 #ifdef NDEBUG
  60 #define DEBUG_WITH_TYPE(TYPE, X) do { } while (0)
  61 #else
  62 #define DEBUG_WITH_TYPE(TYPE, X)                                        \
  63   do { if (DebugFlag && isCurrentDebugType(TYPE)) { X; } } while (0)
  64 #endif
  65
  66 // DEBUG macro - This macro should be used by passes to emit debug information.
  67 // In the '-debug' option is specified on the commandline, and if this is a
  68 // debug build, then the code specified as the option to the macro will be
  69 // executed.  Otherwise it will not be.  Example:
  70 //
  71 // DEBUG(errs() << "Bitset contains: " << Bitset << "\n");
  72 //
  73
  74 #ifndef DEBUG_TYPE
  75 #define DEBUG_TYPE ""
  76 #endif
  77
  78 #define DEBUG(X) DEBUG_WITH_TYPE(DEBUG_TYPE, X)
  79
  80 } // End llvm namespace
  81
  82 #endif