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