1 //===-- Debug.cpp - An easy way to add debug output to your code ----------===//
14 // be enabled automatically if you specify '-debug' on the command-line.
16 // that your debug code belongs to class "foo".  Then, on the command line, you
17 // can specify '-debug-only=foo' to enable JUST the debug information for the
20 // When compiling without assertions, the -debug-* options and all code in
26 #include "llvm/Support/Debug.h"
42 // built without NDEBUG can depend on via the llvm/Support/Debug.h header.
44 /// Exported boolean set by the -debug option.
49 /// Return true if the specified string is the debug type
51 /// with the -debug-only=X option.
64 /// Set the current debug type, as if the -debug-only=X
66 /// debug output to be produced.
81 // All Debug.h functionality is a no-op in NDEBUG mode.
87     return new cl::opt<bool, true>("debug", cl::desc("Enable debug output"),  in call()
92 // -debug-buffer-size - Buffer the last N characters of debug output
97         "debug-buffer-size",  in call()
98         cl::desc("Buffer the last N characters of debug output "  in call()
106 // -debug - Command line option to enable the DEBUG statements in the passes.
107 // This flag may only be enabled in debug builds.
108 static ManagedStatic<cl::opt<bool, true>, CreateDebug> Debug;  variable
132         "debug-only",  in call()
133         cl::desc("Enable a specific type of debug output (comma separated list "  in call()
135         cl::Hidden, cl::value_desc("debug string"),  in call()
146   *Debug;  in initDebugOptions()
151 // Signal handlers - dump debug output on termination.
154   // know that debug mode is enabled and dbgs() really is a  in debug_user_sig_handler()
162 /// dbgs - Return a circular-buffered debug stream.
169         : strm(errs(), "*** Debug Log Output ***\n",  in dbgs()
173         // force a debug dump.  in dbgs()
175       // Otherwise we've already set the debug stream buffer size to  in dbgs()