24.13. Event Recording Configuration — RTEMS Classic API Guide 5.4-rc2 (21st August 2026) documentation

# 24.13. Event Recording Configuration

This section describes configuration options related to the event recording.

## 24.13.1. CONFIGURE_RECORD_EXTENSIONS_ENABLED

CONSTANT:

  `CONFIGURE_RECORD_EXTENSIONS_ENABLED`

OPTION TYPE:

  This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:

  If this configuration option is undefined, then the described feature is not enabled.

DESCRIPTION:

  In case

  - this configuration option is defined

  - and CONFIGURE_RECORD_PER_PROCESSOR_ITEMS is properly defined,

  then the event record extensions are enabled.

NOTES:

  The record extensions capture thread create, start, restart, delete, switch, begin, exitted and terminate events.

## 24.13.2. CONFIGURE_RECORD_FATAL_DUMP_BASE64

CONSTANT:

  `CONFIGURE_RECORD_FATAL_DUMP_BASE64`

OPTION TYPE:

  This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:

  If this configuration option is undefined, then the described feature is not enabled.

DESCRIPTION:

  In case

  - this configuration option is defined

  - and CONFIGURE_RECORD_PER_PROCESSOR_ITEMS is properly defined,

  - and CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB is undefined,

  then the event records are dumped in Base64 encoding in a fatal error extension (see Announcing a Fatal Error).

NOTES:

  This extension can be used to produce crash dumps.

## 24.13.3. CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB

CONSTANT:

  `CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB`

OPTION TYPE:

  This configuration option is a boolean feature define.

DEFAULT CONFIGURATION:

  If this configuration option is undefined, then the described feature is not enabled.

DESCRIPTION:

  In case

  - this configuration option is defined

  - and CONFIGURE_RECORD_PER_PROCESSOR_ITEMS is properly defined,

  then the event records are compressed by zlib and dumped in Base64 encoding in a fatal error extension (see Announcing a Fatal Error).

NOTES:

  The zlib compression needs about 512KiB of RAM. This extension can be used to produce crash dumps.

## 24.13.4. CONFIGURE_RECORD_PER_PROCESSOR_ITEMS

CONSTANT:

  `CONFIGURE_RECORD_PER_PROCESSOR_ITEMS`

OPTION TYPE:

  This configuration option is an integer define.

DEFAULT VALUE:

  The default value is 0.

VALUE CONSTRAINTS:

  The value of this configuration option shall satisfy all of the following constraints:

  - It shall be greater than or equal to 16.

  - It shall be less than or equal to `SIZE_MAX`.

  - It shall be a power of two.

  - It shall be less than or equal to a BSP-specific and application-specific value which depends on the size of the memory available to the application.

DESCRIPTION:

  The value of this configuration option defines the event record item count per processor.

NOTES:

  The event record buffers are statically allocated for each configured processor (CONFIGURE_MAXIMUM_PROCESSORS). If the value of this configuration option is zero, then nothing is allocated.