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

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc.
   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_IO 9S "Apr 4, 1994"
   7 .SH NAME
   8 kstat_io \- structure for I/O 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 I/O kstat statistics are kept in a \fBkstat_io\fR structure. When
  26 \fBkstat_create\fR(9F) creates an \fBI/O\fR \fBkstat\fR, the \fBks_data\fR
  27 field is a pointer to one of these structures. The macro \fBKSTAT_IO_PTR()\fR
  28 is provided to retrieve this field. It looks like this:
  29 .sp
  30 .in +2
  31 .nf
  32 #define KSTAT_IO_PTR(kptr)      ((kstat_io_t *)(kptr)->ks_data)
  33 .fi
  34 .in -2
  35
  36 .SH STRUCTURE MEMBERS
  37 .sp
  38 .in +2
  39 .nf
  40 u_longlong_t      nread;      /* number of bytes read */
  41 u_longlong_t      nwritten;   /* number of bytes written *]/
  42 ulong_t           reads;      /* number of read operations */
  43 ulong_t           writes;     /* number of write operations */
  44 .fi
  45 .in -2
  46
  47 .sp
  48 .LP
  49 The \fBnread\fR field should be updated by the driver with the number of bytes
  50 successfully read upon completion.
  51 .sp
  52 .LP
  53 The \fBnwritten\fR field should be updated by the driver with the number of
  54 bytes successfully written upon completion.
  55 .sp
  56 .LP
  57 The \fBreads\fR field should be updated by the driver after each successful
  58 read operation.
  59 .sp
  60 .LP
  61 The \fBwrites\fR field should be updated by the driver after each successful
  62 write operation.
  63 .sp
  64 .LP
  65 Other \fBI/O\fR statistics are updated through the use of the
  66 \fBkstat_queue\fR(9F) functions.
  67 .SH SEE ALSO
  68 .sp
  69 .LP
  70 \fBkstat_create\fR(9F), \fBkstat_named_init\fR(9F), \fBkstat_queue\fR(9F),
  71 \fBkstat_runq_back_to_waitq\fR(9F), \fBkstat_runq_enter\fR(9F),
  72 \fBkstat_runq_exit\fR(9F), \fBkstat_waitq_enter\fR(9F),
  73 \fBkstat_waitq_exit\fR(9F), \fBkstat_waitq_to_runq\fR(9F)
  74 .sp
  75 .LP
  76 \fIWriting Device Drivers\fR