/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roctracer-docs/checkouts/docs-5.0.0/inc/roctracer.h File Reference

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roctracer-docs/checkouts/docs-5.0.0/inc/roctracer.h File Reference#

ROC Tracer: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-roctracer-docs/checkouts/docs-5.0.0/inc/roctracer.h File Reference
roctracer.h File Reference
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <ext/prof_protocol.h>

Go to the source code of this file.

Data Structures

struct  roctracer_properties_t
 

Macros

#define ROCTRACER_VERSION_MAJOR   4
 
#define ROCTRACER_VERSION_MINOR   0
 

Typedefs

typedef activity_domain_t roctracer_domain_t
 
typedef activity_rtapi_callback_t roctracer_rtapi_callback_t
 
typedef activity_record_t roctracer_record_t
 
typedef void(* roctracer_allocator_t) (char **ptr, size_t size, void *arg)
 
typedef void(* roctracer_buffer_callback_t) (const char *begin, const char *end, void *arg)
 
typedef void roctracer_pool_t
 

Enumerations

enum  roctracer_status_t {
  ROCTRACER_STATUS_SUCCESS = 0 , ROCTRACER_STATUS_ERROR = 1 , ROCTRACER_STATUS_UNINIT = 2 , ROCTRACER_STATUS_BREAK = 3 ,
  ROCTRACER_STATUS_BAD_DOMAIN = 4 , ROCTRACER_STATUS_BAD_PARAMETER = 5 , ROCTRACER_STATUS_HIP_API_ERR = 6 , ROCTRACER_STATUS_HCC_OPS_ERR = 7 ,
  ROCTRACER_STATUS_HSA_ERR = 7 , ROCTRACER_STATUS_ROCTX_ERR = 8
}
 

Functions

uint32_t roctracer_version_major ()
 
uint32_t roctracer_version_minor ()
 
const char * roctracer_error_string ()
 
const char * roctracer_op_string (uint32_t domain, uint32_t op, uint32_t kind)
 
roctracer_status_t roctracer_op_code (uint32_t domain, const char *str, uint32_t *op, uint32_t *kind)
 
roctracer_status_t roctracer_enable_op_callback (activity_domain_t domain, uint32_t op, activity_rtapi_callback_t callback, void *arg)
 
roctracer_status_t roctracer_enable_domain_callback (activity_domain_t domain, activity_rtapi_callback_t callback, void *arg)
 
roctracer_status_t roctracer_enable_callback (activity_rtapi_callback_t callback, void *arg)
 
roctracer_status_t roctracer_disable_op_callback (activity_domain_t domain, uint32_t op)
 
roctracer_status_t roctracer_disable_domain_callback (activity_domain_t domain)
 
roctracer_status_t roctracer_disable_callback ()
 
roctracer_status_t roctracer_open_pool_expl (const roctracer_properties_t *properties, roctracer_pool_t **pool)
 
roctracer_status_t roctracer_close_pool_expl (roctracer_pool_t *pool)
 
roctracer_pool_troctracer_default_pool_expl (roctracer_pool_t *pool)
 
roctracer_status_t roctracer_enable_op_activity_expl (activity_domain_t domain, uint32_t op, roctracer_pool_t *pool)
 
roctracer_status_t roctracer_enable_domain_activity_expl (activity_domain_t domain, roctracer_pool_t *pool)
 
roctracer_status_t roctracer_enable_activity_expl (roctracer_pool_t *pool)
 
roctracer_status_t roctracer_disable_op_activity (activity_domain_t domain, uint32_t op)
 
roctracer_status_t roctracer_disable_domain_activity (activity_domain_t domain)
 
roctracer_status_t roctracer_disable_activity ()
 
roctracer_status_t roctracer_flush_activity_expl (roctracer_pool_t *pool)
 
roctracer_status_t roctracer_get_timestamp (uint64_t *timestamp)
 
bool roctracer_load ()
 
void roctracer_unload ()
 
void roctracer_flush_buf ()
 
roctracer_status_t roctracer_set_properties (roctracer_domain_t domain, void *propertes)
 

Macro Definition Documentation

◆ ROCTRACER_VERSION_MAJOR

#define ROCTRACER_VERSION_MAJOR   4

◆ ROCTRACER_VERSION_MINOR

#define ROCTRACER_VERSION_MINOR   0

Typedef Documentation

◆ roctracer_allocator_t

typedef void(* roctracer_allocator_t) (char **ptr, size_t size, void *arg)

◆ roctracer_buffer_callback_t

