profiling.hpp

Go to the documentation of this file.

// Copyright (c) Lawrence Livermore National Security, LLC and
// other Serac Project Developers. See the top-level LICENSE file for
// details.
//
// SPDX-License-Identifier: (BSD-3-Clause)
 
#pragma once
 
#include <string>
#include <sstream>
 
#include "serac/serac_config.hpp"
 
#ifdef SERAC_USE_ADIAK
#include "adiak.hpp"
#endif
 
#ifdef SERAC_USE_CALIPER
#include "caliper/cali-manager.h"
#include "caliper/cali.h"
#endif
 
#include "mpi.h"
 
#ifdef SERAC_USE_ADIAK
#define SERAC_SET_METADATA(name, data) adiak::value(name, data)
#else
#define SERAC_SET_METADATA(name, data)
#endif
 
// NOTE: The motivation behind wrapping Caliper macros to avoid conflicting macro definitions in the no-op case, and
// give downstream users the option to disable profiling Serac if it pollutes their timings.
 
#ifdef SERAC_USE_CALIPER
#define SERAC_MARK_FUNCTION CALI_CXX_MARK_FUNCTION
#define SERAC_MARK_LOOP_BEGIN(id, name) CALI_CXX_MARK_LOOP_BEGIN(id, name)
#define SERAC_MARK_LOOP_ITERATION(id, i) CALI_CXX_MARK_LOOP_ITERATION(id, i)
#define SERAC_MARK_LOOP_END(id) CALI_CXX_MARK_LOOP_END(id)
#define SERAC_MARK_BEGIN(name) CALI_MARK_BEGIN(name)
#define SERAC_MARK_END(name) CALI_MARK_END(name)
#define SERAC_MARK_SCOPE(name) CALI_CXX_MARK_SCOPE(name)
#else
// Define no-op macros in case Serac has not been configured with Caliper
#define SERAC_MARK_FUNCTION
#define SERAC_MARK_LOOP_BEGIN(id, name)
#define SERAC_MARK_LOOP_ITERATION(id, i)
#define SERAC_MARK_LOOP_END(id)
#define SERAC_MARK_BEGIN(name)
#define SERAC_MARK_END(name)
#define SERAC_MARK_SCOPE(name)
#endif
 
namespace serac::profiling {
 
void initialize([[maybe_unused]] MPI_Comm comm = MPI_COMM_WORLD, [[maybe_unused]] std::string options = "");
 
void finalize();
 
template <typename... T>
std::string concat(T... args)
{
  std::stringstream ss;
  // this fold expression is a more elegant way to implement the concatenation,
  // but nvcc incorrectly generates warning "warning: expression has no effect"
  // when using the fold expression version
  // (ss << ... << args);
  ((ss << args), ...);
  return ss.str();
}
 
}  // namespace serac::profiling