rc.subr revision 1.112 
1#	$OpenBSD: rc.subr,v 1.112 2016/04/27 17:29:50 ajacoutot Exp $
2#
3# Copyright (c) 2010, 2011, 2014-2016 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_do() {
64	if [ -n "${_RC_DEBUG}" ]; then
65		echo "doing $@" && "$@"
66	else
67		"$@" >/dev/null 2>&1
68	fi
69}
70
71_rc_exit() {
72	local _pfix
73	[ -z "${INRC}" -o X"$1" != X"ok" ] && _pfix="($1)"
74	echo ${INRC:+'-n'} "${_pfix}"
75	[ X"$1" = X"ok" ] && exit 0 || exit 1
76}
77
78_rc_wait() {
79	local _i=0
80	while [ $_i -lt ${daemon_timeout} ]; do
81    		case "$1" in
82		reload|start)
83			_rc_do rc_check && return 0 ;;
84		stop)
85			_rc_do rc_check || return 0 ;;
86		*)
87			break ;;
88		esac
89		sleep 1
90		_i=$((_i+1))
91	done
92	return 1
93}
94
95_rc_quirks() {
96	# special care needed for spamlogd to avoid starting it up and failing
97	# all the time
98	if [  X"${spamd_flags}" = X"NO" -o X"${spamd_black}" != X"NO" ]; then
99		spamlogd_flags=NO
100	fi
101
102	# special care needed for pflogd to avoid starting it up and failing
103	# if pf is not enabled
104	if [ X"${pf}" = X"NO" ]; then
105		pflogd_flags=NO
106	fi
107
108	# special care needed if nfs_server=YES to startup nfsd and mountd with
109	# sane default flags
110	if [ X"${nfs_server}" = X"YES" ]; then
111		[ X"${nfsd_flags}" = X"NO" ] && nfsd_flags="-tun 4"
112		[ X"${mountd_flags}" = X"NO" ] && mountd_flags=
113	fi
114
115	# in case domainname is set and /var/yp/binding exists enable ypbind
116	if [ X"`domainname`" != X"" -a -d /var/yp/binding ]; then
117		ypbind_flags=
118	fi
119}
120
121_rc_parse_conf() {
122	typeset -l _key
123	local _l _rcfile _val
124	set -A _allowed_keys -- \
125		accounting amd_master check_quotas ipsec multicast nfs_server \
126		pexp pf pkg_scripts shlib_dirs spamd_black
127
128	[ $# -gt 0 ] || set -- /etc/rc.conf /etc/rc.conf.local
129	for _rcfile; do
130		[[ -f $_rcfile ]] || continue
131		while IFS=' 	' read -r _l; do
132			[[ $_l == [!#=]*=* ]] || continue
133			_key=${_l%%*([[:blank:]])=*}
134			[[ $_key == *_@(flags|rtable|user|timeout) ]] || \
135				[[ " ${_allowed_keys[*]} " == *" $_key "* ]] || \
136				continue
137			[[ $_key == "" ]] && continue
138			_val=${_l##*([!=])=*([[:blank:]])}
139			_val=${_val%%#*}
140			_val=${_val%%*([[:blank:]])}
141			# remove leading and trailing quotes (backwards compat)
142			[[ $_val == @(\"*\"|\'*\') ]] && _val=${_val#?} _val=${_val%?}
143			eval "${_key}=\${_val}"
144		done < $_rcfile
145	done
146
147	_rc_do _rc_quirks
148}
149
150# return if we only want internal functions
151[ -n "${FUNCS_ONLY}" ] && return
152
153rc_start() {
154	${rcexec} "${daemon} ${daemon_flags} ${_bg}"
155}
156
157rc_check() {
158	pgrep -T "${daemon_rtable}" -U "${daemon_user}" -q -xf "${pexp}"
159}
160
161rc_reload() {
162	pkill -T "${daemon_rtable}" -U "${daemon_user}" -HUP -xf "${pexp}"
163}
164
165rc_stop() {
166	pkill -T "${daemon_rtable}" -U "${daemon_user}" -xf "${pexp}"
167}
168
169rc_cmd() {
170	local _bg _n
171
172	[ -n "${1}" ] && echo "${_rc_actions}" | grep -qw -- ${1} || _rc_usage
173
174	[ "$(id -u)" -eq 0 ] || \
175		[ X"${rc_usercheck}" != X"NO" -a X"$1" = "Xcheck" ] || \
176		_rc_err "$0: need root privileges"
177
178	if _rc_not_supported $1; then
179		[ -n "${INRC}" ] && exit 1
180		_rc_err "$0: $1 is not supported"
181	fi
182
183	[ X"${rc_bg}" = X"YES" ] && _bg="&"
184	[ -n "${_RC_DEBUG}" ] || _n="-n"
185
186	_rc_do _rc_parse_conf ${_RC_RUNFILE}
187
188	case "$1" in
189	check)
190		echo $_n "${INRC:+ }${_name}"
191		_rc_do rc_check && _rc_exit ok
192		_rc_exit failed
193		;;
194	start)
195		if [ X"${daemon_flags}" = X"NO" ]; then
196			_rc_err "$0: need -f to force $1 since ${_name}_flags=NO"
197		fi
198		[ -z "${INRC}" ] && _rc_do rc_check && exit 0
199		echo $_n "${INRC:+ }${_name}"
200		while true; do  # no real loop, only needed to break
201			if type rc_pre >/dev/null; then
202				_rc_do rc_pre || break
203			fi
204			_rc_do rc_start || break
205			_rc_do _rc_wait start || break
206			_rc_do _rc_write_runfile
207			_rc_exit ok
208		done
209		# handle failure
210		type rc_post >/dev/null && _rc_do rc_post
211		_rc_do _rc_rm_runfile
212		_rc_exit failed
213		;;
214	stop)
215		_rc_do rc_check || exit 0
216		echo $_n "${INRC:+ }${_name}"
217		_rc_do rc_stop || _rc_exit failed
218		_rc_do _rc_wait stop || _rc_exit failed
219		if type rc_post >/dev/null; then \
220			_rc_do rc_post || _rc_exit failed
221		fi
222		_rc_do _rc_rm_runfile
223		_rc_exit ok
224		;;
225	reload)
226		echo $_n "${INRC:+ }${_name}"
227		_rc_do rc_check && _rc_do rc_reload || _rc_exit failed
228		_rc_do _rc_wait reload || _rc_exit failed
229		_rc_exit ok
230		;;
231	restart)
232		$0 ${_RC_DEBUG} ${_RC_FORCE} stop && \
233			$0 ${_RC_DEBUG} ${_RC_FORCE} start
234		;;
235	*)
236		_rc_usage
237		;;
238	esac
239}
240
241[ -n "${daemon}" ] || _rc_err "$0: daemon is not set"
242
243unset _RC_DEBUG _RC_FORCE
244while getopts "df" c; do
245	case "$c" in
246		d) _RC_DEBUG=-d;;
247		f) _RC_FORCE=-f;;
248		*) _rc_usage;;
249	esac
250done
251shift $((OPTIND-1))
252
253_name=$(basename $0)
254_RC_RUNDIR=/var/run/rc.d
255_RC_RUNFILE=${_RC_RUNDIR}/${_name}
256
257# parse /etc/rc.conf{.local} for the daemon_flags
258_rc_do _rc_parse_conf
259
260eval _rcflags=\${${_name}_flags}
261eval _rcrtable=\${${_name}_rtable}
262eval _rcuser=\${${_name}_user}
263eval _rctimeout=\${${_name}_timeout}
264
265# set default values; duplicated in rcctl(8)
266getcap -f /etc/login.conf ${_name} 1>/dev/null 2>&1 && \
267	daemon_class=${_name} || daemon_class=daemon
268[ -z "${daemon_rtable}" ] && daemon_rtable=0
269[ -z "${daemon_user}" ] && daemon_user=root
270[ -z "${daemon_timeout}" ] && daemon_timeout=30
271
272# use flags from the rc.d script if daemon is not enabled
273[ -n "${_RC_FORCE}" -o "$1" != "start" ] && [ X"${_rcflags}" = X"NO" ] && \
274	unset _rcflags
275
276[ -n "${_rcflags}" ] && daemon_flags=${_rcflags}
277[ -n "${_rcrtable}" ] && daemon_rtable=${_rcrtable}
278[ -n "${_rcuser}" ] && daemon_user=${_rcuser}
279[ -n "${_rctimeout}" ] && daemon_timeout=${_rctimeout}
280
281if [ -n "${_RC_DEBUG}" ]; then
282	echo -n "${_name}_flags "
283	[ -n "${_rcflags}" ] || echo -n "empty, using default "
284	echo ">${daemon_flags}<"
285fi
286
287readonly daemon_class
288unset _rcflags _rcrtable _rcuser _rctimeout
289pexp="${daemon}${daemon_flags:+ ${daemon_flags}}"
290rcexec="su -l -c ${daemon_class} -s /bin/sh ${daemon_user} -c"
291[ "${daemon_rtable}" -eq 0 ] || \
292	rcexec="route -T ${daemon_rtable} exec ${rcexec}"
293