Update #3904. --- c-user/config/event-record.rst | 64 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+)
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst index 7071c77..1dc7204 100644 --- a/c-user/config/event-record.rst +++ b/c-user/config/event-record.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 +.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) .. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) Event Recording Configuration @@ -33,6 +34,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 event records are not + dumped in a fatal error extension. + +DESCRIPTION: + In case + + * this configuration option is defined + + * and :ref:`CONFIGURE_RECORD_EXTENSIONS_ENABLED` is 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 event records are not + dumped in a fatal error extension. + +DESCRIPTION: + In case + + * this configuration option is defined + + * and :ref:`CONFIGURE_RECORD_EXTENSIONS_ENABLED` is 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: -- 2.16.4 _______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel