lib/Support/Debug.cpp

   1 //===-- Debug.cpp - An easy way to add debug output to your code ----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a handle 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 in release mode, the -debug-* options and all code in DEBUG()
  22 // statements disappears, so it does not effect the runtime of the code.
  23 //
  24 //===----------------------------------------------------------------------===//
  25
  26 #include "Support/Statistic.h"
  27 #include "Support/CommandLine.h"
  28
  29 bool DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
  30
  31 namespace {
  32 #ifndef NDEBUG
  33   // -debug - Command line option to enable the DEBUG statements in the passes.
  34   // This flag may only be enabled in debug builds.
  35   cl::opt<bool, true>
  36   Debug("debug", cl::desc("Enable debug output"), cl::Hidden,
  37         cl::location(DebugFlag));
  38
  39   std::string CurrentDebugType;
  40   struct DebugOnlyOpt {
  41     void operator=(const std::string &Val) const {
  42       DebugFlag |= !Val.empty();
  43       CurrentDebugType = Val;
  44     }
  45   } DebugOnlyOptLoc;
  46
  47   cl::opt<DebugOnlyOpt, true, cl::parser<std::string> >
  48   DebugOnly("debug-only", cl::desc("Enable a specific type of debug output"),
  49             cl::Hidden, cl::value_desc("debug string"),
  50             cl::location(DebugOnlyOptLoc), cl::ValueRequired);
  51 #endif
  52 }
  53
  54 // isCurrentDebugType - Return true if the specified string is the debug type
  55 // specified on the command line, or if none was specified on the command line
  56 // with the -debug-only=X option.
  57 //
  58 bool isCurrentDebugType(const char *DebugType) {
  59 #ifndef NDEBUG
  60   return CurrentDebugType.empty() || DebugType == CurrentDebugType;
  61 #else
  62   return false;
  63 #endif
  64 }