Mythreya
4fa165ec1a
* Add ToolsApiTable Add ToolsApiTable wrapping for scratch memory tracking * Add initial support for scratch memory tracking Buffering is implemented * cmake formatting (cmake-format) (#525) Co-authored-by: MythreyaK <MythreyaK@users.noreply.github.com> * source formatting (clang-format v11) (#524) Co-authored-by: MythreyaK <MythreyaK@users.noreply.github.com> * Add callback tracing for scratch Fixed the error where scratch tracking init was called irrespective of whether any client requested for it * Apply suggestions from code review Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com> * Fix tools api copy/update Table were saved/updated incorrectly in previous commit. Also adds passing user data through the callback * Fix OpKind sequence for scratch tracking Previously scratch was using OpKind from rocprofiler-sdk, but templates were instantiated using API ID. These differ by 1 * Integration tests for scratch reporting Added buffer and callback integration tests for scratch reporting * source formatting (clang-format v11) (#550) Co-authored-by: MythreyaK <26112391+MythreyaK@users.noreply.github.com> * cmake formatting (cmake-format) (#551) Co-authored-by: MythreyaK <26112391+MythreyaK@users.noreply.github.com> * python formatting (black) (#549) Co-authored-by: MythreyaK <26112391+MythreyaK@users.noreply.github.com> * CI fixes * source formatting (clang-format v11) (#554) Co-authored-by: MythreyaK <26112391+MythreyaK@users.noreply.github.com> * Update api Rebase on main and updates based on PR feedback * Update scratch reporting and address PR comments - Added agent id to buffer records - Updated `test_internal_correlation_ids` - Is almost identical to one in async-copy - Updated scratch test to check for agent id - Updated queue id serialization in callback records (prints handle as nested key) - Remove `marker_api_traces` from scratch `test_internal_correlation_ids` validation test - Rename `amd_tools_api` to `scratch_memory` - Added doxygen comments - Remove scratch callback from `tool.cpp` - Replace assert with `LOF_IF` in `scratch_memory.cpp` * Update tools table Changed to match up with changes to hsa tables in main branch * Rework scratch memory structure * Update tests - Added suggestions from PR review, and updated tests accordingly * Misc cleanup * Update scratch test As of Apr 4th, `hsa_amd_agent_set_async_scratch_limit` is disabled. Note, > This API: `hsa_amd_agent_set_async_scratch_limit` is currently > disabled. We need some changes in CP firmware to be able to do this > and these changes are not ready yet. > With the current code, you will also not get notifications for > alternate-scratch allocations because this feature has been disabled > while CP firmware is making additional changes > We are hoping to have that feature enabled by ROCm-6.3 * Minor update to lib/rocprofiler-sdk/internal_threading.* - delay destruction of shared_ptrs of the tasks to prevent rare (but possible) data race on the destruction of the shared_ptr --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: MythreyaK <MythreyaK@users.noreply.github.com> Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com> Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>
294 lines
27 KiB
C++
294 lines
27 KiB
C++
// MIT License
|
|
//
|
|
// Copyright (c) 2023 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 HSA_API_META_DEFINITION(HSA_TABLE, HSA_API_ID, HSA_FUNC, HSA_FUNC_PTR) \
|
|
namespace rocprofiler \
|
|
{ \
|
|
namespace hsa \
|
|
{ \
|
|
template <> \
|
|
struct hsa_api_meta<HSA_TABLE, HSA_API_ID> \
|
|
{ \
|
|
static constexpr auto table_idx = HSA_TABLE; \
|
|
static constexpr auto operation_idx = HSA_API_ID; \
|
|
static constexpr auto name = #HSA_FUNC; \
|
|
\
|
|
using this_type = hsa_api_meta<table_idx, operation_idx>; \
|
|
using function_type = hsa_api_func<decltype(::HSA_FUNC)*>::function_type; \
|
|
\
|
|
template <typename TableT> \
|
|
static auto& get_table(TableT& _v) \
|
|
{ \
|
|
return hsa_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 HSA table for " #HSA_FUNC " function"); \
|
|
return _table->HSA_FUNC_PTR; \
|
|
} \
|
|
else \
|
|
{ \
|
|
return _table.HSA_FUNC_PTR; \
|
|
} \
|
|
} \
|
|
}; \
|
|
} \
|
|
}
|
|
|
|
// meta definition for non-public APIs (i.e. only in table)
|
|
#define HSA_API_META_DEFINITION_NP(HSA_TABLE, HSA_API_ID, HSA_FUNC, HSA_FUNC_PTR) \
|
|
namespace rocprofiler \
|
|
{ \
|
|
namespace hsa \
|
|
{ \
|
|
template <> \
|
|
struct hsa_api_meta<HSA_TABLE, HSA_API_ID> \
|
|
{ \
|
|
static constexpr auto table_idx = HSA_TABLE; \
|
|
static constexpr auto operation_idx = HSA_API_ID; \
|
|
static constexpr auto name = #HSA_FUNC; \
|
|
\
|
|
using this_type = hsa_api_meta<table_idx, operation_idx>; \
|
|
using function_type = hsa_api_func<decltype( \
|
|
std::declval<hsa_table_lookup<table_idx>::type>().HSA_FUNC_PTR)>::function_type; \
|
|
\
|
|
static constexpr auto offset() \
|
|
{ \
|
|
return offsetof(hsa_table_lookup<table_idx>::type, HSA_FUNC_PTR); \
|
|
} \
|
|
\
|
|
template <typename TableT> \
|
|
static auto& get_table(TableT& _v) \
|
|
{ \
|
|
return hsa_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 HSA table for " #HSA_FUNC " function"); \
|
|
return _table->HSA_FUNC_PTR; \
|
|
} \
|
|
else \
|
|
{ \
|
|
return _table.HSA_FUNC_PTR; \
|
|
} \
|
|
} \
|
|
}; \
|
|
} \
|
|
}
|
|
|
|
#define HSA_API_INFO_DEFINITION_0(HSA_TABLE, HSA_API_ID, HSA_FUNC, HSA_FUNC_PTR) \
|
|
namespace rocprofiler \
|
|
{ \
|
|
namespace hsa \
|
|
{ \
|
|
template <> \
|
|
struct hsa_api_info<HSA_TABLE, HSA_API_ID> \
|
|
{ \
|
|
static constexpr auto callback_domain_idx = \
|
|
hsa_domain_info<HSA_TABLE>::callback_domain_idx; \
|
|
static constexpr auto buffered_domain_idx = \
|
|
hsa_domain_info<HSA_TABLE>::buffered_domain_idx; \
|
|
static constexpr auto table_idx = HSA_TABLE; \
|
|
static constexpr auto operation_idx = HSA_API_ID; \
|
|
static constexpr auto name = #HSA_FUNC; \
|
|
\
|
|
using this_type = hsa_api_info<table_idx, operation_idx>; \
|
|
using base_type = hsa_api_impl<table_idx, operation_idx>; \
|
|
\
|
|
static constexpr auto offset() \
|
|
{ \
|
|
return offsetof(hsa_table_lookup<table_idx>::type, HSA_FUNC_PTR); \
|
|
} \
|
|
\
|
|
static auto& get_table(tracing_table) \
|
|
{ \
|
|
return hsa_table_lookup<table_idx>{}(tracing_table{}); \
|
|
} \
|
|
\
|
|
template <typename TableT> \
|
|
static auto& get_table(TableT& _v) \
|
|
{ \
|
|
return hsa_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 HSA table for " #HSA_FUNC " function"); \
|
|
return _table->HSA_FUNC_PTR; \
|
|
} \
|
|
else \
|
|
{ \
|
|
return _table.HSA_FUNC_PTR; \
|
|
} \
|
|
} \
|
|
\
|
|
static auto& get_table_func() { return get_table_func(get_table(tracing_table{})); } \
|
|
\
|
|
template <typename DataT> \
|
|
static auto& get_api_data_args(DataT& _data) \
|
|
{ \
|
|
return _data.HSA_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_callback_tracing_hsa_api_data_t) \
|
|
{ \
|
|
return std::vector<void*>{}; \
|
|
} \
|
|
\
|
|
static std::vector<common::stringified_argument> as_arg_list( \
|
|
rocprofiler_callback_tracing_hsa_api_data_t, \
|
|
int32_t) \
|
|
{ \
|
|
return {}; \
|
|
} \
|
|
}; \
|
|
} \
|
|
}
|
|
|
|
#define HSA_API_INFO_DEFINITION_V(HSA_TABLE, HSA_API_ID, HSA_FUNC, HSA_FUNC_PTR, ...) \
|
|
namespace rocprofiler \
|
|
{ \
|
|
namespace hsa \
|
|
{ \
|
|
template <> \
|
|
struct hsa_api_info<HSA_TABLE, HSA_API_ID> \
|
|
{ \
|
|
static constexpr auto callback_domain_idx = \
|
|
hsa_domain_info<HSA_TABLE>::callback_domain_idx; \
|
|
static constexpr auto buffered_domain_idx = \
|
|
hsa_domain_info<HSA_TABLE>::buffered_domain_idx; \
|
|
static constexpr auto table_idx = HSA_TABLE; \
|
|
static constexpr auto operation_idx = HSA_API_ID; \
|
|
static constexpr auto name = #HSA_FUNC; \
|
|
\
|
|
using this_type = hsa_api_info<table_idx, operation_idx>; \
|
|
using base_type = hsa_api_impl<table_idx, operation_idx>; \
|
|
\
|
|
static constexpr auto offset() \
|
|
{ \
|
|
return offsetof(hsa_table_lookup<table_idx>::type, HSA_FUNC_PTR); \
|
|
} \
|
|
\
|
|
static auto& get_table(tracing_table) \
|
|
{ \
|
|
return hsa_table_lookup<table_idx>{}(tracing_table{}); \
|
|
} \
|
|
\
|
|
template <typename TableT> \
|
|
static auto& get_table(TableT& _v) \
|
|
{ \
|
|
return hsa_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 HSA table for " #HSA_FUNC " function"); \
|
|
return _table->HSA_FUNC_PTR; \
|
|
} \
|
|
else \
|
|
{ \
|
|
return _table.HSA_FUNC_PTR; \
|
|
} \
|
|
} \
|
|
\
|
|
static auto& get_table_func() { return get_table_func(get_table(tracing_table{})); } \
|
|
\
|
|
template <typename DataT> \
|
|
static auto& get_api_data_args(DataT& _data) \
|
|
{ \
|
|
return _data.HSA_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_callback_tracing_hsa_api_data_t trace_data) \
|
|
{ \
|
|
return std::vector<void*>{ \
|
|
GET_ADDR_MEMBER_FIELDS(get_api_data_args(trace_data.args), __VA_ARGS__)}; \
|
|
} \
|
|
\
|
|
static auto as_arg_list(rocprofiler_callback_tracing_hsa_api_data_t trace_data, \
|
|
int32_t max_deref) \
|
|
{ \
|
|
return utils::stringize( \
|
|
max_deref, \
|
|
GET_NAMED_MEMBER_FIELDS(get_api_data_args(trace_data.args), __VA_ARGS__)); \
|
|
} \
|
|
}; \
|
|
} \
|
|
}
|
|
|
|
#define HSA_API_TABLE_LOOKUP_DEFINITION(TABLE_ID, TYPE, NAME) \
|
|
namespace rocprofiler \
|
|
{ \
|
|
namespace hsa \
|
|
{ \
|
|
struct tracing_table; \
|
|
struct internal_table; \
|
|
\
|
|
template <> \
|
|
struct hsa_table_lookup<TABLE_ID> \
|
|
{ \
|
|
using type = TYPE; \
|
|
auto& operator()(type& _v) const { return _v; } \
|
|
auto& operator()(type* _v) const { return *_v; } \
|
|
auto& operator()(tracing_table) const { return (*this)(get_tracing_##NAME##_table()); } \
|
|
auto& operator()(internal_table) const { return (*this)(get_##NAME##_table()); } \
|
|
}; \
|
|
\
|
|
template <> \
|
|
struct hsa_table_id_lookup<TYPE> \
|
|
{ \
|
|
static constexpr auto value = TABLE_ID; \
|
|
}; \
|
|
} \
|
|
}
|