0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
1 //===-- llvm/Support/Timer.h - Interval Timing Support ----------*- C++ -*-===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
2 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
3 // The LLVM Compiler Infrastructure
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
4 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
5 // This file is distributed under the University of Illinois Open Source
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
6 // License. See LICENSE.TXT for details.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
7 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
8 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
9
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
10 #ifndef LLVM_SUPPORT_TIMER_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
11 #define LLVM_SUPPORT_TIMER_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
12
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
13 #include "llvm/ADT/StringRef.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
14 #include "llvm/Support/DataTypes.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
15 #include <cassert>
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
16 #include <string>
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
17 #include <utility>
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
18 #include <vector>
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
19
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
20 namespace llvm {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
21
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
22 class Timer;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
23 class TimerGroup;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
24 class raw_ostream;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
25
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
26 class TimeRecord {
|
120
|
27 double WallTime; ///< Wall clock time elapsed in seconds.
|
|
28 double UserTime; ///< User time elapsed.
|
|
29 double SystemTime; ///< System time elapsed.
|
|
30 ssize_t MemUsed; ///< Memory allocated (in bytes).
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
31 public:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
32 TimeRecord() : WallTime(0), UserTime(0), SystemTime(0), MemUsed(0) {}
|
95
|
33
|
120
|
34 /// Get the current time and memory usage. If Start is true we get the memory
|
|
35 /// usage before the time, otherwise we get time before memory usage. This
|
|
36 /// matters if the time to get the memory usage is significant and shouldn't
|
|
37 /// be counted as part of a duration.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
38 static TimeRecord getCurrentTime(bool Start = true);
|
95
|
39
|
|
40 double getProcessTime() const { return UserTime + SystemTime; }
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
41 double getUserTime() const { return UserTime; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
42 double getSystemTime() const { return SystemTime; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
43 double getWallTime() const { return WallTime; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
44 ssize_t getMemUsed() const { return MemUsed; }
|
95
|
45
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
46 bool operator<(const TimeRecord &T) const {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
47 // Sort by Wall Time elapsed, as it is the only thing really accurate
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
48 return WallTime < T.WallTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
49 }
|
95
|
50
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
51 void operator+=(const TimeRecord &RHS) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
52 WallTime += RHS.WallTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
53 UserTime += RHS.UserTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
54 SystemTime += RHS.SystemTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
55 MemUsed += RHS.MemUsed;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
56 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
57 void operator-=(const TimeRecord &RHS) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
58 WallTime -= RHS.WallTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
59 UserTime -= RHS.UserTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
60 SystemTime -= RHS.SystemTime;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
61 MemUsed -= RHS.MemUsed;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
62 }
|
95
|
63
|
100
|
64 /// Print the current time record to \p OS, with a breakdown showing
|
|
65 /// contributions to the \p Total time record.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
66 void print(const TimeRecord &Total, raw_ostream &OS) const;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
67 };
|
95
|
68
|
120
|
69 /// This class is used to track the amount of time spent between invocations of
|
|
70 /// its startTimer()/stopTimer() methods. Given appropriate OS support it can
|
|
71 /// also keep track of the RSS of the program at various points. By default,
|
|
72 /// the Timer will print the amount of time it has captured to standard error
|
|
73 /// when the last timer is destroyed, otherwise it is printed when its
|
|
74 /// TimerGroup is destroyed. Timers do not print their information if they are
|
|
75 /// never started.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
76 class Timer {
|
120
|
77 TimeRecord Time; ///< The total time captured.
|
|
78 TimeRecord StartTime; ///< The time startTimer() was last called.
|
|
79 std::string Name; ///< The name of this time variable.
|
|
80 std::string Description; ///< Description of this time variable.
|
|
81 bool Running; ///< Is the timer currently running?
|
|
82 bool Triggered; ///< Has the timer ever been triggered?
|
|
83 TimerGroup *TG = nullptr; ///< The TimerGroup this Timer is in.
|
95
|
84
|
120
|
85 Timer **Prev; ///< Pointer to \p Next of previous timer in group.
|
|
86 Timer *Next; ///< Next timer in the group.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
87 public:
|
120
|
88 explicit Timer(StringRef Name, StringRef Description) {
|
|
89 init(Name, Description);
|
|
90 }
|
|
91 Timer(StringRef Name, StringRef Description, TimerGroup &tg) {
|
|
92 init(Name, Description, tg);
|
|
93 }
|
|
94 Timer(const Timer &RHS) {
|
77
|
95 assert(!RHS.TG && "Can only copy uninitialized timers");
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
96 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
97 const Timer &operator=(const Timer &T) {
|
77
|
98 assert(!TG && !T.TG && "Can only assign uninit timers");
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
99 return *this;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
100 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
101 ~Timer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
102
|
120
|
103 /// Create an uninitialized timer, client must use 'init'.
|
|
104 explicit Timer() {}
|
|
105 void init(StringRef Name, StringRef Description);
|
|
106 void init(StringRef Name, StringRef Description, TimerGroup &tg);
|
95
|
107
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
108 const std::string &getName() const { return Name; }
|
120
|
109 const std::string &getDescription() const { return Description; }
|
77
|
110 bool isInitialized() const { return TG != nullptr; }
|
95
|
111
|
120
|
112 /// Check if the timer is currently running.
|
|
113 bool isRunning() const { return Running; }
|
|
114
|
100
|
115 /// Check if startTimer() has ever been called on this timer.
|
|
116 bool hasTriggered() const { return Triggered; }
|
|
117
|
|
118 /// Start the timer running. Time between calls to startTimer/stopTimer is
|
|
119 /// counted by the Timer class. Note that these calls must be correctly
|
|
120 /// paired.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
121 void startTimer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
122
|
100
|
123 /// Stop the timer.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
124 void stopTimer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
125
|
100
|
126 /// Clear the timer state.
|
|
127 void clear();
|
|
128
|
|
129 /// Return the duration for which this timer has been running.
|
|
130 TimeRecord getTotalTime() const { return Time; }
|
|
131
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
132 private:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
133 friend class TimerGroup;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
134 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
135
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
136 /// The TimeRegion class is used as a helper class to call the startTimer() and
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
137 /// stopTimer() methods of the Timer class. When the object is constructed, it
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
138 /// starts the timer specified as its argument. When it is destroyed, it stops
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
139 /// the relevant timer. This makes it easy to time a region of code.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
140 class TimeRegion {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
141 Timer *T;
|
83
|
142 TimeRegion(const TimeRegion &) = delete;
|
95
|
143
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
144 public:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
145 explicit TimeRegion(Timer &t) : T(&t) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
146 T->startTimer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
147 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
148 explicit TimeRegion(Timer *t) : T(t) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
149 if (T) T->startTimer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
150 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
151 ~TimeRegion() {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
152 if (T) T->stopTimer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
153 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
154 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
155
|
120
|
156 /// This class is basically a combination of TimeRegion and Timer. It allows
|
|
157 /// you to declare a new timer, AND specify the region to time, all in one
|
|
158 /// statement. All timers with the same name are merged. This is primarily
|
|
159 /// used for debugging and for hunting performance problems.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
160 struct NamedRegionTimer : public TimeRegion {
|
120
|
161 explicit NamedRegionTimer(StringRef Name, StringRef Description,
|
|
162 StringRef GroupName,
|
|
163 StringRef GroupDescription, bool Enabled = true);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
164 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
165
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
166 /// The TimerGroup class is used to group together related timers into a single
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
167 /// report that is printed when the TimerGroup is destroyed. It is illegal to
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
168 /// destroy a TimerGroup object before all of the Timers in it are gone. A
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
169 /// TimerGroup can be specified for a newly created timer in its constructor.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
170 class TimerGroup {
|
120
|
171 struct PrintRecord {
|
|
172 TimeRecord Time;
|
|
173 std::string Name;
|
|
174 std::string Description;
|
|
175
|
|
176 PrintRecord(const PrintRecord &Other) = default;
|
|
177 PrintRecord(const TimeRecord &Time, const std::string &Name,
|
|
178 const std::string &Description)
|
|
179 : Time(Time), Name(Name), Description(Description) {}
|
|
180
|
|
181 bool operator <(const PrintRecord &Other) const {
|
|
182 return Time < Other.Time;
|
|
183 }
|
|
184 };
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
185 std::string Name;
|
120
|
186 std::string Description;
|
|
187 Timer *FirstTimer = nullptr; ///< First timer in the group.
|
|
188 std::vector<PrintRecord> TimersToPrint;
|
95
|
189
|
120
|
190 TimerGroup **Prev; ///< Pointer to Next field of previous timergroup in list.
|
|
191 TimerGroup *Next; ///< Pointer to next timergroup in list.
|
83
|
192 TimerGroup(const TimerGroup &TG) = delete;
|
|
193 void operator=(const TimerGroup &TG) = delete;
|
95
|
194
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
195 public:
|
120
|
196 explicit TimerGroup(StringRef Name, StringRef Description);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
197 ~TimerGroup();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
198
|
120
|
199 void setName(StringRef NewName, StringRef NewDescription) {
|
|
200 Name.assign(NewName.begin(), NewName.end());
|
|
201 Description.assign(NewDescription.begin(), NewDescription.end());
|
|
202 }
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
203
|
120
|
204 /// Print any started timers in this group and zero them.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
205 void print(raw_ostream &OS);
|
95
|
206
|
120
|
207 /// This static method prints all timers and clears them all out.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
208 static void printAll(raw_ostream &OS);
|
95
|
209
|
121
|
210 /// Prints all timers as JSON key/value pairs, and clears them all out.
|
|
211 static const char *printAllJSONValues(raw_ostream &OS, const char *delim);
|
|
212
|
120
|
213 /// Ensure global timer group lists are initialized. This function is mostly
|
|
214 /// used by the Statistic code to influence the construction and destruction
|
|
215 /// order of the global timer lists.
|
|
216 static void ConstructTimerLists();
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
217 private:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
218 friend class Timer;
|
120
|
219 friend void PrintStatisticsJSON(raw_ostream &OS);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
220 void addTimer(Timer &T);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
221 void removeTimer(Timer &T);
|
120
|
222 void prepareToPrintList();
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
223 void PrintQueuedTimers(raw_ostream &OS);
|
120
|
224 void printJSONValue(raw_ostream &OS, const PrintRecord &R,
|
|
225 const char *suffix, double Value);
|
|
226 const char *printJSONValues(raw_ostream &OS, const char *delim);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
227 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
228
|
120
|
229 } // end namespace llvm
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
230
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
231 #endif
|