diff options
authorbellard <bellard@c046a42c-6fe2-441c-8c8c-71466251a162>2005-11-15 23:02:53 +0000
committerbellard <bellard@c046a42c-6fe2-441c-8c8c-71466251a162>2005-11-15 23:02:53 +0000
commit41d03949e198d4ac32cd42419e2b978fb89db461 (patch)
parent7c9d8e07e188597e570a311efc46cb1ab013e5e7 (diff)
git-svn-id: svn://svn.savannah.nongnu.org/qemu/trunk@1623 c046a42c-6fe2-441c-8c8c-71466251a162
2 files changed, 82 insertions, 38 deletions
diff --git a/Changelog b/Changelog
index 6b8420fd93..6cc8090971 100644
--- a/Changelog
+++ b/Changelog
@@ -9,6 +9,7 @@ version 0.7.3:
- Initial USB support
- Linux host serial port access
- Linux host low level parallel port access
+ - New network emulation code supporting VLANs.
version 0.7.2:
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 41b7422789..d0b0b34d1e 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -247,29 +247,56 @@ Network options:
@table @option
-@item -n script
-Set TUN/TAP network init script [default=/etc/qemu-ifup]. This script
-is launched to configure the host network interface (usually tun0)
-corresponding to the virtual NE2000 card.
+@item -net nic[,vlan=n][,macaddr=addr]
+Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
+= 0 is the default). The NIC is currently an NE2000 on the PC
+target. Optionally, the MAC address can be changed. If no
+@option{-net} option is specified, a single NIC is created.
+@item -net user[,vlan=n]
+Use the user mode network stack which requires not administrator
+priviledge to run. This is the default if no @option{-net} option is
+@item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
+Connect the host TAP network interface @var{name} to VLAN @var{n} and
+use the network script @var{file} to configure it. The default
+network script is @file{/etc/qemu-ifup}. If @var{name} is not
+provided, the OS automatically provides one. @option{fd=h} can be
+used to specify the handle of an already opened host TAP interface. Example:
-@item -nics n
+qemu linux.img -net nic -net tap
+@end example
+More complicated example (two NICs, each one connected to a TAP device)
+qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
+ -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
+@end example
-Simulate @var{n} network cards (the default is 1).
-@item -macaddr addr
+@item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
-Set the mac address of the first interface (the format is
-aa:bb:cc:dd:ee:ff in hexa). The mac address is incremented for each
-new network interface.
+Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
+machine using a TCP socket connection. If @option{listen} is
+specified, QEMU waits for incoming connections on @var{port}
+(@var{host} is optional). @option{connect} is used to connect to
+another QEMU instance using the @option{listen} option. @option{fd=h}
+specifies an already opened socket.
-@item -tun-fd fd
-Assumes @var{fd} talks to a tap/tun host network interface and use
-it. Read @url{http://bellard.org/qemu/tetrinet.html} to have an
-example of its use.
+# launch a first QEMU instance
+qemu linux.img -net nic -net socket,listen=:1234
+# connect the VLAN 0 of this instance to the VLAN 0 of the first instance
+qemu linux.img -net nic -net socket,connect=
+@end example
-@item -user-net
-Use the user mode network stack. This is the default if no tun/tap
-network init script is found.
+@item -net none
+Indicate that no network devices should be configured. It is used to
+override the default configuration which is activated if no
+@option{-net} options are provided.
@item -tftp prefix
When using the user mode network stack, activate a built-in TFTP
@@ -327,13 +354,9 @@ telnet localhost 5555
Then when you use on the host @code{telnet localhost 5555}, you
connect to the guest telnet server.
-@item -dummy-net
-Use the dummy network stack: no packet will be received by the network
@end table
-Linux boot specific. When using this options, you can use a given
+Linux boot specific: When using these options, you can use a given
Linux kernel without installing it in the disk image. It can be useful
for easier testing of various kernels.
@@ -521,7 +544,7 @@ show various information about the system state
@table @option
@item info network
-show the network state
+show the various VLANs and the associated devices
@item info block
show the block devices
@item info registers
@@ -700,36 +723,49 @@ command (or @key{C-a s} in the serial console).
@section Network emulation
-QEMU simulates up to 6 networks cards (NE2000 boards). Each card can
-be connected to a specific host network interface.
+QEMU can simulate several networks cards (NE2000 boards 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 priviledged user mode
+network stack can replace the TAP device to have a basic network
+@subsection VLANs
-@subsection Using tun/tap network interface
+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).
-This is the standard way to emulate network. QEMU adds a virtual
-network device on your host (called @code{tun0}), and you can then
-configure it as if it was a real ethernet card.
+@subsection Using TAP network interfaces
+This is the standard way to connect QEMU to a real network. QEMU adds
+a virtual network device on your host (called @code{tapN}), and you
+can then configure it as if it was a real ethernet card.
As an example, you can download the @file{linux-test-xxx.tar.gz}
archive and copy the script @file{qemu-ifup} in @file{/etc} and
configure properly @code{sudo} so that the command @code{ifconfig}
contained in @file{qemu-ifup} can be executed as root. You must verify
-that your host kernel supports the TUN/TAP network interfaces: the
+that your host kernel supports the TAP network interfaces: the
device @file{/dev/net/tun} must be present.
See @ref{direct_linux_boot} to have an example of network use with a
-Linux distribution.
+Linux distribution and @ref{sec_invocation} to have examples of
+command lines using the TAP network interfaces.
@subsection Using the user mode network stack
-By using the option @option{-user-net} or if you have no tun/tap init
-script, QEMU uses a completely user mode network stack (you don't need
-root priviledge to use the virtual network). The virtual network
-configuration is the following:
+By using the option @option{-net user} (default configuration if no
+@option{-net} option is specified), QEMU uses a completely user mode
+network stack (you don't need root priviledge to use the virtual
+network). The virtual network configuration is the following:
-QEMU Virtual Machine <------> Firewall/DHCP server <-----> Internet
- (10.0.2.x) | (
+ QEMU VLAN <------> Firewall/DHCP server <-----> Internet
+ | (
----> DNS server (
@@ -738,7 +774,8 @@ QEMU Virtual Machine <------> Firewall/DHCP server <-----> Internet
The QEMU VM behaves as if it was behind a firewall which blocks all
incoming connections. You can use a DHCP client to automatically
-configure the network in the QEMU VM.
+configure the network in the QEMU VM. The DHCP server assign addresses
+to the hosts starting from
In order to check that the user mode network is working, you can ping
the address and verify that you got an address in the range
@@ -755,6 +792,12 @@ When using the @option{-redir} 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
+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.
@node direct_linux_boot
@section Direct Linux Boot