[linux-block.git] / block / Kconfig

# SPDX-License-Identifier: GPL-2.0
#
# Block layer core configuration
#
menuconfig BLOCK
       bool "Enable the block layer" if EXPERT
       default y
       select SBITMAP
       help
	 Provide block layer support for the kernel.

	 Disable this option to remove the block layer support from the
	 kernel. This may be useful for embedded devices.

	 If this option is disabled:

	   - block device files will become unusable
	   - some filesystems (such as ext3) will become unavailable.

	 Also, SCSI character devices and USB storage will be disabled since
	 they make use of various block layer definitions and facilities.

	 Say Y here unless you know you really don't want to mount disks and
	 suchlike.

if BLOCK

config BLOCK_LEGACY_AUTOLOAD
	bool "Legacy autoloading support"
	default y
	help
	  Enable loading modules and creating block device instances based on
	  accesses through their device special file.  This is a historic Linux
	  feature and makes no sense in a udev world where device files are
	  created on demand, but scripts that manually create device nodes and
	  then call losetup might rely on this behavior.

config BLK_RQ_ALLOC_TIME
	bool

config BLK_CGROUP_RWSTAT
	bool

config BLK_CGROUP_PUNT_BIO
	bool

config BLK_DEV_BSG_COMMON
	tristate

config BLK_ICQ
	bool

config BLK_DEV_BSGLIB
	bool "Block layer SG support v4 helper lib"
	select BLK_DEV_BSG_COMMON
	help
	  Subsystems will normally enable this if needed. Users will not
	  normally need to manually enable this.

	  If unsure, say N.

config BLK_DEV_INTEGRITY
	bool "Block layer data integrity support"
	help
	Some storage devices allow extra information to be
	stored/retrieved to help protect the data.  The block layer
	data integrity option provides hooks which can be used by
	filesystems to ensure better data integrity.

	Say yes here if you have a storage device that provides the
	T10/SCSI Data Integrity Field or the T13/ATA External Path
	Protection.  If in doubt, say N.

config BLK_DEV_INTEGRITY_T10
	tristate
	depends on BLK_DEV_INTEGRITY
	select CRC_T10DIF
	select CRC64_ROCKSOFT

config BLK_DEV_ZONED
	bool "Zoned block device support"
	select MQ_IOSCHED_DEADLINE
	help
	Block layer zoned block device support. This option enables
	support for ZAC/ZBC/ZNS host-managed and host-aware zoned block
	devices.

	Say yes here if you have a ZAC, ZBC, or ZNS storage device.

config BLK_DEV_THROTTLING
	bool "Block layer bio throttling support"
	depends on BLK_CGROUP
	select BLK_CGROUP_RWSTAT
	help
	Block layer bio throttling support. It can be used to limit
	the IO rate to a device. IO rate policies are per cgroup and
	one needs to mount and use blkio cgroup controller for creating
	cgroups and specifying per device IO rate policies.

	See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information.

config BLK_DEV_THROTTLING_LOW
	bool "Block throttling .low limit interface support (EXPERIMENTAL)"
	depends on BLK_DEV_THROTTLING
	help
	Add .low limit interface for block throttling. The low limit is a best
	effort limit to prioritize cgroups. Depending on the setting, the limit
	can be used to protect cgroups in terms of bandwidth/iops and better
	utilize disk resource.

	Note, this is an experimental interface and could be changed someday.

config BLK_WBT
	bool "Enable support for block device writeback throttling"
	help
	Enabling this option enables the block layer to throttle buffered
	background writeback from the VM, making it more smooth and having
	less impact on foreground operations. The throttling is done
	dynamically on an algorithm loosely based on CoDel, factoring in
	the realtime performance of the disk.

config BLK_WBT_MQ
	bool "Enable writeback throttling by default"
	default y
	depends on BLK_WBT
	help
	Enable writeback throttling by default for request-based block devices.

