tim::component::caliper_loop_marker Struct Reference

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

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

Collaboration diagram for tim::component::caliper_loop_marker:

Public Types
using	value_type = void
using	this_type = caliper_loop_marker
using	base_type = base< this_type, value_type >
using	value_type = void
using	this_type = caliper_loop_marker
using	base_type = base< this_type, value_type >
using	attributes_t = int

Public Member Functions
void	start ()
void	stop ()
void	mark_begin ()
void	mark_end ()
template<typename T , enable_if_t< std::is_integral< T >::value, int > = 0>
void	mark_begin (T itr)
template<typename T , enable_if_t< std::is_integral< T >::value, int > = 0>
void	mark_end (T)
template<typename T , enable_if_t< std::is_integral< T >::value, int > = 0>
tim::scope::destructor	record (T itr)
void	set_prefix (const char *_prefix)

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static std::string	label ()
static std::string	description ()
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

Loop marker for the Caliper Performance Analysis Toolbox.

Definition at line 68 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_loop_marker::base_type = base<this_type, value_type>

Definition at line 72 of file components.hpp.

base_type [2/2]

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

Definition at line 381 of file timemory.hpp.

this_type [1/2]

using tim::component::caliper_loop_marker::this_type = caliper_loop_marker

Definition at line 71 of file components.hpp.

this_type [2/2]

using tim::component::caliper_loop_marker::this_type = caliper_loop_marker

Definition at line 380 of file timemory.hpp.

value_type [1/2]

using tim::component::caliper_loop_marker::value_type = void

Definition at line 70 of file components.hpp.

value_type [2/2]

using tim::component::caliper_loop_marker::value_type = void

Definition at line 379 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_loop_marker::description ( )

inlinestatic

Definition at line 75 of file components.hpp.

    {
        return "Variant of caliper_marker with support for loop marking";
    }

description() [2/2]

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

inlinestatic

Definition at line 384 of file timemory.hpp.

    {
        return "Variant of caliper_marker with support for loop marking";
    }

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_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_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_loop_marker::label ( )

inlinestatic

Definition at line 74 of file components.hpp.

{ return "caliper_loop_marker"; }

label() [2/2]

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

inlinestatic

Definition at line 383 of file timemory.hpp.

{ return "caliper_loop_marker"; }

mark_begin() [1/2]

void tim::component::caliper_loop_marker::mark_begin ( )

inline

Definition at line 400 of file timemory.hpp.

    {
        DEBUG_PRINT_HERE("%s", m_prefix);
        cali_begin_int(m_id, m_itr++);
    }

References DEBUG_PRINT_HERE.

mark_begin() [2/2]

template<typename T , enable_if_t< std::is_integral< T >::value, int > = 0>

void tim::component::caliper_loop_marker::mark_begin ( T  itr )

inline

Definition at line 412 of file timemory.hpp.

    {
        DEBUG_PRINT_HERE("%s @ %i", m_prefix, (int) itr);
        m_itr = itr;
        cali_begin_int(m_id, m_itr++);
    }

References DEBUG_PRINT_HERE.

mark_end() [1/2]

void tim::component::caliper_loop_marker::mark_end ( )

inline

Definition at line 405 of file timemory.hpp.

    {
        DEBUG_PRINT_HERE("%s", m_prefix);
        cali_end(m_id);
    }

References DEBUG_PRINT_HERE.

mark_end() [2/2]

template<typename T , enable_if_t< std::is_integral< T >::value, int > = 0>

void tim::component::caliper_loop_marker::mark_end ( T  )

inline

Definition at line 420 of file timemory.hpp.

    {
        DEBUG_PRINT_HERE("%s @ %i", m_prefix, (int) m_itr);
        cali_end(m_id);
    }

References DEBUG_PRINT_HERE.

record()

template<typename T , enable_if_t< std::is_integral< T >::value, int > = 0>

tim::scope::destructor tim::component::caliper_loop_marker::record ( T  itr )

inline

Definition at line 427 of file timemory.hpp.

    {
        DEBUG_PRINT_HERE("%s @ %i", m_prefix, (int) itr);
        m_itr = itr;
        cali_begin_int(m_id, m_itr++);
        return tim::scope::destructor([=]() { cali_end(m_id); });
    }

References DEBUG_PRINT_HERE.

set_prefix()

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

inline

Definition at line 435 of file timemory.hpp.

{ m_prefix = _prefix; }

References tim::_prefix.

start()

void tim::component::caliper_loop_marker::start ( )

inline

Definition at line 391 of file timemory.hpp.

    {
        DEBUG_PRINT_HERE("%s", m_prefix);
        cali_begin_string(m_id, m_prefix);
        m_id  = cali_make_loop_iteration_attribute(m_prefix);
        m_itr = 0;
    }

References DEBUG_PRINT_HERE.

stop()

void tim::component::caliper_loop_marker::stop ( )

inline

Definition at line 398 of file timemory.hpp.

{ cali_end(m_id); }

---

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

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