summaryrefslogtreecommitdiffstats
path: root/posix_users/files_and_directory.rst
blob: a9d95c0921cd1d910267b71e3dbca145d83afaec (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
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
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

Files and Directories Manager
#############################

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

The files and directories manager is ...

The directives provided by the files and directories manager are:

- opendir_ - Open a Directory

- readdir_ - Reads a directory

- rewinddir_ - Resets the ``readdir()`` pointer

- scandir_ - Scan a directory for matching entries

- telldir_ - Return current location in directory stream

- closedir_ - Ends directory read operation

- getdents_ - Get directory entries

- chdir_ - Changes the current working directory

- fchdir_ - Changes the current working directory

- getcwd_ - Gets current working directory

- open_ - Opens a file

- creat_ - Create a new file or rewrite an existing one

- umask_ - Sets a file creation mask

- link_ - Creates a link to a file

- symlink_ - Creates a symbolic link to a file

- readlink_ - Obtain the name of the link destination

- mkdir_ - Makes a directory

- mkfifo_ - Makes a FIFO special file

- unlink_ - Removes a directory entry

- rmdir_ - Delete a directory

- rename_ - Renames a file

- stat_ - Gets information about a file.

- fstat_ - Gets file status

- lstat_ - Gets file status

- access_ - Check permissions for a file.

- chmod_ - Changes file mode

- fchmod_ - Changes permissions of a file

- chown_ - Changes the owner and/ or group of a file

- utime_ - Change access and/or modification times of an inode

- ftruncate_ - Truncate a file to a specified length

- truncate_ - Truncate a file to a specified length

- pathconf_ - Gets configuration values for files

- fpathconf_ - Get configuration values for files

- mknod_ - Create a directory

Background
==========

Path Name Evaluation
--------------------

A pathname is a string that consists of no more than ``PATH_MAX`` bytes,
including the terminating null character. A pathname has an optional beginning
slash, followed by zero or more filenames separated by slashes.  If the
pathname refers to a directory, it may also have one or more trailing
slashes. Multiple successive slahes are considered to be the same as one slash.

POSIX allows a pathname that begins with precisely two successive slashes to be
interpreted in an implementation-defined manner. RTEMS does not currently
recognize this as a special condition. Any number of successive slashes is
treated the same as a single slash. POSIX requires that an implementation treat
more than two leading slashes as a single slash.

Operations
==========

There is currently no text in this section.

Directives
==========

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

.. _opendir:

opendir - Open a Directory
--------------------------
.. index:: opendir
.. index:: open a directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <dirent.h>
    int opendir(
        const char *dirname
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission was denied on a component of the path prefix of
     ``dirname``, or read permission is denied
 * - ``EMFILE``
   - Too many file descriptors in use by process
 * - ``ENFILE``
   - Too many files are currently open in the system.
 * - ``ENOENT``
   - Directory does not exist, or ``name`` is an empty string.
 * - ``ENOMEM``
   - Insufficient memory to complete the operation.
 * - ``ENOTDIR``
   - ``name`` is not a directory.

**DESCRIPTION:**

This routine opens a directory stream corresponding to the
directory specified by the ``dirname`` argument. The
directory stream is positioned at the first entry.

**NOTES:**

The routine is implemented in Cygnus newlib.

.. _readdir:

readdir - Reads a directory
---------------------------
.. index:: readdir
.. index:: reads a directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <dirent.h>
        int readdir(
        DIR *dirp
    );

**STATUS CODES:**

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

 * - ``EBADF``
   - Invalid file descriptor

**DESCRIPTION:**

The ``readdir()`` function returns a pointer to a structure ``dirent``
representing the next directory entry from the directory stream pointed to by
``dirp``. On end-of-file, ``NULL`` is returned.

The ``readdir()`` function may (or may not) return entries for ``.`` or ``..``
Your program should tolerate reading dot and dot-dot but not require them.

The data pointed to be ``readdir()`` may be overwritten by another call to
``readdir()`` for the same directory stream. It will not be overwritten by a
call for another directory.

**NOTES:**

If ``ptr`` is not a pointer returned by ``malloc()``, ``calloc()``, or
``realloc()`` or has been deallocated with ``free()`` or ``realloc()``, the
results are not portable and are probably disastrous.

The routine is implemented in Cygnus newlib.

.. _rewinddir:

rewinddir - Resets the readdir() pointer
----------------------------------------
.. index:: rewinddir
.. index:: resets the readdir() pointer

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <dirent.h>
    void rewinddir(
        DIR *dirp
    );

**STATUS CODES:**

No value is returned.

**DESCRIPTION:**

The ``rewinddir()`` function resets the position associated with the directory
stream pointed to by ``dirp``. It also causes the directory stream to refer to
the current state of the directory.

**NOTES:**

NONE

If ``dirp`` is not a pointer by ``opendir()``, the results are undefined.

The routine is implemented in Cygnus newlib.

.. _scandir:

scandir - Scan a directory for matching entries
-----------------------------------------------
.. index:: scandir
.. index:: scan a directory for matching entries

**CALLING SEQUENCE:**

.. code-block:: c

    #include <dirent.h>
    int scandir(
        const char       *dir,
        struct dirent ***namelist,
        int  (*select)(const struct dirent *),
        int  (*compar)(const struct dirent **, const struct dirent **)
    );

**STATUS CODES:**

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

 * - ``ENOMEM``
   - Insufficient memory to complete the operation.

**DESCRIPTION:**

The ``scandir()`` function scans the directory ``dir``, calling ``select()`` on
each directory entry. Entries for which ``select()`` returns non-zero are
stored in strings allocated via ``malloc()``, sorted using ``qsort()`` with the
comparison function ``compar()``, and collected in array ``namelist`` which is
allocated via ``malloc()``.  If ``select`` is ``NULL``, all entries are
selected.

**NOTES:**

The routine is implemented in Cygnus newlib.

.. _telldir:

telldir - Return current location in directory stream
-----------------------------------------------------
.. index:: telldir
.. index:: return current location in directory stream

**CALLING SEQUENCE:**

.. code-block:: c

    #include <dirent.h>
    off_t telldir(
        DIR *dir
    );

**STATUS CODES:**

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

 * - ``EBADF``
   - Invalid directory stream descriptor ``dir``.

**DESCRIPTION:**

The ``telldir()`` function returns the current location associated with the
directory stream ``dir``.

**NOTES:**

The routine is implemented in Cygnus newlib.

.. _closedir:

closedir - Ends directory read operation
----------------------------------------
.. index:: closedir
.. index:: ends directory read operation

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <dirent.h>
    int closedir(
        DIR *dirp
    );

**STATUS CODES:**

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

 * - ``EBADF``
   - Invalid file descriptor

**DESCRIPTION:**

The directory stream associated with ``dirp`` is closed.  The value in ``dirp``
may not be usable after a call to ``closedir()``.

**NOTES:**

NONE

The argument to ``closedir()`` must be a pointer returned by ``opendir()``. If
it is not, the results are not portable and most likely unpleasant.

The routine is implemented in Cygnus newlib.

.. _chdir:

chdir - Changes the current working directory
---------------------------------------------
.. index:: chdir
.. index:: changes the current working directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int chdir(
        const char *path
    );

**STATUS CODES:**

On error, this routine returns -1 and sets ``errno`` to one of the following:

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when directory
     was expected.

**DESCRIPTION:**

The ``chdir()`` function causes the directory named by ``path`` to become the
current working directory; that is, the starting point for searches of
pathnames not beginning with a slash.

If ``chdir()`` detects an error, the current working directory is not changed.

**NOTES:**

NONE

.. _fchdir:

fchdir - Changes the current working directory
----------------------------------------------
.. index:: fchdir
.. index:: changes the current working directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int fchdir(
        int fd
    );

**STATUS CODES:**

On error, this routine returns -1 and sets ``errno`` to one of the following:

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when directory
     was expected.

**DESCRIPTION:**

The ``fchdir()`` function causes the directory named by ``fd`` to become the
current working directory; that is, the starting point for searches of
pathnames not beginning with a slash.

If ``fchdir()`` detects an error, the current working directory is not changed.

**NOTES:**

NONE

.. _getcwd:

getcwd - Gets current working directory
---------------------------------------
.. index:: getcwd
.. index:: gets current working directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int getcwd( void );

**STATUS CODES:**

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

 * - ``EINVAL``
   - Invalid argument
 * - ``ERANGE``
   - Result is too large
 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.

**DESCRIPTION:**

The ``getcwd()`` function copies the absolute pathname of the current working
directory to the character array pointed to by ``buf``. The ``size`` argument
is the number of bytes available in ``buf``

**NOTES:**

There is no way to determine the maximum string length that ``fetcwd()`` may
need to return. Applications should tolerate getting ``ERANGE`` and allocate a
larger buffer.

It is possible for ``getcwd()`` to return EACCES if, say, ``login`` puts the
process into a directory without read access.

The 1988 standard uses ``int`` instead of ``size_t`` for the second parameter.

.. _open:

open - Opens a file
-------------------
.. index:: open
.. index:: opens a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    #include <fcntl.h>
    int open(
        const char *path,
        int         oflag,
        mode_t      mode
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.
 * - ``EEXIST``
   - The named file already exists.
 * - ``EINTR``
   - Function was interrupted by a signal.
 * - ``EISDIR``
   - Attempt to open a directory for writing or to rename a file to be a
     directory.
 * - ``EMFILE``
   - Too many file descriptors are in use by this process.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENFILE``
   - Too many files are currently open in the system.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOSPC``
   - No space left on disk.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``ENXIO``
   - No such device. This error may also occur when a device is not ready, for
     example, a tape drive is off-line.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

The ``open`` function establishes a connection between a file and a file
descriptor. The file descriptor is a small integer that is used by I/O
functions to reference the file. The ``path`` argument points to the pathname
for the file.

The ``oflag`` argument is the bitwise inclusive OR of the values of symbolic
constants. The programmer must specify exactly one of the following three
symbols:

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

 * - ``O_RDONLY``
   - Open for reading only.
 * - ``O_WRONLY``
   - Open for writing only.
 * - ``O_RDWR``
   - Open for reading and writing.

Any combination of the following symbols may also be used.

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

 * - ``O_APPEND``
   - Set the file offset to the end-of-file prior to each write.
 * - ``O_CREAT``
   - If the file does not exist, allow it to be created. This flag indicates
     that the ``mode`` argument is present in the call to ``open``.
 * - ``O_EXCL``
   - This flag may be used only if ``O_CREAT`` is also set. It causes the call
     to ``open`` to fail if the file already exists.
 * - ``O_NOCTTY``
   - Do not assign controlling terminal.
 * - ``O_NONBLOCK``
   - Do no wait for the device or file to be ready or available. After the file
     is open, the ``read`` and ``write`` calls return immediately. If the
     process would be delayed in the read or write opermation, -1 is returned
     and``errno`` is set to ``EAGAIN`` instead of blocking the caller.
 * - ``O_TRUNC``
   - This flag should be used only on ordinary files opened for writing. It
     causes the file to be tuncated to zero length..

Upon successful completion, ``open`` returns a non-negative file descriptor.

**NOTES:**

NONE

.. _creat:

creat - Create a new file or rewrite an existing one
----------------------------------------------------
.. index:: creat
.. index:: create a new file or rewrite an existing one

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    #include <fcntl.h>
    int creat(
        const char *path,
        mode_t      mode
    );

**STATUS CODES:**

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

 * - ``EEXIST``
   - ``path`` already exists and ``O_CREAT`` and ``O_EXCL`` were used.
 * - ``EISDIR``
   - ``path`` refers to a directory and the access requested involved writing
 * - ``ETXTBSY``
   - ``path`` refers to an executable image which is currently being executed
     and write access was requested
 * - ``EFAULT``
   - ``path`` points outside your accessible address space
 * - ``EACCES``
   - The requested access to the file is not allowed, or one of the directories
     in ``path`` did not allow search (execute) permission.
 * - ``ENAMETOOLONG``
   - ``path`` was too long.
 * - ``ENOENT``
   - A directory component in ``path`` does not exist or is a dangling symbolic
     link.
 * - ``ENOTDIR``
   - A component used as a directory in ``path`` is not, in fact, a directory.
 * - ``EMFILE``
   - The process alreadyh has the maximum number of files open.
 * - ``ENFILE``
   - The limit on the total number of files open on the system has been
     reached.
 * - ``ENOMEM``
   - Insufficient kernel memory was available.
 * - ``EROFS``
   - ``path`` refers to a file on a read-only filesystem and write access was
     requested

**DESCRIPTION:**

``creat`` attempts to create a file and return a file descriptor for use in
read, write, etc.

**NOTES:**

NONE

The routine is implemented in Cygnus newlib.

.. _umask:

umask - Sets a file creation mask.
----------------------------------
.. index:: umask
.. index:: sets a file creation mask.

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    mode_t umask(
        mode_t cmask
    );

**STATUS CODES:**

**DESCRIPTION:**

The ``umask()`` function sets the process file creation mask to ``cmask``.  The
file creation mask is used during ``open()``, ``creat()``, ``mkdir()``,
``mkfifo()`` calls to turn off permission bits in the ``mode`` argument.  Bit
positions that are set in ``cmask`` are cleared in the mode of the created
file.

**NOTES:**

NONE

The ``cmask`` argument should have only permission bits set. All other bits
should be zero.

In a system which supports multiple processes, the file creation mask is
inherited across ``fork()`` and ``exec()`` calls. This makes it possible to
alter the default permission bits of created files. RTEMS does not support
multiple processes so this behavior is not possible.

.. _link:

link - Creates a link to a file
-------------------------------
.. index:: link
.. index:: creates a link to a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int link(
        const char *existing,
        const char *new
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``EEXIST``
   - The named file already exists.
 * - ``EMLINK``
   - The number of links would exceed ``LINK_MAX``.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOSPC``
   - No space left on disk.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``EPERM``
   - Operation is not permitted. Process does not have the appropriate
     priviledges or permissions to perform the requested operations.
 * - ``EROFS``
   - Read-only file system.
 * - ``EXDEV``
   - Attempt to link a file to another file system.

**DESCRIPTION:**

The ``link()`` function atomically creates a new link for an existing file and
increments the link count for the file.

If the ``link()`` function fails, no directories are modified.

The ``existing`` argument should not be a directory.

The caller may (or may not) need permission to access the existing file.

**NOTES:**

NONE

.. _symlink:

symlink - Creates a symbolic link to a file
-------------------------------------------
.. index:: symlink
.. index:: creates a symbolic link to a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int symlink(
        const char *topath,
        const char *frompath
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``EEXIST``
   - The named file already exists.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOSPC``
   - No space left on disk.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``EPERM``
   - Operation is not permitted. Process does not have the appropriate
     priviledges or permissions to perform the requested operations.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

The ``symlink()`` function creates a symbolic link from the frombath to the
topath. The symbolic link will be interpreted at run-time.

If the ``symlink()`` function fails, no directories are modified.

The caller may (or may not) need permission to access the existing file.

**NOTES:**

NONE

.. _readlink:

readlink - Obtain the name of a symbolic link destination
---------------------------------------------------------
.. index:: readlink
.. index:: obtain the name of a symbolic link destination

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int readlink(
        const char *path,
        char       *buf,
        size_t      bufsize
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the prefix pathname was not a directory when a directory
     was expected.
 * - ``ELOOP``
   - Too many symbolic links were encountered in the pathname.
 * - ``EINVAL``
   - The pathname does not refer to a symbolic link
 * - ``EFAULT``
   - An invalid pointer was passed into the ``readlink()`` routine.

**DESCRIPTION:**

The ``readlink()`` function places the symbolic link destination into ``buf``
argument and returns the number of characters copied.

If the symbolic link destination is longer than bufsize characters the name
will be truncated.

**NOTES:**

NONE

.. _mkdir:

mkdir - Makes a directory
-------------------------
.. index:: mkdir
.. index:: makes a directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int mkdir(
        const char *path,
        mode_t      mode
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``EEXIST``
   - The name file already exist.
 * - ``EMLINK``
   - The number of links would exceed ``LINK_MAX``
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOSPC``
   - No space left on disk.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

The ``mkdir()`` function creates a new diectory named ``path``. The permission
bits (modified by the file creation mask) are set from ``mode``.  The owner and
group IDs for the directory are set from the effective user ID and group ID.

The new directory may (or may not) contain entries for ``.`` and ``..`` but is
otherwise empty.

**NOTES:**

NONE

.. _mkfifo:

mkfifo - Makes a FIFO special file
----------------------------------
.. index:: mkfifo
.. index:: makes a fifo special file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int mkfifo(
        const char *path,
        mode_t      mode
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``EEXIST``
   - The named file already exists.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOSPC``
   - No space left on disk.
 * - ``ENOTDIR``
   - A component of the specified ``path`` was not a directory when a directory
     was expected.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

The ``mkfifo()`` function creates a new FIFO special file named ``path``.  The
permission bits (modified by the file creation mask) are set from ``mode``. The
owner and group IDs for the FIFO are set from the efective user ID and
group ID.

**NOTES:**

NONE

.. _unlink:

unlink - Removes a directory entry
----------------------------------
.. index:: unlink
.. index:: removes a directory entry

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int unlink(
        const char path
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``EBUSY``
   - The directory is in use.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the specified ``path`` was not a directory when a directory
     was expected.
 * - ``EPERM``
   - Operation is not permitted. Process does not have the appropriate
     priviledges or permissions to perform the requested operations.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

The ``unlink`` function removes the link named by ``path`` and decrements the
link count of the file referenced by the link. When the link count goes to zero
and no process has the file open, the space occupied by the file is freed and
the file is no longer accessible.

**NOTES:**

NONE

.. _rmdir:

rmdir - Delete a directory
--------------------------
.. index:: rmdir
.. index:: delete a directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int rmdir(
        const char *pathname
    );

**STATUS CODES:**

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

 * - ``EPERM``
   - The filesystem containing ``pathname`` does not support the removal of
     directories.
 * - ``EFAULT``
   - ``pathname`` points ouside your accessible address space.
 * - ``EACCES``
   - Write access to the directory containing ``pathname`` was not allowed for
     the process's effective uid, or one of the directories in``pathname`` did
     not allow search (execute) permission.
 * - ``EPERM``
   - The directory containing ``pathname`` has the stickybit (S_ISVTX) set and
     the process's effective uid is neither the uid of the file to be delected
     nor that of the director containing it.
 * - ``ENAMETOOLONG``
   - ``pathname`` was too long.
 * - ``ENOENT``
   - A dirctory component in ``pathname`` does not exist or is a dangling
     symbolic link.
 * - ``ENOTDIR``
   - ``pathname``, or a component used as a directory in ``pathname``, is not,
     in fact, a directory.
 * - ``ENOTEMPTY``
   - ``pathname`` contains entries other than . and .. .
 * - ``EBUSY``
   - ``pathname`` is the current working directory or root directory of some
     process
 * - ``EBUSY``
   - ``pathname`` is the current directory or root directory of some process.
 * - ``ENOMEM``
   - Insufficient kernel memory was available
 * - ``EROGS``
   - ``pathname`` refers to a file on a read-only filesystem.
 * - ``ELOOP``
   - ``pathname`` contains a reference to a circular symbolic link

**DESCRIPTION:**

``rmdir`` deletes a directory, which must be empty

**NOTES:**

NONE

.. _rename:

rename - Renames a file
-----------------------
.. index:: rename
.. index:: renames a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int rename(
        const char *old,
        const char *new
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.
 * - ``EBUSY``
   - The directory is in use.
 * - ``EEXIST``
   - The named file already exists.
 * - ``EINVAL``
   - Invalid argument.
 * - ``EISDIR``
   - Attempt to open a directory for writing or to rename a file to be a
     directory.
 * - ``EMLINK``
   - The number of links would exceed ``LINK_MAX``.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does no exist.
 * - ``ENOSPC``
   - No space left on disk.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``ENOTEMPTY``
   - Attempt to delete or rename a non-empty directory.
 * - ``EROFS``
   - Read-only file system
 * - ``EXDEV``
   - Attempt to link a file to another file system.

**DESCRIPTION:**

The ``rename()`` function causes the file known bo ``old`` to now be known as
``new``.

Ordinary files may be renamed to ordinary files, and directories may be renamed
to directories; however, files cannot be converted using ``rename()``. The
``new`` pathname may not contain a path prefix of ``old``.

**NOTES:**

If a file already exists by the name ``new``, it is removed. The ``rename()``
function is atomic. If the ``rename()`` detects an error, no files are
removed. This guarantees that the ``rename("x", "x")`` does not remove ``x``.

You may not rename dot or dot-dot.

The routine is implemented in Cygnus newlib using ``link()`` and ``unlink()``.

.. _stat:

stat - Gets information about a file
------------------------------------
.. index:: stat
.. index:: gets information about a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int stat(
        const char  *path,
        struct stat *buf
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.
 * - ``EBADF``
   - Invalid file descriptor.
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.

**DESCRIPTION:**

The ``path`` argument points to a pathname for a file. Read, write, or execute
permission for the file is not required, but all directories listed in ``path``
must be searchable. The ``stat()`` function obtains information about the named
file and writes it to the area pointed to by ``buf``.

**NOTES:**

NONE

.. _fstat:

fstat - Gets file status
------------------------
.. index:: fstat
.. index:: gets file status

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int fstat(
        int          fildes,
        struct stat *buf
    );

**STATUS CODES:**

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

 * - ``EBADF``
   - Invalid file descriptor

**DESCRIPTION:**

The ``fstat()`` function obtains information about the file associated with
``fildes`` and writes it to the area pointed to by the ``buf`` argument.

**NOTES:**

If the filesystem object referred to by ``fildes`` is a link, then the
information returned in ``buf`` refers to the destination of that link.  This
is in contrast to ``lstat()`` which does not follow the link.

.. _lstat:

lstat - Gets file status
------------------------
.. index:: lstat
.. index:: gets file status

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int lstat(
        int          fildes,
        struct stat *buf
    );

**STATUS CODES:**

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

 * - ``EBADF``
   - Invalid file descriptor

**DESCRIPTION:**

The ``lstat()`` function obtains information about the file associated with
``fildes`` and writes it to the area pointed to by the ``buf`` argument.

**NOTES:**

If the filesystem object referred to by ``fildes`` is a link, then the
information returned in ``buf`` refers to the link itself.  This is in contrast
to ``fstat()`` which follows the link.

The ``lstat()`` routine is defined by BSD 4.3 and SVR4 and not included in
POSIX 1003.1b-1996.

.. _access:

access - Check permissions for a file
-------------------------------------
.. index:: access
.. index:: check permissions for a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int access(
        const char *pathname,
        int         mode
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - The requested access would be denied, either to the file itself or one of
     the directories in ``pathname``.
 * - ``EFAULT``
   - ``pathname`` points outside your accessible address space.
 * - ``EINVAL``
   - ``Mode`` was incorrectly specified.
 * - ``ENAMETOOLONG``
   - ``pathname`` is too long.
 * - ``ENOENT``
   - A directory component in ``pathname`` would have been accessible but does
     not exist or was a dangling symbolic link.
 * - ``ENOTDIR``
   - A component used as a directory in ``pathname`` is not, in fact, a
     directory.
 * - ``ENOMEM``
   - Insufficient kernel memory was available.

**DESCRIPTION:**

``Access`` checks whether the process would be allowed to read, write or test
for existence of the file (or other file system object) whose name is
``pathname``. If ``pathname`` is a symbolic link permissions of the file
referred by this symbolic link are tested.

``Mode`` is a mask consisting of one or more of ``R_OK``, ``W_OK``, ``X_OK``
and ``F_OK``.

**NOTES:**

NONE

.. _chmod:

chmod - Changes file mode.
--------------------------
.. index:: chmod
.. index:: changes file mode.

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int chmod(
        const char *path,
        mode_t      mode
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``EPERM``
   - Operation is not permitted. Process does not have the appropriate
     priviledges or permissions to perform the requested operations.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

Set the file permission bits, the set user ID bit, and the set group ID bit for
the file named by ``path`` to ``mode``. If the effective user ID does not match
the owner of the file and the calling process does not have the appropriate
privileges, ``chmod()`` returns -1 and sets ``errno`` to ``EPERM``.

**NOTES:**

NONE

.. _fchmod:

fchmod - Changes permissions of a file
--------------------------------------
.. index:: fchmod
.. index:: changes permissions of a file

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <sys/stat.h>
    int fchmod(
        int    fildes,
        mode_t mode
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix.
 * - ``EBADF``
   - The descriptor is not valid.
 * - ``EFAULT``
   - ``path`` points outside your accessible address space.
 * - ``EIO``
   - A low-level I/o error occurred while modifying the inode.
 * - ``ELOOP``
   - ``path`` contains a circular reference
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does no exist.
 * - ``ENOMEM``
   - Insufficient kernel memory was avaliable.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``EPERM``
   - The effective UID does not match the owner of the file, and is not zero
 * - ``EROFS``
   - Read-only file system

**DESCRIPTION:**

The mode of the file given by ``path`` or referenced by ``filedes`` is changed.

**NOTES:**

NONE

.. _getdents:

getdents - Get directory entries
--------------------------------
.. index:: getdents
.. index:: get directory entries

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    #include <linux/dirent.h>
    #include <linux/unistd.h>
    long getdents(
        int   dd_fd,
        char *dd_buf,
        int   dd_len
    );

**STATUS CODES:**

A successful call to ``getdents`` returns th the number of bytes read.  On end
of directory, 0 is returned. When an error occurs, -1 is returned, and
``errno`` is set appropriately.

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

 * - ``EBADF``
   - Invalid file descriptor ``fd``.
 * - ``EFAULT``
   - Argument points outside the calling process's address space.
 * - ``EINVAL``
   - Result buffer is too small.
 * - ``ENOENT``
   - No such directory.
 * - ``ENOTDIR``
   - File descriptor does not refer to a directory.

**DESCRIPTION:**

``getdents`` reads several ``dirent`` structures from the directory pointed by
``fd`` into the memory area pointed to by ``dirp``. The parameter ``count`` is
the size of the memory area.

**NOTES:**

NONE

.. _chown:

chown - Changes the owner and/or group of a file.
-------------------------------------------------
.. index:: chown
.. index:: changes the owner and/or group of a file.

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    #include <unistd.h>
    int chown(
        const char *path,
        uid_t       owner,
        gid_t       group
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Search permission is denied for a directory in a file's path prefix
 * - ``EINVAL``
   - Invalid argument
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist.
 * - ``ENOTDIR``
   - A component of the specified pathname was not a directory when a directory
     was expected.
 * - ``EPERM``
   - Operation is not permitted. Process does not have the appropriate
     priviledges or permissions to perform the requested operations.
 * - ``EROFS``
   - Read-only file system.

**DESCRIPTION:**

The user ID and group ID of the file named by ``path`` are set to ``owner`` and
``path``, respectively.

For regular files, the set group ID (``S_ISGID``) and set user ID (``S_ISUID``)
bits are cleared.

Some systems consider it a security violation to allow the owner of a file to
be changed, If users are billed for disk space usage, loaning a file to another
user could result in incorrect billing. The ``chown()`` function may be
restricted to privileged users for some or all files. The group ID can still be
changed to one of the supplementary group IDs.

**NOTES:**

This function may be restricted for some file. The ``pathconf`` function can be
used to test the ``_PC_CHOWN_RESTRICTED`` flag.

.. _utime:

utime - Change access and/or modification times of an inode
-----------------------------------------------------------
.. index:: utime
.. index:: change access and/or modification times of an inode

**CALLING SEQUENCE:**

.. code-block:: c

    #include <sys/types.h>
    int utime(
        const char     *filename,
        struct utimbuf *buf
    );

**STATUS CODES:**

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

 * - ``EACCES``
   - Permission to write the file is denied
 * - ``ENOENT``
   - ``Filename`` does not exist

**DESCRIPTION:**

``Utime`` changes the access and modification times of the inode specified by
``filename`` to the ``actime`` and ``modtime`` fields of ``buf``
respectively. If ``buf`` is ``NULL``, then the access and modification times of the
file are set to the current time.

**NOTES:**

NONE

.. _ftruncate:

ftruncate - truncate a file to a specified length
-------------------------------------------------
.. index:: ftruncate
.. index:: truncate a file to a specified length

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int ftrunctate(
        int    fd,
        size_t length
    );

**STATUS CODES:**

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

 * - ``ENOTDIR``
   - A component of the path prefix is not a directory.
 * - ``EINVAL``
   - The pathname contains a character with the high-order bit set.
 * - ``ENAMETOOLONG``
   - The length of the specified pathname exceeds ``PATH_MAX`` bytes, or the length
     of a component of the pathname exceeds ``NAME_MAX`` bytes.
 * - ``ENOENT``
   - The named file does not exist.
 * - ``EACCES``
   - The named file is not writable by the user.
 * - ``EACCES``
   - Search permission is denied for a component of the path prefix.
 * - ``ELOOP``
   - Too many symbolic links were encountered in translating the pathname
 * - ``EISDIR``
   - The named file is a directory.
 * - ``EROFS``
   - The named file resides on a read-only file system
 * - ``ETXTBSY``
   - The file is a pure procedure (shared text) file that is being executed
 * - ``EIO``
   - An I/O error occurred updating the inode.
 * - ``EFAULT``
   - ``Path`` points outside the process's allocated address space.
 * - ``EBADF``
   - The ``fd`` is not a valid descriptor.

**DESCRIPTION:**

``truncate()`` causes the file named by ``path`` or referenced by ``fd`` to be
truncated to at most ``length`` bytes in size. If the file previously was
larger than this size, the extra data is lost. With ``ftruncate()``, the file
must be open for writing.

**NOTES:**

NONE

.. _truncate:

truncate - truncate a file to a specified length
------------------------------------------------
.. index:: truncate
.. index:: truncate a file to a specified length

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int trunctate(
        const char *path,
        size_t      length
    );

**STATUS CODES:**

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

 * - ``ENOTDIR``
   - A component of the path prefix is not a directory.
 * - ``EINVAL``
   - The pathname contains a character with the high-order bit set.
 * - ``ENAMETOOLONG``
   - The length of the specified pathname exceeds ``PATH_MAX`` bytes, or the length
     of a component of the pathname exceeds ``NAME_MAX`` bytes.
 * - ``ENOENT``
   - The named file does not exist.
 * - ``EACCES``
   - The named file is not writable by the user.
 * - ``EACCES``
   - Search permission is denied for a component of the path prefix.
 * - ``ELOOP``
   - Too many symbolic links were encountered in translating the pathname
 * - ``EISDIR``
   - The named file is a directory.
 * - ``EROFS``
   - The named file resides on a read-only file system
 * - ``ETXTBSY``
   - The file is a pure procedure (shared text) file that is being executed
 * - ``EIO``
   - An I/O error occurred updating the inode.
 * - ``EFAULT``
   - ``Path`` points outside the process's allocated address space.
 * - ``EBADF``
   - The ``fd`` is not a valid descriptor.

**DESCRIPTION:**

``truncate()`` causes the file named by ``path`` or referenced by``fd`` to be
truncated to at most ``length`` bytes in size. If the file previously was
larger than this size, the extra data is lost. With ``ftruncate()``, the file
must be open for writing.

**NOTES:**

NONE

.. _pathconf:

pathconf - Gets configuration values for files
----------------------------------------------
.. index:: pathconf
.. index:: gets configuration values for files

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int pathconf(
        const char *path,
        int         name
    );

**STATUS CODES:**

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

 * - ``EINVAL``
   - Invalid argument
 * - ``EACCES``
   - Permission to write the file is denied
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist
 * - ``ENOTDIR``
   - A component of the specified ``path`` was not a directory whan a directory
     was expected.

**DESCRIPTION:**

``pathconf()`` gets a value for the configuration option ``name`` for the open
file descriptor ``filedes``.

The possible values for ``name`` are:

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

 * - ``_PC_LINK_MAX``
   - Returns the maximum number of links to the file. If ``filedes`` or``path``
     refer to a directory, then the value applies to the whole directory. The
     corresponding macro is ``_POSIX_LINK_MAX``.
 * - ``_PC_MAX_CANON``
   - Returns the maximum length of a formatted input line, where ``filedes`` or
     ``path`` must refer to a terminal. The corresponding macro is
     ``_POSIX_MAX_CANON``.
 * - ``_PC_MAX_INPUT``
   - Returns the maximum length of an input line, where ``filedes`` or ``path``
     must refer to a terminal. The corresponding macro is``_POSIX_MAX_INPUT``.
 * - ``_PC_NAME_MAX``
   - Returns the maximum length of a filename in the directory ``path`` or
     ``filedes``. The process is allowed to create. The corresponding macro is
     ``_POSIX_NAME_MAX``.
 * - ``_PC_PATH_MAX``
   - returns the maximum length of a relative pathname when ``path``
     or``filedes`` is the current working directory. The corresponding macro is
     ``_POSIX_PATH_MAX``.
 * - ``_PC_PIPE_BUF``
   - returns the size of the pipe buffer, where ``filedes`` must refer to a
     pipe or FIFO and ``path`` must refer to a FIFO. The corresponding macro is
     ``_POSIX_PIPE_BUF``.
 * - ``_PC_CHOWN_RESTRICTED``
   - Returns nonzero if the ``chown(2)`` call may not be used on this
     file. If``filedes`` or ``path`` refer to a directory, then this applies to
     all files in that directory. The corresponding macro is
     ``_POSIX_CHOWN_RESTRICTED``.

**NOTES:**

Files with name lengths longer than the value returned for ``name`` equal
``_PC_NAME_MAX`` may exist in the given directory.

.. _fpathconf:

fpathconf - Gets configuration values for files
-----------------------------------------------
.. index:: fpathconf
.. index:: gets configuration values for files

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    int fpathconf(
        int filedes,
        int name
    );

**STATUS CODES:**

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

 * - ``EINVAL``
   - Invalid argument
 * - ``EACCES``
   - Permission to write the file is denied
 * - ``ENAMETOOLONG``
   - Length of a filename string exceeds ``PATH_MAX`` and ``_POSIX_NO_TRUNC``
     is in effect.
 * - ``ENOENT``
   - A file or directory does not exist
 * - ``ENOTDIR``
   - A component of the specified ``path`` was not a directory whan a directory
     was expected.

**DESCRIPTION:**

``pathconf()`` gets a value for the configuration option ``name`` for the open
file descriptor ``filedes``.

The possible values for name are:

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

 * - ``_PC_LINK_MAX``
   - Returns the maximum number of links to the file. If ``filedes`` or
     ``path`` refer to a directory, then the value applies to the whole
     directory. The corresponding macro is ``_POSIX_LINK_MAX``.
 * - ``_PC_MAX_CANON``
   - returns the maximum length of a formatted input line, where ``filedes`` or
     ``path`` must refer to a terminal. The corresponding macro is
     ``_POSIX_MAX_CANON``.
 * - ``_PC_MAX_INPUT``
   - Returns the maximum length of an input line, where ``filedes`` or ``path``
     must refer to a terminal. The corresponding macro is ``_POSIX_MAX_INPUT``.
 * - ``_PC_NAME_MAX``
   - Returns the maximum length of a filename in the directory ``path`` or
     ``filedes``. The process is allowed to create. The corresponding macro is
     ``_POSIX_NAME_MAX``.
 * - ``_PC_PATH_MAX``
   - Returns the maximum length of a relative pathname when ``path`` or
     ``filedes`` is the current working directory. The corresponding macro is
     ``_POSIX_PATH_MAX``.
 * - ``_PC_PIPE_BUF``
   - Returns the size of the pipe buffer, where ``filedes`` must refer to a
     pipe or FIFO and ``path`` must refer to a FIFO. The corresponding macro is
     ``_POSIX_PIPE_BUF``.
 * - ``_PC_CHOWN_RESTRICTED``
   - Returns nonzero if the ``chown()`` call may not be used on this file. If
     ``filedes`` or ``path`` refer to a directory, then this applies to all
     files in that directory. The corresponding macro is
     ``_POSIX_CHOWN_RESTRICTED``.

**NOTES:**

NONE

.. _mknod:

mknod - create a directory
--------------------------
.. index:: mknod
.. index:: create a directory

**CALLING SEQUENCE:**

.. code-block:: c

    #include <unistd.h>
    #include <fcntl.h>
    #include <sys/types.h>
    #include <sys/stat.h>
    long mknod(
        const char *pathname,
        mode_t      mode,
        dev_t       dev
    );

**STATUS CODES:**

``mknod`` returns zero on success, or -1 if an error occurred (in which case,
errno is set appropriately).

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

 * - ``ENAMETOOLONG``
   - ``pathname`` was too long.
 * - ``ENOENT``
   - A directory component in ``pathname`` does not exist or is a dangling
     symbolic link.
 * - ``ENOTDIR``
   - A component used in the directory ``pathname`` is not, in fact, a
     directory.
 * - ``ENOMEM``
   - Insufficient kernel memory was available
 * - ``EROFS``
   - ``pathname`` refers to a file on a read-only filesystem.
 * - ``ELOOP``
   - ``pathname`` contains a reference to a circular symbolic link, ie a
     symbolic link whose expansion contains a reference to itself.
 * - ``ENOSPC``
   - The device containing ``pathname`` has no room for the new node.

**DESCRIPTION:**

``mknod`` attempts to create a filesystem node (file, device special file or
named pipe) named ``pathname``, specified by ``mode`` and ``dev``.

``mode`` specifies both the permissions to use and the type of node to be created.

It should be a combination (using bitwise OR) of one of the file types listed
below and the permissions for the new node.

The permissions are modified by the process's ``umask`` in the usual way: the
permissions of the created node are ``(mode & ~umask)``.

The file type should be one of ``S_IFREG``, ``S_IFCHR``, ``S_IFBLK`` and
``S_IFIFO`` to specify a normal file (which will be created empty), character
special file, block special file or FIFO (named pipe), respectively, or zero,
which will create a normal file.

If the file type is ``S_IFCHR`` or ``S_IFBLK`` then ``dev`` specifies the major
and minor numbers of the newly created device special file; otherwise it is
ignored.

The newly created node will be owned by the effective uid of the process. If
the directory containing the node has the set group id bit set, or if the
filesystem is mounted with BSD group semantics, the new node will inherit the
group ownership from its parent directory; otherwise it will be owned by the
effective gid of the process.

**NOTES:**

NONE