Buffer tracing

Contents

Buffer tracing#

typedef int (*rocprofiler_buffer_tracing_kind_cb_t)(rocprofiler_buffer_tracing_kind_t kind, void *data)#

Callback function for mapping rocprofiler_buffer_tracing_kind_t ids to string names.

See also

rocprofiler_iterate_buffer_trace_kind_names.

typedef int (*rocprofiler_buffer_tracing_kind_operation_cb_t)(rocprofiler_buffer_tracing_kind_t kind, rocprofiler_tracing_operation_t operation, void *data)#

Callback function for mapping the operations of a given rocprofiler_buffer_tracing_kind_t to string names.

See also

rocprofiler_iterate_buffer_trace_kind_operation_names.

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)#

Callback function for iterating over the function arguments to a traced function. This function will be invoked for each argument.

See also

rocprofiler_iterate_buffer_tracing_record_args

Param kind:

[in] domain

Param operation:

[in] associated domain operation

Param arg_number:

[in] the argument number, starting at zero

Param arg_value_addr:

[in] the address of the argument stored by rocprofiler.

Param arg_indirection_count:

[in] the total number of indirection levels for the argument, e.g. int == 0, int* == 1, int** == 2

Param arg_type:

[in] the typeid name of the argument (not demangled)

Param arg_name:

[in] the name of the argument in the prototype (or rocprofiler union)

Param arg_value_str:

[in] conversion of the argument to a string, e.g. operator<< overload

Param data:

[in] user data

rocprofiler_status_t rocprofiler_configure_buffer_tracing_service(rocprofiler_context_id_t context_id, rocprofiler_buffer_tracing_kind_t kind, const rocprofiler_tracing_operation_t *operations, unsigned long operations_count, rocprofiler_buffer_id_t buffer_id)#

Configure Buffer Tracing Service.

Parameters:

  • context_id – [in] Associated context to control activation of service

  • kind – [in] Buffer tracing category

  • operations – [in] Array of specific operations (if desired)

  • operations_count – [in] Number of specific operations (if non-null set of operations)

  • buffer_id – [in] Buffer to store the records in

Return values:
Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_query_buffer_tracing_kind_name(rocprofiler_buffer_tracing_kind_t kind, const char **name, uint64_t *name_len)#

Query the name of the buffer tracing kind. The name retrieved from this function is a string literal that is encoded in the read-only section of the binary (i.e. it is always “allocated” and never “deallocated”).

Parameters:

  • kind – [in] Buffer tracing domain

  • name – [out] If non-null and the name is a constant string that does not require dynamic allocation, this paramter will be set to the address of the string literal, otherwise it will be set to nullptr

  • name_len – [out] If non-null, this will be assigned the length of the name (regardless of the name is a constant string or requires dynamic allocation)

Return values:

  • ROCPROFILER_STATUS_ERROR_KIND_NOT_FOUND – Returned if the domain id is not valid

  • ROCPROFILER_STATUS_SUCCESS – Returned if a valid domain, regardless if there is a constant string or not.

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_query_buffer_tracing_kind_operation_name(rocprofiler_buffer_tracing_kind_t kind, rocprofiler_tracing_operation_t operation, const char **name, uint64_t *name_len)#

Query the name of the buffer tracing kind. The name retrieved from this function is a string literal that is encoded in the read-only section of the binary (i.e. it is always “allocated” and never “deallocated”).

Parameters:

  • kind – [in] Buffer tracing domain

  • operation – [in] Enumeration id value which maps to a specific API function or event type

  • name – [out] If non-null and the name is a constant string that does not require dynamic allocation, this paramter will be set to the address of the string literal, otherwise it will be set to nullptr

  • name_len – [out] If non-null, this will be assigned the length of the name (regardless of the name is a constant string or requires dynamic allocation)

Return values:

  • ROCPROFILER_STATUS_ERROR_KIND_NOT_FOUND – An invalid domain id

  • ROCPROFILER_STATUS_ERROR_OPERATION_NOT_FOUND – The operation number is not recognized for the given domain

  • ROCPROFILER_STATUS_ERROR_NOT_IMPLEMENTED – Rocprofiler does not support providing the operation name within this domain

  • ROCPROFILER_STATUS_SUCCESS – Valid domain and operation, regardless of whether there is a constant string or not.

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_iterate_buffer_tracing_kinds(rocprofiler_buffer_tracing_kind_cb_t callback, void *data)#

