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 ovs_ctl_log () {
  41     echo "$@" >> "${logdir}/ovs-ctl.log"
  42 }
  43
  44 ovs_ctl () {
  45     case "$@" in
  46         *"=strace"*)
  47             # In case of running the daemon with strace, piping the o/p causes
  48             # the script to block (strace probably does not close the inherited
  49             # pipe). So, do not log the o/p to ovs-ctl.log.
  50             "${datadir}/scripts/ovs-ctl" "$@"
  51         ;;
  52         "status")
  53             # In case of the command 'status', we should return the exit status
  54             # of ovs-ctl. It is also useful to document the o/p in ovs-ctl.log.
  55             display=`"${datadir}/scripts/ovs-ctl" "$@" 2>&1`
  56             rc=$?
  57             if test -w "${logdir}/ovs-ctl.log"; then
  58                  echo "${display}" | tee -a "${logdir}/ovs-ctl.log"
  59             else
  60                  echo "${display}"
  61             fi
  62             return ${rc}
  63         ;;
  64         *)
  65             echo "`date -u`:$@" >> "${logdir}/ovs-ctl.log"
  66             "${datadir}/scripts/ovs-ctl" "$@" 2>&1 | tee -a "${logdir}/ovs-ctl.log"
  67         ;;
  68     esac
  69 }
  70
  71 VERSION='@VERSION@'
  72
  73 DAEMON_CWD=/
  74
  75 LC_ALL=C; export LC_ALL
  76
  77 ## ------------- ##
  78 ## LSB functions ##
  79 ## ------------- ##
  80
  81 # Use the system's own implementations if it has any.
  82 if test -e /etc/init.d/functions; then
  83     . /etc/init.d/functions
  84 elif test -e /etc/rc.d/init.d/functions; then
  85     . /etc/rc.d/init.d/functions
  86 elif test -e /lib/lsb/init-functions; then
  87     . /lib/lsb/init-functions
  88 fi
  89
  90 # Implement missing functions (e.g. OpenSUSE lacks 'action').
  91 if type log_success_msg >/dev/null 2>&1; then :; else
  92     log_success_msg () {
  93         printf '%s.\n' "$*"
  94     }
  95 fi
  96 if type log_failure_msg >/dev/null 2>&1; then :; else
  97     log_failure_msg () {
  98         printf '%s ... failed!\n' "$*"
  99     }
 100 fi
 101 if type log_warning_msg >/dev/null 2>&1; then :; else
 102     log_warning_msg () {
 103         printf '%s ... (warning).\n' "$*"
 104     }
 105 fi
 106 if type action >/dev/null 2>&1; then :; else
 107     action () {
 108        STRING=$1
 109        shift
 110        "$@"
 111        rc=$?
 112        if test $rc = 0; then
 113             log_success_msg "$STRING"
 114        else
 115             log_failure_msg "$STRING"
 116        fi
 117        return $rc
 118     }
 119 fi
 120
 121 ## ------- ##
 122 ## Daemons ##
 123 ## ------- ##
 124
 125 pid_exists () {
 126     # This is better than "kill -0" because it doesn't require permission to
 127     # send a signal (so daemon_status in particular works as non-root).
 128     test -d /proc/"$1"
 129 }
 130
 131 start_daemon () {
 132     priority=$1
 133     wrapper=$2
 134     shift; shift
 135     daemon=$1
 136     strace=""
 137
 138     # drop core files in a sensible place
 139     test -d "$DAEMON_CWD" || install -d -m 755 -o root -g root "$DAEMON_CWD"
 140     set "$@" --no-chdir
 141     cd "$DAEMON_CWD"
 142
 143     # log file
 144     test -d "$logdir" || install -d -m 755 -o root -g root "$logdir"
 145     set "$@" --log-file="$logdir/$daemon.log"
 146
 147     # pidfile and monitoring
 148     test -d "$rundir" || install -d -m 755 -o root -g root "$rundir"
 149     set "$@" --pidfile="$rundir/$daemon.pid"
 150     set "$@" --detach --monitor
 151
 152     # wrapper
 153     case $wrapper in
 154         valgrind)
 155             if (valgrind --version) > /dev/null 2>&1; then
 156                 set valgrind -q --leak-check=full --time-stamp=yes \
 157                     --log-file="$logdir/$daemon.valgrind.log.%p" "$@"
 158             else
 159                 log_failure_msg "valgrind not installed, running $daemon without it"
 160             fi
 161             ;;
 162         strace)
 163             if (strace -V) > /dev/null 2>&1; then
 164                 strace="strace -tt -T -s 256 -ff"
 165                 if (strace -DV) > /dev/null 2>&1; then
 166                     # Has the -D option.
 167                     set $strace -D -o "$logdir/$daemon.strace.log" "$@"
 168                     strace=""
 169                 fi
 170             else
 171                 log_failure_msg "strace not installed, running $daemon without it"
 172             fi
 173             ;;
 174         glibc)
 175             set env MALLOC_CHECK_=2 MALLOC_PERTURB_=165 "$@"
 176             ;;
 177         '')
 178             ;;
 179         *)
 180             log_failure_msg "unknown wrapper $wrapper, running $daemon without it"
 181             ;;
 182     esac
 183
 184     # priority
 185     if test X"$priority" != X; then
 186         set nice -n "$priority" "$@"
 187     fi
 188
 189     action "Starting $daemon" "$@"
 190
 191     if test X"$strace" != X; then
 192         # Strace doesn't have the -D option so we attach after the fact.
 193         setsid $strace -o "$logdir/$daemon.strace.log" \
 194             -p `cat $rundir/$daemon.pid` > /dev/null 2>&1 &
 195     fi
 196 }
 197
 198 stop_daemon () {
 199     if test -e "$rundir/$1.pid"; then
 200         if pid=`cat "$rundir/$1.pid"`; then
 201             for action in TERM .1 .25 .65 1 1 1 1 KILL 1 1 1 2 10 15 30 FAIL; do
 202                 if pid_exists "$pid" >/dev/null 2>&1; then :; else
 203                     return 0
 204                 fi
 205                 case $action in
 206                     TERM)
 207                         action "Killing $1 ($pid)" kill $pid
 208                         ;;
 209                     KILL)
 210                         action "Killing $1 ($pid) with SIGKILL" kill -9 $pid
 211                         ;;
 212                     FAIL)
 213                         log_failure_msg "Killing $1 ($pid) failed"
 214                         return 1
 215                         ;;
 216                     *)
 217                         sleep $action
 218                         ;;
 219                 esac
 220             done
 221         fi
 222     fi
 223     log_success_msg "$1 is not running"
 224 }
 225
 226 daemon_status () {
 227     pidfile=$rundir/$1.pid
 228     if test -e "$pidfile"; then
 229         if pid=`cat "$pidfile"`; then
 230             if pid_exists "$pid"; then
 231                 echo "$1 is running with pid $pid"
 232                 return 0
 233             else
 234                 echo "Pidfile for $1 ($pidfile) is stale"
 235             fi
 236         else
 237             echo "Pidfile for $1 ($pidfile) exists but cannot be read"
 238         fi
 239     else
 240         echo "$1 is not running"
 241     fi
 242     return 1
 243 }
 244
 245 daemon_is_running () {
 246     pidfile=$rundir/$1.pid
 247     test -e "$pidfile" && pid=`cat "$pidfile"` && pid_exists "$pid"
 248 } >/dev/null 2>&1