docs-6.3.1/source/lib/rocprof-sys-user/rocprofiler-systems/categories.h File Reference

docs-6.3.1/source/lib/rocprof-sys-user/rocprofiler-systems/categories.h File Reference#

rocprofiler-systems: docs-6.3.1/source/lib/rocprof-sys-user/rocprofiler-systems/categories.h File Reference

#include <stddef.h>
#include <stdint.h>

Classes
struct	rocprofsys_annotation
	A struct containing annotation data to be included in the perfetto trace. More...

Typedefs
typedef enum ROCPROFSYS_CATEGORIES	rocprofsys_category_t
	Identifier for categories. More...

typedef enum ROCPROFSYS_ANNOTATION_TYPE	rocprofsys_annotation_type_t

typedef struct rocprofsys_annotation	rocprofsys_annotation_t

Enumerations
enum	ROCPROFSYS_CATEGORIES { ROCPROFSYS_CATEGORY_NONE = 0 , ROCPROFSYS_CATEGORY_PYTHON , ROCPROFSYS_CATEGORY_USER , ROCPROFSYS_CATEGORY_HOST , ROCPROFSYS_CATEGORY_DEVICE_HIP , ROCPROFSYS_CATEGORY_DEVICE_HSA , ROCPROFSYS_CATEGORY_ROCM_HIP , ROCPROFSYS_CATEGORY_ROCM_HSA , ROCPROFSYS_CATEGORY_ROCM_ROCTX , ROCPROFSYS_CATEGORY_ROCM_SMI , ROCPROFSYS_CATEGORY_ROCM_SMI_BUSY , ROCPROFSYS_CATEGORY_ROCM_SMI_TEMP , ROCPROFSYS_CATEGORY_ROCM_SMI_POWER , ROCPROFSYS_CATEGORY_ROCM_SMI_MEMORY_USAGE , ROCPROFSYS_CATEGORY_ROCM_RCCL , ROCPROFSYS_CATEGORY_ROCTRACER , ROCPROFSYS_CATEGORY_ROCPROFILER , ROCPROFSYS_CATEGORY_SAMPLING , ROCPROFSYS_CATEGORY_PTHREAD , ROCPROFSYS_CATEGORY_KOKKOS , ROCPROFSYS_CATEGORY_MPI , ROCPROFSYS_CATEGORY_OMPT , ROCPROFSYS_CATEGORY_PROCESS_SAMPLING , ROCPROFSYS_CATEGORY_COMM_DATA , ROCPROFSYS_CATEGORY_CAUSAL , ROCPROFSYS_CATEGORY_CPU_FREQ , ROCPROFSYS_CATEGORY_PROCESS_PAGE , ROCPROFSYS_CATEGORY_PROCESS_VIRT , ROCPROFSYS_CATEGORY_PROCESS_PEAK , ROCPROFSYS_CATEGORY_PROCESS_CONTEXT_SWITCH , ROCPROFSYS_CATEGORY_PROCESS_PAGE_FAULT , ROCPROFSYS_CATEGORY_PROCESS_USER_MODE_TIME , ROCPROFSYS_CATEGORY_PROCESS_KERNEL_MODE_TIME , ROCPROFSYS_CATEGORY_THREAD_WALL_TIME , ROCPROFSYS_CATEGORY_THREAD_CPU_TIME , ROCPROFSYS_CATEGORY_THREAD_PAGE_FAULT , ROCPROFSYS_CATEGORY_THREAD_PEAK_MEMORY , ROCPROFSYS_CATEGORY_THREAD_CONTEXT_SWITCH , ROCPROFSYS_CATEGORY_THREAD_HARDWARE_COUNTER , ROCPROFSYS_CATEGORY_KERNEL_HARDWARE_COUNTER , ROCPROFSYS_CATEGORY_NUMA , ROCPROFSYS_CATEGORY_TIMER_SAMPLING , ROCPROFSYS_CATEGORY_OVERFLOW_SAMPLING , ROCPROFSYS_CATEGORY_LAST }

