Newer
Older
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2019, 2022 embedded brains GmbH & Co. KG
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
.. https://www.rtems.org/bugs.html
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual. The manual is provided as a part of
.. a release. For development sources please refer to the online
.. documentation at:
.. https://docs.rtems.org
.. Generated from spec:/acfg/if/group-eventrecord
Event Recording Configuration
=============================
This section describes configuration options related to the event recording.
.. Generated from spec:/acfg/if/record-extensions-enabled
.. raw:: latex
\clearpage
.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
CONFIGURE_RECORD_EXTENSIONS_ENABLED
-----------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
.. rubric:: OPTION TYPE:
This configuration option is a boolean feature define.
.. rubric:: DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
* this configuration option is defined
* and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
then the event record extensions are enabled.
.. rubric:: NOTES:
The record extensions capture thread create, start, restart, delete, switch,
begin, exitted and terminate events.
.. Generated from spec:/acfg/if/record-fatal-dump-base64
.. raw:: latex
\clearpage
.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64
.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64:
CONFIGURE_RECORD_FATAL_DUMP_BASE64
----------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_RECORD_FATAL_DUMP_BASE64``
.. rubric:: OPTION TYPE:
This configuration option is a boolean feature define.
.. rubric:: DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
* this configuration option is defined
* and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
* and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined,
then the event records are dumped in Base64 encoding in a fatal error
extension (see :ref:`Terminate`).
.. rubric:: NOTES:
This extension can be used to produce crash dumps.
.. Generated from spec:/acfg/if/record-fatal-dump-base64-zlib
.. raw:: latex
\clearpage
.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB:
CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
---------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB``
.. rubric:: OPTION TYPE:
This configuration option is a boolean feature define.
.. rubric:: DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
* this configuration option is defined
* and :ref:`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 :ref:`Terminate`).
.. rubric:: NOTES:
The zlib compression needs about 512KiB of RAM. This extension can be used
to produce crash dumps.
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
.. Generated from spec:/acfg/if/record-interrupts-enabled
.. raw:: latex
\clearpage
.. index:: CONFIGURE_RECORD_INTERRUPTS_ENABLED
.. _CONFIGURE_RECORD_INTERRUPTS_ENABLED:
CONFIGURE_RECORD_INTERRUPTS_ENABLED
-----------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_RECORD_INTERRUPTS_ENABLED``
.. rubric:: OPTION TYPE:
This configuration option is a boolean feature define.
.. rubric:: DEFAULT CONFIGURATION:
If this configuration option is undefined, then the described feature is not
enabled.
.. rubric:: DESCRIPTION:
In case
* this configuration option is defined
* and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
then the interrupt event recording is enabled.
.. rubric:: NOTES:
The interrupt event recording generates interrupt entry and exit events when
interrupt entries are dispatched.
.. Generated from spec:/acfg/if/record-per-processor-items
.. raw:: latex
\clearpage
.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS:
CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 0.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the event record item count
per processor.
The event record buffers are statically allocated for each configured
processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this
configuration option is zero, then nothing is allocated.
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to 16.
* The value of the configuration option shall be less than or equal to
`SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_.
* The value of the configuration option shall be a power of two.
* The value of the configuration option 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.