summaryrefslogtreecommitdiffstats
path: root/posix-users/thread.rst
blob: e5f47c5e3144660704d35837af532ec707a7295f (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
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
.. comment SPDX-License-Identifier: CC-BY-SA-4.0

.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

Thread Manager
##############

Introduction
============

The thread manager implements the functionality required of the thread manager
as defined by POSIX 1003.1b. This standard requires that a compliant operating
system provide the facilties to manage multiple threads of control and defines
the API that must be provided.

The services provided by the thread manager are:

- pthread_attr_init_ - Initialize a Thread Attribute Set

- pthread_attr_destroy_ - Destroy a Thread Attribute Set

- pthread_attr_setdetachstate_ - Set Detach State

- pthread_attr_getdetachstate_ - Get Detach State

- pthread_attr_setstacksize_ - Set Thread Stack Size

- pthread_attr_getstacksize_ - Get Thread Stack Size

- pthread_attr_setstackaddr_ - Set Thread Stack Address

- pthread_attr_getstackaddr_ - Get Thread Stack Address

- pthread_attr_setscope_ - Set Thread Scheduling Scope

- pthread_attr_getscope_ - Get Thread Scheduling Scope

- pthread_attr_setinheritsched_ - Set Inherit Scheduler Flag

- pthread_attr_getinheritsched_ - Get Inherit Scheduler Flag

- pthread_attr_setschedpolicy_ - Set Scheduling Policy

- pthread_attr_getschedpolicy_ - Get Scheduling Policy

- pthread_attr_setschedparam_ - Set Scheduling Parameters

- pthread_attr_getschedparam_ - Get Scheduling Parameters

- pthread_attr_getaffinity_np_ - Get Thread Affinity Attribute

- pthread_attr_setaffinity_np_ - Set Thread Affinity Attribute

- pthread_create_ - Create a Thread

- pthread_exit_ - Terminate the Current Thread

- pthread_detach_ - Detach a Thread

- pthread_getattr_np_ - Get Thread Attributes

- pthread_join_ - Wait for Thread Termination

- pthread_self_ - Get Thread ID

- pthread_equal_ - Compare Thread IDs

- pthread_once_ - Dynamic Package Initialization

- pthread_setschedparam_ - Set Thread Scheduling Parameters

- pthread_getschedparam_ - Get Thread Scheduling Parameters

- pthread_getaffinity_np_ - Get Thread Affinity

- pthread_setaffinity_np_ - Set Thread Affinity

Background
==========

Thread Attributes
-----------------

Thread attributes are utilized only at thread creation time. A thread attribute
structure may be initialized and passed as an argument to the
``pthread_create`` routine.

*stack address*
    is the address of the optionally user specified stack area for this thread.
    If this value is NULL, then RTEMS allocates the memory for the thread stack
    from the RTEMS Workspace Area. Otherwise, this is the user specified
    address for the memory to be used for the thread's stack. Each thread must
    have a distinct stack area. Each processor family has different alignment
    rules which should be followed.

*stack size*
    is the minimum desired size for this thread's stack area.  If the size of
    this area as specified by the stack size attribute is smaller than the
    minimum for this processor family and the stack is not user specified, then
    RTEMS will automatically allocate a stack of the minimum size for this
    processor family.

*contention scope*
    specifies the scheduling contention scope. RTEMS only supports the
    PTHREAD_SCOPE_PROCESS scheduling contention scope.

*scheduling inheritance*
    specifies whether a user specified or the scheduling policy and parameters
    of the currently executing thread are to be used. When this is
    PTHREAD_INHERIT_SCHED, then the scheduling policy and parameters of the
    currently executing thread are inherited by the newly created thread.

*scheduling policy and parameters*
    specify the manner in which the thread will contend for the processor.  The
    scheduling parameters are interpreted based on the specified policy.  All
    policies utilize the thread priority parameter.

Operations
==========

There is currently no text in this section.

Services
========

This section details the thread manager's services.  A subsection is dedicated
to each of this manager's services and describes the calling sequence, related
constants, usage, and status codes.

.. _pthread_attr_init:

pthread_attr_init - Initialize a Thread Attribute Set
-----------------------------------------------------
.. index:: pthread_attr_init
.. index:: initialize a thread attribute set

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_init(
        pthread_attr_t *attr
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_init`` routine initializes the thread attributes object
specified by ``attr`` with the default value for all of the individual
attributes.

**NOTES:**

The settings in the default attributes are implementation defined. For RTEMS,
the default attributes are as follows:

.. list-table::
 :class: rtems-table

 * - *stackadr*
   - is not set to indicate that RTEMS is to allocate the stack memory.
 * - *stacksize*
   - is set to ``PTHREAD_MINIMUM_STACK_SIZE``.
 * - *contentionscope*
   - is set to ``PTHREAD_SCOPE_PROCESS``.
 * - *inheritsched*
   - is set to ``PTHREAD_INHERIT_SCHED`` to indicate that the created thread
     inherits its scheduling attributes from its parent.
 * - detachstate
   - is set to ``PTHREAD_CREATE_JOINABLE``.

.. _pthread_attr_destroy:

pthread_attr_destroy - Destroy a Thread Attribute Set
-----------------------------------------------------
.. index:: pthread_attr_destroy
.. index:: destroy a thread attribute set

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_destroy(
        pthread_attr_t *attr
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.

**DESCRIPTION:**

The ``pthread_attr_destroy`` routine is used to destroy a thread attributes
object. The behavior of using an attributes object after it is destroyed is
implementation dependent.

**NOTES:**

NONE

.. _pthread_attr_setdetachstate:

pthread_attr_setdetachstate - Set Detach State
----------------------------------------------
.. index:: pthread_attr_setdetachstate
.. index:: set detach state

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setdetachstate(
        pthread_attr_t *attr,
        int             detachstate
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The detachstate argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_setdetachstate`` routine is used to value of the
``detachstate`` attribute. This attribute controls whether the thread is
created in a detached state.

The ``detachstate`` can be either ``PTHREAD_CREATE_DETACHED`` or
``PTHREAD_CREATE_JOINABLE``. The default value for all threads is
``PTHREAD_CREATE_JOINABLE``.

**NOTES:**

If a thread is in a detached state, then the use of the ID with the
``pthread_detach`` or ``pthread_join`` routines is an error.

.. _pthread_attr_getdetachstate:

pthread_attr_getdetachstate - Get Detach State
----------------------------------------------
.. index:: pthread_attr_getdetachstate
.. index:: get detach state

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getdetachstate(
        const pthread_attr_t *attr,
        int                  *detachstate
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The detatchstate pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_getdetachstate`` routine is used to obtain the current value
of the ``detachstate`` attribute as specified by the ``attr`` thread attribute
object.

**NOTES:**

NONE

.. _pthread_attr_setstacksize:

pthread_attr_setstacksize - Set Thread Stack Size
-------------------------------------------------
.. index:: pthread_attr_setstacksize
.. index:: set thread stack size

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setstacksize(
        pthread_attr_t *attr,
        size_t          stacksize
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.

**DESCRIPTION:**

The ``pthread_attr_setstacksize`` routine is used to set the ``stacksize``
attribute in the ``attr`` thread attribute object.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_ATTR_STACKSIZE`` to indicate that this routine is supported.

If the specified stacksize is below the minimum required for this CPU
(``PTHREAD_STACK_MIN``, then the stacksize will be set to the minimum for this
CPU.

.. _pthread_attr_getstacksize:

pthread_attr_getstacksize - Get Thread Stack Size
-------------------------------------------------
.. index:: pthread_attr_getstacksize
.. index:: get thread stack size

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getstacksize(
        const pthread_attr_t *attr,
        size_t               *stacksize
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The stacksize pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_getstacksize`` routine is used to obtain the ``stacksize``
attribute in the ``attr`` thread attribute object.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_ATTR_STACKSIZE`` to indicate that this routine is supported.

.. _pthread_attr_setstackaddr:

pthread_attr_setstackaddr - Set Thread Stack Address
----------------------------------------------------
.. index:: pthread_attr_setstackaddr
.. index:: set thread stack address

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setstackaddr(
        pthread_attr_t *attr,
        void           *stackaddr
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.

**DESCRIPTION:**

The ``pthread_attr_setstackaddr`` routine is used to set the ``stackaddr``
attribute in the ``attr`` thread attribute object.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_ATTR_STACKADDR`` to indicate that this routine is supported.

It is imperative to the proper operation of the system that each thread have
sufficient stack space.

.. _pthread_attr_getstackaddr:

pthread_attr_getstackaddr - Get Thread Stack Address
----------------------------------------------------
.. index:: pthread_attr_getstackaddr
.. index:: get thread stack address

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getstackaddr(
        const pthread_attr_t  *attr,
        void                 **stackaddr
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The stackaddr pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_getstackaddr`` routine is used to obtain the ``stackaddr``
attribute in the ``attr`` thread attribute object.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_ATTR_STACKADDR`` to indicate that this routine is supported.

.. _pthread_attr_setscope:

pthread_attr_setscope - Set Thread Scheduling Scope
---------------------------------------------------
.. index:: pthread_attr_setscope
.. index:: set thread scheduling scope

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setscope(
        pthread_attr_t *attr,
        int             contentionscope
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The contention scope specified is not valid.
 * - ``ENOTSUP``
   - The contention scope specified (``PTHREAD_SCOPE_SYSTEM``) is not supported.

**DESCRIPTION:**

The ``pthread_attr_setscope`` routine is used to set the contention scope field
in the thread attribute object ``attr`` to the value specified by
``contentionscope``.

The ``contentionscope`` must be either ``PTHREAD_SCOPE_SYSTEM`` to indicate
that the thread is to be within system scheduling contention or
``PTHREAD_SCOPE_PROCESS`` indicating that the thread is to be within the
process scheduling contention scope.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_getscope:

pthread_attr_getscope - Get Thread Scheduling Scope
---------------------------------------------------
.. index:: pthread_attr_getscope
.. index:: get thread scheduling scope

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getscope(
        const pthread_attr_t *attr,
        int                  *contentionscope
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The contentionscope pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_getscope`` routine is used to obtain the value of the
contention scope field in the thread attributes object ``attr``. The current
value is returned in ``contentionscope``.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_setinheritsched:

pthread_attr_setinheritsched - Set Inherit Scheduler Flag
---------------------------------------------------------
.. index:: pthread_attr_setinheritsched
.. index:: set inherit scheduler flag

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setinheritsched(
        pthread_attr_t *attr,
        int             inheritsched
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The specified scheduler inheritance argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_setinheritsched`` routine is used to set the inherit
scheduler field in the thread attribute object ``attr`` to the value specified
by ``inheritsched``.

The ``contentionscope`` must be either ``PTHREAD_INHERIT_SCHED`` to indicate
that the thread is to inherit the scheduling policy and parameters fromthe
creating thread, or ``PTHREAD_EXPLICIT_SCHED`` to indicate that the scheduling
policy and parameters for this thread are to be set from the corresponding
values in the attributes object.  If ``contentionscope`` is
``PTHREAD_INHERIT_SCHED``, then the scheduling attributes in the ``attr``
structure will be ignored at thread creation time.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_getinheritsched:

pthread_attr_getinheritsched - Get Inherit Scheduler Flag
---------------------------------------------------------
.. index:: pthread_attr_getinheritsched
.. index:: get inherit scheduler flag

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getinheritsched(
        const pthread_attr_t *attr,
        int                  *inheritsched
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The inheritsched pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_getinheritsched`` routine is used to object the current
value of the inherit scheduler field in the thread attribute object ``attr``.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_setschedpolicy:

pthread_attr_setschedpolicy - Set Scheduling Policy
---------------------------------------------------
.. index:: pthread_attr_setschedpolicy
.. index:: set scheduling policy

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setschedpolicy(
        pthread_attr_t *attr,
        int             policy
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``ENOTSUP``
   - The specified scheduler policy argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_setschedpolicy`` routine is used to set the scheduler policy
field in the thread attribute object ``attr`` to the value specified by
``policy``.

Scheduling policies may be one of the following:

- ``SCHED_DEFAULT``

- ``SCHED_FIFO``

- ``SCHED_RR``

- ``SCHED_SPORADIC``

- ``SCHED_OTHER``

The precise meaning of each of these is discussed elsewhere in this manual.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_getschedpolicy:

pthread_attr_getschedpolicy - Get Scheduling Policy
---------------------------------------------------
.. index:: pthread_attr_getschedpolicy
.. index:: get scheduling policy

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getschedpolicy(
        const pthread_attr_t *attr,
        int                  *policy
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The specified scheduler policy argument pointer is invalid.

**DESCRIPTION:**

The ``pthread_attr_getschedpolicy`` routine is used to obtain the scheduler
policy field from the thread attribute object ``attr``.  The value of this
field is returned in ``policy``.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_setschedparam:

pthread_attr_setschedparam - Set Scheduling Parameters
------------------------------------------------------
.. index:: pthread_attr_setschedparam
.. index:: set scheduling parameters

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_setschedparam(
        pthread_attr_t           *attr,
        const struct sched_param  param
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The specified scheduler parameter argument is invalid.

**DESCRIPTION:**

The ``pthread_attr_setschedparam`` routine is used to set the scheduler
parameters field in the thread attribute object ``attr`` to the value specified
by ``param``.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_getschedparam:

pthread_attr_getschedparam - Get Scheduling Parameters
------------------------------------------------------
.. index:: pthread_attr_getschedparam
.. index:: get scheduling parameters

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_attr_getschedparam(
        const pthread_attr_t *attr,
        struct sched_param   *param
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute pointer argument is invalid.
 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The specified scheduler parameter argument pointer is invalid.

**DESCRIPTION:**

The ``pthread_attr_getschedparam`` routine is used to obtain the scheduler
parameters field from the thread attribute object ``attr``.  The value of this
field is returned in ``param``.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_attr_getaffinity_np:

pthread_attr_getaffinity_np - Get Thread Affinity Attribute
-----------------------------------------------------------

**CALLING SEQUENCE:**

.. code-block:: c

    #define _GNU_SOURCE
    #include <pthread.h>
    int pthread_attr_getaffinity_np(
        const pthread_attr_t *attr,
        size_t                cpusetsize,
        cpu_set_t            *cpuset
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EFAULT``
   - The attribute pointer argument is invalid.
 * - ``EFAULT``
   - The cpuset pointer argument is invalid.
 * - ``EINVAL``
   - The ``cpusetsize`` does not match the value of ``affinitysetsize`` field
     in the thread attribute object.

**DESCRIPTION:**

The ``pthread_attr_getaffinity_np`` routine is used to obtain the
``affinityset`` field from the thread attribute object ``attr``.  The value of
this field is returned in ``cpuset``.

**NOTES:**

NONE

.. _pthread_attr_setaffinity_np:

pthread_attr_setaffinity_np - Set Thread Affinity Attribute
-----------------------------------------------------------

**CALLING SEQUENCE:**

.. code-block:: c

    #define _GNU_SOURCE
    #include <pthread.h>
    int pthread_attr_setaffinity_np(
        pthread_attr_t    *attr,
        size_t             cpusetsize,
        const cpu_set_t   *cpuset
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EFAULT``
   - The attribute pointer argument is invalid.
 * - ``EFAULT``
   - The cpuset pointer argument is invalid.
 * - ``EINVAL``
   - The ``cpusetsize`` does not match the value of ``affinitysetsize`` field
     in the thread attribute object.
 * - ``EINVAL``
   - The ``cpuset`` did not select a valid cpu.
 * - ``EINVAL``
   - The ``cpuset`` selected a cpu that was invalid.

**DESCRIPTION:**

The ``pthread_attr_setaffinity_np`` routine is used to set the ``affinityset``
field in the thread attribute object ``attr``.  The value of this field is
returned in ``cpuset``.

**NOTES:**

NONE

.. _pthread_create:

pthread_create - Create a Thread
--------------------------------
.. index:: pthread_create
.. index:: create a thread

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_create(
        pthread_t             *thread,
        const pthread_attr_t  *attr,
        void                 (*start_routine)( void *),
        void                  *arg
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The attribute set is not initialized.
 * - ``EINVAL``
   - The user specified a stack address and the size of the area was not large
     enough to meet this processor's minimum stack requirements.
 * - ``EINVAL``
   - The specified scheduler inheritance policy was invalid.
 * - ``ENOTSUP``
   - The specified contention scope was ``PTHREAD_SCOPE_PROCESS``.
 * - ``EINVAL``
   - The specified thread priority was invalid.
 * - ``EINVAL``
   - The specified scheduling policy was invalid.
 * - ``EINVAL``
   - The scheduling policy was ``SCHED_SPORADIC`` and the specified
     replenishment period is less than the initial budget.
 * - ``EINVAL``
   - The scheduling policy was ``SCHED_SPORADIC`` and the specified low
     priority is invalid.
 * - ``EAGAIN``
   - The system lacked the necessary resources to create another thread, or the
     self imposed limit on the total number of threads in a process
     ``PTHREAD_THREAD_MAX`` would be exceeded.
 * - ``EINVAL``
   - Invalid argument passed.

**DESCRIPTION:**

The ``pthread_create`` routine is used to create a new thread with the
attributes specified by ``attr``. If the ``attr`` argument is ``NULL``, then
the default attribute set will be used. Modification of the contents of
``attr`` after this thread is created does not have an impact on this thread.

The thread begins execution at the address specified by ``start_routine`` with
``arg`` as its only argument. If ``start_routine`` returns, then it is
functionally equivalent to the thread executing the ``pthread_exit`` service.

Upon successful completion, the ID of the created thread is returned in the
``thread`` argument.

**NOTES:**

There is no concept of a single main thread in RTEMS as there is in a tradition
UNIX system. POSIX requires that the implicit return of the main thread results
in the same effects as if there were a call to ``exit``. This does not occur in
RTEMS.

The signal mask of the newly created thread is inherited from its creator and
the set of pending signals for this thread is empty.

.. _pthread_exit:

pthread_exit - Terminate the Current Thread
-------------------------------------------
.. index:: pthread_exit
.. index:: terminate the current thread

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    void pthread_exit(
        void *status
    );

**STATUS CODES:**

*NONE*

**DESCRIPTION:**

The ``pthread_exit`` routine is used to terminate the calling thread.  The
``status`` is made available to any successful join with the terminating
thread.

When a thread returns from its start routine, it results in an implicit call to
the ``pthread_exit`` routine with the return value of the function serving as
the argument to ``pthread_exit``.

**NOTES:**

Any cancellation cleanup handlers that hace been pushed and not yet popped
shall be popped in reverse of the order that they were pushed. After all
cancellation cleanup handlers have been executed, if the thread has any
thread-specific data, destructors for that data will be invoked.

Thread termination does not release or free any application visible resources
including byt not limited to mutexes, file descriptors, allocated memory,
etc.. Similarly, exitting a thread does not result in any process-oriented
cleanup activity.

There is no concept of a single main thread in RTEMS as there is in a tradition
UNIX system. POSIX requires that the implicit return of the main thread results
in the same effects as if there were a call to ``exit``. This does not occur in
RTEMS.

All access to any automatic variables allocated by the threads is lost when the
thread exits. Thus references (i.e. pointers) to local variables of a thread
should not be used in a global manner without care. As a specific example, a
pointer to a local variable should NOT be used as the return value.

.. _pthread_detach:

pthread_detach - Detach a Thread
--------------------------------
.. index:: pthread_detach
.. index:: detach a thread

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_detach(
        pthread_t thread
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``ESRCH``
   - The thread specified is invalid.
 * - ``EINVAL``
   - The thread specified is not a joinable thread.

**DESCRIPTION:**

The ``pthread_detach`` routine is used to to indicate that storage for
``thread`` can be reclaimed when the thread terminates without another thread
joinging with it.

**NOTES:**

If any threads have previously joined with the specified thread, then they will
remain joined with that thread. Any subsequent calls to ``pthread_join`` on the
specified thread will fail.

.. COMMENT: pthread_getattr_np

.. _pthread_getattr_np:

pthread_getattr_np - Get Thread Attributes
------------------------------------------
.. index:: pthread_getattr_np
.. index:: get thread attributes

**CALLING SEQUENCE:**

.. code-block:: c

    #define _GNU_SOURCE
    #include <pthread.h>
    int pthread_getattr_np(
        pthread_t       thread,
        pthread_attr_t *attr
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``ESRCH``
   - The thread specified is invalid.
 * - ``EINVAL``
   - The attribute pointer argument is invalid.

**DESCRIPTION:**

The ``pthread_getattr_np`` routine is used to obtain the attributes associated
with ``thread``.

**NOTES:**

Modification of the execution modes and priority through the Classic API may
result in a combination that is not representable in the POSIX API.

.. _pthread_join:

pthread_join - Wait for Thread Termination
------------------------------------------
.. index:: pthread_join
.. index:: wait for thread termination

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_join(
        pthread_t    thread,
        void       **value_ptr
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``ESRCH``
   - The thread specified is invalid.
 * - ``EINVAL``
   - The thread specified is not a joinable thread.
 * - ``EDEADLK``
   - A deadlock was detected or thread is the calling thread.

**DESCRIPTION:**

The ``pthread_join`` routine suspends execution of the calling thread until
``thread`` terminates. If ``thread`` has already terminated, then this routine
returns immediately. The value returned by ``thread`` (i.e. passed to
``pthread_exit`` is returned in ``value_ptr``.

When this routine returns, then ``thread`` has been terminated.

**NOTES:**

The results of multiple simultaneous joins on the same thread is undefined.

If any threads have previously joined with the specified thread, then they will
remain joined with that thread. Any subsequent calls to ``pthread_join`` on the
specified thread will fail.

If value_ptr is NULL, then no value is returned.

.. _pthread_self:

pthread_self - Get Thread ID
----------------------------
.. index:: pthread_self
.. index:: get thread id

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    pthread_t pthread_self( void );

**STATUS CODES:**

The value returned is the ID of the calling thread.

**DESCRIPTION:**

This routine returns the ID of the calling thread.

**NOTES:**

NONE

.. _pthread_equal:

pthread_equal - Compare Thread IDs
----------------------------------
.. index:: pthread_equal
.. index:: compare thread ids

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_equal(
        pthread_t t1,
        pthread_t t2
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``zero``
   - The thread ids are not equal.
 * - ``non-zero``
   - The thread ids are equal.

**DESCRIPTION:**

The ``pthread_equal`` routine is used to compare two thread IDs and determine
if they are equal.

**NOTES:**

The behavior is undefined if the thread IDs are not valid.

.. _pthread_once:

pthread_once - Dynamic Package Initialization
---------------------------------------------
.. index:: pthread_once
.. index:: dynamic package initialization

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    pthread_once_t once_control = PTHREAD_ONCE_INIT;
    int pthread_once(
        pthread_once_t   *once_control,
        void            (*init_routine)(void)
    );

**STATUS CODES:**

NONE

**DESCRIPTION:**

The ``pthread_once`` routine is used to provide controlled initialization of
variables. The first call to ``pthread_once`` by any thread with the same
``once_control`` will result in the ``init_routine`` being invoked with no
arguments. Subsequent calls to ``pthread_once`` with the same ``once_control``
will have no effect.

The ``init_routine`` is guaranteed to have run to completion when this routine
returns to the caller.

**NOTES:**

The behavior of ``pthread_once`` is undefined if ``once_control`` is automatic
storage (i.e. on a task stack) or is not initialized using
``PTHREAD_ONCE_INIT``.

.. _pthread_setschedparam:

pthread_setschedparam - Set Thread Scheduling Parameters
--------------------------------------------------------
.. index:: pthread_setschedparam
.. index:: set thread scheduling parameters

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_setschedparam(
        pthread_t           thread,
        int                 policy,
        struct sched_param *param
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The scheduling parameters indicated by the parameter param is invalid.
 * - ``EINVAL``
   - The value specified by policy is invalid.
 * - ``EINVAL``
   - The scheduling policy was ``SCHED_SPORADIC`` and the specified
     replenishment period is less than the initial budget.
 * - ``EINVAL``
   - The scheduling policy was ``SCHED_SPORADIC`` and the specified low
     priority is invalid.
 * - ``ESRCH``
   - The thread indicated was invalid.

**DESCRIPTION:**

The ``pthread_setschedparam`` routine is used to set the scheduler parameters
currently associated with the thread specified by ``thread`` to the policy
specified by ``policy``. The contents of ``param`` are interpreted based upon
the ``policy`` argument.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. _pthread_getschedparam:

pthread_getschedparam - Get Thread Scheduling Parameters
--------------------------------------------------------
.. index:: pthread_getschedparam
.. index:: get thread scheduling parameters

**CALLING SEQUENCE:**

.. code-block:: c

    #include <pthread.h>
    int pthread_getschedparam(
        pthread_t           thread,
        int                *policy,
        struct sched_param *param
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EINVAL``
   - The policy pointer argument is invalid.
 * - ``EINVAL``
   - The scheduling parameters pointer argument is invalid.
 * - ``ESRCH``
   - The thread indicated by the parameter thread is invalid.

**DESCRIPTION:**

The ``pthread_getschedparam`` routine is used to obtain the scheduler policy
and parameters associated with ``thread``.  The current policy and associated
parameters values returned in``policy`` and ``param``, respectively.

**NOTES:**

As required by POSIX, RTEMS defines the feature symbol
``_POSIX_THREAD_PRIORITY_SCHEDULING`` to indicate that the family of routines
to which this routine belongs is supported.

.. COMMENT: pthread_getaffinity_np

.. _pthread_getaffinity_np:

pthread_getaffinity_np - Get Thread Affinity
--------------------------------------------

**CALLING SEQUENCE:**

.. code-block:: c

    #define _GNU_SOURCE
    #include <pthread.h>
    int pthread_getaffinity_np(
        const pthread_t       id,
        size_t                cpusetsize,
        cpu_set_t            *cpuset
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EFAULT``
   - The cpuset pointer argument is invalid.
 * - ``EINVAL``
   - The ``cpusetsize`` does not match the value of ``affinitysetsize`` field
     in the thread attribute object.

**DESCRIPTION:**

The ``pthread_getaffinity_np`` routine is used to obtain the ``affinity.set``
field from the thread control object associated with the ``id``.  The value of
this field is returned in ``cpuset``.

**NOTES:**

NONE

.. COMMENT: pthread_setaffinity_np

.. _pthread_setaffinity_np:

pthread_setaffinity_np - Set Thread Affinity
--------------------------------------------

**CALLING SEQUENCE:**

.. code-block:: c

    #define _GNU_SOURCE
    #include <pthread.h>
    int pthread_setaffinity_np(
        pthread_t          id,
        size_t             cpusetsize,
        const cpu_set_t   *cpuset
    );

**STATUS CODES:**

.. list-table::
 :class: rtems-table

 * - ``EFAULT``
   - The cpuset pointer argument is invalid.
 * - ``EINVAL``
   - The ``cpusetsize`` does not match the value of ``affinitysetsize`` field
     in the thread attribute object.
 * - ``EINVAL``
   - The ``cpuset`` did not select a valid cpu.
 * - ``EINVAL``
   - The ``cpuset`` selected a cpu that was invalid.

**DESCRIPTION:**

The ``pthread_setaffinity_np`` routine is used to set the ``affinityset`` field
of the thread object ``id``.  The value of this field is returned in ``cpuset``

**NOTES:**

NONE