Debug.h revision fe2cce63aa26d0916fa7be32c6bf7fa8fb059ee7
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===- llvm/Support/Debug.h - Easy way to add debug output ------*- C++ -*-===// 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The LLVM Compiler Infrastructure 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file is distributed under the University of Illinois Open Source 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// License. See LICENSE.TXT for details. 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This file implements a handy way of adding debugging information to your 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// code, without it being enabled all of the time, and without having to add 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// command line options to enable it. 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// In particular, just wrap your code with the DEBUG() macro, and it will be 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// enabled automatically if you specify '-debug' on the command-line. 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Alternatively, you can also use the SET_DEBUG_TYPE("foo") macro to specify 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// that your debug code belongs to class "foo". Then, on the command line, you 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// can specify '-debug-only=foo' to enable JUST the debug information for the 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// foo class. 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// When compiling in release mode, the -debug-* options and all code in DEBUG() 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// statements disappears, so it does not effect the runtime of the code. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//===----------------------------------------------------------------------===// 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef LLVM_SUPPORT_DEBUG_H 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LLVM_SUPPORT_DEBUG_H 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "llvm/Support/Streams.h" 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace llvm { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DebugFlag - This boolean is set to true if the '-debug' command line option 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// is specified. This should probably not be referenced directly, instead, use 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the DEBUG macro below. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern bool DebugFlag; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// isCurrentDebugType - Return true if the specified string is the debug type 40a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)// specified on the command line, or if none was specified on the command line 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// with the -debug-only=X option. 42a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)// 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool isCurrentDebugType(const char *Type); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DEBUG macro - This macro should be used by passes to emit debug information. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// In the '-debug' option is specified on the commandline, and if this is a 471320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci// debug build, then the code specified as the option to the macro will be 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// executed. Otherwise it will not be. Example: 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DEBUG(cerr << "Bitset contains: " << Bitset << "\n"); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef DEBUG_TYPE 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEBUG_TYPE "" 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef NDEBUG 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEBUG(X) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DEBUG(X) \ 615d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) do { if (DebugFlag && isCurrentDebugType(DEBUG_TYPE)) { X; } } while (0) 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// getErrorOutputStream - Returns the error output stream (std::cerr). This 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// places the std::c* I/O streams into one .cpp file and relieves the whole 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// program from having to have hundreds of static c'tor/d'tors for them. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/// 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)OStream &getErrorOutputStream(const char *DebugType); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef NDEBUG 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DOUT llvm::OStream(0) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 73116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#define DOUT llvm::getErrorOutputStream(DEBUG_TYPE) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // End llvm namespace 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)