]> git.ipfire.org Git - thirdparty/e2fsprogs.git/blame - misc/ext4.5.in
ext4.5.in: document design changes on the casefold attribute
[thirdparty/e2fsprogs.git] / misc / ext4.5.in
CommitLineData
3c22bf7e
TT
1.\" -*- nroff -*-
2.\" Copyright 1993, 1994, 1995 by Theodore Ts'o. All Rights Reserved.
3.\" This file may be copied under the terms of the GNU Public License.
4.\"
5.TH EXT4 5 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
6.SH NAME
7ext2 \- the second extended file system
8.br
b9ba837d 9ext3 \- the third extended file system
3c22bf7e
TT
10.br
11ext4 \- the fourth extended file system
12.SH DESCRIPTION
13The second, third, and fourth extended file systems, or ext2, ext3, and
14ext4 as they are commonly known, are Linux file systems that have
15historically been the default file system for many Linux distributions.
16They are general purpose file systems that have been designed for
17extensibility and backwards compatibility. In particular, file systems
18previously intended for use with the ext2 and ext3 file systems can be
19mounted using the ext4 file system driver, and indeed in many modern
20Linux distributions, the ext4 file system driver has been configured
f8a801d0 21to handle mount requests for ext2 and ext3 file systems.
3c22bf7e 22.SH FILE SYSTEM FEATURES
f8a801d0
PH
23A file system formatted for ext2, ext3, or ext4 can have some
24collection of the following file system feature flags enabled. Some of
3c22bf7e
TT
25these features are not supported by all implementations of the ext2,
26ext3, and ext4 file system drivers, depending on Linux kernel version in
27use. On other operating systems, such as the GNU/HURD or FreeBSD, only
28a very restrictive set of file system features may be supported in their
29implementations of ext2.
3c22bf7e
TT
30.TP
31.B 64bit
32.br
33Enables the file system to be larger than 2^32 blocks. This feature is set
34automatically, as needed, but it can be useful to specify this feature
35explicitly if the file system might need to be resized larger than 2^32
36blocks, even if it was smaller than that threshold when it was
37originally created. Note that some older kernels and older versions
38of e2fsprogs will not support file systems with this ext4 feature enabled.
39.TP
40.B bigalloc
41.br
42This ext4 feature enables clustered block allocation, so that the unit of
43allocation is a power of two number of blocks. That is, each bit in the
44what had traditionally been known as the block allocation bitmap now
45indicates whether a cluster is in use or not, where a cluster is by
46default composed of 16 blocks. This feature can decrease the time
47spent on doing block allocation and brings smaller fragmentation, especially
48for large files. The size can be specified using the
f8a801d0
PH
49.B mke2fs \-C
50option.
3c22bf7e
TT
51.IP
52.B Warning:
53The bigalloc feature is still under development, and may not be fully
54supported with your kernel or may have various bugs. Please see the web
55page http://ext4.wiki.kernel.org/index.php/Bigalloc for details.
56May clash with delayed allocation (see
f8a801d0
PH
57.B nodelalloc
58mount option).
3c22bf7e
TT
59.IP
60This feature requires that the
61.B extent
f8a801d0 62feature be enabled.
3c22bf7e
TT
63.TP
64.B dir_index
65.br
66Use hashed b-trees to speed up name lookups in large directories. This
67feature is supported by ext3 and ext4 file systems, and is ignored by
68ext2 file systems.
69.TP
70.B dir_nlink
71.br
d7f373b4
TT
72Normally, ext4 allows an inode to have no more than 65,000 hard links.
73This applies to regular files as well as directories, which means that
74there can be no more than 64,998 subdirectories in a directory (because
75each of the '.' and '..' entries, as well as the directory entry for the
76directory in its parent directory counts as a hard link). This feature
77lifts this limit by causing ext4 to use a link count of 1 to indicate
78that the number of hard links to a directory is not known when the link
79count might exceed the maximum count limit.
3c22bf7e 80.TP
4c11e655
TN
81.B ea_inode
82.br
83Normally, a file's extended attributes and associated metadata must fit within
84the inode or the inode's associated extended attribute block. This feature
85allows the value of each extended attribute to be placed in the data blocks of a
86separate inode if necessary, increasing the limit on the size and number of
87extended attributes per file.
88.TP
50a6f4a2
TT
89.B encrypt
90.br
91This ext4 feature provides file-system level encryption of data blocks
92and file names. The inode metadata (timestamps, file size, user/group
93ownership, etc.) is
94.I not
95encrypted.
96.IP
97This feature is most useful on file systems with multiple users, or
98where not all files should be encrypted. In many use cases, especially
99on single-user systems, encryption at the block device layer using
100dm-crypt may provide much better security.
101.TP
f8a801d0
PH
102.B ext_attr
103.br
104This feature enables the use of extended attributes. This feature is
105supported by ext2, ext3, and ext4.
106.TP
3c22bf7e
TT
107.B extent
108.br
109This ext4 feature allows the mapping of logical block numbers for a
110particular inode to physical blocks on the storage device to be stored
111using an extent tree, which is a more efficient data structure than the
112traditional indirect block scheme used by the ext2 and ext3 file
113systems. The use of the extent tree decreases metadata block overhead,
114improves file system performance, and decreases the needed to run
115.BR e2fsck (8)
116on the file system.
117(Note: both
118.B extent
119and
120.B extents
121are accepted as valid names for this feature for
122historical/backwards compatibility reasons.)
123.TP
124.B extra_isize
125.br
126This ext4 feature reserves a specific amount of space in each inode for
127extended metadata such as nanosecond timestamps and file creation time,
f8a801d0 128even if the current kernel does not currently need to reserve this much
3c22bf7e 129space. Without this feature, the kernel will reserve the amount of
f8a801d0 130space for features it currently needs, and the rest may be
3c22bf7e
TT
131consumed by extended attributes.
132
133For this feature to be useful the inode size must be 256 bytes in size
134or larger.
135.TP
3c22bf7e
TT
136.B filetype
137.br
f8a801d0 138This feature enables the storage of file type information in directory
3c22bf7e
TT
139entries. This feature is supported by ext2, ext3, and ext4.
140.TP
3c22bf7e
TT
141.B flex_bg
142.br
143This ext4 feature allows the per-block group metadata (allocation
144bitmaps
145and inode tables)
146to be placed anywhere on the storage media. In addition,
147.B mke2fs
148will place the per-block group metadata together starting at the first
149block group of each "flex_bg group". The size of the flex_bg group
150can be specified using the
151.B \-G
152option.
153.TP
8ea62554
GKB
154.B fname_encoding
155.br
156This ext4 feature provides file system level character encoding support
1384050b
GKB
157for directories with the casefold (+F) flag enabled. This feature is
158name-preserving on the disk, but it allows applications to lookup for a
159file in the file system using an encoding equivalent version of the file
160name.
8ea62554 161.TP
3c22bf7e
TT
162.B has_journal
163.br
164Create a journal to ensure filesystem consistency even across unclean
165shutdowns. Setting the filesystem feature is equivalent to using the
166.B \-j
f8a801d0
PH
167option with
168.BR mke2fs " or " tune2fs.
169This feature is supported by ext3 and ext4, and ignored by the
3c22bf7e
TT
170ext2 file system driver.
171.TP
172.B huge_file
173.br
174This ext4 feature allows files to be larger than 2 terabytes in size.
175.TP
f8a801d0
PH
176.B inline_data
177Allow data to be stored in the inode and extended attribute area.
178.TP
3c22bf7e
TT
179.B journal_dev
180.br
181This feature is enabled on the superblock found on an external journal
182device. The block size for the external journal must be the same as the
183file system which uses it.
184.IP
185The external journal device can be used by a file system by specifying
186the
187.B \-J
188.BR device= <external-device>
189option to
190.BR mke2fs (8)
191or
6a9c8e0b 192.BR tune2fs(8) .
3c22bf7e 193.TP
4c11e655
TN
194.B large_dir
195.br
196This feature increases the limit on the number of files per directory by
197raising the maximum size of directories and, for hashed b-tree directories (see
198.BR dir_index ),
199the maximum height of the hashed b-tree used to store the directory entries.
200.TP
3c22bf7e
TT
201.B large_file
202.br
203This feature flag is set automatically by modern kernels when a file
204larger than 2 gigabytes is created. Very old kernels could not
205handle large files, so this feature flag was used to prohibit those
206kernels from mounting file systems that they could not understand.
53a7a826
TN
207.TP
208.B metadata_csum
209.br
210This ext4 feature enables metadata checksumming. This feature stores
211checksums for all of the filesystem metadata (superblock, group
212descriptor blocks, inode and block bitmaps, directories, and
213extent tree blocks). The checksum algorithm used for the metadata
214blocks is different than the one used for group descriptors with the
215.B uninit_bg
216feature. These two features are incompatible and
217.B metadata_csum
218will be used preferentially instead of
219.BR uninit_bg .
220.TP
221.B metadata_csum_seed
222.br
223This feature allows the filesystem to store the metadata checksum seed in the
224superblock, which allows the administrator to change the UUID of a filesystem
225using the
226.B metadata_csum
227feature while it is mounted.
3c22bf7e
TT
228.TP
229.B meta_bg
230.br
231This ext4 feature allows file systems to be resized on-line without explicitly
232needing to reserve space for growth in the size of the block group
233descriptors. This scheme is also used to resize file systems which are
234larger than 2^32 blocks. It is not recommended that this feature be set
235when a file system is created, since this alternate method of storing
f8a801d0 236the block group descriptors will slow down the time needed to mount the
3c22bf7e
TT
237file system, and newer kernels can automatically set this feature as
238necessary when doing an online resize and no more reserved space is
239available in the resize inode.
240.TP
241.B mmp
242.br
243This ext4 feature provides multiple mount protection (MMP). MMP helps to
244protect the filesystem from being multiply mounted and is useful in
245shared storage environments.
3c22bf7e 246.TP
0c18d036
LX
247.B project
248.br
249This ext4 feature provides project quota support. With this feature,
250the project ID of inode will be managed when the filesystem is mounted.
251.TP
f8a801d0
PH
252.B quota
253.br
254Create quota inodes (inode #3 for userquota and inode
255#4 for group quota) and set them in the superblock.
256With this feature, the quotas will be enabled
257automatically when the filesystem is mounted.
53a7a826
TN
258.IP
259Causes the quota files (i.e., user.quota and
260group.quota which existed
261in the older quota design) to be hidden inodes.
f8a801d0 262.TP
3c22bf7e
TT
263.B resize_inode
264.br
f8a801d0
PH
265This file system feature indicates that space has been reserved so that
266the block group descriptor table can be extended while resizing a mounted
267file system. The online resize operation
268is carried out by the kernel, triggered by
3c22bf7e
TT
269.BR resize2fs (8).
270By default
271.B mke2fs
272will attempt to reserve enough space so that the
273filesystem may grow to 1024 times its initial size. This can be changed
274using the
275.B resize
276extended option.
277.IP
278This feature requires that the
279.B sparse_super
53a7a826
TN
280or
281.B sparse_super2
3c22bf7e
TT
282feature be enabled.
283.TP
284.B sparse_super
285.br
286This file system feature is set on all modern ext2, ext3, and ext4 file
f8a801d0
PH
287systems. It indicates that backup copies of the superblock and block
288group descriptors are present only in a few block groups, not all of
3c22bf7e
TT
289them.
290.TP
f8a801d0
PH
291.B sparse_super2
292.br
293This feature indicates that there will only be at most two backup
294superblocks and block group descriptors. The block groups used to store
295the backup superblock(s) and blockgroup descriptor(s) are stored in the
296superblock, but typically, one will be located at the beginning of block
297group #1, and one in the last block group in the file system. This
298feature is essentially a more extreme version of sparse_super and is
299designed to allow a much larger percentage of the disk to have
300contiguous blocks available for data files.
301.TP
3c22bf7e
TT
302.B uninit_bg
303.br
304This ext4 file system feature indicates that the block group descriptors
305will be protected using checksums, making it safe for
306.BR mke2fs (8)
307to create a file system without initializing all of the block groups.
308The kernel will keep a high watermark of unused inodes, and initialize
f8a801d0 309inode tables and blocks lazily. This feature speeds up the time to check
3c22bf7e
TT
310the file system using
311.BR e2fsck (8),
312and it also speeds up the time required for
313.BR mke2fs (8)
314to create the file system.
3e500a8f
ES
315.SH MOUNT OPTIONS
316This section describes mount options which are specific to ext2, ext3,
317and ext4. Other generic mount options may be used as well; see
318.BR mount (8)
319for details.
320.SH "Mount options for ext2"
321The `ext2' filesystem is the standard Linux filesystem.
322Since Linux 2.5.46, for most mount options the default
323is determined by the filesystem superblock. Set them with
324.BR tune2fs (8).
325.TP
326.BR acl | noacl
78b7cd3b
TT
327Support POSIX Access Control Lists (or not). See the
328.BR acl (5)
329manual page.
3e500a8f
ES
330.TP
331.BR bsddf | minixdf
332Set the behavior for the
333.I statfs
334system call. The
335.B minixdf
336behavior is to return in the
337.I f_blocks
338field the total number of blocks of the filesystem, while the
339.B bsddf
340behavior (which is the default) is to subtract the overhead blocks
341used by the ext2 filesystem and not available for file storage. Thus
342.sp 1
343% mount /k \-o minixdf; df /k; umount /k
344.TS
345tab(#);
346l2 l2 r2 l2 l2 l
347l c r c c l.
348Filesystem#1024-blocks#Used#Available#Capacity#Mounted on
349/dev/sda6#2630655#86954#2412169#3%#/k
350.TE
351.sp 1
352% mount /k \-o bsddf; df /k; umount /k
353.TS
354tab(#);
355l2 l2 r2 l2 l2 l
356l c r c c l.
357Filesystem#1024-blocks#Used#Available#Capacity#Mounted on
358/dev/sda6#2543714#13#2412169#0%#/k
359.TE
360.sp 1
361(Note that this example shows that one can add command line options
362to the options given in
363.IR /etc/fstab .)
364.TP
365.BR check=none " or " nocheck
366No checking is done at mount time. This is the default. This is fast.
367It is wise to invoke
368.BR e2fsck (8)
369every now and then, e.g.\& at boot time. The non-default behavior is unsupported
370(check=normal and check=strict options have been removed). Note that these mount options
371don't have to be supported if ext4 kernel driver is used for ext2 and ext3 filesystems.
372.TP
373.B debug
374Print debugging info upon each (re)mount.
375.TP
376.BR errors= { continue | remount-ro | panic }
377Define the behavior when an error is encountered.
378(Either ignore errors and just mark the filesystem erroneous and continue,
379or remount the filesystem read-only, or panic and halt the system.)
380The default is set in the filesystem superblock, and can be
381changed using
382.BR tune2fs (8).
383.TP
384.BR grpid | bsdgroups " and " nogrpid | sysvgroups
385These options define what group id a newly created file gets.
386When
387.B grpid
388is set, it takes the group id of the directory in which it is created;
389otherwise (the default) it takes the fsgid of the current process, unless
390the directory has the setgid bit set, in which case it takes the gid
391from the parent directory, and also gets the setgid bit set
392if it is a directory itself.
393.TP
394.BR grpquota | noquota | quota | usrquota
395The usrquota (same as quota) mount option enables user quota support on the
396filesystem. grpquota enables group quotas support. You need the quota utilities
397to actually enable and manage the quota system.
398.TP
399.B nouid32
400Disables 32-bit UIDs and GIDs. This is for interoperability with older
401kernels which only store and expect 16-bit values.
402.TP
403.BR oldalloc " or " orlov
404Use old allocator or Orlov allocator for new inodes. Orlov is default.
405.TP
406\fBresgid=\fP\,\fIn\fP and \fBresuid=\fP\,\fIn\fP
407The ext2 filesystem reserves a certain percentage of the available
408space (by default 5%, see
409.BR mke2fs (8)
410and
411.BR tune2fs (8)).
412These options determine who can use the reserved blocks.
413(Roughly: whoever has the specified uid, or belongs to the specified group.)
414.TP
415.BI sb= n
53a7a826
TN
416Instead of using the normal superblock, use an alternative superblock
417specified by
418.IR n .
419This option is normally used when the primary superblock has been
420corrupted. The location of backup superblocks is dependent on the
421filesystem's blocksize, the number of blocks per group, and features
422such as
423.BR sparse_super .
424.IP
425Additional backup superblocks can be determined by using the
3e500a8f 426.B mke2fs
53a7a826
TN
427program using the
428.B \-n
429option to print out where the superblocks exist, supposing
3e500a8f 430.B mke2fs
53a7a826
TN
431is supplied with arguments that are consistent with the filesystem's layout
432(e.g. blocksize, blocks per group,
433.BR sparse_super ,
434etc.).
435.IP
3e500a8f
ES
436The block number here uses 1\ k units. Thus, if you want to use logical
437block 32768 on a filesystem with 4\ k blocks, use "sb=131072".
438.TP
439.BR user_xattr | nouser_xattr
440Support "user." extended attributes (or not).
441
442
443.SH "Mount options for ext3"
444The ext3 filesystem is a version of the ext2 filesystem which has been
445enhanced with journaling. It supports the same options as ext2 as
446well as the following additions:
447.TP
3e500a8f
ES
448.BR journal_dev=devnum / journal_path=path
449When the external journal device's major/minor numbers
450have changed, these options allow the user to specify
451the new journal location. The journal device is
452identified either through its new major/minor numbers encoded
453in devnum, or via a path to the device.
454.TP
455.BR norecovery / noload
456Don't load the journal on mounting. Note that
457if the filesystem was not unmounted cleanly,
458skipping the journal replay will lead to the
459filesystem containing inconsistencies that can
460lead to any number of problems.
461.TP
462.BR data= { journal | ordered | writeback }
463Specifies the journaling mode for file data. Metadata is always journaled.
464To use modes other than
465.B ordered
466on the root filesystem, pass the mode to the kernel as boot parameter, e.g.\&
467.IR rootflags=data=journal .
468.RS
469.TP
470.B journal
471All data is committed into the journal prior to being written into the
472main filesystem.
473.TP
474.B ordered
475This is the default mode. All data is forced directly out to the main file
476system prior to its metadata being committed to the journal.
477.TP
478.B writeback
479Data ordering is not preserved \(en data may be written into the main
480filesystem after its metadata has been committed to the journal.
481This is rumoured to be the highest-throughput option. It guarantees
482internal filesystem integrity, however it can allow old data to appear
483in files after a crash and journal recovery.
484.RE
485.TP
486.B data_err=ignore
487Just print an error message if an error occurs in a file data buffer in
488ordered mode.
489.TP
490.B data_err=abort
491Abort the journal if an error occurs in a file data buffer in ordered mode.
492.TP
493.BR barrier=0 " / " barrier=1 "
494This disables / enables the use of write barriers in the jbd code. barrier=0
495disables, barrier=1 enables (default). This also requires an IO stack which can
496support barriers, and if jbd gets an error on a barrier write, it will disable
497barriers again with a warning. Write barriers enforce proper on-disk ordering
498of journal commits, making volatile disk write caches safe to use, at some
499performance penalty. If your disks are battery-backed in one way or another,
500disabling barriers may safely improve performance.
501.TP
502.BI commit= nrsec
0df8f611 503Start a journal commit every
3e500a8f 504.I nrsec
0df8f611 505seconds. The default value is 5 seconds. Zero means default.
3e500a8f
ES
506.TP
507.B user_xattr
508Enable Extended User Attributes. See the
509.BR attr (5)
510manual page.
511.TP
53a7a826 512.BR jqfmt= { vfsold | vfsv0 | vfsv1 }
3e500a8f 513Apart from the old quota system (as in ext2, jqfmt=vfsold aka version 1 quota)
53a7a826
TN
514ext3 also supports journaled quotas (version 2 quota). jqfmt=vfsv0 or
515jqfmt=vfsv1 enables journaled quotas. Journaled quotas have the advantage that
516even after a crash no quota check is required. When the
517.B quota
518filesystem feature is enabled, journaled quotas are used automatically, and
519this mount option is ignored.
520.TP
521.BR usrjquota=aquota.user | grpjquota=aquota.group
522For journaled quotas (jqfmt=vfsv0 or jqfmt=vfsv1), the mount options
3e500a8f 523usrjquota=aquota.user and grpjquota=aquota.group are required to tell the
53a7a826
TN
524quota system which quota database files to use. When the
525.B quota
526filesystem feature is enabled, journaled quotas are used automatically, and
527this mount option is ignored.
3e500a8f
ES
528
529.SH "Mount options for ext4"
530The ext4 filesystem is an advanced level of the ext3 filesystem which
531incorporates scalability and reliability enhancements for supporting large
532filesystem.
533
534The options
53a7a826
TN
535.B journal_dev, journal_path, norecovery, noload, data, commit, orlov,
536.B oldalloc, [no]user_xattr, [no]acl, bsddf, minixdf, debug, errors,
537.B data_err, grpid, bsdgroups, nogrpid, sysvgroups, resgid, resuid, sb,
538.B quota, noquota, nouid32, grpquota, usrquota, usrjquota, grpjquota,
539.B and jqfmt are backwardly compatible with ext3 or ext2.
3e500a8f 540.TP
53a7a826
TN
541.B journal_checksum | nojournal_checksum
542The journal_checksum option enables checksumming of the journal transactions.
543This will allow the recovery code in e2fsck and the kernel to detect corruption
544in the kernel. It is a compatible change and will be ignored by older kernels.
3e500a8f
ES
545.TP
546.B journal_async_commit
547Commit block can be written to disk without waiting for descriptor blocks. If
548enabled older kernels cannot mount the device.
549This will enable 'journal_checksum' internally.
550.TP
551.BR barrier=0 " / " barrier=1 " / " barrier " / " nobarrier
552These mount options have the same effect as in ext3. The mount options
553"barrier" and "nobarrier" are added for consistency with other ext4 mount
554options.
555
556The ext4 filesystem enables write barriers by default.
557.TP
558.BI inode_readahead_blks= n
559This tuning parameter controls the maximum number of inode table blocks that
560ext4's inode table readahead algorithm will pre-read into the buffer cache.
561The value must be a power of 2. The default value is 32 blocks.
562.TP
563.BI stripe= n
564Number of filesystem blocks that mballoc will try to use for allocation size
565and alignment. For RAID5/6 systems this should be the number of data disks *
566RAID chunk size in filesystem blocks.
567.TP
568.B delalloc
569Deferring block allocation until write-out time.
570.TP
571.B nodelalloc
572Disable delayed allocation. Blocks are allocated when data is copied from user
573to page cache.
574.TP
575.BI max_batch_time= usec
576Maximum amount of time ext4 should wait for additional filesystem operations to
577be batch together with a synchronous write operation. Since a synchronous
578write operation is going to force a commit and then a wait for the I/O
579complete, it doesn't cost much, and can be a huge throughput win, we wait for a
580small amount of time to see if any other transactions can piggyback on the
581synchronous write. The algorithm used is designed to automatically tune for
582the speed of the disk, by measuring the amount of time (on average) that it
583takes to finish committing a transaction. Call this time the "commit time".
584If the time that the transaction has been running is less than the commit time,
585ext4 will try sleeping for the commit time to see if other operations will join
586the transaction. The commit time is capped by the max_batch_time, which
587defaults to 15000\ \[mc]s (15\ ms). This optimization can be turned off entirely by
588setting max_batch_time to 0.
589.TP
590.BI min_batch_time= usec
591This parameter sets the commit time (as described above) to be at least
592min_batch_time. It defaults to zero microseconds. Increasing this parameter
593may improve the throughput of multi-threaded, synchronous workloads on very
594fast disks, at the cost of increasing latency.
595.TP
596.BI journal_ioprio= prio
597The I/O priority (from 0 to 7, where 0 is the highest priority) which should be
598used for I/O operations submitted by kjournald2 during a commit operation.
599This defaults to 3, which is a slightly higher priority than the default I/O
600priority.
601.TP
602.B abort
603Simulate the effects of calling ext4_abort() for
604debugging purposes. This is normally used while
605remounting a filesystem which is already mounted.
606.TP
607.BR auto_da_alloc | noauto_da_alloc
608Many broken applications don't use fsync() when
609replacing existing files via patterns such as
610
611fd = open("foo.new")/write(fd,...)/close(fd)/ rename("foo.new", "foo")
612
613or worse yet
614
615fd = open("foo", O_TRUNC)/write(fd,...)/close(fd).
616
617If auto_da_alloc is enabled, ext4 will detect the replace-via-rename and
618replace-via-truncate patterns and force that any delayed allocation blocks are
619allocated such that at the next journal commit, in the default data=ordered
620mode, the data blocks of the new file are forced to disk before the rename()
621operation is committed. This provides roughly the same level of guarantees as
622ext3, and avoids the "zero-length" problem that can happen when a system
623crashes before the delayed allocation blocks are forced to disk.
624.TP
625.B noinit_itable
626Do not initialize any uninitialized inode table blocks in the background. This
627feature may be used by installation CD's so that the install process can
628complete as quickly as possible; the inode table initialization process would
629then be deferred until the next time the filesystem is mounted.
630.TP
631.B init_itable=n
632The lazy itable init code will wait n times the number of milliseconds it took
633to zero out the previous block group's inode table. This minimizes the impact on
634system performance while the filesystem's inode table is being initialized.
635.TP
636.BR discard / nodiscard
637Controls whether ext4 should issue discard/TRIM commands to the underlying
638block device when blocks are freed. This is useful for SSD devices and
639sparse/thinly-provisioned LUNs, but it is off by default until sufficient
640testing has been done.
641.TP
3e500a8f 642.BR block_validity / noblock_validity
53a7a826 643This option enables/disables the in-kernel facility for tracking
3e500a8f
ES
644filesystem metadata blocks within internal data structures. This allows multi-\c
645block allocator and other routines to quickly locate extents which might
646overlap with filesystem metadata blocks. This option is intended for debugging
647purposes and since it negatively affects the performance, it is off by default.
648.TP
649.BR dioread_lock / dioread_nolock
650Controls whether or not ext4 should use the DIO read locking. If the
651dioread_nolock option is specified ext4 will allocate uninitialized extent
652before buffer write and convert the extent to initialized after IO completes.
653This approach allows ext4 code to avoid using inode mutex, which improves
654scalability on high speed storages. However this does not work with data
655journaling and dioread_nolock option will be ignored with kernel warning.
656Note that dioread_nolock code path is only used for extent-based files.
657Because of the restrictions this options comprises it is off by default
658(e.g.\& dioread_lock).
659.TP
660.B max_dir_size_kb=n
661This limits the size of the directories so that any attempt to expand them
662beyond the specified limit in kilobytes will cause an ENOSPC error. This is
663useful in memory-constrained environments, where a very large directory can
664cause severe performance problems or even provoke the Out Of Memory killer. (For
665example, if there is only 512\ MB memory available, a 176\ MB directory may
666seriously cramp the system's style.)
667.TP
668.B i_version
669Enable 64-bit inode version support. This option is off by default.
53a7a826
TN
670.TP
671.B nombcache
672This option disables use of mbcache for extended attribute deduplication. On
673systems where extended attributes are rarely or never shared between files,
674use of mbcache for deduplication adds unnecessary computational overhead.
675.TP
676.B prjquota
677The prjquota mount option enables project quota support on the filesystem.
678You need the quota utilities to actually enable and manage the quota system.
679This mount option requires the
680.B project
681filesystem feature.
3e500a8f 682
e92beaac
ES
683.SH FILE ATTRIBUTES
684The ext2, ext3, and ext4 filesystems support setting the following file
685attributes on Linux systems using the
686.BR chattr (1)
687utility:
688.sp
689.BR a " - append only"
690.sp
691.BR A " - no atime updates"
692.sp
693.BR d " - no dump"
694.sp
695.BR D " - synchronous directory updates"
696.sp
697.BR i " - immutable"
698.sp
699.BR S " - synchronous updates"
700.sp
701.BR u " - undeletable"
702.sp
703In addition, the ext3 and ext4 filesystems support the following flag:
704.sp
705.BR j " - data journaling"
706.sp
707Finally, the ext4 filesystem also supports the following flag:
708.sp
709.BR e " - extents format"
710.sp
711For descriptions of these attribute flags, please refer to the
712.BR chattr (1)
713man page.
50a6f4a2
TT
714.SH KERNEL SUPPORT
715This section lists the file system driver (e.g., ext2, ext3, ext4) and
716upstream kernel version where a particular file system feature was
717supported. Note that in some cases the feature was present in earlier
718kernel versions, but there were known, serious bugs. In other cases the
719feature may still be considered in an experimental state. Finally, note
720that some distributions may have backported features into older kernels;
721in particular the kernel versions in certain "enterprise distributions"
722can be extremely misleading.
723.IP "\fBfiletype\fR" 2in
724ext2, 2.2.0
725.IP "\fBsparse_super\fR" 2in
726ext2, 2.2.0
727.IP "\fBlarge_file\fR" 2in
728ext2, 2.2.0
729.IP "\fBhas_journal\fR" 2in
730ext3, 2.4.15
731.IP "\fBext_attr\fR" 2in
732ext2/ext3, 2.6.0
733.IP "\fBdir_index\fR" 2in
734ext3, 2.6.0
735.IP "\fBresize_inode\fR" 2in
736ext3, 2.6.10 (online resizing)
737.IP "\fB64bit\fR" 2in
738ext4, 2.6.28
739.IP "\fBdir_nlink\fR" 2in
740ext4, 2.6.28
741.IP "\fBextent\fR" 2in
742ext4, 2.6.28
743.IP "\fBextra_isize\fR" 2in
744ext4, 2.6.28
745.IP "\fBflex_bg\fR" 2in
746ext4, 2.6.28
747.IP "\fBhuge_file\fR" 2in
748ext4, 2.6.28
749.IP "\fBmeta_bg\fR" 2in
750ext4, 2.6.28
751.IP "\fBuninit_bg\fR" 2in
752ext4, 2.6.28
753.IP "\fBmmp\fR" 2in
754ext4, 3.0
755.IP "\fBbigalloc\fR" 2in
756ext4, 3.2
757.IP "\fBquota\fR" 2in
758ext4, 3.6
759.IP "\fBinline_data\fR" 2in
760ext4, 3.8
761.IP "\fBsparse_super2\fR" 2in
762ext4, 3.16
8515abdc 763.IP "\fBmetadata_csum\fR" 2in
50a6f4a2
TT
764ext4, 3.18
765.IP "\fBencrypt\fR" 2in
766ext4, 4.1
6a9c8e0b 767.IP "\fBmetadata_csum_seed\fR" 2i
53a7a826 768ext4, 4.4
6a9c8e0b 769.IP "\fBproject\fR" 2i
50a6f4a2 770ext4, 4.5
6a9c8e0b 771.IP "\fBea_inode\fR" 2i
53a7a826 772ext4, 4.13
6a9c8e0b 773.IP "\fBlarge_dir\fR" 2i
53a7a826 774ext4, 4.13
3c22bf7e
TT
775.SH SEE ALSO
776.BR mke2fs (8),
777.BR mke2fs.conf (5),
778.BR e2fsck (8),
779.BR dumpe2fs (8),
780.BR tune2fs (8),
3e500a8f 781.BR debugfs (8),
e92beaac
ES
782.BR mount (8),
783.BR chattr (1)