tim::component::hip_event Struct Reference

Records the time interval between two points in a HIP stream. Less accurate than 'cupti_activity' for kernel timing but does not require linking to the HIP driver. More...

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

Collaboration diagram for tim::component::hip_event:

Classes
struct	explicit_streams_only
struct	marker

Public Types
using	value_type = float
using	base_type = base< hip_event, value_type >
using	marker_list_t = std::vector< marker >
using	storage_type = empty_storage

Public Member Functions
	hip_event (hip::stream_t _stream)
float	get_display () const
float	get () const
void	store (explicit_streams_only, bool _v)
void	start ()
void	stop ()
void	sync ()
void	set_stream (hip::stream_t _stream)
auto	get_stream ()
void	mark_begin ()
void	mark_end ()
void	mark_begin (hip::stream_t _stream)
void	mark_end (hip::stream_t _stream)

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

Protected Member Functions
void	append_marker_list (const uint64_t nsize)

Detailed Description

Records the time interval between two points in a HIP stream. Less accurate than 'cupti_activity' for kernel timing but does not require linking to the HIP driver.

Definition at line 64 of file components.hpp.

---

Class Documentation

tim::component::hip_event::explicit_streams_only

struct tim::component::hip_event::explicit_streams_only

Definition at line 123 of file components.hpp.

Collaboration diagram for tim::component::hip_event::explicit_streams_only:

Member Typedef Documentation

base_type

using tim::component::hip_event::base_type = base<hip_event, value_type>

Definition at line 106 of file components.hpp.

marker_list_t

using tim::component::hip_event::marker_list_t = std::vector<marker>

Definition at line 107 of file components.hpp.

storage_type

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

inherited

Definition at line 66 of file declaration.hpp.

value_type

using tim::component::hip_event::value_type = float

Definition at line 105 of file components.hpp.

Constructor & Destructor Documentation

hip_event()

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

inlineexplicit

Definition at line 129 of file components.hpp.

    : m_stream(_stream)
    {}

Member Function Documentation

append_marker_list()

void tim::component::hip_event::append_marker_list ( const uint64_t  nsize )

inlineprotected

Definition at line 206 of file components.hpp.

    {
        m_markers.reserve(m_markers.size() + nsize);
        for(uint64_t i = 0; i < nsize; ++i)
            m_markers.emplace_back(marker{});
    }

Referenced by mark_begin().

description()

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

inlinestatic

Definition at line 110 of file components.hpp.

    {
        return "Records the time interval between two points in a HIP stream. Less "
               "accurate than 'roctracer' for kernel timing";
    }

get()

float tim::component::hip_event::get ( ) const

inline

Definition at line 135 of file components.hpp.

{ return load() / static_cast<float>(base_type::get_unit()); }

References tim::component::base< Tp, Value >::get_unit(), and tim::component::base< hip_event, float >::load().

Referenced by get_display().

get_batched_marker_size()

static uint64_t & tim::component::hip_event::get_batched_marker_size ( )

inlinestatic

Definition at line 117 of file components.hpp.

    {
        static uint64_t _instance = settings::cuda_event_batch_size();
        return _instance;
    }

References tim::cuda_event_batch_size.

get_display()

float tim::component::hip_event::get_display ( ) const

inline

Definition at line 133 of file components.hpp.

{ return get(); }

References get().

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

auto tim::component::hip_event::get_stream ( )

inline

Definition at line 181 of file components.hpp.

{ return m_stream; }

label()

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

inlinestatic

Definition at line 109 of file components.hpp.

{ return "hip_event"; }

mark_begin() [1/2]

void tim::component::hip_event::mark_begin ( )

inline

Definition at line 183 of file components.hpp.

    {
        m_markers_synced = false;
        m_current_marker = m_num_markers++;
        if(m_current_marker >= m_markers.size())
            append_marker_list(std::max<uint64_t>(m_marker_batch_size, 1));
        m_markers[m_current_marker].start(m_stream);
    }

References append_marker_list().

mark_begin() [2/2]

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

inline

Definition at line 194 of file components.hpp.

    {
        m_markers_synced = false;
        m_current_marker = m_num_markers++;
        if(m_current_marker >= m_markers.size())
            append_marker_list(std::max<uint64_t>(m_marker_batch_size, 1));
        m_markers[m_current_marker].start(_stream);
    }

References append_marker_list().

mark_end() [1/2]

void tim::component::hip_event::mark_end ( )

inline

Definition at line 192 of file components.hpp.

{ m_markers[m_current_marker].stop(m_stream); }

mark_end() [2/2]

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

inline

Definition at line 203 of file components.hpp.

{ m_markers[m_current_marker].stop(_stream); }

record()

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

inlinestatic

Definition at line 115 of file components.hpp.

{ return 0.0f; }

set_stream()

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

inline

Definition at line 180 of file components.hpp.

{ m_stream = _stream; }

start()

void tim::component::hip_event::start ( )

inline

Definition at line 139 of file components.hpp.

    {
        if(!m_explicit_only || m_stream != hip::default_stream_v)
        {
            m_global_synced = false;
            m_global.start(m_stream);
        }
    }

References tim::component::hip_event::marker::start().

stop()

void tim::component::hip_event::stop ( )

inline

Definition at line 148 of file components.hpp.

    {
        for(uint64_t i = 0; i < m_num_markers; ++i)
            m_markers[i].stop(m_stream);
        if(m_current_marker == 0 && m_num_markers == 0)
            m_global.stop(m_stream);
        sync();
    }

References stop(), tim::component::hip_event::marker::stop(), and sync().

Referenced by stop().

store()

void tim::component::hip_event::store ( explicit_streams_only  , bool  _v  )

inline

Definition at line 137 of file components.hpp.

{ m_explicit_only = _v; }

sync()

void tim::component::hip_event::sync ( )

inline

Definition at line 157 of file components.hpp.

    {
        if(m_current_marker == 0 && m_num_markers == 0)
        {
            if(!m_global_synced)
            {
                float tmp       = m_global.sync();
                m_global_synced = true;
                accum += tmp;
                value = tmp;
            }
        }
        else if(m_current_marker > m_synced_markers)
        {
            float tmp = 0.0;
            for(uint64_t i = m_synced_markers; i < m_num_markers; ++i, ++m_synced_markers)
                tmp += m_markers[i].sync();
            m_markers_synced = true;
            accum += tmp;
            value = tmp;
        }
    }

References tim::component::hip_event::marker::sync(), and sync().

Referenced by stop(), and sync().

---

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

• timemory/components/hip/components.hpp