Profile Class Reference

This class collects all function timings and produces a profiling for certain areas of the code. More...

#include <timer.h>

Collaboration diagram for Profile:

Public Member Functions
	Profile (const std::string &name)
	~Profile ()

Static Public Member Functions
static MInt	getTimingId (std::string name)
static MString	printTime (MFloat secs)

Static Public Attributes
static std::vector< FunctionTiming >	s_functionTimings

Private Attributes
const MFloat	m_initCpuTime
const MFloat	m_initWallTime
const MString	m_name

Detailed Description

Author

Lennart Schneiders

Date

14.02.2013

Definition at line 679 of file timer.h.

Constructor & Destructor Documentation

Profile()

Profile::Profile ( const std::string &  name )

inlineexplicit

Definition at line 681 of file timer.h.

: m_initCpuTime(cpuTime()), m_initWallTime(wallTime()), m_name(name) {}

~Profile()

Profile::~Profile

(

)

Definition at line 32 of file timer.cpp.

                  {
#ifdef _OPENMP
  if(omp_get_max_threads() > 1) {
    m_log << "Skipping profile output for OpenMP. FIXME: Tracer not thread-safe!" << std::endl;
    return;
  }
#endif
 
  const MFloat exitCpuTime = cpuTime();
  const MFloat exitWallTime = wallTime();
  const MFloat thresholdPercentage = 0.5;
  stringstream sstream;
  sstream << "    CPU      WALL   FUNCTION                    >> profile: '" << m_name << "' <<";
  const string header = sstream.str();
  const MString dashes1(header.size(), '_');
  const MString dashes2(header.size(), '-');
  m_log << dashes1 << endl << header << endl << dashes2 << endl << endl;
 
  MInt counter = 0;
  MInt supCounter = 0;
  // TODO labels:TIMERS add mode to compute statistics over all ranks
  if(s_functionTimings.size() > 0) {
    sort(s_functionTimings.begin(), s_functionTimings.end());
    reverse(s_functionTimings.begin(), s_functionTimings.end());
    for(vector<FunctionTiming>::size_type i = 0; i < s_functionTimings.size(); i++) {
      if(s_functionTimings[i].getInitCpuTime() < m_initCpuTime) continue;
      const MFloat relCpuTime =
          100.0 * s_functionTimings[i].getDeltaCpuTime() / max(1e-15, (exitCpuTime - m_initCpuTime));
      const MFloat relWallTime =
          100.0 * s_functionTimings[i].getDeltaWallTime() / max(1e-15, (exitWallTime - m_initWallTime));
      if(relCpuTime < thresholdPercentage) {
        supCounter++;
        continue;
      }
      char buffer[7];
      sprintf(buffer, "%6.2f", relCpuTime);
      char buffer2[7];
      sprintf(buffer2, "%6.2f", relWallTime);
      // TODO labels:TIMERS abbreviate function names/remove templates etc
      m_log << buffer << "%   " << buffer2 << "%   " << s_functionTimings[i].getName() << endl;
      counter++;
    }
    if(supCounter > 0) {
      m_log << "  .....     .....   (" << supCounter << " shorter timings with CPU<" << thresholdPercentage
            << "% were suppressed)" << endl;
    }
  }
  if(counter == 0) {
    m_log << "No timings recorded for timer '" << m_name << "'." << endl;
  }
  m_log << dashes2 << endl;
  m_log << "Total cpu time:  " << printTime(exitCpuTime - m_initCpuTime) << endl;
  m_log << "Total wall time: " << printTime(exitWallTime - m_initWallTime) << endl;
  m_log << dashes1 << endl;
}

Member Function Documentation

getTimingId()

MInt Profile::getTimingId ( std::string  name )

static

Definition at line 88 of file timer.cpp.

                                            {
  MInt tId = -1;
  if(s_functionTimings.size() > 0) {
    for(vector<FunctionTiming>::size_type i = 0; i < s_functionTimings.size(); i++) {
      if(s_functionTimings[i].getName() == name) {
        tId = i;
        break;
      }
    }
  }
  if(tId < 0) {
    tId = static_cast<MInt>(s_functionTimings.size());
    s_functionTimings.push_back(FunctionTiming(name));
  }
  ASSERT(tId > -1, "Non-existing timer");
  return tId;
}

printTime()

MString Profile::printTime ( MFloat  secs )

static

Definition at line 106 of file timer.cpp.

                                      {
  stringstream time;
  time.str("");
  MFloat rem = secs;
  if(rem > 86400.0) {
    const MFloat div = floor(rem / 86400.0);
    time << ((MInt)div) << " days, ";
    rem -= div * 86400.0;
  }
  if(rem > 3600.0) {
    const MFloat div = floor(rem / 3600.0);
    time << ((MInt)div) << " hours, ";
    rem -= div * 3600.0;
  }
  if(rem > 60.0) {
    const MFloat div = floor(rem / 60.0);
    time << ((MInt)div) << " mins, ";
    rem -= div * 60.0;
  }
  time << rem << " secs";
  const MString ret = time.str();
  return ret;
}

Member Data Documentation

m_initCpuTime

const MFloat Profile::m_initCpuTime

private

Definition at line 688 of file timer.h.

m_initWallTime

const MFloat Profile::m_initWallTime

private

Definition at line 689 of file timer.h.

m_name

const MString Profile::m_name

private

Definition at line 690 of file timer.h.

s_functionTimings

vector< FunctionTiming > Profile::s_functionTimings

static

Definition at line 685 of file timer.h.

---

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

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/UTIL/timer.h
• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/UTIL/timer.cpp