[linux-block.git] / arch / um / Kconfig.net

# SPDX-License-Identifier: GPL-2.0

menu "UML Network Devices"
	depends on NET

# UML virtual driver
config UML_NET
	bool "Virtual network device"
	help
        While the User-Mode port cannot directly talk to any physical
        hardware devices, this choice and the following transport options
        provide one or more virtual network devices through which the UML
        kernels can talk to each other, the host, and with the host's help,
        machines on the outside world.

        For more information, including explanations of the networking and
        sample configurations, see
        <http://user-mode-linux.sourceforge.net/old/networking.html>.

        If you'd like to be able to enable networking in the User-Mode
        linux environment, say Y; otherwise say N.  Note that you must
        enable at least one of the following transport options to actually
        make use of UML networking.

config UML_NET_ETHERTAP
	bool "Ethertap transport"
	depends on UML_NET
	help
        The Ethertap User-Mode Linux network transport allows a single
        running UML to exchange packets with its host over one of the
        host's Ethertap devices, such as /dev/tap0.  Additional running
        UMLs can use additional Ethertap devices, one per running UML.
        While the UML believes it's on a (multi-device, broadcast) virtual
        Ethernet network, it's in fact communicating over a point-to-point
        link with the host.

        To use this, your host kernel must have support for Ethertap
        devices.  Also, if your host kernel is 2.4.x, it must have
        CONFIG_NETLINK_DEV configured as Y or M.

        For more information, see
        <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
        has examples of the UML command line to use to enable Ethertap
        networking.

        If you'd like to set up an IP network with the host and/or the
        outside world, say Y to this, the Daemon Transport and/or the
        Slip Transport.  You'll need at least one of them, but may choose
        more than one without conflict.  If you don't need UML networking,
        say N.

config UML_NET_TUNTAP
	bool "TUN/TAP transport"
	depends on UML_NET
	help
        The UML TUN/TAP network transport allows a UML instance to exchange
        packets with the host over a TUN/TAP device.  This option will only
        work with a 2.4 host, unless you've applied the TUN/TAP patch to
        your 2.2 host kernel.

        To use this transport, your host kernel must have support for TUN/TAP
        devices, either built-in or as a module.

config UML_NET_SLIP
	bool "SLIP transport"
	depends on UML_NET
	help
        The slip User-Mode Linux network transport allows a running UML to
        network with its host over a point-to-point link.  Unlike Ethertap,
        which can carry any Ethernet frame (and hence even non-IP packets),
        the slip transport can only carry IP packets.

        To use this, your host must support slip devices.

        For more information, see
        <http://user-mode-linux.sourceforge.net/old/networking.html>.
        has examples of the UML command line to use to enable slip
        networking, and details of a few quirks with it.

        The Ethertap Transport is preferred over slip because of its
        limitations.  If you prefer slip, however, say Y here.  Otherwise
        choose the Multicast transport (to network multiple UMLs on
        multiple hosts), Ethertap (to network with the host and the
        outside world), and/or the Daemon transport (to network multiple
        UMLs on a single host).  You may choose more than one without
        conflict.  If you don't need UML networking, say N.

config UML_NET_DAEMON
	bool "Daemon transport"
	depends on UML_NET
	help
        This User-Mode Linux network transport allows one or more running
        UMLs on a single host to communicate with each other, but not to
        the host.

        To use this form of networking, you'll need to run the UML
        networking daemon on the host.

        For more information, see
        <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
        has examples of the UML command line to use to enable Daemon
        networking.

        If you'd like to set up a network with other UMLs on a single host,
        say Y.  If you need a network between UMLs on multiple physical
        hosts, choose the Multicast Transport.  To set up a network with
        the host and/or other IP machines, say Y to the Ethertap or Slip
        transports.  You'll need at least one of them, but may choose
        more than one without conflict.  If you don't need UML networking,
        say N.

