itrace
Instrumented Trace
Classes | Macros | Typedefs | Enumerations
itrace_types.h File Reference

Public itrace types. More...

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

Go to the source code of this file.

Classes

struct  itrace_event_t
 
struct  itrace_measured_events_t
 
struct  itrace_section_no_events_context_t
 
struct  itrace_section_context_t
 

Macros

#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_MAX_LENGTH_THREAD_NAME   64
 
#define ITRACE_DEFAULT_EVENTS_READER_PERIOD_DSP_US   1000
 
#define ITRACE_DEFAULT_EVENTS_READER_PERIOD_CPU_US   5000
 
#define ITRACE_MIN_EVENTS_READER_PERIOD_DSP_US   100
 
#define ITRACE_MIN_EVENTS_READER_PERIOD_v79_DSP_US   10
 
#define ITRACE_MIN_EVENTS_READER_PERIOD_CPU_US   100
 
#define ITRACE_DEFAULT_LOGS_FLUSHER_PERIOD_US   10000
 
#define ITRACE_MIN_LOGS_FLUSHER_PERIOD_US   1000
 
#define ITRACE_VERSION_MAJOR   8
 
#define ITRACE_VERSION_MINOR   4
 
#define ITRACE_SECURITY_VERSION_MAJOR   1
 
#define ITRACE_SECURITY_VERSION_MINOR   0
 
#define ITRACE_DEFAULT_ROOT_FILENAME   "/data/local/tmp/itrace_results/itrace_output"
 
#define ITRACE_DEFAULT_INPUT_FILENAME   "@itrace_config.txt"
 
#define ITRACE_MIN_LOG_SIZE   (64 * 8 * 1000) /* 64 events every 10 us and flushing every 10 ms */
 
#define ITRACE_MAX_STACK_DEPTH   32
 
#define ITRACE_BYPASS_PMU_ARBITRATION   -1
 
#define ITRACE_EVENT_UNINITIALIZED   0
 
#define ITRACE_NEW_EVENT_SET   -1
 
#define ITRACE_RETURN_TYPE_OFFSET   ITRACE_RET_FAILED
 
#define LOCAL_DOMAIN_ID   0x100
 
#define CPU_DOMAIN_ID   0x101
 
#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
 
#define ITRACE_NUMPY_FILE   0x40
 
#define ITRACE_DEFAULT_OUTPUT_TYPES   (ITRACE_JSON_FILE | ITRACE_CSV_FILE | ITRACE_FLAMEGRAPH_FILE | ITRACE_GPROF_FILE | ITRACE_GPROF_JSON_FILE)
 
#define ITRACE_ALL_OUTPUT_TYPES   0xFFFF
 
#define ITRACE_PM_DEFAULT   0
 
#define ITRACE_PM_RAW   1
 
#define ITRACE_PM_DELTA   2
 
#define ITRACE_PM_NORMALIZED   3
 
#define ITRACE_PM_STID_FILTERING   0x10
 
#define ITRACE_STID_DISABLED   0
 
#define ITRACE_STID_PROCESS   0x8001
 
#define CONFIG_IDENTIFIER_COMMENT   "#"
 
#define CONFIG_IDENTIFIER_COMMENT_ALTERNATE   " "
 
#define CONFIG_IDENTIFIER_LOG_SIZE   "LOG_SIZE:"
 
#define CONFIG_IDENTIFIER_DOMAIN   "DOMAIN:"
 
#define CONFIG_IDENTIFIER_OUTPUT_TYPE   "OUTPUT_TYPE:"
 
#define CONFIG_IDENTIFIER_PERIOD_EVENT_READER_US   "PERIOD_EVENT_READER_US:"
 
#define CONFIG_IDENTIFIER_PERIOD_LOG_FLUSHER_US   "PERIOD_LOG_FLUSHER_US:"
 
#define CONFIG_IDENTIFIER_ROOT_FILENAME   "ROOT_FILENAME:"
 
#define CONFIG_IDENTIFIER_MIN_NUMBER_REGISTERED_PMUS   "MIN_NUMBER_REGISTERED_PMUS:"
 
#define CONFIG_IDENTIFIER_MAX_NUMBER_REGISTERED_PMUS   "MAX_NUMBER_REGISTERED_PMUS:"
 
#define CONFIG_IDENTIFIER_PMU_REGISTRATION_TIMEOUT_US   "PMU_REGISTRATION_TIMEOUT_US:"
 
#define CONFIG_IDENTIFIER_NEW_EVENT_SET   "NEW_EVENT_SET"
 
#define CONFIG_IDENTIFIER_RAW_EVENT_ID_PREFIX   "0x"
 
#define CONFIG_IDENTIFIER_OUTPUT_PREFIX   "0x"
 

Typedefs

typedef uint64_t itrace_section_id_t
 
typedef void * itrace_logger_handle_t
 
typedef void * itrace_profiler_handle_t
 
typedef uint32_t itrace_processing_mode_t
 
typedef uint32_t itrace_stid_t
 
typedef itrace_return_t(* itrace_open_logger_t) (int domain, itrace_logger_handle_t *logger_handle_ptr)
 
typedef itrace_return_t(* itrace_remote_open_t) (itrace_logger_handle_t *logger_handle_ptr, int is_blocking_call)
 
typedef itrace_return_t(* itrace_remote_close_t) (void)
 
typedef itrace_return_t(* itrace_close_logger_t) (itrace_logger_handle_t logger_handle)
 
