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 "llvm/Support/Debug.h"
  27 #include "llvm/Support/CommandLine.h"
  28 #include <iostream>
  29 using namespace llvm;
  30
  31 bool llvm::DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
  32
  33 namespace {
  34 #ifndef NDEBUG
  35   // -debug - Command line option to enable the DEBUG statements in the passes.
  36   // This flag may only be enabled in debug builds.
  37   cl::opt<bool, true>
  38   Debug("debug", cl::desc("Enable debug output"), cl::Hidden,
  39         cl::location(DebugFlag));
  40
  41   std::string CurrentDebugType;
  42   struct DebugOnlyOpt {
  43     void operator=(const std::string &Val) const {
  44       DebugFlag |= !Val.empty();
  45       CurrentDebugType = Val;
  46     }
  47   } DebugOnlyOptLoc;
  48
  49   cl::opt<DebugOnlyOpt, true, cl::parser<std::string> >
  50   DebugOnly("debug-only", cl::desc("Enable a specific type of debug output"),
  51             cl::Hidden, cl::value_desc("debug string"),
  52             cl::location(DebugOnlyOptLoc), cl::ValueRequired);
  53 #endif
  54 }
  55
  56 // isCurrentDebugType - Return true if the specified string is the debug type
  57 // specified on the command line, or if none was specified on the command line
  58 // with the -debug-only=X option.
  59 //
  60 bool llvm::isCurrentDebugType(const char *DebugType) {
  61 #ifndef NDEBUG
  62   return CurrentDebugType.empty() || DebugType == CurrentDebugType;
  63 #else
  64   return false;
  65 #endif
  66 }
  67
  68 // getErrorOutputStream - Returns the error output stream (std::cerr). This
  69 // places the std::c* I/O streams into one .cpp file and relieves the whole
  70 // program from having to have hundreds of static c'tor/d'tors for them.
  71 //
  72 llvm_ostream llvm::getErrorOutputStream(const char *DebugType) {
  73   if (DebugFlag && isCurrentDebugType(DebugType))
  74     return llvm_ostream(std::cerr);
  75   else
  76     return llvm_ostream();
  77 }