1 # SPDX-License-Identifier: GPL-2.0-only 1 # SPDX-License-Identifier: GPL-2.0-only
2 2
3 config EROFS_FS 3 config EROFS_FS
4 tristate "EROFS filesystem support" 4 tristate "EROFS filesystem support"
5 depends on BLOCK 5 depends on BLOCK
6 select FS_IOMAP <<
7 select LIBCRC32C <<
8 help 6 help
9 EROFS (Enhanced Read-Only File Syste !! 7 EROFS (Enhanced Read-Only File System) is a lightweight
10 file system with modern designs (e.g !! 8 read-only file system with modern designs (eg. page-sized
11 xattrs/data, chunk-based deduplicati !! 9 blocks, inline xattrs/data, etc.) for scenarios which need
12 scenarios which need high-performanc !! 10 high-performance read-only requirements, e.g. Android OS
13 smartphones with Android OS, LiveCDs !! 11 for mobile phones and LIVECDs.
14 numerous containers; !! 12
15 !! 13 It also provides fixed-sized output compression support,
16 It also provides fixed-sized output !! 14 which improves storage density, keeps relatively higher
17 improve storage density as well as k !! 15 compression ratios, which is more useful to achieve high
18 ratios and implements in-place decom !! 16 performance for embedded devices with limited memory.
19 for compressed data temporarily with <<
20 quite useful to ensure guaranteed en <<
21 performance under extremely memory p <<
22 <<
23 See the documentation at <file:Docum <<
24 and the web pages at <https://erofs. <<
25 17
26 If unsure, say N. 18 If unsure, say N.
27 19
28 config EROFS_FS_DEBUG 20 config EROFS_FS_DEBUG
29 bool "EROFS debugging feature" 21 bool "EROFS debugging feature"
30 depends on EROFS_FS 22 depends on EROFS_FS
31 help 23 help
32 Print debugging messages and enable 24 Print debugging messages and enable more BUG_ONs which check
33 filesystem consistency and find pote 25 filesystem consistency and find potential issues aggressively,
34 which can be used for Android eng bu 26 which can be used for Android eng build, for example.
35 27
36 For daily use, say N. 28 For daily use, say N.
37 29
38 config EROFS_FS_XATTR 30 config EROFS_FS_XATTR
39 bool "EROFS extended attributes" 31 bool "EROFS extended attributes"
40 depends on EROFS_FS 32 depends on EROFS_FS
41 select XXHASH <<
42 default y 33 default y
43 help 34 help
44 Extended attributes are name:value p 35 Extended attributes are name:value pairs associated with inodes by
45 the kernel or by users (see the attr 36 the kernel or by users (see the attr(5) manual page, or visit
46 <http://acl.bestbits.at/> for detail 37 <http://acl.bestbits.at/> for details).
47 38
48 If unsure, say N. 39 If unsure, say N.
49 40
50 config EROFS_FS_POSIX_ACL 41 config EROFS_FS_POSIX_ACL
51 bool "EROFS Access Control Lists" 42 bool "EROFS Access Control Lists"
52 depends on EROFS_FS_XATTR 43 depends on EROFS_FS_XATTR
53 select FS_POSIX_ACL 44 select FS_POSIX_ACL
54 default y 45 default y
55 help 46 help
56 Posix Access Control Lists (ACLs) su 47 Posix Access Control Lists (ACLs) support permissions for users and
57 groups beyond the owner/group/world 48 groups beyond the owner/group/world scheme.
58 49
59 To learn more about Access Control L 50 To learn more about Access Control Lists, visit the POSIX ACLs for
60 Linux website <http://acl.bestbits.a 51 Linux website <http://acl.bestbits.at/>.
61 52
62 If you don't know what Access Contro 53 If you don't know what Access Control Lists are, say N.
63 54
64 config EROFS_FS_SECURITY 55 config EROFS_FS_SECURITY
65 bool "EROFS Security Labels" 56 bool "EROFS Security Labels"
66 depends on EROFS_FS_XATTR 57 depends on EROFS_FS_XATTR
67 default y 58 default y
68 help 59 help
69 Security labels provide an access co 60 Security labels provide an access control facility to support Linux
70 Security Models (LSMs) accepted by A 61 Security Models (LSMs) accepted by AppArmor, SELinux, Smack and TOMOYO
71 Linux. This option enables an extend 62 Linux. This option enables an extended attribute handler for file
72 security labels in the erofs filesys 63 security labels in the erofs filesystem, so that it requires enabling
73 the extended attribute support in ad 64 the extended attribute support in advance.
74 65
75 If you are not using a security modu 66 If you are not using a security module, say N.
76 67
77 config EROFS_FS_ZIP 68 config EROFS_FS_ZIP
78 bool "EROFS Data Compression Support" 69 bool "EROFS Data Compression Support"
79 depends on EROFS_FS 70 depends on EROFS_FS
80 select LZ4_DECOMPRESS 71 select LZ4_DECOMPRESS
81 default y 72 default y
82 help 73 help
83 Enable fixed-sized output compressio 74 Enable fixed-sized output compression for EROFS.
84 75
85 If you don't want to enable compress 76 If you don't want to enable compression feature, say N.
86 77
87 config EROFS_FS_ZIP_LZMA !! 78 config EROFS_FS_CLUSTER_PAGE_LIMIT
88 bool "EROFS LZMA compressed data suppo !! 79 int "EROFS Cluster Pages Hard Limit"
89 depends on EROFS_FS_ZIP <<
90 select XZ_DEC <<
91 select XZ_DEC_MICROLZMA <<
92 help <<
93 Saying Y here includes support for r <<
94 containing LZMA compressed data, spe <<
95 gives better compression ratios than <<
96 expense of more CPU overhead. <<
97 <<
98 If unsure, say N. <<
99 <<
100 config EROFS_FS_ZIP_DEFLATE <<
101 bool "EROFS DEFLATE compressed data su <<
102 depends on EROFS_FS_ZIP <<
103 select ZLIB_INFLATE <<
104 help <<
105 Saying Y here includes support for r <<
106 containing DEFLATE compressed data. <<
107 ratios than the default LZ4 format, <<
108 overhead. <<
109 <<
110 DEFLATE support is an experimental f <<
111 file systems will be readable withou <<
112 <<
113 If unsure, say N. <<
114 <<
115 config EROFS_FS_ZIP_ZSTD <<
116 bool "EROFS Zstandard compressed data <<
117 depends on EROFS_FS_ZIP <<
118 select ZSTD_DECOMPRESS <<
119 help <<
120 Saying Y here includes support for r <<
121 containing Zstandard compressed data <<
122 ratios than the default LZ4 format, <<
123 overhead. <<
124 <<
125 Zstandard support is an experimental <<
126 file systems will be readable withou <<
127 <<
128 If unsure, say N. <<
129 <<
130 config EROFS_FS_ONDEMAND <<
131 bool "EROFS fscache-based on-demand re <<
132 depends on EROFS_FS <<
133 select NETFS_SUPPORT <<
134 select FSCACHE <<
135 select CACHEFILES <<
136 select CACHEFILES_ONDEMAND <<
137 help <<
138 This permits EROFS to use fscache-ba <<
139 read support. <<
140 <<
141 If unsure, say N. <<
142 <<
143 config EROFS_FS_PCPU_KTHREAD <<
144 bool "EROFS per-cpu decompression kthr <<
145 depends on EROFS_FS_ZIP 80 depends on EROFS_FS_ZIP
>> 81 range 1 256
>> 82 default "1"
146 help 83 help
147 Saying Y here enables per-CPU kthrea !! 84 Indicates maximum # of pages of a compressed
148 async decompression for low latencie !! 85 physical cluster.
149 86
150 If unsure, say N. !! 87 For example, if files in a image were compressed
>> 88 into 8k-unit, hard limit should not be configured
>> 89 less than 2. Otherwise, the image will be refused
>> 90 to mount on this kernel.
151 91
152 config EROFS_FS_PCPU_KTHREAD_HIPRI <<
153 bool "EROFS high priority per-CPU kthr <<
154 depends on EROFS_FS_ZIP && EROFS_FS_PC <<
155 default y <<
156 help <<
157 This permits EROFS to configure per- <<
158 at higher priority. <<
159 <<
160 If unsure, say N. <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.