instrumentation.h

Go to the documentation of this file.

/*
 * Copyright 2023 Linaro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_INSTRUMENTATION_INSTRUMENTATION_H_
#define ZEPHYR_INCLUDE_INSTRUMENTATION_INSTRUMENTATION_H_
 
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !defined(__no_instrumentation__)
#error "No toolchain support for __no_instrumentation__"
#endif

enum instr_event_types {
        INSTR_EVENT_ENTRY = 0, 
        INSTR_EVENT_EXIT,       
        INSTR_EVENT_PROFILE, 
        INSTR_EVENT_SCHED_IN,       
        INSTR_EVENT_SCHED_OUT,     
        INSTR_EVENT_NUM, 
        INSTR_EVENT_INVALID  
} __packed;

struct instr_header {
        enum instr_event_types type;
} __packed;

struct instr_event_context {
        uint8_t mode: 3;
        uint8_t cpu: 5;
        void *thread_id;
#ifdef CONFIG_THREAD_NAME
        char thread_name[CONFIG_THREAD_MAX_NAME_LEN];
#endif
} __packed;

struct instr_record {
        struct instr_header header;
        void *callee;
        void *caller;
        uint64_t timestamp;
        union {
                struct instr_event_context context; /* Context data */
                /* Add more payloads here */
        };
} __packed;

bool instr_tracing_supported(void);

bool instr_profiling_supported(void);

bool instr_fundamentals_initialized(void);

int instr_init(void);

bool instr_initialized(void);

bool instr_enabled(void);

int instr_enable(void);

int instr_disable(void);

int instr_turn_on(void);

int instr_turn_off(void);

bool instr_turned_on(void);

bool instr_trace_enabled(void);

bool instr_profile_enabled(void);

void instr_dump_buffer_uart(void);

void instr_dump_deltas_uart(void);

void instr_event_handler(enum instr_event_types opcode, void *func, void *caller);

void instr_set_trigger_func(void *callee);

void instr_set_stop_func(void *callee);

void *instr_get_trigger_func(void);

void *instr_get_stop_func(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_INSTRUMENTATION_INSTRUMENTATION_H_ */