vde-2/README

   1 VDEv2.0 : Virtual Distributed Ethernet.
   2
   3 (c) 2003/2004/2005 Renzo Davoli
   4 Long long time ago based on uml-router Copyright 2002 Yon Uriarte and Jeff Dike
   5 qemu-vde-HOWTO is (c) by Jim Brown
   6
   7 Components of the VDE architecture:
   8 - VDE switches: virtual counterpart of ethernet switches.
   9 - VDE cables: virtual counterpart of a crossed-cable used to connect two switches.
  10
  11 - VDE 2 includes:
  12 - switch management both from console and from a "unix socket terminal"
  13 - VLAN 801.1q *almost* compatible
  14 - FSTP (fast spanning tree) already incomplete and currently not tested for 802.1d/w/s
  15   compatibility. under development. (vde_switch must be compiled with the FSTP flag on)
  16
  17 Using VDE:
  18 - All units connected to the VDE see each other as they were on a real ethernet.
  19 - A real Linux box can be connected to the VDE using a tap interface (TUNTAP)
  20   (packets can be further routed using standard linux methods).
  21 - It is possible to join two VDE switches -- also running on different
  22   real conputers -- using virtual VDE cables
  23 - UML (user-mode-linux) virtual machines can be connected to the VDE
  24 - MPS (MIPS emulated machines (c) Morsiani/Davoli) can be connected
  25 to the virtual VDE.
  26
  27 Examples of VDE uses:
  28 - With VDE it is possible to create a virtual network of UML machines running
  29 on several real computer
  30 - VDE can be used to create tunnels (even crossing masquerated networks)
  31 - VDE can provide mobility support. Changing a VDE cable with another does not
  32 affect the communications in place. The new VDE cable can use a completely
  33 different path on the real net. VDE supports also multiple concurrent VDE cables
  34 between a pair of VDE-switches during the hand-off. This eliminates when possible
  35 hich-ups of communications due to hand-offs.
  36
  37 HOWTO and basic command syntax (for a complete explanation RTM):
  38
  39 vde-switch [ -unix control-socket ] [ -tap tuntap-device ] [ -hub ] [-daemon]
  40 This command creates a VDE switch.
  41 -unix control-socket
  42         The control socket is the socket used for local processes to create a new
  43         connection. The default value is /tmp/vde.ctl.
  44         User-mode-linux default value is /tmp/uml.ctl, so if you want to use vde
  45         with UML you can: (1) use "-unix /tmp/uml.ctl" for vde-switch (2) use
  46         "eth0=daemon,,/tmp/vde.ctl" for UML
  47 -tap tuntap-device
  48         the vde-switch is connected to the specified tap interface.
  49         Ususally it is reserved for root as /dev/net/tun is not writable.
  50         (It is dangerous to have /dev/net/tun writable by ordinary users).
  51 -hub
  52         the vde-switch works as a hub (all packets are broadcast on all interfaces.
  53 -daemon
  54         the switch works as a daemon: it runs in background, it uses syslog
  55         for error management.
  56
  57 vde-plug [-p port] [socketname]
  58 A vde-cable is composed by two vde-plug and a "cable". A vde-plug connects its
  59 standard input and output to a switch.
  60 socketname is the control-socket of the switch the plug must be connected to
  61 (default value /tmp/vde.ctl).
  62 -p port. To use a specific port of the switch. The first available port is
  63 assaigned when not specified. It is possibl eto connect several cables to the
  64 same prot: Cables connected to the same port represent several path
  65 for the same destination.
  66
  67 dpipe cmd1 [arg1] = cmd2 [arg2]
  68 it is the double pipe command (it is here just becouse it is not provided by
  69 shells).
  70 cmd1 and cmd2 are executed, the stdout of cmd1 if pipe connected to the stdin of
  71 cmd2 and viceversa. (the symbol = is intended as a pair of communication pipes
  72 between the two processes.
  73
  74 HOW TO:
  75 - (1) SETUP A DAEMON:
  76 (as root)
  77 # vde_switch -tap tap0 -mod 777 -daemon
  78 # ifconfig tap0 192.168.0.254
  79
  80 if you want to have routing to the Internet you can use standard routing
  81 commands on the host machine e.g.:
  82 # echo "1" > /proc/sys/net/ipv4/ip_forward
  83 # iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
  84
  85 for ipv6
  86 # echo "1" > /proc/sys/net/ipv6/conf/eth0/forwarding
  87 # radvd
  88
  89 radvd must be configured to broadcast the correct prefix for the tap0 subnet
  90
  91 ----- example of /etc/radvd.conf file
  92 interface tap0
  93 {
  94    AdvSendAdvert on;
  95    MaxRtrAdvInterval 120;
  96 #put here your prefix.
  97    prefix 1111:2222:3333:4444::/64
  98    {
  99            AdvOnLink on;
 100            AdvAutonomous on;
 101            AdvRouterAddr on;
 102
 103    };
 104 };
 105 ------ end of example
 106
 107 - (2) SETUP A SECOND DAEMON
 108 (no need for root access)
 109
 110 % vde_switch /tmp/my.ctl
 111
 112 (add - daemon if you want to run it in background)
 113
 114 - (3) CONNECT TWO LOCAL SWITCHES TOGETHER
 115
 116 % dpipe vde_plug = vde_plug /tmp/my.ctl
 117 (or
 118 % dpipe vde_plug /tmp/my.ctl = vde_plug
 119 )
 120
 121 connects the vde_switch with ctl socket /tmp/vde.ctl with the other using
 122 /tmp/my.ctl.
 123
 124 - (3) CONNECT TWO REMOTE SWITCHES TOGETHER
 125
 126 You need a tool to interconnect stdin stdout of two remote processes.
 127 e.g.
 128
 129 % dpipe vde_plug /tmp/my.ctl = ssh remote_machine vde_plug
 130
 131 connects the vde_switch with ctl socket /tmp/vde.ctl on the remote_machine
 132 with the local switch using /tmp/my.ctl.
 133
 134 It is possible to use other tools in place of ssh like netcat.
 135 In this latter case the communication is not secure.
 136
 137 - (4) CREATION OF TUNNELS.
 138 (it needs kernel support for policy routing)
 139
 140 Setup two daemon as described in (1).
 141 In this example 192.168.0.1 is the tap0 address on the server side.
 142 Route the traffic to the Internet on the tunnel server side.
 143
 144 On the tunnel client side:
 145         - in the example 100.200.201.202 is the IP address on eth0
 146         and 100.200.201.254 is the default gateway.
 147         - create a specific rule for the eth0 routing
 148                 ip rule add from 100.200.201.202 table eth0-table
 149         (please note that eth0-table must be listed in /etc/iproute2/rt_tables)
 150                 ip route del default via 100.200.201.254
 151                 ip route add default via 100.200.201.254 table eth0-table
 152         the previous default route will be the def. route just for the
 153         packets originated with the eth0 inteface address.
 154         - connect the two vde-switch together:
 155                 dpipe vde-plug = ssh -b 100.200.201.202 server-machine vde-plug
 156         - setup an appropriate IP address for tap0 interface (or get it by dhcp
 157                 if set up on server side). (e.g. 192.168.0.10)
 158         - use tap0 as the default interface:
 159                 ip route add default via 192.168.0.1
 160
 161 - (5) SUPPORT FOR MOBILITY
 162
 163 Create a tunnel like in 4 using a group number on the vde-cable:
 164         dpipe vde-plug -g 1 = ssh -b 100.200.201.202 server-machine vde-plug -g 1
 165
 166 Create a second tunnel (say on ppp0 addr. 100.100.101.102 gateway 100.100.101.254)
 167         # ip rule add from 100.100.101.102 table ppp0-table
 168         # ip route add default via 100.100.101.254 table ppp0-table
 169
 170 Connect the a second cable using the same group number:
 171         # dpipe vde-plug -g 1 = ssh -b 100.100.101.102 server-machine vde-plug -g 1
 172 Disconnect the first cable (kill the processes of the first cable)
 173
 174         All the traffic get rerouted on the new vde-cable (thus to another path
 175         on the rel network. Connections in place are unaffected by the change.
 176         Several cables of the same group can be in place during the handoff phase
 177         but note that this ends up in duplicated packets that can slow down
 178         the communication.
 179
 180 Please note also that the vde-switches do not manage (yet) the minimum spanning
 181 tree protocol thus a loop in the topology can lead to inconsistent MAC forward
 182 tables and to network saturation.
 183
 184 Copyright 2003/2004/2005 Renzo Davoli
 185 Acknowlegments:
 186 Thanks to Marco Giordani, Leonardo Macchia for their useful help for debugging.
 187 Imported code by Danny Gasparovsky, Fabrice Ballard.
 188 Code organization, bugfixes, autotool support Mattia Belletti.