[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 COMPAT_BINFMT_ELF
	bool
	depends on COMPAT && BINFMT_ELF
	select ELFCORE

config ARCH_BINFMT_ELF_STATE
	bool

config BINFMT_ELF_FDPIC
	bool "Kernel support for FDPIC ELF binaries"
	default y if !BINFMT_ELF
	depends on (ARM || (SUPERH32 && !MMU) || C6X)
	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.txt 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_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_SHARED_FLAT
	bool "Enable shared FLAT support"
	depends on BINFMT_FLAT
	help
	  Support FLAT shared libraries

config HAVE_AOUT
       def_bool n

config BINFMT_AOUT
	tristate "Kernel support for a.out and ECOFF binaries"
	depends on HAVE_AOUT
	---help---
	  A.out (Assembler.OUTput) is a set of formats for libraries and
	  executables used in the earliest versions of UNIX.  Linux used
	  the a.out formats QMAGIC and ZMAGIC until they were replaced
	  with the ELF format.

	  The conversion to ELF started in 1995.  This option is primarily
	  provided for historical interest and for the benefit of those
	  who need to run binaries from that era.

	  Most people should answer N here.  If you think you may have
	  occasional use for this format, enable module support above
	  and answer M here to compile this support as a module called
	  binfmt_aout.

	  If any crucial components of your system (such as /sbin/init
	  or /lib/ld.so) are still in a.out format, you will have to
	  say Y here.

config OSF4_COMPAT
	bool "OSF/1 v4 readv/writev compatibility"
	depends on ALPHA && BINFMT_AOUT
	help
	  Say Y if you are using OSF/1 binaries (like Netscape and Acrobat)
	  with v4 shared libraries freely available from Compaq. If you're
	  going to use shared libraries from Tru64 version 5.0 or later, say N.

config BINFMT_EM86
	tristate "Kernel support for Linux/Intel ELF binaries"
	depends on ALPHA
	---help---
	  Say Y here if you want to be able to execute Linux/Intel ELF
	  binaries just like native Alpha binaries on your Alpha machine. For
	  this to work, you need to have the emulator /usr/bin/em86 in place.

	  You can get the same functionality by saying N here and saying Y to
	  "Kernel support for MISC binaries".

	  You may answer M to compile the emulation support as a module and
	  later load the module when you want to use a Linux/Intel binary. The
	  module will be called binfmt_em86. If unsure, say Y.

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 LT	9	default y
	10	---help---
	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
b9d36d5d RM	31	config COMPAT_BINFMT_ELF
b9d36d5d RM	32	bool
4cea5ceb	33	depends on COMPAT && BINFMT_ELF
f43edca7	34	select ELFCORE
b9d36d5d	35
774c105e PB	36	config ARCH_BINFMT_ELF_STATE
	37	bool
	38
1da177e4 LT	39	config BINFMT_ELF_FDPIC
1da177e4 LT	40	bool "Kernel support for FDPIC ELF binaries"
382e67ae	41	default y if !BINFMT_ELF
a687a533	42	depends on (ARM \|\| (SUPERH32 && !MMU) \|\| C6X)
f43edca7	43	select ELFCORE
1da177e4 LT	44	help
	45	ELF FDPIC binaries are based on ELF, but allow the individual load
	46	segments of a binary to be located in memory independently of each
	47	other. This makes this format ideal for use in environments where no
	48	MMU is available as it still permits text segments to be shared,
	49	even if data segments are not.
	50
	51	It is also possible to run FDPIC ELF binaries on MMU linux also.
	52
f43edca7 RB	53	config ELFCORE
	54	bool
	55	help
	56	This option enables kernel/elfcore.o.
	57
656eb2cd RM	58	config CORE_DUMP_DEFAULT_ELF_HEADERS
656eb2cd RM	59	bool "Write ELF core dumps with partial segments"
89502155	60	default y
2d96d105	61	depends on BINFMT_ELF && ELF_CORE
656eb2cd RM	62	help
	63	ELF core dump files describe each memory mapping of the crashed
	64	process, and can contain or omit the memory contents of each one.
	65	The contents of an unmodified text mapping are omitted by default.
	66
	67	For an unmodified text mapping of an ELF object, including just
	68	the first page of the file in a core dump makes it possible to
	69	identify the build ID bits in the file, without paying the i/o
	70	cost and disk space to dump all the text. However, versions of
	71	GDB before 6.7 are confused by ELF core dump files in this format.
	72
	73	The core dump behavior can be controlled per process using
	74	the /proc/PID/coredump_filter pseudo-file; this setting is
	75	inherited. See Documentation/filesystems/proc.txt for details.
	76
	77	This config option changes the default setting of coredump_filter
89502155	78	seen at boot time. If unsure, say Y.
656eb2cd	79
2535e0d7 JT	80	config BINFMT_SCRIPT
	81	tristate "Kernel support for scripts starting with #!"
	82	default y
	83	help
	84	Say Y here if you want to execute interpreted scripts starting with
	85	#! followed by the path to an interpreter.
	86
	87	You can build this support as a module; however, until that module
	88	gets loaded, you cannot run scripts. Thus, if you want to load this
	89	module from an initramfs, the portion of the initramfs before loading
	90	this module must consist of compiled binaries only.
	91
	92	Most systems will not boot if you say M or N here. If unsure, say Y.
	93
aef0f78e CH	94	config ARCH_HAS_BINFMT_FLAT
	95	bool
	96
1da177e4	97	config BINFMT_FLAT
3202e181	98	bool "Kernel support for flat binaries"
aef0f78e	99	depends on ARCH_HAS_BINFMT_FLAT
1da177e4 LT	100	help
	101	Support uClinux FLAT format binaries.
	102
bdd15a28 CH	103	config BINFMT_FLAT_ARGVP_ENVP_ON_STACK
	104	bool
	105
1d52dca1 CH	106	config BINFMT_FLAT_OLD_ALWAYS_RAM
	107	bool
	108
cf9a566c CH	109	config BINFMT_FLAT_OLD
	110	bool "Enable support for very old legacy flat binaries"
	111	depends on BINFMT_FLAT
	112	help
	113	Support decade old uClinux FLAT format binaries. Unless you know
	114	you have some of those say N here.
	115
1da177e4 LT	116	config BINFMT_ZFLAT
	117	bool "Enable ZFLAT support"
	118	depends on BINFMT_FLAT
	119	select ZLIB_INFLATE
	120	help
	121	Support FLAT format compressed binaries
	122
	123	config BINFMT_SHARED_FLAT
	124	bool "Enable shared FLAT support"
	125	depends on BINFMT_FLAT
	126	help
	127	Support FLAT shared libraries
	128
e17c6d56 DW	129	config HAVE_AOUT
	130	def_bool n
	131
1da177e4 LT	132	config BINFMT_AOUT
1da177e4 LT	133	tristate "Kernel support for a.out and ECOFF binaries"
e17c6d56	134	depends on HAVE_AOUT
1da177e4 LT	135	---help---
	136	A.out (Assembler.OUTput) is a set of formats for libraries and
	137	executables used in the earliest versions of UNIX. Linux used
	138	the a.out formats QMAGIC and ZMAGIC until they were replaced
	139	with the ELF format.
	140
	141	The conversion to ELF started in 1995. This option is primarily
	142	provided for historical interest and for the benefit of those
	143	who need to run binaries from that era.
	144
	145	Most people should answer N here. If you think you may have
	146	occasional use for this format, enable module support above
	147	and answer M here to compile this support as a module called
	148	binfmt_aout.
	149
	150	If any crucial components of your system (such as /sbin/init
	151	or /lib/ld.so) are still in a.out format, you will have to
	152	say Y here.
	153
	154	config OSF4_COMPAT
	155	bool "OSF/1 v4 readv/writev compatibility"
	156	depends on ALPHA && BINFMT_AOUT
	157	help
	158	Say Y if you are using OSF/1 binaries (like Netscape and Acrobat)
	159	with v4 shared libraries freely available from Compaq. If you're
	160	going to use shared libraries from Tru64 version 5.0 or later, say N.
	161
	162	config BINFMT_EM86
	163	tristate "Kernel support for Linux/Intel ELF binaries"
	164	depends on ALPHA
	165	---help---
	166	Say Y here if you want to be able to execute Linux/Intel ELF
	167	binaries just like native Alpha binaries on your Alpha machine. For
	168	this to work, you need to have the emulator /usr/bin/em86 in place.
	169
	170	You can get the same functionality by saying N here and saying Y to
	171	"Kernel support for MISC binaries".
	172
	173	You may answer M to compile the emulation support as a module and
	174	later load the module when you want to use a Linux/Intel binary. The
	175	module will be called binfmt_em86. If unsure, say Y.
	176
1da177e4 LT	177	config BINFMT_MISC
	178	tristate "Kernel support for MISC binaries"
	179	---help---
	180	If you say Y here, it will be possible to plug wrapper-driven binary
	181	formats into the kernel. You will like this especially when you use
	182	programs that need an interpreter to run like Java, Python, .NET or
	183	Emacs-Lisp. It's also useful if you often run DOS executables under
	184	the Linux DOS emulator DOSEMU (read the DOSEMU-HOWTO, available from
	185	<http://www.tldp.org/docs.html#howto>). Once you have
	186	registered such a binary class with the kernel, you can start one of
	187	those programs simply by typing in its name at a shell prompt; Linux
	188	will automatically feed it to the correct interpreter.
	189
	190	You can do other nice things, too. Read the file
34962fb8	191	<file:Documentation/admin-guide/binfmt-misc.rst> to learn how to use this
8c27ceff MCC	192	feature, <file:Documentation/admin-guide/java.rst> for information about how
8c27ceff MCC	193	to include Java support. and <file:Documentation/admin-guide/mono.rst> for
1da177e4 LT	194	information about how to include Mono-based .NET support.
	195
	196	To use binfmt_misc, you will need to mount it:
	197	mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc
	198
	199	You may say M here for module support and later load the module when
	200	you have use for it; the module is called binfmt_misc. If you
	201	don't know what to answer at this point, say Y.
046d662f AK	202
	203	config COREDUMP
	204	bool "Enable core dump support" if EXPERT
	205	default y
	206	help
	207	This option enables support for performing core dumps. You almost
	208	certainly want to say Y here. Not necessary on systems that never
	209	need debugging or only ever run flawless code.
006477f4 CH	210
006477f4 CH	211	endmenu