Copyright (c) 2004, 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]
cc[ flag.\|.\|. ] file.\|.\|. -lkstat [ library.\|.\|.] #include <kstat.h> kstat_ctl_t *kstat_open(void);
int kstat_close(kstat_ctl_t *kc);
The kstat_open() function initializes a kstat control structure that provides access to the kernel statistics library. It returns a pointer to this structure, which must be supplied as the kc argument in subsequent libkstat function calls.
The kstat_close() function frees all resources that were associated with kc. This is performed automatically on exit(2) and execve(2).
Upon successful completion, kstat_open() returns a pointer to a kstat control structure. Otherwise, it returns NULL, no resources are allocated, and errno is set to indicate the error.
Upon successful completion, kstat_close() returns 0. Otherwise, -1 is returned and errno is set to indicate the error.
The kstat_open() function will fail if: ENOMEM
Insufficient storage space is available.
The kstat was temporarily unavailable for reading or writing.
The given kstat could not be located for reading.
The data for the given kstat was too large to be stored in the structure.
The kstat_open() function can also return the error values for open(2).
The kstat_close() function can also return the error values for close(2).
kernel statistics driver
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Stable |
| MT-Level Unsafe |
close(2), execve(2), open(2), exit(2), kstat(3KSTAT), kstat_chain_update(3KSTAT), kstat_lookup(3KSTAT), kstat_read(3KSTAT), attributes(5)