LLVM API Documentation

llvm::Timer Class Reference

#include <Timer.h>

Collaboration diagram for llvm::Timer:
[legend]

List of all members.

Public Member Functions

 Timer (const std::string &N)
 Timer (const std::string &N, TimerGroup &tg)
 Timer (const Timer &T)
 ~Timer ()
double getProcessTime () const
double getWallTime () const
ssize_t getMemUsed () const
size_t getPeakMem () const
std::string getName () const
const Timer & operator= (const Timer &T)
bool operator< (const Timer &T) const
bool operator> (const Timer &T) const
void startTimer ()
void stopTimer ()
void print (const Timer &Total, std::ostream &OS)

Static Public Member Functions

static void addPeakMemoryMeasurement ()

Friends

class TimerGroup


Detailed Description

Timer - This class is used to track the amount of time spent between invocations of it's startTimer()/stopTimer() methods. Given appropriate OS support it can also keep track of the RSS of the program at various points. By default, the Timer will print the amount of time it has captured to standard error when the laster timer is destroyed, otherwise it is printed when its TimerGroup is destroyed. Timers do not print their information if they are never started.

Definition at line 37 of file Timer.h.


Constructor & Destructor Documentation

Timer::Timer ( const std::string &  N  )  [explicit]

Definition at line 73 of file Timer.cpp.

References llvm::TimerGroup::addTimer().

Timer::Timer ( const std::string &  N,
TimerGroup &  tg 
)

Definition at line 79 of file Timer.cpp.

References llvm::TimerGroup::addTimer().

Timer::Timer ( const Timer &  T  ) 

Definition at line 85 of file Timer.cpp.

References llvm::TimerGroup::addTimer(), operator=(), and TG.

Timer::~Timer (  ) 


Member Function Documentation

double llvm::Timer::getProcessTime (  )  const [inline]

Definition at line 54 of file Timer.h.

Referenced by print().

double llvm::Timer::getWallTime (  )  const [inline]

Definition at line 55 of file Timer.h.

ssize_t llvm::Timer::getMemUsed (  )  const [inline]

Definition at line 56 of file Timer.h.

size_t llvm::Timer::getPeakMem (  )  const [inline]

Definition at line 57 of file Timer.h.

std::string llvm::Timer::getName (  )  const [inline]

Definition at line 58 of file Timer.h.

const Timer& llvm::Timer::operator= ( const Timer &  T  )  [inline]

bool llvm::Timer::operator< ( const Timer &  T  )  const [inline]

Definition at line 91 of file Timer.h.

References Elapsed.

bool llvm::Timer::operator> ( const Timer &  T  )  const [inline]

Definition at line 95 of file Timer.h.

void Timer::startTimer (  ) 

void Timer::stopTimer (  ) 

void Timer::addPeakMemoryMeasurement (  )  [static]

addPeakMemoryMeasurement - This method should be called whenever memory usage needs to be checked. It adds a peak memory measurement to the currently active timers, which will be printed when the timer group prints

addPeakMemoryMeasurement - This method should be called whenever memory usage needs to be checked. It adds a peak memory measurement to the currently active timers, which will be printed when the timer group prints

Definition at line 205 of file Timer.cpp.

References E, and getMemUsage().

void Timer::print ( const Timer &  Total,
std::ostream &  OS 
)

print - Print the current timer to standard error, and reset the "Started" flag.

Definition at line 303 of file Timer.cpp.

References llvm::sys::SmartMutex< mt_only >::acquire(), Elapsed, getProcessTime(), Lock, MemUsed, PeakMem, printVal(), llvm::sys::SmartMutex< mt_only >::release(), SystemTime, and UserTime.


Friends And Related Function Documentation

friend class TimerGroup [friend]

Definition at line 118 of file Timer.h.


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