rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-02 15:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

c-user: Document new event record config options

Browse Source 
Update #3904.
This commit is contained in:
Sebastian Huber 2020-03-24 07:47:18 +01:00
parent dfe0ec05b9
commit 62d58f229f
1 changed files with 64 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
c-user/config/event-record.rst
View File

@ -1,6 +1,6 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0 .. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2019 embedded brains GmbH (http://www.embedded-brains.de) .. Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
Event Recording Configuration Event Recording Configuration
============================= =============================
@ -37,6 +37,69 @@ NOTES:
The record extensions capture thread create, start, restart, delete, switch, The record extensions capture thread create, start, restart, delete, switch,
begin, exitted and terminate events. begin, exitted and terminate events.
.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64
.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64:
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 :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`).
NOTES:
This extension can be used to produce crash dumps.
.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB:
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 :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`).
NOTES:
The zlib compression needs about 512KiB of RAM. This extension can be used
to produce crash dumps.
.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS .. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS: .. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS: