stackchk.h File Reference

This header file provides the Stack Checker API. More...

#include <rtems.h>
#include <rtems/print.h>

Go to the source code of this file.

Data Structures
struct	rtems_stack_checker_info
	Stack information provided by the stack checker. More...

Macros
#define	RTEMS_STACK_CHECKER_EXTENSION
	Stack Checker Extension Set Definition.

Typedefs
typedef void(*	rtems_stack_checker_visitor) (const rtems_stack_checker_info *info, void *arg)
	Visitor routines invoked by rtems_stack_checker_iterate() shall have this type.
typedef void(*	Stack_checker_Reporter_handler) (const rtems_tcb *running, bool pattern_ok)
	The Stack Checker Reporter Initialization Handler.

Functions
bool	rtems_stack_checker_is_blown (void)
	Checks if current task is blown its stack.
void	rtems_stack_checker_report_usage (void)
	Print the stack usage report using printk.
void	rtems_stack_checker_report_usage_with_plugin (const rtems_printer *printer)
	Print the stack usage report using caller's routine.
void	rtems_stack_checker_iterate (rtems_stack_checker_visitor visit, void *arg)
	Iterates over all stacks used by the system and invokes the visitor routine for each stack.
bool	rtems_stack_checker_create_extension (rtems_tcb *running, rtems_tcb *the_thread)
	Stack Checker Task Create Extension.
void	rtems_stack_checker_begin_extension (rtems_tcb *executing)
void	rtems_stack_checker_switch_extension (rtems_tcb *running, rtems_tcb *heir)
	Stack Checker Task Context Switch Extension.
void	rtems_stack_checker_reporter_quiet (const rtems_tcb *running, bool pattern_ok)
	A Quiet Version of Stack Checker Reporter.
void	rtems_stack_checker_reporter_print_details (const rtems_tcb *running, bool pattern_ok)
	The Default Function to Report a Blown Stack.

Variables
const Stack_checker_Reporter_handler	Stack_checker_Reporter
	The Stack Checker Reporter Initialization Handler.

Detailed Description

This header file provides the Stack Checker API.