RTEMS Filesystem Design Guide (6.a3cfaea).¶

2.1. Pathname Evaluation Handlers¶

There are two pathname evaluation routines. The handler patheval() is called to find, verify privlages on and return information on a node that exists. The handler evalformake() is called to find, verify permissions, and return information on a node that is to become a parent. Additionally, evalformake() returns a pointer to the start of the name of the new node to be created.

Pathname evaluation is specific to a filesystem. Each filesystem is required to provide both a patheval() and an evalformake() routine. Both of these routines gets a name to evaluate and a node indicating where to start the evaluation.

2.2. Crossing a Mount Point During Path Evaluation¶

If the filesystem supports the mount command, the evaluate routines must handle crossing the mountpoint. The evaluate routine should evaluate the name upto the first directory node where the new filesystem is mounted. The filesystem may process terminator characters prior to calling the evaluate routine for the new filesystem. A pointer to the portion of the name which has not been evaluated along with the root node of the new file system (gotten from the mount table entry) is passed to the correct mounted filesystem evaluate routine.

2.3. The rtems_filesystem_location_info_t Structure¶

The rtems_filesystem_location_info_t structure contains all information necessary for identification of a node.

The generic rtems filesystem code defines two global rtems_filesystem_location_info_t structures, the``rtems_filesystem_root`` and the rtems_filesystem_current. Both are initially defined to be the root node of the base filesystem. Once the chdir command is correctly used the rtems_filesystem_current is set to the location specified by the command.

The filesystem generic code peeks at the first character in the name to be evaluated. If this character is a valid seperator, the``rtems_filesystem_root`` is used as the node to start the evaluation with. Otherwise, the rtems_filesystem_current node is used as the node to start evaluating with. Therefore, a valid rtems_filesystem_location_info_t is given to the evaluate routine to start evaluation with. The evaluate routines are then responsible for making any changes necessary to this structure to correspond to the name being parsed.

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;
};

node_access

This element is filesystem specific. A filesystem can define and store any information necessary to identify a node at this location. This element is normally filled in by the filesystem’s evaluate routine. For the filesystem’s root node, the filesystem’s initilization routine should fill this in, and it should remain valid until the instance of the filesystem is unmounted.

handlers

This element is defined as a set of routines that may change within a given filesystem based upon node type. For example a directory and a memory file may have to completely different read routines. This element is set to an initialization state defined by the mount table, and may be set to the desired state by the evaluation routines.

ops

This element is defined as a set of routines that remain static for the filesystem. This element identifies entry points into the filesystem to the generic code.

mt_entry

This element identifies the mount table entry for this instance of the filesystem.

3.1. Base Filesystem¶

RTEMS initially mounts a RAM based file system known as the base file system. The root directory of this file system tree serves as the logical root of the directory hierarchy (Figure 3). Under the root directory a ‘/dev’ directory is created under which all I/O device directories and files are registered as part of the file system hierarchy.

Figure of the tree structure goes here.

A RAM based file system draws its management resources from memory. File and directory nodes are simply allocated blocks of memory. Data associated with regular files is stored in collections of memory blocks. When the system is turned off or restarted all memory-based components of the file system are lost.

The base file system serves as a starting point for the mounting of file systems that are resident on semi-permanent storage media. Examples of such media include non- volatile memory, flash memory and IDE hard disk drives (Figure 3). File systems of other types will be mounted onto mount points within the base file system or other file systems that are subordinate to the base file system. The framework set up under the base file system will allow for these new file system types and the unique data and functionality that is required to manage the future file systems.

Figure of the mount table chain goes here.

Figure  of the Mount Table Processing goes here.

4.1. Mount Points¶

The following is the list of the characteristics of a mount point:

• The mount point must be a directory. It may have files and other directories under it. These files and directories will be hidden when the filesystem is mounted.

• The task must have read/write/execute permissions to the mount point or the mount attempt will be rejected.

• Only one filesystem can be mounted to a single mount point.

• The Root of the mountable filesystem will be referenced by the name of the mount point after the mount is complete.

4.2. Mount Table Chain¶

The mount table chain is a dynamic list of structures that describe mounted filesystems a specific points in the filesystem hierarchy. It is initialized to an empty state during the base filesystem initialization. The mount operation will add entries to the mount table chain. The un-mount operation will remove entries from the mount table chain.

Each entry in the mount table chain is of the following type:

struct rtems_filesystem_mount_table_entry_tt
{
    Chain_Node                             Node;
    rtems_filesystem_location_info_t       mt_point_node;
    rtems_filesystem_location_info_t       mt_fs_root;
    int                                    options;
    void                                  *fs_info;
    rtems_filesystem_limits_and_options_t  pathconf_limits_and_options;
    /*
     *  When someone adds a mounted filesystem on a real device,
     *  this will need to be used.
     *
     *  The best option long term for this is probably an
     *  open file descriptor.
     */
     char                                  *dev;
};

Node

The Node is used to produce a linked list of mount table entry nodes.

mt_point_node

The mt_point_node contains all information necessary to access the directory where a filesystem is mounted onto. This element may contain memory that is allocated during a path evaluation of the filesystem containing the mountpoint directory. The generic code allows this memory to be returned by unmount when the filesystem identified by mt_fs_root is unmounted.

mt_fs_root

The mt_fs_root contains all information necessary to identify the root of the mounted filesystem. The user is never allowed access to this node by the generic code, but it is used to identify to the mounted filesystem where to start evaluation of pathnames at.

options

XXX

fs_info

