summaryrefslogtreecommitdiffstats
path: root/cpukit/libcsupport/include/rtems/libio.h
blob: 2a67496800f4c394d8a57b3b1768ef303b5bfb6f (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
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
/**
 * @file
 *
 * @ingroup LibIO
 *
 * @brief Basic IO API
 *
 * This file contains the support infrastructure used to manage the
 * table of integer style file descriptors used by the low level
 * POSIX system calls like open(), read, fstat(), etc.
 */

/*
 *  COPYRIGHT (c) 1989-2008.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  Modifications to support reference counting in the file system are
 *  Copyright (c) 2012 embedded brains GmbH.
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.org/license/LICENSE.
 */

#ifndef _RTEMS_RTEMS_LIBIO_H
#define _RTEMS_RTEMS_LIBIO_H

#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioccom.h>
#include <sys/statvfs.h>
#include <sys/uio.h>

#include <unistd.h>
#include <termios.h>

#include <rtems.h>
#include <rtems/fs.h>
#include <rtems/chain.h>

#ifdef __cplusplus
extern "C" {
#endif

struct knote;

/**
 * @defgroup LibIOFSOps File System Operations
 *
 * @ingroup LibIO
 *
 * @brief File system operations.
 */
/**@{**/

/**
 * @brief Locks a file system instance.
 *
 * This lock must allow nesting.
 *
 * @param[in, out] mt_entry The mount table entry of the file system instance.
 *
 * @see rtems_filesystem_default_lock().
 */
typedef void (*rtems_filesystem_mt_entry_lock_t)(
  const rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Unlocks a file system instance.
 *
 * @param[in, out] mt_entry The mount table entry of the file system instance.
 *
 * @see rtems_filesystem_default_unlock().
 */
typedef void (*rtems_filesystem_mt_entry_unlock_t)(
  const rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Path evaluation context.
 */
typedef struct {
  /**
   * The contents of the remaining path to be evaluated.
   */
  const char *path;

  /**
   * The length of the remaining path to be evaluated.
   */
  size_t pathlen;

  /**
   * The contents of the token to be evaluated with respect to the current
   * location.
   */
  const char *token;

  /**
   * The length of the token to be evaluated with respect to the current
   * location.
   */
  size_t tokenlen;

  /**
   * The path evaluation is controlled by the following flags
   *  - RTEMS_FS_PERMS_READ,
   *  - RTEMS_FS_PERMS_WRITE,
   *  - RTEMS_FS_PERMS_EXEC,
   *  - RTEMS_FS_FOLLOW_HARD_LINK,
   *  - RTEMS_FS_FOLLOW_SYM_LINK,
   *  - RTEMS_FS_MAKE,
   *  - RTEMS_FS_EXCLUSIVE,
   *  - RTEMS_FS_ACCEPT_RESIDUAL_DELIMITERS, and
   *  - RTEMS_FS_REJECT_TERMINAL_DOT.
   */
  int flags;

  /**
   * Symbolic link evaluation is a recursive operation.  This field helps to
   * limit the recursion level and thus prevents a stack overflow.  The
   * recursion level is limited by RTEMS_FILESYSTEM_SYMLOOP_MAX.
   */
  int recursionlevel;

  /**
   * This is the current file system location of the evaluation process.
   * Tokens are evaluated with respect to the current location.  The token
   * interpretation may change the current location.  The purpose of the path
   * evaluation is to change the start location into a final current location
   * according to the path.
   */
  rtems_filesystem_location_info_t currentloc;

  /**
   * The location of the root directory of the user environment during the
   * evaluation start.
   */
  rtems_filesystem_global_location_t *rootloc;

  /**
   * The start location of the evaluation process.  The start location my
   * change during symbolic link evaluation.
   */
  rtems_filesystem_global_location_t *startloc;
} rtems_filesystem_eval_path_context_t;

/**
 * @brief Path evaluation.
 *
 * @param[in, out] ctx The path evaluation context.
 *
 * @see rtems_filesystem_default_eval_path().
 */
typedef void (*rtems_filesystem_eval_path_t)(
  rtems_filesystem_eval_path_context_t *ctx
);

/**
 * @brief Creates a new link for the existing file.
 *
 * @param[in] parentloc The location of the parent of the new link.
 * @param[in] targetloc The location of the target file.
 * @param[in] name Name for the new link.
 * @param[in] namelen Length of the name for the new link in characters.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_link().
 */
typedef int (*rtems_filesystem_link_t)(
  const rtems_filesystem_location_info_t *parentloc,
  const rtems_filesystem_location_info_t *targetloc,
  const char *name,
  size_t namelen
);

/**
 * @brief Changes the mode of a node.
 *
 * @param[in] loc The location of the node.
 * @param[in] mode The new mode of the node
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_fchmod().
 */
typedef int (*rtems_filesystem_fchmod_t)(
  const rtems_filesystem_location_info_t *loc,
  mode_t mode
);

/**
 * @brief Changes owner and group of a node.
 *
 * @param[in] loc The location of the node.
 * @param[in] owner User ID for the node.
 * @param[in] group Group ID for the node.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_chown().
 */
typedef int (*rtems_filesystem_chown_t)(
  const rtems_filesystem_location_info_t *loc,
  uid_t owner,
  gid_t group
);

/**
 * @brief Clones a location.
 *
 * The location is initialized with a bitwise copy of an existing location.
 * The caller must ensure that this location is protected from a release during
 * the clone operation.  After a successful clone operation the clone will be
 * added to the location chain of the corresponding mount table entry.
 *
 * @param[in, out] loc Location to clone.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_clonenode().
 */
typedef int (*rtems_filesystem_clonenode_t)(
  rtems_filesystem_location_info_t *loc
);

/**
 * @brief Frees the location of a node.
 *
 * @param[in] loc The location of the node.
 *
 * @see rtems_filesystem_default_freenode().
 */
typedef void (*rtems_filesystem_freenode_t)(
  const rtems_filesystem_location_info_t *loc
);

/**
 * @brief Mounts a file system instance in a mount point (directory).
 *
 * The mount point belongs to the file system instance of the handler and is
 * specified by a field of the mount table entry.  The handler must check that
 * the mount point is capable of mounting a file system instance.  This is the
 * last step during the mount process.  The file system instance is fully
 * initialized at this point.
 *
 * @param[in] mt_entry The mount table entry.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_mount().
 */
typedef int (*rtems_filesystem_mount_t) (
  rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Initializes a file system instance.
 *
 * This function must initialize the file system root node in the mount table
 * entry.
 *
 * @param[in] mt_entry The mount table entry.
 * @param[in] data The data provided by the user.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 */
typedef int (*rtems_filesystem_fsmount_me_t)(
  rtems_filesystem_mount_table_entry_t *mt_entry,
  const void *data
);

/**
 * @brief Unmounts a file system instance in a mount point (directory).
 *
 * In case this function is successful the file system instance will be marked
 * as unmounted.  The file system instance will be destroyed when the last
 * reference to it vanishes.
 *
 * @param[in] mt_entry The mount table entry.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_unmount().
 */
typedef int (*rtems_filesystem_unmount_t) (
  rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Destroys a file system instance.
 *
 * The mount point node location of the mount table entry is invalid.  This
 * handler must free the file system root location and all remaining resources
 * of the file system instance.
 *
 * @param[in] mt_entry The mount table entry.
 *
 * @see rtems_filesystem_default_fsunmount().
 */
typedef void (*rtems_filesystem_fsunmount_me_t)(
  rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Tests if the node of one location is equal to the node of the other
 * location.
 *
 * The caller ensures that both nodes are within the same file system instance.
 *
 * @param[in] a The one location.
 * @param[in] b The other location.
 *
 * @retval true The nodes of the locations are equal.
 * @retval false Otherwise.
 *
 * @see rtems_filesystem_default_are_nodes_equal().
 */
typedef bool (*rtems_filesystem_are_nodes_equal_t)(
  const rtems_filesystem_location_info_t *a,
  const rtems_filesystem_location_info_t *b
);

/**
 * @brief Creates a new node.
 *
 * This handler should create a new node according to the parameters.
 *
 * @param[in] parentloc The location of the parent of the new node.
 * @param[in] name Name for the new node.
 * @param[in] namelen Length of the name for the new node in characters.
 * @param[in] mode Mode for the new node.
 * @param[in] dev Optional device identifier for the new node.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_mknod().
 */
typedef int (*rtems_filesystem_mknod_t)(
  const rtems_filesystem_location_info_t *parentloc,
  const char *name,
  size_t namelen,
  mode_t mode,
  dev_t dev
);

/**
 * @brief Removes a node.
 *
 * @param[in] parentloc The location of the parent of the node.
 * @param[in] loc The location of the node.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_rmnod().
 */
typedef int (*rtems_filesystem_rmnod_t)(
  const rtems_filesystem_location_info_t *parentloc,
  const rtems_filesystem_location_info_t *loc
);

/**
 * @brief Set node access and modification times.
 *
 * @param[in] loc The location of the node.
 * @param[in] actime Access time for the node.
 * @param[in] modtime Modification for the node.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_utime().
 */
typedef int (*rtems_filesystem_utime_t)(
  const rtems_filesystem_location_info_t *loc,
  time_t actime,
  time_t modtime
);

/**
 * @brief Makes a symbolic link to a node.
 *
 * @param[in] parentloc The location of the parent of the new symbolic link.
 * @param[in] name Name for the new symbolic link.
 * @param[in] namelen Length of the name for the new symbolic link in
 * characters.
 * @param[in] target Contents for the symbolic link.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_symlink().
 */
typedef int (*rtems_filesystem_symlink_t)(
  const rtems_filesystem_location_info_t *parentloc,
  const char *name,
  size_t namelen,
  const char *target
);

/**
 * @brief Reads the contents of a symbolic link.
 *
 * @param[in] loc The location of the symbolic link.
 * @param[out] buf The buffer for the contents.
 * @param[in] bufsize The size of the buffer in characters.
 *
 * @retval non-negative Size of the actual contents in characters.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_readlink().
 */
typedef ssize_t (*rtems_filesystem_readlink_t)(
  const rtems_filesystem_location_info_t *loc,
  char *buf,
  size_t bufsize
);

/**
 * @brief Renames a node.
 *
 * @param[in] oldparentloc The location of the parent of the old node.
 * @param[in] oldloc The location of the old node.
 * @param[in] newparentloc The location of the parent of the new node.
 * @param[in] name Name for the new node.
 * @param[in] namelen Length of the name for the new node in characters.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_rename().
 */
typedef int (*rtems_filesystem_rename_t)(
  const rtems_filesystem_location_info_t *oldparentloc,
  const rtems_filesystem_location_info_t *oldloc,
  const rtems_filesystem_location_info_t *newparentloc,
  const char *name,
  size_t namelen
);

/**
 * @brief Gets file system information.
 *
 * @param[in] loc The location of a node.
 * @param[out] buf Buffer for file system information.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_statvfs().
 */
typedef int (*rtems_filesystem_statvfs_t)(
  const rtems_filesystem_location_info_t *loc,
  struct statvfs *buf
);

/**
 * @brief File system operations table.
 */
struct _rtems_filesystem_operations_table {
  rtems_filesystem_mt_entry_lock_t lock_h;
  rtems_filesystem_mt_entry_unlock_t unlock_h;
  rtems_filesystem_eval_path_t eval_path_h;
  rtems_filesystem_link_t link_h;
  rtems_filesystem_are_nodes_equal_t are_nodes_equal_h;
  rtems_filesystem_mknod_t mknod_h;
  rtems_filesystem_rmnod_t rmnod_h;
  rtems_filesystem_fchmod_t fchmod_h;
  rtems_filesystem_chown_t chown_h;
  rtems_filesystem_clonenode_t clonenod_h;
  rtems_filesystem_freenode_t freenod_h;
  rtems_filesystem_mount_t mount_h;
  rtems_filesystem_unmount_t unmount_h;
  rtems_filesystem_fsunmount_me_t fsunmount_me_h;
  rtems_filesystem_utime_t utime_h;
  rtems_filesystem_symlink_t symlink_h;
  rtems_filesystem_readlink_t readlink_h;
  rtems_filesystem_rename_t rename_h;
  rtems_filesystem_statvfs_t statvfs_h;
};

/**
 * @brief File system operations table with default operations.
 */
extern const rtems_filesystem_operations_table
  rtems_filesystem_operations_default;

/**
 * @brief Obtains the IO library mutex.
 *
 * @see rtems_filesystem_mt_entry_lock_t.
 */
void rtems_filesystem_default_lock(
  const rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Releases the IO library mutex.
 *
 * @see rtems_filesystem_mt_entry_unlock_t.
 */
void rtems_filesystem_default_unlock(
  const rtems_filesystem_mount_table_entry_t *mt_entry
);

/**
 * @brief Terminates the path evaluation and replaces the current location with
 * the null location.
 *
 * @see rtems_filesystem_eval_path_t.
 */
void rtems_filesystem_default_eval_path(
  rtems_filesystem_eval_path_context_t *ctx
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_link_t.
 */
int rtems_filesystem_default_link(
  const rtems_filesystem_location_info_t *parentloc,
  const rtems_filesystem_location_info_t *targetloc,
  const char *name,
  size_t namelen
);

/**
 * @brief Tests if the node access pointer of one location is equal to
 * the node access pointer of the other location.
 *
 * @param[in] a The one location.
 * @param[in] b The other location.
 *
 * @retval true The node access pointers of the locations are equal.
 * @retval false Otherwise.
 *
 * @see rtems_filesystem_are_nodes_equal_t.
 */
bool rtems_filesystem_default_are_nodes_equal(
  const rtems_filesystem_location_info_t *a,
  const rtems_filesystem_location_info_t *b
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_mknod_t.
 */
int rtems_filesystem_default_mknod(
  const rtems_filesystem_location_info_t *parentloc,
  const char *name,
  size_t namelen,
  mode_t mode,
  dev_t dev
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_rmnod_t.
 */
int rtems_filesystem_default_rmnod(
  const rtems_filesystem_location_info_t *parentloc,
  const rtems_filesystem_location_info_t *loc
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_fchmod_t.
 */
int rtems_filesystem_default_fchmod(
  const rtems_filesystem_location_info_t *loc,
  mode_t mode
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_chown_t.
 */
int rtems_filesystem_default_chown(
  const rtems_filesystem_location_info_t *loc,
  uid_t owner,
  gid_t group
);

/**
 * @retval 0 Always.
 *
 * @see rtems_filesystem_clonenode_t.
 */
int rtems_filesystem_default_clonenode(
  rtems_filesystem_location_info_t *loc
);

/**
 * @see rtems_filesystem_freenode_t.
 */
void rtems_filesystem_default_freenode(
  const rtems_filesystem_location_info_t *loc
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_mount_t.
 */
int rtems_filesystem_default_mount (
   rtems_filesystem_mount_table_entry_t *mt_entry     /* IN */
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_unmount_t.
 */
int rtems_filesystem_default_unmount(
  rtems_filesystem_mount_table_entry_t *mt_entry     /* IN */
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_fsunmount_me_t.
 */
void rtems_filesystem_default_fsunmount(
   rtems_filesystem_mount_table_entry_t *mt_entry    /* IN */
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_utime_t.
 */
int rtems_filesystem_default_utime(
  const rtems_filesystem_location_info_t *loc,
  time_t actime,
  time_t modtime
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_symlink_t.
 */
int rtems_filesystem_default_symlink(
  const rtems_filesystem_location_info_t *parentloc,
  const char *name,
  size_t namelen,
  const char *target
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_readlink_t.
 */
ssize_t rtems_filesystem_default_readlink(
  const rtems_filesystem_location_info_t *loc,
  char *buf,
  size_t bufsize
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_rename_t.
 */
int rtems_filesystem_default_rename(
  const rtems_filesystem_location_info_t *oldparentloc,
  const rtems_filesystem_location_info_t *oldloc,
  const rtems_filesystem_location_info_t *newparentloc,
  const char *name,
  size_t namelen
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_statvfs_t.
 */
int rtems_filesystem_default_statvfs(
  const rtems_filesystem_location_info_t *loc,
  struct statvfs *buf
);

/** @} */

/**
 * @defgroup LibIOFSHandler File System Node Handler
 *
 * @ingroup LibIO
 *
 * @brief File system node handler.
 */
/**@{**/

/**
 * @brief Opens a node.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] path The path.
 * @param[in] oflag The open flags.
 * @param[in] mode Optional mode for node creation.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_open().
 */
typedef int (*rtems_filesystem_open_t)(
  rtems_libio_t *iop,
  const char    *path,
  int            oflag,
  mode_t         mode
);

/**
 * @brief Closes a node.
 *
 * @param[in, out] iop The IO pointer.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_close().
 */
typedef int (*rtems_filesystem_close_t)(
  rtems_libio_t *iop
);

/**
 * @brief Reads from a node.
 *
 * This handler is responsible to update the offset field of the IO descriptor.
 *
 * @param[in, out] iop The IO pointer.
 * @param[out] buffer The buffer for read data.
 * @param[in] count The size of the buffer in characters.
 *
 * @retval non-negative Count of read characters.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_read().
 */
typedef ssize_t (*rtems_filesystem_read_t)(
  rtems_libio_t *iop,
  void          *buffer,
  size_t         count
);

/**
 * @brief Reads an IO vector from a node.
 *
 * This handler is responsible to update the offset field of the IO descriptor.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] iov The IO vector with buffer for read data.  The caller must
 * ensure that the IO vector values are valid.
 * @param[in] iovcnt The count of buffers in the IO vector.
 * @param[in] total The total count of bytes in the buffers in the IO vector.
 *
 * @retval non-negative Count of read characters.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_readv().
 */
typedef ssize_t (*rtems_filesystem_readv_t)(
  rtems_libio_t      *iop,
  const struct iovec *iov,
  int                 iovcnt,
  ssize_t             total
);

/**
 * @brief Writes to a node.
 *
 * This handler is responsible to update the offset field of the IO descriptor.
 *
 * @param[in, out] iop The IO pointer.
 * @param[out] buffer The buffer for write data.
 * @param[in] count The size of the buffer in characters.
 *
 * @retval non-negative Count of written characters.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_write().
 */
typedef ssize_t (*rtems_filesystem_write_t)(
  rtems_libio_t *iop,
  const void    *buffer,
  size_t         count
);

/**
 * @brief Writes an IO vector to a node.
 *
 * This handler is responsible to update the offset field of the IO descriptor.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] iov The IO vector with buffer for write data.  The caller must
 * ensure that the IO vector values are valid.
 * @param[in] iovcnt The count of buffers in the IO vector.
 * @param[in] total The total count of bytes in the buffers in the IO vector.
 *
 * @retval non-negative Count of written characters.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_writev().
 */
typedef ssize_t (*rtems_filesystem_writev_t)(
  rtems_libio_t      *iop,
  const struct iovec *iov,
  int                 iovcnt,
  ssize_t             total
);

/**
 * @brief IO control of a node.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] request The IO control request.
 * @param[in, out] buffer The buffer for IO control request data.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_ioctl().
 */
typedef int (*rtems_filesystem_ioctl_t)(
  rtems_libio_t   *iop,
  ioctl_command_t  request,
  void            *buffer
);

/**
 * @brief Moves the read/write file offset.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] offset The offset.
 * @param[in] whence The reference position for the offset.
 *
 * @retval non-negative The new offset from the beginning of the file.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_lseek(),
 * rtems_filesystem_default_lseek_file(), and
 * rtems_filesystem_default_lseek_directory().
 */
typedef off_t (*rtems_filesystem_lseek_t)(
  rtems_libio_t *iop,
  off_t          offset,
  int            whence
);

/**
 * @brief Gets a node status.
 *
 * @param[in, out] iop The IO pointer.
 * @param[out] stat The buffer to status information.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_fstat().
 */
typedef int (*rtems_filesystem_fstat_t)(
  const rtems_filesystem_location_info_t *loc,
  struct stat *buf
);

/**
 * @brief Truncates a file to a specified length.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] length The new length in characters.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_ftruncate() and
 * rtems_filesystem_default_ftruncate_directory().
 */
typedef int (*rtems_filesystem_ftruncate_t)(
  rtems_libio_t *iop,
  off_t length
);

/**
 * @brief Synchronizes changes to a file.
 *
 * @param[in, out] iop The IO pointer.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_fsync_or_fdatasync() and
 * rtems_filesystem_default_fsync_or_fdatasync_success().
 */
typedef int (*rtems_filesystem_fsync_t)(
  rtems_libio_t *iop
);

/**
 * @brief Synchronizes the data of a file.
 *
 * @param[in, out] iop The IO pointer.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The errno is set to indicate the error.
 *
 * @see rtems_filesystem_default_fsync_or_fdatasync() and
 * rtems_filesystem_default_fsync_or_fdatasync_success().
 */
typedef int (*rtems_filesystem_fdatasync_t)(
  rtems_libio_t *iop
);

/**
 * @brief File control.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] cmd Control command.
 *
 * @retval 0 Successful operation.
 * @retval errno An error occurred.  This value is assigned to errno.
 *
 * @see rtems_filesystem_default_fcntl().
 */
typedef int (*rtems_filesystem_fcntl_t)(
  rtems_libio_t *iop,
  int cmd
);

/**
 * @brief Poll and select support.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] events The poll events.
 *
 * @return The poll return events.
 *
 * @see rtems_filesystem_default_poll().
 */
typedef int (*rtems_filesystem_poll_t)(
  rtems_libio_t *iop,
  int events
);

/**
 * @brief Kernel event filter support.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in] kn The kernel event note.
 *
 * @retval 0 Successful operation.
 * @retval error An error occurred.  This is usually EINVAL.
 *
 * @see rtems_filesystem_default_kqfilter().
 */
typedef int (*rtems_filesystem_kqfilter_t)(
  rtems_libio_t *iop,
  struct knote *kn
);

/**
 * @brief MMAP support.
 *
 * @param[in, out] iop The IO pointer.
 * @param[in, out] addr The starting address of the mapped memory.
 * @param[in] len The maximum number of bytes to map.
 * @param[in] prot The desired memory protection.
 * @param[in] off The offset within the file descriptor to map.
 *
 * @retval 0 Successful operation.
 * @retval error An error occurred.  This is usually EINVAL.
 *
 * @see rtems_filesystem_default_mmap().
 */
typedef int (*rtems_filesystem_mmap_t)(
  rtems_libio_t *iop,
  void **addr,
  size_t len,
  int prot,
  off_t off
);

/**
 * @brief File system node operations table.
 */
struct _rtems_filesystem_file_handlers_r {
  rtems_filesystem_open_t open_h;
  rtems_filesystem_close_t close_h;
  rtems_filesystem_read_t read_h;
  rtems_filesystem_write_t write_h;
  rtems_filesystem_ioctl_t ioctl_h;
  rtems_filesystem_lseek_t lseek_h;
  rtems_filesystem_fstat_t fstat_h;
  rtems_filesystem_ftruncate_t ftruncate_h;
  rtems_filesystem_fsync_t fsync_h;
  rtems_filesystem_fdatasync_t fdatasync_h;
  rtems_filesystem_fcntl_t fcntl_h;
  rtems_filesystem_poll_t poll_h;
  rtems_filesystem_kqfilter_t kqfilter_h;
  rtems_filesystem_readv_t readv_h;
  rtems_filesystem_writev_t writev_h;
  rtems_filesystem_mmap_t mmap_h;
};

/**
 * @brief File system node handler table with default node handlers.
 */
extern const rtems_filesystem_file_handlers_r
  rtems_filesystem_handlers_default;

/**
 * @retval 0 Always.
 *
 * @see rtems_filesystem_open_t.
 */
int rtems_filesystem_default_open(
  rtems_libio_t *iop,
  const char    *path,
  int            oflag,
  mode_t         mode
);

/**
 * @retval 0 Always.
 *
 * @see rtems_filesystem_close_t.
 */
int rtems_filesystem_default_close(
  rtems_libio_t *iop
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_read_t.
 */
ssize_t rtems_filesystem_default_read(
  rtems_libio_t *iop,
  void          *buffer,
  size_t         count
);

/**
 * @brief Calls the read handler for each IO vector entry.
 *
 * @see rtems_filesystem_readv_t.
 */
ssize_t rtems_filesystem_default_readv(
  rtems_libio_t      *iop,
  const struct iovec *iov,
  int                 iovcnt,
  ssize_t             total
);

/**
 * @retval -1 Always.  The errno is set to ENOTSUP.
 *
 * @see rtems_filesystem_write_t.
 */
ssize_t rtems_filesystem_default_write(
  rtems_libio_t *iop,
  const void    *buffer,
  size_t         count
);

/**
 * @brief Calls the write handler for each IO vector entry.
 *
 * @see rtems_filesystem_write_t.
 */
ssize_t rtems_filesystem_default_writev(
  rtems_libio_t      *iop,
  const struct iovec *iov,
  int                 iovcnt,
  ssize_t             total
);

/**
 * @retval -1 Always.  The errno is set to ENOTTY.
 *
 * @see rtems_filesystem_ioctl_t.
 */
int rtems_filesystem_default_ioctl(
  rtems_libio_t   *iop,
  ioctl_command_t  request,
  void            *buffer
);

/**
 * @retval -1 Always.  The errno is set to ESPIPE.
 *
 * @see rtems_filesystem_lseek_t.
 */
off_t rtems_filesystem_default_lseek(
  rtems_libio_t *iop,
  off_t          offset,
  int            whence
);

/**
 * @brief An offset 0 with a whence of SEEK_SET will perform a directory rewind
 * operation.
 *
 * This function has no protection against concurrent access.
 *
 * @retval -1 The offset is not zero or the whence is not SEEK_SET.
 * @retval 0 Successful rewind operation.
 *
 * @see rtems_filesystem_lseek_t.
 */
off_t rtems_filesystem_default_lseek_directory(
  rtems_libio_t *iop,
  off_t offset,
  int whence
);

/**
 * @brief Default lseek() handler for files.
 *
 * The fstat() handler will be used to obtain the file size in case whence is
 * SEEK_END.
 *
 * This function has no protection against concurrent access.
 *
 * @retval -1 An error occurred.  In case an integer overflow occurred, then the
 * errno will be set to EOVERFLOW.  In case the new offset is negative, then
 * the errno will be set to EINVAL.  In case the whence is SEEK_END and the
 * fstat() handler to obtain the current file size returned an error status,
 * then the errno will be set by the fstat() handler.
 * @retval offset The new offset.
 *
 * @see rtems_filesystem_lseek_t.
 */
off_t rtems_filesystem_default_lseek_file(
  rtems_libio_t *iop,
  off_t offset,
  int whence
);

/**
 * @brief Sets the mode to S_IRWXU | S_IRWXG | S_IRWXO.
 *
 * @retval 0 Always.
 *
 * @see rtems_filesystem_fstat_t.
 */
int rtems_filesystem_default_fstat(
  const rtems_filesystem_location_info_t *loc,
  struct stat *buf
);

/**
 * @retval -1 Always.  The errno is set to EINVAL.
 *
 * @see rtems_filesystem_ftruncate_t.
 */
int rtems_filesystem_default_ftruncate(
  rtems_libio_t *iop,
  off_t length
);

/**
 * @retval -1 Always.  The errno is set to EISDIR.
 *
 * @see rtems_filesystem_ftruncate_t.
 */
int rtems_filesystem_default_ftruncate_directory(
  rtems_libio_t *iop,
  off_t length
);

/**
 * @retval -1 Always.  The errno is set to EINVAL.
 *
 * @see rtems_filesystem_fsync_t and rtems_filesystem_fdatasync_t.
 */
int rtems_filesystem_default_fsync_or_fdatasync(
  rtems_libio_t *iop
);

/**
 * @retval 0 Always.
 *
 * @see rtems_filesystem_fsync_t and rtems_filesystem_fdatasync_t.
 */
int rtems_filesystem_default_fsync_or_fdatasync_success(
  rtems_libio_t *iop
);

/**
 * @retval 0 Always.
 *
 * @see rtems_filesystem_fcntl_t.
 */
int rtems_filesystem_default_fcntl(
  rtems_libio_t *iop,
  int cmd
);

/**
 * @brief Default poll handler.
 *
 * @retval POLLERR Always.
 *
 * @see rtems_filesystem_poll_t.
 */
int rtems_filesystem_default_poll(
  rtems_libio_t *iop,
  int events
);

/**
 * @brief Default kernel event filter handler.
 *
 * @retval EINVAL Always.
 *
 * @see rtems_filesystem_kqfilter_t.
 */
int rtems_filesystem_default_kqfilter(
  rtems_libio_t *iop,
  struct knote *kn
);

/**
 * @brief Default MMAP handler.
 *
 * @retval ENOTSUP Always.
 *
 * @see rtems_filesystem_mmap_t.
 */
int rtems_filesystem_default_mmap(
  rtems_libio_t *iop,
  void **addr,
  size_t len,
  int prot,
  off_t off
);

/** @} */

/**
 * @defgroup LibIO IO Library
 *
 * @brief Provides system call and file system interface definitions.
 *
 * General purpose communication channel for RTEMS to allow UNIX/POSIX
 * system call behavior under RTEMS.  Initially this supported only
 * IO to devices but has since been enhanced to support networking
 * and support for mounted file systems.
 */
/**@{**/

typedef off_t rtems_off64_t __attribute__((deprecated));

/**
 * @brief Gets the mount handler for the file system @a type.
 *
 * @return The file system mount handler associated with the @a type, or
 * @c NULL if no such association exists.
 */
rtems_filesystem_fsmount_me_t
rtems_filesystem_get_mount_handler(
  const char *type
);

/**
 * @brief Contain file system specific information which is required to support
 * fpathconf().
 */
typedef struct {
  int    link_max;                 /* count */
  int    max_canon;                /* max formatted input line size */
  int    max_input;                /* max input line size */
  int    name_max;                 /* max name length */
  int    path_max;                 /* max path */
  int    pipe_buf;                 /* pipe buffer size */
  int    posix_async_io;           /* async IO supported on fs, 0=no, 1=yes */
  int    posix_chown_restrictions; /* can chown: 0=no, 1=yes */
  int    posix_no_trunc;           /* error on names > max name, 0=no, 1=yes */
  int    posix_prio_io;            /* priority IO, 0=no, 1=yes */
  int    posix_sync_io;            /* file can be sync'ed, 0=no, 1=yes */
  int    posix_vdisable;           /* special char processing, 0=no, 1=yes */
} rtems_filesystem_limits_and_options_t;

/**
 * @brief Default pathconf settings.
 *
 * Override in a filesystem.
 */
extern const rtems_filesystem_limits_and_options_t
  rtems_filesystem_default_pathconf;

/**
 * @brief An open file data structure.
 *
 * It will be indexed by 'fd'.
 *
 * @todo Should really have a separate per/file data structure that this points
 * to (eg: offset, driver, pathname should be in that)
 */
struct rtems_libio_tt {
  rtems_driver_name_t                    *driver;
  off_t                                   offset;    /* current offset into file */
  uint32_t                                flags;
  rtems_filesystem_location_info_t        pathinfo;
  uint32_t                                data0;     /* private to "driver" */
  void                                   *data1;     /* ... */
};

/**
 * @brief Paramameter block for read/write.
 *
 * It must include 'offset' instead of using iop's offset since we can have
 * multiple outstanding i/o's on a device.
 */
typedef struct {
  rtems_libio_t          *iop;
  off_t                   offset;
  char                   *buffer;
  uint32_t                count;
  uint32_t                flags;
  uint32_t                bytes_moved;
} rtems_libio_rw_args_t;

/**
 * @brief Parameter block for open/close.
 */
typedef struct {
  rtems_libio_t          *iop;
  uint32_t                flags;
  uint32_t                mode;
} rtems_libio_open_close_args_t;

/**
 * @brief Parameter block for ioctl.
 */
typedef struct {
  rtems_libio_t          *iop;
  ioctl_command_t         command;
  void                   *buffer;
  int                     ioctl_return;
} rtems_libio_ioctl_args_t;

/**
 * @name Flag Values
 */
/**@{**/

#define LIBIO_FLAGS_NO_DELAY      0x0001U  /* return immediately if no data */
#define LIBIO_FLAGS_READ          0x0002U  /* reading */
#define LIBIO_FLAGS_WRITE         0x0004U  /* writing */
#define LIBIO_FLAGS_OPEN          0x0100U  /* device is open */
#define LIBIO_FLAGS_APPEND        0x0200U  /* all writes append */
#define LIBIO_FLAGS_CLOSE_ON_EXEC 0x0800U  /* close on process exec() */
#define LIBIO_FLAGS_READ_WRITE    (LIBIO_FLAGS_READ | LIBIO_FLAGS_WRITE)

/** @} */

static inline uint32_t rtems_libio_iop_flags( const rtems_libio_t *iop )
{
  return iop->flags;
}

/**
 * @brief Returns true if this is a no delay iop, otherwise returns false.
 *
 * @param[in] iop The iop.
 */
static inline bool rtems_libio_iop_is_no_delay( const rtems_libio_t *iop )
{
  return ( rtems_libio_iop_flags( iop ) & LIBIO_FLAGS_NO_DELAY ) != 0;
}

/**
 * @brief Returns true if this is a readable iop, otherwise returns false.
 *
 * @param[in] iop The iop.
 */
static inline bool rtems_libio_iop_is_readable( const rtems_libio_t *iop )
{
  return ( rtems_libio_iop_flags( iop ) & LIBIO_FLAGS_READ ) != 0;
}

/**
 * @brief Returns true if this is a writeable iop, otherwise returns false.
 *
 * @param[in] iop The iop.
 */
static inline bool rtems_libio_iop_is_writeable( const rtems_libio_t *iop )
{
  return ( rtems_libio_iop_flags( iop ) & LIBIO_FLAGS_WRITE ) != 0;
}

/**
 * @brief Returns true if this is an append iop, otherwise returns false.
 *
 * @param[in] iop The iop.
 */
static inline bool rtems_libio_iop_is_append( const rtems_libio_t *iop )
{
  return ( rtems_libio_iop_flags( iop ) & LIBIO_FLAGS_APPEND ) != 0;
}

/**
 * @name External I/O Handlers
 */
/**@{**/

typedef int (*rtems_libio_open_t)(
  const char  *pathname,
  uint32_t    flag,
  uint32_t    mode
);

typedef int (*rtems_libio_close_t)(
  int  fd
);

typedef ssize_t (*rtems_libio_read_t)(
  int         fd,
  void       *buffer,
  size_t    count
);

typedef ssize_t (*rtems_libio_write_t)(
  int         fd,
  const void *buffer,
  size_t      count
);

typedef int (*rtems_libio_ioctl_t)(
  int         fd,
  uint32_t    command,
  void       *buffer
);

typedef off_t (*rtems_libio_lseek_t)(
  int           fd,
  off_t         offset,
  int           whence
);

/** @} */

/**
 * @name Permission Macros
 */
/**@{**/

/*
 *  The following macros are used to build up the permissions sets
 *  used to check permissions.  These are similar in style to the
 *  mode_t bits and should stay compatible with them.
 */
#define RTEMS_FS_PERMS_READ 0x4
#define RTEMS_FS_PERMS_WRITE 0x2
#define RTEMS_FS_PERMS_EXEC 0x1
#define RTEMS_FS_PERMS_RWX \
  (RTEMS_FS_PERMS_READ | RTEMS_FS_PERMS_WRITE | RTEMS_FS_PERMS_EXEC)
#define RTEMS_FS_FOLLOW_HARD_LINK 0x8
#define RTEMS_FS_FOLLOW_SYM_LINK 0x10
#define RTEMS_FS_FOLLOW_LINK \
  (RTEMS_FS_FOLLOW_HARD_LINK | RTEMS_FS_FOLLOW_SYM_LINK)
#define RTEMS_FS_MAKE 0x20
#define RTEMS_FS_EXCLUSIVE 0x40
#define RTEMS_FS_ACCEPT_RESIDUAL_DELIMITERS 0x80
#define RTEMS_FS_REJECT_TERMINAL_DOT 0x100

/** @} */

union __rtems_dev_t {
  dev_t device;
  struct {
     rtems_device_major_number major;
     rtems_device_minor_number minor;
  } __overlay;
};

static inline dev_t rtems_filesystem_make_dev_t(
  rtems_device_major_number _major,
  rtems_device_minor_number _minor
)
{
  union __rtems_dev_t temp;

  temp.__overlay.major = _major;
  temp.__overlay.minor = _minor;
  return temp.device;
}

static inline dev_t rtems_filesystem_make_dev_t_from_pointer(
  const void *pointer
)
{
  uint64_t temp = (((uint64_t) 1) << 63) | (((uintptr_t) pointer) >> 1);

  return rtems_filesystem_make_dev_t((uint32_t) (temp >> 32), (uint32_t) temp);
}

static inline rtems_device_major_number rtems_filesystem_dev_major_t(
  dev_t device
)
{
  union __rtems_dev_t temp;

  temp.device = device;
  return temp.__overlay.major;
}


static inline rtems_device_minor_number rtems_filesystem_dev_minor_t(
  dev_t device
)
{
  union __rtems_dev_t temp;

  temp.device = device;
  return temp.__overlay.minor;
}

#define rtems_filesystem_split_dev_t( _dev, _major, _minor ) \
  do { \
    (_major) = rtems_filesystem_dev_major_t ( _dev ); \
    (_minor) = rtems_filesystem_dev_minor_t( _dev ); \
  } while(0)

/*
 *  Prototypes for filesystem
 */

/**
 *  @brief Base File System Initialization
 *
 *  Initialize the foundation of the file system.  This is specified
 *  by the structure rtems_filesystem_mount_table.  The usual
 *  configuration is a single instantiation of the IMFS or miniIMFS with
 *  a single "/dev" directory in it.
 */
void rtems_filesystem_initialize( void );

void rtems_libio_post_driver(void);

void rtems_libio_exit(void);

/**
 * @brief Creates a directory and all its parent directories according to
 * @a path.
 *
 * The @a mode value selects the access permissions of the directory.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The @c errno indicates the error.
 */
extern int rtems_mkdir(const char *path, mode_t mode);

/** @} */

/**
 * @defgroup FileSystemTypesAndMount File System Types and Mount
 *
 * @ingroup LibIO
 *
 * @brief File system types and mount.
 */
/**@{**/

/**
 * @name File System Types
 */
/**@{**/

#define RTEMS_FILESYSTEM_TYPE_IMFS "imfs"
#define RTEMS_FILESYSTEM_TYPE_MINIIMFS "mimfs"
#define RTEMS_FILESYSTEM_TYPE_DEVFS "devfs"
#define RTEMS_FILESYSTEM_TYPE_FTPFS "ftpfs"
#define RTEMS_FILESYSTEM_TYPE_TFTPFS "tftpfs"
#define RTEMS_FILESYSTEM_TYPE_NFS "nfs"
#define RTEMS_FILESYSTEM_TYPE_DOSFS "dosfs"
#define RTEMS_FILESYSTEM_TYPE_RFS "rfs"
#define RTEMS_FILESYSTEM_TYPE_JFFS2 "jffs2"

/** @} */

/**
 * @brief Mount table entry.
 */
struct rtems_filesystem_mount_table_entry_tt {
  rtems_chain_node                       mt_node;
  void                                  *fs_info;
  const rtems_filesystem_operations_table *ops;
  const void                            *immutable_fs_info;
  rtems_chain_control                    location_chain;
  rtems_filesystem_global_location_t    *mt_point_node;
  rtems_filesystem_global_location_t    *mt_fs_root;
  bool                                   mounted;
  bool                                   writeable;
  const rtems_filesystem_limits_and_options_t *pathconf_limits_and_options;

  /*
   * The target or mount point of the file system.
   */
  const char                            *target;

  /*
   * The type of filesystem or the name of the filesystem.
   */
  const char                            *type;

  /*
   *  When someone adds a mounted filesystem on a real device,
   *  this will need to be used.
   *
   *  The lower layers can manage how this is managed. Leave as a
   *  string.
   */
  char                                  *dev;

  /**
   * The task that initiated the unmount process.  After unmount process
   * completion this task will be notified via the transient event.
   *
   * @see ClassicEventTransient.
   */
  rtems_id                               unmount_task;
};

/**
 * @brief File system options.
 */
typedef enum {
  RTEMS_FILESYSTEM_READ_ONLY,
  RTEMS_FILESYSTEM_READ_WRITE,
  RTEMS_FILESYSTEM_BAD_OPTIONS
} rtems_filesystem_options_t;

/**
 * @brief File system table entry.
 */
typedef struct rtems_filesystem_table_t {
  const char                    *type;
  rtems_filesystem_fsmount_me_t  mount_h;
} rtems_filesystem_table_t;

/**
 * @brief Static table of file systems.
 *
 * Externally defined by confdefs.h or the user.
 */
extern const rtems_filesystem_table_t rtems_filesystem_table [];

extern rtems_chain_control rtems_filesystem_mount_table;

/**
 * @brief Registers a file system @a type.
 *
 * The @a mount_h handler will be used to mount a file system of this @a type.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The @c errno indicates the error.
 */
int rtems_filesystem_register(
  const char                    *type,
  rtems_filesystem_fsmount_me_t  mount_h
);

/**
 * @brief Unregisters a file system @a type.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The @c errno indicates the error.
 */
int rtems_filesystem_unregister(
  const char *type
);

/**
 * @brief Unmounts the file system instance at the specified mount path.
 *
 * The function waits for the unmount process completion.  In case the calling
 * thread uses resources of the unmounted file system the function may never
 * return.  In case the calling thread has its root or current directory in the
 * unmounted file system the function returns with an error status and errno is
 * set to EBUSY.
 *
 * The unmount process completion notification uses the transient event.  It is
 * a fatal error to terminate the calling thread while waiting for this event.
 *
 * A concurrent unmount request for the same file system instance has
 * unpredictable effects.
 *
 * @param[in] mount_path The path to the file system instance mount point.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The @c errno indicates the error.
 *
 * @see ClassicEventTransient.
 */
int unmount(
  const char *mount_path
);

/**
 * @brief Mounts a file system instance at the specified target path.
 *
 * To mount a standard file system instance one of the following defines should
 * be used to select the file system type
 * - RTEMS_FILESYSTEM_TYPE_DEVFS,
 * - RTEMS_FILESYSTEM_TYPE_DOSFS,
 * - RTEMS_FILESYSTEM_TYPE_FTPFS,
 * - RTEMS_FILESYSTEM_TYPE_IMFS,
 * - RTEMS_FILESYSTEM_TYPE_JFFS2,
 * - RTEMS_FILESYSTEM_TYPE_MINIIMFS,
 * - RTEMS_FILESYSTEM_TYPE_NFS,
 * - RTEMS_FILESYSTEM_TYPE_RFS, or
 * - RTEMS_FILESYSTEM_TYPE_TFTPFS.
 *
 * Only configured or registered file system types are available.  You can add
 * file system types to your application configuration with the following
 * configuration options
 * - CONFIGURE_FILESYSTEM_DEVFS,
 * - CONFIGURE_FILESYSTEM_DOSFS,
 * - CONFIGURE_FILESYSTEM_FTPFS,
 * - CONFIGURE_FILESYSTEM_IMFS,
 * - CONFIGURE_FILESYSTEM_JFFS2,
 * - CONFIGURE_FILESYSTEM_MINIIMFS,
 * - CONFIGURE_FILESYSTEM_NFS,
 * - CONFIGURE_FILESYSTEM_RFS, and
 * - CONFIGURE_FILESYSTEM_TFTPFS.
 *
 * In addition to these configuration options file system types can be
 * registered with rtems_filesystem_register().
 *
 * @param[in] source The source parameter will be forwarded to the file system
 * initialization handler.  Usually the source is a path to the corresponding
 * device file, or @c NULL in case the file system does not use a device file.
 * @param[in] target The target path must lead to an existing directory, or
 * must be @c NULL.  In case the target is @c NULL, the root file system will
 * be mounted.
 * @param[in] filesystemtype This string selects the file system type.
 * @param[in] options The options specify if the file system instance allows
 * read-write or read-only access.
 * @param[in] data The data parameter will be forwarded to the file system
 * initialization handler.  It can be used to pass file system specific mount
 * options.  The data structure for mount options is file system specific.  See
 * also in the corresponding file system documentation.
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The @c errno indicates the error.
 *
 * @see rtems_filesystem_register(), mount_and_make_target_path(), @ref DOSFS
 * and @ref JFFS2.
 */
int mount(
  const char                 *source,
  const char                 *target,
  const char                 *filesystemtype,
  rtems_filesystem_options_t options,
  const void                 *data
);

/**
 * @brief Mounts a file system and makes the @a target path.
 *
 * The @a target path will be created with rtems_mkdir() and must not be
 * @c NULL.
 *
 * @see mount().
 *
 * @retval 0 Successful operation.
 * @retval -1 An error occurred.  The @c errno indicates the error.
 */
int mount_and_make_target_path(
  const char                 *source,
  const char                 *target,
  const char                 *filesystemtype,
  rtems_filesystem_options_t options,
  const void                 *data
);

/**
 * @brief Per file system type routine.
 *
 * @see rtems_filesystem_iterate().
 *
 * @retval true Stop the iteration.
 * @retval false Continue the iteration.
 */
typedef bool (*rtems_per_filesystem_routine)(
  const rtems_filesystem_table_t *fs_entry,
  void *arg
);

/**
 * @brief Iterates over all file system types.
 *
 * For each file system type the @a routine will be called with the entry and
 * the @a routine_arg parameter.
 *
 * Do not register or unregister file system types in @a routine.
 *
 * The iteration is protected by the IO library mutex.
 *
 * @retval true Iteration stopped due to @a routine return status.
 * @retval false Iteration through all entries.
 */
bool rtems_filesystem_iterate(
  rtems_per_filesystem_routine routine,
  void *routine_arg
);

/**
 * @brief Mount table entry visitor.
 *
 * @retval true Stop the iteration.
 * @retval false Continue the iteration.
 *
 * @see rtems_filesystem_mount_iterate().
 */
typedef bool (*rtems_filesystem_mt_entry_visitor)(
  const rtems_filesystem_mount_table_entry_t *mt_entry,
  void *arg
);

/**
 * @brief Iterates over all file system mount entries.
 *
 * The iteration is protected by the IO library mutex.  Do not mount or unmount
 * file systems in the visitor function.
 *
 * @param[in] visitor For each file system mount entry the visitor function
 * will be called with the entry and the visitor argument as parameters.
 * @param[in] visitor_arg The second parameter for the visitor function.
 *
 * @retval true Iteration stopped due to visitor function return status.
 * @retval false Iteration through all entries.
 */
bool rtems_filesystem_mount_iterate(
  rtems_filesystem_mt_entry_visitor visitor,
  void *visitor_arg
);

typedef struct {
  const char *source;
  const char *target;
  const char *filesystemtype;
  rtems_filesystem_options_t options;
  const void *data;
} rtems_filesystem_mount_configuration;

extern const rtems_filesystem_mount_configuration
  rtems_filesystem_root_configuration;

/** @} */

/**
 * @defgroup Termios Termios
 *
 * @ingroup LibIO
 *
 * @brief Termios
 */
/**@{**/

typedef struct rtems_termios_callbacks {
  int    (*firstOpen)(int major, int minor, void *arg);
  int    (*lastClose)(int major, int minor, void *arg);
  int    (*pollRead)(int minor);
  ssize_t (*write)(int minor, const char *buf, size_t len);
  int    (*setAttributes)(int minor, const struct termios *t);
  int    (*stopRemoteTx)(int minor);
  int    (*startRemoteTx)(int minor);
  int    outputUsesInterrupts;
} rtems_termios_callbacks;

void rtems_termios_initialize (void);

/*
 * CCJ: Change before opening a tty. Newer code from Eric is coming
 * so extra work to handle an open tty is not worth it. If the tty
 * is open, close then open it again.
 */
rtems_status_code rtems_termios_bufsize (
  size_t cbufsize,     /* cooked buffer size */
  size_t raw_input,    /* raw input buffer size */
  size_t raw_output    /* raw output buffer size */
);

rtems_status_code rtems_termios_open (
  rtems_device_major_number      major,
  rtems_device_minor_number      minor,
  void                          *arg,
  const rtems_termios_callbacks *callbacks
);

rtems_status_code rtems_termios_close(
  void *arg
);

rtems_status_code rtems_termios_read(
  void *arg
);

rtems_status_code rtems_termios_write(
  void *arg
);

rtems_status_code rtems_termios_ioctl(
  void *arg
);

int rtems_termios_enqueue_raw_characters(
  void *ttyp,
  const char *buf,
  int   len
);

int rtems_termios_dequeue_characters(
  void *ttyp,
  int   len
);

/** @} */

/**
 * @brief The pathconf setting for a file system.
 */
#define rtems_filesystem_pathconf(_mte) ((_mte)->pathconf_limits_and_options)

/**
 * @brief The type of file system. Its name.
 */
#define rtems_filesystem_type(_mte) ((_mte)->type)

/**
 * @brief The mount point of a file system.
 */
#define rtems_filesystem_mount_point(_mte) ((_mte)->target)

/**
 * @brief The device entry of a file system.
 */
#define rtems_filesystem_mount_device(_mte) ((_mte)->dev)

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_LIBIO_H */