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
36 double Elapsed; // Wall clock time elapsed in seconds
37 double UserTime; // User time elapsed
38 double SystemTime; // System time elapsed
39 long MemUsed; // Memory allocated (in bytes)
40 long PeakMem; // Peak memory used
41 long PeakMemBase; // Temporary for peak calculation...
42 std::string Name; // The name of this time variable
43 bool Started; // Has this time variable ever been started?
44 TimerGroup *TG; // The TimerGroup this Timer is in.
46 Timer(const std::string &N);
47 Timer(const std::string &N, TimerGroup &tg);
48 Timer(const Timer &T);
51 double getProcessTime() const { return UserTime+SystemTime; }
52 double getWallTime() const { return Elapsed; }
53 long getMemUsed() const { return MemUsed; }
54 long getPeakMem() const { return PeakMem; }
55 std::string getName() const { return Name; }
57 const Timer &operator=(const Timer &T) {
59 UserTime = T.UserTime;
60 SystemTime = T.SystemTime;
63 PeakMemBase = T.PeakMemBase;
66 assert(TG == T.TG && "Can only assign timers in the same TimerGroup!");
70 // operator< - Allow sorting...
71 bool operator<(const Timer &T) const {
72 // Sort by Wall Time elapsed, as it is the only thing really accurate
73 return Elapsed < T.Elapsed;
75 bool operator>(const Timer &T) const { return T.operator<(*this); }
77 /// startTimer - Start the timer running. Time between calls to
78 /// startTimer/stopTimer is counted by the Timer class. Note that these calls
79 /// must be correctly paired.
83 /// stopTimer - Stop the timer.
87 /// addPeakMemoryMeasurement - This method should be called whenever memory
88 /// usage needs to be checked. It adds a peak memory measurement to the
89 /// currently active timers, which will be printed when the timer group prints
91 static void addPeakMemoryMeasurement();
93 /// print - Print the current timer to standard error, and reset the "Started"
95 void print(const Timer &Total, std::ostream &OS);
98 friend class TimerGroup;
100 // Copy ctor, initialize with no TG member.
101 Timer(bool, const Timer &T);
103 /// sum - Add the time accumulated in the specified timer into this timer.
105 void sum(const Timer &T);
111 TimeRegion(const TimeRegion &); // DO NOT IMPLEMENT
113 TimeRegion(Timer &t) : T(t) {
124 std::vector<Timer> TimersToPrint;
126 TimerGroup(const std::string &name) : Name(name), NumTimers(0) {}
128 assert(NumTimers == 0 &&
129 "TimerGroup destroyed before all contained timers!");
134 void addTimer() { ++NumTimers; }
136 void addTimerToPrint(const Timer &T) {
137 TimersToPrint.push_back(Timer(true, T));