Timer.cpp revision 206083
1//===-- Timer.cpp - Interval Timing Support -------------------------------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// Interval Timing implementation. 11// 12//===----------------------------------------------------------------------===// 13 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" 24using namespace llvm; 25 26// CreateInfoOutputFile - Return a file stream to print our output on. 27namespace llvm { extern raw_ostream *CreateInfoOutputFile(); } 28 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 36// it. 37static ManagedStatic<std::string> LibSupportInfoOutputFilename; 38static std::string &getLibSupportInfoOutputFilename() { 39 return *LibSupportInfoOutputFilename; 40} 41 42static ManagedStatic<sys::SmartMutex<true> > TimerLock; 43 44namespace { 45 static cl::opt<bool> 46 TrackSpace("track-memory", cl::desc("Enable -time-passes memory " 47 "tracking (this may be slow)"), 48 cl::Hidden); 49 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())); 54} 55 56// CreateInfoOutputFile - Return a file stream to print our output on. 57raw_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. 63 64 std::string Error; 65 raw_ostream *Result = new raw_fd_ostream(OutputFilename.c_str(), 66 Error, raw_fd_ostream::F_Append); 67 if (Error.empty()) 68 return Result; 69 70 errs() << "Error opening info-output-file '" 71 << OutputFilename << " for appending!\n"; 72 delete Result; 73 return new raw_fd_ostream(2, false); // stderr. 74} 75 76 77static TimerGroup *DefaultTimerGroup = 0; 78static TimerGroup *getDefaultTimerGroup() { 79 TimerGroup *tmp = DefaultTimerGroup; 80 sys::MemoryFence(); 81 if (tmp) return tmp; 82 83 llvm_acquire_global_lock(); 84 tmp = DefaultTimerGroup; 85 if (!tmp) { 86 tmp = new TimerGroup("Miscellaneous Ungrouped Timers"); 87 sys::MemoryFence(); 88 DefaultTimerGroup = tmp; 89 } 90 llvm_release_global_lock(); 91 92 return tmp; 93} 94 95//===----------------------------------------------------------------------===// 96// Timer Implementation 97//===----------------------------------------------------------------------===// 98 99void Timer::init(StringRef N) { 100 assert(TG == 0 && "Timer already initialized"); 101 Name.assign(N.begin(), N.end()); 102 Started = false; 103 TG = getDefaultTimerGroup(); 104 TG->addTimer(*this); 105} 106 107void Timer::init(StringRef N, TimerGroup &tg) { 108 assert(TG == 0 && "Timer already initialized"); 109 Name.assign(N.begin(), N.end()); 110 Started = false; 111 TG = &tg; 112 TG->addTimer(*this); 113} 114 115Timer::~Timer() { 116 if (!TG) return; // Never initialized, or already cleared. 117 TG->removeTimer(*this); 118} 119 120static inline size_t getMemUsage() { 121 if (!TrackSpace) return 0; 122 return sys::Process::GetMallocUsage(); 123} 124 125TimeRecord TimeRecord::getCurrentTime(bool Start) { 126 TimeRecord Result; 127 sys::TimeValue now(0,0), user(0,0), sys(0,0); 128 129 if (Start) { 130 Result.MemUsed = getMemUsage(); 131 sys::Process::GetTimeUsage(now, user, sys); 132 } else { 133 sys::Process::GetTimeUsage(now, user, sys); 134 Result.MemUsed = getMemUsage(); 135 } 136 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; 140 return Result; 141} 142 143static ManagedStatic<std::vector<Timer*> > ActiveTimers; 144 145void Timer::startTimer() { 146 Started = true; 147 ActiveTimers->push_back(this); 148 Time -= TimeRecord::getCurrentTime(true); 149} 150 151void Timer::stopTimer() { 152 Time += TimeRecord::getCurrentTime(false); 153 154 if (ActiveTimers->back() == this) { 155 ActiveTimers->pop_back(); 156 } else { 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); 161 } 162} 163 164static void printVal(double Val, double Total, raw_ostream &OS) { 165 if (Total < 1e-7) // Avoid dividing by zero. 166 OS << " ----- "; 167 else { 168 OS << " " << format("%7.4f", Val) << " ("; 169 OS << format("%5.1f", Val*100/Total) << "%)"; 170 } 171} 172 173void 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); 181 182 OS << " "; 183 184 if (Total.getMemUsed()) 185 OS << format("%9lld", (long long)getMemUsed()) << " "; 186} 187 188 189//===----------------------------------------------------------------------===// 190// NamedRegionTimer Implementation 191//===----------------------------------------------------------------------===// 192 193typedef StringMap<Timer> Name2TimerMap; 194 195class Name2PairMap { 196 StringMap<std::pair<TimerGroup*, Name2TimerMap> > Map; 197public: 198 ~Name2PairMap() { 199 for (StringMap<std::pair<TimerGroup*, Name2TimerMap> >::iterator 200 I = Map.begin(), E = Map.end(); I != E; ++I) 201 delete I->second.first; 202 } 203 204 Timer &get(StringRef Name, StringRef GroupName) { 205 sys::SmartScopedLock<true> L(*TimerLock); 206 207 std::pair<TimerGroup*, Name2TimerMap> &GroupEntry = Map[GroupName]; 208 209 if (!GroupEntry.first) 210 GroupEntry.first = new TimerGroup(GroupName); 211 212 Timer &T = GroupEntry.second[Name]; 213 if (!T.isInitialized()) 214 T.init(Name, *GroupEntry.first); 215 return T; 216 } 217}; 218 219static ManagedStatic<Name2TimerMap> NamedTimers; 220static ManagedStatic<Name2PairMap> NamedGroupedTimers; 221 222static Timer &getNamedRegionTimer(StringRef Name) { 223 sys::SmartScopedLock<true> L(*TimerLock); 224 225 Timer &T = (*NamedTimers)[Name]; 226 if (!T.isInitialized()) 227 T.init(Name); 228 return T; 229} 230 231NamedRegionTimer::NamedRegionTimer(StringRef Name) 232 : TimeRegion(getNamedRegionTimer(Name)) {} 233 234NamedRegionTimer::NamedRegionTimer(StringRef Name, StringRef GroupName) 235 : TimeRegion(NamedGroupedTimers->get(Name, GroupName)) {} 236 237//===----------------------------------------------------------------------===// 238// TimerGroup Implementation 239//===----------------------------------------------------------------------===// 240 241/// TimerGroupList - This is the global list of TimerGroups, maintained by the 242/// TimerGroup ctor/dtor and is protected by the TimerLock lock. 243static TimerGroup *TimerGroupList = 0; 244 245TimerGroup::TimerGroup(StringRef name) 246 : Name(name.begin(), name.end()), FirstTimer(0) { 247 248 // Add the group to TimerGroupList. 249 sys::SmartScopedLock<true> L(*TimerLock); 250 if (TimerGroupList) 251 TimerGroupList->Prev = &Next; 252 Next = TimerGroupList; 253 Prev = &TimerGroupList; 254 TimerGroupList = this; 255} 256 257TimerGroup::~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); 262 263 // Remove the group from the TimerGroupList. 264 sys::SmartScopedLock<true> L(*TimerLock); 265 *Prev = Next; 266 if (Next) 267 Next->Prev = Prev; 268} 269 270 271void TimerGroup::removeTimer(Timer &T) { 272 sys::SmartScopedLock<true> L(*TimerLock); 273 274 // If the timer was started, move its data to TimersToPrint. 275 if (T.Started) 276 TimersToPrint.push_back(std::make_pair(T.Time, T.Name)); 277 278 T.TG = 0; 279 280 // Unlink the timer from our list. 281 *T.Prev = T.Next; 282 if (T.Next) 283 T.Next->Prev = T.Prev; 284 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()) 288 return; 289 290 raw_ostream *OutStream = CreateInfoOutputFile(); 291 PrintQueuedTimers(*OutStream); 292 delete OutStream; // Close the file. 293} 294 295void TimerGroup::addTimer(Timer &T) { 296 sys::SmartScopedLock<true> L(*TimerLock); 297 298 // Add the timer to our list. 299 if (FirstTimer) 300 FirstTimer->Prev = &T.Next; 301 T.Next = FirstTimer; 302 T.Prev = &FirstTimer; 303 FirstTimer = &T; 304} 305 306void TimerGroup::PrintQueuedTimers(raw_ostream &OS) { 307 // Sort the timers in descending order by amount of time taken. 308 std::sort(TimersToPrint.begin(), TimersToPrint.end()); 309 310 TimeRecord Total; 311 for (unsigned i = 0, e = TimersToPrint.size(); i != e; ++i) 312 Total += TimersToPrint[i].first; 313 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"; 321 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"; 329 } 330 OS << '\n'; 331 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()) 340 OS << " ---Mem---"; 341 OS << " --- Name ---\n"; 342 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'; 348 } 349 350 Total.print(Total, OS); 351 OS << "Total\n\n"; 352 OS.flush(); 353 354 TimersToPrint.clear(); 355} 356 357/// print - Print any started timers in this group and zero them. 358void TimerGroup::print(raw_ostream &OS) { 359 sys::SmartScopedLock<true> L(*TimerLock); 360 361 // See if any of our timers were started, if so add them to TimersToPrint and 362 // reset them. 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)); 366 367 // Clear out the time. 368 T->Started = 0; 369 T->Time = TimeRecord(); 370 } 371 372 // If any timers were started, print the group. 373 if (!TimersToPrint.empty()) 374 PrintQueuedTimers(OS); 375} 376 377/// printAll - This static method prints all timers and clears them all out. 378void TimerGroup::printAll(raw_ostream &OS) { 379 sys::SmartScopedLock<true> L(*TimerLock); 380 381 for (TimerGroup *TG = TimerGroupList; TG; TG = TG->Next) 382 TG->print(OS); 383} 384