The fs_info element is a location available for use by the mounted file system to identify unique things applicable to this instance of the file system. For example the IMFS uses this space to provide node identification that is unique for each instance (mounting) of the filesystem.

pathconf_limits_and_options

XXX

dev

This character string represents the device where the filesystem will reside.

4.3. Adding entries to the chain during mount¶

When a filesystem is mounted, its presence and location in the file system hierarchy is recorded in a dynamic list structure known as a chain. A unique rtems_filesystem_mount_table_entry_tt structure is logged for each filesystem that is mounted. This includes the base filesystem.

4.4. Removing entries from the chain during unmount¶

When a filesystem is dismounted its entry in the mount table chain is extracted and the memory for this entry is freed.

5.1. access¶

File:

access.c

Processing:

This routine is layered on the stat() function. It acquires the current status information for the specified file and then determines if the caller has the ability to access the file for read, write or execute according to the mode argument to this function.

Development Comments:

This routine is layered on top of the stat() function. As long as the st_mode element in the returned structure follow the standard UNIX conventions, this function should support other filesystems without alteration.

5.2. chdir¶

File:

chdir.c

Processing:

This routine will determine if the pathname that we are attempting to make that current directory exists and is in fact a directory. If these conditions are met the global indication of the current directory (rtems_filesystem_current) is set to the rtems_filesystem_location_info_t structure that is returned by the rtems_filesystem_evaluate_path() routine.

Development Comments:

This routine is layered on the rtems_filesystem_evaluate_path() routine and the filesystem specific OP table function node_type().

The routine node_type() must be a routine provided for each filesystem since it must access the filesystems node information to determine which of the following types the node is:

• RTEMS_FILESYSTEM_DIRECTORY

• RTEMS_FILESYSTEM_DEVICE

• RTEMS_FILESYSTEM_HARD_LINK

• RTEMS_FILESYSTEM_MEMORY_FILE

This acknowledges that the form of the node management information can vary from one filesystem implementation to another.

RTEMS has a special global structure that maintains the current directory location. This global variable is of type rtems_filesystem_location_info_t and is called rtems_filesystem_current. This structure is not always valid. In order to determine if the structure is valid, you must first test the node_access element of this structure. If the pointer is NULL, then the structure does not contain a valid indication of what the current directory is.

5.3. chmod¶

File:

chmod.c

Processing:

This routine is layered on the open(), fchmod() and close() functions. As long as the standard interpretation of the mode_t value is maintained, this routine should not need modification to support other filesystems.

Development Comments:

The routine first determines if the selected file can be open with read/write access. This is required to allow modification of the mode associated with the selected path.

The fchmod() function is used to actually change the mode of the path using the integer file descriptor returned by the open() function.

After mode modification, the open file descriptor is closed.

5.4. chown¶

File:

chown.c

Processing:

This routine is layered on the rtems_filesystem_evaluate_path() and the file system specific chown() routine that is specified in the OPS table for the file system.

Development Comments:

rtems_filesystem_evaluate_path() is used to determine if the path specified actually exists. If it does a rtems_filesystem_location_info_t structure will be obtained that allows the shell function to locate the OPS table that is to be used for this filesystem.

It is possible that the chown() function that should be in the OPS table is not defined. A test for a non-NULL OPS table chown() entry is performed before the function is called.

If the chown() function is defined in the indicated OPS table, the function is called with the rtems_filesystem_location_info_t structure returned from the path evaluation routine, the desired owner, and group information.

5.5. close¶

File:

close.c

Processing:

This routine will allow for the closing of both network connections and file system devices. If the file descriptor is associated with a network device, the appropriate network function handler will be selected from a table of previously registered network functions (rtems_libio_handlers) and that function will be invoked.

If the file descriptor refers to an entry in the filesystem, the appropriate handler will be selected using information that has been placed in the file control block for the device (rtems_libio_t structure).

Development Comments:

rtems_file_descriptor_type examines some of the upper bits of the file descriptor index. If it finds that the upper bits are set in the file descriptor index, the device referenced is a network device.

Network device handlers are obtained from a special registration table (rtems_libio_handlers) that is set up during network initialization. The network handler invoked and the status of the network handler will be returned to the calling process.

If none of the upper bits are set in the file descriptor index, the file descriptor refers to an element of the RTEMS filesystem.

The following sequence will be performed for any filesystem file descriptor:

1. Use the rtems_libio_iop() function to obtain the rtems_libio_t structure for the file descriptor

2. Range check the file descriptor using rtems_libio_check_fd()

3. Determine if there is actually a function in the selected handler table that processes the close() operation for the filesystem and node type selected. This is generally done to avoid execution attempts on functions that have not been implemented.

4. If the function has been defined it is invoked with the file control block pointer as its argument.

5. The file control block that was associated with the open file descriptor is marked as free using rtems_libio_free().

6. The return code from the close handler is then passed back to the calling program.

5.6. closedir¶

File:

closedir.c

Processing:

The code was obtained from the BSD group. This routine must clean up the memory resources that are required to track an open directory. The code is layered on the close() function and standard memory free() functions. It should not require alterations to support other filesystems.

Development Comments:

The routine alters the file descriptor and the index into the DIR structure to make it an invalid file descriptor. Apparently the memory that is about to be freed may still be referenced before it is reallocated.

The dd_buf structure’s memory is reallocated before the control structure that contains the pointer to the dd_buf region.

DIR control memory is reallocated.

The close() function is used to free the file descriptor index.

5.7. dup() Unimplemented¶

File:

dup.c

