samba-mirror/ctdb/tools/onnode

#!/bin/bash

# Run commands on CTDB nodes.

# See http://ctdb.samba.org/ for more information about CTDB.

# Copyright (C) Martin Schwenke  2008

# Based on an earlier script by Andrew Tridgell and Ronnie Sahlberg.

# Copyright (C) Andrew Tridgell  2007

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
   
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
   
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>.

prog=$(basename $0)

usage ()
{
    cat >&2 <<EOF
Usage: onnode [OPTION] ... <NODES> <COMMAND> ...
  options:
    -c         Run in current working directory on specified nodes.
    -p         Run command in parallel on specified nodes.
    -q         Do not print node addresses (overrides -v).
    -v         Print node address even for a single node.
  <NODES>      "all", "ok" (or "healthy"), "con" (or "connected"),
               "rm" (or "recmaster");
               or a node number (0 base); or
               list (comma separated) of <NODES>; or
               range (hyphen separated) of node numbers.
EOF
    exit 1

}

invalid_nodespec ()
{
    echo "Invalid <nodespec>" >&2 ; echo >&2
    usage
}

# Defaults.
current=false
parallel=false
verbose=false
quiet=false

parse_options ()
{
    # $POSIXLY_CORRECT means that the command passed to onnode can
    # take options and getopt won't reorder things to make them
    # options ot onnode.
    local temp=$(POSIXLY_CORRECT=1 getopt -n "$prog" -o "chpqv" -l help -- "$@")

    [ $? != 0 ] && usage

    eval set -- "$temp"

    while true ; do
	case "$1" in
	    -c) current=true ; shift ;;
	    -p) parallel=true ; shift ;;
	    -q) quiet=true ; shift ;;
	    -v) verbose=true ; shift ;;
	    --) shift ; break ;;
	    -h|--help|*) usage ;; # Shouldn't happen, so this is reasonable.
	esac
    done

    [ $# -lt 2 ] && usage

    nodespec="$1" ; shift
    command="$@"
}

# Can probably be avoided if we use bash?
get_nth ()
{
    local n="$1" ; shift

    local c=0
    local j
    for j ; do
	if [ $n -eq $c ] ; then
	    echo $j
	    break
	fi
	c=$(($c + 1))
    done
}

echo_nth ()
{
    local node=$(get_nth "$@")
    if [ -n "$node" ] ; then
	echo $node
    else
	echo "${prog}: \"node ${n}\" does not exist" >&2
	exit 1
    fi
}

parse_nodespec ()
{
    # Subshell avoids hacks to restore $IFS.
    (
	IFS=","
	for i in $1 ; do
	    case "$i" in
		*-*) seq "${i%-*}" "${i#*-}" 2>/dev/null || invalid_nodespec ;;
		all|ok|healthy|con|connected|rm|recmaster) echo "$i" ;;
		*)
		    [ $i -gt -1 ] 2>/dev/null || invalid_nodespec
		    echo $i
	    esac
	done
    )
}

# Cache
ctdb_status_output=""
get_nodes_with_status ()
{
    local all_nodes="$1"
    local status="$2"

    local bits
    case "$status" in
	ok|healthy)
	    bits="0:0:0:0"
	    ;;
	con|connected)
	    bits="0:[0-1]:[0-1]:[0-1]"
	    ;;
	*)
	    invalid_nodespec
    esac

    if [ -z "$ctdb_status_output" ] ; then
	ctdb_status_output=$(ctdb -Y status 2>/dev/null)
	if [ $? -ne 0 ] ; then
	    echo "${prog}: unable to get status of CTDB nodes" >&2
	    exit 1
	fi
	ctdb_status_output="${ctdb_status_output#* }"
    fi

    local nodes=""
    local i
    for i in $ctdb_status_output ; do
	# Try removing bits from end.
	local t="${i%:${bits}:}"
	if [ "$t" != "$i" ] ; then
	    # Succeeded.  Get address.  NOTE: this is an optimisation.
	    # It might be better to get the node number and then use
	    # get_nth() to get the address.  This would make things
	    # more consistent if /etc/ctdb/nodes actually contained
	    # hostnames.
	    nodes="${nodes} ${t##*:}"
	fi
    done

    echo $nodes
}

ctdb_recmaster=""
get_nodes ()
{
    [ -f "$CTDB_NODES_FILE" ] || CTDB_NODES_FILE=/etc/ctdb/nodes
    local all_nodes=$(egrep '^[[:alnum:]]' $CTDB_NODES_FILE)

    local nodes=""
    local n
    for n in $(parse_nodespec "$1") ; do
	[ $? != 0 ] && exit 1  # Required to catch exit in above subshell.
	case "$n" in
	    all)
		echo $all_nodes ;;
	    ok|healthy|con|connected) 
		get_nodes_with_status "$all_nodes" "$n" || exit 1
		;;
	    rm|recmaster)
		if [ -z "$ctdb_recmaster" ] ; then
		    ctdb_recmaster=$(ctdb recmaster 2>/dev/null)
		    [ $? -eq 0 ] || ctdb_recmaster=""
		fi
		if [ -n "$ctdb_recmaster" ] ; then
		    echo_nth "$ctdb_recmaster" $all_nodes
		else
		    echo "${prog}: No recmaster available" >&2
		    exit 1
		fi
		
		;;
	    *)
		echo_nth $n $all_nodes
	esac
	
    done
}

######################################################################

parse_options "$@"

$current && command="cd $PWD && $command"

SSH_OPTS=
# Could "2>/dev/null || true" but want to see errors from typos in file.
[ -r /etc/ctdb/onnode.conf ] && . /etc/ctdb/onnode.conf
[ -n "$SSH" ] || SSH=ssh
if [ "$SSH" = "ssh" ] ; then
    ssh_opts="-n"
else
    : # rsh? All bets are off!
fi

######################################################################

nodes=$(get_nodes "$nodespec")
[ $? != 0 ] && exit 1   # Required to catch exit in above subshell.

if $quiet ; then
    verbose=false
else
    # If $nodes contains a space or a newline then assume multiple nodes.
    nl="
"
    [ "$nodes" != "${nodes%[ ${nl}]*}" ] && verbose=true
fi

pids=""
trap 'kill -TERM $pids 2>/dev/null' INT TERM
# There's a small race here where the kill can fail if no processes
# have been added to $pids and the script is interrupted.  However,
# the part of the window where it matter is very small.
retcode=0
for n in $nodes ; do
    if $parallel ; then
	if $verbose ; then
	    # pipefail is a bashism - is there some way to do this with plain sh?
	    set -o pipefail 2>/dev/null
	    ($SSH $ssh_opts $EXTRA_SSH_OPTS $n "$command" 2>&1 | sed -e "s@^@[$n] @" )&
	else
	    $SSH $ssh_opts $EXTRA_SSH_OPTS $n "$command" &
	fi
	pids="${pids} $!"
    else
	if $verbose ; then
	    echo >&2 ; echo ">> NODE: $n <<" >&2
	fi

	$SSH $ssh_opts $EXTRA_SSH_OPTS $n "$command" 
	[ $? = 0 ] || retcode=$?
    fi
done

$parallel && {
    for p in $pids; do
	wait $p
	[ $? = 0 ] || retcode=$?
    done
}

exit $retcode