[linux-block.git] / fs / f2fs / Kconfig

# SPDX-License-Identifier: GPL-2.0-only
config F2FS_FS
	tristate "F2FS filesystem support"
	depends on BLOCK
	select NLS
	select CRYPTO
	select CRYPTO_CRC32
	select F2FS_FS_XATTR if FS_ENCRYPTION
	select FS_ENCRYPTION_ALGS if FS_ENCRYPTION
	select LZ4_COMPRESS if F2FS_FS_LZ4
	select LZ4_DECOMPRESS if F2FS_FS_LZ4
	select LZ4HC_COMPRESS if F2FS_FS_LZ4HC
	select LZO_COMPRESS if F2FS_FS_LZO
	select LZO_DECOMPRESS if F2FS_FS_LZO
	select ZSTD_COMPRESS if F2FS_FS_ZSTD
	select ZSTD_DECOMPRESS if F2FS_FS_ZSTD
	help
	  F2FS is based on Log-structured File System (LFS), which supports
	  versatile "flash-friendly" features. The design has been focused on
	  addressing the fundamental issues in LFS, which are snowball effect
	  of wandering tree and high cleaning overhead.

	  Since flash-based storages show different characteristics according to
	  the internal geometry or flash memory management schemes aka FTL, F2FS
	  and tools support various parameters not only for configuring on-disk
	  layout, but also for selecting allocation and cleaning algorithms.

	  If unsure, say N.

config F2FS_STAT_FS
	bool "F2FS Status Information"
	depends on F2FS_FS
	default y
	help
	  /sys/kernel/debug/f2fs/ contains information about all the partitions
	  mounted as f2fs. Each file shows the whole f2fs information.

	  /sys/kernel/debug/f2fs/status includes:
	    - major filesystem information managed by f2fs currently
	    - average SIT information about whole segments
	    - current memory footprint consumed by f2fs.

config F2FS_FS_XATTR
	bool "F2FS extended attributes"
	depends on F2FS_FS
	default y
	help
	  Extended attributes are name:value pairs associated with inodes by
	  the kernel or by users (see the attr(5) manual page for details).

	  If unsure, say N.

config F2FS_FS_POSIX_ACL
	bool "F2FS Access Control Lists"
	depends on F2FS_FS_XATTR
	select FS_POSIX_ACL
	default y
	help
	  Posix Access Control Lists (ACLs) support permissions for users and
	  groups beyond the owner/group/world scheme.

	  If you don't know what Access Control Lists are, say N

config F2FS_FS_SECURITY
	bool "F2FS Security Labels"
	depends on F2FS_FS_XATTR
	help
	  Security labels provide an access control facility to support Linux
	  Security Models (LSMs) accepted by AppArmor, SELinux, Smack and TOMOYO
	  Linux. This option enables an extended attribute handler for file
	  security labels in the f2fs filesystem, so that it requires enabling
	  the extended attribute support in advance. In particular you need this
	  option if you use the setcap command to assign initial process capabi-
	  lities to executables (the security.* extended attributes).

	  If you are not using a security module, say N.

config F2FS_CHECK_FS
	bool "F2FS consistency checking feature"
	depends on F2FS_FS
	help
	  Enables BUG_ONs which check the filesystem consistency in runtime.

	  If you want to improve the performance, say N.

config F2FS_FAULT_INJECTION
	bool "F2FS fault injection facility"
	depends on F2FS_FS
	help
	  Test F2FS to inject faults such as ENOMEM, ENOSPC, and so on.

	  If unsure, say N.

config F2FS_FS_COMPRESSION
	bool "F2FS compression feature"
	depends on F2FS_FS
	help
	  Enable filesystem-level compression on f2fs regular files,
	  multiple back-end compression algorithms are supported.

config F2FS_FS_LZO
	bool "LZO compression support"
	depends on F2FS_FS_COMPRESSION
	default y
	help
	  Support LZO compress algorithm, if unsure, say Y.

config F2FS_FS_LZ4
	bool "LZ4 compression support"
	depends on F2FS_FS_COMPRESSION
	default y
	help
	  Support LZ4 compress algorithm, if unsure, say Y.

config F2FS_FS_LZ4HC
	bool "LZ4HC compression support"
	depends on F2FS_FS_COMPRESSION
	depends on F2FS_FS_LZ4
	default y
	help
	  Support LZ4HC compress algorithm, LZ4HC has compatible on-disk
	  layout with LZ4, if unsure, say Y.

config F2FS_FS_ZSTD
	bool "ZSTD compression support"
	depends on F2FS_FS_COMPRESSION
	default y
	help
	  Support ZSTD compress algorithm, if unsure, say Y.

config F2FS_FS_LZORLE
	bool "LZO-RLE compression support"
	depends on F2FS_FS_COMPRESSION
	depends on F2FS_FS_LZO
	default y
	help
	  Support LZO-RLE compress algorithm, if unsure, say Y.
Commit	Line	Data
ec8f24b7	1	# SPDX-License-Identifier: GPL-2.0-only
a14d5393	2	config F2FS_FS
d7196c5a	3	tristate "F2FS filesystem support"
573ea5fc	4	depends on BLOCK
aabc172b	5	select NLS
43b6573b KM	6	select CRYPTO
43b6573b KM	7	select CRYPTO_CRC32
643fa961	8	select F2FS_FS_XATTR if FS_ENCRYPTION
ede7a09f	9	select FS_ENCRYPTION_ALGS if FS_ENCRYPTION
72f85881 GU	10	select LZ4_COMPRESS if F2FS_FS_LZ4
	11	select LZ4_DECOMPRESS if F2FS_FS_LZ4
	12	select LZ4HC_COMPRESS if F2FS_FS_LZ4HC
	13	select LZO_COMPRESS if F2FS_FS_LZO
	14	select LZO_DECOMPRESS if F2FS_FS_LZO
	15	select ZSTD_COMPRESS if F2FS_FS_ZSTD
	16	select ZSTD_DECOMPRESS if F2FS_FS_ZSTD