Processing:

Development Comments:

5.8. dup2() Unimplemented¶

File:

dup2.c

Processing:

Development Comments:

5.9. fchmod¶

File:

fchmod.c

Processing:

This routine will alter the permissions of a node in a filesystem. It is layered on the following functions and macros:

• rtems_file_descriptor_type()

• rtems_libio_iop()

• rtems_libio_check_fd()

• rtems_libio_check_permissions()

• fchmod() function that is referenced by the handler table in the file control block associated with this file descriptor

Development Comments:

The routine will test to see if the file descriptor index is associated with a network connection. If it is, an error is returned from this routine.

The file descriptor index is used to obtain the associated file control block.

The file descriptor value is range checked.

The file control block is examined to determine if it has write permissions to allow us to alter the mode of the file.

A test is made to determine if the handler table that is referenced in the file control block contains an entry for the fchmod() handler function. If it does not, an error is returned to the calling routine.

If the fchmod() handler function exists, it is called with the file control block and the desired mode as parameters.

5.10. fcntl()¶

File:

fcntl.c

Processing:

This routine currently only interacts with the file control block. If the structure of the file control block and the associated meanings do not change, the partial implementation of fcntl() should remain unaltered for other filesystem implementations.

Development Comments:

The only commands that have been implemented are the F_GETFD and F_SETFD. The commands manipulate the LIBIO_FLAGS_CLOSE_ON_EXEC bit in the``flags`` element of the file control block associated with the file descriptor index.

The current implementation of the function performs the sequence of operations below:

1. Test to see if we are trying to operate on a file descriptor associated with a network connection

2. Obtain the file control block that is associated with the file descriptor index

3. Perform a range check on the file descriptor index.

5.11. fdatasync¶

File:

fdatasync.c

Processing:

This routine is a template in the in memory filesystem that will route us to the appropriate handler function to carry out the fdatasync() processing. In the in memory filesystem this function is not necessary. Its function in a disk based file system that employs a memory cache is to flush all memory based data buffers to disk. It is layered on the following functions and macros:

• rtems_file_descriptor_type()

• rtems_libio_iop()

• rtems_libio_check_fd()

• rtems_libio_check_permissions()

• fdatasync() function that is referenced by the handler table in the file control block associated with this file descriptor

Development Comments:

The routine will test to see if the file descriptor index is associated with a network connection. If it is, an error is returned from this routine.

The file descriptor index is used to obtain the associated file control block.

The file descriptor value is range checked.

The file control block is examined to determine if it has write permissions to the file.

A test is made to determine if the handler table that is referenced in the file control block contains an entry for the fdatasync() handler function. If it does not an error is returned to the calling routine.

If the fdatasync() handler function exists, it is called with the file control block as its parameter.

5.12. fpathconf¶

File:

fpathconf.c

Processing:

This routine is layered on the following functions and macros:

• rtems_file_descriptor_type()

• rtems_libio_iop()

• rtems_libio_check_fd()

• rtems_libio_check_permissions()

When a filesystem is mounted, a set of constants is specified for the filesystem. These constants are stored with the mount table entry for the filesystem. These constants appear in the POSIX standard and are listed below.

• PCLINKMAX

• PCMAXCANON

• PCMAXINPUT

• PCNAMEMAX

• PCPATHMAX

• PCPIPEBUF

• PCCHOWNRESTRICTED

• PCNOTRUNC

• PCVDISABLE

• PCASYNCIO

• PCPRIOIO

• PCSYNCIO

This routine will find the mount table information associated the file control block for the specified file descriptor parameter. The mount table entry structure contains a set of filesystem specific constants that can be accessed by individual identifiers.

Development Comments:

The routine will test to see if the file descriptor index is associated with a network connection. If it is, an error is returned from this routine.

The file descriptor index is used to obtain the associated file control block.

The file descriptor value is range checked.

The file control block is examined to determine if it has read permissions to the file.

Pathinfo in the file control block is used to locate the mount table entry for the filesystem associated with the file descriptor.

The mount table entry contains the pathconf_limits_and_options element. This element is a table of constants that is associated with the filesystem.

The name argument is used to reference the desired constant from the pathconf_limits_and_options table.

5.13. fstat¶

File:

fstat.c

Processing:

This routine will return information concerning a file or network connection. If the file descriptor is associated with a network connection, the current implementation of fstat() will return a mode set to S_IFSOCK. In a later version, this routine will map the status of a network connection to an external handler routine.

If the file descriptor is associated with a node under a filesystem, the fstat() routine will map to the fstat() function taken from the node handler table.

Development Comments:

This routine validates that the struct stat pointer is not NULL so that the return location is valid.

The struct stat is then initialized to all zeros.

rtems_file_descriptor_type() is then used to determine if the file descriptor is associated with a network connection. If it is, network status processing is performed. In the current implementation, the file descriptor type processing needs to be improved. It currently just drops into the normal processing for file system nodes.

If the file descriptor is associated with a node under a filesystem, the following steps are performed:

1. Obtain the file control block that is associated with the file descriptor index.

2. Range check the file descriptor index.

3. Test to see if there is a non-NULL function pointer in the handler table for the fstat() function. If there is, invoke the function with the file control block and the pointer to the stat structure.

5.14. ioctl¶

File:

ioctl.c

Processing:

Not defined in the POSIX 1003.1b standard but commonly supported in most UNIX and POSIX system. Ioctl() is a catchall for I/O operations. Routine is layered on external network handlers and filesystem specific handlers. The development of new filesystems should not alter the basic processing performed by this routine.

