xref: /illumos-gate/usr/src/man/man3picltree/picld_plugin_register.3picltree (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
te
Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PICLD_PLUGIN_REGISTER 3PICLTREE "Sep 19, 2001"
NAME
picld_plugin_register - register plug-in with the daemon
SYNOPSIS

cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>

int picld_plugin_register(picld_plugin_reg_t *regp);
DESCRIPTION

The picld_plugin_register() function is the function used by a plug-in module to register itself with the PICL daemon upon initialization. The plug-in provides its name and the entry points of the initialization and cleanup routines in the regp argument.

typedef struct {
 int version; /* PICLD_PLUGIN_VERSION */
 int critical; /* is plug-in critical? */
 char *name; /* name of the plugin module */
 void (*plugin_init)(void); /* init/reinit function */
 void (*plugin_fini)(void); /* fini/cleanup function */
} picld_plugin_reg_t;

The plug-in module also specifies whether it is a critical module for the proper system operation. The critical field in the registration information is set to PICLD_PLUGIN_NON_CRITICAL by plug-in modules that are not critical to system operation, and is set to PICLD_PLUGIN_CRITICAL by plug-in modules that are critical to the system operation. An environment control plug-in module is an example for a PICLD_PLUGIN_CRITICAL type of plug-in module.

The PICL daemon saves the information passed during registration in regp in the order in which the plug-ins registered.

Upon initialization, the PICL daemon invokes the plugin_init() routine of each of the registered plug-in modules in the order in which they registered. In their plugin_init() routines, the plug-in modules collect the platform configuration data and add it to the PICL tree using PICLTREE interfaces (3PICLTREE).

On reinitialization, the PICL daemon invokes the plugin_fini() routines of the registered plug-in modules in the reverse order of registration. Then, the plugin_init() entry points are invoked again in the order in which the plug-ins registered.

RETURN VALUES

Upon successful completion, 0 is returned. On failure, a negative value is returned.

ERRORS
PICL_NOTSUPPORTED

Version not supported

PICL_FAILURE

General system failure

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

libpicltree (3PICLTREE), attributes (7)