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 VERSION='@VERSION@'
  32
  33 LC_ALL=C; export LC_ALL
  34
  35 ## ------------- ##
  36 ## LSB functions ##
  37 ## ------------- ##
  38
  39 # Use the system's own implementations if it has any.
  40 if test -e /etc/init.d/functions; then
  41     . /etc/init.d/functions
  42 elif test -e /etc/rc.d/init.d/functions; then
  43     . /etc/rc.d/init.d/functions
  44 elif test -e /lib/lsb/init-functions; then
  45     . /lib/lsb/init-functions
  46 fi
  47
  48 # Implement missing functions (e.g. OpenSUSE lacks 'action').
  49 if type log_success_msg >/dev/null 2>&1; then :; else
  50     log_success_msg () {
  51         printf '%s.\n' "$*"
  52     }
  53 fi
  54 if type log_failure_msg >/dev/null 2>&1; then :; else
  55     log_failure_msg () {
  56         printf '%s ... failed!\n' "$*"
  57     }
  58 fi
  59 if type log_warning_msg >/dev/null 2>&1; then :; else
  60     log_warning_msg () {
  61         printf '%s ... (warning).\n' "$*"
  62     }
  63 fi
  64 if type action >/dev/null 2>&1; then :; else
  65     action () {
  66        STRING=$1
  67        shift
  68        "$@"
  69        rc=$?
  70        if test $rc = 0; then
  71             log_success_msg "$STRING"
  72        else
  73             log_failure_msg "$STRING"
  74        fi
  75        return $rc
  76     }
  77 fi
  78
  79 ## ------- ##
  80 ## Daemons ##
  81 ## ------- ##
  82
  83 pid_exists () {
  84     # This is better than "kill -0" because it doesn't require permission to
  85     # send a signal (so daemon_status in particular works as non-root).
  86     test -d /proc/"$1"
  87 }
  88
  89 start_daemon () {
  90     priority=$1
  91     shift
  92     daemon=$1
  93
  94     # drop core files in a sensible place
  95     test -d "$DAEMON_CWD" || install -d -m 755 -o root -g root "$DAEMON_CWD"
  96     set "$@" --no-chdir
  97     cd "$DAEMON_CWD"
  98
  99     # log file
 100     test -d "$logdir" || install -d -m 755 -o root -g root "$logdir"
 101     set "$@" --log-file="$logdir/$daemon.log"
 102
 103     # pidfile and monitoring
 104     test -d "$rundir" || install -d -m 755 -o root -g root "$rundir"
 105     set "$@" --pidfile="$rundir/$daemon.pid"
 106     set "$@" --detach --monitor
 107
 108     # priority
 109     if test X"$priority" != X; then
 110         set nice -n "$priority" "$@"
 111     fi
 112
 113     action "Starting $daemon" "$@"
 114 }
 115
 116 DAEMON_CWD=/
 117 stop_daemon () {
 118     if test -e "$rundir/$1.pid"; then
 119         if pid=`cat "$rundir/$1.pid"`; then
 120             for action in TERM .1 .25 .65 1 1 1 1 KILL 1 1 1 1 FAIL; do
 121                 case $action in
 122                     TERM)
 123                         action "Killing $1 ($pid)" kill $pid
 124                         ;;
 125                     KILL)
 126                         action "Killing $1 ($pid) with SIGKILL" kill -9 $pid
 127                         ;;
 128                     FAIL)
 129                         log_failure_msg "Killing $1 ($pid) failed"
 130                         return 1
 131                         ;;
 132                     *)
 133                         if pid_exists $pid >/dev/null 2>&1; then
 134                             sleep $action
 135                         else
 136                             return 0
 137                         fi
 138                         ;;
 139                 esac
 140             done
 141         fi
 142     fi
 143     log_success_msg "$1 is not running"
 144 }
 145
 146 daemon_status () {
 147     pidfile=$rundir/$1.pid
 148     if test -e "$pidfile"; then
 149         if pid=`cat "$pidfile"`; then
 150             if pid_exists "$pid"; then
 151                 echo "$1 is running with pid $pid"
 152                 return 0
 153             else
 154                 echo "Pidfile for $1 ($pidfile) is stale"
 155             fi
 156         else
 157             echo "Pidfile for $1 ($pidfile) exists but cannot be read"
 158         fi
 159     else
 160         echo "$1 is not running"
 161     fi
 162     return 1
 163 }
 164
 165 daemon_is_running () {
 166     pidfile=$rundir/$1.pid
 167     test -e "$pidfile" && pid=`cat "$pidfile"` && pid_exists "$pid"
 168 } >/dev/null 2>&1