thread_analyzer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 - 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __STACK_SIZE_ANALYZER_H
#define __STACK_SIZE_ANALYZER_H
 
#include <stddef.h>
#include <zephyr/kernel/thread.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
struct thread_analyzer_info {
        const char *name;
        size_t stack_size;
        size_t stack_used;
 
#ifdef CONFIG_THREAD_RUNTIME_STATS
        unsigned int utilization;
#ifdef CONFIG_SCHED_THREAD_USAGE
        k_thread_runtime_stats_t  usage;
#endif
#endif
 
#ifdef CONFIG_THREAD_ANALYZER_STACK_SAFETY
        uint32_t stack_safety;
#endif
 
#ifdef CONFIG_THREAD_ANALYZER_PRIV_STACK_USAGE
        size_t priv_stack_size;

        size_t priv_stack_used;
#endif
};

 
/* No stack safety issues detected */
#define THREAD_ANALYZE_STACK_SAFETY_NO_ISSUES 0
 
/* Unused stack space is below the defined threshold */
#define THREAD_ANALYZE_STACK_SAFETY_THRESHOLD_EXCEEDED 1
 
/* No unused stack space is left */
#define THREAD_ANALYZE_STACK_SAFETY_AT_LIMIT 2
 
/* Stack overflow detected */
#define THREAD_ANALYZE_STACK_SAFETY_OVERFLOW 3

typedef void (*thread_analyzer_stack_safety_handler)(struct k_thread *thread,
                                                     size_t unused_space,
                                                     uint32_t *stack_issue);

void thread_analyzer_stack_safety_handler_set(thread_analyzer_stack_safety_handler handler);
 
 

typedef void (*thread_analyzer_cb)(struct thread_analyzer_info *info);

void thread_analyzer_run(thread_analyzer_cb cb, unsigned int cpu);

void thread_analyzer_print(unsigned int cpu);

 
#ifdef __cplusplus
}
#endif
 
#endif /* __STACK_SIZE_ANALYZER_H */