[SDK][rocprofv3] Buffer tracing records with args (HIP) (#285)
* [SDK][rocprofv3] HIP API buffer records with args (ext) - New buffer tracing domain(s) for HIP APIs which include the arguments and the return value in the buffer records - Update HIP stream support for extended HIP buffer tracing - Update rocprofv3 tool library and output library to use extended HIP buffer tracing recods * Update stream.cpp - handle hipStream_t address being reused for a new stream * Update doxygen docs for rocprofiler_iterate_buffer_tracing_record_args * Update rocprofv3 tool.cpp - configure buffer tracing services with HIP_*_API_EXT variants - tweak logging level for hip_stream_display_callback * Fix validation tests - add HIP_RUNTIME_API_EXT and HIP_COMPILER_API_EXT to valid domain names * Serialization support for buffer tracing args * Disable stream service for __hipPopCallConfiguration - this is interpreted as a stream create but it doesn't create a stream * Fix execute_buffer_record_emplace for HIP extended contexts * Add uint64_t_retval to rocprofiler_hip_api_retval_t union - reading in hipError_t_retval during serialization of pointer return value causes undefined behavior * Fix compilation warning about unused but set parameter - in hip/stream.cpp * Add synchronization for async_copy_data * Fix compilation error * Fix compilation error --------- Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>
Этот коммит содержится в:
Madsen, Jonathan
коммит произвёл
GitHub
GitHub
родитель
2d072f9217
Коммит
e33dff7ad0
@@ -25,6 +25,7 @@
|
||||
#include <rocprofiler-sdk/agent.h>
|
||||
#include <rocprofiler-sdk/defines.h>
|
||||
#include <rocprofiler-sdk/fwd.h>
|
||||
#include <rocprofiler-sdk/hip/api_args.h>
|
||||
#include <rocprofiler-sdk/kfd/page_migration_args.h>
|
||||
|
||||
#include <stdint.h>
|
||||
@@ -84,7 +85,30 @@ typedef struct
|
||||
} rocprofiler_buffer_tracing_hip_api_record_t;
|
||||
|
||||
/**
|
||||
* @brief Additional trace data for OMPT target routines
|
||||
* @brief ROCProfiler Buffer HIP API Tracer Record.
|
||||
*/
|
||||
typedef struct
|
||||
{
|
||||
uint64_t size; ///< size of this struct
|
||||
rocprofiler_buffer_tracing_kind_t kind;
|
||||
rocprofiler_tracing_operation_t operation;
|
||||
rocprofiler_correlation_id_t correlation_id; ///< correlation ids for record
|
||||
rocprofiler_timestamp_t start_timestamp; ///< start time in nanoseconds
|
||||
rocprofiler_timestamp_t end_timestamp; ///< end time in nanoseconds
|
||||
rocprofiler_thread_id_t thread_id; ///< id for thread generating this record
|
||||
rocprofiler_hip_api_args_t args; ///< arguments of function call
|
||||
rocprofiler_hip_api_retval_t retval; ///< return value of function call
|
||||
|
||||
/// @var kind
|
||||
/// @brief ::ROCPROFILER_CALLBACK_TRACING_HIP_RUNTIME_API or
|
||||
/// ::ROCPROFILER_CALLBACK_TRACING_HIP_COMPILER_API
|
||||
/// @var operation
|
||||
/// @brief Specification of the API function, e.g., ::rocprofiler_hip_runtime_api_id_t or
|
||||
/// ::rocprofiler_hip_compiler_api_id_t
|
||||
} rocprofiler_buffer_tracing_hip_api_ext_record_t;
|
||||
|
||||
/**
|
||||
* @brief Additional trace data for OpenMP target routines
|
||||
*/
|
||||
|
||||
typedef struct rocprofiler_buffer_tracing_ompt_target_t
|
||||
@@ -494,6 +518,53 @@ rocprofiler_iterate_buffer_tracing_kind_operations(
|
||||
rocprofiler_buffer_tracing_kind_operation_cb_t callback,
|
||||
void* data) ROCPROFILER_API ROCPROFILER_NONNULL(2);
|
||||
|
||||
/**
|
||||
* @brief Callback function for iterating over the function arguments to a traced function.
|
||||
* This function will be invoked for each argument.
|
||||
* @see rocprofiler_iterate_buffer_tracing_record_args
|
||||
*
|
||||
* @param [in] kind domain
|
||||
* @param [in] operation associated domain operation
|
||||
* @param [in] arg_number the argument number, starting at zero
|
||||
* @param [in] arg_value_addr the address of the argument stored by rocprofiler.
|
||||
* @param [in] arg_indirection_count the total number of indirection levels for the argument, e.g.
|
||||
* int == 0, int* == 1, int** == 2
|
||||
* @param [in] arg_type the typeid name of the argument (not demangled)
|
||||
* @param [in] arg_name the name of the argument in the prototype (or rocprofiler union)
|
||||
* @param [in] arg_value_str conversion of the argument to a string, e.g. operator<< overload
|
||||
* @param [in] data user data
|
||||
*/
|
||||
typedef int (*rocprofiler_buffer_tracing_operation_args_cb_t)(
|
||||
rocprofiler_buffer_tracing_kind_t kind,
|
||||
rocprofiler_tracing_operation_t operation,
|
||||
uint32_t arg_number,
|
||||
const void* const arg_value_addr,
|
||||
int32_t arg_indirection_count,
|
||||
const char* arg_type,
|
||||
const char* arg_name,
|
||||
const char* arg_value_str,
|
||||
void* data);
|
||||
|
||||
/**
|
||||
* @brief Iterates over all the arguments for the traced function (when available). This is
|
||||
* particularly useful when tools want to annotate traces with the function arguments. See
|
||||
* @example samples/api_buffer_tracing/client.cpp for a usage example.
|
||||
*
|
||||
* In contrast to ::rocprofiler_iterate_callback_tracing_kind_operation_args, this function
|
||||
* cannot dereference pointer arguments since there is a high probability that the pointer
|
||||
* address references the stack and the buffer tracing record is delivered after the
|
||||
* stack variables of the corresponding function have been destroyed.
|
||||
*
|
||||
* @param[in] record Buffer record
|
||||
* @param[in] callback The callback function which will be invoked for each argument
|
||||
* @param[in] user_data Data to be passed to each invocation of the callback
|
||||
*/
|
||||
rocprofiler_status_t
|
||||
rocprofiler_iterate_buffer_tracing_record_args(
|
||||
rocprofiler_record_header_t record,
|
||||
rocprofiler_buffer_tracing_operation_args_cb_t callback,
|
||||
void* user_data) ROCPROFILER_API ROCPROFILER_NONNULL(2);
|
||||
|
||||
/** @} */
|
||||
|
||||
ROCPROFILER_EXTERN_C_FINI
|
||||
|
||||
@@ -85,8 +85,69 @@
|
||||
# define ROCPROFILER_SDK_CEREAL_NAMESPACE_END } // namespace cereal
|
||||
#endif
|
||||
|
||||
namespace rocprofiler
|
||||
{
|
||||
namespace sdk
|
||||
{
|
||||
namespace serialization
|
||||
{
|
||||
struct buffer_tracing_args
|
||||
{
|
||||
std::string type = {};
|
||||
std::string name = {};
|
||||
std::string value = {};
|
||||
};
|
||||
|
||||
template <typename Tp>
|
||||
auto
|
||||
get_buffer_tracing_args(Tp& data)
|
||||
{
|
||||
auto populate_args_array = [](rocprofiler_buffer_tracing_kind_t /*kind*/,
|
||||
rocprofiler_tracing_operation_t /*operation*/,
|
||||
uint32_t arg_number,
|
||||
const void* const /*arg_value_addr*/,
|
||||
int32_t /*arg_indirection_count*/,
|
||||
const char* arg_type,
|
||||
const char* arg_name,
|
||||
const char* arg_value_str,
|
||||
void* cb_data) -> int {
|
||||
if(!cb_data) return 1;
|
||||
|
||||
auto* vec = static_cast<std::vector<buffer_tracing_args>*>(cb_data);
|
||||
auto sz = std::max<size_t>(arg_number + 1, vec->size());
|
||||
vec->resize(sz, buffer_tracing_args{});
|
||||
vec->at(arg_number) = buffer_tracing_args{arg_type, arg_name, arg_value_str};
|
||||
|
||||
return 0;
|
||||
};
|
||||
|
||||
auto ret = std::vector<buffer_tracing_args>{};
|
||||
auto record = rocprofiler_record_header_t{};
|
||||
record.hash =
|
||||
rocprofiler_record_header_compute_hash(ROCPROFILER_BUFFER_CATEGORY_TRACING, data.kind);
|
||||
record.payload = &data;
|
||||
|
||||
rocprofiler_iterate_buffer_tracing_record_args(record, populate_args_array, &ret);
|
||||
|
||||
return ret;
|
||||
}
|
||||
} // namespace serialization
|
||||
} // namespace sdk
|
||||
} // namespace rocprofiler
|
||||
|
||||
ROCPROFILER_SDK_CEREAL_NAMESPACE_BEGIN
|
||||
|
||||
namespace sdk = ::rocprofiler::sdk;
|
||||
|
||||
template <typename ArchiveT>
|
||||
void
|
||||
save(ArchiveT& ar, const sdk::serialization::buffer_tracing_args& data)
|
||||
{
|
||||
ROCP_SDK_SAVE_DATA_FIELD(type);
|
||||
ROCP_SDK_SAVE_DATA_FIELD(name);
|
||||
ROCP_SDK_SAVE_DATA_FIELD(value);
|
||||
}
|
||||
|
||||
template <typename ArchiveT>
|
||||
void
|
||||
save(ArchiveT& ar, rocprofiler_context_id_t data)
|
||||
@@ -316,7 +377,7 @@ template <typename ArchiveT>
|
||||
void
|
||||
save(ArchiveT& ar, rocprofiler_hip_api_retval_t data)
|
||||
{
|
||||
ROCP_SDK_SAVE_DATA_FIELD(hipError_t_retval);
|
||||
ROCP_SDK_SAVE_DATA_FIELD(uint64_t_retval);
|
||||
}
|
||||
|
||||
template <typename ArchiveT>
|
||||
@@ -513,6 +574,16 @@ save(ArchiveT& ar, rocprofiler_buffer_tracing_hip_api_record_t data)
|
||||
save_buffer_tracing_api_record(ar, data);
|
||||
}
|
||||
|
||||
template <typename ArchiveT>
|
||||
void
|
||||
save(ArchiveT& ar, rocprofiler_buffer_tracing_hip_api_ext_record_t data)
|
||||
{
|
||||
save_buffer_tracing_api_record(ar, data);
|
||||
auto args = sdk::serialization::get_buffer_tracing_args(data);
|
||||
ROCP_SDK_SAVE_VALUE("args", args);
|
||||
ROCP_SDK_SAVE_DATA_FIELD(retval);
|
||||
}
|
||||
|
||||
template <typename ArchiveT>
|
||||
void
|
||||
save(ArchiveT& ar, rocprofiler_buffer_tracing_marker_api_record_t data)
|
||||
|
||||
@@ -214,7 +214,16 @@ typedef enum // NOLINT(performance-enum-size)
|
||||
ROCPROFILER_BUFFER_TRACING_ROCDECODE_API, ///< rocDecode tracing
|
||||
ROCPROFILER_BUFFER_TRACING_ROCJPEG_API, ///< rocJPEG tracing
|
||||
ROCPROFILER_BUFFER_TRACING_HIP_STREAM_API, ///< Display HIP Stream
|
||||
ROCPROFILER_BUFFER_TRACING_HIP_RUNTIME_API_EXT,
|
||||
ROCPROFILER_BUFFER_TRACING_HIP_COMPILER_API_EXT,
|
||||
ROCPROFILER_BUFFER_TRACING_LAST,
|
||||
|
||||
/// @var ROCPROFILER_BUFFER_TRACING_HIP_RUNTIME_API_EXT
|
||||
/// @brief Similar to ROCPROFILER_BUFFER_TRACING_HIP_RUNTIME_API except the buffer record
|
||||
/// contains the function argument(s) and return value
|
||||
/// @var ROCPROFILER_BUFFER_TRACING_HIP_COMPILER_API_EXT
|
||||
/// @brief Similar to ROCPROFILER_BUFFER_TRACING_HIP_COMPILER_API except the buffer record
|
||||
/// contains the function argument(s) and return value
|
||||
} rocprofiler_buffer_tracing_kind_t;
|
||||
|
||||
/**
|
||||
|
||||
@@ -35,6 +35,8 @@
|
||||
#include <hip/amd_detail/amd_hip_gl_interop.h>
|
||||
#include <hip/amd_detail/hip_api_trace.hpp>
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
ROCPROFILER_EXTERN_C_INIT
|
||||
|
||||
// Empty struct has a size of 0 in C but size of 1 in C++.
|
||||
@@ -52,6 +54,7 @@ typedef union rocprofiler_hip_api_retval_t
|
||||
~rocprofiler_hip_api_retval_t() = default;
|
||||
#endif
|
||||
|
||||
uint64_t uint64_t_retval;
|
||||
int int_retval;
|
||||
const char* const_charp_retval;
|
||||
hipError_t hipError_t_retval;
|
||||
|
||||
Ссылка в новой задаче
Block a user