usr/src/man/man9s/kstat_named.9s

   1 '\" te
   2 .\" Copyright (c) 2000, 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 KSTAT_NAMED 9S "Apr 4, 1994"
   7 .SH NAME
   8 kstat_named \- structure for named kstats
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/types.h>
  13 #include <sys/kstat.h>
  14 #include <sys/ddi.h>
  15 #include <sys/sunddi.h>
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI)
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 Named \fBkstats\fR are an array of name-value pairs. These pairs are kept in
  26 the \fBkstat_named\fR structure. When a \fBkstat\fR is created by
  27 \fBkstat_create\fR(9F), the driver specifies how many of these structures will
  28 be allocated. The structures are returned as an array pointed to by the
  29 \fBks_data\fR field.
  30 .SH STRUCTURE MEMBERS
  31 .sp
  32 .in +2
  33 .nf
  34 union {
  35           char                   c[16];
  36           long                   l;
  37           ulong_t                ul;
  38           longlong_t             ll;
  39           u_longlong_t           ull;
  40 } value;  /* value of counter */
  41 .fi
  42 .in -2
  43
  44 .sp
  45 .LP
  46 The only member exposed to drivers is the \fBvalue\fR member. This field is a
  47 union of several data types. The driver must specify which type it will use in
  48 the call to \fBkstat_named_init()\fR.
  49 .SH SEE ALSO
  50 .sp
  51 .LP
  52 \fBkstat_create\fR(9F), \fBkstat_named_init\fR(9F)
  53 .sp
  54 .LP
  55 \fIWriting Device Drivers\fR