Iterate over all the buffer tracing kinds and invokes the callback for each buffer tracing kind.

This is typically used to invoke rocprofiler_iterate_buffer_tracing_kind_operations for each buffer tracing kind.

Parameters:

  • callback – [in] Callback function invoked for each enumeration value in rocprofiler_buffer_tracing_kind_t with the exception of the NONE and LAST values.

  • data – [in] User data passed back into the callback

Returns:

rocprofiler_status_t

rocprofiler_status_t rocprofiler_iterate_buffer_tracing_kind_operations(rocprofiler_buffer_tracing_kind_t kind, rocprofiler_buffer_tracing_kind_operation_cb_t callback, void *data)#

Iterates over all the operations for a given rocprofiler_buffer_tracing_kind_t and invokes the callback with the kind and operation id. This is useful to build a map of the operation names during tool initialization instead of querying rocprofiler everytime in the callback hotpath.

Parameters:

  • kind – [in] which buffer tracing kind operations to iterate over

  • callback – [in] Callback function invoked for each operation associated with rocprofiler_buffer_tracing_kind_t with the exception of the NONE and LAST values.

  • data – [in] User data passed back into the callback

Returns:

rocprofiler_status_t

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)#
struct rocprofiler_buffer_tracing_hsa_api_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer HSA API Tracer Record.

struct rocprofiler_buffer_tracing_hip_api_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer HIP API Tracer Record.

struct rocprofiler_buffer_tracing_hip_api_ext_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer HIP API Tracer Record.

struct rocprofiler_buffer_tracing_ompt_target_t#
#include <rocprofiler-sdk/buffer_tracing.h>

Additional trace data for OpenMP target routines.

struct rocprofiler_buffer_tracing_ompt_target_data_op_t#
struct rocprofiler_buffer_tracing_ompt_target_kernel_t#
struct rocprofiler_buffer_tracing_ompt_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer OMPT Tracer Record.

struct rocprofiler_buffer_tracing_marker_api_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Marker Tracer Record.

struct rocprofiler_buffer_tracing_rccl_api_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer RCCL API Record.

struct rocprofiler_buffer_tracing_rocdecode_api_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer rocDecode API Record.

struct rocprofiler_buffer_tracing_rocdecode_api_ext_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

An extended ROCProfiler rocDecode API Tracer Record which includes function arguments. Pointers are not dereferenced.

struct rocprofiler_buffer_tracing_rocjpeg_api_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer rocJPEG API Record.

struct rocprofiler_buffer_tracing_memory_copy_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Memory Copy Tracer Record.

struct rocprofiler_buffer_tracing_memory_allocation_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Memory Allocation Tracer Record.

struct rocprofiler_buffer_tracing_kernel_dispatch_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Kernel Dispatch Tracer Record.

struct rocprofiler_buffer_tracing_kfd_event_page_migrate_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Page Migration event record from KFD.

struct rocprofiler_buffer_tracing_kfd_event_page_fault_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Page Fault event record from KFD.

struct rocprofiler_buffer_tracing_kfd_event_queue_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Queue event record from KFD.

struct rocprofiler_buffer_tracing_kfd_event_unmap_from_gpu_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Unmap of memory from GPU event record from KFD.

struct rocprofiler_buffer_tracing_kfd_event_dropped_events_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Dropped events event record, for when KFD reports that it has dropped some events.

struct rocprofiler_buffer_tracing_kfd_page_migrate_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Page Migration (paired) record from KFD.

struct rocprofiler_buffer_tracing_kfd_page_fault_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Page Fault (paired) record from KFD.

struct rocprofiler_buffer_tracing_kfd_queue_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Queue suspend (paired) record from KFD.

struct rocprofiler_buffer_tracing_scratch_memory_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Scratch Memory Tracer Record.

struct rocprofiler_buffer_tracing_correlation_id_retirement_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Correlation ID Retirement Tracer Record.

struct rocprofiler_buffer_tracing_runtime_initialization_record_t#
#include <rocprofiler-sdk/buffer_tracing.h>

ROCProfiler Buffer Runtime Initialization Tracer Record.

rocprofiler_buffer_tracing_ompt_record_t.__unnamed1__

Public Members

rocprofiler_buffer_tracing_ompt_target_t target#
rocprofiler_buffer_tracing_ompt_target_data_op_t target_data_op#
rocprofiler_buffer_tracing_ompt_target_kernel_t target_kernel#
uint64_t reserved[5]#
Contents