Development Comments:

The file descriptor is examined to determine if it is associated with a network device. If it is processing is mapped to an external network handler. The value returned by this handler is then returned to the calling program.

File descriptors that are associated with a filesystem undergo the following processing:

1. The file descriptor index is used to obtain the associated file control block.

2. The file descriptor value is range checked.

3. A test is made to determine if the handler table that is referenced in the file control block contains an entry for the ioctl() handler function. If it does not, an error is returned to the calling routine.

4. If the ioctl() handler function exists, it is called with the file control block, the command and buffer as its parameters.

5. The return code from this function is then sent to the calling routine.

5.15. link¶

File:

link.c

Processing:

This routine will establish a hard link to a file, directory or a device. The target of the hard link must be in the same filesystem as the new link being created. A link to an existing link is also permitted but the existing link is evaluated before the new link is made. This implies that links to links are reduced to links to files, directories or devices before they are made.

Development Comments:

Calling parameters:

const char   *existing
const char   *new

link() will determine if the target of the link actually exists using rtems_filesystem_evaluate_path()

rtems_filesystem_get_start_loc() is used to determine where to start the path evaluation of the new name. This macro examines the first characters of the name to see if the name of the new link starts with a rtems_filesystem_is_separator. If it does the search starts from the root of the RTEMS filesystem; otherwise the search will start from the current directory.

The OPS table evalformake() function for the parent’s filesystem is used to locate the node that will be the parent of the new link. It will also locate the start of the new path’s name. This name will be used to define a child under the parent directory.

If the parent is found, the routine will determine if the hard link that we are trying to create will cross a filesystem boundary. This is not permitted for hard-links.

If the hard-link does not cross a filesystem boundary, a check is performed to determine if the OPS table contains an entry for the link() function.

If a link() function is defined, the OPS table link() function will be called to establish the actual link within the filesystem.

The return code from the OPS table link() function is returned to the calling program.

5.16. lseek¶

File:

lseek.c

Processing:

This routine is layered on both external handlers and filesystem / node type specific handlers. This routine should allow for the support of new filesystems without modification.

Development Comments:

This routine will determine if the file descriptor is associated with a network device. If it is lseek will map to an external network handler. The handler will be called with the file descriptor, offset and whence as its calling parameters. The return code from the external handler will be returned to the calling routine.

If the file descriptor is not associated with a network connection, it is associated with a node in a filesystem. The following steps will be performed for filesystem nodes:

1. The file descriptor is used to obtain the file control block for the node.

2. The file descriptor is range checked.

3. The offset element of the file control block is altered as indicated by the offset and whence calling parameters

4. The handler table in the file control block is examined to determine if it contains an entry for the lseek() function. If it does not an error is returned to the calling program.

5. The lseek() function from the designated handler table is called with the file control block, offset and whence as calling arguments

6. The return code from the lseek() handler function is returned to the calling program

5.17. mkdir¶

File:

mkdir.c

Processing:

This routine attempts to create a directory node under the filesystem. The routine is layered the mknod() function.

Development Comments:

See mknod() for developmental comments.

5.18. mkfifo¶

File:

mkfifo.c

Processing:

This routine attempts to create a FIFO node under the filesystem. The routine is layered the mknod() function.

Development Comments:

See mknod() for developmental comments

5.19. mknod¶

File:

mknod.c

Processing:

This function will allow for the creation of the following types of nodes under the filesystem:

• directories

• regular files

• character devices

• block devices

• fifos

At the present time, an attempt to create a FIFO will result in an ENOTSUP error to the calling function. This routine is layered the filesystem specific routines evalformake and mknod. The introduction of a new filesystem must include its own evalformake and mknod function to support the generic mknod() function. Under this condition the generic mknod() function should accommodate other filesystem types without alteration.

Development Comments:

Test for nodal types - I thought that this test should look like the following code:

if ( (mode & S_IFDIR) = = S_IFDIR) ||
     (mode & S_IFREG) = = S_IFREG) ||
     (mode & S_IFCHR) = = S_IFCHR) ||
     (mode & S_IFBLK) = = S_IFBLK) ||
     (mode & S_IFIFO) = = S_IFIFO))
        Set_errno_and_return_minus_one (EINVAL);

Where:

• S_IFREG (0100000) - Creation of a regular file

• S_IFCHR (0020000) - Creation of a character device

• S_IFBLK (0060000) - Creation of a block device

• S_IFIFO (0010000) - Creation of a FIFO

Determine if the pathname that we are trying to create starts at the root directory or is relative to the current directory using the rtems_filesystem_get_start_loc() function.

Determine if the pathname leads to a valid directory that can be accessed for the creation of a node.

If the pathname is a valid location to create a node, verify that a filesystem specific mknod() function exists.

If the mknod() function exists, call the filesystem specific mknod() function. Pass the name, mode, device type and the location information associated with the directory under which the node will be created.

5.20. mount¶

File:

mount.c

Arguments (Not a standard POSIX call):

rtems_filesystem_mount_table_entry_t   **mt_entry,

If the mount operation is successful, this pointer to a pointer will be set to reference the mount table chain entry that has been allocated for this file system mount.

rtems_filesystem_operations_table   *fs_ops,

This is a pointer to a table of functions that are associated with the file system that we are about to mount. This is the mechanism to selected file system type without keeping a dynamic database of all possible file system types that are valid for the mount operation. Using this method, it is only necessary to configure the filesystems that we wish to use into the RTEMS build. Unused filesystems types will not be drawn into the build.

