utilities/ovs-save

   1 #! /bin/sh
   2
   3 # Copyright (c) 2011, 2013, 2016 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 case $0 in
  18     */*) dir0=`echo "$0" | sed 's,/[^/]*$,,'` ;;
  19     *) dir0=./ ;;
  20 esac
  21 . "$dir0/ovs-lib" || exit 1
  22
  23 usage() {
  24     UTIL=$(basename $0)
  25     cat <<EOF
  26 ${UTIL}: Provides helper functions to save Open vSwitch's configuration.
  27 usage: $0 COMMAND
  28
  29 Commands:
  30  save-interfaces        Outputs a shell script on stdout that will restore
  31                         the current kernel configuration of the specified
  32                         network interfaces, as well as the system iptables
  33                         configuration.
  34  save-flows             Outputs a shell script on stdout that will restore
  35                         OpenFlow flows of each Open vSwitch bridge.
  36 This script is meant as a helper for the Open vSwitch init script commands.
  37 EOF
  38 }
  39
  40 save_interfaces () {
  41     if (ip link show) > /dev/null 2>&1; then :; else
  42         echo "$0: ip not found in $PATH" >&2
  43         exit 1
  44     fi
  45
  46     if test "$#" = 0; then
  47         exit 0
  48     fi
  49
  50     devs="$@"
  51     for dev in $devs; do
  52         state=`ip link show dev $dev` || continue
  53
  54         echo "# $dev"
  55         # Link state (Ethernet addresses, up/down, ...)
  56         linkcmd=
  57         case $state in
  58             *"state UP"* | *[,\<]"UP"[,\>]* )
  59                 linkcmd="$linkcmd up"
  60                 ;;
  61             *"state DOWN"*)
  62                 linkcmd="$linkcmd down"
  63                 ;;
  64         esac
  65         if expr "$state" : '.*\bdynamic\b' > /dev/null; then
  66             linkcmd="$linkcmd dynamic"
  67         fi
  68         if qlen=`expr "$state" : '.*qlen \([0-9]\+\)'`; then
  69             linkcmd="$linkcmd txqueuelen $qlen"
  70         fi
  71         if hwaddr=`expr "$state" : '.*link/ether \([^ ]*\)'`; then
  72             linkcmd="$linkcmd address $hwaddr"
  73         fi
  74         if brd=`expr "$state" : '.*brd \([^ ]*\)'`; then
  75             linkcmd="$linkcmd broadcast $brd"
  76         fi
  77         if mtu=`expr "$state" : '.*mtu \([0-9]\+\)'`; then
  78             linkcmd="$linkcmd mtu $mtu"
  79         fi
  80         if test -n "$linkcmd"; then
  81             echo ip link set dev $dev down # Required to change hwaddr.
  82             echo ip link set dev $dev $linkcmd
  83         fi
  84
  85         move_ip_address $dev $dev
  86
  87         move_ip_routes $dev $dev
  88
  89         echo
  90     done
  91
  92     if (iptables-save) > /dev/null 2>&1; then
  93         echo "# global"
  94         echo "iptables-restore <<'EOF'"
  95         iptables-save
  96         echo "EOF"
  97     else
  98         echo "# iptables-save not found in $PATH, not saving iptables state"
  99     fi
 100 }
 101
 102 get_highest_ofp_version() {
 103     ovs-vsctl get bridge "$1" protocols | \
 104         awk -F '"' '{ print (NF>1)? $(NF-1) : "OpenFlow14" }'
 105 }
 106
 107 save_flows () {
 108     if (ovs-ofctl --version) > /dev/null 2>&1; then :; else
 109         echo "$0: ovs-ofctl not found in $PATH" >&2
 110         exit 1
 111     fi
 112
 113     # OVS 2.7 and earlier do not enable OpenFlow 1.4 (by default) and lack
 114     # other features needed to save and restore flows.  Don't try.
 115     case `ovs-appctl version | sed 1q` in
 116         "ovs-vswitchd (Open vSwitch) 1."*.*)
 117             return
 118             ;;
 119         "ovs-vswitchd (Open vSwitch) 2."[0-7].*)
 120             return
 121             ;;
 122     esac
 123
 124     workdir=$(mktemp -d "${TMPDIR:-/tmp}/ovs-save.XXXXXXXXXX")
 125     for bridge in "$@"; do
 126         # Get the highest enabled OpenFlow version
 127         ofp_version=$(get_highest_ofp_version "$bridge")
 128
 129         printf "%s" "ovs-ofctl add-tlv-map ${bridge} '"
 130         ovs-ofctl dump-tlv-map ${bridge} | \
 131         awk '/^  *0x/ {if (cnt != 0) printf ","; \
 132              cnt++;printf "{class="$1",type="$2",len="$3"}->"$4}'
 133         echo "'"
 134
 135         # If possible use OpenFlow 1.4 atomic bundle txn for flows and groups
 136         [ ${ofp_version#OpenFlow} -ge 14 ] && bundle=" --bundle" || bundle=""
 137
 138         echo "ovs-ofctl -O $ofp_version add-groups ${bridge} \
 139               \"$workdir/$bridge.groups.dump\" ${bundle}"
 140
 141         echo "ovs-ofctl -O $ofp_version replace-flows ${bridge} \
 142               \"$workdir/$bridge.flows.dump\" ${bundle}"
 143
 144         ovs-ofctl -O $ofp_version dump-groups "$bridge" | \
 145             sed -e '/^OFPST_GROUP_DESC/d' \
 146                 -e '/^NXST_GROUP_DESC/d' > \
 147                 "$workdir/$bridge.groups.dump"
 148
 149         ovs-ofctl -O $ofp_version dump-flows --no-names --no-stats "$bridge" | \
 150             sed -e '/NXST_FLOW/d' \
 151                 -e '/OFPST_FLOW/d' \
 152                 -e 's/\(idle\|hard\)_age=[^,]*,//g' > \
 153                 "$workdir/$bridge.flows.dump"
 154     done
 155     echo "rm -rf \"$workdir\""
 156 }
 157
 158 while [ $# -ne 0 ]
 159 do
 160     case $1 in
 161         "save-flows")
 162             shift
 163             save_flows "$@"
 164             exit 0
 165             ;;
 166         "save-interfaces")
 167             shift
 168             save_interfaces "$@"
 169             exit 0
 170             ;;
 171         -h | --help)
 172             usage
 173             exit 0
 174             ;;
 175         *)
 176             echo >&2 "$0: unknown command \"$1\" (use --help for help)"
 177             exit 1
 178             ;;
 179     esac
 180 done
 181
 182 exit 0