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/Support/CommandLine.h"
16 #include "llvm/Support/Debug.h"
17 #include "llvm/Support/ManagedStatic.h"
18 #include "llvm/Support/raw_ostream.h"
19 #include "llvm/Support/Format.h"
20 #include "llvm/System/Mutex.h"
21 #include "llvm/System/Process.h"
22 #include "llvm/ADT/OwningPtr.h"
23 #include "llvm/ADT/StringMap.h"
26 // CreateInfoOutputFile - Return a file stream to print our output on.
27 namespace llvm { extern raw_ostream *CreateInfoOutputFile(); }
29 // getLibSupportInfoOutputFilename - This ugly hack is brought to you courtesy
30 // of constructor/destructor ordering being unspecified by C++. Basically the
31 // problem is that a Statistic object gets destroyed, which ends up calling
32 // 'GetLibSupportInfoOutputFile()' (below), which calls this function.
33 // LibSupportInfoOutputFilename used to be a global variable, but sometimes it
34 // would get destroyed before the Statistic, causing havoc to ensue. We "fix"
35 // this by creating the string the first time it is needed and never destroying
37 static ManagedStatic<std::string> LibSupportInfoOutputFilename;
38 static std::string &getLibSupportInfoOutputFilename() {
39 return *LibSupportInfoOutputFilename;
42 static ManagedStatic<sys::SmartMutex<true> > TimerLock;
46 TrackSpace("track-memory", cl::desc("Enable -time-passes memory "
47 "tracking (this may be slow)"),
50 static cl::opt<std::string, true>
51 InfoOutputFilename("info-output-file", cl::value_desc("filename"),
52 cl::desc("File to append -stats and -timer output to"),
53 cl::Hidden, cl::location(getLibSupportInfoOutputFilename()));
56 // CreateInfoOutputFile - Return a file stream to print our output on.
57 raw_ostream *llvm::CreateInfoOutputFile() {
58 const std::string &OutputFilename = getLibSupportInfoOutputFilename();
59 if (OutputFilename.empty())
60 return new raw_fd_ostream(2, false); // stderr.
61 if (OutputFilename == "-")
62 return new raw_fd_ostream(1, false); // stdout.
65 raw_ostream *Result = new raw_fd_ostream(OutputFilename.c_str(),
66 Error, raw_fd_ostream::F_Append);
70 errs() << "Error opening info-output-file '"
71 << OutputFilename << " for appending!\n";
73 return new raw_fd_ostream(2, false); // stderr.
77 static TimerGroup *DefaultTimerGroup = 0;
78 static TimerGroup *getDefaultTimerGroup() {
79 TimerGroup *tmp = DefaultTimerGroup;
83 llvm_acquire_global_lock();
84 tmp = DefaultTimerGroup;
86 tmp = new TimerGroup("Miscellaneous Ungrouped Timers");
88 DefaultTimerGroup = tmp;
90 llvm_release_global_lock();
95 //===----------------------------------------------------------------------===//
96 // Timer Implementation
97 //===----------------------------------------------------------------------===//
99 void Timer::init(StringRef N) {
100 assert(TG == 0 && "Timer already initialized");
101 Name.assign(N.begin(), N.end());
103 TG = getDefaultTimerGroup();
107 void Timer::init(StringRef N, TimerGroup &tg) {
108 assert(TG == 0 && "Timer already initialized");
109 Name.assign(N.begin(), N.end());
116 if (!TG) return; // Never initialized, or already cleared.
117 TG->removeTimer(*this);
120 static inline size_t getMemUsage() {
121 if (!TrackSpace) return 0;
122 return sys::Process::GetMallocUsage();
125 TimeRecord TimeRecord::getCurrentTime(bool Start) {
127 sys::TimeValue now(0,0), user(0,0), sys(0,0);
130 Result.MemUsed = getMemUsage();
131 sys::Process::GetTimeUsage(now, user, sys);
133 sys::Process::GetTimeUsage(now, user, sys);
134 Result.MemUsed = getMemUsage();
137 Result.WallTime = now.seconds() + now.microseconds() / 1000000.0;
138 Result.UserTime = user.seconds() + user.microseconds() / 1000000.0;
139 Result.SystemTime = sys.seconds() + sys.microseconds() / 1000000.0;
143 static ManagedStatic<std::vector<Timer*> > ActiveTimers;
145 void Timer::startTimer() {
147 ActiveTimers->push_back(this);
148 Time -= TimeRecord::getCurrentTime(true);
151 void Timer::stopTimer() {
152 Time += TimeRecord::getCurrentTime(false);
154 if (ActiveTimers->back() == this) {
155 ActiveTimers->pop_back();
157 std::vector<Timer*>::iterator I =
158 std::find(ActiveTimers->begin(), ActiveTimers->end(), this);
159 assert(I != ActiveTimers->end() && "stop but no startTimer?");
160 ActiveTimers->erase(I);
164 static void printVal(double Val, double Total, raw_ostream &OS) {
165 if (Total < 1e-7) // Avoid dividing by zero.
168 OS << " " << format("%7.4f", Val) << " (";
169 OS << format("%5.1f", Val*100/Total) << "%)";
173 void TimeRecord::print(const TimeRecord &Total, raw_ostream &OS) const {
174 if (Total.getUserTime())
175 printVal(getUserTime(), Total.getUserTime(), OS);
176 if (Total.getSystemTime())
177 printVal(getSystemTime(), Total.getSystemTime(), OS);
178 if (Total.getProcessTime())
179 printVal(getProcessTime(), Total.getProcessTime(), OS);
180 printVal(getWallTime(), Total.getWallTime(), OS);
184 if (Total.getMemUsed())
185 OS << format("%9lld", (long long)getMemUsed()) << " ";
189 //===----------------------------------------------------------------------===//
190 // NamedRegionTimer Implementation
191 //===----------------------------------------------------------------------===//
193 typedef StringMap<Timer> Name2TimerMap;
196 StringMap<std::pair<TimerGroup*, Name2TimerMap> > Map;
199 for (StringMap<std::pair<TimerGroup*, Name2TimerMap> >::iterator
200 I = Map.begin(), E = Map.end(); I != E; ++I)
201 delete I->second.first;
204 Timer &get(StringRef Name, StringRef GroupName) {
205 sys::SmartScopedLock<true> L(*TimerLock);
207 std::pair<TimerGroup*, Name2TimerMap> &GroupEntry = Map[GroupName];
209 if (!GroupEntry.first)
210 GroupEntry.first = new TimerGroup(GroupName);
212 Timer &T = GroupEntry.second[Name];
213 if (!T.isInitialized())
214 T.init(Name, *GroupEntry.first);
219 static ManagedStatic<Name2TimerMap> NamedTimers;
220 static ManagedStatic<Name2PairMap> NamedGroupedTimers;
222 static Timer &getNamedRegionTimer(StringRef Name) {
223 sys::SmartScopedLock<true> L(*TimerLock);
225 Timer &T = (*NamedTimers)[Name];
226 if (!T.isInitialized())
231 NamedRegionTimer::NamedRegionTimer(StringRef Name)
232 : TimeRegion(getNamedRegionTimer(Name)) {}
234 NamedRegionTimer::NamedRegionTimer(StringRef Name, StringRef GroupName)
235 : TimeRegion(NamedGroupedTimers->get(Name, GroupName)) {}
237 //===----------------------------------------------------------------------===//
238 // TimerGroup Implementation
239 //===----------------------------------------------------------------------===//
241 /// TimerGroupList - This is the global list of TimerGroups, maintained by the
242 /// TimerGroup ctor/dtor and is protected by the TimerLock lock.
243 static TimerGroup *TimerGroupList = 0;
245 TimerGroup::TimerGroup(StringRef name)
246 : Name(name.begin(), name.end()), FirstTimer(0) {
248 // Add the group to TimerGroupList.
249 sys::SmartScopedLock<true> L(*TimerLock);
251 TimerGroupList->Prev = &Next;
252 Next = TimerGroupList;
253 Prev = &TimerGroupList;
254 TimerGroupList = this;
257 TimerGroup::~TimerGroup() {
258 // If the timer group is destroyed before the timers it owns, accumulate and
259 // print the timing data.
260 while (FirstTimer != 0)
261 removeTimer(*FirstTimer);
263 // Remove the group from the TimerGroupList.
264 sys::SmartScopedLock<true> L(*TimerLock);
271 void TimerGroup::removeTimer(Timer &T) {
272 sys::SmartScopedLock<true> L(*TimerLock);
274 // If the timer was started, move its data to TimersToPrint.
276 TimersToPrint.push_back(std::make_pair(T.Time, T.Name));
280 // Unlink the timer from our list.
283 T.Next->Prev = T.Prev;
285 // Print the report when all timers in this group are destroyed if some of
286 // them were started.
287 if (FirstTimer != 0 || TimersToPrint.empty())
290 raw_ostream *OutStream = CreateInfoOutputFile();
291 PrintQueuedTimers(*OutStream);
292 delete OutStream; // Close the file.
295 void TimerGroup::addTimer(Timer &T) {
296 sys::SmartScopedLock<true> L(*TimerLock);
298 // Add the timer to our list.
300 FirstTimer->Prev = &T.Next;
302 T.Prev = &FirstTimer;
306 void TimerGroup::PrintQueuedTimers(raw_ostream &OS) {
307 // Sort the timers in descending order by amount of time taken.
308 std::sort(TimersToPrint.begin(), TimersToPrint.end());
311 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i)
312 Total += TimersToPrint[i].first;
314 // Print out timing header.
315 OS << "===" << std::string(73, '-') << "===\n";
316 // Figure out how many spaces to indent TimerGroup name.
317 unsigned Padding = (80-Name.length())/2;
318 if (Padding > 80) Padding = 0; // Don't allow "negative" numbers
319 OS.indent(Padding) << Name << '\n';
320 OS << "===" << std::string(73, '-') << "===\n";
322 // If this is not an collection of ungrouped times, print the total time.
323 // Ungrouped timers don't really make sense to add up. We still print the
324 // TOTAL line to make the percentages make sense.
325 if (this != DefaultTimerGroup) {
326 OS << " Total Execution Time: ";
327 OS << format("%5.4f", Total.getProcessTime()) << " seconds (";
328 OS << format("%5.4f", Total.getWallTime()) << " wall clock)\n";
332 if (Total.getUserTime())
333 OS << " ---User Time---";
334 if (Total.getSystemTime())
335 OS << " --System Time--";
336 if (Total.getProcessTime())
337 OS << " --User+System--";
338 OS << " ---Wall Time---";
339 if (Total.getMemUsed())
341 OS << " --- Name ---\n";
343 // Loop through all of the timing data, printing it out.
344 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i) {
345 const std::pair<TimeRecord, std::string> &Entry = TimersToPrint[e-i-1];
346 Entry.first.print(Total, OS);
347 OS << Entry.second << '\n';
350 Total.print(Total, OS);
354 TimersToPrint.clear();
357 /// print - Print any started timers in this group and zero them.
358 void TimerGroup::print(raw_ostream &OS) {
359 sys::SmartScopedLock<true> L(*TimerLock);
361 // See if any of our timers were started, if so add them to TimersToPrint and
363 for (Timer *T = FirstTimer; T; T = T->Next) {
364 if (!T->Started) continue;
365 TimersToPrint.push_back(std::make_pair(T->Time, T->Name));
367 // Clear out the time.
369 T->Time = TimeRecord();
372 // If any timers were started, print the group.
373 if (!TimersToPrint.empty())
374 PrintQueuedTimers(OS);
377 /// printAll - This static method prints all timers and clears them all out.
378 void TimerGroup::printAll(raw_ostream &OS) {
379 sys::SmartScopedLock<true> L(*TimerLock);
381 for (TimerGroup *TG = TimerGroupList; TG; TG = TG->Next)