cs_profiling.h

Go to the documentation of this file.

#pragma once
 
/*============================================================================
 * Building with profiling annotations.
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 EDF S.A.
 
  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
 
  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  details.
 
  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/*----------------------------------------------------------------------------*/
 
// Numeric values for different profiling libraries.
 
#define CS_PROFILING_NONE 0
 
#define CS_PROFILING_NVTX 1
 
#define CS_PROFILING_ROCTX 2
 
// No profiling library is used by default.
#ifndef CS_PROFILING
#define CS_PROFILING CS_PROFILING_NONE
#endif
 
// Make sure NVTX profiling is used in host code only, not CUDA.
#if defined(__CUDA_ARCH__) || defined(__HIP_DEVICE_COMPILE__) \
  || defined(__SYCL_DEVICE_ONLY__)
#undef CS_PROFILING
#define CS_PROFILING CS_PROFILING_NONE
#endif
 
#define CS_COMBINE_DETAIL(x, y) x##y
#define CS_COMBINE(x, y) CS_COMBINE_DETAIL(x, y)
 
#define CS_STRINGIFY_DETAIL(x) #x
#define CS_STRINGIFY(x) CS_STRINGIFY_DETAIL(x)
 
#if CS_PROFILING == CS_PROFILING_NONE
 
/*----------------------------------------------------------------------------
 * Default: no profiling library
 *----------------------------------------------------------------------------*/
 
// Start profiling, when activated y code.
#define CS_PROFILE_START()
 
// Stop profiling, when activated y code.
#define CS_PROFILE_STOP()
 
#define CS_PROFILE_FUNC_RANGE()
 
#define CS_PROFILE_MARK_LINE()
 
/*----------------------------------------------------------------------------
 * Profiling with NVIDIA NVTX3
 *----------------------------------------------------------------------------*/
 
#elif CS_PROFILING == CS_PROFILING_NVTX
 
#include <cuda_profiler_api.h>
 
#include <nvtx3/nvtx3.hpp>
// #include <nvToolsExt.h>
 
// Start profiling, when activated by code.
#define CS_PROFILE_START() {cudaProfilerStart();}
 
// Stop profiling, when activated by code.
#define CS_PROFILE_STOP() {cudaProfilerStop();}
 
#define CS_PROFILE_FUNC_RANGE() NVTX3_FUNC_RANGE()
 
#define CS_PROFILE_MARK_LINE() nvtx3::mark(__FILE__ ":" CS_STRINGIFY(__LINE__))
 
/*----------------------------------------------------------------------------
 * Profiling with AMD ROCTX
 *----------------------------------------------------------------------------*/
 
#elif CS_PROFILING == CS_PROFILING_ROCTX
 
#include <rocprofiler-sdk-roctx/roctx.h>
 
/* Helper class for scoped range
 *------------------------------*/
 
class cs_profiling_scoped_range {
public:
  // Constructor
  cs_profiling_scoped_range(const char *descr)
  { roctxRangePushA(descr); }
 
  // Destructor
  ~cs_profiling_scoped_range()
  { roctxRangePop(); }
};
 
// Start profiling, when activated by code.
 
#define CS_PROFILE_START() {roctxProfilerResume();}
 
// Stop profiling, when activated by code.
#define CS_PROFILE_STOP() {roctxProfilerPause();}
 
#define CS_PROFILE_FUNC_RANGE() \
  cs_profiling_scoped_range _cs_psr = cs_profiling_scoped_range(__func__);
 
#define CS_PROFILE_MARK_LINE() roctxMarkA(__FILE__ ":" CS_STRINGIFY(__LINE__))
 
/*----------------------------------------------------------------------------*/
 
#endif
 
/*----------------------------------------------------------------------------*/