LLVM: llvm::TimerGroup Class Reference (original) (raw)

The TimerGroup class is used to group together related timers into a single report that is printed when the TimerGroup is destroyed. More...

#include "[llvm/Support/Timer.h](Timer%5F8h%5Fsource.html)"

Public Member Functions
LLVM_ABI	TimerGroup (StringRef Name, StringRef Description, bool PrintOnExit=true)
LLVM_ABI	TimerGroup (StringRef Name, StringRef Description, const StringMap< TimeRecord > &Records, bool PrintOnExit=true)
LLVM_ABI	~TimerGroup ()
void	setName (StringRef NewName, StringRef NewDescription)
LLVM_ABI void	print (raw_ostream &OS, bool ResetAfterPrint=false)
	Print any started timers in this group, optionally resetting timers after printing them.
LLVM_ABI void	clear ()
	Clear all timers in this group.
LLVM_ABI const char *	printJSONValues (raw_ostream &OS, const char *delim)

Static Public Member Functions
static LLVM_ABI void	printAll (raw_ostream &OS)
	This static method prints all timers.
static LLVM_ABI void	clearAll ()
	Clear out all timers.
static LLVM_ABI const char *	printAllJSONValues (raw_ostream &OS, const char *delim)
	Prints all timers as JSON key/value pairs.
static LLVM_ABI void	constructForStatistics ()
	Ensure global objects required for statistics printing are initialized.
static LLVM_ABI void *	acquireTimerGlobals ()
	This makes the timer globals unmanaged, and lets the user manage the lifetime.

The TimerGroup class is used to group together related timers into a single report that is printed when the TimerGroup is destroyed.

It is illegal to destroy a TimerGroup object before all of the Timers in it are gone. A TimerGroup can be specified for a newly created timer in its constructor.

Definition at line 191 of file Timer.h.

◆ TimerGroup() [2/2]

◆ ~TimerGroup()

TimerGroup::~TimerGroup	(	)

◆ acquireTimerGlobals()

void * TimerGroup::acquireTimerGlobals ( )	static

◆ clear()

void TimerGroup::clear	(	)

◆ clearAll()

void TimerGroup::clearAll ( )	static

Clear out all timers.

This is mostly used to disable automatic printing on shutdown, when timers have already been printed explicitly using printAll or printJSONValues.

Definition at line 451 of file Timer.cpp.

References TimerGroupList, and timerLock().

◆ constructForStatistics()

void TimerGroup::constructForStatistics ( )	static

Ensure global objects required for statistics printing are initialized.

This function is used by the Statistic code to ensure correct order of global constructors and destructors.

Definition at line 570 of file Timer.cpp.

References ManagedTimerGlobals.

◆ print()

Print any started timers in this group, optionally resetting timers after printing them.

Definition at line 426 of file Timer.cpp.

References timerLock().

◆ printAll()

◆ printAllJSONValues()

◆ printJSONValues()

◆ setName()

◆ PrintStatisticsJSON

Print statistics in JSON format.

This does include all global timers (

◆ Timer

◆ TimerGlobals

The documentation for this class was generated from the following files:

include/llvm/Support/Timer.h
lib/Support/Timer.cpp