1# $NetBSD: rc.subr,v 1.67 2006/10/07 11:25:15 elad Exp $ 2# $FreeBSD$ 3# 4# Copyright (c) 1997-2004 The NetBSD Foundation, Inc. 5# All rights reserved. 6# 7# This code is derived from software contributed to The NetBSD Foundation 8# by Luke Mewburn. 9# 10# Redistribution and use in source and binary forms, with or without 11# modification, are permitted provided that the following conditions 12# are met: 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. 18# 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. 30# 31# rc.subr 32# functions used by various rc scripts 33# 34 35: ${RC_PID:=$$}; export RC_PID 36 37# 38# Operating System dependent/independent variables 39# 40 41if [ -n "${_rc_subr_loaded}" ]; then 42 return 43fi 44 45_rc_subr_loaded="YES" 46 47SYSCTL="/sbin/sysctl" 48SYSCTL_N="${SYSCTL} -n" 49SYSCTL_W="${SYSCTL}" 50PROTECT="/usr/bin/protect" 51ID="/usr/bin/id" 52IDCMD="if [ -x $ID ]; then $ID -un; fi" 53PS="/bin/ps -ww" 54JID=0 55# rc_service provides the path to the service script that we are executing. 56# This is not being set here in an execution context, necessarily, so it's 57# really just a reasonable guess, and it will get overwritten later if 58# we are executing from some other means than direct execution by service(8) 59# or manual invocation of the service script. The prime example of this is 60# during system startup, all rc scripts will be invoked via /etc/rc, so 61# run_rc_script will overwrite rc_service with the file being sourced. 62rc_service="$0" 63 64# 65# functions 66# --------- 67 68# list_vars pattern 69# List variables matching glob pattern. 70# 71list_vars() 72{ 73 # Localize 'set' option below. 74 local - 75 local IFS=$'\n' line varname 76 77 # Disable path expansion in unquoted 'for' parameters below. 78 set -o noglob 79 80 for line in $(set); do 81 varname="${line%%=*}" 82 83 case "$varname" in 84 "$line"|*[!a-zA-Z0-9_]*) 85 continue 86 ;; 87 $1) 88 echo $varname 89 ;; 90 esac 91 done 92} 93 94# set_rcvar [var] [defval] [desc] 95# 96# Echo or define a rc.conf(5) variable name. Global variable 97# $rcvars is used. 98# 99# If no argument is specified, echo "${name}_enable". 100# 101# If only a var is specified, echo "${var}_enable". 102# 103# If var and defval are specified, the ${var} is defined as 104# rc.conf(5) variable and the default value is ${defvar}. An 105# optional argument $desc can also be specified to add a 106# description for that. 107# 108set_rcvar() 109{ 110 local _var 111 112 case $# in 113 0) echo ${name}_enable ;; 114 1) echo ${1}_enable ;; 115 *) 116 debug "set_rcvar: \$$1=$2 is added" \ 117 " as a rc.conf(5) variable." 118 _var=$1 119 rcvars="${rcvars# } $_var" 120 eval ${_var}_defval=\"$2\" 121 shift 2 122 eval ${_var}_desc=\"$*\" 123 ;; 124 esac 125} 126 127# set_rcvar_obsolete oldvar [newvar] [msg] 128# Define obsolete variable. 129# Global variable $rcvars_obsolete is used. 130# 131set_rcvar_obsolete() 132{ 133 local _var 134 _var=$1 135 debug "set_rcvar_obsolete: \$$1(old) -> \$$2(new) is defined" 136 137 rcvars_obsolete="${rcvars_obsolete# } $1" 138 eval ${1}_newvar=\"$2\" 139 shift 2 140 eval ${_var}_obsolete_msg=\"$*\" 141} 142 143# 144# force_depend script [rcvar] 145# Force a service to start. Intended for use by services 146# to resolve dependency issues. 147# $1 - filename of script, in /etc/rc.d, to run 148# $2 - name of the script's rcvar (minus the _enable) 149# 150force_depend() 151{ 152 local _depend _dep_rcvar 153 154 _depend="$1" 155 _dep_rcvar="${2:-$1}_enable" 156 157 [ -n "$rc_fast" ] && ! checkyesno always_force_depends && 158 checkyesno $_dep_rcvar && return 0 159 160 /etc/rc.d/${_depend} forcestatus >/dev/null 2>&1 && return 0 161 162 info "${name} depends on ${_depend}, which will be forced to start." 163 if ! /etc/rc.d/${_depend} forcestart; then 164 warn "Unable to force ${_depend}. It may already be running." 165 return 1 166 fi 167} 168 169# 170# checkyesno var 171# Test $1 variable, and warn if not set to YES or NO. 172# Return 0 if it's "yes" (et al), nonzero otherwise. 173# 174checkyesno() 175{ 176 eval _value=\$${1} 177 debug "checkyesno: $1 is set to $_value." 178 case $_value in 179 180 # "yes", "true", "on", or "1" 181 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 182 return 0 183 ;; 184 185 # "no", "false", "off", or "0" 186 [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0) 187 return 1 188 ;; 189 *) 190 warn "\$${1} is not set properly - see rc.conf(5)." 191 return 1 192 ;; 193 esac 194} 195 196# 197# reverse_list list 198# print the list in reverse order 199# 200reverse_list() 201{ 202 _revlist= 203 for _revfile; do 204 _revlist="$_revfile $_revlist" 205 done 206 echo $_revlist 207} 208 209# stop_boot always 210# If booting directly to multiuser or $always is enabled, 211# send SIGTERM to the parent (/etc/rc) to abort the boot. 212# Otherwise just exit. 213# 214stop_boot() 215{ 216 local always 217 218 case $1 in 219 # "yes", "true", "on", or "1" 220 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 221 always=true 222 ;; 223 *) 224 always=false 225 ;; 226 esac 227 if [ "$autoboot" = yes -o "$always" = true ]; then 228 echo "ERROR: ABORTING BOOT (sending SIGTERM to parent)!" 229 kill -TERM ${RC_PID} 230 fi 231 exit 1 232} 233 234# 235# mount_critical_filesystems type 236# Go through the list of critical filesystems as provided in 237# the rc.conf(5) variable $critical_filesystems_${type}, checking 238# each one to see if it is mounted, and if it is not, mounting it. 239# 240mount_critical_filesystems() 241{ 242 eval _fslist=\$critical_filesystems_${1} 243 for _fs in $_fslist; do 244 mount | ( 245 _ismounted=false 246 while read what _on on _type type; do 247 if [ $on = $_fs ]; then 248 _ismounted=true 249 fi 250 done 251 if $_ismounted; then 252 : 253 else 254 mount $_fs >/dev/null 2>&1 255 fi 256 ) 257 done 258} 259 260# 261# check_pidfile pidfile procname [interpreter] 262# Parses the first line of pidfile for a PID, and ensures 263# that the process is running and matches procname. 264# Prints the matching PID upon success, nothing otherwise. 265# interpreter is optional; see _find_processes() for details. 266# 267check_pidfile() 268{ 269 _pidfile=$1 270 _procname=$2 271 _interpreter=$3 272 if [ -z "$_pidfile" -o -z "$_procname" ]; then 273 err 3 'USAGE: check_pidfile pidfile procname [interpreter]' 274 fi 275 if [ ! -f $_pidfile ]; then 276 debug "pid file ($_pidfile): not readable." 277 return 278 fi 279 read _pid _junk < $_pidfile 280 if [ -z "$_pid" ]; then 281 debug "pid file ($_pidfile): no pid in file." 282 return 283 fi 284 _find_processes $_procname ${_interpreter:-.} '-p '"$_pid" 285} 286 287# 288# check_process procname [interpreter] 289# Ensures that a process (or processes) named procname is running. 290# Prints a list of matching PIDs. 291# interpreter is optional; see _find_processes() for details. 292# 293check_process() 294{ 295 _procname=$1 296 _interpreter=$2 297 if [ -z "$_procname" ]; then 298 err 3 'USAGE: check_process procname [interpreter]' 299 fi 300 _find_processes $_procname ${_interpreter:-.} '-ax' 301} 302 303# 304# _find_processes procname interpreter psargs 305# Search for procname in the output of ps generated by psargs. 306# Prints the PIDs of any matching processes, space separated. 307# 308# If interpreter == ".", check the following variations of procname 309# against the first word of each command: 310# procname 311# `basename procname` 312# `basename procname` + ":" 313# "(" + `basename procname` + ")" 314# "[" + `basename procname` + "]" 315# 316# If interpreter != ".", read the first line of procname, remove the 317# leading #!, normalise whitespace, append procname, and attempt to 318# match that against each command, either as is, or with extra words 319# at the end. As an alternative, to deal with interpreted daemons 320# using perl, the basename of the interpreter plus a colon is also 321# tried as the prefix to procname. 322# 323_find_processes() 324{ 325 if [ $# -ne 3 ]; then 326 err 3 'USAGE: _find_processes procname interpreter psargs' 327 fi 328 _procname=$1 329 _interpreter=$2 330 _psargs=$3 331 332 _pref= 333 if [ $_interpreter != "." ]; then # an interpreted script 334 _script="${_chroot}${_chroot:+/}$_procname" 335 if [ -r "$_script" ]; then 336 read _interp < $_script # read interpreter name 337 case "$_interp" in 338 \#!*) 339 _interp=${_interp#\#!} # strip #! 340 set -- $_interp 341 case $1 in 342 */bin/env) 343 shift # drop env to get real name 344 ;; 345 esac 346 if [ $_interpreter != $1 ]; then 347 warn "\$command_interpreter $_interpreter != $1" 348 fi 349 ;; 350 *) 351 warn "no shebang line in $_script" 352 set -- $_interpreter 353 ;; 354 esac 355 else 356 warn "cannot read shebang line from $_script" 357 set -- $_interpreter 358 fi 359 _interp="$* $_procname" # cleanup spaces, add _procname 360 _interpbn=${1##*/} 361 _fp_args='_argv' 362 _fp_match='case "$_argv" in 363 ${_interp}|"${_interp} "*|"[${_interpbn}]"|"${_interpbn}: ${_procname}"*)' 364 else # a normal daemon 365 _procnamebn=${_procname##*/} 366 _fp_args='_arg0 _argv' 367 _fp_match='case "$_arg0" in 368 $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})"|"[${_procnamebn}]")' 369 fi 370 371 _proccheck="\ 372 $PS 2>/dev/null -o pid= -o jid= -o command= $_psargs"' | 373 while read _npid _jid '"$_fp_args"'; do 374 '"$_fp_match"' 375 if [ "$JID" -eq "$_jid" ]; 376 then echo -n "$_pref$_npid"; 377 _pref=" "; 378 fi 379 ;; 380 esac 381 done' 382 383# debug "in _find_processes: proccheck is ($_proccheck)." 384 eval $_proccheck 385} 386 387# sort_lite [-b] [-n] [-k POS] [-t SEP] 388# A lite version of sort(1) (supporting a few options) that can be used 389# before the real sort(1) is available (e.g., in scripts that run prior 390# to mountcritremote). Requires only shell built-in functionality. 391# 392sort_lite() 393{ 394 local funcname=sort_lite 395 local sort_sep="$IFS" sort_ignore_leading_space= 396 local sort_field=0 sort_strict_fields= sort_numeric= 397 local nitems=0 skip_leading=0 trim= 398 399 local OPTIND flag 400 while getopts bnk:t: flag; do 401 case "$flag" in 402 b) sort_ignore_leading_space=1 ;; 403 n) sort_numeric=1 sort_ignore_leading_space=1 ;; 404 k) sort_field="${OPTARG%%,*}" ;; # only up to first comma 405 # NB: Unlike sort(1) only one POS allowed 406 t) sort_sep="$OPTARG" 407 if [ ${#sort_sep} -gt 1 ]; then 408 echo "$funcname: multi-character tab \`$sort_sep'" >&2 409 return 1 410 fi 411 sort_strict_fields=1 412 ;; 413 \?) return 1 ;; 414 esac 415 done 416 shift $(( $OPTIND - 1 )) 417 418 # Create transformation pattern to trim leading text if desired 419 case "$sort_field" in 420 ""|[!0-9]*|*[!0-9.]*) 421 echo "$funcname: invalid sort field \`$sort_field'" >&2 422 return 1 423 ;; 424 *.*) 425 skip_leading=${sort_field#*.} sort_field=${sort_field%%.*} 426 while [ ${skip_leading:-0} -gt 1 ] 2> /dev/null; do 427 trim="$trim?" skip_leading=$(( $skip_leading - 1 )) 428 done 429 esac 430 431 # Copy input to series of local numbered variables 432 # NB: IFS of NULL preserves leading whitespace 433 local LINE 434 while IFS= read -r LINE || [ "$LINE" ]; do 435 nitems=$(( $nitems + 1 )) 436 local src_$nitems="$LINE" 437 done 438 439 # 440 # Sort numbered locals using insertion sort 441 # 442 local curitem curitem_orig curitem_mod curitem_haskey 443 local dest dest_orig dest_mod dest_haskey 444 local d gt n 445 local i=1 446 while [ $i -le $nitems ]; do 447 curitem_haskey=1 # Assume sort field (-k POS) exists 448 eval curitem=\"\$src_$i\" 449 curitem_mod="$curitem" # for modified comparison 450 curitem_orig="$curitem" # for original comparison 451 452 # Trim leading whitespace if desired 453 if [ "$sort_ignore_leading_space" ]; then 454 while case "$curitem_orig" in 455 [$IFS]*) : ;; *) false; esac 456 do 457 curitem_orig="${curitem_orig#?}" 458 done 459 curitem_mod="$curitem_orig" 460 fi 461 462 # Shift modified comparison value if sort field (-k POS) is > 1 463 n=$sort_field 464 while [ $n -gt 1 ]; do 465 case "$curitem_mod" in 466 *[$sort_sep]*) 467 # Cut text up-to (and incl.) first separator 468 curitem_mod="${curitem_mod#*[$sort_sep]}" 469 470 # Skip NULLs unless strict field splitting 471 [ "$sort_strict_fields" ] || 472 [ "${curitem_mod%%[$sort_sep]*}" ] || 473 [ $n -eq 2 ] || 474 continue 475 ;; 476 *) 477 # Asked for a field that doesn't exist 478 curitem_haskey= break 479 esac 480 n=$(( $n - 1 )) 481 done 482 483 # Trim trailing words if sort field >= 1 484 [ $sort_field -ge 1 -a "$sort_numeric" ] && 485 curitem_mod="${curitem_mod%%[$sort_sep]*}" 486 487 # Apply optional trim (-k POS.TRIM) to cut leading characters 488 curitem_mod="${curitem_mod#$trim}" 489 490 # Determine the type of modified comparison to use initially 491 # NB: Prefer numerical if requested but fallback to standard 492 case "$curitem_mod" in 493 ""|[!0-9]*) # NULL or begins with non-number 494 gt=">" 495 [ "$sort_numeric" ] && curitem_mod=0 496 ;; 497 *) 498 if [ "$sort_numeric" ]; then 499 gt="-gt" 500 curitem_mod="${curitem_mod%%[!0-9]*}" 501 # NB: trailing non-digits removed 502 # otherwise numeric comparison fails 503 else 504 gt=">" 505 fi 506 esac 507 508 # If first time through, short-circuit below position-search 509 if [ $i -le 1 ]; then 510 d=0 511 else 512 d=1 513 fi 514 515 # 516 # Find appropriate element position 517 # 518 while [ $d -gt 0 ] 519 do 520 dest_haskey=$curitem_haskey 521 eval dest=\"\$dest_$d\" 522 dest_mod="$dest" # for modified comparison 523 dest_orig="$dest" # for original comparison 524 525 # Trim leading whitespace if desired 526 if [ "$sort_ignore_leading_space" ]; then 527 while case "$dest_orig" in 528 [$IFS]*) : ;; *) false; esac 529 do 530 dest_orig="${dest_orig#?}" 531 done 532 dest_mod="$dest_orig" 533 fi 534 535 # Shift modified value if sort field (-k POS) is > 1 536 n=$sort_field 537 while [ $n -gt 1 ]; do 538 case "$dest_mod" in 539 *[$sort_sep]*) 540 # Cut text up-to (and incl.) 1st sep 541 dest_mod="${dest_mod#*[$sort_sep]}" 542 543 # Skip NULLs unless strict fields 544 [ "$sort_strict_fields" ] || 545 [ "${dest_mod%%[$sort_sep]*}" ] || 546 [ $n -eq 2 ] || 547 continue 548 ;; 549 *) 550 # Asked for a field that doesn't exist 551 dest_haskey= break 552 esac 553 n=$(( $n - 1 )) 554 done 555 556 # Trim trailing words if sort field >= 1 557 [ $sort_field -ge 1 -a "$sort_numeric" ] && 558 dest_mod="${dest_mod%%[$sort_sep]*}" 559 560 # Apply optional trim (-k POS.TRIM), cut leading chars 561 dest_mod="${dest_mod#$trim}" 562 563 # Determine type of modified comparison to use 564 # NB: Prefer numerical if requested, fallback to std 565 case "$dest_mod" in 566 ""|[!0-9]*) # NULL or begins with non-number 567 gt=">" 568 [ "$sort_numeric" ] && dest_mod=0 569 ;; 570 *) 571 if [ "$sort_numeric" ]; then 572 gt="-gt" 573 dest_mod="${dest_mod%%[!0-9]*}" 574 # NB: kill trailing non-digits 575 # for numeric comparison safety 576 else 577 gt=">" 578 fi 579 esac 580 581 # Break if we've found the proper element position 582 if [ "$curitem_haskey" -a "$dest_haskey" ]; then 583 if [ "$dest_mod" = "$curitem_mod" ]; then 584 [ "$dest_orig" ">" "$curitem_orig" ] && 585 break 586 elif [ "$dest_mod" $gt "$curitem_mod" ] \ 587 2> /dev/null 588 then 589 break 590 fi 591 else 592 [ "$dest_orig" ">" "$curitem_orig" ] && break 593 fi 594 595 # Break if we've hit the end 596 [ $d -ge $i ] && break 597 598 d=$(( $d + 1 )) 599 done 600 601 # Shift remaining positions forward, making room for new item 602 n=$i 603 while [ $n -ge $d ]; do 604 # Shift destination item forward one placement 605 eval dest_$(( $n + 1 ))=\"\$dest_$n\" 606 n=$(( $n - 1 )) 607 done 608 609 # Place the element 610 if [ $i -eq 1 ]; then 611 local dest_1="$curitem" 612 else 613 local dest_$d="$curitem" 614 fi 615 616 i=$(( $i + 1 )) 617 done 618 619 # Print sorted results 620 d=1 621 while [ $d -le $nitems ]; do 622 eval echo \"\$dest_$d\" 623 d=$(( $d + 1 )) 624 done 625} 626 627# 628# wait_for_pids pid [pid ...] 629# spins until none of the pids exist 630# 631wait_for_pids() 632{ 633 local _list _prefix _nlist _j 634 635 _list="$@" 636 if [ -z "$_list" ]; then 637 return 638 fi 639 _prefix= 640 while true; do 641 _nlist=""; 642 for _j in $_list; do 643 if kill -0 $_j 2>/dev/null; then 644 _nlist="${_nlist}${_nlist:+ }$_j" 645 [ -n "$_prefix" ] && sleep 1 646 fi 647 done 648 if [ -z "$_nlist" ]; then 649 break 650 fi 651 _list=$_nlist 652 echo -n ${_prefix:-"Waiting for PIDS: "}$_list 653 _prefix=", " 654 pwait $_list 2>/dev/null 655 done 656 if [ -n "$_prefix" ]; then 657 echo "." 658 fi 659} 660 661# 662# get_pidfile_from_conf string file 663# 664# Takes a string to search for in the specified file. 665# Ignores lines with traditional comment characters. 666# 667# Example: 668# 669# if get_pidfile_from_conf string file; then 670# pidfile="$_pidfile_from_conf" 671# else 672# pidfile='appropriate default' 673# fi 674# 675get_pidfile_from_conf() 676{ 677 if [ -z "$1" -o -z "$2" ]; then 678 err 3 "USAGE: get_pidfile_from_conf string file ($name)" 679 fi 680 681 local string file line 682 683 string="$1" ; file="$2" 684 685 if [ ! -s "$file" ]; then 686 err 3 "get_pidfile_from_conf: $file does not exist ($name)" 687 fi 688 689 while read line; do 690 case "$line" in 691 *[#\;]*${string}*) continue ;; 692 *${string}*) break ;; 693 esac 694 done < $file 695 696 if [ -n "$line" ]; then 697 line=${line#*/} 698 _pidfile_from_conf="/${line%%[\"\;]*}" 699 else 700 return 1 701 fi 702} 703 704# 705# check_startmsgs 706# If rc_quiet is set (usually as a result of using faststart at 707# boot time) check if rc_startmsgs is enabled. 708# 709check_startmsgs() 710{ 711 if [ -n "$rc_quiet" ]; then 712 checkyesno rc_startmsgs 713 else 714 return 0 715 fi 716} 717 718# 719# startmsg 720# Preferred method to use when displaying start messages in lieu of echo. 721# 722startmsg() 723{ 724 check_startmsgs && echo "$@" 725} 726 727# 728# run_rc_command argument 729# Search for argument in the list of supported commands, which is: 730# "start stop restart rcvar status poll ${extra_commands}" 731# If there's a match, run ${argument}_cmd or the default method 732# (see below). 733# 734# If argument has a given prefix, then change the operation as follows: 735# Prefix Operation 736# ------ --------- 737# fast Skip the pid check, and set rc_fast=yes, rc_quiet=yes 738# force Set ${rcvar} to YES, and set rc_force=yes 739# one Set ${rcvar} to YES 740# quiet Don't output some diagnostics, and set rc_quiet=yes 741# 742# The following globals are used: 743# 744# Name Needed Purpose 745# ---- ------ ------- 746# name y Name of script. 747# 748# command n Full path to command. 749# Not needed if ${rc_arg}_cmd is set for 750# each keyword. 751# 752# command_args n Optional args/shell directives for command. 753# 754# command_interpreter n If not empty, command is interpreted, so 755# call check_{pidfile,process}() appropriately. 756# 757# desc n Description of script. 758# 759# extra_commands n List of extra commands supported. 760# 761# pidfile n If set, use check_pidfile $pidfile $command, 762# otherwise use check_process $command. 763# In either case, only check if $command is set. 764# 765# procname n Process name to check for instead of $command. 766# 767# rcvar n This is checked with checkyesno to determine 768# if the action should be run. 769# 770# ${name}_program n Full path to command. 771# Meant to be used in /etc/rc.conf to override 772# ${command}. 773# 774# ${name}_chroot n Directory to chroot to before running ${command} 775# Requires /usr to be mounted. 776# 777# ${name}_chdir n Directory to cd to before running ${command} 778# (if not using ${name}_chroot). 779# 780# ${name}_flags n Arguments to call ${command} with. 781# NOTE: $flags from the parent environment 782# can be used to override this. 783# 784# ${name}_env n Environment variables to run ${command} with. 785# 786# ${name}_env_file n File to source variables to run ${command} with. 787# 788# ${name}_fib n Routing table number to run ${command} with. 789# 790# ${name}_nice n Nice level to run ${command} at. 791# 792# ${name}_oomprotect n Don't kill ${command} when swap space is exhausted. 793# 794# ${name}_user n User to run ${command} as, using su(1) if not 795# using ${name}_chroot. 796# Requires /usr to be mounted. 797# 798# ${name}_group n Group to run chrooted ${command} as. 799# Requires /usr to be mounted. 800# 801# ${name}_groups n Comma separated list of supplementary groups 802# to run the chrooted ${command} with. 803# Requires /usr to be mounted. 804# 805# ${name}_prepend n Command added before ${command}. 806# 807# ${name}_setup n Command executed before ${command}. 808# 809# ${name}_login_class n Login class to use, else "daemon". 810# 811# ${name}_limits n limits(1) to apply to ${command}. 812# 813# ${rc_arg}_cmd n If set, use this as the method when invoked; 814# Otherwise, use default command (see below) 815# 816# ${rc_arg}_precmd n If set, run just before performing the 817# ${rc_arg}_cmd method in the default 818# operation (i.e, after checking for required 819# bits and process (non)existence). 820# If this completes with a non-zero exit code, 821# don't run ${rc_arg}_cmd. 822# 823# ${rc_arg}_postcmd n If set, run just after performing the 824# ${rc_arg}_cmd method, if that method 825# returned a zero exit code. 826# 827# required_dirs n If set, check for the existence of the given 828# directories before running a (re)start command. 829# 830# required_files n If set, check for the readability of the given 831# files before running a (re)start command. 832# 833# required_modules n If set, ensure the given kernel modules are 834# loaded before running a (re)start command. 835# The check and possible loads are actually 836# done after start_precmd so that the modules 837# aren't loaded in vain, should the precmd 838# return a non-zero status to indicate a error. 839# If a word in the list looks like "foo:bar", 840# "foo" is the KLD file name and "bar" is the 841# module name. If a word looks like "foo~bar", 842# "foo" is the KLD file name and "bar" is a 843# egrep(1) pattern matching the module name. 844# Otherwise the module name is assumed to be 845# the same as the KLD file name, which is most 846# common. See load_kld(). 847# 848# required_vars n If set, perform checkyesno on each of the 849# listed variables before running the default 850# (re)start command. 851# 852# Default behaviour for a given argument, if no override method is 853# provided: 854# 855# Argument Default behaviour 856# -------- ----------------- 857# start if !running && checkyesno ${rcvar} 858# ${command} 859# 860# stop if ${pidfile} 861# rc_pid=$(check_pidfile $pidfile $command) 862# else 863# rc_pid=$(check_process $command) 864# kill $sig_stop $rc_pid 865# wait_for_pids $rc_pid 866# ($sig_stop defaults to TERM.) 867# 868# reload Similar to stop, except use $sig_reload instead, 869# and don't wait_for_pids. 870# $sig_reload defaults to HUP. 871# Note that `reload' isn't provided by default, 872# it should be enabled via $extra_commands. 873# 874# restart Run `stop' then `start'. 875# 876# status Show if ${command} is running, etc. 877# 878# poll Wait for ${command} to exit. 879# 880# rcvar Display what rc.conf variable is used (if any). 881# 882# enabled Return true if the service is enabled. 883# 884# describe Show the service's description 885# 886# extracommands Show the service's extra commands 887# 888# Variables available to methods, and after run_rc_command() has 889# completed: 890# 891# Variable Purpose 892# -------- ------- 893# rc_arg Argument to command, after fast/force/one processing 894# performed 895# 896# rc_flags Flags to start the default command with. 897# Defaults to ${name}_flags, unless overridden 898# by $flags from the environment. 899# This variable may be changed by the precmd method. 900# 901# rc_service Path to the service being executed, in case the service 902# needs to re-invoke itself. 903# 904# rc_pid PID of command (if appropriate) 905# 906# rc_fast Not empty if "fast" was provided (q.v.) 907# 908# rc_force Not empty if "force" was provided (q.v.) 909# 910# rc_quiet Not empty if "quiet" was provided 911# 912# 913run_rc_command() 914{ 915 _return=0 916 rc_arg=$1 917 if [ -z "$name" ]; then 918 err 3 'run_rc_command: $name is not set.' 919 fi 920 921 # Don't repeat the first argument when passing additional command- 922 # line arguments to the command subroutines. 923 # 924 shift 1 925 rc_extra_args="$*" 926 927 _rc_prefix= 928 case "$rc_arg" in 929 fast*) # "fast" prefix; don't check pid 930 rc_arg=${rc_arg#fast} 931 rc_fast=yes 932 rc_quiet=yes 933 ;; 934 force*) # "force" prefix; always run 935 rc_force=yes 936 _rc_prefix=force 937 rc_arg=${rc_arg#${_rc_prefix}} 938 if [ -n "${rcvar}" ]; then 939 eval ${rcvar}=YES 940 fi 941 ;; 942 one*) # "one" prefix; set ${rcvar}=yes 943 _rc_prefix=one 944 rc_arg=${rc_arg#${_rc_prefix}} 945 if [ -n "${rcvar}" ]; then 946 eval ${rcvar}=YES 947 fi 948 ;; 949 quiet*) # "quiet" prefix; omit some messages 950 _rc_prefix=quiet 951 rc_arg=${rc_arg#${_rc_prefix}} 952 rc_quiet=yes 953 ;; 954 esac 955 956 eval _override_command=\$${name}_program 957 command=${_override_command:-$command} 958 959 _keywords="start stop restart rcvar enable disable delete enabled describe extracommands $extra_commands" 960 rc_pid= 961 _pidcmd= 962 _procname=${procname:-${command}} 963 964 # setup pid check command 965 if [ -n "$_procname" ]; then 966 if [ -n "$pidfile" ]; then 967 _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')' 968 else 969 _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')' 970 fi 971 _keywords="${_keywords} status poll" 972 else 973 if [ ! -z "${status_cmd}" ] 974 then 975 _keywords="${_keywords} status" 976 fi 977 fi 978 979 if [ -z "$rc_arg" ]; then 980 rc_usage $_keywords 981 fi 982 983 if [ "$rc_arg" = "enabled" ] ; then 984 checkyesno ${rcvar} 985 return $? 986 fi 987 988 if [ -n "$flags" ]; then # allow override from environment 989 rc_flags=$flags 990 else 991 eval rc_flags=\$${name}_flags 992 fi 993 eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \ 994 _nice=\$${name}_nice _user=\$${name}_user \ 995 _group=\$${name}_group _groups=\$${name}_groups \ 996 _fib=\$${name}_fib _env=\$${name}_env \ 997 _prepend=\$${name}_prepend _login_class=\${${name}_login_class:-daemon} \ 998 _limits=\$${name}_limits _oomprotect=\$${name}_oomprotect \ 999 _setup=\$${name}_setup _env_file=\$${name}_env_file 1000 1001 if [ -n "$_env_file" ] && [ -r "${_env_file}" ]; then # load env from file 1002 set -a 1003 . $_env_file 1004 set +a 1005 fi 1006 1007 if [ -n "$_user" ]; then # unset $_user if running as that user 1008 if [ "$_user" = "$(eval $IDCMD)" ]; then 1009 unset _user 1010 fi 1011 fi 1012 1013 [ -z "$autoboot" ] && eval $_pidcmd # determine the pid if necessary 1014 1015 for _elem in $_keywords; do 1016 if [ "$_elem" != "$rc_arg" ]; then 1017 continue 1018 fi 1019 # if ${rcvar} is set, $1 is not "rcvar", "describe", 1020 # "enable" or "delete", and ${rc_pid} is not set, run: 1021 # checkyesno ${rcvar} 1022 # and return if that failed 1023 # 1024 if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" -a "$rc_arg" != "stop" \ 1025 -a "$rc_arg" != "delete" -a "$rc_arg" != "enable" \ 1026 -a "$rc_arg" != "describe" ] || 1027 [ -n "${rcvar}" -a "$rc_arg" = "stop" -a -z "${rc_pid}" ]; then 1028 if ! checkyesno ${rcvar}; then 1029 if [ -n "${rc_quiet}" ]; then 1030 return 0 1031 fi 1032 echo -n "Cannot '${rc_arg}' $name. Set ${rcvar} to " 1033 echo -n "YES in /etc/rc.conf or use 'one${rc_arg}' " 1034 echo "instead of '${rc_arg}'." 1035 return 0 1036 fi 1037 fi 1038 1039 if [ $rc_arg = "start" -a -z "$rc_fast" -a -n "$rc_pid" ]; then 1040 if [ -z "$rc_quiet" ]; then 1041 echo 1>&2 "${name} already running? " \ 1042 "(pid=$rc_pid)." 1043 fi 1044 return 1 1045 fi 1046 1047 # if there's a custom ${XXX_cmd}, 1048 # run that instead of the default 1049 # 1050 eval _cmd=\$${rc_arg}_cmd \ 1051 _precmd=\$${rc_arg}_precmd \ 1052 _postcmd=\$${rc_arg}_postcmd 1053 1054 if [ -n "$_cmd" ]; then 1055 if [ -n "$_env" ]; then 1056 eval "export -- $_env" 1057 fi 1058 _run_rc_precmd || return 1 1059 _run_rc_doit "$_cmd $rc_extra_args" || return 1 1060 _run_rc_postcmd 1061 return $_return 1062 fi 1063 1064 case "$rc_arg" in # default operations... 1065 1066 describe) 1067 if [ -n "$desc" ]; then 1068 echo "$desc" 1069 fi 1070 ;; 1071 1072 extracommands) 1073 echo "$extra_commands" 1074 ;; 1075 1076 enable) 1077 _out=$(/usr/sbin/sysrc -vs "$name" "$rcvar=YES") && 1078 echo "$name enabled in ${_out%%:*}" 1079 ;; 1080 1081 disable) 1082 _out=$(/usr/sbin/sysrc -vs "$name" "$rcvar=NO") && 1083 echo "$name disabled in ${_out%%:*}" 1084 ;; 1085 1086 delete) 1087 _files= 1088 for _file in $(sysrc -lEs "$name"); do 1089 _out=$(sysrc -Fif $_file "$rcvar") && _files="$_files $_file" 1090 done 1091 /usr/sbin/sysrc -x "$rcvar" && echo "$rcvar deleted in ${_files# }" 1092 # delete file in rc.conf.d if desired and empty. 1093 checkyesno service_delete_empty || _files= 1094 for _file in $_files; do 1095 [ "$_file" = "${_file#*/rc.conf.d/}" ] && continue 1096 [ $(/usr/bin/stat -f%z $_file) -gt 0 ] && continue 1097 /bin/rm "$_file" && echo "Empty file $_file removed" 1098 done 1099 ;; 1100 1101 status) 1102 _run_rc_precmd || return 1 1103 if [ -n "$rc_pid" ]; then 1104 echo "${name} is running as pid $rc_pid." 1105 else 1106 echo "${name} is not running." 1107 return 1 1108 fi 1109 _run_rc_postcmd 1110 ;; 1111 1112 start) 1113 if [ ! -x "${_chroot}${_chroot:+/}${command}" ]; then 1114 warn "run_rc_command: cannot run $command" 1115 return 1 1116 fi 1117 1118 if ! _run_rc_precmd; then 1119 warn "failed precmd routine for ${name}" 1120 return 1 1121 fi 1122 1123 # setup the full command to run 1124 # 1125 startmsg "Starting ${name}." 1126 if [ -n "$_chroot" ]; then 1127 _cd= 1128 _doit="\ 1129${_nice:+nice -n $_nice }\ 1130${_fib:+setfib -F $_fib }\ 1131${_env:+env $_env }\ 1132chroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\ 1133$_chroot $command $rc_flags $command_args" 1134 else 1135 _cd="${_chdir:+cd $_chdir && }" 1136 _doit="\ 1137${_fib:+setfib -F $_fib }\ 1138${_env:+env $_env }\ 1139$command $rc_flags $command_args" 1140 if [ -n "$_user" ]; then 1141 _doit="su -m $_user -c 'sh -c \"$_doit\"'" 1142 fi 1143 if [ -n "$_nice" ]; then 1144 if [ -z "$_user" ]; then 1145 _doit="sh -c \"$_doit\"" 1146 fi 1147 _doit="nice -n $_nice $_doit" 1148 fi 1149 if [ -n "$_prepend" ]; then 1150 _doit="$_prepend $_doit" 1151 fi 1152 fi 1153 1154 if [ -n "$_setup" ]; then 1155 if ! _run_rc_doit "$_setup"; then 1156 warn "failed to setup ${name}" 1157 fi 1158 fi 1159 1160 # Prepend default limits 1161 _doit="$_cd limits -C $_login_class $_limits $_doit" 1162 1163 # run the full command 1164 # 1165 if ! _run_rc_doit "$_doit"; then 1166 warn "failed to start ${name}" 1167 return 1 1168 fi 1169 1170 # finally, run postcmd 1171 # 1172 _run_rc_postcmd 1173 ;; 1174 1175 stop) 1176 if [ -z "$rc_pid" ]; then 1177 [ -n "$rc_fast" ] && return 0 1178 _run_rc_notrunning 1179 return 1 1180 fi 1181 1182 _run_rc_precmd || return 1 1183 1184 # send the signal to stop 1185 # 1186 echo "Stopping ${name}." 1187 _doit=$(_run_rc_killcmd "${sig_stop:-TERM}") 1188 _run_rc_doit "$_doit" || return 1 1189 1190 # wait for the command to exit, 1191 # and run postcmd. 1192 wait_for_pids $rc_pid 1193 1194 _run_rc_postcmd 1195 ;; 1196 1197 reload) 1198 if [ -z "$rc_pid" ]; then 1199 _run_rc_notrunning 1200 return 1 1201 fi 1202 1203 _run_rc_precmd || return 1 1204 1205 _doit=$(_run_rc_killcmd "${sig_reload:-HUP}") 1206 _run_rc_doit "$_doit" || return 1 1207 1208 _run_rc_postcmd 1209 ;; 1210 1211 restart) 1212 # prevent restart being called more 1213 # than once by any given script 1214 # 1215 if ${_rc_restart_done:-false}; then 1216 return 0 1217 fi 1218 _rc_restart_done=true 1219 1220 _run_rc_precmd || return 1 1221 1222 # run those in a subshell to keep global variables 1223 ( run_rc_command ${_rc_prefix}stop $rc_extra_args ) 1224 ( run_rc_command ${_rc_prefix}start $rc_extra_args ) 1225 _return=$? 1226 [ $_return -ne 0 ] && [ -z "$rc_force" ] && return 1 1227 1228 _run_rc_postcmd 1229 ;; 1230 1231 poll) 1232 _run_rc_precmd || return 1 1233 if [ -n "$rc_pid" ]; then 1234 wait_for_pids $rc_pid 1235 fi 1236 _run_rc_postcmd 1237 ;; 1238 1239 rcvar) 1240 echo -n "# $name" 1241 if [ -n "$desc" ]; then 1242 echo " : $desc" 1243 else 1244 echo "" 1245 fi 1246 echo "#" 1247 # Get unique vars in $rcvar $rcvars 1248 for _v in $rcvar $rcvars; do 1249 case $v in 1250 $_v\ *|\ *$_v|*\ $_v\ *) ;; 1251 *) v="${v# } $_v" ;; 1252 esac 1253 done 1254 1255 # Display variables. 1256 for _v in $v; do 1257 if [ -z "$_v" ]; then 1258 continue 1259 fi 1260 1261 eval _desc=\$${_v}_desc 1262 eval _defval=\$${_v}_defval 1263 _h="-" 1264 1265 eval echo \"$_v=\\\"\$$_v\\\"\" 1266 # decode multiple lines of _desc 1267 while [ -n "$_desc" ]; do 1268 case $_desc in 1269 *^^*) 1270 echo "# $_h ${_desc%%^^*}" 1271 _desc=${_desc#*^^} 1272 _h=" " 1273 ;; 1274 *) 1275 echo "# $_h ${_desc}" 1276 break 1277 ;; 1278 esac 1279 done 1280 echo "# (default: \"$_defval\")" 1281 done 1282 echo "" 1283 ;; 1284 1285 *) 1286 rc_usage $_keywords 1287 ;; 1288 1289 esac 1290 1291 # Apply protect(1) to the PID if ${name}_oomprotect is set. 1292 case "$rc_arg" in 1293 start) 1294 # We cannot use protect(1) inside jails. 1295 if [ -n "$_oomprotect" ] && [ -f "${PROTECT}" ] && 1296 [ "$(sysctl -n security.jail.jailed)" -eq 0 ]; then 1297 [ -z "${rc_pid}" ] && eval $_pidcmd 1298 case $_oomprotect in 1299 [Aa][Ll][Ll]) 1300 ${PROTECT} -d -i -p ${rc_pid} 1301 ;; 1302 [Yy][Ee][Ss]) 1303 ${PROTECT} -p ${rc_pid} 1304 ;; 1305 esac 1306 fi 1307 ;; 1308 esac 1309 1310 return $_return 1311 done 1312 1313 echo 1>&2 "$0: unknown directive '$rc_arg'." 1314 rc_usage $_keywords 1315 # not reached 1316} 1317 1318# 1319# Helper functions for run_rc_command: common code. 1320# They use such global variables besides the exported rc_* ones: 1321# 1322# name R/W 1323# ------------------ 1324# _precmd R 1325# _postcmd R 1326# _return W 1327# 1328_run_rc_precmd() 1329{ 1330 check_required_before "$rc_arg" || return 1 1331 1332 if [ -n "$_precmd" ]; then 1333 debug "run_rc_command: ${rc_arg}_precmd: $_precmd $rc_extra_args" 1334 eval "$_precmd $rc_extra_args" 1335 _return=$? 1336 1337 # If precmd failed and force isn't set, request exit. 1338 if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then 1339 return 1 1340 fi 1341 fi 1342 1343 check_required_after "$rc_arg" || return 1 1344 1345 return 0 1346} 1347 1348_run_rc_postcmd() 1349{ 1350 if [ -n "$_postcmd" ]; then 1351 debug "run_rc_command: ${rc_arg}_postcmd: $_postcmd $rc_extra_args" 1352 eval "$_postcmd $rc_extra_args" 1353 _return=$? 1354 fi 1355 return 0 1356} 1357 1358_run_rc_doit() 1359{ 1360 debug "run_rc_command: doit: $*" 1361 eval "$@" 1362 _return=$? 1363 1364 # If command failed and force isn't set, request exit. 1365 if [ $_return -ne 0 ] && [ -z "$rc_force" ]; then 1366 return 1 1367 fi 1368 1369 return 0 1370} 1371 1372_run_rc_notrunning() 1373{ 1374 local _pidmsg 1375 1376 if [ -n "$pidfile" ]; then 1377 _pidmsg=" (check $pidfile)." 1378 else 1379 _pidmsg= 1380 fi 1381 echo 1>&2 "${name} not running?${_pidmsg}" 1382} 1383 1384_run_rc_killcmd() 1385{ 1386 local _cmd 1387 1388 _cmd="kill -$1 $rc_pid" 1389 if [ -n "$_user" ]; then 1390 _cmd="su -m ${_user} -c 'sh -c \"${_cmd}\"'" 1391 fi 1392 echo "$_cmd" 1393} 1394 1395# 1396# run_rc_script file arg 1397# Start the script `file' with `arg', and correctly handle the 1398# return value from the script. 1399# If `file' ends with `.sh' and lives in /etc/rc.d, ignore it as it's 1400# an old-style startup file. 1401# If `file' ends with `.sh' and does not live in /etc/rc.d, it's sourced 1402# into the current environment if $rc_fast_and_loose is set; otherwise 1403# it is run as a child process. 1404# If `file' appears to be a backup or scratch file, ignore it. 1405# Otherwise if it is executable run as a child process. 1406# 1407run_rc_script() 1408{ 1409 _file=$1 1410 _arg=$2 1411 if [ -z "$_file" -o -z "$_arg" ]; then 1412 err 3 'USAGE: run_rc_script file arg' 1413 fi 1414 1415 unset name command command_args command_interpreter \ 1416 extra_commands pidfile procname \ 1417 rcvar rcvars rcvars_obsolete required_dirs required_files \ 1418 required_vars 1419 eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd 1420 1421 rc_service="$_file" 1422 case "$_file" in 1423 /etc/rc.d/*.sh) # no longer allowed in the base 1424 warn "Ignoring old-style startup script $_file" 1425 ;; 1426 *[~#]|*.OLD|*.bak|*.orig|*,v) # scratch file; skip 1427 warn "Ignoring scratch file $_file" 1428 ;; 1429 *) # run in subshell 1430 if [ -x $_file ]; then 1431 if [ -n "$rc_boottrace" ]; then 1432 boottrace_fn "$_file" "$_arg" 1433 elif [ -n "$rc_fast_and_loose" ]; then 1434 set $_arg; . $_file 1435 else 1436 ( trap "echo Script $_file interrupted >&2 ; kill -QUIT $$" 3 1437 trap "echo Script $_file interrupted >&2 ; exit 1" 2 1438 trap "echo Script $_file running >&2" 29 1439 set $_arg; . $_file ) 1440 fi 1441 fi 1442 ;; 1443 esac 1444} 1445 1446boottrace_fn() 1447{ 1448 local _file _arg 1449 _file=$1 1450 _arg=$2 1451 1452 if [ -n "$rc_fast_and_loose" ]; then 1453 boottrace_sysctl "$_file start" 1454 set $_arg; . $_file 1455 boottrace_sysctl "$_file done" 1456 else 1457 $boottrace_cmd "$_file" "$_arg" 1458 fi 1459} 1460 1461boottrace_sysctl() 1462{ 1463 ${SYSCTL} kern.boottrace.boottrace="$1" 1464} 1465 1466# 1467# load_rc_config [service] 1468# Source in the configuration file(s) for a given service. 1469# If no service is specified, only the global configuration 1470# file(s) will be loaded. 1471# 1472load_rc_config() 1473{ 1474 local _name _rcvar_val _var _defval _v _msg _new _d 1475 _name=$1 1476 1477 if ${_rc_conf_loaded:-false}; then 1478 : 1479 else 1480 if [ -r /etc/defaults/rc.conf ]; then 1481 debug "Sourcing /etc/defaults/rc.conf" 1482 . /etc/defaults/rc.conf 1483 source_rc_confs 1484 elif [ -r /etc/rc.conf ]; then 1485 debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)." 1486 . /etc/rc.conf 1487 fi 1488 _rc_conf_loaded=true 1489 fi 1490 1491 # If a service name was specified, attempt to load 1492 # service-specific configuration 1493 if [ -n "$_name" ] ; then 1494 for _d in /etc ${local_startup}; do 1495 _d=${_d%/rc.d} 1496 if [ -f ${_d}/rc.conf.d/"$_name" ]; then 1497 debug "Sourcing ${_d}/rc.conf.d/$_name" 1498 . ${_d}/rc.conf.d/"$_name" 1499 elif [ -d ${_d}/rc.conf.d/"$_name" ] ; then 1500 local _rc 1501 for _rc in ${_d}/rc.conf.d/"$_name"/* ; do 1502 if [ -f "$_rc" ] ; then 1503 debug "Sourcing $_rc" 1504 . "$_rc" 1505 fi 1506 done 1507 fi 1508 done 1509 fi 1510 1511 # Set defaults if defined. 1512 for _var in $rcvar $rcvars; do 1513 eval _defval=\$${_var}_defval 1514 if [ -n "$_defval" ]; then 1515 eval : \${$_var:=\$${_var}_defval} 1516 fi 1517 done 1518 1519 # check obsolete rc.conf variables 1520 for _var in $rcvars_obsolete; do 1521 eval _v=\$$_var 1522 eval _msg=\$${_var}_obsolete_msg 1523 eval _new=\$${_var}_newvar 1524 case $_v in 1525 "") 1526 ;; 1527 *) 1528 if [ -z "$_new" ]; then 1529 _msg="Ignored." 1530 else 1531 eval $_new=\"\$$_var\" 1532 if [ -z "$_msg" ]; then 1533 _msg="Use \$$_new instead." 1534 fi 1535 fi 1536 warn "\$$_var is obsolete. $_msg" 1537 ;; 1538 esac 1539 done 1540} 1541 1542# 1543# load_rc_config_var name var 1544# Read the rc.conf(5) var for name and set in the 1545# current shell, using load_rc_config in a subshell to prevent 1546# unwanted side effects from other variable assignments. 1547# 1548load_rc_config_var() 1549{ 1550 if [ $# -ne 2 ]; then 1551 err 3 'USAGE: load_rc_config_var name var' 1552 fi 1553 eval $(eval '( 1554 load_rc_config '$1' >/dev/null; 1555 if [ -n "${'$2'}" -o "${'$2'-UNSET}" != "UNSET" ]; then 1556 echo '$2'=\'\''${'$2'}\'\''; 1557 fi 1558 )' ) 1559} 1560 1561# 1562# rc_usage commands 1563# Print a usage string for $0, with `commands' being a list of 1564# valid commands. 1565# 1566rc_usage() 1567{ 1568 echo -n 1>&2 "Usage: $0 [fast|force|one|quiet](" 1569 1570 _sep= 1571 for _elem; do 1572 echo -n 1>&2 "$_sep$_elem" 1573 _sep="|" 1574 done 1575 echo 1>&2 ")" 1576 exit 1 1577} 1578 1579# 1580# err exitval message 1581# Display message to stderr and log to the syslog, and exit with exitval. 1582# 1583err() 1584{ 1585 exitval=$1 1586 shift 1587 1588 if [ -x /usr/bin/logger ]; then 1589 logger "$0: ERROR: $*" 1590 fi 1591 echo 1>&2 "$0: ERROR: $*" 1592 exit $exitval 1593} 1594 1595# 1596# warn message 1597# Display message to stderr and log to the syslog. 1598# 1599warn() 1600{ 1601 if [ -x /usr/bin/logger ]; then 1602 logger "$0: WARNING: $*" 1603 fi 1604 echo 1>&2 "$0: WARNING: $*" 1605} 1606 1607# 1608# info message 1609# Display informational message to stdout and log to syslog. 1610# 1611info() 1612{ 1613 case ${rc_info} in 1614 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 1615 if [ -x /usr/bin/logger ]; then 1616 logger "$0: INFO: $*" 1617 fi 1618 echo "$0: INFO: $*" 1619 ;; 1620 esac 1621} 1622 1623# 1624# debug message 1625# If debugging is enabled in rc.conf output message to stderr. 1626# BEWARE that you don't call any subroutine that itself calls this 1627# function. 1628# 1629debug() 1630{ 1631 case ${rc_debug} in 1632 [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) 1633 if [ -x /usr/bin/logger ]; then 1634 logger "$0: DEBUG: $*" 1635 fi 1636 echo 1>&2 "$0: DEBUG: $*" 1637 ;; 1638 esac 1639} 1640 1641# 1642# backup_file action file cur backup 1643# Make a backup copy of `file' into `cur', and save the previous 1644# version of `cur' as `backup'. 1645# 1646# The `action' keyword can be one of the following: 1647# 1648# add `file' is now being backed up (and is possibly 1649# being reentered into the backups system). `cur' 1650# is created. 1651# 1652# update `file' has changed and needs to be backed up. 1653# If `cur' exists, it is copied to `back' 1654# and then `file' is copied to `cur'. 1655# 1656# remove `file' is no longer being tracked by the backups 1657# system. `cur' is moved `back'. 1658# 1659# 1660backup_file() 1661{ 1662 _action=$1 1663 _file=$2 1664 _cur=$3 1665 _back=$4 1666 1667 case $_action in 1668 add|update) 1669 if [ -f $_cur ]; then 1670 cp -p $_cur $_back 1671 fi 1672 cp -p $_file $_cur 1673 chown root:wheel $_cur 1674 ;; 1675 remove) 1676 mv -f $_cur $_back 1677 ;; 1678 esac 1679} 1680 1681# make_symlink src link 1682# Make a symbolic link 'link' to src from basedir. If the 1683# directory in which link is to be created does not exist 1684# a warning will be displayed and an error will be returned. 1685# Returns 0 on success, 1 otherwise. 1686# 1687make_symlink() 1688{ 1689 local src link linkdir _me 1690 src="$1" 1691 link="$2" 1692 linkdir="`dirname $link`" 1693 _me="make_symlink()" 1694 1695 if [ -z "$src" -o -z "$link" ]; then 1696 warn "$_me: requires two arguments." 1697 return 1 1698 fi 1699 if [ ! -d "$linkdir" ]; then 1700 warn "$_me: the directory $linkdir does not exist." 1701 return 1 1702 fi 1703 if ! ln -sf $src $link; then 1704 warn "$_me: unable to make a symbolic link from $link to $src" 1705 return 1 1706 fi 1707 return 0 1708} 1709 1710# devfs_rulesets_from_file file 1711# Reads a set of devfs commands from file, and creates 1712# the specified rulesets with their rules. Returns non-zero 1713# if there was an error. 1714# 1715devfs_rulesets_from_file() 1716{ 1717 local file _err _me _opts 1718 file="$1" 1719 _me="devfs_rulesets_from_file" 1720 _err=0 1721 1722 if [ -z "$file" ]; then 1723 warn "$_me: you must specify a file" 1724 return 1 1725 fi 1726 if [ ! -e "$file" ]; then 1727 debug "$_me: no such file ($file)" 1728 return 0 1729 fi 1730 1731 # Disable globbing so that the rule patterns are not expanded 1732 # by accident with matching filesystem entries. 1733 _opts=$-; set -f 1734 1735 debug "reading rulesets from file ($file)" 1736 { while read line 1737 do 1738 case $line in 1739 \#*) 1740 continue 1741 ;; 1742 \[*\]*) 1743 rulenum=`expr "$line" : "\[.*=\([0-9]*\)\]"` 1744 if [ -z "$rulenum" ]; then 1745 warn "$_me: cannot extract rule number ($line)" 1746 _err=1 1747 break 1748 fi 1749 rulename=`expr "$line" : "\[\(.*\)=[0-9]*\]"` 1750 if [ -z "$rulename" ]; then 1751 warn "$_me: cannot extract rule name ($line)" 1752 _err=1 1753 break; 1754 fi 1755 eval $rulename=\$rulenum 1756 debug "found ruleset: $rulename=$rulenum" 1757 if ! /sbin/devfs rule -s $rulenum delset; then 1758 _err=1 1759 break 1760 fi 1761 ;; 1762 *) 1763 rulecmd="${line%%"\#*"}" 1764 # evaluate the command incase it includes 1765 # other rules 1766 if [ -n "$rulecmd" ]; then 1767 debug "adding rule ($rulecmd)" 1768 if ! eval /sbin/devfs rule -s $rulenum $rulecmd 1769 then 1770 _err=1 1771 break 1772 fi 1773 fi 1774 ;; 1775 esac 1776 if [ $_err -ne 0 ]; then 1777 debug "error in $_me" 1778 break 1779 fi 1780 done } < $file 1781 case $_opts in *f*) ;; *) set +f ;; esac 1782 return $_err 1783} 1784 1785# devfs_init_rulesets 1786# Initializes rulesets from configuration files. Returns 1787# non-zero if there was an error. 1788# 1789devfs_init_rulesets() 1790{ 1791 local file _me 1792 _me="devfs_init_rulesets" 1793 1794 # Go through this only once 1795 if [ -n "$devfs_rulesets_init" ]; then 1796 debug "$_me: devfs rulesets already initialized" 1797 return 1798 fi 1799 for file in $devfs_rulesets; do 1800 if ! devfs_rulesets_from_file $file; then 1801 warn "$_me: could not read rules from $file" 1802 return 1 1803 fi 1804 done 1805 devfs_rulesets_init=1 1806 debug "$_me: devfs rulesets initialized" 1807 return 0 1808} 1809 1810# devfs_set_ruleset ruleset [dir] 1811# Sets the default ruleset of dir to ruleset. The ruleset argument 1812# must be a ruleset name as specified in devfs.rules(5) file. 1813# Returns non-zero if it could not set it successfully. 1814# 1815devfs_set_ruleset() 1816{ 1817 local devdir rs _me 1818 [ -n "$1" ] && eval rs=\$$1 || rs= 1819 [ -n "$2" ] && devdir="-m "$2"" || devdir= 1820 _me="devfs_set_ruleset" 1821 1822 if [ -z "$rs" ]; then 1823 warn "$_me: you must specify a ruleset number" 1824 return 1 1825 fi 1826 debug "$_me: setting ruleset ($rs) on mount-point (${devdir#-m })" 1827 if ! /sbin/devfs $devdir ruleset $rs; then 1828 warn "$_me: unable to set ruleset $rs to ${devdir#-m }" 1829 return 1 1830 fi 1831 return 0 1832} 1833 1834# devfs_apply_ruleset ruleset [dir] 1835# Apply ruleset number $ruleset to the devfs mountpoint $dir. 1836# The ruleset argument must be a ruleset name as specified 1837# in a devfs.rules(5) file. Returns 0 on success or non-zero 1838# if it could not apply the ruleset. 1839# 1840devfs_apply_ruleset() 1841{ 1842 local devdir rs _me 1843 [ -n "$1" ] && eval rs=\$$1 || rs= 1844 [ -n "$2" ] && devdir="-m "$2"" || devdir= 1845 _me="devfs_apply_ruleset" 1846 1847 if [ -z "$rs" ]; then 1848 warn "$_me: you must specify a ruleset" 1849 return 1 1850 fi 1851 debug "$_me: applying ruleset ($rs) to mount-point (${devdir#-m })" 1852 if ! /sbin/devfs $devdir rule -s $rs applyset; then 1853 warn "$_me: unable to apply ruleset $rs to ${devdir#-m }" 1854 return 1 1855 fi 1856 return 0 1857} 1858 1859# devfs_domount dir [ruleset] 1860# Mount devfs on dir. If ruleset is specified it is set 1861# on the mount-point. It must also be a ruleset name as specified 1862# in a devfs.rules(5) file. Returns 0 on success. 1863# 1864devfs_domount() 1865{ 1866 local devdir rs _me 1867 devdir="$1" 1868 [ -n "$2" ] && rs=$2 || rs= 1869 _me="devfs_domount()" 1870 1871 if [ -z "$devdir" ]; then 1872 warn "$_me: you must specify a mount-point" 1873 return 1 1874 fi 1875 debug "$_me: mount-point is ($devdir), ruleset is ($rs)" 1876 if ! mount -t devfs dev "$devdir"; then 1877 warn "$_me: Unable to mount devfs on $devdir" 1878 return 1 1879 fi 1880 if [ -n "$rs" ]; then 1881 devfs_init_rulesets 1882 devfs_set_ruleset $rs $devdir 1883 devfs -m $devdir rule applyset 1884 fi 1885 return 0 1886} 1887 1888# Provide a function for normalizing the mounting of memory 1889# filesystems. This should allow the rest of the code here to remain 1890# as close as possible between 5-current and 4-stable. 1891# $1 = size 1892# $2 = mount point 1893# $3 = (optional) extra mdmfs flags 1894mount_md() 1895{ 1896 if [ -n "$3" ]; then 1897 flags="$3" 1898 fi 1899 /sbin/mdmfs $flags -s $1 ${mfs_type} $2 1900} 1901 1902# Code common to scripts that need to load a kernel module 1903# if it isn't in the kernel yet. Syntax: 1904# load_kld [-e regex] [-m module] file 1905# where -e or -m chooses the way to check if the module 1906# is already loaded: 1907# regex is egrep'd in the output from `kldstat -v', 1908# module is passed to `kldstat -m'. 1909# The default way is as though `-m file' were specified. 1910load_kld() 1911{ 1912 local _loaded _mod _opt _re 1913 1914 while getopts "e:m:" _opt; do 1915 case "$_opt" in 1916 e) _re="$OPTARG" ;; 1917 m) _mod="$OPTARG" ;; 1918 *) err 3 'USAGE: load_kld [-e regex] [-m module] file' ;; 1919 esac 1920 done 1921 shift $(($OPTIND - 1)) 1922 if [ $# -ne 1 ]; then 1923 err 3 'USAGE: load_kld [-e regex] [-m module] file' 1924 fi 1925 _mod=${_mod:-$1} 1926 _loaded=false 1927 if [ -n "$_re" ]; then 1928 if kldstat -v | egrep -q -e "$_re"; then 1929 _loaded=true 1930 fi 1931 else 1932 if kldstat -q -m "$_mod"; then 1933 _loaded=true 1934 fi 1935 fi 1936 if ! $_loaded; then 1937 if ! kldload "$1"; then 1938 warn "Unable to load kernel module $1" 1939 return 1 1940 else 1941 info "$1 kernel module loaded." 1942 fi 1943 else 1944 debug "load_kld: $1 kernel module already loaded." 1945 fi 1946 return 0 1947} 1948 1949# ltr str src dst [var] 1950# Change every $src in $str to $dst. 1951# Useful when /usr is not yet mounted and we cannot use tr(1), sed(1) nor 1952# awk(1). If var is non-NULL, set it to the result. 1953ltr() 1954{ 1955 local _str _src _dst _out _com _var 1956 _str="$1" 1957 _src="$2" 1958 _dst="$3" 1959 _var="$4" 1960 _out="" 1961 1962 local IFS="${_src}" 1963 for _com in ${_str}; do 1964 if [ -z "${_out}" ]; then 1965 _out="${_com}" 1966 else 1967 _out="${_out}${_dst}${_com}" 1968 fi 1969 done 1970 if [ -n "${_var}" ]; then 1971 setvar "${_var}" "${_out}" 1972 else 1973 echo "${_out}" 1974 fi 1975} 1976 1977# Creates a list of providers for GELI encryption. 1978geli_make_list() 1979{ 1980 local devices devices2 1981 local provider mountpoint type options rest 1982 1983 # Create list of GELI providers from fstab. 1984 while read provider mountpoint type options rest ; do 1985 case ":${options}" in 1986 :*noauto*) 1987 noauto=yes 1988 ;; 1989 *) 1990 noauto=no 1991 ;; 1992 esac 1993 1994 case ":${provider}" in 1995 :#*) 1996 continue 1997 ;; 1998 *.eli) 1999 # Skip swap devices. 2000 if [ "${type}" = "swap" -o "${options}" = "sw" -o "${noauto}" = "yes" ]; then 2001 continue 2002 fi 2003 devices="${devices} ${provider}" 2004 ;; 2005 esac 2006 done < /etc/fstab 2007 2008 # Append providers from geli_devices. 2009 devices="${devices} ${geli_devices}" 2010 2011 for provider in ${devices}; do 2012 provider=${provider%.eli} 2013 provider=${provider#/dev/} 2014 devices2="${devices2} ${provider}" 2015 done 2016 2017 echo ${devices2} 2018} 2019 2020# Originally, root mount hold had to be released before mounting 2021# the root filesystem. This delayed the boot, so it was changed 2022# to only wait if the root device isn't readily available. This 2023# can result in rc scripts executing before all the devices - such 2024# as graid(8), or USB disks - can be accessed. This function can 2025# be used to explicitly wait for root mount holds to be released. 2026root_hold_wait() 2027{ 2028 local wait waited holders 2029 2030 waited=0 2031 while true; do 2032 holders="$(sysctl -n vfs.root_mount_hold)" 2033 if [ -z "${holders}" ]; then 2034 break; 2035 fi 2036 if [ ${waited} -eq 0 ]; then 2037 echo -n "Waiting ${root_hold_delay}s" \ 2038 "for the root mount holders: ${holders}" 2039 else 2040 echo -n . 2041 fi 2042 if [ ${waited} -ge ${root_hold_delay} ]; then 2043 echo 2044 break 2045 fi 2046 sleep 1 2047 waited=$(($waited + 1)) 2048 done 2049} 2050 2051# Find scripts in local_startup directories that use the old syntax 2052# 2053find_local_scripts_old() { 2054 zlist='' 2055 slist='' 2056 for dir in ${local_startup}; do 2057 if [ -d "${dir}" ]; then 2058 for file in ${dir}/[0-9]*.sh; do 2059 grep '^# PROVIDE:' $file >/dev/null 2>&1 && 2060 continue 2061 zlist="$zlist $file" 2062 done 2063 for file in ${dir}/[!0-9]*.sh; do 2064 grep '^# PROVIDE:' $file >/dev/null 2>&1 && 2065 continue 2066 slist="$slist $file" 2067 done 2068 fi 2069 done 2070} 2071 2072find_local_scripts_new() { 2073 local_rc='' 2074 for dir in ${local_startup}; do 2075 if [ -d "${dir}" ]; then 2076 for file in `grep -l '^# PROVIDE:' ${dir}/* 2>/dev/null`; do 2077 case "$file" in 2078 *.sample) ;; 2079 *) if [ -x "$file" ]; then 2080 local_rc="${local_rc} ${file}" 2081 fi 2082 ;; 2083 esac 2084 done 2085 fi 2086 done 2087} 2088 2089# check_required_{before|after} command 2090# Check for things required by the command before and after its precmd, 2091# respectively. The two separate functions are needed because some 2092# conditions should prevent precmd from being run while other things 2093# depend on precmd having already been run. 2094# 2095check_required_before() 2096{ 2097 local _f 2098 2099 case "$1" in 2100 start) 2101 for _f in $required_vars; do 2102 if ! checkyesno $_f; then 2103 warn "\$${_f} is not enabled." 2104 if [ -z "$rc_force" ]; then 2105 return 1 2106 fi 2107 fi 2108 done 2109 2110 for _f in $required_dirs; do 2111 if [ ! -d "${_f}/." ]; then 2112 warn "${_f} is not a directory." 2113 if [ -z "$rc_force" ]; then 2114 return 1 2115 fi 2116 fi 2117 done 2118 2119 for _f in $required_files; do 2120 if [ ! -r "${_f}" ]; then 2121 warn "${_f} is not readable." 2122 if [ -z "$rc_force" ]; then 2123 return 1 2124 fi 2125 fi 2126 done 2127 ;; 2128 esac 2129 2130 return 0 2131} 2132 2133check_required_after() 2134{ 2135 local _f _args 2136 2137 case "$1" in 2138 start) 2139 for _f in $required_modules; do 2140 case "${_f}" in 2141 *~*) _args="-e ${_f#*~} ${_f%%~*}" ;; 2142 *:*) _args="-m ${_f#*:} ${_f%%:*}" ;; 2143 *) _args="${_f}" ;; 2144 esac 2145 if ! load_kld ${_args}; then 2146 if [ -z "$rc_force" ]; then 2147 return 1 2148 fi 2149 fi 2150 done 2151 ;; 2152 esac 2153 2154 return 0 2155} 2156 2157# check_jail mib 2158# Return true if security.jail.$mib exists and set to 1. 2159 2160check_jail() 2161{ 2162 local _mib _v 2163 2164 _mib=$1 2165 if _v=$(${SYSCTL_N} "security.jail.$_mib" 2> /dev/null); then 2166 case $_v in 2167 1) return 0;; 2168 esac 2169 fi 2170 return 1 2171} 2172 2173# check_kern_features mib 2174# Return existence of kern.features.* sysctl MIB as true or 2175# false. The result will be cached in $_rc_cache_kern_features_ 2176# namespace. "0" means the kern.features.X exists. 2177 2178check_kern_features() 2179{ 2180 local _v 2181 2182 [ -n "$1" ] || return 1; 2183 eval _v=\$_rc_cache_kern_features_$1 2184 [ -n "$_v" ] && return "$_v"; 2185 2186 if ${SYSCTL_N} kern.features.$1 > /dev/null 2>&1; then 2187 eval _rc_cache_kern_features_$1=0 2188 return 0 2189 else 2190 eval _rc_cache_kern_features_$1=1 2191 return 1 2192 fi 2193} 2194 2195# check_namevarlist var 2196# Return "0" if ${name}_var is reserved in rc.subr. 2197 2198_rc_namevarlist="program chroot chdir env flags fib nice user group groups prepend setup" 2199check_namevarlist() 2200{ 2201 local _v 2202 2203 for _v in $_rc_namevarlist; do 2204 case $1 in 2205 $_v) return 0 ;; 2206 esac 2207 done 2208 2209 return 1 2210} 2211 2212# _echoonce var msg mode 2213# mode=0: Echo $msg if ${$var} is empty. 2214# After doing echo, a string is set to ${$var}. 2215# 2216# mode=1: Echo $msg if ${$var} is a string with non-zero length. 2217# 2218_echoonce() 2219{ 2220 local _var _msg _mode 2221 eval _var=\$$1 2222 _msg=$2 2223 _mode=$3 2224 2225 case $_mode in 2226 1) [ -n "$_var" ] && echo "$_msg" ;; 2227 *) [ -z "$_var" ] && echo -n "$_msg" && eval "$1=finished" ;; 2228 esac 2229} 2230 2231# If the loader env variable rc.debug is set, turn on debugging. rc.conf will 2232# still override this, but /etc/defaults/rc.conf can't unconditionally set this 2233# since it would undo what we've done here. 2234if kenv -q rc.debug > /dev/null ; then 2235 rc_debug=YES 2236fi 2237 2238boottrace_cmd=`command -v boottrace` 2239if [ -n "$boottrace_cmd" ] && [ "`${SYSCTL_N} -q kern.boottrace.enabled`" = "1" ]; then 2240 rc_boottrace=YES 2241fi 2242