xref: /linux/fs/xfs/Kconfig (revision 27c0b5c4f67aeb73edd515200bd1e0c82a3ee892)
1# SPDX-License-Identifier: GPL-2.0-only
2config XFS_FS
3	tristate "XFS filesystem support"
4	depends on BLOCK
5	select EXPORTFS
6	select CRC32
7	select FS_IOMAP
8	help
9	  XFS is a high performance journaling filesystem which originated
10	  on the SGI IRIX platform.  It is completely multi-threaded, can
11	  support large files and large filesystems, extended attributes,
12	  variable block sizes, is extent based, and makes extensive use of
13	  Btrees (directories, extents, free space) to aid both performance
14	  and scalability.
15
16	  Refer to the documentation at <http://oss.sgi.com/projects/xfs/>
17	  for complete details.  This implementation is on-disk compatible
18	  with the IRIX version of XFS.
19
20	  To compile this file system support as a module, choose M here: the
21	  module will be called xfs.  Be aware, however, that if the file
22	  system of your root partition is compiled as a module, you'll need
23	  to use an initial ramdisk (initrd) to boot.
24
25config XFS_SUPPORT_V4
26	bool "Support deprecated V4 (crc=0) format"
27	depends on XFS_FS
28	default n
29	help
30	  The V4 filesystem format lacks certain features that are supported
31	  by the V5 format, such as metadata checksumming, strengthened
32	  metadata verification, and the ability to store timestamps past the
33	  year 2038.  Because of this, the V4 format is deprecated.  All users
34	  should upgrade by backing up their files, reformatting, and restoring
35	  from the backup.
36
37	  Administrators and users can detect a V4 filesystem by running
38	  xfs_info against a filesystem mountpoint and checking for a string
39	  beginning with "crc=".  If the string "crc=0" is found, the
40	  filesystem is a V4 filesystem.  If no such string is found, please
41	  upgrade xfsprogs to the latest version and try again.
42
43	  This option became default N in September 2025.  Support for the
44	  V4 format will be removed entirely in September 2030.  Distributors
45	  can say N here to withdraw support earlier.
46
47	  To continue supporting the old V4 format (crc=0), say Y.
48	  To close off an attack surface, say N.
49
50config XFS_SUPPORT_ASCII_CI
51	bool "Support deprecated case-insensitive ascii (ascii-ci=1) format"
52	depends on XFS_FS
53	default n
54	help
55	  The ASCII case insensitivity filesystem feature only works correctly
56	  on systems that have been coerced into using ISO 8859-1, and it does
57	  not work on extended attributes.  The kernel has no visibility into
58	  the locale settings in userspace, so it corrupts UTF-8 names.
59	  Enabling this feature makes XFS vulnerable to mixed case sensitivity
60	  attacks.  Because of this, the feature is deprecated.  All users
61	  should upgrade by backing up their files, reformatting, and restoring
62	  from the backup.
63
64	  Administrators and users can detect such a filesystem by running
65	  xfs_info against a filesystem mountpoint and checking for a string
66	  beginning with "ascii-ci=".  If the string "ascii-ci=1" is found, the
67	  filesystem is a case-insensitive filesystem.  If no such string is
68	  found, please upgrade xfsprogs to the latest version and try again.
69
70	  This option became default N in September 2025.  Support for the
71	  feature will be removed entirely in September 2030.  Distributors
72	  can say N here to withdraw support earlier.
73
74	  To continue supporting case-insensitivity (ascii-ci=1), say Y.
75	  To close off an attack surface, say N.
76
77config XFS_QUOTA
78	bool "XFS Quota support"
79	depends on XFS_FS
80	select QUOTACTL
81	help
82	  If you say Y here, you will be able to set limits for disk usage on
83	  a per user and/or a per group basis under XFS.  XFS considers quota
84	  information as filesystem metadata and uses journaling to provide a
85	  higher level guarantee of consistency.  The on-disk data format for
86	  quota is also compatible with the IRIX version of XFS, allowing a
87	  filesystem to be migrated between Linux and IRIX without any need
88	  for conversion.
89
90	  If unsure, say N.  More comprehensive documentation can be found in
91	  README.quota in the xfsprogs package.  XFS quota can be used either
92	  with or without the generic quota support enabled (CONFIG_QUOTA) -
93	  they are completely independent subsystems.
94
95config XFS_POSIX_ACL
96	bool "XFS POSIX ACL support"
97	depends on XFS_FS
98	select FS_POSIX_ACL
99	help
100	  POSIX Access Control Lists (ACLs) support permissions for users and
101	  groups beyond the owner/group/world scheme.
102
103	  If you don't know what Access Control Lists are, say N.
104
105config XFS_RT
106	bool "XFS Realtime subvolume support"
107	depends on XFS_FS
108	default BLK_DEV_ZONED
109	help
110	  If you say Y here you will be able to mount and use XFS filesystems
111	  which contain a realtime subvolume.  The realtime subvolume is a
112	  separate area of disk space where only file data is stored.  It was
113	  originally designed to provide deterministic data rates suitable
114	  for media streaming applications, but is also useful as a generic
115	  mechanism for ensuring data and metadata/log I/Os are completely
116	  separated.  Regular file I/Os are isolated to a separate device
117	  from all other requests, and this can be done quite transparently
118	  to applications via the inherit-realtime directory inode flag.
119
120	  See the xfs man page in section 5 for additional information.
121
122	  This option is mandatory to support zoned block devices. For these
123	  devices, the realtime subvolume must be backed by a zoned block
124	  device and a regular block device used as the main device (for
125	  metadata). If the zoned block device is a host-managed SMR hard-disk
126	  containing conventional zones at the beginning of its address space,
127	  XFS will use the disk conventional zones as the main device and the
128	  remaining sequential write required zones as the backing storage for
129	  the realtime subvolume.
130
131	  If unsure, say N.
132
133config XFS_DRAIN_INTENTS
134	bool
135	select JUMP_LABEL if HAVE_ARCH_JUMP_LABEL
136
137config XFS_LIVE_HOOKS
138	bool
139	select JUMP_LABEL if HAVE_ARCH_JUMP_LABEL
140
141config XFS_MEMORY_BUFS
142	bool
143
144config XFS_BTREE_IN_MEM
145	bool
146
147config XFS_ONLINE_SCRUB
148	bool "XFS online metadata check support"
149	default y
150	depends on XFS_FS
151	depends on TMPFS && SHMEM
152	select XFS_LIVE_HOOKS
153	select XFS_DRAIN_INTENTS
154	select XFS_MEMORY_BUFS
155	help
156	  If you say Y here you will be able to check metadata on a
157	  mounted XFS filesystem.  This feature is intended to reduce
158	  filesystem downtime by supplementing xfs_repair.  The key
159	  advantage here is to look for problems proactively so that
160	  they can be dealt with in a controlled manner.
161
162	  See the xfs_scrub man page in section 8 for additional information.
163
164config XFS_ONLINE_SCRUB_STATS
165	bool "XFS online metadata check usage data collection"
166	default y
167	depends on XFS_ONLINE_SCRUB
168	depends on DEBUG_FS
169	help
170	  If you say Y here, the kernel will gather usage data about
171	  the online metadata check subsystem.  This includes the number
172	  of invocations, the outcomes, and the results of repairs, if any.
173	  This may slow down scrub slightly due to the use of high precision
174	  timers and the need to merge per-invocation information into the
175	  filesystem counters.
176
177	  Usage data are collected in /sys/kernel/debug/xfs/scrub.
178
179config XFS_ONLINE_REPAIR
180	bool "XFS online metadata repair support"
181	default y
182	depends on XFS_FS && XFS_ONLINE_SCRUB
183	select XFS_BTREE_IN_MEM
184	help
185	  If you say Y here you will be able to repair metadata on a
186	  mounted XFS filesystem.  This feature is intended to reduce
187	  filesystem downtime by fixing minor problems before they cause the
188	  filesystem to go down.  However, it requires that the filesystem be
189	  formatted with secondary metadata, such as reverse mappings and inode
190	  parent pointers.
191
192	  See the xfs_scrub man page in section 8 for additional information.
193
194config XFS_WARN
195	bool "XFS Verbose Warnings"
196	depends on XFS_FS && !XFS_DEBUG
197	help
198	  Say Y here to get an XFS build with many additional warnings.
199	  It converts ASSERT checks to WARN, so will log any out-of-bounds
200	  conditions that occur that would otherwise be missed. It is much
201	  lighter weight than XFS_DEBUG and does not modify algorithms and will
202	  not cause the kernel to panic on non-fatal errors.
203
204	  However, similar to XFS_DEBUG, it is only advisable to use this if you
205	  are debugging a particular problem.
206
207config XFS_DEBUG
208	bool "XFS Debugging support"
209	depends on XFS_FS
210	help
211	  Say Y here to get an XFS build with many debugging features,
212	  including ASSERT checks, function wrappers around macros,
213	  and extra sanity-checking functions in various code paths.
214
215	  Note that the resulting code will be HUGE and SLOW, and probably
216	  not useful unless you are debugging a particular problem.
217
218	  Say N unless you are an XFS developer, or you play one on TV.
219
220config XFS_DEBUG_EXPENSIVE
221	bool "XFS expensive debugging checks"
222	depends on XFS_FS && XFS_DEBUG
223	help
224	  Say Y here to get an XFS build with expensive debugging checks
225	  enabled.  These checks may affect performance significantly.
226
227	  Note that the resulting code will be HUGER and SLOWER, and probably
228	  not useful unless you are debugging a particular problem.
229
230	  Say N unless you are an XFS developer, or you play one on TV.
231
232config XFS_ASSERT_FATAL
233	bool "XFS fatal asserts"
234	default y
235	depends on XFS_FS && XFS_DEBUG
236	help
237	  Set the default DEBUG mode ASSERT failure behavior.
238
239	  Say Y here to cause DEBUG mode ASSERT failures to result in fatal
240	  errors that BUG() the kernel by default. If you say N, ASSERT failures
241	  result in warnings.
242
243	  This behavior can be modified at runtime via sysfs.
244