tim::component::caliper_marker Struct Reference

Standard marker for the Caliper Performance Analysis Toolbox. More...

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

Collaboration diagram for tim::component::caliper_marker:

Public Types
using	value_type = void
using	this_type = caliper_marker
using	base_type = base< this_type, value_type >
using	value_type = void
using	this_type = caliper_marker
using	base_type = base< this_type, value_type >
using	storage_type = empty_storage
using	attributes_t = int

Public Member Functions
void	start ()
void	stop ()
void	set_prefix (const char *_prefix)
void	get () const

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static std::string	label ()
static std::string	description ()
static void	start (const std::string &_name)
static void	stop (const std::string &_name)
template<typename... Args>
static opaque	get_opaque (Args &&...)
static void	_init ()
static void	init ()
static std::string &	get_channel ()
static attributes_t &	get_attributes ()
static attributes_t	get_default_attributes ()
static attributes_t	get_nested ()
static auto	get_process_scope ()
static auto	get_thread_scope ()
static auto	get_task_scope ()
static void	enable_process_scope ()
static void	enable_thread_scope ()
static void	enable_task_scope ()

Detailed Description

Standard marker for the Caliper Performance Analysis Toolbox.

Definition at line 55 of file components.hpp.

Member Typedef Documentation

attributes_t

using tim::component::caliper_common::attributes_t = int

inherited

Definition at line 77 of file timemory.hpp.

base_type [1/2]

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

Definition at line 59 of file components.hpp.

base_type [2/2]

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

Definition at line 308 of file timemory.hpp.

storage_type

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

inherited

Definition at line 66 of file declaration.hpp.

this_type [1/2]

using tim::component::caliper_marker::this_type = caliper_marker

Definition at line 58 of file components.hpp.

this_type [2/2]

using tim::component::caliper_marker::this_type = caliper_marker

Definition at line 307 of file timemory.hpp.

value_type [1/2]

using tim::component::caliper_marker::value_type = void

Definition at line 57 of file components.hpp.

value_type [2/2]

using tim::component::caliper_marker::value_type = void

Definition at line 306 of file timemory.hpp.

Member Function Documentation

_init()

static void tim::component::caliper_common::_init ( )

inlinestaticinherited

Definition at line 79 of file timemory.hpp.

    {
        if(tim::settings::debug() || tim::settings::verbose() > 0)
            puts("Initializing caliper...");
        cali_init();
    }

References tim::debug, and tim::verbose.

Referenced by tim::component::caliper_common::init().

description() [1/2]

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

inlinestatic

Definition at line 62 of file components.hpp.

    {
        return "Generic forwarding of markers to Caliper instrumentation";
    }

description() [2/2]

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

inlinestatic

Definition at line 311 of file timemory.hpp.

    {
        return "Generic forwarding of markers to Caliper instrumentation";
    }

enable_process_scope()

static void tim::component::caliper_common::enable_process_scope ( )

inlinestaticinherited

Definition at line 121 of file timemory.hpp.

{ get_attributes() = get_process_scope(); }

References tim::component::caliper_common::get_attributes(), and tim::component::caliper_common::get_process_scope().

enable_task_scope()

static void tim::component::caliper_common::enable_task_scope ( )

inlinestaticinherited

Definition at line 123 of file timemory.hpp.

{ get_attributes() = get_task_scope(); }

References tim::component::caliper_common::get_attributes(), and tim::component::caliper_common::get_task_scope().

enable_thread_scope()

static void tim::component::caliper_common::enable_thread_scope ( )

inlinestaticinherited

Definition at line 122 of file timemory.hpp.

{ get_attributes() = get_thread_scope(); }

References tim::component::caliper_common::get_attributes(), and tim::component::caliper_common::get_thread_scope().

get()

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

inlineinherited

Definition at line 69 of file declaration.hpp.

{}

get_attributes()

static attributes_t & tim::component::caliper_common::get_attributes ( )

inlinestaticinherited

Definition at line 94 of file timemory.hpp.

{ return get_persistent_data().attributes; }

Referenced by tim::component::caliper_common::enable_process_scope(), tim::component::caliper_common::enable_task_scope(), and tim::component::caliper_common::enable_thread_scope().