config UML_NET_VDE
	bool "VDE transport"
	depends on UML_NET
	help
	This User-Mode Linux network transport allows one or more running
	UMLs on a single host to communicate with each other and also
	with the rest of the world using Virtual Distributed Ethernet,
	an improved fork of uml_switch.

	You must have libvdeplug installed in order to build the vde
	transport into UML.

	To use this form of networking, you will need to run vde_switch
	on the host.

	For more information, see <http://wiki.virtualsquare.org/>
	That site has a good overview of what VDE is and also examples
	of the UML command line to use to enable VDE networking.

	If you need UML networking with VDE,
	say Y.

config UML_NET_MCAST
	bool "Multicast transport"
	depends on UML_NET
	help
        This Multicast User-Mode Linux network transport allows multiple
        UMLs (even ones running on different host machines!) to talk to
        each other over a virtual ethernet network.  However, it requires
        at least one UML with one of the other transports to act as a
        bridge if any of them need to be able to talk to their hosts or any
        other IP machines.

        To use this, your host kernel(s) must support IP Multicasting.

        For more information, see
        <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
        has examples of the UML command line to use to enable Multicast
        networking, and notes about the security of this approach.

        If you need UMLs on multiple physical hosts to communicate as if
        they shared an Ethernet network, say Y.  If you need to communicate
        with other IP machines, make sure you select one of the other
        transports (possibly in addition to Multicast; they're not
        exclusive).  If you don't need to network UMLs say N to each of
        the transports.

config UML_NET_PCAP
	bool "pcap transport"
	depends on UML_NET
	help
	The pcap transport makes a pcap packet stream on the host look
	like an ethernet device inside UML.  This is useful for making
	UML act as a network monitor for the host.  You must have libcap
	installed in order to build the pcap transport into UML.

        For more information, see
        <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
        has examples of the UML command line to use to enable this option.

	If you intend to use UML as a network monitor for the host, say
	Y here.  Otherwise, say N.

config UML_NET_SLIRP
	bool "SLiRP transport"
	depends on UML_NET
	help
        The SLiRP User-Mode Linux network transport allows a running UML
        to network by invoking a program that can handle SLIP encapsulated
        packets.  This is commonly (but not limited to) the application
        known as SLiRP, a program that can re-socket IP packets back onto
        the host on which it is run.  Only IP packets are supported,
        unlike other network transports that can handle all Ethernet
        frames.  In general, slirp allows the UML the same IP connectivity
        to the outside world that the host user is permitted, and unlike
        other transports, SLiRP works without the need of root level
        privleges, setuid binaries, or SLIP devices on the host.  This
        also means not every type of connection is possible, but most
        situations can be accommodated with carefully crafted slirp
        commands that can be passed along as part of the network device's
        setup string.  The effect of this transport on the UML is similar
        that of a host behind a firewall that masquerades all network
        connections passing through it (but is less secure).

        To use this you should first have slirp compiled somewhere
        accessible on the host, and have read its documentation.  If you
        don't need UML networking, say N.

        Startup example: "eth0=slirp,FE:FD:01:02:03:04,/usr/local/bin/slirp"

endmenu
Commit	Line	Data
b2441318	1	# SPDX-License-Identifier: GPL-2.0
1da177e4 LT	2
	3	menu "UML Network Devices"
	4	depends on NET
	5
	6	# UML virtual driver
	7	config UML_NET
	8	bool "Virtual network device"
	9	help
	10	While the User-Mode port cannot directly talk to any physical
	11	hardware devices, this choice and the following transport options
	12	provide one or more virtual network devices through which the UML
	13	kernels can talk to each other, the host, and with the host's help,
	14	machines on the outside world.
	15
	16	For more information, including explanations of the networking and
	17	sample configurations, see
