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/ManagedStatic.h"
17 #include "llvm/Support/raw_ostream.h"
18 #include "llvm/Support/Format.h"
19 #include "llvm/System/Process.h"
25 // GetLibSupportInfoOutputFile - Return a file stream to print our output on.
26 namespace llvm { extern raw_ostream *GetLibSupportInfoOutputFile(); }
28 // getLibSupportInfoOutputFilename - This ugly hack is brought to you courtesy
29 // of constructor/destructor ordering being unspecified by C++. Basically the
30 // problem is that a Statistic object gets destroyed, which ends up calling
31 // 'GetLibSupportInfoOutputFile()' (below), which calls this function.
32 // LibSupportInfoOutputFilename used to be a global variable, but sometimes it
33 // would get destroyed before the Statistic, causing havoc to ensue. We "fix"
34 // this by creating the string the first time it is needed and never destroying
36 static ManagedStatic<std::string> LibSupportInfoOutputFilename;
37 static std::string &getLibSupportInfoOutputFilename() {
38 return *LibSupportInfoOutputFilename;
41 static ManagedStatic<sys::SmartMutex<true> > TimerLock;
45 TrackSpace("track-memory", cl::desc("Enable -time-passes memory "
46 "tracking (this may be slow)"),
49 static cl::opt<std::string, true>
50 InfoOutputFilename("info-output-file", cl::value_desc("filename"),
51 cl::desc("File to append -stats and -timer output to"),
52 cl::Hidden, cl::location(getLibSupportInfoOutputFilename()));
55 static TimerGroup *DefaultTimerGroup = 0;
56 static TimerGroup *getDefaultTimerGroup() {
57 TimerGroup* tmp = DefaultTimerGroup;
60 llvm_acquire_global_lock();
61 tmp = DefaultTimerGroup;
63 tmp = new TimerGroup("Miscellaneous Ungrouped Timers");
65 DefaultTimerGroup = tmp;
67 llvm_release_global_lock();
73 Timer::Timer(const std::string &N)
74 : Elapsed(0), UserTime(0), SystemTime(0), MemUsed(0), PeakMem(0), Name(N),
75 Started(false), TG(getDefaultTimerGroup()) {
79 Timer::Timer(const std::string &N, TimerGroup &tg)
80 : Elapsed(0), UserTime(0), SystemTime(0), MemUsed(0), PeakMem(0), Name(N),
81 Started(false), TG(&tg) {
85 Timer::Timer(const Timer &T) {
87 if (TG) TG->addTimer();
92 // Copy ctor, initialize with no TG member.
93 Timer::Timer(bool, const Timer &T) {
94 TG = T.TG; // Avoid assertion in operator=
95 operator=(T); // Copy contents
104 TG->addTimerToPrint(*this);
110 static inline size_t getMemUsage() {
112 return sys::Process::GetMallocUsage();
117 double Elapsed, UserTime, SystemTime;
121 static TimeRecord getTimeRecord(bool Start) {
124 sys::TimeValue now(0,0);
125 sys::TimeValue user(0,0);
126 sys::TimeValue sys(0,0);
130 MemUsed = getMemUsage();
131 sys::Process::GetTimeUsage(now,user,sys);
133 sys::Process::GetTimeUsage(now,user,sys);
134 MemUsed = getMemUsage();
137 Result.Elapsed = now.seconds() + now.microseconds() / 1000000.0;
138 Result.UserTime = user.seconds() + user.microseconds() / 1000000.0;
139 Result.SystemTime = sys.seconds() + sys.microseconds() / 1000000.0;
140 Result.MemUsed = MemUsed;
145 static ManagedStatic<std::vector<Timer*> > ActiveTimers;
147 void Timer::startTimer() {
148 sys::SmartScopedLock<true> L(*TimerLock);
150 ActiveTimers->push_back(this);
151 TimeRecord TR = getTimeRecord(true);
152 Elapsed -= TR.Elapsed;
153 UserTime -= TR.UserTime;
154 SystemTime -= TR.SystemTime;
155 MemUsed -= TR.MemUsed;
156 PeakMemBase = TR.MemUsed;
159 void Timer::stopTimer() {
160 sys::SmartScopedLock<true> L(*TimerLock);
161 TimeRecord TR = getTimeRecord(false);
162 Elapsed += TR.Elapsed;
163 UserTime += TR.UserTime;
164 SystemTime += TR.SystemTime;
165 MemUsed += TR.MemUsed;
167 if (ActiveTimers->back() == this) {
168 ActiveTimers->pop_back();
170 std::vector<Timer*>::iterator I =
171 std::find(ActiveTimers->begin(), ActiveTimers->end(), this);
172 assert(I != ActiveTimers->end() && "stop but no startTimer?");
173 ActiveTimers->erase(I);
177 void Timer::sum(const Timer &T) {
178 Elapsed += T.Elapsed;
179 UserTime += T.UserTime;
180 SystemTime += T.SystemTime;
181 MemUsed += T.MemUsed;
182 PeakMem += T.PeakMem;
185 /// addPeakMemoryMeasurement - This method should be called whenever memory
186 /// usage needs to be checked. It adds a peak memory measurement to the
187 /// currently active timers, which will be printed when the timer group prints
189 void Timer::addPeakMemoryMeasurement() {
190 sys::SmartScopedLock<true> L(*TimerLock);
191 size_t MemUsed = getMemUsage();
193 for (std::vector<Timer*>::iterator I = ActiveTimers->begin(),
194 E = ActiveTimers->end(); I != E; ++I)
195 (*I)->PeakMem = std::max((*I)->PeakMem, MemUsed-(*I)->PeakMemBase);
198 //===----------------------------------------------------------------------===//
199 // NamedRegionTimer Implementation
200 //===----------------------------------------------------------------------===//
204 typedef std::map<std::string, Timer> Name2Timer;
205 typedef std::map<std::string, std::pair<TimerGroup, Name2Timer> > Name2Pair;
209 static ManagedStatic<Name2Timer> NamedTimers;
211 static ManagedStatic<Name2Pair> NamedGroupedTimers;
213 static Timer &getNamedRegionTimer(const std::string &Name) {
214 sys::SmartScopedLock<true> L(*TimerLock);
215 Name2Timer::iterator I = NamedTimers->find(Name);
216 if (I != NamedTimers->end())
219 return NamedTimers->insert(I, std::make_pair(Name, Timer(Name)))->second;
222 static Timer &getNamedRegionTimer(const std::string &Name,
223 const std::string &GroupName) {
224 sys::SmartScopedLock<true> L(*TimerLock);
226 Name2Pair::iterator I = NamedGroupedTimers->find(GroupName);
227 if (I == NamedGroupedTimers->end()) {
228 TimerGroup TG(GroupName);
229 std::pair<TimerGroup, Name2Timer> Pair(TG, Name2Timer());
230 I = NamedGroupedTimers->insert(I, std::make_pair(GroupName, Pair));
233 Name2Timer::iterator J = I->second.second.find(Name);
234 if (J == I->second.second.end())
235 J = I->second.second.insert(J,
243 NamedRegionTimer::NamedRegionTimer(const std::string &Name)
244 : TimeRegion(getNamedRegionTimer(Name)) {}
246 NamedRegionTimer::NamedRegionTimer(const std::string &Name,
247 const std::string &GroupName)
248 : TimeRegion(getNamedRegionTimer(Name, GroupName)) {}
250 //===----------------------------------------------------------------------===//
251 // TimerGroup Implementation
252 //===----------------------------------------------------------------------===//
255 static void printVal(double Val, double Total, raw_ostream &OS) {
256 if (Total < 1e-7) // Avoid dividing by zero...
259 OS << " " << format("%7.4f", Val) << " (";
260 OS << format("%5.1f", Val*100/Total) << "%)";
264 void Timer::print(const Timer &Total, raw_ostream &OS) {
265 sys::SmartScopedLock<true> L(*TimerLock);
267 printVal(UserTime, Total.UserTime, OS);
268 if (Total.SystemTime)
269 printVal(SystemTime, Total.SystemTime, OS);
270 if (Total.getProcessTime())
271 printVal(getProcessTime(), Total.getProcessTime(), OS);
272 printVal(Elapsed, Total.Elapsed, OS);
277 OS << format("%9lld", (long long)MemUsed) << " ";
281 OS << format("%9lld", (long long)PeakMem) << " ";
287 Started = false; // Once printed, don't print again
290 // GetLibSupportInfoOutputFile - Return a file stream to print our output on...
292 llvm::GetLibSupportInfoOutputFile() {
293 std::string &LibSupportInfoOutputFilename = getLibSupportInfoOutputFilename();
294 if (LibSupportInfoOutputFilename.empty())
296 if (LibSupportInfoOutputFilename == "-")
301 raw_ostream *Result = new raw_fd_ostream(LibSupportInfoOutputFilename.c_str(),
302 Error, raw_fd_ostream::F_Append);
306 errs() << "Error opening info-output-file '"
307 << LibSupportInfoOutputFilename << " for appending!\n";
313 void TimerGroup::removeTimer() {
314 sys::SmartScopedLock<true> L(*TimerLock);
315 if (--NumTimers == 0 && !TimersToPrint.empty()) { // Print timing report...
316 // Sort the timers in descending order by amount of time taken...
317 std::sort(TimersToPrint.begin(), TimersToPrint.end(),
318 std::greater<Timer>());
320 // Figure out how many spaces to indent TimerGroup name...
321 unsigned Padding = (80-Name.length())/2;
322 if (Padding > 80) Padding = 0; // Don't allow "negative" numbers
324 raw_ostream *OutStream = GetLibSupportInfoOutputFile();
327 { // Scope to contain Total timer... don't allow total timer to drop us to
329 Timer Total("TOTAL");
331 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i)
332 Total.sum(TimersToPrint[i]);
334 // Print out timing header...
335 *OutStream << "===" << std::string(73, '-') << "===\n"
336 << std::string(Padding, ' ') << Name << "\n"
337 << "===" << std::string(73, '-')
340 // If this is not an collection of ungrouped times, print the total time.
341 // Ungrouped timers don't really make sense to add up. We still print the
342 // TOTAL line to make the percentages make sense.
343 if (this != DefaultTimerGroup) {
344 *OutStream << " Total Execution Time: ";
346 *OutStream << format("%5.4f", Total.getProcessTime()) << " seconds (";
347 *OutStream << format("%5.4f", Total.getWallTime()) << " wall clock)\n";
352 *OutStream << " ---User Time---";
353 if (Total.SystemTime)
354 *OutStream << " --System Time--";
355 if (Total.getProcessTime())
356 *OutStream << " --User+System--";
357 *OutStream << " ---Wall Time---";
358 if (Total.getMemUsed())
359 *OutStream << " ---Mem---";
360 if (Total.getPeakMem())
361 *OutStream << " -PeakMem-";
362 *OutStream << " --- Name ---\n";
364 // Loop through all of the timing data, printing it out...
365 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i)
366 TimersToPrint[i].print(Total, *OutStream);
368 Total.print(Total, *OutStream);
374 TimersToPrint.clear();
376 if (OutStream != &errs() && OutStream != &outs())
377 delete OutStream; // Close the file...
381 void TimerGroup::addTimer() {
382 sys::SmartScopedLock<true> L(*TimerLock);
386 void TimerGroup::addTimerToPrint(const Timer &T) {
387 sys::SmartScopedLock<true> L(*TimerLock);
388 TimersToPrint.push_back(Timer(true, T));