xref: /illumos-gate/usr/src/cmd/svc/shell/smf_include.sh (revision 2654012f83cec5dc15b61dfe3e4a4915f186e7a6)
1#!/bin/sh
2#
3# CDDL HEADER START
4#
5# The contents of this file are subject to the terms of the
6# Common Development and Distribution License (the "License").
7# You may not use this file except in compliance with the License.
8#
9# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10# or http://www.opensolaris.org/os/licensing.
11# See the License for the specific language governing permissions
12# and limitations under the License.
13#
14# When distributing Covered Code, include this CDDL HEADER in each
15# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16# If applicable, add the following below this CDDL HEADER, with the
17# fields enclosed by brackets "[]" replaced with your own identifying
18# information: Portions Copyright [yyyy] [name of copyright owner]
19#
20# CDDL HEADER END
21#
22#
23# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24# Use is subject to license terms.
25#
26
27smf_present () {
28	[ -r /etc/svc/volatile/repository_door ] && \
29	    [ ! -f /etc/svc/volatile/repository_door ]
30}
31
32smf_clear_env () {
33	unset \
34		SMF_FMRI \
35		SMF_METHOD \
36		SMF_RESTARTER \
37		SMF_ZONENAME
38}
39
40# smf_console
41#
42#   Use as "echo message 2>&1 | smf_console".  If SMF_MSGLOG_REDIRECT is
43#   unset, message will be displayed to console.  SMF_MSGLOG_REDIRECT is
44#   reserved for future use.
45#
46smf_console () {
47	/usr/bin/tee ${SMF_MSGLOG_REDIRECT:-/dev/msglog}
48}
49
50# smf_zonename
51#
52#  Prints the name of this zone.
53
54smf_zonename() {
55	echo "${SMF_ZONENAME:=`/sbin/zonename`}"
56}
57
58# smf_is_globalzone
59#
60#  Returns zero (success) if this is the global zone.  1 otherwise.
61#
62smf_is_globalzone() {
63	[ "${SMF_ZONENAME:=`/sbin/zonename`}" = "global" ] && return 0
64	return 1
65}
66
67# smf_is_nonglobalzone
68#
69#  Returns zero (success) if this is not the global zone.  1 otherwise.
70#
71smf_is_nonglobalzone() {
72	[ "${SMF_ZONENAME:=`/sbin/zonename`}" != "global" ] && return 0
73	return 1
74}
75
76# smf_configure_ip
77#
78#  Returns zero (success) if this zone needs IP to be configured i.e.
79#  the global zone or has an exclusive stack.  1 otherwise.
80#
81smf_configure_ip() {
82	[ "${SMF_ZONENAME:=`/sbin/zonename`}" = "global" -o \
83	 `/sbin/zonename -t` = exclusive ] && return 0
84	return 1
85}
86
87# smf_dont_configure_ip
88#
89#  Inverse of smf_configure_ip
90#
91smf_dont_configure_ip() {
92	[ "${SMF_ZONENAME:=`/sbin/zonename`}" != "global" -a \
93	 `/sbin/zonename -t` = shared ] && return 0
94	return 1
95}
96
97# smf_dont_configure_vt
98#
99#  Returns zero (success) if vt functionality is not to be configured,
100#  1 otherwise.
101#
102smf_dont_configure_vt() {
103	[ "${SMF_ZONENAME:=`/sbin/zonename`}" != "global" ] && return 0
104	/usr/lib/vtinfo > /dev/null 2>&1
105	return $?
106}
107
108# smf_is_system_labeled
109#
110#  Returns zero (success) if system is labeled (aka Trusted Extensions).
111#  1 otherwise.
112#
113smf_is_system_labeled() {
114	[ ! -x /bin/plabel ] && return 1
115	/bin/plabel > /dev/null 2>&1
116	return $?
117}
118
119# smf_netstrategy
120#   -> (_INIT_NET_IF, _INIT_NET_STRATEGY)
121#
122#   Sets _INIT_NET_IF to the name for the network-booted
123#   interface if we are booting from the network.  _INIT_NET_STRATEGY is
124#   assigned the value of the current network configuration strategy.
125#   Valid values for _INIT_NET_STRATEGY are "none", "dhcp", and "rarp".
126#
127#   The network boot strategy for a zone is always "none".
128#
129smf_netstrategy () {
130	if smf_is_nonglobalzone; then
131		_INIT_NET_STRATEGY="none" export _INIT_NET_STRATEGY
132		return 0
133	fi
134
135	set -- `/sbin/netstrategy`
136	if [ $? -eq 0 ]; then
137		[ "$1" = "nfs" -o "$1" = "cachefs" ] && \
138			_INIT_NET_IF="$2" export _INIT_NET_IF
139		_INIT_NET_STRATEGY="$3" export _INIT_NET_STRATEGY
140	else
141		return 1
142	fi
143}
144
145#
146# smf_kill_contract CONTRACT SIGNAL WAIT TIMEOUT
147#
148#   To be called from stop methods of non-transient services.
149#   Sends SIGNAL to the service contract CONTRACT.  If the
150#   WAIT argument is non-zero, smf_kill_contract will wait
151#   until the contract is empty before returning, or until
152#   TIMEOUT expires.
153#
154#   Example, send SIGTERM to contract 200:
155#
156#       smf_kill_contract 200 TERM
157#
158#   Since killing a contract with pkill(1) is not atomic,
159#   smf_kill_contract will continue to send SIGNAL to CONTRACT
160#   every second until the contract is empty.  This will catch
161#   races between fork(2) and pkill(1).
162#
163#   Returns 1 if the contract is invalid.
164#   Returns 2 if WAIT is "1", TIMEOUT is > 0, and TIMEOUT expires.
165#   Returns 0 on success.
166#
167smf_kill_contract() {
168
169	time_waited=0
170	time_to_wait=$4
171
172	[ -z "$time_to_wait" ] && time_to_wait=0
173
174	# Verify contract id is valid using pgrep
175	/usr/bin/pgrep -c $1 > /dev/null 2>&1
176	ret=$?
177	if [ $ret -gt 1 ] ; then
178		echo "Error, invalid contract \"$1\"" >&2
179		return 1
180	fi
181
182	# Return if contract is already empty.
183	[ $ret -eq 1 ] && return 0
184
185	# Kill contract.
186	/usr/bin/pkill -$2 -c $1
187	if [ $? -gt 1 ] ; then
188		echo "Error, could not kill contract \"$1\"" >&2
189		return 1
190	fi
191
192	# Return if WAIT is not set or is "0"
193	[ -z "$3" ] && return 0
194	[ "$3" -eq 0 ] && return 0
195
196	# If contract does not empty, keep killing the contract to catch
197	# any child processes missed because they were forking
198	/usr/bin/sleep 5
199	/usr/bin/pgrep -c $1 > /dev/null 2>&1
200	while [ $? -eq 0 ] ; do
201
202		time_waited=`/usr/bin/expr $time_waited + 5`
203
204		# Return  if TIMEOUT was passed, and it has expired
205		[ "$time_to_wait" -gt 0 -a $time_waited -ge $time_to_wait ] && \
206		    return 2
207		/usr/bin/pkill -$2 -c $1
208		/usr/bin/sleep 5
209		/usr/bin/pgrep -c $1 > /dev/null 2>&1
210	done
211
212	return 0
213}
214
215#
216# smf(5) method and monitor exit status definitions
217#   SMF_EXIT_ERR_OTHER, although not defined, encompasses all non-zero
218#   exit status values.
219#
220SMF_EXIT_OK=0
221SMF_EXIT_ERR_FATAL=95
222SMF_EXIT_ERR_CONFIG=96
223SMF_EXIT_MON_DEGRADE=97
224SMF_EXIT_MON_OFFLINE=98
225SMF_EXIT_ERR_NOSMF=99
226SMF_EXIT_ERR_PERM=100
227