Print this page
10451 smf_method(5) man page needs updates after 7928
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man5/smf_method.5.man.txt
+++ new/usr/src/man/man5/smf_method.5.man.txt
1 1 SMF_METHOD(5) Standards, Environments, and Macros SMF_METHOD(5)
2 2
3 3
4 4
5 5 NAME
6 6 smf_method - service management framework conventions for methods
7 7
8 8 DESCRIPTION
9 9 The class of services managed by svc.startd(1M) in the service
10 10 management framework, smf(5), consists of applications that fit a
11 11 simple fork(2)-exec(2) model. The svc.startd(1M) master daemon and
12 12 other restarters support the fork(2)-exec(2) model, potentially with
13 13 additional capabilities. The svc.startd(1M) daemon and other restarters
14 14 require that the methods which activate, manipulate, or examine a
15 15 service instance follow the conventions described in this manual page.
16 16
17 17 Invocation form
18 18 The form of a method invocation is not dictated by convention. In some
19 19 cases, a method invocation might consist of the direct invocation of
20 20 the daemon or other binary executable that provides the service. For
21 21 cases in which an executable script or other mediating executable is
22 22 used, the convention recommends the form:
23 23
24 24 /path/to/method_executable abbr_method_name
25 25
26 26
27 27
28 28 The abbr_method_name used for the recommended form is a supported
29 29 method such as start or stop. The set of methods supported by a
30 30 restarter is given on the related restarter page. The svc.startd(1M)
31 31 daemon supports start, stop, and refresh methods.
32 32
33 33
34 34 A restarter might define other kinds of methods beyond those referenced
35 35 in this page. The conventions surrounding such extensions are defined
36 36 by the restarter and might not be identical to those given here.
37 37
38 38 Environment Variables
39 39 The restarter provides four environment variables to the method that
40 40 determine the context in which the method is invoked.
41 41
42 42 SMF_FMRI
43 43
44 44 The service fault management resource identifier (FMRI) of the
45 45 instance for which the method is invoked.
46 46
47 47
48 48 SMF_METHOD
49 49
50 50 The full name of the method being invoked, such as start or stop.
51 51
52 52
53 53 SMF_RESTARTER
54 54
55 55 The service FMRI of the restarter that invokes the method
56 56
57 57
58 58 SMF_ZONENAME
59 59
60 60 The name of the zone in which the method is running. This can also
61 61 be obtained by using the zonename(1) command.
62 62
63 63
64 64
65 65 These variables should be removed from the environment prior to the
66 66 invocation of any persistent process by the method. A convenience shell
67 67 function, smf_clear_env, is given for service authors who use Bourne-
68 68 compatible shell scripting to compose service methods in the include
69 69 file described below.
70 70
71 71
72 72 The method context can cause other environment variables to be set as
73 73 described below.
74 74
75 75 Method Definition
76 76 A method is defined minimally by three properties in a propertygroup of
77 77 type method.
78 78
79 79
80 80 These properties are:
81 81
82 82 exec (astring)
83 83 Method executable string.
84 84
85 85
86 86 timeout_seconds (count)
87 87 Number of seconds before method times out.
88 88 See the Timeouts section for more detail.
89 89
90 90
91 91 type (astring)
92 92 Method type. Currently always set to method.
93 93
94 94
95 95
96 96 A Method Context can be defined to further refine the execution
97 97 environment of the method. See the Method Context section for more
98 98 information.
99 99
100 100 Method Tokens
101 101 When defined in the exec string of the method by the restarter
102 102 svc.startd, a set of tokens are parsed and expanded with appropriate
103 103 value. Other restarters might not support method tokens. The delegated
104 104 restarter for inet services, inetd(1M), does not support the following
105 105 method expansions.
106 106
107 107 %%
108 108
109 109 %
110 110
111 111
112 112 %r
113 113
114 114 Name of the restarter, such as svc.startd
115 115
116 116
117 117 %m
118 118
119 119 The full name of the method being invoked, such as start or stop.
120 120
121 121
122 122 %s
123 123
124 124 Name of the service
125 125
126 126
127 127 %i
128 128
129 129 Name of the instance
130 130
131 131
132 132 %f
133 133
134 134 FMRI of the instance
135 135
136 136
137 137 %{prop[:,]}
138 138
139 139 Value(s) of a property. The prop might be a property FMRI, a
140 140 property group name and a property name separated by a /, or a
141 141 property name in the application property group. These values can
142 142 be followed by a , (comma) or : (colon). If present, the separators
143 143 are used to separate multiple values. If absent, a space is used.
144 144 The following shell metacharacters encountered in string values are
145 145 quoted with a (backslash):
146 146
147 147 ; & ( ) | ^ < > newline space tab " '
148 148
149 149 An invalid expansion constitutes method failure.
150 150
151 151
152 152
153 153 Two explicit tokens can be used in the place of method commands.
154 154
155 155 :kill [-signal]
156 156
157 157 Sends the specified signal, which is SIGTERM by default, to all
158 158 processes in the primary instance contract. Always returns
159 159 SMF_EXIT_OK. This token should be used to replace common pkill
160 160 invocations.
161 161
162 162
163 163 :true
164 164
165 165 Always returns SMF_EXIT_OK. This token should be used for methods
166 166 that are required by the restarter but which are unnecessary for
167 167 the particular service implementation.
168 168
169 169
170 170 Exiting and Exit Status
171 171 The required behavior of a start method is to delay exiting until the
172 172 service instance is ready to answer requests or is otherwise
173 173 functional.
174 174
175 175
|
↓ open down ↓ |
175 lines elided |
↑ open up ↑ |
176 176 The following exit status codes are defined in <libscf.h> and in the
177 177 shell support file.
178 178
179 179
180 180
181 181
182 182 SMF_EXIT_OK 0 Method exited,
183 183 performing its
184 184 operation
185 185 successfully.
186 + SMF_EXIT_NODAEMON 94 Method exited
187 + successfully but
188 + purposefully leaves
189 + no processes
190 + remaining in the
191 + contract; it should
192 + be treated as if it
193 + had a transient
194 + service model.
186 195 SMF_EXIT_ERR_FATAL 95 Method failed
187 196 fatally and is
188 197 unrecoverable
189 198 without
190 199 administrative
191 200 intervention.
192 201 SMF_EXIT_ERR_CONFIG 96 Unrecoverable
193 202 configuration
194 203 error. A common
195 204 condition that
196 205 returns this exit
197 206 status is the
198 207 absence of required
199 208 configuration files
200 209 for an enabled
201 210 service instance.
202 211 SMF_EXIT_ERR_NOSMF 99 Method has been
203 212 mistakenly invoked
204 213 outside the smf(5)
205 214 facility. Services
206 215 that depend on
207 216 smf(5) capabilities
208 217 should exit with
209 218 this status value.
210 219 SMF_EXIT_ERR_PERM 100 Method requires a
211 220 form of permission
212 221 such as file
213 222 access, privilege,
214 223 authorization, or
215 224 other credential
216 225 that is not
217 226 available when
218 227 invoked.
219 228 SMF_EXIT_ERR_OTHER non-zero Any non-zero exit
220 229 status from a
221 230 method is treated
222 231 as an unknown
223 232 error. A series of
224 233 unknown errors can
225 234 be diagnosed as a
226 235 fault by the
227 236 restarter or on
228 237 behalf of the
229 238 restarter.
230 239
231 240
232 241
233 242 Use of a precise exit code allows the responsible restarter to
234 243 categorize an error response as likely to be intermittent and worth
235 244 pursuing restart or permanent and request administrative intervention.
236 245
237 246 Timeouts
238 247 Each method can have an independent timeout, given in seconds. The
239 248 choice of a particular timeout should be based on site expectations for
240 249 detecting a method failure due to non-responsiveness. Sites with
241 250 replicated filesystems or other failover resources can elect to
242 251 lengthen method timeouts from the default. Sites with no remote
243 252 resources can elect to shorten the timeouts. Method timeout is
244 253 specified by the timeout_seconds property.
245 254
246 255
247 256 If you specify 0 timeout_seconds for a method, it declares to the
248 257 restarter that there is no timeout for the service. This setting is not
249 258 preferred, but is available for services that absolutely require it.
250 259
251 260
252 261 -1 timeout_seconds is also accepted, but is a deprecated specification.
253 262
254 263 Shell Programming Support
255 264 A set of environment variables that define the above exit status values
256 265 is provided with convenience shell functions in the file
257 266 /lib/svc/share/smf_include.sh. This file is a Bourne shell script
258 267 suitable for inclusion via the source operator in any Bourne-compatible
259 268 shell.
260 269
261 270
262 271 To assist in the composition of scripts that can serve as SMF methods
263 272 as well as /etc/init.d scripts, the smf_present() shell function is
264 273 provided. If the smf(5) facility is not available, smf_present()
265 274 returns a non-zero exit status.
266 275
267 276
268 277 One possible structure for such a script follows:
269 278
270 279 if smf_present; then
271 280 # Shell code to run application as managed service
272 281 ....
273 282
274 283 smf_clear_env
275 284 else
276 285 # Shell code to run application as /etc/init.d script
277 286 ....
278 287 fi
279 288
280 289
281 290
282 291 This example shows the use of both convenience functions that are
283 292 provided.
284 293
285 294 Method Context
286 295 The service management facility offers a common mechanism set the
287 296 context in which the fork(2)-exec(2) model services execute.
288 297
289 298
290 299 The desired method context should be provided by the service developer.
291 300 All service instances should run with the lowest level of privileges
292 301 possible to limit potential security compromises.
293 302
294 303
295 304 A method context can contain the following properties:
296 305
297 306 use_profile
298 307
299 308 A boolean that specifies whether the profile should be used instead
300 309 of the user, group, privileges, and limit_privileges properties.
301 310
302 311
303 312 environment
304 313
305 314 Environment variables to insert into the environment of the method,
306 315 in the form of a number of NAME=value strings.
307 316
308 317
309 318 profile
310 319
311 320 The name of an RBAC (role-based access control) profile which,
312 321 along with the method executable, identifies an entry in
313 322 exec_attr(4).
314 323
315 324
316 325 user
317 326
318 327 The user ID in numeric or text form.
319 328
320 329
321 330 group
322 331
323 332 The group ID in numeric or text form.
324 333
325 334
326 335 supp_groups
327 336
328 337 An optional string that specifies the supplemental group
329 338 memberships by ID, in numeric or text form.
330 339
331 340
332 341 privileges
333 342
334 343 An optional string specifying the privilege set as defined in
335 344 privileges(5).
336 345
337 346
338 347 limit_privileges
339 348
340 349 An optional string specifying the limit privilege set as defined in
341 350 privileges(5).
342 351
343 352
344 353 working_directory
345 354
346 355 The home directory from which to launch the method. :home can be
347 356 used as a token to indicate the home directory of the user whose
348 357 uid is used to launch the method. If the property is unset, :home
349 358 is used.
350 359
351 360
352 361 security_flags
353 362
354 363 The security flags to apply when launching the method. See
355 364 security-flags(5).
356 365
357 366
358 367 The "default" keyword specifies those flags specified in
359 368 svc:/system/process-security. The "all" keyword enables all flags,
360 369 the "none" keyword enables no flags. The "current" keyword
361 370 specifies the current flags. Flags may be added by specifying
362 371 their name (optionally preceded by '+'), and removed by preceding
363 372 their name with '-').
364 373
365 374
366 375 Use of "all" has associated risks, as future versions of the system
367 376 may include further flags which may harm poorly implemented
368 377 software.
369 378
370 379
371 380 corefile_pattern
372 381
373 382 An optional string that specifies the corefile pattern to use for
374 383 the service, as per coreadm(1M). Most restarters supply a default.
375 384 Setting this property overrides local customizations to the global
376 385 core pattern.
377 386
378 387
379 388 project
380 389
381 390 The project ID in numeric or text form. :default can be used as a
382 391 token to indicate a project identified by getdefaultproj(3PROJECT)
383 392 for the user whose uid is used to launch the method.
384 393
385 394
386 395 resource_pool
387 396
388 397 The resource pool name on which to launch the method. :default can
389 398 be used as a token to indicate the pool specified in the project(4)
390 399 entry given in the project attribute above.
391 400
392 401
393 402
394 403 The method context can be set for the entire service instance by
395 404 specifying a method_context property group for the service or instance.
396 405 A method might override the instance method context by providing the
397 406 method context properties on the method property group.
398 407
399 408
400 409 Invalid method context settings always lead to failure of the method,
401 410 with the exception of invalid environment variables that issue
402 411 warnings.
403 412
404 413
405 414 In addition to the context defined above, many fork(2)-exec(2) model
406 415 restarters also use the following conventions when invoking executables
407 416 as methods:
408 417
409 418 Argument array
410 419
411 420 The arguments in argv[] are set consistently with the result
412 421 /bin/sh -c of the exec string.
413 422
414 423
415 424 File descriptors
416 425
417 426 File descriptor 0 is /dev/null. File descriptors 1 and 2 are
418 427 recommended to be a per-service log file.
419 428
420 429
421 430 FILES
422 431 /lib/svc/share/smf_include.sh
423 432
424 433 Definitions of exit status values.
425 434
426 435
427 436 /usr/include/libscf.h
428 437
429 438 Definitions of exit status codes.
430 439
431 440
432 441 SEE ALSO
433 442 zonename(1), coreadm(1M), inetd(1M), svccfg(1M), svc.startd(1M),
434 443 exec(2), fork(2), getdefaultproj(3PROJECT), exec_attr(4), project(4),
435 444 service_bundle(4), attributes(5), privileges(5), rbac(5), smf(5),
436 445 smf_bootstrap(5), zones(5), security-flags(5)
437 446
438 447 NOTES
|
↓ open down ↓ |
243 lines elided |
↑ open up ↑ |
439 448 The present version of smf(5) does not support multiple repositories.
440 449
441 450
442 451 When a service is configured to be started as root but with privileges
443 452 different from limit_privileges, the resulting process is privilege
444 453 aware. This can be surprising to developers who expect seteuid(<non-
445 454 zero UID>) to reduce privileges to basic or less.
446 455
447 456
448 457
449 - June 6, 2016 SMF_METHOD(5)
458 + February 25, 2019 SMF_METHOD(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX