1 //===-- Timer.cpp - Interval Timing Support -------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Interval Timing implementation.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Support/Timer.h"
15 #include "llvm/ADT/Statistic.h"
16 #include "llvm/ADT/StringMap.h"
17 #include "llvm/Support/CommandLine.h"
18 #include "llvm/Support/FileSystem.h"
19 #include "llvm/Support/Format.h"
20 #include "llvm/Support/ManagedStatic.h"
21 #include "llvm/Support/Mutex.h"
22 #include "llvm/Support/Process.h"
23 #include "llvm/Support/raw_ostream.h"
26 // getLibSupportInfoOutputFilename - This ugly hack is brought to you courtesy
27 // of constructor/destructor ordering being unspecified by C++. Basically the
28 // problem is that a Statistic object gets destroyed, which ends up calling
29 // 'GetLibSupportInfoOutputFile()' (below), which calls this function.
30 // LibSupportInfoOutputFilename used to be a global variable, but sometimes it
31 // would get destroyed before the Statistic, causing havoc to ensue. We "fix"
32 // this by creating the string the first time it is needed and never destroying
34 static ManagedStatic<std::string> LibSupportInfoOutputFilename;
35 static std::string &getLibSupportInfoOutputFilename() {
36 return *LibSupportInfoOutputFilename;
39 static ManagedStatic<sys::SmartMutex<true> > TimerLock;
43 TrackSpace("track-memory", cl::desc("Enable -time-passes memory "
44 "tracking (this may be slow)"),
47 static cl::opt<std::string, true>
48 InfoOutputFilename("info-output-file", cl::value_desc("filename"),
49 cl::desc("File to append -stats and -timer output to"),
50 cl::Hidden, cl::location(getLibSupportInfoOutputFilename()));
53 // Return a file stream to print our output on.
54 std::unique_ptr<raw_fd_ostream> llvm::CreateInfoOutputFile() {
55 const std::string &OutputFilename = getLibSupportInfoOutputFilename();
56 if (OutputFilename.empty())
57 return llvm::make_unique<raw_fd_ostream>(2, false); // stderr.
58 if (OutputFilename == "-")
59 return llvm::make_unique<raw_fd_ostream>(1, false); // stdout.
61 // Append mode is used because the info output file is opened and closed
62 // each time -stats or -time-passes wants to print output to it. To
63 // compensate for this, the test-suite Makefiles have code to delete the
64 // info output file before running commands which write to it.
66 auto Result = llvm::make_unique<raw_fd_ostream>(
67 OutputFilename, EC, sys::fs::F_Append | sys::fs::F_Text);
71 errs() << "Error opening info-output-file '"
72 << OutputFilename << " for appending!\n";
73 return llvm::make_unique<raw_fd_ostream>(2, false); // stderr.
77 static TimerGroup *DefaultTimerGroup = nullptr;
78 static TimerGroup *getDefaultTimerGroup() {
79 TimerGroup *tmp = DefaultTimerGroup;
83 sys::SmartScopedLock<true> Lock(*TimerLock);
84 tmp = DefaultTimerGroup;
86 tmp = new TimerGroup("Miscellaneous Ungrouped Timers");
88 DefaultTimerGroup = tmp;
94 //===----------------------------------------------------------------------===//
95 // Timer Implementation
96 //===----------------------------------------------------------------------===//
98 void Timer::init(StringRef N) {
99 init(N, *getDefaultTimerGroup());
102 void Timer::init(StringRef N, TimerGroup &tg) {
103 assert(!TG && "Timer already initialized");
104 Name.assign(N.begin(), N.end());
105 Running = Triggered = false;
111 if (!TG) return; // Never initialized, or already cleared.
112 TG->removeTimer(*this);
115 static inline size_t getMemUsage() {
116 if (!TrackSpace) return 0;
117 return sys::Process::GetMallocUsage();
120 TimeRecord TimeRecord::getCurrentTime(bool Start) {
122 sys::TimeValue now(0,0), user(0,0), sys(0,0);
125 Result.MemUsed = getMemUsage();
126 sys::Process::GetTimeUsage(now, user, sys);
128 sys::Process::GetTimeUsage(now, user, sys);
129 Result.MemUsed = getMemUsage();
132 Result.WallTime = now.seconds() + now.microseconds() / 1000000.0;
133 Result.UserTime = user.seconds() + user.microseconds() / 1000000.0;
134 Result.SystemTime = sys.seconds() + sys.microseconds() / 1000000.0;
138 void Timer::startTimer() {
139 assert(!Running && "Cannot start a running timer");
140 Running = Triggered = true;
141 StartTime = TimeRecord::getCurrentTime(true);
144 void Timer::stopTimer() {
145 assert(Running && "Cannot stop a paused timer");
147 Time += TimeRecord::getCurrentTime(false);
151 void Timer::clear() {
152 Running = Triggered = false;
153 Time = StartTime = TimeRecord();
156 static void printVal(double Val, double Total, raw_ostream &OS) {
157 if (Total < 1e-7) // Avoid dividing by zero.
160 OS << format(" %7.4f (%5.1f%%)", Val, Val*100/Total);
163 void TimeRecord::print(const TimeRecord &Total, raw_ostream &OS) const {
164 if (Total.getUserTime())
165 printVal(getUserTime(), Total.getUserTime(), OS);
166 if (Total.getSystemTime())
167 printVal(getSystemTime(), Total.getSystemTime(), OS);
168 if (Total.getProcessTime())
169 printVal(getProcessTime(), Total.getProcessTime(), OS);
170 printVal(getWallTime(), Total.getWallTime(), OS);
174 if (Total.getMemUsed())
175 OS << format("%9" PRId64 " ", (int64_t)getMemUsed());
179 //===----------------------------------------------------------------------===//
180 // NamedRegionTimer Implementation
181 //===----------------------------------------------------------------------===//
185 typedef StringMap<Timer> Name2TimerMap;
188 StringMap<std::pair<TimerGroup*, Name2TimerMap> > Map;
191 for (StringMap<std::pair<TimerGroup*, Name2TimerMap> >::iterator
192 I = Map.begin(), E = Map.end(); I != E; ++I)
193 delete I->second.first;
196 Timer &get(StringRef Name, StringRef GroupName) {
197 sys::SmartScopedLock<true> L(*TimerLock);
199 std::pair<TimerGroup*, Name2TimerMap> &GroupEntry = Map[GroupName];
201 if (!GroupEntry.first)
202 GroupEntry.first = new TimerGroup(GroupName);
204 Timer &T = GroupEntry.second[Name];
205 if (!T.isInitialized())
206 T.init(Name, *GroupEntry.first);
213 static ManagedStatic<Name2TimerMap> NamedTimers;
214 static ManagedStatic<Name2PairMap> NamedGroupedTimers;
216 static Timer &getNamedRegionTimer(StringRef Name) {
217 sys::SmartScopedLock<true> L(*TimerLock);
219 Timer &T = (*NamedTimers)[Name];
220 if (!T.isInitialized())
225 NamedRegionTimer::NamedRegionTimer(StringRef Name,
227 : TimeRegion(!Enabled ? nullptr : &getNamedRegionTimer(Name)) {}
229 NamedRegionTimer::NamedRegionTimer(StringRef Name, StringRef GroupName,
231 : TimeRegion(!Enabled ? nullptr : &NamedGroupedTimers->get(Name, GroupName)){}
233 //===----------------------------------------------------------------------===//
234 // TimerGroup Implementation
235 //===----------------------------------------------------------------------===//
237 /// TimerGroupList - This is the global list of TimerGroups, maintained by the
238 /// TimerGroup ctor/dtor and is protected by the TimerLock lock.
239 static TimerGroup *TimerGroupList = nullptr;
241 TimerGroup::TimerGroup(StringRef name)
242 : Name(name.begin(), name.end()), FirstTimer(nullptr) {
244 // Add the group to TimerGroupList.
245 sys::SmartScopedLock<true> L(*TimerLock);
247 TimerGroupList->Prev = &Next;
248 Next = TimerGroupList;
249 Prev = &TimerGroupList;
250 TimerGroupList = this;
253 TimerGroup::~TimerGroup() {
254 // If the timer group is destroyed before the timers it owns, accumulate and
255 // print the timing data.
257 removeTimer(*FirstTimer);
259 // Remove the group from the TimerGroupList.
260 sys::SmartScopedLock<true> L(*TimerLock);
267 void TimerGroup::removeTimer(Timer &T) {
268 sys::SmartScopedLock<true> L(*TimerLock);
270 // If the timer was started, move its data to TimersToPrint.
271 if (T.hasTriggered())
272 TimersToPrint.emplace_back(T.Time, T.Name);
276 // Unlink the timer from our list.
279 T.Next->Prev = T.Prev;
281 // Print the report when all timers in this group are destroyed if some of
282 // them were started.
283 if (FirstTimer || TimersToPrint.empty())
286 std::unique_ptr<raw_ostream> OutStream = CreateInfoOutputFile();
287 PrintQueuedTimers(*OutStream);
290 void TimerGroup::addTimer(Timer &T) {
291 sys::SmartScopedLock<true> L(*TimerLock);
293 // Add the timer to our list.
295 FirstTimer->Prev = &T.Next;
297 T.Prev = &FirstTimer;
301 void TimerGroup::PrintQueuedTimers(raw_ostream &OS) {
302 // Sort the timers in descending order by amount of time taken.
303 std::sort(TimersToPrint.begin(), TimersToPrint.end());
306 for (auto &RecordNamePair : TimersToPrint)
307 Total += RecordNamePair.first;
309 // Print out timing header.
310 OS << "===" << std::string(73, '-') << "===\n";
311 // Figure out how many spaces to indent TimerGroup name.
312 unsigned Padding = (80-Name.length())/2;
313 if (Padding > 80) Padding = 0; // Don't allow "negative" numbers
314 OS.indent(Padding) << Name << '\n';
315 OS << "===" << std::string(73, '-') << "===\n";
317 // If this is not an collection of ungrouped times, print the total time.
318 // Ungrouped timers don't really make sense to add up. We still print the
319 // TOTAL line to make the percentages make sense.
320 if (this != DefaultTimerGroup)
321 OS << format(" Total Execution Time: %5.4f seconds (%5.4f wall clock)\n",
322 Total.getProcessTime(), Total.getWallTime());
325 if (Total.getUserTime())
326 OS << " ---User Time---";
327 if (Total.getSystemTime())
328 OS << " --System Time--";
329 if (Total.getProcessTime())
330 OS << " --User+System--";
331 OS << " ---Wall Time---";
332 if (Total.getMemUsed())
334 OS << " --- Name ---\n";
336 // Loop through all of the timing data, printing it out.
337 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i) {
338 const std::pair<TimeRecord, std::string> &Entry = TimersToPrint[e-i-1];
339 Entry.first.print(Total, OS);
340 OS << Entry.second << '\n';
343 Total.print(Total, OS);
347 TimersToPrint.clear();
350 /// print - Print any started timers in this group and zero them.
351 void TimerGroup::print(raw_ostream &OS) {
352 sys::SmartScopedLock<true> L(*TimerLock);
354 // See if any of our timers were started, if so add them to TimersToPrint and
356 for (Timer *T = FirstTimer; T; T = T->Next) {
357 if (!T->hasTriggered()) continue;
358 TimersToPrint.emplace_back(T->Time, T->Name);
360 // Clear out the time.
364 // If any timers were started, print the group.
365 if (!TimersToPrint.empty())
366 PrintQueuedTimers(OS);
369 /// printAll - This static method prints all timers and clears them all out.
370 void TimerGroup::printAll(raw_ostream &OS) {
371 sys::SmartScopedLock<true> L(*TimerLock);
373 for (TimerGroup *TG = TimerGroupList; TG; TG = TG->Next)