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
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
|
# SOME DESCRIPTIVE TITLE
# Copyright (C) YEAR Free Software Foundation, Inc.
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2024-03-01 16:52+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#. type: TH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "attributes"
msgstr ""
#. type: TH
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
#, no-wrap
msgid "2023-11-01"
msgstr ""
#. type: TH
#: archlinux fedora-40 fedora-rawhide mageia-cauldron
#, no-wrap
msgid "Linux man-pages 6.06"
msgstr ""
#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "NAME"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid "attributes - POSIX safety concepts"
msgstr ""
#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "DESCRIPTION"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"I<Note>: the text of this man page is based on the material taken from the "
"\"POSIX Safety Concepts\" section of the GNU C Library manual. Further "
"details on the topics described here can be found in that manual."
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Various function manual pages include a section ATTRIBUTES that describes "
"the safety of calling the function in various contexts. This section "
"annotates functions with the following safety markings:"
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<MT-Safe>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"I<MT-Safe> or Thread-Safe functions are safe to call in the presence of "
"other threads. MT, in MT-Safe, stands for Multi Thread."
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Being MT-Safe does not imply a function is atomic, nor that it uses any of "
"the memory synchronization mechanisms POSIX exposes to users. It is even "
"possible that calling MT-Safe functions in sequence does not yield an MT-"
"Safe combination. For example, having a thread call two MT-Safe functions "
"one right after the other does not guarantee behavior equivalent to atomic "
"execution of a combination of both functions, since concurrent calls in "
"other threads may interfere in a destructive way."
msgstr ""
#
#
#
#. #-#-#-#-# archlinux: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# debian-bookworm: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancellation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# debian-unstable: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# fedora-40: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# fedora-rawhide: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# mageia-cauldron: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# opensuse-leap-15-6: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#. #-#-#-#-# opensuse-tumbleweed: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. .TP
#. .I AS-Safe
#. .I AS-Safe
#. or Async-Signal-Safe functions are safe to call from
#. asynchronous signal handlers.
#. AS, in AS-Safe, stands for Asynchronous Signal.
#. Many functions that are AS-Safe may set
#. .IR errno ,
#. or modify the floating-point environment,
#. because their doing so does not make them
#. unsuitable for use in signal handlers.
#. However, programs could misbehave should asynchronous signal handlers
#. modify this thread-local state,
#. and the signal handling machinery cannot be counted on to
#. preserve it.
#. Therefore, signal handlers that call functions that may set
#. .I errno
#. or modify the floating-point environment
#. .I must
#. save their original values, and restore them before returning.
#. .TP
#. .I AC-Safe
#. .I AC-Safe
#. or Async-Cancel-Safe functions are safe to call when
#. asynchronous cancelation is enabled.
#. AC in AC-Safe stands for Asynchronous Cancelation.
#. The POSIX standard defines only three functions to be AC-Safe, namely
#. .BR pthread_cancel (3),
#. .BR pthread_setcancelstate (3),
#. and
#. .BR pthread_setcanceltype (3).
#. At present the GNU C Library provides no
#. guarantees beyond these three functions,
#. but does document which functions are presently AC-Safe.
#. This documentation is provided for use
#. by the GNU C Library developers.
#. Just like signal handlers, cancelation cleanup routines must configure
#. the floating point environment they require.
#. The routines cannot assume a floating point environment,
#. particularly when asynchronous cancelation is enabled.
#. If the configuration of the floating point
#. environment cannot be performed atomically then it is also possible that
#. the environment encountered is internally inconsistent.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Whole-program optimizations that could inline functions across library "
"interfaces may expose unsafe reordering, and so performing inlining across "
"the GNU C Library interface is not recommended. The documented MT-Safety "
"status is not guaranteed under whole-program optimization. However, "
"functions defined in user-visible headers are designed to be safe for "
"inlining."
msgstr ""
#. ", " AS-Unsafe ", " AC-Unsafe
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<MT-Unsafe>"
msgstr ""
#
#
#
#
#
#
#. ", " AS-Unsafe ", " AC-Unsafe
#. functions are not
#. safe to call within the safety contexts described above.
#. Calling them
#. within such contexts invokes undefined behavior.
#. Functions not explicitly documented as safe in a safety context should
#. be regarded as Unsafe.
#. .TP
#. .I Preliminary
#. .I Preliminary
#. safety properties are documented, indicating these
#. properties may
#. .I not
#. be counted on in future releases of
#. the GNU C Library.
#. Such preliminary properties are the result of an assessment of the
#. properties of our current implementation,
#. rather than of what is mandated and permitted
#. by current and future standards.
#. Although we strive to abide by the standards, in some cases our
#. implementation is safe even when the standard does not demand safety,
#. and in other cases our implementation does not meet the standard safety
#. requirements.
#. The latter are most likely bugs; the former, when marked
#. as
#. .IR Preliminary ,
#. should not be counted on: future standards may
#. require changes that are not compatible with the additional safety
#. properties afforded by the current implementation.
#. Furthermore,
#. the POSIX standard does not offer a detailed definition of safety.
#. We assume that, by "safe to call", POSIX means that,
#. as long as the program does not invoke undefined behavior,
#. the "safe to call" function behaves as specified,
#. and does not cause other functions to deviate from their specified behavior.
#. We have chosen to use its loose
#. definitions of safety, not because they are the best definitions to use,
#. but because choosing them harmonizes this manual with POSIX.
#. Please keep in mind that these are preliminary definitions and annotations,
#. and certain aspects of the definitions are still under
#. discussion and might be subject to clarification or change.
#. Over time,
#. we envision evolving the preliminary safety notes into stable commitments,
#. as stable as those of our interfaces.
#. As we do, we will remove the
#. .I Preliminary
#. keyword from safety notes.
#. As long as the keyword remains, however,
#. they are not to be regarded as a promise of future behavior.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"I<MT-Unsafe> functions are not safe to call in a multithreaded programs."
msgstr ""
#
#
#
#
#
#
#
#
#
#
#
#. .SS Unsafe features
#. Functions that are unsafe to call in certain contexts are annotated with
#. keywords that document their features that make them unsafe to call.
#. AS-Unsafe features in this section indicate the functions are never safe
#. to call when asynchronous signals are enabled.
#. AC-Unsafe features
#. indicate they are never safe to call when asynchronous cancelation is
#. .\" enabled.
#. There are no MT-Unsafe marks in this section.
#. .TP
#. .\" .I code
#. Functions marked with
#. .I lock
#. as an AS-Unsafe feature may be
#. .\" interrupted by a signal while holding a non-recursive lock.
#. If the signal handler calls another such function that takes the same lock,
#. the result is a deadlock.
#. Functions annotated with
#. .I lock
#. as an AC-Unsafe feature may, if canceled asynchronously,
#. fail to release a lock that would have been released if their execution
#. had not been interrupted by asynchronous thread cancelation.
#. Once a lock is left taken,
#. attempts to take that lock will block indefinitely.
#. .TP
#. .I corrupt
#. Functions marked with
#. .\" .I corrupt
#. as an AS-Unsafe feature may corrupt
#. data structures and misbehave when they interrupt,
#. or are interrupted by, another such function.
#. Unlike functions marked with
#. .IR lock ,
#. these take recursive locks to avoid MT-Safety problems,
#. but this is not enough to stop a signal handler from observing
#. a partially-updated data structure.
#. Further corruption may arise from the interrupted function's
#. failure to notice updates made by signal handlers.
#. Functions marked with
#. .I corrupt
#. as an AC-Unsafe feature may leave
#. data structures in a corrupt, partially updated state.
#. Subsequent uses of the data structure may misbehave.
#. .\" A special case, probably not worth documenting separately, involves
#. .\" reallocing, or even freeing pointers. Any case involving free could
#. .\" be easily turned into an ac-safe leak by resetting the pointer before
#. .\" releasing it; I don't think we have any case that calls for this sort
#. .\" of fixing. Fixing the realloc cases would require a new interface:
#. .\" instead of @code{ptr=realloc(ptr,size)} we'd have to introduce
#. .\" @code{acsafe_realloc(&ptr,size)} that would modify ptr before
#. .\" releasing the old memory. The ac-unsafe realloc could be implemented
#. .\" in terms of an internal interface with this semantics (say
#. .\" __acsafe_realloc), but since realloc can be overridden, the function
#. .\" we call to implement realloc should not be this internal interface,
#. .\" but another internal interface that calls __acsafe_realloc if realloc
#. .\" was not overridden, and calls the overridden realloc with async
#. .\" cancel disabled. --lxoliva
#. .TP
#. .I heap
#. Functions marked with
#. .I heap
#. may call heap memory management functions from the
#. .BR malloc (3)/ free (3)
#. family of functions and are only as safe as those functions.
#. This note is thus equivalent to:
#. | AS-Unsafe lock | AC-Unsafe lock fd mem |
#. .\" @sampsafety{@asunsafe{@asulock{}}@acunsafe{@aculock{} @acsfd{} @acsmem{}}}
#. .\"
#. .\" Check for cases that should have used plugin instead of or in
#. .\" addition to this. Then, after rechecking gettext, adjust i18n if
#. .\" needed.
#. .TP
#. .I dlopen
#. Functions marked with
#. .I dlopen
#. use the dynamic loader to load
#. shared libraries into the current execution image.
#. This involves opening files, mapping them into memory,
#. allocating additional memory, resolving symbols,
#. applying relocations and more,
#. all of this while holding internal dynamic loader locks.
#. The locks are enough for these functions to be AS-Unsafe and AC-Unsafe,
#. but other issues may arise.
#. At present this is a placeholder for all
#. potential safety issues raised by
#. .BR dlopen (3).
#. .\" dlopen runs init and fini sections of the module; does this mean
#. .\" dlopen always implies plugin?
#. .TP
#. .I plugin
#. Functions annotated with
#. .I plugin
#. may run code from plugins that
#. may be external to the GNU C Library.
#. Such plugin functions are assumed to be
#. MT-Safe, AS-Unsafe and AC-Unsafe.
#. Examples of such plugins are stack unwinding libraries,
#. name service switch (NSS) and character set conversion (iconv) back-ends.
#. Although the plugins mentioned as examples are all brought in by means
#. of dlopen, the
#. .I plugin
#. keyword does not imply any direct
#. involvement of the dynamic loader or the
#. .I libdl
#. interfaces,
#. those are covered by
#. .IR dlopen .
#. For example, if one function loads a module and finds the addresses
#. of some of its functions,
#. while another just calls those already-resolved functions,
#. the former will be marked with
#. .IR dlopen ,
#. whereas the latter will get the
#. .IR plugin .
#. When a single function takes all of these actions, then it gets both marks.
#. .TP
#. .I i18n
#. Functions marked with
#. .I i18n
#. may call internationalization
#. functions of the
#. .BR gettext (3)
#. family and will be only as safe as those
#. functions.
#. This note is thus equivalent to:
#. | MT-Safe env | AS-Unsafe corrupt heap dlopen | AC-Unsafe corrupt |
#. .\" @sampsafety{@mtsafe{@mtsenv{}}@asunsafe{@asucorrupt{} @ascuheap{} @ascudlopen{}}@acunsafe{@acucorrupt{}}}
#. .TP
#. .I timer
#. Functions marked with
#. .I timer
#. use the
#. .BR alarm (3)
#. function or
#. similar to set a time-out for a system call or a long-running operation.
#. In a multi-threaded program, there is a risk that the time-out signal
#. will be delivered to a different thread,
#. thus failing to interrupt the intended thread.
#. Besides being MT-Unsafe, such functions are always
#. AS-Unsafe, because calling them in signal handlers may interfere with
#. timers set in the interrupted code, and AC-Unsafe,
#. because there is no safe way to guarantee an earlier timer
#. will be reset in case of asynchronous cancelation.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Other keywords that appear in safety notes are defined in subsequent "
"sections."
msgstr ""
#. type: SS
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "Conditionally safe features"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"For some features that make functions unsafe to call in certain contexts, "
"there are known ways to avoid the safety problem other than refraining from "
"calling the function altogether. The keywords that follow refer to such "
"features, and each of their definitions indicates how the whole program "
"needs to be constrained in order to remove the safety problem indicated by "
"the keyword. Only when all the reasons that make a function unsafe are "
"observed and addressed, by applying the documented constraints, does the "
"function become safe to call in a context."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<init>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<init> as an MT-Unsafe feature perform MT-Unsafe "
"initialization when they are first called."
msgstr ""
#
#
#
#
#
#. Functions marked with
#. .I init
#. as an AS-Unsafe or AC-Unsafe feature use the GNU C Library internal
#. .I libc_once
#. machinery or similar to initialize internal data structures.
#. If a signal handler interrupts such an initializer,
#. and calls any function that also performs
#. .I libc_once
#. initialization, it will deadlock if the thread library has been loaded.
#. Furthermore, if an initializer is partially complete before it is canceled
#. or interrupted by a signal whose handler requires the same initialization,
#. some or all of the initialization may be performed more than once,
#. leaking resources or even resulting in corrupt internal data.
#. Applications that need to call functions marked with
#. .I init
#. as an AS-Safety or AC-Unsafe feature should ensure
#. the initialization is performed
#. before configuring signal handlers or enabling cancelation,
#. so that the AS-Safety and AC-Safety issues related with
#. .I libc_once
#. do not arise.
#. .\" We may have to extend the annotations to cover conditions in which
#. .\" initialization may or may not occur, since an initial call in a safe
#. .\" context is no use if the initialization doesn't take place at that
#. .\" time: it doesn't remove the risk for later calls.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Calling such a function at least once in single-threaded mode removes this "
"specific cause for the function to be regarded as MT-Unsafe. If no other "
"cause for that remains, the function can then be safely called after other "
"threads are started."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<race>"
msgstr ""
#
#
#
#
#
#
#
#. #-#-#-#-# archlinux: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-null pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# debian-bookworm: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-NULL pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# debian-unstable: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-NULL pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# fedora-40: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-null pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# fedora-rawhide: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-null pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# mageia-cauldron: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-null pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# opensuse-leap-15-6: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-NULL pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#. #-#-#-#-# opensuse-tumbleweed: attributes.7.pot (PACKAGE VERSION) #-#-#-#-#
#. We consider access to objects passed as (indirect) arguments to
#. functions to be data race free.
#. The assurance of data race free objects
#. is the caller's responsibility.
#. We will not mark a function as MT-Unsafe or AS-Unsafe
#. if it misbehaves when users fail to take the measures required by
#. POSIX to avoid data races when dealing with such objects.
#. As a general rule, if a function is documented as reading from
#. an object passed (by reference) to it, or modifying it,
#. users ought to use memory synchronization primitives
#. to avoid data races just as they would should they perform
#. the accesses themselves rather than by calling the library function.
#. Standard I/O
#. .RI ( "FILE *" )
#. streams are the exception to the general rule,
#. in that POSIX mandates the library to guard against data races
#. in many functions that manipulate objects of this specific opaque type.
#. We regard this as a convenience provided to users,
#. rather than as a general requirement whose expectations
#. should extend to other types.
#. In order to remind users that guarding certain arguments is their
#. responsibility, we will annotate functions that take objects of certain
#. types as arguments.
#. We draw the line for objects passed by users as follows:
#. objects whose types are exposed to users,
#. and that users are expected to access directly,
#. such as memory buffers, strings,
#. and various user-visible structured types, do
#. .I not
#. give reason for functions to be annotated with
#. .IR race .
#. It would be noisy and redundant with the general requirement,
#. and not many would be surprised by the library's lack of internal
#. guards when accessing objects that can be accessed directly by users.
#. As for objects that are opaque or opaque-like,
#. in that they are to be manipulated only by passing them
#. to library functions (e.g.,
#. .IR FILE ,
#. .IR DIR ,
#. .IR obstack ,
#. .IR iconv_t ),
#. there might be additional expectations as to internal coordination
#. of access by the library.
#. We will annotate, with
#. .I race
#. followed by a colon and the argument name,
#. functions that take such objects but that do not take
#. care of synchronizing access to them by default.
#. For example,
#. .I FILE
#. stream
#. .I unlocked
#. functions
#. .RB ( unlocked_stdio (3))
#. will be annotated,
#. but those that perform implicit locking on
#. .I FILE
#. streams by default will not,
#. even though the implicit locking may be disabled on a per-stream basis.
#. In either case, we will not regard as MT-Unsafe functions that may
#. access user-supplied objects in unsafe ways should users fail to ensure
#. the accesses are well defined.
#. The notion prevails that users are expected to safeguard against
#. data races any user-supplied objects that the library accesses
#. on their behalf.
#. .\" The above describes @mtsrace; @mtasurace is described below.
#. This user responsibility does not apply, however,
#. to objects controlled by the library itself,
#. such as internal objects and static buffers used
#. to return values from certain calls.
#. When the library doesn't guard them against concurrent uses,
#. these cases are regarded as MT-Unsafe and AS-Unsafe (although the
#. .I race
#. mark under AS-Unsafe will be omitted
#. as redundant with the one under MT-Unsafe).
#. As in the case of user-exposed objects,
#. the mark may be followed by a colon and an identifier.
#. The identifier groups all functions that operate on a
#. certain unguarded object; users may avoid the MT-Safety issues related
#. with unguarded concurrent access to such internal objects by creating a
#. non-recursive mutex related with the identifier,
#. and always holding the mutex when calling any function marked
#. as racy on that identifier,
#. as they would have to should the identifier be
#. an object under user control.
#. The non-recursive mutex avoids the MT-Safety issue,
#. but it trades one AS-Safety issue for another,
#. so use in asynchronous signals remains undefined.
#. When the identifier relates to a static buffer used to hold return values,
#. the mutex must be held for as long as the buffer remains in use
#. by the caller.
#. Many functions that return pointers to static buffers offer reentrant
#. variants that store return values in caller-supplied buffers instead.
#. In some cases, such as
#. .BR tmpname (3),
#. the variant is chosen not by calling an alternate entry point,
#. but by passing a non-NULL pointer to the buffer in which the
#. returned values are to be stored.
#. These variants are generally preferable in multi-threaded programs,
#. although some of them are not MT-Safe because of other internal buffers,
#. also documented with
#. .I race
#. notes.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions annotated with I<race> as an MT-Safety issue operate on objects in "
"ways that may cause data races or similar forms of destructive interference "
"out of concurrent execution. In some cases, the objects are passed to the "
"functions by users; in others, they are used by the functions to return "
"values to users; in others, they are not even exposed to users."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<const>"
msgstr ""
#. and AS-Unsafe,
#. equally
#. and AS-Unsafe
#. and AS-Safe
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<const> as an MT-Safety issue non-atomically modify "
"internal objects that are better regarded as constant, because a substantial "
"portion of the GNU C Library accesses them without synchronization. Unlike "
"I<race>, which causes both readers and writers of internal objects to be "
"regarded as MT-Unsafe, this mark is applied to writers only. Writers remain "
"MT-Unsafe to call, but the then-mandatory constness of objects they modify "
"enables readers to be regarded as MT-Safe (as long as no other reasons for "
"them to be unsafe remain), since the lack of synchronization is not a "
"problem when the objects are effectively constant."
msgstr ""
#
#. The non-recursive locking removes the MT-Safety problem,
#. but it trades one AS-Safety problem for another,
#. so use in asynchronous signals remains undefined.
#. .\" But what if, instead of marking modifiers with const:id and readers
#. .\" with just id, we marked writers with race:id and readers with ro:id?
#. .\" Instead of having to define each instance of 'id', we'd have a
#. .\" general pattern governing all such 'id's, wherein race:id would
#. .\" suggest the need for an exclusive/write lock to make the function
#. .\" safe, whereas ro:id would indicate 'id' is expected to be read-only,
#. .\" but if any modifiers are called (while holding an exclusive lock),
#. .\" then ro:id-marked functions ought to be guarded with a read lock for
#. .\" safe operation. ro:env or ro:locale, for example, seems to convey
#. .\" more clearly the expectations and the meaning, than just env or
#. .\" locale.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"The identifier that follows the I<const> mark will appear by itself as a "
"safety note in readers. Programs that wish to work around this safety "
"issue, so as to call writers, may use a non-recursive read-write lock "
"associated with the identifier, and guard I<all> calls to functions marked "
"with I<const> followed by the identifier with a write lock, and I<all> calls "
"to functions marked with the identifier by itself with a read lock."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<sig>"
msgstr ""
#. (that implies an identical AS-Safety issue, omitted for brevity)
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<sig> as a MT-Safety issue may temporarily install a "
"signal handler for internal purposes, which may interfere with other uses of "
"the signal, identified after a colon."
msgstr ""
#
#
#
#. There is no safe way to guarantee the original signal handler is
#. restored in case of asynchronous cancelation,
#. therefore so-marked functions are also AC-Unsafe.
#. .\" fixme: at least deferred cancelation should get it right, and would
#. .\" obviate the restoring bit below, and the qualifier above.
#. Besides the measures recommended to work around the
#. MT-Safety and AS-Safety problem,
#. in order to avert the cancelation problem,
#. disabling asynchronous cancelation
#. .I and
#. installing a cleanup handler to restore the signal to the desired state
#. and to release the mutex are recommended.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"This safety problem can be worked around by ensuring that no other uses of "
"the signal will take place for the duration of the call. Holding a non-"
"recursive mutex while calling all functions that use the same temporary "
"signal; blocking that signal before the call and resetting its handler "
"afterwards is recommended."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<term>"
msgstr ""
#. The same window enables changes made by asynchronous signals to be lost.
#. These functions are also AS-Unsafe,
#. but the corresponding mark is omitted as redundant.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<term> as an MT-Safety issue may change the terminal "
"settings in the recommended way, namely: call B<tcgetattr>(3), modify some "
"flags, and then call B<tcsetattr>(3), this creates a window in which changes "
"made by other threads are lost. Thus, functions marked with I<term> are MT-"
"Unsafe."
msgstr ""
#
#
#
#. Functions marked with
#. .I term
#. as an AC-Safety issue are supposed to
#. restore terminal settings to their original state,
#. after temporarily changing them, but they may fail to do so if canceled.
#. .\" fixme: at least deferred cancelation should get it right, and would
#. .\" obviate the restoring bit below, and the qualifier above.
#. Besides the measures recommended to work around the
#. MT-Safety and AS-Safety problem,
#. in order to avert the cancelation problem,
#. disabling asynchronous cancelation
#. .I and
#. installing a cleanup handler to
#. restore the terminal settings to the original state and to release the
#. mutex are recommended.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"It is thus advisable for applications using the terminal to avoid concurrent "
"and reentrant interactions with it, by not using it in signal handlers or "
"blocking signals that might use it, and holding a lock while calling these "
"functions and interacting with the terminal. This lock should also be used "
"for mutual exclusion with functions marked with I<race:tcattr(fd)>, where "
"I<fd> is a file descriptor for the controlling terminal. The caller may use "
"a single mutex for simplicity, or use one mutex per terminal, even if "
"referenced by different file descriptors."
msgstr ""
#. type: SS
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "Other safety remarks"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Additional keywords may be attached to functions, indicating features that "
"do not make a function unsafe to call, but that may need to be taken into "
"account in certain classes of programs:"
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<locale>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions annotated with I<locale> as an MT-Safety issue read from the "
"locale object without any form of synchronization. Functions annotated with "
"I<locale> called concurrently with locale changes may behave in ways that do "
"not correspond to any of the locales active during their execution, but an "
"unpredictable mix thereof."
msgstr ""
#. or AS-Unsafe,
#. Should the locking strategy suggested under @code{const} be used,
#. failure to guard locale uses is not as fatal as data races in
#. general: unguarded uses will @emph{not} follow dangling pointers or
#. access uninitialized, unmapped or recycled memory. Each access will
#. read from a consistent locale object that is or was active at some
#. point during its execution. Without synchronization, however, it
#. cannot even be assumed that, after a change in locale, earlier
#. locales will no longer be used, even after the newly-chosen one is
#. used in the thread. Nevertheless, even though unguarded reads from
#. the locale will not violate type safety, functions that access the
#. locale multiple times may invoke all sorts of undefined behavior
#. because of the unexpected locale changes.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"We do not mark these functions as MT-Unsafe, however, because functions that "
"modify the locale object are marked with I<const:locale> and regarded as "
"unsafe. Being unsafe, the latter are not to be called when multiple threads "
"are running or asynchronous signals are enabled, and so the locale can be "
"considered effectively constant in these contexts, which makes the former "
"safe."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<env>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<env> as an MT-Safety issue access the environment "
"with B<getenv>(3) or similar, without any guards to ensure safety in the "
"presence of concurrent modifications."
msgstr ""
#. or AS-Unsafe,
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"We do not mark these functions as MT-Unsafe, however, because functions that "
"modify the environment are all marked with I<const:env> and regarded as "
"unsafe. Being unsafe, the latter are not to be called when multiple threads "
"are running or asynchronous signals are enabled, and so the environment can "
"be considered effectively constant in these contexts, which makes the former "
"safe."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<hostid>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"The function marked with I<hostid> as an MT-Safety issue reads from the "
"system-wide data structures that hold the \"host ID\" of the machine. These "
"data structures cannot generally be modified atomically. Since it is "
"expected that the \"host ID\" will not normally change, the function that "
"reads from it (B<gethostid>(3)) is regarded as safe, whereas the function "
"that modifies it (B<sethostid>(3)) is marked with I<const:hostid>, "
"indicating it may require special care if it is to be called. In this "
"specific case, the special care amounts to system-wide (not merely intra-"
"process) coordination."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<sigintr>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<sigintr> as an MT-Safety issue access the GNU C "
"Library I<_sigintr> internal data structure without any guards to ensure "
"safety in the presence of concurrent modifications."
msgstr ""
#
#
#
#
#
#. or AS-Unsafe,
#. .TP
#. .I fd
#. Functions annotated with
#. .I fd
#. as an AC-Safety issue may leak file
#. descriptors if asynchronous thread cancelation interrupts their
#. execution.
#. Functions that allocate or deallocate file descriptors will generally be
#. marked as such.
#. Even if they attempted to protect the file descriptor
#. allocation and deallocation with cleanup regions,
#. allocating a new descriptor and storing its number where the cleanup region
#. could release it cannot be performed as a single atomic operation.
#. Similarly,
#. releasing the descriptor and taking it out of the data structure
#. normally responsible for releasing it cannot be performed atomically.
#. There will always be a window in which the descriptor cannot be released
#. because it was not stored in the cleanup handler argument yet,
#. or it was already taken out before releasing it.
#. .\" It cannot be taken out after release:
#. an open descriptor could mean either that the descriptor still
#. has to be closed,
#. or that it already did so but the descriptor was
#. reallocated by another thread or signal handler.
#. Such leaks could be internally avoided, with some performance penalty,
#. by temporarily disabling asynchronous thread cancelation.
#. However,
#. since callers of allocation or deallocation functions would have to do
#. this themselves, to avoid the same sort of leak in their own layer,
#. it makes more sense for the library to assume they are taking care of it
#. than to impose a performance penalty that is redundant when the problem
#. is solved in upper layers, and insufficient when it is not.
#. This remark by itself does not cause a function to be regarded as
#. AC-Unsafe.
#. However, cumulative effects of such leaks may pose a
#. problem for some programs.
#. If this is the case,
#. suspending asynchronous cancelation for the duration of calls
#. to such functions is recommended.
#. .TP
#. .I mem
#. Functions annotated with
#. .I mem
#. as an AC-Safety issue may leak
#. memory if asynchronous thread cancelation interrupts their execution.
#. The problem is similar to that of file descriptors: there is no atomic
#. interface to allocate memory and store its address in the argument to a
#. cleanup handler,
#. or to release it and remove its address from that argument,
#. without at least temporarily disabling asynchronous cancelation,
#. which these functions do not do.
#. This remark does not by itself cause a function to be regarded as
#. generally AC-Unsafe.
#. However, cumulative effects of such leaks may be
#. severe enough for some programs that disabling asynchronous cancelation
#. for the duration of calls to such functions may be required.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"We do not mark these functions as MT-Unsafe, however, because functions that "
"modify this data structure are all marked with I<const:sigintr> and regarded "
"as unsafe. Being unsafe, the latter are not to be called when multiple "
"threads are running or asynchronous signals are enabled, and so the data "
"structure can be considered effectively constant in these contexts, which "
"makes the former safe."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<cwd>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Functions marked with I<cwd> as an MT-Safety issue may temporarily change "
"the current working directory during their execution, which may cause "
"relative pathnames to be resolved in unexpected ways in other threads or "
"within asynchronous signal or cancelation handlers."
msgstr ""
#
#. or AS-Unsafe,
#. .TP
#. .I !posix
#. This remark, as an MT-Safety, AS-Safety or AC-Safety
#. note to a function,
#. indicates the safety status of the function is known to differ
#. from the specified status in the POSIX standard.
#. For example, POSIX does not require a function to be Safe,
#. but our implementation is, or vice-versa.
#. For the time being, the absence of this remark does not imply the safety
#. properties we documented are identical to those mandated by POSIX for
#. the corresponding functions.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"This is not enough of a reason to mark so-marked functions as MT-Unsafe, but "
"when this behavior is optional (e.g., B<nftw>(3) with B<FTW_CHDIR>), "
"avoiding the option may be a good alternative to using full pathnames or "
"file descriptor-relative (e.g., B<openat>(2)) system calls."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I<:identifier>"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Annotations may sometimes be followed by identifiers, intended to group "
"several functions that, for example, access the data structures in an unsafe "
"way, as in I<race> and I<const>, or to provide more specific information, "
"such as naming a signal in a function marked with I<sig>. It is envisioned "
"that it may be applied to I<lock> and I<corrupt> as well in the future."
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"In most cases, the identifier will name a set of functions, but it may name "
"global objects or function arguments, or identifiable properties or logical "
"components associated with them, with a notation such as, for example, I<:"
"buf(arg)> to denote a buffer associated with the argument I<arg>, or I<:"
"tcattr(fd)> to denote the terminal attributes of a file descriptor I<fd>."
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"The most common use for identifiers is to provide logical groups of "
"functions and arguments that need to be protected by the same "
"synchronization primitive in order to ensure safe operation in a given "
"context."
msgstr ""
#. type: TP
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "I</condition>"
msgstr ""
#. Such conditions as
#. .I /hurd
#. or
#. .I /!linux!bsd
#. indicate the preceding marker only
#. applies when the underlying kernel is the HURD,
#. or when it is neither Linux nor a BSD kernel, respectively.
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"Some safety annotations may be conditional, in that they only apply if a "
"boolean expression involving arguments, global variables or even the "
"underlying kernel evaluates to true. For example, I</!ps> and I</"
"one_per_line> indicate the preceding marker only applies when argument I<ps> "
"is NULL, or global variable I<one_per_line> is nonzero."
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid ""
"When all marks that render a function unsafe are adorned with such "
"conditions, and none of the named conditions hold, then the function can be "
"regarded as safe."
msgstr ""
#. type: SH
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "SEE ALSO"
msgstr ""
#. type: Plain text
#: archlinux debian-bookworm debian-unstable fedora-40 fedora-rawhide
#: mageia-cauldron opensuse-leap-15-6 opensuse-tumbleweed
msgid "B<pthreads>(7), B<signal-safety>(7)"
msgstr ""
#. type: TH
#: debian-bookworm
#, no-wrap
msgid "2022-10-30"
msgstr ""
#. type: TH
#: debian-bookworm
#, no-wrap
msgid "Linux man-pages 6.03"
msgstr ""
#. type: TH
#: debian-unstable opensuse-leap-15-6 opensuse-tumbleweed
#, no-wrap
msgid "2023-03-18"
msgstr ""
#. type: TH
#: debian-unstable opensuse-tumbleweed
#, no-wrap
msgid "Linux man-pages 6.05.01"
msgstr ""
#. type: TH
#: opensuse-leap-15-6
#, no-wrap
msgid "Linux man-pages 6.04"
msgstr ""
|