1 | .. SPDX-License-Identifier: CC-BY-SA-4.0 |
---|
2 | |
---|
3 | .. Copyright (C) 2019, 2021 embedded brains GmbH (http://www.embedded-brains.de) |
---|
4 | |
---|
5 | .. This file is part of the RTEMS quality process and was automatically |
---|
6 | .. generated. If you find something that needs to be fixed or |
---|
7 | .. worded better please post a report or patch to an RTEMS mailing list |
---|
8 | .. or raise a bug report: |
---|
9 | .. |
---|
10 | .. https://www.rtems.org/bugs.html |
---|
11 | .. |
---|
12 | .. For information on updating and regenerating please refer to the How-To |
---|
13 | .. section in the Software Requirements Engineering chapter of the |
---|
14 | .. RTEMS Software Engineering manual. The manual is provided as a part of |
---|
15 | .. a release. For development sources please refer to the online |
---|
16 | .. documentation at: |
---|
17 | .. |
---|
18 | .. https://docs.rtems.org |
---|
19 | |
---|
20 | .. Generated from spec:/acfg/if/group-eventrecord |
---|
21 | |
---|
22 | Event Recording Configuration |
---|
23 | ============================= |
---|
24 | |
---|
25 | This section describes configuration options related to the event recording. |
---|
26 | |
---|
27 | .. Generated from spec:/acfg/if/record-extensions-enabled |
---|
28 | |
---|
29 | .. raw:: latex |
---|
30 | |
---|
31 | \clearpage |
---|
32 | |
---|
33 | .. index:: CONFIGURE_RECORD_EXTENSIONS_ENABLED |
---|
34 | |
---|
35 | .. _CONFIGURE_RECORD_EXTENSIONS_ENABLED: |
---|
36 | |
---|
37 | CONFIGURE_RECORD_EXTENSIONS_ENABLED |
---|
38 | ----------------------------------- |
---|
39 | |
---|
40 | .. rubric:: CONSTANT: |
---|
41 | |
---|
42 | ``CONFIGURE_RECORD_EXTENSIONS_ENABLED`` |
---|
43 | |
---|
44 | .. rubric:: OPTION TYPE: |
---|
45 | |
---|
46 | This configuration option is a boolean feature define. |
---|
47 | |
---|
48 | .. rubric:: DEFAULT CONFIGURATION: |
---|
49 | |
---|
50 | If this configuration option is undefined, then the described feature is not |
---|
51 | enabled. |
---|
52 | |
---|
53 | .. rubric:: DESCRIPTION: |
---|
54 | |
---|
55 | In case |
---|
56 | |
---|
57 | * this configuration option is defined |
---|
58 | |
---|
59 | * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined, |
---|
60 | |
---|
61 | then the event record extensions are enabled. |
---|
62 | |
---|
63 | .. rubric:: NOTES: |
---|
64 | |
---|
65 | The record extensions capture thread create, start, restart, delete, switch, |
---|
66 | begin, exitted and terminate events. |
---|
67 | |
---|
68 | .. Generated from spec:/acfg/if/record-fatal-dump-base64 |
---|
69 | |
---|
70 | .. raw:: latex |
---|
71 | |
---|
72 | \clearpage |
---|
73 | |
---|
74 | .. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64 |
---|
75 | |
---|
76 | .. _CONFIGURE_RECORD_FATAL_DUMP_BASE64: |
---|
77 | |
---|
78 | CONFIGURE_RECORD_FATAL_DUMP_BASE64 |
---|
79 | ---------------------------------- |
---|
80 | |
---|
81 | .. rubric:: CONSTANT: |
---|
82 | |
---|
83 | ``CONFIGURE_RECORD_FATAL_DUMP_BASE64`` |
---|
84 | |
---|
85 | .. rubric:: OPTION TYPE: |
---|
86 | |
---|
87 | This configuration option is a boolean feature define. |
---|
88 | |
---|
89 | .. rubric:: DEFAULT CONFIGURATION: |
---|
90 | |
---|
91 | If this configuration option is undefined, then the described feature is not |
---|
92 | enabled. |
---|
93 | |
---|
94 | .. rubric:: DESCRIPTION: |
---|
95 | |
---|
96 | In case |
---|
97 | |
---|
98 | * this configuration option is defined |
---|
99 | |
---|
100 | * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined, |
---|
101 | |
---|
102 | * and :ref:`CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` is undefined, |
---|
103 | |
---|
104 | then the event records are dumped in Base64 encoding in a fatal error |
---|
105 | extension (see :ref:`Terminate`). |
---|
106 | |
---|
107 | .. rubric:: NOTES: |
---|
108 | |
---|
109 | This extension can be used to produce crash dumps. |
---|
110 | |
---|
111 | .. Generated from spec:/acfg/if/record-fatal-dump-base64-zlib |
---|
112 | |
---|
113 | .. raw:: latex |
---|
114 | |
---|
115 | \clearpage |
---|
116 | |
---|
117 | .. index:: CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB |
---|
118 | |
---|
119 | .. _CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB: |
---|
120 | |
---|
121 | CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB |
---|
122 | --------------------------------------- |
---|
123 | |
---|
124 | .. rubric:: CONSTANT: |
---|
125 | |
---|
126 | ``CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB`` |
---|
127 | |
---|
128 | .. rubric:: OPTION TYPE: |
---|
129 | |
---|
130 | This configuration option is a boolean feature define. |
---|
131 | |
---|
132 | .. rubric:: DEFAULT CONFIGURATION: |
---|
133 | |
---|
134 | If this configuration option is undefined, then the described feature is not |
---|
135 | enabled. |
---|
136 | |
---|
137 | .. rubric:: DESCRIPTION: |
---|
138 | |
---|
139 | In case |
---|
140 | |
---|
141 | * this configuration option is defined |
---|
142 | |
---|
143 | * and :ref:`CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` is properly defined, |
---|
144 | |
---|
145 | then the event records are compressed by zlib and dumped in Base64 encoding |
---|
146 | in a fatal error extension (see :ref:`Terminate`). |
---|
147 | |
---|
148 | .. rubric:: NOTES: |
---|
149 | |
---|
150 | The zlib compression needs about 512KiB of RAM. This extension can be used |
---|
151 | to produce crash dumps. |
---|
152 | |
---|
153 | .. Generated from spec:/acfg/if/record-per-processor-items |
---|
154 | |
---|
155 | .. raw:: latex |
---|
156 | |
---|
157 | \clearpage |
---|
158 | |
---|
159 | .. index:: CONFIGURE_RECORD_PER_PROCESSOR_ITEMS |
---|
160 | |
---|
161 | .. _CONFIGURE_RECORD_PER_PROCESSOR_ITEMS: |
---|
162 | |
---|
163 | CONFIGURE_RECORD_PER_PROCESSOR_ITEMS |
---|
164 | ------------------------------------ |
---|
165 | |
---|
166 | .. rubric:: CONSTANT: |
---|
167 | |
---|
168 | ``CONFIGURE_RECORD_PER_PROCESSOR_ITEMS`` |
---|
169 | |
---|
170 | .. rubric:: OPTION TYPE: |
---|
171 | |
---|
172 | This configuration option is an integer define. |
---|
173 | |
---|
174 | .. rubric:: DEFAULT VALUE: |
---|
175 | |
---|
176 | The default value is 0. |
---|
177 | |
---|
178 | .. rubric:: DESCRIPTION: |
---|
179 | |
---|
180 | The value of this configuration option defines the event record item count |
---|
181 | per processor. |
---|
182 | |
---|
183 | .. rubric:: NOTES: |
---|
184 | |
---|
185 | The event record buffers are statically allocated for each configured |
---|
186 | processor (:ref:`CONFIGURE_MAXIMUM_PROCESSORS`). If the value of this |
---|
187 | configuration option is zero, then nothing is allocated. |
---|
188 | |
---|
189 | .. rubric:: CONSTRAINTS: |
---|
190 | |
---|
191 | The following constraints apply to this configuration option: |
---|
192 | |
---|
193 | * The value of the configuration option shall be greater than or equal to 16. |
---|
194 | |
---|
195 | * The value of the configuration option shall be less than or equal to |
---|
196 | `SIZE_MAX <https://en.cppreference.com/w/c/types/limits>`_. |
---|
197 | |
---|
198 | * The value of the configuration option shall be a power of two. |
---|
199 | |
---|
200 | * The value of the configuration option shall be less than or equal to a |
---|
201 | BSP-specific and application-specific value which depends on the size of the |
---|
202 | memory available to the application. |
---|