rc.subr revision 1.65
11.65Slukem# $NetBSD: rc.subr,v 1.65 2004/10/12 14:45:29 lukem Exp $
21.11Slukem#
31.65Slukem# Copyright (c) 1997-2004 The NetBSD Foundation, Inc.
41.11Slukem# All rights reserved.
51.11Slukem#
61.11Slukem# This code is derived from software contributed to The NetBSD Foundation
71.11Slukem# by Luke Mewburn.
81.11Slukem#
91.11Slukem# Redistribution and use in source and binary forms, with or without
101.11Slukem# modification, are permitted provided that the following conditions
111.11Slukem# are met:
121.11Slukem# 1. Redistributions of source code must retain the above copyright
131.11Slukem#    notice, this list of conditions and the following disclaimer.
141.11Slukem# 2. Redistributions in binary form must reproduce the above copyright
151.11Slukem#    notice, this list of conditions and the following disclaimer in the
161.11Slukem#    documentation and/or other materials provided with the distribution.
171.11Slukem# 3. All advertising materials mentioning features or use of this software
181.11Slukem#    must display the following acknowledgement:
191.11Slukem#        This product includes software developed by the NetBSD
201.11Slukem#        Foundation, Inc. and its contributors.
211.11Slukem# 4. Neither the name of The NetBSD Foundation nor the names of its
221.11Slukem#    contributors may be used to endorse or promote products derived
231.11Slukem#    from this software without specific prior written permission.
241.11Slukem#
251.11Slukem# THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
261.11Slukem# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
271.11Slukem# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
281.11Slukem# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
291.11Slukem# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
301.11Slukem# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
311.11Slukem# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
321.11Slukem# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
331.11Slukem# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
341.11Slukem# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
351.11Slukem# POSSIBILITY OF SUCH DAMAGE.
361.11Slukem#
371.11Slukem# rc.subr
381.11Slukem#	functions used by various rc scripts
391.11Slukem#
401.11Slukem
411.62Sjmmv: ${rcvar_manpage:='rc.conf(5)'}
421.62Sjmmv
431.11Slukem#
441.11Slukem#	functions
451.11Slukem#	---------
461.1Scjs
471.5Slukem#
481.11Slukem# checkyesno var
491.5Slukem#	Test $1 variable, and warn if not set to YES or NO.
501.11Slukem#	Return 0 if it's "yes" (et al), nonzero otherwise.
511.5Slukem#
521.11Slukemcheckyesno()
531.11Slukem{
541.11Slukem	eval _value=\$${1}
551.11Slukem	case $_value in
561.4Slukem
571.4Slukem		#	"yes", "true", "on", or "1"
581.4Slukem	[Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
591.4Slukem		return 0
601.3Slukem		;;
611.4Slukem
621.4Slukem		#	"no", "false", "off", or "0"
631.4Slukem	[Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
641.4Slukem		return 1
651.3Slukem		;;
661.3Slukem	*)
671.62Sjmmv		warn "\$${1} is not set properly - see ${rcvar_manpage}."
681.4Slukem		return 1
691.3Slukem		;;
701.3Slukem	esac
711.38Slukem}
721.38Slukem
731.65Slukem#
741.38Slukem# reverse_list list
751.38Slukem#	print the list in reverse order
761.38Slukem#
771.38Slukemreverse_list()
781.38Slukem{
791.38Slukem	_revlist=
801.56Schristos	for _revfile; do
811.38Slukem		_revlist="$_revfile $_revlist"
821.38Slukem	done
831.38Slukem	echo $_revlist
841.6Smellon}
851.6Smellon
861.6Smellon#
871.47Slukem# mount_critical_filesystems type
881.47Slukem#	Go through the list of critical filesystems as provided in
891.47Slukem#	the rc.conf(5) variable $critical_filesystems_${type}, checking
901.47Slukem#	each one to see if it is mounted, and if it is not, mounting it.
911.6Smellon#
921.11Slukemmount_critical_filesystems()
931.11Slukem{
941.47Slukem	eval _fslist=\$critical_filesystems_${1}
951.17Slukem	for _fs in $_fslist; do
961.6Smellon		mount | (
971.53Slukem			_ismounted=false
981.6Smellon			while read what _on on _type type; do
991.17Slukem				if [ $on = $_fs ]; then
1001.53Slukem					_ismounted=true
1011.6Smellon				fi
1021.6Smellon			done
1031.53Slukem			if $_ismounted; then
1041.55Slukem				:
1051.55Slukem			else
1061.17Slukem				mount $_fs >/dev/null 2>&1
1071.6Smellon			fi
1081.46Slukem		)
1091.6Smellon	done
1101.7Scjs}
1111.7Scjs
1121.11Slukem#
1131.45Slukem# check_pidfile pidfile procname [interpreter]
1141.45Slukem#	Parses the first line of pidfile for a PID, and ensures
1151.11Slukem#	that the process is running and matches procname.
1161.45Slukem#	Prints the matching PID upon success, nothing otherwise.
1171.45Slukem#	interpreter is optional; see _find_processes() for details.
1181.11Slukem#
1191.11Slukemcheck_pidfile()
1201.11Slukem{
1211.11Slukem	_pidfile=$1
1221.11Slukem	_procname=$2
1231.45Slukem	_interpreter=$3
1241.11Slukem	if [ -z "$_pidfile" -o -z "$_procname" ]; then
1251.45Slukem		err 3 'USAGE: check_pidfile pidfile procname [interpreter]'
1261.11Slukem	fi
1271.11Slukem	if [ ! -f $_pidfile ]; then
1281.11Slukem		return
1291.11Slukem	fi
1301.11Slukem	read _pid _junk < $_pidfile
1311.11Slukem	if [ -z "$_pid" ]; then
1321.11Slukem		return
1331.11Slukem	fi
1341.45Slukem	_find_processes $_procname ${_interpreter:-.} '-p '"$_pid"
1351.11Slukem}
1361.11Slukem
1371.11Slukem#
1381.45Slukem# check_process procname [interpreter]
1391.11Slukem#	Ensures that a process (or processes) named procname is running.
1401.45Slukem#	Prints a list of matching PIDs.
1411.45Slukem#	interpreter is optional; see _find_processes() for details.
1421.11Slukem#
1431.11Slukemcheck_process()
1441.11Slukem{
1451.11Slukem	_procname=$1
1461.45Slukem	_interpreter=$2
1471.11Slukem	if [ -z "$_procname" ]; then
1481.45Slukem		err 3 'USAGE: check_process procname [interpreter]'
1491.45Slukem	fi
1501.45Slukem	_find_processes $_procname ${_interpreter:-.} '-ax'
1511.45Slukem}
1521.45Slukem
1531.46Slukem#
1541.45Slukem# _find_processes procname interpreter psargs
1551.45Slukem#	Search for procname in the output of ps generated by psargs.
1561.45Slukem#	Prints the PIDs of any matching processes, space separated.
1571.45Slukem#
1581.45Slukem#	If interpreter == ".", check the following variations of procname
1591.45Slukem#	against the first word of each command:
1601.45Slukem#		procname
1611.45Slukem#		`basename procname`
1621.45Slukem#		`basename procname` + ":"
1631.45Slukem#		"(" + `basename procname` + ")"
1641.45Slukem#
1651.45Slukem#	If interpreter != ".", read the first line of procname, remove the
1661.45Slukem#	leading #!, normalise whitespace, append procname, and attempt to
1671.45Slukem#	match that against each command, either as is, or with extra words
1681.45Slukem#	at the end.
1691.45Slukem#
1701.45Slukem_find_processes()
1711.45Slukem{
1721.45Slukem	if [ $# -ne 3 ]; then
1731.45Slukem		err 3 'USAGE: _find_processes procname interpreter psargs'
1741.11Slukem	fi
1751.45Slukem	_procname=$1
1761.45Slukem	_interpreter=$2
1771.45Slukem	_psargs=$3
1781.45Slukem
1791.11Slukem	_pref=
1801.45Slukem	if [ $_interpreter != "." ]; then	# an interpreted script
1811.45Slukem		read _interp < $_procname	# read interpreter name
1821.45Slukem		_interp=${_interp#\#!}		# strip #!
1831.45Slukem		set -- $_interp
1841.45Slukem		if [ $_interpreter != $1 ]; then
1851.45Slukem			warn "\$command_interpreter $_interpreter != $1"
1861.45Slukem		fi
1871.45Slukem		_interp="$* $_procname"		# cleanup spaces, add _procname
1881.45Slukem		_fp_args='_argv'
1891.45Slukem		_fp_match='case "$_argv" in
1901.45Slukem		    ${_interp}|"${_interp} "*)'
1911.45Slukem	else					# a normal daemon
1921.45Slukem		_procnamebn=${_procname##*/}
1931.45Slukem		_fp_args='_arg0 _argv'
1941.45Slukem		_fp_match='case "$_arg0" in
1951.45Slukem		    $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})")'
1961.45Slukem	fi
1971.45Slukem
1981.45Slukem	_proccheck='
1991.46Slukem		ps -o "pid,command" '"$_psargs"' |
2001.45Slukem		while read _npid '"$_fp_args"'; do
2011.45Slukem			case "$_npid" in
2021.45Slukem			    PID)
2031.45Slukem				continue ;;
2041.45Slukem			esac ; '"$_fp_match"'
2051.45Slukem				echo -n "$_pref$_npid" ;
2061.45Slukem				_pref=" "
2071.45Slukem				;;
2081.45Slukem			esac
2091.45Slukem		done'
2101.45Slukem
2111.45Slukem#echo 1>&2 "proccheck is :$_proccheck:"
2121.45Slukem	eval $_proccheck
2131.11Slukem}
2141.11Slukem
2151.11Slukem#
2161.33Slukem# wait_for_pids pid [pid ...]
2171.35Slukem#	spins until none of the pids exist
2181.33Slukem#
2191.33Slukemwait_for_pids()
2201.33Slukem{
2211.56Schristos	_list="$@"
2221.33Slukem	if [ -z "$_list" ]; then
2231.33Slukem		return
2241.33Slukem	fi
2251.35Slukem	_prefix=
2261.35Slukem	while true; do
2271.33Slukem		_nlist="";
2281.33Slukem		for _j in $_list; do
2291.33Slukem			if kill -0 $_j 2>/dev/null; then
2301.33Slukem				_nlist="${_nlist}${_nlist:+ }$_j"
2311.33Slukem			fi
2321.33Slukem		done
2331.33Slukem		if [ -z "$_nlist" ]; then
2341.33Slukem			break
2351.33Slukem		fi
2361.33Slukem		_list=$_nlist
2371.35Slukem		echo -n ${_prefix:-"Waiting for PIDS: "}$_list
2381.35Slukem		_prefix=", "
2391.35Slukem		sleep 2
2401.33Slukem	done
2411.35Slukem	if [ -n "$_prefix" ]; then
2421.35Slukem		echo "."
2431.35Slukem	fi
2441.33Slukem}
2451.33Slukem
2461.33Slukem#
2471.46Slukem# run_rc_command argument
2481.46Slukem#	Search for argument in the list of supported commands, which is:
2491.33Slukem#		"start stop restart rcvar status poll ${extra_commands}"
2501.46Slukem#	If there's a match, run ${argument}_cmd or the default method
2511.46Slukem#	(see below).
2521.11Slukem#
2531.46Slukem#	If argument has a given prefix, then change the operation as follows:
2541.46Slukem#		Prefix	Operation
2551.11Slukem#		------	---------
2561.48Slukem#		fast	Skip the pid check, and set rc_fast=yes
2571.48Slukem#		force	Set ${rcvar} to YES, and set rc_force=yes
2581.61Slukem#		one	Set ${rcvar} to YES
2591.11Slukem#
2601.11Slukem#	The following globals are used:
2611.24Slukem#
2621.46Slukem#	Name		Needed	Purpose
2631.46Slukem#	----		------	-------
2641.11Slukem#	name		y	Name of script.
2651.24Slukem#
2661.11Slukem#	command		n	Full path to command.
2671.46Slukem#				Not needed if ${rc_arg}_cmd is set for
2681.11Slukem#				each keyword.
2691.24Slukem#
2701.11Slukem#	command_args	n	Optional args/shell directives for command.
2711.24Slukem#
2721.45Slukem#	command_interpreter n	If not empty, command is interpreted, so
2731.45Slukem#				call check_{pidfile,process}() appropriately.
2741.45Slukem#
2751.16Slukem#	extra_commands	n	List of extra commands supported.
2761.24Slukem#
2771.42Slukem#	pidfile		n	If set, use check_pidfile $pidfile $command,
2781.42Slukem#				otherwise use check_process $command.
2791.42Slukem#				In either case, only check if $command is set.
2801.42Slukem#
2811.42Slukem#	procname	n	Process name to check for instead of $command.
2821.24Slukem#
2831.24Slukem#	rcvar		n	This is checked with checkyesno to determine
2841.24Slukem#				if the action should be run.
2851.24Slukem#
2861.22Slukem#	${name}_chroot	n	Directory to chroot to before running ${command}
2871.42Slukem#				Requires /usr to be mounted.
2881.24Slukem#
2891.22Slukem#	${name}_chdir	n	Directory to cd to before running ${command}
2901.22Slukem#				(if not using ${name}_chroot).
2911.24Slukem#
2921.11Slukem#	${name}_flags	n	Arguments to call ${command} with.
2931.24Slukem#				NOTE:	$flags from the parent environment
2941.24Slukem#					can be used to override this.
2951.24Slukem#
2961.23Slukem#	${name}_nice	n	Nice level to run ${command} at.
2971.24Slukem#
2981.22Slukem#	${name}_user	n	User to run ${command} as, using su(1) if not
2991.22Slukem#				using ${name}_chroot.
3001.42Slukem#				Requires /usr to be mounted.
3011.24Slukem#
3021.22Slukem#	${name}_group	n	Group to run chrooted ${command} as.
3031.42Slukem#				Requires /usr to be mounted.
3041.24Slukem#
3051.32Slukem#	${name}_groups	n	Comma separated list of supplementary groups
3061.32Slukem#				to run the chrooted ${command} with.
3071.42Slukem#				Requires /usr to be mounted.
3081.24Slukem#
3091.50Satatat#	${name}_systrace n	Flags passed to systrace(1) if it is used.
3101.50Satatat#				Setting this variable enables systracing
3111.50Satatat# 				of the given program.  The use of "-a" is
3121.50Satatat#				recommended so that the boot process is not
3131.50Satatat#				stalled.  In order to pass no flags to
3141.50Satatat#				systrace, set this variable to "--".
3151.50Satatat#
3161.46Slukem#	${rc_arg}_cmd	n	If set, use this as the method when invoked;
3171.11Slukem#				Otherwise, use default command (see below)
3181.24Slukem#
3191.46Slukem#	${rc_arg}_precmd n	If set, run just before performing the
3201.46Slukem#				${rc_arg}_cmd method in the default
3211.46Slukem#				operation (i.e, after checking for required
3221.46Slukem#				bits and process (non)existence).
3231.11Slukem#				If this completes with a non-zero exit code,
3241.46Slukem#				don't run ${rc_arg}_cmd.
3251.24Slukem#
3261.46Slukem#	${rc_arg}_postcmd n	If set, run just after performing the
3271.46Slukem#				${rc_arg}_cmd method, if that method
3281.43Slukem#				returned a zero exit code.
3291.43Slukem#
3301.11Slukem#	required_dirs	n	If set, check for the existence of the given
3311.11Slukem#				directories before running the default
3321.11Slukem#				(re)start command.
3331.24Slukem#
3341.11Slukem#	required_files	n	If set, check for the readability of the given
3351.11Slukem#				files before running the default (re)start
3361.11Slukem#				command.
3371.24Slukem#
3381.11Slukem#	required_vars	n	If set, perform checkyesno on each of the
3391.11Slukem#				listed variables before running the default
3401.11Slukem#				(re)start command.
3411.11Slukem#
3421.46Slukem#	Default behaviour for a given argument, if no override method is
3431.46Slukem#	provided:
3441.24Slukem#
3451.46Slukem#	Argument	Default behaviour
3461.46Slukem#	--------	-----------------
3471.11Slukem#	start		if !running && checkyesno ${rcvar}
3481.11Slukem#				${command}
3491.24Slukem#
3501.11Slukem#	stop		if ${pidfile}
3511.46Slukem#				rc_pid=$(check_pidfile $pidfile $command)
3521.11Slukem#			else
3531.46Slukem#				rc_pid=$(check_process $command)
3541.46Slukem#			kill $sig_stop $rc_pid
3551.46Slukem#			wait_for_pids $rc_pid
3561.35Slukem#			($sig_stop defaults to TERM.)
3571.24Slukem#
3581.35Slukem#	reload		Similar to stop, except use $sig_reload instead,
3591.35Slukem#			and doesn't wait_for_pids.
3601.11Slukem#			$sig_reload defaults to HUP.
3611.24Slukem#
3621.11Slukem#	restart		Run `stop' then `start'.
3631.11Slukem#
3641.33Slukem#	status		Show if ${command} is running, etc.
3651.33Slukem#
3661.33Slukem#	poll		Wait for ${command} to exit.
3671.33Slukem#
3681.33Slukem#	rcvar		Display what rc.conf variable is used (if any).
3691.33Slukem#
3701.46Slukem#	Variables available to methods, and after run_rc_command() has
3711.46Slukem#	completed:
3721.46Slukem#
3731.46Slukem#	Variable	Purpose
3741.46Slukem#	--------	-------
3751.61Slukem#	rc_arg		Argument to command, after fast/force/one processing
3761.46Slukem#			performed
3771.46Slukem#
3781.46Slukem#	rc_flags	Flags to start the default command with.
3791.46Slukem#			Defaults to ${name}_flags, unless overridden
3801.46Slukem#			by $flags from the environment.
3811.46Slukem#			This variable may be changed by the precmd method.
3821.46Slukem#
3831.46Slukem#	rc_pid		PID of command (if appropriate)
3841.46Slukem#
3851.46Slukem#	rc_fast		Not empty if "fast" was provided (q.v.)
3861.46Slukem#
3871.46Slukem#	rc_force	Not empty if "force" was provided (q.v.)
3881.33Slukem#
3891.24Slukem#
3901.11Slukemrun_rc_command()
3911.11Slukem{
3921.46Slukem	rc_arg=$1
3931.24Slukem	if [ -z "$name" ]; then
3941.30Slukem		err 3 'run_rc_command: $name is not set.'
3951.11Slukem	fi
3961.11Slukem
3971.61Slukem	_rc_prefix=
3981.46Slukem	case "$rc_arg" in
3991.24Slukem	fast*)				# "fast" prefix; don't check pid
4001.46Slukem		rc_arg=${rc_arg#fast}
4011.48Slukem		rc_fast=yes
4021.11Slukem		;;
4031.61Slukem	force*)				# "force" prefix; always run
4041.48Slukem		rc_force=yes
4051.61Slukem		_rc_prefix=force
4061.61Slukem		rc_arg=${rc_arg#${_rc_prefix}}
4071.61Slukem		if [ -n "${rcvar}" ]; then
4081.61Slukem			eval ${rcvar}=YES
4091.61Slukem		fi
4101.61Slukem		;;
4111.61Slukem	one*)				# "one" prefix; set ${rcvar}=yes
4121.61Slukem		_rc_prefix=one
4131.61Slukem		rc_arg=${rc_arg#${_rc_prefix}}
4141.29Slukem		if [ -n "${rcvar}" ]; then
4151.29Slukem			eval ${rcvar}=YES
4161.29Slukem		fi
4171.11Slukem		;;
4181.11Slukem	esac
4191.11Slukem
4201.16Slukem	_keywords="start stop restart rcvar $extra_commands"
4211.46Slukem	rc_pid=
4221.11Slukem	_pidcmd=
4231.42Slukem	_procname=${procname:-${command}}
4241.42Slukem
4251.24Slukem					# setup pid check command if not fast
4261.46Slukem	if [ -z "$rc_fast" -a -n "$_procname" ]; then
4271.11Slukem		if [ -n "$pidfile" ]; then
4281.46Slukem			_pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')'
4291.42Slukem		else
4301.46Slukem			_pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')'
4311.11Slukem		fi
4321.11Slukem		if [ -n "$_pidcmd" ]; then
4331.33Slukem			_keywords="${_keywords} status poll"
4341.11Slukem		fi
4351.11Slukem	fi
4361.11Slukem
4371.46Slukem	if [ -z "$rc_arg" ]; then
4381.11Slukem		rc_usage "$_keywords"
4391.11Slukem	fi
4401.11Slukem
4411.17Slukem	if [ -n "$flags" ]; then	# allow override from environment
4421.46Slukem		rc_flags=$flags
4431.11Slukem	else
4441.46Slukem		eval rc_flags=\$${name}_flags
4451.11Slukem	fi
4461.30Slukem	eval _chdir=\$${name}_chdir	_chroot=\$${name}_chroot \
4471.30Slukem	    _nice=\$${name}_nice	_user=\$${name}_user \
4481.50Satatat	    _group=\$${name}_group	_groups=\$${name}_groups \
4491.50Satatat	    _systrace=\$${name}_systrace
4501.11Slukem
4511.42Slukem	if [ -n "$_user" ]; then	# unset $_user if running as that user
4521.42Slukem		if [ "$_user" = "$(id -un)" ]; then
4531.42Slukem			unset _user
4541.42Slukem		fi
4551.42Slukem	fi
4561.42Slukem
4571.29Slukem					# if ${rcvar} is set, and $1 is not
4581.40Slukem					# "rcvar", then run
4591.29Slukem					#	checkyesno ${rcvar}
4601.29Slukem					# and return if that failed
4611.24Slukem					#
4621.46Slukem	if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" ]; then
4631.24Slukem		if ! checkyesno ${rcvar}; then
4641.24Slukem			return 0
4651.24Slukem		fi
4661.24Slukem	fi
4671.24Slukem
4681.24Slukem	eval $_pidcmd			# determine the pid if necessary
4691.11Slukem
4701.11Slukem	for _elem in $_keywords; do
4711.46Slukem		if [ "$_elem" != "$rc_arg" ]; then
4721.11Slukem			continue
4731.11Slukem		fi
4741.11Slukem
4751.24Slukem					# if there's a custom ${XXX_cmd},
4761.24Slukem					# run that instead of the default
4771.24Slukem					#
4781.46Slukem		eval _cmd=\$${rc_arg}_cmd _precmd=\$${rc_arg}_precmd \
4791.46Slukem		    _postcmd=\$${rc_arg}_postcmd
4801.11Slukem		if [ -n "$_cmd" ]; then
4811.24Slukem					# if the precmd failed and force
4821.24Slukem					# isn't set, exit
4831.24Slukem					#
4841.46Slukem			if ! eval $_precmd && [ -z "$rc_force" ]; then
4851.24Slukem				return 1
4861.24Slukem			fi
4871.24Slukem
4881.46Slukem			if ! eval $_cmd && [ -z "$rc_force" ]; then
4891.44Slukem				return 1
4901.44Slukem			fi
4911.44Slukem			eval $_postcmd
4921.11Slukem			return 0
4931.11Slukem		fi
4941.11Slukem
4951.46Slukem		case "$rc_arg" in	# default operations...
4961.11Slukem
4971.11Slukem		status)
4981.46Slukem			if [ -n "$rc_pid" ]; then
4991.46Slukem				echo "${name} is running as pid $rc_pid."
5001.11Slukem			else
5011.11Slukem				echo "${name} is not running."
5021.28Slukem				return 1
5031.11Slukem			fi
5041.11Slukem			;;
5051.11Slukem
5061.11Slukem		start)
5071.46Slukem			if [ -n "$rc_pid" ]; then
5081.63Slukem				echo 1>&2 "${name} already running? (pid=$rc_pid)."
5091.11Slukem				exit 1
5101.11Slukem			fi
5111.11Slukem
5121.57Slukem			if [ ! -x ${_chroot}${command} ]; then
5131.11Slukem				return 0
5141.11Slukem			fi
5151.11Slukem
5161.24Slukem					# check for required variables,
5171.24Slukem					# directories, and files
5181.24Slukem					#
5191.11Slukem			for _f in $required_vars; do
5201.11Slukem				if ! checkyesno $_f; then
5211.65Slukem					warn "\$${_f} is not enabled."
5221.46Slukem					if [ -z "$rc_force" ]; then
5231.24Slukem						return 1
5241.24Slukem					fi
5251.11Slukem				fi
5261.11Slukem			done
5271.11Slukem			for _f in $required_dirs; do
5281.11Slukem				if [ ! -d "${_f}/." ]; then
5291.25Slukem					warn "${_f} is not a directory."
5301.46Slukem					if [ -z "$rc_force" ]; then
5311.24Slukem						return 1
5321.24Slukem					fi
5331.11Slukem				fi
5341.11Slukem			done
5351.11Slukem			for _f in $required_files; do
5361.11Slukem				if [ ! -r "${_f}" ]; then
5371.25Slukem					warn "${_f} is not readable."
5381.46Slukem					if [ -z "$rc_force" ]; then
5391.24Slukem						return 1
5401.24Slukem					fi
5411.11Slukem				fi
5421.11Slukem			done
5431.11Slukem
5441.24Slukem					# if the precmd failed and force
5451.24Slukem					# isn't set, exit
5461.24Slukem					#
5471.46Slukem			if ! eval $_precmd && [ -z "$rc_force" ]; then
5481.24Slukem				return 1
5491.24Slukem			fi
5501.24Slukem
5511.24Slukem					# setup the command to run, and run it
5521.29Slukem					#
5531.11Slukem			echo "Starting ${name}."
5541.22Slukem			if [ -n "$_chroot" ]; then
5551.22Slukem				_doit="\
5561.23Slukem${_nice:+nice -n $_nice }\
5571.50Satatat${_systrace:+systrace $_systrace }\
5581.22Slukemchroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\
5591.46Slukem$_chroot $command $rc_flags $command_args"
5601.22Slukem			else
5611.22Slukem				_doit="\
5621.18Slukem${_chdir:+cd $_chdir; }\
5631.18Slukem${_nice:+nice -n $_nice }\
5641.50Satatat${_systrace:+systrace $_systrace }\
5651.46Slukem$command $rc_flags $command_args"
5661.34Slukem				if [ -n "$_user" ]; then
5671.34Slukem				    _doit="su -m $_user -c 'sh -c \"$_doit\"'"
5681.34Slukem				fi
5691.22Slukem			fi
5701.43Slukem
5711.43Slukem					# if the cmd failed and force
5721.43Slukem					# isn't set, exit
5731.43Slukem					#
5741.46Slukem			if ! eval $_doit && [ -z "$rc_force" ]; then
5751.43Slukem				return 1
5761.43Slukem			fi
5771.43Slukem
5781.43Slukem					# finally, run postcmd
5791.43Slukem					#
5801.43Slukem			eval $_postcmd
5811.11Slukem			;;
5821.11Slukem
5831.11Slukem		stop)
5841.46Slukem			if [ -z "$rc_pid" ]; then
5851.24Slukem				if [ -n "$pidfile" ]; then
5861.63Slukem					echo 1>&2 \
5871.24Slukem				    "${name} not running? (check $pidfile)."
5881.24Slukem				else
5891.63Slukem					echo 1>&2 "${name} not running?"
5901.11Slukem				fi
5911.24Slukem				exit 1
5921.11Slukem			fi
5931.11Slukem
5941.43Slukem					# if the precmd failed and force
5951.43Slukem					# isn't set, exit
5961.43Slukem					#
5971.46Slukem			if ! eval $_precmd && [ -z "$rc_force" ]; then
5981.24Slukem				return 1
5991.24Slukem			fi
6001.43Slukem
6011.43Slukem					# send the signal to stop
6021.43Slukem					#
6031.11Slukem			echo "Stopping ${name}."
6041.46Slukem			_doit="kill -${sig_stop:-TERM} $rc_pid"
6051.34Slukem			if [ -n "$_user" ]; then
6061.34Slukem				_doit="su -m $_user -c 'sh -c \"$_doit\"'"
6071.34Slukem			fi
6081.43Slukem
6091.43Slukem					# if the stop cmd failed and force
6101.43Slukem					# isn't set, exit
6111.43Slukem					#
6121.46Slukem			if ! eval $_doit && [ -z "$rc_force" ]; then
6131.43Slukem				return 1
6141.43Slukem			fi
6151.43Slukem
6161.43Slukem					# wait for the command to exit,
6171.43Slukem					# and run postcmd.
6181.46Slukem			wait_for_pids $rc_pid
6191.43Slukem			eval $_postcmd
6201.11Slukem			;;
6211.11Slukem
6221.11Slukem		reload)
6231.46Slukem			if [ -z "$rc_pid" ]; then
6241.24Slukem				if [ -n "$pidfile" ]; then
6251.63Slukem					echo 1>&2 \
6261.11Slukem				    "${name} not running? (check $pidfile)."
6271.24Slukem				else
6281.63Slukem					echo 1>&2 "${name} not running?"
6291.11Slukem				fi
6301.24Slukem				exit 1
6311.11Slukem			fi
6321.11Slukem			echo "Reloading ${name} config files."
6331.46Slukem			if ! eval $_precmd && [ -z "$rc_force" ]; then
6341.24Slukem				return 1
6351.24Slukem			fi
6361.46Slukem			_doit="kill -${sig_reload:-HUP} $rc_pid"
6371.34Slukem			if [ -n "$_user" ]; then
6381.34Slukem				_doit="su -m $_user -c 'sh -c \"$_doit\"'"
6391.34Slukem			fi
6401.46Slukem			if ! eval $_doit && [ -z "$rc_force" ]; then
6411.43Slukem				return 1
6421.43Slukem			fi
6431.43Slukem			eval $_postcmd
6441.11Slukem			;;
6451.11Slukem
6461.11Slukem		restart)
6471.46Slukem			if ! eval $_precmd && [ -z "$rc_force" ]; then
6481.24Slukem				return 1
6491.11Slukem			fi
6501.29Slukem					# prevent restart being called more
6511.29Slukem					# than once by any given script
6521.29Slukem					#
6531.53Slukem			if ${_rc_restart_done:-false}; then
6541.29Slukem				return 0
6551.29Slukem			fi
6561.53Slukem			_rc_restart_done=true
6571.33Slukem
6581.61Slukem			( $0 ${_rc_prefix}stop )
6591.61Slukem			$0 ${_rc_prefix}start
6601.11Slukem
6611.43Slukem			eval $_postcmd
6621.33Slukem			;;
6631.33Slukem
6641.33Slukem		poll)
6651.46Slukem			if [ -n "$rc_pid" ]; then
6661.46Slukem				wait_for_pids $rc_pid
6671.33Slukem			fi
6681.11Slukem			;;
6691.11Slukem
6701.11Slukem		rcvar)
6711.11Slukem			echo "# $name"
6721.24Slukem			if [ -n "$rcvar" ]; then
6731.24Slukem				if checkyesno ${rcvar}; then
6741.24Slukem					echo "\$${rcvar}=YES"
6751.24Slukem				else
6761.24Slukem					echo "\$${rcvar}=NO"
6771.24Slukem				fi
6781.11Slukem			fi
6791.11Slukem			;;
6801.11Slukem
6811.11Slukem		*)
6821.11Slukem			rc_usage "$_keywords"
6831.11Slukem			;;
6841.11Slukem
6851.11Slukem		esac
6861.11Slukem		return 0
6871.11Slukem	done
6881.11Slukem
6891.46Slukem	echo 1>&2 "$0: unknown directive '$rc_arg'."
6901.11Slukem	rc_usage "$_keywords"
6911.11Slukem	exit 1
6921.11Slukem}
6931.11Slukem
6941.11Slukem#
6951.11Slukem# run_rc_script file arg
6961.11Slukem#	Start the script `file' with `arg', and correctly handle the
6971.17Slukem#	return value from the script.  If `file' ends with `.sh', it's
6981.37Slukem#	sourced into the current environment.  If `file' appears to be
6991.37Slukem#	a backup or scratch file, ignore it.  Otherwise if it's
7001.37Slukem#	executable run as a child process.
7011.17Slukem#
7021.11Slukemrun_rc_script()
7031.11Slukem{
7041.11Slukem	_file=$1
7051.11Slukem	_arg=$2
7061.11Slukem	if [ -z "$_file" -o -z "$_arg" ]; then
7071.11Slukem		err 3 'USAGE: run_rc_script file arg'
7081.11Slukem	fi
7091.11Slukem
7101.45Slukem	unset	name command command_args command_interpreter \
7111.45Slukem		extra_commands pidfile procname \
7121.42Slukem		rcvar required_dirs required_files required_vars
7131.43Slukem	eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd
7141.39Slukem
7151.39Slukem	case "$_file" in
7161.39Slukem	*.sh)				# run in current shell
7171.11Slukem		set $_arg ; . $_file
7181.39Slukem		;;
7191.60Slukem	*[~#]|*.OLD|*.orig|*,v)		# scratch file; skip
7201.39Slukem		warn "Ignoring scratch file $_file"
7211.39Slukem		;;
7221.39Slukem	*)				# run in subshell
7231.39Slukem		if [ -x $_file ]; then
7241.39Slukem			if [ -n "$rc_fast_and_loose" ]; then
7251.39Slukem				set $_arg ; . $_file
7261.39Slukem			else
7271.37Slukem				( set $_arg ; . $_file )
7281.37Slukem			fi
7291.39Slukem		fi
7301.39Slukem		;;
7311.39Slukem	esac
7321.11Slukem}
7331.19Slukem
7341.19Slukem#
7351.65Slukem# load_rc_config command
7361.19Slukem#	Source in the configuration file for a given command.
7371.19Slukem#
7381.19Slukemload_rc_config()
7391.19Slukem{
7401.19Slukem	_command=$1
7411.19Slukem	if [ -z "$_command" ]; then
7421.19Slukem		err 3 'USAGE: load_rc_config command'
7431.19Slukem	fi
7441.19Slukem
7451.54Slukem	if ${_rc_conf_loaded:-false}; then
7461.54Slukem		:
7471.54Slukem	else
7481.30Slukem		. /etc/rc.conf
7491.53Slukem		_rc_conf_loaded=true
7501.30Slukem	fi
7511.20Sfvdl	if [ -f /etc/rc.conf.d/"$_command" ]; then
7521.20Sfvdl		. /etc/rc.conf.d/"$_command"
7531.20Sfvdl	fi
7541.19Slukem}
7551.19Slukem
7561.65Slukem#
7571.65Slukem# load_rc_config_var cmd var
7581.65Slukem#	Read the rc.conf(5) var for cmd and set in the
7591.65Slukem#	current shell, using load_rc_config in a subshell to prevent
7601.65Slukem#	unwanted side effects from other variable assignments.
7611.65Slukem#
7621.65Slukemload_rc_config_var()
7631.65Slukem{
7641.65Slukem	if [ $# -ne 2 ]; then
7651.65Slukem		err 3 'USAGE: load_rc_config_var cmd var'
7661.65Slukem	fi
7671.65Slukem	eval $(eval '(
7681.65Slukem		load_rc_config '$1' >/dev/null;
7691.65Slukem                if [ -n "${'$2'}" -o "${'$2'-UNSET}" != "UNSET" ]; then
7701.65Slukem			echo '$2'=\'\''${'$2'}\'\'';
7711.65Slukem		fi
7721.65Slukem	)' )
7731.65Slukem}
7741.11Slukem
7751.11Slukem#
7761.11Slukem# rc_usage commands
7771.11Slukem#	Print a usage string for $0, with `commands' being a list of
7781.11Slukem#	valid commands.
7791.11Slukem#
7801.11Slukemrc_usage()
7811.11Slukem{
7821.61Slukem	echo -n 1>&2 "Usage: $0 [fast|force|one]("
7831.11Slukem
7841.11Slukem	_sep=
7851.56Schristos	for _elem; do
7861.11Slukem		echo -n 1>&2 "$_sep$_elem"
7871.11Slukem		_sep="|"
7881.11Slukem	done
7891.11Slukem	echo 1>&2 ")"
7901.11Slukem	exit 1
7911.11Slukem}
7921.11Slukem
7931.11Slukem#
7941.11Slukem# err exitval message
7951.11Slukem#	Display message to stderr and log to the syslog, and exit with exitval.
7961.11Slukem#
7971.11Slukemerr()
7981.11Slukem{
7991.11Slukem	exitval=$1
8001.11Slukem	shift
8011.11Slukem
8021.51Sgrant	if [ -x /usr/bin/logger ]; then
8031.51Sgrant		logger "$0: ERROR: $*"
8041.51Sgrant	fi
8051.21Slukem	echo 1>&2 "$0: ERROR: $*"
8061.11Slukem	exit $exitval
8071.11Slukem}
8081.11Slukem
8091.11Slukem#
8101.11Slukem# warn message
8111.11Slukem#	Display message to stderr and log to the syslog.
8121.11Slukem#
8131.11Slukemwarn()
8141.11Slukem{
8151.51Sgrant	if [ -x /usr/bin/logger ]; then
8161.51Sgrant		logger "$0: WARNING: $*"
8171.51Sgrant	fi
8181.21Slukem	echo 1>&2 "$0: WARNING: $*"
8191.31Satatat}
8201.31Satatat
8211.31Satatat#
8221.31Satatat# backup_file action file cur backup
8231.31Satatat#	Make a backup copy of `file' into `cur', and save the previous
8241.31Satatat#	version of `cur' as `backup' or use rcs for archiving.
8251.31Satatat#
8261.31Satatat#	This routine checks the value of the backup_uses_rcs variable,
8271.31Satatat#	which can be either YES or NO.
8281.31Satatat#
8291.31Satatat#	The `action' keyword can be one of the following:
8301.31Satatat#
8311.31Satatat#	add		`file' is now being backed up (and is possibly
8321.31Satatat#			being reentered into the backups system).  `cur'
8331.31Satatat#			is created and RCS files, if necessary, are
8341.31Satatat#			created as well.
8351.31Satatat#
8361.31Satatat#	update		`file' has changed and needs to be backed up.
8371.31Satatat#			If `cur' exists, it is copied to to `back' or
8381.31Satatat#			checked into RCS (if the repository file is old),
8391.31Satatat#			and then `file' is copied to `cur'.  Another RCS
8401.31Satatat#			check in done here if RCS is being used.
8411.31Satatat#
8421.31Satatat#	remove		`file' is no longer being tracked by the backups
8431.31Satatat#			system.  If RCS is not being used, `cur' is moved
8441.31Satatat#			to `back', otherwise an empty file is checked in,
8451.31Satatat#			and then `cur' is removed.
8461.31Satatat#
8471.31Satatat#
8481.31Satatatbackup_file()
8491.31Satatat{
8501.31Satatat	_action=$1
8511.31Satatat	_file=$2
8521.31Satatat	_cur=$3
8531.31Satatat	_back=$4
8541.31Satatat
8551.31Satatat	if checkyesno backup_uses_rcs; then
8561.31Satatat		_msg0="backup archive"
8571.31Satatat		_msg1="update"
8581.31Satatat
8591.36Satatat		# ensure that history file is not locked
8601.36Satatat		if [ -f $_cur,v ]; then
8611.36Satatat			rcs -q -u -U -M $_cur
8621.36Satatat		fi
8631.36Satatat
8641.31Satatat		# ensure after switching to rcs that the
8651.31Satatat		# current backup is not lost
8661.31Satatat		if [ -f $_cur ]; then
8671.31Satatat			# no archive, or current newer than archive
8681.31Satatat			if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then
8691.36Satatat				ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
8701.36Satatat				rcs -q -kb -U $_cur
8711.49Slukem				co -q -f -u $_cur
8721.31Satatat			fi
8731.31Satatat		fi
8741.31Satatat
8751.31Satatat		case $_action in
8761.31Satatat		add|update)
8771.31Satatat			cp -p $_file $_cur
8781.36Satatat			ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
8791.36Satatat			rcs -q -kb -U $_cur
8801.49Slukem			co -q -f -u $_cur
8811.31Satatat			chown root:wheel $_cur $_cur,v
8821.31Satatat			;;
8831.31Satatat		remove)
8841.31Satatat			cp /dev/null $_cur
8851.36Satatat			ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
8861.36Satatat			rcs -q -kb -U $_cur
8871.31Satatat			chown root:wheel $_cur $_cur,v
8881.31Satatat			rm $_cur
8891.31Satatat			;;
8901.31Satatat		esac
8911.31Satatat	else
8921.31Satatat		case $_action in
8931.31Satatat		add|update)
8941.31Satatat			if [ -f $_cur ]; then
8951.31Satatat				cp -p $_cur $_back
8961.31Satatat			fi
8971.31Satatat			cp -p $_file $_cur
8981.31Satatat			chown root:wheel $_cur
8991.31Satatat			;;
9001.31Satatat		remove)
9011.31Satatat			mv -f $_cur $_back
9021.31Satatat			;;
9031.31Satatat		esac
9041.31Satatat	fi
9051.1Scjs}
9061.64Smycroft
9071.64Smycroft_rc_subr_loaded=:
908