Commit fc2f6fe7 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: filesystems: convert xfs-self-describing-metadata.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/7c26b200e12cfc07b9bd379612452d845a8d1474.1588021877.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent c3d2f6cb
...@@ -118,4 +118,5 @@ Documentation for filesystem implementations. ...@@ -118,4 +118,5 @@ Documentation for filesystem implementations.
virtiofs virtiofs
vfat vfat
xfs-delayed-logging-design xfs-delayed-logging-design
xfs-self-describing-metadata
zonefs zonefs
.. SPDX-License-Identifier: GPL-2.0
============================
XFS Self Describing Metadata XFS Self Describing Metadata
---------------------------- ============================
Introduction Introduction
------------ ============
The largest scalability problem facing XFS is not one of algorithmic The largest scalability problem facing XFS is not one of algorithmic
scalability, but of verification of the filesystem structure. Scalabilty of the scalability, but of verification of the filesystem structure. Scalabilty of the
...@@ -34,7 +37,7 @@ required for basic forensic analysis of the filesystem structure. ...@@ -34,7 +37,7 @@ required for basic forensic analysis of the filesystem structure.
Self Describing Metadata Self Describing Metadata
------------------------ ========================
One of the problems with the current metadata format is that apart from the One of the problems with the current metadata format is that apart from the
magic number in the metadata block, we have no other way of identifying what it magic number in the metadata block, we have no other way of identifying what it
...@@ -142,7 +145,7 @@ modification occurred between the corruption being written and when it was ...@@ -142,7 +145,7 @@ modification occurred between the corruption being written and when it was
detected. detected.
Runtime Validation Runtime Validation
------------------ ==================
Validation of self-describing metadata takes place at runtime in two places: Validation of self-describing metadata takes place at runtime in two places:
...@@ -183,18 +186,18 @@ error occurs during this process, the buffer is again marked with a EFSCORRUPTED ...@@ -183,18 +186,18 @@ error occurs during this process, the buffer is again marked with a EFSCORRUPTED
error for the higher layers to catch. error for the higher layers to catch.
Structures Structures
---------- ==========
A typical on-disk structure needs to contain the following information: A typical on-disk structure needs to contain the following information::
struct xfs_ondisk_hdr { struct xfs_ondisk_hdr {
__be32 magic; /* magic number */ __be32 magic; /* magic number */
__be32 crc; /* CRC, not logged */ __be32 crc; /* CRC, not logged */
uuid_t uuid; /* filesystem identifier */ uuid_t uuid; /* filesystem identifier */
__be64 owner; /* parent object */ __be64 owner; /* parent object */
__be64 blkno; /* location on disk */ __be64 blkno; /* location on disk */
__be64 lsn; /* last modification in log, not logged */ __be64 lsn; /* last modification in log, not logged */
}; };
Depending on the metadata, this information may be part of a header structure Depending on the metadata, this information may be part of a header structure
separate to the metadata contents, or may be distributed through an existing separate to the metadata contents, or may be distributed through an existing
...@@ -214,14 +217,14 @@ level of information is generally provided. For example: ...@@ -214,14 +217,14 @@ level of information is generally provided. For example:
well. hence the additional metadata headers change the overall format well. hence the additional metadata headers change the overall format
of the metadata. of the metadata.
A typical buffer read verifier is structured as follows: A typical buffer read verifier is structured as follows::
#define XFS_FOO_CRC_OFF offsetof(struct xfs_ondisk_hdr, crc) #define XFS_FOO_CRC_OFF offsetof(struct xfs_ondisk_hdr, crc)
static void static void
xfs_foo_read_verify( xfs_foo_read_verify(
struct xfs_buf *bp) struct xfs_buf *bp)
{ {
struct xfs_mount *mp = bp->b_mount; struct xfs_mount *mp = bp->b_mount;
if ((xfs_sb_version_hascrc(&mp->m_sb) && if ((xfs_sb_version_hascrc(&mp->m_sb) &&
...@@ -231,7 +234,7 @@ xfs_foo_read_verify( ...@@ -231,7 +234,7 @@ xfs_foo_read_verify(
XFS_CORRUPTION_ERROR(__func__, XFS_ERRLEVEL_LOW, mp, bp->b_addr); XFS_CORRUPTION_ERROR(__func__, XFS_ERRLEVEL_LOW, mp, bp->b_addr);
xfs_buf_ioerror(bp, EFSCORRUPTED); xfs_buf_ioerror(bp, EFSCORRUPTED);
} }
} }
The code ensures that the CRC is only checked if the filesystem has CRCs enabled The code ensures that the CRC is only checked if the filesystem has CRCs enabled
by checking the superblock of the feature bit, and then if the CRC verifies OK by checking the superblock of the feature bit, and then if the CRC verifies OK
...@@ -239,12 +242,12 @@ by checking the superblock of the feature bit, and then if the CRC verifies OK ...@@ -239,12 +242,12 @@ by checking the superblock of the feature bit, and then if the CRC verifies OK
The verifier function will take a couple of different forms, depending on The verifier function will take a couple of different forms, depending on
whether the magic number can be used to determine the format of the block. In whether the magic number can be used to determine the format of the block. In
the case it can't, the code is structured as follows: the case it can't, the code is structured as follows::
static bool static bool
xfs_foo_verify( xfs_foo_verify(
struct xfs_buf *bp) struct xfs_buf *bp)
{ {
struct xfs_mount *mp = bp->b_mount; struct xfs_mount *mp = bp->b_mount;
struct xfs_ondisk_hdr *hdr = bp->b_addr; struct xfs_ondisk_hdr *hdr = bp->b_addr;
...@@ -263,15 +266,15 @@ xfs_foo_verify( ...@@ -263,15 +266,15 @@ xfs_foo_verify(
/* object specific verification checks here */ /* object specific verification checks here */
return true; return true;
} }
If there are different magic numbers for the different formats, the verifier If there are different magic numbers for the different formats, the verifier
will look like: will look like::
static bool static bool
xfs_foo_verify( xfs_foo_verify(
struct xfs_buf *bp) struct xfs_buf *bp)
{ {
struct xfs_mount *mp = bp->b_mount; struct xfs_mount *mp = bp->b_mount;
struct xfs_ondisk_hdr *hdr = bp->b_addr; struct xfs_ondisk_hdr *hdr = bp->b_addr;
...@@ -288,15 +291,15 @@ xfs_foo_verify( ...@@ -288,15 +291,15 @@ xfs_foo_verify(
/* object specific verification checks here */ /* object specific verification checks here */
return true; return true;
} }
Write verifiers are very similar to the read verifiers, they just do things in Write verifiers are very similar to the read verifiers, they just do things in
the opposite order to the read verifiers. A typical write verifier: the opposite order to the read verifiers. A typical write verifier::
static void static void
xfs_foo_write_verify( xfs_foo_write_verify(
struct xfs_buf *bp) struct xfs_buf *bp)
{ {
struct xfs_mount *mp = bp->b_mount; struct xfs_mount *mp = bp->b_mount;
struct xfs_buf_log_item *bip = bp->b_fspriv; struct xfs_buf_log_item *bip = bp->b_fspriv;
...@@ -315,7 +318,7 @@ xfs_foo_write_verify( ...@@ -315,7 +318,7 @@ xfs_foo_write_verify(
hdr->lsn = cpu_to_be64(bip->bli_item.li_lsn); hdr->lsn = cpu_to_be64(bip->bli_item.li_lsn);
} }
xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length), XFS_FOO_CRC_OFF); xfs_update_cksum(bp->b_addr, BBTOB(bp->b_length), XFS_FOO_CRC_OFF);
} }
This will verify the internal structure of the metadata before we go any This will verify the internal structure of the metadata before we go any
further, detecting corruptions that have occurred as the metadata has been further, detecting corruptions that have occurred as the metadata has been
...@@ -324,7 +327,7 @@ update the LSN field (when it was last modified) and calculate the CRC on the ...@@ -324,7 +327,7 @@ update the LSN field (when it was last modified) and calculate the CRC on the
metadata. Once this is done, we can issue the IO. metadata. Once this is done, we can issue the IO.
Inodes and Dquots Inodes and Dquots
----------------- =================
Inodes and dquots are special snowflakes. They have per-object CRC and Inodes and dquots are special snowflakes. They have per-object CRC and
self-identifiers, but they are packed so that there are multiple objects per self-identifiers, but they are packed so that there are multiple objects per
...@@ -347,4 +350,3 @@ XXX: inode unlinked list modification doesn't recalculate the inode CRC! None of ...@@ -347,4 +350,3 @@ XXX: inode unlinked list modification doesn't recalculate the inode CRC! None of
the unlinked list modifications check or update CRCs, neither during unlink nor the unlinked list modifications check or update CRCs, neither during unlink nor
log recovery. So, it's gone unnoticed until now. This won't matter immediately - log recovery. So, it's gone unnoticed until now. This won't matter immediately -
repair will probably complain about it - but it needs to be fixed. repair will probably complain about it - but it needs to be fixed.
...@@ -18534,7 +18534,7 @@ T: git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git ...@@ -18534,7 +18534,7 @@ T: git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
F: Documentation/ABI/testing/sysfs-fs-xfs F: Documentation/ABI/testing/sysfs-fs-xfs
F: Documentation/admin-guide/xfs.rst F: Documentation/admin-guide/xfs.rst
F: Documentation/filesystems/xfs-delayed-logging-design.rst F: Documentation/filesystems/xfs-delayed-logging-design.rst
F: Documentation/filesystems/xfs-self-describing-metadata.txt F: Documentation/filesystems/xfs-self-describing-metadata.rst
F: fs/xfs/ F: fs/xfs/
F: include/uapi/linux/dqblk_xfs.h F: include/uapi/linux/dqblk_xfs.h
F: include/uapi/linux/fsmap.h F: include/uapi/linux/fsmap.h
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment