planetlab/scripts/sliver-ovs.in

   1 #!/bin/bash
   2 # -*-shell-mode-*-
   3
   4 ### expected to be run as root
   5
   6 COMMAND=$0
   7
   8 #################### global vars
   9 RUN_DIR=@RUNDIR@
  10 DB_CONF_FILE=@DBDIR@/conf.db
  11 DB_SCHEMA=@pkgdatadir@/vswitch.ovsschema
  12 DB_LOG=@LOGDIR@/ovs-db.log
  13 ##
  14 DB_SOCKET=$RUN_DIR/db.sock
  15 ##
  16 SWITCH_LOG=@LOGDIR@/ovs-switch.log
  17
  18 #################### helper functions
  19
  20 function kill_pltap_ovs () {
  21     killall pltap-ovs 2>/dev/null || :
  22 }
  23
  24 function error {
  25     echo "$@" >&2
  26     exit 1
  27 }
  28
  29 function get_params {
  30     params=$1; shift
  31     err_msg="$COMMAND $SUBCOMMAND $(echo $params | perl -pe 's/\S+/<$&>/g')"
  32     for p in $params; do
  33         [[ -z "$@" ]] && error "$err_msg"
  34         pname=$(echo -n $p|perl -pe 's/\W/_/g')
  35         eval $pname="$1"; shift
  36     done
  37     [[ -n "$@" ]] && error "$err_msg"
  38 }
  39
  40 function is_switch_running {
  41     ovs-appctl --target=ovs-vswitchd version >& /dev/null
  42 }
  43
  44 function is_db_running {
  45     ovs-appctl --target=ovsdb-server version >& /dev/null
  46 }
  47
  48 function tapname () {
  49     IP=$1; shift
  50     echo $(ip addr show to "$IP/32" | perl -ne '/^\s*\d+:\s*([\w-]+):/ && print $1')
  51 }
  52
  53 function wait_server () {
  54     pid_file=$1; shift
  55     server_name=$1; shift
  56     timeout=$1; shift
  57
  58     expire=$(($(date +%s) + $timeout))
  59
  60     ## wait for it to be up - xxx todo - could use a timeout of some kind
  61     while [ ! -f "$pid_file" ]; do
  62         echo "Waiting for $server_name to start... $(($expire - $(date +%s)))s left" >&2
  63         sleep 1;
  64         [ $(date +%s) -ge $expire ] && return 1
  65     done
  66     cat "$pid_file"
  67 }
  68
  69 function wait_device () {
  70     local tapname=$1; shift
  71     local timeout=$1; shift
  72
  73     local expire=$(($(date +%s) + $timeout))
  74
  75     while ! ip link show up | egrep -q "^[0-9]+: +$tapname:"; do
  76         echo "Waiting for $tapname to come UP...$(($expire - $(date +%s)))s left" >&2
  77         sleep 1
  78         [ $(date +%s) -ge $expire ] && return 1
  79     done
  80     return 0
  81 }
  82
  83 ######################################## startup
  84 function start_db () {
  85     get_params "" "$@"
  86
  87     ## init conf
  88     conf_dir=$(dirname $DB_CONF_FILE)
  89     [ -d $conf_dir ] || mkdir -p $conf_dir
  90     [ -f $DB_CONF_FILE ] || ovsdb-tool create $DB_CONF_FILE $DB_SCHEMA
  91
  92     ## init run
  93     [ -d $RUN_DIR ] || mkdir -p $RUN_DIR
  94
  95     ## check
  96     [ -f $DB_CONF_FILE ] || { echo "Could not initialize $DB_CONF_FILE - exiting" ; exit 1 ; }
  97     [ -d $RUN_DIR ] || { echo "Could not initialize $RUN_DIR - exiting" ; exit 1 ; }
  98
  99     ## run the stuff
 100     if [ ! -f "$RUN_DIR/ovsdb-server.pid" ]; then
 101         ovsdb-server $DB_CONF_FILE \
 102             --remote=punix:$DB_SOCKET \
 103             --remote=db:Open_vSwitch,Open_vSwitch,manager_options \
 104             --private-key=db:Open_vSwitch,SSL,private_key \
 105             --certificate=db:Open_vSwitch,SSL,certificate \
 106             --bootstrap-ca-cert=db:Open_vSwitch,SSL,ca_cert \
 107             --pidfile \
 108             --log-file=$DB_LOG \
 109             --detach >& /dev/null
 110     else
 111         echo 'ovsdb-server appears to be running already, *not* starting'
 112     fi
 113     wait_server $RUN_DIR/ovsdb-server.pid ovsdb-server 30
 114 }
 115
 116 function start_switch () {
 117     get_params "" "$@"
 118
 119     # ensure ovsdb-server is running
 120     is_db_running || { echo "ovsdb-server not running" >&2 ; exit 1 ; }
 121
 122     if [ ! -f "$RUN_DIR/ovs-vswitchd.pid" ] ; then
 123         ovs-vswitchd \
 124             --pidfile \
 125             --log-file=$SWITCH_LOG \
 126             --detach \
 127             unix:$DB_SOCKET >& /dev/null
 128     else
 129         echo 'ovs-vswitchd appears to be running already, *not* starting'
 130     fi
 131     wait_server $RUN_DIR/ovs-vswitchd.pid ovs-vswitchd 30
 132 }
 133
 134 function stop_db () {
 135     ovs-appctl --target=ovsdb-server exit || :
 136 }
 137
 138 function stop_switch () {
 139     ovs-appctl --target=ovs-vswitchd exit || :
 140 }
 141
 142 function status () {
 143     pids=$(pgrep '^ovs')
 144     [ -n "$pids" ] && ps $pids
 145 }
 146
 147 function start () {
 148     start_db
 149     start_switch
 150 }
 151
 152 function stop () {
 153     stop_switch
 154     stop_db
 155 }
 156
 157 #################### create functions
 158 function create_bridge () {
 159
 160     get_params "bridge IP/PREFIX" "$1" "$2"
 161     shift; shift;
 162
 163     IP=${IP_PREFIX%/*}
 164     PREFIX=${IP_PREFIX#*/}
 165
 166     W=
 167     if ! is_switch_running; then
 168         # we can create the bridge even if ovs-vswitchd is not running,
 169         # but we need a running ovsdb-server
 170         is_db_running || { echo "ovsdb-server not running" >&2; exit 1; }
 171         W="--no-wait"
 172     fi
 173
 174
 175     set -e
 176     ovs-vsctl --db=unix:$DB_SOCKET $W -- --may-exist add-br "$bridge" \
 177         -- set bridge "$bridge" datapath_type=planetlab \
 178         -- set interface "$bridge" options:local_ip="$IP" option:local_netmask="$PREFIX" \
 179         -- "$@"
 180
 181     # check that the bridge has actually been created
 182     if [ -z "$W" ]; then
 183             local tap=$(ovs-appctl netdev-pltap/get-tapname "$bridge")
 184             wait_device $tap 10
 185     fi
 186 }
 187
 188 function create_port () {
 189
 190     get_params "bridge port" "$@"
 191
 192     W=
 193     if ! is_switch_running; then
 194         # we can create the port even if ovs-vswitchd is not running,
 195         # but we need a running ovsdb-server
 196         is_db_running || { echo "ovsdb-server not running" >&2; exit 1; }
 197         W="--no-wait"
 198     fi
 199
 200     set -e
 201     ovs-vsctl --db=unix:$DB_SOCKET $W -- --may-exist add-port "$bridge" "$port" \
 202         -- set interface "$port" type=tunnel
 203 }
 204
 205 function get_local_endpoint () {
 206
 207     get_params "local_port" "$@"
 208
 209     is_switch_running || { echo "ovs-vswitchd not running" >&2; exit 1; }
 210
 211     set -e
 212     ovs-appctl --target=ovs-vswitchd netdev-tunnel/get-port "$local_port"
 213 }
 214
 215 function set_remote_endpoint () {
 216
 217     get_params "local_port remote_ip remote_UDP_port" "$@"
 218
 219     W=
 220     if ! is_switch_running; then
 221         # we can store the info even if ovs-vswitchd is not running,
 222         # but we need a running ovsdb-server
 223         is_db_running || { echo "ovsdb-server not running" >&2; exit 1; }
 224         W="--no-wait"
 225     fi
 226
 227     set -e
 228     ovs-vsctl --db=unix:$DB_SOCKET $W set interface $local_port \
 229         options:remote_ip=$remote_ip \
 230         options:remote_port=$remote_UDP_port
 231 }
 232
 233 function set_controller () {
 234
 235     get_params "bridge_name controller" "$@"
 236
 237     # ensure ovs-vswitchd is running
 238     is_switch_running || { echo "ovs-vswitchd not running" >&2 ; exit 1 ; }
 239
 240     set -e
 241     ovs-vsctl --db=unix:$DB_SOCKET set-controller "$bridge_name" "$controller"
 242 }
 243
 244 function del_controller () {
 245
 246     get_params "bridge_name" "$@"
 247
 248     # ensure ovs-vswitchd is running
 249     is_switch_running || { echo "ovs-vswitchd not running" >&2 ; exit 1 ; }
 250
 251     set -e
 252     ovs-vsctl --db=unix:$DB_SOCKET del-controller "$bridge_name"
 253 }
 254
 255 #################### del functions
 256 function del_bridge () {
 257
 258     get_params "bridge_name" "$@"
 259
 260     W=
 261     if ! is_switch_running; then
 262         # we can delete the bridge even if ovs-vswitchd is not running,
 263         # but we need a running ovsdb-server
 264         is_db_running || { echo "ovsdb-server not running" >&2; exit 1; }
 265         W="--no-wait"
 266     fi
 267
 268     ovs-vsctl --db=unix:$DB_SOCKET $W -- --if-exists del-br $bridge_name
 269 }
 270
 271 function del_port () {
 272
 273     get_params "port" "$@"
 274
 275     W=
 276     if ! is_switch_running; then
 277         # we can delete the port even if ovs-vswitchd is not running,
 278         # but we need a running ovsdb-server
 279         is_db_running || { echo "ovsdb-server not running" >&2; exit 1; }
 280         W="--no-wait"
 281     fi
 282
 283     ovs-vsctl --db=unix:$DB_SOCKET $W -- --if-exists del-port "$port"
 284 }
 285
 286 function show () {
 287
 288     get_params "" "$@"
 289
 290     is_db_running || { echo "ovsdb-server not running" >&2; exit 1; }
 291
 292     ovs-vsctl --db=unix:$DB_SOCKET show
 293 }
 294
 295 function get_local_ip () {
 296
 297     get_params "bridge" "$@"
 298
 299     set -e
 300     ovs-vsctl --db=unix:$DB_SOCKET br-exists "$bridge" || return
 301     local ip=$(ovs-vsctl get interface "$bridge" options:local_ip)
 302     local netmask=$(ovs-vsctl get interface "$bridge" options:local_netmask)
 303     eval echo $ip/$netmask
 304 }
 305
 306 function get_local_links () {
 307
 308     get_params "bridge" "$@"
 309
 310     set -e
 311     ovs-vsctl --db=unix:$DB_SOCKET br-exists "$bridge" || return
 312     ovs-vsctl --db=unix:$DB_SOCKET list-ifaces "$bridge"
 313 }
 314
 315 function get_mac () {
 316
 317     get_params "bridge" "$@"
 318
 319     set -e
 320     local tap=$(ovs-appctl netdev-pltap/get-tapname "$bridge")
 321     ifconfig "$tap" | awk '/HWaddr/ { print $5 }'
 322 }
 323
 324 ### for demos - connect to an ndnmap deployment to visualize links bandwidth
 325 # this expects 3 arguments
 326 # an interface name, L<id1>-<id2> based on your ids in conf.mk
 327 # the hostname for a ndnmap deployment
 328 # a linkid, this is the id that this link has in your ndnmap scenario (hard-coded in some json file)
 329 # this one-shot function writes the current statistics onto the ndnmap site
 330 # it needs to be called regularly so that ndnmap can do the bw computations
 331 # would make sense for the caller to redirect stderr onto some relevant location
 332 function gmap_probe_once () {
 333     iface=$1; shift
 334     hostname=$1; shift
 335     linkid=$1; shift
 336     rx_bytes=$(ovs-appctl netdev-tunnel/get-rx-bytes $iface)
 337     tx_bytes=$(ovs-appctl netdev-tunnel/get-tx-bytes $iface)
 338     rx_bits=$(($rx_bytes*8))
 339     tx_bits=$(($tx_bytes*8))
 340     now=$(date +%s).$(date +%N)
 341     trigger=http://${hostname}/bw/${linkid}/${now}/${rx_bits}/${tx_bits}
 342 #    curl -s -L $trigger | grep -q "Got it" || echo Missed event with $trigger
 343 #    echo $trigger
 344     curl -s -L $trigger >& /dev/null
 345 }
 346
 347 ### the front end, manages pid and so on
 348 function gmap_probe () {
 349     iface=$1; shift
 350     hostname=$1; shift
 351     linkid=$1; shift
 352     looptime=$1; shift
 353     [ -z "$looptime" ] && looptime=1
 354     pid_file=/var/run/openvswitch/gmap-$iface.pid
 355     if [ -f $pid_file ] ; then
 356         pid=$(cat $pid_file)
 357         [ -n "$pid" ] && kill $pid >& /dev/null
 358         rm $pid_file
 359     fi
 360     # close std fds so that ssh invokations can return
 361     exec <&-
 362     exec >&-
 363     while true; do
 364         gmap_probe_once $iface $hostname $linkid
 365         sleep $looptime
 366     done &
 367     # this is the pid for the background process
 368     echo $! > $pid_file
 369 }
 370
 371 ####################
 372 SUPPORTED_SUBCOMMANDS="start stop status
 373 start_db stop_db start_switch stop_switch
 374 create_bridge create_port del_bridge del_port
 375 show get_local_endpoint set_remote_endpoint
 376 set_controller del_controller gmap_probe
 377 get_local_ip get_local_links get_mac"
 378
 379 function main () {
 380         message="Usage: $COMMAND <subcommand> ...
 381 Supported subcommands are (dash or underscore is the same):
 382 $SUPPORTED_SUBCOMMANDS"
 383         [[ -z "$@" ]] && error "$message"
 384
 385         SUBCOMMAND=$1; shift
 386         # support dashes instead of underscores
 387         SUBCOMMAND=$(echo $SUBCOMMAND | sed -e s,-,_,g)
 388         found=""
 389         for supported in $SUPPORTED_SUBCOMMANDS; do [ "$SUBCOMMAND" = "$supported" ] && found=yes; done
 390
 391         [ -z "$found" ] && error $message
 392
 393         $SUBCOMMAND "$@"
 394 }
 395
 396 main "$@"