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=`
57 # set_rcvar_obsolete oldvar [newvar] [msg]
58 # Define obsolete variable.
59 # Global variable $rcvars_obsolete is used.
65 debug "rcvar_obsolete: \$$1(old) -> \$$2(new) is defined"
67 rcvars_obsolete="${rcvars_obsolete# } $1"
68 eval ${1}_newvar=\"$2\"
70 eval ${_var}_obsolete_msg=\"$*\"
74 # force_depend script [rcvar]
75 # Force a service to start. Intended for use by services
76 # to resolve dependency issues.
77 # $1 - filename of script, in /etc/rc.d, to run
78 # $2 - name of the script's rcvar (minus the _enable)
82 local _depend _dep_rcvar
85 _dep_rcvar="${2:-$1}_enable"
87 [ -n "$rc_fast" ] && ! checkyesno always_force_depends &&
88 checkyesno $_dep_rcvar && return 0
90 /etc/rc.d/${_depend} forcestatus >/dev/null 2>&1 && return 0
92 info "${name} depends on ${_depend}, which will be forced to start."
93 if ! /etc/rc.d/${_depend} forcestart; then
94 warn "Unable to force ${_depend}. It may already be running."
101 # Test $1 variable, and warn if not set to YES or NO.
102 # Return 0 if it's "yes" (et al), nonzero otherwise.
107 debug "checkyesno: $1 is set to $_value."
110 # "yes", "true", "on", or "1"
111 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
115 # "no", "false", "off", or "0"
116 [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0)
120 warn "\$${1} is not set properly - see rc.conf(5)."
128 # print the list in reverse order
134 _revlist="$_revfile $_revlist"
140 # If booting directly to multiuser or $always is enabled,
141 # send SIGTERM to the parent (/etc/rc) to abort the boot.
142 # Otherwise just exit.
149 # "yes", "true", "on", or "1"
150 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
157 if [ "$autoboot" = yes -o "$always" = true ]; then
158 echo "ERROR: ABORTING BOOT (sending SIGTERM to parent)!"
165 # mount_critical_filesystems type
166 # Go through the list of critical filesystems as provided in
167 # the rc.conf(5) variable $critical_filesystems_${type}, checking
168 # each one to see if it is mounted, and if it is not, mounting it.
170 mount_critical_filesystems()
172 eval _fslist=\$critical_filesystems_${1}
173 for _fs in $_fslist; do
176 while read what _on on _type type; do
177 if [ $on = $_fs ]; then
184 mount $_fs >/dev/null 2>&1
191 # check_pidfile pidfile procname [interpreter]
192 # Parses the first line of pidfile for a PID, and ensures
193 # that the process is running and matches procname.
194 # Prints the matching PID upon success, nothing otherwise.
195 # interpreter is optional; see _find_processes() for details.
202 if [ -z "$_pidfile" -o -z "$_procname" ]; then
203 err 3 'USAGE: check_pidfile pidfile procname [interpreter]'
205 if [ ! -f $_pidfile ]; then
206 debug "pid file ($_pidfile): not readable."
209 read _pid _junk < $_pidfile
210 if [ -z "$_pid" ]; then
211 debug "pid file ($_pidfile): no pid in file."
214 _find_processes $_procname ${_interpreter:-.} '-p '"$_pid"
218 # check_process procname [interpreter]
219 # Ensures that a process (or processes) named procname is running.
220 # Prints a list of matching PIDs.
221 # interpreter is optional; see _find_processes() for details.
227 if [ -z "$_procname" ]; then
228 err 3 'USAGE: check_process procname [interpreter]'
230 _find_processes $_procname ${_interpreter:-.} '-ax'
234 # _find_processes procname interpreter psargs
235 # Search for procname in the output of ps generated by psargs.
236 # Prints the PIDs of any matching processes, space separated.
238 # If interpreter == ".", check the following variations of procname
239 # against the first word of each command:
241 # `basename procname`
242 # `basename procname` + ":"
243 # "(" + `basename procname` + ")"
244 # "[" + `basename procname` + "]"
246 # If interpreter != ".", read the first line of procname, remove the
247 # leading #!, normalise whitespace, append procname, and attempt to
248 # match that against each command, either as is, or with extra words
249 # at the end. As an alternative, to deal with interpreted daemons
250 # using perl, the basename of the interpreter plus a colon is also
251 # tried as the prefix to procname.
255 if [ $# -ne 3 ]; then
256 err 3 'USAGE: _find_processes procname interpreter psargs'
263 if [ $_interpreter != "." ]; then # an interpreted script
264 _script="${_chroot}${_chroot:+/}$_procname"
265 if [ -r "$_script" ]; then
266 read _interp < $_script # read interpreter name
269 _interp=${_interp#\#!} # strip #!
273 shift # drop env to get real name
276 if [ $_interpreter != $1 ]; then
277 warn "\$command_interpreter $_interpreter != $1"
281 warn "no shebang line in $_script"
286 warn "cannot read shebang line from $_script"
289 _interp="$* $_procname" # cleanup spaces, add _procname
292 _fp_match='case "$_argv" in
293 ${_interp}|"${_interp} "*|"${_interpbn}: ${_procname}"*)'
294 else # a normal daemon
295 _procnamebn=${_procname##*/}
296 _fp_args='_arg0 _argv'
297 _fp_match='case "$_arg0" in
298 $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})"|"[${_procnamebn}]")'
302 $PS 2>/dev/null -o pid= -o jid= -o command= $_psargs"' |
303 while read _npid _jid '"$_fp_args"'; do
305 if [ "$JID" -eq "$_jid" ];
306 then echo -n "$_pref$_npid";
313 # debug "in _find_processes: proccheck is ($_proccheck)."
318 # wait_for_pids pid [pid ...]
319 # spins until none of the pids exist
323 local _list _prefix _nlist _j
326 if [ -z "$_list" ]; then
333 if kill -0 $_j 2>/dev/null; then
334 _nlist="${_nlist}${_nlist:+ }$_j"
335 [ -n "$_prefix" ] && sleep 1
338 if [ -z "$_nlist" ]; then
342 echo -n ${_prefix:-"Waiting for PIDS: "}$_list
344 pwait $_list 2>/dev/null
346 if [ -n "$_prefix" ]; then
352 # get_pidfile_from_conf string file
354 # Takes a string to search for in the specified file.
355 # Ignores lines with traditional comment characters.
359 # if get_pidfile_from_conf string file; then
360 # pidfile="$_pidfile_from_conf"
362 # pidfile='appropriate default'
365 get_pidfile_from_conf()
367 if [ -z "$1" -o -z "$2" ]; then
368 err 3 "USAGE: get_pidfile_from_conf string file ($name)"
371 local string file line
373 string="$1" ; file="$2"
375 if [ ! -s "$file" ]; then
376 err 3 "get_pidfile_from_conf: $file does not exist ($name)"
381 *[#\;]*${string}*) continue ;;
382 *${string}*) break ;;
386 if [ -n "$line" ]; then
388 _pidfile_from_conf="/${line%%[\"\;]*}"
396 # If rc_quiet is set (usually as a result of using faststart at
397 # boot time) check if rc_startmsgs is enabled.
401 if [ -n "$rc_quiet" ]; then
402 checkyesno rc_startmsgs
409 # run_rc_command argument
410 # Search for argument in the list of supported commands, which is:
411 # "start stop restart rcvar status poll ${extra_commands}"
412 # If there's a match, run ${argument}_cmd or the default method
415 # If argument has a given prefix, then change the operation as follows:
418 # fast Skip the pid check, and set rc_fast=yes, rc_quiet=yes
419 # force Set ${rcvar} to YES, and set rc_force=yes
420 # one Set ${rcvar} to YES
421 # quiet Don't output some diagnostics, and set rc_quiet=yes
423 # The following globals are used:
425 # Name Needed Purpose
426 # ---- ------ -------
427 # name y Name of script.
429 # command n Full path to command.
430 # Not needed if ${rc_arg}_cmd is set for
433 # command_args n Optional args/shell directives for command.
435 # command_interpreter n If not empty, command is interpreted, so
436 # call check_{pidfile,process}() appropriately.
438 # desc n Description of script.
440 # extra_commands n List of extra commands supported.
442 # pidfile n If set, use check_pidfile $pidfile $command,
443 # otherwise use check_process $command.
444 # In either case, only check if $command is set.
446 # procname n Process name to check for instead of $command.
448 # rcvar n This is checked with checkyesno to determine
449 # if the action should be run.
451 # ${name}_program n Full path to command.
452 # Meant to be used in /etc/rc.conf to override
455 # ${name}_chroot n Directory to chroot to before running ${command}
456 # Requires /usr to be mounted.
458 # ${name}_chdir n Directory to cd to before running ${command}
459 # (if not using ${name}_chroot).
461 # ${name}_flags n Arguments to call ${command} with.
462 # NOTE: $flags from the parent environment
463 # can be used to override this.
465 # ${name}_fib n Routing table number to run ${command} with.
467 # ${name}_nice n Nice level to run ${command} at.
469 # ${name}_user n User to run ${command} as, using su(1) if not
470 # using ${name}_chroot.
471 # Requires /usr to be mounted.
473 # ${name}_group n Group to run chrooted ${command} as.
474 # Requires /usr to be mounted.
476 # ${name}_groups n Comma separated list of supplementary groups
477 # to run the chrooted ${command} with.
478 # Requires /usr to be mounted.
480 # ${rc_arg}_cmd n If set, use this as the method when invoked;
481 # Otherwise, use default command (see below)
483 # ${rc_arg}_precmd n If set, run just before performing the
484 # ${rc_arg}_cmd method in the default
485 # operation (i.e, after checking for required
486 # bits and process (non)existence).
487 # If this completes with a non-zero exit code,
488 # don't run ${rc_arg}_cmd.
490 # ${rc_arg}_postcmd n If set, run just after performing the
491 # ${rc_arg}_cmd method, if that method
492 # returned a zero exit code.
494 # required_dirs n If set, check for the existence of the given
495 # directories before running a (re)start command.
497 # required_files n If set, check for the readability of the given
498 # files before running a (re)start command.
500 # required_modules n If set, ensure the given kernel modules are
501 # loaded before running a (re)start command.
502 # The check and possible loads are actually
503 # done after start_precmd so that the modules
504 # aren't loaded in vain, should the precmd
505 # return a non-zero status to indicate a error.
506 # If a word in the list looks like "foo:bar",
507 # "foo" is the KLD file name and "bar" is the
508 # module name. If a word looks like "foo~bar",
509 # "foo" is the KLD file name and "bar" is a
510 # egrep(1) pattern matching the module name.
511 # Otherwise the module name is assumed to be
512 # the same as the KLD file name, which is most
513 # common. See load_kld().
515 # required_vars n If set, perform checkyesno on each of the
516 # listed variables before running the default
519 # Default behaviour for a given argument, if no override method is
522 # Argument Default behaviour
523 # -------- -----------------
524 # start if !running && checkyesno ${rcvar}
528 # rc_pid=$(check_pidfile $pidfile $command)
530 # rc_pid=$(check_process $command)
531 # kill $sig_stop $rc_pid
532 # wait_for_pids $rc_pid
533 # ($sig_stop defaults to TERM.)
535 # reload Similar to stop, except use $sig_reload instead,
536 # and doesn't wait_for_pids.
537 # $sig_reload defaults to HUP.
538 # Note that `reload' isn't provided by default,
539 # it should be enabled via $extra_commands.
541 # restart Run `stop' then `start'.
543 # status Show if ${command} is running, etc.
545 # poll Wait for ${command} to exit.
547 # rcvar Display what rc.conf variable is used (if any).
549 # Variables available to methods, and after run_rc_command() has
554 # rc_arg Argument to command, after fast/force/one processing
557 # rc_flags Flags to start the default command with.
558 # Defaults to ${name}_flags, unless overridden
559 # by $flags from the environment.
560 # This variable may be changed by the precmd method.
562 # rc_pid PID of command (if appropriate)
564 # rc_fast Not empty if "fast" was provided (q.v.)
566 # rc_force Not empty if "force" was provided (q.v.)
568 # rc_quiet Not empty if "quiet" was provided
575 if [ -z "$name" ]; then
576 err 3 'run_rc_command: $name is not set.'
579 # Don't repeat the first argument when passing additional command-
580 # line arguments to the command subroutines.
587 fast*) # "fast" prefix; don't check pid
588 rc_arg=${rc_arg#fast}
592 force*) # "force" prefix; always run
595 rc_arg=${rc_arg#${_rc_prefix}}
596 if [ -n "${rcvar}" ]; then
600 one*) # "one" prefix; set ${rcvar}=yes
602 rc_arg=${rc_arg#${_rc_prefix}}
603 if [ -n "${rcvar}" ]; then
607 quiet*) # "quiet" prefix; omit some messages
609 rc_arg=${rc_arg#${_rc_prefix}}
614 eval _override_command=\$${name}_program
615 command=${_override_command:-$command}
617 _keywords="start stop restart rcvar $extra_commands"
620 _procname=${procname:-${command}}
622 # setup pid check command
623 if [ -n "$_procname" ]; then
624 if [ -n "$pidfile" ]; then
625 _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')'
627 _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')'
629 if [ -n "$_pidcmd" ]; then
630 _keywords="${_keywords} status poll"
634 if [ -z "$rc_arg" ]; then
638 if [ -n "$flags" ]; then # allow override from environment
641 eval rc_flags=\$${name}_flags
643 eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \
644 _nice=\$${name}_nice _user=\$${name}_user \
645 _group=\$${name}_group _groups=\$${name}_groups \
648 if [ -n "$_user" ]; then # unset $_user if running as that user
649 if [ "$_user" = "$(eval $IDCMD)" ]; then
654 [ -z "$autoboot" ] && eval $_pidcmd # determine the pid if necessary
656 for _elem in $_keywords; do
657 if [ "$_elem" != "$rc_arg" ]; then
660 # if ${rcvar} is set, $1 is not "rcvar"
661 # and ${rc_pid} is not set, then run
662 # checkyesno ${rcvar}
663 # and return if that failed
665 if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" -a "$rc_arg" != "stop" ] ||
666 [ -n "${rcvar}" -a "$rc_arg" = "stop" -a -z "${rc_pid}" ]; then
667 if ! checkyesno ${rcvar}; then
668 if [ -n "${rc_quiet}" ]; then
671 echo -n "Cannot '${rc_arg}' $name. Set ${rcvar} to "
672 echo -n "YES in /etc/rc.conf or use 'one${rc_arg}' "
673 echo "instead of '${rc_arg}'."
678 # if there's a custom ${XXX_cmd},
679 # run that instead of the default
681 eval _cmd=\$${rc_arg}_cmd \
682 _precmd=\$${rc_arg}_precmd \
683 _postcmd=\$${rc_arg}_postcmd
685 if [ -n "$_cmd" ]; then
686 _run_rc_precmd || return 1
687 _run_rc_doit "$_cmd $rc_extra_args" || return 1
692 case "$rc_arg" in # default operations...
695 _run_rc_precmd || return 1
696 if [ -n "$rc_pid" ]; then
697 echo "${name} is running as pid $rc_pid."
699 echo "${name} is not running."
706 if [ -z "$rc_fast" -a -n "$rc_pid" ]; then
707 if [ -z "$rc_quiet" ]; then
708 echo 1>&2 "${name} already running? " \
714 if [ ! -x "${_chroot}${_chroot:+/}${command}" ]; then
715 warn "run_rc_command: cannot run $command"
719 if ! _run_rc_precmd; then
720 warn "failed precmd routine for ${name}"
724 # setup the full command to run
726 check_startmsgs && echo "Starting ${name}."
727 if [ -n "$_chroot" ]; then
729 ${_nice:+nice -n $_nice }\
730 ${_fib:+setfib -F $_fib }\
731 chroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\
732 $_chroot $command $rc_flags $command_args"
735 ${_chdir:+cd $_chdir && }\
736 ${_fib:+setfib -F $_fib }\
737 $command $rc_flags $command_args"
738 if [ -n "$_user" ]; then
739 _doit="su -m $_user -c 'sh -c \"$_doit\"'"
741 if [ -n "$_nice" ]; then
742 if [ -z "$_user" ]; then
743 _doit="sh -c \"$_doit\""
745 _doit="nice -n $_nice $_doit"
749 # run the full command
751 if ! _run_rc_doit "$_doit"; then
752 warn "failed to start ${name}"
756 # finally, run postcmd
762 if [ -z "$rc_pid" ]; then
763 [ -n "$rc_fast" ] && return 0
768 _run_rc_precmd || return 1
770 # send the signal to stop
772 echo "Stopping ${name}."
773 _doit=$(_run_rc_killcmd "${sig_stop:-TERM}")
774 _run_rc_doit "$_doit" || return 1
776 # wait for the command to exit,
778 wait_for_pids $rc_pid
784 if [ -z "$rc_pid" ]; then
789 _run_rc_precmd || return 1
791 _doit=$(_run_rc_killcmd "${sig_reload:-HUP}")
792 _run_rc_doit "$_doit" || return 1
798 # prevent restart being called more
799 # than once by any given script
801 if ${_rc_restart_done:-false}; then
804 _rc_restart_done=true
806 _run_rc_precmd || return 1
808 # run those in a subshell to keep global variables
809 ( run_rc_command ${_rc_prefix}stop $rc_extra_args )
810 ( run_rc_command ${_rc_prefix}start $rc_extra_args )
812 [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1
818 _run_rc_precmd || return 1
819 if [ -n "$rc_pid" ]; then
820 wait_for_pids $rc_pid
827 if [ -n "$desc" ]; then
833 # Get unique vars in $rcvar
836 $_v\ *|\ *$_v|*\ $_v\ *) ;;
843 if [ -z "$_v" ]; then
847 eval _desc=\$${_v}_desc
848 eval _defval=\$${_v}_defval
851 eval echo \"$_v=\\\"\$$_v\\\"\"
852 # decode multiple lines of _desc
853 while [ -n "$_desc" ]; do
856 echo "# $_h ${_desc%%^^*}"
861 echo "# $_h ${_desc}"
866 echo "# (default: \"$_defval\")"
879 echo 1>&2 "$0: unknown directive '$rc_arg'."
885 # Helper functions for run_rc_command: common code.
886 # They use such global variables besides the exported rc_* ones:
896 check_required_before "$rc_arg" || return 1
898 if [ -n "$_precmd" ]; then
899 debug "run_rc_command: ${rc_arg}_precmd: $_precmd $rc_extra_args"
900 eval "$_precmd $rc_extra_args"
903 # If precmd failed and force isn't set, request exit.
904 if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then
909 check_required_after "$rc_arg" || return 1
916 if [ -n "$_postcmd" ]; then
917 debug "run_rc_command: ${rc_arg}_postcmd: $_postcmd $rc_extra_args"
918 eval "$_postcmd $rc_extra_args"
926 debug "run_rc_command: doit: $*"
930 # If command failed and force isn't set, request exit.
931 if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then
942 if [ -n "$pidfile" ]; then
943 _pidmsg=" (check $pidfile)."
947 echo 1>&2 "${name} not running?${_pidmsg}"
954 _cmd="kill -$1 $rc_pid"
955 if [ -n "$_user" ]; then
956 _cmd="su -m ${_user} -c 'sh -c \"${_cmd}\"'"
962 # run_rc_script file arg
963 # Start the script `file' with `arg', and correctly handle the
964 # return value from the script.
965 # If `file' ends with `.sh', it's sourced into the current environment
966 # when $rc_fast_and_loose is set, otherwise it is run as a child process.
967 # If `file' appears to be a backup or scratch file, ignore it.
968 # Otherwise if it is executable run as a child process.
974 if [ -z "$_file" -o -z "$_arg" ]; then
975 err 3 'USAGE: run_rc_script file arg'
978 unset name command command_args command_interpreter \
979 extra_commands pidfile procname \
980 rcvar rcvars_obsolete required_dirs required_files \
982 eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd
985 /etc/rc.d/*.sh) # no longer allowed in the base
986 warn "Ignoring old-style startup script $_file"
988 *[~#]|*.OLD|*.bak|*.orig|*,v) # scratch file; skip
989 warn "Ignoring scratch file $_file"
992 if [ -x $_file ]; then
993 if [ -n "$rc_fast_and_loose" ]; then
996 ( trap "echo Script $_file interrupted >&2 ; kill -QUIT $$" 3
997 trap "echo Script $_file interrupted >&2 ; exit 1" 2
998 trap "echo Script $_file running >&2" 29
999 set $_arg; . $_file )
1007 # load_rc_config name
1008 # Source in the configuration file for a given name.
1012 local _name _rcvar_val _var _defval _v _msg _new
1014 if [ -z "$_name" ]; then
1015 err 3 'USAGE: load_rc_config name'
1018 if ${_rc_conf_loaded:-false}; then
1021 if [ -r /etc/defaults/rc.conf ]; then
1022 debug "Sourcing /etc/defaults/rc.conf"
1023 . /etc/defaults/rc.conf
1025 elif [ -r /etc/rc.conf ]; then
1026 debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)."
1029 _rc_conf_loaded=true
1031 if [ -f /etc/rc.conf.d/"$_name" ]; then
1032 debug "Sourcing /etc/rc.conf.d/${_name}"
1033 . /etc/rc.conf.d/"$_name"
1036 # Set defaults if defined.
1037 for _var in $rcvar; do
1038 eval _defval=\$${_var}_defval
1039 if [ -n "$_defval" ]; then
1040 eval : \${$_var:=\$${_var}_defval}
1044 # check obsolete rc.conf variables
1045 for _var in $rcvars_obsolete; do
1047 eval _msg=\$${_var}_obsolete_msg
1048 eval _new=\$${_var}_newvar
1053 if [ -z "$_new" ]; then
1056 eval $_new=\"\$$_var\"
1057 if [ -z "$_msg" ]; then
1058 _msg="Use \$$_new instead."
1061 warn "\$$_var is obsolete. $_msg"
1068 # load_rc_config_var name var
1069 # Read the rc.conf(5) var for name and set in the
1070 # current shell, using load_rc_config in a subshell to prevent
1071 # unwanted side effects from other variable assignments.
1073 load_rc_config_var()
1075 if [ $# -ne 2 ]; then
1076 err 3 'USAGE: load_rc_config_var name var'
1079 load_rc_config '$1' >/dev/null;
1080 if [ -n "${'$2'}" -o "${'$2'-UNSET}" != "UNSET" ]; then
1081 echo '$2'=\'\''${'$2'}\'\'';
1088 # Print a usage string for $0, with `commands' being a list of
1093 echo -n 1>&2 "Usage: $0 [fast|force|one|quiet]("
1097 echo -n 1>&2 "$_sep$_elem"
1105 # err exitval message
1106 # Display message to stderr and log to the syslog, and exit with exitval.
1113 if [ -x /usr/bin/logger ]; then
1114 logger "$0: ERROR: $*"
1116 echo 1>&2 "$0: ERROR: $*"
1122 # Display message to stderr and log to the syslog.
1126 if [ -x /usr/bin/logger ]; then
1127 logger "$0: WARNING: $*"
1129 echo 1>&2 "$0: WARNING: $*"
1134 # Display informational message to stdout and log to syslog.
1139 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
1140 if [ -x /usr/bin/logger ]; then
1141 logger "$0: INFO: $*"
1150 # If debugging is enabled in rc.conf output message to stderr.
1151 # BEWARE that you don't call any subroutine that itself calls this
1157 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1)
1158 if [ -x /usr/bin/logger ]; then
1159 logger "$0: DEBUG: $*"
1161 echo 1>&2 "$0: DEBUG: $*"
1167 # backup_file action file cur backup
1168 # Make a backup copy of `file' into `cur', and save the previous
1169 # version of `cur' as `backup' or use rcs for archiving.
1171 # This routine checks the value of the backup_uses_rcs variable,
1172 # which can be either YES or NO.
1174 # The `action' keyword can be one of the following:
1176 # add `file' is now being backed up (and is possibly
1177 # being reentered into the backups system). `cur'
1178 # is created and RCS files, if necessary, are
1181 # update `file' has changed and needs to be backed up.
1182 # If `cur' exists, it is copied to to `back' or
1183 # checked into RCS (if the repository file is old),
1184 # and then `file' is copied to `cur'. Another RCS
1185 # check in done here if RCS is being used.
1187 # remove `file' is no longer being tracked by the backups
1188 # system. If RCS is not being used, `cur' is moved
1189 # to `back', otherwise an empty file is checked in,
1190 # and then `cur' is removed.
1200 if checkyesno backup_uses_rcs; then
1201 _msg0="backup archive"
1204 # ensure that history file is not locked
1205 if [ -f $_cur,v ]; then
1206 rcs -q -u -U -M $_cur
1209 # ensure after switching to rcs that the
1210 # current backup is not lost
1211 if [ -f $_cur ]; then
1212 # no archive, or current newer than archive
1213 if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then
1214 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1223 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1226 chown root:wheel $_cur $_cur,v
1230 ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur
1232 chown root:wheel $_cur $_cur,v
1239 if [ -f $_cur ]; then
1243 chown root:wheel $_cur
1252 # make_symlink src link
1253 # Make a symbolic link 'link' to src from basedir. If the
1254 # directory in which link is to be created does not exist
1255 # a warning will be displayed and an error will be returned.
1256 # Returns 0 on success, 1 otherwise.
1260 local src link linkdir _me
1263 linkdir="`dirname $link`"
1264 _me="make_symlink()"
1266 if [ -z "$src" -o -z "$link" ]; then
1267 warn "$_me: requires two arguments."
1270 if [ ! -d "$linkdir" ]; then
1271 warn "$_me: the directory $linkdir does not exist."
1274 if ! ln -sf $src $link; then
1275 warn "$_me: unable to make a symbolic link from $link to $src"
1281 # devfs_rulesets_from_file file
1282 # Reads a set of devfs commands from file, and creates
1283 # the specified rulesets with their rules. Returns non-zero
1284 # if there was an error.
1286 devfs_rulesets_from_file()
1290 _me="devfs_rulesets_from_file"
1293 if [ -z "$file" ]; then
1294 warn "$_me: you must specify a file"
1297 if [ ! -e "$file" ]; then
1298 debug "$_me: no such file ($file)"
1301 debug "reading rulesets from file ($file)"
1309 rulenum=`expr "$line" : "\[.*=\([0-9]*\)\]"`
1310 if [ -z "$rulenum" ]; then
1311 warn "$_me: cannot extract rule number ($line)"
1315 rulename=`expr "$line" : "\[\(.*\)=[0-9]*\]"`
1316 if [ -z "$rulename" ]; then
1317 warn "$_me: cannot extract rule name ($line)"
1321 eval $rulename=\$rulenum
1322 debug "found ruleset: $rulename=$rulenum"
1323 if ! /sbin/devfs rule -s $rulenum delset; then
1329 rulecmd="${line%%"\#*"}"
1330 # evaluate the command incase it includes
1332 if [ -n "$rulecmd" ]; then
1333 debug "adding rule ($rulecmd)"
1334 if ! eval /sbin/devfs rule -s $rulenum $rulecmd
1342 if [ $_err -ne 0 ]; then
1343 debug "error in $_me"
1350 # devfs_init_rulesets
1351 # Initializes rulesets from configuration files. Returns
1352 # non-zero if there was an error.
1354 devfs_init_rulesets()
1357 _me="devfs_init_rulesets"
1359 # Go through this only once
1360 if [ -n "$devfs_rulesets_init" ]; then
1361 debug "$_me: devfs rulesets already initialized"
1364 for file in $devfs_rulesets; do
1365 if ! devfs_rulesets_from_file $file; then
1366 warn "$_me: could not read rules from $file"
1370 devfs_rulesets_init=1
1371 debug "$_me: devfs rulesets initialized"
1375 # devfs_set_ruleset ruleset [dir]
1376 # Sets the default ruleset of dir to ruleset. The ruleset argument
1377 # must be a ruleset name as specified in devfs.rules(5) file.
1378 # Returns non-zero if it could not set it successfully.
1383 [ -n "$1" ] && eval rs=\$$1 || rs=
1384 [ -n "$2" ] && devdir="-m "$2"" || devdir=
1385 _me="devfs_set_ruleset"
1387 if [ -z "$rs" ]; then
1388 warn "$_me: you must specify a ruleset number"
1391 debug "$_me: setting ruleset ($rs) on mount-point (${devdir#-m })"
1392 if ! /sbin/devfs $devdir ruleset $rs; then
1393 warn "$_me: unable to set ruleset $rs to ${devdir#-m }"
1399 # devfs_apply_ruleset ruleset [dir]
1400 # Apply ruleset number $ruleset to the devfs mountpoint $dir.
1401 # The ruleset argument must be a ruleset name as specified
1402 # in a devfs.rules(5) file. Returns 0 on success or non-zero
1403 # if it could not apply the ruleset.
1405 devfs_apply_ruleset()
1408 [ -n "$1" ] && eval rs=\$$1 || rs=
1409 [ -n "$2" ] && devdir="-m "$2"" || devdir=
1410 _me="devfs_apply_ruleset"
1412 if [ -z "$rs" ]; then
1413 warn "$_me: you must specify a ruleset"
1416 debug "$_me: applying ruleset ($rs) to mount-point (${devdir#-m })"
1417 if ! /sbin/devfs $devdir rule -s $rs applyset; then
1418 warn "$_me: unable to apply ruleset $rs to ${devdir#-m }"
1424 # devfs_domount dir [ruleset]
1425 # Mount devfs on dir. If ruleset is specified it is set
1426 # on the mount-point. It must also be a ruleset name as specified
1427 # in a devfs.rules(5) file. Returns 0 on success.
1433 [ -n "$2" ] && rs=$2 || rs=
1434 _me="devfs_domount()"
1436 if [ -z "$devdir" ]; then
1437 warn "$_me: you must specify a mount-point"
1440 debug "$_me: mount-point is ($devdir), ruleset is ($rs)"
1441 if ! mount -t devfs dev "$devdir"; then
1442 warn "$_me: Unable to mount devfs on $devdir"
1445 if [ -n "$rs" ]; then
1447 devfs_set_ruleset $rs $devdir
1448 devfs -m $devdir rule applyset
1453 # devfs_mount_jail dir [ruleset]
1454 # Mounts a devfs file system appropriate for jails
1455 # on the directory dir. If ruleset is specified, the ruleset
1456 # it names will be used instead. If present, ruleset must
1457 # be the name of a ruleset as defined in a devfs.rules(5) file.
1458 # This function returns non-zero if an error occurs.
1464 [ -n "$2" ] && rs=$2 || rs="devfsrules_jail"
1465 _me="devfs_mount_jail"
1468 if ! devfs_domount "$jdev" $rs; then
1469 warn "$_me: devfs was not mounted on $jdev"
1475 # Provide a function for normalizing the mounting of memory
1476 # filesystems. This should allow the rest of the code here to remain
1477 # as close as possible between 5-current and 4-stable.
1480 # $3 = (optional) extra mdmfs flags
1483 if [ -n "$3" ]; then
1486 /sbin/mdmfs $flags -s $1 md $2
1489 # Code common to scripts that need to load a kernel module
1490 # if it isn't in the kernel yet. Syntax:
1491 # load_kld [-e regex] [-m module] file
1492 # where -e or -m chooses the way to check if the module
1493 # is already loaded:
1494 # regex is egrep'd in the output from `kldstat -v',
1495 # module is passed to `kldstat -m'.
1496 # The default way is as though `-m file' were specified.
1499 local _loaded _mod _opt _re
1501 while getopts "e:m:" _opt; do
1504 m) _mod="$OPTARG" ;;
1505 *) err 3 'USAGE: load_kld [-e regex] [-m module] file' ;;
1508 shift $(($OPTIND - 1))
1509 if [ $# -ne 1 ]; then
1510 err 3 'USAGE: load_kld [-e regex] [-m module] file'
1514 if [ -n "$_re" ]; then
1515 if kldstat -v | egrep -q -e "$_re"; then
1519 if kldstat -q -m "$_mod"; then
1524 if ! kldload "$1"; then
1525 warn "Unable to load kernel module $1"
1528 info "$1 kernel module loaded."
1531 debug "load_kld: $1 kernel module already loaded."
1537 # Change every $src in $str to $dst.
1538 # Useful when /usr is not yet mounted and we cannot use tr(1), sed(1) nor
1542 local _str _src _dst _out _com
1549 for _com in ${_str}; do
1550 if [ -z "${_out}" ]; then
1553 _out="${_out}${_dst}${_com}"
1559 # Creates a list of providers for GELI encryption.
1562 local devices devices2
1563 local provider mountpoint type options rest
1565 # Create list of GELI providers from fstab.
1566 while read provider mountpoint type options rest ; do
1567 case ":${options}" in
1576 case ":${provider}" in
1581 # Skip swap devices.
1582 if [ "${type}" = "swap" -o "${options}" = "sw" -o "${noauto}" = "yes" ]; then
1585 devices="${devices} ${provider}"
1590 # Append providers from geli_devices.
1591 devices="${devices} ${geli_devices}"
1593 for provider in ${devices}; do
1594 provider=${provider%.eli}
1595 provider=${provider#/dev/}
1596 devices2="${devices2} ${provider}"
1602 # Find scripts in local_startup directories that use the old syntax
1604 find_local_scripts_old() {
1607 for dir in ${local_startup}; do
1608 if [ -d "${dir}" ]; then
1609 for file in ${dir}/[0-9]*.sh; do
1610 grep '^# PROVIDE:' $file >/dev/null 2>&1 &&
1612 zlist="$zlist $file"
1614 for file in ${dir}/[!0-9]*.sh; do
1615 grep '^# PROVIDE:' $file >/dev/null 2>&1 &&
1617 slist="$slist $file"
1623 find_local_scripts_new() {
1625 for dir in ${local_startup}; do
1626 if [ -d "${dir}" ]; then
1627 for file in `grep -l '^# PROVIDE:' ${dir}/* 2>/dev/null`; do
1630 *) if [ -x "$file" ]; then
1631 local_rc="${local_rc} ${file}"
1640 # check_required_{before|after} command
1641 # Check for things required by the command before and after its precmd,
1642 # respectively. The two separate functions are needed because some
1643 # conditions should prevent precmd from being run while other things
1644 # depend on precmd having already been run.
1646 check_required_before()
1652 for _f in $required_vars; do
1653 if ! checkyesno $_f; then
1654 warn "\$${_f} is not enabled."
1655 if [ -z "$rc_force" ]; then
1661 for _f in $required_dirs; do
1662 if [ ! -d "${_f}/." ]; then
1663 warn "${_f} is not a directory."
1664 if [ -z "$rc_force" ]; then
1670 for _f in $required_files; do
1671 if [ ! -r "${_f}" ]; then
1672 warn "${_f} is not readable."
1673 if [ -z "$rc_force" ]; then
1684 check_required_after()
1690 for _f in $required_modules; do
1692 *~*) _args="-e ${_f#*~} ${_f%%~*}" ;;
1693 *:*) _args="-m ${_f#*:} ${_f%%:*}" ;;
1696 if ! load_kld ${_args}; then
1697 if [ -z "$rc_force" ]; then
1708 # check_kern_features mib
1709 # Return existence of kern.features.* sysctl MIB as true or
1710 # false. The result will be cached in $_rc_cache_kern_features_
1711 # namespace. "0" means the kern.features.X exists.
1713 check_kern_features()
1717 [ -n "$1" ] || return 1;
1718 eval _v=\$_rc_cache_kern_features_$1
1719 [ -n "$_v" ] && return "$_v";
1721 if ${SYSCTL_N} kern.features.$1 > /dev/null 2>&1; then
1722 eval _rc_cache_kern_features_$1=0
1725 eval _rc_cache_kern_features_$1=1
1730 # check_namevarlist var
1731 # Return "0" if ${name}_var is reserved in rc.subr.
1733 _rc_namevarlist="program chroot chdir flags fib nice user group groups"
1738 for _v in $_rc_namevarlist; do
1747 # _echoonce var msg mode
1748 # mode=0: Echo $msg if ${$var} is empty.
1749 # After doing echo, a string is set to ${$var}.
1751 # mode=1: Echo $msg if ${$var} is a string with non-zero length.
1755 local _var _msg _mode
1761 1) [ -n "$_var" ] && echo "$_msg" ;;
1762 *) [ -z "$_var" ] && echo -n "$_msg" && eval "$1=finished" ;;
1766 fi # [ -z "${_rc_subr_loaded}" ]