summaryrefslogtreecommitdiffstats
path: root/c-user/config/posix-api.rst
blob: 78cb724ae60a13ce188f96755ed9c8bc4fc16196 (plain)
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
.. 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-posix

POSIX API Configuration
=======================

This section describes configuration options related to the POSIX API.  Most
POSIX API objects are available by default since RTEMS 5.1.  The queued signals
and timers are only available if RTEMS was built with the enable POSIX
build configuration option.

.. Generated from spec:/acfg/if/max-posix-keys

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_KEYS

.. _CONFIGURE_MAXIMUM_POSIX_KEYS:

CONFIGURE_MAXIMUM_POSIX_KEYS
----------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_KEYS``

.. 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 maximum number of POSIX
API Keys that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option may be defined through
  :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
  object class, if the value passed to :c:func:`rtems_resource_unlimited`
  satisfies all other constraints of the configuration option.

.. Generated from spec:/acfg/if/max-posix-key-value-pairs

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS

.. _CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS:

CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS
---------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_KEY_VALUE_PAIRS``

.. rubric:: OPTION TYPE:

This configuration option is an integer define.

.. rubric:: DEFAULT VALUE:

The default value is
:ref:`CONFIGURE_MAXIMUM_POSIX_KEYS` *
( :ref:`CONFIGURE_MAXIMUM_TASKS` +
:ref:`CONFIGURE_MAXIMUM_POSIX_THREADS` ).

.. rubric:: DESCRIPTION:

The value of this configuration option defines the maximum number of key
value pairs used by POSIX API Keys that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.

A key value pair is created by :c:func:`pthread_setspecific` if the value
is not `NULL <https://en.cppreference.com/w/c/types/NULL>`_, otherwise it is deleted.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option may be defined through
  :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
  object class, if the value passed to :c:func:`rtems_resource_unlimited`
  satisfies all other constraints of the configuration option.

.. Generated from spec:/acfg/if/max-posix-message-queues

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES

.. _CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES:

CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES
--------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES``

.. 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 maximum number of POSIX
API Message Queues that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.  You have to account for the memory used to
store the messages of each message queue, see
:ref:`CONFIGURE_MESSAGE_BUFFER_MEMORY`.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option shall be small enough so that the RTEMS
  Workspace size calculation carried out by ``<rtems/confdefs.h>`` does not
  overflow an integer of type `uintptr_t
  <https://en.cppreference.com/w/c/types/integer>`_.

* The value of the configuration option may be defined through
  :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
  object class, if the value passed to :c:func:`rtems_resource_unlimited`
  satisfies all other constraints of the configuration option.

.. Generated from spec:/acfg/if/max-posix-queued-signals

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS

.. _CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS:

CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS
--------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS``

.. 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 maximum number of POSIX
API Queued Signals that can be concurrently active.

.. rubric:: NOTES:

Unlimited objects are not available for queued signals.

Queued signals are only available if RTEMS was built with the POSIX API
build configuration option enabled.

.. 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 a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option shall be small enough so that the RTEMS
  Workspace size calculation carried out by ``<rtems/confdefs.h>`` does not
  overflow an integer of type `uintptr_t
  <https://en.cppreference.com/w/c/types/integer>`_.

* The value of the configuration option shall be zero if the POSIX API is not
  enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True`` build
  configuration option).  Otherwise a compile time error in the configuration
  file will occur.

.. Generated from spec:/acfg/if/max-posix-semaphores

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_SEMAPHORES

.. _CONFIGURE_MAXIMUM_POSIX_SEMAPHORES:

CONFIGURE_MAXIMUM_POSIX_SEMAPHORES
----------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_SEMAPHORES``

.. 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 maximum number of POSIX
API Named Semaphores that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.

Named semaphores are created with :c:func:`sem_open`.  Semaphores
initialized with :c:func:`sem_init` are not affected by this
configuration option since the storage space for these semaphores is
user-provided.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option shall be small enough so that the RTEMS
  Workspace size calculation carried out by ``<rtems/confdefs.h>`` does not
  overflow an integer of type `uintptr_t
  <https://en.cppreference.com/w/c/types/integer>`_.

