timer_macro.hpp

Go to the documentation of this file.

#ifndef TIMER_MACRO_HPP
#define TIMER_MACRO_HPP

#ifdef CAM_TIMERS
#include "gptl.h"
#else
// If camtimers is not present, use this spoofed version of the timers
static int GPTLinitialize(){ return 0;}
static int GPTLstart(const char* name){ return 0;}
static int GPTLstop(const char* name){ return 0;}
static int GPTLpr_file(const char* name){ return 0;}
#endif

// Since it's a common name, make sure it isn't already used somewhere
#ifdef TIMER
#error "TIMER macro already defined"
#endif

// Debug flag: adds an MPI barrier with checkpoint before and after each timer
#include "checkpoint.hpp"
#define TIMER_CHKPT_START(N) if(global_debug_flag) checkpoint(std::string("Starting '") + N + std::string("'...\n"));
#define TIMER_CHKPT_END(N) if(global_debug_flag) checkpoint(std::string("Finished '") + N + std::string("'!\n"));

#define TIMER(N,F) {TIMER_CHKPT_START(N); GPTLstart(N); F; GPTLstop(N); TIMER_CHKPT_END(N);}
// e.g.: TIMER(push(), "Push");
// becomes:
// {
//   GPTLstart("Push");
//   push();
//   GPTLstop("Push");
// }
// The braces are there for safe scoping, but that means you can't time declarations.

// Here is a macro for timing Kokkos kernels from regression tests.  This includes
// a call to Kokkos::fence() to time the full kernel, not just the launch.

#ifdef FENCED_TIMER
#error "FENCED_TIMER macro already defined"
#endif

#define FENCED_TIMER(N,F) {TIMER_CHKPT_START(N); GPTLstart(N); F; Kokkos::fence(); GPTLstop(N); TIMER_CHKPT_END(N);}
// e.g.: FENCED_TIMER(push(), "Push");
// becomes:
// {
//   GPTLstart("Push");
//   push();
//   Kokkos::fence();
//   GPTLstop("Push");
// }

// Here is an non-scoped version:

#ifdef TIMER_NS
#error "TIMER_NS macro already defined"
#endif

#define TIMER_NS(N,F) TIMER_CHKPT_START(N); GPTLstart(N); F; GPTLstop(N); TIMER_CHKPT_END(N);


// Timer for performance testing barrier
#ifdef USE_MPI
#define PERF_BARRIER_TIMER(N) if(global_perf_barriers_flag) TIMER(N, MPI_Barrier(MPI_COMM_WORLD));
#else
#define PERF_BARRIER_TIMER(N)
#endif

#endif