CpuTimer Class Reference

#include <CpuTimer.hpp>

Classes
struct	EventTimer

Public Types
enum	TimerResolution { TimerResolution::kSeconds, TimerResolution::kMilliseconds, TimerResolution::kMicroseconds, TimerResolution::kNanoseconds }

Public Member Functions
	CpuTimer (const std::string &label)
	CpuTimer (const std::string &label, const int64_t nest_level)
	~CpuTimer ()
void	start_event_timer (const std::string &event_label)
std::shared_ptr< CpuTimer >	start_nested_event_timer (const std::string &event_label)
void	end_event_timer ()

Private Types
using	time_point = std::chrono::time_point< std::chrono::high_resolution_clock >

Private Member Functions
EventTimer &	start_event_timer_impl (const std::string &event_label, const bool make_nested)
void	initialize ()
void	finalize ()
void	print_timings ()

Private Attributes
const std::string	timer_label_
const size_t	nest_level_
time_point	timers_start_
time_point	timers_end_
std::vector< EventTimer >	event_timers_

Detailed Description

Definition at line 30 of file CpuTimer.hpp.

Member Typedef Documentation

using CpuTimer::time_point = std::chrono::time_point<std::chrono::high_resolution_clock>

private

Definition at line 31 of file CpuTimer.hpp.

Member Enumeration Documentation

enum CpuTimer::TimerResolution

strong

Enumerator
kSeconds
kMilliseconds
kMicroseconds
kNanoseconds

Definition at line 34 of file CpuTimer.hpp.

{ kSeconds, kMilliseconds, kMicroseconds, kNanoseconds };

Constructor & Destructor Documentation

CpuTimer::CpuTimer ( const std::string &  label )

inline

Definition at line 36 of file CpuTimer.hpp.

References initialize().

                                   : timer_label_(label), nest_level_(0) {
    initialize();
  }

Here is the call graph for this function:

CpuTimer::CpuTimer ( const std::string &  label, const int64_t  nest_level  )

inline

Definition at line 39 of file CpuTimer.hpp.

References initialize().

      : timer_label_(label), nest_level_(nest_level) {
    initialize();
  }

Here is the call graph for this function:

CpuTimer::~CpuTimer ( )

inline

Definition at line 44 of file CpuTimer.hpp.

References nest_level_, and print_timings().

              {
    if (nest_level_ == 0) {
      print_timings();
    }
  }

Here is the call graph for this function:

Member Function Documentation

void CpuTimer::end_event_timer ( )

inline

Definition at line 59 of file CpuTimer.hpp.

References event_timers_.

                         {
    if (!event_timers_.empty()) {
      event_timers_.back().finalize();
    }
  }

void CpuTimer::finalize ( )

inlineprivate

Definition at line 108 of file CpuTimer.hpp.

References event_timers_, and timers_end_.

Referenced by print_timings().

                  {
    timers_end_ = std::chrono::high_resolution_clock::now();
    if (!event_timers_.empty()) {
      event_timers_.back().finalize();
    }
  }

Here is the caller graph for this function:

void CpuTimer::initialize ( )

inlineprivate

Definition at line 106 of file CpuTimer.hpp.

References timers_start_.

Referenced by CpuTimer().

{ timers_start_ = std::chrono::high_resolution_clock::now(); }

Here is the caller graph for this function:

void CpuTimer::print_timings ( )

inlineprivate

Definition at line 115 of file CpuTimer.hpp.

References event_timers_, finalize(), report::header, nest_level_, timer_label_, timers_end_, and timers_start_.

Referenced by ~CpuTimer().

                       {
    if (nest_level_ == 0) {
      finalize();
    }
    const std::string header{timer_label_ + " Timings"};
    const std::string header_underline{std::string(header.size(), '=')};
    const std::string nest_spaces{std::string(nest_level_ * 2, ' ')};
    std::cout << std::endl
              << nest_spaces << header << std::endl
              << nest_spaces << header_underline << std::endl;

    const size_t timings_left_margin{50};

    for (auto& event_timer : event_timers_) {
      const int64_t ms_elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
                                     event_timer.end_time - event_timer.start_time)
                                     .count();
      const int64_t total_ms_elapsed =
          std::chrono::duration_cast<std::chrono::milliseconds>(event_timer.end_time -
                                                                timers_start_)
              .count();
      const size_t label_width{event_timer.event_label.size()};
      const size_t margin_calc{
          label_width < timings_left_margin ? timings_left_margin - label_width : 0};

      std::cout << nest_spaces << event_timer.event_label << ": "
                << std::setw(margin_calc) << std::fixed << std::setprecision(4)
                << ms_elapsed << " ms elapsed, " << total_ms_elapsed << " ms total"
                << std::endl;

      if (event_timer.nested_event_timer != nullptr) {
        event_timer.nested_event_timer->print_timings();
        std::cout << std::endl;
      }
    }
    const int64_t total_ms_elapsed =
        std::chrono::duration_cast<std::chrono::milliseconds>(timers_end_ - timers_start_)
            .count();
    std::cout << nest_spaces << timer_label_ << " total elapsed: " << std::fixed
              << std::setprecision(4) << total_ms_elapsed << " ms" << std::endl;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void CpuTimer::start_event_timer ( const std::string &  event_label )

inline

Definition at line 50 of file CpuTimer.hpp.

References start_event_timer_impl().

                                                       {
    start_event_timer_impl(event_label, false);
  }

Here is the call graph for this function:

EventTimer& CpuTimer::start_event_timer_impl ( const std::string &  event_label, const bool  make_nested  )

inlineprivate

Definition at line 97 of file CpuTimer.hpp.

References event_timers_, and nest_level_.

Referenced by start_event_timer(), and start_nested_event_timer().

                                                             {
    if (!event_timers_.empty()) {
      event_timers_.back().finalize();
    }
    event_timers_.emplace_back(EventTimer(event_label, nest_level_, make_nested));
    return event_timers_.back();
  }

Here is the caller graph for this function:

std::shared_ptr<CpuTimer> CpuTimer::start_nested_event_timer ( const std::string &  event_label )

inline

Definition at line 54 of file CpuTimer.hpp.

References start_event_timer_impl().

                                                                                 {
    auto& event_timer = start_event_timer_impl(event_label, true);
    return event_timer.nested_event_timer;
  }

Here is the call graph for this function:

Member Data Documentation

std::vector<EventTimer> CpuTimer::event_timers_

private

Definition at line 161 of file CpuTimer.hpp.

Referenced by end_event_timer(), finalize(), print_timings(), and start_event_timer_impl().

const size_t CpuTimer::nest_level_

private

Definition at line 158 of file CpuTimer.hpp.

Referenced by print_timings(), start_event_timer_impl(), and ~CpuTimer().

const std::string CpuTimer::timer_label_

private

Definition at line 157 of file CpuTimer.hpp.

Referenced by print_timings().

time_point CpuTimer::timers_end_

private

Definition at line 160 of file CpuTimer.hpp.

Referenced by finalize(), and print_timings().

time_point CpuTimer::timers_start_

private

Definition at line 159 of file CpuTimer.hpp.

Referenced by initialize(), and print_timings().

---

The documentation for this class was generated from the following file:

• /home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/TableFunctions/SystemFunctions/os/Shared/CpuTimer.hpp