char                      *fsoptions,

This argument points to a string that selects mounting for read only access or read/write access. Valid states are “RO” and “RW”

char                      *device,

This argument is reserved for the name of a device that will be used to access the filesystem information. Current filesystem implementations are memory based and do not require a device to access filesystem information.

char                      *mount_point

This is a pathname to a directory in a currently mounted filesystem that allows read, write and execute permissions. If successful, the node found by evaluating this name, is stored in the mt_entry.

Processing:

This routine will handle the mounting of a filesystem on a mount point. If the operation is successful, a pointer to the mount table chain entry associated with the mounted filesystem will be returned to the calling function. The specifics about the processing required at the mount point and within the filesystem being mounted is isolated in the filesystem specific mount() and fsmount_me() functions. This allows the generic mount() function to remain unaltered even if new filesystem types are introduced.

Development Comments:

This routine will use get_file_system_options() to determine if the mount options are valid (“RO” or “RW”).

It confirms that a filesystem ops-table has been selected.

Space is allocated for a mount table entry and selective elements of the temporary mount table entry are initialized.

If a mount point is specified: The mount point is examined to determine that it is a directory and also has the appropriate permissions to allow a filesystem to be mounted.

The current mount table chain is searched to determine that there is not another filesystem mounted at the mount point we are trying to mount onto.

If a mount function is defined in the ops table for the filesystem containing the mount point, it is called at this time.

If no mount point is specified: Processing if performed to set up the mount table chain entry as the base filesystem.

If the fsmount_me() function is specified for ops-table of the filesystem being mounted, that function is called to initialize for the new filesystem.

On successful completion, the temporary mount table entry will be placed on the mount table chain to record the presence of the mounted filesystem.

5.21. open¶

File:

open.c

Processing:

This routine is layered on both RTEMS calls and filesystem specific implementations of the open() function. These functional interfaces should not change for new filesystems and therefore this code should be stable as new file systems are introduced.

Development Comments:

This routine will allocate a file control block for the file or device that we are about to open.

It will then test to see if the pathname exists. If it does a rtems_filesystem_location_info_t data structure will be filled out. This structure contains information that associates node information, filesystem specific functions and mount table chain information with the pathname.

If the create option has been it will attempt to create a node for a regular file along the specified path. If a file already exists along this path, an error will be generated; otherwise, a node will be allocated for the file under the filesystem that contains the pathname. When a new node is created, it is also evaluated so that an appropriate rtems_filesystem_location_info_t data structure can be filled out for the newly created node.

If the file exists or the new file was created successfully, the file control block structure will be initialized with handler table information, node information and the rtems_filesystem_location_info_t data structure that describes the node and filesystem data in detail.

If an open() function exists in the filesystem specific handlers table for the node that we are trying to open, it will be called at this time.

If any error is detected in the process, cleanup is performed. It consists of freeing the file control block structure that was allocated at the beginning of the generic open() routine.

On a successful open(), the index into the file descriptor table will be calculated and returned to the calling routine.

5.22. opendir¶

File:

opendir.c

Processing:

This routine will attempt to open a directory for read access. It will setup a DIR control structure that will be used to access directory information. This routine is layered on the generic open() routine and filesystem specific directory processing routines.

Development Comments:

The BSD group provided this routine.

5.23. pathconf¶

File:

pathconf.c

Processing:

This routine will obtain the value of one of the path configuration parameters and return it to the calling routine. It is layered on the generic open() and fpathconf() functions. These interfaces should not change with the addition of new filesystem types.

Development Comments:

This routine will try to open the file indicated by path.

If successful, the file descriptor will be used to access the pathconf value specified by name using the fpathconf() function.

The file that was accessed is then closed.

5.24. read¶

File:

deviceio.c

Processing:

This routine is layered on a set of RTEMS calls and filesystem specific read operations. The functions are layered in such a way as to isolate them from change as new filesystems are introduced.

Development Comments:

This routine will examine the type of file descriptor it is sent.

If the file descriptor is associated with a network device, the read function will be mapped to a special network handler. The return code from the network handler will then be sent as the return code from generic read() function.

For file descriptors that are associated with the filesystem the following sequence will be performed:

1. Obtain the file control block associated with the file descriptor

2. Range check the file descriptor

3. Determine that the buffer pointer is not invalid

4. Check that the count is not zero

5. Check the file control block to see if we have permissions to read

6. If there is a read function in the handler table, invoke the handler table read() function

7. Use the return code from the handler table read function(number of bytes read) to increment the offset element of the file control block

8. Return the number of bytes read to the calling program

5.25. readdir¶

File:

readdir.c

Processing:

This routine was acquired from the BSD group. It has not been altered from its original form.

Development Comments:

The routine calls a customized getdents() function that is provided by the user. This routine provides the filesystem specific aspects of reading a directory.

It is layered on the read() function in the directory handler table. This function has been mapped to the Imfs_dir_read() function.

5.26. unmount¶

File:

unmount.c

Processing:

This routine will attempt to dismount a mounted filesystem and then free all resources that were allocated for the management of that filesystem.

Development Comments:

• This routine will determine if there are any filesystems currently mounted under the filesystem that we are trying to dismount. This would prevent the dismount of the filesystem.

• It will test to see if the current directory is in the filesystem that we are attempting to dismount. This would prevent the dismount of the filesystem.

• It will scan all the currently open file descriptors to determine is there is an open file descriptor to a file in the filesystem that we are attempting to unmount().

If the above preconditions are met then the following sequence is performed:

1. Call the filesystem specific unmount() function for the filesystem that contains the mount point. This routine should indicate that the mount point no longer has a filesystem mounted below it.

2. Call the filesystem specific fsunmount_me() function for the mounted filesystem that we are trying to unmount(). This routine should clean up any resources that are no longer needed for the management of the file system being un-mounted.

3. Extract the mount table entry for the filesystem that was just dismounted from the mount table chain.

4. Free the memory associated with the extracted mount table entry.

5.27. eval¶

File:

XXX

Processing:

XXX

Development Comments:

XXX

5.28. getdentsc¶

File:

XXX

Processing:

XXX

Development Comments:

XXX

6.1. 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.

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.

Figure of the Filesystem Functional Layering goes here.
This figure focuses on the Base Filesystem and IMFS.

Figure of the IMFS Memfile control blocks

6.2. 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.

6.3. API Layering¶

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;
};

6.4. 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.

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;

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;

7.1. IMFS Per Node Data Structure¶

Each regular file, device, hard link, and directory is represented by a data structure called a jnode. The jnode is formally represented by the structure:

struct IMFS_jnode_tt {
    Chain_Node          Node;             /* for chaining them together */
    IMFS_jnode_t       *Parent;           /* Parent node */
    char                name[NAME_MAX+1]; /* "basename" */
    mode_t              st_mode;          /* File mode */
    nlink_t             st_nlink;         /* Link count */
    ino_t               st_ino;           /* inode */
    uid_t               st_uid;           /* User ID of owner */
    gid_t               st_gid;           /* Group ID of owner */
    time_t              st_atime;         /* Time of last access */
    time_t              st_mtime;         /* Time of last modification */
    time_t              st_ctime;         /* Time of last status change */
    IMFS_jnode_types_t  type;             /* Type of this entry */
    IMFS_typs_union     info;
};

The key elements of this structure are listed below together with a brief explanation of their role in the filesystem.

Node

exists to allow the entire jnode structure to be included in a chain.

Parent

is a pointer to another jnode structure that is the logical parent of the node in which it appears. This field may be NULL if the file associated with this node is deleted but there are open file descriptors on this file or there are still hard links to this node.

name

is the name of this node within the filesystem hierarchical tree. Example: If the fully qualified pathname to the jnode was /a/b/c, the jnode name field would contain the null terminated string "c".

st_mode

is the standard Unix access permissions for the file or directory.

st_nlink

is the number of hard links to this file. When a jnode is first created its link count is set to 1. A jnode and its associated resources cannot be deleted unless its link count is less than 1.

st_ino

is a unique node identification number

st_uid

is the user ID of the file’s owner

st_gid

is the group ID of the file’s owner

st_atime

is the time of the last access to this file

st_mtime

is the time of the last modification of this file

st_ctime

is the time of the last status change to the file

type

is the indication of node type must be one of the following states:

• IMFS_DIRECTORY

• IMFS_MEMORY_FILE

• IMFS_HARD_LINK

• IMFS_SYM_LINK

• IMFS_DEVICE

info

is this contains a structure that is unique to file type (See IMFS_typs_union in imfs.h).

• IMFS_DIRECTORY

  An IMFS directory contains a dynamic chain structure that records all files and directories that are subordinate to the directory node.

• IMFS_MEMORY_FILE

  Under the in memory filesystem regular files hold data. Data is dynamically allocated to the file in 128 byte chunks of memory. The individual chunks of memory are tracked by arrays of pointers that record the address of the allocated chunk of memory. Single, double, and triple indirection pointers are used to record the locations of all segments of the file. The memory organization of an IMFS file are discussed elsewhere in this manual.

• IMFS_HARD_LINK

  The IMFS filesystem supports the concept of hard links to other nodes in the IMFS filesystem. These hard links are actual pointers to other nodes in the same filesystem. This type of link cannot cross-filesystem boundaries.

• IMFS_SYM_LINK

  The IMFS filesystem supports the concept of symbolic links to other nodes in any filesystem. A symbolic link consists of a pointer to a character string that represents the pathname to the target node. This type of link can cross-filesystem boundaries. Just as with most versions of UNIX supporting symbolic links, a symbolic link can point to a non-existent file.

• IMFS_DEVICE

  All RTEMS devices now appear as files under the in memory filesystem. On system initialization, all devices are registered as nodes under the file system.

7.2. Miscellaneous IMFS Information¶

TBD

7.3. Memory associated with the IMFS¶

A memory based filesystem draws its resources for files and directories from the memory resources of the system. When it is time to un-mount the filesystem, the memory resources that supported filesystem are set free. In order to free these resources, a recursive walk of the filesystems tree structure will be performed. As the leaf nodes under the filesystem are encountered their resources are freed. When directories are made empty by this process, their resources are freed.

7.4. IMFS Operation Tables¶

rtems_filesystem_operations_table  IMFS_ops = {
    IMFS_eval_path,
    IMFS_evaluate_for_make,
    IMFS_link,
    IMFS_unlink,
    IMFS_node_type,
    IMFS_mknod,
    IMFS_rmnod,
    IMFS_chown,
    IMFS_freenodinfo,
    IMFS_mount,
    IMFS_initialize,
    IMFS_unmount,
    IMFS_fsunmount,
    IMFS_utime,
    IMFS_evaluate_link,
    IMFS_symlink,
    IMFS_readlink
};

