1 //===-- Support/Timer.h - Interval Timing Support ---------------*- C++ -*-===//
3 // This file defines three classes: Timer, TimeRegion, and TimerGroup.
5 // The Timer class is used to track the amount of time spent between invocations
6 // of it's startTimer()/stopTimer() methods. Given appropriate OS support it
7 // can also keep track of the RSS of the program at various points. By default,
8 // the Timer will print the amount of time it has captured to standard error
9 // when the laster timer is destroyed, otherwise it is printed when it's
10 // TimerGroup is destroyed. Timer's do not print their information if they are
13 // The TimeRegion class is used as a helper class to call the startTimer() and
14 // stopTimer() methods of the Timer class. When the object is constructed, it
15 // starts the timer specified as it's argument. When it is destroyed, it stops
16 // the relevant timer. This makes it easy to time a region of code.
18 // The TimerGroup class is used to group together related timers into a single
19 // report that is printed when the TimerGroup is destroyed. It is illegal to
20 // destroy a TimerGroup object before all of the Timers in it are gone. A
21 // TimerGroup can be specified for a newly created timer in its constructor.
23 //===----------------------------------------------------------------------===//
25 #ifndef SUPPORT_TIMER_H
26 #define SUPPORT_TIMER_H
35 double Elapsed; // Wall clock time elapsed in seconds
36 double UserTime; // User time elapsed
37 double SystemTime; // System time elapsed
38 long MemUsed; // Memory allocated (in bytes)
39 long PeakMem; // Peak memory used
40 long PeakMemBase; // Temporary for peak calculation...
41 std::string Name; // The name of this time variable
42 bool Started; // Has this time variable ever been started?
43 TimerGroup *TG; // The TimerGroup this Timer is in.
45 Timer(const std::string &N);
46 Timer(const std::string &N, TimerGroup &tg);
47 Timer(const Timer &T);
50 double getProcessTime() const { return UserTime+SystemTime; }
51 double getWallTime() const { return Elapsed; }
52 long getMemUsed() const { return MemUsed; }
53 long getPeakMem() const { return PeakMem; }
54 std::string getName() const { return Name; }
56 const Timer &operator=(const Timer &T) {
58 UserTime = T.UserTime;
59 SystemTime = T.SystemTime;
62 PeakMemBase = T.PeakMemBase;
65 assert(TG == T.TG && "Can only assign timers in the same TimerGroup!");
69 // operator< - Allow sorting...
70 bool operator<(const Timer &T) const {
71 // Sort by Wall Time elapsed, as it is the only thing really accurate
72 return Elapsed < T.Elapsed;
74 bool operator>(const Timer &T) const { return T.operator<(*this); }
76 /// startTimer - Start the timer running. Time between calls to
77 /// startTimer/stopTimer is counted by the Timer class. Note that these calls
78 /// must be correctly paired.
82 /// stopTimer - Stop the timer.
86 /// addPeakMemoryMeasurement - This method should be called whenever memory
87 /// usage needs to be checked. It adds a peak memory measurement to the
88 /// currently active timers, which will be printed when the timer group prints
90 static void addPeakMemoryMeasurement();
92 /// print - Print the current timer to standard error, and reset the "Started"
94 void print(const Timer &Total, std::ostream &OS);
97 friend class TimerGroup;
99 // Copy ctor, initialize with no TG member.
100 Timer(bool, const Timer &T);
102 /// sum - Add the time accumulated in the specified timer into this timer.
104 void sum(const Timer &T);
110 TimeRegion(const TimeRegion &); // DO NOT IMPLEMENT
112 TimeRegion(Timer &t) : T(t) {
123 std::vector<Timer> TimersToPrint;
125 TimerGroup(const std::string &name) : Name(name), NumTimers(0) {}
127 assert(NumTimers == 0 &&
128 "TimerGroup destroyed before all contained timers!");
133 void addTimer() { ++NumTimers; }
135 void addTimerToPrint(const Timer &T) {
136 TimersToPrint.push_back(Timer(true, T));