itrace_types.h

Go to the documentation of this file.

#ifndef ITRACE_TYPES_H
#define ITRACE_TYPES_H

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

#ifdef __cplusplus
extern "C" {
#endif

#define ITRACE_MAX_NUMBER_REGISTERED_EVENTS 40

#define ITRACE_MAX_NUMBER_EVENTS_TO_REGISTER 2056

#define ITRACE_MAX_NUMBER_SET_TO_REGISTER 512

#define ITRACE_MAX_NUMBER_REGISTERED_DERIVED_METRICS 4

#define ITRACE_MAX_LENGTH_FILENAME 512

#define ITRACE_MAX_LENGTH_DSP_VERSION 3

#define ITRACE_MAX_LENGTH_SECTION_NAME 64

#define ITRACE_DEFAULT_SAMPLER_PERIOD_DSP_US 1000

#define ITRACE_DEFAULT_SAMPLER_PERIOD_CPU_US 5000

#define ITRACE_MIN_SAMPLER_PERIOD_DSP_US 500

#define ITRACE_MIN_SAMPLER_PERIOD_CPU_US 1500

#define ITRACE_VERSION_MAJOR 5

#define ITRACE_VERSION_MINOR 2

#define ITRACE_SECURITY_VERSION_MAJOR 1

#define ITRACE_SECURITY_VERSION_MINOR 0

#define ITRACE_DEFAULT_ROOT_FILENAME "itrace_results/itrace_output"

#define ITRACE_DEFAULT_INPUT_FILENAME "itrace_config.txt"

#define ITRACE_MIN_LOG_SIZE 1024


#ifdef __hexagon__

typedef uint32_t section_id_t;
#else

typedef uint64_t section_id_t;
#endif

#define ITRACE_EVENT_UNINITIALIZED 0

#define ITRACE_NEW_EVENT_SET -1

// Undocumented. Used by event header files
#define CONCAT_HELPER(PREFIX,NAME)    PREFIX##NAME
#define CONCAT_PREFIX(PREFIX,NAME)    CONCAT_HELPER(PREFIX,NAME)

typedef enum {
    ITRACE_RET_SUCCESS=0,    
    ITRACE_RET_FAILED=0xa0000000,    
    ITRACE_RET_NO_MEMORY,    
    ITRACE_RET_UNSUPPORTED,    
    ITRACE_RET_REMOTE_ERR,    
    ITRACE_RET_BAD_PARAM,    
    ITRACE_RET_FILE_ERR,    
    ITRACE_RET_BAD_STATE,    
    ITRACE_RET_LOG_OVERFLOW,    
    ITRACE_RET_EVENT_SET_OVERFLOW,    
    ITRACE_RET_INVALID_EVENTS,    
    ITRACE_RET_EVENT_REGISTRATION_FAILED,    
    ITRACE_RET_OUT_OF_ORDER_EVENTS_REGISTRATION,    
} itrace_return_t;

#define ITRACE_RETURN_TYPE_OFFSET    ITRACE_RET_FAILED

#define ITRACE_RETURN_TYPE_TO_IDX(type)     (type-ITRACE_RETURN_TYPE_OFFSET)

#define LOCAL_DOMAIN_ID 0x100

#define CPU_DOMAIN_ID 0x101

typedef void* itrace_logger_handle_t;

typedef void* itrace_profiler_handle_t;

#define ITRACE_JSON_FILE 0x1

#define ITRACE_CSV_FILE   0x2

#define ITRACE_FLAMEGRAPH_FILE   0x4

#define ITRACE_GPROF_FILE   0x8

#define ITRACE_PROTOBUF_FILE   0x10

#define ITRACE_GPROF_JSON_FILE 0x20

typedef enum {
    ITRACE_PM_DEFAULT,    
    ITRACE_PM_RAW,        
    ITRACE_PM_DELTA,      
    ITRACE_PM_NORMALIZED  
} itrace_processing_mode_t;

typedef enum {
    ITRACE_RS_NOT_REGISTERED_YET,         
    ITRACE_RS_REGISTERED,                 
    ITRACE_RS_INVALID_EVENT,              
    ITRACE_RS_FAILED_REGISTRATION         
} itrace_registration_status_t;

typedef struct {
    uint32_t event_id;                              
    itrace_processing_mode_t processing_mode;       
    uint64_t (*client_method)(void* client_handle); 
    void* client_handle;                            
    itrace_registration_status_t status;            
    uint32_t is_disabled;                           
} itrace_event_t;

typedef struct {
    uint64_t values[ITRACE_MAX_NUMBER_REGISTERED_EVENTS];     
    int num_values;                                     
} itrace_measured_events_t;

#ifdef __cplusplus
}
#endif


#endif