LLVM 20.0.0git
Timer.h
Go to the documentation of this file.
1//===-- llvm/Support/Timer.h - Interval Timing Support ----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_SUPPORT_TIMER_H
10#define LLVM_SUPPORT_TIMER_H
11
12#include "llvm/ADT/StringMap.h"
13#include "llvm/ADT/StringRef.h"
15#include "llvm/Support/Mutex.h"
16#include <cassert>
17#include <memory>
18#include <string>
19#include <vector>
20
21namespace llvm {
22
23class TimerGlobals;
24class TimerGroup;
25class raw_ostream;
26
28 double WallTime = 0.0; ///< Wall clock time elapsed in seconds.
29 double UserTime = 0.0; ///< User time elapsed.
30 double SystemTime = 0.0; ///< System time elapsed.
31 ssize_t MemUsed = 0; ///< Memory allocated (in bytes).
32 uint64_t InstructionsExecuted = 0; ///< Number of instructions executed
33public:
34 TimeRecord() = default;
35
36 /// Get the current time and memory usage. If Start is true we get the memory
37 /// usage before the time, otherwise we get time before memory usage. This
38 /// matters if the time to get the memory usage is significant and shouldn't
39 /// be counted as part of a duration.
40 static TimeRecord getCurrentTime(bool Start = true);
41
42 double getProcessTime() const { return UserTime + SystemTime; }
43 double getUserTime() const { return UserTime; }
44 double getSystemTime() const { return SystemTime; }
45 double getWallTime() const { return WallTime; }
46 ssize_t getMemUsed() const { return MemUsed; }
47 uint64_t getInstructionsExecuted() const { return InstructionsExecuted; }
48
49 bool operator<(const TimeRecord &T) const {
50 // Sort by Wall Time elapsed, as it is the only thing really accurate
51 return WallTime < T.WallTime;
52 }
53
54 void operator+=(const TimeRecord &RHS) {
55 WallTime += RHS.WallTime;
56 UserTime += RHS.UserTime;
57 SystemTime += RHS.SystemTime;
58 MemUsed += RHS.MemUsed;
59 InstructionsExecuted += RHS.InstructionsExecuted;
60 }
61 void operator-=(const TimeRecord &RHS) {
62 WallTime -= RHS.WallTime;
63 UserTime -= RHS.UserTime;
64 SystemTime -= RHS.SystemTime;
65 MemUsed -= RHS.MemUsed;
66 InstructionsExecuted -= RHS.InstructionsExecuted;
67 }
68
69 /// Print the current time record to \p OS, with a breakdown showing
70 /// contributions to the \p Total time record.
71 void print(const TimeRecord &Total, raw_ostream &OS) const;
72};
73
74/// This class is used to track the amount of time spent between invocations of
75/// its startTimer()/stopTimer() methods. Given appropriate OS support it can
76/// also keep track of the RSS of the program at various points. By default,
77/// the Timer will print the amount of time it has captured to standard error
78/// when the last timer is destroyed, otherwise it is printed when its
79/// TimerGroup is destroyed. Timers do not print their information if they are
80/// never started.
81class Timer {
82 TimeRecord Time; ///< The total time captured.
83 TimeRecord StartTime; ///< The time startTimer() was last called.
84 std::string Name; ///< The name of this time variable.
85 std::string Description; ///< Description of this time variable.
86 bool Running = false; ///< Is the timer currently running?
87 bool Triggered = false; ///< Has the timer ever been triggered?
88 TimerGroup *TG = nullptr; ///< The TimerGroup this Timer is in.
89
90 Timer **Prev = nullptr; ///< Pointer to \p Next of previous timer in group.
91 Timer *Next = nullptr; ///< Next timer in the group.
92public:
93 explicit Timer(StringRef TimerName, StringRef TimerDescription) {
94 init(TimerName, TimerDescription);
95 }
96 Timer(StringRef TimerName, StringRef TimerDescription, TimerGroup &tg) {
97 init(TimerName, TimerDescription, tg);
98 }
99 Timer(const Timer &RHS) {
100 assert(!RHS.TG && "Can only copy uninitialized timers");
101 }
102 const Timer &operator=(const Timer &T) {
103 assert(!TG && !T.TG && "Can only assign uninit timers");
104 return *this;
105 }
106 ~Timer();
107
108 /// Create an uninitialized timer, client must use 'init'.
109 explicit Timer() = default;
110 void init(StringRef TimerName, StringRef TimerDescription);
111 void init(StringRef TimerName, StringRef TimerDescription, TimerGroup &tg);
112
113 const std::string &getName() const { return Name; }
114 const std::string &getDescription() const { return Description; }
115 bool isInitialized() const { return TG != nullptr; }
116
117 /// Check if the timer is currently running.
118 bool isRunning() const { return Running; }
119
120 /// Check if startTimer() has ever been called on this timer.
121 bool hasTriggered() const { return Triggered; }
122
123 /// Start the timer running. Time between calls to startTimer/stopTimer is
124 /// counted by the Timer class. Note that these calls must be correctly
125 /// paired.
126 void startTimer();
127
128 /// Stop the timer.
129 void stopTimer();
130
131 /// Clear the timer state.
132 void clear();
133
134 /// Stop the timer and start another timer.
135 void yieldTo(Timer &);
136
137 /// Return the duration for which this timer has been running.
138 TimeRecord getTotalTime() const { return Time; }
139
140private:
141 friend class TimerGroup;
142};
143
144/// The TimeRegion class is used as a helper class to call the startTimer() and
145/// stopTimer() methods of the Timer class. When the object is constructed, it
146/// starts the timer specified as its argument. When it is destroyed, it stops
147/// the relevant timer. This makes it easy to time a region of code.
149 Timer *T;
150 TimeRegion(const TimeRegion &) = delete;
151
152public:
153 explicit TimeRegion(Timer &t) : T(&t) {
154 T->startTimer();
155 }
156 explicit TimeRegion(Timer *t) : T(t) {
157 if (T) T->startTimer();
158 }
160 if (T) T->stopTimer();
161 }
162};
163
164/// This class is basically a combination of TimeRegion and Timer. It allows
165/// you to declare a new timer, AND specify the region to time, all in one
166/// statement. All timers with the same name are merged. This is primarily
167/// used for debugging and for hunting performance problems.
169 explicit NamedRegionTimer(StringRef Name, StringRef Description,
170 StringRef GroupName,
171 StringRef GroupDescription, bool Enabled = true);
172};
173
174/// The TimerGroup class is used to group together related timers into a single
175/// report that is printed when the TimerGroup is destroyed. It is illegal to
176/// destroy a TimerGroup object before all of the Timers in it are gone. A
177/// TimerGroup can be specified for a newly created timer in its constructor.
179 struct PrintRecord {
180 TimeRecord Time;
181 std::string Name;
182 std::string Description;
183
184 PrintRecord(const PrintRecord &Other) = default;
185 PrintRecord &operator=(const PrintRecord &Other) = default;
186 PrintRecord(const TimeRecord &Time, const std::string &Name,
187 const std::string &Description)
188 : Time(Time), Name(Name), Description(Description) {}
189
190 bool operator <(const PrintRecord &Other) const {
191 return Time < Other.Time;
192 }
193 };
194 std::string Name;
195 std::string Description;
196 Timer *FirstTimer = nullptr; ///< First timer in the group.
197 std::vector<PrintRecord> TimersToPrint;
198
199 TimerGroup **Prev; ///< Pointer to Next field of previous timergroup in list.
200 TimerGroup *Next; ///< Pointer to next timergroup in list.
201 TimerGroup(const TimerGroup &TG) = delete;
202 void operator=(const TimerGroup &TG) = delete;
203
204 friend class TimerGlobals;
205 explicit TimerGroup(StringRef Name, StringRef Description,
207
208public:
209 explicit TimerGroup(StringRef Name, StringRef Description);
210
211 explicit TimerGroup(StringRef Name, StringRef Description,
212 const StringMap<TimeRecord> &Records);
213
214 ~TimerGroup();
215
216 void setName(StringRef NewName, StringRef NewDescription) {
217 Name.assign(NewName.begin(), NewName.end());
218 Description.assign(NewDescription.begin(), NewDescription.end());
219 }
220
221 /// Print any started timers in this group, optionally resetting timers after
222 /// printing them.
223 void print(raw_ostream &OS, bool ResetAfterPrint = false);
224
225 /// Clear all timers in this group.
226 void clear();
227
228 /// This static method prints all timers.
229 static void printAll(raw_ostream &OS);
230
231 /// Clear out all timers. This is mostly used to disable automatic
232 /// printing on shutdown, when timers have already been printed explicitly
233 /// using \c printAll or \c printJSONValues.
234 static void clearAll();
235
236 const char *printJSONValues(raw_ostream &OS, const char *delim);
237
238 /// Prints all timers as JSON key/value pairs.
239 static const char *printAllJSONValues(raw_ostream &OS, const char *delim);
240
241 /// Ensure global objects required for statistics printing are initialized.
242 /// This function is used by the Statistic code to ensure correct order of
243 /// global constructors and destructors.
244 static void constructForStatistics();
245
246 /// This makes the timer globals unmanaged, and lets the user manage the
247 /// lifetime.
248 static void *acquireTimerGlobals();
249
250private:
251 friend class Timer;
253 void addTimer(Timer &T);
254 void removeTimer(Timer &T);
255 void prepareToPrintList(bool reset_time = false);
256 void PrintQueuedTimers(raw_ostream &OS);
257 void printJSONValue(raw_ostream &OS, const PrintRecord &R,
258 const char *suffix, double Value);
259};
260
261} // end namespace llvm
262
263#endif
This file defines the StringMap class.
std::string Name
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
raw_pwrite_stream & OS
static bool Enabled
Definition: Statistic.cpp:46
Value * RHS
StringMap - This is an unconventional map that is specialized for handling keys that are "strings",...
Definition: StringMap.h:128
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:51
iterator begin() const
Definition: StringRef.h:116
iterator end() const
Definition: StringRef.h:118
double getUserTime() const
Definition: Timer.h:43
double getProcessTime() const
Definition: Timer.h:42
TimeRecord()=default
static TimeRecord getCurrentTime(bool Start=true)
Get the current time and memory usage.
Definition: Timer.cpp:128
double getWallTime() const
Definition: Timer.h:45
ssize_t getMemUsed() const
Definition: Timer.h:46
void operator-=(const TimeRecord &RHS)
Definition: Timer.h:61
void operator+=(const TimeRecord &RHS)
Definition: Timer.h:54
double getSystemTime() const
Definition: Timer.h:44
bool operator<(const TimeRecord &T) const
Definition: Timer.h:49
void print(const TimeRecord &Total, raw_ostream &OS) const
Print the current time record to OS, with a breakdown showing contributions to the Total time record.
Definition: Timer.cpp:186
uint64_t getInstructionsExecuted() const
Definition: Timer.h:47
The TimeRegion class is used as a helper class to call the startTimer() and stopTimer() methods of th...
Definition: Timer.h:148
TimeRegion(Timer &t)
Definition: Timer.h:153
TimeRegion(Timer *t)
Definition: Timer.h:156
The TimerGroup class is used to group together related timers into a single report that is printed wh...
Definition: Timer.h:178
static void printAll(raw_ostream &OS)
This static method prints all timers.
Definition: Timer.cpp:416
void setName(StringRef NewName, StringRef NewDescription)
Definition: Timer.h:216
void print(raw_ostream &OS, bool ResetAfterPrint=false)
Print any started timers in this group, optionally resetting timers after printing them.
Definition: Timer.cpp:398
static void clearAll()
Clear out all timers.
Definition: Timer.cpp:423
void clear()
Clear all timers in this group.
Definition: Timer.cpp:410
friend void PrintStatisticsJSON(raw_ostream &OS)
Print statistics in JSON format.
static void * acquireTimerGlobals()
This makes the timer globals unmanaged, and lets the user manage the lifetime.
Definition: Timer.cpp:550
static const char * printAllJSONValues(raw_ostream &OS, const char *delim)
Prints all timers as JSON key/value pairs.
Definition: Timer.cpp:467
const char * printJSONValues(raw_ostream &OS, const char *delim)
Definition: Timer.cpp:440
static void constructForStatistics()
Ensure global objects required for statistics printing are initialized.
Definition: Timer.cpp:546
This class is used to track the amount of time spent between invocations of its startTimer()/stopTime...
Definition: Timer.h:81
bool hasTriggered() const
Check if startTimer() has ever been called on this timer.
Definition: Timer.h:121
void yieldTo(Timer &)
Stop the timer and start another timer.
Definition: Timer.cpp:174
bool isRunning() const
Check if the timer is currently running.
Definition: Timer.h:118
void stopTimer()
Stop the timer.
Definition: Timer.cpp:159
const Timer & operator=(const Timer &T)
Definition: Timer.h:102
const std::string & getDescription() const
Definition: Timer.h:114
void init(StringRef TimerName, StringRef TimerDescription)
Definition: Timer.cpp:92
void clear()
Clear the timer state.
Definition: Timer.cpp:169
const std::string & getName() const
Definition: Timer.h:113
Timer()=default
Create an uninitialized timer, client must use 'init'.
Timer(const Timer &RHS)
Definition: Timer.h:99
bool isInitialized() const
Definition: Timer.h:115
Timer(StringRef TimerName, StringRef TimerDescription)
Definition: Timer.h:93
Timer(StringRef TimerName, StringRef TimerDescription, TimerGroup &tg)
Definition: Timer.h:96
void startTimer()
Start the timer running.
Definition: Timer.cpp:150
TimeRecord getTotalTime() const
Return the duration for which this timer has been running.
Definition: Timer.h:138
LLVM Value Representation.
Definition: Value.h:74
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
SmartMutex - A mutex with a compile time constant parameter that indicates whether this mutex should ...
Definition: Mutex.h:28
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Other
Any other memory.
This class is basically a combination of TimeRegion and Timer.
Definition: Timer.h:168