Additional 1.0.0 changes (#317)

* Additional 1.0.0 changes

- Update VERSION
- Add beta compatibility for rocprofiler_agent_set_profile_callback_t

* Fix location of deprecated typedef rocprofiler_agent_set_profile_callback_t

* rocprofiler_record_counter_t -> rocprofiler_counter_record_t

* Experimental + deprecated annotations

* rocprofiler_record_dimension_info_t -> rocprofiler_counter_record_dimension_info_t

---------

Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com>

[ROCm/rocprofiler-sdk commit: a1fcdf7f83]
This commit is contained in:
Meserve, Mark
2025-03-26 02:12:03 -05:00
committed by GitHub
parent 146169577b
commit d80c047fd2
23 changed files with 144 additions and 126 deletions
@@ -85,7 +85,7 @@ typedef struct ROCPROFILER_SDK_EXPERIMENTAL rocprofiler_counter_info_v1_t
/**
* @brief (experimental) Query counter id information from record_id.
*
* @param [in] id record id from rocprofiler_record_counter_t
* @param [in] id record id from rocprofiler_counter_record_t
* @param [out] counter_id counter id associated with the record
* @return ::rocprofiler_status_t
* @retval ROCPROFILER_STATUS_SUCCESS if id decoded
@@ -99,7 +99,7 @@ rocprofiler_query_record_counter_id(rocprofiler_counter_instance_id_t id,
* @brief (experimental) Query dimension position from record_id. If the dimension does not exist
* in the counter, the return will be 0.
*
* @param [in] id record id from @ref rocprofiler_record_counter_t
* @param [in] id record id from @ref rocprofiler_counter_record_t
* @param [in] dim dimension for which positional info is requested (currently only
* 0 is allowed, i.e. flat array without dimension).
* @param [out] pos value of the dimension in id
@@ -560,7 +560,7 @@ save(ArchiveT& ar, rocprofiler_buffer_tracing_hsa_api_record_t data)
template <typename ArchiveT>
void
save(ArchiveT& ar, rocprofiler_record_counter_t data)
save(ArchiveT& ar, rocprofiler_counter_record_t data)
{
ROCP_SDK_SAVE_DATA_FIELD(id);
ROCP_SDK_SAVE_DATA_FIELD(counter_value);
@@ -1261,7 +1261,7 @@ save(ArchiveT& ar, rocprofiler_counter_info_v1_t data)
template <typename ArchiveT>
void
save(ArchiveT& ar, rocprofiler_record_dimension_info_t data)
save(ArchiveT& ar, rocprofiler_counter_record_dimension_info_t data)
{
ROCP_SDK_SAVE_DATA_FIELD(id);
ROCP_SDK_SAVE_DATA_FIELD(instance_size);
@@ -41,10 +41,10 @@ ROCPROFILER_EXTERN_C_INIT
ROCPROFILER_SDK_DEPRECATED(
"Function using this alias has been deprecated. See rocprofiler_iterate_counter_dimensions")
typedef rocprofiler_status_t (*rocprofiler_available_dimensions_cb_t)(
rocprofiler_counter_id_t id,
const rocprofiler_record_dimension_info_t* dim_info,
size_t num_dims,
void* user_data);
rocprofiler_counter_id_t id,
const rocprofiler_counter_record_dimension_info_t* dim_info,
size_t num_dims,
void* user_data);
/**
* @brief (deprecated) Return information about the dimensions that exists for a specific counter
@@ -132,9 +132,19 @@ rocprofiler_status_t
rocprofiler_sample_device_counting_service(rocprofiler_context_id_t context_id,
rocprofiler_user_data_t user_data,
rocprofiler_counter_flag_t flags,
rocprofiler_record_counter_t* output_records,
rocprofiler_counter_record_t* output_records,
size_t* rec_count) ROCPROFILER_API;
#if defined(ROCPROFILER_SDK_BETA_COMPAT) && ROCPROFILER_SDK_BETA_COMPAT > 0
// "rocprofiler_agent_set_profile_callback_t" renamed to
// "rocprofiler_device_counting_agent_cb_t"
ROCPROFILER_SDK_DEPRECATED(
"rocprofiler_agent_set_profile_callback_t renamed to rocprofiler_device_counting_agent_cb_t")
typedef rocprofiler_device_counting_agent_cb_t rocprofiler_agent_set_profile_callback_t;
#endif
/** @} */
ROCPROFILER_EXTERN_C_FINI
@@ -58,7 +58,7 @@ typedef struct ROCPROFILER_SDK_EXPERIMENTAL rocprofiler_dispatch_counting_servic
typedef struct ROCPROFILER_SDK_EXPERIMENTAL rocprofiler_dispatch_counting_service_record_t
{
uint64_t size; ///< Size of this struct
uint64_t num_records; ///< number of ::rocprofiler_record_counter_t records
uint64_t num_records; ///< number of ::rocprofiler_counter_record_t records
rocprofiler_async_correlation_id_t correlation_id; ///< Correlation ID for this dispatch
rocprofiler_timestamp_t start_timestamp; ///< start time in nanoseconds
rocprofiler_timestamp_t end_timestamp; ///< end time in nanoseconds
@@ -98,7 +98,7 @@ typedef void (*rocprofiler_dispatch_counting_service_cb_t)(
ROCPROFILER_SDK_EXPERIMENTAL
typedef void (*rocprofiler_dispatch_counting_record_cb_t)(
rocprofiler_dispatch_counting_service_data_t dispatch_data,
rocprofiler_record_counter_t* record_data,
rocprofiler_counter_record_t* record_data,
size_t record_count,
rocprofiler_user_data_t user_data,
void* callback_data_args);
@@ -806,9 +806,9 @@ typedef struct rocprofiler_kernel_dispatch_info_t
} rocprofiler_kernel_dispatch_info_t;
/**
* @brief Details for the dimension, including its size, for a counter record.
* @brief (experimental) Details for the dimension, including its size, for a counter record.
*/
typedef struct rocprofiler_counter_record_dimension_info_t
typedef struct ROCPROFILER_SDK_EXPERIMENTAL rocprofiler_counter_record_dimension_info_t
{
const char* name;
size_t instance_size;
@@ -818,12 +818,14 @@ typedef struct rocprofiler_counter_record_dimension_info_t
/// @brief Id for this dimension used by ::rocprofiler_query_record_dimension_position
} rocprofiler_counter_record_dimension_info_t;
ROCPROFILER_SDK_DEPRECATED("rocprofiler_counter_record_dimension_info_t was renamed to "
"rocprofiler_counter_record_dimension_info_t")
typedef rocprofiler_counter_record_dimension_info_t rocprofiler_record_dimension_info_t;
/**
* @brief ROCProfiler Profile Counting Counter Record per instance.
* @brief (experimental) ROCProfiler Profile Counting Counter Record per instance.
*/
typedef struct rocprofiler_counter_record_t
typedef struct ROCPROFILER_SDK_EXPERIMENTAL rocprofiler_counter_record_t
{
rocprofiler_counter_instance_id_t id; ///< counter identifier
double counter_value; ///< counter value
@@ -839,25 +841,13 @@ typedef struct rocprofiler_counter_record_t
/// ::rocprofiler_kernel_dispatch_info_t) of a ::rocprofiler_dispatch_counting_service_data_t
/// instance (provided during callback for profile config) or a
/// ::rocprofiler_dispatch_counting_service_record_t records (which will be insert into the
/// buffer prior to the associated ::rocprofiler_record_counter_t records).
/// buffer prior to the associated ::rocprofiler_counter_record_t records).
} rocprofiler_counter_record_t;
ROCPROFILER_SDK_DEPRECATED(
"rocprofiler_record_counter_t was renamed to rocprofiler_counter_record_t")
typedef rocprofiler_counter_record_t rocprofiler_record_counter_t;
/**
* @brief ROCProfiler SPM Record.
*
*/
typedef struct rocprofiler_spm_record_t
{
/**
* Counters, including identifiers to get counter information and Counters
* values
*/
rocprofiler_record_counter_t* counters;
uint64_t counters_count;
} rocprofiler_spm_record_t;
#if defined(ROCPROFILER_SDK_BETA_COMPAT) && ROCPROFILER_SDK_BETA_COMPAT > 0
// "profile_config" renamed to "counter_config"
@@ -34,6 +34,20 @@ ROCPROFILER_EXTERN_C_INIT
* @{
*/
/**
* @brief (experimental) ROCProfiler SPM Record.
*
*/
typedef struct ROCPROFILER_SDK_EXPERIMENTAL rocprofiler_spm_record_t
{
/**
* Counters, including identifiers to get counter information and Counters
* values
*/
rocprofiler_counter_record_t* counters;
uint64_t counters_count;
} rocprofiler_spm_record_t;
/**
* @brief Configure SPM Service.
*