|SMF_METHOD(7)||Standards, Environments, and Macros||SMF_METHOD(7)|
smf_method - service management framework conventions for methods
The class of services managed by svc.startd(8) in the service management framework, smf(7), consists of applications that fit a simple fork(2)-exec(2) model. The svc.startd(8) master daemon and other restarters support the fork(2)-exec(2) model, potentially with additional capabilities. The svc.startd(8) daemon and other restarters require that the methods which activate, manipulate, or examine a service instance follow the conventions described in this manual page.
The form of a method invocation is not dictated by convention. In some cases, a method invocation might consist of the direct invocation of the daemon or other binary executable that provides the service. For cases in which an executable script or other mediating executable is used, the convention recommends the form:
The abbr_method_name used for the recommended form is a supported method such as start or stop. The set of methods supported by a restarter is given on the related restarter page. The svc.startd(8) daemon supports start, stop, and refresh methods.
A restarter might define other kinds of methods beyond those referenced in this page. The conventions surrounding such extensions are defined by the restarter and might not be identical to those given here.
The restarter provides four environment variables to the method that determine the context in which the method is invoked.
These variables should be removed from the environment prior to the invocation of any persistent process by the method. A convenience shell function, smf_clear_env, is given for service authors who use Bourne-compatible shell scripting to compose service methods in the include file described below.
The method context can cause other environment variables to be set as described below.
A method is defined minimally by three properties in a propertygroup of type method.
These properties are:
A Method Context can be defined to further refine the execution environment of the method. See the Method Context section for more information.
When defined in the exec string of the method by the restarter svc.startd, a set of tokens are parsed and expanded with appropriate value. Other restarters might not support method tokens. The delegated restarter for inet services, inetd(8), does not support the following method expansions.
; & ( ) | ^ < > newline space tab " '
An invalid expansion constitutes method failure.
Two explicit tokens can be used in the place of method commands.
The required behavior of a start method is to delay exiting until the service instance is ready to answer requests or is otherwise functional.
The following exit status codes are defined in <libscf.h> and in the shell support file.
|SMF_EXIT_OK||0||Method exited, performing its operation successfully.|
|SMF_EXIT_NODAEMON||94||Method exited successfully but purposefully leaves no processes remaining in the contract; it should be treated as if it had a transient service model.|
|SMF_EXIT_ERR_FATAL||95||Method failed fatally and is unrecoverable without administrative intervention.|
|SMF_EXIT_ERR_CONFIG||96||Unrecoverable configuration error. A common condition that returns this exit status is the absence of required configuration files for an enabled service instance.|
|SMF_EXIT_ERR_NOSMF||99||Method has been mistakenly invoked outside the smf(7) facility. Services that depend on smf(7) capabilities should exit with this status value.|
|SMF_EXIT_ERR_PERM||100||Method requires a form of permission such as file access, privilege, authorization, or other credential that is not available when invoked.|
|SMF_EXIT_ERR_OTHER||non-zero||Any non-zero exit status from a method is treated as an unknown error. A series of unknown errors can be diagnosed as a fault by the restarter or on behalf of the restarter.|
Use of a precise exit code allows the responsible restarter to categorize an error response as likely to be intermittent and worth pursuing restart or permanent and request administrative intervention.
Each method can have an independent timeout, given in seconds. The choice of a particular timeout should be based on site expectations for detecting a method failure due to non-responsiveness. Sites with replicated filesystems or other failover resources can elect to lengthen method timeouts from the default. Sites with no remote resources can elect to shorten the timeouts. Method timeout is specified by the timeout_seconds property.
If you specify 0 timeout_seconds for a method, it declares to the restarter that there is no timeout for the service. This setting is not preferred, but is available for services that absolutely require it.
-1 timeout_seconds is also accepted, but is a deprecated specification.
A set of environment variables that define the above exit status values is provided with convenience shell functions in the file /lib/svc/share/smf_include.sh. This file is a Bourne shell script suitable for inclusion via the source operator in any Bourne-compatible shell.
To assist in the composition of scripts that can serve as SMF methods as well as /etc/init.d scripts, the smf_present() shell function is provided. If the smf(7) facility is not available, smf_present() returns a non-zero exit status.
One possible structure for such a script follows:
if smf_present; then
# Shell code to run application as managed service
# Shell code to run application as /etc/init.d script
This example shows the use of both convenience functions that are provided.
The desired method context should be provided by the service developer. All service instances should run with the lowest level of privileges possible to limit potential security compromises.
A method context can contain the following properties:
The "default" keyword specifies those flags specified in svc:/system/process-security. The "all" keyword enables all flags, the "none" keyword enables no flags. The "current" keyword specifies the current flags. Flags may be added by specifying their name (optionally preceded by '+'), and removed by preceding their name with '-').
Use of "all" has associated risks, as future versions of the system may include further flags which may harm poorly implemented software.
The method context can be set for the entire service instance by specifying a method_context property group for the service or instance. A method might override the instance method context by providing the method context properties on the method property group.
Invalid method context settings always lead to failure of the method, with the exception of invalid environment variables that issue warnings.
zonename(1), exec(2), fork(2), getdefaultproj(3PROJECT), exec_attr(5), project(5), service_bundle(5), attributes(7), privileges(7), rbac(7), security-flags(7), smf(7), smf_bootstrap(7), zones(7), coreadm(8), inetd(8), svc.startd(8), svccfg(8)
The present version of smf(7) does not support multiple repositories.
When a service is configured to be started as root but with privileges different from limit_privileges, the resulting process is privilege aware. This can be surprising to developers who expect seteuid(<non-zero UID>) to reduce privileges to basic or less.
|February 25, 2019||OmniOS|