forked from Imagelibrary/rtems
More cleanup.
This commit is contained in:
@@ -18,7 +18,7 @@ and 7).
|
|||||||
|
|
||||||
|
|
||||||
@example
|
@example
|
||||||
Figure of the File System Functional Layering goes here.
|
Figure of the Filesystem Functional Layering goes here.
|
||||||
This figure includes networking and disk caching layering.
|
This figure includes networking and disk caching layering.
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
@@ -81,8 +81,8 @@ interface routines.
|
|||||||
|
|
||||||
|
|
||||||
@example
|
@example
|
||||||
Figure of the File System Functional Layering goes here.
|
Figure of the Filesystem Functional Layering goes here.
|
||||||
This figure focuses on the Base File System and IMFS.
|
This figure focuses on the Base Filesystem and IMFS.
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
|
|
||||||
@@ -97,7 +97,7 @@ Figure of the IMFS Memfile control blocks
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
@section Mapping of Generic System Calls to File System Specific Functions
|
@section Mapping of Generic System Calls to Filesystem Specific Functions
|
||||||
|
|
||||||
|
|
||||||
The list of generic system calls includes the routines open(), read(),
|
The list of generic system calls includes the routines open(), read(),
|
||||||
@@ -263,13 +263,13 @@ pointers to the OPS table for the file system that contains the node, the
|
|||||||
node type specific handlers for the node and a reference pointer to the
|
node type specific handlers for the node and a reference pointer to the
|
||||||
mount table entry associated with the file system containing the node
|
mount table entry associated with the file system containing the node
|
||||||
|
|
||||||
@subsection File System Functional Interface to Files and Directories
|
@subsection Filesystem Functional Interface to Files and Directories
|
||||||
|
|
||||||
@itemize @bullet
|
@itemize @bullet
|
||||||
|
|
||||||
@item Access using relative or absolute path names to file
|
@item Access using relative or absolute path names to file
|
||||||
|
|
||||||
@item OP Table for File System - rtems_filesystem_operations_table
|
@item OP Table for Filesystem - rtems_filesystem_operations_table
|
||||||
|
|
||||||
@enumerate
|
@enumerate
|
||||||
@item evalpath()
|
@item evalpath()
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
@c
|
@c
|
||||||
|
|
||||||
|
|
||||||
@chapter Base File System
|
@chapter Base Filesystem
|
||||||
|
|
||||||
RTEMS initially mounts a RAM based file system known as the base file system.
|
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
|
The root directory of this file system tree serves as the logical root of the
|
||||||
@@ -34,7 +34,7 @@ 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
|
for these new file system types and the unique data and functionality that is
|
||||||
required to manage the future file systems.
|
required to manage the future file systems.
|
||||||
|
|
||||||
@section Base File System Mounting
|
@section Base Filesystem Mounting
|
||||||
|
|
||||||
At present, the first file system to be mounted is the `In Memory File
|
At present, the first file system to be mounted is the `In Memory File
|
||||||
System'. It is mounted using a standard MOUNT() command in which the mount
|
System'. It is mounted using a standard MOUNT() command in which the mount
|
||||||
@@ -71,7 +71,7 @@ Note: Other file systems can be mounted but they are mounted onto points
|
|||||||
(directory mount points) in the base file system.
|
(directory mount points) in the base file system.
|
||||||
|
|
||||||
|
|
||||||
@subsection Base File System Node Structure and Function
|
@subsection Base Filesystem Node Structure and Function
|
||||||
|
|
||||||
Each regular file, device, hard link, and directory is represented by a data
|
Each regular file, device, hard link, and directory is represented by a data
|
||||||
structure called a @code{jnode}. The @code{jnode} is formally represented by the
|
structure called a @code{jnode}. The @code{jnode} is formally represented by the
|
||||||
@@ -235,7 +235,7 @@ function.
|
|||||||
|
|
||||||
@section IMFS
|
@section IMFS
|
||||||
|
|
||||||
@subsection OPS Table Functions for the In Memory File System (IMFS)
|
@subsection OPS Table Functions for the In Memory Filesystem (IMFS)
|
||||||
|
|
||||||
@example
|
@example
|
||||||
|
|
||||||
@@ -262,7 +262,7 @@ Readlink Imfs_readlink.c IMFS_readlink()
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
@subsection Handler Functions for Regular Files of In Memory File System
|
@subsection Handler Functions for Regular Files of In Memory Filesystem
|
||||||
|
|
||||||
@example
|
@example
|
||||||
Handler Function File Routine Name
|
Handler Function File Routine Name
|
||||||
@@ -282,7 +282,7 @@ Fdatasync NA NULL
|
|||||||
@end example
|
@end example
|
||||||
|
|
||||||
|
|
||||||
@subsection Handler Functions for Directories of In Memory File System
|
@subsection Handler Functions for Directories of In Memory Filesystem
|
||||||
|
|
||||||
@example
|
@example
|
||||||
Handler Function File Routine Name
|
Handler Function File Routine Name
|
||||||
@@ -303,7 +303,7 @@ Fdatasync NA NULL
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
@subsection Handler Functions for Devices of In Memory File System
|
@subsection Handler Functions for Devices of In Memory Filesystem
|
||||||
|
|
||||||
@example
|
@example
|
||||||
Handler Function File Routine Name
|
Handler Function File Routine Name
|
||||||
|
|||||||
@@ -79,13 +79,13 @@ This is the online version of the RTEMS Filesystem Design Guide.
|
|||||||
|
|
||||||
@menu
|
@menu
|
||||||
* Preface::
|
* Preface::
|
||||||
* Base File System::
|
* Base Filesystem::
|
||||||
* Applications and Functional Layering::
|
* Applications and Functional Layering::
|
||||||
* Pathname Evaluation::
|
* Pathname Evaluation::
|
||||||
* System Initialization::
|
* System Initialization::
|
||||||
* Mounting and Unmounting File Systems::
|
* Mounting and Unmounting Filesystems::
|
||||||
* File System Lifecycle::
|
* Filesystem Lifecycle::
|
||||||
* In-Memory File System::
|
* In-Memory Filesystem::
|
||||||
* System Call Development Notes::
|
* System Call Development Notes::
|
||||||
* Command and Variable Index::
|
* Command and Variable Index::
|
||||||
* Concept Index::
|
* Concept Index::
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
|
|
||||||
@chapter In-Memory File System
|
@chapter In-Memory Filesystem
|
||||||
|
|
||||||
This chapter describes the In-Memory File System.
|
This chapter describes the In-Memory Filesystem.
|
||||||
|
|
||||||
@section OPS Table Functions
|
@section Filesystem Handler Table Functions
|
||||||
|
|
||||||
OPS table functions are defined in a rtems_filesystem_operations_table
|
OPS table functions are defined in a rtems_filesystem_operations_table
|
||||||
structure. It defines functions that are specific to a given file system.
|
structure. It defines functions that are specific to a given file system.
|
||||||
@@ -619,7 +619,7 @@ XXX
|
|||||||
@c
|
@c
|
||||||
@c
|
@c
|
||||||
@page
|
@page
|
||||||
@section Handler Table Functions for Regular Files
|
@section Regular File Handler Table Functions
|
||||||
|
|
||||||
Handler table functions are defined in a rtems_filesystem_file_handlers_r
|
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
|
structure. It defines functions that are specific to a node type in a given
|
||||||
@@ -652,7 +652,7 @@ typedef struct @{
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection open() for Regular File
|
@subsection open() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -682,7 +682,7 @@ a success code is always returned.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection close() for Regular File
|
@subsection close() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -711,7 +711,7 @@ and then immediately returns a success status.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection read() for Regular File
|
@subsection read() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -758,7 +758,7 @@ IMFS_memfile_read() will do the following:
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection write() for Regular File
|
@subsection write() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -781,7 +781,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection ioctl() for Regular File
|
@subsection ioctl() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -810,7 +810,7 @@ a successful completion status.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection lseek() for Regular File
|
@subsection lseek() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -843,7 +843,7 @@ file position index. A success code is always returned from this routine.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection fstat() for Regular File
|
@subsection fstat() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -905,7 +905,7 @@ structure:
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection fchmod() for Regular File
|
@subsection fchmod() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -946,7 +946,7 @@ based on the mode calling parameter.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection ftruncate() for Regular File
|
@subsection ftruncate() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -969,7 +969,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection fpathconf() for Regular File
|
@subsection fpathconf() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -994,7 +994,7 @@ Not Implemented
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection fsync() for Regular File
|
@subsection fsync() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1018,7 +1018,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@subsection fdatasync() for Regular File
|
@subsection fdatasync() for Regular Files
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1039,7 +1039,7 @@ XXX
|
|||||||
@c
|
@c
|
||||||
@c
|
@c
|
||||||
@page
|
@page
|
||||||
@section Handler Table Functions for Directories
|
@section Directory Handler Table Functions
|
||||||
|
|
||||||
Handler table functions are defined in a rtems_filesystem_file_handlers_r
|
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
|
structure. It defines functions that are specific to a node type in a given
|
||||||
@@ -1072,7 +1072,7 @@ typedef struct @{
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section open() for Directories
|
@subsection open() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1108,7 +1108,7 @@ This allows us to start reading at the beginning of the directory.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section close() for Directories
|
@subsection close() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1135,7 +1135,7 @@ immediately returns a success status.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section read() for Directories
|
@subsection read() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1166,7 +1166,7 @@ this routine.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section write() for Directories
|
@subsection write() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1190,7 +1190,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section ioctl() for Directories
|
@subsection ioctl() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1213,7 +1213,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section lseek() for Directories
|
@subsection lseek() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1247,7 +1247,7 @@ the open directory.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fstat() for Directories
|
@subsection fstat() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1293,7 +1293,7 @@ of the children of the directory.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fchmod() for Directories
|
@subsection fchmod() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1334,7 +1334,7 @@ based on the mode calling parameter.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section ftruncate() for Directories
|
@subsection ftruncate() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1358,7 +1358,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fpathconf() for Directories
|
@subsection fpathconf() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1383,7 +1383,7 @@ Not Implemented
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fsync() for Directories
|
@subsection fsync() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1407,7 +1407,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fdatasync() for Directories
|
@subsection fdatasync() for Directories
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1426,7 +1426,7 @@ XXX
|
|||||||
XXX
|
XXX
|
||||||
|
|
||||||
|
|
||||||
@section Handler Table Functions for Devices
|
@section Device Handler Table Functions
|
||||||
|
|
||||||
Handler table functions are defined in a rtems_filesystem_file_handlers_r
|
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
|
structure. It defines functions that are specific to a node type in a given
|
||||||
@@ -1458,7 +1458,7 @@ typedef struct @{
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section open() for Devices
|
@subsection open() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1494,7 +1494,7 @@ driver that contains the file control block, flags and mode information.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section close() for Devices
|
@subsection close() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1527,7 +1527,7 @@ major and minor device numbers.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section read() for Devices
|
@subsection read() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1578,7 +1578,7 @@ read will be returned to the calling program.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section write() for Devices
|
@subsection write() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1601,7 +1601,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section ioctl() for Devices
|
@subsection ioctl() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1647,7 +1647,7 @@ the calling program, otherwise the ioctl_return value is returned.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section lseek() for Devices
|
@subsection lseek() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1676,7 +1676,7 @@ successful status.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fstat() for Devices
|
@subsection fstat() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1738,7 +1738,7 @@ structure:
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fchmod() for Devices
|
@subsection fchmod() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1780,7 +1780,7 @@ based on the mode calling parameter.
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section ftruncate() for Devices
|
@subsection ftruncate() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1803,7 +1803,7 @@ XXX
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fpathconf() for Devices
|
@subsection fpathconf() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
@@ -1828,7 +1828,7 @@ Not Implemented
|
|||||||
|
|
||||||
@page
|
@page
|
||||||
|
|
||||||
@section fsync() for Devices
|
@subsection fsync() for Devices
|
||||||
|
|
||||||
@subheading Slot Function:
|
@subheading Slot Function:
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ of the following:
|
|||||||
@item Initialization of mount table chain control structure
|
@item Initialization of mount table chain control structure
|
||||||
|
|
||||||
@item Allocation of a @code{jnode} structure that will server as the root node
|
@item Allocation of a @code{jnode} structure that will server as the root node
|
||||||
of the `In Memory File System'
|
of the `In Memory Filesystem'
|
||||||
|
|
||||||
@item Initialization of the allocated @code{jnode} with the appropriate OPS,
|
@item Initialization of the allocated @code{jnode} with the appropriate OPS,
|
||||||
directory handlers and pathconf limits and options.
|
directory handlers and pathconf limits and options.
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
@c $Id$
|
@c $Id$
|
||||||
@c
|
@c
|
||||||
|
|
||||||
@chapter File System Lifecycle
|
@chapter Filesystem Lifecycle
|
||||||
|
|
||||||
This chapter describes some of the dynamic behavior of file system control
|
This chapter describes some of the dynamic behavior of file system control
|
||||||
structures
|
structures
|
||||||
@@ -19,7 +19,7 @@ initialized to an empty state during the base file system initialization.
|
|||||||
The mount operation will add entries to the mount table chain. The
|
The mount operation will add entries to the mount table chain. The
|
||||||
un-mount operation will remove entries from the mount table chain.
|
un-mount operation will remove entries from the mount table chain.
|
||||||
|
|
||||||
@section Memory associated with the In Memory File System
|
@section Memory associated with the In Memory Filesystem
|
||||||
|
|
||||||
A memory based file system draws its resources for files and directories
|
A memory based file system draws its resources for files and directories
|
||||||
from the memory resources of the system. When it is time to un-mount the
|
from the memory resources of the system. When it is time to un-mount the
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
@c $Id$
|
@c $Id$
|
||||||
@c
|
@c
|
||||||
|
|
||||||
@chapter Mounting and Unmounting File Systems
|
@chapter Mounting and Unmounting Filesystems
|
||||||
|
|
||||||
@section Mount Points
|
@section Mount Points
|
||||||
|
|
||||||
@@ -32,6 +32,7 @@ of the mount point after the mount is complete.
|
|||||||
|
|
||||||
Each entry in the mount table chain is of the following type:
|
Each entry in the mount table chain is of the following type:
|
||||||
|
|
||||||
|
@example
|
||||||
struct rtems_filesystem_mount_table_entry_tt
|
struct rtems_filesystem_mount_table_entry_tt
|
||||||
@{
|
@{
|
||||||
Chain_Node Node;
|
Chain_Node Node;
|
||||||
@@ -51,6 +52,7 @@ struct rtems_filesystem_mount_table_entry_tt
|
|||||||
*/
|
*/
|
||||||
char *dev;
|
char *dev;
|
||||||
@};
|
@};
|
||||||
|
@end example
|
||||||
|
|
||||||
@section Adding entries to the chain during mount
|
@section Adding entries to the chain during mount
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
@c
|
@c
|
||||||
|
|
||||||
@ifinfo
|
@ifinfo
|
||||||
@node Preface, Base File System, Top, Top
|
@node Preface, Base Filesystem, Top, Top
|
||||||
@end ifinfo
|
@end ifinfo
|
||||||
@unnumbered Preface
|
@unnumbered Preface
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user