usr/src/man/man1m/picld.1m

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PICLD 1M "Aug 10, 2004"
   7 .SH NAME
   8 picld \- PICL daemon
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/picl/picld\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The Platform Information and Control Library (\fBPICL\fR) provides a mechanism
  19 to publish platform-specific information for clients to access in a
  20 platform-independent way. \fBpicld\fR maintains and controls access to the
  21 \fBPICL\fR information from clients and plug-in modules. The daemon is started
  22 in both single-user and multi-user boot mode.
  23 .sp
  24 .LP
  25 Upon startup, the \fBPICL\fR daemon loads and initializes the plug-in modules.
  26 These modules use the \fBlibpicltree\fR(3PICLTREE) interface to create nodes
  27 and properties in the \fBPICL\fR tree to publish platform configuration
  28 information. After the plug-in modules are initialized, the daemon opens the
  29 \fBPICL\fR daemon door to service client requests to access information in the
  30 \fBPICL\fR tree.
  31 .SS "PICL Tree"
  32 .sp
  33 .LP
  34 The \fBPICL\fR tree is the repository of all the nodes and properties created
  35 by the plug-in modules to represent the platform configuration. Every node in
  36 the \fBPICL\fR tree is an instance of a well-defined \fBPICL\fR class. The name
  37 of the base \fBPICL\fR class is \fBpicl\fR, which defines a basic set of
  38 properties that all nodes in the tree must possess. Two of those properties are
  39 \fBname\fR and \fB_class\fR, where \fBname\fR contains the name of the node,
  40 and the \fB_class\fR contains the \fBPICL\fR class name of the node. Certain
  41 nodes in the \fBPICL\fR tree have well-known names. For example, the name of
  42 the root node of the \fBPICL\fR tree is \fB/\fR and the name of the root node
  43 of the sub-tree containing platform device nodes is \fBplatform\fR.
  44 .SS "PICL plug-in Modules"
  45 .sp
  46 .LP
  47 The \fBPICL\fR plug-in modules are shared objects that publish
  48 platform-specific data in the \fBPICL\fR tree. They are located in well-known
  49 directories so that the daemon can locate and load them.
  50 .sp
  51 .LP
  52 Plug-in modules are located in one of the following plug-in directories
  53 depending on the plaform-specific nature of the data that they collect and
  54 publish:
  55 .sp
  56 .in +2
  57 .nf
  58 /usr/platform/`uname -i`/lib/picl/plugins
  59 /usr/platform/`uname -m`/lib/picl/plugins
  60 .fi
  61 .in -2
  62 .sp
  63
  64 .sp
  65 .LP
  66 A plug-in module can specify its dependency on another plug-in module using the
  67 \fB-l\fR or \fB-R\fR linker option. The plug-ins are loaded by the daemon using
  68 \fBdlopen\fR(3C) according to the specified dependencies. Each plug-in module
  69 must define a \fB\&.init\fR section, which is executed when the plug-in module
  70 is loaded, to register themselves with the daemon. See
  71 \fBpicld_plugin_register\fR(3PICLTREE) for additional information on plug-in
  72 registration.
  73 .sp
  74 .LP
  75 The plug-in modules use the \fBlibpicltree\fR(3PICLTREE) interface to publish
  76 nodes and properties in the \fBPICL\fR tree so that clients can access them.
  77 .sp
  78 .LP
  79 When the \fBPICL\fR daemon invokes the initialization routine of the plug-in
  80 module, the plug-in collects the platform information and creates nodes and/or
  81 properties to represent the configuration in the \fBPICL\fR tree. A plug-in can
  82 create additional threads to monitor the platform configuration and update the
  83 \fBPICL\fR tree with any changes. This enables a \fBPICL\fR plug-in to operate
  84 as a daemon within the \fBPICL\fR framework.
  85 .sp
  86 .LP
  87 An environmental monitor is an example of a plug-in module that uses a thread
  88 to monitor the temperatures and fan speeds of the platform, then publishes the
  89 environmental information in the \fBPICL\fR tree so clients can access them.
  90 .sp
  91 .LP
  92 Clients use the \fBlibpicl\fR(3PICL) interface to send requests to \fBpicld\fR
  93 for accessing the \fBPICL\fR tree.
  94 .SH EXIT STATUS
  95 .sp
  96 .LP
  97 \fBpicld\fR does not return an exit status.
  98 .SH FILES
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fB/var/run/picld_door\fR\fR
 103 .ad
 104 .RS 23n
 105 \fBPICL\fR daemon door
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fB/usr/lib/picl/picld\fR\fR
 112 .ad
 113 .RS 23n
 114 \fBPICL\fR daemon
 115 .RE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBsvcs\fR(1), \fBsvcadm\fR(1M), \fBdlopen\fR(3C), \fBlibpicl\fR(3PICL),
 121 \fBlibpicltree\fR(3PICLTREE), \fBpicld_log\fR(3PICLTREE),
 122 \fBpicld_plugin_register\fR(3PICLTREE), \fBattributes\fR(5), \fBsmf\fR(5)
 123 .SH NOTES
 124 .sp
 125 .LP
 126 The \fBpicld\fR service is managed by the service management facility,
 127 \fBsmf\fR(5), under the service identifier:
 128 .sp
 129 .in +2
 130 .nf
 131 svc:/system/picl
 132 .fi
 133 .in -2
 134 .sp
 135
 136 .sp
 137 .LP
 138 Administrative actions on this service, such as enabling, disabling, or
 139 requesting restart, can be performed using \fBsvcadm\fR(1M). The service's
 140 status can be queried using the \fBsvcs\fR(1) command.