sdk Namespace Reference

sdk Namespace Reference#

Rocprofiler SDK Developer API: rocprofiler::sdk Namespace Reference

Rocprofiler SDK Developer API 0.5.0

ROCm Profiling API and tools

Namespaces
namespace	category

namespace	codeobj

namespace	hash

namespace	join

namespace	mpl

namespace	operators

namespace	parse

namespace	utility

Data Structures
struct	perfetto_category

struct	perfetto_category< category ::hip_api >

struct	perfetto_category< category ::hsa_api >

struct	perfetto_category< category ::kernel_dispatch >

struct	perfetto_category< category ::marker_api >

struct	perfetto_category< category ::memory_copy >

struct	perfetto_category< category ::rccl_api >

Typedefs
template<typename Tp = std::string_view>
using	callback_name_info_t = utility::name_info< rocprofiler_callback_tracing_kind_t, Tp >

template<typename Tp = std::string_view>
using	buffer_name_info_t = utility::name_info< rocprofiler_buffer_tracing_kind_t, Tp >

using	callback_name_info = callback_name_info_t< std::string_view >

using	buffer_name_info = buffer_name_info_t< std::string_view >

using	perfetto_event_context_t = ::perfetto::EventContext

Functions
template<typename Tp >
callback_name_info_t< Tp >	get_callback_tracing_names ()

template<typename Tp >
buffer_name_info_t< Tp >	get_buffer_tracing_names ()

template<typename Np , typename Tp >
auto	add_perfetto_annotation (perfetto_event_context_t &ctx, Np &&_name, Tp &&_val)

Variables
constexpr auto	success_v = ROCPROFILER_STATUS_SUCCESS

Data Structure Documentation

◆ rocprofiler::sdk::perfetto_category

struct rocprofiler::sdk::perfetto_category

template<typename Tp>
struct rocprofiler::sdk::perfetto_category< Tp >

Definition at line 73 of file perfetto.hpp.

Collaboration diagram for rocprofiler::sdk::perfetto_category< Tp >:

Typedef Documentation

◆ buffer_name_info

using rocprofiler::sdk::buffer_name_info = typedef buffer_name_info_t<std::string_view>

Definition at line 103 of file name_info.hpp.

◆ buffer_name_info_t

template<typename Tp = std::string_view>

using rocprofiler::sdk::buffer_name_info_t = typedef utility::name_info<rocprofiler_buffer_tracing_kind_t, Tp>

Definition at line 100 of file name_info.hpp.

◆ callback_name_info

using rocprofiler::sdk::callback_name_info = typedef callback_name_info_t<std::string_view>

Definition at line 102 of file name_info.hpp.

◆ callback_name_info_t

template<typename Tp = std::string_view>

using rocprofiler::sdk::callback_name_info_t = typedef utility::name_info<rocprofiler_callback_tracing_kind_t, Tp>

Definition at line 97 of file name_info.hpp.

◆ perfetto_event_context_t

using rocprofiler::sdk::perfetto_event_context_t = typedef ::perfetto::EventContext

Definition at line 100 of file perfetto.hpp.

Function Documentation

◆ add_perfetto_annotation()

template<typename Np , typename Tp >

auto rocprofiler::sdk::add_perfetto_annotation	(	perfetto_event_context_t &	ctx,
		Np &&	_name,
		Tp &&	_val
	)

Definition at line 104 of file perfetto.hpp.

{
    namespace mpl = ::rocprofiler::sdk::mpl;
 
    using named_type = mpl::unqualified_identity_t<Np>;
    using value_type = mpl::unqualified_identity_t<Tp>;
 
    static_assert(mpl::is_string_type<named_type>::value, "Error! name is not a string type");
 
    auto _get_dbg = [&]() {
        auto* _dbg = ctx.event()->add_debug_annotations();
        _dbg->set_name(std::string_view{std::forward<Np>(_name)}.data());
        return _dbg;
    };
 
    if constexpr(std::is_same<value_type, std::string_view>::value)
    {
        _get_dbg()->set_string_value(_val.data());
    }
    else if constexpr(mpl::is_string_type<value_type>::value)
    {
        _get_dbg()->set_string_value(std::forward<Tp>(_val));
    }
    else if constexpr(std::is_same<value_type, bool>::value)
    {
        _get_dbg()->set_bool_value(_val);
    }
    else if constexpr(std::is_enum<value_type>::value)
    {
        _get_dbg()->set_int_value(static_cast<int64_t>(_val));
    }
    else if constexpr(std::is_floating_point<value_type>::value)
    {
        _get_dbg()->set_double_value(static_cast<double>(_val));
    }
    else if constexpr(std::is_integral<value_type>::value)
    {
        if constexpr(std::is_unsigned<value_type>::value)
        {
            _get_dbg()->set_uint_value(_val);
        }
        else
        {
            _get_dbg()->set_int_value(_val);
        }
    }
    else if constexpr(std::is_pointer<value_type>::value)
    {
        _get_dbg()->set_pointer_value(reinterpret_cast<uint64_t>(_val));
    }
    else if constexpr(mpl::can_stringify<value_type>::value)
    {
        auto _ss = std::stringstream{};
        _ss << std::forward<Tp>(_val);
        _get_dbg()->set_string_value(_ss.str());
    }
    else
    {
        static_assert(std::is_empty<value_type>::value, "Error! unsupported data type");
    }
}

