add long comment to vif-invirtroute explaining the metric trickery
[invirt/packages/invirt-xen-config.git] / vif-invirtroute
1 #!/bin/bash
2
3 #============================================================================
4 # /etc/xen/vif-route
5 #
6 # Script for configuring a vif in routed mode.
7 # The hotplugging system will call this script if it is specified either in
8 # the device configuration given to Xend, or the default Xend configuration
9 # in /etc/xen/xend-config.sxp.  If the script is specified in neither of those
10 # places, then vif-bridge is the default.
11 #
12 # Usage:
13 # vif-route (add|remove|online|offline)
14 #
15 # Environment vars:
16 # vif         vif interface name (required).
17 # XENBUS_PATH path to this device's details in the XenStore (required).
18 # Read from the store:
19 # ip      list of IP networks for the vif, space-separated (default given in
20 #         this script).
21 #
22 # This script will set up proxy arp  for any ip addresses that are being routed
23 # type read to determine if the device is ioemu
24
25 #============================================================================
26 dir=$(dirname "$0")
27 . "$dir/vif-common.sh"
28
29 main_ip=$(dom0_ip)
30 dev=${dev:-${vif}}
31
32 case "$command" in
33     online|add)
34         ifconfig ${dev} ${main_ip} netmask 255.255.255.255 up
35         echo 1 >/proc/sys/net/ipv4/conf/${dev}/proxy_arp
36         echo 1 >/proc/sys/net/ipv4/conf/${dev}/rp_filter 
37         xenstore-write "$XENBUS_PATH/feature-gso-tcpv4" 0
38         if [ x${qemu_online} != xyes ]; then
39           ethtool -K ${dev} tx off
40         fi
41         ipcmd='add'
42         cmdprefix=''
43         ;;
44     offline|remove)
45         do_without_error ifdown ${vif}
46         ipcmd='del'
47         cmdprefix='do_without_error'
48         ;;
49 esac
50
51 vif_type=$(xenstore_read_default "$XENBUS_PATH/type" "viffront")
52 if [  ${vif_type} != "ioemu"  -o  x${qemu_online} = xyes ] ; then
53     if [ "${ip}" ] ; then
54     # If we've been given a list of IP addresses, then add routes from dom0 to
55     # the guest using those addresses.
56         for addr in ${ip} ; do
57             # When PVHVM is enabled, Xen plugs two interfaces into
58             # HVMs - an emulated tap device and a paravirt vif device.
59             # vif-invirtroute (and vif-route, for that matter!) will
60             # fail when the second one is brought up, because the
61             # second invocation of 'ip route add' is identical to the
62             # first (same source and destination IPs) and the kernel
63             # rejects the new route.
64             #
65             # We work around this by adding the routes with different metrics.
66             # This should work because:
67             #
68             # 1) In the case of a pv-aware guest, the kernel will
69             # unplug the tap interface, which will bring down the tap
70             # interface's route, leaving only the one via the vif (and
71             # so the metric shouldn't matter, because it's the only
72             # route)
73             #
74             # 2) In the case of a non-pv-aware guest, the tap route
75             # (with metric 1) should take precedence over the vif
76             # route and carry all the traffic.
77                  
78
79             if [ $ipcmd == "add" ]; then
80                 case $dev in
81                     vif*)
82                         metric="metric 2"
83                         ;;
84                     tap*)
85                         metric="metric 1"
86                         ;;
87                 esac
88             fi
89             ${cmdprefix} ip route ${ipcmd} ${addr} dev ${dev} src ${main_ip} $metric
90             case "$command" in
91                 online|add)
92                     arpspoof -i $(invirt-getconf xen.iface) -t 18.181.0.1 ${addr}&
93                     sleep 5
94                     kill %arpspoof
95                     ;;
96             esac
97         done 
98     fi
99 fi
100
101 log debug "Successful vif-route $command for $vif."
102 case "$command" in
103     online|add)
104         success
105         ;;
106 esac