mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-11-01 15:11:24 +00:00
283b399377
behavior based on other files defining DEBUG_TYPE, which means it cannot define DEBUG_TYPE at all. This is actually better IMO as it forces folks to define relevant DEBUG_TYPEs for their files. However, it requires all files that currently use DEBUG(...) to define a DEBUG_TYPE if they don't already. I've updated all such files in LLVM and will do the same for other upstream projects. This still leaves one important change in how LLVM uses the DEBUG_TYPE macro going forward: we need to only define the macro *after* header files have been #include-ed. Previously, this wasn't possible because Debug.h required the macro to be pre-defined. This commit removes that. By defining DEBUG_TYPE after the includes two things are fixed: - Header files that need to provide a DEBUG_TYPE for some inline code can do so by defining the macro before their inline code and undef-ing it afterward so the macro does not escape. - We no longer have rampant ODR violations due to including headers with different DEBUG_TYPE definitions. This may be mostly an academic violation today, but with modules these types of violations are easy to check for and potentially very relevant. Where necessary to suppor headers with DEBUG_TYPE, I have moved the definitions below the includes in this commit. I plan to move the rest of the DEBUG_TYPE macros in LLVM in subsequent commits; this one is big enough. The comments in Debug.h, which were hilariously out of date already, have been updated to reflect the recommended practice going forward. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@206822 91177308-0d34-0410-b5e6-96231b3b80d8
98 lines
3.9 KiB
C++
98 lines
3.9 KiB
C++
//===- llvm/Support/Debug.h - Easy way to add debug output ------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements a handy way of adding debugging information to your
|
|
// code, without it being enabled all of the time, and without having to add
|
|
// command line options to enable it.
|
|
//
|
|
// In particular, just wrap your code with the DEBUG() macro, and it will be
|
|
// enabled automatically if you specify '-debug' on the command-line.
|
|
// Alternatively, you can also define the DEBUG_TYPE macro to "foo" specify
|
|
// that your debug code belongs to class "foo". Be careful that you only do
|
|
// this after including Debug.h and not around any #include of headers. Headers
|
|
// should define and undef the macro acround the code that needs to use the
|
|
// DEBUG() macro. Then, on the command line, you can specify '-debug-only=foo'
|
|
// to enable JUST the debug information for the foo class.
|
|
//
|
|
// When compiling without assertions, the -debug-* options and all code in
|
|
// DEBUG() statements disappears, so it does not affect the runtime of the code.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_SUPPORT_DEBUG_H
|
|
#define LLVM_SUPPORT_DEBUG_H
|
|
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
namespace llvm {
|
|
|
|
#ifndef NDEBUG
|
|
/// DebugFlag - This boolean is set to true if the '-debug' command line option
|
|
/// is specified. This should probably not be referenced directly, instead, use
|
|
/// the DEBUG macro below.
|
|
///
|
|
extern bool DebugFlag;
|
|
|
|
/// isCurrentDebugType - Return true if the specified string is the debug type
|
|
/// specified on the command line, or if none was specified on the command line
|
|
/// with the -debug-only=X option.
|
|
///
|
|
bool isCurrentDebugType(const char *Type);
|
|
|
|
/// setCurrentDebugType - Set the current debug type, as if the -debug-only=X
|
|
/// option were specified. Note that DebugFlag also needs to be set to true for
|
|
/// debug output to be produced.
|
|
///
|
|
void setCurrentDebugType(const char *Type);
|
|
|
|
/// DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug
|
|
/// information. In the '-debug' option is specified on the commandline, and if
|
|
/// this is a debug build, then the code specified as the option to the macro
|
|
/// will be executed. Otherwise it will not be. Example:
|
|
///
|
|
/// DEBUG_WITH_TYPE("bitset", dbgs() << "Bitset contains: " << Bitset << "\n");
|
|
///
|
|
/// This will emit the debug information if -debug is present, and -debug-only
|
|
/// is not specified, or is specified as "bitset".
|
|
#define DEBUG_WITH_TYPE(TYPE, X) \
|
|
do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType(TYPE)) { X; } \
|
|
} while (0)
|
|
|
|
#else
|
|
#define isCurrentDebugType(X) (false)
|
|
#define setCurrentDebugType(X)
|
|
#define DEBUG_WITH_TYPE(TYPE, X) do { } while (0)
|
|
#endif
|
|
|
|
/// EnableDebugBuffering - This defaults to false. If true, the debug
|
|
/// stream will install signal handlers to dump any buffered debug
|
|
/// output. It allows clients to selectively allow the debug stream
|
|
/// to install signal handlers if they are certain there will be no
|
|
/// conflict.
|
|
///
|
|
extern bool EnableDebugBuffering;
|
|
|
|
/// dbgs() - This returns a reference to a raw_ostream for debugging
|
|
/// messages. If debugging is disabled it returns errs(). Use it
|
|
/// like: dbgs() << "foo" << "bar";
|
|
raw_ostream &dbgs();
|
|
|
|
// DEBUG macro - This macro should be used by passes to emit debug information.
|
|
// In the '-debug' option is specified on the commandline, and if this is a
|
|
// debug build, then the code specified as the option to the macro will be
|
|
// executed. Otherwise it will not be. Example:
|
|
//
|
|
// DEBUG(dbgs() << "Bitset contains: " << Bitset << "\n");
|
|
//
|
|
#define DEBUG(X) DEBUG_WITH_TYPE(DEBUG_TYPE, X)
|
|
|
|
} // End llvm namespace
|
|
|
|
#endif
|