enum	ROCPROFSYS_ANNOTATION_TYPE { ROCPROFSYS_VALUE_NONE = 0 , ROCPROFSYS_VALUE_CSTR = 1 , ROCPROFSYS_STRING = ROCPROFSYS_VALUE_CSTR , ROCPROFSYS_VALUE_SIZE_T = 2 , ROCPROFSYS_SIZE_T = ROCPROFSYS_VALUE_SIZE_T , ROCPROFSYS_VALUE_INT64 = 3 , ROCPROFSYS_INT64 = ROCPROFSYS_VALUE_INT64 , ROCPROFSYS_I64 = ROCPROFSYS_VALUE_INT64 , ROCPROFSYS_VALUE_UINT64 = 4 , ROCPROFSYS_UINT64 = ROCPROFSYS_VALUE_UINT64 , ROCPROFSYS_U64 = ROCPROFSYS_VALUE_UINT64 , ROCPROFSYS_VALUE_FLOAT64 = 5 , ROCPROFSYS_FLOAT64 = ROCPROFSYS_VALUE_FLOAT64 , ROCPROFSYS_FP64 = ROCPROFSYS_VALUE_FLOAT64 , ROCPROFSYS_VALUE_VOID_P = 6 , ROCPROFSYS_VOID_P = ROCPROFSYS_VALUE_VOID_P , ROCPROFSYS_PTR = ROCPROFSYS_VALUE_VOID_P , ROCPROFSYS_VALUE_INT32 = 7 , ROCPROFSYS_INT32 = ROCPROFSYS_VALUE_INT32 , ROCPROFSYS_I32 = ROCPROFSYS_VALUE_INT32 , ROCPROFSYS_VALUE_UINT32 = 8 , ROCPROFSYS_UINT32 = ROCPROFSYS_VALUE_UINT32 , ROCPROFSYS_U32 = ROCPROFSYS_VALUE_UINT32 , ROCPROFSYS_VALUE_FLOAT32 = 9 , ROCPROFSYS_FLOAT32 = ROCPROFSYS_VALUE_FLOAT32 , ROCPROFSYS_FP32 = ROCPROFSYS_VALUE_FLOAT32 , ROCPROFSYS_VALUE_INT16 = 10 , ROCPROFSYS_INT16 = ROCPROFSYS_VALUE_INT16 , ROCPROFSYS_I16 = ROCPROFSYS_VALUE_INT16 , ROCPROFSYS_VALUE_UINT16 = 11 , ROCPROFSYS_UINT16 = ROCPROFSYS_VALUE_UINT16 , ROCPROFSYS_U16 = ROCPROFSYS_VALUE_UINT16 , ROCPROFSYS_VALUE_LAST }
	Identifier for the data type of the annotation. if the data type is not a pointer, pass the address of data. More...

Class Documentation

◆ rocprofsys_annotation

struct rocprofsys_annotation

A struct containing annotation data to be included in the perfetto trace.

#include <cstddef>
#include <cstdint>
 
double
compute_residual(size_t n, double* data);
 
double
compute(size_t n, double* data, size_t nitr, double tolerance)
{
    rocprofsys_annotation_t _annotations[] = {
        { "iteration", ROCPROFSYS_VALUE_SIZE_T, nullptr },
        { "residual", ROCPROFSYS_VALUE_FLOAT64, nullptr },
        { "data", ROCPROFSYS_VALUE_PTR, data },
        { "size", ROCPROFSYS_VALUE_SIZE_T, &n },
        { "tolerance", ROCPROFSYS_VALUE_FLOAT64, &tolerance },
        nullptr
    };
 
    double residual = tolerance;
    for(size_t i = 0; i < nitr; ++i)
    {
        rocprofsys_user_push_annotated_region("compute", &_annotations);
 
        residual = compute_residual(n, data);
 
        _annotations[0].value = &i;
        _annotations[1].value = &residual;
        rocprofsys_user_pop_annotated_region("compute", &_annotations);
    }
 
    return residual;
}

