LLVM  4.0.0
Debug.h
Go to the documentation of this file.
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 // DEBUG() requires the DEBUG_TYPE macro to be defined. Set it to "foo" specify
17 // that your debug code belongs to class "foo". Be careful that you only do
18 // this after including Debug.h and not around any #include of headers. Headers
19 // should define and undef the macro acround the code that needs to use the
20 // DEBUG() macro. Then, on the command line, you can specify '-debug-only=foo'
21 // to enable JUST the debug information for the foo class.
22 //
23 // When compiling without assertions, the -debug-* options and all code in
24 // DEBUG() statements disappears, so it does not affect the runtime of the code.
25 //
26 //===----------------------------------------------------------------------===//
27 
28 #ifndef LLVM_SUPPORT_DEBUG_H
29 #define LLVM_SUPPORT_DEBUG_H
30 
31 namespace llvm {
32 
33 class raw_ostream;
34 
35 #ifndef NDEBUG
36 /// DebugFlag - This boolean is set to true if the '-debug' command line option
37 /// is specified. This should probably not be referenced directly, instead, use
38 /// the DEBUG macro below.
39 ///
40 extern bool DebugFlag;
41 
42 /// isCurrentDebugType - Return true if the specified string is the debug type
43 /// specified on the command line, or if none was specified on the command line
44 /// with the -debug-only=X option.
45 ///
46 bool isCurrentDebugType(const char *Type);
47 
48 /// setCurrentDebugType - Set the current debug type, as if the -debug-only=X
49 /// option were specified. Note that DebugFlag also needs to be set to true for
50 /// debug output to be produced.
51 ///
52 void setCurrentDebugType(const char *Type);
53 
54 /// setCurrentDebugTypes - Set the current debug type, as if the
55 /// -debug-only=X,Y,Z option were specified. Note that DebugFlag
56 /// also needs to be set to true for debug output to be produced.
57 ///
58 void setCurrentDebugTypes(const char **Types, unsigned Count);
59 
60 /// DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug
61 /// information. In the '-debug' option is specified on the commandline, and if
62 /// this is a debug build, then the code specified as the option to the macro
63 /// will be executed. Otherwise it will not be. Example:
64 ///
65 /// DEBUG_WITH_TYPE("bitset", dbgs() << "Bitset contains: " << Bitset << "\n");
66 ///
67 /// This will emit the debug information if -debug is present, and -debug-only
68 /// is not specified, or is specified as "bitset".
69 #define DEBUG_WITH_TYPE(TYPE, X) \
70  do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType(TYPE)) { X; } \
71  } while (false)
72 
73 #else
74 #define isCurrentDebugType(X) (false)
75 #define setCurrentDebugType(X)
76 #define setCurrentDebugTypes(X, N)
77 #define DEBUG_WITH_TYPE(TYPE, X) do { } while (false)
78 #endif
79 
80 /// EnableDebugBuffering - This defaults to false. If true, the debug
81 /// stream will install signal handlers to dump any buffered debug
82 /// output. It allows clients to selectively allow the debug stream
83 /// to install signal handlers if they are certain there will be no
84 /// conflict.
85 ///
86 extern bool EnableDebugBuffering;
87 
88 /// dbgs() - This returns a reference to a raw_ostream for debugging
89 /// messages. If debugging is disabled it returns errs(). Use it
90 /// like: dbgs() << "foo" << "bar";
91 raw_ostream &dbgs();
92 
93 // DEBUG macro - This macro should be used by passes to emit debug information.
94 // In the '-debug' option is specified on the commandline, and if this is a
95 // debug build, then the code specified as the option to the macro will be
96 // executed. Otherwise it will not be. Example:
97 //
98 // DEBUG(dbgs() << "Bitset contains: " << Bitset << "\n");
99 //
100 #define DEBUG(X) DEBUG_WITH_TYPE(DEBUG_TYPE, X)
101 
102 } // end namespace llvm
103 
104 #endif // LLVM_SUPPORT_DEBUG_H
void setCurrentDebugType(const char *Type)
setCurrentDebugType - Set the current debug type, as if the -debug-only=X option were specified...
Definition: Debug.cpp:68
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
bool EnableDebugBuffering
EnableDebugBuffering - This defaults to false.
Definition: Debug.cpp:165
bool DebugFlag
DebugFlag - This boolean is set to true if the '-debug' command line option is specified.
Definition: Debug.cpp:43
bool isCurrentDebugType(const char *Type)
isCurrentDebugType - Return true if the specified string is the debug type specified on the command l...
Definition: Debug.cpp:50
void setCurrentDebugTypes(const char **Types, unsigned Count)
setCurrentDebugTypes - Set the current debug type, as if the -debug-only=X,Y,Z option were specified...
Definition: Debug.cpp:72