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());
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 static ManagedStatic<std::vector<Timer*> > ActiveTimers;
140 void Timer::startTimer() {
142 ActiveTimers->push_back(this);
143 Time -= TimeRecord::getCurrentTime(true);
146 void Timer::stopTimer() {
147 Time += TimeRecord::getCurrentTime(false);
149 if (ActiveTimers->back() == this) {
150 ActiveTimers->pop_back();
152 std::vector<Timer*>::iterator I =
153 std::find(ActiveTimers->begin(), ActiveTimers->end(), this);
154 assert(I != ActiveTimers->end() && "stop but no startTimer?");
155 ActiveTimers->erase(I);
159 static void printVal(double Val, double Total, raw_ostream &OS) {
160 if (Total < 1e-7) // Avoid dividing by zero.
163 OS << format(" %7.4f (%5.1f%%)", Val, Val*100/Total);
166 void TimeRecord::print(const TimeRecord &Total, raw_ostream &OS) const {
167 if (Total.getUserTime())
168 printVal(getUserTime(), Total.getUserTime(), OS);
169 if (Total.getSystemTime())
170 printVal(getSystemTime(), Total.getSystemTime(), OS);
171 if (Total.getProcessTime())
172 printVal(getProcessTime(), Total.getProcessTime(), OS);
173 printVal(getWallTime(), Total.getWallTime(), OS);
177 if (Total.getMemUsed())
178 OS << format("%9" PRId64 " ", (int64_t)getMemUsed());
182 //===----------------------------------------------------------------------===//
183 // NamedRegionTimer Implementation
184 //===----------------------------------------------------------------------===//
188 typedef StringMap<Timer> Name2TimerMap;
191 StringMap<std::pair<TimerGroup*, Name2TimerMap> > Map;
194 for (StringMap<std::pair<TimerGroup*, Name2TimerMap> >::iterator
195 I = Map.begin(), E = Map.end(); I != E; ++I)
196 delete I->second.first;
199 Timer &get(StringRef Name, StringRef GroupName) {
200 sys::SmartScopedLock<true> L(*TimerLock);
202 std::pair<TimerGroup*, Name2TimerMap> &GroupEntry = Map[GroupName];
204 if (!GroupEntry.first)
205 GroupEntry.first = new TimerGroup(GroupName);
207 Timer &T = GroupEntry.second[Name];
208 if (!T.isInitialized())
209 T.init(Name, *GroupEntry.first);
216 static ManagedStatic<Name2TimerMap> NamedTimers;
217 static ManagedStatic<Name2PairMap> NamedGroupedTimers;
219 static Timer &getNamedRegionTimer(StringRef Name) {
220 sys::SmartScopedLock<true> L(*TimerLock);
222 Timer &T = (*NamedTimers)[Name];
223 if (!T.isInitialized())
228 NamedRegionTimer::NamedRegionTimer(StringRef Name,
230 : TimeRegion(!Enabled ? nullptr : &getNamedRegionTimer(Name)) {}
232 NamedRegionTimer::NamedRegionTimer(StringRef Name, StringRef GroupName,
234 : TimeRegion(!Enabled ? nullptr : &NamedGroupedTimers->get(Name, GroupName)){}
236 //===----------------------------------------------------------------------===//
237 // TimerGroup Implementation
238 //===----------------------------------------------------------------------===//
240 /// TimerGroupList - This is the global list of TimerGroups, maintained by the
241 /// TimerGroup ctor/dtor and is protected by the TimerLock lock.
242 static TimerGroup *TimerGroupList = nullptr;
244 TimerGroup::TimerGroup(StringRef name)
245 : Name(name.begin(), name.end()), FirstTimer(nullptr) {
247 // Add the group to TimerGroupList.
248 sys::SmartScopedLock<true> L(*TimerLock);
250 TimerGroupList->Prev = &Next;
251 Next = TimerGroupList;
252 Prev = &TimerGroupList;
253 TimerGroupList = this;
256 TimerGroup::~TimerGroup() {
257 // If the timer group is destroyed before the timers it owns, accumulate and
258 // print the timing data.
260 removeTimer(*FirstTimer);
262 // Remove the group from the TimerGroupList.
263 sys::SmartScopedLock<true> L(*TimerLock);
270 void TimerGroup::removeTimer(Timer &T) {
271 sys::SmartScopedLock<true> L(*TimerLock);
273 // If the timer was started, move its data to TimersToPrint.
275 TimersToPrint.push_back(std::make_pair(T.Time, T.Name));
279 // Unlink the timer from our list.
282 T.Next->Prev = T.Prev;
284 // Print the report when all timers in this group are destroyed if some of
285 // them were started.
286 if (FirstTimer || TimersToPrint.empty())
289 std::unique_ptr<raw_ostream> OutStream = CreateInfoOutputFile();
290 PrintQueuedTimers(*OutStream);
293 void TimerGroup::addTimer(Timer &T) {
294 sys::SmartScopedLock<true> L(*TimerLock);
296 // Add the timer to our list.
298 FirstTimer->Prev = &T.Next;
300 T.Prev = &FirstTimer;
304 void TimerGroup::PrintQueuedTimers(raw_ostream &OS) {
305 // Sort the timers in descending order by amount of time taken.
306 std::sort(TimersToPrint.begin(), TimersToPrint.end());
309 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i)
310 Total += TimersToPrint[i].first;
312 // Print out timing header.
313 OS << "===" << std::string(73, '-') << "===\n";
314 // Figure out how many spaces to indent TimerGroup name.
315 unsigned Padding = (80-Name.length())/2;
316 if (Padding > 80) Padding = 0; // Don't allow "negative" numbers
317 OS.indent(Padding) << Name << '\n';
318 OS << "===" << std::string(73, '-') << "===\n";
320 // If this is not an collection of ungrouped times, print the total time.
321 // Ungrouped timers don't really make sense to add up. We still print the
322 // TOTAL line to make the percentages make sense.
323 if (this != DefaultTimerGroup)
324 OS << format(" Total Execution Time: %5.4f seconds (%5.4f wall clock)\n",
325 Total.getProcessTime(), Total.getWallTime());
328 if (Total.getUserTime())
329 OS << " ---User Time---";
330 if (Total.getSystemTime())
331 OS << " --System Time--";
332 if (Total.getProcessTime())
333 OS << " --User+System--";
334 OS << " ---Wall Time---";
335 if (Total.getMemUsed())
337 OS << " --- Name ---\n";
339 // Loop through all of the timing data, printing it out.
340 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i) {
341 const std::pair<TimeRecord, std::string> &Entry = TimersToPrint[e-i-1];
342 Entry.first.print(Total, OS);
343 OS << Entry.second << '\n';
346 Total.print(Total, OS);
350 TimersToPrint.clear();
353 /// print - Print any started timers in this group and zero them.
354 void TimerGroup::print(raw_ostream &OS) {
355 sys::SmartScopedLock<true> L(*TimerLock);
357 // See if any of our timers were started, if so add them to TimersToPrint and
359 for (Timer *T = FirstTimer; T; T = T->Next) {
360 if (!T->Started) continue;
361 TimersToPrint.push_back(std::make_pair(T->Time, T->Name));
363 // Clear out the time.
365 T->Time = TimeRecord();
368 // If any timers were started, print the group.
369 if (!TimersToPrint.empty())
370 PrintQueuedTimers(OS);
373 /// printAll - This static method prints all timers and clears them all out.
374 void TimerGroup::printAll(raw_ostream &OS) {
375 sys::SmartScopedLock<true> L(*TimerLock);
377 for (TimerGroup *TG = TimerGroupList; TG; TG = TG->Next)