[SDK] Release 1.0 Public API Modifications (#277)

* Make sure all structs/enums can be forward declared

* Updates to counter collection

- consistency updates and cleanup

* Conversion of dimension information to info struct

* Added deprecated folder

* Testing changes

* merge changes

* Fix shadowed variable

* Source code formatting

* Fix shadowed variable

* Update rocprofiler_counter_info_v1_t member names

* Split version.h into version.h and ext_version.h

- ext_version.h contains external version info, e.g. ROCPROFILER_HSA_API_TABLE_MAJOR_VERSION, ROCPROFILER_HSA_RUNTIME_VERSION
- this reduces amount of recompilation after a commit since version.h gets updated with the git revision

* profile_config -> counter_config

* EOF new line

* [Samples] Reduce header includes + reorg counter collection samples

* Misc compilation fixes

- shadowed variables
- use of [[deprecated("...")]] in C code
- unused variables

* Minor misc modifications

- use common:: instead of rocprofiler::common:: when inside rocprofiler namespace
- counters.cpp
  - move local anon namespace functions into rocprofiler::counters:: anon namespace
  - use std::string_view for get_static_string
  - const ref for get_static_ptr
  - misc namespace shortening

* [Public API] rocprofiler_get_version_triplet + rocprofiler_version_triplet_t

- struct rocprofiler_version_triplet_t containing fields for the major, minor, and patch version
- public API function: rocprofiler_get_version_triplet
- define C++ operators for rocprofiler_version_triplet_t
- C++ function compute_version_triplet

* [Tests] Improve async-copy-testing test

- relax constraints
- improve logging

* Update counter_config.h doxygen docs

* ROCPROFILER_SDK_BETA_COMPAT

- ppdef which helps with renaming when set to 1

* Remove spurious include

* Fix includes for cxx/version.hpp

* Doxygen fixes for rocprofiler_get_version and rocprofiler_get_version_triplet

* Public API Experimental Designation

- ROCPROFILER_SDK_EXPERIMENTAL added to experimental function
- "(experimental)" added to doxygen @brief entries

* Fix use of assert instead of static_assert in hip/stream.cpp

* Use typedef instead of define for rocprofiler_profile_config_id_t

* Use inline rocprofiler_{create,destroy}_profile_config instead of ppdef

- added <rocprofiler-sdk/deprecated/profile_config.h>

* Doxygen for rocprofiler_{create,destroy}_profile_config

* ROCPROFILER_SDK_DEPRECATED_WARNINGS

* Temporarily comment out ROCPROFILER_SDK_DEPRECATED_WARNINGS=1

* cmake formatting

* Misc variable renaming in samples and tests

* Fix declarations of types

* Fix hip stream tracing service struct name

- rocprofiler_callback_tracing_stream_handle_data_t renamed to rocprofiler_callback_tracing_hip_stream_api_data_t

* Rename "HIP_STREAM_API" to "HIP_STREAM"

---------

Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>
Co-authored-by: Benjamin Welton <bewelton@amd.com>
This commit is contained in:
Welton, Benjamin
2025-03-23 23:37:33 -07:00
committed by GitHub
parent cd4676ae6f
commit 4cd121e27b
127 changed files with 1629 additions and 988 deletions
@@ -52,7 +52,7 @@ ROCPROFILER_EXTERN_C_INIT
* @brief ROCProfiler Enumeration for code object storage types (identical values to
* `hsa_ven_amd_loader_code_object_storage_type_t` enumeration)
*/
typedef enum
typedef enum rocprofiler_code_object_storage_type_t
{
ROCPROFILER_CODE_OBJECT_STORAGE_TYPE_NONE = HSA_VEN_AMD_LOADER_CODE_OBJECT_STORAGE_TYPE_NONE,
ROCPROFILER_CODE_OBJECT_STORAGE_TYPE_FILE = HSA_VEN_AMD_LOADER_CODE_OBJECT_STORAGE_TYPE_FILE,
@@ -64,7 +64,7 @@ typedef enum
/**
* @brief ROCProfiler HSA API Callback Data.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_hsa_api_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_hsa_api_args_t args;
@@ -74,7 +74,7 @@ typedef struct
/**
* @brief ROCProfiler HIP runtime and compiler API Tracer Callback Data.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_hip_api_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_hip_api_args_t args;
@@ -89,7 +89,7 @@ typedef struct
/**
* @brief ROCProfiler OMPT Callback Data
*/
typedef struct
typedef struct rocprofiler_callback_tracing_ompt_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_ompt_args_t args;
@@ -98,7 +98,7 @@ typedef struct
/**
* @brief ROCProfiler Marker Tracer Callback Data.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_marker_api_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_marker_api_args_t args;
@@ -108,7 +108,7 @@ typedef struct
/**
* @brief ROCProfiler RCCL API Callback Data.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_rccl_api_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_rccl_api_args_t args;
@@ -138,7 +138,7 @@ typedef struct rocprofiler_callback_tracing_rocjpeg_api_data_t
/**
* @brief ROCProfiler Code Object Load Tracer Callback Record.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_code_object_load_data_t
{
uint64_t size; ///< size of this struct
uint64_t code_object_id; ///< unique code object identifier
@@ -245,7 +245,7 @@ typedef struct rocprofiler_callback_tracing_code_object_kernel_symbol_register_d
} rocprofiler_callback_tracing_code_object_kernel_symbol_register_data_t;
// rename struct
typedef struct
typedef struct rocprofiler_callback_tracing_code_object_host_kernel_symbol_register_data_t
{
uint64_t size; ///< size of this struct
uint64_t host_function_id; ///< unique host function identifier value
@@ -283,7 +283,7 @@ typedef struct rocprofiler_callback_tracing_kernel_dispatch_data_t
* The timestamps in this record will only be non-zero in the ::ROCPROFILER_CALLBACK_PHASE_EXIT
* callback
*/
typedef struct
typedef struct rocprofiler_callback_tracing_memory_copy_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_timestamp_t start_timestamp; ///< start time in nanoseconds
@@ -298,7 +298,7 @@ typedef struct
/**
* @brief ROCProfiler Memory Allocation Tracer Record.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_memory_allocation_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_timestamp_t start_timestamp; ///< start time in nanoseconds
@@ -339,11 +339,11 @@ typedef struct rocprofiler_callback_tracing_runtime_initialization_data_t
/**
* @brief ROCProfiler Stream Handle Callback Data.
*/
typedef struct
typedef struct rocprofiler_callback_tracing_hip_stream_data_t
{
uint64_t size; ///< size of this struct
rocprofiler_stream_id_t stream_id; ///< HIP stream ID
} rocprofiler_callback_tracing_stream_handle_data_t;
} rocprofiler_callback_tracing_hip_stream_data_t;
/**
* @brief API Tracing callback function. This function is invoked twice per API function: once