blob: 09c541fd13336d19044a826b18c75f71cb96c63b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
|
.. SPDX-License-Identifier: CC-BY-SA-4.0
.. Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
.. This file is part of the RTEMS quality process and was automatically
.. generated. If you find something that needs to be fixed or
.. worded better please post a report or patch to an RTEMS mailing list
.. or raise a bug report:
..
.. https://www.rtems.org/bugs.html
..
.. For information on updating and regenerating please refer to the How-To
.. section in the Software Requirements Engineering chapter of the
.. RTEMS Software Engineering manual. The manual is provided as a part of
.. a release. For development sources please refer to the online
.. documentation at:
..
.. https://docs.rtems.org
.. Generated from spec:/acfg/if/group-mpci
Multiprocessing Configuration
=============================
This section describes multiprocessing related configuration options. The
options are only used if RTEMS was built with the ``--enable-multiprocessing``
build configuration option. Additionally, this class of configuration options
are only applicable if the configuration option :ref:`CONFIGURE_MP_APPLICATION`
is defined. The multiprocessing (MPCI) support must not be confused with the
SMP support.
.. Generated from spec:/acfg/if/mp-extra-server-stack
.. raw:: latex
\clearpage
.. index:: CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK
.. _CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK:
CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK
-----------------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 0.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the number of bytes the
applications wishes to add to the MPCI task stack on top of
:ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.
.. rubric:: NOTES:
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
* The value of the configuration option shall be small enough so that the MPCI
receive server stack area calculation carried out by ``<rtems/confdefs.h>``
does not overflow an integer of type `size_t
<https://en.cppreference.com/w/c/types/size_t>`_.
.. Generated from spec:/acfg/if/mp-appl
.. raw:: latex
\clearpage
.. index:: CONFIGURE_MP_APPLICATION
.. _CONFIGURE_MP_APPLICATION:
CONFIGURE_MP_APPLICATION
------------------------
.. rubric:: CONSTANT:
``CONFIGURE_MP_APPLICATION``
.. rubric:: OPTION TYPE:
This configuration option is a boolean feature define.
.. rubric:: DEFAULT CONFIGURATION:
If this configuration option is undefined, then the multiprocessing services
are not initialized.
.. rubric:: DESCRIPTION:
This configuration option is defined to indicate that the application intends
to be part of a multiprocessing configuration. Additional configuration
options are assumed to be provided.
.. rubric:: NOTES:
This configuration option shall be undefined if the multiprocessing support
is not enabled (e.g. RTEMS was built without the ``--enable-multiprocessing``
build configuration option). Otherwise a compile time error in the
configuration file will occur.
.. Generated from spec:/acfg/if/mp-max-global-objects
.. raw:: latex
\clearpage
.. index:: CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
.. _CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS:
CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS
-----------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 32.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the maximum number of
concurrently active global objects in a multiprocessor system.
.. rubric:: NOTES:
This value corresponds to the total number of objects which can be created
with the :c:macro:`RTEMS_GLOBAL` attribute.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/mp-max-nodes
.. raw:: latex
\clearpage
.. index:: CONFIGURE_MP_MAXIMUM_NODES
.. _CONFIGURE_MP_MAXIMUM_NODES:
CONFIGURE_MP_MAXIMUM_NODES
--------------------------
.. rubric:: CONSTANT:
``CONFIGURE_MP_MAXIMUM_NODES``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 2.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the maximum number of nodes in
a multiprocessor system.
.. rubric:: NOTES:
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/mp-max-proxies
.. raw:: latex
\clearpage
.. index:: CONFIGURE_MP_MAXIMUM_PROXIES
.. _CONFIGURE_MP_MAXIMUM_PROXIES:
CONFIGURE_MP_MAXIMUM_PROXIES
----------------------------
.. rubric:: CONSTANT:
``CONFIGURE_MP_MAXIMUM_PROXIES``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is 32.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the maximum number of
concurrently active thread/task proxies on this node in a multiprocessor
system.
.. rubric:: NOTES:
Since a proxy is used to represent a remote task/thread which is blocking
on this node. This configuration parameter reflects the maximum number of
remote tasks/threads which can be blocked on objects on this node, see
:ref:`MPCIProxies`.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
.. Generated from spec:/acfg/if/mp-mpci-table-pointer
.. raw:: latex
\clearpage
.. index:: CONFIGURE_MP_MPCI_TABLE_POINTER
.. _CONFIGURE_MP_MPCI_TABLE_POINTER:
CONFIGURE_MP_MPCI_TABLE_POINTER
-------------------------------
.. rubric:: CONSTANT:
``CONFIGURE_MP_MPCI_TABLE_POINTER``
.. rubric:: OPTION TYPE:
This configuration option is an initializer define.
.. rubric:: DEFAULT VALUE:
The default value is ``&MPCI_table``.
.. rubric:: DESCRIPTION:
The value of this configuration option initializes the MPCI Configuration
Table.
.. rubric:: NOTES:
RTEMS provides a Shared Memory MPCI Device Driver which can be used on any
Multiprocessor System assuming the BSP provides the proper set of
supporting methods.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. rubric:: CONSTRAINTS:
The value of the configuration option shall be a pointer to
:c:type:`rtems_mpci_table`.
.. Generated from spec:/acfg/if/mp-node-number
.. raw:: latex
\clearpage
.. index:: CONFIGURE_MP_NODE_NUMBER
.. _CONFIGURE_MP_NODE_NUMBER:
CONFIGURE_MP_NODE_NUMBER
------------------------
.. rubric:: CONSTANT:
``CONFIGURE_MP_NODE_NUMBER``
.. rubric:: OPTION TYPE:
This configuration option is an integer define.
.. rubric:: DEFAULT VALUE:
The default value is ``NODE_NUMBER``.
.. rubric:: DESCRIPTION:
The value of this configuration option defines the node number of this node
in a multiprocessor system.
.. rubric:: NOTES:
In the RTEMS Multiprocessing Test Suite, the node number is derived from
the Makefile variable ``NODE_NUMBER``. The same code is compiled with the
``NODE_NUMBER`` set to different values. The test programs behave
differently based upon their node number.
This configuration option is only evaluated if
:ref:`CONFIGURE_MP_APPLICATION` is defined.
.. rubric:: CONSTRAINTS:
The following constraints apply to this configuration option:
* The value of the configuration option shall be greater than or equal to zero.
* The value of the configuration option shall be less than or equal to
`UINT32_MAX <https://en.cppreference.com/w/c/types/integer>`_.
|
