rc.subr revision 175676
1164640Sflz# $NetBSD: rc.subr,v 1.67 2006/10/07 11:25:15 elad Exp $ 298186Sgordon# $FreeBSD: head/etc/rc.subr 175676 2008-01-26 11:22:12Z mtm $ 378344Sobrien# 4157473Sflz# Copyright (c) 1997-2004 The NetBSD Foundation, Inc. 578344Sobrien# All rights reserved. 678344Sobrien# 778344Sobrien# This code is derived from software contributed to The NetBSD Foundation 878344Sobrien# by Luke Mewburn. 978344Sobrien# 1078344Sobrien# Redistribution and use in source and binary forms, with or without 1178344Sobrien# modification, are permitted provided that the following conditions 1278344Sobrien# are met: 1378344Sobrien# 1. Redistributions of source code must retain the above copyright 1478344Sobrien# notice, this list of conditions and the following disclaimer. 1578344Sobrien# 2. Redistributions in binary form must reproduce the above copyright 1678344Sobrien# notice, this list of conditions and the following disclaimer in the 1778344Sobrien# documentation and/or other materials provided with the distribution. 1878344Sobrien# 3. All advertising materials mentioning features or use of this software 1978344Sobrien# must display the following acknowledgement: 2078344Sobrien# This product includes software developed by the NetBSD 2178344Sobrien# Foundation, Inc. and its contributors. 2278344Sobrien# 4. Neither the name of The NetBSD Foundation nor the names of its 2378344Sobrien# contributors may be used to endorse or promote products derived 2478344Sobrien# from this software without specific prior written permission. 2578344Sobrien# 2678344Sobrien# THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 2778344Sobrien# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2878344Sobrien# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2978344Sobrien# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 3078344Sobrien# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 3178344Sobrien# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 3278344Sobrien# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 3378344Sobrien# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 3478344Sobrien# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 3578344Sobrien# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 3678344Sobrien# POSSIBILITY OF SUCH DAMAGE. 3778344Sobrien# 3878344Sobrien# rc.subr 3978344Sobrien# functions used by various rc scripts 4078344Sobrien# 4178344Sobrien 42157473Sflz: ${rcvar_manpage:='rc.conf(5)'} 43169668Smtm: ${RC_PID:=$$}; export RC_PID 44157473Sflz 4578344Sobrien# 4698186Sgordon# Operating System dependent/independent variables 4798186Sgordon# 4898186Sgordon 49131550Scpercivaif [ -z "${_rc_subr_loaded}" ]; then 50131550Scperciva 51131550Scperciva_rc_subr_loaded="YES" 52131550Scperciva 5398186SgordonSYSCTL="/sbin/sysctl" 5498186SgordonSYSCTL_N="${SYSCTL} -n" 5598186SgordonCMD_OSTYPE="${SYSCTL_N} kern.ostype" 56103018SgordonOSTYPE=`${CMD_OSTYPE}` 57124832SmtmID="/usr/bin/id" 58124832SmtmIDCMD="if [ -x $ID ]; then $ID -un; fi" 59161435SyarPS="/bin/ps -ww" 60161435SyarJID=`$PS -p $$ -o jid=` 6198186Sgordon 62103018Sgordoncase ${OSTYPE} in 6398186SgordonFreeBSD) 6498186Sgordon SYSCTL_W="${SYSCTL}" 6598186Sgordon ;; 6698186SgordonNetBSD) 6798186Sgordon SYSCTL_W="${SYSCTL} -w" 6898186Sgordon ;; 6998186Sgordonesac 7098186Sgordon 7198186Sgordon# 7278344Sobrien# functions 7378344Sobrien# --------- 7478344Sobrien 7578344Sobrien# 7698186Sgordon# set_rcvar base_var 7798186Sgordon# Set the variable name enabling a specific service. 7898186Sgordon# FreeBSD uses ${service}_enable, while NetBSD uses 7998186Sgordon# just the name of the service. For example: 8098186Sgordon# FreeBSD: sendmail_enable="YES" 8198186Sgordon# NetBSD : sendmail="YES" 8298186Sgordon# $1 - if $name is not the base to work of off, specify 8398186Sgordon# a different one 8498186Sgordon# 8598186Sgordonset_rcvar() 8698186Sgordon{ 8798186Sgordon if [ -z "$1" ]; then 8898186Sgordon base_var=${name} 8998186Sgordon else 9098186Sgordon base_var="$1" 9198186Sgordon fi 9298186Sgordon 93103018Sgordon case ${OSTYPE} in 9498186Sgordon FreeBSD) 9598186Sgordon echo ${base_var}_enable 9698186Sgordon ;; 9798186Sgordon NetBSD) 9898186Sgordon echo ${base_var} 9998186Sgordon ;; 10098186Sgordon *) 10198186Sgordon echo 'XXX' 10298186Sgordon ;; 10398186Sgordon esac 10498186Sgordon} 10598186Sgordon 10698186Sgordon# 10798186Sgordon# force_depend script 10898186Sgordon# Force a service to start. Intended for use by services 10998186Sgordon# to resolve dependency issues. It is assumed the caller 11098186Sgordon# has check to make sure this call is necessary 11198186Sgordon# $1 - filename of script, in /etc/rc.d, to run 11298186Sgordon# 11398186Sgordonforce_depend() 11498186Sgordon{ 11598186Sgordon _depend="$1" 11698186Sgordon 11798186Sgordon info "${name} depends on ${_depend}, which will be forced to start." 118146490Sschweikh if ! /etc/rc.d/${_depend} forcestart; then 11998186Sgordon warn "Unable to force ${_depend}. It may already be running." 12098186Sgordon return 1 12198186Sgordon fi 12298186Sgordon return 0 12398186Sgordon} 12498186Sgordon 12598186Sgordon# 12678344Sobrien# checkyesno var 12778344Sobrien# Test $1 variable, and warn if not set to YES or NO. 12878344Sobrien# Return 0 if it's "yes" (et al), nonzero otherwise. 12978344Sobrien# 13078344Sobriencheckyesno() 13178344Sobrien{ 13278344Sobrien eval _value=\$${1} 13398186Sgordon debug "checkyesno: $1 is set to $_value." 13478344Sobrien case $_value in 13578344Sobrien 13678344Sobrien # "yes", "true", "on", or "1" 13778344Sobrien [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 13878344Sobrien return 0 13978344Sobrien ;; 14078344Sobrien 14178344Sobrien # "no", "false", "off", or "0" 14278344Sobrien [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0) 14378344Sobrien return 1 14478344Sobrien ;; 14578344Sobrien *) 146157473Sflz warn "\$${1} is not set properly - see ${rcvar_manpage}." 14778344Sobrien return 1 14878344Sobrien ;; 14978344Sobrien esac 15078344Sobrien} 15178344Sobrien 152157473Sflz# 15398186Sgordon# reverse_list list 15498186Sgordon# print the list in reverse order 15578344Sobrien# 15698186Sgordonreverse_list() 15798186Sgordon{ 15898186Sgordon _revlist= 159126286Smtm for _revfile; do 16098186Sgordon _revlist="$_revfile $_revlist" 16198186Sgordon done 16298186Sgordon echo $_revlist 16398186Sgordon} 16498186Sgordon 165169668Smtm# stop_boot always 166169668Smtm# If booting directly to multiuser or $always is enabled, 167169668Smtm# send SIGTERM to the parent (/etc/rc) to abort the boot. 168169668Smtm# Otherwise just exit. 16978344Sobrien# 170169668Smtmstop_boot() 171169668Smtm{ 172169668Smtm local always 173169668Smtm 174169668Smtm if [ -n "$1" ] && checkyesno $1; then 175169668Smtm always=true 176169668Smtm else 177169668Smtm always=false 178169668Smtm fi 179169668Smtm if [ "$autoboot" = yes -o "$always" = true ]; then 180169668Smtm echo "ERROR: ABORTING BOOT (sending SIGTERM to parent)!" 181169668Smtm kill -TERM ${RC_PID} 182169668Smtm fi 183169668Smtm exit 1 184169668Smtm} 185169668Smtm 186169668Smtm# 18798186Sgordon# mount_critical_filesystems type 18898186Sgordon# Go through the list of critical filesystems as provided in 18998186Sgordon# the rc.conf(5) variable $critical_filesystems_${type}, checking 19098186Sgordon# each one to see if it is mounted, and if it is not, mounting it. 19198186Sgordon# 19278344Sobrienmount_critical_filesystems() 19378344Sobrien{ 19498186Sgordon eval _fslist=\$critical_filesystems_${1} 19578344Sobrien for _fs in $_fslist; do 19678344Sobrien mount | ( 197126285Smtm _ismounted=false 19878344Sobrien while read what _on on _type type; do 19978344Sobrien if [ $on = $_fs ]; then 200126285Smtm _ismounted=true 20178344Sobrien fi 20278344Sobrien done 203126285Smtm if $_ismounted; then 204126285Smtm : 205126285Smtm else 20678344Sobrien mount $_fs >/dev/null 2>&1 20778344Sobrien fi 20898186Sgordon ) 20978344Sobrien done 21078344Sobrien} 21178344Sobrien 21278344Sobrien# 21398186Sgordon# check_pidfile pidfile procname [interpreter] 21498186Sgordon# Parses the first line of pidfile for a PID, and ensures 21578344Sobrien# that the process is running and matches procname. 21698186Sgordon# Prints the matching PID upon success, nothing otherwise. 21798186Sgordon# interpreter is optional; see _find_processes() for details. 21878344Sobrien# 21978344Sobriencheck_pidfile() 22078344Sobrien{ 22178344Sobrien _pidfile=$1 22278344Sobrien _procname=$2 22398186Sgordon _interpreter=$3 22478344Sobrien if [ -z "$_pidfile" -o -z "$_procname" ]; then 22598186Sgordon err 3 'USAGE: check_pidfile pidfile procname [interpreter]' 22678344Sobrien fi 22778344Sobrien if [ ! -f $_pidfile ]; then 228131061Smtm debug "pid file ($_pidfile): not readable." 22978344Sobrien return 23078344Sobrien fi 23178344Sobrien read _pid _junk < $_pidfile 23278344Sobrien if [ -z "$_pid" ]; then 233139949Skeramida debug "pid file ($_pidfile): no pid in file." 23478344Sobrien return 23578344Sobrien fi 23698186Sgordon _find_processes $_procname ${_interpreter:-.} '-p '"$_pid" 23778344Sobrien} 23878344Sobrien 23978344Sobrien# 24098186Sgordon# check_process procname [interpreter] 24178344Sobrien# Ensures that a process (or processes) named procname is running. 24298186Sgordon# Prints a list of matching PIDs. 24398186Sgordon# interpreter is optional; see _find_processes() for details. 24478344Sobrien# 24578344Sobriencheck_process() 24678344Sobrien{ 24778344Sobrien _procname=$1 24898186Sgordon _interpreter=$2 24978344Sobrien if [ -z "$_procname" ]; then 25098186Sgordon err 3 'USAGE: check_process procname [interpreter]' 25178344Sobrien fi 25298186Sgordon _find_processes $_procname ${_interpreter:-.} '-ax' 25398186Sgordon} 25498186Sgordon 25598186Sgordon# 25698186Sgordon# _find_processes procname interpreter psargs 25798186Sgordon# Search for procname in the output of ps generated by psargs. 25898186Sgordon# Prints the PIDs of any matching processes, space separated. 25998186Sgordon# 26098186Sgordon# If interpreter == ".", check the following variations of procname 26198186Sgordon# against the first word of each command: 26298186Sgordon# procname 26398186Sgordon# `basename procname` 26498186Sgordon# `basename procname` + ":" 26598186Sgordon# "(" + `basename procname` + ")" 266155719Sceri# "[" + `basename procname` + "]" 26798186Sgordon# 26898186Sgordon# If interpreter != ".", read the first line of procname, remove the 26998186Sgordon# leading #!, normalise whitespace, append procname, and attempt to 27098186Sgordon# match that against each command, either as is, or with extra words 271157841Sflz# at the end. As an alternative, to deal with interpreted daemons 272157841Sflz# using perl, the basename of the interpreter plus a colon is also 273157841Sflz# tried as the prefix to procname. 27498186Sgordon# 27598186Sgordon_find_processes() 27698186Sgordon{ 27798186Sgordon if [ $# -ne 3 ]; then 27898186Sgordon err 3 'USAGE: _find_processes procname interpreter psargs' 27998186Sgordon fi 28098186Sgordon _procname=$1 28198186Sgordon _interpreter=$2 28298186Sgordon _psargs=$3 28398186Sgordon 28478344Sobrien _pref= 28598186Sgordon if [ $_interpreter != "." ]; then # an interpreted script 286170282Syar _script=${_chroot}${_chroot:+"/"}$_procname 287170282Syar if [ -r $_script ]; then 288170282Syar read _interp < $_script # read interpreter name 289170282Syar case "$_interp" in 290170282Syar \#!*) 291170282Syar _interp=${_interp#\#!} # strip #! 292170282Syar set -- $_interp 293170282Syar case $1 in 294170282Syar */bin/env) 295170282Syar shift # drop env to get real name 296170282Syar ;; 297170282Syar esac 298170282Syar if [ $_interpreter != $1 ]; then 299170282Syar warn "\$command_interpreter $_interpreter != $1" 300170282Syar fi 301170282Syar ;; 302170282Syar *) 303170282Syar warn "no shebang line in $_script" 304170282Syar set -- $_interpreter 305170282Syar ;; 306170282Syar esac 307170282Syar else 308170282Syar warn "cannot read shebang line from $_script" 309170282Syar set -- $_interpreter 31078344Sobrien fi 31198186Sgordon _interp="$* $_procname" # cleanup spaces, add _procname 312157841Sflz _interpbn=${1##*/} 31398186Sgordon _fp_args='_argv' 31498186Sgordon _fp_match='case "$_argv" in 315157841Sflz ${_interp}|"${_interp} "*|"${_interpbn}: ${_procname}"*)' 31698186Sgordon else # a normal daemon 31798186Sgordon _procnamebn=${_procname##*/} 31898186Sgordon _fp_args='_arg0 _argv' 31998186Sgordon _fp_match='case "$_arg0" in 320151426Sjhb $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})"|"[${_procnamebn}]")' 32198186Sgordon fi 32298186Sgordon 323161435Syar _proccheck="\ 324161436Syar $PS 2>/dev/null -o pid= -o jid= -o command= $_psargs"' | 325157657Sflz while read _npid _jid '"$_fp_args"'; do 326161436Syar '"$_fp_match"' 327157657Sflz if [ "$JID" -eq "$_jid" ]; 328157657Sflz then echo -n "$_pref$_npid"; 329157657Sflz _pref=" "; 330157657Sflz fi 33198186Sgordon ;; 33298186Sgordon esac 33398186Sgordon done' 33498186Sgordon 335114272Smtm# debug "in _find_processes: proccheck is ($_proccheck)." 33698186Sgordon eval $_proccheck 33798186Sgordon} 33898186Sgordon 33998186Sgordon# 34098186Sgordon# wait_for_pids pid [pid ...] 34198186Sgordon# spins until none of the pids exist 34298186Sgordon# 34398186Sgordonwait_for_pids() 34498186Sgordon{ 345126286Smtm _list="$@" 34698186Sgordon if [ -z "$_list" ]; then 34798186Sgordon return 34898186Sgordon fi 34998186Sgordon _prefix= 35098186Sgordon while true; do 35198186Sgordon _nlist=""; 35298186Sgordon for _j in $_list; do 35398186Sgordon if kill -0 $_j 2>/dev/null; then 35498186Sgordon _nlist="${_nlist}${_nlist:+ }$_j" 35598186Sgordon fi 35698186Sgordon done 35798186Sgordon if [ -z "$_nlist" ]; then 35898186Sgordon break 35978344Sobrien fi 36098186Sgordon _list=$_nlist 36198186Sgordon echo -n ${_prefix:-"Waiting for PIDS: "}$_list 36298186Sgordon _prefix=", " 36398186Sgordon sleep 2 36478344Sobrien done 36598186Sgordon if [ -n "$_prefix" ]; then 36698186Sgordon echo "." 36798186Sgordon fi 36878344Sobrien} 36978344Sobrien 37078344Sobrien# 37198186Sgordon# run_rc_command argument 37298186Sgordon# Search for argument in the list of supported commands, which is: 37398186Sgordon# "start stop restart rcvar status poll ${extra_commands}" 37498186Sgordon# If there's a match, run ${argument}_cmd or the default method 37598186Sgordon# (see below). 37678344Sobrien# 37798186Sgordon# If argument has a given prefix, then change the operation as follows: 37898186Sgordon# Prefix Operation 37978344Sobrien# ------ --------- 380175676Smtm# fast Skip the pid check, and set rc_fast=yes, rc_quiet=yes 38198186Sgordon# force Set ${rcvar} to YES, and set rc_force=yes 382126303Smtm# one Set ${rcvar} to YES 383175676Smtm# quiet Don't output some diagnostics, and set rc_quiet=yes 38478344Sobrien# 38578344Sobrien# The following globals are used: 38678344Sobrien# 38798186Sgordon# Name Needed Purpose 38898186Sgordon# ---- ------ ------- 38978344Sobrien# name y Name of script. 39078344Sobrien# 39178344Sobrien# command n Full path to command. 39298186Sgordon# Not needed if ${rc_arg}_cmd is set for 39378344Sobrien# each keyword. 39478344Sobrien# 39578344Sobrien# command_args n Optional args/shell directives for command. 39678344Sobrien# 39798186Sgordon# command_interpreter n If not empty, command is interpreted, so 39898186Sgordon# call check_{pidfile,process}() appropriately. 39998186Sgordon# 40078344Sobrien# extra_commands n List of extra commands supported. 40178344Sobrien# 40298186Sgordon# pidfile n If set, use check_pidfile $pidfile $command, 40398186Sgordon# otherwise use check_process $command. 40498186Sgordon# In either case, only check if $command is set. 40578344Sobrien# 40698186Sgordon# procname n Process name to check for instead of $command. 40798186Sgordon# 40878344Sobrien# rcvar n This is checked with checkyesno to determine 40978344Sobrien# if the action should be run. 41078344Sobrien# 411157653Sflz# ${name}_program n Full path to command. 412157653Sflz# Meant to be used in /etc/rc.conf to override 413157653Sflz# ${command}. 414157653Sflz# 41578344Sobrien# ${name}_chroot n Directory to chroot to before running ${command} 41698186Sgordon# Requires /usr to be mounted. 41778344Sobrien# 41878344Sobrien# ${name}_chdir n Directory to cd to before running ${command} 41978344Sobrien# (if not using ${name}_chroot). 42078344Sobrien# 42178344Sobrien# ${name}_flags n Arguments to call ${command} with. 42278344Sobrien# NOTE: $flags from the parent environment 42378344Sobrien# can be used to override this. 42478344Sobrien# 42578344Sobrien# ${name}_nice n Nice level to run ${command} at. 42678344Sobrien# 42778344Sobrien# ${name}_user n User to run ${command} as, using su(1) if not 42878344Sobrien# using ${name}_chroot. 42998186Sgordon# Requires /usr to be mounted. 43078344Sobrien# 43178344Sobrien# ${name}_group n Group to run chrooted ${command} as. 43298186Sgordon# Requires /usr to be mounted. 43378344Sobrien# 43498186Sgordon# ${name}_groups n Comma separated list of supplementary groups 43598186Sgordon# to run the chrooted ${command} with. 43698186Sgordon# Requires /usr to be mounted. 43778344Sobrien# 43898186Sgordon# ${rc_arg}_cmd n If set, use this as the method when invoked; 43978344Sobrien# Otherwise, use default command (see below) 44078344Sobrien# 44198186Sgordon# ${rc_arg}_precmd n If set, run just before performing the 44298186Sgordon# ${rc_arg}_cmd method in the default 44398186Sgordon# operation (i.e, after checking for required 44498186Sgordon# bits and process (non)existence). 44578344Sobrien# If this completes with a non-zero exit code, 44698186Sgordon# don't run ${rc_arg}_cmd. 44778344Sobrien# 44898186Sgordon# ${rc_arg}_postcmd n If set, run just after performing the 44998186Sgordon# ${rc_arg}_cmd method, if that method 45098186Sgordon# returned a zero exit code. 45198186Sgordon# 45278344Sobrien# required_dirs n If set, check for the existence of the given 453165565Syar# directories before running a (re)start command. 45478344Sobrien# 45578344Sobrien# required_files n If set, check for the readability of the given 456165565Syar# files before running a (re)start command. 45778344Sobrien# 458165565Syar# required_modules n If set, ensure the given kernel modules are 459165565Syar# loaded before running a (re)start command. 460165565Syar# The check and possible loads are actually 461165565Syar# done after start_precmd so that the modules 462165565Syar# aren't loaded in vain, should the precmd 463165565Syar# return a non-zero status to indicate a error. 464165565Syar# If a word in the list looks like "foo:bar", 465165565Syar# "foo" is the KLD file name and "bar" is the 466165565Syar# module name. If a word looks like "foo~bar", 467165565Syar# "foo" is the KLD file name and "bar" is a 468165565Syar# egrep(1) pattern matching the module name. 469165565Syar# Otherwise the module name is assumed to be 470165565Syar# the same as the KLD file name, which is most 471165565Syar# common. See load_kld(). 472165565Syar# 47378344Sobrien# required_vars n If set, perform checkyesno on each of the 47478344Sobrien# listed variables before running the default 47578344Sobrien# (re)start command. 47678344Sobrien# 47798186Sgordon# Default behaviour for a given argument, if no override method is 47898186Sgordon# provided: 47978344Sobrien# 48098186Sgordon# Argument Default behaviour 48198186Sgordon# -------- ----------------- 48278344Sobrien# start if !running && checkyesno ${rcvar} 48378344Sobrien# ${command} 48478344Sobrien# 48578344Sobrien# stop if ${pidfile} 48698186Sgordon# rc_pid=$(check_pidfile $pidfile $command) 48778344Sobrien# else 48898186Sgordon# rc_pid=$(check_process $command) 48998186Sgordon# kill $sig_stop $rc_pid 49098186Sgordon# wait_for_pids $rc_pid 49198186Sgordon# ($sig_stop defaults to TERM.) 49278344Sobrien# 49398186Sgordon# reload Similar to stop, except use $sig_reload instead, 49498186Sgordon# and doesn't wait_for_pids. 49578344Sobrien# $sig_reload defaults to HUP. 496151685Syar# Note that `reload' isn't provided by default, 497151685Syar# it should be enabled via $extra_commands. 49878344Sobrien# 49978344Sobrien# restart Run `stop' then `start'. 50078344Sobrien# 50198186Sgordon# status Show if ${command} is running, etc. 50278344Sobrien# 50398186Sgordon# poll Wait for ${command} to exit. 50498186Sgordon# 50598186Sgordon# rcvar Display what rc.conf variable is used (if any). 50698186Sgordon# 50798186Sgordon# Variables available to methods, and after run_rc_command() has 50898186Sgordon# completed: 50998186Sgordon# 51098186Sgordon# Variable Purpose 51198186Sgordon# -------- ------- 512126303Smtm# rc_arg Argument to command, after fast/force/one processing 51398186Sgordon# performed 51498186Sgordon# 51598186Sgordon# rc_flags Flags to start the default command with. 51698186Sgordon# Defaults to ${name}_flags, unless overridden 51798186Sgordon# by $flags from the environment. 51898186Sgordon# This variable may be changed by the precmd method. 51998186Sgordon# 52098186Sgordon# rc_pid PID of command (if appropriate) 52198186Sgordon# 52298186Sgordon# rc_fast Not empty if "fast" was provided (q.v.) 52398186Sgordon# 52498186Sgordon# rc_force Not empty if "force" was provided (q.v.) 52598186Sgordon# 526175676Smtm# rc_quiet Not empty if "quiet" was provided 52798186Sgordon# 528175676Smtm# 52978344Sobrienrun_rc_command() 53078344Sobrien{ 531116097Smtm _return=0 53298186Sgordon rc_arg=$1 53378344Sobrien if [ -z "$name" ]; then 53498186Sgordon err 3 'run_rc_command: $name is not set.' 53578344Sobrien fi 53678344Sobrien 537132892Smtm # Don't repeat the first argument when passing additional command- 538132892Smtm # line arguments to the command subroutines. 539132892Smtm # 540132892Smtm shift 1 541132892Smtm rc_extra_args="$*" 542132892Smtm 543126303Smtm _rc_prefix= 54498186Sgordon case "$rc_arg" in 54578344Sobrien fast*) # "fast" prefix; don't check pid 54698186Sgordon rc_arg=${rc_arg#fast} 54798186Sgordon rc_fast=yes 548175676Smtm rc_quiet=yes 54978344Sobrien ;; 550126303Smtm force*) # "force prefix; always run 55198186Sgordon rc_force=yes 552126303Smtm _rc_prefix=force 553126303Smtm rc_arg=${rc_arg#${_rc_prefix}} 55478344Sobrien if [ -n "${rcvar}" ]; then 55578344Sobrien eval ${rcvar}=YES 55678344Sobrien fi 55778344Sobrien ;; 558126303Smtm one*) # "one" prefix; set ${rcvar}=yes 559126303Smtm _rc_prefix=one 560126303Smtm rc_arg=${rc_arg#${_rc_prefix}} 561126303Smtm if [ -n "${rcvar}" ]; then 562126303Smtm eval ${rcvar}=YES 563126303Smtm fi 564126303Smtm ;; 565175676Smtm quiet*) # "quiet" prefix; omit some messages 566175676Smtm _rc_prefix=quiet 567175676Smtm rc_arg=${rc_arg#${_rc_prefix}} 568175676Smtm rc_quiet=yes 569175676Smtm ;; 57078344Sobrien esac 57178344Sobrien 572161530Sflz eval _override_command=\$${name}_program 573161530Sflz command=${command:+${_override_command:-$command}} 574161530Sflz 57578344Sobrien _keywords="start stop restart rcvar $extra_commands" 57698186Sgordon rc_pid= 57778344Sobrien _pidcmd= 57898186Sgordon _procname=${procname:-${command}} 57998186Sgordon 580131135Smtm # setup pid check command 581131135Smtm if [ -n "$_procname" ]; then 58278344Sobrien if [ -n "$pidfile" ]; then 58398186Sgordon _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')' 58498186Sgordon else 58598186Sgordon _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')' 58678344Sobrien fi 58778344Sobrien if [ -n "$_pidcmd" ]; then 58898186Sgordon _keywords="${_keywords} status poll" 58978344Sobrien fi 59078344Sobrien fi 59178344Sobrien 59298186Sgordon if [ -z "$rc_arg" ]; then 593150796Syar rc_usage $_keywords 59478344Sobrien fi 59578344Sobrien 59678344Sobrien if [ -n "$flags" ]; then # allow override from environment 59798186Sgordon rc_flags=$flags 59878344Sobrien else 59998186Sgordon eval rc_flags=\$${name}_flags 60078344Sobrien fi 60198186Sgordon eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \ 60298186Sgordon _nice=\$${name}_nice _user=\$${name}_user \ 60398186Sgordon _group=\$${name}_group _groups=\$${name}_groups 60478344Sobrien 60598186Sgordon if [ -n "$_user" ]; then # unset $_user if running as that user 606124832Smtm if [ "$_user" = "$(eval $IDCMD)" ]; then 60798186Sgordon unset _user 60898186Sgordon fi 60998186Sgordon fi 61098186Sgordon 61178344Sobrien # if ${rcvar} is set, and $1 is not 61298186Sgordon # "rcvar", then run 61378344Sobrien # checkyesno ${rcvar} 61478344Sobrien # and return if that failed 61578344Sobrien # 61698186Sgordon if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" ]; then 61778344Sobrien if ! checkyesno ${rcvar}; then 618175676Smtm if [ -n "${rc_quiet}" ]; then 619175676Smtm return 0 620175676Smtm fi 621175676Smtm echo -n "Cannot '${rc_arg}' $name. Set ${rcvar} to " 622175676Smtm echo -n "YES in /etc/rc.conf or use 'one${rc_arg}' " 623175676Smtm echo "instead of '${rc_arg}'." 62478344Sobrien return 0 62578344Sobrien fi 62678344Sobrien fi 62778344Sobrien 62878344Sobrien eval $_pidcmd # determine the pid if necessary 62978344Sobrien 63078344Sobrien for _elem in $_keywords; do 63198186Sgordon if [ "$_elem" != "$rc_arg" ]; then 63278344Sobrien continue 63378344Sobrien fi 63478344Sobrien # if there's a custom ${XXX_cmd}, 63578344Sobrien # run that instead of the default 63678344Sobrien # 637165565Syar eval _cmd=\$${rc_arg}_cmd \ 638165565Syar _precmd=\$${rc_arg}_precmd \ 639165565Syar _postcmd=\$${rc_arg}_postcmd 640165565Syar 64178344Sobrien if [ -n "$_cmd" ]; then 642165565Syar _run_rc_precmd || return 1 643165565Syar _run_rc_doit "$_cmd $rc_extra_args" || return 1 644165565Syar _run_rc_postcmd 645116097Smtm return $_return 64678344Sobrien fi 64778344Sobrien 64898186Sgordon case "$rc_arg" in # default operations... 64978344Sobrien 65078344Sobrien status) 651165565Syar _run_rc_precmd || return 1 65298186Sgordon if [ -n "$rc_pid" ]; then 65398186Sgordon echo "${name} is running as pid $rc_pid." 65478344Sobrien else 65578344Sobrien echo "${name} is not running." 65678344Sobrien return 1 65778344Sobrien fi 658165565Syar _run_rc_postcmd 65978344Sobrien ;; 66078344Sobrien 66178344Sobrien start) 662131135Smtm if [ -z "$rc_fast" -a -n "$rc_pid" ]; then 663157473Sflz echo 1>&2 "${name} already running? (pid=$rc_pid)." 664153152Syar return 1 66578344Sobrien fi 66678344Sobrien 667167413Syar if [ ! -x ${_chroot}${_chroot:+"/"}${command} ]; then 668160667Syar warn "run_rc_command: cannot run $command" 669153152Syar return 1 67078344Sobrien fi 67178344Sobrien 672165565Syar _run_rc_precmd || return 1 67378344Sobrien 674160668Syar # setup the full command to run 67578344Sobrien # 67678344Sobrien echo "Starting ${name}." 67778344Sobrien if [ -n "$_chroot" ]; then 67878344Sobrien _doit="\ 67978344Sobrien${_nice:+nice -n $_nice }\ 68078344Sobrienchroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\ 68198186Sgordon$_chroot $command $rc_flags $command_args" 68278344Sobrien else 68378344Sobrien _doit="\ 684161396Syar${_chdir:+cd $_chdir && }\ 68598186Sgordon$command $rc_flags $command_args" 68698186Sgordon if [ -n "$_user" ]; then 68798186Sgordon _doit="su -m $_user -c 'sh -c \"$_doit\"'" 68898186Sgordon fi 689161396Syar if [ -n "$_nice" ]; then 690161396Syar if [ -z "$_user" ]; then 691161396Syar _doit="sh -c \"$_doit\"" 692161396Syar fi 693161396Syar _doit="nice -n $_nice $_doit" 694161396Syar fi 69578344Sobrien fi 69698186Sgordon 697165565Syar # run the full command 69898186Sgordon # 699165565Syar _run_rc_doit "$_doit" || return 1 70098186Sgordon 70198186Sgordon # finally, run postcmd 70298186Sgordon # 703165565Syar _run_rc_postcmd 70478344Sobrien ;; 70578344Sobrien 70678344Sobrien stop) 70798186Sgordon if [ -z "$rc_pid" ]; then 708153152Syar [ -n "$rc_fast" ] && return 0 709165565Syar _run_rc_notrunning 710153152Syar return 1 71178344Sobrien fi 71278344Sobrien 713165565Syar _run_rc_precmd || return 1 71498186Sgordon 71598186Sgordon # send the signal to stop 71698186Sgordon # 71778344Sobrien echo "Stopping ${name}." 718165565Syar _doit=$(_run_rc_killcmd "${sig_stop:-TERM}") 719165565Syar _run_rc_doit "$_doit" || return 1 72098186Sgordon 72198186Sgordon # wait for the command to exit, 72298186Sgordon # and run postcmd. 72398186Sgordon wait_for_pids $rc_pid 724165565Syar 725165565Syar _run_rc_postcmd 72678344Sobrien ;; 72778344Sobrien 72878344Sobrien reload) 72998186Sgordon if [ -z "$rc_pid" ]; then 730165565Syar _run_rc_notrunning 731153152Syar return 1 73278344Sobrien fi 733165565Syar 734165565Syar _run_rc_precmd || return 1 735165565Syar 736165565Syar _doit=$(_run_rc_killcmd "${sig_reload:-HUP}") 737165565Syar _run_rc_doit "$_doit" || return 1 738165565Syar 739165565Syar _run_rc_postcmd 74078344Sobrien ;; 74178344Sobrien 74278344Sobrien restart) 74378344Sobrien # prevent restart being called more 74478344Sobrien # than once by any given script 74578344Sobrien # 746126285Smtm if ${_rc_restart_done:-false}; then 74778344Sobrien return 0 74878344Sobrien fi 749126285Smtm _rc_restart_done=true 75078344Sobrien 751165565Syar _run_rc_precmd || return 1 752165565Syar 753165565Syar # run those in a subshell to keep global variables 754152519Syar ( run_rc_command ${_rc_prefix}stop $rc_extra_args ) 755165565Syar ( run_rc_command ${_rc_prefix}start $rc_extra_args ) 756165565Syar _return=$? 757165565Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1 75898186Sgordon 759165565Syar _run_rc_postcmd 76078344Sobrien ;; 76178344Sobrien 76298186Sgordon poll) 763165565Syar _run_rc_precmd || return 1 76498186Sgordon if [ -n "$rc_pid" ]; then 76598186Sgordon wait_for_pids $rc_pid 76698186Sgordon fi 767165565Syar _run_rc_postcmd 76898186Sgordon ;; 76998186Sgordon 77078344Sobrien rcvar) 77178344Sobrien echo "# $name" 77278344Sobrien if [ -n "$rcvar" ]; then 77378344Sobrien if checkyesno ${rcvar}; then 774164629Sflz echo "${rcvar}=YES" 77578344Sobrien else 776164629Sflz echo "${rcvar}=NO" 77778344Sobrien fi 77878344Sobrien fi 77978344Sobrien ;; 78078344Sobrien 78178344Sobrien *) 782150796Syar rc_usage $_keywords 78378344Sobrien ;; 78478344Sobrien 78578344Sobrien esac 786116097Smtm return $_return 78778344Sobrien done 78878344Sobrien 78998186Sgordon echo 1>&2 "$0: unknown directive '$rc_arg'." 790150796Syar rc_usage $_keywords 791153152Syar # not reached 79278344Sobrien} 79378344Sobrien 79478344Sobrien# 795165565Syar# Helper functions for run_rc_command: common code. 796165565Syar# They use such global variables besides the exported rc_* ones: 797165565Syar# 798165565Syar# name R/W 799165565Syar# ------------------ 800165565Syar# _precmd R 801165565Syar# _postcmd R 802165565Syar# _return W 803165565Syar# 804165565Syar_run_rc_precmd() 805165565Syar{ 806165565Syar check_required_before "$rc_arg" || return 1 807165565Syar 808165565Syar if [ -n "$_precmd" ]; then 809165565Syar debug "run_rc_command: ${rc_arg}_precmd: $_precmd $rc_extra_args" 810165565Syar eval "$_precmd $rc_extra_args" 811165565Syar _return=$? 812165565Syar 813165565Syar # If precmd failed and force isn't set, request exit. 814165565Syar if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then 815165565Syar return 1 816165565Syar fi 817165565Syar fi 818165565Syar 819165565Syar check_required_after "$rc_arg" || return 1 820165565Syar 821165565Syar return 0 822165565Syar} 823165565Syar 824165565Syar_run_rc_postcmd() 825165565Syar{ 826165565Syar if [ -n "$_postcmd" ]; then 827165565Syar debug "run_rc_command: ${rc_arg}_postcmd: $_postcmd $rc_extra_args" 828165565Syar eval "$_postcmd $rc_extra_args" 829165565Syar _return=$? 830165565Syar fi 831165565Syar return 0 832165565Syar} 833165565Syar 834165565Syar_run_rc_doit() 835165565Syar{ 836165565Syar debug "run_rc_command: doit: $*" 837165565Syar eval "$@" 838165565Syar _return=$? 839165565Syar 840165565Syar # If command failed and force isn't set, request exit. 841165565Syar if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then 842165565Syar return 1 843165565Syar fi 844165565Syar 845165565Syar return 0 846165565Syar} 847165565Syar 848165565Syar_run_rc_notrunning() 849165565Syar{ 850165565Syar local _pidmsg 851165565Syar 852165565Syar if [ -n "$pidfile" ]; then 853165565Syar _pidmsg=" (check $pidfile)." 854165565Syar else 855165565Syar _pidmsg= 856165565Syar fi 857165565Syar echo 1>&2 "${name} not running?${_pidmsg}" 858165565Syar} 859165565Syar 860165565Syar_run_rc_killcmd() 861165565Syar{ 862165565Syar local _cmd 863165565Syar 864165565Syar _cmd="kill -$1 $rc_pid" 865165565Syar if [ -n "$_user" ]; then 866165565Syar _cmd="su -m ${_user} -c 'sh -c \"${_cmd}\"'" 867165565Syar fi 868165565Syar echo "$_cmd" 869165565Syar} 870165565Syar 871165565Syar# 87278344Sobrien# run_rc_script file arg 87378344Sobrien# Start the script `file' with `arg', and correctly handle the 87478344Sobrien# return value from the script. If `file' ends with `.sh', it's 87598186Sgordon# sourced into the current environment. If `file' appears to be 87698186Sgordon# a backup or scratch file, ignore it. Otherwise if it's 87798186Sgordon# executable run as a child process. 87878344Sobrien# 87978344Sobrienrun_rc_script() 88078344Sobrien{ 88178344Sobrien _file=$1 88278344Sobrien _arg=$2 88378344Sobrien if [ -z "$_file" -o -z "$_arg" ]; then 88478344Sobrien err 3 'USAGE: run_rc_script file arg' 88578344Sobrien fi 88678344Sobrien 88798186Sgordon unset name command command_args command_interpreter \ 88898186Sgordon extra_commands pidfile procname \ 88998186Sgordon rcvar required_dirs required_files required_vars 89098186Sgordon eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd 89198186Sgordon 89278344Sobrien case "$_file" in 893153105Sdougb /etc/rc.d/*.sh) # run in current shell 894146490Sschweikh set $_arg; . $_file 89578344Sobrien ;; 896153105Sdougb *[~#]|*.OLD|*.bak|*.orig|*,v) # scratch file; skip 89798186Sgordon warn "Ignoring scratch file $_file" 89898186Sgordon ;; 89978344Sobrien *) # run in subshell 90098186Sgordon if [ -x $_file ]; then 90198186Sgordon if [ -n "$rc_fast_and_loose" ]; then 902146490Sschweikh set $_arg; . $_file 90398186Sgordon else 904130161Smtm ( trap "echo Script $_file interrupted; kill -QUIT $$" 3 905130161Smtm trap "echo Script $_file interrupted; exit 1" 2 906146490Sschweikh set $_arg; . $_file ) 90798186Sgordon fi 90898186Sgordon fi 90978344Sobrien ;; 91078344Sobrien esac 91178344Sobrien} 91278344Sobrien 91378344Sobrien# 914157653Sflz# load_rc_config name 915157653Sflz# Source in the configuration file for a given name. 91678344Sobrien# 91778344Sobrienload_rc_config() 91878344Sobrien{ 919157653Sflz _name=$1 920157653Sflz if [ -z "$_name" ]; then 921157653Sflz err 3 'USAGE: load_rc_config name' 92278344Sobrien fi 92378344Sobrien 924126285Smtm if ${_rc_conf_loaded:-false}; then 925126285Smtm : 926126285Smtm else 92798186Sgordon if [ -r /etc/defaults/rc.conf ]; then 92898186Sgordon debug "Sourcing /etc/defaults/rc.conf" 92998186Sgordon . /etc/defaults/rc.conf 93098186Sgordon source_rc_confs 93198186Sgordon elif [ -r /etc/rc.conf ]; then 93298186Sgordon debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)." 93398186Sgordon . /etc/rc.conf 93498186Sgordon fi 935126285Smtm _rc_conf_loaded=true 93698186Sgordon fi 937161530Sflz if [ -f /etc/rc.conf.d/"$_name" ]; then 938157653Sflz debug "Sourcing /etc/rc.conf.d/${_name}" 939161530Sflz . /etc/rc.conf.d/"$_name" 940157653Sflz fi 94178344Sobrien} 942157473Sflz 943157473Sflz# 944157653Sflz# load_rc_config_var name var 945157653Sflz# Read the rc.conf(5) var for name and set in the 946157473Sflz# current shell, using load_rc_config in a subshell to prevent 947157473Sflz# unwanted side effects from other variable assignments. 948157473Sflz# 949157473Sflzload_rc_config_var() 950157473Sflz{ 951157473Sflz if [ $# -ne 2 ]; then 952157653Sflz err 3 'USAGE: load_rc_config_var name var' 953157473Sflz fi 954157473Sflz eval $(eval '( 955157473Sflz load_rc_config '$1' >/dev/null; 956157473Sflz if [ -n "${'$2'}" -o "${'$2'-UNSET}" != "UNSET" ]; then 957157473Sflz echo '$2'=\'\''${'$2'}\'\''; 958157473Sflz fi 959157473Sflz )' ) 960157473Sflz} 96178344Sobrien 96278344Sobrien# 96378344Sobrien# rc_usage commands 96478344Sobrien# Print a usage string for $0, with `commands' being a list of 96578344Sobrien# valid commands. 96678344Sobrien# 96778344Sobrienrc_usage() 96878344Sobrien{ 969126303Smtm echo -n 1>&2 "Usage: $0 [fast|force|one](" 97078344Sobrien 97178344Sobrien _sep= 972126286Smtm for _elem; do 97378344Sobrien echo -n 1>&2 "$_sep$_elem" 97478344Sobrien _sep="|" 97578344Sobrien done 97678344Sobrien echo 1>&2 ")" 97778344Sobrien exit 1 97878344Sobrien} 97978344Sobrien 98078344Sobrien# 98178344Sobrien# err exitval message 98278344Sobrien# Display message to stderr and log to the syslog, and exit with exitval. 98378344Sobrien# 98478344Sobrienerr() 98578344Sobrien{ 98678344Sobrien exitval=$1 98778344Sobrien shift 98878344Sobrien 989106643Sgordon if [ -x /usr/bin/logger ]; then 990106643Sgordon logger "$0: ERROR: $*" 991106643Sgordon fi 992106643Sgordon echo 1>&2 "$0: ERROR: $*" 99378344Sobrien exit $exitval 99478344Sobrien} 99578344Sobrien 99678344Sobrien# 99778344Sobrien# warn message 99878344Sobrien# Display message to stderr and log to the syslog. 99978344Sobrien# 100078344Sobrienwarn() 100178344Sobrien{ 1002106643Sgordon if [ -x /usr/bin/logger ]; then 1003106643Sgordon logger "$0: WARNING: $*" 1004106643Sgordon fi 1005106643Sgordon echo 1>&2 "$0: WARNING: $*" 100678344Sobrien} 100798186Sgordon 100898186Sgordon# 100998186Sgordon# info message 101098186Sgordon# Display informational message to stdout and log to syslog. 101198186Sgordon# 101298186Sgordoninfo() 101398186Sgordon{ 1014119170Smtm case ${rc_info} in 1015119170Smtm [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 1016119170Smtm if [ -x /usr/bin/logger ]; then 1017119170Smtm logger "$0: INFO: $*" 1018119170Smtm fi 1019119170Smtm echo "$0: INFO: $*" 1020119170Smtm ;; 1021119170Smtm esac 102298186Sgordon} 102398186Sgordon 102498186Sgordon# 102598186Sgordon# debug message 1026106643Sgordon# If debugging is enabled in rc.conf output message to stderr. 102798186Sgordon# BEWARE that you don't call any subroutine that itself calls this 102898186Sgordon# function. 102998186Sgordon# 103098186Sgordondebug() 103198186Sgordon{ 103298186Sgordon case ${rc_debug} in 103398186Sgordon [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 1034106700Sgordon if [ -x /usr/bin/logger ]; then 1035162947Syar logger "$0: DEBUG: $*" 1036106700Sgordon fi 1037146490Sschweikh echo 1>&2 "$0: DEBUG: $*" 103898186Sgordon ;; 103998186Sgordon esac 104098186Sgordon} 104198186Sgordon 104298186Sgordon# 104398186Sgordon# backup_file action file cur backup 104498186Sgordon# Make a backup copy of `file' into `cur', and save the previous 104598186Sgordon# version of `cur' as `backup' or use rcs for archiving. 104698186Sgordon# 104798186Sgordon# This routine checks the value of the backup_uses_rcs variable, 104898186Sgordon# which can be either YES or NO. 104998186Sgordon# 105098186Sgordon# The `action' keyword can be one of the following: 105198186Sgordon# 105298186Sgordon# add `file' is now being backed up (and is possibly 105398186Sgordon# being reentered into the backups system). `cur' 105498186Sgordon# is created and RCS files, if necessary, are 105598186Sgordon# created as well. 105698186Sgordon# 105798186Sgordon# update `file' has changed and needs to be backed up. 105898186Sgordon# If `cur' exists, it is copied to to `back' or 105998186Sgordon# checked into RCS (if the repository file is old), 106098186Sgordon# and then `file' is copied to `cur'. Another RCS 106198186Sgordon# check in done here if RCS is being used. 106298186Sgordon# 106398186Sgordon# remove `file' is no longer being tracked by the backups 106498186Sgordon# system. If RCS is not being used, `cur' is moved 106598186Sgordon# to `back', otherwise an empty file is checked in, 106698186Sgordon# and then `cur' is removed. 106798186Sgordon# 106898186Sgordon# 106998186Sgordonbackup_file() 107098186Sgordon{ 107198186Sgordon _action=$1 107298186Sgordon _file=$2 107398186Sgordon _cur=$3 107498186Sgordon _back=$4 107598186Sgordon 107698186Sgordon if checkyesno backup_uses_rcs; then 107798186Sgordon _msg0="backup archive" 107898186Sgordon _msg1="update" 107998186Sgordon 108098186Sgordon # ensure that history file is not locked 108198186Sgordon if [ -f $_cur,v ]; then 108298186Sgordon rcs -q -u -U -M $_cur 108398186Sgordon fi 108498186Sgordon 108598186Sgordon # ensure after switching to rcs that the 108698186Sgordon # current backup is not lost 108798186Sgordon if [ -f $_cur ]; then 108898186Sgordon # no archive, or current newer than archive 108998186Sgordon if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then 109098186Sgordon ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur 109198186Sgordon rcs -q -kb -U $_cur 109298186Sgordon co -q -f -u $_cur 109398186Sgordon fi 109498186Sgordon fi 109598186Sgordon 109698186Sgordon case $_action in 109798186Sgordon add|update) 109898186Sgordon cp -p $_file $_cur 109998186Sgordon ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur 110098186Sgordon rcs -q -kb -U $_cur 110198186Sgordon co -q -f -u $_cur 110298186Sgordon chown root:wheel $_cur $_cur,v 110398186Sgordon ;; 110498186Sgordon remove) 110598186Sgordon cp /dev/null $_cur 110698186Sgordon ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur 110798186Sgordon rcs -q -kb -U $_cur 110898186Sgordon chown root:wheel $_cur $_cur,v 110998186Sgordon rm $_cur 111098186Sgordon ;; 111198186Sgordon esac 111298186Sgordon else 111398186Sgordon case $_action in 111498186Sgordon add|update) 111598186Sgordon if [ -f $_cur ]; then 111698186Sgordon cp -p $_cur $_back 111798186Sgordon fi 111898186Sgordon cp -p $_file $_cur 111998186Sgordon chown root:wheel $_cur 112098186Sgordon ;; 112198186Sgordon remove) 112298186Sgordon mv -f $_cur $_back 112398186Sgordon ;; 112498186Sgordon esac 112598186Sgordon fi 112698186Sgordon} 1127119166Smtm 1128123344Smtm# make_symlink src link 1129123344Smtm# Make a symbolic link 'link' to src from basedir. If the 1130123344Smtm# directory in which link is to be created does not exist 1131123344Smtm# a warning will be displayed and an error will be returned. 1132123344Smtm# Returns 0 on sucess, 1 otherwise. 1133119166Smtm# 1134123344Smtmmake_symlink() 1135119166Smtm{ 1136123344Smtm local src link linkdir _me 1137123344Smtm src="$1" 1138123344Smtm link="$2" 1139123344Smtm linkdir="`dirname $link`" 1140123344Smtm _me="make_symlink()" 1141119166Smtm 1142123344Smtm if [ -z "$src" -o -z "$link" ]; then 1143123344Smtm warn "$_me: requires two arguments." 1144119166Smtm return 1 1145119166Smtm fi 1146123344Smtm if [ ! -d "$linkdir" ]; then 1147160667Syar warn "$_me: the directory $linkdir does not exist." 1148119166Smtm return 1 1149119166Smtm fi 1150146490Sschweikh if ! ln -sf $src $link; then 1151123344Smtm warn "$_me: unable to make a symbolic link from $link to $src" 1152119166Smtm return 1 1153119166Smtm fi 1154119166Smtm return 0 1155119166Smtm} 1156119166Smtm 1157119166Smtm# devfs_rulesets_from_file file 1158119166Smtm# Reads a set of devfs commands from file, and creates 1159119166Smtm# the specified rulesets with their rules. Returns non-zero 1160119166Smtm# if there was an error. 1161119166Smtm# 1162119166Smtmdevfs_rulesets_from_file() 1163119166Smtm{ 1164119166Smtm local file _err _me 1165119166Smtm file="$1" 1166119166Smtm _me="devfs_rulesets_from_file" 1167119166Smtm _err=0 1168119166Smtm 1169119166Smtm if [ -z "$file" ]; then 1170119166Smtm warn "$_me: you must specify a file" 1171119166Smtm return 1 1172119166Smtm fi 1173119166Smtm if [ ! -e "$file" ]; then 1174119166Smtm debug "$_me: no such file ($file)" 1175119166Smtm return 0 1176119166Smtm fi 1177119166Smtm debug "reading rulesets from file ($file)" 1178119166Smtm { while read line 1179119166Smtm do 1180119166Smtm case $line in 1181119166Smtm \#*) 1182119166Smtm continue 1183119166Smtm ;; 1184119166Smtm \[*\]*) 1185119166Smtm rulenum=`expr "$line" : "\[.*=\([0-9]*\)\]"` 1186119166Smtm if [ -z "$rulenum" ]; then 1187119166Smtm warn "$_me: cannot extract rule number ($line)" 1188119166Smtm _err=1 1189119166Smtm break 1190119166Smtm fi 1191119166Smtm rulename=`expr "$line" : "\[\(.*\)=[0-9]*\]"` 1192119166Smtm if [ -z "$rulename" ]; then 1193119166Smtm warn "$_me: cannot extract rule name ($line)" 1194119166Smtm _err=1 1195119166Smtm break; 1196119166Smtm fi 1197119166Smtm eval $rulename=\$rulenum 1198119166Smtm debug "found ruleset: $rulename=$rulenum" 1199146490Sschweikh if ! /sbin/devfs rule -s $rulenum delset; then 1200119166Smtm _err=1 1201119166Smtm break 1202119166Smtm fi 1203119166Smtm ;; 1204119166Smtm *) 1205119166Smtm rulecmd="${line%%"\#*"}" 1206119166Smtm # evaluate the command incase it includes 1207119166Smtm # other rules 1208119166Smtm if [ -n "$rulecmd" ]; then 1209119166Smtm debug "adding rule ($rulecmd)" 1210119166Smtm if ! eval /sbin/devfs rule -s $rulenum $rulecmd 1211119166Smtm then 1212119166Smtm _err=1 1213119166Smtm break 1214119166Smtm fi 1215119166Smtm fi 1216119166Smtm ;; 1217119166Smtm esac 1218119166Smtm if [ $_err -ne 0 ]; then 1219119166Smtm debug "error in $_me" 1220119166Smtm break 1221119166Smtm fi 1222119166Smtm done } < $file 1223119166Smtm return $_err 1224119166Smtm} 1225119166Smtm 1226119166Smtm# devfs_init_rulesets 1227119166Smtm# Initializes rulesets from configuration files. Returns 1228119166Smtm# non-zero if there was an error. 1229119166Smtm# 1230119166Smtmdevfs_init_rulesets() 1231119166Smtm{ 1232119166Smtm local file _me 1233119166Smtm _me="devfs_init_rulesets" 1234119166Smtm 1235119166Smtm # Go through this only once 1236119166Smtm if [ -n "$devfs_rulesets_init" ]; then 1237119166Smtm debug "$_me: devfs rulesets already initialized" 1238119166Smtm return 1239119166Smtm fi 1240146490Sschweikh for file in $devfs_rulesets; do 1241119166Smtm devfs_rulesets_from_file $file || return 1 1242119166Smtm done 1243119166Smtm devfs_rulesets_init=1 1244119166Smtm debug "$_me: devfs rulesets initialized" 1245119166Smtm return 0 1246119166Smtm} 1247119166Smtm 1248119166Smtm# devfs_set_ruleset ruleset [dir] 1249151619Smaxim# Sets the default ruleset of dir to ruleset. The ruleset argument 1250119166Smtm# must be a ruleset name as specified in devfs.rules(5) file. 1251119166Smtm# Returns non-zero if it could not set it successfully. 1252119166Smtm# 1253119166Smtmdevfs_set_ruleset() 1254119166Smtm{ 1255119166Smtm local devdir rs _me 1256119166Smtm [ -n "$1" ] && eval rs=\$$1 || rs= 1257119166Smtm [ -n "$2" ] && devdir="-m "$2"" || devdir= 1258119166Smtm _me="devfs_set_ruleset" 1259119166Smtm 1260119166Smtm if [ -z "$rs" ]; then 1261119166Smtm warn "$_me: you must specify a ruleset number" 1262119166Smtm return 1 1263119166Smtm fi 1264119166Smtm debug "$_me: setting ruleset ($rs) on mount-point (${devdir#-m })" 1265146490Sschweikh if ! /sbin/devfs $devdir ruleset $rs; then 1266119166Smtm warn "$_me: unable to set ruleset $rs to ${devdir#-m }" 1267119166Smtm return 1 1268119166Smtm fi 1269119166Smtm return 0 1270119166Smtm} 1271119166Smtm 1272119166Smtm# devfs_apply_ruleset ruleset [dir] 1273119166Smtm# Apply ruleset number $ruleset to the devfs mountpoint $dir. 1274119166Smtm# The ruleset argument must be a ruleset name as specified 1275119166Smtm# in a devfs.rules(5) file. Returns 0 on success or non-zero 1276119166Smtm# if it could not apply the ruleset. 1277119166Smtm# 1278119166Smtmdevfs_apply_ruleset() 1279119166Smtm{ 1280119166Smtm local devdir rs _me 1281119166Smtm [ -n "$1" ] && eval rs=\$$1 || rs= 1282119166Smtm [ -n "$2" ] && devdir="-m "$2"" || devdir= 1283119166Smtm _me="devfs_apply_ruleset" 1284119166Smtm 1285119166Smtm if [ -z "$rs" ]; then 1286119166Smtm warn "$_me: you must specify a ruleset" 1287119166Smtm return 1 1288119166Smtm fi 1289119166Smtm debug "$_me: applying ruleset ($rs) to mount-point (${devdir#-m })" 1290146490Sschweikh if ! /sbin/devfs $devdir rule -s $rs applyset; then 1291119166Smtm warn "$_me: unable to apply ruleset $rs to ${devdir#-m }" 1292119166Smtm return 1 1293119166Smtm fi 1294119166Smtm return 0 1295119166Smtm} 1296119166Smtm 1297119166Smtm# devfs_domount dir [ruleset] 1298119166Smtm# Mount devfs on dir. If ruleset is specified it is set 1299119166Smtm# on the mount-point. It must also be a ruleset name as specified 1300119166Smtm# in a devfs.rules(5) file. Returns 0 on success. 1301119166Smtm# 1302119166Smtmdevfs_domount() 1303119166Smtm{ 1304119166Smtm local devdir rs _me 1305119166Smtm devdir="$1" 1306119166Smtm [ -n "$2" ] && rs=$2 || rs= 1307119166Smtm _me="devfs_domount()" 1308119166Smtm 1309119166Smtm if [ -z "$devdir" ]; then 1310119166Smtm warn "$_me: you must specify a mount-point" 1311119166Smtm return 1 1312119166Smtm fi 1313119166Smtm debug "$_me: mount-point is ($devdir), ruleset is ($rs)" 1314146490Sschweikh if ! mount -t devfs dev "$devdir"; then 1315119166Smtm warn "$_me: Unable to mount devfs on $devdir" 1316119166Smtm return 1 1317119166Smtm fi 1318119166Smtm if [ -n "$rs" ]; then 1319119166Smtm devfs_init_rulesets 1320119166Smtm devfs_set_ruleset $rs $devdir 1321124797Scperciva devfs -m $devdir rule applyset 1322119166Smtm fi 1323119166Smtm return 0 1324119166Smtm} 1325119166Smtm 1326119166Smtm# devfs_mount_jail dir [ruleset] 1327119166Smtm# Mounts a devfs file system appropriate for jails 1328119166Smtm# on the directory dir. If ruleset is specified, the ruleset 1329119166Smtm# it names will be used instead. If present, ruleset must 1330119166Smtm# be the name of a ruleset as defined in a devfs.rules(5) file. 1331119166Smtm# This function returns non-zero if an error occurs. 1332119166Smtm# 1333119166Smtmdevfs_mount_jail() 1334119166Smtm{ 1335119166Smtm local jdev rs _me 1336119166Smtm jdev="$1" 1337119166Smtm [ -n "$2" ] && rs=$2 || rs="devfsrules_jail" 1338119166Smtm _me="devfs_mount_jail" 1339119166Smtm 1340119166Smtm devfs_init_rulesets 1341146490Sschweikh if ! devfs_domount "$jdev" $rs; then 1342119166Smtm warn "$_me: devfs was not mounted on $jdev" 1343119166Smtm return 1 1344119166Smtm fi 1345119166Smtm return 0 1346119166Smtm} 1347127345Sbrooks 1348127345Sbrooks# Provide a function for normalizing the mounting of memory 1349127345Sbrooks# filesystems. This should allow the rest of the code here to remain 1350127345Sbrooks# as close as possible between 5-current and 4-stable. 1351127345Sbrooks# $1 = size 1352127345Sbrooks# $2 = mount point 1353137451Skeramida# $3 = (optional) extra mdmfs flags 1354146490Sschweikhmount_md() 1355146490Sschweikh{ 1356127345Sbrooks if [ -n "$3" ]; then 1357137451Skeramida flags="$3" 1358127345Sbrooks fi 1359149421Syar /sbin/mdmfs $flags -s $1 md $2 1360127345Sbrooks} 1361131550Scperciva 1362159828Syar# Code common to scripts that need to load a kernel module 1363159828Syar# if it isn't in the kernel yet. Syntax: 1364160666Syar# load_kld [-e regex] [-m module] file 1365159828Syar# where -e or -m chooses the way to check if the module 1366159828Syar# is already loaded: 1367160666Syar# regex is egrep'd in the output from `kldstat -v', 1368160666Syar# module is passed to `kldstat -m'. 1369160666Syar# The default way is as though `-m file' were specified. 1370159828Syarload_kld() 1371159828Syar{ 1372159828Syar local _loaded _mod _opt _re 1373159828Syar 1374159828Syar while getopts "e:m:" _opt; do 1375159828Syar case "$_opt" in 1376159828Syar e) _re="$OPTARG" ;; 1377159828Syar m) _mod="$OPTARG" ;; 1378160666Syar *) err 3 'USAGE: load_kld [-e regex] [-m module] file' ;; 1379159828Syar esac 1380159828Syar done 1381159828Syar shift $(($OPTIND - 1)) 1382160666Syar if [ $# -ne 1 ]; then 1383160666Syar err 3 'USAGE: load_kld [-e regex] [-m module] file' 1384160666Syar fi 1385159828Syar _mod=${_mod:-$1} 1386159828Syar _loaded=false 1387159828Syar if [ -n "$_re" ]; then 1388159828Syar if kldstat -v | egrep -q -e "$_re"; then 1389159828Syar _loaded=true 1390159828Syar fi 1391159828Syar else 1392159828Syar if kldstat -q -m "$_mod"; then 1393159828Syar _loaded=true 1394159828Syar fi 1395159828Syar fi 1396159828Syar if ! $_loaded; then 1397159828Syar if ! kldload "$1"; then 1398159828Syar warn "Unable to load kernel module $1" 1399159828Syar return 1 1400160666Syar else 1401160666Syar info "$1 kernel module loaded." 1402159828Syar fi 1403160666Syar else 1404160666Syar debug "load_kld: $1 kernel module already loaded." 1405159828Syar fi 1406159828Syar return 0 1407159828Syar} 1408159828Syar 1409149049Spjd# ltr str src dst 1410149049Spjd# Change every $src in $str to $dst. 1411149049Spjd# Useful when /usr is not yet mounted and we cannot use tr(1), sed(1) nor 1412149049Spjd# awk(1). 1413149049Spjdltr() 1414149049Spjd{ 1415149049Spjd local _str _src _dst _out _com 1416149049Spjd _str=$1 1417149049Spjd _src=$2 1418149049Spjd _dst=$3 1419149049Spjd _out="" 1420149049Spjd 1421149049Spjd IFS=${_src} 1422149049Spjd for _com in ${_str}; do 1423149049Spjd if [ -z "${_out}" ]; then 1424149049Spjd _out="${_com}" 1425149049Spjd else 1426149049Spjd _out="${_out}${_dst}${_com}" 1427149049Spjd fi 1428149049Spjd done 1429149049Spjd echo "${_out}" 1430149049Spjd} 1431149049Spjd 1432149050Spjd# Creates a list of providers for GELI encryption. 1433149050Spjdgeli_make_list() 1434149050Spjd{ 1435149050Spjd local devices devices2 1436149050Spjd local provider mountpoint type options rest 1437149050Spjd 1438149050Spjd # Create list of GELI providers from fstab. 1439149050Spjd while read provider mountpoint type options rest ; do 1440155570Sflz case ":${options}" in 1441155570Sflz :*noauto*) 1442155570Sflz noauto=yes 1443155570Sflz ;; 1444155570Sflz *) 1445155570Sflz noauto=no 1446155570Sflz ;; 1447155570Sflz esac 1448155570Sflz 1449149050Spjd case ":${provider}" in 1450149050Spjd :#*) 1451149050Spjd continue 1452149050Spjd ;; 1453149050Spjd *.eli) 1454149050Spjd # Skip swap devices. 1455155570Sflz if [ "${type}" = "swap" -o "${options}" = "sw" -o "${noauto}" = "yes" ]; then 1456149050Spjd continue 1457149050Spjd fi 1458149050Spjd devices="${devices} ${provider}" 1459149050Spjd ;; 1460149050Spjd esac 1461149050Spjd done < /etc/fstab 1462149050Spjd 1463149050Spjd # Append providers from geli_devices. 1464149050Spjd devices="${devices} ${geli_devices}" 1465149050Spjd 1466149050Spjd for provider in ${devices}; do 1467149050Spjd provider=${provider%.eli} 1468149050Spjd provider=${provider#/dev/} 1469149050Spjd devices2="${devices2} ${provider}" 1470149050Spjd done 1471149050Spjd 1472149050Spjd echo ${devices2} 1473149050Spjd} 1474149050Spjd 1475153027Sdougb# Find scripts in local_startup directories that use the old syntax 1476153027Sdougb# 1477153027Sdougbfind_local_scripts_old () { 1478153027Sdougb zlist='' 1479153027Sdougb slist='' 1480153027Sdougb for dir in ${local_startup}; do 1481153027Sdougb if [ -d "${dir}" ]; then 1482153027Sdougb for file in ${dir}/[0-9]*.sh; do 1483153027Sdougb grep '^# PROVIDE:' $file >/dev/null 2>&1 && 1484153027Sdougb continue 1485153027Sdougb zlist="$zlist $file" 1486153027Sdougb done 1487153027Sdougb for file in ${dir}/[^0-9]*.sh; do 1488153027Sdougb grep '^# PROVIDE:' $file >/dev/null 2>&1 && 1489153027Sdougb continue 1490153027Sdougb slist="$slist $file" 1491153027Sdougb done 1492153027Sdougb fi 1493153027Sdougb done 1494153027Sdougb} 1495153027Sdougb 1496153027Sdougbfind_local_scripts_new () { 1497153027Sdougb local_rc='' 1498153027Sdougb for dir in ${local_startup}; do 1499153027Sdougb if [ -d "${dir}" ]; then 1500153297Sdougb for file in `grep -l '^# PROVIDE:' ${dir}/* 2>/dev/null`; do 1501153027Sdougb case "$file" in 1502153027Sdougb *.sample) ;; 1503153027Sdougb *) if [ -x "$file" ]; then 1504153027Sdougb local_rc="${local_rc} ${file}" 1505153027Sdougb fi 1506153027Sdougb ;; 1507153027Sdougb esac 1508153027Sdougb done 1509153027Sdougb fi 1510153027Sdougb done 1511153027Sdougb} 1512153027Sdougb 1513165565Syar# check_required_{before|after} command 1514165565Syar# Check for things required by the command before and after its precmd, 1515165565Syar# respectively. The two separate functions are needed because some 1516165565Syar# conditions should prevent precmd from being run while other things 1517165565Syar# depend on precmd having already been run. 1518165565Syar# 1519165565Syarcheck_required_before() 1520165565Syar{ 1521165565Syar local _f 1522165565Syar 1523165565Syar case "$1" in 1524165565Syar start) 1525165565Syar for _f in $required_vars; do 1526165565Syar if ! checkyesno $_f; then 1527165565Syar warn "\$${_f} is not enabled." 1528165565Syar if [ -z "$rc_force" ]; then 1529165565Syar return 1 1530165565Syar fi 1531165565Syar fi 1532165565Syar done 1533165565Syar 1534165565Syar for _f in $required_dirs; do 1535165565Syar if [ ! -d "${_f}/." ]; then 1536165565Syar warn "${_f} is not a directory." 1537165565Syar if [ -z "$rc_force" ]; then 1538165565Syar return 1 1539165565Syar fi 1540165565Syar fi 1541165565Syar done 1542165565Syar 1543165565Syar for _f in $required_files; do 1544165565Syar if [ ! -r "${_f}" ]; then 1545165565Syar warn "${_f} is not readable." 1546165565Syar if [ -z "$rc_force" ]; then 1547165565Syar return 1 1548165565Syar fi 1549165565Syar fi 1550165565Syar done 1551165565Syar ;; 1552165565Syar esac 1553165565Syar 1554165565Syar return 0 1555165565Syar} 1556165565Syar 1557165565Syarcheck_required_after() 1558165565Syar{ 1559165565Syar local _f _args 1560165565Syar 1561165565Syar case "$1" in 1562165565Syar start) 1563165565Syar for _f in $required_modules; do 1564165565Syar case "${_f}" in 1565165565Syar *~*) _args="-e ${_f#*~} ${_f%%~*}" ;; 1566165565Syar *:*) _args="-m ${_f#*:} ${_f%%:*}" ;; 1567165565Syar *) _args="${_f}" ;; 1568165565Syar esac 1569165565Syar if ! load_kld ${_args}; then 1570165565Syar if [ -z "$rc_force" ]; then 1571165565Syar return 1 1572165565Syar fi 1573165565Syar fi 1574165565Syar done 1575165565Syar ;; 1576165565Syar esac 1577165565Syar 1578165565Syar return 0 1579165565Syar} 1580165565Syar 1581131550Scpercivafi 1582157841Sflz 1583157841Sflz_rc_subr_loaded=: 1584