^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ======================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) The SGI XFS Filesystem
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) ======================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) XFS is a high performance journaling filesystem which originated
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) on the SGI IRIX platform. It is completely multi-threaded, can
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) support large files and large filesystems, extended attributes,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) variable block sizes, is extent based, and makes extensive use of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) Btrees (directories, extents, free space) to aid both performance
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) and scalability.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) Refer to the documentation at https://xfs.wiki.kernel.org/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) for further details. This implementation is on-disk compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) with the IRIX version of XFS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) Mount Options
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) =============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) When mounting an XFS filesystem, the following options are accepted.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) allocsize=size
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) Sets the buffered I/O end-of-file preallocation size when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) doing delayed allocation writeout (default size is 64KiB).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) Valid values for this option are page size (typically 4KiB)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) through to 1GiB, inclusive, in power-of-2 increments.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) The default behaviour is for dynamic end-of-file
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) preallocation size, which uses a set of heuristics to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) optimise the preallocation size based on the current
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) allocation patterns within the file and the access patterns
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) to the file. Specifying a fixed ``allocsize`` value turns off
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) the dynamic behaviour.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) attr2 or noattr2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) The options enable/disable an "opportunistic" improvement to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) be made in the way inline extended attributes are stored
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) on-disk. When the new form is used for the first time when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) ``attr2`` is selected (either when setting or removing extended
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) attributes) the on-disk superblock feature bit field will be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) updated to reflect this format being in use.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) The default behaviour is determined by the on-disk feature
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) bit indicating that ``attr2`` behaviour is active. If either
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) mount option is set, then that becomes the new default used
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) by the filesystem.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) CRC enabled filesystems always use the ``attr2`` format, and so
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) will reject the ``noattr2`` mount option if it is set.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) discard or nodiscard (default)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) Enable/disable the issuing of commands to let the block
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) device reclaim space freed by the filesystem. This is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) useful for SSD devices, thinly provisioned LUNs and virtual
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) machine images, but may have a performance impact.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) Note: It is currently recommended that you use the ``fstrim``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) application to ``discard`` unused blocks rather than the ``discard``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) mount option because the performance impact of this option
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) is quite severe.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) grpid/bsdgroups or nogrpid/sysvgroups (default)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) These options define what group ID a newly created file
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) gets. When ``grpid`` is set, it takes the group ID of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) directory in which it is created; otherwise it takes the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) ``fsgid`` of the current process, unless the directory has the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) ``setgid`` bit set, in which case it takes the ``gid`` from the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) parent directory, and also gets the ``setgid`` bit set if it is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) a directory itself.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) filestreams
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) Make the data allocator use the filestreams allocation mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) across the entire filesystem rather than just on directories
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) configured to use it.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) ikeep or noikeep (default)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) When ``ikeep`` is specified, XFS does not delete empty inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) clusters and keeps them around on disk. When ``noikeep`` is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) specified, empty inode clusters are returned to the free
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) space pool.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) inode32 or inode64 (default)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) When ``inode32`` is specified, it indicates that XFS limits
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) inode creation to locations which will not result in inode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) numbers with more than 32 bits of significance.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) When ``inode64`` is specified, it indicates that XFS is allowed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) to create inodes at any location in the filesystem,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) including those which will result in inode numbers occupying
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) more than 32 bits of significance.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) ``inode32`` is provided for backwards compatibility with older
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) systems and applications, since 64 bits inode numbers might
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) cause problems for some applications that cannot handle
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) large inode numbers. If applications are in use which do
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) not handle inode numbers bigger than 32 bits, the ``inode32``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) option should be specified.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) largeio or nolargeio (default)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) If ``nolargeio`` is specified, the optimal I/O reported in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) ``st_blksize`` by **stat(2)** will be as small as possible to allow
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) user applications to avoid inefficient read/modify/write
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) I/O. This is typically the page size of the machine, as
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) this is the granularity of the page cache.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) If ``largeio`` is specified, a filesystem that was created with a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) ``swidth`` specified will return the ``swidth`` value (in bytes)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) in ``st_blksize``. If the filesystem does not have a ``swidth``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) specified but does specify an ``allocsize`` then ``allocsize``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) (in bytes) will be returned instead. Otherwise the behaviour
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) is the same as if ``nolargeio`` was specified.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) logbufs=value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) Set the number of in-memory log buffers. Valid numbers
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) range from 2-8 inclusive.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) The default value is 8 buffers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) If the memory cost of 8 log buffers is too high on small
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) systems, then it may be reduced at some cost to performance
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) on metadata intensive workloads. The ``logbsize`` option below
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) controls the size of each buffer and so is also relevant to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) this case.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) logbsize=value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) Set the size of each in-memory log buffer. The size may be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) specified in bytes, or in kilobytes with a "k" suffix.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) Valid sizes for version 1 and version 2 logs are 16384 (16k)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) and 32768 (32k). Valid sizes for version 2 logs also
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) include 65536 (64k), 131072 (128k) and 262144 (256k). The
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) logbsize must be an integer multiple of the log
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) stripe unit configured at **mkfs(8)** time.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) The default value for version 1 logs is 32768, while the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) default value for version 2 logs is MAX(32768, log_sunit).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) logdev=device and rtdev=device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) Use an external log (metadata journal) and/or real-time device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) An XFS filesystem has up to three parts: a data section, a log
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) section, and a real-time section. The real-time section is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) optional, and the log section can be separate from the data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) section or contained within it.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) noalign
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) Data allocations will not be aligned at stripe unit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) boundaries. This is only relevant to filesystems created
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) with non-zero data alignment parameters (``sunit``, ``swidth``) by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) **mkfs(8)**.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) norecovery
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) The filesystem will be mounted without running log recovery.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) If the filesystem was not cleanly unmounted, it is likely to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) be inconsistent when mounted in ``norecovery`` mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) Some files or directories may not be accessible because of this.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) Filesystems mounted ``norecovery`` must be mounted read-only or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) the mount will fail.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) nouuid
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) Don't check for double mounted file systems using the file
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) system ``uuid``. This is useful to mount LVM snapshot volumes,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) and often used in combination with ``norecovery`` for mounting
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) read-only snapshots.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) noquota
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) Forcibly turns off all quota accounting and enforcement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) within the filesystem.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) uquota/usrquota/uqnoenforce/quota
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) User disk quota accounting enabled, and limits (optionally)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) enforced. Refer to **xfs_quota(8)** for further details.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) gquota/grpquota/gqnoenforce
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) Group disk quota accounting enabled and limits (optionally)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) enforced. Refer to **xfs_quota(8)** for further details.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) pquota/prjquota/pqnoenforce
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) Project disk quota accounting enabled and limits (optionally)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) enforced. Refer to **xfs_quota(8)** for further details.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) sunit=value and swidth=value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) Used to specify the stripe unit and width for a RAID device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) or a stripe volume. "value" must be specified in 512-byte
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) block units. These options are only relevant to filesystems
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) that were created with non-zero data alignment parameters.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) The ``sunit`` and ``swidth`` parameters specified must be compatible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) with the existing filesystem alignment characteristics. In
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) general, that means the only valid changes to ``sunit`` are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) increasing it by a power-of-2 multiple. Valid ``swidth`` values
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) are any integer multiple of a valid ``sunit`` value.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) Typically the only time these mount options are necessary if
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) after an underlying RAID device has had it's geometry
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) modified, such as adding a new disk to a RAID5 lun and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) reshaping it.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) swalloc
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) Data allocations will be rounded up to stripe width boundaries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) when the current end of file is being extended and the file
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) size is larger than the stripe width size.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) wsync
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) When specified, all filesystem namespace operations are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) executed synchronously. This ensures that when the namespace
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) operation (create, unlink, etc) completes, the change to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) namespace is on stable storage. This is useful in HA setups
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) where failover must not result in clients seeing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) inconsistent namespace presentation during or after a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) failover event.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) Deprecation of V4 Format
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) ========================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) The V4 filesystem format lacks certain features that are supported by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) the V5 format, such as metadata checksumming, strengthened metadata
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) verification, and the ability to store timestamps past the year 2038.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) Because of this, the V4 format is deprecated. All users should upgrade
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) by backing up their files, reformatting, and restoring from the backup.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) Administrators and users can detect a V4 filesystem by running xfs_info
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) against a filesystem mountpoint and checking for a string containing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) "crc=". If no such string is found, please upgrade xfsprogs to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) latest version and try again.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) The deprecation will take place in two parts. Support for mounting V4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) filesystems can now be disabled at kernel build time via Kconfig option.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) The option will default to yes until September 2025, at which time it
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) will be changed to default to no. In September 2030, support will be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) removed from the codebase entirely.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) Note: Distributors may choose to withdraw V4 format support earlier than
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) the dates listed above.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) Deprecated Mount Options
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) ========================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) =========================== ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) Name Removal Schedule
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) =========================== ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) Mounting with V4 filesystem September 2030
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) ikeep/noikeep September 2025
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) attr2/noattr2 September 2025
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) =========================== ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) Removed Mount Options
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) =====================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251) =========================== =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) Name Removed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) =========================== =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) delaylog/nodelaylog v4.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) ihashsize v4.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) irixsgid v4.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) osyncisdsync/osyncisosync v4.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) barrier v4.19
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259) nobarrier v4.19
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) =========================== =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) sysctls
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) The following sysctls are available for the XFS filesystem:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) fs.xfs.stats_clear (Min: 0 Default: 0 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) Setting this to "1" clears accumulated XFS statistics
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) in /proc/fs/xfs/stat. It then immediately resets to "0".
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) fs.xfs.xfssyncd_centisecs (Min: 100 Default: 3000 Max: 720000)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) The interval at which the filesystem flushes metadata
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) out to disk and runs internal cache cleanup routines.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) fs.xfs.filestream_centisecs (Min: 1 Default: 3000 Max: 360000)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) The interval at which the filesystem ages filestreams cache
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) references and returns timed-out AGs back to the free stream
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) pool.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) fs.xfs.speculative_prealloc_lifetime
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) (Units: seconds Min: 1 Default: 300 Max: 86400)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) The interval at which the background scanning for inodes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) with unused speculative preallocation runs. The scan
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) removes unused preallocation from clean inodes and releases
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) the unused space back to the free pool.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) fs.xfs.error_level (Min: 0 Default: 3 Max: 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) A volume knob for error reporting when internal errors occur.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) This will generate detailed messages & backtraces for filesystem
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) shutdowns, for example. Current threshold values are:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) XFS_ERRLEVEL_OFF: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) XFS_ERRLEVEL_LOW: 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) XFS_ERRLEVEL_HIGH: 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) fs.xfs.panic_mask (Min: 0 Default: 0 Max: 256)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) Causes certain error conditions to call BUG(). Value is a bitmask;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) OR together the tags which represent errors which should cause panics:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) XFS_NO_PTAG 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) XFS_PTAG_IFLUSH 0x00000001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) XFS_PTAG_LOGRES 0x00000002
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) XFS_PTAG_AILDELETE 0x00000004
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304) XFS_PTAG_ERROR_REPORT 0x00000008
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) XFS_PTAG_SHUTDOWN_CORRUPT 0x00000010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) XFS_PTAG_SHUTDOWN_IOERROR 0x00000020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) XFS_PTAG_SHUTDOWN_LOGERROR 0x00000040
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) XFS_PTAG_FSBLOCK_ZERO 0x00000080
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) XFS_PTAG_VERIFIER_ERROR 0x00000100
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) This option is intended for debugging only.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313) fs.xfs.irix_symlink_mode (Min: 0 Default: 0 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) Controls whether symlinks are created with mode 0777 (default)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) or whether their mode is affected by the umask (irix mode).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) fs.xfs.irix_sgid_inherit (Min: 0 Default: 0 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) Controls files created in SGID directories.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319) If the group ID of the new file does not match the effective group
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) ID or one of the supplementary group IDs of the parent dir, the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) ISGID bit is cleared if the irix_sgid_inherit compatibility sysctl
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) is set.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) fs.xfs.inherit_sync (Min: 0 Default: 1 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) Setting this to "1" will cause the "sync" flag set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) by the **xfs_io(8)** chattr command on a directory to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) inherited by files in that directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) fs.xfs.inherit_nodump (Min: 0 Default: 1 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) Setting this to "1" will cause the "nodump" flag set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331) by the **xfs_io(8)** chattr command on a directory to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) inherited by files in that directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) fs.xfs.inherit_noatime (Min: 0 Default: 1 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) Setting this to "1" will cause the "noatime" flag set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) by the **xfs_io(8)** chattr command on a directory to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) inherited by files in that directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339) fs.xfs.inherit_nosymlinks (Min: 0 Default: 1 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) Setting this to "1" will cause the "nosymlinks" flag set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) by the **xfs_io(8)** chattr command on a directory to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) inherited by files in that directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) fs.xfs.inherit_nodefrag (Min: 0 Default: 1 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) Setting this to "1" will cause the "nodefrag" flag set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346) by the **xfs_io(8)** chattr command on a directory to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) inherited by files in that directory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349) fs.xfs.rotorstep (Min: 1 Default: 1 Max: 256)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) In "inode32" allocation mode, this option determines how many
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) files the allocator attempts to allocate in the same allocation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) group before moving to the next allocation group. The intent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) is to control the rate at which the allocator moves between
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354) allocation groups when allocating extents for new files.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) Deprecated Sysctls
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) ==================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) =========================== ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360) Name Removal Schedule
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) =========================== ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) fs.xfs.irix_sgid_inherit September 2025
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363) fs.xfs.irix_symlink_mode September 2025
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) =========================== ================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) Removed Sysctls
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) ===============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) ============================= =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371) Name Removed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) ============================= =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) fs.xfs.xfsbufd_centisec v4.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) fs.xfs.age_buffer_centisecs v4.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) ============================= =======
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377) Error handling
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378) ==============
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) XFS can act differently according to the type of error found during its
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381) operation. The implementation introduces the following concepts to the error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382) handler:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) -failure speed:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) Defines how fast XFS should propagate an error upwards when a specific
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) error is found during the filesystem operation. It can propagate
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) immediately, after a defined number of retries, after a set time period,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) or simply retry forever.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) -error classes:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391) Specifies the subsystem the error configuration will apply to, such as
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) metadata IO or memory allocation. Different subsystems will have
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) different error handlers for which behaviour can be configured.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395) -error handlers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396) Defines the behavior for a specific error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) The filesystem behavior during an error can be set via ``sysfs`` files. Each
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) error handler works independently - the first condition met by an error handler
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400) for a specific class will cause the error to be propagated rather than reset and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401) retried.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 402)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 403) The action taken by the filesystem when the error is propagated is context
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 404) dependent - it may cause a shut down in the case of an unrecoverable error,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 405) it may be reported back to userspace, or it may even be ignored because
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 406) there's nothing useful we can with the error or anyone we can report it to (e.g.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 407) during unmount).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 408)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 409) The configuration files are organized into the following hierarchy for each
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 410) mounted filesystem:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 411)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 412) /sys/fs/xfs/<dev>/error/<class>/<error>/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 413)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 414) Where:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 415) <dev>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 416) The short device name of the mounted filesystem. This is the same device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 417) name that shows up in XFS kernel error messages as "XFS(<dev>): ..."
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 418)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 419) <class>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 420) The subsystem the error configuration belongs to. As of 4.9, the defined
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 421) classes are:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 422)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 423) - "metadata": applies metadata buffer write IO
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 424)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 425) <error>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 426) The individual error handler configurations.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 427)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 428)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 429) Each filesystem has "global" error configuration options defined in their top
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 430) level directory:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 431)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 432) /sys/fs/xfs/<dev>/error/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 433)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 434) fail_at_unmount (Min: 0 Default: 1 Max: 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 435) Defines the filesystem error behavior at unmount time.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 436)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 437) If set to a value of 1, XFS will override all other error configurations
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 438) during unmount and replace them with "immediate fail" characteristics.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 439) i.e. no retries, no retry timeout. This will always allow unmount to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 440) succeed when there are persistent errors present.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 441)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 442) If set to 0, the configured retry behaviour will continue until all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 443) retries and/or timeouts have been exhausted. This will delay unmount
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 444) completion when there are persistent errors, and it may prevent the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 445) filesystem from ever unmounting fully in the case of "retry forever"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 446) handler configurations.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 447)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 448) Note: there is no guarantee that fail_at_unmount can be set while an
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 449) unmount is in progress. It is possible that the ``sysfs`` entries are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 450) removed by the unmounting filesystem before a "retry forever" error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 451) handler configuration causes unmount to hang, and hence the filesystem
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 452) must be configured appropriately before unmount begins to prevent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 453) unmount hangs.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 454)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 455) Each filesystem has specific error class handlers that define the error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 456) propagation behaviour for specific errors. There is also a "default" error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 457) handler defined, which defines the behaviour for all errors that don't have
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 458) specific handlers defined. Where multiple retry constraints are configured for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 459) a single error, the first retry configuration that expires will cause the error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 460) to be propagated. The handler configurations are found in the directory:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 461)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 462) /sys/fs/xfs/<dev>/error/<class>/<error>/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 463)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 464) max_retries (Min: -1 Default: Varies Max: INTMAX)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 465) Defines the allowed number of retries of a specific error before
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 466) the filesystem will propagate the error. The retry count for a given
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 467) error context (e.g. a specific metadata buffer) is reset every time
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 468) there is a successful completion of the operation.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 469)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 470) Setting the value to "-1" will cause XFS to retry forever for this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 471) specific error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 472)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 473) Setting the value to "0" will cause XFS to fail immediately when the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 474) specific error is reported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 475)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 476) Setting the value to "N" (where 0 < N < Max) will make XFS retry the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 477) operation "N" times before propagating the error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 478)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 479) retry_timeout_seconds (Min: -1 Default: Varies Max: 1 day)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 480) Define the amount of time (in seconds) that the filesystem is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 481) allowed to retry its operations when the specific error is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 482) found.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 483)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 484) Setting the value to "-1" will allow XFS to retry forever for this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 485) specific error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 486)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 487) Setting the value to "0" will cause XFS to fail immediately when the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 488) specific error is reported.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 489)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 490) Setting the value to "N" (where 0 < N < Max) will allow XFS to retry the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 491) operation for up to "N" seconds before propagating the error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 492)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 493) **Note:** The default behaviour for a specific error handler is dependent on both
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 494) the class and error context. For example, the default values for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 495) "metadata/ENODEV" are "0" rather than "-1" so that this error handler defaults
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 496) to "fail immediately" behaviour. This is done because ENODEV is a fatal,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 497) unrecoverable error no matter how many times the metadata IO is retried.
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags