[thirdparty/kernel/linux.git] / fs / Kconfig.binfmt

# SPDX-License-Identifier: GPL-2.0-only

menu "Executable file formats"

config BINFMT_ELF
	bool "Kernel support for ELF binaries"
	depends on MMU
	select ELFCORE
	default y
	help
	  ELF (Executable and Linkable Format) is a format for libraries and
	  executables used across different architectures and operating
	  systems. Saying Y here will enable your kernel to run ELF binaries
	  and enlarge it by about 13 KB. ELF support under Linux has now all
	  but replaced the traditional Linux a.out formats (QMAGIC and ZMAGIC)
	  because it is portable (this does *not* mean that you will be able
	  to run executables from different architectures or operating systems
	  however) and makes building run-time libraries very easy. Many new
	  executables are distributed solely in ELF format. You definitely
	  want to say Y here.

	  Information about ELF is contained in the ELF HOWTO available from
	  <http://www.tldp.org/docs.html#howto>.

	  If you find that after upgrading from Linux kernel 1.2 and saying Y
	  here, you still can't run any ELF binaries (they just crash), then
	  you'll have to install the newest ELF runtime libraries, including
	  ld.so (check the file <file:Documentation/Changes> for location and
	  latest version).

config BINFMT_ELF_KUNIT_TEST
	bool "Build KUnit tests for ELF binary support" if !KUNIT_ALL_TESTS
	depends on KUNIT=y && BINFMT_ELF=y
	default KUNIT_ALL_TESTS
	help
	  This builds the ELF loader KUnit tests, which try to gather
	  prior bug fixes into a regression test collection. This is really
	  only needed for debugging. Note that with CONFIG_COMPAT=y, the
	  compat_binfmt_elf KUnit test is also created.

config COMPAT_BINFMT_ELF
	def_bool y
	depends on COMPAT && BINFMT_ELF
	select ELFCORE

config ARCH_BINFMT_ELF_STATE
	bool

config ARCH_BINFMT_ELF_EXTRA_PHDRS
	bool

config ARCH_HAVE_ELF_PROT
	bool

config ARCH_USE_GNU_PROPERTY
	bool

config BINFMT_ELF_FDPIC
	bool "Kernel support for FDPIC ELF binaries"
	default y if !BINFMT_ELF
	depends on ARM || ((M68K || RISCV || SUPERH || XTENSA) && !MMU)
	select ELFCORE
	help
	  ELF FDPIC binaries are based on ELF, but allow the individual load
	  segments of a binary to be located in memory independently of each
	  other. This makes this format ideal for use in environments where no
	  MMU is available as it still permits text segments to be shared,
	  even if data segments are not.

	  It is also possible to run FDPIC ELF binaries on MMU linux also.

config ELFCORE
	bool
	help
	  This option enables kernel/elfcore.o.

config CORE_DUMP_DEFAULT_ELF_HEADERS
	bool "Write ELF core dumps with partial segments"
	default y
	depends on BINFMT_ELF && ELF_CORE
	help
	  ELF core dump files describe each memory mapping of the crashed
	  process, and can contain or omit the memory contents of each one.
	  The contents of an unmodified text mapping are omitted by default.

	  For an unmodified text mapping of an ELF object, including just
	  the first page of the file in a core dump makes it possible to
	  identify the build ID bits in the file, without paying the i/o
	  cost and disk space to dump all the text.  However, versions of
	  GDB before 6.7 are confused by ELF core dump files in this format.

	  The core dump behavior can be controlled per process using
	  the /proc/PID/coredump_filter pseudo-file; this setting is
	  inherited.  See Documentation/filesystems/proc.rst for details.

	  This config option changes the default setting of coredump_filter
	  seen at boot time.  If unsure, say Y.

config BINFMT_SCRIPT
	tristate "Kernel support for scripts starting with #!"
	default y
	help
	  Say Y here if you want to execute interpreted scripts starting with
	  #! followed by the path to an interpreter.

	  You can build this support as a module; however, until that module
	  gets loaded, you cannot run scripts.  Thus, if you want to load this
	  module from an initramfs, the portion of the initramfs before loading
	  this module must consist of compiled binaries only.

	  Most systems will not boot if you say M or N here.  If unsure, say Y.

config ARCH_HAS_BINFMT_FLAT
	bool

config BINFMT_FLAT
	bool "Kernel support for flat binaries"
	depends on ARCH_HAS_BINFMT_FLAT
	help
	  Support uClinux FLAT format binaries.

config BINFMT_FLAT_ARGVP_ENVP_ON_STACK
	bool

config BINFMT_FLAT_OLD_ALWAYS_RAM
	bool

config BINFMT_FLAT_NO_DATA_START_OFFSET
	bool

config BINFMT_FLAT_OLD
	bool "Enable support for very old legacy flat binaries"
	depends on BINFMT_FLAT
	help
	  Support decade old uClinux FLAT format binaries.  Unless you know
	  you have some of those say N here.