typedef itrace_return_t(* itrace_set_root_filename_t) (itrace_logger_handle_t logger_handle, const char *root_filename)
 
typedef itrace_return_t(* itrace_get_root_filename_t) (itrace_logger_handle_t logger_handle, char *root_filename)
 
typedef itrace_return_t(* itrace_flush_logs_t) (itrace_logger_handle_t logger_handle)
 
typedef itrace_return_t(* itrace_close_files_t) (itrace_logger_handle_t logger_handle)
 
typedef itrace_return_t(* itrace_set_target_files_t) (itrace_logger_handle_t logger_handle, uint32_t file_types)
 
typedef itrace_return_t(* itrace_open_profiler_t) (itrace_logger_handle_t logger_handle, uint32_t domain, size_t log_size, itrace_profiler_handle_t *profiler_handle_ptr)
 
typedef itrace_return_t(* itrace_close_profiler_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_add_event_t) (itrace_profiler_handle_t profiler_handle, itrace_event_t event)
 
typedef itrace_return_t(* itrace_add_event_by_id_t) (itrace_profiler_handle_t profiler_handle, uint32_t event_id)
 
typedef itrace_return_t(* itrace_add_events_t) (itrace_profiler_handle_t profiler_handle, itrace_event_t *events, int num_events)
 
typedef itrace_return_t(* itrace_add_events_from_file_t) (itrace_profiler_handle_t profiler_handle, const char *events_filename)
 
typedef itrace_return_t(* itrace_add_all_pmu_events_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_remove_all_events_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_register_events_t) (itrace_profiler_handle_t profiler_handle, itrace_event_t *attempted_to_register_events, int *num_attempted_to_register_events)
 
typedef itrace_return_t(* itrace_get_num_events_left_to_register_t) (itrace_profiler_handle_t profiler_handle, int *num_events_left_to_register)
 
typedef itrace_return_t(* itrace_get_registered_events_t) (itrace_profiler_handle_t profiler_handle, itrace_event_t *registered_events, int *num_registered_events)
 
typedef itrace_return_t(* itrace_set_processing_mode_t) (itrace_profiler_handle_t profiler_handle, itrace_processing_mode_t processing_mode)
 
typedef itrace_return_t(* itrace_deregister_events_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_start_section_t) (itrace_profiler_handle_t profiler_handle, const char *section_name, itrace_measured_events_t *measured_events)
 
typedef itrace_return_t(* itrace_start_section_with_section_id_t) (itrace_profiler_handle_t profiler_handle, itrace_section_id_t section_id, itrace_measured_events_t *measured_events)
 
typedef itrace_return_t(* itrace_end_section_t) (itrace_profiler_handle_t profiler_handle, itrace_measured_events_t *measured_events)
 
typedef itrace_return_t(* itrace_read_events_t) (itrace_profiler_handle_t profiler_handle, itrace_measured_events_t *measured_events)
 
typedef itrace_return_t(* itrace_add_marker_t) (itrace_profiler_handle_t profiler_handle, const char *marker_name)
 
typedef itrace_return_t(* itrace_start_periodic_events_reader_t) (itrace_profiler_handle_t profiler_handle, uint32_t events_reader_period_us, uint32_t thread_priority)
 
typedef itrace_return_t(* itrace_end_periodic_events_reader_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_start_periodic_logs_flusher_t) (itrace_logger_handle_t logger_handle, uint32_t flushing_period_us)
 
typedef itrace_return_t(* itrace_end_periodic_logs_flusher_t) (itrace_logger_handle_t logger_handle)
 
typedef itrace_return_t(* itrace_setup_from_file_t) (itrace_logger_handle_t *logger_handle_ptr, const char *setup_filename)
 
typedef itrace_return_t(* itrace_teardown_t) (itrace_logger_handle_t logger_handle)
 
typedef itrace_return_t(* itrace_flush_log_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_set_default_profiler_t) (itrace_profiler_handle_t profiler_handle)
 
typedef itrace_return_t(* itrace_get_dsp_version_t) (itrace_profiler_handle_t profiler_handle, char *dsp_version)
 
typedef itrace_return_t(* itrace_get_domain_t) (itrace_profiler_handle_t profiler_handle, uint32_t *domain_id)
 
typedef itrace_return_t(* itrace_get_itrace_version_t) (itrace_profiler_handle_t profiler_handle, uint32_t *version)
 
typedef itrace_return_t(* itrace_configure_pmu_policy_t) (itrace_profiler_handle_t profiler_handle, uint32_t min_num_pmu_events_to_register, uint32_t max_num_pmu_events_to_register, uint32_t pmu_registration_timeout_us)
 
typedef itrace_return_t(* itrace_register_thread_t) (itrace_profiler_handle_t profiler_handle, const char *thread_name)
 

Enumerations

enum  itrace_return_t {
  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_EVENTS_FAILED_TO_REGISTER, ITRACE_RET_OUT_OF_ORDER_EVENTS_REGISTRATION,
  ITRACE_RET_REGISTRATION_TIMEOUT
}
 
enum  itrace_registration_status_t { ITRACE_RS_NOT_REGISTERED_YET, ITRACE_RS_REGISTERED, ITRACE_RS_INVALID_EVENT, ITRACE_RS_FAILED_REGISTRATION }
 

Detailed Description

Public itrace types.

=============================================================================

Note: This file is automatically generated.

Copyright (c) 2024 Qualcomm Technologies Incorporated.

All Rights Reserved. Qualcomm Proprietary and Confidential.