rocprofiler-sdk/external_correlation.h Source File#
Rocprofiler SDK Developer API 0.6.0
ROCm Profiling API and tools
|
external_correlation.h
Go to the documentation of this file.
32 * @brief User-defined correlation identifiers to supplement rocprofiler generated correlation ids
42 * correlation IDs. Typically, rocprofiler-sdk uses the most recent external correlation ID on the
43 * current thread set via ::rocprofiler_push_external_correlation_id; however, this approach can be
45 * ::ROCPROFILER_CALLBACK_PHASE_ENTER callback or if relevant external correlation IDs are desired
48 * overhead for those who only need these callbacks for, say, kernel dispatches while the HSA API is
49 * being traced (i.e. lots of callbacks for HSA API functions). The enumeration below is provided to
50 * ensure that tools can default to using the external correlation IDs set via the push/pop methods
84 * ::ROCPROFILER_BUFFER_TRACING_HSA_CORE_API, the data/record for `hsa_init` will have an operation
87 * @param [out] external_corr_id_value Set this value to the desired external correlation ID value
93 * correlation ID value and the thread-local value for the most recently pushed external correlation
110 * this parameter is null, all tracing operations will invoke the callback to request an external
120 * @retval ::ROCPROFILER_STATUS_ERROR_CONTEXT_NOT_FOUND The provided context is not valid/registered
134 * @brief Push default value for `external` field in @ref rocprofiler_correlation_id_t onto stack.
136 * External correlation ids are thread-local values. However, if rocprofiler internally requests an
137 * external correlation id on a non-main thread and an external correlation id has not been pushed
138 * for this thread, the external correlation ID will default to the latest external correlation id
140 * thread for, say, the MPI rank or process-wide UUID and this value will be used by all subsequent
158 * @brief Pop default value for `external` field in @ref rocprofiler_correlation_id_t off of stack
int32_t rocprofiler_tracing_operation_t
Tracing Operation ID. Depending on the kind, operations can be determined. If the value is equal to z...
Definition fwd.h:475
uint64_t rocprofiler_thread_id_t
Thread ID. Value will be equivalent to syscall(__NR_gettid)
Definition fwd.h:466
rocprofiler_status_t rocprofiler_configure_external_correlation_id_request_service(rocprofiler_context_id_t context_id, const rocprofiler_external_correlation_id_request_kind_t *kinds, unsigned long kinds_count, rocprofiler_external_correlation_id_request_cb_t callback, void *callback_args)
Configure External Correlation ID Request Service.
rocprofiler_status_t rocprofiler_push_external_correlation_id(rocprofiler_context_id_t context, rocprofiler_thread_id_t tid, rocprofiler_user_data_t external_correlation_id)
Push default value for external field in rocprofiler_correlation_id_t onto stack.
int(* rocprofiler_external_correlation_id_request_cb_t)(rocprofiler_thread_id_t thread_id, rocprofiler_context_id_t context_id, rocprofiler_external_correlation_id_request_kind_t kind, rocprofiler_tracing_operation_t operation, uint64_t internal_corr_id_value, rocprofiler_user_data_t *external_corr_id_value, void *data)
Callback requesting a value for the external correlation id.
Definition external_correlation.h:96
rocprofiler_status_t rocprofiler_pop_external_correlation_id(rocprofiler_context_id_t context, rocprofiler_thread_id_t tid, rocprofiler_user_data_t *external_correlation_id)
Pop default value for external field in rocprofiler_correlation_id_t off of stack.
rocprofiler_external_correlation_id_request_kind_t
ROCProfiler External Correlation ID Operations.
Definition external_correlation.h:55
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_LAST
Definition external_correlation.h:72
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_SCRATCH_MEMORY
Definition external_correlation.h:68
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MARKER_NAME_API
Definition external_correlation.h:65
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_HSA_FINALIZE_EXT_API
Definition external_correlation.h:60
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_HIP_RUNTIME_API
Definition external_correlation.h:61
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MEMORY_COPY
Definition external_correlation.h:66
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MARKER_CORE_API
Definition external_correlation.h:63
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_RCCL_API
Definition external_correlation.h:69
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_KERNEL_DISPATCH
Definition external_correlation.h:67
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_HSA_IMAGE_EXT_API
Definition external_correlation.h:59
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MARKER_CONTROL_API
Definition external_correlation.h:64
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_HSA_CORE_API
Definition external_correlation.h:57
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_OMPT
Definition external_correlation.h:70
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_HIP_COMPILER_API
Definition external_correlation.h:62
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_HSA_AMD_EXT_API
Definition external_correlation.h:58
@ ROCPROFILER_EXTERNAL_CORRELATION_REQUEST_MEMORY_ALLOCATION
Definition external_correlation.h:71
Generated by 1.9.8