tim::component::vtune_profiler Struct Reference

Implements __itt_pause() and __itt_resume() to control where the vtune profiler is active. More...

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

Collaboration diagram for tim::component::vtune_profiler:

Public Types
using	value_type = void
using	this_type = vtune_profiler
using	base_type = base< this_type, value_type >
using	tracker_type = policy::instance_tracker< vtune_profiler, false >
using	storage_type = empty_storage

Public Member Functions
void	start ()
void	stop ()
void	get () const

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()
static void	global_init ()
static void	global_finalize ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

Implements __itt_pause() and __itt_resume() to control where the vtune profiler is active.

Definition at line 156 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 162 of file components.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

this_type

using tim::component::vtune_profiler::this_type = vtune_profiler

Definition at line 161 of file components.hpp.

tracker_type

using tim::component::vtune_profiler::tracker_type = policy::instance_tracker<vtune_profiler, false>

Definition at line 163 of file components.hpp.

value_type

using tim::component::vtune_profiler::value_type = void

Definition at line 160 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 166 of file components.hpp.

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

get()

void tim::component::empty_base::get ( ) const

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

global_finalize()

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

inlinestatic

Definition at line 173 of file components.hpp.

{ ittnotify::pause(); }

global_init()

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

inlinestatic

Definition at line 172 of file components.hpp.

{ ittnotify::pause(); }

label()

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

inlinestatic

Definition at line 165 of file components.hpp.

{ return "vtune_profiler"; }

record()

static value_type tim::component::vtune_profiler::record ( )

inlinestatic

Definition at line 170 of file components.hpp.

{}

start()

void tim::component::vtune_profiler::start ( )

inline

Definition at line 177 of file components.hpp.

    {
        tracker_type::start();
 
        if(m_tot == 0)
            ittnotify::resume();
    }

References tim::invoke::start().

stop()

void tim::component::vtune_profiler::stop ( )

inline

Definition at line 185 of file components.hpp.

    {
        tracker_type::stop();
 
        if(m_tot == 0)
            ittnotify::pause();
    }

References tim::invoke::stop().

---

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

• timemory/components/vtune/components.hpp