rtems_filesystem_file_handlers_r IMFS_memfile_handlers = {
    memfile_open,
    memfile_close,
    memfile_read,
    memfile_write,
    memfile_ioctl,
    memfile_lseek,
    IMFS_stat,
    IMFS_fchmod,
    memfile_ftruncate,
    NULL,                /* fpathconf */
    NULL,                /* fsync */
    IMFS_fdatasync,
    IMFS_fcntl
};

rtems_filesystem_file_handlers_r IMFS_directory_handlers = {
    IMFS_dir_open,
    IMFS_dir_close,
    IMFS_dir_read,
    NULL,             /* write */
    NULL,             /* ioctl */
    IMFS_dir_lseek,
    IMFS_dir_fstat,
    IMFS_fchmod,
    NULL,             /* ftruncate */
    NULL,             /* fpathconf */
    NULL,             /* fsync */
    IMFS_fdatasync,
    IMFS_fcntl
};

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_file_handlers_r;

9.1. RTEMS TFTP Filesystem Implementation¶

The RTEMS TFTP filesystem implements a TFTP client which can be used through the file system. With other words, one needs to mount the TFTP filesystem and can afterwards open a file for reading or writing below that mount point. The content of that file is then effectively read from or written to the remote server. The RTEMS implementation implements the following features:

• RFC 1350 The TFTP Protocol (Revision 2)

• RFC 2347 TFTP Option Extension

• RFC 2348 TFTP Blocksize Option

• RFC 7440 TFTP Windowsize Option

Many simple TFTP server do not support options (RFC 2347). Therefore, in case the server rejects the first request with options, the RTEMS client makes automatically a second attempt using only the “classical” RFC 1350.

The implementation has the following shortcomings:

• IPv6 is not supported (yet).

• No congestion control is implemented.

  (Congestion is simply expressed a network traffic jam which involves package loss.) This implementation would worsen a congestion situation and squeeze out TCP connections. If that is a concern in your setup, it can be prevented by using value 1 as windowsize when mounting the TFTP file system.

• One must call open(), read(), write() and close() at a good pace.

  TFTP is designed to read or write a whole already existing file in one sweep. It uses timeouts (of unspecified length) and it does not know keep-alive messages. If the client does not respond to the server in due time, the server sets the connection faulty and drops it. To avoid this, the user must read or write enough data fast enough.

  The point here is, one cannot pause the reading or writing for longer periods of time. TFTP cannot be used for example to write log files where all few seconds a line is written. Also opening the file at the beginning of an application and closing it that the end will certainly lead to a timeout. As another example, one cannot read a file by reading one byte per second, this will trigger a timeout and the server closes the connection. The opening, reading or writing and closing must happen in swift consecutive steps.

• The transfer mode is always octet. The only alternative netascii cannot be selected.

• Block number roll-over is currently not supported. Therefore, the maximum file size is limited to max-block-number times blocksize. For RFC 1350 blocksize is would be 65535 * 512 = 32 MB. For the default blocksize is would be 65535 * 1456 = 90 MB.

• The inherent insecurity of the protocol has already be mentioned but it is worth repeating.

9.2. Prerequisites¶

To use the RTEMS TFTP filesystem one needs:

• The RTEMS tools (cross-compiler, linker, debugger etc.)

• The RTEMS Board Support Package (BSP)

• A network stack for RTEMS, for example RTEMS libbsd

As an example the ARM architecture and a xilinx_zynq_a9 BSP is used below together with RTEMS libbsd. The instructions are tested with RTEMS version 6. It is recommended to actually use arm/xilinx_zynq_a9_qemu for the first experiments as other BSPs tend to require different configuration values and/or command line options.

Moreover, it is recommended to first execute any code using QEMU as simulator so that no hardware is needed. Therefore, qemu-system-arm must be installed. In Linux distributions this executable is usually available in the repositories as package qemu-arm.

--rtems-bsps=arm/xilinx_zynq_a9_qemu

#define CONFIGURE_FILESYSTEM_TFTPFS

/* Configure libbsd. */
#define RTEMS_BSD_CONFIG_NET_PF_UNIX
#define RTEMS_BSD_CONFIG_NET_IF_BRIDGE
#define RTEMS_BSD_CONFIG_NET_IF_LAGG
#define RTEMS_BSD_CONFIG_NET_IF_VLAN
#define RTEMS_BSD_CONFIG_BSP_CONFIG
#define RTEMS_BSD_CONFIG_INIT

#include <machine/rtems-bsd-config.h>

/* RTEMS configuration for libbsd */
#define CONFIGURE_MAXIMUM_USER_EXTENSIONS 1
#define CONFIGURE_INIT_TASK_STACK_SIZE (32 * 1024)
#define CONFIGURE_INIT_TASK_INITIAL_MODES RTEMS_DEFAULT_MODES
#define CONFIGURE_INIT_TASK_ATTRIBUTES RTEMS_FLOATING_POINT
#define CONFIGURE_APPLICATION_NEEDS_LIBBLOCK

/* RTEMS configuration for tftp */
#define CONFIGURE_FILESYSTEM_TFTPFS
#define CONFIGURE_MAXIMUM_FILE_DESCRIPTORS 64

/* Simple RTEMS configuration */
#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
#define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
#define CONFIGURE_UNLIMITED_OBJECTS
#define CONFIGURE_UNIFIED_WORK_AREAS
#define CONFIGURE_RTEMS_INIT_TASKS_TABLE
#define CONFIGURE_INIT

#include <rtems/confdefs.h>

<PREFIX>/arm-rtems6/xilinx_zynq_a9_qemu/lib/libtftpfs.a