Definition at line 177 of file categories.h.

Class Members
const char *	name	label for annotation
unsigned long	type	rocprofsys_annotation_type_t
void *	value	data to annotate

Typedef Documentation

◆ rocprofsys_annotation_t

rocprofsys_annotation rocprofsys_annotation_t

◆ rocprofsys_annotation_type_t

ROCPROFSYS_ANNOTATION_TYPE rocprofsys_annotation_type_t

◆ rocprofsys_category_t

rocprofsys_category_t

Identifier for categories.

Enumeration Type Documentation

◆ ROCPROFSYS_ANNOTATION_TYPE

enum ROCPROFSYS_ANNOTATION_TYPE

Identifier for the data type of the annotation. if the data type is not a pointer, pass the address of data.

Enumerator
ROCPROFSYS_VALUE_NONE
ROCPROFSYS_VALUE_CSTR
ROCPROFSYS_STRING
ROCPROFSYS_VALUE_SIZE_T
ROCPROFSYS_SIZE_T
ROCPROFSYS_VALUE_INT64
ROCPROFSYS_INT64
ROCPROFSYS_I64
ROCPROFSYS_VALUE_UINT64
ROCPROFSYS_UINT64
ROCPROFSYS_U64
ROCPROFSYS_VALUE_FLOAT64
ROCPROFSYS_FLOAT64
ROCPROFSYS_FP64
ROCPROFSYS_VALUE_VOID_P
ROCPROFSYS_VOID_P
ROCPROFSYS_PTR
ROCPROFSYS_VALUE_INT32
ROCPROFSYS_INT32
ROCPROFSYS_I32
ROCPROFSYS_VALUE_UINT32
ROCPROFSYS_UINT32
ROCPROFSYS_U32
ROCPROFSYS_VALUE_FLOAT32
ROCPROFSYS_FLOAT32
ROCPROFSYS_FP32
ROCPROFSYS_VALUE_INT16
ROCPROFSYS_INT16
ROCPROFSYS_I16
ROCPROFSYS_VALUE_UINT16
ROCPROFSYS_UINT16
ROCPROFSYS_U16
ROCPROFSYS_VALUE_LAST

Definition at line 96 of file categories.h.

     {
         // Do not use first enum value
         ROCPROFSYS_VALUE_NONE = 0,
         // arrange these in the order most likely to
         // be used since they have to be iterated over
         ROCPROFSYS_VALUE_CSTR    = 1,
         ROCPROFSYS_STRING        = ROCPROFSYS_VALUE_CSTR,
         ROCPROFSYS_VALUE_SIZE_T  = 2,
         ROCPROFSYS_SIZE_T        = ROCPROFSYS_VALUE_SIZE_T,
         ROCPROFSYS_VALUE_INT64   = 3,
         ROCPROFSYS_INT64         = ROCPROFSYS_VALUE_INT64,
         ROCPROFSYS_I64           = ROCPROFSYS_VALUE_INT64,
         ROCPROFSYS_VALUE_UINT64  = 4,
         ROCPROFSYS_UINT64        = ROCPROFSYS_VALUE_UINT64,
         ROCPROFSYS_U64           = ROCPROFSYS_VALUE_UINT64,
         ROCPROFSYS_VALUE_FLOAT64 = 5,
         ROCPROFSYS_FLOAT64       = ROCPROFSYS_VALUE_FLOAT64,
         ROCPROFSYS_FP64          = ROCPROFSYS_VALUE_FLOAT64,
         ROCPROFSYS_VALUE_VOID_P  = 6,
         ROCPROFSYS_VOID_P        = ROCPROFSYS_VALUE_VOID_P,
         ROCPROFSYS_PTR           = ROCPROFSYS_VALUE_VOID_P,
         ROCPROFSYS_VALUE_INT32   = 7,
         ROCPROFSYS_INT32         = ROCPROFSYS_VALUE_INT32,
         ROCPROFSYS_I32           = ROCPROFSYS_VALUE_INT32,
         ROCPROFSYS_VALUE_UINT32  = 8,
         ROCPROFSYS_UINT32        = ROCPROFSYS_VALUE_UINT32,
         ROCPROFSYS_U32           = ROCPROFSYS_VALUE_UINT32,
         ROCPROFSYS_VALUE_FLOAT32 = 9,
         ROCPROFSYS_FLOAT32       = ROCPROFSYS_VALUE_FLOAT32,
         ROCPROFSYS_FP32          = ROCPROFSYS_VALUE_FLOAT32,
         ROCPROFSYS_VALUE_INT16   = 10,
         ROCPROFSYS_INT16         = ROCPROFSYS_VALUE_INT16,
         ROCPROFSYS_I16           = ROCPROFSYS_VALUE_INT16,
         ROCPROFSYS_VALUE_UINT16  = 11,
         ROCPROFSYS_UINT16        = ROCPROFSYS_VALUE_UINT16,
         ROCPROFSYS_U16           = ROCPROFSYS_VALUE_UINT16,
         // the value of below enum is used for iterating
         // over the enum in C++ templates. It MUST
         // be the last enumerated id
         ROCPROFSYS_VALUE_LAST
     } rocprofsys_annotation_type_t;

