RTEMS 4.9.5 On-Line Library

RTEMS Specific Commands wkspace - display information on executive workspace

RTEMS Shell User's Guide

5.2.4: wkspace - display information on executive workspace

SYNOPSYS:

wkspace

DESCRIPTION:

This command prints information on the current state of the RTEMS Executive Workspace reported. This includes the following information:

Number of free blocks
Largest free block
Total bytes free
Number of used blocks
Largest used block
Total bytes used

EXIT STATUS:

This command always succeeds and returns 0.

NOTES:

NONE

EXAMPLES:

The following is an example of how to use wkspace:

SHLL [/] $ wkspace
Number of free blocks: 1
Largest free block:    132336
Total bytes free:      132336
Number of used blocks: 36
Largest used block:    16408
Total bytes used:      55344

CONFIGURATION:

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

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

PROGRAMMING INFORMATION:

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

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

The configuration structure for the wkspace has the following prototype:

extern rtems_shell_cmd_t rtems_shell_WKSPACE_Command;

RTEMS Shell User's Guide