utilities/ovs-lib.in

   1 # This is a shell function library sourced by some Open vSwitch scripts.
   2 # It is not intended to be invoked on its own.
   3
   4 # Copyright (C) 2009, 2010, 2011, 2012 Nicira, Inc.
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at:
   9 #
  10 #     http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17
  18 ## ----------------- ##
  19 ## configure options ##
  20 ## ----------------- ##
  21
  22 # All of these should be substituted by the Makefile at build time.
  23 logdir=${OVS_LOGDIR-'@LOGDIR@'}                 # /var/log/openvswitch
  24 rundir=${OVS_RUNDIR-'@RUNDIR@'}                 # /var/run/openvswitch
  25 sysconfdir=${OVS_SYSCONFDIR-'@sysconfdir@'}     # /etc
  26 etcdir=$sysconfdir/openvswitch                  # /etc/openvswitch
  27 datadir=${OVS_PKGDATADIR-'@pkgdatadir@'}        # /usr/share/openvswitch
  28 bindir=${OVS_BINDIR-'@bindir@'}                 # /usr/bin
  29 sbindir=${OVS_SBINDIR-'@sbindir@'}              # /usr/sbin
  30
  31 # /etc/openvswitch or /var/lib/openvswitch
  32 if test X"$OVS_DBDIR" != X; then
  33     dbdir=$OVS_DBDIR
  34 elif test X"$OVS_SYSCONFDIR" != X; then
  35     dbdir=$OVS_SYSCONFDIR/openvswitch
  36 else
  37     dbdir='@DBDIR@'
  38 fi
  39
  40 VERSION='@VERSION@'
  41
  42 DAEMON_CWD=/
  43
  44 LC_ALL=C; export LC_ALL
  45
  46 ## ------------- ##
  47 ## LSB functions ##
  48 ## ------------- ##
  49
  50 # Use the system's own implementations if it has any.
  51 if test -e /etc/init.d/functions; then
  52     . /etc/init.d/functions
  53 elif test -e /etc/rc.d/init.d/functions; then
  54     . /etc/rc.d/init.d/functions
  55 elif test -e /lib/lsb/init-functions; then
  56     . /lib/lsb/init-functions
  57 fi
  58
  59 # Implement missing functions (e.g. OpenSUSE lacks 'action').
  60 if type log_success_msg >/dev/null 2>&1; then :; else
  61     log_success_msg () {
  62         printf '%s.\n' "$*"
  63     }
  64 fi
  65 if type log_failure_msg >/dev/null 2>&1; then :; else
  66     log_failure_msg () {
  67         printf '%s ... failed!\n' "$*"
  68     }
  69 fi
  70 if type log_warning_msg >/dev/null 2>&1; then :; else
  71     log_warning_msg () {
  72         printf '%s ... (warning).\n' "$*"
  73     }
  74 fi
  75 if type action >/dev/null 2>&1; then :; else
  76     action () {
  77        STRING=$1
  78        shift
  79        "$@"
  80        rc=$?
  81        if test $rc = 0; then
  82             log_success_msg "$STRING"
  83        else
  84             log_failure_msg "$STRING"
  85        fi
  86        return $rc
  87     }
  88 fi
  89
  90 ## ------- ##
  91 ## Daemons ##
  92 ## ------- ##
  93
  94 pid_exists () {
  95     # This is better than "kill -0" because it doesn't require permission to
  96     # send a signal (so daemon_status in particular works as non-root).
  97     test -d /proc/"$1"
  98 }
  99
 100 start_daemon () {
 101     priority=$1
 102     wrapper=$2
 103     shift; shift
 104     daemon=$1
 105     strace=""
 106
 107     # drop core files in a sensible place
 108     test -d "$DAEMON_CWD" || install -d -m 755 -o root -g root "$DAEMON_CWD"
 109     set "$@" --no-chdir
 110     cd "$DAEMON_CWD"
 111
 112     # log file
 113     test -d "$logdir" || install -d -m 755 -o root -g root "$logdir"
 114     set "$@" --log-file="$logdir/$daemon.log"
 115
 116     # pidfile and monitoring
 117     test -d "$rundir" || install -d -m 755 -o root -g root "$rundir"
 118     set "$@" --pidfile="$rundir/$daemon.pid"
 119     set "$@" --detach --monitor
 120
 121     # wrapper
 122     case $wrapper in
 123         valgrind)
 124             if (valgrind --version) > /dev/null 2>&1; then
 125                 set valgrind -q --leak-check=full --time-stamp=yes \
 126                     --log-file="$logdir/$daemon.valgrind.log.%p" "$@"
 127             else
 128                 log_failure_msg "valgrind not installed, running $daemon without it"
 129             fi
 130             ;;
 131         strace)
 132             if (strace -V) > /dev/null 2>&1; then
 133                 strace="strace -tt -T -s 256 -ff"
 134                 if (strace -DV) > /dev/null 2>&1; then
 135                     # Has the -D option.
 136                     set $strace -D -o "$logdir/$daemon.strace.log" "$@"
 137                     strace=""
 138                 fi
 139             else
 140                 log_failure_msg "strace not installed, running $daemon without it"
 141             fi
 142             ;;
 143         '')
 144             ;;
 145         *)
 146             log_failure_msg "unknown wrapper $wrapper, running $daemon without it"
 147             ;;
 148     esac
 149
 150     # priority
 151     if test X"$priority" != X; then
 152         set nice -n "$priority" "$@"
 153     fi
 154
 155     action "Starting $daemon" "$@"
 156
 157     if test X"$strace" != X; then
 158         # Strace doesn't have the -D option so we attach after the fact.
 159         setsid $strace -o "$logdir/$daemon.strace.log" \
 160             -p `cat $rundir/$daemon.pid` > /dev/null 2>&1 &
 161     fi
 162 }
 163
 164 stop_daemon () {
 165     if test -e "$rundir/$1.pid"; then
 166         if pid=`cat "$rundir/$1.pid"`; then
 167             for action in TERM .1 .25 .65 1 1 1 1 KILL 1 1 1 1 FAIL; do
 168                 case $action in
 169                     TERM)
 170                         action "Killing $1 ($pid)" kill $pid
 171                         ;;
 172                     KILL)
 173                         action "Killing $1 ($pid) with SIGKILL" kill -9 $pid
 174                         ;;
 175                     FAIL)
 176                         log_failure_msg "Killing $1 ($pid) failed"
 177                         return 1
 178                         ;;
 179                     *)
 180                         if pid_exists $pid >/dev/null 2>&1; then
 181                             sleep $action
 182                         else
 183                             return 0
 184                         fi
 185                         ;;
 186                 esac
 187             done
 188         fi
 189     fi
 190     log_success_msg "$1 is not running"
 191 }
 192
 193 daemon_status () {
 194     pidfile=$rundir/$1.pid
 195     if test -e "$pidfile"; then
 196         if pid=`cat "$pidfile"`; then
 197             if pid_exists "$pid"; then
 198                 echo "$1 is running with pid $pid"
 199                 return 0
 200             else
 201                 echo "Pidfile for $1 ($pidfile) is stale"
 202             fi
 203         else
 204             echo "Pidfile for $1 ($pidfile) exists but cannot be read"
 205         fi
 206     else
 207         echo "$1 is not running"
 208     fi
 209     return 1
 210 }
 211
 212 daemon_is_running () {
 213     pidfile=$rundir/$1.pid
 214     test -e "$pidfile" && pid=`cat "$pidfile"` && pid_exists "$pid"
 215 } >/dev/null 2>&1