include/sys/kstat.h

   1 /*****************************************************************************\
   2  *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
   3  *  Copyright (C) 2007 The Regents of the University of California.
   4  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
   5  *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
   6  *  UCRL-CODE-235197
   7  *
   8  *  This file is part of the SPL, Solaris Porting Layer.
   9  *  For details, see <http://zfsonlinux.org/>.
  10  *
  11  *  The SPL is free software; you can redistribute it and/or modify it
  12  *  under the terms of the GNU General Public License as published by the
  13  *  Free Software Foundation; either version 2 of the License, or (at your
  14  *  option) any later version.
  15  *
  16  *  The SPL is distributed in the hope that it will be useful, but WITHOUT
  17  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19  *  for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License along
  22  *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
  23 \*****************************************************************************/
  24
  25 #ifndef _SPL_KSTAT_H
  26 #define _SPL_KSTAT_H
  27
  28 #include <linux/module.h>
  29 #include <linux/proc_compat.h>
  30 #include <sys/types.h>
  31 #include <sys/time.h>
  32 #include <sys/kmem.h>
  33 #include <sys/mutex.h>
  34
  35 #define KSTAT_STRLEN            31
  36 #define KSTAT_RAW_MAX           (128*1024)
  37
  38 /* For reference valid classes are:
  39  * disk, tape, net, controller, vm, kvm, hat, streams, kstat, misc
  40  */
  41
  42 #define KSTAT_TYPE_RAW          0       /* can be anything; ks_ndata >= 1 */
  43 #define KSTAT_TYPE_NAMED        1       /* name/value pair; ks_ndata >= 1 */
  44 #define KSTAT_TYPE_INTR         2       /* interrupt stats; ks_ndata == 1 */
  45 #define KSTAT_TYPE_IO           3       /* I/O stats; ks_ndata == 1 */
  46 #define KSTAT_TYPE_TIMER        4       /* event timer; ks_ndata >= 1 */
  47 #define KSTAT_TYPE_TXG          5       /* txg sync; ks_ndata >= 1 */
  48 #define KSTAT_NUM_TYPES         6
  49
  50 #define KSTAT_DATA_CHAR         0
  51 #define KSTAT_DATA_INT32        1
  52 #define KSTAT_DATA_UINT32       2
  53 #define KSTAT_DATA_INT64        3
  54 #define KSTAT_DATA_UINT64       4
  55 #define KSTAT_DATA_LONG         5
  56 #define KSTAT_DATA_ULONG        6
  57 #define KSTAT_DATA_STRING       7
  58 #define KSTAT_NUM_DATAS         8
  59
  60 #define KSTAT_INTR_HARD         0
  61 #define KSTAT_INTR_SOFT         1
  62 #define KSTAT_INTR_WATCHDOG     2
  63 #define KSTAT_INTR_SPURIOUS     3
  64 #define KSTAT_INTR_MULTSVC      4
  65 #define KSTAT_NUM_INTRS         5
  66
  67 #define KSTAT_FLAG_VIRTUAL      0x01
  68 #define KSTAT_FLAG_VAR_SIZE     0x02
  69 #define KSTAT_FLAG_WRITABLE     0x04
  70 #define KSTAT_FLAG_PERSISTENT   0x08
  71 #define KSTAT_FLAG_DORMANT      0x10
  72 #define KSTAT_FLAG_UNSUPPORTED  (KSTAT_FLAG_VAR_SIZE | KSTAT_FLAG_WRITABLE | \
  73                                  KSTAT_FLAG_PERSISTENT | KSTAT_FLAG_DORMANT)
  74
  75
  76 #define KS_MAGIC                0x9d9d9d9d
  77
  78 /* Dynamic updates */
  79 #define KSTAT_READ              0
  80 #define KSTAT_WRITE             1
  81
  82 struct kstat_s;
  83 typedef struct kstat_s kstat_t;
  84
  85 typedef int kid_t;                                  /* unique kstat id */
  86 typedef int kstat_update_t(struct kstat_s *, int);  /* dynamic update cb */
  87
  88 typedef struct kstat_module {
  89         char             ksm_name[KSTAT_STRLEN+1];  /* module name */
  90         struct list_head ksm_module_list;           /* module linkage */
  91         struct list_head ksm_kstat_list;            /* list of kstat entries */
  92         struct proc_dir_entry *ksm_proc;            /* proc entry */
  93 } kstat_module_t;
  94
  95 typedef struct kstat_raw_ops {
  96         int (*headers)(char *buf, size_t size);
  97         int (*data)(char *buf, size_t size, void *data);
  98         void *(*addr)(kstat_t *ksp, loff_t index);
  99 } kstat_raw_ops_t;
 100
 101 struct kstat_s {
 102         int              ks_magic;                  /* magic value */
 103         kid_t            ks_kid;                    /* unique kstat ID */
 104         hrtime_t         ks_crtime;                 /* creation time */
 105         hrtime_t         ks_snaptime;               /* last access time */
 106         char             ks_module[KSTAT_STRLEN+1]; /* provider module name */
 107         int              ks_instance;               /* provider module instance */
 108         char             ks_name[KSTAT_STRLEN+1];   /* kstat name */
 109         char             ks_class[KSTAT_STRLEN+1];  /* kstat class */
 110         uchar_t          ks_type;                   /* kstat data type */
 111         uchar_t          ks_flags;                  /* kstat flags */
 112         void             *ks_data;                  /* kstat type-specific data */
 113         uint_t           ks_ndata;                  /* # of type-specific data records */
 114         size_t           ks_data_size;              /* size of kstat data section */
 115         struct proc_dir_entry *ks_proc;             /* proc linkage */
 116         kstat_update_t   *ks_update;                /* dynamic updates */
 117         void             *ks_private;               /* private data */
 118         kmutex_t         ks_lock;                   /* kstat data lock */
 119         struct list_head ks_list;                   /* kstat linkage */
 120         kstat_module_t   *ks_owner;                 /* kstat module linkage */
 121         kstat_raw_ops_t  ks_raw_ops;                /* ops table for raw type */
 122         char             *ks_raw_buf;               /* buf used for raw ops */
 123         size_t           ks_raw_bufsize;            /* size of raw ops buffer */
 124 };
 125
 126 typedef struct kstat_named_s {
 127         char             name[KSTAT_STRLEN];        /* name of counter */
 128         uchar_t          data_type;                 /* data type */
 129         union {
 130                 char            c[16];              /* 128-bit int */
 131                 int32_t         i32;                /* 32-bit signed int */
 132                 uint32_t        ui32;               /* 32-bit unsigned int */
 133                 int64_t         i64;                /* 64-bit signed int */
 134                 uint64_t        ui64;               /* 64-bit unsigned int */
 135                 long            l;                  /* native signed long */
 136                 ulong_t         ul;                 /* native unsigned long */
 137                 struct {
 138                         union {
 139                                 char *ptr;          /* NULL-term string */
 140                                 char __pad[8];      /* 64-bit padding */
 141                         } addr;
 142                         uint32_t len;               /* # bytes for strlen + '\0' */
 143                 } string;
 144         } value;
 145 } kstat_named_t;
 146
 147 #define KSTAT_NAMED_STR_PTR(knptr) ((knptr)->value.string.addr.ptr)
 148 #define KSTAT_NAMED_STR_BUFLEN(knptr) ((knptr)->value.string.len)
 149
 150 typedef struct kstat_intr {
 151         uint_t intrs[KSTAT_NUM_INTRS];
 152 } kstat_intr_t;
 153
 154 typedef struct kstat_io {
 155         u_longlong_t     nread;       /* number of bytes read */
 156         u_longlong_t     nwritten;    /* number of bytes written */
 157         uint_t           reads;       /* number of read operations */
 158         uint_t           writes;      /* number of write operations */
 159         hrtime_t         wtime;       /* cumulative wait (pre-service) time */
 160         hrtime_t         wlentime;    /* cumulative wait length*time product*/
 161         hrtime_t         wlastupdate; /* last time wait queue changed */
 162         hrtime_t         rtime;       /* cumulative run (service) time */
 163         hrtime_t         rlentime;    /* cumulative run length*time product */
 164         hrtime_t         rlastupdate; /* last time run queue changed */
 165         uint_t           wcnt;        /* count of elements in wait state */
 166         uint_t           rcnt;        /* count of elements in run state */
 167 } kstat_io_t;
 168
 169 typedef struct kstat_timer {
 170         char         name[KSTAT_STRLEN+1]; /* event name */
 171         u_longlong_t num_events;           /* number of events */
 172         hrtime_t     elapsed_time;         /* cumulative elapsed time */
 173         hrtime_t     min_time;             /* shortest event duration */
 174         hrtime_t     max_time;             /* longest event duration */
 175         hrtime_t     start_time;           /* previous event start time */
 176         hrtime_t     stop_time;            /* previous event stop time */
 177 } kstat_timer_t;
 178
 179 typedef enum kstat_txg_state {
 180         TXG_STATE_OPEN      = 1,
 181         TXG_STATE_QUIESCING = 2,
 182         TXG_STATE_SYNCING   = 3,
 183         TXG_STATE_COMMITTED = 4,
 184 } kstat_txg_state_t;
 185
 186 typedef struct kstat_txg {
 187         u_longlong_t       txg;         /* txg id */
 188         kstat_txg_state_t  state;       /* txg state */
 189         hrtime_t           birth;       /* birth time stamp */
 190         u_longlong_t       nread;       /* number of bytes read */
 191         u_longlong_t       nwritten;    /* number of bytes written */
 192         uint_t             reads;       /* number of read operations */
 193         uint_t             writes;      /* number of write operations */
 194         hrtime_t           open_time;   /* open time */
 195         hrtime_t           quiesce_time;/* quiesce time */
 196         hrtime_t           sync_time;   /* sync time */
 197 } kstat_txg_t;
 198
 199 int spl_kstat_init(void);
 200 void spl_kstat_fini(void);
 201
 202 extern void __kstat_set_raw_ops(kstat_t *ksp,
 203                     int (*headers)(char *buf, size_t size),
 204                     int (*data)(char *buf, size_t size, void *data),
 205                     void* (*addr)(kstat_t *ksp, loff_t index));
 206 extern kstat_t *__kstat_create(const char *ks_module, int ks_instance,
 207                              const char *ks_name, const char *ks_class,
 208                              uchar_t ks_type, uint_t ks_ndata,
 209                              uchar_t ks_flags);
 210 extern void __kstat_install(kstat_t *ksp);
 211 extern void __kstat_delete(kstat_t *ksp);
 212
 213 #define kstat_set_raw_ops(k,h,d,a)      __kstat_set_raw_ops(k,h,d,a)
 214 #define kstat_create(m,i,n,c,t,s,f)     __kstat_create(m,i,n,c,t,s,f)
 215 #define kstat_install(k)                __kstat_install(k)
 216 #define kstat_delete(k)                 __kstat_delete(k)
 217
 218 #endif  /* _SPL_KSTAT_H */