◆ get_buffer_tracing_names()

template<typename Tp >

buffer_name_info_t< Tp > rocprofiler::sdk::get_buffer_tracing_names ( )

inline

Definition at line 145 of file name_info.hpp.

{
    auto cb_name_info = buffer_name_info_t<Tp>{};
    //
    // callback for each kind operation
    //
    static auto tracing_kind_operation_cb = [](rocprofiler_buffer_tracing_kind_t kindv,
                                               rocprofiler_tracing_operation_t   operation,
                                               void*                             data_v) {
        auto* name_info_v = static_cast<buffer_name_info_t<Tp>*>(data_v);
 
        const char* name = nullptr;
        auto        status =
            rocprofiler_query_buffer_tracing_kind_operation_name(kindv, operation, &name, nullptr);
        if(status == success_v && name) name_info_v->emplace(kindv, operation, name);
        return 0;
    };
 
    //
    //  callback for each buffer kind (i.e. domain)
    //
    static auto tracing_kind_cb = [](rocprofiler_buffer_tracing_kind_t kind, void* data) {
        //  store the buffer kind name
        auto*       name_info_v = static_cast<buffer_name_info_t<Tp>*>(data);
        const char* name        = nullptr;
        auto        status      = rocprofiler_query_buffer_tracing_kind_name(kind, &name, nullptr);
        if(status == success_v && name) name_info_v->emplace(kind, name);
 
        rocprofiler_iterate_buffer_tracing_kind_operations(kind, tracing_kind_operation_cb, data);
        return 0;
    };
 
    rocprofiler_iterate_buffer_tracing_kinds(tracing_kind_cb, &cb_name_info);
 
    return cb_name_info;
}

References rocprofiler_iterate_buffer_tracing_kind_operations(), rocprofiler_iterate_buffer_tracing_kinds(), rocprofiler_query_buffer_tracing_kind_name(), rocprofiler_query_buffer_tracing_kind_operation_name(), and success_v.

Here is the call graph for this function:

◆ get_callback_tracing_names()

template<typename Tp >

callback_name_info_t< Tp > rocprofiler::sdk::get_callback_tracing_names ( )

inline

Definition at line 106 of file name_info.hpp.

{
    auto cb_name_info = callback_name_info_t<Tp>{};
    //
    // callback for each kind operation
    //
    static auto tracing_kind_operation_cb = [](rocprofiler_callback_tracing_kind_t kindv,
                                               rocprofiler_tracing_operation_t     operation,
                                               void*                               data_v) {
        auto* name_info_v = static_cast<callback_name_info_t<Tp>*>(data_v);
 
        const char* name   = nullptr;
        auto        status = rocprofiler_query_callback_tracing_kind_operation_name(
            kindv, operation, &name, nullptr);
        if(status == success_v && name) name_info_v->emplace(kindv, operation, name);
        return 0;
    };
 
    //
    //  callback for each buffer kind (i.e. domain)
    //
    static auto tracing_kind_cb = [](rocprofiler_callback_tracing_kind_t kind, void* data) {
        //  store the buffer kind name
        auto*       name_info_v = static_cast<callback_name_info_t<Tp>*>(data);
        const char* name        = nullptr;
        auto        status = rocprofiler_query_callback_tracing_kind_name(kind, &name, nullptr);
        if(status == success_v && name) name_info_v->emplace(kind, name);
 
        rocprofiler_iterate_callback_tracing_kind_operations(kind, tracing_kind_operation_cb, data);
        return 0;
    };
 
    rocprofiler_iterate_callback_tracing_kinds(tracing_kind_cb, &cb_name_info);
 
    return cb_name_info;
}

References rocprofiler_iterate_callback_tracing_kind_operations(), rocprofiler_iterate_callback_tracing_kinds(), rocprofiler_query_callback_tracing_kind_name(), rocprofiler_query_callback_tracing_kind_operation_name(), and success_v.

Here is the call graph for this function:

Variable Documentation

◆ success_v

constexpr auto rocprofiler::sdk::success_v = ROCPROFILER_STATUS_SUCCESS

constexpr