itrace.h

Go to the documentation of this file.

#ifndef ITRACE_H
#define ITRACE_H
#include "itrace_types.h"
#include "itrace_utils.h"
#ifndef DISABLE_ITRACE

#ifdef __cplusplus
extern "C" {
#endif


itrace_return_t itrace_open_logger(int domain, itrace_logger_handle_t* logger_handle_ptr);

itrace_return_t itrace_remote_open(itrace_logger_handle_t* logger_handle_ptr, int is_blocking_call);

itrace_return_t itrace_remote_close(void);


itrace_return_t itrace_close_logger(itrace_logger_handle_t logger_handle);

itrace_return_t itrace_set_root_filename(itrace_logger_handle_t logger_handle, const char* root_filename);

itrace_return_t itrace_get_root_filename(itrace_logger_handle_t logger_handle, char* root_filename);

itrace_return_t itrace_flush_logs(itrace_logger_handle_t logger_handle);

itrace_return_t itrace_close_files(itrace_logger_handle_t logger_handle);

itrace_return_t itrace_set_target_files(itrace_logger_handle_t logger_handle, uint32_t file_types);


itrace_return_t itrace_open_profiler(itrace_logger_handle_t logger_handle, uint32_t domain, size_t log_size, itrace_profiler_handle_t* profiler_handle_ptr);

itrace_return_t itrace_close_profiler(itrace_profiler_handle_t profiler_handle);

itrace_return_t itrace_add_event(itrace_profiler_handle_t profiler_handle, itrace_event_t* event);

itrace_return_t itrace_add_event_by_id(itrace_profiler_handle_t profiler_handle, uint32_t event_id);

itrace_return_t itrace_add_events(itrace_profiler_handle_t profiler_handle, itrace_event_t* events, int num_events);

itrace_return_t itrace_add_events_from_file(itrace_profiler_handle_t profiler_handle, const char* events_filename);

itrace_return_t itrace_add_all_pmu_events(itrace_profiler_handle_t profiler_handle);

itrace_return_t itrace_remove_all_events(itrace_profiler_handle_t profiler_handle);

#ifndef DISABLE_ITRACE_EVENTS

itrace_return_t itrace_register_events(itrace_profiler_handle_t profiler_handle, itrace_event_t* attempted_to_register_events, int* num_attempted_to_register_events);

itrace_return_t itrace_deregister_events(itrace_profiler_handle_t profiler_handle);

#endif // DISABLE_ITRACE_EVENTS

itrace_return_t itrace_get_num_events_left_to_register(itrace_profiler_handle_t profiler_handle, int* num_events_left_to_register);

itrace_return_t itrace_get_registered_events(itrace_profiler_handle_t profiler_handle, itrace_event_t* registered_events, int* num_registered_events);

itrace_return_t itrace_set_processing_mode(itrace_profiler_handle_t profiler_handle, itrace_processing_mode_t processing_mode);

itrace_return_t itrace_set_stid(itrace_profiler_handle_t profiler_handle, itrace_stid_t* stid);

void itrace_start_section_no_events(itrace_section_id_t section_id);

void itrace_end_section_no_events(void);

#ifndef DISABLE_ITRACE_EVENTS

itrace_return_t itrace_start_section(itrace_profiler_handle_t profiler_handle, const char* section_name, itrace_measured_events_t* measured_events);

itrace_return_t itrace_start_section_with_section_id(itrace_profiler_handle_t profiler_handle, itrace_section_id_t section_id, itrace_measured_events_t* measured_events);

itrace_return_t itrace_end_section(itrace_profiler_handle_t profiler_handle, itrace_measured_events_t* measured_events);

#else  // DISABLE_ITRACE_EVENTS

static inline itrace_return_t itrace_start_section(itrace_profiler_handle_t profiler_handle, const char* section_name, itrace_measured_events_t* measured_events) {
    // Use char address as a simple way of generating a (likely) unique section_id
    // Mask with 0xff to make fingerprints shorter and thus more readable
    itrace_start_section_no_events(0xff&(itrace_section_id_t)(section_name));
    return ITRACE_RET_SUCCESS;
}

static inline itrace_return_t itrace_start_section_with_section_id(itrace_profiler_handle_t profiler_handle, itrace_section_id_t section_id, itrace_measured_events_t* measured_events) {
    itrace_start_section_no_events(section_id);
    return ITRACE_RET_SUCCESS;
}

static inline itrace_return_t itrace_end_section(itrace_profiler_handle_t profiler_handle, itrace_measured_events_t* measured_events) {
    itrace_end_section_no_events();
    return ITRACE_RET_SUCCESS;
}

#endif // DISABLE_ITRACE_EVENTS

itrace_return_t itrace_read_events(itrace_profiler_handle_t profiler_handle, itrace_measured_events_t* measured_events);

#ifndef DISABLE_ITRACE_MARKERS

itrace_return_t itrace_add_marker(itrace_profiler_handle_t profiler_handle, const char* marker_name);
#endif  // DISABLE_ITRACE_MARKERS

itrace_return_t itrace_start_periodic_events_reader(itrace_profiler_handle_t profiler_handle, uint32_t events_reader_period_us, uint32_t thread_priority);

itrace_return_t itrace_end_periodic_events_reader(itrace_profiler_handle_t profiler_handle);

itrace_return_t itrace_start_periodic_logs_flusher(itrace_logger_handle_t logger_handle, uint32_t flushing_period_us);

itrace_return_t itrace_end_periodic_logs_flusher(itrace_logger_handle_t logger_handle);

itrace_return_t itrace_setup_from_file(itrace_logger_handle_t* logger_handle_ptr, const char* setup_filename);

itrace_return_t itrace_teardown(itrace_logger_handle_t logger_handle);

itrace_return_t itrace_flush_log(itrace_profiler_handle_t profiler_handle);

itrace_return_t itrace_set_default_profiler(itrace_profiler_handle_t profiler_handle);

itrace_return_t itrace_get_dsp_version(itrace_profiler_handle_t profiler_handle, char* dsp_version);

itrace_return_t itrace_get_domain(itrace_profiler_handle_t profiler_handle, uint32_t* domain_id);

itrace_return_t itrace_get_itrace_version(itrace_profiler_handle_t profiler_handle, uint32_t* version);

itrace_return_t itrace_configure_pmu_policy(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);

itrace_return_t itrace_register_thread(itrace_profiler_handle_t profiler_handle, const char* thread_name);


// Function only needed internally for multi-pass macros
void itrace_merge_csv_files(char *file_name,int num_files);

#define ITRACE_START_SECTION_WITH_CONTEXT_NO_EVENTS(itrace_section_id_param) \
    itrace_section_no_events_context_t itrace_section_no_events_context; \
    itrace_section_id_t itrace_section_id = itrace_section_id_param; \
    itrace_start_section_with_context_no_events(&itrace_section_no_events_context);

#define ITRACE_END_SECTION_WITH_CONTEXT_NO_EVENTS() itrace_end_section_with_context_no_events(itrace_section_id, &itrace_section_no_events_context);

#ifndef DISABLE_ITRACE_EVENTS

#define ITRACE_START_SECTION_WITH_CONTEXT(itrace_section_id_param) \
    itrace_section_context_t itrace_section_context; \
    itrace_section_id_t itrace_section_id = itrace_section_id_param; \
    itrace_start_section_with_context(&itrace_section_context);

#define ITRACE_END_SECTION_WITH_CONTEXT() itrace_end_section_with_context(itrace_section_id, &itrace_section_context);

#endif // DISABLE_ITRACE_EVENTS

#define ITRACE_START_SECTION_WITH_CONTEXT_NO_EVENTS_MSPS(itrace_section_id_param) \
    itrace_section_no_events_context_t itrace_section_no_events_context_##itrace_section_id_param; \
    itrace_section_id_t itrace_section_id_##itrace_section_id_param = itrace_section_id_param; \
    itrace_start_section_with_context_no_events(&itrace_section_no_events_context_##itrace_section_id_param);

#define ITRACE_END_SECTION_WITH_CONTEXT_NO_EVENTS_MSPS(itrace_section_id_param) itrace_end_section_with_context_no_events(itrace_section_id_##itrace_section_id_param, &itrace_section_no_events_context_##itrace_section_id_param);

#ifndef DISABLE_ITRACE_EVENTS

#define ITRACE_START_SECTION_WITH_CONTEXT_MSPS(itrace_section_id_param) \
    itrace_section_context_t itrace_section_context_##itrace_section_id_param; \
    itrace_section_id_t itrace_section_id_##itrace_section_id_param = itrace_section_id_param; \
    itrace_start_section_with_context(&itrace_section_context_##itrace_section_id_param);

#define ITRACE_END_SECTION_WITH_CONTEXT_MSPS(itrace_section_id_param) itrace_end_section_with_context(itrace_section_id_##itrace_section_id_param, &itrace_section_context_##itrace_section_id_param);

#endif // DISABLE_ITRACE_EVENTS

#ifdef __cplusplus
}

#define ITRACE_MONITOR_FUNCTION_NO_EVENTS_CPP(...) \
  static bool itrace_is_first_function_occurrence = true; \
  itrace_section_id_t itrace_function_section_id = (itrace_section_id_t) &itrace_is_first_function_occurrence; \
  auto itrace_function_profiler = itrace_is_message_registration_needed(itrace_function_section_id) ? make_itrace_function_profiler<false>(itrace_function_section_id, __FUNCSIG__, ## __VA_ARGS__) : make_itrace_function_profiler<false>(itrace_function_section_id, ## __VA_ARGS__); \
  itrace_is_first_function_occurrence = false;

#define ITRACE_MONITOR_FUNCTION_CPP(...) \
  static bool itrace_is_first_function_occurrence = true; \
  itrace_section_id_t itrace_function_section_id = (itrace_section_id_t) &itrace_is_first_function_occurrence; \
  auto itrace_function_profiler = itrace_is_message_registration_needed(itrace_function_section_id) ? make_itrace_function_profiler<true>(itrace_function_section_id, __FUNCSIG__, ## __VA_ARGS__) : make_itrace_function_profiler<true>(itrace_function_section_id, ## __VA_ARGS__); \
  itrace_is_first_function_occurrence = false;

#define ITRACE_MONITOR_SCOPE_NO_EVENTS_CPP(name, ...) \
  static bool itrace_is_first_scope_occurrence = true; \
  itrace_section_id_t itrace_scope_section_id = (itrace_section_id_t) &itrace_is_first_scope_occurrence; \
  auto itrace_scope_profiler = itrace_is_message_registration_needed(itrace_scope_section_id) ? make_itrace_function_profiler<false>(itrace_scope_section_id, #name, ## __VA_ARGS__) : make_itrace_function_profiler<false>(itrace_scope_section_id, ## __VA_ARGS__); \
  itrace_is_first_scope_occurrence = false;

#define ITRACE_MONITOR_SCOPE_CPP(name, ...) \
  static bool itrace_is_first_scope_occurrence = true; \
  itrace_section_id_t itrace_scope_section_id = (itrace_section_id_t) &itrace_is_first_scope_occurrence; \
  auto itrace_scope_profiler = itrace_is_message_registration_needed(itrace_scope_section_id) ? make_itrace_function_profiler<true>(itrace_scope_section_id, #name, ## __VA_ARGS__) : make_itrace_function_profiler<true>(itrace_scope_section_id, ## __VA_ARGS__); \
  itrace_is_first_scope_occurrence = false;

#define ITRACE_START_SECTION_CPP(name, ...) \
  static bool itrace_is_first_section_occurrence = true; \
  itrace_section_id_t itrace_section_id = (itrace_section_id_t) &itrace_is_first_section_occurrence; \
  auto itrace_section_profiler = itrace_is_message_registration_needed(itrace_section_id) ? make_itrace_function_profiler<true>(itrace_section_id, #name, ## __VA_ARGS__) : make_itrace_function_profiler<true>(itrace_section_id, ## __VA_ARGS__); \
  itrace_is_first_section_occurrence = false;

#define ITRACE_END_SECTION_CPP() \
    itrace_section_profiler.reset();

#define ITRACE_START_SECTION_MSPS_CPP(name, ...) \
  static bool itrace_is_first_section_occurrence_##name = true; \
  itrace_section_id_t itrace_section_id_##name = (itrace_section_id_t) &itrace_is_first_section_occurrence_##name; \
  auto itrace_section_profiler_##name = itrace_is_message_registration_needed(itrace_section_id_##name) ? make_itrace_function_profiler<true>(itrace_section_id_##name, #name, ## __VA_ARGS__) : make_itrace_function_profiler<true>(itrace_section_id_##name, ## __VA_ARGS__); \
  itrace_is_first_section_occurrence_##name = false;

#define ITRACE_END_SECTION_MSPS_CPP(name) \
    itrace_section_profiler_##name.reset();

#ifndef DISABLE_ITRACE_MARKERS

#define ITRACE_ADD_MARKER_WITH_VARIABLES_CPP(table_name, ...) \
{ \
    static bool itrace_is_first_variable_dump = true; \
    itrace_add_marker_with_variables(itrace_is_first_variable_dump, #table_name, ## __VA_ARGS__); \
}
#endif // DISABLE_ITRACE_MARKERS

#endif // __cplusplus

#endif // DISABLE_ITRACE

#endif // ITRACE_H