blob: 8100f3bf4aeba5e5eecb457c73c0863b9d2fd805 [file] [log] [blame]
Jim Cownie4cc4bb42014-10-07 16:25:50 +00001/** @file kmp_stats.cpp
2 * Statistics gathering and processing.
3 */
4
5
6//===----------------------------------------------------------------------===//
7//
8// The LLVM Compiler Infrastructure
9//
10// This file is dual licensed under the MIT and the University of Illinois Open
11// Source Licenses. See LICENSE.txt for details.
12//
13//===----------------------------------------------------------------------===//
14
Jim Cownie4cc4bb42014-10-07 16:25:50 +000015#include "kmp.h"
16#include "kmp_str.h"
17#include "kmp_lock.h"
18#include "kmp_stats.h"
19
20#include <algorithm>
21#include <sstream>
22#include <iomanip>
23#include <stdlib.h> // for atexit
Jonathan Peyton6e98d7982016-03-15 20:28:47 +000024#include <ctime>
Jim Cownie4cc4bb42014-10-07 16:25:50 +000025
26#define STRINGIZE2(x) #x
27#define STRINGIZE(x) STRINGIZE2(x)
28
29#define expandName(name,flags,ignore) {STRINGIZE(name),flags},
30statInfo timeStat::timerInfo[] = {
31 KMP_FOREACH_TIMER(expandName,0)
32 {0,0}
33};
34const statInfo counter::counterInfo[] = {
35 KMP_FOREACH_COUNTER(expandName,0)
36 {0,0}
37};
38#undef expandName
39
40#define expandName(ignore1,ignore2,ignore3) {0.0,0.0,0.0},
41kmp_stats_output_module::rgb_color kmp_stats_output_module::timerColorInfo[] = {
42 KMP_FOREACH_TIMER(expandName,0)
43 {0.0,0.0,0.0}
44};
45#undef expandName
46
47const kmp_stats_output_module::rgb_color kmp_stats_output_module::globalColorArray[] = {
48 {1.0, 0.0, 0.0}, // red
49 {1.0, 0.6, 0.0}, // orange
50 {1.0, 1.0, 0.0}, // yellow
Jonathan Peyton072772b2016-04-05 18:48:48 +000051 {0.0, 1.0, 0.0}, // green
Jim Cownie4cc4bb42014-10-07 16:25:50 +000052 {0.0, 0.0, 1.0}, // blue
53 {0.6, 0.2, 0.8}, // purple
54 {1.0, 0.0, 1.0}, // magenta
55 {0.0, 0.4, 0.2}, // dark green
56 {1.0, 1.0, 0.6}, // light yellow
57 {0.6, 0.4, 0.6}, // dirty purple
58 {0.0, 1.0, 1.0}, // cyan
59 {1.0, 0.4, 0.8}, // pink
60 {0.5, 0.5, 0.5}, // grey
61 {0.8, 0.7, 0.5}, // brown
62 {0.6, 0.6, 1.0}, // light blue
63 {1.0, 0.7, 0.5}, // peach
64 {0.8, 0.5, 1.0}, // lavender
65 {0.6, 0.0, 0.0}, // dark red
66 {0.7, 0.6, 0.0}, // gold
67 {0.0, 0.0, 0.0} // black
68};
69
70// Ensure that the atexit handler only runs once.
71static uint32_t statsPrinted = 0;
72
73// output interface
74static kmp_stats_output_module __kmp_stats_global_output;
75
76/* ****************************************************** */
77/* ************* statistic member functions ************* */
78
79void statistic::addSample(double sample)
80{
81 double delta = sample - meanVal;
82
83 sampleCount = sampleCount + 1;
84 meanVal = meanVal + delta/sampleCount;
85 m2 = m2 + delta*(sample - meanVal);
86
87 minVal = std::min(minVal, sample);
88 maxVal = std::max(maxVal, sample);
89}
90
91statistic & statistic::operator+= (const statistic & other)
92{
93 if (sampleCount == 0)
94 {
95 *this = other;
96 return *this;
97 }
98
99 uint64_t newSampleCount = sampleCount + other.sampleCount;
100 double dnsc = double(newSampleCount);
101 double dsc = double(sampleCount);
102 double dscBydnsc = dsc/dnsc;
103 double dosc = double(other.sampleCount);
104 double delta = other.meanVal - meanVal;
105
106 // Try to order these calculations to avoid overflows.
107 // If this were Fortran, then the compiler would not be able to re-order over brackets.
108 // In C++ it may be legal to do that (we certainly hope it doesn't, and CC+ Programming Language 2nd edition
109 // suggests it shouldn't, since it says that exploitation of associativity can only be made if the operation
110 // really is associative (which floating addition isn't...)).
111 meanVal = meanVal*dscBydnsc + other.meanVal*(1-dscBydnsc);
112 m2 = m2 + other.m2 + dscBydnsc*dosc*delta*delta;
113 minVal = std::min (minVal, other.minVal);
114 maxVal = std::max (maxVal, other.maxVal);
115 sampleCount = newSampleCount;
116
117
118 return *this;
119}
120
121void statistic::scale(double factor)
122{
123 minVal = minVal*factor;
124 maxVal = maxVal*factor;
125 meanVal= meanVal*factor;
126 m2 = m2*factor*factor;
127 return;
128}
129
130std::string statistic::format(char unit, bool total) const
131{
132 std::string result = formatSI(sampleCount,9,' ');
Jonathan Peyton072772b2016-04-05 18:48:48 +0000133
Jonathan Peytonc1a7c972016-03-03 21:24:13 +0000134 if (sampleCount == 0)
135 {
136 result = result + std::string(", ") + formatSI(0.0, 9, unit);
137 result = result + std::string(", ") + formatSI(0.0, 9, unit);
138 result = result + std::string(", ") + formatSI(0.0, 9, unit);
139 if (total)
140 result = result + std::string(", ") + formatSI(0.0, 9, unit);
141 result = result + std::string(", ") + formatSI(0.0, 9, unit);
142 }
143 else
144 {
145 result = result + std::string(", ") + formatSI(minVal, 9, unit);
146 result = result + std::string(", ") + formatSI(meanVal, 9, unit);
147 result = result + std::string(", ") + formatSI(maxVal, 9, unit);
148 if (total)
149 result = result + std::string(", ") + formatSI(meanVal*sampleCount, 9, unit);
150 result = result + std::string(", ") + formatSI(getSD(), 9, unit);
151 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000152 return result;
153}
154
155/* ********************************************************** */
156/* ************* explicitTimer member functions ************* */
157
Jonathan Peyton072772b2016-04-05 18:48:48 +0000158void explicitTimer::start(timer_e timerEnumValue) {
159 startTime = tsc_tick_count::now();
Jonathan Peyton11dc82f2016-05-05 16:15:57 +0000160 totalPauseTime = 0;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000161 if(timeStat::logEvent(timerEnumValue)) {
162 __kmp_stats_thread_ptr->incrementNestValue();
163 }
164 return;
165}
166
167void explicitTimer::stop(timer_e timerEnumValue) {
168 if (startTime.getValue() == 0)
169 return;
170
171 tsc_tick_count finishTime = tsc_tick_count::now();
172
173 //stat->addSample ((tsc_tick_count::now() - startTime).ticks());
Jonathan Peyton11dc82f2016-05-05 16:15:57 +0000174 stat->addSample(((finishTime - startTime) - totalPauseTime).ticks());
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000175
176 if(timeStat::logEvent(timerEnumValue)) {
Jonathan Peyton072772b2016-04-05 18:48:48 +0000177 __kmp_stats_thread_ptr->push_event(startTime.getValue() - __kmp_stats_start_time.getValue(), finishTime.getValue() - __kmp_stats_start_time.getValue(), __kmp_stats_thread_ptr->getNestValue(), timerEnumValue);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000178 __kmp_stats_thread_ptr->decrementNestValue();
179 }
180
181 /* We accept the risk that we drop a sample because it really did start at t==0. */
Jonathan Peyton072772b2016-04-05 18:48:48 +0000182 startTime = 0;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000183 return;
184}
185
Jonathan Peyton11dc82f2016-05-05 16:15:57 +0000186/* ************************************************************** */
187/* ************* partitionedTimers member functions ************* */
188partitionedTimers::partitionedTimers() {
189 timer_stack.reserve(8);
190}
191
192// add a timer to this collection of partitioned timers.
193void partitionedTimers::add_timer(explicit_timer_e timer_index, explicitTimer* timer_pointer) {
194 KMP_DEBUG_ASSERT((int)timer_index < (int)EXPLICIT_TIMER_LAST+1);
195 timers[timer_index] = timer_pointer;
196}
197
198// initialize the paritioned timers to an initial timer
199void partitionedTimers::init(timerPair init_timer_pair) {
200 KMP_DEBUG_ASSERT(this->timer_stack.size() == 0);
201 timer_stack.push_back(init_timer_pair);
202 timers[init_timer_pair.get_index()]->start(init_timer_pair.get_timer());
203}
204
205// stop/save the current timer, and start the new timer (timer_pair)
206// There is a special condition where if the current timer is equal to
207// the one you are trying to push, then it only manipulates the stack,
208// and it won't stop/start the currently running timer.
209void partitionedTimers::push(timerPair timer_pair) {
210 // get the current timer
211 // stop current timer
212 // push new timer
213 // start the new timer
214 KMP_DEBUG_ASSERT(this->timer_stack.size() > 0);
215 timerPair current_timer = timer_stack.back();
216 timer_stack.push_back(timer_pair);
217 if(current_timer != timer_pair) {
218 timers[current_timer.get_index()]->pause();
219 timers[timer_pair.get_index()]->start(timer_pair.get_timer());
220 }
221}
222
223// stop/discard the current timer, and start the previously saved timer
224void partitionedTimers::pop() {
225 // get the current timer
226 // stop current timer
227 // pop current timer
228 // get the new current timer and start it back up
229 KMP_DEBUG_ASSERT(this->timer_stack.size() > 1);
230 timerPair current_timer = timer_stack.back();
231 timer_stack.pop_back();
232 timerPair new_timer = timer_stack.back();
233 if(current_timer != new_timer) {
234 timers[current_timer.get_index()]->stop(current_timer.get_timer());
235 timers[new_timer.get_index()]->resume();
236 }
237}
238
239// Wind up all the currently running timers.
240// This pops off all the timers from the stack and clears the stack
241// After this is called, init() must be run again to initialize the
242// stack of timers
243void partitionedTimers::windup() {
244 while(timer_stack.size() > 1) {
245 this->pop();
246 }
247 if(timer_stack.size() > 0) {
248 timerPair last_timer = timer_stack.back();
249 timer_stack.pop_back();
250 timers[last_timer.get_index()]->stop(last_timer.get_timer());
251 }
252}
253
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000254/* ******************************************************************* */
255/* ************* kmp_stats_event_vector member functions ************* */
256
257void kmp_stats_event_vector::deallocate() {
258 __kmp_free(events);
259 internal_size = 0;
260 allocated_size = 0;
261 events = NULL;
262}
263
264// This function is for qsort() which requires the compare function to return
265// either a negative number if event1 < event2, a positive number if event1 > event2
Jonathan Peyton072772b2016-04-05 18:48:48 +0000266// or zero if event1 == event2.
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000267// This sorts by start time (lowest to highest).
268int compare_two_events(const void* event1, const void* event2) {
269 kmp_stats_event* ev1 = (kmp_stats_event*)event1;
270 kmp_stats_event* ev2 = (kmp_stats_event*)event2;
271
272 if(ev1->getStart() < ev2->getStart()) return -1;
273 else if(ev1->getStart() > ev2->getStart()) return 1;
274 else return 0;
275}
276
277void kmp_stats_event_vector::sort() {
278 qsort(events, internal_size, sizeof(kmp_stats_event), compare_two_events);
279}
280
281/* *********************************************************** */
282/* ************* kmp_stats_list member functions ************* */
283
284// returns a pointer to newly created stats node
Jonathan Peyton072772b2016-04-05 18:48:48 +0000285kmp_stats_list* kmp_stats_list::push_back(int gtid) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000286 kmp_stats_list* newnode = (kmp_stats_list*)__kmp_allocate(sizeof(kmp_stats_list));
287 // placement new, only requires space and pointer and initializes (so __kmp_allocate instead of C++ new[] is used)
288 new (newnode) kmp_stats_list();
289 newnode->setGtid(gtid);
290 newnode->prev = this->prev;
291 newnode->next = this;
292 newnode->prev->next = newnode;
293 newnode->next->prev = newnode;
294 return newnode;
295}
296void kmp_stats_list::deallocate() {
297 kmp_stats_list* ptr = this->next;
298 kmp_stats_list* delptr = this->next;
299 while(ptr != this) {
300 delptr = ptr;
301 ptr=ptr->next;
302 // placement new means we have to explicitly call destructor.
303 delptr->_event_vector.deallocate();
304 delptr->~kmp_stats_list();
305 __kmp_free(delptr);
306 }
307}
308kmp_stats_list::iterator kmp_stats_list::begin() {
309 kmp_stats_list::iterator it;
310 it.ptr = this->next;
311 return it;
312}
313kmp_stats_list::iterator kmp_stats_list::end() {
314 kmp_stats_list::iterator it;
315 it.ptr = this;
316 return it;
317}
318int kmp_stats_list::size() {
319 int retval;
320 kmp_stats_list::iterator it;
321 for(retval=0, it=begin(); it!=end(); it++, retval++) {}
322 return retval;
323}
324
325/* ********************************************************************* */
326/* ************* kmp_stats_list::iterator member functions ************* */
327
Jonathan Peyton072772b2016-04-05 18:48:48 +0000328kmp_stats_list::iterator::iterator() : ptr(NULL) {}
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000329kmp_stats_list::iterator::~iterator() {}
330kmp_stats_list::iterator kmp_stats_list::iterator::operator++() {
331 this->ptr = this->ptr->next;
332 return *this;
333}
334kmp_stats_list::iterator kmp_stats_list::iterator::operator++(int dummy) {
335 this->ptr = this->ptr->next;
336 return *this;
337}
338kmp_stats_list::iterator kmp_stats_list::iterator::operator--() {
339 this->ptr = this->ptr->prev;
340 return *this;
341}
342kmp_stats_list::iterator kmp_stats_list::iterator::operator--(int dummy) {
343 this->ptr = this->ptr->prev;
344 return *this;
345}
346bool kmp_stats_list::iterator::operator!=(const kmp_stats_list::iterator & rhs) {
Jonathan Peyton072772b2016-04-05 18:48:48 +0000347 return this->ptr!=rhs.ptr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000348}
349bool kmp_stats_list::iterator::operator==(const kmp_stats_list::iterator & rhs) {
Jonathan Peyton072772b2016-04-05 18:48:48 +0000350 return this->ptr==rhs.ptr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000351}
352kmp_stats_list* kmp_stats_list::iterator::operator*() const {
353 return this->ptr;
354}
355
356/* *************************************************************** */
357/* ************* kmp_stats_output_module functions ************** */
358
359const char* kmp_stats_output_module::outputFileName = NULL;
360const char* kmp_stats_output_module::eventsFileName = NULL;
361const char* kmp_stats_output_module::plotFileName = NULL;
362int kmp_stats_output_module::printPerThreadFlag = 0;
363int kmp_stats_output_module::printPerThreadEventsFlag = 0;
364
365// init() is called very near the beginning of execution time in the constructor of __kmp_stats_global_output
Jonathan Peyton072772b2016-04-05 18:48:48 +0000366void kmp_stats_output_module::init()
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000367{
368 char * statsFileName = getenv("KMP_STATS_FILE");
369 eventsFileName = getenv("KMP_STATS_EVENTS_FILE");
370 plotFileName = getenv("KMP_STATS_PLOT_FILE");
371 char * threadStats = getenv("KMP_STATS_THREADS");
372 char * threadEvents = getenv("KMP_STATS_EVENTS");
373
374 // set the stats output filenames based on environment variables and defaults
375 outputFileName = statsFileName;
376 eventsFileName = eventsFileName ? eventsFileName : "events.dat";
377 plotFileName = plotFileName ? plotFileName : "events.plt";
378
379 // set the flags based on environment variables matching: true, on, 1, .true. , .t. , yes
380 printPerThreadFlag = __kmp_str_match_true(threadStats);
381 printPerThreadEventsFlag = __kmp_str_match_true(threadEvents);
382
383 if(printPerThreadEventsFlag) {
384 // assigns a color to each timer for printing
385 setupEventColors();
386 } else {
387 // will clear flag so that no event will be logged
388 timeStat::clearEventFlags();
389 }
390
391 return;
392}
393
394void kmp_stats_output_module::setupEventColors() {
395 int i;
396 int globalColorIndex = 0;
397 int numGlobalColors = sizeof(globalColorArray) / sizeof(rgb_color);
398 for(i=0;i<TIMER_LAST;i++) {
399 if(timeStat::logEvent((timer_e)i)) {
400 timerColorInfo[i] = globalColorArray[globalColorIndex];
401 globalColorIndex = (globalColorIndex+1)%numGlobalColors;
402 }
403 }
404 return;
405}
406
Jonathan Peytone2554af2016-03-11 20:20:49 +0000407void kmp_stats_output_module::printTimerStats(FILE *statsOut, statistic const * theStats, statistic const * totalStats)
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000408{
Jonathan Peytone2554af2016-03-11 20:20:49 +0000409 fprintf (statsOut, "Timer, SampleCount, Min, Mean, Max, Total, SD\n");
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000410 for (timer_e s = timer_e(0); s<TIMER_LAST; s = timer_e(s+1)) {
Jonathan Peytone2554af2016-03-11 20:20:49 +0000411 statistic const * stat = &theStats[s];
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000412 char tag = timeStat::noUnits(s) ? ' ' : 'T';
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000413
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000414 fprintf (statsOut, "%-28s, %s\n", timeStat::name(s), stat->format(tag, true).c_str());
Jonathan Peyton53eca522016-04-18 17:24:20 +0000415 }
416 // Also print the Total_ versions of times.
417 for (timer_e s = timer_e(0); s<TIMER_LAST; s = timer_e(s+1)) {
418 char tag = timeStat::noUnits(s) ? ' ' : 'T';
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000419 if (totalStats && !timeStat::noTotal(s))
420 fprintf(statsOut, "Total_%-22s, %s\n", timeStat::name(s), totalStats[s].format(tag, true).c_str());
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000421 }
Jonathan Peytone2554af2016-03-11 20:20:49 +0000422}
423
424void kmp_stats_output_module::printCounterStats(FILE *statsOut, statistic const * theStats)
425{
426 fprintf (statsOut, "Counter, ThreadCount, Min, Mean, Max, Total, SD\n");
427 for (int s = 0; s<COUNTER_LAST; s++) {
428 statistic const * stat = &theStats[s];
429 fprintf (statsOut, "%-25s, %s\n", counter::name(counter_e(s)), stat->format(' ', true).c_str());
430 }
431}
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000432
433void kmp_stats_output_module::printCounters(FILE * statsOut, counter const * theCounters)
434{
435 // We print all the counters even if they are zero.
436 // That makes it easier to slice them into a spreadsheet if you need to.
437 fprintf (statsOut, "\nCounter, Count\n");
438 for (int c = 0; c<COUNTER_LAST; c++) {
439 counter const * stat = &theCounters[c];
440 fprintf (statsOut, "%-25s, %s\n", counter::name(counter_e(c)), formatSI(stat->getValue(), 9, ' ').c_str());
441 }
442}
443
444void kmp_stats_output_module::printEvents(FILE* eventsOut, kmp_stats_event_vector* theEvents, int gtid) {
445 // sort by start time before printing
446 theEvents->sort();
447 for (int i = 0; i < theEvents->size(); i++) {
448 kmp_stats_event ev = theEvents->at(i);
449 rgb_color color = getEventColor(ev.getTimerName());
Jonathan Peyton072772b2016-04-05 18:48:48 +0000450 fprintf(eventsOut, "%d %lu %lu %1.1f rgb(%1.1f,%1.1f,%1.1f) %s\n",
451 gtid,
452 ev.getStart(),
453 ev.getStop(),
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000454 1.2 - (ev.getNestLevel() * 0.2),
455 color.r, color.g, color.b,
456 timeStat::name(ev.getTimerName())
457 );
458 }
459 return;
460}
461
462void kmp_stats_output_module::windupExplicitTimers()
463{
Jonathan Peyton072772b2016-04-05 18:48:48 +0000464 // Wind up any explicit timers. We assume that it's fair at this point to just walk all the explcit timers in all threads
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000465 // and say "it's over".
466 // If the timer wasn't running, this won't record anything anyway.
467 kmp_stats_list::iterator it;
468 for(it = __kmp_stats_list.begin(); it != __kmp_stats_list.end(); it++) {
Jonathan Peyton11dc82f2016-05-05 16:15:57 +0000469 kmp_stats_list* ptr = *it;
470 ptr->getPartitionedTimers()->windup();
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000471 for (int timer=0; timer<EXPLICIT_TIMER_LAST; timer++) {
Jonathan Peyton11dc82f2016-05-05 16:15:57 +0000472 ptr->getExplicitTimer(explicit_timer_e(timer))->stop((timer_e)timer);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000473 }
474 }
475}
476
477void kmp_stats_output_module::printPloticusFile() {
478 int i;
479 int size = __kmp_stats_list.size();
480 FILE* plotOut = fopen(plotFileName, "w+");
481
482 fprintf(plotOut, "#proc page\n"
483 " pagesize: 15 10\n"
484 " scale: 1.0\n\n");
485
486 fprintf(plotOut, "#proc getdata\n"
Jonathan Peyton072772b2016-04-05 18:48:48 +0000487 " file: %s\n\n",
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000488 eventsFileName);
489
490 fprintf(plotOut, "#proc areadef\n"
491 " title: OpenMP Sampling Timeline\n"
492 " titledetails: align=center size=16\n"
493 " rectangle: 1 1 13 9\n"
494 " xautorange: datafield=2,3\n"
Jonathan Peyton072772b2016-04-05 18:48:48 +0000495 " yautorange: -1 %d\n\n",
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000496 size);
497
498 fprintf(plotOut, "#proc xaxis\n"
499 " stubs: inc\n"
500 " stubdetails: size=12\n"
501 " label: Time (ticks)\n"
502 " labeldetails: size=14\n\n");
503
504 fprintf(plotOut, "#proc yaxis\n"
505 " stubs: inc 1\n"
506 " stubrange: 0 %d\n"
507 " stubdetails: size=12\n"
508 " label: Thread #\n"
Jonathan Peyton072772b2016-04-05 18:48:48 +0000509 " labeldetails: size=14\n\n",
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000510 size-1);
511
512 fprintf(plotOut, "#proc bars\n"
513 " exactcolorfield: 5\n"
514 " axis: x\n"
515 " locfield: 1\n"
516 " segmentfields: 2 3\n"
517 " barwidthfield: 4\n\n");
518
519 // create legend entries corresponding to the timer color
520 for(i=0;i<TIMER_LAST;i++) {
521 if(timeStat::logEvent((timer_e)i)) {
522 rgb_color c = getEventColor((timer_e)i);
523 fprintf(plotOut, "#proc legendentry\n"
524 " sampletype: color\n"
525 " label: %s\n"
526 " details: rgb(%1.1f,%1.1f,%1.1f)\n\n",
527 timeStat::name((timer_e)i),
528 c.r, c.g, c.b);
529
530 }
531 }
532
533 fprintf(plotOut, "#proc legend\n"
534 " format: down\n"
535 " location: max max\n\n");
536 fclose(plotOut);
537 return;
538}
539
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000540/*
541 * Print some useful information about
542 * * the date and time this experiment ran.
543 * * the machine on which it ran.
544 * We output all of this as stylised comments, though we may decide to parse some of it.
545 */
546void kmp_stats_output_module::printHeaderInfo(FILE * statsOut)
547{
548 std::time_t now = std::time(0);
549 char buffer[40];
550 char hostName[80];
551
552 std::strftime(&buffer[0], sizeof(buffer), "%c", std::localtime(&now));
553 fprintf (statsOut, "# Time of run: %s\n", &buffer[0]);
554 if (gethostname(&hostName[0], sizeof(hostName)) == 0)
555 fprintf (statsOut,"# Hostname: %s\n", &hostName[0]);
556#if KMP_ARCH_X86 || KMP_ARCH_X86_64
557 fprintf (statsOut, "# CPU: %s\n", &__kmp_cpuinfo.name[0]);
558 fprintf (statsOut, "# Family: %d, Model: %d, Stepping: %d\n", __kmp_cpuinfo.family, __kmp_cpuinfo.model, __kmp_cpuinfo.stepping);
Jonathan Peyton20c1e4e2016-03-15 20:55:32 +0000559 if (__kmp_cpuinfo.frequency == 0)
560 fprintf (statsOut, "# Nominal frequency: Unknown\n");
561 else
562 fprintf (statsOut, "# Nominal frequency: %sz\n", formatSI(double(__kmp_cpuinfo.frequency),9,'H').c_str());
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000563#endif
564}
565
Jonathan Peyton072772b2016-04-05 18:48:48 +0000566void kmp_stats_output_module::outputStats(const char* heading)
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000567{
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000568 // Stop all the explicit timers in all threads
569 // Do this before declaring the local statistics because thay have constructors so will take time to create.
570 windupExplicitTimers();
571
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000572 statistic allStats[TIMER_LAST];
Jonathan Peytone2554af2016-03-11 20:20:49 +0000573 statistic totalStats[TIMER_LAST]; /* Synthesized, cross threads versions of normal timer stats */
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000574 statistic allCounters[COUNTER_LAST];
575
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000576 FILE * statsOut = outputFileName ? fopen (outputFileName, "a+") : stderr;
577 if (!statsOut)
578 statsOut = stderr;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000579
580 FILE * eventsOut;
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000581 if (eventPrintingEnabled()) {
582 eventsOut = fopen(eventsFileName, "w+");
583 }
584
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000585 printHeaderInfo (statsOut);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000586 fprintf(statsOut, "%s\n",heading);
587 // Accumulate across threads.
588 kmp_stats_list::iterator it;
589 for (it = __kmp_stats_list.begin(); it != __kmp_stats_list.end(); it++) {
590 int t = (*it)->getGtid();
591 // Output per thread stats if requested.
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000592 if (printPerThreadFlag) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000593 fprintf (statsOut, "Thread %d\n", t);
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000594 printTimerStats (statsOut, (*it)->getTimers(), 0);
595 printCounters (statsOut, (*it)->getCounters());
596 fprintf (statsOut,"\n");
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000597 }
598 // Output per thread events if requested.
599 if (eventPrintingEnabled()) {
600 kmp_stats_event_vector events = (*it)->getEventVector();
601 printEvents(eventsOut, &events, t);
602 }
603
Jonathan Peytone2554af2016-03-11 20:20:49 +0000604 // Accumulate timers.
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000605 for (timer_e s = timer_e(0); s<TIMER_LAST; s = timer_e(s+1)) {
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000606 // See if we should ignore this timer when aggregating
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000607 if ((timeStat::masterOnly(s) && (t != 0)) || // Timer is only valid on the master and this thread is a worker
608 (timeStat::workerOnly(s) && (t == 0)) // Timer is only valid on a worker and this thread is the master
Jonathan Peyton072772b2016-04-05 18:48:48 +0000609 )
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000610 {
611 continue;
612 }
613
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000614 statistic * threadStat = (*it)->getTimer(s);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000615 allStats[s] += *threadStat;
Jonathan Peytone2554af2016-03-11 20:20:49 +0000616
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000617 // Add Total stats for timers that are valid in more than one thread
618 if (!timeStat::noTotal(s))
Jonathan Peytone2554af2016-03-11 20:20:49 +0000619 totalStats[s].addSample(threadStat->getTotal());
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000620 }
621
Jonathan Peytone2554af2016-03-11 20:20:49 +0000622 // Accumulate counters.
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000623 for (counter_e c = counter_e(0); c<COUNTER_LAST; c = counter_e(c+1)) {
624 if (counter::masterOnly(c) && t != 0)
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000625 continue;
Jonathan Peyton6e98d7982016-03-15 20:28:47 +0000626 allCounters[c].addSample ((*it)->getCounter(c)->getValue());
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000627 }
628 }
629
630 if (eventPrintingEnabled()) {
631 printPloticusFile();
632 fclose(eventsOut);
633 }
634
635 fprintf (statsOut, "Aggregate for all threads\n");
Jonathan Peytone2554af2016-03-11 20:20:49 +0000636 printTimerStats (statsOut, &allStats[0], &totalStats[0]);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000637 fprintf (statsOut, "\n");
Jonathan Peytone2554af2016-03-11 20:20:49 +0000638 printCounterStats (statsOut, &allCounters[0]);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000639
640 if (statsOut != stderr)
641 fclose(statsOut);
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000642}
643
644/* ************************************************** */
645/* ************* exported C functions ************** */
646
647// no name mangling for these functions, we want the c files to be able to get at these functions
648extern "C" {
649
650void __kmp_reset_stats()
651{
652 kmp_stats_list::iterator it;
653 for(it = __kmp_stats_list.begin(); it != __kmp_stats_list.end(); it++) {
654 timeStat * timers = (*it)->getTimers();
655 counter * counters = (*it)->getCounters();
656 explicitTimer * eTimers = (*it)->getExplicitTimers();
657
658 for (int t = 0; t<TIMER_LAST; t++)
659 timers[t].reset();
660
661 for (int c = 0; c<COUNTER_LAST; c++)
662 counters[c].reset();
663
664 for (int t=0; t<EXPLICIT_TIMER_LAST; t++)
665 eTimers[t].reset();
666
667 // reset the event vector so all previous events are "erased"
668 (*it)->resetEventVector();
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000669 }
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000670}
671
672// This function will reset all stats and stop all threads' explicit timers if they haven't been stopped already.
673void __kmp_output_stats(const char * heading)
674{
675 __kmp_stats_global_output.outputStats(heading);
676 __kmp_reset_stats();
677}
678
679void __kmp_accumulate_stats_at_exit(void)
680{
681 // Only do this once.
682 if (KMP_XCHG_FIXED32(&statsPrinted, 1) != 0)
683 return;
684
685 __kmp_output_stats("Statistics on exit");
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000686}
687
Jonathan Peyton072772b2016-04-05 18:48:48 +0000688void __kmp_stats_init(void)
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000689{
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000690}
691
Jonathan Peyton072772b2016-04-05 18:48:48 +0000692} // extern "C"
Jim Cownie4cc4bb42014-10-07 16:25:50 +0000693