HW Counter Configurations

HW Counter Configurations#

ROCprofiler-SDK developer API: HW Counter Configurations
ROCprofiler-SDK developer API 1.1.0
ROCm Profiling API and tools
HW Counter Configurations

Group one or more hardware counters into a unique handle. More...

Functions

rocprofiler_status_t rocprofiler_create_counter_config (rocprofiler_agent_id_t agent_id, rocprofiler_counter_id_t *counters_list, unsigned long counters_count, rocprofiler_counter_config_id_t *config_id)
 (experimental) Create Counter Configuration. A config is bound to an agent but can be used across many contexts. The config has a fixed set of counters that are collected (and specified by counter_list). The available counters for an agent can be queried using rocprofiler_iterate_agent_supported_counters. An existing config may be supplied via config_id to use as a base for the new config. All counters in the existing config will be copied over to the new config. The existing config will remain unmodified and usable with the new config id being returned in config_id.
 
rocprofiler_status_t rocprofiler_destroy_counter_config (rocprofiler_counter_config_id_t config_id)
 (experimental) Destroy Profile Configuration.
 

Detailed Description

Group one or more hardware counters into a unique handle.

Function Documentation

◆ rocprofiler_create_counter_config()

rocprofiler_status_t rocprofiler_create_counter_config ( rocprofiler_agent_id_t  agent_id,
rocprofiler_counter_id_t counters_list,
unsigned long  counters_count,
rocprofiler_counter_config_id_t config_id 
)

#include <rocprofiler-sdk/counter_config.h>

(experimental) Create Counter Configuration. A config is bound to an agent but can be used across many contexts. The config has a fixed set of counters that are collected (and specified by counter_list). The available counters for an agent can be queried using rocprofiler_iterate_agent_supported_counters. An existing config may be supplied via config_id to use as a base for the new config. All counters in the existing config will be copied over to the new config. The existing config will remain unmodified and usable with the new config id being returned in config_id.

Parameters
[in]agent_idAgent identifier
[in]counters_listList of GPU counters
[in]counters_countSize of counters list
[in,out]config_idIdentifier for GPU counters group. If an existing config is supplied, that profiles counters will be copied over to a new config (returned via this id)
Returns
rocprofiler_status_t
Return values
ROCPROFILER_STATUS_SUCCESSif config created
ROCPROFILER_STATUS_ERRORif config could not be created

◆ rocprofiler_destroy_counter_config()

rocprofiler_status_t rocprofiler_destroy_counter_config ( rocprofiler_counter_config_id_t  config_id)

#include <rocprofiler-sdk/counter_config.h>

(experimental) Destroy Profile Configuration.

Parameters
[in]config_id
Returns
rocprofiler_status_t
Return values
ROCPROFILER_STATUS_SUCCESSif config destroyed
ROCPROFILER_STATUS_ERRORif config could not be destroyed