rc.subr revision 1.129 
1#	$OpenBSD: rc.subr,v 1.129 2018/10/29 07:55:40 ajacoutot Exp $
2#
3# Copyright (c) 2010, 2011, 2014-2017 Antoine Jacoutot <ajacoutot@openbsd.org>
4# Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
5# Copyright (c) 2010, 2011, 2014 Robert Nagy <robert@openbsd.org>
6#
7# Permission to use, copy, modify, and distribute this software for any
8# purpose with or without fee is hereby granted, provided that the above
9# copyright notice and this permission notice appear in all copies.
10#
11# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18
19_rc_actions="start stop restart reload check"
20readonly _rc_actions
21
22_rc_err() {
23	[ -n "${1}" ] && echo "${1}" 1>&2
24	[ -n "${2}" ] && exit "${2}" || exit 1
25}
26
27_rc_not_supported() {
28	local _a _enotsup _what=${1}
29	for _a in ${_rc_actions}; do
30		[ "${_what}" == "restart" ] && _what="stop"
31		if [ "${_what}" == "${_a}" ]; then
32			eval _enotsup=\${rc_${_what}}
33			break
34		fi
35	done
36	[ X"${_enotsup}" == X"NO" ]
37}
38
39_rc_usage() {
40	local _a _allsup
41	for _a in ${_rc_actions}; do
42		_rc_not_supported ${_a} || _allsup="${_allsup:+$_allsup|}${_a}"
43	done
44	_rc_err "usage: $0 [-df] ${_allsup}"
45}
46
47_rc_write_runfile() {
48	[ -d ${_RC_RUNDIR} ] || mkdir -p ${_RC_RUNDIR} &&
49		cat >${_RC_RUNFILE} <<EOF
50daemon_class=${daemon_class}
51daemon_flags=${daemon_flags}
52daemon_rtable=${daemon_rtable}
53daemon_timeout=${daemon_timeout}
54daemon_user=${daemon_user}
55pexp=${pexp}
56EOF
57}
58
59_rc_rm_runfile() {
60	rm -f ${_RC_RUNFILE}
61}
62
63_rc_check_name() {
64	[[ $1 == +([_[:alpha:]])+(|[_[:alnum:]]) ]]
65}
66
67_rc_do() {
68	if [ -n "${_RC_DEBUG}" ]; then
69		echo "doing $@" && "$@"
70	else
71		"$@" >/dev/null 2>&1
72	fi
73}
74
75_rc_exit() {
76	local _pfix
77	[ -z "${INRC}" -o X"$1" != X"ok" ] && _pfix="($1)"
78	echo ${INRC:+'-n'} "${_pfix}"
79	[ X"$1" = X"ok" ] && exit 0 || exit 1
80}
81
82_rc_alarm()
83{
84	trap - ALRM
85	kill -ALRM ${_TIMERSUB} 2>/dev/null # timer may not be running anymore
86	kill $! 2>/dev/null # kill last job if it's running
87}
88
89_rc_wait() {
90	local _i=0
91	if [ X"$1" = X"start" ]; then # prevent hanging the boot sequence
92		trap "_rc_alarm" ALRM
93		while [ $_i -lt ${daemon_timeout} ]; do
94			if _rc_do rc_check; then
95				[ X"${rc_bg}" = X"YES" ] || [ -z "$$" ] && break
96			fi
97			sleep 1
98			_i=$((_i+1))
99		done & wait
100		pkill -ALRM -P $$
101		return
102	fi
103	while [ $_i -lt ${daemon_timeout} ]; do
104		case "$1" in
105		reload)
106			_rc_do rc_check && return 0 ;;
107		stop)
108			_rc_do rc_check || return 0 ;;
109		*)
110			break ;;
111		esac
112		sleep 1
113		_i=$((_i+1))
114	done
115	return 1
116}
117
118_rc_quirks() {
119	# special care needed for spamlogd to avoid starting it up and failing
120	# all the time
121	if [ X"${spamd_flags}" = X"NO" -o X"${spamd_black}" != X"NO" ]; then
122		spamlogd_flags=NO
123	fi
124
125	# special care needed for pflogd to avoid starting it up and failing
126	# if pf is not enabled
127	if [ X"${pf}" = X"NO" ]; then
128		pflogd_flags=NO
129	fi
130
131	# special care needed if nfs_server=YES to startup nfsd and mountd with
132	# sane default flags
133	if [ X"${nfs_server}" = X"YES" ]; then
134		[ X"${nfsd_flags}" = X"NO" ] && nfsd_flags="-tun 4"
135		[ X"${mountd_flags}" = X"NO" ] && mountd_flags=
136	fi
137}
138
139_rc_parse_conf() {
140	typeset -l _key
141	local _l _rcfile _val
142	set -A _allowed_keys -- \
143		accounting amd_master check_quotas ipsec library_aslr \
144		multicast nfs_server pexp pf pkg_scripts shlib_dirs spamd_black
145
146	[ $# -gt 0 ] || set -- /etc/rc.conf /etc/rc.conf.local
147	for _rcfile; do
148		[[ -f $_rcfile ]] || continue
149		while IFS=' 	' read -r _l; do
150			[[ $_l == [!#=]*=* ]] || continue
151			_key=${_l%%*([[:blank:]])=*}
152			[[ $_key == *_@(flags|rtable|user|timeout) ]] ||
153				[[ " ${_allowed_keys[*]} " == *" $_key "* ]] ||
154				continue
155			[[ $_key == "" ]] && continue
156			_val=${_l##*([!=])=*([[:blank:]])}
157			_val=${_val%%#*}
158			_val=${_val%%*([[:blank:]])}
159			# remove leading and trailing quotes (backwards compat)
160			[[ $_val == @(\"*\"|\'*\') ]] &&
161				_val=${_val#?} _val=${_val%?}
162			eval "${_key}=\${_val}"
163		done < $_rcfile
164	done
165
166	_rc_do _rc_quirks
167}
168
169# return if we only want internal functions
170[ -n "${FUNCS_ONLY}" ] && return
171
172rc_start() {
173	${rcexec} "${daemon} ${daemon_flags}"
174}
175
176rc_check() {
177	pgrep -T "${daemon_rtable}" -q -xf "${pexp}"
178}
179
180rc_reload() {
181	pkill -HUP -T "${daemon_rtable}" -xf "${pexp}"
182}
183
184rc_stop() {
185	pkill -T "${daemon_rtable}" -xf "${pexp}"
186}
187
188rc_cmd() {
189	local _to _n _ret
190
191	[ -n "${1}" ] && echo "${_rc_actions}" | grep -qw -- ${1} || _rc_usage
192
193	[ "$(id -u)" -eq 0 ] ||
194		[ X"${rc_usercheck}" != X"NO" -a X"$1" = "Xcheck" ] ||
195		_rc_err "$0: need root privileges"
196
197	if _rc_not_supported $1; then
198		[ -n "${INRC}" ] && exit 1
199		_rc_err "$0: $1 is not supported"
200	fi
201
202	[ -n "${_RC_DEBUG}" ] || _n="-n"
203
204	_rc_do _rc_parse_conf ${_RC_RUNFILE}
205
206	case "$1" in
207	check)
208		echo $_n "${INRC:+ }${_name}"
209		_rc_do rc_check && _rc_exit ok
210		_rc_exit failed
211		;;
212	start)
213		if [ X"${daemon_flags}" = X"NO" ]; then
214			_rc_err "$0: need -f to force $1 since ${_name}_flags=NO"
215		fi
216		[ -z "${INRC}" ] && _rc_do rc_check && exit 0
217		echo $_n "${INRC:+ }${_name}"
218		while true; do # no real loop, only needed to break
219			if type rc_pre >/dev/null; then
220				_rc_do rc_pre || break
221			fi
222			_rc_do _rc_wait start & _TIMERSUB=$!
223			trap "_rc_alarm" ALRM
224			_rc_do rc_start; _ret=$?
225			kill -ALRM ${_TIMERSUB}
226			wait ${_TIMERSUB} 2>/dev/null # don't print Alarm clock
227			[[ "${_ret}" == 142 ]] && [ X"${rc_bg}" != X"YES" ] &&
228				_to="timeout"
229			# XXX for unknown reason, rc_check can fail (e.g. redis)
230			# while it just succeeded in _rc_wait; the check is
231			# needed to cope with failing daemons returning 0
232			#[[ "${_ret}" == @(0|142) ]] && _rc_do rc_check || break
233			[[ "${_ret}" == @(0|142) ]] || break
234			_rc_do _rc_write_runfile
235			_rc_exit ${_to:=ok}
236		done
237		# handle failure
238		type rc_post >/dev/null && _rc_do rc_post
239		_rc_do _rc_rm_runfile
240		_rc_exit failed
241		;;
242	stop)
243		_rc_do rc_check || exit 0
244		echo $_n "${INRC:+ }${_name}"
245		_rc_do rc_stop || _rc_exit failed
246		_rc_do _rc_wait stop || _rc_exit failed
247		if type rc_post >/dev/null; then
248			_rc_do rc_post || _rc_exit failed
249		fi
250		_rc_do _rc_rm_runfile
251		_rc_exit ok
252		;;
253	reload)
254		echo $_n "${INRC:+ }${_name}"
255		_rc_do rc_check && _rc_do rc_reload || _rc_exit failed
256		_rc_do _rc_wait reload || _rc_exit failed
257		_rc_exit ok
258		;;
259	restart)
260		$0 ${_RC_DEBUG} ${_RC_FORCE} stop &&
261			$0 ${_RC_DEBUG} ${_RC_FORCE} start
262		;;
263	*)
264		_rc_usage
265		;;
266	esac
267}
268
269_name=$(basename $0)
270_rc_check_name "${_name}" || _rc_err "invalid rc.d script name: ${_name}"
271
272[ -n "${daemon}" ] || _rc_err "$0: daemon is not set"
273
274unset _RC_DEBUG _RC_FORCE
275while getopts "df" c; do
276	case "$c" in
277		d) _RC_DEBUG=-d;;
278		f) _RC_FORCE=-f;;
279		*) _rc_usage;;
280	esac
281done
282shift $((OPTIND-1))
283
284_RC_RUNDIR=/var/run/rc.d
285_RC_RUNFILE=${_RC_RUNDIR}/${_name}
286
287# parse /etc/rc.conf{.local} for the daemon_flags
288_rc_do _rc_parse_conf
289
290eval _rcflags=\${${_name}_flags}
291eval _rcrtable=\${${_name}_rtable}
292eval _rcuser=\${${_name}_user}
293eval _rctimeout=\${${_name}_timeout}
294
295# set default values; duplicated in rcctl(8)
296getcap -f /etc/login.conf ${_name} 1>/dev/null 2>&1 && daemon_class=${_name} ||
297	daemon_class=daemon
298[ -z "${daemon_rtable}" ] && daemon_rtable=0
299[ -z "${daemon_user}" ] && daemon_user=root
300[ -z "${daemon_timeout}" ] && daemon_timeout=30
301
302# use flags from the rc.d script if daemon is not enabled
303[ -n "${_RC_FORCE}" -o "$1" != "start" ] && [ X"${_rcflags}" = X"NO" ] &&
304	unset _rcflags
305
306[ -n "${_rcflags}" ] && daemon_flags=${_rcflags}
307[ -n "${_rcrtable}" ] && daemon_rtable=${_rcrtable}
308[ -n "${_rcuser}" ] && daemon_user=${_rcuser}
309[ -n "${_rctimeout}" ] && daemon_timeout=${_rctimeout}
310
311if [ -n "${_RC_DEBUG}" ]; then
312	echo -n "${_name}_flags "
313	[ -n "${_rcflags}" ] || echo -n "empty, using default "
314	echo ">${daemon_flags}<"
315fi
316
317readonly daemon_class
318unset _rcflags _rcrtable _rcuser _rctimeout
319pexp="${daemon}${daemon_flags:+ ${daemon_flags}}"
320rcexec="su -l -c ${daemon_class} -s /bin/sh ${daemon_user} -c"
321[ "${daemon_rtable}" -eq 0 ] ||
322	rcexec="route -T ${daemon_rtable} exec ${rcexec}"
323