usr/src/man/man9e/ks_snapshot.9e

   1 '\" te
   2 .\"  Copyright (c) 2002, 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 KS_SNAPSHOT 9E "Sep 7, 2015"
   7 .SH NAME
   8 ks_snapshot \- take a snapshot of kstat data
   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
  17
  18
  19 \fBint prefix\fR\fB_ks_snapshot\fR(\fBkstat_t *\fR\fIksp\fR, \fBvoid *\fR\fIbuf\fR, \fBint\fR \fIrw\fR);
  20 .fi
  21
  22 .SH INTERFACE LEVEL
  23 .LP
  24 Solaris DDI specific (Solaris DDI).
  25 .SH PARAMETERS
  26 .ne 2
  27 .na
  28 \fB\fIksp\fR \fR
  29 .ad
  30 .RS 8n
  31 Pointer to a \fBkstat\fR(9S) structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIbuf\fR \fR
  38 .ad
  39 .RS 8n
  40 Pointer to a buffer to copy the snapshot into.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIrw\fR \fR
  47 .ad
  48 .RS 8n
  49 Read/Write flag. Possible values are:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBKSTAT_READ\fR\fR
  54 .ad
  55 .RS 15n
  56 Copy driver statistics from the driver to the buffer.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBKSTAT_WRITE\fR\fR
  63 .ad
  64 .RS 15n
  65 Copy statistics from the buffer to the driver.
  66 .RE
  67
  68 .RE
  69
  70 .SH DESCRIPTION
  71 .LP
  72 The \fBkstat\fR mechanism allows for an optional \fBks_snapshot()\fR function
  73 to copy \fBkstat\fR data. This is the routine that is called to marshall the
  74 \fBkstat\fR data to be copied to user-land. A driver can opt to use a custom
  75 snapshot routine rather than the default snapshot routine; to take advantage of
  76 this feature, set the \fBks_snapshot\fR field before calling
  77 \fBkstat_install\fR(9F).
  78 .sp
  79 .LP
  80 The \fBks_snapshot()\fR function must have the following structure:
  81 .sp
  82 .in +2
  83 .nf
  84 static int
  85 xx_kstat_snapshot(kstat_t *ksp, void *buf, int rw)
  86 {
  87      if (rw == KSTAT_WRITE) {
  88 /* set the native stats to the values in buf */
  89 /* return EACCES if you don't support this */
  90      } else {
  91 /* copy the kstat-specific data into buf */
  92      }
  93      return (0);
  94 }
  95 .fi
  96 .in -2
  97 .sp
  98
  99 .sp
 100 .LP
 101 In general, the \fBks_snapshot()\fR routine might need to refer to
 102 provider-private data; for example, it might need a pointer to the provider's
 103 raw statistics. The \fBks_private\fR field is available for this purpose. Its
 104 use is entirely at the provider's discretion.
 105 .sp
 106 .LP
 107 No \fBkstat\fR locking should be done inside the \fBks_snapshot()\fR routine. The
 108 caller will already be holding the \fBkstat\fR's \fBks_lock\fR (to ensure
 109 consistent data) and will prevent the \fBkstat\fR from being removed.
 110 .RS +4
 111 .TP
 112 1.
 113 \fBks_snaptime\fR must be set (via \fBgethrtime\fR(9F)) to timestamp the
 114 data.
 115 .RE
 116 .RS +4
 117 .TP
 118 2.
 119 Data gets copied from the \fBkstat\fR to the buffer on \fBKSTAT_READ\fR, and
 120 from the buffer to the \fBkstat\fR on \fBKSTAT_WRITE\fR.
 121 .RE
 122 .SH RETURN VALUES
 123 .ne 2
 124 .na
 125 \fB\fB0\fR\fR
 126 .ad
 127 .RS 10n
 128 Success
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBEACCES\fR\fR
 135 .ad
 136 .RS 10n
 137 If \fBKSTAT_WRITE\fR is not allowed
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBEIO\fR\fR
 144 .ad
 145 .RS 10n
 146 For any other error
 147 .RE
 148
 149 .SH CONTEXT
 150 .LP
 151 This function is called from user context only.
 152 .SH EXAMPLES
 153 .LP
 154 \fBExample 1 \fRNamed \fBkstat\fRs with Long Strings (\fBKSTAT_DATA_STRING\fR)
 155 .sp
 156 .in +2
 157 .nf
 158 static int
 159 xxx_kstat_snapshot(kstat_t *ksp, void *buf, int rw)
 160 {
 161     if (rw == KSTAT_WRITE) {
 162          return (EACCES);
 163     } else {
 164          kstat_named_t *knp = buf;
 165          char *end = knp + ksp->ks_ndata;
 166          uint_t i;
 167
 168          bcopy(ksp->ks_data, buf,
 169                  sizeof (kstat_named_t) * ksp->ks_ndata);
 170 /*
 171  * Now copy the strings to the end of the buffer, and
 172  * update the pointers appropriately.
 173  */
 174          for (i = 0; i < ksp->ks_ndata; i++, knp++)
 175                  if (knp->data_type == KSTAT_DATA_STRING &&
 176                      KSTAT_NAMED_STR_PTR(knp) != NULL) {
 177                          bcopy(KSTAT_NAMED_STR_PTR(knp), end,
 178                                  KSTAT_NAMED_STR_BUFLEN(knp));
 179                          KSTAT_NAMED_STR_PTR(knp) = end;
 180                          end += KSTAT_NAMED_STR_BUFLEN(knp);
 181                  }
 182     }
 183     return (0);
 184 }
 185 .fi
 186 .in -2
 187 .sp
 188
 189 .SH SEE ALSO
 190 .LP
 191 \fBks_update\fR(9E), \fBkstat_create\fR(9F), \fBkstat_install\fR(9F),
 192 \fBkstat\fR(9S)
 193 .sp
 194 .LP
 195 \fIWriting Device Drivers\fR