aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDarrick J. Wong <darrick.wong@oracle.com>2016-12-19 14:06:56 -0800
committerDarrick J. Wong <darrick.wong@oracle.com>2016-12-20 22:46:32 -0800
commitfc7cfa00bcdc8b880c7ea99a22796febfaee7f2b (patch)
tree8496fba1b75f87091f8669fce1084dba52e0f7a4
parent33bb782ac245caf8b4bc4c167ad662bf32077be5 (diff)
downloadxfs-documentation-fc7cfa00bcdc8b880c7ea99a22796febfaee7f2b.tar.gz
docs: enumerate possible directory ftype values
We don't actually list the ftype constants, so do that. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
-rw-r--r--design/XFS_Filesystem_Structure/directories.asciidoc29
1 files changed, 29 insertions, 0 deletions
diff --git a/design/XFS_Filesystem_Structure/directories.asciidoc b/design/XFS_Filesystem_Structure/directories.asciidoc
index 1758c4e..9bb50bd 100644
--- a/design/XFS_Filesystem_Structure/directories.asciidoc
+++ b/design/XFS_Filesystem_Structure/directories.asciidoc
@@ -26,6 +26,35 @@ directories.
* An +offset+ or +tag+ used for iterative readdir calls.
+* If the +XFS_SB_FEAT_INCOMPAT_FTYPE+ feature flag is set, each
+directory entry contains an +ftype+ field that caches the inode's type
+to avoid having to perform an inode lookup.
+
+.ftype values
+[options="header"]
+|=====
+| Flag | Description
+| +XFS_DIR3_FT_UNKNOWN+ |
+Entry points to an unknown inode type. This should never appear on disk.
+| +XFS_DIR3_FT_REG_FILE+ |
+Entry points to a file.
+| +XFS_DIR3_FT_DIR+ |
+Entry points to another directory.
+| +XFS_DIR3_FT_CHRDEV+ |
+Entry points to a character device.
+| +XFS_DIR3_FT_BLKDEV+ |
+Entry points to a block device.
+| +XFS_DIR3_FT_FIFO+ |
+Entry points to a FIFO.
+| +XFS_DIR3_FT_SOCK+ |
+Entry points to a socket.
+| +XFS_DIR3_FT_SYMLINK+ |
+Entry points to a symbolic link.
+| +XFS_DIR3_FT_WHT+ |
+Entry points to an overlayfs whiteout file. This (as far as the author
+knows) has never appeared on disk.
+|=====
+
All non-shortform directories also contain two additional structures: ``leaves''
and ``freespace indexes''.