Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Module for analyzing threads More...

Data Structures

struct  thread_analyzer_info
 

Typedefs

typedef void(* thread_analyzer_cb) (struct thread_analyzer_info *info)
 Thread analyzer stack size callback function.
 

Functions

void thread_analyzer_run (thread_analyzer_cb cb, unsigned int cpu)
 Run the thread analyzer and provide information to the callback.
 
void thread_analyzer_print (unsigned int cpu)
 Run the thread analyzer and print stack size statistics.
 

Detailed Description

Module for analyzing threads

This module implements functions and the configuration that simplifies thread analysis.

Typedef Documentation

◆ thread_analyzer_cb

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

#include <zephyr/debug/thread_analyzer.h>

Thread analyzer stack size callback function.

Callback function with thread analysis information.

Parameters
infoThread analysis information.

Function Documentation

◆ thread_analyzer_print()

void thread_analyzer_print ( unsigned int cpu)

#include <zephyr/debug/thread_analyzer.h>

Run the thread analyzer and print stack size statistics.

This function runs the thread analyzer and prints the output in standard form. In the special case when Kconfig option THREAD_ANALYZER_AUTO_SEPARATE_CORES is set, the function analyzes only the threads running on the specified cpu.

Parameters
cpucpu to analyze, ignored if THREAD_ANALYZER_AUTO_SEPARATE_CORES=n

◆ thread_analyzer_run()

void thread_analyzer_run ( thread_analyzer_cb cb,
unsigned int cpu )

#include <zephyr/debug/thread_analyzer.h>

Run the thread analyzer and provide information to the callback.

This function analyzes the current state for all threads and calls a given callback on every thread found. In the special case when Kconfig option THREAD_ANALYZER_AUTO_SEPARATE_CORES is set, the function analyzes only the threads running on the specified cpu.

Parameters
cbThe callback function handler
cpucpu to analyze, ignored if THREAD_ANALYZER_AUTO_SEPARATE_CORES=n