config BLK_CGROUP_IOLATENCY
	bool "Enable support for latency based cgroup IO protection"
	depends on BLK_CGROUP
	help
	Enabling this option enables the .latency interface for IO throttling.
	The IO controller will attempt to maintain average IO latencies below
	the configured latency target, throttling anybody with a higher latency
	target than the victimized group.

	Note, this is an experimental interface and could be changed someday.

config BLK_CGROUP_FC_APPID
	bool "Enable support to track FC I/O Traffic across cgroup applications"
	depends on BLK_CGROUP && NVME_FC
	help
	  Enabling this option enables the support to track FC I/O traffic across
	  cgroup applications. It enables the Fabric and the storage targets to
	  identify, monitor, and handle FC traffic based on VM tags by inserting
	  application specific identification into the FC frame.

config BLK_CGROUP_IOCOST
	bool "Enable support for cost model based cgroup IO controller"
	depends on BLK_CGROUP
	select BLK_RQ_ALLOC_TIME
	help
	Enabling this option enables the .weight interface for cost
	model based proportional IO control.  The IO controller
	distributes IO capacity between different groups based on
	their share of the overall weight distribution.

config BLK_CGROUP_IOPRIO
	bool "Cgroup I/O controller for assigning an I/O priority class"
	depends on BLK_CGROUP
	help
	Enable the .prio interface for assigning an I/O priority class to
	requests. The I/O priority class affects the order in which an I/O
	scheduler and block devices process requests. Only some I/O schedulers
	and some block devices support I/O priorities.

config BLK_DEBUG_FS
	bool "Block layer debugging information in debugfs"
	default y
	depends on DEBUG_FS
	help
	Include block layer debugging information in debugfs. This information
	is mostly useful for kernel developers, but it doesn't incur any cost
	at runtime.

	Unless you are building a kernel for a tiny system, you should
	say Y here.

config BLK_DEBUG_FS_ZONED
       bool
       default BLK_DEBUG_FS && BLK_DEV_ZONED

config BLK_SED_OPAL
	bool "Logic for interfacing with Opal enabled SEDs"
	help
	Builds Logic for interfacing with Opal enabled controllers.
	Enabling this option enables users to setup/unlock/lock
	Locking ranges for SED devices using the Opal protocol.

config BLK_INLINE_ENCRYPTION
	bool "Enable inline encryption support in block layer"
	help
	  Build the blk-crypto subsystem. Enabling this lets the
	  block layer handle encryption, so users can take
	  advantage of inline encryption hardware if present.

config BLK_INLINE_ENCRYPTION_FALLBACK
	bool "Enable crypto API fallback for blk-crypto"
	depends on BLK_INLINE_ENCRYPTION
	select CRYPTO
	select CRYPTO_SKCIPHER
	help
	  Enabling this lets the block layer handle inline encryption
	  by falling back to the kernel crypto API when inline
	  encryption hardware is not present.

source "block/partitions/Kconfig"

config BLK_MQ_PCI
	def_bool PCI

config BLK_MQ_VIRTIO
	bool
	depends on VIRTIO
	default y

config BLK_PM
	def_bool PM

# do not use in new code
config BLOCK_HOLDER_DEPRECATED
	bool

config BLK_MQ_STACKING
	bool

source "block/Kconfig.iosched"

