tim::component::roctx_marker Struct Reference

Inserts ROCTX markers with the current timemory prefix. More...

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

Collaboration diagram for tim::component::roctx_marker:

Public Types
using	value_type = void
using	this_type = roctx_marker
using	base_type = base< this_type, value_type >
using	storage_type = empty_storage

Public Member Functions
	roctx_marker (hip::stream_t _stream)
	construct with an specific HIP stream More...
void	start ()
	start an roctx range. Equivalent to roctxRangeStartEx More...
void	stop ()
	stop the roctx range. Equivalent to roctxRangeEnd. Depending on settings::roctx_marker_device_sync() this will either call hipDeviceSynchronize() or hipStreamSynchronize(m_stream) before stopping the range. More...
void	mark_begin ()
	asynchronously add a marker. Equivalent to roctxMarkA More...
void	mark_end ()
	asynchronously add a marker. Equivalent to roctxMarkA More...
void	mark_begin (hip::stream_t _stream)
	asynchronously add a marker for a specific stream. Equivalent to roctxMarkA More...
void	mark_end (hip::stream_t _stream)
	asynchronously add a marker for a specific stream. Equivalent to roctxMarkA More...
void	set_stream (hip::stream_t _stream)
	set the current HIP stream More...
void	set_prefix (const char *_prefix)
	set the label More...
auto	get_range_id ()
auto	get_stream ()
void	get () const

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

Detailed Description

Inserts ROCTX markers with the current timemory prefix.

Definition at line 252 of file components.hpp.

Member Typedef Documentation

base_type

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

Definition at line 256 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::roctx_marker::this_type = roctx_marker

Definition at line 255 of file components.hpp.

value_type

using tim::component::roctx_marker::value_type = void

Definition at line 254 of file components.hpp.

Constructor & Destructor Documentation

roctx_marker()

tim::component::roctx_marker::roctx_marker ( hip::stream_t  _stream )

inlineexplicit

construct with an specific HIP stream

Definition at line 274 of file components.hpp.

    : m_stream(_stream)
    {}

Member Function Documentation

description()

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

inlinestatic

Definition at line 259 of file components.hpp.

    {
        return "Generates high-level region markers for HIP profilers";
    }

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

get_range_id()

auto tim::component::roctx_marker::get_range_id ( )

inline

Definition at line 329 of file components.hpp.

{ return m_range_id; }

get_stream()

auto tim::component::roctx_marker::get_stream ( )

inline

Definition at line 330 of file components.hpp.

{ return m_stream; }

label()

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

inlinestatic

Definition at line 258 of file components.hpp.

{ return "roctx_marker"; }

mark_begin() [1/2]

void tim::component::roctx_marker::mark_begin ( )

inline

asynchronously add a marker. Equivalent to roctxMarkA

Definition at line 299 of file components.hpp.

    {
        roctx::mark(TIMEMORY_JOIN("", m_prefix, "_begin_t", threading::get_id()));
    }

References tim::invoke::mark(), and TIMEMORY_JOIN.

mark_begin() [2/2]

void tim::component::roctx_marker::mark_begin ( hip::stream_t  _stream )

inline

asynchronously add a marker for a specific stream. Equivalent to roctxMarkA

Definition at line 311 of file components.hpp.

    {
        roctx::mark(TIMEMORY_JOIN("", m_prefix, "_begin_t", threading::get_id(), "_s",
                                  get_stream_id(_stream)));
    }

References tim::invoke::mark(), and TIMEMORY_JOIN.

mark_end() [1/2]

void tim::component::roctx_marker::mark_end ( )

inline

asynchronously add a marker. Equivalent to roctxMarkA

Definition at line 305 of file components.hpp.

    {
        roctx::mark(TIMEMORY_JOIN("", m_prefix, "_end_t", threading::get_id()));
    }

References tim::invoke::mark(), and TIMEMORY_JOIN.

mark_end() [2/2]

void tim::component::roctx_marker::mark_end ( hip::stream_t  _stream )

inline

asynchronously add a marker for a specific stream. Equivalent to roctxMarkA

Definition at line 318 of file components.hpp.

    {
        roctx::mark(TIMEMORY_JOIN("", m_prefix, "_end_t", threading::get_id(), "_s",
                                  get_stream_id(_stream)));
    }

References tim::invoke::mark(), and TIMEMORY_JOIN.

record()

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

inlinestatic

Definition at line 263 of file components.hpp.

{}

set_prefix()

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

inline

set the label

Definition at line 327 of file components.hpp.

{ m_prefix = _prefix; }

References tim::_prefix.

set_stream()

void tim::component::roctx_marker::set_stream ( hip::stream_t  _stream )

inline

set the current HIP stream

Definition at line 325 of file components.hpp.

{ m_stream = _stream; }

start()

void tim::component::roctx_marker::start ( )

inline

start an roctx range. Equivalent to roctxRangeStartEx

Definition at line 279 of file components.hpp.

{ m_range_id = roctx::range_start(m_prefix); }

stop()

void tim::component::roctx_marker::stop ( )

inline

stop the roctx range. Equivalent to roctxRangeEnd. Depending on settings::roctx_marker_device_sync() this will either call hipDeviceSynchronize() or hipStreamSynchronize(m_stream) before stopping the range.

Definition at line 285 of file components.hpp.

    {
        if(use_device_sync())
        {
            hip::device_sync();
        }
        else
        {
            hip::stream_sync(m_stream);
        }
        roctx::range_stop(m_range_id);
    }

References use_device_sync().

use_device_sync()

static bool & tim::component::roctx_marker::use_device_sync ( )

inlinestatic

Definition at line 265 of file components.hpp.

    {
        static bool _instance = settings::nvtx_marker_device_sync();
        return _instance;
    }

References tim::nvtx_marker_device_sync.

Referenced by stop().

---

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

• timemory/components/hip/components.hpp