get_channel()

static std::string & tim::component::caliper_common::get_channel ( )

inlinestaticinherited

Definition at line 92 of file timemory.hpp.

{ return get_persistent_data().channel; }

get_default_attributes()

static attributes_t tim::component::caliper_common::get_default_attributes ( )

inlinestaticinherited

Definition at line 96 of file timemory.hpp.

    {
        return (get_nested() | CALI_ATTR_SCOPE_THREAD);
    }

References tim::component::caliper_common::get_nested().

get_nested()

static attributes_t tim::component::caliper_common::get_nested ( )

inlinestaticinherited

Definition at line 101 of file timemory.hpp.

    {
        return (tim::settings::flat_profile()) ? 0 : CALI_ATTR_NESTED;
    }

References tim::flat_profile.

Referenced by tim::component::caliper_common::get_default_attributes(), tim::component::caliper_common::get_process_scope(), tim::component::caliper_common::get_task_scope(), and tim::component::caliper_common::get_thread_scope().

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_process_scope()

static auto tim::component::caliper_common::get_process_scope ( )

inlinestaticinherited

Definition at line 106 of file timemory.hpp.

    {
        return attributes_t(get_nested() | CALI_ATTR_SCOPE_PROCESS);
    }

References tim::component::caliper_common::get_nested().

Referenced by tim::component::caliper_common::enable_process_scope().

get_task_scope()

static auto tim::component::caliper_common::get_task_scope ( )

inlinestaticinherited

Definition at line 116 of file timemory.hpp.

    {
        return attributes_t(get_nested() | CALI_ATTR_SCOPE_TASK);
    }

References tim::component::caliper_common::get_nested().

Referenced by tim::component::caliper_common::enable_task_scope().

get_thread_scope()

static auto tim::component::caliper_common::get_thread_scope ( )

inlinestaticinherited

Definition at line 111 of file timemory.hpp.

    {
        return attributes_t(get_nested() | CALI_ATTR_SCOPE_THREAD);
    }

References tim::component::caliper_common::get_nested().

Referenced by tim::component::caliper_common::enable_thread_scope().

init()

static void tim::component::caliper_common::init ( )

inlinestaticinherited

Definition at line 86 of file timemory.hpp.

    {
        static bool _ini = (_init(), true);
        consume_parameters(_ini);
    }

References tim::component::caliper_common::_init(), and tim::consume_parameters().

Referenced by tim::component::caliper_common::caliper_common().

label() [1/2]

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

inlinestatic

Definition at line 61 of file components.hpp.

{ return "caliper_marker"; }

label() [2/2]

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

inlinestatic

Definition at line 310 of file timemory.hpp.

{ return "caliper_marker"; }

set_prefix()

void tim::component::caliper_marker::set_prefix ( const char *  _prefix )

inline

Definition at line 333 of file timemory.hpp.

{ m_prefix = _prefix; }

References tim::_prefix.

start() [1/2]

void tim::component::caliper_marker::start ( )

inline

Definition at line 318 of file timemory.hpp.

    {
        if(m_prefix == nullptr)
            return;
        DEBUG_PRINT_HERE("'%s'", m_prefix);
        cali_begin_string(m_id, m_prefix);
    }

References DEBUG_PRINT_HERE.

start() [2/2]

static void tim::component::caliper_marker::start ( const std::string &  _name )

inlinestatic

Definition at line 342 of file timemory.hpp.

{ CALI_MARK_BEGIN(_name.c_str()); }

stop() [1/2]

void tim::component::caliper_marker::stop ( )

inline

Definition at line 325 of file timemory.hpp.

    {
        if(m_prefix == nullptr)
            return;
        DEBUG_PRINT_HERE("'%s'", m_prefix);
        cali_safe_end_string(m_id, m_prefix);
    }

References DEBUG_PRINT_HERE.

stop() [2/2]

static void tim::component::caliper_marker::stop ( const std::string &  _name )

inlinestatic

Definition at line 343 of file timemory.hpp.

{ CALI_MARK_END(_name.c_str()); }

---

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

• timemory/components/caliper/components.hpp
• timemory/components/caliper/timemory.hpp