lib/Support/Debug.cpp

   1 //===-- Debug.cpp - An easy way to add debug output to your code ----------===//
   2 //
   3 // This file implements a handle way of adding debugging information to your
   4 // code, without it being enabled all of the time, and without having to add
   5 // command line options to enable it.
   6 //
   7 // In particular, just wrap your code with the DEBUG() macro, and it will be
   8 // enabled automatically if you specify '-debug' on the command-line.
   9 // Alternatively, you can also use the SET_DEBUG_TYPE("foo") macro to specify
  10 // that your debug code belongs to class "foo".  Then, on the command line, you
  11 // can specify '-debug-only=foo' to enable JUST the debug information for the
  12 // foo class.
  13 //
  14 // When compiling in release mode, the -debug-* options and all code in DEBUG()
  15 // statements disappears, so it does not effect the runtime of the code.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "Support/Statistic.h"
  20 #include "Support/CommandLine.h"
  21
  22 bool DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
  23
  24 namespace {
  25 #ifndef NDEBUG
  26   // -debug - Command line option to enable the DEBUG statements in the passes.
  27   // This flag may only be enabled in debug builds.
  28   cl::opt<bool, true>
  29   Debug("debug", cl::desc("Enable debug output"), cl::Hidden,
  30         cl::location(DebugFlag));
  31
  32   std::string CurrentDebugType;
  33   struct DebugOnlyOpt {
  34     void operator=(const std::string &Val) const {
  35       DebugFlag |= !Val.empty();
  36       CurrentDebugType = Val;
  37     }
  38   } DebugOnlyOptLoc;
  39
  40   cl::opt<DebugOnlyOpt, true, cl::parser<std::string> >
  41   DebugOnly("debug-only", cl::desc("Enable a specific type of debug output"),
  42             cl::Hidden, cl::value_desc("debug string"),
  43             cl::location(DebugOnlyOptLoc), cl::ValueRequired);
  44 #endif
  45 }
  46
  47 // isCurrentDebugType - Return true if the specified string is the debug type
  48 // specified on the command line, or if none was specified on the command line
  49 // with the -debug-only=X option.
  50 //
  51 bool isCurrentDebugType(const char *DebugType) {
  52   return CurrentDebugType.empty() || DebugType == CurrentDebugType;
  53 }