xref: /titanic_51/usr/src/man/man9f/kstat_install.9f (revision bbaa8b60dd95d714741fc474adad3cf710ef4efd)
te
Copyright (c) 1994, 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]
KSTAT_INSTALL 9F "May 26, 1994"
NAME
kstat_install - add a fully initialized kstat to the system
SYNOPSIS

#include <sys/types.h>
#include <sys/kstat.h>



void kstat_install(kstat_t *ksp);
INTERFACE LEVEL

Solaris DDI specific (Solaris DDI)

PARAMETERS
ksp

Pointer to a fully initialized kstat(9S) structure.

DESCRIPTION

kstat_install() is used in conjunction with kstat_create(9F) to allocate and initialize a kstat(9S) structure.

After a successful call to kstat_create() the driver must perform any necessary initialization of the data section (such as setting the name fields in a kstat of type KSTAT_TYPE_NAMED). Virtual kstats must have the ks_data field set at this time. The provider may also set the ks_update, ks_private, and ks_lock fields if necessary.

Once the kstat is completely initialized, kstat_install is used to make the kstat accessible to the outside world.

RETURN VALUES

None.

CONTEXT

kstat_install() can be called from user or kernel context.

EXAMPLES

Example 1 Allocating and Initializing a kstat Structure

The method for allocating and initializing a kstat structure is generally as follows:

kstat_t *ksp;
ksp = kstat_create(module, instance, name, class, type, ndata, flags);
if (ksp) { 
 /* ... provider initialization, if necessary */
 kstat_install(ksp);
}
SEE ALSO

kstat_create(9F), kstat_delete(9F), kstat_named_init(9F), kstat(9S)

Writing Device Drivers