tim::component::ompt_handle< Api > Struct Template Reference

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

Collaboration diagram for tim::component::ompt_handle< Api >:

Public Types
using	api_type = Api
using	this_type = ompt_handle< api_type >
using	value_type = void
using	base_type = base< this_type, value_type >
using	storage_type = typename base_type::storage_type
using	toolset_type = typename trait::ompt_handle< api_type >::type
using	tracker_type = policy::instance_tracker< this_type >

Public Member Functions
void	start ()
void	stop ()
void	set_prefix (const std::string &_prefix)
void	get () const

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static auto &	get_initializer ()
static void	configure ()
static void	preinit ()
static void	global_init ()
static void	global_finalize ()
static std::string	get_prefix ()
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

template<typename Api>
struct tim::component::ompt_handle< Api >

Definition at line 58 of file components.hpp.

Member Typedef Documentation

api_type

template<typename Api >

using tim::component::ompt_handle< Api >::api_type = Api

Definition at line 62 of file components.hpp.

base_type

template<typename Api >

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

Definition at line 65 of file components.hpp.

storage_type

template<typename Api >

using tim::component::ompt_handle< Api >::storage_type = typename base_type::storage_type

Definition at line 66 of file components.hpp.

this_type

template<typename Api >

using tim::component::ompt_handle< Api >::this_type = ompt_handle<api_type>

Definition at line 63 of file components.hpp.

toolset_type

template<typename Api >

using tim::component::ompt_handle< Api >::toolset_type = typename trait::ompt_handle<api_type>::type

Definition at line 67 of file components.hpp.

tracker_type

template<typename Api >

using tim::component::ompt_handle< Api >::tracker_type = policy::instance_tracker<this_type>

Definition at line 68 of file components.hpp.

value_type

template<typename Api >

using tim::component::ompt_handle< Api >::value_type = void

Definition at line 64 of file components.hpp.

Member Function Documentation

configure()

template<typename Api >

static void tim::component::ompt_handle< Api >::configure ( )

inlinestatic

Definition at line 84 of file components.hpp.

    {
        static int32_t _once = 0;
        if(_once++ == 0)
            this_type::get_initializer()();
    }

References tim::component::ompt_handle< Api >::get_initializer().

Referenced by tim::component::ompt_handle< Api >::global_init().

description()

template<typename Api >

static std::string tim::component::ompt_handle< Api >::description ( )

inlinestatic

Definition at line 71 of file components.hpp.

    {
        return std::string(
                   "Control switch for enabling/disabling OpenMP tools defined by the ") +
               demangle<api_type>() + " tag";
    }

get()

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

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

get_initializer()

template<typename Api >

static auto & tim::component::ompt_handle< Api >::get_initializer ( )

inlinestatic

Definition at line 78 of file components.hpp.

    {
        static std::function<void()> _instance = []() {};
        return _instance;
    }

Referenced by tim::component::ompt_handle< Api >::configure().

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{};
    }

get_prefix()

template<typename Api >

static std::string tim::component::ompt_handle< Api >::get_prefix ( )

inlinestatic

Definition at line 137 of file components.hpp.

    {
        tim::auto_lock_t lk(get_persistent_data().m_mutex);
        return get_persistent_data().m_prefix;
    }

global_finalize()

template<typename Api >

static void tim::component::ompt_handle< Api >::global_finalize ( )

inlinestatic

Definition at line 105 of file components.hpp.

{ trait::runtime_enabled<toolset_type>::set(false); }

References tim::trait::runtime_enabled< T >::set().

global_init()

template<typename Api >

static void tim::component::ompt_handle< Api >::global_init ( )

inlinestatic

Definition at line 98 of file components.hpp.

    {
        // if handle gets initialized (i.e. used), it indicates we want to disable
        trait::runtime_enabled<toolset_type>::set(false);
        configure();
    }

References tim::component::ompt_handle< Api >::configure(), and tim::trait::runtime_enabled< T >::set().

label()

template<typename Api >

static std::string tim::component::ompt_handle< Api >::label ( )

inlinestatic

Definition at line 70 of file components.hpp.

{ return "ompt_handle"; }

preinit()

template<typename Api >

static void tim::component::ompt_handle< Api >::preinit ( )

inlinestatic

Definition at line 91 of file components.hpp.

    {
        static thread_local auto _data_tracker =
            tim::storage_initializer::get<ompt_data_tracker<api_type>>();
        consume_parameters(_data_tracker);
    }

References tim::consume_parameters().

set_prefix()

template<typename Api >

void tim::component::ompt_handle< Api >::set_prefix ( const std::string &  _prefix )

inline

Definition at line 129 of file components.hpp.

    {
        if(_prefix.empty())
            return;
        tim::auto_lock_t lk(get_persistent_data().m_mutex);
        get_persistent_data().m_prefix = _prefix + "/";
    }

References tim::_prefix.

start()

template<typename Api >

void tim::component::ompt_handle< Api >::start ( )

inline

Definition at line 107 of file components.hpp.

    {
#if defined(TIMEMORY_USE_OMPT)
        tracker_type::start();
        if(m_tot == 0)
            trait::runtime_enabled<toolset_type>::set(true);
#endif
    }

References tim::trait::runtime_enabled< T >::set(), and tim::invoke::start().

stop()

template<typename Api >

void tim::component::ompt_handle< Api >::stop ( )

inline

Definition at line 116 of file components.hpp.

    {
#if defined(TIMEMORY_USE_OMPT)
        tracker_type::stop();
        if(m_tot == 0)
            trait::runtime_enabled<toolset_type>::set(false);
#endif
    }

References tim::trait::runtime_enabled< T >::set(), and tim::invoke::stop().

---

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

• timemory/components/ompt/components.hpp