0ba9d3f9	18	<http://user-mode-linux.sourceforge.net/old/networking.html>.
1da177e4 LT	19
	20	If you'd like to be able to enable networking in the User-Mode
	21	linux environment, say Y; otherwise say N. Note that you must
	22	enable at least one of the following transport options to actually
	23	make use of UML networking.
	24
	25	config UML_NET_ETHERTAP
	26	bool "Ethertap transport"
	27	depends on UML_NET
	28	help
	29	The Ethertap User-Mode Linux network transport allows a single
	30	running UML to exchange packets with its host over one of the
	31	host's Ethertap devices, such as /dev/tap0. Additional running
	32	UMLs can use additional Ethertap devices, one per running UML.
	33	While the UML believes it's on a (multi-device, broadcast) virtual
	34	Ethernet network, it's in fact communicating over a point-to-point
	35	link with the host.
	36
	37	To use this, your host kernel must have support for Ethertap
08b178eb	38	devices. Also, if your host kernel is 2.4.x, it must have
1da177e4 LT	39	CONFIG_NETLINK_DEV configured as Y or M.
	40
	41	For more information, see
0ba9d3f9	42	<http://user-mode-linux.sourceforge.net/old/networking.html> That site
1da177e4 LT	43	has examples of the UML command line to use to enable Ethertap
	44	networking.
	45
	46	If you'd like to set up an IP network with the host and/or the
08b178eb	47	outside world, say Y to this, the Daemon Transport and/or the
1da177e4 LT	48	Slip Transport. You'll need at least one of them, but may choose
	49	more than one without conflict. If you don't need UML networking,
	50	say N.
	51
	52	config UML_NET_TUNTAP
	53	bool "TUN/TAP transport"
	54	depends on UML_NET
	55	help
	56	The UML TUN/TAP network transport allows a UML instance to exchange
	57	packets with the host over a TUN/TAP device. This option will only
	58	work with a 2.4 host, unless you've applied the TUN/TAP patch to
	59	your 2.2 host kernel.
	60
	61	To use this transport, your host kernel must have support for TUN/TAP
	62	devices, either built-in or as a module.
	63
	64	config UML_NET_SLIP
	65	bool "SLIP transport"
	66	depends on UML_NET
	67	help
	68	The slip User-Mode Linux network transport allows a running UML to
	69	network with its host over a point-to-point link. Unlike Ethertap,
	70	which can carry any Ethernet frame (and hence even non-IP packets),
	71	the slip transport can only carry IP packets.
	72
	73	To use this, your host must support slip devices.
	74
	75	For more information, see
0ba9d3f9	76	<http://user-mode-linux.sourceforge.net/old/networking.html>.
1da177e4 LT	77	has examples of the UML command line to use to enable slip
	78	networking, and details of a few quirks with it.
	79
	80	The Ethertap Transport is preferred over slip because of its
	81	limitations. If you prefer slip, however, say Y here. Otherwise
08b178eb	82	choose the Multicast transport (to network multiple UMLs on
1da177e4 LT	83	multiple hosts), Ethertap (to network with the host and the
	84	outside world), and/or the Daemon transport (to network multiple
	85	UMLs on a single host). You may choose more than one without
	86	conflict. If you don't need UML networking, say N.
	87
	88	config UML_NET_DAEMON
	89	bool "Daemon transport"
	90	depends on UML_NET
	91	help
	92	This User-Mode Linux network transport allows one or more running
	93	UMLs on a single host to communicate with each other, but not to
	94	the host.
	95
	96	To use this form of networking, you'll need to run the UML
	97	networking daemon on the host.
	98
	99	For more information, see
0ba9d3f9	100	<http://user-mode-linux.sourceforge.net/old/networking.html> That site
1da177e4 LT	101	has examples of the UML command line to use to enable Daemon
	102	networking.
	103
	104	If you'd like to set up a network with other UMLs on a single host,
	105	say Y. If you need a network between UMLs on multiple physical
	106	hosts, choose the Multicast Transport. To set up a network with
	107	the host and/or other IP machines, say Y to the Ethertap or Slip
	108	transports. You'll need at least one of them, but may choose
	109	more than one without conflict. If you don't need UML networking,
	110	say N.
	111