◆ ROCPROFSYS_CATEGORIES

enum ROCPROFSYS_CATEGORIES

Enumerator
ROCPROFSYS_CATEGORY_NONE
ROCPROFSYS_CATEGORY_PYTHON
ROCPROFSYS_CATEGORY_USER
ROCPROFSYS_CATEGORY_HOST
ROCPROFSYS_CATEGORY_DEVICE_HIP
ROCPROFSYS_CATEGORY_DEVICE_HSA
ROCPROFSYS_CATEGORY_ROCM_HIP
ROCPROFSYS_CATEGORY_ROCM_HSA
ROCPROFSYS_CATEGORY_ROCM_ROCTX
ROCPROFSYS_CATEGORY_ROCM_SMI
ROCPROFSYS_CATEGORY_ROCM_SMI_BUSY
ROCPROFSYS_CATEGORY_ROCM_SMI_TEMP
ROCPROFSYS_CATEGORY_ROCM_SMI_POWER
ROCPROFSYS_CATEGORY_ROCM_SMI_MEMORY_USAGE
ROCPROFSYS_CATEGORY_ROCM_RCCL
ROCPROFSYS_CATEGORY_ROCTRACER
ROCPROFSYS_CATEGORY_ROCPROFILER
ROCPROFSYS_CATEGORY_SAMPLING
ROCPROFSYS_CATEGORY_PTHREAD
ROCPROFSYS_CATEGORY_KOKKOS
ROCPROFSYS_CATEGORY_MPI
ROCPROFSYS_CATEGORY_OMPT
ROCPROFSYS_CATEGORY_PROCESS_SAMPLING
ROCPROFSYS_CATEGORY_COMM_DATA
ROCPROFSYS_CATEGORY_CAUSAL
ROCPROFSYS_CATEGORY_CPU_FREQ
ROCPROFSYS_CATEGORY_PROCESS_PAGE
ROCPROFSYS_CATEGORY_PROCESS_VIRT
ROCPROFSYS_CATEGORY_PROCESS_PEAK
ROCPROFSYS_CATEGORY_PROCESS_CONTEXT_SWITCH
ROCPROFSYS_CATEGORY_PROCESS_PAGE_FAULT
ROCPROFSYS_CATEGORY_PROCESS_USER_MODE_TIME
ROCPROFSYS_CATEGORY_PROCESS_KERNEL_MODE_TIME
ROCPROFSYS_CATEGORY_THREAD_WALL_TIME
ROCPROFSYS_CATEGORY_THREAD_CPU_TIME
ROCPROFSYS_CATEGORY_THREAD_PAGE_FAULT
ROCPROFSYS_CATEGORY_THREAD_PEAK_MEMORY
ROCPROFSYS_CATEGORY_THREAD_CONTEXT_SWITCH
ROCPROFSYS_CATEGORY_THREAD_HARDWARE_COUNTER
ROCPROFSYS_CATEGORY_KERNEL_HARDWARE_COUNTER
ROCPROFSYS_CATEGORY_NUMA
ROCPROFSYS_CATEGORY_TIMER_SAMPLING
ROCPROFSYS_CATEGORY_OVERFLOW_SAMPLING
ROCPROFSYS_CATEGORY_LAST

