Go to the documentation of this file.
43 #if !defined(ROCTRACER_CALL)
44 #define ROCTRACER_CALL
47 #if !defined(ROCTRACER_EXPORT_DECORATOR)
49 #define ROCTRACER_EXPORT_DECORATOR __attribute__((visibility("default")))
50 #elif defined(_MSC_VER)
51 #define ROCTRACER_EXPORT_DECORATOR __declspec(dllexport)
55 #if !defined(ROCTRACER_IMPORT_DECORATOR)
57 #define ROCTRACER_IMPORT_DECORATOR
58 #elif defined(_MSC_VER)
59 #define ROCTRACER_IMPORT_DECORATOR __declspec(dllimport)
63 #define ROCTRACER_EXPORT ROCTRACER_EXPORT_DECORATOR ROCTRACER_CALL
64 #define ROCTRACER_IMPORT ROCTRACER_IMPORT_DECORATOR ROCTRACER_CALL
66 #if !defined(ROCTRACER)
67 #if defined(ROCTRACER_EXPORTS)
68 #define ROCTRACER_API ROCTRACER_EXPORT
70 #define ROCTRACER_API ROCTRACER_IMPORT
77 #include <ext/prof_protocol.h>
102 #define ROCTRACER_VERSION_4_1
123 #define ROCTRACER_VERSION_MAJOR 4
129 #define ROCTRACER_VERSION_MINOR 1
354 activity_rtapi_callback_t callback,
ROCTRACER_API roctracer_status_t roctracer_enable_op_activity(activity_domain_t domain, uint32_t op) ROCTRACER_VERSION_4_1
Enable activity record logging for a specified operation of a domain using the default memory pool.
ROCTRACER_API roctracer_status_t roctracer_open_pool_expl(const roctracer_properties_t *properties, roctracer_pool_t **pool) ROCTRACER_VERSION_4_1
Create tracer memory pool.
@ ROCTRACER_STATUS_BREAK
Deprecated error code.
Definition: roctracer.h:201
ROCTRACER_API roctracer_status_t roctracer_flush_activity() ROCTRACER_VERSION_4_1
Flush available activity records for the default memory pool.
ROCTRACER_API uint32_t roctracer_version_minor() ROCTRACER_VERSION_4_1
Query the minor version of the installed library.
void(* roctracer_allocator_t)(char **ptr, size_t size, void *arg)
Memory pool allocator callback.
Definition: roctracer.h:483
void * buffer_callback_arg
The argument to pass when invoking the buffer_callback_fun callback.
Definition: roctracer.h:534
@ ROCTRACER_STATUS_HSA_ERR
Deprecated error code.
Definition: roctracer.h:225
ROCTRACER_API uint32_t roctracer_version_major() ROCTRACER_VERSION_4_1
Query the major version of the installed library.
ROCTRACER_API const char * roctracer_error_string() ROCTRACER_VERSION_4_1
Query the textual description of the last error for the current thread.
ROCTRACER_API roctracer_status_t roctracer_disable_op_callback(activity_domain_t domain, uint32_t op) ROCTRACER_VERSION_4_1
Disable runtime API callback for a specific operation of a domain.
#define ROCTRACER_API
Definition: roctracer.h:70
ROCTRACER_API roctracer_status_t roctracer_disable_domain_callback(activity_domain_t domain) ROCTRACER_VERSION_4_1
Disable runtime API callback for all operations of a domain.
ROCTRACER_API roctracer_status_t roctracer_enable_activity() ROCTRACER_VERSION_4_1
Enable activity record logging for all operations of all domains using the default memory pool.
roctracer_allocator_t alloc_fun
The allocator function to use to allocate and deallocate the buffer.
Definition: roctracer.h:519
@ ROCTRACER_STATUS_ERROR_INVALID_DOMAIN_ID
The domain ID is invalid.
Definition: roctracer.h:173
@ ROCTRACER_STATUS_HCC_OPS_ERR
Deprecated error code.
Definition: roctracer.h:221
ROCTRACER_API roctracer_status_t roctracer_enable_activity_expl(roctracer_pool_t *pool) ROCTRACER_VERSION_4_1
Enable activity record logging for all operations of all domains providing a memory pool.
ROCTRACER_API roctracer_status_t roctracer_close_pool() ROCTRACER_VERSION_4_1
Close default tracer memory pool, if defined, and set to undefined.
void * alloc_arg
The argument to pass when invoking the alloc_fun allocator.
Definition: roctracer.h:524
activity_rtapi_callback_t roctracer_rtapi_callback_t
Runtime API callback type.
Definition: roctracer.h:331
roctracer_status_t
ROC Tracer API status codes.
Definition: roctracer.h:161
@ ROCTRACER_STATUS_HIP_OPS_ERR
Deprecated error code.
Definition: roctracer.h:217
ROCTRACER_API roctracer_status_t roctracer_enable_op_callback(activity_domain_t domain, uint32_t op, activity_rtapi_callback_t callback, void *arg) ROCTRACER_VERSION_4_1
Enable runtime API callback for a specific operation of a domain.
ROCTRACER_API roctracer_status_t roctracer_flush_activity_expl(roctracer_pool_t *pool) ROCTRACER_VERSION_4_1
Flush available activity records for a memory pool.
ROCTRACER_API roctracer_status_t roctracer_enable_domain_callback(activity_domain_t domain, activity_rtapi_callback_t callback, void *arg) ROCTRACER_VERSION_4_1
Enable runtime API callback for all operations of a domain.
@ ROCTRACER_STATUS_ERROR_DEFAULT_POOL_ALREADY_DEFINED
The default pool is already defined.
Definition: roctracer.h:185
@ ROCTRACER_STATUS_ROCTX_ERR
Deprecated error code.
Definition: roctracer.h:229
ROCTRACER_API roctracer_status_t roctracer_next_record(const activity_record_t *record, const activity_record_t **next) ROCTRACER_VERSION_4_1
Get a pointer to the next activity record.
@ ROCTRACER_STATUS_SUCCESS
The function has executed successfully.
Definition: roctracer.h:165
#define ROCTRACER_VERSION_4_1
The function was introduced in version 4.1 of the interface and has the symbol version string of "ROC...
Definition: roctracer.h:102
size_t buffer_size
Size of buffer in bytes.
Definition: roctracer.h:513
ROCTRACER_API roctracer_status_t roctracer_enable_callback(activity_rtapi_callback_t callback, void *arg) ROCTRACER_VERSION_4_1
Enable runtime API callback for all operations of all domains.
ROCTRACER_API roctracer_status_t roctracer_set_properties(roctracer_domain_t domain, void *properties) ROCTRACER_VERSION_4_1
Set the properties of a domain.
ROCTRACER_API roctracer_pool_t * roctracer_default_pool() ROCTRACER_VERSION_4_1
Query the current default memory pool.
ROCTRACER_API roctracer_status_t roctracer_enable_domain_activity(activity_domain_t domain) ROCTRACER_VERSION_4_1
Enable activity record logging for all operations of a domain using the default memory pool.
@ ROCTRACER_STATUS_ERROR
A generic error has occurred.
Definition: roctracer.h:169
activity_record_t roctracer_record_t
Activity record.
Definition: roctracer.h:445
ROCTRACER_API roctracer_status_t roctracer_get_timestamp(roctracer_timestamp_t *timestamp) ROCTRACER_VERSION_4_1
Get the system clock timestamp.
@ ROCTRACER_STATUS_BAD_PARAMETER
Deprecated error code.
Definition: roctracer.h:209
ROCTRACER_API roctracer_status_t roctracer_disable_activity() ROCTRACER_VERSION_4_1
Disable activity record logging for all operations of all domains.
@ ROCTRACER_STATUS_ERROR_DEFAULT_POOL_UNDEFINED
No default pool is defined.
Definition: roctracer.h:181
ROCTRACER_API roctracer_status_t roctracer_close_pool_expl(roctracer_pool_t *pool) ROCTRACER_VERSION_4_1
Close tracer memory pool.
void(* roctracer_buffer_callback_t)(const char *begin, const char *end, void *arg)
Memory pool buffer callback.
Definition: roctracer.h:497
@ ROCTRACER_STATUS_ERROR_INVALID_ARGUMENT
An invalid argument was given to the function.
Definition: roctracer.h:177
@ ROCTRACER_STATUS_ERROR_MEMORY_ALLOCATION
Memory allocation error.
Definition: roctracer.h:189
ROCTRACER_API roctracer_status_t roctracer_enable_op_activity_expl(activity_domain_t domain, uint32_t op, roctracer_pool_t *pool) ROCTRACER_VERSION_4_1
Enable activity record logging for a specified operation of a domain providing a memory pool.
roctracer_buffer_callback_t buffer_callback_fun
The function to call when a buffer becomes full or is flushed.
Definition: roctracer.h:529
uint32_t mode
ROC Tracer mode.
Definition: roctracer.h:508
ROCTRACER_API roctracer_status_t roctracer_disable_op_activity(activity_domain_t domain, uint32_t op) ROCTRACER_VERSION_4_1
Disable activity record logging for a specified operation of a domain.
ROCTRACER_API roctracer_status_t roctracer_enable_domain_activity_expl(activity_domain_t domain, roctracer_pool_t *pool) ROCTRACER_VERSION_4_1
Enable activity record logging for all operations of a domain providing a memory pool.
@ ROCTRACER_STATUS_BAD_DOMAIN
Deprecated error code.
Definition: roctracer.h:205
ROCTRACER_API roctracer_status_t roctracer_disable_callback() ROCTRACER_VERSION_4_1
Disable runtime API callback for all operations of all domains.
ROCTRACER_API roctracer_status_t roctracer_disable_domain_activity(activity_domain_t domain) ROCTRACER_VERSION_4_1
Disable activity record logging for all operations of a domain.
@ ROCTRACER_STATUS_ERROR_MISMATCHED_EXTERNAL_CORRELATION_ID
External correlation ID pop mismatch.
Definition: roctracer.h:193
ROCTRACER_API roctracer_status_t roctracer_op_code(uint32_t domain, const char *str, uint32_t *op, uint32_t *kind) ROCTRACER_VERSION_4_1
Query the operation code given a domain and the name of an operation.
Memory pool properties.
Definition: roctracer.h:504
ROCTRACER_API roctracer_pool_t * roctracer_default_pool_expl(roctracer_pool_t *pool) ROCTRACER_VERSION_4_1
Query and set the default memory pool.
ROCTRACER_API roctracer_status_t roctracer_open_pool(const roctracer_properties_t *properties) ROCTRACER_VERSION_4_1
Create tracer memory pool.
ROCTRACER_API const char * roctracer_op_string(uint32_t domain, uint32_t op, uint32_t kind) ROCTRACER_VERSION_4_1
Query textual name of an operation of a domain.
@ ROCTRACER_STATUS_UNINIT
Deprecated error code.
Definition: roctracer.h:197
@ ROCTRACER_STATUS_HIP_API_ERR
Deprecated error code.
Definition: roctracer.h:213
activity_domain_t roctracer_domain_t
Enumeration of domains that can be traced.
Definition: roctracer.h:258
void roctracer_pool_t
Tracer memory pool type.
Definition: roctracer.h:540