tim::component::cuda_profiler Struct Reference

Control switch for a CUDA profiler running on the application. Only the first call to start() and the last call to stop() actually toggle the state of the external CUDA profiler when component instances are nested. More...

#include "timemory/components/cuda/components.hpp"

Collaboration diagram for tim::component::cuda_profiler:

Public Types
enum class	mode : short {   nvp ,   csv }
using	value_type = void
using	this_type = cuda_profiler
using	base_type = base< this_type, value_type >
using	tracker_type = policy::instance_tracker< cuda_profiler >
using	config_type = std::tuple< std::string, std::string, mode >
using	initializer_type = std::function< config_type()>

Public Member Functions
	cuda_profiler ()
void	start ()
void	stop ()

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static initializer_type &	get_initializer ()
static void	global_init ()
static void	global_finalize ()
static void	configure ()
static void	configure (const std::string &_infile, const std::string &_outfile, mode _mode)

Detailed Description

Control switch for a CUDA profiler running on the application. Only the first call to start() and the last call to stop() actually toggle the state of the external CUDA profiler when component instances are nested.

Definition at line 267 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::cuda_profiler::base_type = base<this_type, value_type>

Definition at line 273 of file components.hpp.

config_type

using tim::component::cuda_profiler::config_type = std::tuple<std::string, std::string, mode>

Definition at line 288 of file components.hpp.

initializer_type

using tim::component::cuda_profiler::initializer_type = std::function<config_type()>

Definition at line 289 of file components.hpp.

this_type

using tim::component::cuda_profiler::this_type = cuda_profiler

Definition at line 272 of file components.hpp.

tracker_type

using tim::component::cuda_profiler::tracker_type = policy::instance_tracker<cuda_profiler>

Definition at line 274 of file components.hpp.

value_type

using tim::component::cuda_profiler::value_type = void

Definition at line 271 of file components.hpp.

Member Enumeration Documentation

mode

enum tim::component::cuda_profiler::mode : short

strong

Enumerator
nvp
csv

Definition at line 282 of file components.hpp.

    {
        nvp,
        csv
    };

Constructor & Destructor Documentation

cuda_profiler()

tim::component::cuda_profiler::cuda_profiler ( )

inline

Definition at line 333 of file components.hpp.

{ configure(); }

References configure().

Member Function Documentation

configure() [1/2]

static void tim::component::cuda_profiler::configure ( )

inlinestatic

Definition at line 313 of file components.hpp.

    {
        auto _config = get_initializer()();
        configure(std::get<0>(_config), std::get<1>(_config), std::get<2>(_config));
    }

References get_initializer().

Referenced by cuda_profiler().

configure() [2/2]

static void tim::component::cuda_profiler::configure ( const std::string &  _infile, const std::string &  _outfile, mode  _mode  )

inlinestatic

Definition at line 319 of file components.hpp.

    {
        static std::atomic<int32_t> _once;
        if(_once++ > 0)
            return;
#if defined(TIMEMORY_USE_CUDA) && (CUDA_VERSION < 11000)
        cudaProfilerInitialize(_infile.c_str(), _outfile.c_str(),
                               (_mode == mode::nvp) ? cudaKeyValuePair : cudaCSV);
#else
        consume_parameters(_infile, _outfile, _mode);
#endif
    }

References tim::consume_parameters(), and nvp.

description()

static std::string tim::component::cuda_profiler::description ( )

inlinestatic

Definition at line 277 of file components.hpp.

    {
        return "Control switch for a CUDA profiler running on the application";
    }

get_initializer()

static initializer_type& tim::component::cuda_profiler::get_initializer ( )

inlinestatic

Definition at line 291 of file components.hpp.

    {
        static initializer_type _instance = []() {
            return config_type("cuda_profiler.inp", "cuda_profiler.out", mode::nvp);
        };
        return _instance;
    }

References nvp.

Referenced by configure().

global_finalize()

static void tim::component::cuda_profiler::global_finalize ( )

inlinestatic

Definition at line 306 of file components.hpp.

    {
#if defined(TIMEMORY_USE_CUDA)
        cudaProfilerStop();
#endif
    }

global_init()

static void tim::component::cuda_profiler::global_init ( )

inlinestatic

Definition at line 299 of file components.hpp.

    {
#if defined(TIMEMORY_USE_CUDA)
        cudaProfilerStop();
#endif
    }

label()

static std::string tim::component::cuda_profiler::label ( )

inlinestatic

Definition at line 276 of file components.hpp.

{ return "cuda_profiler"; }

start()

void tim::component::cuda_profiler::start ( )

inline

Definition at line 335 of file components.hpp.

    {
#if defined(TIMEMORY_USE_CUDA)
        tracker_type::start();
        if(m_tot == 0)
            cudaProfilerStart();
#endif
    }

References tim::invoke::start().

stop()

void tim::component::cuda_profiler::stop ( )

inline

Definition at line 344 of file components.hpp.

    {
#if defined(TIMEMORY_USE_CUDA)
        tracker_type::stop();
        if(m_tot == 0)
            cudaProfilerStop();
#endif
    }

References tim::invoke::stop().

---

The documentation for this struct was generated from the following file:

• timemory/components/cuda/components.hpp