summaryrefslogtreecommitdiffstats
path: root/c-user
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-24 07:47:18 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-03-24 07:48:40 +0100
commit62d58f229f7b499ce02ed644c3d628281bbd7d99 (patch)
tree0feb557fc2d031654460b48d7656c54ff92279c6 /c-user
parentdfe0ec05b9c06e7dc915788e24c74582f51791f9 (diff)
downloadrtems-docs-master.tar.bz2
c-user: Document new event record config optionsHEADmaster
Update #3904.
Diffstat (limited to 'c-user')
-rw-r--r--c-user/config/event-record.rst65
1 files changed, 64 insertions, 1 deletions
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
index 8ca9534..edd8722 100644
--- a/c-user/config/event-record.rst
+++ b/c-user/config/event-record.rst
@@ -1,6 +1,6 @@
.. 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
=============================
@@ -37,6 +37,69 @@ NOTES:
The record extensions capture thread create, start, restart, delete, switch,
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
.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS: