[linux.git] / fs / f2fs / Kconfig

# SPDX-License-Identifier: GPL-2.0-only
config F2FS_FS
	tristate "F2FS filesystem support"
	depends on BLOCK
	select BUFFER_HEAD
	select NLS
	select CRYPTO
	select CRYPTO_CRC32
	select F2FS_FS_XATTR if FS_ENCRYPTION
	select FS_ENCRYPTION_ALGS if FS_ENCRYPTION
	select FS_IOMAP
	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_LZORLE
	bool "LZO-RLE compression support"
	depends on F2FS_FS_LZO
	default y
	help
	  Support LZO-RLE 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_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_IOSTAT
	bool "F2FS IO statistics information"
	depends on F2FS_FS
	default y
	help
	  Support getting IO statistics through sysfs and printing out periodic
	  IO statistics tracepoint events. You have to turn on "iostat_enable"
	  sysfs node to enable this feature.

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