7c6390d6279adcab6163694270c570f31519e63d
[cascardo/ovs.git] / utilities / ovs-save
1 #! /bin/sh
2
3 # Copyright (c) 2011, 2013 Nicira, Inc.
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at:
8 #
9 #     http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 usage() {
18     UTIL=$(basename $0)
19     cat <<EOF
20 ${UTIL}: Provides helper functions to save Open vSwitch's configuration.
21 usage: $0 COMMAND
22
23 Commands:
24  save-interfaces        Outputs a shell script on stdout that will restore
25                         the current kernel configuration of the specified
26                         network interfaces, as well as the system iptables
27                         configuration.
28  save-flows             Outputs a shell script on stdout that will restore
29                         OpenFlow flows of each Open vSwitch bridge.
30  save-ofports           Outputs a shell script on stdout that will restore
31                         the ofport value across a force-reload-kmod.
32 This script is meant as a helper for the Open vSwitch init script commands.
33 EOF
34 }
35
36 save_interfaces () {
37     if (ip -V) > /dev/null 2>&1; then :; else
38         echo "$0: ip not found in $PATH" >&2
39         exit 1
40     fi
41
42     if test "$#" = 0; then
43         exit 0
44     fi
45
46     devs="$@"
47     for dev in $devs; do
48         state=`ip link show dev $dev` || continue
49
50         echo "# $dev"
51         # Link state (Ethernet addresses, up/down, ...)
52         linkcmd=
53         case $state in
54             *"state UP"* | *[,\<]"UP"[,\>]* )
55                 linkcmd="$linkcmd up"
56                 ;;
57             *"state DOWN"*)
58                 linkcmd="$linkcmd down"
59                 ;;
60         esac
61         if expr "$state" : '.*\bdynamic\b' > /dev/null; then
62             linkcmd="$linkcmd dynamic"
63         fi
64         if qlen=`expr "$state" : '.*qlen \([0-9]+\)'`; then
65             linkcmd="$linkcmd txqueuelen $qlen"
66         fi
67         if hwaddr=`expr "$state" : '.*link/ether \([^ ]*\)'`; then
68             linkcmd="$linkcmd address $hwaddr"
69         fi
70         if brd=`expr "$state" : '.*brd \([^ ]*\)'`; then
71             linkcmd="$linkcmd broadcast $brd"
72         fi
73         if mtu=`expr "$state" : '.*mtu \([0-9]+\)'`; then
74             linkcmd="$linkcmd mtu $mtu"
75         fi
76         if test -n "$linkcmd"; then
77             echo ip link set dev $dev down # Required to change hwaddr.
78             echo ip link set dev $dev $linkcmd
79         fi
80
81         # IP addresses (including IPv6).
82         echo "ip addr flush dev $dev 2>/dev/null" # Suppresses "Nothing to flush".
83         ip addr show dev $dev | while read addr; do
84             set -- $addr
85
86             # Check and trim family.
87             family=$1
88             shift
89             case $family in
90                 inet | inet6) ;;
91                 *) continue ;;
92             esac
93
94             # Trim device off the end--"ip" insists on having "dev" precede it.
95             addrcmd=
96             while test $# != 0; do
97                 case $1 in
98                     dynamic)
99                         # Omit kernel-maintained route.
100                         continue 2
101                         ;;
102                     scope)
103                         if test "$2" = link -a "$family" != inet6; then
104                             # Omit route derived from IP address, e.g.
105                             # 172.16.0.0/16 derived from 172.16.12.34,
106                             # but preserve IPv6 link-local address.
107                             continue 2
108                         fi
109                         ;;
110                     "$dev"|"$dev:"*)
111                         # Address label string
112                         addrcmd="$addrcmd label $1"
113                         shift
114                         continue
115                         ;;
116                 esac
117                 addrcmd="$addrcmd $1"
118                 shift
119             done
120             if test "$1" != "$dev"; then
121                 addrcmd="$addrcmd $1"
122             fi
123
124             echo ip -f $family addr add $addrcmd dev $dev
125         done
126
127         # Routes.
128         echo "ip route flush dev $dev proto boot 2>/dev/null" # Suppresses "Nothing to flush".
129         ip route show dev $dev | while read route; do
130             # "proto kernel" routes are installed by the kernel automatically.
131             case $route in
132                 *" proto kernel "*) continue ;;
133             esac
134
135             echo "ip route add $route dev $dev"
136         done
137
138         echo
139     done
140
141     if (iptables-save) > /dev/null 2>&1; then
142         echo "# global"
143         echo "iptables-restore <<'EOF'"
144         iptables-save
145         echo "EOF"
146     else
147         echo "# iptables-save not found in $PATH, not saving iptables state"
148     fi
149 }
150
151 save_flows () {
152     if (ovs-ofctl --version) > /dev/null 2>&1; then :; else
153         echo "$0: ovs-ofctl not found in $PATH" >&2
154         exit 1
155     fi
156
157     for bridge in "$@"; do
158         echo "ovs-ofctl add-flows ${bridge} - << EOF"
159         ovs-ofctl dump-flows "${bridge}" | sed -e '/NXST_FLOW/d' \
160             -e 's/\(idle\|hard\)_age=[^,]*,//g'
161         echo "EOF"
162     done
163 }
164
165 ovs_vsctl () {
166     ovs-vsctl --no-wait "$@"
167 }
168
169 save_ofports ()
170 {
171     if (ovs-vsctl --version) > /dev/null 2>&1; then :; else
172         echo "$0: ovs-vsctl not found in $PATH" >&2
173         exit 1
174     fi
175
176     for bridge in "$@"; do
177         count=0
178         for iface in `ovs_vsctl list-ifaces ${bridge}`; do
179             ofport=`ovs_vsctl get interface ${iface} ofport`
180             [ "${count}" -eq 0 ] && cmd="ovs-vsctl --no-wait"
181             cmd="${cmd} -- --if-exists set interface "${iface}" \
182                      ofport_request="${ofport}""
183
184             # Run set interface command on 50 ports at a time.
185             count=`expr ${count} + 1`
186             [ "${count}" -eq 50 ] && count=0 && echo "${cmd}" && cmd=""
187         done
188         echo "${cmd}"
189     done
190 }
191
192 while [ $# -ne 0 ]
193 do
194     case $1 in
195         "save-flows")
196             shift
197             save_flows "$@"
198             exit 0
199             ;;
200         "save-interfaces")
201             shift
202             save_interfaces "$@"
203             exit 0
204             ;;
205         "save-ofports")
206             shift
207             save_ofports "$@"
208             exit 0
209             ;;
210         -h | --help)
211             usage
212             exit 0
213             ;;
214         *)
215             echo >&2 "$0: unknown command \"$1\" (use --help for help)"
216             exit 1
217             ;;
218     esac
219 done
220
221 exit 0