typedef void(* roctracer_buffer_callback_t) (const char *begin, const char *end, void *arg)

◆ roctracer_domain_t

typedef activity_domain_t roctracer_domain_t

◆ roctracer_pool_t

typedef void roctracer_pool_t

◆ roctracer_record_t

typedef activity_record_t roctracer_record_t

◆ roctracer_rtapi_callback_t

typedef activity_rtapi_callback_t roctracer_rtapi_callback_t

Enumeration Type Documentation

◆ roctracer_status_t

Enumerator
ROCTRACER_STATUS_SUCCESS 
ROCTRACER_STATUS_ERROR 
ROCTRACER_STATUS_UNINIT 
ROCTRACER_STATUS_BREAK 
ROCTRACER_STATUS_BAD_DOMAIN 
ROCTRACER_STATUS_BAD_PARAMETER 
ROCTRACER_STATUS_HIP_API_ERR 
ROCTRACER_STATUS_HCC_OPS_ERR 
ROCTRACER_STATUS_HSA_ERR 
ROCTRACER_STATUS_ROCTX_ERR 

Function Documentation

◆ roctracer_close_pool_expl()

roctracer_status_t roctracer_close_pool_expl ( roctracer_pool_t pool)

◆ roctracer_default_pool_expl()

roctracer_pool_t* roctracer_default_pool_expl ( roctracer_pool_t pool)

◆ roctracer_disable_activity()

roctracer_status_t roctracer_disable_activity ( )

◆ roctracer_disable_callback()

roctracer_status_t roctracer_disable_callback ( )

◆ roctracer_disable_domain_activity()

roctracer_status_t roctracer_disable_domain_activity ( activity_domain_t  domain)

◆ roctracer_disable_domain_callback()

roctracer_status_t roctracer_disable_domain_callback ( activity_domain_t  domain)

◆ roctracer_disable_op_activity()

roctracer_status_t roctracer_disable_op_activity ( activity_domain_t  domain,
uint32_t  op 
)

◆ roctracer_disable_op_callback()

roctracer_status_t roctracer_disable_op_callback ( activity_domain_t  domain,
uint32_t  op 
)

◆ roctracer_enable_activity_expl()

roctracer_status_t roctracer_enable_activity_expl ( roctracer_pool_t pool)

◆ roctracer_enable_callback()

roctracer_status_t roctracer_enable_callback ( activity_rtapi_callback_t  callback,
void *  arg 
)

◆ roctracer_enable_domain_activity_expl()

roctracer_status_t roctracer_enable_domain_activity_expl ( activity_domain_t  domain,
roctracer_pool_t pool 
)

◆ roctracer_enable_domain_callback()

roctracer_status_t roctracer_enable_domain_callback ( activity_domain_t  domain,
activity_rtapi_callback_t  callback,
void *  arg 
)

◆ roctracer_enable_op_activity_expl()

roctracer_status_t roctracer_enable_op_activity_expl ( activity_domain_t  domain,
uint32_t  op,
roctracer_pool_t pool 
)

◆ roctracer_enable_op_callback()

roctracer_status_t roctracer_enable_op_callback ( activity_domain_t  domain,
uint32_t  op,
activity_rtapi_callback_t  callback,
void *  arg 
)

◆ roctracer_error_string()

const char* roctracer_error_string ( )

◆ roctracer_flush_activity_expl()

roctracer_status_t roctracer_flush_activity_expl ( roctracer_pool_t pool)

◆ roctracer_flush_buf()

void roctracer_flush_buf ( )

◆ roctracer_get_timestamp()

roctracer_status_t roctracer_get_timestamp ( uint64_t *  timestamp)

◆ roctracer_load()

bool roctracer_load ( )

◆ roctracer_op_code()

roctracer_status_t roctracer_op_code ( uint32_t  domain,
const char *  str,
uint32_t *  op,
uint32_t *  kind 
)

◆ roctracer_op_string()

const char* roctracer_op_string ( uint32_t  domain,
uint32_t  op,
uint32_t  kind 
)

◆ roctracer_open_pool_expl()

roctracer_status_t roctracer_open_pool_expl ( const roctracer_properties_t properties,
roctracer_pool_t **  pool 
)

◆ roctracer_set_properties()

roctracer_status_t roctracer_set_properties ( roctracer_domain_t  domain,
void *  propertes 
)

◆ roctracer_unload()

void roctracer_unload ( )

◆ roctracer_version_major()

uint32_t roctracer_version_major ( )

◆ roctracer_version_minor()

uint32_t roctracer_version_minor ( )