* The value of the configuration option may be defined through
  :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
  object class, if the value passed to :c:func:`rtems_resource_unlimited`
  satisfies all other constraints of the configuration option.

.. Generated from spec:/acfg/if/max-posix-shms

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_SHMS

.. _CONFIGURE_MAXIMUM_POSIX_SHMS:

CONFIGURE_MAXIMUM_POSIX_SHMS
----------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_SHMS``

.. 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 maximum number of POSIX
API Shared Memory objects that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option shall be small enough so that the RTEMS
  Workspace size calculation carried out by ``<rtems/confdefs.h>`` does not
  overflow an integer of type `uintptr_t
  <https://en.cppreference.com/w/c/types/integer>`_.

* The value of the configuration option may be defined through
  :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
  object class, if the value passed to :c:func:`rtems_resource_unlimited`
  satisfies all other constraints of the configuration option.

.. Generated from spec:/acfg/if/max-posix-threads

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_THREADS

.. _CONFIGURE_MAXIMUM_POSIX_THREADS:

CONFIGURE_MAXIMUM_POSIX_THREADS
-------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_THREADS``

.. 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 maximum number of POSIX
API Threads that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.

This calculations for the required memory in the RTEMS Workspace for threads
assume that each thread has a minimum stack size and has floating point
support enabled.  The configuration option :ref:`CONFIGURE_EXTRA_TASK_STACKS` is used
to specify thread stack requirements **above** the minimum size required.

The maximum number of Classic API Tasks is specified by
:ref:`CONFIGURE_MAXIMUM_TASKS`.

All POSIX threads have floating point enabled.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size of the
  memory available to the application.

* The value of the configuration option shall be small enough so that the task
  stack space calculation carried out by ``<rtems/confdefs.h>`` does not
  overflow an integer of type `uintptr_t
  <https://en.cppreference.com/w/c/types/integer>`_.

.. Generated from spec:/acfg/if/max-posix-timers

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MAXIMUM_POSIX_TIMERS

.. _CONFIGURE_MAXIMUM_POSIX_TIMERS:

CONFIGURE_MAXIMUM_POSIX_TIMERS
------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MAXIMUM_POSIX_TIMERS``

.. 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 maximum number of POSIX
API Timers that can be concurrently active.

.. rubric:: NOTES:

This object class can be configured in unlimited allocation mode, see
:ref:`ConfigUnlimitedObjects`.

Timers are only available if RTEMS was built with the POSIX API build
configuration option enabled.

.. 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 65535.

* The value of the configuration option shall be less than or equal to a
  BSP-specific and application-specific value which depends on the size
  of the memory available to the application.

* The value of the configuration option may be defined through
  :c:func:`rtems_resource_unlimited` the enable unlimited objects for the
  object class, if the value passed to :c:func:`rtems_resource_unlimited`
  satisfies all other constraints of the configuration option.

* The value of the configuration option shall be zero if the POSIX API
is not
  enabled (e.g. RTEMS was built without the ``RTEMS_POSIX_API = True``
  build configuration option).  Otherwise a compile time error in the
  configuration
  file will occur.

.. Generated from spec:/acfg/if/min-posix-thread-stack-size

.. raw:: latex

    \clearpage

.. index:: CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE
.. index:: minimum POSIX thread stack size

.. _CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE:

CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE
-----------------------------------------

.. rubric:: CONSTANT:

``CONFIGURE_MINIMUM_POSIX_THREAD_STACK_SIZE``

.. rubric:: OPTION TYPE:

This configuration option is an integer define.

.. rubric:: DEFAULT VALUE:

The default value is two times the value of
:ref:`CONFIGURE_MINIMUM_TASK_STACK_SIZE`.

.. rubric:: DESCRIPTION:

The value of this configuration option defines the minimum stack size in
bytes for every POSIX thread in the system.

.. rubric:: CONSTRAINTS:

The following constraints apply to this configuration option:

* The value of the configuration option shall be small enough so that the task
  stack space calculation carried out by ``<rtems/confdefs.h>`` does not
  overflow an integer of type `uintptr_t
  <https://en.cppreference.com/w/c/types/integer>`_.

* The value of the configuration option shall be greater than or equal to a
  BSP-specific and application-specific minimum value.