RTEMS 4.10.0 On-Line Library

RTEMS Specific Commands stackuse - print per thread stack usage

RTEMS Shell User's Guide

5.2.3: stackuse - print per thread stack usage

SYNOPSYS:

stackuse

DESCRIPTION:

This command prints a Stack Usage Report for all of the tasks and threads in the system. On systems which support it, the usage of the interrupt stack is also included in the report.

EXIT STATUS:

This command always succeeds and returns 0.

NOTES:

The CONFIGURE_STACK_CHECKER_ENABLED confdefs.h constant must be defined when the application is configured for this command to have any information to report.

EXAMPLES:

The following is an example of how to use stackuse:

SHLL [/] $ stackuse
Stack usage by thread
    ID      NAME    LOW          HIGH     CURRENT     AVAILABLE     USED
0x09010001  IDLE 0x023d89a0 - 0x023d99af 0x023d9760      4096        608
0x0a010001  UI1  0x023d9f30 - 0x023daf3f 0x023dad18      4096       1804
0x0a010002  SHLL 0x023db4c0 - 0x023df4cf 0x023de9d0     16384       5116
0xffffffff  INTR 0x023d2760 - 0x023d375f 0x00000000      4080        316

CONFIGURATION:

This command is included in the default shell command set. When building a custom command set, define CONFIGURE_SHELL_COMMAND_STACKUSE to have this command included.

This command can be excluded from the shell command set by defining CONFIGURE_SHELL_NO_COMMAND_STACKUSE when all shell commands have been configured.

PROGRAMMING INFORMATION:

The stackuse is implemented by a C language function which has the following prototype:

int rtems_shell_rtems_main_stackuse(
  int    argc,
  char **argv
);

The configuration structure for the stackuse has the following prototype:

extern rtems_shell_cmd_t rtems_shell_STACKUSE_Command;

RTEMS Shell User's Guide