1238438Sdteskeif [ ! "$_STARTUP_RCVAR_SUBR" ]; then _STARTUP_RCVAR_SUBR=1 2238438Sdteske# 3249751Sdteske# Copyright (c) 2006-2013 Devin Teske 4252980Sdteske# All rights reserved. 5238438Sdteske# 6238438Sdteske# Redistribution and use in source and binary forms, with or without 7238438Sdteske# modification, are permitted provided that the following conditions 8238438Sdteske# are met: 9238438Sdteske# 1. Redistributions of source code must retain the above copyright 10238438Sdteske# notice, this list of conditions and the following disclaimer. 11238438Sdteske# 2. Redistributions in binary form must reproduce the above copyright 12238438Sdteske# notice, this list of conditions and the following disclaimer in the 13238438Sdteske# documentation and/or other materials provided with the distribution. 14238438Sdteske# 15238438Sdteske# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16252987Sdteske# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17238438Sdteske# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18238438Sdteske# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19238438Sdteske# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20252987Sdteske# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21238438Sdteske# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22238438Sdteske# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23238438Sdteske# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24238438Sdteske# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25238438Sdteske# SUCH DAMAGE. 26238438Sdteske# 27238438Sdteske# $FreeBSD$ 28238438Sdteske# 29238438Sdteske############################################################ INCLUDES 30238438Sdteske 31240684SdteskeBSDCFG_SHARE="/usr/share/bsdconfig" 32240684Sdteske. $BSDCFG_SHARE/common.subr || exit 1 33244675Sdteskef_dprintf "%s: loading includes..." startup/rcvar.subr 34240684Sdteskef_include $BSDCFG_SHARE/sysrc.subr 35238438Sdteske 36238438Sdteske############################################################ CONFIGURATION 37238438Sdteske 38238438Sdteske# 39238438Sdteske# Default path to the `/etc/rc.d' directory where service(8) scripts are stored 40238438Sdteske# 41238438Sdteske: ${ETC_RC_D:=/etc/rc.d} 42238438Sdteske 43238438Sdteske# 44238438Sdteske# Default path to `/etc/rc.subr' (for find_local_scripts_new()) 45238438Sdteske# 46238438Sdteske: ${ETC_RC_SUBR:=/etc/rc.subr} 47238438Sdteske 48238438Sdteske############################################################ GLOBALS 49238438Sdteske 50238438Sdteske# 51238438Sdteske# Initialize in-memory cache variables 52238438Sdteske# 53238438SdteskeSTARTUP_RCVAR_MAP= 54238438Sdteske_STARTUP_RCVAR_MAP= 55238438Sdteske 56238438Sdteske# 57238438Sdteske# Define what an rcvar looks like 58238438Sdteske# 59238438SdteskeSTARTUP_RCVAR_REGEX='[[:alpha:]_][[:alnum:]_]*="([Yy][Ee][Ss]|[Nn][Oo])"' 60238438Sdteske 61238438Sdteske# 62238438Sdteske# Default path to on-disk cache file(s) 63238438Sdteske# 64238438SdteskeSTARTUP_RCVAR_MAP_CACHEFILE="/var/run/bsdconfig/startup_rcvar_map.cache" 65238438Sdteske 66238438Sdteske############################################################ FUNCTIONS 67238438Sdteske 68249751Sdteske# f_startup_rcvar_map [$var_to_set] 69238438Sdteske# 70238438Sdteske# Produce a map (beit from in-memory cache or on-disk cache) of rc.d scripts 71238438Sdteske# and their associated rcvar's. The map returned has the following format: 72238438Sdteske# 73238438Sdteske# rcvar default script description 74238438Sdteske# 75238438Sdteske# With each as follows: 76238438Sdteske# 77238438Sdteske# rcvar the variable used to enable this rc.d script 78238438Sdteske# default default value for this variable 79238438Sdteske# script the rc.d script in-question 80238438Sdteske# description description of the variable from rc.conf(5) defaults 81238438Sdteske# 82249751Sdteske# If $var_to_set is missing or NULL, the map is printed to standard output for 83249751Sdteske# capturing in a sub-shell (which is less-recommended because of performance 84249751Sdteske# degredation; for example, when called in a loop). 85249751Sdteske# 86238438Sdteskef_startup_rcvar_map() 87238438Sdteske{ 88259054Sdteske local __funcname=f_startup_rcvar_map 89249751Sdteske local __var_to_set="$1" 90249751Sdteske 91238438Sdteske # If the in-memory cached value is available, return it immediately 92238438Sdteske if [ "$_STARTUP_RCVAR_MAP" ]; then 93249751Sdteske if [ "$__var_to_set" ]; then 94249751Sdteske setvar "$__var_to_set" "$STARTUP_RCVAR_MAP" 95249751Sdteske else 96249751Sdteske echo "$STARTUP_RCVAR_MAP" 97249751Sdteske fi 98238438Sdteske return $SUCCESS 99238438Sdteske fi 100238438Sdteske 101238438Sdteske # 102238438Sdteske # create the in-memory cache (potentially from validated on-disk cache) 103238438Sdteske # 104238438Sdteske 105238438Sdteske # Get a list of /etc/rc.d scripts ... 106249751Sdteske local __file __rc_script_list= 107249751Sdteske for __file in "$ETC_RC_D"/*; do 108249751Sdteske [ -f "$__file" ] || continue 109249751Sdteske [ -x "$__file" ] || continue 110249751Sdteske __rc_script_list="$__rc_script_list $__file" 111238438Sdteske done 112238438Sdteske # ... and /usr/local/etc/rc.d scripts 113249751Sdteske __rc_script_list="$__rc_script_list $( 114238438Sdteske local_startup=$( f_sysrc_get local_startup ) 115238438Sdteske f_include "$ETC_RC_SUBR" 116238438Sdteske find_local_scripts_new 117238438Sdteske echo $local_rc 118238438Sdteske )" 119249751Sdteske __rc_script_list="${__rc_script_list# }" # Trim leading space 120238438Sdteske 121238438Sdteske # 122244727Sdteske # Calculate a digest given the checksums of all dependencies (scripts 123244727Sdteske # and the defaults file). This digest will be used to determine if an 124298884Spfg # on-disk global persistent cache file (containg this digest on the 125244727Sdteske # first line) is valid and can be used to quickly populate the cache 126244727Sdteske # value for immediate return. 127238438Sdteske # 128249751Sdteske local __rc_script_list_digest 129259054Sdteske __rc_script_list_digest=$( cd "$ETC_RC_D" 2> /dev/null && 130259054Sdteske cksum "$RC_DEFAULTS" $__rc_script_list 2> /dev/null | md5 ) 131238438Sdteske 132238438Sdteske # 133298884Spfg # Check to see if the global persistent cache file exists 134238438Sdteske # 135238438Sdteske if [ -f "$STARTUP_RCVAR_MAP_CACHEFILE" ]; then 136238438Sdteske # 137238438Sdteske # Attempt to populate the in-memory cache with the (soon to be) 138249751Sdteske # validated on-disk cache. If validation fails, fall-back to 139249751Sdteske # the current value and return error. 140238438Sdteske # 141238438Sdteske STARTUP_RCVAR_MAP=$( 142249751Sdteske ( # Get digest as first word on first line 143238438Sdteske read digest rest_ignored 144238438Sdteske 145238438Sdteske # 146244727Sdteske # If the stored digest matches the calculated- 147244727Sdteske # one populate the in-memory cache from the on- 148249751Sdteske # disk cache and return success. 149238438Sdteske # 150249751Sdteske if [ "$digest" = "$__rc_script_list_digest" ] 151244727Sdteske then 152238438Sdteske cat 153238438Sdteske exit $SUCCESS 154238438Sdteske else 155238438Sdteske # Otherwise, return the current value 156238438Sdteske echo "$STARTUP_RCVAR_MAP" 157238438Sdteske exit $FAILURE 158238438Sdteske fi 159238438Sdteske ) < "$STARTUP_RCVAR_MAP_CACHEFILE" 160238438Sdteske ) 161249751Sdteske local __retval=$? 162249751Sdteske export STARTUP_RCVAR_MAP # Make children faster (export cache) 163249751Sdteske if [ $__retval -eq $SUCCESS ]; then 164238438Sdteske export _STARTUP_RCVAR_MAP=1 165249751Sdteske if [ "$__var_to_set" ]; then 166249751Sdteske setvar "$__var_to_set" "$STARTUP_RCVAR_MAP" 167249751Sdteske else 168249751Sdteske echo "$STARTUP_RCVAR_MAP" 169249751Sdteske fi 170238438Sdteske return $SUCCESS 171238438Sdteske fi 172244727Sdteske # Otherwise, fall-thru to create in-memory cache from scratch 173238438Sdteske fi 174238438Sdteske 175238438Sdteske # 176238438Sdteske # If we reach this point, we need to generate the data from scratch 177298884Spfg # (and after we do, we'll attempt to create the global persistent 178238438Sdteske # cache file to speed up future executions). 179238438Sdteske # 180238438Sdteske 181238438Sdteske STARTUP_RCVAR_MAP=$( 182249751Sdteske for script in $__rc_script_list; do 183259054Sdteske rcvar_list=$( $script rcvar 2> /dev/null | awk -F= \ 184238438Sdteske -v script="$script" ' 185238438Sdteske /^'"$STARTUP_RCVAR_REGEX"'/ { 186238438Sdteske if ( $2 ~ /^"[Yy][Ee][Ss]"$/ ) 187238438Sdteske print $1 ",YES" 188238438Sdteske else 189238438Sdteske print $1 ",NO" 190238438Sdteske }' ) 191238438Sdteske for entry in $rcvar_list; do 192238438Sdteske rcvar="${entry%%,*}" 193238438Sdteske rcvar_default=$( f_sysrc_get_default "$rcvar" ) 194238438Sdteske [ "$rcvar_default" ] || 195238438Sdteske rcvar_default="${entry#*,}" 196238438Sdteske rcvar_desc=$( f_sysrc_desc "$rcvar" ) 197238438Sdteske echo $rcvar ${rcvar_default:-NO} \ 198238438Sdteske $script "$rcvar_desc" 199238438Sdteske done 200238438Sdteske done | sort -u 201238438Sdteske ) 202238438Sdteske export STARTUP_RCVAR_MAP 203238438Sdteske export _STARTUP_RCVAR_MAP=1 204249751Sdteske if [ "$__var_to_set" ]; then 205249751Sdteske setvar "$__var_to_set" "$STARTUP_RCVAR_MAP" 206249751Sdteske else 207249751Sdteske echo "$STARTUP_RCVAR_MAP" 208249751Sdteske fi 209238438Sdteske 210238438Sdteske # 211298884Spfg # Attempt to create/update the persistent global cache 212238438Sdteske # 213238438Sdteske 214238438Sdteske # Create a new temporary file to write to 215259054Sdteske local __tmpfile 216259054Sdteske f_eval_catch -dk __tmpfile $__funcname mktemp \ 217259054Sdteske 'mktemp -t "%s"' "$__tmpfile" || return $FAILURE 218238438Sdteske 219238438Sdteske # Write the temporary file contents 220249751Sdteske echo "$__rc_script_list_digest" > "$__tmpfile" 221249751Sdteske echo "$STARTUP_RCVAR_MAP" >> "$__tmpfile" 222238438Sdteske 223238438Sdteske # Finally, move the temporary file into place 224238438Sdteske case "$STARTUP_RCVAR_MAP_CACHEFILE" in 225259054Sdteske */*) f_eval_catch -d $__funcname mkdir \ 226259054Sdteske 'mkdir -p "%s"' "${STARTUP_RCVAR_MAP_CACHEFILE%/*}" 227238438Sdteske esac 228259054Sdteske f_eval_catch -d $__funcname mv \ 229259054Sdteske 'mv "%s" "%s"' "$__tmpfile" "$STARTUP_RCVAR_MAP_CACHEFILE" 230238438Sdteske} 231238438Sdteske 232244675Sdteske############################################################ MAIN 233244675Sdteske 234244675Sdteskef_dprintf "%s: Successfully loaded." startup/rcvar.subr 235244675Sdteske 236238438Sdteskefi # ! $_STARTUP_RCVAR_SUBR 237