1 # $NetBSD: rc.subr,v 1.67 2006/10/07 11:25:15 elad Exp $
4 # Copyright (c) 1997-2004 The NetBSD Foundation, Inc.
7 # This code is derived from software contributed to The NetBSD Foundation
10 # Redistribution and use in source and binary forms, with or without
11 # modification, are permitted provided that the following conditions
13 # 1. Redistributions of source code must retain the above copyright
14 # notice, this list of conditions and the following disclaimer.
15 # 2. Redistributions in binary form must reproduce the above copyright
16 # notice, this list of conditions and the following disclaimer in the
17 # documentation and/or other materials provided with the distribution.
19 # THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 # ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 # TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 # POSSIBILITY OF SUCH DAMAGE.
32 # functions used by various rc scripts
35 : ${RC_PID:=$$}; export RC_PID
38 # Operating System dependent/independent variables
41 if [ -z "${_rc_subr_loaded}" ]; then
46 SYSCTL_N="${SYSCTL} -n"
49 IDCMD="if [ -x $ID ]; then $ID -un; fi"
51 JID=`$PS -p $$ -o jid=`
58 # List vars matching pattern.
62 set | { while read LINE; do
65 "$LINE"|*[!a-zA-Z0-9_]*) continue ;;
71 # set_rcvar [var] [defval] [desc]
73 # Echo or define a rc.conf(5) variable name. Global variable
76 # If no argument is specified, echo "${name}_enable".
78 # If only a var is specified, echo "${var}_enable".
80 # If var and defval are specified, the ${var} is defined as
81 # rc.conf(5) variable and the default value is ${defvar}. An
82 # optional argument $desc can also be specified to add a
83 # description for that.
95 debug "rcvar_define: \$$1=$2 is added" \
96 " as a rc.conf(5) variable."
100 rcvars="${rcvars# } $_var"
101 eval ${_var}_defval=\"$2\"
103 # encode multiple lines of _desc
105 eval ${_var}_desc=\"\${${_var}_desc#^^}^^$l\"
107 eval ${_var}_desc=\"\${${_var}_desc#^^}\"
112 # set_rcvar_obsolete oldvar [newvar] [msg]
113 # Define obsolete variable.
114 # Global variable $rcvars_obsolete is used.
120 debug "rcvar_obsolete: \$$1(old) -> \$$2(new) is defined"
122 rcvars_obsolete="${rcvars_obsolete# } $1"
123 eval ${1}_newvar=\"$2\"
125 eval ${_var}_obsolete_msg=\"$*\"
129 # force_depend script [rcvar]
130 # Force a service to start. Intended for use by services
131 # to resolve dependency issues.
132 # $1 - filename of script, in /etc/rc.d, to run
133 # $2 - name of the script's rcvar (minus the _enable)
137 local _depend _dep_rcvar
140 _dep_rcvar="${2:-$1}_enable"
142 [ -n "$rc_fast" ] && ! checkyesno always_force_depends &&
143 checkyesno $_dep_rcvar && return 0
145 /etc/rc.d/${_depend} forcestatus >/dev/null 2>&1 && return 0
147 info "${name} depends on ${_depend}, which will be forced to start."
148 if ! /etc/rc.d/${_depend} forcestart; then
149 warn "Unable to force ${_depend}. It may already be running."
156 # Test $1 variable, and warn if not set to YES or NO.
157 # Return 0 if it's "yes" (et al), nonzero otherwise.
162 debug "checkyesno: $1 is set to $_value."
165 # "yes", "true", "on", or "1"
166 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
170 # "no", "false", "off", or "0"
171 [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
175 warn "\$${1} is not set properly - see rc.conf(5)."
183 # print the list in reverse order
189 _revlist="$_revfile $_revlist"
195 # If booting directly to multiuser or $always is enabled,
196 # send SIGTERM to the parent (/etc/rc) to abort the boot.
197 # Otherwise just exit.
204 # "yes", "true", "on", or "1"
205 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
212 if [ "$autoboot" = yes -o "$always" = true ]; then
213 echo "ERROR: ABORTING BOOT (sending SIGTERM to parent)!"
220 # mount_critical_filesystems type
221 # Go through the list of critical filesystems as provided in
222 # the rc.conf(5) variable $critical_filesystems_${type}, checking
223 # each one to see if it is mounted, and if it is not, mounting it.
225 mount_critical_filesystems()
227 eval _fslist=\$critical_filesystems_${1}
228 for _fs in $_fslist; do
231 while read what _on on _type type; do
232 if [ $on = $_fs ]; then
239 mount $_fs >/dev/null 2>&1
246 # check_pidfile pidfile procname [interpreter]
247 # Parses the first line of pidfile for a PID, and ensures
248 # that the process is running and matches procname.
249 # Prints the matching PID upon success, nothing otherwise.
250 # interpreter is optional; see _find_processes() for details.
257 if [ -z "$_pidfile" -o -z "$_procname" ]; then
258 err 3 'USAGE: check_pidfile pidfile procname [interpreter]'
260 if [ ! -f $_pidfile ]; then
261 debug "pid file ($_pidfile): not readable."
264 read _pid _junk < $_pidfile
265 if [ -z "$_pid" ]; then
266 debug "pid file ($_pidfile): no pid in file."
269 _find_processes $_procname ${_interpreter:-.} '-p '"$_pid"
273 # check_process procname [interpreter]
274 # Ensures that a process (or processes) named procname is running.
275 # Prints a list of matching PIDs.
276 # interpreter is optional; see _find_processes() for details.
282 if [ -z "$_procname" ]; then
283 err 3 'USAGE: check_process procname [interpreter]'
285 _find_processes $_procname ${_interpreter:-.} '-ax'
289 # _find_processes procname interpreter psargs
290 # Search for procname in the output of ps generated by psargs.
291 # Prints the PIDs of any matching processes, space separated.
293 # If interpreter == ".", check the following variations of procname
294 # against the first word of each command:
296 # `basename procname`
297 # `basename procname` + ":"
298 # "(" + `basename procname` + ")"
299 # "[" + `basename procname` + "]"
301 # If interpreter != ".", read the first line of procname, remove the
302 # leading #!, normalise whitespace, append procname, and attempt to
303 # match that against each command, either as is, or with extra words
304 # at the end. As an alternative, to deal with interpreted daemons
305 # using perl, the basename of the interpreter plus a colon is also
306 # tried as the prefix to procname.
310 if [ $# -ne 3 ]; then
311 err 3 'USAGE: _find_processes procname interpreter psargs'
318 if [ $_interpreter != "." ]; then # an interpreted script
319 _script="${_chroot}${_chroot:+/}$_procname"
320 if [ -r "$_script" ]; then
321 read _interp < $_script # read interpreter name
324 _interp=${_interp#\#!} # strip #!
328 shift # drop env to get real name
331 if [ $_interpreter != $1 ]; then
332 warn "\$command_interpreter $_interpreter != $1"
336 warn "no shebang line in $_script"
341 warn "cannot read shebang line from $_script"
344 _interp="$* $_procname" # cleanup spaces, add _procname
347 _fp_match='case "$_argv" in
348 ${_interp}|"${_interp} "*|"[${_interpbn}]"|"${_interpbn}: ${_procname}"*)'
349 else # a normal daemon
350 _procnamebn=${_procname##*/}
351 _fp_args='_arg0 _argv'
352 _fp_match='case "$_arg0" in
353 $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})"|"[${_procnamebn}]")'
357 $PS 2>/dev/null -o pid= -o jid= -o command= $_psargs"' |
358 while read _npid _jid '"$_fp_args"'; do
360 if [ "$JID" -eq "$_jid" ];
361 then echo -n "$_pref$_npid";
368 # debug "in _find_processes: proccheck is ($_proccheck)."
372 # sort_lite [-b] [-n] [-k POS] [-t SEP]
373 # A lite version of sort(1) (supporting a few options) that can be used
374 # before the real sort(1) is available (e.g., in scripts that run prior
375 # to mountcritremote). Requires only shell built-in functionality.
379 local funcname=sort_lite
380 local sort_sep="$IFS" sort_ignore_leading_space=
381 local sort_field=0 sort_strict_fields= sort_numeric=
382 local nitems=0 skip_leading=0 trim=
385 while getopts bnk:t: flag; do
387 b) sort_ignore_leading_space=1 ;;
388 n) sort_numeric=1 sort_ignore_leading_space=1 ;;
389 k) sort_field="${OPTARG%%,*}" ;; # only up to first comma
390 # NB: Unlike sort(1) only one POS allowed
391 t) sort_sep="$OPTARG"
392 if [ ${#sort_sep} -gt 1 ]; then
393 echo "$funcname: multi-character tab \`$sort_sep'" >&2
401 shift $(( $OPTIND - 1 ))
403 # Create transformation pattern to trim leading text if desired
404 case "$sort_field" in
405 ""|[!0-9]*|*[!0-9.]*)
406 echo "$funcname: invalid sort field \`$sort_field'" >&2
410 skip_leading=${sort_field#*.} sort_field=${sort_field%%.*}
411 while [ ${skip_leading:-0} -gt 1 ] 2> /dev/null; do
412 trim="$trim?" skip_leading=$(( $skip_leading - 1 ))
416 # Copy input to series of local numbered variables
417 # NB: IFS of NULL preserves leading whitespace
419 while IFS= read -r LINE || [ "$LINE" ]; do
420 nitems=$(( $nitems + 1 ))
421 local src_$nitems="$LINE"
425 # Sort numbered locals using insertion sort
427 local curitem curitem_orig curitem_mod curitem_haskey
428 local dest dest_orig dest_mod dest_haskey
431 while [ $i -le $nitems ]; do
432 curitem_haskey=1 # Assume sort field (-k POS) exists
433 eval curitem=\"\$src_$i\"
434 curitem_mod="$curitem" # for modified comparison
435 curitem_orig="$curitem" # for original comparison
437 # Trim leading whitespace if desired
438 if [ "$sort_ignore_leading_space" ]; then
439 while case "$curitem_orig" in
440 [$IFS]*) : ;; *) false; esac
442 curitem_orig="${curitem_orig#?}"
444 curitem_mod="$curitem_orig"
447 # Shift modified comparison value if sort field (-k POS) is > 1
449 while [ $n -gt 1 ]; do
450 case "$curitem_mod" in
452 # Cut text up-to (and incl.) first separator
453 curitem_mod="${curitem_mod#*[$sort_sep]}"
455 # Skip NULLs unless strict field splitting
456 [ "$sort_strict_fields" ] ||
457 [ "${curitem_mod%%[$sort_sep]*}" ] ||
462 # Asked for a field that doesn't exist
463 curitem_haskey= break
468 # Trim trailing words if sort field >= 1
469 [ $sort_field -ge 1 -a "$sort_numeric" ] &&
470 curitem_mod="${curitem_mod%%[$sort_sep]*}"
472 # Apply optional trim (-k POS.TRIM) to cut leading characters
473 curitem_mod="${curitem_mod#$trim}"
475 # Determine the type of modified comparison to use initially
476 # NB: Prefer numerical if requested but fallback to standard
477 case "$curitem_mod" in
478 ""|[!0-9]*) # NULL or begins with non-number
480 [ "$sort_numeric" ] && curitem_mod=0
483 if [ "$sort_numeric" ]; then
485 curitem_mod="${curitem_mod%%[!0-9]*}"
486 # NB: trailing non-digits removed
487 # otherwise numeric comparison fails
493 # If first time through, short-circuit below position-search
494 if [ $i -le 1 ]; then
501 # Find appropriate element position
505 dest_haskey=$curitem_haskey
506 eval dest=\"\$dest_$d\"
507 dest_mod="$dest" # for modified comparison
508 dest_orig="$dest" # for original comparison
510 # Trim leading whitespace if desired
511 if [ "$sort_ignore_leading_space" ]; then
512 while case "$dest_orig" in
513 [$IFS]*) : ;; *) false; esac
515 dest_orig="${dest_orig#?}"
517 dest_mod="$dest_orig"
520 # Shift modified value if sort field (-k POS) is > 1
522 while [ $n -gt 1 ]; do
525 # Cut text up-to (and incl.) 1st sep
526 dest_mod="${dest_mod#*[$sort_sep]}"
528 # Skip NULLs unless strict fields
529 [ "$sort_strict_fields" ] ||
530 [ "${dest_mod%%[$sort_sep]*}" ] ||
535 # Asked for a field that doesn't exist
541 # Trim trailing words if sort field >= 1
542 [ $sort_field -ge 1 -a "$sort_numeric" ] &&
543 dest_mod="${dest_mod%%[$sort_sep]*}"
545 # Apply optional trim (-k POS.TRIM), cut leading chars
546 dest_mod="${dest_mod#$trim}"
548 # Determine type of modified comparison to use
549 # NB: Prefer numerical if requested, fallback to std
551 ""|[!0-9]*) # NULL or begins with non-number
553 [ "$sort_numeric" ] && dest_mod=0
556 if [ "$sort_numeric" ]; then
558 dest_mod="${dest_mod%%[!0-9]*}"
559 # NB: kill trailing non-digits
560 # for numeric comparison safety
566 # Break if we've found the proper element position
567 if [ "$curitem_haskey" -a "$dest_haskey" ]; then
568 if [ "$dest_mod" = "$curitem_mod" ]; then
569 [ "$dest_orig" ">" "$curitem_orig" ] &&
571 elif [ "$dest_mod" $gt "$curitem_mod" ] \
577 [ "$dest_orig" ">" "$curitem_orig" ] && break
580 # Break if we've hit the end
581 [ $d -ge $i ] && break
586 # Shift remaining positions forward, making room for new item
588 while [ $n -ge $d ]; do
589 # Shift destination item forward one placement
590 eval dest_$(( $n + 1 ))=\"\$dest_$n\"
595 if [ $i -eq 1 ]; then
596 local dest_1="$curitem"
598 local dest_$d="$curitem"
604 # Print sorted results
606 while [ $d -le $nitems ]; do
607 eval echo \"\$dest_$d\"
613 # wait_for_pids pid [pid ...]
614 # spins until none of the pids exist
618 local _list _prefix _nlist _j
621 if [ -z "$_list" ]; then
628 if kill -0 $_j 2>/dev/null; then
629 _nlist="${_nlist}${_nlist:+ }$_j"
630 [ -n "$_prefix" ] && sleep 1
633 if [ -z "$_nlist" ]; then
637 echo -n ${_prefix:-"Waiting for PIDS: "}$_list
639 pwait $_list 2>/dev/null
641 if [ -n "$_prefix" ]; then
647 # get_pidfile_from_conf string file
649 # Takes a string to search for in the specified file.
650 # Ignores lines with traditional comment characters.
654 # if get_pidfile_from_conf string file; then
655 # pidfile="$_pidfile_from_conf"
657 # pidfile='appropriate default'
660 get_pidfile_from_conf()
662 if [ -z "$1" -o -z "$2" ]; then
663 err 3 "USAGE: get_pidfile_from_conf string file ($name)"
666 local string file line
668 string="$1" ; file="$2"
670 if [ ! -s "$file" ]; then
671 err 3 "get_pidfile_from_conf: $file does not exist ($name)"
676 *[#\;]*${string}*) continue ;;
677 *${string}*) break ;;
681 if [ -n "$line" ]; then
683 _pidfile_from_conf="/${line%%[\"\;]*}"
691 # If rc_quiet is set (usually as a result of using faststart at
692 # boot time) check if rc_startmsgs is enabled.
696 if [ -n "$rc_quiet" ]; then
697 checkyesno rc_startmsgs
704 # run_rc_command argument
705 # Search for argument in the list of supported commands, which is:
706 # "start stop restart rcvar status poll ${extra_commands}"
707 # If there's a match, run ${argument}_cmd or the default method
710 # If argument has a given prefix, then change the operation as follows:
713 # fast Skip the pid check, and set rc_fast=yes, rc_quiet=yes
714 # force Set ${rcvar} to YES, and set rc_force=yes
715 # one Set ${rcvar} to YES
716 # quiet Don't output some diagnostics, and set rc_quiet=yes
718 # The following globals are used:
720 # Name Needed Purpose
721 # ---- ------ -------
722 # name y Name of script.
724 # command n Full path to command.
725 # Not needed if ${rc_arg}_cmd is set for
728 # command_args n Optional args/shell directives for command.
730 # command_interpreter n If not empty, command is interpreted, so
731 # call check_{pidfile,process}() appropriately.
733 # desc n Description of script.
735 # extra_commands n List of extra commands supported.
737 # pidfile n If set, use check_pidfile $pidfile $command,
738 # otherwise use check_process $command.
739 # In either case, only check if $command is set.
741 # procname n Process name to check for instead of $command.
743 # rcvar n This is checked with checkyesno to determine
744 # if the action should be run.
746 # ${name}_program n Full path to command.
747 # Meant to be used in /etc/rc.conf to override
750 # ${name}_chroot n Directory to chroot to before running ${command}
751 # Requires /usr to be mounted.
753 # ${name}_chdir n Directory to cd to before running ${command}
754 # (if not using ${name}_chroot).
756 # ${name}_flags n Arguments to call ${command} with.
757 # NOTE: $flags from the parent environment
758 # can be used to override this.
760 # ${name}_fib n Routing table number to run ${command} with.
762 # ${name}_nice n Nice level to run ${command} at.
764 # ${name}_user n User to run ${command} as, using su(1) if not
765 # using ${name}_chroot.
766 # Requires /usr to be mounted.
768 # ${name}_group n Group to run chrooted ${command} as.
769 # Requires /usr to be mounted.
771 # ${name}_groups n Comma separated list of supplementary groups
772 # to run the chrooted ${command} with.
773 # Requires /usr to be mounted.
775 # ${rc_arg}_cmd n If set, use this as the method when invoked;
776 # Otherwise, use default command (see below)
778 # ${rc_arg}_precmd n If set, run just before performing the
779 # ${rc_arg}_cmd method in the default
780 # operation (i.e, after checking for required
781 # bits and process (non)existence).
782 # If this completes with a non-zero exit code,
783 # don't run ${rc_arg}_cmd.
785 # ${rc_arg}_postcmd n If set, run just after performing the
786 # ${rc_arg}_cmd method, if that method
787 # returned a zero exit code.
789 # required_dirs n If set, check for the existence of the given
790 # directories before running a (re)start command.
792 # required_files n If set, check for the readability of the given
793 # files before running a (re)start command.
795 # required_modules n If set, ensure the given kernel modules are
796 # loaded before running a (re)start command.
797 # The check and possible loads are actually
798 # done after start_precmd so that the modules
799 # aren't loaded in vain, should the precmd
800 # return a non-zero status to indicate a error.
801 # If a word in the list looks like "foo:bar",
802 # "foo" is the KLD file name and "bar" is the
803 # module name. If a word looks like "foo~bar",
804 # "foo" is the KLD file name and "bar" is a
805 # egrep(1) pattern matching the module name.
806 # Otherwise the module name is assumed to be
807 # the same as the KLD file name, which is most
808 # common. See load_kld().
810 # required_vars n If set, perform checkyesno on each of the
811 # listed variables before running the default
814 # Default behaviour for a given argument, if no override method is
817 # Argument Default behaviour
818 # -------- -----------------
819 # start if !running && checkyesno ${rcvar}
823 # rc_pid=$(check_pidfile $pidfile $command)
825 # rc_pid=$(check_process $command)
826 # kill $sig_stop $rc_pid
827 # wait_for_pids $rc_pid
828 # ($sig_stop defaults to TERM.)
830 # reload Similar to stop, except use $sig_reload instead,
831 # and doesn't wait_for_pids.
832 # $sig_reload defaults to HUP.
833 # Note that `reload' isn't provided by default,
834 # it should be enabled via $extra_commands.
836 # restart Run `stop' then `start'.
838 # status Show if ${command} is running, etc.
840 # poll Wait for ${command} to exit.
842 # rcvar Display what rc.conf variable is used (if any).
844 # Variables available to methods, and after run_rc_command() has
849 # rc_arg Argument to command, after fast/force/one processing
852 # rc_flags Flags to start the default command with.
853 # Defaults to ${name}_flags, unless overridden
854 # by $flags from the environment.
855 # This variable may be changed by the precmd method.
857 # rc_pid PID of command (if appropriate)
859 # rc_fast Not empty if "fast" was provided (q.v.)
861 # rc_force Not empty if "force" was provided (q.v.)
863 # rc_quiet Not empty if "quiet" was provided
870 if [ -z "$name" ]; then
871 err 3 'run_rc_command: $name is not set.'
874 # Don't repeat the first argument when passing additional command-
875 # line arguments to the command subroutines.
882 fast*) # "fast" prefix; don't check pid
883 rc_arg=${rc_arg#fast}
887 force*) # "force" prefix; always run
890 rc_arg=${rc_arg#${_rc_prefix}}
891 if [ -n "${rcvar}" ]; then
895 one*) # "one" prefix; set ${rcvar}=yes
897 rc_arg=${rc_arg#${_rc_prefix}}
898 if [ -n "${rcvar}" ]; then
902 quiet*) # "quiet" prefix; omit some messages
904 rc_arg=${rc_arg#${_rc_prefix}}
909 eval _override_command=\$${name}_program
910 command=${_override_command:-$command}
912 _keywords="start stop restart rcvar $extra_commands"
915 _procname=${procname:-${command}}
917 # setup pid check command
918 if [ -n "$_procname" ]; then
919 if [ -n "$pidfile" ]; then
920 _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')'
922 _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')'
924 if [ -n "$_pidcmd" ]; then
925 _keywords="${_keywords} status poll"
929 if [ -z "$rc_arg" ]; then
933 if [ -n "$flags" ]; then # allow override from environment
936 eval rc_flags=\$${name}_flags
938 eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \
939 _nice=\$${name}_nice _user=\$${name}_user \
940 _group=\$${name}_group _groups=\$${name}_groups \
943 if [ -n "$_user" ]; then # unset $_user if running as that user
944 if [ "$_user" = "$(eval $IDCMD)" ]; then
949 [ -z "$autoboot" ] && eval $_pidcmd # determine the pid if necessary
951 for _elem in $_keywords; do
952 if [ "$_elem" != "$rc_arg" ]; then
955 # if ${rcvar} is set, $1 is not "rcvar"
956 # and ${rc_pid} is not set, then run
957 # checkyesno ${rcvar}
958 # and return if that failed
960 if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" -a "$rc_arg" != "stop" ] ||
961 [ -n "${rcvar}" -a "$rc_arg" = "stop" -a -z "${rc_pid}" ]; then
962 if ! checkyesno ${rcvar}; then
963 if [ -n "${rc_quiet}" ]; then
966 echo -n "Cannot '${rc_arg}' $name. Set ${rcvar} to "
967 echo -n "YES in /etc/rc.conf or use 'one${rc_arg}' "
968 echo "instead of '${rc_arg}'."
973 # if there's a custom ${XXX_cmd},
974 # run that instead of the default
976 eval _cmd=\$${rc_arg}_cmd \
977 _precmd=\$${rc_arg}_precmd \
978 _postcmd=\$${rc_arg}_postcmd
980 if [ -n "$_cmd" ]; then
981 _run_rc_precmd || return 1
982 _run_rc_doit "$_cmd $rc_extra_args" || return 1
987 case "$rc_arg" in # default operations...
990 _run_rc_precmd || return 1
991 if [ -n "$rc_pid" ]; then
992 echo "${name} is running as pid $rc_pid."
994 echo "${name} is not running."
1001 if [ -z "$rc_fast" -a -n "$rc_pid" ]; then
1002 if [ -z "$rc_quiet" ]; then
1003 echo 1>&2 "${name} already running? " \
1009 if [ ! -x "${_chroot}${_chroot:+/}${command}" ]; then
1010 warn "run_rc_command: cannot run $command"
1014 if ! _run_rc_precmd; then
1015 warn "failed precmd routine for ${name}"
1019 # setup the full command to run
1021 check_startmsgs && echo "Starting ${name}."
1022 if [ -n "$_chroot" ]; then
1024 ${_nice:+nice -n $_nice }\
1025 ${_fib:+setfib -F $_fib }\
1026 chroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\
1027 $_chroot $command $rc_flags $command_args"
1030 ${_chdir:+cd $_chdir && }\
1031 ${_fib:+setfib -F $_fib }\
1032 $command $rc_flags $command_args"
1033 if [ -n "$_user" ]; then
1034 _doit="su -m $_user -c 'sh -c \"$_doit\"'"
1036 if [ -n "$_nice" ]; then
1037 if [ -z "$_user" ]; then
1038 _doit="sh -c \"$_doit\""
1040 _doit="nice -n $_nice $_doit"
1044 # run the full command
1046 if ! _run_rc_doit "$_doit"; then
1047 warn "failed to start ${name}"
1051 # finally, run postcmd
1057 if [ -z "$rc_pid" ]; then
1058 [ -n "$rc_fast" ] && return 0
1063 _run_rc_precmd || return 1
1065 # send the signal to stop
1067 echo "Stopping ${name}."
1068 _doit=$(_run_rc_killcmd "${sig_stop:-TERM}")
1069 _run_rc_doit "$_doit" || return 1
1071 # wait for the command to exit,
1073 wait_for_pids $rc_pid
1079 if [ -z "$rc_pid" ]; then
1084 _run_rc_precmd || return 1
1086 _doit=$(_run_rc_killcmd "${sig_reload:-HUP}")
1087 _run_rc_doit "$_doit" || return 1
1093 # prevent restart being called more
1094 # than once by any given script
1096 if ${_rc_restart_done:-false}; then
1099 _rc_restart_done=true
1101 _run_rc_precmd || return 1
1103 # run those in a subshell to keep global variables
1104 ( run_rc_command ${_rc_prefix}stop $rc_extra_args )
1105 ( run_rc_command ${_rc_prefix}start $rc_extra_args )
1107 [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1
1113 _run_rc_precmd || return 1
1114 if [ -n "$rc_pid" ]; then
1115 wait_for_pids $rc_pid
1122 if [ -n "$desc" ]; then
1128 # Get unique vars in $rcvar $rcvars
1129 for _v in $rcvar $rcvars; do
1131 $_v\ *|\ *$_v|*\ $_v\ *) ;;
1132 *) v="${v# } $_v" ;;
1136 # Display variables.
1138 if [ -z "$_v" ]; then
1142 eval _desc=\$${_v}_desc
1143 eval _defval=\$${_v}_defval
1146 eval echo \"$_v=\\\"\$$_v\\\"\"
1147 # decode multiple lines of _desc
1148 while [ -n "$_desc" ]; do
1151 echo "# $_h ${_desc%%^^*}"
1156 echo "# $_h ${_desc}"
1161 echo "# (default: \"$_defval\")"
1174 echo 1>&2 "$0: unknown directive '$rc_arg'."
1180 # Helper functions for run_rc_command: common code.
1181 # They use such global variables besides the exported rc_* ones:
1184 # ------------------
1191 check_required_before "$rc_arg" || return 1
1193 if [ -n "$_precmd" ]; then
1194 debug "run_rc_command: ${rc_arg}_precmd: $_precmd $rc_extra_args"
1195 eval "$_precmd $rc_extra_args"
1198 # If precmd failed and force isn't set, request exit.
1199 if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then
1204 check_required_after "$rc_arg" || return 1
1211 if [ -n "$_postcmd" ]; then
1212 debug "run_rc_command: ${rc_arg}_postcmd: $_postcmd $rc_extra_args"
1213 eval "$_postcmd $rc_extra_args"
1221 debug "run_rc_command: doit: $*"
1225 # If command failed and force isn't set, request exit.
1226 if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then
1233 _run_rc_notrunning()
1237 if [ -n "$pidfile" ]; then
1238 _pidmsg=" (check $pidfile)."
1242 echo 1>&2 "${name} not running?${_pidmsg}"
1249 _cmd="kill -$1 $rc_pid"
1250 if [ -n "$_user" ]; then
1251 _cmd="su -m ${_user} -c 'sh -c \"${_cmd}\"'"
1257 # run_rc_script file arg
1258 # Start the script `file' with `arg', and correctly handle the
1259 # return value from the script.
1260 # If `file' ends with `.sh', it's sourced into the current environment
1261 # when $rc_fast_and_loose is set, otherwise it is run as a child process.
1262 # If `file' appears to be a backup or scratch file, ignore it.
1263 # Otherwise if it is executable run as a child process.
1269 if [ -z "$_file" -o -z "$_arg" ]; then
1270 err 3 'USAGE: run_rc_script file arg'
1273 unset name command command_args command_interpreter \
1274 extra_commands pidfile procname \
1275 rcvar rcvars rcvars_obsolete required_dirs required_files \
1277 eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd
1280 /etc/rc.d/*.sh) # no longer allowed in the base
1281 warn "Ignoring old-style startup script $_file"
1283 *[~#]|*.OLD|*.bak|*.orig|*,v) # scratch file; skip
1284 warn "Ignoring scratch file $_file"
1286 *) # run in subshell
1287 if [ -x $_file ]; then
1288 if [ -n "$rc_fast_and_loose" ]; then
1291 ( trap "echo Script $_file interrupted >&2 ; kill -QUIT $$" 3
1292 trap "echo Script $_file interrupted >&2 ; exit 1" 2
1293 trap "echo Script $_file running >&2" 29
1294 set $_arg; . $_file )
1302 # load_rc_config name
1303 # Source in the configuration file for a given name.
1307 local _name _var _defval _v _msg _new
1309 if [ -z "$_name" ]; then
1310 err 3 'USAGE: load_rc_config name'
1313 if ${_rc_conf_loaded:-false}; then
1316 if [ -r /etc/defaults/rc.conf ]; then
1317 debug "Sourcing /etc/defaults/rc.conf"
1318 . /etc/defaults/rc.conf
1320 elif [ -r /etc/rc.conf ]; then
1321 debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)."
1324 _rc_conf_loaded=true
1326 if [ -f /etc/rc.conf.d/"$_name" ]; then
1327 debug "Sourcing /etc/rc.conf.d/${_name}"
1328 . /etc/rc.conf.d/"$_name"
1331 # Set defaults if defined.
1332 for _var in $rcvar $rcvars; do
1333 eval _defval=\$${_var}_defval
1334 if [ -n "$_defval" ]; then
1335 eval : \${$_var:=\$${_var}_defval}
1339 # check obsolete rc.conf variables
1340 for _var in $rcvars_obsolete; do
1342 eval _msg=\$${_var}_obsolete_msg
1343 eval _new=\$${_var}_newvar
1348 if [ -z "$_new" ]; then
1351 eval $_new=\"\$$_var\"
1352 if [ -z "$_msg" ]; then
1353 _msg="Use \$$_new instead."
1356 warn "\$$_var is obsolete. $_msg"
1363 # load_rc_config_var name var
1364 # Read the rc.conf(5) var for name and set in the
1365 # current shell, using load_rc_config in a subshell to prevent
1366 # unwanted side effects from other variable assignments.
1368 load_rc_config_var()
1370 if [ $# -ne 2 ]; then
1371 err 3 'USAGE: load_rc_config_var name var'
1374 load_rc_config '$1' >/dev/null;
1375 if [ -n "${'$2'}" -o "${'$2'-UNSET}" != "UNSET" ]; then
1376 echo '$2'=\'\''${'$2'}\'\'';
1383 # Print a usage string for $0, with `commands' being a list of
1388 echo -n 1>&2 "Usage: $0 [fast|force|one|quiet]("
1392 echo -n 1>&2 "$_sep$_elem"
1400 # err exitval message
1401 # Display message to stderr and log to the syslog, and exit with exitval.
1408 if [ -x /usr/bin/logger ]; then
1409 logger "$0: ERROR: $*"
1411 echo 1>&2 "$0: ERROR: $*"
1417 # Display message to stderr and log to the syslog.
1421 if [ -x /usr/bin/logger ]; then
1422 logger "$0: WARNING: $*"
1424 echo 1>&2 "$0: WARNING: $*"
1429 # Display informational message to stdout and log to syslog.
1434 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
1435 if [ -x /usr/bin/logger ]; then
1436 logger "$0: INFO: $*"
1445 # If debugging is enabled in rc.conf output message to stderr.
1446 # BEWARE that you don't call any subroutine that itself calls this
1452 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
1453 if [ -x /usr/bin/logger ]; then
1454 logger "$0: DEBUG: $*"
1456 echo 1>&2 "$0: DEBUG: $*"
1462 # backup_file action file cur backup
1463 # Make a backup copy of `file' into `cur', and save the previous
1464 # version of `cur' as `backup' or use rcs for archiving.
1466 # This routine checks the value of the backup_uses_rcs variable,
1467 # which can be either YES or NO.
1469 # The `action' keyword can be one of the following:
1471 # add `file' is now being backed up (and is possibly
1472 # being reentered into the backups system). `cur'
1473 # is created and RCS files, if necessary, are
1476 # update `file' has changed and needs to be backed up.
1477 # If `cur' exists, it is copied to to `back' or
1478 # checked into RCS (if the repository file is old),
1479 # and then `file' is copied to `cur'. Another RCS
1480 # check in done here if RCS is being used.
1482 # remove `file' is no longer being tracked by the backups
1483 # system. If RCS is not being used, `cur' is moved
1484 # to `back', otherwise an empty file is checked in,
1485 # and then `cur' is removed.
1495 if checkyesno backup_uses_rcs; then
1496 _msg0="backup archive"
1499 # ensure that history file is not locked
1500 if [ -f $_cur,v ]; then
1501 rcs -q -u -U -M $_cur
1504 # ensure after switching to rcs that the
1505 # current backup is not lost
1506 if [ -f $_cur ]; then
1507 # no archive, or current newer than archive
1508 if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then
1509 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1518 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1521 chown root:wheel $_cur $_cur,v
1525 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1527 chown root:wheel $_cur $_cur,v
1534 if [ -f $_cur ]; then
1538 chown root:wheel $_cur
1547 # make_symlink src link
1548 # Make a symbolic link 'link' to src from basedir. If the
1549 # directory in which link is to be created does not exist
1550 # a warning will be displayed and an error will be returned.
1551 # Returns 0 on sucess, 1 otherwise.
1555 local src link linkdir _me
1558 linkdir="`dirname $link`"
1559 _me="make_symlink()"
1561 if [ -z "$src" -o -z "$link" ]; then
1562 warn "$_me: requires two arguments."
1565 if [ ! -d "$linkdir" ]; then
1566 warn "$_me: the directory $linkdir does not exist."
1569 if ! ln -sf $src $link; then
1570 warn "$_me: unable to make a symbolic link from $link to $src"
1576 # devfs_rulesets_from_file file
1577 # Reads a set of devfs commands from file, and creates
1578 # the specified rulesets with their rules. Returns non-zero
1579 # if there was an error.
1581 devfs_rulesets_from_file()
1583 local file _err _me _opts
1585 _me="devfs_rulesets_from_file"
1588 if [ -z "$file" ]; then
1589 warn "$_me: you must specify a file"
1592 if [ ! -e "$file" ]; then
1593 debug "$_me: no such file ($file)"
1597 # Disable globbing so that the rule patterns are not expanded
1598 # by accident with matching filesystem entries.
1601 debug "reading rulesets from file ($file)"
1609 rulenum=`expr "$line" : "\[.*=\([0-9]*\)\]"`
1610 if [ -z "$rulenum" ]; then
1611 warn "$_me: cannot extract rule number ($line)"
1615 rulename=`expr "$line" : "\[\(.*\)=[0-9]*\]"`
1616 if [ -z "$rulename" ]; then
1617 warn "$_me: cannot extract rule name ($line)"
1621 eval $rulename=\$rulenum
1622 debug "found ruleset: $rulename=$rulenum"
1623 if ! /sbin/devfs rule -s $rulenum delset; then
1629 rulecmd="${line%%"\#*"}"
1630 # evaluate the command incase it includes
1632 if [ -n "$rulecmd" ]; then
1633 debug "adding rule ($rulecmd)"
1634 if ! eval /sbin/devfs rule -s $rulenum $rulecmd
1642 if [ $_err -ne 0 ]; then
1643 debug "error in $_me"
1647 case $_opts in *f*) ;; *) set +f ;; esac
1651 # devfs_init_rulesets
1652 # Initializes rulesets from configuration files. Returns
1653 # non-zero if there was an error.
1655 devfs_init_rulesets()
1658 _me="devfs_init_rulesets"
1660 # Go through this only once
1661 if [ -n "$devfs_rulesets_init" ]; then
1662 debug "$_me: devfs rulesets already initialized"
1665 for file in $devfs_rulesets; do
1666 if ! devfs_rulesets_from_file $file; then
1667 warn "$_me: could not read rules from $file"
1671 devfs_rulesets_init=1
1672 debug "$_me: devfs rulesets initialized"
1676 # devfs_set_ruleset ruleset [dir]
1677 # Sets the default ruleset of dir to ruleset. The ruleset argument
1678 # must be a ruleset name as specified in devfs.rules(5) file.
1679 # Returns non-zero if it could not set it successfully.
1684 [ -n "$1" ] && eval rs=\$$1 || rs=
1685 [ -n "$2" ] && devdir="-m "$2"" || devdir=
1686 _me="devfs_set_ruleset"
1688 if [ -z "$rs" ]; then
1689 warn "$_me: you must specify a ruleset number"
1692 debug "$_me: setting ruleset ($rs) on mount-point (${devdir#-m })"
1693 if ! /sbin/devfs $devdir ruleset $rs; then
1694 warn "$_me: unable to set ruleset $rs to ${devdir#-m }"
1700 # devfs_apply_ruleset ruleset [dir]
1701 # Apply ruleset number $ruleset to the devfs mountpoint $dir.
1702 # The ruleset argument must be a ruleset name as specified
1703 # in a devfs.rules(5) file. Returns 0 on success or non-zero
1704 # if it could not apply the ruleset.
1706 devfs_apply_ruleset()
1709 [ -n "$1" ] && eval rs=\$$1 || rs=
1710 [ -n "$2" ] && devdir="-m "$2"" || devdir=
1711 _me="devfs_apply_ruleset"
1713 if [ -z "$rs" ]; then
1714 warn "$_me: you must specify a ruleset"
1717 debug "$_me: applying ruleset ($rs) to mount-point (${devdir#-m })"
1718 if ! /sbin/devfs $devdir rule -s $rs applyset; then
1719 warn "$_me: unable to apply ruleset $rs to ${devdir#-m }"
1725 # devfs_domount dir [ruleset]
1726 # Mount devfs on dir. If ruleset is specified it is set
1727 # on the mount-point. It must also be a ruleset name as specified
1728 # in a devfs.rules(5) file. Returns 0 on success.
1734 [ -n "$2" ] && rs=$2 || rs=
1735 _me="devfs_domount()"
1737 if [ -z "$devdir" ]; then
1738 warn "$_me: you must specify a mount-point"
1741 debug "$_me: mount-point is ($devdir), ruleset is ($rs)"
1742 if ! mount -t devfs dev "$devdir"; then
1743 warn "$_me: Unable to mount devfs on $devdir"
1746 if [ -n "$rs" ]; then
1748 devfs_set_ruleset $rs $devdir
1749 devfs -m $devdir rule applyset
1754 # devfs_mount_jail dir [ruleset]
1755 # Mounts a devfs file system appropriate for jails
1756 # on the directory dir. If ruleset is specified, the ruleset
1757 # it names will be used instead. If present, ruleset must
1758 # be the name of a ruleset as defined in a devfs.rules(5) file.
1759 # This function returns non-zero if an error occurs.
1765 [ -n "$2" ] && rs=$2 || rs="devfsrules_jail"
1766 _me="devfs_mount_jail"
1769 if ! devfs_domount "$jdev" $rs; then
1770 warn "$_me: devfs was not mounted on $jdev"
1776 # Provide a function for normalizing the mounting of memory
1777 # filesystems. This should allow the rest of the code here to remain
1778 # as close as possible between 5-current and 4-stable.
1781 # $3 = (optional) extra mdmfs flags
1784 if [ -n "$3" ]; then
1787 /sbin/mdmfs $flags -s $1 md $2
1790 # Code common to scripts that need to load a kernel module
1791 # if it isn't in the kernel yet. Syntax:
1792 # load_kld [-e regex] [-m module] file
1793 # where -e or -m chooses the way to check if the module
1794 # is already loaded:
1795 # regex is egrep'd in the output from `kldstat -v',
1796 # module is passed to `kldstat -m'.
1797 # The default way is as though `-m file' were specified.
1800 local _loaded _mod _opt _re
1802 while getopts "e:m:" _opt; do
1805 m) _mod="$OPTARG" ;;
1806 *) err 3 'USAGE: load_kld [-e regex] [-m module] file' ;;
1809 shift $(($OPTIND - 1))
1810 if [ $# -ne 1 ]; then
1811 err 3 'USAGE: load_kld [-e regex] [-m module] file'
1815 if [ -n "$_re" ]; then
1816 if kldstat -v | egrep -q -e "$_re"; then
1820 if kldstat -q -m "$_mod"; then
1825 if ! kldload "$1"; then
1826 warn "Unable to load kernel module $1"
1829 info "$1 kernel module loaded."
1832 debug "load_kld: $1 kernel module already loaded."
1837 # ltr str src dst [var]
1838 # Change every $src in $str to $dst.
1839 # Useful when /usr is not yet mounted and we cannot use tr(1), sed(1) nor
1840 # awk(1). If var is non-NULL, set it to the result.
1843 local _str _src _dst _out _com _var
1851 for _com in ${_str}; do
1852 if [ -z "${_out}" ]; then
1855 _out="${_out}${_dst}${_com}"
1858 if [ -n "${_var}" ]; then
1859 setvar "${_var}" "${_out}"
1865 # Creates a list of providers for GELI encryption.
1868 local devices devices2
1869 local provider mountpoint type options rest
1871 # Create list of GELI providers from fstab.
1872 while read provider mountpoint type options rest ; do
1873 case ":${options}" in
1882 case ":${provider}" in
1887 # Skip swap devices.
1888 if [ "${type}" = "swap" -o "${options}" = "sw" -o "${noauto}" = "yes" ]; then
1891 devices="${devices} ${provider}"
1896 # Append providers from geli_devices.
1897 devices="${devices} ${geli_devices}"
1899 for provider in ${devices}; do
1900 provider=${provider%.eli}
1901 provider=${provider#/dev/}
1902 devices2="${devices2} ${provider}"
1908 # Find scripts in local_startup directories that use the old syntax
1910 find_local_scripts_old () {
1913 for dir in ${local_startup}; do
1914 if [ -d "${dir}" ]; then
1915 for file in ${dir}/[0-9]*.sh; do
1916 grep '^# PROVIDE:' $file >/dev/null 2>&1 &&
1918 zlist="$zlist $file"
1920 for file in ${dir}/[^0-9]*.sh; do
1921 grep '^# PROVIDE:' $file >/dev/null 2>&1 &&
1923 slist="$slist $file"
1929 find_local_scripts_new () {
1931 for dir in ${local_startup}; do
1932 if [ -d "${dir}" ]; then
1933 for file in `grep -l '^# PROVIDE:' ${dir}/* 2>/dev/null`; do
1936 *) if [ -x "$file" ]; then
1937 local_rc="${local_rc} ${file}"
1946 # check_required_{before|after} command
1947 # Check for things required by the command before and after its precmd,
1948 # respectively. The two separate functions are needed because some
1949 # conditions should prevent precmd from being run while other things
1950 # depend on precmd having already been run.
1952 check_required_before()
1958 for _f in $required_vars; do
1959 if ! checkyesno $_f; then
1960 warn "\$${_f} is not enabled."
1961 if [ -z "$rc_force" ]; then
1967 for _f in $required_dirs; do
1968 if [ ! -d "${_f}/." ]; then
1969 warn "${_f} is not a directory."
1970 if [ -z "$rc_force" ]; then
1976 for _f in $required_files; do
1977 if [ ! -r "${_f}" ]; then
1978 warn "${_f} is not readable."
1979 if [ -z "$rc_force" ]; then
1990 check_required_after()
1996 for _f in $required_modules; do
1998 *~*) _args="-e ${_f#*~} ${_f%%~*}" ;;
1999 *:*) _args="-m ${_f#*:} ${_f%%:*}" ;;
2002 if ! load_kld ${_args}; then
2003 if [ -z "$rc_force" ]; then
2014 # check_kern_features mib
2015 # Return existence of kern.features.* sysctl MIB as true or
2016 # false. The result will be cached in $_rc_cache_kern_features_
2017 # namespace. "0" means the kern.features.X exists.
2019 check_kern_features()
2023 [ -n "$1" ] || return 1;
2024 eval _v=\$_rc_cache_kern_features_$1
2025 [ -n "$_v" ] && return "$_v";
2027 if ${SYSCTL_N} kern.features.$1 > /dev/null 2>&1; then
2028 eval _rc_cache_kern_features_$1=0
2031 eval _rc_cache_kern_features_$1=1
2036 # check_namevarlist var
2037 # Return "0" if ${name}_var is reserved in rc.subr.
2039 _rc_namevarlist="program chroot chdir flags fib nice user group groups"
2044 for _v in $_rc_namevarlist; do
2053 # _echoonce var msg mode
2054 # mode=0: Echo $msg if ${$var} is empty.
2055 # After doing echo, a string is set to ${$var}.
2057 # mode=1: Echo $msg if ${$var} is a string with non-zero length.
2061 local _var _msg _mode
2067 1) [ -n "$_var" ] && echo "$_msg" ;;
2068 *) [ -z "$_var" ] && echo -n "$_msg" && eval "$1=finished" ;;
2072 fi # [ -z "${_rc_subr_loaded}" ]