Definition at line 37 of file categories.h.

     {
         // Do not use first enum value
         ROCPROFSYS_CATEGORY_NONE = 0,
         // arrange these in the order most likely to
         // be used since they have to be iterated over
         ROCPROFSYS_CATEGORY_PYTHON,
         ROCPROFSYS_CATEGORY_USER,
         ROCPROFSYS_CATEGORY_HOST,
         ROCPROFSYS_CATEGORY_DEVICE_HIP,
         ROCPROFSYS_CATEGORY_DEVICE_HSA,
         ROCPROFSYS_CATEGORY_ROCM_HIP,
         ROCPROFSYS_CATEGORY_ROCM_HSA,
         ROCPROFSYS_CATEGORY_ROCM_ROCTX,
         ROCPROFSYS_CATEGORY_ROCM_SMI,
         ROCPROFSYS_CATEGORY_ROCM_SMI_BUSY,
         ROCPROFSYS_CATEGORY_ROCM_SMI_TEMP,
         ROCPROFSYS_CATEGORY_ROCM_SMI_POWER,
         ROCPROFSYS_CATEGORY_ROCM_SMI_MEMORY_USAGE,
         ROCPROFSYS_CATEGORY_ROCM_RCCL,
         ROCPROFSYS_CATEGORY_ROCTRACER,
         ROCPROFSYS_CATEGORY_ROCPROFILER,
         ROCPROFSYS_CATEGORY_SAMPLING,
         ROCPROFSYS_CATEGORY_PTHREAD,
         ROCPROFSYS_CATEGORY_KOKKOS,
         ROCPROFSYS_CATEGORY_MPI,
         ROCPROFSYS_CATEGORY_OMPT,
         ROCPROFSYS_CATEGORY_PROCESS_SAMPLING,
         ROCPROFSYS_CATEGORY_COMM_DATA,
         ROCPROFSYS_CATEGORY_CAUSAL,
         ROCPROFSYS_CATEGORY_CPU_FREQ,
         ROCPROFSYS_CATEGORY_PROCESS_PAGE,
         ROCPROFSYS_CATEGORY_PROCESS_VIRT,
         ROCPROFSYS_CATEGORY_PROCESS_PEAK,
         ROCPROFSYS_CATEGORY_PROCESS_CONTEXT_SWITCH,
         ROCPROFSYS_CATEGORY_PROCESS_PAGE_FAULT,
         ROCPROFSYS_CATEGORY_PROCESS_USER_MODE_TIME,
         ROCPROFSYS_CATEGORY_PROCESS_KERNEL_MODE_TIME,
         ROCPROFSYS_CATEGORY_THREAD_WALL_TIME,
         ROCPROFSYS_CATEGORY_THREAD_CPU_TIME,
         ROCPROFSYS_CATEGORY_THREAD_PAGE_FAULT,
         ROCPROFSYS_CATEGORY_THREAD_PEAK_MEMORY,
         ROCPROFSYS_CATEGORY_THREAD_CONTEXT_SWITCH,
         ROCPROFSYS_CATEGORY_THREAD_HARDWARE_COUNTER,
         ROCPROFSYS_CATEGORY_KERNEL_HARDWARE_COUNTER,
         ROCPROFSYS_CATEGORY_NUMA,
         ROCPROFSYS_CATEGORY_TIMER_SAMPLING,
         ROCPROFSYS_CATEGORY_OVERFLOW_SAMPLING,
         ROCPROFSYS_CATEGORY_LAST
         // the value of below enum is used for iterating
         // over the enum in C++ templates. It MUST
         // be the last enumerated id
     } rocprofsys_category_t;