net: Get rid of 'vlan'
v3 cover net: Get rid of 'vlan'
The 'vlan' term caused a lot of confusion and misconfigurations in the past. The parameter has been marked as deprecated since QEMU v2.9.0, so it's now time to finally remove the parameter and use the better word "hub" in the remaining spots that actually mean the QEMU emulated hub feature.
v3:
- Some rewordings in qemu-doc and net.json according to Paolo's suggestions
v2:
- Added first patch to actually remove the deprecated 'vlan' parameter (instead of only updating the wording in the sources and docs)
Thomas Huth (3):
net: Remove the deprecated "vlan" parameter
net: Get rid of 'vlan' terminology and use 'hub' instead in the source
files
net: Get rid of 'vlan' terminology and use 'hub' instead in the doc
files
docs/qdev-device-use.txt | 3 -- hw/core/qdev-properties-system.c | 80 ---------------------------------------- include/hw/qdev-properties.h | 3 -- include/net/net.h | 1 - net/hub.c | 7 ++-- net/net.c | 12 ++---- net/slirp.c | 8 ++-- net/tap.c | 4 +- qapi/net.json | 15 ++++---- qemu-doc.texi | 51 ++++++++++++------------- qemu-options.hx | 29 ++++++--------- 11 files changed, 54 insertions(+), 159 deletions(-)
Signature · 1 line
1.8.3.1
PATCH v3 1/3 net: Remove the deprecated "vlan" parameter
It's been marked as deprecated since QEMU v2.9.0, so that should have been enough time for everybody to either just drop unnecessary "vlan=0" parameters, to switch to the modern -device + -netdev syntax for connecting guest NICs with host network backends, or to switch to the "hubport" netdev in case hubs are really wanted instead.
--- docs/qdev-device-use.txt | 3 -- hw/core/qdev-properties-system.c | 80 ---------------------------------------- include/hw/qdev-properties.h | 3 -- include/net/net.h | 1 - net/net.c | 12 ++---- qapi/net.json | 15 ++++---- qemu-doc.texi | 9 ----- qemu-options.hx | 29 ++++++--------- 8 files changed, 22 insertions(+), 130 deletions(-)
docs/qdev-device-use.txt +0 -3
@@ -277,9 +277,6 @@ devices and ne2k_isa are. Some PCI devices aren't available with -net nic, e.g. i82558a. -To connect to a VLAN instead of an ordinary host part, replace -netdev=NET-ID by vlan=VLAN. - === Graphics Devices === Host and guest part of graphics devices have always been separate.
hw/core/qdev-properties-system.c +0 -80
86 lines not on this page · raw message
include/hw/qdev-properties.h +0 -3
@@ -29,7 +29,6 @@ extern const PropertyInfo qdev_prop_bios_chs_trans;extern const PropertyInfo qdev_prop_fdc_drive_type;extern const PropertyInfo qdev_prop_drive;extern const PropertyInfo qdev_prop_netdev; -extern const PropertyInfo qdev_prop_vlan;extern const PropertyInfo qdev_prop_pci_devfn;extern const PropertyInfo qdev_prop_blocksize;extern const PropertyInfo qdev_prop_pci_host_devaddr;
@@ -195,8 +194,6 @@ extern const PropertyInfo qdev_prop_off_auto_pcibar; DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*) #define DEFINE_PROP_NETDEV(_n, _s, _f) \DEFINE_PROP (_n, _s, _f, qdev_prop_netdev, NICPeers) -#define DEFINE_PROP_VLAN(_n, _s, _f) \ - DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, NICPeers) #define DEFINE_PROP_DRIVE(_n, _s, _f) \ DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockBackend *) #define DEFINE_PROP_MACADDR(_n, _s, _f) \
include/net/net.h +0 -1
@@ -37,7 +37,6 @@ typedef struct NICConf {#define DEFINE_NIC_PROPERTIES (_state, _conf) \ DEFINE_PROP_MACADDR("mac", _state, _conf.macaddr), \ - DEFINE_PROP_VLAN("vlan", _state, _conf.peers), \ DEFINE_PROP_NETDEV("netdev", _state, _conf.peers)
net/net.c +3 -9
@@ -965,7 +965,6 @@ static int net_client_init1(const void *object, bool is_netdev, Error **errp)const Netdev *netdev;const char *name;NetClientState *peer =NULL ; -static bool vlan_warned;if (is_netdev) { netdev = object;
@@ -1036,15 +1035,10 @@ static int net_client_init1(const void *object, bool is_netdev, Error **errp)return -1 ; } -/* Do not add to a vlan if it's a nic with a netdev= parameter. */ +/* Do not add to a hub if it's a nic with a netdev= parameter. */ if (netdev->type !=NET_CLIENT_DRIVER_NIC || !opts->u.nic.has_netdev) { - peer =net_hub_add_port (net->has_vlan ? net->vlan :0 ,NULL ,NULL ); - } - -if (net->has_vlan && !vlan_warned) { -error_report ("'vlan' is deprecated. Please use 'netdev' instead." ); - vlan_warned = true; + peer =net_hub_add_port (0 ,NULL ,NULL ); } }
@@ -1365,7 +1359,7 @@ void qmp_set_link(const char *name, bool up, Error **errp)* If the peer is a HUBPORT or a backend, we do not change the * link status. * -* This behavior is compatible with qemu vlans where there could be +* This behavior is compatible with qemu hubs where there could be * multiple clients that can still communicate with each other in * disconnected mode. For now maintain this compatibility. */
qapi/net.json +7 -8
@@ -209,7 +209,7 @@ ## # @NetdevTapOptions: # -# Connect the host TAP network interface name to the VLAN. +# Used to configure a host TAP network interface backend. # # @ifname: interface name #
@@ -267,8 +267,8 @@ ## # @NetdevSocketOptions: # -# Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP -# socket connection. +# Socket netdevs are used to establish a network connection to another +# QEMU virtual machine via a TCP socket. # # @fd: file descriptor of an already opened socket #
@@ -296,7 +296,7 @@ ## # @NetdevL2TPv3Options: # -# Connect the VLAN to Ethernet over L2TPv3 Static tunnel +# Configure an Ethernet over L2TPv3 tunnel. # # @src: source address #
@@ -352,7 +352,7 @@ ## # @NetdevVdeOptions: # -# Connect the VLAN to a vde switch running on the host. +# Connect to a vde switch running on the host. # # @sock: socket path #
@@ -490,8 +490,6 @@ # # Captures the configuration of a network device; legacy. # -# @vlan: vlan number -# # @id: identifier for monitor commands # # @name: identifier for monitor commands, ignored if @id is present
@@ -499,10 +497,11 @@ # @opts: device type specific properties (legacy) # # Since: 1.2 +# +# 'vlan' - removed with 2.12 ## { 'struct': 'NetLegacy', 'data': { - '*vlan': 'int32', '*id': 'str', '*name': 'str', 'opts': 'NetLegacyOptions' } }
qemu-doc.texi +0 -9
@@ -2855,15 +2855,6 @@ with ``-device ...,netdev=x''), or ``-nic user,smb=/some/dir'' (for embedded NICs). The new syntax allows different settings to be provided per NIC. -@subsection -net vlan (since 2.9.0) - -The ``-net vlan=NN'' argument was mostly used to attach separate -network backends to different virtual NICs. This is the default -behavior for ``-netdev'' and ``-nic''. You can connect multiple -``-netdev'' and ``-nic'' devices to the same network using the -"hubport" network backend, created with ``-netdev hubport,hubid=NN,...'' -and ``-nic hubport,hubid=NN''. - @subsection -drive cyls=...,heads=...,secs=...,trans=... (since 2.10.0) The drive geometry arguments are replaced by the the geometry arguments
qemu-options.hx +12 -17
@@ -2003,7 +2003,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, " configure a vhost-user network, backed by a chardev 'dev'\n" #endif "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" - " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) + " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) DEF("nic", HAS_ARG, QEMU_OPTION_nic, "--nic [tap|bridge|" #ifdef CONFIG_SLIRP
@@ -2028,10 +2028,9 @@ DEF("nic", HAS_ARG, QEMU_OPTION_nic, " provided a 'user' network connection)\n", QEMU_ARCH_ALL) DEF("net", HAS_ARG, QEMU_OPTION_net, - "-net nic[,vlan=n][,netdev=nd][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" + "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" " configure or create an on-board (or machine default) NIC and\n" - " connect it either to VLAN 'n' or the netdev 'nd' (for pluggable\n" - " NICs please use '-device devtype,netdev=nd' instead)\n" + " connect it to hub 0 (please use -nic for direct connections)\n" "-net [" #ifdef CONFIG_SLIRP "user|"
@@ -2044,7 +2043,7 @@ DEF("net", HAS_ARG, QEMU_OPTION_net, #ifdef CONFIG_NETMAP "netmap|" #endif - "socket][,vlan=n][,option][,option][,...]\n" + "socket][,option][,option][,...]\n" " old way to initialize a host network interface\n" " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) STEXI
@@ -2462,17 +2461,14 @@ qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,sha Create a hub port on the emulated hub with ID @var{hubid}. The hubport netdev lets you connect a NIC to a QEMU emulated hub instead of a -single netdev. @code{-net} and @code{-device} with the parameter @option{vlan} -(deprecated), or @code{-nic hubport} can also be used to connect a -network device or a NIC to a hub. Alternatively, you can also connect the -hubport to another netdev with ID @var{nd} by using the @option{netdev=@var{nd}} -option. +single netdev. Alternatively, you can also connect the hubport to another +netdev with ID @var{nd} by using the @option{netdev=@var{nd}} option. -@item -net nic[,vlan=@var{n}][,netdev=@var{nd}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] +@item -net nic[,netdev=@var{nd}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] @findex -net Legacy option to configure or create an on-board (or machine default) Network -Interface Card(NIC) and connect it either to the emulated hub port ("vlan") -with number @var{n} (@var{n} = 0 is the default), or to the netdev @var{nd}. +Interface Card(NIC) and connect it either to the emulated hub with ID 0 (i.e. +the default hub), or to the netdev @var{nd}. The NIC is an e1000 by default on the PC target. Optionally, the MAC address can be changed to @var{mac}, the device address set to @var{addr} (PCI cards only), and a @var{name} can be assigned for use in monitor commands.
@@ -2482,11 +2478,10 @@ that the card should have; this option currently only affects virtio cards; set NIC is created. QEMU can emulate several different models of network card. Use @code{-net nic,model=help} for a list of available devices for your target. -@item -net user|tap|bridge|socket|l2tpv3|vde[,...][,vlan=@var{n}][,name=@var{name}] +@item -net user|tap|bridge|socket|l2tpv3|vde[,...][,name=@var{name}] Configure a host network backend (with the options corresponding to the same -@option{-netdev} option) and connect it to the emulated hub ("vlan") with the -number @var{n} (default is number 0). Use @var{name} to specify the name of the -hub port. +@option{-netdev} option) and connect it to the emulated hub 0 (the default +hub). Use @var{name} to specify the name of the hub port. ETEXI STEXI
Signature · 1 line
1.8.3.1
Re: [Qemu-devel] [PATCH v3 for-2.13 1/3] net: Remove the deprecated "vlan" parameter
qapi/net.json line 501
Quoted 6 lines · Thomas Huth
qapi/net.json +2
-0@@ -499,10 +497,11 @@ # @opts: device type specific properties (legacy) # # Since: 1.2 +# +# 'vlan' - removed with 2.12
Not sure how to interpret this. How about "removed in 2.13"?
qemu-options.hx DEF("nic", HAS_ARG, QEMU_OPTION_nic, · line 2033
Quoted 10 lines
qemu-options.hx +2
-3@@ -2028,10 +2028,9 @@ DEF("nic", HAS_ARG, QEMU_OPTION_nic, " provided a 'user' network connection)\n", QEMU_ARCH_ALL) DEF("net", HAS_ARG, QEMU_OPTION_net, - "-net nic[,vlan=n][,netdev=nd][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" + "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" " configure or create an on-board (or machine default) NIC and\n" - " connect it either to VLAN 'n' or the netdev 'nd' (for pluggable\n" - " NICs please use '-device devtype,netdev=nd' instead)\n" + " connect it to hub 0 (please use -nic for direct connections)\n"
What does "direct connections" means?
Re: [Qemu-devel] [PATCH v3 for-2.13 1/3] net: Remove the deprecated "vlan" parameter
Quoted 9 lines · Stefan Hajnoczi
qapi/net.json line 501
Quoted 6 lines · Thomas Huth
qapi/net.json +2
-0@@ -499,10 +497,11 @@ # @opts: device type specific properties (legacy) # # Since: 1.2 +# +# 'vlan' - removed with 2.12Not sure how to interpret this. How about "removed in 2.13"?
Sure, will change it.
Quoted 4 lines
Quoted 4 lines
qemu-options.hx +0
-0@@ -2028,10 +2028,9 @@ DEF("nic", HAS_ARG, QEMU_OPTION_nic, " provided a 'user' network connection)\n", QEMU_ARCH_ALL) DEF("net", HAS_ARG, QEMU_OPTION_net,
Quoted 8 lines
qemu-options.hx DEF("nic", HAS_ARG, QEMU_OPTION_nic, · line 2033
Quoted 6 lines
qemu-options.hx +2
-3- "-net nic[,vlan=n][,netdev=nd][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" + "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" " configure or create an on-board (or machine default) NIC and\n" - " connect it either to VLAN 'n' or the netdev 'nd' (for pluggable\n" - " NICs please use '-device devtype,netdev=nd' instead)\n" + " connect it to hub 0 (please use -nic for direct connections)\n"What does "direct connections" means?
I mean a 1:1 connection between the backend and frontend here, without a hub inbetween. Can you think of a better wording?
Thomas
Re: [Qemu-devel] [PATCH v3 for-2.13 1/3] net: Remove the deprecated "vlan" parameter
Quoted 9 lines · Thomas Huth
Quoted 7 lines
qemu-options.hx DEF("nic", HAS_ARG, QEMU_OPTION_nic, · line 2033
Quoted 6 lines
qemu-options.hx +2
-3- "-net nic[,vlan=n][,netdev=nd][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" + "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" " configure or create an on-board (or machine default) NIC and\n" - " connect it either to VLAN 'n' or the netdev 'nd' (for pluggable\n" - " NICs please use '-device devtype,netdev=nd' instead)\n" + " connect it to hub 0 (please use -nic for direct connections)\n"What does "direct connections" means?
I mean a 1:1 connection between the backend and frontend here, without a hub inbetween. Can you think of a better wording?
"use -nic unless you need a hub"?
Paolo
PATCH v3 2/3 net: Get rid of 'vlan' terminology and use 'hub' instead in the source files
In reply to Thomas Huth'vlan' is very confusing since it does not mean something like IEEE 802.1Q, but rather emulated hubs, so let's switch to that terminology instead.
--- net/hub.c | 7 +++---- net/slirp.c | 8 ++++---- net/tap.c | 4 ++-- 3 files changed, 9 insertions(+), 10 deletions(-)
net/hub.c +3 -4
@@ -23,8 +23,7 @@/* * A hub broadcasts incoming packets to all its ports except the source port. -* Hubs can be used to provide independent network segments, also confusingly -* named the QEMU 'vlan' feature. +* Hubs can be used to provide independent emulated network segments. */ typedef struct NetHub NetHub ;
@@ -345,10 +344,10 @@ void net_hub_check_clients(void) } }if (has_host_dev && !has_nic) { -warn_report ("vlan %d with no nics" , hub->id); +warn_report ("hub %d with no nics" , hub->id); }if (has_nic && !has_host_dev) { -warn_report ("vlan %d is not connected to host network" , hub->id); +warn_report ("hub %d is not connected to host network" , hub->id); } } }
net/slirp.c +4 -4
@@ -415,7 +415,7 @@ static SlirpState *slirp_lookup(Monitor *mon, const char *hub_id,if (hub_id) { nc =net_hub_find_client_by_name (strtol (hub_id,NULL ,0 ), name);if (!nc) { -monitor_printf (mon,"unrecognized (vlan-id, stackname) pair\n" ); +monitor_printf (mon,"unrecognized (hub-id, stackname) pair\n" );return NULL ; } }else {
@@ -870,9 +870,9 @@ void hmp_info_usernet(Monitor *mon, const QDict *qdict) QTAILQ_FOREACH(s, &slirp_stacks, entry) {int id; -bool got_vlan_id =net_hub_id_for_client (&s->nc, &id) ==0 ; -monitor_printf (mon,"VLAN %d (%s):\n" , - got_vlan_id ? id :-1 , +bool got_hub_id =net_hub_id_for_client (&s->nc, &id) ==0 ; +monitor_printf (mon,"Hub %d (%s):\n" , + got_hub_id ? id :-1 , s->nc.name);slirp_connection_info (s->slirp, mon); }
net/tap.c +2 -2
@@ -766,10 +766,10 @@ int net_init_tap(const Netdev *netdev, const char *name, queues = tap->has_queues ? tap->queues :1 ; vhostfdname = tap->has_vhostfd ? tap->vhostfd :NULL ; -/* QEMU vlans does not support multiqueue tap, in this case peer is set. +/* QEMU hubs do not support multiqueue tap, in this case peer is set. * For -netdev, peer is always NULL. */ if (peer && (tap->has_queues || tap->has_fds || tap->has_vhostfds)) { -error_setg (errp,"Multiqueue tap cannot be used with QEMU vlans" ); +error_setg (errp,"Multiqueue tap cannot be used with hubs" );return -1 ; }
Signature · 1 line
1.8.3.1
Re: [Qemu-devel] [PATCH v3 for-2.13 2/3] net: Get rid of 'vlan' terminology and use 'hub' instead in the source files
Quoted 11 lines · Thomas Huth
'vlan' is very confusing since it does not mean something like IEEE 802.1Q, but rather emulated hubs, so let's switch to that terminology instead.
Signed-off-by Thomas Huth <[email protected]>--- net/hub.c | 7 +++---- net/slirp.c | 8 ++++---- net/tap.c | 4 ++-- 3 files changed, 9 insertions(+), 10 deletions(-)
PATCH v3 3/3 net: Get rid of 'vlan' terminology and use 'hub' instead in the doc files
In reply to Thomas Huth'vlan' is very confusing since it does not mean something like IEEE 802.1Q, but rather emulated hubs, so let's switch to that terminology instead. While we're at it, move the subsection about hub a little bit downward in the documentation (it's not as important anymore as it was before the invention of the -netdev parameter), and extend it a little bit.
--- qemu-doc.texi | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-)
qemu-doc.texi +23 -19
@@ -714,20 +714,12 @@ state is not saved or restored properly (in particular USB). @node pcsys_network @section Network emulation -QEMU can simulate several network cards (PCI or ISA cards on the PC -target) and can connect them to an arbitrary number of Virtual Local -Area Networks (VLANs). Host TAP devices can be connected to any QEMU -VLAN. VLAN can be connected between separate instances of QEMU to -simulate large networks. For simpler usage, a non privileged user mode -network stack can replace the TAP device to have a basic network -connection. - -@subsection VLANs - -QEMU simulates several VLANs. A VLAN can be symbolised as a virtual -connection between several network devices. These devices can be for -example QEMU virtual Ethernet cards or virtual Host ethernet devices -(TAP devices). +QEMU can simulate several network cards (e.g. PCI or ISA cards on the PC +target) and can connect them to a network backend on the host or an emulated +hub. The various host network backends can either be used to connect the NIC of +the guest to a real network (e.g. by using a TAP devices or the non-privileged +user mode network stack), or to other guest instances running in another QEMU +process (e.g. by using the socket host network backend). @subsection Using TAP network interfaces
@@ -763,7 +755,7 @@ network). The virtual network configuration is the following: @example - QEMU VLAN <------> Firewall/DHCP server <-----> Internet + guest (10.0.2.15) <------> Firewall/DHCP server <-----> Internet | (10.0.2.2) | ----> DNS server (10.0.2.3)
@@ -798,11 +790,23 @@ When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP connections can be redirected from the host to the guest. It allows for example to redirect X11, telnet or SSH connections. -@subsection Connecting VLANs between QEMU instances +@subsection Hubs + +QEMU can simulate several hubs. A hub can be symbolised as a virtual connection +between several network devices. These devices can be for example QEMU virtual +ethernet cards or virtual Host ethernet devices (TAP devices). You can connect +guest NICs or host network backends to such a hub using the @option{-netdev +hubport} or @option{-nic hubport} options. The legacy @option{-net} option +also connects the given device to the emulated hub with ID 0 (i.e. the default +hub) unless you specify a netdev with @option{-net nic,netdev=xxx} here. + +@subsection Connecting emulated networks between QEMU instances -Using the @option{-net socket} option, it is possible to make VLANs -that span several QEMU instances. See @ref{sec_invocation} to have a -basic example. +Using the @option{-netdev socket} (or @option{-nic socket} or +@option{-net socket}) option, it is possible to create emulated +networks that span several QEMU instances. +See the description of the @option{-netdev socket} option in the +@ref{sec_invocation,,Invocation chapter} to have a basic example. @node pcsys_other_devs @section Other Devices
Signature · 1 line
1.8.3.1
Re: [Qemu-devel] [PATCH v3 for-2.13 3/3] net: Get rid of 'vlan' terminology and use 'hub' instead in the doc files
qemu-doc.texi When using the @option{'-netdev user,hostfwd=...'} option, TCP or UDP · line 795
Quoted 4 lines · Thomas Huth
-@subsection Connecting VLANs between QEMU instances +@subsection Hubs
qemu-doc.texi +2
-0+ +QEMU can simulate several hubs. A hub can be symbolised as a virtual connection
s/symbolised/thought of/