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
|
.. comment SPDX-License-Identifier: CC-BY-SA-4.0
.. COMMENT: COPYRIGHT (c) 1988-2002.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.
Filesystem Implementation Requirements
**************************************
This chapter details the behavioral requirements that all filesystem
implementations must adhere to.
General
=======
The RTEMS filesystem framework was intended to be compliant with the POSIX
Files and Directories interface standard. The following filesystem
characteristics resulted in a functional switching layer.
.. code-block:: shell
Figure of the Filesystem Functional Layering goes here.
This figure includes networking and disk caching layering.
# Application programs are presented with a standard set of POSIX compliant
functions that allow them to interface with the files, devices and
directories in the filesystem. The interfaces to these routines do not
reflect the type of subordinate filesystem implementation in which the file
will be found.
# The filesystem framework developed under RTEMS allows for mounting filesystem
of different types under the base filesystem.
# The mechanics of locating file information may be quite different between
filesystem types.
# The process of locating a file may require crossing filesystem boundaries.
# The transitions between filesystem and the processing required to access
information in different filesystem is not visible at the level of the POSIX
function call.
# The POSIX interface standard provides file access by character pathname to
the file in some functions and through an integer file descriptor in other
functions.
# The nature of the integer file descriptor and its associated processing is
operating system and filesystem specific.
# Directory and device information must be processed with some of the same
routines that apply to files.
# The form and content of directory and device information differs greatly from
that of a regular file.
# Files, directories and devices represent elements (nodes) of a tree
hierarchy.
# The rules for processing each of the node types that exist under the
filesystem are node specific but are still not reflected in the POSIX
interface routines.
.. code-block:: shell
Figure of the Filesystem Functional Layering goes here.
This figure focuses on the Base Filesystem and IMFS.
.. code-block:: shell
Figure of the IMFS Memfile control blocks
.. _file-and-directory-removal-constraints:
File and Directory Removal Constraints
======================================
The following POSIX constraints must be honored by all filesystems.
- If a node is a directory with children it cannot be removed.
- The root node of any filesystem, whether the base filesystem or a mounted
filesystem, cannot be removed.
- A node that is a directory that is acting as the mount point of a file system
cannot be removed.
- On filesystems supporting hard links, a link count is maintained. Prior to
node removal, the node's link count is decremented by one. The link count
must be less than one to allow for removal of the node.
API Layering
============
Mapping of Generic System Calls to Filesystem Specific Functions
----------------------------------------------------------------
The list of generic system calls includes the routines open(), read(), write(),
close(), etc..
The Files and Directories section of the POSIX Application Programs Interface
specifies a set of functions with calling arguments that are used to gain
access to the information in a filesystem. To the application program, these
functions allow access to information in any mounted filesystem without
explicit knowledge of the filesystem type or the filesystem mount
configuration. The following are functions that are provided to the
application:
#. access()
#. chdir()
#. chmod()
#. chown()
#. close()
#. closedir()
#. fchmod()
#. fcntl()
#. fdatasync()
#. fpathconf()
#. fstat()
#. fsync()
#. ftruncate()
#. link()
#. lseek()
#. mkdir()
#. mknod()
#. mount()
#. open()
#. opendir()
#. pathconf()
#. read()
#. readdir()
#. rewinddir()
#. rmdir()
#. rmnod()
#. scandir()
#. seekdir()
#. stat()
#. telldir()
#. umask()
#. unlink()
#. unmount()
#. utime()
#. write()
The filesystem's type as well as the node type within the filesystem determine
the nature of the processing that must be performed for each of the functions
above. The RTEMS filesystem provides a framework that allows new filesystem to
be developed and integrated without alteration to the basic framework.
To provide the functional switching that is required, each of the POSIX file
and directory functions have been implemented as a shell function. The shell
function adheres to the POSIX interface standard. Within this functional shell,
filesystem and node type information is accessed which is then used to invoke
the appropriate filesystem and node type specific routine to process the POSIX
function call.
File/Device/Directory function access via file control block - rtems_libio_t structure
--------------------------------------------------------------------------------------
The POSIX open() function returns an integer file descriptor that is used as a
reference to file control block information for a specific file. The file
control block contains information that is used to locate node, file system,
mount table and functional handler information. The diagram in Figure 8 depicts
the relationship between and among the following components.
File Descriptor Table:
This is an internal RTEMS structure that tracks all currently defined file
descriptors in the system. The index that is returned by the file open()
operation references a slot in this table. The slot contains a pointer to the
file descriptor table entry for this file. The rtems_libio_t structure
represents the file control block.
Allocation of entry in the File Descriptor Table:
Access to the file descriptor table is controlled through a semaphore that is
implemented using the rtems_libio_allocate() function. This routine will grab
a semaphore and then scan the file control blocks to determine which slot is
free for use. The first free slot is marked as used and the index to this
slot is returned as the file descriptor for the open() request. After the
alterations have been made to the file control block table, the semaphore is
released to allow further operations on the table.
Maximum number of entries in the file descriptor table is configurable
through the src/exec/sapi/headers/confdefs.h file. If the
``CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS`` constant is defined its value
will represent the maximum number of file descriptors that are allowed. If
``CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS`` is not specified a default value
of 20 will be used as the maximum number of file descriptors allowed.
File control block - rtems_libio_t structure:
.. code-block:: c
struct rtems_libio_tt {
rtems_driver_name_t *driver;
off_t size;
off_t offset;
unsigned32 flags;
rtems_filesystem_location_info_t pathinfo;
Objects_Id sem;
unsigned32 data0;
void data1;
void file_info;
rtems_filesystem_file_handlers_r handlers;
};
A file control block can exist for regular files, devices and directories.
The following fields are important for regular file and directory access:
- Size - For a file this represents the number of bytes currently stored in a
file. For a directory this field is not filled in.
- Offset - For a file this is the byte file position index relative to the
start of the file. For a directory this is the byte offset into a sequence
of dirent structures.
- Pathinfo - This is a structure that provides a pointer to node information,
OPS table functions, Handler functions and the mount table entry associated
with this node.
- file_info - A pointer to node information that is used by Handler functions
- handlers - A pointer to a table of handler functions that operate on a
file, device or directory through a file descriptor index
File/Directory function access via rtems_filesystem_location_info_t structure
-----------------------------------------------------------------------------
The ``rtems_filesystem_location_info_tt`` structure below provides sufficient
information to process nodes under a mounted filesystem.
.. code-block:: c
struct rtems_filesystem_location_info_tt {
void *node_access;
rtems_filesystem_file_handlers_r *handlers;
rtems_filesystem_operations_table *ops;
rtems_filesystem_mount_table_entry_t *mt_entry;
};
It contains a void pointer to filesystem specific nodal structure, pointers to
the OPS table for the filesystem that contains the node, the node type specific
handlers for the node and a reference pointer to the mount table entry
associated with the filesystem containing the node
Operation Tables
================
Filesystem specific operations are invoked indirectly. The set of routines
that implement the filesystem are configured into two tables. The Filesystem
Handler Table has routines that are specific to a filesystem but remain
constant regardless of the actual file type. The File Handler Table has
routines that are both filesystem and file type specific.
Filesystem Handler Table Functions
----------------------------------
OPS table functions are defined in a ``rtems_filesystem_operations_table``
structure. It defines functions that are specific to a given filesystem. One
table exists for each filesystem that is supported in the RTEMS
configuration. The structure definition appears below and is followed by
general developmental information on each of the functions contained in this
function management structure.
.. code-block:: c
typedef struct {
rtems_filesystem_evalpath_t evalpath;
rtems_filesystem_evalmake_t evalformake;
rtems_filesystem_link_t link;
rtems_filesystem_unlink_t unlink;
rtems_filesystem_node_type_t node_type;
rtems_filesystem_mknod_t mknod;
rtems_filesystem_rmnod_t rmnod;
rtems_filesystem_chown_t chown;
rtems_filesystem_freenode_t freenod;
rtems_filesystem_mount_t mount;
rtems_filesystem_fsmount_me_t fsmount_me;
rtems_filesystem_unmount_t unmount;
rtems_filesystem_fsunmount_me_t fsunmount_me;
rtems_filesystem_utime_t utime;
rtems_filesystem_evaluate_link_t eval_link;
rtems_filesystem_symlink_t symlink;
} rtems_filesystem_operations_table;
evalpath Handler
^^^^^^^^^^^^^^^^
Corresponding Structure Element:
``evalpath``
Arguments:
.. code-block:: c
const char *pathname, /* IN */
int flags, /* IN */
rtems_filesystem_location_info_t *pathloc /* IN/OUT */
Description:
This routine is responsible for evaluating the pathname passed in based
upon the flags and the valid ``rthems_filesystem_location_info_t``.
Additionally, it must make any changes to pathloc necessary to identify the
pathname node. This should include calling the evalpath for a mounted
filesystem, if the given filesystem supports the mount command.
This routine returns a 0 if the evaluation was successful. Otherwise, it
returns a -1 and sets errno to the correct error.
This routine is required and should NOT be set to NULL.
evalformake Handler
^^^^^^^^^^^^^^^^^^^
Corresponding Structure Element:
``evalformake``
Arguments:
.. code-block:: c
const char *path, /* IN */
rtems_filesystem_location_info_t *pathloc, /* IN/OUT */
const char **name /* OUT */
Description:
This method is given a path to evaluate and a valid start location. It is
responsible for finding the parent node for a requested make command,
setting pathloc information to identify the parent node, and setting the
name pointer to the first character of the name of the new node.
Additionally, if the filesystem supports the mount command, this method
should call the evalformake routine for the mounted filesystem.
This routine returns a 0 if the evaluation was successful. Otherwise, it
returns a -1 and sets errno to the correct error.
This routine is required and should NOT be set to NULL. However, if the
filesystem does not support user creation of a new node, it may set errno
to ENOSYS and return -1.
link Handler
^^^^^^^^^^^^
Corresponding Structure Element:
``link``
Arguments:
.. code-block:: c
rtems_filesystem_location_info_t *to_loc, /* IN */
rtems_filesystem_location_info_t *parent_loc, /* IN */
const char *token /* IN */
Description:
This routine is used to create a hard-link.
It will first examine the st_nlink count of the node that we are trying to.
If the link count exceeds LINK_MAX an error will be returned.
The name of the link will be normalized to remove extraneous separators
from the end of the name.
This routine is not required and may be set to NULL.
unlink Handler
^^^^^^^^^^^^^^
Corresponding Structure Element:
``unlink``
Arguments:
XXX
Description:
XXX
node_type Handler
^^^^^^^^^^^^^^^^^
Corresponding Structure Element:
``node_type()``
Arguments:
.. code-block:: c
rtems_filesystem_location_info_t *pathloc /* IN */
Description:
XXX
mknod Handler
^^^^^^^^^^^^^
Corresponding Structure Element:
``mknod()``
Arguments:
.. code-block:: c
const char *token, /* IN */
mode_t mode, /* IN */
dev_t dev, /* IN */
rtems_filesystem_location_info_t *pathloc /* IN/OUT */
Description:
XXX
rmnod Handler
^^^^^^^^^^^^^
Corresponding Structure Element:
``rmnod()``
Arguments:
XXX
Description:
XXX
chown Handler
^^^^^^^^^^^^^
Corresponding Structure Element:
``chown()``
Arguments:
.. code-block:: c
rtems_filesystem_location_info_t *pathloc /* IN */
uid_t owner /* IN */
gid_t group /* IN */
Description:
XXX
freenod Handler
^^^^^^^^^^^^^^^
Corresponding Structure Element:
``freenod()``
Arguments:
.. code-block:: c
rtems_filesystem_location_info_t *pathloc /* IN */
Description:
This routine is used by the generic code to allow memory to be allocated
during the evaluate routines, and set free when the generic code is
finished accessing a node. If the evaluate routines allocate memory to
identify a node this routine should be utilized to free that memory.
This routine is not required and may be set to NULL.
mount Handler
^^^^^^^^^^^^^
Corresponding Structure Element:
``mount()``
Arguments:
.. code-block:: c
rtems_filesystem_mount_table_entry_t *mt_entry
Description:
XXX
fsmount_me Handler
^^^^^^^^^^^^^^^^^^
Corresponding Structure Element:
``imfs_fsmount_me``
Arguments:
.. code-block:: c
rtems_filesystem_mount_table_entry_t *mt_entry
Description:
This function is provided with a filesystem to take care of the internal
filesystem management details associated with mounting that filesystem
under the RTEMS environment.
It is not responsible for the mounting details associated the filesystem
containing the mount point.
The rtems_filesystem_mount_table_entry_t structure contains the key
elements below:
.. code-block:: c
rtems_filesystem_location_info_t *mt_point_node,
This structure contains information about the mount point. This allows us
to find the ops-table and the handling functions associated with the
filesystem containing the mount point.
.. code-block:: c
rtems_filesystem_location_info_t *fs_root_node,
This structure contains information about the root node in the file system
to be mounted. It allows us to find the ops-table and the handling
functions associated with the filesystem to be mounted.
.. code-block:: c
rtems_filesystem_options_t options,
Read only or read/write access
.. code-block:: c
void *fs_info,
This points to an allocated block of memory the will be used to hold any
filesystem specific information of a global nature. This allocated region
if important because it allows us to mount the same filesystem type more
than once under the RTEMS system. Each instance of the mounted filesystem
has its own set of global management information that is separate from the
global management information associated with the other instances of the
mounted filesystem type.
.. code-block:: c
rtems_filesystem_limits_and_options_t pathconf_info,
The table contains the following set of values associated with the mounted
filesystem:
- link_max
- max_canon
- max_input
- name_max
- path_max
- pipe_buf
- posix_async_io
- posix_chown_restrictions
- posix_no_trunc
- posix_prio_io
- posix_sync_io
- posix_vdisable
These values are accessed with the pathconf() and the fpathconf () functions.
.. code-block:: c
const char *dev
The is intended to contain a string that identifies the device that
contains the filesystem information. The filesystems that are currently
implemented are memory based and don't require a device specification.
If the mt_point_node.node_access is NULL then we are mounting the base file
system.
The routine will create a directory node for the root of the IMFS file
system.
The node will have read, write and execute permissions for owner, group and
others.
The node's name will be a null string.
A filesystem information structure(fs_info) will be allocated and
initialized for the IMFS filesystem. The fs_info pointer in the mount table
entry will be set to point the filesystem information structure.
The pathconf_info element of the mount table will be set to the appropriate
table of path configuration constants (LIMITS_AND_OPTIONS).
The fs_root_node structure will be filled in with the following:
- pointer to the allocated root node of the filesystem
- directory handlers for a directory node under the IMFS filesystem
- OPS table functions for the IMFS
A 0 will be returned to the calling routine if the process succeeded,
otherwise a 1 will be returned.
unmount Handler
^^^^^^^^^^^^^^^
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
fsunmount_me Handler
^^^^^^^^^^^^^^^^^^^^
Corresponding Structure Element:
``imfs_fsunmount_me()``
Arguments:
.. code-block:: c
rtems_filesystem_mount_table_entry_t *mt_entry
Description:
XXX
utime Handler
^^^^^^^^^^^^^
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
eval_link Handler
^^^^^^^^^^^^^^^^^
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
symlink Handler
^^^^^^^^^^^^^^^
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
File Handler Table Functions
----------------------------
Handler table functions are defined in a ``rtems_filesystem_file_handlers_r``
structure. It defines functions that are specific to a node type in a given
filesystem. One table exists for each of the filesystem's node types. The
structure definition appears below. It is followed by general developmental
information on each of the functions associated with regular files contained in
this function management structure.
.. code-block:: c
typedef struct {
rtems_filesystem_open_t open;
rtems_filesystem_close_t close;
rtems_filesystem_read_t read;
rtems_filesystem_write_t write;
rtems_filesystem_ioctl_t ioctl;
rtems_filesystem_lseek_t lseek;
rtems_filesystem_fstat_t fstat;
rtems_filesystem_fchmod_t fchmod;
rtems_filesystem_ftruncate_t ftruncate;
rtems_filesystem_fpathconf_t fpathconf;
rtems_filesystem_fsync_t fsync;
rtems_filesystem_fdatasync_t fdatasync;
rtems_filesystem_fcntl_t fcntl;
} rtems_filesystem_file_handlers_r;
open Handler
^^^^^^^^^^^^
Corresponding Structure Element:
``open()``
Arguments:
.. code-block:: c
rtems_libio_t *iop,
const char *pathname,
unsigned32 flag,
unsigned32 mode
Description:
XXX
close Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
``close()``
Arguments:
.. code-block:: c
rtems_libio_t *iop
Description:
XXX
NOTES:
XXX
read Handler
~~~~~~~~~~~~
Corresponding Structure Element:
``read()``
Arguments:
.. code-block:: c
rtems_libio_t *iop,
void *buffer,
unsigned32 count
Description:
XXX
NOTES:
XXX
write Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
NOTES:
XXX
ioctl Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
.. code-block:: c
rtems_libio_t *iop,
unsigned32 command,
void *buffer
Description:
XXX
NOTES:
XXX
lseek Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
``lseek()``
Arguments:
.. code-block:: c
rtems_libio_t *iop,
off_t offset,
int whence
Description:
XXX
NOTES:
XXX
fstat Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
``fstat()``
Arguments:
.. code-block:: c
rtems_filesystem_location_info_t *loc,
struct stat *buf
Description:
The following information is extracted from the filesystem specific node
and placed in the ``stat`` structure:
- st_mode
- st_nlink
- st_ino
- st_uid
- st_gid
- st_atime
- st_mtime
- st_ctime
NOTES:
Both the ``stat()`` and ``lstat()`` services are implemented directly using
the ``fstat()`` handler. The difference in behavior is determined by how
the path is evaluated prior to this handler being called on a particular
file entity.
The ``fstat()`` system call is implemented directly on top of this
filesystem handler.
fchmod Handler
~~~~~~~~~~~~~~
Corresponding Structure Element:
``fchmod()``
Arguments:
.. code-block:: c
rtems_libio_t *iop
mode_t mode
Description:
XXX
NOTES:
XXX
ftruncate Handler
~~~~~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
NOTES:
XXX
fpathconf Handler
~~~~~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
NOTES:
XXX
fsync Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
NOTES:
XXX
fdatasync Handler
~~~~~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
NOTES:
XXX
fcntl Handler
~~~~~~~~~~~~~
Corresponding Structure Element:
XXX
Arguments:
XXX
Description:
XXX
NOTES:
XXX
|