1 # $NetBSD: rc.subr,v 1.49 2002/05/21 12:31:01 lukem Exp $
2 # $FreeBSD: src/etc/rc.subr,v 1.13 2003/06/09 17:31:06 mtm Exp $
3 # $DragonFly: src/etc/rc.subr,v 1.3 2003/08/01 16:30:41 rob Exp $
5 # Copyright (c) 1997-2002 The NetBSD Foundation, Inc.
8 # This code is derived from software contributed to The NetBSD Foundation
11 # Redistribution and use in source and binary forms, with or without
12 # modification, are permitted provided that the following conditions
14 # 1. Redistributions of source code must retain the above copyright
15 # notice, this list of conditions and the following disclaimer.
16 # 2. Redistributions in binary form must reproduce the above copyright
17 # notice, this list of conditions and the following disclaimer in the
18 # documentation and/or other materials provided with the distribution.
19 # 3. All advertising materials mentioning features or use of this software
20 # must display the following acknowledgement:
21 # This product includes software developed by the NetBSD
22 # Foundation, Inc. and its contributors.
23 # 4. Neither the name of The NetBSD Foundation nor the names of its
24 # contributors may be used to endorse or promote products derived
25 # from this software without specific prior written permission.
27 # THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 # ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 # POSSIBILITY OF SUCH DAMAGE.
40 # functions used by various rc scripts
44 # Operating System dependent/independent variables
48 SYSCTL_N="${SYSCTL} -n"
49 CMD_OSTYPE="${SYSCTL_N} kern.ostype"
50 OSTYPE=`${CMD_OSTYPE}`
60 SYSCTL_W="${SYSCTL} -w"
70 # Set the variable name enabling a specific service.
71 # FreeBSD uses ${service}_enable, while NetBSD uses
72 # just the name of the service. For example:
73 # FreeBSD: sendmail_enable="YES"
74 # NetBSD : sendmail="YES"
75 # $1 - if $name is not the base to work of off, specify
88 echo ${base_var}_enable;;
90 echo ${base_var}_enable
102 # force_depend script
103 # Force a service to start. Intended for use by services
104 # to resolve dependency issues. It is assumed the caller
105 # has check to make sure this call is necessary
106 # $1 - filename of script, in /etc/rc.d, to run
112 info "${name} depends on ${_depend}, which will be forced to start."
113 if ! /etc/rc.d/${_depend} forcestart ; then
114 warn "Unable to force ${_depend}. It may already be running."
122 # Test $1 variable, and warn if not set to YES or NO.
123 # Return 0 if it's "yes" (et al), nonzero otherwise.
128 debug "checkyesno: $1 is set to $_value."
131 # "yes", "true", "on", or "1"
132 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
136 # "no", "false", "off", or "0"
137 [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
141 warn "\$${1} is not set properly - see rc.conf(5)."
148 # print the list in reverse order
153 for _revfile in $*; do
154 _revlist="$_revfile $_revlist"
160 # mount_critical_filesystems type
161 # Go through the list of critical filesystems as provided in
162 # the rc.conf(5) variable $critical_filesystems_${type}, checking
163 # each one to see if it is mounted, and if it is not, mounting it.
165 mount_critical_filesystems()
167 eval _fslist=\$critical_filesystems_${1}
168 for _fs in $_fslist; do
171 while read what _on on _type type; do
172 if [ $on = $_fs ]; then
176 if [ $_ismounted = no ]; then
177 mount $_fs >/dev/null 2>&1
184 # check_pidfile pidfile procname [interpreter]
185 # Parses the first line of pidfile for a PID, and ensures
186 # that the process is running and matches procname.
187 # Prints the matching PID upon success, nothing otherwise.
188 # interpreter is optional; see _find_processes() for details.
195 if [ -z "$_pidfile" -o -z "$_procname" ]; then
196 err 3 'USAGE: check_pidfile pidfile procname [interpreter]'
198 if [ ! -f $_pidfile ]; then
199 debug "pid file {$_pidfile): not readable."
202 read _pid _junk < $_pidfile
203 if [ -z "$_pid" ]; then
204 debug "pid file {$_pidfile): no pid in file."
207 _find_processes $_procname ${_interpreter:-.} '-p '"$_pid"
211 # check_process procname [interpreter]
212 # Ensures that a process (or processes) named procname is running.
213 # Prints a list of matching PIDs.
214 # interpreter is optional; see _find_processes() for details.
220 if [ -z "$_procname" ]; then
221 err 3 'USAGE: check_process procname [interpreter]'
223 _find_processes $_procname ${_interpreter:-.} '-ax'
227 # _find_processes procname interpreter psargs
228 # Search for procname in the output of ps generated by psargs.
229 # Prints the PIDs of any matching processes, space separated.
231 # If interpreter == ".", check the following variations of procname
232 # against the first word of each command:
234 # `basename procname`
235 # `basename procname` + ":"
236 # "(" + `basename procname` + ")"
238 # If interpreter != ".", read the first line of procname, remove the
239 # leading #!, normalise whitespace, append procname, and attempt to
240 # match that against each command, either as is, or with extra words
245 if [ $# -ne 3 ]; then
246 err 3 'USAGE: _find_processes procname interpreter psargs'
253 if [ $_interpreter != "." ]; then # an interpreted script
254 read _interp < $_procname # read interpreter name
255 _interp=${_interp#\#!} # strip #!
257 if [ $_interpreter != $1 ]; then
258 warn "\$command_interpreter $_interpreter != $1"
260 _interp="$* $_procname" # cleanup spaces, add _procname
262 _fp_match='case "$_argv" in
263 ${_interp}|"${_interp} "*)'
264 else # a normal daemon
265 _procnamebn=${_procname##*/}
266 _fp_args='_arg0 _argv'
267 _fp_match='case "$_arg0" in
268 $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})")'
272 ps -o "pid,command" '"$_psargs"' |
273 while read _npid '"$_fp_args"'; do
277 esac ; '"$_fp_match"'
278 echo -n "$_pref$_npid" ;
284 # debug "in _find_processes: proccheck is ($_proccheck)."
289 # wait_for_pids pid [pid ...]
290 # spins until none of the pids exist
295 if [ -z "$_list" ]; then
302 if kill -0 $_j 2>/dev/null; then
303 _nlist="${_nlist}${_nlist:+ }$_j"
306 if [ -z "$_nlist" ]; then
310 echo -n ${_prefix:-"Waiting for PIDS: "}$_list
314 if [ -n "$_prefix" ]; then
320 # run_rc_command argument
321 # Search for argument in the list of supported commands, which is:
322 # "start stop restart rcvar status poll ${extra_commands}"
323 # If there's a match, run ${argument}_cmd or the default method
326 # If argument has a given prefix, then change the operation as follows:
329 # fast Skip the pid check, and set rc_fast=yes
330 # force Set ${rcvar} to YES, and set rc_force=yes
332 # The following globals are used:
334 # Name Needed Purpose
335 # ---- ------ -------
336 # name y Name of script.
338 # command n Full path to command.
339 # Not needed if ${rc_arg}_cmd is set for
342 # command_args n Optional args/shell directives for command.
344 # command_interpreter n If not empty, command is interpreted, so
345 # call check_{pidfile,process}() appropriately.
347 # extra_commands n List of extra commands supported.
349 # pidfile n If set, use check_pidfile $pidfile $command,
350 # otherwise use check_process $command.
351 # In either case, only check if $command is set.
353 # procname n Process name to check for instead of $command.
355 # rcvar n This is checked with checkyesno to determine
356 # if the action should be run.
358 # ${name}_chroot n Directory to chroot to before running ${command}
359 # Requires /usr to be mounted.
361 # ${name}_chdir n Directory to cd to before running ${command}
362 # (if not using ${name}_chroot).
364 # ${name}_flags n Arguments to call ${command} with.
365 # NOTE: $flags from the parent environment
366 # can be used to override this.
368 # ${name}_nice n Nice level to run ${command} at.
370 # ${name}_user n User to run ${command} as, using su(1) if not
371 # using ${name}_chroot.
372 # Requires /usr to be mounted.
374 # ${name}_group n Group to run chrooted ${command} as.
375 # Requires /usr to be mounted.
377 # ${name}_groups n Comma separated list of supplementary groups
378 # to run the chrooted ${command} with.
379 # Requires /usr to be mounted.
381 # ${rc_arg}_cmd n If set, use this as the method when invoked;
382 # Otherwise, use default command (see below)
384 # ${rc_arg}_precmd n If set, run just before performing the
385 # ${rc_arg}_cmd method in the default
386 # operation (i.e, after checking for required
387 # bits and process (non)existence).
388 # If this completes with a non-zero exit code,
389 # don't run ${rc_arg}_cmd.
391 # ${rc_arg}_postcmd n If set, run just after performing the
392 # ${rc_arg}_cmd method, if that method
393 # returned a zero exit code.
395 # required_dirs n If set, check for the existence of the given
396 # directories before running the default
399 # required_files n If set, check for the readability of the given
400 # files before running the default (re)start
403 # required_vars n If set, perform checkyesno on each of the
404 # listed variables before running the default
407 # Default behaviour for a given argument, if no override method is
410 # Argument Default behaviour
411 # -------- -----------------
412 # start if !running && checkyesno ${rcvar}
416 # rc_pid=$(check_pidfile $pidfile $command)
418 # rc_pid=$(check_process $command)
419 # kill $sig_stop $rc_pid
420 # wait_for_pids $rc_pid
421 # ($sig_stop defaults to TERM.)
423 # reload Similar to stop, except use $sig_reload instead,
424 # and doesn't wait_for_pids.
425 # $sig_reload defaults to HUP.
427 # restart Run `stop' then `start'.
429 # status Show if ${command} is running, etc.
431 # poll Wait for ${command} to exit.
433 # rcvar Display what rc.conf variable is used (if any).
435 # Variables available to methods, and after run_rc_command() has
440 # rc_arg Argument to command, after fast/force processing
443 # rc_flags Flags to start the default command with.
444 # Defaults to ${name}_flags, unless overridden
445 # by $flags from the environment.
446 # This variable may be changed by the precmd method.
448 # rc_pid PID of command (if appropriate)
450 # rc_fast Not empty if "fast" was provided (q.v.)
452 # rc_force Not empty if "force" was provided (q.v.)
459 if [ -z "$name" ]; then
460 err 3 'run_rc_command: $name is not set.'
464 fast*) # "fast" prefix; don't check pid
465 rc_arg=${rc_arg#fast}
468 force*) # "force prefix; always start
469 rc_arg=${rc_arg#force}
471 if [ -n "${rcvar}" ]; then
477 eval _overide_command=\$${name}_program
478 if [ -n "$_overide_command" ]; then
479 command=$_overide_command
482 _keywords="start stop restart rcvar $extra_commands"
485 _procname=${procname:-${command}}
487 # setup pid check command if not fast
488 if [ -z "$rc_fast" -a -n "$_procname" ]; then
489 if [ -n "$pidfile" ]; then
490 _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')'
492 _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')'
494 if [ -n "$_pidcmd" ]; then
495 _keywords="${_keywords} status poll"
499 if [ -z "$rc_arg" ]; then
500 rc_usage "$_keywords"
503 if [ -n "$flags" ]; then # allow override from environment
506 eval rc_flags=\$${name}_flags
508 eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \
509 _nice=\$${name}_nice _user=\$${name}_user \
510 _group=\$${name}_group _groups=\$${name}_groups
512 if [ -n "$_user" ]; then # unset $_user if running as that user
513 if [ "$_user" = "$(id -un)" ]; then
518 # if ${rcvar} is set, and $1 is not
520 # checkyesno ${rcvar}
521 # and return if that failed
523 if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" ]; then
524 if ! checkyesno ${rcvar}; then
529 eval $_pidcmd # determine the pid if necessary
531 for _elem in $_keywords; do
532 if [ "$_elem" != "$rc_arg" ]; then
536 # if there's a custom ${XXX_cmd},
537 # run that instead of the default
539 eval _cmd=\$${rc_arg}_cmd _precmd=\$${rc_arg}_precmd \
540 _postcmd=\$${rc_arg}_postcmd
541 if [ -n "$_cmd" ]; then
542 # if the precmd failed and force
545 if [ -n "$_precmd" ]; then
546 debug "run_rc_command: evaluating ${_precmd}()."
549 [ $_return -ne 0 ] && [ -z "$rc_force" ] &&
553 if [ -n "$_cmd" ]; then
554 debug "run_rc_command: evaluating ${_cmd}()."
557 [ $_return -ne 0 ] && [ -z "$rc_force" ] &&
561 if [ -n "$_postcmd" ]; then
562 debug "run_rc_command: evaluating ${_postcmd}()."
569 case "$rc_arg" in # default operations...
572 if [ -n "$rc_pid" ]; then
573 echo "${name} is running as pid $rc_pid."
575 echo "${name} is not running."
581 if [ -n "$rc_pid" ]; then
582 echo "${name} already running? (pid=$rc_pid)."
586 if [ ! -x $command ]; then
587 info "run_rc_command: cannot run ($command)."
591 # check for required variables,
592 # directories, and files
594 for _f in $required_vars; do
595 if ! checkyesno $_f; then
596 warn "\$${_f} is not set."
597 if [ -z "$rc_force" ]; then
602 for _f in $required_dirs; do
603 if [ ! -d "${_f}/." ]; then
604 warn "${_f} is not a directory."
605 if [ -z "$rc_force" ]; then
610 for _f in $required_files; do
611 if [ ! -r "${_f}" ]; then
612 warn "${_f} is not readable."
613 if [ -z "$rc_force" ]; then
619 # if the precmd failed and force
622 if [ -n "${_precmd}" ]; then
623 debug "run_rc_command: evaluating ${_precmd}()."
626 [ $_return -ne 0 ] && [ -z "$rc_force" ] &&
630 # setup the command to run, and run it
632 echo "Starting ${name}."
633 if [ -n "$_chroot" ]; then
635 ${_nice:+nice -n $_nice }\
636 chroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\
637 $_chroot $command $rc_flags $command_args"
640 ${_chdir:+cd $_chdir; }\
641 ${_nice:+nice -n $_nice }\
642 $command $rc_flags $command_args"
643 if [ -n "$_user" ]; then
644 _doit="su -m $_user -c 'sh -c \"$_doit\"'"
648 # if the cmd failed and force
651 debug "run_rc_command: _doit: $_doit"
654 [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1
656 # finally, run postcmd
658 if [ -n "${_postcmd}" ]; then
659 debug "run_rc_command: evaluating ${_postcmd}()."
665 if [ -z "$rc_pid" ]; then
666 if [ -n "$pidfile" ]; then
668 "${name} not running? (check $pidfile)."
670 echo "${name} not running?"
675 # if the precmd failed and force
678 if [ -n $_precmd ]; then
681 [ $_return -ne 0 ] && [ -z "$rc_force" ] &&
685 # send the signal to stop
687 echo "Stopping ${name}."
688 _doit="kill -${sig_stop:-TERM} $rc_pid"
689 if [ -n "$_user" ]; then
690 _doit="su -m $_user -c 'sh -c \"$_doit\"'"
693 # if the stop cmd failed and force
698 [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1
700 # wait for the command to exit,
702 wait_for_pids $rc_pid
703 if [ -n "$_postcmd" ]; then
710 if [ -z "$rc_pid" ]; then
711 if [ -n "$pidfile" ]; then
713 "${name} not running? (check $pidfile)."
715 echo "${name} not running?"
719 echo "Reloading ${name} config files."
720 if [ -n "$_precmd" ]; then
723 [ $_return -ne 0 ] && [ -z "$rc_force" ] &&
726 _doit="kill -${sig_reload:-HUP} $rc_pid"
727 if [ -n "$_user" ]; then
728 _doit="su -m $_user -c 'sh -c \"$_doit\"'"
732 [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1
733 if [ -n "$_postcmd" ]; then
740 if [ -n "$_precmd" ]; then
743 [ $_return -ne 0 ] && [ -z "$rc_force" ] &&
746 # prevent restart being called more
747 # than once by any given script
749 if [ -n "$_rc_restart_done" ]; then
754 ( $0 ${rc_force:+force}stop )
755 $0 ${rc_force:+force}start
757 if [ -n "$_postcmd" ]; then
764 if [ -n "$rc_pid" ]; then
765 wait_for_pids $rc_pid
771 if [ -n "$rcvar" ]; then
772 if checkyesno ${rcvar}; then
773 echo "\$${rcvar}=YES"
781 rc_usage "$_keywords"
788 echo 1>&2 "$0: unknown directive '$rc_arg'."
789 rc_usage "$_keywords"
794 # run_rc_script file arg
795 # Start the script `file' with `arg', and correctly handle the
796 # return value from the script. If `file' ends with `.sh', it's
797 # sourced into the current environment. If `file' appears to be
798 # a backup or scratch file, ignore it. Otherwise if it's
799 # executable run as a child process.
805 if [ -z "$_file" -o -z "$_arg" ]; then
806 err 3 'USAGE: run_rc_script file arg'
809 trap "echo 'Reboot interrupted'; exit 1" 3
811 unset name command command_args command_interpreter \
812 extra_commands pidfile procname \
813 rcvar required_dirs required_files required_vars
814 eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd
817 *.sh) # run in current shell
820 *[~#]|*.OLD|*.orig) # scratch file; skip
821 warn "Ignoring scratch file $_file"
824 if [ -x $_file ]; then
825 if [ -n "$rc_fast_and_loose" ]; then
828 ( trap "echo 'Reboot interrupted'; exit 1" 3
829 set $_arg ; . $_file )
838 # Source in the configuration file for a given command.
843 if [ -z "$_command" ]; then
844 err 3 'USAGE: load_rc_config command'
847 if [ -z "$_rc_conf_loaded" ]; then
848 if [ -r /etc/defaults/rc.conf ]; then
849 debug "Sourcing /etc/defaults/rc.conf"
850 . /etc/defaults/rc.conf
852 elif [ -r /etc/rc.conf ]; then
853 debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)."
858 if [ -f /etc/rc.conf.d/"$_command" ]; then
859 debug "Sourcing /etc/rc.conf.d/${_command}"
860 . /etc/rc.conf.d/"$_command"
863 # XXX - Deprecated variable name support
867 [ -n "$portmap_enable" ] && rpcbind_enable="$portmap_enable"
868 [ -n "$portmap_program" ] && rpcbind_program="$portmap_program"
869 [ -n "$portmap_flags" ] && rpcbind_flags="$portmap_flags"
870 [ -n "$single_mountd_enable" ] && mountd_enable="$single_mountd_enable"
871 [ -n "$xntpd_enable" ] && ntpd_enable="$xntpd_enable"
872 [ -n "$xntpd_program" ] && ntpd_program="$xntpd_program"
873 [ -n "$xntpd_flags" ] && ntpd_flags="$xntpd_flags"
874 [ -n "$dhcp_program" ] && dhclient_program="$dhcp_program"
875 [ -n "$dhcp_flags" ] && dhclient_flags="$dhcp_flags"
883 # Print a usage string for $0, with `commands' being a list of
888 echo -n 1>&2 "Usage: $0 [fast|force]("
892 echo -n 1>&2 "$_sep$_elem"
900 # err exitval message
901 # Display message to stderr and log to the syslog, and exit with exitval.
908 if [ -x /usr/bin/logger ]; then
909 logger "$0: ERROR: $*"
911 echo 1>&2 "$0: ERROR: $*"
917 # Display message to stderr and log to the syslog.
921 if [ -x /usr/bin/logger ]; then
922 logger "$0: WARNING: $*"
924 echo 1>&2 "$0: WARNING: $*"
929 # Display informational message to stdout and log to syslog.
933 if [ -x /usr/bin/logger ]; then
934 logger "$0: INFO: $*"
941 # If debugging is enabled in rc.conf output message to stderr.
942 # BEWARE that you don't call any subroutine that itself calls this
948 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
949 if [ -x /usr/bin/logger ]; then
950 logger "$0: INFO: $*"
952 echo 1>&2 "$0: DEBUG: $*"
958 # backup_file action file cur backup
959 # Make a backup copy of `file' into `cur', and save the previous
960 # version of `cur' as `backup' or use rcs for archiving.
962 # This routine checks the value of the backup_uses_rcs variable,
963 # which can be either YES or NO.
965 # The `action' keyword can be one of the following:
967 # add `file' is now being backed up (and is possibly
968 # being reentered into the backups system). `cur'
969 # is created and RCS files, if necessary, are
972 # update `file' has changed and needs to be backed up.
973 # If `cur' exists, it is copied to to `back' or
974 # checked into RCS (if the repository file is old),
975 # and then `file' is copied to `cur'. Another RCS
976 # check in done here if RCS is being used.
978 # remove `file' is no longer being tracked by the backups
979 # system. If RCS is not being used, `cur' is moved
980 # to `back', otherwise an empty file is checked in,
981 # and then `cur' is removed.
991 if checkyesno backup_uses_rcs; then
992 _msg0="backup archive"
995 # ensure that history file is not locked
996 if [ -f $_cur,v ]; then
997 rcs -q -u -U -M $_cur
1000 # ensure after switching to rcs that the
1001 # current backup is not lost
1002 if [ -f $_cur ]; then
1003 # no archive, or current newer than archive
1004 if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then
1005 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1014 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1017 chown root:wheel $_cur $_cur,v
1021 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1023 chown root:wheel $_cur $_cur,v
1030 if [ -f $_cur ]; then
1034 chown root:wheel $_cur