source: rtems-docs/c-user/config/event-record.rst @ 62d58f2

5
Last change on this file since 62d58f2 was 62d58f2, checked in by Sebastian Huber <sebastian.huber@…>, on 03/24/20 at 06:47:18

c-user: Document new event record config options

Update #3904.
  • Property mode set to 100644
File size: 3.2 KB
Line 
1.. SPDX-License-Identifier: CC-BY-SA-4.0
2
3.. Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de)
4
5Event Recording Configuration
6=============================
7
8This section describes configuration options related to the event recording.
9
10.. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED
11
12.. _CONFIGURE_RECORD_EXTENSIONS_ENABLED:
13
14CONFIGURE_RECORD_EXTENSIONS_ENABLED
15-----------------------------------
16
17CONSTANT:
18    ``CONFIGURE_RECORD_EXTENSIONS_ENABLED``
19
20OPTION TYPE:
21    This configuration option is a boolean feature define.
22
23DEFAULT CONFIGURATION:
24    If this configuration option is undefined, then the described feature is not
25    enabled.
26
27DESCRIPTION:
28    In case
29
30    * this configuration option is defined
31
32    * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
33
34    then the event record extensions are enabled.
35
36NOTES:
37    The record extensions capture thread create, start, restart, delete, switch,
38    begin, exitted and terminate events.
39
40.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64
41
42.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64:
43
44CONFIGURE_RECORD_FATAL_DUMP_BASE64
45----------------------------------
46
47CONSTANT:
48    ``CONFIGURE_RECORD_FATAL_DUMP_BASE64``
49
50OPTION TYPE:
51    This configuration option is a boolean feature define.
52
53DEFAULT CONFIGURATION:
54    If this configuration option is undefined, then the described feature is not
55    enabled.
56
57DESCRIPTION:
58    In case
59
60    * this configuration option is defined
61
62    * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
63
64    * and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined,
65
66    then the event records are dumped in Base64 encoding in a fatal error
67    extension (see :ref:`Terminate`).
68
69NOTES:
70    This extension can be used to produce crash dumps.
71
72.. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
73
74.. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB:
75
76CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB
77---------------------------------------
78
79CONSTANT:
80    ``CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB``
81
82OPTION TYPE:
83    This configuration option is a boolean feature define.
84
85DEFAULT CONFIGURATION:
86    If this configuration option is undefined, then the described feature is not
87    enabled.
88
89DESCRIPTION:
90    In case
91
92    * this configuration option is defined
93
94    * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined,
95
96    then the event records are compressed by zlib and dumped in Base64 encoding
97    in a fatal error extension (see :ref:`Terminate`).
98
99NOTES:
100    The zlib compression needs about 512KiB of RAM.  This extension can be used
101    to produce crash dumps.
102
103.. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
104
105.. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS:
106
107CONFIGURE_RECORD_PER_PROCESSOR_ITEMS
108------------------------------------
109
110CONSTANT:
111    ``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS``
112
113DATA TYPE:
114    Unsigned integer (``unsigned int``).
115
116RANGE:
117    A power of two greater than or equal to 16.
118
119DEFAULT VALUE:
120    This is not defined by default.
121
122DESCRIPTION:
123    If defined, then a record item buffer of the specified item count is
124    statically allocated for each configured processor
125    (:ref:`CONFIGURE_MAXIMUM_PROCESSORS <CONFIGURE_MAXIMUM_PROCESSORS>`).
126
127NOTES:
128    None.
Note: See TracBrowser for help on using the repository browser.