Stack Checker Mechanism

Stack Checker Information. More...

Files
file	check.c
	Stack Overflow Check User Extension SetNOTE: This extension set automatically determines at initialization time whether the stack for this CPU grows up or down and installs the correct extension routines for that direction.

Macros
#define	RTEMS_STACK_CHECKER_EXTENSION
	Stack Checker Extension Set Definition. More...

Functions
bool	rtems_stack_checker_is_blown (void)
	Checks if current task is blown its stack. More...
void	rtems_stack_checker_report_usage (void)
	Print the stack usage report using printk. More...
void	rtems_stack_checker_report_usage_with_plugin (void *context, rtems_printk_plugin_t print)
	Print the stack usage report using caller's routine. More...
bool	rtems_stack_checker_create_extension (Thread_Control *running, Thread_Control *the_thread)
	Stack Checker Task Create Extension. More...
void	rtems_stack_checker_begin_extension (Thread_Control *the_thread)
	Stack Checker Task Begin Extension. More...
void	rtems_stack_checker_switch_extension (Thread_Control *running, Thread_Control *heir)
	Stack Checker Task Context Switch Extension. More...

Detailed Description

Stack Checker Information.

This include file contains information necessary to utilize and install the stack checker mechanism.

Macro Definition Documentation

RTEMS_STACK_CHECKER_EXTENSION

#define RTEMS_STACK_CHECKER_EXTENSION

Value:

{ \
  rtems_stack_checker_create_extension,        /* rtems_task_create  */ \
  0,                                           /* rtems_task_start   */ \
  0,                                           /* rtems_task_restart */ \
  0,                                           /* rtems_task_delete  */ \
  rtems_stack_checker_switch_extension,        /* task_switch  */ \
  rtems_stack_checker_begin_extension,         /* task_begin   */ \
  0,                                           /* task_exitted */ \
  0 /* rtems_stack_checker_fatal_extension */, /* fatal        */ \
}

Stack Checker Extension Set Definition.

This macro defines the user extension handler set for the stack checker. This macro is normally only used by confdefs.h.

Function Documentation

rtems_stack_checker_begin_extension()

void rtems_stack_checker_begin_extension

(

Thread_Control *

the_thread

)

Stack Checker Task Begin Extension.

This method is the task begin extension for the stack checker.

Parameters

[in]

the_thread

points to task starting to execute

Note

This is called from the internal method _Thread_Handler.

References Objects_Control::id, and Thread_Control::Object.

rtems_stack_checker_create_extension()

bool rtems_stack_checker_create_extension	(	Thread_Control *	running,
		Thread_Control *	the_thread
	)

Stack Checker Task Create Extension.

This method is the task create extension for the stack checker.

Parameters

[in]	running	points to the currently executing task
[in]	the_thread	points to the newly created task

Note

If this this the first task created, the stack checker will automatically intialize itself.

rtems_stack_checker_is_blown()

bool rtems_stack_checker_is_blown

(

void

)

Checks if current task is blown its stack.

This method is used to determine if the current stack pointer of the currently executing task is within bounds.

Return values

This	method returns true if the currently executing task has blown its stack.

References _Thread_Get_executing(), Thread_Start_information::Initial_stack, and Thread_Control::Start.

rtems_stack_checker_report_usage()

void rtems_stack_checker_report_usage

(

void

)

Print the stack usage report using printk.

This method prints a stack usage report for the curently executing task.

Note

It uses printk to print the report.

References printk_plugin(), and rtems_stack_checker_report_usage_with_plugin().

rtems_stack_checker_report_usage_with_plugin()

void rtems_stack_checker_report_usage_with_plugin	(	void *	context,
		rtems_printk_plugin_t	print
	)

Print the stack usage report using caller's routine.

This method prints a stack usage report for the curently executing task.

Parameters

[in]	context	is the context to pass to the print handler
[in]	print	is the print handler

Note

It uses the caller's routine to print the report.

Referenced by rtems_stack_checker_report_usage().

rtems_stack_checker_switch_extension()

void rtems_stack_checker_switch_extension	(	Thread_Control *	running,
		Thread_Control *	heir
	)

Stack Checker Task Context Switch Extension.

This method is the task context switch extension for the stack checker.

Parameters

[in]	running	points to the currently executing task which is being context switched out
[in]	running	points to the heir task which we are switching to

Note

This is called from the internal method _Thread_Dispatch.

References Thread_Start_information::Initial_stack, and Thread_Control::Start.