'\" 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]
.TH KSTAT_INSTALL 9F "May 26, 1994"
.SH NAME
kstat_install \- add a fully initialized kstat to the system
.SH SYNOPSIS
.nf
#include <sys/types.h>
#include <sys/kstat.h>



\fBvoid\fR \fBkstat_install\fR(\fBkstat_t *\fR\fIksp\fR);
.fi

.SH INTERFACE LEVEL
illumos DDI specific (illumos DDI)
.SH PARAMETERS
.ne 2
.na
\fB\fIksp\fR\fR
.ad
.RS 7n
Pointer to a fully initialized \fBkstat\fR(9S) structure.
.RE

.SH DESCRIPTION
\fBkstat_install()\fR is used in conjunction with \fBkstat_create\fR(9F) to
allocate and initialize a \fBkstat\fR(9S) structure.
.sp
.LP
After a successful call to \fBkstat_create()\fR the driver must perform any
necessary initialization of the data section (such as setting the name fields
in a kstat of type  \fBKSTAT_TYPE_NAMED\fR). Virtual kstats must have the
\fBks_data\fR field set at this time. The provider may also set the
\fBks_update\fR, \fBks_private\fR, and \fBks_lock\fR fields if necessary.
.sp
.LP
Once the kstat is completely initialized, \fBkstat_install\fR is used to make
the kstat accessible to the outside world.
.SH RETURN VALUES
None.
.SH CONTEXT
\fBkstat_install()\fR can be called from user or kernel context.
.SH EXAMPLES
\fBExample 1 \fRAllocating and Initializing a \fBkstat\fR Structure
.sp
.LP
The method for allocating and initializing a \fBkstat\fR structure is generally
as follows:

.sp
.in +2
.nf
kstat_t *ksp;
ksp = kstat_create(module, instance, name, class, type, ndata, flags);
if (ksp) {
	 /* ... provider initialization, if necessary */
	kstat_install(ksp);
}
.fi
.in -2

.SH SEE ALSO
\fBkstat_create\fR(9F), \fBkstat_delete\fR(9F), \fBkstat_named_init\fR(9F),
\fBkstat\fR(9S)
.sp
.LP
\fIWriting Device Drivers\fR