Debug.h File Reference

#include "llvm/Support/Compiler.h"

Go to the source code of this file.

Namespaces
namespace	llvm
	This is an optimization pass for GlobalISel generic memory operations.

Macros
#define	DEBUG_WITH_TYPE(TYPE, ...)
	DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug information.
#define	LLVM_DEBUG(...)   DEBUG_WITH_TYPE(DEBUG_TYPE, __VA_ARGS__)

Functions
LLVM_ABI bool	llvm::isCurrentDebugType (const char *Type, int Level=0)
	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.
LLVM_ABI bool	llvm::isCurrentDebugType (int Level, const char *Type)
	Overload allowing to swap the order of the Type and Level arguments.
LLVM_ABI void	llvm::setCurrentDebugType (const char *Type)
	setCurrentDebugType - Set the current debug type, as if the -debug-only=X option were specified.
LLVM_ABI void	llvm::setCurrentDebugTypes (const char **Types, unsigned Count)
	setCurrentDebugTypes - Set the current debug type, as if the -debug-only=X,Y,Z option were specified.
LLVM_ABI raw_ostream &	llvm::dbgs ()
	dbgs() - This returns a reference to a raw_ostream for debugging messages.

Variables
LLVM_ABI bool	llvm::DebugFlag = false
	This boolean is set to true if the '-debug' command line option is specified.
LLVM_ABI bool	llvm::EnableDebugBuffering = false
	EnableDebugBuffering - This defaults to false.

Macro Definition Documentation

DEBUG_WITH_TYPE

#define DEBUG_WITH_TYPE	(		TYPE,
			...
	)

Value:

  do {                                                                         \
    if (::llvm::DebugFlag && ::llvm::isCurrentDebugType(TYPE, 1)) {            \
      __VA_ARGS__;                                                             \
    }                                                                          \
  } while (false)

DEBUG_WITH_TYPE macro - This macro should be used by passes to emit debug information.

If 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".

Definition at line 77 of file Debug.h.

LLVM_DEBUG

#define LLVM_DEBUG

(

...

)

DEBUG_WITH_TYPE(DEBUG_TYPE, __VA_ARGS__)

Definition at line 119 of file Debug.h.