Miklos Szeredi | ef94b18 | 2014-11-20 16:39:59 +0100 | [diff] [blame] | 1 | config OVERLAY_FS |
Miklos Szeredi | e9be9d5 | 2014-10-24 00:14:38 +0200 | [diff] [blame] | 2 | tristate "Overlay filesystem support" |
Arnd Bergmann | 72d4250 | 2017-05-11 13:34:29 +0200 | [diff] [blame] | 3 | select EXPORTFS |
Miklos Szeredi | e9be9d5 | 2014-10-24 00:14:38 +0200 | [diff] [blame] | 4 | 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 Szeredi | 688ea0e | 2016-12-16 11:02:57 +0100 | [diff] [blame] | 12 | |
| 13 | config OVERLAY_FS_REDIRECT_DIR |
Miklos Szeredi | 4280f74 | 2018-05-31 11:06:10 +0200 | [diff] [blame] | 14 | bool "Overlayfs: turn on redirect directory feature by default" |
Miklos Szeredi | 688ea0e | 2016-12-16 11:02:57 +0100 | [diff] [blame] | 15 | 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 Goldstein | 02bcd15 | 2017-06-21 15:28:36 +0300 | [diff] [blame] | 26 | |
Miklos Szeredi | 36cd95df | 2018-03-07 11:47:15 +0100 | [diff] [blame] | 27 | If unsure, say N. |
| 28 | |
Miklos Szeredi | 438c84c | 2017-12-11 11:28:10 +0100 | [diff] [blame] | 29 | config 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 Szeredi | 36cd95df | 2018-03-07 11:47:15 +0100 | [diff] [blame] | 37 | If backward compatibility is not an issue, then it is safe and |
| 38 | recommended to say N here. |
| 39 | |
Miklos Szeredi | 438c84c | 2017-12-11 11:28:10 +0100 | [diff] [blame] | 40 | For more information, see Documentation/filesystems/overlayfs.txt |
| 41 | |
Miklos Szeredi | 36cd95df | 2018-03-07 11:47:15 +0100 | [diff] [blame] | 42 | If unsure, say Y. |
| 43 | |
Amir Goldstein | 02bcd15 | 2017-06-21 15:28:36 +0300 | [diff] [blame] | 44 | config 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 Szeredi | 4280f74 | 2018-05-31 11:06:10 +0200 | [diff] [blame] | 49 | the index directory to map lower inodes to upper inodes by default. |
Amir Goldstein | 02bcd15 | 2017-06-21 15:28:36 +0300 | [diff] [blame] | 50 | 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 Goldstein | 60b8664 | 2018-01-10 23:15:21 +0200 | [diff] [blame] | 57 | 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 Goldstein | f168f10 | 2018-01-19 11:26:53 +0200 | [diff] [blame] | 60 | |
Miklos Szeredi | 36cd95df | 2018-03-07 11:47:15 +0100 | [diff] [blame] | 61 | If unsure, say N. |
| 62 | |
Amir Goldstein | f168f10 | 2018-01-19 11:26:53 +0200 | [diff] [blame] | 63 | config 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 Goyal | d579104 | 2018-05-11 11:49:27 -0400 | [diff] [blame] | 67 | depends on !OVERLAY_FS_METACOPY |
Amir Goldstein | f168f10 | 2018-01-19 11:26:53 +0200 | [diff] [blame] | 68 | help |
| 69 | If this config option is enabled then overlay filesystems will use |
Miklos Szeredi | 4280f74 | 2018-05-31 11:06:10 +0200 | [diff] [blame] | 70 | the index directory to decode overlay NFS file handles by default. |
Amir Goldstein | f168f10 | 2018-01-19 11:26:53 +0200 | [diff] [blame] | 71 | 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 Szeredi | 36cd95df | 2018-03-07 11:47:15 +0100 | [diff] [blame] | 85 | |
| 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 Goldstein | 795939a | 2018-03-29 09:08:18 +0300 | [diff] [blame] | 90 | |
| 91 | config 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 Goyal | d579104 | 2018-05-11 11:49:27 -0400 | [diff] [blame] | 107 | |
| 108 | config 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. |