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>.
8 * This file is part of the SPL, Solaris Porting Layer.
9 * For details, see <http://zfsonlinux.org/>.
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.
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
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 \*****************************************************************************/
28 #include <linux/module.h>
29 #include <linux/proc_compat.h>
30 #include <sys/types.h>
33 #include <sys/mutex.h>
35 #define KSTAT_STRLEN 255
36 #define KSTAT_RAW_MAX (128*1024)
39 * For reference valid classes are:
40 * disk, tape, net, controller, vm, kvm, hat, streams, kstat, misc
43 #define KSTAT_TYPE_RAW 0 /* can be anything; ks_ndata >= 1 */
44 #define KSTAT_TYPE_NAMED 1 /* name/value pair; ks_ndata >= 1 */
45 #define KSTAT_TYPE_INTR 2 /* interrupt stats; ks_ndata == 1 */
46 #define KSTAT_TYPE_IO 3 /* I/O stats; ks_ndata == 1 */
47 #define KSTAT_TYPE_TIMER 4 /* event timer; ks_ndata >= 1 */
48 #define KSTAT_NUM_TYPES 5
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
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
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 \
73 (KSTAT_FLAG_VAR_SIZE | KSTAT_FLAG_WRITABLE | \
74 KSTAT_FLAG_PERSISTENT | KSTAT_FLAG_DORMANT)
75 #define KSTAT_FLAG_NO_HEADERS 0x80
77 #define KS_MAGIC 0x9d9d9d9d
84 typedef struct kstat_s kstat_t
;
86 typedef int kid_t
; /* unique kstat id */
87 typedef int kstat_update_t(struct kstat_s
*, int); /* dynamic update cb */
89 typedef struct kstat_module
{
90 char ksm_name
[KSTAT_STRLEN
+1]; /* module name */
91 struct list_head ksm_module_list
; /* module linkage */
92 struct list_head ksm_kstat_list
; /* list of kstat entries */
93 struct proc_dir_entry
*ksm_proc
; /* proc entry */
96 typedef struct kstat_raw_ops
{
97 int (*headers
)(char *buf
, size_t size
);
98 int (*data
)(char *buf
, size_t size
, void *data
);
99 void *(*addr
)(kstat_t
*ksp
, loff_t index
);
103 int ks_magic
; /* magic value */
104 kid_t ks_kid
; /* unique kstat ID */
105 hrtime_t ks_crtime
; /* creation time */
106 hrtime_t ks_snaptime
; /* last access time */
107 char ks_module
[KSTAT_STRLEN
+1]; /* provider module name */
108 int ks_instance
; /* provider module instance */
109 char ks_name
[KSTAT_STRLEN
+1]; /* kstat name */
110 char ks_class
[KSTAT_STRLEN
+1]; /* kstat class */
111 uchar_t ks_type
; /* kstat data type */
112 uchar_t ks_flags
; /* kstat flags */
113 void *ks_data
; /* kstat type-specific data */
114 uint_t ks_ndata
; /* # of data records */
115 size_t ks_data_size
; /* size of kstat data section */
116 struct proc_dir_entry
*ks_proc
; /* proc linkage */
117 kstat_update_t
*ks_update
; /* dynamic updates */
118 void *ks_private
; /* private data */
119 kmutex_t ks_private_lock
; /* kstat private data lock */
120 kmutex_t
*ks_lock
; /* kstat data lock */
121 struct list_head ks_list
; /* kstat linkage */
122 kstat_module_t
*ks_owner
; /* kstat module linkage */
123 kstat_raw_ops_t ks_raw_ops
; /* ops table for raw type */
124 char *ks_raw_buf
; /* buf used for raw ops */
125 size_t ks_raw_bufsize
; /* size of raw ops buffer */
128 typedef struct kstat_named_s
{
129 char name
[KSTAT_STRLEN
]; /* name of counter */
130 uchar_t data_type
; /* data type */
132 char c
[16]; /* 128-bit int */
133 int32_t i32
; /* 32-bit signed int */
134 uint32_t ui32
; /* 32-bit unsigned int */
135 int64_t i64
; /* 64-bit signed int */
136 uint64_t ui64
; /* 64-bit unsigned int */
137 long l
; /* native signed long */
138 ulong_t ul
; /* native unsigned long */
141 char *ptr
; /* NULL-term string */
142 char __pad
[8]; /* 64-bit padding */
144 uint32_t len
; /* # bytes for strlen + '\0' */
149 #define KSTAT_NAMED_STR_PTR(knptr) ((knptr)->value.string.addr.ptr)
150 #define KSTAT_NAMED_STR_BUFLEN(knptr) ((knptr)->value.string.len)
152 typedef struct kstat_intr
{
153 uint_t intrs
[KSTAT_NUM_INTRS
];
156 typedef struct kstat_io
{
157 u_longlong_t nread
; /* number of bytes read */
158 u_longlong_t nwritten
; /* number of bytes written */
159 uint_t reads
; /* number of read operations */
160 uint_t writes
; /* number of write operations */
161 hrtime_t wtime
; /* cumulative wait (pre-service) time */
162 hrtime_t wlentime
; /* cumulative wait len*time product */
163 hrtime_t wlastupdate
; /* last time wait queue changed */
164 hrtime_t rtime
; /* cumulative run (service) time */
165 hrtime_t rlentime
; /* cumulative run length*time product */
166 hrtime_t rlastupdate
; /* last time run queue changed */
167 uint_t wcnt
; /* count of elements in wait state */
168 uint_t rcnt
; /* count of elements in run state */
171 typedef struct kstat_timer
{
172 char name
[KSTAT_STRLEN
+1]; /* event name */
173 u_longlong_t num_events
; /* number of events */
174 hrtime_t elapsed_time
; /* cumulative elapsed time */
175 hrtime_t min_time
; /* shortest event duration */
176 hrtime_t max_time
; /* longest event duration */
177 hrtime_t start_time
; /* previous event start time */
178 hrtime_t stop_time
; /* previous event stop time */
181 int spl_kstat_init(void);
182 void spl_kstat_fini(void);
184 extern void __kstat_set_raw_ops(kstat_t
*ksp
,
185 int (*headers
)(char *buf
, size_t size
),
186 int (*data
)(char *buf
, size_t size
, void *data
),
187 void* (*addr
)(kstat_t
*ksp
, loff_t index
));
189 extern kstat_t
*__kstat_create(const char *ks_module
, int ks_instance
,
190 const char *ks_name
, const char *ks_class
, uchar_t ks_type
,
191 uint_t ks_ndata
, uchar_t ks_flags
);
193 extern void __kstat_install(kstat_t
*ksp
);
194 extern void __kstat_delete(kstat_t
*ksp
);
195 extern void kstat_waitq_enter(kstat_io_t
*);
196 extern void kstat_waitq_exit(kstat_io_t
*);
197 extern void kstat_runq_enter(kstat_io_t
*);
198 extern void kstat_runq_exit(kstat_io_t
*);
200 #define kstat_set_raw_ops(k, h, d, a) \
201 __kstat_set_raw_ops(k, h, d, a)
202 #define kstat_create(m, i, n, c, t, s, f) \
203 __kstat_create(m, i, n, c, t, s, f)
205 #define kstat_install(k) __kstat_install(k)
206 #define kstat_delete(k) __kstat_delete(k)
208 #endif /* _SPL_KSTAT_H */