16 #include "kmp_config.h" 17 #include "kmp_debug.h" 28 #include "kmp_stats_timing.h" 39 #define KMP_DEVELOPER_STATS 0 42 #define KMP_STATS_HIST 0 95 #define KMP_FOREACH_COUNTER(macro, arg) \ 96 macro(OMP_PARALLEL,stats_flags_e::onlyInMaster|stats_flags_e::noTotal,arg) \ 97 macro(OMP_NESTED_PARALLEL, 0, arg) \ 98 macro(OMP_LOOP_STATIC, 0, arg) \ 99 macro(OMP_LOOP_STATIC_STEAL, 0, arg) \ 100 macro(OMP_LOOP_DYNAMIC, 0, arg) \ 101 macro(OMP_DISTRIBUTE, 0, arg) \ 102 macro(OMP_BARRIER, 0, arg) \ 103 macro(OMP_CRITICAL, 0, arg) \ 104 macro(OMP_SINGLE, 0, arg) \ 105 macro(OMP_MASTER, 0, arg) \ 106 macro(OMP_MASKED, 0, arg) \ 107 macro(OMP_TEAMS, 0, arg) \ 108 macro(OMP_set_lock, 0, arg) \ 109 macro(OMP_test_lock, 0, arg) \ 110 macro(REDUCE_wait, 0, arg) \ 111 macro(REDUCE_nowait, 0, arg) \ 112 macro(OMP_TASKYIELD, 0, arg) \ 113 macro(OMP_TASKLOOP, 0, arg) \ 114 macro(TASK_executed, 0, arg) \ 115 macro(TASK_cancelled, 0, arg) \ 116 macro(TASK_stolen, 0, arg) 138 #define KMP_FOREACH_TIMER(macro, arg) \ 139 macro (OMP_worker_thread_life, stats_flags_e::logEvent, arg) \ 140 macro (OMP_parallel, stats_flags_e::logEvent, arg) \ 141 macro (OMP_parallel_overhead, stats_flags_e::logEvent, arg) \ 142 macro (OMP_teams, stats_flags_e::logEvent, arg) \ 143 macro (OMP_teams_overhead, stats_flags_e::logEvent, arg) \ 144 macro (OMP_loop_static, 0, arg) \ 145 macro (OMP_loop_static_scheduling, 0, arg) \ 146 macro (OMP_loop_dynamic, 0, arg) \ 147 macro (OMP_loop_dynamic_scheduling, 0, arg) \ 148 macro (OMP_distribute, 0, arg) \ 149 macro (OMP_distribute_scheduling, 0, arg) \ 150 macro (OMP_critical, 0, arg) \ 151 macro (OMP_critical_wait, 0, arg) \ 152 macro (OMP_single, 0, arg) \ 153 macro (OMP_master, 0, arg) \ 154 macro (OMP_masked, 0, arg) \ 155 macro (OMP_task_immediate, 0, arg) \ 156 macro (OMP_task_taskwait, 0, arg) \ 157 macro (OMP_task_taskyield, 0, arg) \ 158 macro (OMP_task_taskgroup, 0, arg) \ 159 macro (OMP_task_join_bar, 0, arg) \ 160 macro (OMP_task_plain_bar, 0, arg) \ 161 macro (OMP_taskloop_scheduling, 0, arg) \ 162 macro (OMP_plain_barrier, stats_flags_e::logEvent, arg) \ 163 macro (OMP_idle, stats_flags_e::logEvent, arg) \ 164 macro (OMP_fork_barrier, stats_flags_e::logEvent, arg) \ 165 macro (OMP_join_barrier, stats_flags_e::logEvent, arg) \ 166 macro (OMP_serial, stats_flags_e::logEvent, arg) \ 167 macro (OMP_set_numthreads, stats_flags_e::noUnits | stats_flags_e::noTotal, \ 169 macro (OMP_PARALLEL_args, stats_flags_e::noUnits | stats_flags_e::noTotal, \ 171 macro (OMP_loop_static_iterations, \ 172 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) \ 173 macro (OMP_loop_static_total_iterations, \ 174 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) \ 175 macro (OMP_loop_dynamic_iterations, \ 176 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) \ 177 macro (OMP_loop_dynamic_total_iterations, \ 178 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) \ 179 macro (OMP_distribute_iterations, \ 180 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) \ 181 KMP_FOREACH_DEVELOPER_TIMER(macro, arg) 233 #if (KMP_DEVELOPER_STATS) 250 #define KMP_FOREACH_DEVELOPER_TIMER(macro, arg) \ 251 macro(KMP_fork_call, 0, arg) \ 252 macro(KMP_join_call, 0, arg) \ 253 macro(KMP_end_split_barrier, 0, arg) \ 254 macro(KMP_hier_gather, 0, arg) \ 255 macro(KMP_hier_release, 0, arg) \ 256 macro(KMP_hyper_gather, 0, arg) \ 257 macro(KMP_hyper_release, 0, arg) \ 258 macro(KMP_linear_gather, 0, arg) \ 259 macro(KMP_linear_release, 0, arg) \ 260 macro(KMP_tree_gather, 0, arg) \ 261 macro(KMP_tree_release, 0, arg) \ 262 macro(USER_resume, 0, arg) \ 263 macro(USER_suspend, 0, arg) \ 264 macro(USER_mwait, 0, arg) \ 265 macro(KMP_allocate_team, 0, arg) \ 266 macro(KMP_setup_icv_copy, 0, arg) \ 267 macro(USER_icv_copy, 0, arg) \ 268 macro (FOR_static_steal_stolen, \ 269 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) \ 270 macro (FOR_static_steal_chunks, \ 271 stats_flags_e::noUnits | stats_flags_e::noTotal, arg) 273 #define KMP_FOREACH_DEVELOPER_TIMER(macro, arg) 296 #define KMP_FOREACH_EXPLICIT_TIMER(macro, arg) KMP_FOREACH_TIMER(macro, arg) 298 #define ENUMERATE(name, ignore, prefix) prefix##name, 299 enum timer_e { KMP_FOREACH_TIMER(ENUMERATE, TIMER_) TIMER_LAST };
301 enum explicit_timer_e {
328 uint32_t KMP_ALIGN_CACHE zeroCount;
334 static double binMax[numBins];
340 uint64_t t = zeroCount;
341 for (
int i = 0; i < numBins; i++)
343 KMP_DEBUG_ASSERT(t == _total);
346 void check()
const {}
350 logHistogram() { reset(); }
352 logHistogram(logHistogram
const &o) {
353 for (
int i = 0; i < numBins; i++)
362 for (
int i = 0; i < numBins; i++) {
371 uint32_t count(
int b)
const {
return bins[b + logOffset].count; }
372 double total(
int b)
const {
return bins[b + logOffset].total; }
373 static uint32_t findBin(
double sample);
375 logHistogram &operator+=(logHistogram
const &o) {
376 zeroCount += o.zeroCount;
377 for (
int i = 0; i < numBins; i++) {
378 bins[i].count += o.bins[i].count;
379 bins[i].total += o.bins[i].total;
389 void addSample(
double sample);
393 std::string format(
char)
const;
397 double KMP_ALIGN_CACHE minVal;
401 uint64_t sampleCount;
407 statistic(
bool doHist =
bool(KMP_STATS_HIST)) {
409 collectingHist = doHist;
411 statistic(statistic
const &o)
412 : minVal(o.minVal), maxVal(o.maxVal), meanVal(o.meanVal), m2(o.m2),
413 sampleCount(o.sampleCount), offset(o.offset),
414 collectingHist(o.collectingHist), hist(o.hist) {}
415 statistic(
double minv,
double maxv,
double meanv, uint64_t sc,
double sd)
416 : minVal(minv), maxVal(maxv), meanVal(meanv), m2(sd * sd * sc),
417 sampleCount(sc), offset(0.0), collectingHist(
false) {}
418 bool haveHist()
const {
return collectingHist; }
419 double getMin()
const {
return minVal; }
420 double getMean()
const {
return meanVal; }
421 double getMax()
const {
return maxVal; }
422 uint64_t getCount()
const {
return sampleCount; }
423 double getSD()
const {
return sqrt(m2 / sampleCount); }
424 double getTotal()
const {
return sampleCount * meanVal; }
425 logHistogram
const *getHist()
const {
return &hist; }
426 void setOffset(
double d) { offset = d; }
429 minVal = (std::numeric_limits<double>::max)();
437 void addSample(
double sample);
438 void scale(
double factor);
439 void scaleDown(
double f) { scale(1. / f); }
440 void forceCount(uint64_t count) { sampleCount = count; }
441 statistic &operator+=(statistic
const &other);
443 std::string format(
char unit,
bool total =
false)
const;
444 std::string formatHist(
char unit)
const {
return hist.format(unit); }
452 class timeStat :
public statistic {
453 static statInfo timerInfo[];
456 timeStat() : statistic() {}
457 static const char *name(timer_e e) {
return timerInfo[e].name; }
458 static bool noTotal(timer_e e) {
461 static bool masterOnly(timer_e e) {
464 static bool workerOnly(timer_e e) {
467 static bool noUnits(timer_e e) {
473 static void clearEventFlags() {
474 for (
int i = 0; i < TIMER_LAST; i++) {
483 class explicitTimer {
485 timer_e timerEnumValue;
486 tsc_tick_count startTime;
487 tsc_tick_count pauseStartTime;
488 tsc_tick_count::tsc_interval_t totalPauseTime;
491 explicitTimer(timeStat *s, timer_e te)
492 : stat(s), timerEnumValue(te), startTime(), pauseStartTime(0),
496 void start(tsc_tick_count tick);
497 void pause(tsc_tick_count tick) { pauseStartTime = tick; }
498 void resume(tsc_tick_count tick) {
499 totalPauseTime += (tick - pauseStartTime);
501 void stop(tsc_tick_count tick, kmp_stats_list *stats_ptr =
nullptr);
507 timer_e get_type()
const {
return timerEnumValue; }
516 class partitionedTimers {
518 std::vector<explicitTimer> timer_stack;
522 void init(explicitTimer timer);
523 void exchange(explicitTimer timer);
524 void push(explicitTimer timer);
531 class blockPartitionedTimer {
532 partitionedTimers *part_timers;
535 blockPartitionedTimer(partitionedTimers *pt, explicitTimer timer)
537 part_timers->push(timer);
539 ~blockPartitionedTimer() { part_timers->pop(); }
545 class blockThreadState {
551 : state_pointer(thread_state_pointer), old_state(*thread_state_pointer) {
552 *state_pointer = new_state;
554 ~blockThreadState() { *state_pointer = old_state; }
562 static const statInfo counterInfo[];
565 counter() : value(0) {}
566 void increment() { value++; }
567 uint64_t getValue()
const {
return value; }
568 void reset() { value = 0; }
569 static const char *name(counter_e e) {
return counterInfo[e].name; }
570 static bool masterOnly(counter_e e) {
608 class kmp_stats_event {
616 : start(0), stop(0), nest_level(0), timer_name(TIMER_LAST) {}
617 kmp_stats_event(uint64_t strt, uint64_t stp,
int nst, timer_e nme)
618 : start(strt), stop(stp), nest_level(nst), timer_name(nme) {}
619 inline uint64_t getStart()
const {
return start; }
620 inline uint64_t getStop()
const {
return stop; }
621 inline int getNestLevel()
const {
return nest_level; }
622 inline timer_e getTimerName()
const {
return timer_name; }
651 class kmp_stats_event_vector {
652 kmp_stats_event *events;
655 static const int INIT_SIZE = 1024;
658 kmp_stats_event_vector() {
660 (kmp_stats_event *)__kmp_allocate(
sizeof(kmp_stats_event) * INIT_SIZE);
662 allocated_size = INIT_SIZE;
664 ~kmp_stats_event_vector() {}
665 inline void reset() { internal_size = 0; }
666 inline int size()
const {
return internal_size; }
667 void push_back(uint64_t start_time, uint64_t stop_time,
int nest_level,
670 if (internal_size == allocated_size) {
671 kmp_stats_event *tmp = (kmp_stats_event *)__kmp_allocate(
672 sizeof(kmp_stats_event) * allocated_size * 2);
673 for (i = 0; i < internal_size; i++)
679 events[internal_size] =
680 kmp_stats_event(start_time, stop_time, nest_level, name);
686 const kmp_stats_event &operator[](
int index)
const {
return events[index]; }
687 kmp_stats_event &operator[](
int index) {
return events[index]; }
688 const kmp_stats_event &at(
int index)
const {
return events[index]; }
689 kmp_stats_event &at(
int index) {
return events[index]; }
719 class kmp_stats_list {
721 timeStat _timers[TIMER_LAST + 1];
722 counter _counters[COUNTER_LAST + 1];
723 explicitTimer thread_life_timer;
724 partitionedTimers _partitionedTimers;
726 kmp_stats_event_vector _event_vector;
727 kmp_stats_list *next;
728 kmp_stats_list *prev;
730 int thread_is_idle_flag;
734 : thread_life_timer(&_timers[TIMER_OMP_worker_thread_life],
735 TIMER_OMP_worker_thread_life),
736 _nestLevel(0), _event_vector(), next(
this), prev(
this), state(IDLE),
737 thread_is_idle_flag(0) {}
739 inline timeStat *getTimer(timer_e idx) {
return &_timers[idx]; }
740 inline counter *getCounter(counter_e idx) {
return &_counters[idx]; }
741 inline partitionedTimers *getPartitionedTimers() {
742 return &_partitionedTimers;
744 inline timeStat *getTimers() {
return _timers; }
745 inline counter *getCounters() {
return _counters; }
746 inline kmp_stats_event_vector &getEventVector() {
return _event_vector; }
747 inline void startLife() { thread_life_timer.start(tsc_tick_count::now()); }
748 inline void endLife() { thread_life_timer.stop(tsc_tick_count::now(),
this); }
749 inline void resetEventVector() { _event_vector.reset(); }
750 inline void incrementNestValue() { _nestLevel++; }
751 inline int getNestValue() {
return _nestLevel; }
752 inline void decrementNestValue() { _nestLevel--; }
753 inline int getGtid()
const {
return gtid; }
754 inline void setGtid(
int newgtid) { gtid = newgtid; }
755 inline void setState(
stats_state_e newstate) { state = newstate; }
758 inline bool isIdle() {
return thread_is_idle_flag == 1; }
759 inline void setIdleFlag() { thread_is_idle_flag = 1; }
760 inline void resetIdleFlag() { thread_is_idle_flag = 0; }
761 kmp_stats_list *push_back(
int gtid);
762 inline void push_event(uint64_t start_time, uint64_t stop_time,
763 int nest_level, timer_e name) {
764 _event_vector.push_back(start_time, stop_time, nest_level, name);
768 kmp_stats_list::iterator begin();
769 kmp_stats_list::iterator end();
773 friend kmp_stats_list::iterator kmp_stats_list::begin();
774 friend kmp_stats_list::iterator kmp_stats_list::end();
779 iterator operator++();
780 iterator operator++(
int dummy);
781 iterator operator--();
782 iterator operator--(
int dummy);
783 bool operator!=(
const iterator &rhs);
784 bool operator==(
const iterator &rhs);
785 kmp_stats_list *operator*()
const;
818 class kmp_stats_output_module {
828 std::string outputFileName;
829 static const char *eventsFileName;
830 static const char *plotFileName;
831 static int printPerThreadFlag;
832 static int printPerThreadEventsFlag;
833 static const rgb_color globalColorArray[];
834 static rgb_color timerColorInfo[];
837 static void setupEventColors();
838 static void printPloticusFile();
839 static void printHeaderInfo(FILE *statsOut);
840 static void printTimerStats(FILE *statsOut, statistic
const *theStats,
841 statistic
const *totalStats);
842 static void printCounterStats(FILE *statsOut, statistic
const *theStats);
843 static void printCounters(FILE *statsOut, counter
const *theCounters);
844 static void printEvents(FILE *eventsOut, kmp_stats_event_vector *theEvents,
846 static rgb_color getEventColor(timer_e e) {
return timerColorInfo[e]; }
847 static void windupExplicitTimers();
848 bool eventPrintingEnabled()
const {
return printPerThreadEventsFlag; }
851 kmp_stats_output_module() { init(); }
852 void outputStats(
const char *heading);
858 void __kmp_stats_init();
859 void __kmp_stats_fini();
860 void __kmp_reset_stats();
861 void __kmp_output_stats(
const char *);
862 void __kmp_accumulate_stats_at_exit(
void);
864 extern KMP_THREAD_LOCAL kmp_stats_list *__kmp_stats_thread_ptr;
866 extern kmp_stats_list *__kmp_stats_list;
868 extern kmp_tas_lock_t __kmp_stats_lock;
870 extern tsc_tick_count __kmp_stats_start_time;
872 extern kmp_stats_output_module __kmp_stats_output;
891 #define KMP_COUNT_VALUE(name, value) \ 892 __kmp_stats_thread_ptr->getTimer(TIMER_##name)->addSample((double)value) 904 #define KMP_COUNT_BLOCK(name) \ 905 __kmp_stats_thread_ptr->getCounter(COUNTER_##name)->increment() 924 #define KMP_OUTPUT_STATS(heading_string) __kmp_output_stats(heading_string) 933 #define KMP_INIT_PARTITIONED_TIMERS(name) \ 934 __kmp_stats_thread_ptr->getPartitionedTimers()->init(explicitTimer( \ 935 __kmp_stats_thread_ptr->getTimer(TIMER_##name), TIMER_##name)) 937 #define KMP_TIME_PARTITIONED_BLOCK(name) \ 938 blockPartitionedTimer __PBLOCKTIME__( \ 939 __kmp_stats_thread_ptr->getPartitionedTimers(), \ 940 explicitTimer(__kmp_stats_thread_ptr->getTimer(TIMER_##name), \ 943 #define KMP_PUSH_PARTITIONED_TIMER(name) \ 944 __kmp_stats_thread_ptr->getPartitionedTimers()->push(explicitTimer( \ 945 __kmp_stats_thread_ptr->getTimer(TIMER_##name), TIMER_##name)) 947 #define KMP_POP_PARTITIONED_TIMER() \ 948 __kmp_stats_thread_ptr->getPartitionedTimers()->pop() 950 #define KMP_EXCHANGE_PARTITIONED_TIMER(name) \ 951 __kmp_stats_thread_ptr->getPartitionedTimers()->exchange(explicitTimer( \ 952 __kmp_stats_thread_ptr->getTimer(TIMER_##name), TIMER_##name)) 954 #define KMP_SET_THREAD_STATE(state_name) \ 955 __kmp_stats_thread_ptr->setState(state_name) 957 #define KMP_GET_THREAD_STATE() __kmp_stats_thread_ptr->getState() 959 #define KMP_SET_THREAD_STATE_BLOCK(state_name) \ 960 blockThreadState __BTHREADSTATE__(__kmp_stats_thread_ptr->getStatePointer(), \ 970 #define KMP_RESET_STATS() __kmp_reset_stats() 972 #if (KMP_DEVELOPER_STATS) 973 #define KMP_COUNT_DEVELOPER_VALUE(n, v) KMP_COUNT_VALUE(n, v) 974 #define KMP_COUNT_DEVELOPER_BLOCK(n) KMP_COUNT_BLOCK(n) 975 #define KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(n) KMP_TIME_PARTITIONED_BLOCK(n) 976 #define KMP_PUSH_DEVELOPER_PARTITIONED_TIMER(n) KMP_PUSH_PARTITIONED_TIMER(n) 977 #define KMP_POP_DEVELOPER_PARTITIONED_TIMER(n) KMP_POP_PARTITIONED_TIMER(n) 978 #define KMP_EXCHANGE_DEVELOPER_PARTITIONED_TIMER(n) \ 979 KMP_EXCHANGE_PARTITIONED_TIMER(n) 982 #define KMP_COUNT_DEVELOPER_VALUE(n, v) ((void)0) 983 #define KMP_COUNT_DEVELOPER_BLOCK(n) ((void)0) 984 #define KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(n) ((void)0) 985 #define KMP_PUSH_DEVELOPER_PARTITIONED_TIMER(n) ((void)0) 986 #define KMP_POP_DEVELOPER_PARTITIONED_TIMER(n) ((void)0) 987 #define KMP_EXCHANGE_DEVELOPER_PARTITIONED_TIMER(n) ((void)0) 990 #else // KMP_STATS_ENABLED 993 #define KMP_COUNT_VALUE(n, v) ((void)0) 994 #define KMP_COUNT_BLOCK(n) ((void)0) 996 #define KMP_OUTPUT_STATS(heading_string) ((void)0) 997 #define KMP_RESET_STATS() ((void)0) 999 #define KMP_COUNT_DEVELOPER_VALUE(n, v) ((void)0) 1000 #define KMP_COUNT_DEVELOPER_BLOCK(n) ((void)0) 1001 #define KMP_TIME_DEVELOPER_PARTITIONED_BLOCK(n) ((void)0) 1002 #define KMP_PUSH_DEVELOPER_PARTITIONED_TIMER(n) ((void)0) 1003 #define KMP_POP_DEVELOPER_PARTITIONED_TIMER(n) ((void)0) 1004 #define KMP_EXCHANGE_DEVELOPER_PARTITIONED_TIMER(n) ((void)0) 1005 #define KMP_INIT_PARTITIONED_TIMERS(name) ((void)0) 1006 #define KMP_TIME_PARTITIONED_BLOCK(name) ((void)0) 1007 #define KMP_PUSH_PARTITIONED_TIMER(name) ((void)0) 1008 #define KMP_POP_PARTITIONED_TIMER() ((void)0) 1009 #define KMP_SET_THREAD_STATE(state_name) ((void)0) 1010 #define KMP_GET_THREAD_STATE() ((void)0) 1011 #define KMP_SET_THREAD_STATE_BLOCK(state_name) ((void)0) 1012 #endif // KMP_STATS_ENABLED 1014 #endif // KMP_STATS_H statistic is valid only for primary thread
statistic is valid only for non-primary threads
do not show a TOTAL_aggregation for this statistic
#define KMP_FOREACH_EXPLICIT_TIMER(macro, arg)
Add new explicit timers under KMP_FOREACH_EXPLICIT_TIMER() macro.
statistic doesn't need units printed next to it
stats_flags_e
flags to describe the statistic (timer or counter)
#define KMP_FOREACH_COUNTER(macro, arg)
Add new counters under KMP_FOREACH_COUNTER() macro in kmp_stats.h.
stats_state_e
the states which a thread can be in