endif # BLOCK
Commit	Line	Data
	1	# SPDX-License-Identifier: GPL-2.0
	2	#
	3	# Block layer core configuration
	4	#
	5	menuconfig BLOCK
	6	bool "Enable the block layer" if EXPERT
	7	default y
	8	select SBITMAP
	9	help
	10	Provide block layer support for the kernel.
	11
	12	Disable this option to remove the block layer support from the
	13	kernel. This may be useful for embedded devices.
	14
	15	If this option is disabled:
	16
	17	- block device files will become unusable
	18	- some filesystems (such as ext3) will become unavailable.
	19
	20	Also, SCSI character devices and USB storage will be disabled since
	21	they make use of various block layer definitions and facilities.
	22
	23	Say Y here unless you know you really don't want to mount disks and
	24	suchlike.
	25
	26	if BLOCK
	27
	28	config BLOCK_LEGACY_AUTOLOAD
	29	bool "Legacy autoloading support"
	30	default y
	31	help
	32	Enable loading modules and creating block device instances based on
	33	accesses through their device special file. This is a historic Linux
	34	feature and makes no sense in a udev world where device files are
	35	created on demand, but scripts that manually create device nodes and
	36	then call losetup might rely on this behavior.
	37
	38	config BLK_RQ_ALLOC_TIME
	39	bool
	40
	41	config BLK_CGROUP_RWSTAT
	42	bool
	43
	44	config BLK_CGROUP_PUNT_BIO
	45	bool
	46
	47	config BLK_DEV_BSG_COMMON
	48	tristate
	49
	50	config BLK_ICQ
	51	bool
	52
	53	config BLK_DEV_BSGLIB
	54	bool "Block layer SG support v4 helper lib"
	55	select BLK_DEV_BSG_COMMON
	56	help
	57	Subsystems will normally enable this if needed. Users will not
	58	normally need to manually enable this.
	59
	60	If unsure, say N.
	61
	62	config BLK_DEV_INTEGRITY
	63	bool "Block layer data integrity support"
	64	help
	65	Some storage devices allow extra information to be
	66	stored/retrieved to help protect the data. The block layer
	67	data integrity option provides hooks which can be used by
	68	filesystems to ensure better data integrity.
	69
	70	Say yes here if you have a storage device that provides the
	71	T10/SCSI Data Integrity Field or the T13/ATA External Path
	72	Protection. If in doubt, say N.
	73
	74	config BLK_DEV_INTEGRITY_T10
	75	tristate
	76	depends on BLK_DEV_INTEGRITY
	77	select CRC_T10DIF
	78	select CRC64_ROCKSOFT
	79
	80	config BLK_DEV_ZONED
	81	bool "Zoned block device support"
	82	select MQ_IOSCHED_DEADLINE
	83	help
	84	Block layer zoned block device support. This option enables
	85	support for ZAC/ZBC/ZNS host-managed and host-aware zoned block
	86	devices.
	87
	88	Say yes here if you have a ZAC, ZBC, or ZNS storage device.
	89
	90	config BLK_DEV_THROTTLING
	91	bool "Block layer bio throttling support"
	92	depends on BLK_CGROUP
	93	select BLK_CGROUP_RWSTAT
	94	help
	95	Block layer bio throttling support. It can be used to limit
	96	the IO rate to a device. IO rate policies are per cgroup and
	97	one needs to mount and use blkio cgroup controller for creating
	98	cgroups and specifying per device IO rate policies.
	99
	100	See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information.
	101
	102	config BLK_DEV_THROTTLING_LOW
	103	bool "Block throttling .low limit interface support (EXPERIMENTAL)"
	104	depends on BLK_DEV_THROTTLING
	105	help
	106	Add .low limit interface for block throttling. The low limit is a best
	107	effort limit to prioritize cgroups. Depending on the setting, the limit
	108	can be used to protect cgroups in terms of bandwidth/iops and better
	109	utilize disk resource.
	110
	111	Note, this is an experimental interface and could be changed someday.
	112
	113	config BLK_WBT
	114	bool "Enable support for block device writeback throttling"
	115	help
	116	Enabling this option enables the block layer to throttle buffered
	117	background writeback from the VM, making it more smooth and having
	118	less impact on foreground operations. The throttling is done
	119	dynamically on an algorithm loosely based on CoDel, factoring in
	120	the realtime performance of the disk.
	121
	122	config BLK_WBT_MQ
	123	bool "Enable writeback throttling by default"
	124	default y
	125	depends on BLK_WBT
	126	help
	127	Enable writeback throttling by default for request-based block devices.
	128
	129	config BLK_CGROUP_IOLATENCY
	130	bool "Enable support for latency based cgroup IO protection"
	131	depends on BLK_CGROUP
	132	help
	133	Enabling this option enables the .latency interface for IO throttling.
	134	The IO controller will attempt to maintain average IO latencies below
	135	the configured latency target, throttling anybody with a higher latency
	136	target than the victimized group.
	137
	138	Note, this is an experimental interface and could be changed someday.
	139
	140	config BLK_CGROUP_FC_APPID
	141	bool "Enable support to track FC I/O Traffic across cgroup applications"
	142	depends on BLK_CGROUP && NVME_FC
	143	help
	144	Enabling this option enables the support to track FC I/O traffic across
	145	cgroup applications. It enables the Fabric and the storage targets to
	146	identify, monitor, and handle FC traffic based on VM tags by inserting
	147	application specific identification into the FC frame.
	148
	149	config BLK_CGROUP_IOCOST
	150	bool "Enable support for cost model based cgroup IO controller"
	151	depends on BLK_CGROUP
	152	select BLK_RQ_ALLOC_TIME
	153	help
	154	Enabling this option enables the .weight interface for cost
	155	model based proportional IO control. The IO controller
	156	distributes IO capacity between different groups based on
	157	their share of the overall weight distribution.
	158
	159	config BLK_CGROUP_IOPRIO
	160	bool "Cgroup I/O controller for assigning an I/O priority class"
	161	depends on BLK_CGROUP
	162	help
	163	Enable the .prio interface for assigning an I/O priority class to
	164	requests. The I/O priority class affects the order in which an I/O
	165	scheduler and block devices process requests. Only some I/O schedulers
	166	and some block devices support I/O priorities.
	167
	168	config BLK_DEBUG_FS
	169	bool "Block layer debugging information in debugfs"
	170	default y
	171	depends on DEBUG_FS
	172	help
	173	Include block layer debugging information in debugfs. This information
	174	is mostly useful for kernel developers, but it doesn't incur any cost
	175	at runtime.
	176
	177	Unless you are building a kernel for a tiny system, you should
	178	say Y here.
	179
	180	config BLK_DEBUG_FS_ZONED
	181	bool
	182	default BLK_DEBUG_FS && BLK_DEV_ZONED
	183
	184	config BLK_SED_OPAL
	185	bool "Logic for interfacing with Opal enabled SEDs"
	186	help
	187	Builds Logic for interfacing with Opal enabled controllers.
	188	Enabling this option enables users to setup/unlock/lock
	189	Locking ranges for SED devices using the Opal protocol.
	190
	191	config BLK_INLINE_ENCRYPTION
	192	bool "Enable inline encryption support in block layer"
	193	help
	194	Build the blk-crypto subsystem. Enabling this lets the
	195	block layer handle encryption, so users can take
	196	advantage of inline encryption hardware if present.
	197
	198	config BLK_INLINE_ENCRYPTION_FALLBACK
	199	bool "Enable crypto API fallback for blk-crypto"
	200	depends on BLK_INLINE_ENCRYPTION
	201	select CRYPTO
	202	select CRYPTO_SKCIPHER
	203	help
	204	Enabling this lets the block layer handle inline encryption
	205	by falling back to the kernel crypto API when inline
	206	encryption hardware is not present.
	207
	208	source "block/partitions/Kconfig"
	209
	210	config BLK_MQ_PCI
	211	def_bool PCI
	212
	213	config BLK_MQ_VIRTIO
	214	bool
	215	depends on VIRTIO
	216	default y
	217
	218	config BLK_PM
	219	def_bool PM
	220
	221	# do not use in new code
	222	config BLOCK_HOLDER_DEPRECATED
	223	bool
	224
	225	config BLK_MQ_STACKING
	226	bool
	227
	228	source "block/Kconfig.iosched"
	229
	230	endif # BLOCK