Blame view

fs/overlayfs/Kconfig 4.89 KB
ec8f24b7f   Thomas Gleixner   treewide: Add SPD...
1
  # SPDX-License-Identifier: GPL-2.0-only
ef94b1864   Miklos Szeredi   ovl: rename files...
2
  config OVERLAY_FS
e9be9d5e7   Miklos Szeredi   overlay filesystem
3
  	tristate "Overlay filesystem support"
72d42504b   Arnd Bergmann   ovl: select EXPORTFS
4
  	select EXPORTFS
e9be9d5e7   Miklos Szeredi   overlay filesystem
5
6
7
8
9
10
  	help
  	  An overlay filesystem combines two filesystems - an 'upper' filesystem
  	  and a 'lower' filesystem.  When a name exists in both filesystems, the
  	  object in the 'upper' filesystem is visible while the object in the
  	  'lower' filesystem is either hidden or, in the case of directories,
  	  merged with the 'upper' object.
72ef5e52b   Mauro Carvalho Chehab   docs: fix broken ...
11
  	  For more information see Documentation/filesystems/overlayfs.rst
688ea0e5a   Miklos Szeredi   ovl: allow redire...
12
13
  
  config OVERLAY_FS_REDIRECT_DIR
4280f74a5   Miklos Szeredi   ovl: Kconfig docu...
14
  	bool "Overlayfs: turn on redirect directory feature by default"
688ea0e5a   Miklos Szeredi   ovl: allow redire...
15
16
17
18
19
20
21
22
23
24
25
  	depends on OVERLAY_FS
  	help
  	  If this config option is enabled then overlay filesystems will use
  	  redirects when renaming directories by default.  In this case it is
  	  still possible to turn off redirects globally with the
  	  "redirect_dir=off" module option or on a filesystem instance basis
  	  with the "redirect_dir=off" mount option.
  
  	  Note, that redirects are not backward compatible.  That is, mounting
  	  an overlay which has redirects on a kernel that doesn't support this
  	  feature will have unexpected results.
02bcd1577   Amir Goldstein   ovl: introduce th...
26

36cd95dfa   Miklos Szeredi   ovl: update Kconf...
27
  	  If unsure, say N.
438c84c2f   Miklos Szeredi   ovl: don't follow...
28
29
30
31
32
33
34
  config OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW
  	bool "Overlayfs: follow redirects even if redirects are turned off"
  	default y
  	depends on OVERLAY_FS
  	help
  	  Disable this to get a possibly more secure configuration, but that
  	  might not be backward compatible with previous kernels.
36cd95dfa   Miklos Szeredi   ovl: update Kconf...
35
36
  	  If backward compatibility is not an issue, then it is safe and
  	  recommended to say N here.
72ef5e52b   Mauro Carvalho Chehab   docs: fix broken ...
37
  	  For more information, see Documentation/filesystems/overlayfs.rst
438c84c2f   Miklos Szeredi   ovl: don't follow...
38

36cd95dfa   Miklos Szeredi   ovl: update Kconf...
39
  	  If unsure, say Y.
02bcd1577   Amir Goldstein   ovl: introduce th...
40
41
42
43
44
  config OVERLAY_FS_INDEX
  	bool "Overlayfs: turn on inodes index feature by default"
  	depends on OVERLAY_FS
  	help
  	  If this config option is enabled then overlay filesystems will use
4280f74a5   Miklos Szeredi   ovl: Kconfig docu...
45
  	  the index directory to map lower inodes to upper inodes by default.
02bcd1577   Amir Goldstein   ovl: introduce th...
46
47
48
49
50
51
  	  In this case it is still possible to turn off index globally with the
  	  "index=off" module option or on a filesystem instance basis with the
  	  "index=off" mount option.
  
  	  The inodes index feature prevents breaking of lower hardlinks on copy
  	  up.
60b866420   Amir Goldstein   ovl: update docum...
52
53
54
  	  Note, that the inodes index feature is not backward compatible.
  	  That is, mounting an overlay which has an inodes index on a kernel
  	  that doesn't support this feature will have unexpected results.
