17ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens//===- llvm/Support/Debug.h - Easy way to add debug output ------*- C++ -*-===// 27ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 37ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// The LLVM Compiler Infrastructure 47ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 57ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// This file is distributed under the University of Illinois Open Source 67ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// License. See LICENSE.TXT for details. 77ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 87ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens//===----------------------------------------------------------------------===// 97ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 107ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// This file implements a handy way of adding debugging information to your 117ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// code, without it being enabled all of the time, and without having to add 127ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// command line options to enable it. 137ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 147ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// In particular, just wrap your code with the DEBUG() macro, and it will be 157ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// enabled automatically if you specify '-debug' on the command-line. 167ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// DEBUG() requires the DEBUG_TYPE macro to be defined. Set it to "foo" specify 177ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// that your debug code belongs to class "foo". Be careful that you only do 187ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// this after including Debug.h and not around any #include of headers. Headers 197ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// should define and undef the macro acround the code that needs to use the 207ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// DEBUG() macro. Then, on the command line, you can specify '-debug-only=foo' 217ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// to enable JUST the debug information for the foo class. 227ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 237ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// When compiling without assertions, the -debug-* options and all code in 247ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// DEBUG() statements disappears, so it does not affect the runtime of the code. 257ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 267ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens//===----------------------------------------------------------------------===// 277ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 287ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#ifndef LLVM_SUPPORT_DEBUG_H 297ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#define LLVM_SUPPORT_DEBUG_H 307ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 317ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensnamespace llvm { 327ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 337ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensclass raw_ostream; 347ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 357ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#ifndef NDEBUG 367ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// DebugFlag - This boolean is set to true if the '-debug' command line option 377ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// is specified. This should probably not be referenced directly, instead, use 387ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// the DEBUG macro below. 397ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// 407ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensextern bool DebugFlag; 417ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 427ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// isCurrentDebugType - Return true if the specified string is the debug type 437ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// specified on the command line, or if none was specified on the command line 447ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// with the -debug-only=X option. 457ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// 467ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensbool isCurrentDebugType(const char *Type); 477ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 487ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// setCurrentDebugType - Set the current debug type, as if the -debug-only=X 497ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// option were specified. Note that DebugFlag also needs to be set to true for 507ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// debug output to be produced. 517ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// 527ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensvoid setCurrentDebugType(const char *Type); 537ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 547ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug 557ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// information. In the '-debug' option is specified on the commandline, and if 567ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// this is a debug build, then the code specified as the option to the macro 577ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// will be executed. Otherwise it will not be. Example: 587ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// 597ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// DEBUG_WITH_TYPE("bitset", dbgs() << "Bitset contains: " << Bitset << "\n"); 607ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// 617ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// This will emit the debug information if -debug is present, and -debug-only 627ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// is not specified, or is specified as "bitset". 637ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#define DEBUG_WITH_TYPE(TYPE, X) \ 647ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType(TYPE)) { X; } \ 657ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens } while (false) 667ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 677ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#else 687ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#define isCurrentDebugType(X) (false) 697ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#define setCurrentDebugType(X) 707ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#define DEBUG_WITH_TYPE(TYPE, X) do { } while (false) 717ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#endif 727ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 737ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// EnableDebugBuffering - This defaults to false. If true, the debug 747ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// stream will install signal handlers to dump any buffered debug 757ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// output. It allows clients to selectively allow the debug stream 767ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// to install signal handlers if they are certain there will be no 777ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// conflict. 787ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// 797ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensextern bool EnableDebugBuffering; 807ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 817ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// dbgs() - This returns a reference to a raw_ostream for debugging 827ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// messages. If debugging is disabled it returns errs(). Use it 837ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens/// like: dbgs() << "foo" << "bar"; 847ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capensraw_ostream &dbgs(); 857ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 867ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// DEBUG macro - This macro should be used by passes to emit debug information. 877ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// In the '-debug' option is specified on the commandline, and if this is a 887ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// debug build, then the code specified as the option to the macro will be 897ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// executed. Otherwise it will not be. Example: 907ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 917ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// DEBUG(dbgs() << "Bitset contains: " << Bitset << "\n"); 927ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens// 937ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#define DEBUG(X) DEBUG_WITH_TYPE(DEBUG_TYPE, X) 947ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 957ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens} // end namespace llvm 967ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens 977ad046f5968d4709c3c68d165387d13f1da7bab6Nicolas Capens#endif // LLVM_SUPPORT_DEBUG_H 98