a14d5393 JK	17	help
	18	F2FS is based on Log-structured File System (LFS), which supports
	19	versatile "flash-friendly" features. The design has been focused on
	20	addressing the fundamental issues in LFS, which are snowball effect
	21	of wandering tree and high cleaning overhead.
	22
	23	Since flash-based storages show different characteristics according to
	24	the internal geometry or flash memory management schemes aka FTL, F2FS
	25	and tools support various parameters not only for configuring on-disk
	26	layout, but also for selecting allocation and cleaning algorithms.
	27
	28	If unsure, say N.
	29
	30	config F2FS_STAT_FS
	31	bool "F2FS Status Information"
fc7100ea	32	depends on F2FS_FS
a14d5393 JK	33	default y
	34	help
	35	/sys/kernel/debug/f2fs/ contains information about all the partitions
	36	mounted as f2fs. Each file shows the whole f2fs information.
	37
	38	/sys/kernel/debug/f2fs/status includes:
e1c42045	39	- major filesystem information managed by f2fs currently
a14d5393 JK	40	- average SIT information about whole segments
	41	- current memory footprint consumed by f2fs.
	42
	43	config F2FS_FS_XATTR
	44	bool "F2FS extended attributes"
	45	depends on F2FS_FS
	46	default y
	47	help
	48	Extended attributes are name:value pairs associated with inodes by
91581e4c	49	the kernel or by users (see the attr(5) manual page for details).
a14d5393 JK	50
	51	If unsure, say N.
	52
	53	config F2FS_FS_POSIX_ACL
	54	bool "F2FS Access Control Lists"
	55	depends on F2FS_FS_XATTR
	56	select FS_POSIX_ACL
	57	default y
	58	help
	59	Posix Access Control Lists (ACLs) support permissions for users and
217940d4	60	groups beyond the owner/group/world scheme.
a14d5393	61
a14d5393	62	If you don't know what Access Control Lists are, say N
8ae8f162 JK	63
	64	config F2FS_FS_SECURITY
	65	bool "F2FS Security Labels"
	66	depends on F2FS_FS_XATTR
	67	help
	68	Security labels provide an access control facility to support Linux
	69	Security Models (LSMs) accepted by AppArmor, SELinux, Smack and TOMOYO
	70	Linux. This option enables an extended attribute handler for file
	71	security labels in the f2fs filesystem, so that it requires enabling
bd7253bc L	72	the extended attribute support in advance. In particular you need this
	73	option if you use the setcap command to assign initial process capabi-
	74	lities to executables (the security.* extended attributes).
8ae8f162 JK	75
8ae8f162 JK	76	If you are not using a security module, say N.
3b218e3a JK	77
	78	config F2FS_CHECK_FS
	79	bool "F2FS consistency checking feature"
	80	depends on F2FS_FS
	81	help
e1c42045	82	Enables BUG_ONs which check the filesystem consistency in runtime.
3b218e3a JK	83
3b218e3a JK	84	If you want to improve the performance, say N.
63f92ddc	85
73faec4d JK	86	config F2FS_FAULT_INJECTION
	87	bool "F2FS fault injection facility"
	88	depends on F2FS_FS
	89	help
	90	Test F2FS to inject faults such as ENOMEM, ENOSPC, and so on.
	91
	92	If unsure, say N.
4c8ff709 CY	93
	94	config F2FS_FS_COMPRESSION
	95	bool "F2FS compression feature"
	96	depends on F2FS_FS
	97	help
	98	Enable filesystem-level compression on f2fs regular files,
	99	multiple back-end compression algorithms are supported.
	100
	101	config F2FS_FS_LZO
	102	bool "LZO compression support"
	103	depends on F2FS_FS_COMPRESSION
4c8ff709 CY	104	default y
	105	help
	106	Support LZO compress algorithm, if unsure, say Y.
	107
	108	config F2FS_FS_LZ4
	109	bool "LZ4 compression support"
	110	depends on F2FS_FS_COMPRESSION
4c8ff709 CY	111	default y
	112	help
	113	Support LZ4 compress algorithm, if unsure, say Y.
50cfa66f	114
3fde13f8 CY	115	config F2FS_FS_LZ4HC
	116	bool "LZ4HC compression support"
	117	depends on F2FS_FS_COMPRESSION
	118	depends on F2FS_FS_LZ4
3fde13f8 CY	119	default y
	120	help
	121	Support LZ4HC compress algorithm, LZ4HC has compatible on-disk
	122	layout with LZ4, if unsure, say Y.
	123
50cfa66f CY	124	config F2FS_FS_ZSTD
	125	bool "ZSTD compression support"
	126	depends on F2FS_FS_COMPRESSION
50cfa66f CY	127	default y
	128	help
	129	Support ZSTD compress algorithm, if unsure, say Y.
6d92b201 CY	130
	131	config F2FS_FS_LZORLE
	132	bool "LZO-RLE compression support"
	133	depends on F2FS_FS_COMPRESSION
	134	depends on F2FS_FS_LZO
6d92b201 CY	135	default y
	136	help
	137	Support LZO-RLE compress algorithm, if unsure, say Y.