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>.
8 * This file is part of the SPL, Solaris Porting Layer.
10 * The SPL is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
15 * The SPL is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * You should have received a copy of the GNU General Public License along
21 * with the SPL. If not, see <http://www.gnu.org/licenses/>.
27 #include <linux/module.h>
28 #include <sys/types.h>
31 #include <sys/mutex.h>
34 #define KSTAT_STRLEN 255
35 #define KSTAT_RAW_MAX (128*1024)
38 * For reference valid classes are:
39 * disk, tape, net, controller, vm, kvm, hat, streams, kstat, misc
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_NUM_TYPES 5
49 #define KSTAT_DATA_CHAR 0
50 #define KSTAT_DATA_INT32 1
51 #define KSTAT_DATA_UINT32 2
52 #define KSTAT_DATA_INT64 3
53 #define KSTAT_DATA_UINT64 4
54 #define KSTAT_DATA_LONG 5
55 #define KSTAT_DATA_ULONG 6
56 #define KSTAT_DATA_STRING 7
57 #define KSTAT_NUM_DATAS 8
59 #define KSTAT_INTR_HARD 0
60 #define KSTAT_INTR_SOFT 1
61 #define KSTAT_INTR_WATCHDOG 2
62 #define KSTAT_INTR_SPURIOUS 3
63 #define KSTAT_INTR_MULTSVC 4
64 #define KSTAT_NUM_INTRS 5
66 #define KSTAT_FLAG_VIRTUAL 0x01
67 #define KSTAT_FLAG_VAR_SIZE 0x02
68 #define KSTAT_FLAG_WRITABLE 0x04
69 #define KSTAT_FLAG_PERSISTENT 0x08
70 #define KSTAT_FLAG_DORMANT 0x10
71 #define KSTAT_FLAG_INVALID 0x20
72 #define KSTAT_FLAG_LONGSTRINGS 0x40
73 #define KSTAT_FLAG_NO_HEADERS 0x80
75 #define KS_MAGIC 0x9d9d9d9d
82 typedef struct kstat_s kstat_t
;
84 typedef int kid_t
; /* unique kstat id */
85 typedef int kstat_update_t(struct kstat_s
*, int); /* dynamic update cb */
87 typedef struct kstat_module
{
88 char ksm_name
[KSTAT_STRLEN
]; /* module name */
89 struct list_head ksm_module_list
; /* module linkage */
90 struct list_head ksm_kstat_list
; /* list of kstat entries */
91 struct proc_dir_entry
*ksm_proc
; /* proc entry */
94 typedef struct kstat_raw_ops
{
95 int (*headers
)(char *buf
, size_t size
);
96 int (*data
)(char *buf
, size_t size
, void *data
);
97 void *(*addr
)(kstat_t
*ksp
, loff_t index
);
100 typedef struct kstat_proc_entry
{
101 char kpe_name
[KSTAT_STRLEN
]; /* kstat name */
102 char kpe_module
[KSTAT_STRLEN
]; /* provider module name */
103 kstat_module_t
*kpe_owner
; /* kstat module linkage */
104 struct list_head kpe_list
; /* kstat linkage */
105 struct proc_dir_entry
*kpe_proc
; /* procfs entry */
106 } kstat_proc_entry_t
;
109 int ks_magic
; /* magic value */
110 kid_t ks_kid
; /* unique kstat ID */
111 hrtime_t ks_crtime
; /* creation time */
112 hrtime_t ks_snaptime
; /* last access time */
113 int ks_instance
; /* provider module instance */
114 char ks_class
[KSTAT_STRLEN
]; /* kstat class */
115 uchar_t ks_type
; /* kstat data type */
116 uchar_t ks_flags
; /* kstat flags */
117 void *ks_data
; /* kstat type-specific data */
118 uint_t ks_ndata
; /* # of data records */
119 size_t ks_data_size
; /* size of kstat data section */
120 kstat_update_t
*ks_update
; /* dynamic updates */
121 void *ks_private
; /* private data */
122 kmutex_t ks_private_lock
; /* kstat private data lock */
123 kmutex_t
*ks_lock
; /* kstat data lock */
124 kstat_raw_ops_t ks_raw_ops
; /* ops table for raw type */
125 char *ks_raw_buf
; /* buf used for raw ops */
126 size_t ks_raw_bufsize
; /* size of raw ops buffer */
127 kstat_proc_entry_t ks_proc
; /* data for procfs entry */
130 typedef struct kstat_named_s
{
131 char name
[KSTAT_STRLEN
]; /* name of counter */
132 uchar_t data_type
; /* data type */
134 char c
[16]; /* 128-bit int */
135 int32_t i32
; /* 32-bit signed int */
136 uint32_t ui32
; /* 32-bit unsigned int */
137 int64_t i64
; /* 64-bit signed int */
138 uint64_t ui64
; /* 64-bit unsigned int */
139 long l
; /* native signed long */
140 ulong_t ul
; /* native unsigned long */
143 char *ptr
; /* NULL-term string */
144 char __pad
[8]; /* 64-bit padding */
146 uint32_t len
; /* # bytes for strlen + '\0' */
151 #define KSTAT_NAMED_STR_PTR(knptr) ((knptr)->value.string.addr.ptr)
152 #define KSTAT_NAMED_STR_BUFLEN(knptr) ((knptr)->value.string.len)
154 #ifdef HAVE_PROC_OPS_STRUCT
155 typedef struct proc_ops kstat_proc_op_t
;
157 typedef struct file_operations kstat_proc_op_t
;
160 typedef struct kstat_intr
{
161 uint_t intrs
[KSTAT_NUM_INTRS
];
164 typedef struct kstat_io
{
165 u_longlong_t nread
; /* number of bytes read */
166 u_longlong_t nwritten
; /* number of bytes written */
167 uint_t reads
; /* number of read operations */
168 uint_t writes
; /* number of write operations */
169 hrtime_t wtime
; /* cumulative wait (pre-service) time */
170 hrtime_t wlentime
; /* cumulative wait len*time product */
171 hrtime_t wlastupdate
; /* last time wait queue changed */
172 hrtime_t rtime
; /* cumulative run (service) time */
173 hrtime_t rlentime
; /* cumulative run length*time product */
174 hrtime_t rlastupdate
; /* last time run queue changed */
175 uint_t wcnt
; /* count of elements in wait state */
176 uint_t rcnt
; /* count of elements in run state */
179 typedef struct kstat_timer
{
180 char name
[KSTAT_STRLEN
]; /* event name */
181 u_longlong_t num_events
; /* number of events */
182 hrtime_t elapsed_time
; /* cumulative elapsed time */
183 hrtime_t min_time
; /* shortest event duration */
184 hrtime_t max_time
; /* longest event duration */
185 hrtime_t start_time
; /* previous event start time */
186 hrtime_t stop_time
; /* previous event stop time */
189 int spl_kstat_init(void);
190 void spl_kstat_fini(void);
192 extern void __kstat_set_raw_ops(kstat_t
*ksp
,
193 int (*headers
)(char *buf
, size_t size
),
194 int (*data
)(char *buf
, size_t size
, void *data
),
195 void* (*addr
)(kstat_t
*ksp
, loff_t index
));
197 extern kstat_t
*__kstat_create(const char *ks_module
, int ks_instance
,
198 const char *ks_name
, const char *ks_class
, uchar_t ks_type
,
199 uint_t ks_ndata
, uchar_t ks_flags
);
201 extern void kstat_proc_entry_init(kstat_proc_entry_t
*kpep
,
202 const char *module
, const char *name
);
203 extern void kstat_proc_entry_delete(kstat_proc_entry_t
*kpep
);
204 extern void kstat_proc_entry_install(kstat_proc_entry_t
*kpep
, mode_t mode
,
205 const kstat_proc_op_t
*file_ops
, void *data
);
207 extern void __kstat_install(kstat_t
*ksp
);
208 extern void __kstat_delete(kstat_t
*ksp
);
210 #define kstat_set_raw_ops(k, h, d, a) \
211 __kstat_set_raw_ops(k, h, d, a)
212 #define kstat_create(m, i, n, c, t, s, f) \
213 __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)
218 #endif /* _SPL_KSTAT_H */