def build(ctx):
    rtems.build(ctx)
    ctx(features = 'c cprogram',
        target = 'tftp_app.exe',
        cflags = '-g -O2',
        source = ['tftp_app.c', 'tftp_init.c'],
        lib    = ['tftpfs', 'bsd', 'm'])

-nic user,model=cadence_gem,tftp=/tmp

# Create and configure TAP interface
ip tuntap add qtap mode tap user <APP-USER>
ip link set dev qtap up
ip addr add 169.254.1.1/16 dev qtap

# Open firewalld as non-permanent configuration
firewall-cmd --zone=home --add-service=tftp
firewall-cmd --zone=home --add-interface=qtap

# Start TFTP daemon
touch /var/log/atftpd/atftp.log
chown tftp.tftp /var/log/atftpd/atftp.log
atftpd --user tftp --group tftp --daemon --verbose \
    --logfile /var/log/atftpd/atftp.log /srv/tftpboot

-nic tap,model=cadence_gem,ifname=qtap,script=no,downscript=no

9.3. Usage¶

The following diagram usage shows how the TFTP filesystem is used by an application. The mount point can be any directory. The name /tftp used in the figure serves only as an example. The final unmounting and remove directory steps are optional.

<PREFIX>/<server-address>:<path-on-server>

"/tftp/169.254.1.1:file.txt"
"/TFTPFS/tftp-server.sample.org:bootfiles/image"

9.4. Use From Shell¶

It is possible to use the RTEMS shell through test media01 of libbsd to exercise the TFTP filesystem. This text assumes that libbsd has already been setup, configured, compiled and installed as described in the README.rst of the rtems-libbsd GIT repository. How the test media01.exe can be executed is described in section Qemu and Networking of that file.

A TFTP server must be setup and run. The instructions to setup an TAP device and an atftp server found above in section External TFTP Server Example for OpenSUSE could be followed for this purpose. It may be useful to create a sample file for later download in the directory served by the TFTP server. For atftp “root” could create a file with these instructions:

# echo "Hello World!" >/srv/tftpboot/hello.txt
# chown tftp.tftp /srv/tftpboot/hello.txt

Start the media01 test in one terminal — as “normal” user:

$ qemu-system-arm -serial null -serial mon:stdio -nographic \
  -M xilinx-zynq-a9 -m 256M \
  -nic tap,model=cadence_gem,ifname=qtap,script=no,downscript=no \
  -kernel build/arm-rtems6-xilinx_zynq_a9_qemu-default/media01.exe

Wait till a line like the following is printed in the terminal:

info: cgem0: using IPv4LL address 169.254.191.13

Next use the displayed IP address to open a telnet connection in a second terminal:

$ telnet 169.254.191.13

At the telnet prompt, enter this command to list the filesystems available for mounting:

TLNT [/] # mount -L
File systems: / dosfs tftpfs

tftpfs should be among them. Create a directory and mount the TFTP filesystem:

TLNT [/] # mkdir /tftp
TLNT [/] # mount -t tftpfs -o verbose "" /tftp
mounted  -> /tftp

Now, files can be sent to and read from the TFTP server using the usual shell commands:

TLNT [/] # cp /etc/dhcpcd.duid /tftp/169.254.1.1:dhcpcd.duid
TFTPFS: /169.254.1.1:dhcpcd.duid
TLNT [/] # cat /tftp/169.254.1.1:hello.txt
TFTPFS: /169.254.1.1:hello.txt
Hello World!

The terminal session can be terminated with key combination “CTRL-]” followed by a quit command; the QEMU simulation with “CTRL-a x” and tail -f with “CTRL-c”.

9.5. TFTP Client API¶

The TFTP filesystem has a TFTP client which is responsible to handle all network traffic. It permits the use of TFTP without filesystem. Essentially, one saves the mounting of the filesystem. Otherwise the usage is similar to the one of the filesystem. The equivalent of the open(), read(), write(), and close() functions are:

int tftp_open(
  const char *hostname,
  const char *path,
  bool is_for_reading,
  const tftp_net_config *config,
  void **tftp_handle
);

ssize_t tftp_read( void *tftp_handle, void *buffer, size_t count );

ssize_t tftp_write( void *tftp_handle, const void *buffer, size_t count );

int tftp_close( void *tftp_handle );

tftp_open() accepts as input a data structure of type tftp_net_config. It can be used to specify certain values governing the file transfer such as the already described options. Data of tftp_net_config type can be initialized using function

void tftp_initialize_net_config( tftp_net_config *config );

The full description can be found in the file cpukit/include/rtems/tftp.h. The function rtems_tftpfs_initialize() found there is only for RTEMS internal use by the mount() function.

9.6. Software Design¶

The original source code contained only the files cpukit/include/rtems/tftp.h and cpukit/libfs/src/ftpfs/tftpDriver.c. There was no test suite nor any documentation.

When the code was extended to support options (RFC 2347 and others), the code in tftpDriver.c was split. The new file tftpfs.c is responsible to handle all filesystem related issues while tftpDriver.c provides the network related functions. In effect tftpDriver.c is a TFTP client library which can be used independently of the filesystem. tftpfs.c calls the functions of tftpDriver.c to do the actual TFTP file transfer.

At this occasion a test suite and this documentation in the RTEMS Filesystem Design Guide was added.

$ cd <path-to-rtems-git-worktree>
$ rtems-test --log-mode=all --rtems-bsp=xilinx_zynq_a9_qemu \
  build/arm/xilinx_zynq_a9_qemu/testsuites/fstests/tftpfs.exe