f168f1098   Amir Goldstein   ovl: add support ...
55

36cd95dfa   Miklos Szeredi   ovl: update Kconf...
56
  	  If unsure, say N.
f168f1098   Amir Goldstein   ovl: add support ...
57
58
59
60
  config OVERLAY_FS_NFS_EXPORT
  	bool "Overlayfs: turn on NFS export feature by default"
  	depends on OVERLAY_FS
  	depends on OVERLAY_FS_INDEX
d5791044d   Vivek Goyal   ovl: Provide a mo...
61
  	depends on !OVERLAY_FS_METACOPY
f168f1098   Amir Goldstein   ovl: add support ...
62
63
  	help
  	  If this config option is enabled then overlay filesystems will use
4280f74a5   Miklos Szeredi   ovl: Kconfig docu...
64
  	  the index directory to decode overlay NFS file handles by default.
f168f1098   Amir Goldstein   ovl: add support ...
65
66
67
68
69
70
71
72
73
74
75
76
77
78
  	  In this case, it is still possible to turn off NFS export support
  	  globally with the "nfs_export=off" module option or on a filesystem
  	  instance basis with the "nfs_export=off" mount option.
  
  	  The NFS export feature creates an index on copy up of every file and
  	  directory.  This full index is used to detect overlay filesystems
  	  inconsistencies on lookup, like redirect from multiple upper dirs to
  	  the same lower dir.  The full index may incur some overhead on mount
  	  time, especially when verifying that directory file handles are not
  	  stale.
  
  	  Note, that the NFS export feature is not backward compatible.
  	  That is, mounting an overlay which has a full index on a kernel
  	  that doesn't support this feature will have unexpected results.
36cd95dfa   Miklos Szeredi   ovl: update Kconf...
79
80
81
82
83
  
  	  Most users should say N here and enable this feature on a case-by-
  	  case basis with the "nfs_export=on" mount option.
  
  	  Say N unless you fully understand the consequences.
795939a93   Amir Goldstein   ovl: add support ...
84
85
86
87
88
  
  config OVERLAY_FS_XINO_AUTO
  	bool "Overlayfs: auto enable inode number mapping"
  	default n
  	depends on OVERLAY_FS
53afcd310   Amir Goldstein   ovl: fix some xin...
89
  	depends on 64BIT
795939a93   Amir Goldstein   ovl: add support ...
90
91
92
93
94
95
96
97
  	help
  	  If this config option is enabled then overlay filesystems will use
  	  unused high bits in undelying filesystem inode numbers to map all
  	  inodes to a unified address space.  The mapped 64bit inode numbers
  	  might not be compatible with applications that expect 32bit inodes.
  
  	  If compatibility with applications that expect 32bit inodes is not an
  	  issue, then it is safe and recommended to say Y here.
72ef5e52b   Mauro Carvalho Chehab   docs: fix broken ...
98
  	  For more information, see Documentation/filesystems/overlayfs.rst
795939a93   Amir Goldstein   ovl: add support ...
99
100
  
  	  If unsure, say N.
d5791044d   Vivek Goyal   ovl: Provide a mo...
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
  
  config OVERLAY_FS_METACOPY
  	bool "Overlayfs: turn on metadata only copy up feature by default"
  	depends on OVERLAY_FS
  	select OVERLAY_FS_REDIRECT_DIR
  	help
  	  If this config option is enabled then overlay filesystems will
  	  copy up only metadata where appropriate and data copy up will
  	  happen when a file is opened for WRITE operation. It is still
  	  possible to turn off this feature globally with the "metacopy=off"
  	  module option or on a filesystem instance basis with the
  	  "metacopy=off" mount option.
  
  	  Note, that this feature is not backward compatible.  That is,
  	  mounting an overlay which has metacopy only inodes on a kernel
  	  that doesn't support this feature will have unexpected results.
  
  	  If unsure, say N.