timer.h File Reference

Go to the source code of this file.

Classes
class	MTimers
	MTimers manages all MAIA Timers and allows primitive profiling. More...
struct	MTimers::Timer
class	FunctionTiming
	This class counts the static execution time of a function. More...
class	Profile
	This class collects all function timings and produces a profiling for certain areas of the code. More...

Functions
MTimers &	timers ()
MBool	operator< (const FunctionTiming &a, const FunctionTiming &b)
void	logDuration_ (const MFloat timeStart, const MString module, const MString comment, const MPI_Comm comm, const MInt domainId, const MInt noDomains)
	Output the min/max/average duration of a code section over the ranks in a communicator Note: only use this function for timing initialization steps or similar due to the blocking MPI_Allreduce operations involved. Instead use logDurations() to assemble a vector of durations first and evaluate at once. More...
void	logDurations (std::vector< std::pair< MFloat, MString > > &durations, const MString module, const MPI_Comm comm, const MInt domainId, const MInt noDomains)
	Output the min/max/average durations of provided timed code sections over the ranks in a communicator. More...

Variables
InfoOutFile	m_log
InfoOutFile	maia_res

Function Documentation

logDuration_()

void logDuration_	(	const MFloat	timeStart,
		const MString	module,
		const MString	comment,
		const MPI_Comm	comm,
		const MInt	domainId,
		const MInt	noDomains
	)

Parameters

[in]

timeStart

start time obtained with wallTime()/MPI_Wtime() to compute difference to

Definition at line 171 of file timer.cpp.

                                                             {
  const MFloat duration = wallTime() - timeStart;
 
  std::vector<std::pair<MFloat, MString>> durations{};
  durations.push_back(std::make_pair(duration, comment));
  logDurations(durations, module, comm, domainId, noDomains);
}

logDurations()

void logDurations	(	std::vector< std::pair< MFloat, MString > > &	durations,
		const MString	module,
		const MPI_Comm	comm,
		const MInt	domainId,
		const MInt	noDomains
	)

Definition at line 182 of file timer.cpp.

                                                             {
  const MInt noDurations = durations.size();
 
  std::vector<MFloat> maxDurations(noDurations);
  for(MInt i = 0; i < noDurations; i++) {
    maxDurations[i] = durations[i].first;
  }
  // Copy durations vector
  std::vector<MFloat> minDurations = maxDurations;
  std::vector<MFloat> sumDurations = maxDurations;
 
  // Compute max, min and sum of durations over all involved ranks
  MPI_Allreduce(MPI_IN_PLACE, &maxDurations[0], noDurations, maia::type_traits<MFloat>::mpiType(), MPI_MAX, comm, AT_,
                "MPI_IN_PLACE", "maxDurations");
  MPI_Allreduce(MPI_IN_PLACE, &minDurations[0], noDurations, maia::type_traits<MFloat>::mpiType(), MPI_MIN, comm, AT_,
                "MPI_IN_PLACE", "minDurations");
  MPI_Allreduce(MPI_IN_PLACE, &sumDurations[0], noDurations, maia::type_traits<MFloat>::mpiType(), MPI_SUM, comm, AT_,
                "MPI_IN_PLACE", "sumDurations");
 
  const MInt maxLineLength = 256;
  MChar b[maxLineLength];
  for(MInt i = 0; i < noDurations; i++) {
    const MString comment = durations[i].second;
    snprintf(b, maxLineLength, "=== MAIA %s DURATION: %-35s | min: %.4e s | avg: %.4e s | max: %.4e s |",
             module.c_str(), comment.c_str(), minDurations[i], sumDurations[i] / (MFloat)noDomains, maxDurations[i]);
    if(domainId == 0) {
      std::cerr << b << std::endl;
    }
    m_log << b << std::endl;
  }
}

operator<()

MBool operator<	(	const FunctionTiming &	a,
		const FunctionTiming &	b
	)

Definition at line 27 of file timer.cpp.

                                                                  {
  if(approx(a.getDeltaCpuTime(), b.getDeltaCpuTime(), MFloatEps)) return (a.getInitCpuTime() < b.getInitCpuTime());
  return (a.getDeltaCpuTime() < b.getDeltaCpuTime());
}

timers()

MTimers & timers

(

)

Definition at line 170 of file timer.cpp.

                  {
  static MTimers timers;
  return timers;
}

Variable Documentation

m_log

std::ostream& m_log

extern

Definition at line 34 of file timer.h.

maia_res

std::ostream& maia_res

extern

Definition at line 35 of file timer.h.