ad43c356 JD	112	config UML_NET_VDE
	113	bool "VDE transport"
	114	depends on UML_NET
	115	help
	116	This User-Mode Linux network transport allows one or more running
	117	UMLs on a single host to communicate with each other and also
	118	with the rest of the world using Virtual Distributed Ethernet,
	119	an improved fork of uml_switch.
	120
	121	You must have libvdeplug installed in order to build the vde
	122	transport into UML.
	123
	124	To use this form of networking, you will need to run vde_switch
	125	on the host.
	126
	127	For more information, see <http://wiki.virtualsquare.org/>
	128	That site has a good overview of what VDE is and also examples
	129	of the UML command line to use to enable VDE networking.
	130
	131	If you need UML networking with VDE,
	132	say Y.
	133
1da177e4 LT	134	config UML_NET_MCAST
	135	bool "Multicast transport"
	136	depends on UML_NET
	137	help
	138	This Multicast User-Mode Linux network transport allows multiple
	139	UMLs (even ones running on different host machines!) to talk to
	140	each other over a virtual ethernet network. However, it requires
	141	at least one UML with one of the other transports to act as a
	142	bridge if any of them need to be able to talk to their hosts or any
	143	other IP machines.
	144
	145	To use this, your host kernel(s) must support IP Multicasting.
	146
	147	For more information, see
0ba9d3f9	148	<http://user-mode-linux.sourceforge.net/old/networking.html> That site
1da177e4 LT	149	has examples of the UML command line to use to enable Multicast
	150	networking, and notes about the security of this approach.
	151
	152	If you need UMLs on multiple physical hosts to communicate as if
	153	they shared an Ethernet network, say Y. If you need to communicate
	154	with other IP machines, make sure you select one of the other
	155	transports (possibly in addition to Multicast; they're not
	156	exclusive). If you don't need to network UMLs say N to each of
	157	the transports.
	158
	159	config UML_NET_PCAP
	160	bool "pcap transport"
75dacf5d	161	depends on UML_NET
1da177e4 LT	162	help
1da177e4 LT	163	The pcap transport makes a pcap packet stream on the host look
08b178eb	164	like an ethernet device inside UML. This is useful for making
1da177e4 LT	165	UML act as a network monitor for the host. You must have libcap
	166	installed in order to build the pcap transport into UML.
	167
	168	For more information, see
0ba9d3f9	169	<http://user-mode-linux.sourceforge.net/old/networking.html> That site
1da177e4 LT	170	has examples of the UML command line to use to enable this option.
	171
	172	If you intend to use UML as a network monitor for the host, say
	173	Y here. Otherwise, say N.
	174
	175	config UML_NET_SLIRP
	176	bool "SLiRP transport"
	177	depends on UML_NET
	178	help
	179	The SLiRP User-Mode Linux network transport allows a running UML
	180	to network by invoking a program that can handle SLIP encapsulated
	181	packets. This is commonly (but not limited to) the application
	182	known as SLiRP, a program that can re-socket IP packets back onto
	183	the host on which it is run. Only IP packets are supported,
	184	unlike other network transports that can handle all Ethernet
	185	frames. In general, slirp allows the UML the same IP connectivity
	186	to the outside world that the host user is permitted, and unlike
	187	other transports, SLiRP works without the need of root level
	188	privleges, setuid binaries, or SLIP devices on the host. This
	189	also means not every type of connection is possible, but most
25985edc	190	situations can be accommodated with carefully crafted slirp
1da177e4 LT	191	commands that can be passed along as part of the network device's
	192	setup string. The effect of this transport on the UML is similar
	193	that of a host behind a firewall that masquerades all network
	194	connections passing through it (but is less secure).
08b178eb	195
1da177e4 LT	196	To use this you should first have slirp compiled somewhere
	197	accessible on the host, and have read its documentation. If you
	198	don't need UML networking, say N.
08b178eb	199
1da177e4 LT	200	Startup example: "eth0=slirp,FE:FD:01:02:03:04,/usr/local/bin/slirp"
	201
	202	endmenu
	203