TimingMacros.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
 
 
/* UNCRUSTIFY-OFF */
 
#ifndef GEOS_COMMON_TIMINGMACROS_HPP_
#define GEOS_COMMON_TIMINGMACROS_HPP_
 
#include "common/GeosxConfig.hpp"
#include "GeosxMacros.hpp"
 
namespace timingHelpers
{
  inline std::string stripPF( char const * prettyFunction )
  {
    std::string input(prettyFunction);
    std::string::size_type const end = input.find_first_of( '(' );
    std::string::size_type const beg = input.find_last_of( ' ', end)+1;
    return input.substr( beg, end-beg );
  }
}
 
 
#if defined( GEOS_USE_CUDA ) && defined( GEOS_USE_CUDA_NVTOOLSEXT )
 
#include "nvToolsExt.h"
 
namespace timingHelpers
{
  enum NVTXColors {
    GREEN = 0xff00ff00,
    BLUE = 0xff0000ff,
    YELLOW = 0xffffff00,
    PURPLE = 0xffff00ff,
    AQUA = 0xff00ffff,
    RED = 0xffff0000,
    WHITE = 0xffffffff
  };
 
  class NVTXScopeTracer {
  public:
    NVTXScopeTracer( const char* name, NVTXColors color ) {
      nvtxEventAttributes_t eventAttrib = { 0 };
      eventAttrib.version = NVTX_VERSION;
      eventAttrib.size = NVTX_EVENT_ATTRIB_STRUCT_SIZE;
      eventAttrib.colorType = NVTX_COLOR_ARGB;
      eventAttrib.color = color;
      eventAttrib.messageType = NVTX_MESSAGE_TYPE_ASCII;
      eventAttrib.message.ascii = name;
      nvtxRangePushEx(&eventAttrib);
    }
    ~NVTXScopeTracer() {
      nvtxRangePop();
    }
  };
 
}
#  define GEOS_NVTX_MARK_SCOPE_COLORED(name, color) timingHelpers::NVTXScopeTracer __FILE__ ## _ ## __LINE__ ## _ ## scopeTracer = timingHelpers::NVTXScopeTracer(name, color)
#  define GEOS_NVTX_MARK_SCOPE(name) GEOS_NVTX_MARK_SCOPE_COLORED(STRINGIZE_NX(name), timingHelpers::PURPLE)
#  define GEOS_NVTX_MARK_FUNCTION GEOS_NVTX_MARK_SCOPE_COLORED(timingHelpers::stripPF(__PRETTY_FUNCTION__).c_str(), timingHelpers::BLUE)
#else
#  define GEOS_NVTX_MARK_SCOPE(name)
#  define GEOS_NVTX_MARK_FUNCTION
#endif /* USE_CUDA */
 
 
#ifdef GEOS_USE_CALIPER
#include <caliper/cali.h>
#include <sys/time.h>
#include <string>
#include <iostream>
 
#define GEOS_CALIPER_MARK_SCOPE(name) cali::Function __cali_ann##__LINE__(STRINGIZE_NX(name))
 
#define GEOS_CALIPER_MARK_FUNCTION cali::Function __cali_ann##__func__(timingHelpers::stripPF(__PRETTY_FUNCTION__).c_str())
 
#define GEOS_CALIPER_MARK_BEGIN(name) CALI_MARK_BEGIN(STRINGIZE(name))
 
#define GEOS_CALIPER_MARK_END(name) CALI_MARK_END(STRINGIZE(name))
 
#define GEOS_CALIPER_MARK_FUNCTION_BEGIN CALI_MARK_FUNCTION_BEGIN
 
#define GEOS_CALIPER_MARK_FUNCTION_END CALI_MARK_FUNCTION_END
 
#else // GEOS_USE_CALIPER
 
#define GEOS_CALIPER_MARK_SCOPE(name)
#define GEOS_CALIPER_MARK_FUNCTION
 
#define GEOS_CALIPER_MARK_BEGIN(name)
#define GEOS_CALIPER_MARK_END(name)
 
#define GEOS_CALIPER_MARK_FUNCTION_BEGIN
#define GEOS_CALIPER_MARK_FUNCTION_END
 
#endif // GEOS_USE_CALIPER
 
#define GEOS_MARK_SCOPE(name) GEOS_CALIPER_MARK_SCOPE(name); GEOS_NVTX_MARK_SCOPE(name)
#define GEOS_MARK_FUNCTION GEOS_CALIPER_MARK_FUNCTION; GEOS_NVTX_MARK_FUNCTION
#define GEOS_MARK_FUNCTION_BEGIN(name) GEOS_CALIPER_MARK_FUNCTION_BEGIN(name)
#define GEOS_MARK_FUNCTION_END(name) GEOS_CALIPER_MARK_FUNCTION_END(name)
#define GEOS_MARK_BEGIN(name) GEOS_CALIPER_MARK_BEGIN(name)
#define GEOS_MARK_END(name) GEOS_CALIPER_MARK_END(name)
 
#ifdef GEOS_USE_TIMERS
#define GEOS_GET_TIME( time )                                                 \
  real64 time;                                                                 \
  do                                                                           \
  {                                                                            \
    timeval tim;                                                               \
    gettimeofday(&tim, nullptr);                                               \
    time = tim.tv_sec + (tim.tv_usec / 1000000.0);                             \
  } while (false)
#else
#define GEOS_GET_TIME( time )
#endif
 
#endif // GEOS_COMMON_TIMINGMACROS_HPP_