blob: 2ef91be2a04ee1a3a13581a8c9cb1309267f2786 [file] [log] [blame]
Miklos Szeredief94b182014-11-20 16:39:59 +01001config OVERLAY_FS
Miklos Szeredie9be9d52014-10-24 00:14:38 +02002 tristate "Overlay filesystem support"
Arnd Bergmann72d42502017-05-11 13:34:29 +02003 select EXPORTFS
Miklos Szeredie9be9d52014-10-24 00:14:38 +02004 help
5 An overlay filesystem combines two filesystems - an 'upper' filesystem
6 and a 'lower' filesystem. When a name exists in both filesystems, the
7 object in the 'upper' filesystem is visible while the object in the
8 'lower' filesystem is either hidden or, in the case of directories,
9 merged with the 'upper' object.
10
11 For more information see Documentation/filesystems/overlayfs.txt
Miklos Szeredi688ea0e2016-12-16 11:02:57 +010012
13config OVERLAY_FS_REDIRECT_DIR
Miklos Szeredi4280f742018-05-31 11:06:10 +020014 bool "Overlayfs: turn on redirect directory feature by default"
Miklos Szeredi688ea0e2016-12-16 11:02:57 +010015 depends on OVERLAY_FS
16 help
17 If this config option is enabled then overlay filesystems will use
18 redirects when renaming directories by default. In this case it is
19 still possible to turn off redirects globally with the
20 "redirect_dir=off" module option or on a filesystem instance basis
21 with the "redirect_dir=off" mount option.
22
23 Note, that redirects are not backward compatible. That is, mounting
24 an overlay which has redirects on a kernel that doesn't support this
25 feature will have unexpected results.
Amir Goldstein02bcd152017-06-21 15:28:36 +030026
Miklos Szeredi36cd95df2018-03-07 11:47:15 +010027 If unsure, say N.
28
Miklos Szeredi438c84c2017-12-11 11:28:10 +010029config OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW
30 bool "Overlayfs: follow redirects even if redirects are turned off"
31 default y
32 depends on OVERLAY_FS
33 help
34 Disable this to get a possibly more secure configuration, but that
35 might not be backward compatible with previous kernels.
36
Miklos Szeredi36cd95df2018-03-07 11:47:15 +010037 If backward compatibility is not an issue, then it is safe and
38 recommended to say N here.
39
Miklos Szeredi438c84c2017-12-11 11:28:10 +010040 For more information, see Documentation/filesystems/overlayfs.txt
41
Miklos Szeredi36cd95df2018-03-07 11:47:15 +010042 If unsure, say Y.
43
Amir Goldstein02bcd152017-06-21 15:28:36 +030044config OVERLAY_FS_INDEX
45 bool "Overlayfs: turn on inodes index feature by default"
46 depends on OVERLAY_FS
47 help
48 If this config option is enabled then overlay filesystems will use
Miklos Szeredi4280f742018-05-31 11:06:10 +020049 the index directory to map lower inodes to upper inodes by default.
Amir Goldstein02bcd152017-06-21 15:28:36 +030050 In this case it is still possible to turn off index globally with the
51 "index=off" module option or on a filesystem instance basis with the
52 "index=off" mount option.
53
54 The inodes index feature prevents breaking of lower hardlinks on copy
55 up.
56
Amir Goldstein60b86642018-01-10 23:15:21 +020057 Note, that the inodes index feature is not backward compatible.
58 That is, mounting an overlay which has an inodes index on a kernel
59 that doesn't support this feature will have unexpected results.
Amir Goldsteinf168f102018-01-19 11:26:53 +020060
Miklos Szeredi36cd95df2018-03-07 11:47:15 +010061 If unsure, say N.
62
Amir Goldsteinf168f102018-01-19 11:26:53 +020063config OVERLAY_FS_NFS_EXPORT
64 bool "Overlayfs: turn on NFS export feature by default"
65 depends on OVERLAY_FS
66 depends on OVERLAY_FS_INDEX
Vivek Goyald5791042018-05-11 11:49:27 -040067 depends on !OVERLAY_FS_METACOPY
Amir Goldsteinf168f102018-01-19 11:26:53 +020068 help
69 If this config option is enabled then overlay filesystems will use
Miklos Szeredi4280f742018-05-31 11:06:10 +020070 the index directory to decode overlay NFS file handles by default.
Amir Goldsteinf168f102018-01-19 11:26:53 +020071 In this case, it is still possible to turn off NFS export support
72 globally with the "nfs_export=off" module option or on a filesystem
73 instance basis with the "nfs_export=off" mount option.
74
75 The NFS export feature creates an index on copy up of every file and
76 directory. This full index is used to detect overlay filesystems
77 inconsistencies on lookup, like redirect from multiple upper dirs to
78 the same lower dir. The full index may incur some overhead on mount
79 time, especially when verifying that directory file handles are not
80 stale.
81
82 Note, that the NFS export feature is not backward compatible.
83 That is, mounting an overlay which has a full index on a kernel
84 that doesn't support this feature will have unexpected results.
Miklos Szeredi36cd95df2018-03-07 11:47:15 +010085
86 Most users should say N here and enable this feature on a case-by-
87 case basis with the "nfs_export=on" mount option.
88
89 Say N unless you fully understand the consequences.
Amir Goldstein795939a2018-03-29 09:08:18 +030090
91config OVERLAY_FS_XINO_AUTO
92 bool "Overlayfs: auto enable inode number mapping"
93 default n
94 depends on OVERLAY_FS
95 help
96 If this config option is enabled then overlay filesystems will use
97 unused high bits in undelying filesystem inode numbers to map all
98 inodes to a unified address space. The mapped 64bit inode numbers
99 might not be compatible with applications that expect 32bit inodes.
100
101 If compatibility with applications that expect 32bit inodes is not an
102 issue, then it is safe and recommended to say Y here.
103
104 For more information, see Documentation/filesystems/overlayfs.txt
105
106 If unsure, say N.
Vivek Goyald5791042018-05-11 11:49:27 -0400107
108config OVERLAY_FS_METACOPY
109 bool "Overlayfs: turn on metadata only copy up feature by default"
110 depends on OVERLAY_FS
111 select OVERLAY_FS_REDIRECT_DIR
112 help
113 If this config option is enabled then overlay filesystems will
114 copy up only metadata where appropriate and data copy up will
115 happen when a file is opened for WRITE operation. It is still
116 possible to turn off this feature globally with the "metacopy=off"
117 module option or on a filesystem instance basis with the
118 "metacopy=off" mount option.
119
120 Note, that this feature is not backward compatible. That is,
121 mounting an overlay which has metacopy only inodes on a kernel
122 that doesn't support this feature will have unexpected results.
123
124 If unsure, say N.