xref: /illumos-gate/usr/src/cmd/svc/shell/smf_include.sh (revision d6bb6a8465e557cb946ef49d56ed3202f6218652)
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 2006 Sun Microsystems, Inc.  All rights reserved.
24# Use is subject to license terms.
25#
26#ident	"%Z%%M%	%I%	%E% SMI"
27
28smf_present () {
29	[ -r /etc/svc/volatile/repository_door ] && \
30	    [ ! -f /etc/svc/volatile/repository_door ]
31}
32
33smf_clear_env () {
34	unset \
35		SMF_FMRI \
36		SMF_METHOD \
37		SMF_RESTARTER \
38		SMF_ZONENAME
39}
40
41# smf_console
42#
43#   Use as "echo message 2>&1 | smf_console".  If SMF_MSGLOG_REDIRECT is
44#   unset, message will be displayed to console.  SMF_MSGLOG_REDIRECT is
45#   reserved for future use.
46#
47smf_console () {
48	/usr/bin/tee ${SMF_MSGLOG_REDIRECT:-/dev/msglog}
49}
50
51# smf_zonename
52#
53#  Prints the name of this zone.
54
55smf_zonename() {
56	echo "${SMF_ZONENAME:=`/sbin/zonename`}"
57}
58
59# smf_is_globalzone
60#
61#  Returns zero (success) if this is the global zone.  1 otherwise.
62#
63smf_is_globalzone() {
64	[ "${SMF_ZONENAME:=`/sbin/zonename`}" = "global" ] && return 0
65	return 1
66}
67
68# smf_is_nonglobalzone
69#
70#  Returns zero (success) if this is not the global zone.  1 otherwise.
71#
72smf_is_nonglobalzone() {
73	[ "${SMF_ZONENAME:=`/sbin/zonename`}" != "global" ] && return 0
74	return 1
75}
76
77# smf_netstrategy
78#   -> (_INIT_NET_IF, _INIT_NET_STRATEGY)
79#
80#   Sets _INIT_NET_IF to the name for the network-booted
81#   interface if we are booting from the network.  _INIT_NET_STRATEGY is
82#   assigned the value of the current network configuration strategy.
83#   Valid values for _INIT_NET_STRATEGY are "none", "dhcp", and "rarp".
84#
85#   The network boot strategy for a zone is always "none".
86#
87smf_netstrategy () {
88	if smf_is_nonglobalzone; then
89		_INIT_NET_STRATEGY="none" export _INIT_NET_STRATEGY
90		return 0
91	fi
92
93	set -- `/sbin/netstrategy`
94	if [ $? -eq 0 ]; then
95		[ "$1" = "nfs" -o "$1" = "cachefs" ] && \
96			_INIT_NET_IF="$2" export _INIT_NET_IF
97		_INIT_NET_STRATEGY="$3" export _INIT_NET_STRATEGY
98	else
99		return 1
100	fi
101}
102
103#
104# smf_kill_contract CONTRACT SIGNAL WAIT TIMEOUT
105#
106#   To be called from stop methods of non-transient services.
107#   Sends SIGNAL to the service contract CONTRACT.  If the
108#   WAIT argument is non-zero, smf_kill_contract will wait
109#   until the contract is empty before returning, or until
110#   TIMEOUT expires.
111#
112#   Example, send SIGTERM to contract 200:
113#
114#       smf_kill_contract 200 TERM
115#
116#   Since killing a contract with pkill(1) is not atomic,
117#   smf_kill_contract will continue to send SIGNAL to CONTRACT
118#   every second until the contract is empty.  This will catch
119#   races between fork(2) and pkill(1).
120#
121#   Returns 1 if the contract is invalid.
122#   Returns 2 if WAIT is "1", TIMEOUT is > 0, and TIMEOUT expires.
123#   Returns 0 on success.
124#
125smf_kill_contract() {
126
127	time_waited=0
128	time_to_wait=$4
129
130	[ -z "$time_to_wait" ] && time_to_wait=0
131
132	# Verify contract id is valid using pgrep
133	/usr/bin/pgrep -c $1 > /dev/null 2>&1
134	ret=$?
135	if [ $ret -gt 1 ] ; then
136		echo "Error, invalid contract \"$1\"" >&2
137		return 1
138	fi
139
140	# Return if contract is already empty.
141	[ $ret -eq 1 ] && return 0
142
143	# Kill contract.
144	/usr/bin/pkill -$2 -c $1
145	if [ $? -gt 1 ] ; then
146		echo "Error, could not kill contract \"$1\"" >&2
147		return 1
148	fi
149
150	# Return if WAIT is not set or is "0"
151	[ -z "$3" ] && return 0
152	[ "$3" -eq 0 ] && return 0
153
154	# If contract does not empty, keep killing the contract to catch
155	# any child processes missed because they were forking
156	/usr/bin/sleep 5
157	/usr/bin/pgrep -c $1 > /dev/null 2>&1
158	while [ $? -eq 0 ] ; do
159
160		time_waited=`/usr/bin/expr $time_waited + 5`
161
162		# Return  if TIMEOUT was passed, and it has expired
163		[ "$time_to_wait" -gt 0 -a $time_waited -ge $time_to_wait ] && \
164		    return 2
165		/usr/bin/pkill -$2 -c $1
166		/usr/bin/sleep 5
167		/usr/bin/pgrep -c $1 > /dev/null 2>&1
168	done
169
170	return 0
171}
172
173#
174# smf(5) method and monitor exit status definitions
175#   SMF_EXIT_ERR_OTHER, although not defined, encompasses all non-zero
176#   exit status values.
177#
178SMF_EXIT_OK=0
179SMF_EXIT_ERR_FATAL=95
180SMF_EXIT_ERR_CONFIG=96
181SMF_EXIT_MON_DEGRADE=97
182SMF_EXIT_MON_OFFLINE=98
183SMF_EXIT_ERR_NOSMF=99
184SMF_EXIT_ERR_PERM=100
185