config BINFMT_ZFLAT
	bool "Enable ZFLAT support"
	depends on BINFMT_FLAT
	select ZLIB_INFLATE
	help
	  Support FLAT format compressed binaries

config BINFMT_MISC
	tristate "Kernel support for MISC binaries"
	help
	  If you say Y here, it will be possible to plug wrapper-driven binary
	  formats into the kernel. You will like this especially when you use
	  programs that need an interpreter to run like Java, Python, .NET or
	  Emacs-Lisp. It's also useful if you often run DOS executables under
	  the Linux DOS emulator DOSEMU (read the DOSEMU-HOWTO, available from
	  <http://www.tldp.org/docs.html#howto>). Once you have
	  registered such a binary class with the kernel, you can start one of
	  those programs simply by typing in its name at a shell prompt; Linux
	  will automatically feed it to the correct interpreter.

	  You can do other nice things, too. Read the file
	  <file:Documentation/admin-guide/binfmt-misc.rst> to learn how to use this
	  feature, <file:Documentation/admin-guide/java.rst> for information about how
	  to include Java support. and <file:Documentation/admin-guide/mono.rst> for
          information about how to include Mono-based .NET support.

          To use binfmt_misc, you will need to mount it:
		mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc

	  You may say M here for module support and later load the module when
	  you have use for it; the module is called binfmt_misc. If you
	  don't know what to answer at this point, say Y.

config COREDUMP
	bool "Enable core dump support" if EXPERT
	default y
	help
	  This option enables support for performing core dumps. You almost
	  certainly want to say Y here. Not necessary on systems that never
	  need debugging or only ever run flawless code.

endmenu
Commit	Line	Data
ec8f24b7	1	# SPDX-License-Identifier: GPL-2.0-only
006477f4 CH	2
	3	menu "Executable file formats"
	4
1da177e4 LT	5	config BINFMT_ELF
1da177e4 LT	6	bool "Kernel support for ELF binaries"
a687a533	7	depends on MMU
f43edca7	8	select ELFCORE
1da177e4	9	default y
a7f7f624	10	help
1da177e4 LT	11	ELF (Executable and Linkable Format) is a format for libraries and
	12	executables used across different architectures and operating
	13	systems. Saying Y here will enable your kernel to run ELF binaries
	14	and enlarge it by about 13 KB. ELF support under Linux has now all
	15	but replaced the traditional Linux a.out formats (QMAGIC and ZMAGIC)
	16	because it is portable (this does not mean that you will be able
	17	to run executables from different architectures or operating systems
	18	however) and makes building run-time libraries very easy. Many new
	19	executables are distributed solely in ELF format. You definitely
	20	want to say Y here.
	21
	22	Information about ELF is contained in the ELF HOWTO available from
	23	<http://www.tldp.org/docs.html#howto>.
	24
	25	If you find that after upgrading from Linux kernel 1.2 and saying Y
	26	here, you still can't run any ELF binaries (they just crash), then
	27	you'll have to install the newest ELF runtime libraries, including
	28	ld.so (check the file <file:Documentation/Changes> for location and
	29	latest version).
	30
9e1a3ce0 KC	31	config BINFMT_ELF_KUNIT_TEST
	32	bool "Build KUnit tests for ELF binary support" if !KUNIT_ALL_TESTS
	33	depends on KUNIT=y && BINFMT_ELF=y
	34	default KUNIT_ALL_TESTS
	35	help
	36	This builds the ELF loader KUnit tests, which try to gather
	37	prior bug fixes into a regression test collection. This is really
	38	only needed for debugging. Note that with CONFIG_COMPAT=y, the
	39	compat_binfmt_elf KUnit test is also created.
	40
b9d36d5d	41	config COMPAT_BINFMT_ELF
41026c34	42	def_bool y
4cea5ceb	43	depends on COMPAT && BINFMT_ELF
f43edca7	44	select ELFCORE
b9d36d5d	45
774c105e PB	46	config ARCH_BINFMT_ELF_STATE
	47	bool
	48
b62a8486 CM	49	config ARCH_BINFMT_ELF_EXTRA_PHDRS
	50	bool
	51
fe0f6766 DM	52	config ARCH_HAVE_ELF_PROT
	53	bool
	54
db751e30 DM	55	config ARCH_USE_GNU_PROPERTY
	56	bool
	57
1da177e4 LT	58	config BINFMT_ELF_FDPIC
1da177e4 LT	59	bool "Kernel support for FDPIC ELF binaries"
382e67ae	60	default y if !BINFMT_ELF
9549fb35	61	depends on ARM \|\| ((M68K \|\| RISCV \|\| SUPERH \|\| XTENSA) && !MMU)
f43edca7	62	select ELFCORE
1da177e4 LT	63	help
	64	ELF FDPIC binaries are based on ELF, but allow the individual load
	65	segments of a binary to be located in memory independently of each
	66	other. This makes this format ideal for use in environments where no
	67	MMU is available as it still permits text segments to be shared,
	68	even if data segments are not.
	69
	70	It is also possible to run FDPIC ELF binaries on MMU linux also.
	71
f43edca7 RB	72	config ELFCORE
	73	bool
	74	help
	75	This option enables kernel/elfcore.o.
	76
656eb2cd RM	77	config CORE_DUMP_DEFAULT_ELF_HEADERS
656eb2cd RM	78	bool "Write ELF core dumps with partial segments"
89502155	79	default y
2d96d105	80	depends on BINFMT_ELF && ELF_CORE
656eb2cd RM	81	help
	82	ELF core dump files describe each memory mapping of the crashed
	83	process, and can contain or omit the memory contents of each one.
	84	The contents of an unmodified text mapping are omitted by default.
	85
	86	For an unmodified text mapping of an ELF object, including just
	87	the first page of the file in a core dump makes it possible to
	88	identify the build ID bits in the file, without paying the i/o
	89	cost and disk space to dump all the text. However, versions of
	90	GDB before 6.7 are confused by ELF core dump files in this format.
	91
	92	The core dump behavior can be controlled per process using
	93	the /proc/PID/coredump_filter pseudo-file; this setting is
0c1bc6b8	94	inherited. See Documentation/filesystems/proc.rst for details.
656eb2cd RM	95
656eb2cd RM	96	This config option changes the default setting of coredump_filter
89502155	97	seen at boot time. If unsure, say Y.
656eb2cd	98
2535e0d7 JT	99	config BINFMT_SCRIPT
	100	tristate "Kernel support for scripts starting with #!"
	101	default y
	102	help
	103	Say Y here if you want to execute interpreted scripts starting with
	104	#! followed by the path to an interpreter.
	105
	106	You can build this support as a module; however, until that module
	107	gets loaded, you cannot run scripts. Thus, if you want to load this
	108	module from an initramfs, the portion of the initramfs before loading
	109	this module must consist of compiled binaries only.
	110
	111	Most systems will not boot if you say M or N here. If unsure, say Y.
	112
aef0f78e CH	113	config ARCH_HAS_BINFMT_FLAT
	114	bool
	115
1da177e4	116	config BINFMT_FLAT
3202e181	117	bool "Kernel support for flat binaries"
aef0f78e	118	depends on ARCH_HAS_BINFMT_FLAT
1da177e4 LT	119	help
	120	Support uClinux FLAT format binaries.
	121
bdd15a28 CH	122	config BINFMT_FLAT_ARGVP_ENVP_ON_STACK
	123	bool
	124
1d52dca1 CH	125	config BINFMT_FLAT_OLD_ALWAYS_RAM
	126	bool
	127
04d82a6d DLM	128	config BINFMT_FLAT_NO_DATA_START_OFFSET
	129	bool
	130
cf9a566c CH	131	config BINFMT_FLAT_OLD
	132	bool "Enable support for very old legacy flat binaries"
	133	depends on BINFMT_FLAT
	134	help
	135	Support decade old uClinux FLAT format binaries. Unless you know
	136	you have some of those say N here.
	137
1da177e4 LT	138	config BINFMT_ZFLAT
	139	bool "Enable ZFLAT support"
	140	depends on BINFMT_FLAT
	141	select ZLIB_INFLATE
	142	help
	143	Support FLAT format compressed binaries
	144
1da177e4 LT	145	config BINFMT_MISC
1da177e4 LT	146	tristate "Kernel support for MISC binaries"
a7f7f624	147	help
1da177e4 LT	148	If you say Y here, it will be possible to plug wrapper-driven binary
	149	formats into the kernel. You will like this especially when you use
	150	programs that need an interpreter to run like Java, Python, .NET or
	151	Emacs-Lisp. It's also useful if you often run DOS executables under
	152	the Linux DOS emulator DOSEMU (read the DOSEMU-HOWTO, available from
	153	<http://www.tldp.org/docs.html#howto>). Once you have
	154	registered such a binary class with the kernel, you can start one of
	155	those programs simply by typing in its name at a shell prompt; Linux
	156	will automatically feed it to the correct interpreter.
	157
	158	You can do other nice things, too. Read the file
34962fb8	159	<file:Documentation/admin-guide/binfmt-misc.rst> to learn how to use this
8c27ceff MCC	160	feature, <file:Documentation/admin-guide/java.rst> for information about how
8c27ceff MCC	161	to include Java support. and <file:Documentation/admin-guide/mono.rst> for
1da177e4 LT	162	information about how to include Mono-based .NET support.
	163
	164	To use binfmt_misc, you will need to mount it:
	165	mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc
	166
	167	You may say M here for module support and later load the module when
	168	you have use for it; the module is called binfmt_misc. If you
	169	don't know what to answer at this point, say Y.
046d662f AK	170
	171	config COREDUMP
	172	bool "Enable core dump support" if EXPERT
	173	default y
	174	help
	175	This option enables support for performing core dumps. You almost
	176	certainly want to say Y here. Not necessary on systems that never
	177	need debugging or only ever run flawless code.
006477f4 CH	178
006477f4 CH	179	endmenu