Files
rocm-systems/source/lib/rocprofiler-sdk/rocdecode/defines.hpp
T
Trowbridge, Ian 077723337a rocDecode Buffer Tracing Support (#315)
* Added buffer tracing support for rocdecode and updated tests to work with buffer tracing

* Updated perfetto to output args individually rather than as a string list

* Updated docstrings and operation type, changed OTF2 code to remove warning due to change in operation type

* Updated tests for review comments

* Test args exist and return value

* Updated to use string entry

* Change function name

* Updated PR to reflect review comments

* Updated for PR review comments

* Change function name
2025-04-11 21:56:36 +00:00

227 rader
20 KiB
C++

// MIT License
//
// Copyright (c) 2023-2025 Advanced Micro Devices, Inc. All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#pragma once
#include "lib/common/defines.hpp"
#define ROCDECODE_API_INFO_DEFINITION_0( \
ROCDECODE_TABLE, ROCDECODE_API_ID, ROCDECODE_FUNC, ROCDECODE_FUNC_PTR) \
namespace rocprofiler \
{ \
namespace rocdecode \
{ \
template <> \
struct rocdecode_api_info<ROCDECODE_TABLE, ROCDECODE_API_ID> \
: rocdecode_domain_info<ROCDECODE_TABLE> \
{ \
static constexpr auto table_idx = ROCDECODE_TABLE; \
static constexpr auto operation_idx = ROCDECODE_API_ID; \
static constexpr auto name = #ROCDECODE_FUNC; \
\
using domain_type = rocdecode_domain_info<table_idx>; \
using this_type = rocdecode_api_info<table_idx, operation_idx>; \
using base_type = rocdecode_api_impl<table_idx, operation_idx>; \
\
using domain_type::callback_domain_idx; \
using domain_type::buffered_domain_idx; \
using domain_type::args_type; \
using domain_type::retval_type; \
using domain_type::callback_data_type; \
\
static constexpr auto offset() \
{ \
return offsetof(rocdecode_table_lookup<table_idx>::type, ROCDECODE_FUNC_PTR); \
} \
\
static_assert(offsetof(rocdecode_table_lookup<table_idx>::type, ROCDECODE_FUNC_PTR) == \
(sizeof(size_t) + (operation_idx * sizeof(void*))), \
"ABI error for " #ROCDECODE_FUNC); \
\
static auto& get_table() { return rocdecode_table_lookup<table_idx>{}(); } \
\
template <typename TableT> \
static auto& get_table(TableT& _v) \
{ \
return rocdecode_table_lookup<table_idx>{}(_v); \
} \
\
template <typename TableT> \
static auto& get_table_func(TableT& _table) \
{ \
if constexpr(std::is_pointer<TableT>::value) \
{ \
assert(_table != nullptr && "nullptr to MARKER table for " #ROCDECODE_FUNC \
" function"); \
return _table->ROCDECODE_FUNC_PTR; \
} \
else \
{ \
return _table.ROCDECODE_FUNC_PTR; \
} \
} \
\
static auto& get_table_func() { return get_table_func(get_table()); } \
\
template <typename DataT> \
static auto& get_api_data_args(DataT& _data) \
{ \
return _data.ROCDECODE_FUNC; \
} \
\
template <typename RetT, typename... Args> \
static auto get_functor(RetT (*)(Args...)) \
{ \
return &base_type::functor<RetT, Args...>; \
} \
\
static std::vector<void*> as_arg_addr(rocprofiler_rocdecode_api_args_t) \
{ \
return std::vector<void*>{}; \
} \
\
static std::vector<common::stringified_argument> as_arg_list( \
rocprofiler_rocdecode_api_args_t, \
int32_t) \
{ \
return {}; \
} \
}; \
} \
}
#define ROCDECODE_API_INFO_DEFINITION_V( \
ROCDECODE_TABLE, ROCDECODE_API_ID, ROCDECODE_FUNC, ROCDECODE_FUNC_PTR, ...) \
namespace rocprofiler \
{ \
namespace rocdecode \
{ \
template <> \
struct rocdecode_api_info<ROCDECODE_TABLE, ROCDECODE_API_ID> \
: rocdecode_domain_info<ROCDECODE_TABLE> \
{ \
static constexpr auto table_idx = ROCDECODE_TABLE; \
static constexpr auto operation_idx = ROCDECODE_API_ID; \
static constexpr auto name = #ROCDECODE_FUNC; \
\
using domain_type = rocdecode_domain_info<table_idx>; \
using this_type = rocdecode_api_info<table_idx, operation_idx>; \
using base_type = rocdecode_api_impl<table_idx, operation_idx>; \
\
static constexpr auto callback_domain_idx = domain_type::callback_domain_idx; \
static constexpr auto buffered_domain_idx = domain_type::buffered_domain_idx; \
\
using domain_type::args_type; \
using domain_type::retval_type; \
using domain_type::callback_data_type; \
\
static constexpr auto offset() \
{ \
return offsetof(rocdecode_table_lookup<table_idx>::type, ROCDECODE_FUNC_PTR); \
} \
\
static_assert(offsetof(rocdecode_table_lookup<table_idx>::type, ROCDECODE_FUNC_PTR) == \
(sizeof(size_t) + (operation_idx * sizeof(void*))), \
"ABI error for " #ROCDECODE_FUNC); \
\
static auto& get_table() { return rocdecode_table_lookup<table_idx>{}(); } \
\
template <typename TableT> \
static auto& get_table(TableT& _v) \
{ \
return rocdecode_table_lookup<table_idx>{}(_v); \
} \
\
template <typename TableT> \
static auto& get_table_func(TableT& _table) \
{ \
if constexpr(std::is_pointer<TableT>::value) \
{ \
assert(_table != nullptr && "nullptr to MARKER table for " #ROCDECODE_FUNC \
" function"); \
return _table->ROCDECODE_FUNC_PTR; \
} \
else \
{ \
return _table.ROCDECODE_FUNC_PTR; \
} \
} \
\
static auto& get_table_func() { return get_table_func(get_table()); } \
\
template <typename DataT> \
static auto& get_api_data_args(DataT& _data) \
{ \
return _data.ROCDECODE_FUNC; \
} \
\
template <typename RetT, typename... Args> \
static auto get_functor(RetT (*)(Args...)) \
{ \
return &base_type::functor<RetT, Args...>; \
} \
\
static std::vector<void*> as_arg_addr(rocprofiler_rocdecode_api_args_t args) \
{ \
return std::vector<void*>{ \
GET_ADDR_MEMBER_FIELDS(get_api_data_args(args), __VA_ARGS__)}; \
} \
static auto as_arg_list(rocprofiler_rocdecode_api_args_t args, int32_t max_deref) \
{ \
return utils::stringize( \
max_deref, GET_NAMED_MEMBER_FIELDS(get_api_data_args(args), __VA_ARGS__)); \
} \
}; \
} \
}
#define ROCDECODE_API_TABLE_LOOKUP_DEFINITION(TABLE_ID, TYPE) \
namespace rocprofiler \
{ \
namespace rocdecode \
{ \
namespace \
{ \
template <> \
auto* get_table<TABLE_ID>() \
{ \
return get_table_impl<TYPE>(); \
} \
} \
\
template <> \
struct rocdecode_table_lookup<TABLE_ID> \
{ \
using type = TYPE; \
auto& operator()(type& _v) const { return _v; } \
auto& operator()(type* _v) const { return *_v; } \
auto& operator()() const { return (*this)(get_table<TABLE_ID>()); } \
}; \
\
template <> \
struct rocdecode_table_id_lookup<TYPE> \
{ \
static constexpr auto value = TABLE_ID; \
}; \
} \
}