rc.subr revision 161436
1157841Sflz# $NetBSD: rc.subr,v 1.66 2006/04/01 10:05:50 he Exp $ 298186Sgordon# $FreeBSD: head/etc/rc.subr 161436 2006-08-18 13:07:38Z yar $ 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)'} 43157473Sflz 4478344Sobrien# 4598186Sgordon# Operating System dependent/independent variables 4698186Sgordon# 4798186Sgordon 48131550Scpercivaif [ -z "${_rc_subr_loaded}" ]; then 49131550Scperciva 50131550Scperciva_rc_subr_loaded="YES" 51131550Scperciva 5298186SgordonSYSCTL="/sbin/sysctl" 5398186SgordonSYSCTL_N="${SYSCTL} -n" 5498186SgordonCMD_OSTYPE="${SYSCTL_N} kern.ostype" 55103018SgordonOSTYPE=`${CMD_OSTYPE}` 56124832SmtmID="/usr/bin/id" 57124832SmtmIDCMD="if [ -x $ID ]; then $ID -un; fi" 58161435SyarPS="/bin/ps -ww" 59161435SyarJID=`$PS -p $$ -o jid=` 6098186Sgordon 61103018Sgordoncase ${OSTYPE} in 6298186SgordonFreeBSD) 6398186Sgordon SYSCTL_W="${SYSCTL}" 6498186Sgordon ;; 6598186SgordonNetBSD) 6698186Sgordon SYSCTL_W="${SYSCTL} -w" 6798186Sgordon ;; 6898186Sgordonesac 6998186Sgordon 7098186Sgordon# 7178344Sobrien# functions 7278344Sobrien# --------- 7378344Sobrien 7478344Sobrien# 7598186Sgordon# set_rcvar base_var 7698186Sgordon# Set the variable name enabling a specific service. 7798186Sgordon# FreeBSD uses ${service}_enable, while NetBSD uses 7898186Sgordon# just the name of the service. For example: 7998186Sgordon# FreeBSD: sendmail_enable="YES" 8098186Sgordon# NetBSD : sendmail="YES" 8198186Sgordon# $1 - if $name is not the base to work of off, specify 8298186Sgordon# a different one 8398186Sgordon# 8498186Sgordonset_rcvar() 8598186Sgordon{ 8698186Sgordon if [ -z "$1" ]; then 8798186Sgordon base_var=${name} 8898186Sgordon else 8998186Sgordon base_var="$1" 9098186Sgordon fi 9198186Sgordon 92103018Sgordon case ${OSTYPE} in 9398186Sgordon FreeBSD) 9498186Sgordon echo ${base_var}_enable 9598186Sgordon ;; 9698186Sgordon NetBSD) 9798186Sgordon echo ${base_var} 9898186Sgordon ;; 9998186Sgordon *) 10098186Sgordon echo 'XXX' 10198186Sgordon ;; 10298186Sgordon esac 10398186Sgordon} 10498186Sgordon 10598186Sgordon# 10698186Sgordon# force_depend script 10798186Sgordon# Force a service to start. Intended for use by services 10898186Sgordon# to resolve dependency issues. It is assumed the caller 10998186Sgordon# has check to make sure this call is necessary 11098186Sgordon# $1 - filename of script, in /etc/rc.d, to run 11198186Sgordon# 11298186Sgordonforce_depend() 11398186Sgordon{ 11498186Sgordon _depend="$1" 11598186Sgordon 11698186Sgordon info "${name} depends on ${_depend}, which will be forced to start." 117146490Sschweikh if ! /etc/rc.d/${_depend} forcestart; then 11898186Sgordon warn "Unable to force ${_depend}. It may already be running." 11998186Sgordon return 1 12098186Sgordon fi 12198186Sgordon return 0 12298186Sgordon} 12398186Sgordon 12498186Sgordon# 12578344Sobrien# checkyesno var 12678344Sobrien# Test $1 variable, and warn if not set to YES or NO. 12778344Sobrien# Return 0 if it's "yes" (et al), nonzero otherwise. 12878344Sobrien# 12978344Sobriencheckyesno() 13078344Sobrien{ 13178344Sobrien eval _value=\$${1} 13298186Sgordon debug "checkyesno: $1 is set to $_value." 13378344Sobrien case $_value in 13478344Sobrien 13578344Sobrien # "yes", "true", "on", or "1" 13678344Sobrien [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 13778344Sobrien return 0 13878344Sobrien ;; 13978344Sobrien 14078344Sobrien # "no", "false", "off", or "0" 14178344Sobrien [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0) 14278344Sobrien return 1 14378344Sobrien ;; 14478344Sobrien *) 145157473Sflz warn "\$${1} is not set properly - see ${rcvar_manpage}." 14678344Sobrien return 1 14778344Sobrien ;; 14878344Sobrien esac 14978344Sobrien} 15078344Sobrien 151157473Sflz# 15298186Sgordon# reverse_list list 15398186Sgordon# print the list in reverse order 15478344Sobrien# 15598186Sgordonreverse_list() 15698186Sgordon{ 15798186Sgordon _revlist= 158126286Smtm for _revfile; do 15998186Sgordon _revlist="$_revfile $_revlist" 16098186Sgordon done 16198186Sgordon echo $_revlist 16298186Sgordon} 16398186Sgordon 16478344Sobrien# 16598186Sgordon# mount_critical_filesystems type 16698186Sgordon# Go through the list of critical filesystems as provided in 16798186Sgordon# the rc.conf(5) variable $critical_filesystems_${type}, checking 16898186Sgordon# each one to see if it is mounted, and if it is not, mounting it. 16998186Sgordon# 17078344Sobrienmount_critical_filesystems() 17178344Sobrien{ 17298186Sgordon eval _fslist=\$critical_filesystems_${1} 17378344Sobrien for _fs in $_fslist; do 17478344Sobrien mount | ( 175126285Smtm _ismounted=false 17678344Sobrien while read what _on on _type type; do 17778344Sobrien if [ $on = $_fs ]; then 178126285Smtm _ismounted=true 17978344Sobrien fi 18078344Sobrien done 181126285Smtm if $_ismounted; then 182126285Smtm : 183126285Smtm else 18478344Sobrien mount $_fs >/dev/null 2>&1 18578344Sobrien fi 18698186Sgordon ) 18778344Sobrien done 18878344Sobrien} 18978344Sobrien 19078344Sobrien# 19198186Sgordon# check_pidfile pidfile procname [interpreter] 19298186Sgordon# Parses the first line of pidfile for a PID, and ensures 19378344Sobrien# that the process is running and matches procname. 19498186Sgordon# Prints the matching PID upon success, nothing otherwise. 19598186Sgordon# interpreter is optional; see _find_processes() for details. 19678344Sobrien# 19778344Sobriencheck_pidfile() 19878344Sobrien{ 19978344Sobrien _pidfile=$1 20078344Sobrien _procname=$2 20198186Sgordon _interpreter=$3 20278344Sobrien if [ -z "$_pidfile" -o -z "$_procname" ]; then 20398186Sgordon err 3 'USAGE: check_pidfile pidfile procname [interpreter]' 20478344Sobrien fi 20578344Sobrien if [ ! -f $_pidfile ]; then 206131061Smtm debug "pid file ($_pidfile): not readable." 20778344Sobrien return 20878344Sobrien fi 20978344Sobrien read _pid _junk < $_pidfile 21078344Sobrien if [ -z "$_pid" ]; then 211139949Skeramida debug "pid file ($_pidfile): no pid in file." 21278344Sobrien return 21378344Sobrien fi 21498186Sgordon _find_processes $_procname ${_interpreter:-.} '-p '"$_pid" 21578344Sobrien} 21678344Sobrien 21778344Sobrien# 21898186Sgordon# check_process procname [interpreter] 21978344Sobrien# Ensures that a process (or processes) named procname is running. 22098186Sgordon# Prints a list of matching PIDs. 22198186Sgordon# interpreter is optional; see _find_processes() for details. 22278344Sobrien# 22378344Sobriencheck_process() 22478344Sobrien{ 22578344Sobrien _procname=$1 22698186Sgordon _interpreter=$2 22778344Sobrien if [ -z "$_procname" ]; then 22898186Sgordon err 3 'USAGE: check_process procname [interpreter]' 22978344Sobrien fi 23098186Sgordon _find_processes $_procname ${_interpreter:-.} '-ax' 23198186Sgordon} 23298186Sgordon 23398186Sgordon# 23498186Sgordon# _find_processes procname interpreter psargs 23598186Sgordon# Search for procname in the output of ps generated by psargs. 23698186Sgordon# Prints the PIDs of any matching processes, space separated. 23798186Sgordon# 23898186Sgordon# If interpreter == ".", check the following variations of procname 23998186Sgordon# against the first word of each command: 24098186Sgordon# procname 24198186Sgordon# `basename procname` 24298186Sgordon# `basename procname` + ":" 24398186Sgordon# "(" + `basename procname` + ")" 244155719Sceri# "[" + `basename procname` + "]" 24598186Sgordon# 24698186Sgordon# If interpreter != ".", read the first line of procname, remove the 24798186Sgordon# leading #!, normalise whitespace, append procname, and attempt to 24898186Sgordon# match that against each command, either as is, or with extra words 249157841Sflz# at the end. As an alternative, to deal with interpreted daemons 250157841Sflz# using perl, the basename of the interpreter plus a colon is also 251157841Sflz# tried as the prefix to procname. 25298186Sgordon# 25398186Sgordon_find_processes() 25498186Sgordon{ 25598186Sgordon if [ $# -ne 3 ]; then 25698186Sgordon err 3 'USAGE: _find_processes procname interpreter psargs' 25798186Sgordon fi 25898186Sgordon _procname=$1 25998186Sgordon _interpreter=$2 26098186Sgordon _psargs=$3 26198186Sgordon 26278344Sobrien _pref= 26398186Sgordon if [ $_interpreter != "." ]; then # an interpreted script 26498186Sgordon read _interp < $_procname # read interpreter name 26598186Sgordon _interp=${_interp#\#!} # strip #! 26698186Sgordon set -- $_interp 26798186Sgordon if [ $_interpreter != $1 ]; then 26898186Sgordon warn "\$command_interpreter $_interpreter != $1" 26978344Sobrien fi 27098186Sgordon _interp="$* $_procname" # cleanup spaces, add _procname 271157841Sflz _interpbn=${1##*/} 27298186Sgordon _fp_args='_argv' 27398186Sgordon _fp_match='case "$_argv" in 274157841Sflz ${_interp}|"${_interp} "*|"${_interpbn}: ${_procname}"*)' 27598186Sgordon else # a normal daemon 27698186Sgordon _procnamebn=${_procname##*/} 27798186Sgordon _fp_args='_arg0 _argv' 27898186Sgordon _fp_match='case "$_arg0" in 279151426Sjhb $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})"|"[${_procnamebn}]")' 28098186Sgordon fi 28198186Sgordon 282161435Syar _proccheck="\ 283161436Syar $PS 2>/dev/null -o pid= -o jid= -o command= $_psargs"' | 284157657Sflz while read _npid _jid '"$_fp_args"'; do 285161436Syar '"$_fp_match"' 286157657Sflz if [ "$JID" -eq "$_jid" ]; 287157657Sflz then echo -n "$_pref$_npid"; 288157657Sflz _pref=" "; 289157657Sflz fi 29098186Sgordon ;; 29198186Sgordon esac 29298186Sgordon done' 29398186Sgordon 294114272Smtm# debug "in _find_processes: proccheck is ($_proccheck)." 29598186Sgordon eval $_proccheck 29698186Sgordon} 29798186Sgordon 29898186Sgordon# 29998186Sgordon# wait_for_pids pid [pid ...] 30098186Sgordon# spins until none of the pids exist 30198186Sgordon# 30298186Sgordonwait_for_pids() 30398186Sgordon{ 304126286Smtm _list="$@" 30598186Sgordon if [ -z "$_list" ]; then 30698186Sgordon return 30798186Sgordon fi 30898186Sgordon _prefix= 30998186Sgordon while true; do 31098186Sgordon _nlist=""; 31198186Sgordon for _j in $_list; do 31298186Sgordon if kill -0 $_j 2>/dev/null; then 31398186Sgordon _nlist="${_nlist}${_nlist:+ }$_j" 31498186Sgordon fi 31598186Sgordon done 31698186Sgordon if [ -z "$_nlist" ]; then 31798186Sgordon break 31878344Sobrien fi 31998186Sgordon _list=$_nlist 32098186Sgordon echo -n ${_prefix:-"Waiting for PIDS: "}$_list 32198186Sgordon _prefix=", " 32298186Sgordon sleep 2 32378344Sobrien done 32498186Sgordon if [ -n "$_prefix" ]; then 32598186Sgordon echo "." 32698186Sgordon fi 32778344Sobrien} 32878344Sobrien 32978344Sobrien# 33098186Sgordon# run_rc_command argument 33198186Sgordon# Search for argument in the list of supported commands, which is: 33298186Sgordon# "start stop restart rcvar status poll ${extra_commands}" 33398186Sgordon# If there's a match, run ${argument}_cmd or the default method 33498186Sgordon# (see below). 33578344Sobrien# 33698186Sgordon# If argument has a given prefix, then change the operation as follows: 33798186Sgordon# Prefix Operation 33878344Sobrien# ------ --------- 33998186Sgordon# fast Skip the pid check, and set rc_fast=yes 34098186Sgordon# force Set ${rcvar} to YES, and set rc_force=yes 341126303Smtm# one Set ${rcvar} to YES 34278344Sobrien# 34378344Sobrien# The following globals are used: 34478344Sobrien# 34598186Sgordon# Name Needed Purpose 34698186Sgordon# ---- ------ ------- 34778344Sobrien# name y Name of script. 34878344Sobrien# 34978344Sobrien# command n Full path to command. 35098186Sgordon# Not needed if ${rc_arg}_cmd is set for 35178344Sobrien# each keyword. 35278344Sobrien# 35378344Sobrien# command_args n Optional args/shell directives for command. 35478344Sobrien# 35598186Sgordon# command_interpreter n If not empty, command is interpreted, so 35698186Sgordon# call check_{pidfile,process}() appropriately. 35798186Sgordon# 35878344Sobrien# extra_commands n List of extra commands supported. 35978344Sobrien# 36098186Sgordon# pidfile n If set, use check_pidfile $pidfile $command, 36198186Sgordon# otherwise use check_process $command. 36298186Sgordon# In either case, only check if $command is set. 36378344Sobrien# 36498186Sgordon# procname n Process name to check for instead of $command. 36598186Sgordon# 36678344Sobrien# rcvar n This is checked with checkyesno to determine 36778344Sobrien# if the action should be run. 36878344Sobrien# 369157653Sflz# ${name}_program n Full path to command. 370157653Sflz# Meant to be used in /etc/rc.conf to override 371157653Sflz# ${command}. 372157653Sflz# 37378344Sobrien# ${name}_chroot n Directory to chroot to before running ${command} 37498186Sgordon# Requires /usr to be mounted. 37578344Sobrien# 37678344Sobrien# ${name}_chdir n Directory to cd to before running ${command} 37778344Sobrien# (if not using ${name}_chroot). 37878344Sobrien# 37978344Sobrien# ${name}_flags n Arguments to call ${command} with. 38078344Sobrien# NOTE: $flags from the parent environment 38178344Sobrien# can be used to override this. 38278344Sobrien# 38378344Sobrien# ${name}_nice n Nice level to run ${command} at. 38478344Sobrien# 38578344Sobrien# ${name}_user n User to run ${command} as, using su(1) if not 38678344Sobrien# using ${name}_chroot. 38798186Sgordon# Requires /usr to be mounted. 38878344Sobrien# 38978344Sobrien# ${name}_group n Group to run chrooted ${command} as. 39098186Sgordon# Requires /usr to be mounted. 39178344Sobrien# 39298186Sgordon# ${name}_groups n Comma separated list of supplementary groups 39398186Sgordon# to run the chrooted ${command} with. 39498186Sgordon# Requires /usr to be mounted. 39578344Sobrien# 39698186Sgordon# ${rc_arg}_cmd n If set, use this as the method when invoked; 39778344Sobrien# Otherwise, use default command (see below) 39878344Sobrien# 39998186Sgordon# ${rc_arg}_precmd n If set, run just before performing the 40098186Sgordon# ${rc_arg}_cmd method in the default 40198186Sgordon# operation (i.e, after checking for required 40298186Sgordon# bits and process (non)existence). 40378344Sobrien# If this completes with a non-zero exit code, 40498186Sgordon# don't run ${rc_arg}_cmd. 40578344Sobrien# 40698186Sgordon# ${rc_arg}_postcmd n If set, run just after performing the 40798186Sgordon# ${rc_arg}_cmd method, if that method 40898186Sgordon# returned a zero exit code. 40998186Sgordon# 41078344Sobrien# required_dirs n If set, check for the existence of the given 41178344Sobrien# directories before running the default 41278344Sobrien# (re)start command. 41378344Sobrien# 41478344Sobrien# required_files n If set, check for the readability of the given 41578344Sobrien# files before running the default (re)start 41678344Sobrien# command. 41778344Sobrien# 41878344Sobrien# required_vars n If set, perform checkyesno on each of the 41978344Sobrien# listed variables before running the default 42078344Sobrien# (re)start command. 42178344Sobrien# 42298186Sgordon# Default behaviour for a given argument, if no override method is 42398186Sgordon# provided: 42478344Sobrien# 42598186Sgordon# Argument Default behaviour 42698186Sgordon# -------- ----------------- 42778344Sobrien# start if !running && checkyesno ${rcvar} 42878344Sobrien# ${command} 42978344Sobrien# 43078344Sobrien# stop if ${pidfile} 43198186Sgordon# rc_pid=$(check_pidfile $pidfile $command) 43278344Sobrien# else 43398186Sgordon# rc_pid=$(check_process $command) 43498186Sgordon# kill $sig_stop $rc_pid 43598186Sgordon# wait_for_pids $rc_pid 43698186Sgordon# ($sig_stop defaults to TERM.) 43778344Sobrien# 43898186Sgordon# reload Similar to stop, except use $sig_reload instead, 43998186Sgordon# and doesn't wait_for_pids. 44078344Sobrien# $sig_reload defaults to HUP. 441151685Syar# Note that `reload' isn't provided by default, 442151685Syar# it should be enabled via $extra_commands. 44378344Sobrien# 44478344Sobrien# restart Run `stop' then `start'. 44578344Sobrien# 44698186Sgordon# status Show if ${command} is running, etc. 44778344Sobrien# 44898186Sgordon# poll Wait for ${command} to exit. 44998186Sgordon# 45098186Sgordon# rcvar Display what rc.conf variable is used (if any). 45198186Sgordon# 45298186Sgordon# Variables available to methods, and after run_rc_command() has 45398186Sgordon# completed: 45498186Sgordon# 45598186Sgordon# Variable Purpose 45698186Sgordon# -------- ------- 457126303Smtm# rc_arg Argument to command, after fast/force/one processing 45898186Sgordon# performed 45998186Sgordon# 46098186Sgordon# rc_flags Flags to start the default command with. 46198186Sgordon# Defaults to ${name}_flags, unless overridden 46298186Sgordon# by $flags from the environment. 46398186Sgordon# This variable may be changed by the precmd method. 46498186Sgordon# 46598186Sgordon# rc_pid PID of command (if appropriate) 46698186Sgordon# 46798186Sgordon# rc_fast Not empty if "fast" was provided (q.v.) 46898186Sgordon# 46998186Sgordon# rc_force Not empty if "force" was provided (q.v.) 47098186Sgordon# 47198186Sgordon# 47278344Sobrienrun_rc_command() 47378344Sobrien{ 474116097Smtm _return=0 47598186Sgordon rc_arg=$1 47678344Sobrien if [ -z "$name" ]; then 47798186Sgordon err 3 'run_rc_command: $name is not set.' 47878344Sobrien fi 47978344Sobrien 480132892Smtm # Don't repeat the first argument when passing additional command- 481132892Smtm # line arguments to the command subroutines. 482132892Smtm # 483132892Smtm shift 1 484132892Smtm rc_extra_args="$*" 485132892Smtm 486126303Smtm _rc_prefix= 48798186Sgordon case "$rc_arg" in 48878344Sobrien fast*) # "fast" prefix; don't check pid 48998186Sgordon rc_arg=${rc_arg#fast} 49098186Sgordon rc_fast=yes 49178344Sobrien ;; 492126303Smtm force*) # "force prefix; always run 49398186Sgordon rc_force=yes 494126303Smtm _rc_prefix=force 495126303Smtm rc_arg=${rc_arg#${_rc_prefix}} 49678344Sobrien if [ -n "${rcvar}" ]; then 49778344Sobrien eval ${rcvar}=YES 49878344Sobrien fi 49978344Sobrien ;; 500126303Smtm one*) # "one" prefix; set ${rcvar}=yes 501126303Smtm _rc_prefix=one 502126303Smtm rc_arg=${rc_arg#${_rc_prefix}} 503126303Smtm if [ -n "${rcvar}" ]; then 504126303Smtm eval ${rcvar}=YES 505126303Smtm fi 506126303Smtm ;; 50778344Sobrien esac 50878344Sobrien 50978344Sobrien _keywords="start stop restart rcvar $extra_commands" 51098186Sgordon rc_pid= 51178344Sobrien _pidcmd= 51298186Sgordon _procname=${procname:-${command}} 51398186Sgordon 514131135Smtm # setup pid check command 515131135Smtm if [ -n "$_procname" ]; then 51678344Sobrien if [ -n "$pidfile" ]; then 51798186Sgordon _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')' 51898186Sgordon else 51998186Sgordon _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')' 52078344Sobrien fi 52178344Sobrien if [ -n "$_pidcmd" ]; then 52298186Sgordon _keywords="${_keywords} status poll" 52378344Sobrien fi 52478344Sobrien fi 52578344Sobrien 52698186Sgordon if [ -z "$rc_arg" ]; then 527150796Syar rc_usage $_keywords 52878344Sobrien fi 52978344Sobrien 53078344Sobrien if [ -n "$flags" ]; then # allow override from environment 53198186Sgordon rc_flags=$flags 53278344Sobrien else 53398186Sgordon eval rc_flags=\$${name}_flags 53478344Sobrien fi 53598186Sgordon eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \ 53698186Sgordon _nice=\$${name}_nice _user=\$${name}_user \ 53798186Sgordon _group=\$${name}_group _groups=\$${name}_groups 53878344Sobrien 53998186Sgordon if [ -n "$_user" ]; then # unset $_user if running as that user 540124832Smtm if [ "$_user" = "$(eval $IDCMD)" ]; then 54198186Sgordon unset _user 54298186Sgordon fi 54398186Sgordon fi 54498186Sgordon 54578344Sobrien # if ${rcvar} is set, and $1 is not 54698186Sgordon # "rcvar", then run 54778344Sobrien # checkyesno ${rcvar} 54878344Sobrien # and return if that failed 54978344Sobrien # 55098186Sgordon if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" ]; then 55178344Sobrien if ! checkyesno ${rcvar}; then 55278344Sobrien return 0 55378344Sobrien fi 55478344Sobrien fi 55578344Sobrien 55678344Sobrien eval $_pidcmd # determine the pid if necessary 55778344Sobrien 55878344Sobrien for _elem in $_keywords; do 55998186Sgordon if [ "$_elem" != "$rc_arg" ]; then 56078344Sobrien continue 56178344Sobrien fi 56278344Sobrien 56378344Sobrien # if there's a custom ${XXX_cmd}, 56478344Sobrien # run that instead of the default 56578344Sobrien # 56698186Sgordon eval _cmd=\$${rc_arg}_cmd _precmd=\$${rc_arg}_precmd \ 56798186Sgordon _postcmd=\$${rc_arg}_postcmd 56878344Sobrien if [ -n "$_cmd" ]; then 56978344Sobrien # if the precmd failed and force 57078344Sobrien # isn't set, exit 57178344Sobrien # 572116097Smtm if [ -n "$_precmd" ]; then 573116097Smtm debug "run_rc_command: evaluating ${_precmd}()." 574132892Smtm eval $_precmd $rc_extra_args 575116097Smtm _return=$? 576160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && 577160698Syar return 1 57878344Sobrien fi 57978344Sobrien 580116097Smtm if [ -n "$_cmd" ]; then 581116097Smtm debug "run_rc_command: evaluating ${_cmd}()." 582132892Smtm eval $_cmd $rc_extra_args 583116097Smtm _return=$? 584160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && 585160698Syar return 1 58698186Sgordon fi 587109582Smtm 588116097Smtm if [ -n "$_postcmd" ]; then 589116097Smtm debug "run_rc_command: evaluating ${_postcmd}()." 590132892Smtm eval $_postcmd $rc_extra_args 591116097Smtm _return=$? 592116097Smtm fi 593116097Smtm return $_return 59478344Sobrien fi 59578344Sobrien 59698186Sgordon case "$rc_arg" in # default operations... 59778344Sobrien 59878344Sobrien status) 59998186Sgordon if [ -n "$rc_pid" ]; then 60098186Sgordon echo "${name} is running as pid $rc_pid." 60178344Sobrien else 60278344Sobrien echo "${name} is not running." 60378344Sobrien return 1 60478344Sobrien fi 60578344Sobrien ;; 60678344Sobrien 60778344Sobrien start) 608131135Smtm if [ -z "$rc_fast" -a -n "$rc_pid" ]; then 609157473Sflz echo 1>&2 "${name} already running? (pid=$rc_pid)." 610153152Syar return 1 61178344Sobrien fi 61278344Sobrien 613126287Smtm if [ ! -x ${_chroot}${command} ]; then 614160667Syar warn "run_rc_command: cannot run $command" 615153152Syar return 1 61678344Sobrien fi 61778344Sobrien 61878344Sobrien # check for required variables, 61978344Sobrien # directories, and files 62078344Sobrien # 62178344Sobrien for _f in $required_vars; do 62278344Sobrien if ! checkyesno $_f; then 623157473Sflz warn "\$${_f} is not enabled." 62498186Sgordon if [ -z "$rc_force" ]; then 62578344Sobrien return 1 62678344Sobrien fi 62778344Sobrien fi 62878344Sobrien done 62978344Sobrien for _f in $required_dirs; do 63078344Sobrien if [ ! -d "${_f}/." ]; then 63178344Sobrien warn "${_f} is not a directory." 63298186Sgordon if [ -z "$rc_force" ]; then 63378344Sobrien return 1 63478344Sobrien fi 63578344Sobrien fi 63678344Sobrien done 63778344Sobrien for _f in $required_files; do 63878344Sobrien if [ ! -r "${_f}" ]; then 63978344Sobrien warn "${_f} is not readable." 64098186Sgordon if [ -z "$rc_force" ]; then 64178344Sobrien return 1 64278344Sobrien fi 64378344Sobrien fi 64478344Sobrien done 64578344Sobrien 64678344Sobrien # if the precmd failed and force 64778344Sobrien # isn't set, exit 64878344Sobrien # 649116097Smtm if [ -n "${_precmd}" ]; then 650116097Smtm debug "run_rc_command: evaluating ${_precmd}()." 651116097Smtm eval $_precmd 652116097Smtm _return=$? 653160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && 654160698Syar return 1 65578344Sobrien fi 65678344Sobrien 657160668Syar # setup the full command to run 65878344Sobrien # 65978344Sobrien echo "Starting ${name}." 66078344Sobrien if [ -n "$_chroot" ]; then 66178344Sobrien _doit="\ 66278344Sobrien${_nice:+nice -n $_nice }\ 66378344Sobrienchroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\ 66498186Sgordon$_chroot $command $rc_flags $command_args" 66578344Sobrien else 66678344Sobrien _doit="\ 667161396Syar${_chdir:+cd $_chdir && }\ 66898186Sgordon$command $rc_flags $command_args" 66998186Sgordon if [ -n "$_user" ]; then 67098186Sgordon _doit="su -m $_user -c 'sh -c \"$_doit\"'" 67198186Sgordon fi 672161396Syar if [ -n "$_nice" ]; then 673161396Syar if [ -z "$_user" ]; then 674161396Syar _doit="sh -c \"$_doit\"" 675161396Syar fi 676161396Syar _doit="nice -n $_nice $_doit" 677161396Syar fi 67878344Sobrien fi 67998186Sgordon 680160668Syar # run the full command; 68198186Sgordon # if the cmd failed and force 68298186Sgordon # isn't set, exit 68398186Sgordon # 68498186Sgordon debug "run_rc_command: _doit: $_doit" 685116097Smtm eval $_doit 686116097Smtm _return=$? 687160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1 68898186Sgordon 68998186Sgordon # finally, run postcmd 69098186Sgordon # 691116097Smtm if [ -n "${_postcmd}" ]; then 692116097Smtm debug "run_rc_command: evaluating ${_postcmd}()." 693116097Smtm eval $_postcmd 694116097Smtm fi 69578344Sobrien ;; 69678344Sobrien 69778344Sobrien stop) 69898186Sgordon if [ -z "$rc_pid" ]; then 699153152Syar [ -n "$rc_fast" ] && return 0 70078344Sobrien if [ -n "$pidfile" ]; then 701157473Sflz echo 1>&2 \ 70278344Sobrien "${name} not running? (check $pidfile)." 70378344Sobrien else 704157473Sflz echo 1>&2 "${name} not running?" 70578344Sobrien fi 706153152Syar return 1 70778344Sobrien fi 70878344Sobrien 70998186Sgordon # if the precmd failed and force 71098186Sgordon # isn't set, exit 71198186Sgordon # 712117977Smtm if [ -n "$_precmd" ]; then 713116097Smtm eval $_precmd 714116097Smtm _return=$? 715160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && 716160698Syar return 1 71778344Sobrien fi 71898186Sgordon 71998186Sgordon # send the signal to stop 72098186Sgordon # 72178344Sobrien echo "Stopping ${name}." 72298186Sgordon _doit="kill -${sig_stop:-TERM} $rc_pid" 72398186Sgordon if [ -n "$_user" ]; then 72498186Sgordon _doit="su -m $_user -c 'sh -c \"$_doit\"'" 72598186Sgordon fi 72698186Sgordon 72798186Sgordon # if the stop cmd failed and force 72898186Sgordon # isn't set, exit 72998186Sgordon # 730116097Smtm eval $_doit 731116097Smtm _return=$? 732160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1 73398186Sgordon 73498186Sgordon # wait for the command to exit, 73598186Sgordon # and run postcmd. 73698186Sgordon wait_for_pids $rc_pid 737116097Smtm if [ -n "$_postcmd" ]; then 738116097Smtm eval $_postcmd 739116097Smtm _return=$? 740116097Smtm fi 74178344Sobrien ;; 74278344Sobrien 74378344Sobrien reload) 74498186Sgordon if [ -z "$rc_pid" ]; then 74578344Sobrien if [ -n "$pidfile" ]; then 746157473Sflz echo 1>&2 \ 74778344Sobrien "${name} not running? (check $pidfile)." 74878344Sobrien else 749157473Sflz echo 1>&2 "${name} not running?" 75078344Sobrien fi 751153152Syar return 1 75278344Sobrien fi 75378344Sobrien echo "Reloading ${name} config files." 754116097Smtm if [ -n "$_precmd" ]; then 755116097Smtm eval $_precmd 756116097Smtm _return=$? 757160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && 758160698Syar return 1 75978344Sobrien fi 76098186Sgordon _doit="kill -${sig_reload:-HUP} $rc_pid" 76198186Sgordon if [ -n "$_user" ]; then 76298186Sgordon _doit="su -m $_user -c 'sh -c \"$_doit\"'" 76398186Sgordon fi 764116097Smtm eval $_doit 765116097Smtm _return=$? 766160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1 767116097Smtm if [ -n "$_postcmd" ]; then 768116097Smtm eval $_postcmd 769116097Smtm _return=$? 77098186Sgordon fi 77178344Sobrien ;; 77278344Sobrien 77378344Sobrien restart) 774116097Smtm if [ -n "$_precmd" ]; then 775132892Smtm eval $_precmd $rc_extra_args 776116097Smtm _return=$? 777160698Syar [ $_return -ne 0 ] && [ -z "$rc_force" ] && 778160698Syar return 1 77978344Sobrien fi 78078344Sobrien # prevent restart being called more 78178344Sobrien # than once by any given script 78278344Sobrien # 783126285Smtm if ${_rc_restart_done:-false}; then 78478344Sobrien return 0 78578344Sobrien fi 786126285Smtm _rc_restart_done=true 78778344Sobrien 788152519Syar # run stop in a subshell to keep variables for start 789152519Syar ( run_rc_command ${_rc_prefix}stop $rc_extra_args ) 790152519Syar run_rc_command ${_rc_prefix}start $rc_extra_args 79198186Sgordon 792116097Smtm if [ -n "$_postcmd" ]; then 793132892Smtm eval $_postcmd $rc_extra_args 794116097Smtm _return=$? 795116097Smtm fi 79678344Sobrien ;; 79778344Sobrien 79898186Sgordon poll) 79998186Sgordon if [ -n "$rc_pid" ]; then 80098186Sgordon wait_for_pids $rc_pid 80198186Sgordon fi 80298186Sgordon ;; 80398186Sgordon 80478344Sobrien rcvar) 80578344Sobrien echo "# $name" 80678344Sobrien if [ -n "$rcvar" ]; then 80778344Sobrien if checkyesno ${rcvar}; then 80878344Sobrien echo "\$${rcvar}=YES" 80978344Sobrien else 81078344Sobrien echo "\$${rcvar}=NO" 81178344Sobrien fi 81278344Sobrien fi 81378344Sobrien ;; 81478344Sobrien 81578344Sobrien *) 816150796Syar rc_usage $_keywords 81778344Sobrien ;; 81878344Sobrien 81978344Sobrien esac 820116097Smtm return $_return 82178344Sobrien done 82278344Sobrien 82398186Sgordon echo 1>&2 "$0: unknown directive '$rc_arg'." 824150796Syar rc_usage $_keywords 825153152Syar # not reached 82678344Sobrien} 82778344Sobrien 82878344Sobrien# 82978344Sobrien# run_rc_script file arg 83078344Sobrien# Start the script `file' with `arg', and correctly handle the 83178344Sobrien# return value from the script. If `file' ends with `.sh', it's 83298186Sgordon# sourced into the current environment. If `file' appears to be 83398186Sgordon# a backup or scratch file, ignore it. Otherwise if it's 83498186Sgordon# executable run as a child process. 83578344Sobrien# 83678344Sobrienrun_rc_script() 83778344Sobrien{ 83878344Sobrien _file=$1 83978344Sobrien _arg=$2 84078344Sobrien if [ -z "$_file" -o -z "$_arg" ]; then 84178344Sobrien err 3 'USAGE: run_rc_script file arg' 84278344Sobrien fi 84378344Sobrien 84498186Sgordon unset name command command_args command_interpreter \ 84598186Sgordon extra_commands pidfile procname \ 84698186Sgordon rcvar required_dirs required_files required_vars 84798186Sgordon eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd 84898186Sgordon 84978344Sobrien case "$_file" in 850153105Sdougb /etc/rc.d/*.sh) # run in current shell 851146490Sschweikh set $_arg; . $_file 85278344Sobrien ;; 853153105Sdougb *[~#]|*.OLD|*.bak|*.orig|*,v) # scratch file; skip 85498186Sgordon warn "Ignoring scratch file $_file" 85598186Sgordon ;; 85678344Sobrien *) # run in subshell 85798186Sgordon if [ -x $_file ]; then 85898186Sgordon if [ -n "$rc_fast_and_loose" ]; then 859146490Sschweikh set $_arg; . $_file 86098186Sgordon else 861130161Smtm ( trap "echo Script $_file interrupted; kill -QUIT $$" 3 862130161Smtm trap "echo Script $_file interrupted; exit 1" 2 863146490Sschweikh set $_arg; . $_file ) 86498186Sgordon fi 86598186Sgordon fi 86678344Sobrien ;; 86778344Sobrien esac 86878344Sobrien} 86978344Sobrien 87078344Sobrien# 871157653Sflz# load_rc_config name 872157653Sflz# Source in the configuration file for a given name. 87378344Sobrien# 87478344Sobrienload_rc_config() 87578344Sobrien{ 876157653Sflz local _tmp 877157653Sflz 878157653Sflz _name=$1 879157653Sflz if [ -z "$_name" ]; then 880157653Sflz err 3 'USAGE: load_rc_config name' 88178344Sobrien fi 88278344Sobrien 883126285Smtm if ${_rc_conf_loaded:-false}; then 884126285Smtm : 885126285Smtm else 88698186Sgordon if [ -r /etc/defaults/rc.conf ]; then 88798186Sgordon debug "Sourcing /etc/defaults/rc.conf" 88898186Sgordon . /etc/defaults/rc.conf 88998186Sgordon source_rc_confs 89098186Sgordon elif [ -r /etc/rc.conf ]; then 89198186Sgordon debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)." 89298186Sgordon . /etc/rc.conf 89398186Sgordon fi 894126285Smtm _rc_conf_loaded=true 89598186Sgordon fi 896157653Sflz 897157653Sflz eval _override_command=\$${name}_program 898157653Sflz command=${command:+${_override_command:-$command}} 899157653Sflz 900157653Sflz if [ -z "${command}" ]; then 901157653Sflz _tmp=`/bin/realpath $0` 902157653Sflz prefix=${_tmp%/etc/rc.d/*}/ 903157653Sflz else 904157653Sflz prefix=${command%/*bin/*}/ 90578344Sobrien fi 906157653Sflz if [ "${prefix}" = "/" -o "${prefix}" = "/usr/" ] ; then 907157653Sflz etcdir="/etc" 908157653Sflz else 909157653Sflz etcdir="${prefix}etc" 910157653Sflz fi 911101850Sgordon 912157653Sflz # XXX - Deprecated 913157653Sflz if [ -f /etc/rc.conf.d/${_name} -a ${etcdir} != "/etc" ]; then 914157653Sflz debug "Sourcing /etc/rc.conf.d/${_name}" 915157653Sflz warn "Warning: /etc/rc.conf.d/${_name} is deprecated, please use ${etcdir}/rc.conf.d/${_name} instead." 916157656Sflz if [ -f ${etcdir}/rc.conf.d/${_name} ]; then 917157653Sflz warn "Warning: Both /etc/rc.conf.d/${_name} and ${etcdir}/rc.conf.d/${_name} exist." 918157653Sflz fi 919157653Sflz . /etc/rc.conf.d/${_name} 920157653Sflz fi 921157653Sflz 922157653Sflz if [ -f ${etcdir}/rc.conf.d/${_name} ]; then 923157653Sflz debug "Sourcing ${etcdir}/rc.conf.d/${_name}" 924157653Sflz . ${etcdir}/rc.conf.d/${_name} 925157653Sflz fi 926157653Sflz 927101850Sgordon # XXX - Deprecated variable name support 928101850Sgordon # 929103018Sgordon case ${OSTYPE} in 930101850Sgordon FreeBSD) 931146490Sschweikh [ -n "$portmap_enable" ] && rpcbind_enable="$portmap_enable" 932146490Sschweikh [ -n "$portmap_program" ] && rpcbind_program="$portmap_program" 933146490Sschweikh [ -n "$portmap_flags" ] && rpcbind_flags="$portmap_flags" 934146490Sschweikh [ -n "$single_mountd_enable" ] && mountd_enable="$single_mountd_enable" 935146490Sschweikh [ -n "$xntpd_enable" ] && ntpd_enable="$xntpd_enable" 936146490Sschweikh [ -n "$xntpd_program" ] && ntpd_program="$xntpd_program" 937146490Sschweikh [ -n "$xntpd_flags" ] && ntpd_flags="$xntpd_flags" 938115950Smtm [ -n "$dhcp_program" ] && dhclient_program="$dhcp_program" 939115950Smtm [ -n "$dhcp_flags" ] && dhclient_flags="$dhcp_flags" 940146490Sschweikh ;; 941101850Sgordon esac 94278344Sobrien} 943157473Sflz 944157473Sflz# 945157653Sflz# load_rc_config_var name var 946157653Sflz# Read the rc.conf(5) var for name and set in the 947157473Sflz# current shell, using load_rc_config in a subshell to prevent 948157473Sflz# unwanted side effects from other variable assignments. 949157473Sflz# 950157473Sflzload_rc_config_var() 951157473Sflz{ 952157473Sflz if [ $# -ne 2 ]; then 953157653Sflz err 3 'USAGE: load_rc_config_var name var' 954157473Sflz fi 955157473Sflz eval $(eval '( 956157473Sflz load_rc_config '$1' >/dev/null; 957157473Sflz if [ -n "${'$2'}" -o "${'$2'-UNSET}" != "UNSET" ]; then 958157473Sflz echo '$2'=\'\''${'$2'}\'\''; 959157473Sflz fi 960157473Sflz )' ) 961157473Sflz} 96278344Sobrien 96378344Sobrien# 96478344Sobrien# rc_usage commands 96578344Sobrien# Print a usage string for $0, with `commands' being a list of 96678344Sobrien# valid commands. 96778344Sobrien# 96878344Sobrienrc_usage() 96978344Sobrien{ 970126303Smtm echo -n 1>&2 "Usage: $0 [fast|force|one](" 97178344Sobrien 97278344Sobrien _sep= 973126286Smtm for _elem; do 97478344Sobrien echo -n 1>&2 "$_sep$_elem" 97578344Sobrien _sep="|" 97678344Sobrien done 97778344Sobrien echo 1>&2 ")" 97878344Sobrien exit 1 97978344Sobrien} 98078344Sobrien 98178344Sobrien# 98278344Sobrien# err exitval message 98378344Sobrien# Display message to stderr and log to the syslog, and exit with exitval. 98478344Sobrien# 98578344Sobrienerr() 98678344Sobrien{ 98778344Sobrien exitval=$1 98878344Sobrien shift 98978344Sobrien 990106643Sgordon if [ -x /usr/bin/logger ]; then 991106643Sgordon logger "$0: ERROR: $*" 992106643Sgordon fi 993106643Sgordon echo 1>&2 "$0: ERROR: $*" 99478344Sobrien exit $exitval 99578344Sobrien} 99678344Sobrien 99778344Sobrien# 99878344Sobrien# warn message 99978344Sobrien# Display message to stderr and log to the syslog. 100078344Sobrien# 100178344Sobrienwarn() 100278344Sobrien{ 1003106643Sgordon if [ -x /usr/bin/logger ]; then 1004106643Sgordon logger "$0: WARNING: $*" 1005106643Sgordon fi 1006106643Sgordon echo 1>&2 "$0: WARNING: $*" 100778344Sobrien} 100898186Sgordon 100998186Sgordon# 101098186Sgordon# info message 101198186Sgordon# Display informational message to stdout and log to syslog. 101298186Sgordon# 101398186Sgordoninfo() 101498186Sgordon{ 1015119170Smtm case ${rc_info} in 1016119170Smtm [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 1017119170Smtm if [ -x /usr/bin/logger ]; then 1018119170Smtm logger "$0: INFO: $*" 1019119170Smtm fi 1020119170Smtm echo "$0: INFO: $*" 1021119170Smtm ;; 1022119170Smtm esac 102398186Sgordon} 102498186Sgordon 102598186Sgordon# 102698186Sgordon# debug message 1027106643Sgordon# If debugging is enabled in rc.conf output message to stderr. 102898186Sgordon# BEWARE that you don't call any subroutine that itself calls this 102998186Sgordon# function. 103098186Sgordon# 103198186Sgordondebug() 103298186Sgordon{ 103398186Sgordon case ${rc_debug} in 103498186Sgordon [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 1035106700Sgordon if [ -x /usr/bin/logger ]; then 1036106700Sgordon logger "$0: INFO: $*" 1037106700Sgordon fi 1038146490Sschweikh echo 1>&2 "$0: DEBUG: $*" 103998186Sgordon ;; 104098186Sgordon esac 104198186Sgordon} 104298186Sgordon 104398186Sgordon# 104498186Sgordon# backup_file action file cur backup 104598186Sgordon# Make a backup copy of `file' into `cur', and save the previous 104698186Sgordon# version of `cur' as `backup' or use rcs for archiving. 104798186Sgordon# 104898186Sgordon# This routine checks the value of the backup_uses_rcs variable, 104998186Sgordon# which can be either YES or NO. 105098186Sgordon# 105198186Sgordon# The `action' keyword can be one of the following: 105298186Sgordon# 105398186Sgordon# add `file' is now being backed up (and is possibly 105498186Sgordon# being reentered into the backups system). `cur' 105598186Sgordon# is created and RCS files, if necessary, are 105698186Sgordon# created as well. 105798186Sgordon# 105898186Sgordon# update `file' has changed and needs to be backed up. 105998186Sgordon# If `cur' exists, it is copied to to `back' or 106098186Sgordon# checked into RCS (if the repository file is old), 106198186Sgordon# and then `file' is copied to `cur'. Another RCS 106298186Sgordon# check in done here if RCS is being used. 106398186Sgordon# 106498186Sgordon# remove `file' is no longer being tracked by the backups 106598186Sgordon# system. If RCS is not being used, `cur' is moved 106698186Sgordon# to `back', otherwise an empty file is checked in, 106798186Sgordon# and then `cur' is removed. 106898186Sgordon# 106998186Sgordon# 107098186Sgordonbackup_file() 107198186Sgordon{ 107298186Sgordon _action=$1 107398186Sgordon _file=$2 107498186Sgordon _cur=$3 107598186Sgordon _back=$4 107698186Sgordon 107798186Sgordon if checkyesno backup_uses_rcs; then 107898186Sgordon _msg0="backup archive" 107998186Sgordon _msg1="update" 108098186Sgordon 108198186Sgordon # ensure that history file is not locked 108298186Sgordon if [ -f $_cur,v ]; then 108398186Sgordon rcs -q -u -U -M $_cur 108498186Sgordon fi 108598186Sgordon 108698186Sgordon # ensure after switching to rcs that the 108798186Sgordon # current backup is not lost 108898186Sgordon if [ -f $_cur ]; then 108998186Sgordon # no archive, or current newer than archive 109098186Sgordon if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then 109198186Sgordon ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur 109298186Sgordon rcs -q -kb -U $_cur 109398186Sgordon co -q -f -u $_cur 109498186Sgordon fi 109598186Sgordon fi 109698186Sgordon 109798186Sgordon case $_action in 109898186Sgordon add|update) 109998186Sgordon cp -p $_file $_cur 110098186Sgordon ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur 110198186Sgordon rcs -q -kb -U $_cur 110298186Sgordon co -q -f -u $_cur 110398186Sgordon chown root:wheel $_cur $_cur,v 110498186Sgordon ;; 110598186Sgordon remove) 110698186Sgordon cp /dev/null $_cur 110798186Sgordon ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur 110898186Sgordon rcs -q -kb -U $_cur 110998186Sgordon chown root:wheel $_cur $_cur,v 111098186Sgordon rm $_cur 111198186Sgordon ;; 111298186Sgordon esac 111398186Sgordon else 111498186Sgordon case $_action in 111598186Sgordon add|update) 111698186Sgordon if [ -f $_cur ]; then 111798186Sgordon cp -p $_cur $_back 111898186Sgordon fi 111998186Sgordon cp -p $_file $_cur 112098186Sgordon chown root:wheel $_cur 112198186Sgordon ;; 112298186Sgordon remove) 112398186Sgordon mv -f $_cur $_back 112498186Sgordon ;; 112598186Sgordon esac 112698186Sgordon fi 112798186Sgordon} 1128119166Smtm 1129123344Smtm# make_symlink src link 1130123344Smtm# Make a symbolic link 'link' to src from basedir. If the 1131123344Smtm# directory in which link is to be created does not exist 1132123344Smtm# a warning will be displayed and an error will be returned. 1133123344Smtm# Returns 0 on sucess, 1 otherwise. 1134119166Smtm# 1135123344Smtmmake_symlink() 1136119166Smtm{ 1137123344Smtm local src link linkdir _me 1138123344Smtm src="$1" 1139123344Smtm link="$2" 1140123344Smtm linkdir="`dirname $link`" 1141123344Smtm _me="make_symlink()" 1142119166Smtm 1143123344Smtm if [ -z "$src" -o -z "$link" ]; then 1144123344Smtm warn "$_me: requires two arguments." 1145119166Smtm return 1 1146119166Smtm fi 1147123344Smtm if [ ! -d "$linkdir" ]; then 1148160667Syar warn "$_me: the directory $linkdir does not exist." 1149119166Smtm return 1 1150119166Smtm fi 1151146490Sschweikh if ! ln -sf $src $link; then 1152123344Smtm warn "$_me: unable to make a symbolic link from $link to $src" 1153119166Smtm return 1 1154119166Smtm fi 1155119166Smtm return 0 1156119166Smtm} 1157119166Smtm 1158119166Smtm# devfs_rulesets_from_file file 1159119166Smtm# Reads a set of devfs commands from file, and creates 1160119166Smtm# the specified rulesets with their rules. Returns non-zero 1161119166Smtm# if there was an error. 1162119166Smtm# 1163119166Smtmdevfs_rulesets_from_file() 1164119166Smtm{ 1165119166Smtm local file _err _me 1166119166Smtm file="$1" 1167119166Smtm _me="devfs_rulesets_from_file" 1168119166Smtm _err=0 1169119166Smtm 1170119166Smtm if [ -z "$file" ]; then 1171119166Smtm warn "$_me: you must specify a file" 1172119166Smtm return 1 1173119166Smtm fi 1174119166Smtm if [ ! -e "$file" ]; then 1175119166Smtm debug "$_me: no such file ($file)" 1176119166Smtm return 0 1177119166Smtm fi 1178119166Smtm debug "reading rulesets from file ($file)" 1179119166Smtm { while read line 1180119166Smtm do 1181119166Smtm case $line in 1182119166Smtm \#*) 1183119166Smtm continue 1184119166Smtm ;; 1185119166Smtm \[*\]*) 1186119166Smtm rulenum=`expr "$line" : "\[.*=\([0-9]*\)\]"` 1187119166Smtm if [ -z "$rulenum" ]; then 1188119166Smtm warn "$_me: cannot extract rule number ($line)" 1189119166Smtm _err=1 1190119166Smtm break 1191119166Smtm fi 1192119166Smtm rulename=`expr "$line" : "\[\(.*\)=[0-9]*\]"` 1193119166Smtm if [ -z "$rulename" ]; then 1194119166Smtm warn "$_me: cannot extract rule name ($line)" 1195119166Smtm _err=1 1196119166Smtm break; 1197119166Smtm fi 1198119166Smtm eval $rulename=\$rulenum 1199119166Smtm debug "found ruleset: $rulename=$rulenum" 1200146490Sschweikh if ! /sbin/devfs rule -s $rulenum delset; then 1201119166Smtm _err=1 1202119166Smtm break 1203119166Smtm fi 1204119166Smtm ;; 1205119166Smtm *) 1206119166Smtm rulecmd="${line%%"\#*"}" 1207119166Smtm # evaluate the command incase it includes 1208119166Smtm # other rules 1209119166Smtm if [ -n "$rulecmd" ]; then 1210119166Smtm debug "adding rule ($rulecmd)" 1211119166Smtm if ! eval /sbin/devfs rule -s $rulenum $rulecmd 1212119166Smtm then 1213119166Smtm _err=1 1214119166Smtm break 1215119166Smtm fi 1216119166Smtm fi 1217119166Smtm ;; 1218119166Smtm esac 1219119166Smtm if [ $_err -ne 0 ]; then 1220119166Smtm debug "error in $_me" 1221119166Smtm break 1222119166Smtm fi 1223119166Smtm done } < $file 1224119166Smtm return $_err 1225119166Smtm} 1226119166Smtm 1227119166Smtm# devfs_init_rulesets 1228119166Smtm# Initializes rulesets from configuration files. Returns 1229119166Smtm# non-zero if there was an error. 1230119166Smtm# 1231119166Smtmdevfs_init_rulesets() 1232119166Smtm{ 1233119166Smtm local file _me 1234119166Smtm _me="devfs_init_rulesets" 1235119166Smtm 1236119166Smtm # Go through this only once 1237119166Smtm if [ -n "$devfs_rulesets_init" ]; then 1238119166Smtm debug "$_me: devfs rulesets already initialized" 1239119166Smtm return 1240119166Smtm fi 1241146490Sschweikh for file in $devfs_rulesets; do 1242119166Smtm devfs_rulesets_from_file $file || return 1 1243119166Smtm done 1244119166Smtm devfs_rulesets_init=1 1245119166Smtm debug "$_me: devfs rulesets initialized" 1246119166Smtm return 0 1247119166Smtm} 1248119166Smtm 1249119166Smtm# devfs_set_ruleset ruleset [dir] 1250151619Smaxim# Sets the default ruleset of dir to ruleset. The ruleset argument 1251119166Smtm# must be a ruleset name as specified in devfs.rules(5) file. 1252119166Smtm# Returns non-zero if it could not set it successfully. 1253119166Smtm# 1254119166Smtmdevfs_set_ruleset() 1255119166Smtm{ 1256119166Smtm local devdir rs _me 1257119166Smtm [ -n "$1" ] && eval rs=\$$1 || rs= 1258119166Smtm [ -n "$2" ] && devdir="-m "$2"" || devdir= 1259119166Smtm _me="devfs_set_ruleset" 1260119166Smtm 1261119166Smtm if [ -z "$rs" ]; then 1262119166Smtm warn "$_me: you must specify a ruleset number" 1263119166Smtm return 1 1264119166Smtm fi 1265119166Smtm debug "$_me: setting ruleset ($rs) on mount-point (${devdir#-m })" 1266146490Sschweikh if ! /sbin/devfs $devdir ruleset $rs; then 1267119166Smtm warn "$_me: unable to set ruleset $rs to ${devdir#-m }" 1268119166Smtm return 1 1269119166Smtm fi 1270119166Smtm return 0 1271119166Smtm} 1272119166Smtm 1273119166Smtm# devfs_apply_ruleset ruleset [dir] 1274119166Smtm# Apply ruleset number $ruleset to the devfs mountpoint $dir. 1275119166Smtm# The ruleset argument must be a ruleset name as specified 1276119166Smtm# in a devfs.rules(5) file. Returns 0 on success or non-zero 1277119166Smtm# if it could not apply the ruleset. 1278119166Smtm# 1279119166Smtmdevfs_apply_ruleset() 1280119166Smtm{ 1281119166Smtm local devdir rs _me 1282119166Smtm [ -n "$1" ] && eval rs=\$$1 || rs= 1283119166Smtm [ -n "$2" ] && devdir="-m "$2"" || devdir= 1284119166Smtm _me="devfs_apply_ruleset" 1285119166Smtm 1286119166Smtm if [ -z "$rs" ]; then 1287119166Smtm warn "$_me: you must specify a ruleset" 1288119166Smtm return 1 1289119166Smtm fi 1290119166Smtm debug "$_me: applying ruleset ($rs) to mount-point (${devdir#-m })" 1291146490Sschweikh if ! /sbin/devfs $devdir rule -s $rs applyset; then 1292119166Smtm warn "$_me: unable to apply ruleset $rs to ${devdir#-m }" 1293119166Smtm return 1 1294119166Smtm fi 1295119166Smtm return 0 1296119166Smtm} 1297119166Smtm 1298119166Smtm# devfs_domount dir [ruleset] 1299119166Smtm# Mount devfs on dir. If ruleset is specified it is set 1300119166Smtm# on the mount-point. It must also be a ruleset name as specified 1301119166Smtm# in a devfs.rules(5) file. Returns 0 on success. 1302119166Smtm# 1303119166Smtmdevfs_domount() 1304119166Smtm{ 1305119166Smtm local devdir rs _me 1306119166Smtm devdir="$1" 1307119166Smtm [ -n "$2" ] && rs=$2 || rs= 1308119166Smtm _me="devfs_domount()" 1309119166Smtm 1310119166Smtm if [ -z "$devdir" ]; then 1311119166Smtm warn "$_me: you must specify a mount-point" 1312119166Smtm return 1 1313119166Smtm fi 1314119166Smtm debug "$_me: mount-point is ($devdir), ruleset is ($rs)" 1315146490Sschweikh if ! mount -t devfs dev "$devdir"; then 1316119166Smtm warn "$_me: Unable to mount devfs on $devdir" 1317119166Smtm return 1 1318119166Smtm fi 1319119166Smtm if [ -n "$rs" ]; then 1320119166Smtm devfs_init_rulesets 1321119166Smtm devfs_set_ruleset $rs $devdir 1322124797Scperciva devfs -m $devdir rule applyset 1323119166Smtm fi 1324119166Smtm return 0 1325119166Smtm} 1326119166Smtm 1327119166Smtm# devfs_mount_jail dir [ruleset] 1328119166Smtm# Mounts a devfs file system appropriate for jails 1329119166Smtm# on the directory dir. If ruleset is specified, the ruleset 1330119166Smtm# it names will be used instead. If present, ruleset must 1331119166Smtm# be the name of a ruleset as defined in a devfs.rules(5) file. 1332119166Smtm# This function returns non-zero if an error occurs. 1333119166Smtm# 1334119166Smtmdevfs_mount_jail() 1335119166Smtm{ 1336119166Smtm local jdev rs _me 1337119166Smtm jdev="$1" 1338119166Smtm [ -n "$2" ] && rs=$2 || rs="devfsrules_jail" 1339119166Smtm _me="devfs_mount_jail" 1340119166Smtm 1341119166Smtm devfs_init_rulesets 1342146490Sschweikh if ! devfs_domount "$jdev" $rs; then 1343119166Smtm warn "$_me: devfs was not mounted on $jdev" 1344119166Smtm return 1 1345119166Smtm fi 1346119166Smtm return 0 1347119166Smtm} 1348127345Sbrooks 1349127345Sbrooks# Provide a function for normalizing the mounting of memory 1350127345Sbrooks# filesystems. This should allow the rest of the code here to remain 1351127345Sbrooks# as close as possible between 5-current and 4-stable. 1352127345Sbrooks# $1 = size 1353127345Sbrooks# $2 = mount point 1354137451Skeramida# $3 = (optional) extra mdmfs flags 1355146490Sschweikhmount_md() 1356146490Sschweikh{ 1357127345Sbrooks if [ -n "$3" ]; then 1358137451Skeramida flags="$3" 1359127345Sbrooks fi 1360149421Syar /sbin/mdmfs $flags -s $1 md $2 1361127345Sbrooks} 1362131550Scperciva 1363159828Syar# Code common to scripts that need to load a kernel module 1364159828Syar# if it isn't in the kernel yet. Syntax: 1365160666Syar# load_kld [-e regex] [-m module] file 1366159828Syar# where -e or -m chooses the way to check if the module 1367159828Syar# is already loaded: 1368160666Syar# regex is egrep'd in the output from `kldstat -v', 1369160666Syar# module is passed to `kldstat -m'. 1370160666Syar# The default way is as though `-m file' were specified. 1371159828Syarload_kld() 1372159828Syar{ 1373159828Syar local _loaded _mod _opt _re 1374159828Syar 1375159828Syar while getopts "e:m:" _opt; do 1376159828Syar case "$_opt" in 1377159828Syar e) _re="$OPTARG" ;; 1378159828Syar m) _mod="$OPTARG" ;; 1379160666Syar *) err 3 'USAGE: load_kld [-e regex] [-m module] file' ;; 1380159828Syar esac 1381159828Syar done 1382159828Syar shift $(($OPTIND - 1)) 1383160666Syar if [ $# -ne 1 ]; then 1384160666Syar err 3 'USAGE: load_kld [-e regex] [-m module] file' 1385160666Syar fi 1386159828Syar _mod=${_mod:-$1} 1387159828Syar _loaded=false 1388159828Syar if [ -n "$_re" ]; then 1389159828Syar if kldstat -v | egrep -q -e "$_re"; then 1390159828Syar _loaded=true 1391159828Syar fi 1392159828Syar else 1393159828Syar if kldstat -q -m "$_mod"; then 1394159828Syar _loaded=true 1395159828Syar fi 1396159828Syar fi 1397159828Syar if ! $_loaded; then 1398159828Syar if ! kldload "$1"; then 1399159828Syar warn "Unable to load kernel module $1" 1400159828Syar return 1 1401160666Syar else 1402160666Syar info "$1 kernel module loaded." 1403159828Syar fi 1404160666Syar else 1405160666Syar debug "load_kld: $1 kernel module already loaded." 1406159828Syar fi 1407159828Syar return 0 1408159828Syar} 1409159828Syar 1410149049Spjd# ltr str src dst 1411149049Spjd# Change every $src in $str to $dst. 1412149049Spjd# Useful when /usr is not yet mounted and we cannot use tr(1), sed(1) nor 1413149049Spjd# awk(1). 1414149049Spjdltr() 1415149049Spjd{ 1416149049Spjd local _str _src _dst _out _com 1417149049Spjd _str=$1 1418149049Spjd _src=$2 1419149049Spjd _dst=$3 1420149049Spjd _out="" 1421149049Spjd 1422149049Spjd IFS=${_src} 1423149049Spjd for _com in ${_str}; do 1424149049Spjd if [ -z "${_out}" ]; then 1425149049Spjd _out="${_com}" 1426149049Spjd else 1427149049Spjd _out="${_out}${_dst}${_com}" 1428149049Spjd fi 1429149049Spjd done 1430149049Spjd echo "${_out}" 1431149049Spjd} 1432149049Spjd 1433149050Spjd# Creates a list of providers for GELI encryption. 1434149050Spjdgeli_make_list() 1435149050Spjd{ 1436149050Spjd local devices devices2 1437149050Spjd local provider mountpoint type options rest 1438149050Spjd 1439149050Spjd # Create list of GELI providers from fstab. 1440149050Spjd while read provider mountpoint type options rest ; do 1441155570Sflz case ":${options}" in 1442155570Sflz :*noauto*) 1443155570Sflz noauto=yes 1444155570Sflz ;; 1445155570Sflz *) 1446155570Sflz noauto=no 1447155570Sflz ;; 1448155570Sflz esac 1449155570Sflz 1450149050Spjd case ":${provider}" in 1451149050Spjd :#*) 1452149050Spjd continue 1453149050Spjd ;; 1454149050Spjd *.eli) 1455149050Spjd # Skip swap devices. 1456155570Sflz if [ "${type}" = "swap" -o "${options}" = "sw" -o "${noauto}" = "yes" ]; then 1457149050Spjd continue 1458149050Spjd fi 1459149050Spjd devices="${devices} ${provider}" 1460149050Spjd ;; 1461149050Spjd esac 1462149050Spjd done < /etc/fstab 1463149050Spjd 1464149050Spjd # Append providers from geli_devices. 1465149050Spjd devices="${devices} ${geli_devices}" 1466149050Spjd 1467149050Spjd for provider in ${devices}; do 1468149050Spjd provider=${provider%.eli} 1469149050Spjd provider=${provider#/dev/} 1470149050Spjd devices2="${devices2} ${provider}" 1471149050Spjd done 1472149050Spjd 1473149050Spjd echo ${devices2} 1474149050Spjd} 1475149050Spjd 1476153027Sdougb# Find scripts in local_startup directories that use the old syntax 1477153027Sdougb# 1478153027Sdougbfind_local_scripts_old () { 1479153027Sdougb zlist='' 1480153027Sdougb slist='' 1481153027Sdougb for dir in ${local_startup}; do 1482153027Sdougb if [ -d "${dir}" ]; then 1483153027Sdougb for file in ${dir}/[0-9]*.sh; do 1484153027Sdougb grep '^# PROVIDE:' $file >/dev/null 2>&1 && 1485153027Sdougb continue 1486153027Sdougb zlist="$zlist $file" 1487153027Sdougb done 1488153027Sdougb for file in ${dir}/[^0-9]*.sh; do 1489153027Sdougb grep '^# PROVIDE:' $file >/dev/null 2>&1 && 1490153027Sdougb continue 1491153027Sdougb slist="$slist $file" 1492153027Sdougb done 1493153027Sdougb fi 1494153027Sdougb done 1495153027Sdougb} 1496153027Sdougb 1497153027Sdougbfind_local_scripts_new () { 1498153027Sdougb local_rc='' 1499153027Sdougb for dir in ${local_startup}; do 1500153027Sdougb if [ -d "${dir}" ]; then 1501153297Sdougb for file in `grep -l '^# PROVIDE:' ${dir}/* 2>/dev/null`; do 1502153027Sdougb case "$file" in 1503153027Sdougb *.sample) ;; 1504153027Sdougb *) if [ -x "$file" ]; then 1505153027Sdougb local_rc="${local_rc} ${file}" 1506153027Sdougb fi 1507153027Sdougb ;; 1508153027Sdougb esac 1509153027Sdougb done 1510153027Sdougb fi 1511153027Sdougb done 1512153027Sdougb} 1513153027Sdougb 1514131550Scpercivafi 1515157841Sflz 1516157841Sflz_rc_subr_loaded=: 1517