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 *****************************************************************************
24 * Solaris Porting Layer (SPL) Kstat Implementation.
25 \*****************************************************************************/
27 #include <linux/seq_file.h>
28 #include <sys/kstat.h>
29 #include <spl-debug.h>
31 #ifdef SS_DEBUG_SUBSYS
32 #undef SS_DEBUG_SUBSYS
35 #define SS_DEBUG_SUBSYS SS_KSTAT
37 #define PDE_DATA(x) (PDE(x)->data)
40 static kmutex_t kstat_module_lock
;
41 static struct list_head kstat_module_list
;
42 static kid_t kstat_id
;
45 kstat_resize_raw(kstat_t
*ksp
)
47 if (ksp
->ks_raw_bufsize
== KSTAT_RAW_MAX
)
50 vmem_free(ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
);
51 ksp
->ks_raw_bufsize
= MIN(ksp
->ks_raw_bufsize
* 2, KSTAT_RAW_MAX
);
52 ksp
->ks_raw_buf
= vmem_alloc(ksp
->ks_raw_bufsize
, KM_SLEEP
);
58 kstat_seq_show_headers(struct seq_file
*f
)
60 kstat_t
*ksp
= (kstat_t
*)f
->private;
63 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
65 seq_printf(f
, "%d %d 0x%02x %d %d %lld %lld\n",
66 ksp
->ks_kid
, ksp
->ks_type
, ksp
->ks_flags
,
67 ksp
->ks_ndata
, (int)ksp
->ks_data_size
,
68 ksp
->ks_crtime
, ksp
->ks_snaptime
);
70 switch (ksp
->ks_type
) {
73 if (ksp
->ks_raw_ops
.headers
) {
74 rc
= ksp
->ks_raw_ops
.headers(
75 ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
);
76 if (rc
== ENOMEM
&& !kstat_resize_raw(ksp
))
79 seq_puts(f
, ksp
->ks_raw_buf
);
81 seq_printf(f
, "raw data\n");
84 case KSTAT_TYPE_NAMED
:
85 seq_printf(f
, "%-31s %-4s %s\n",
86 "name", "type", "data");
89 seq_printf(f
, "%-8s %-8s %-8s %-8s %-8s\n",
90 "hard", "soft", "watchdog",
91 "spurious", "multsvc");
95 "%-8s %-8s %-8s %-8s %-8s %-8s "
96 "%-8s %-8s %-8s %-8s %-8s %-8s\n",
97 "nread", "nwritten", "reads", "writes",
98 "wtime", "wlentime", "wupdate",
99 "rtime", "rlentime", "rupdate",
102 case KSTAT_TYPE_TIMER
:
105 "%-8s %-8s %-8s %-8s %-8s\n",
106 "name", "events", "elapsed",
107 "min", "max", "start", "stop");
111 "%-8s %-5s %-13s %-12s %-12s %-8s %-8s "
112 "%-12s %-12s %-12s\n",
113 "txg", "state", "birth",
114 "nread", "nwritten", "reads", "writes",
115 "otime", "qtime", "stime");
118 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
125 kstat_seq_show_raw(struct seq_file
*f
, unsigned char *p
, int l
)
130 seq_printf(f
, "%03x:", i
);
132 for (j
= 0; j
< 16; j
++) {
133 if (i
* 16 + j
>= l
) {
138 seq_printf(f
, " %02x", (unsigned char)p
[i
* 16 + j
]);
147 kstat_seq_show_named(struct seq_file
*f
, kstat_named_t
*knp
)
149 seq_printf(f
, "%-31s %-4d ", knp
->name
, knp
->data_type
);
151 switch (knp
->data_type
) {
152 case KSTAT_DATA_CHAR
:
153 knp
->value
.c
[15] = '\0'; /* NULL terminate */
154 seq_printf(f
, "%-16s", knp
->value
.c
);
156 /* XXX - We need to be more careful able what tokens are
157 * used for each arch, for now this is correct for x86_64.
159 case KSTAT_DATA_INT32
:
160 seq_printf(f
, "%d", knp
->value
.i32
);
162 case KSTAT_DATA_UINT32
:
163 seq_printf(f
, "%u", knp
->value
.ui32
);
165 case KSTAT_DATA_INT64
:
166 seq_printf(f
, "%lld", (signed long long)knp
->value
.i64
);
168 case KSTAT_DATA_UINT64
:
169 seq_printf(f
, "%llu", (unsigned long long)knp
->value
.ui64
);
171 case KSTAT_DATA_LONG
:
172 seq_printf(f
, "%ld", knp
->value
.l
);
174 case KSTAT_DATA_ULONG
:
175 seq_printf(f
, "%lu", knp
->value
.ul
);
177 case KSTAT_DATA_STRING
:
178 KSTAT_NAMED_STR_PTR(knp
)
179 [KSTAT_NAMED_STR_BUFLEN(knp
)-1] = '\0';
180 seq_printf(f
, "%s", KSTAT_NAMED_STR_PTR(knp
));
183 PANIC("Undefined kstat data type %d\n", knp
->data_type
);
192 kstat_seq_show_intr(struct seq_file
*f
, kstat_intr_t
*kip
)
194 seq_printf(f
, "%-8u %-8u %-8u %-8u %-8u\n",
195 kip
->intrs
[KSTAT_INTR_HARD
],
196 kip
->intrs
[KSTAT_INTR_SOFT
],
197 kip
->intrs
[KSTAT_INTR_WATCHDOG
],
198 kip
->intrs
[KSTAT_INTR_SPURIOUS
],
199 kip
->intrs
[KSTAT_INTR_MULTSVC
]);
205 kstat_seq_show_io(struct seq_file
*f
, kstat_io_t
*kip
)
208 "%-8llu %-8llu %-8u %-8u %-8lld %-8lld "
209 "%-8lld %-8lld %-8lld %-8lld %-8u %-8u\n",
210 kip
->nread
, kip
->nwritten
,
211 kip
->reads
, kip
->writes
,
212 kip
->wtime
, kip
->wlentime
, kip
->wlastupdate
,
213 kip
->rtime
, kip
->wlentime
, kip
->rlastupdate
,
214 kip
->wcnt
, kip
->rcnt
);
220 kstat_seq_show_timer(struct seq_file
*f
, kstat_timer_t
*ktp
)
223 "%-31s %-8llu %-8lld %-8lld %-8lld %-8lld %-8lld\n",
224 ktp
->name
, ktp
->num_events
, ktp
->elapsed_time
,
225 ktp
->min_time
, ktp
->max_time
,
226 ktp
->start_time
, ktp
->stop_time
);
232 kstat_seq_show_txg(struct seq_file
*f
, kstat_txg_t
*ktp
)
236 switch (ktp
->state
) {
237 case TXG_STATE_OPEN
: state
= 'O'; break;
238 case TXG_STATE_QUIESCING
: state
= 'Q'; break;
239 case TXG_STATE_SYNCING
: state
= 'S'; break;
240 case TXG_STATE_COMMITTED
: state
= 'C'; break;
241 default: state
= '?'; break;
245 "%-8llu %-5c %-13llu %-12llu %-12llu %-8u %-8u "
246 "%12lld %12lld %12lld\n", ktp
->txg
, state
, ktp
->birth
,
247 ktp
->nread
, ktp
->nwritten
, ktp
->reads
, ktp
->writes
,
248 ktp
->open_time
, ktp
->quiesce_time
, ktp
->sync_time
);
253 kstat_seq_show(struct seq_file
*f
, void *p
)
255 kstat_t
*ksp
= (kstat_t
*)f
->private;
258 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
260 switch (ksp
->ks_type
) {
263 if (ksp
->ks_raw_ops
.data
) {
264 rc
= ksp
->ks_raw_ops
.data(
265 ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
, p
);
266 if (rc
== ENOMEM
&& !kstat_resize_raw(ksp
))
269 seq_puts(f
, ksp
->ks_raw_buf
);
271 ASSERT(ksp
->ks_ndata
== 1);
272 rc
= kstat_seq_show_raw(f
, ksp
->ks_data
,
276 case KSTAT_TYPE_NAMED
:
277 rc
= kstat_seq_show_named(f
, (kstat_named_t
*)p
);
279 case KSTAT_TYPE_INTR
:
280 rc
= kstat_seq_show_intr(f
, (kstat_intr_t
*)p
);
283 rc
= kstat_seq_show_io(f
, (kstat_io_t
*)p
);
285 case KSTAT_TYPE_TIMER
:
286 rc
= kstat_seq_show_timer(f
, (kstat_timer_t
*)p
);
289 rc
= kstat_seq_show_txg(f
, (kstat_txg_t
*)p
);
292 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
299 kstat_default_update(kstat_t
*ksp
, int rw
)
303 if (rw
== KSTAT_WRITE
)
310 kstat_seq_data_addr(kstat_t
*ksp
, loff_t n
)
315 switch (ksp
->ks_type
) {
317 if (ksp
->ks_raw_ops
.addr
)
318 rc
= ksp
->ks_raw_ops
.addr(ksp
, n
);
322 case KSTAT_TYPE_NAMED
:
323 rc
= ksp
->ks_data
+ n
* sizeof(kstat_named_t
);
325 case KSTAT_TYPE_INTR
:
326 rc
= ksp
->ks_data
+ n
* sizeof(kstat_intr_t
);
329 rc
= ksp
->ks_data
+ n
* sizeof(kstat_io_t
);
331 case KSTAT_TYPE_TIMER
:
332 rc
= ksp
->ks_data
+ n
* sizeof(kstat_timer_t
);
335 rc
= ksp
->ks_data
+ n
* sizeof(kstat_txg_t
);
338 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
345 kstat_seq_start(struct seq_file
*f
, loff_t
*pos
)
348 kstat_t
*ksp
= (kstat_t
*)f
->private;
349 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
352 mutex_enter(&ksp
->ks_lock
);
354 if (ksp
->ks_type
== KSTAT_TYPE_RAW
) {
355 ksp
->ks_raw_bufsize
= PAGE_SIZE
;
356 ksp
->ks_raw_buf
= vmem_alloc(ksp
->ks_raw_bufsize
, KM_SLEEP
);
359 /* Dynamically update kstat, on error existing kstats are used */
360 (void) ksp
->ks_update(ksp
, KSTAT_READ
);
362 ksp
->ks_snaptime
= gethrtime();
364 if (!n
&& kstat_seq_show_headers(f
))
367 if (n
>= ksp
->ks_ndata
)
370 SRETURN(kstat_seq_data_addr(ksp
, n
));
374 kstat_seq_next(struct seq_file
*f
, void *p
, loff_t
*pos
)
376 kstat_t
*ksp
= (kstat_t
*)f
->private;
377 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
381 if (*pos
>= ksp
->ks_ndata
)
384 SRETURN(kstat_seq_data_addr(ksp
, *pos
));
388 kstat_seq_stop(struct seq_file
*f
, void *v
)
390 kstat_t
*ksp
= (kstat_t
*)f
->private;
391 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
393 if (ksp
->ks_type
== KSTAT_TYPE_RAW
)
394 vmem_free(ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
);
396 mutex_exit(&ksp
->ks_lock
);
399 static struct seq_operations kstat_seq_ops
= {
400 .show
= kstat_seq_show
,
401 .start
= kstat_seq_start
,
402 .next
= kstat_seq_next
,
403 .stop
= kstat_seq_stop
,
406 static kstat_module_t
*
407 kstat_find_module(char *name
)
409 kstat_module_t
*module
;
411 list_for_each_entry(module
, &kstat_module_list
, ksm_module_list
)
412 if (strncmp(name
, module
->ksm_name
, KSTAT_STRLEN
) == 0)
418 static kstat_module_t
*
419 kstat_create_module(char *name
)
421 kstat_module_t
*module
;
422 struct proc_dir_entry
*pde
;
424 pde
= proc_mkdir(name
, proc_spl_kstat
);
428 module
= kmem_alloc(sizeof (kstat_module_t
), KM_SLEEP
);
429 module
->ksm_proc
= pde
;
430 strlcpy(module
->ksm_name
, name
, KSTAT_STRLEN
+1);
431 INIT_LIST_HEAD(&module
->ksm_kstat_list
);
432 list_add_tail(&module
->ksm_module_list
, &kstat_module_list
);
439 kstat_delete_module(kstat_module_t
*module
)
441 ASSERT(list_empty(&module
->ksm_kstat_list
));
442 remove_proc_entry(module
->ksm_name
, proc_spl_kstat
);
443 list_del(&module
->ksm_module_list
);
444 kmem_free(module
, sizeof(kstat_module_t
));
448 proc_kstat_open(struct inode
*inode
, struct file
*filp
)
453 rc
= seq_open(filp
, &kstat_seq_ops
);
457 f
= filp
->private_data
;
458 f
->private = PDE_DATA(inode
);
464 proc_kstat_write(struct file
*filp
, const char __user
*buf
,
465 size_t len
, loff_t
*ppos
)
467 struct seq_file
*f
= filp
->private_data
;
468 kstat_t
*ksp
= f
->private;
471 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
473 mutex_enter(ksp
->ks_lock
);
474 rc
= ksp
->ks_update(ksp
, KSTAT_WRITE
);
475 mutex_exit(ksp
->ks_lock
);
484 static struct file_operations proc_kstat_operations
= {
485 .open
= proc_kstat_open
,
486 .write
= proc_kstat_write
,
489 .release
= seq_release
,
493 __kstat_set_raw_ops(kstat_t
*ksp
,
494 int (*headers
)(char *buf
, size_t size
),
495 int (*data
)(char *buf
, size_t size
, void *data
),
496 void *(*addr
)(kstat_t
*ksp
, loff_t index
))
498 ksp
->ks_raw_ops
.headers
= headers
;
499 ksp
->ks_raw_ops
.data
= data
;
500 ksp
->ks_raw_ops
.addr
= addr
;
502 EXPORT_SYMBOL(__kstat_set_raw_ops
);
505 __kstat_create(const char *ks_module
, int ks_instance
, const char *ks_name
,
506 const char *ks_class
, uchar_t ks_type
, uint_t ks_ndata
,
512 ASSERT(ks_instance
== 0);
514 ASSERT(!(ks_flags
& KSTAT_FLAG_UNSUPPORTED
));
516 if ((ks_type
== KSTAT_TYPE_INTR
) || (ks_type
== KSTAT_TYPE_IO
))
517 ASSERT(ks_ndata
== 1);
519 ksp
= kmem_zalloc(sizeof(*ksp
), KM_SLEEP
);
523 mutex_enter(&kstat_module_lock
);
524 ksp
->ks_kid
= kstat_id
;
526 mutex_exit(&kstat_module_lock
);
528 ksp
->ks_magic
= KS_MAGIC
;
529 mutex_init(&ksp
->ks_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
530 INIT_LIST_HEAD(&ksp
->ks_list
);
532 ksp
->ks_crtime
= gethrtime();
533 ksp
->ks_snaptime
= ksp
->ks_crtime
;
534 strncpy(ksp
->ks_module
, ks_module
, KSTAT_STRLEN
);
535 ksp
->ks_instance
= ks_instance
;
536 strncpy(ksp
->ks_name
, ks_name
, KSTAT_STRLEN
);
537 strncpy(ksp
->ks_class
, ks_class
, KSTAT_STRLEN
);
538 ksp
->ks_type
= ks_type
;
539 ksp
->ks_flags
= ks_flags
;
540 ksp
->ks_update
= kstat_default_update
;
541 ksp
->ks_private
= NULL
;
542 ksp
->ks_raw_ops
.headers
= NULL
;
543 ksp
->ks_raw_ops
.data
= NULL
;
544 ksp
->ks_raw_ops
.addr
= NULL
;
545 ksp
->ks_raw_buf
= NULL
;
546 ksp
->ks_raw_bufsize
= 0;
548 switch (ksp
->ks_type
) {
551 ksp
->ks_data_size
= ks_ndata
;
553 case KSTAT_TYPE_NAMED
:
554 ksp
->ks_ndata
= ks_ndata
;
555 ksp
->ks_data_size
= ks_ndata
* sizeof(kstat_named_t
);
557 case KSTAT_TYPE_INTR
:
558 ksp
->ks_ndata
= ks_ndata
;
559 ksp
->ks_data_size
= ks_ndata
* sizeof(kstat_intr_t
);
562 ksp
->ks_ndata
= ks_ndata
;
563 ksp
->ks_data_size
= ks_ndata
* sizeof(kstat_io_t
);
565 case KSTAT_TYPE_TIMER
:
566 ksp
->ks_ndata
= ks_ndata
;
567 ksp
->ks_data_size
= ks_ndata
* sizeof(kstat_timer_t
);
570 ksp
->ks_ndata
= ks_ndata
;
571 ksp
->ks_data_size
= ks_ndata
* sizeof(kstat_timer_t
);
574 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
577 if (ksp
->ks_flags
& KSTAT_FLAG_VIRTUAL
) {
580 ksp
->ks_data
= kmem_alloc(ksp
->ks_data_size
, KM_SLEEP
);
581 if (ksp
->ks_data
== NULL
) {
582 kmem_free(ksp
, sizeof(*ksp
));
589 EXPORT_SYMBOL(__kstat_create
);
592 __kstat_install(kstat_t
*ksp
)
594 kstat_module_t
*module
;
599 mutex_enter(&kstat_module_lock
);
601 module
= kstat_find_module(ksp
->ks_module
);
602 if (module
== NULL
) {
603 module
= kstat_create_module(ksp
->ks_module
);
609 * Only one entry by this name per-module, on failure the module
610 * shouldn't be deleted because we know it has at least one entry.
612 list_for_each_entry(tmp
, &module
->ksm_kstat_list
, ks_list
)
613 if (strncmp(tmp
->ks_name
, ksp
->ks_name
, KSTAT_STRLEN
) == 0)
616 list_add_tail(&ksp
->ks_list
, &module
->ksm_kstat_list
);
618 mutex_enter(&ksp
->ks_lock
);
619 ksp
->ks_owner
= module
;
620 ksp
->ks_proc
= proc_create_data(ksp
->ks_name
, 0644,
621 module
->ksm_proc
, &proc_kstat_operations
, (void *)ksp
);
622 if (ksp
->ks_proc
== NULL
) {
623 list_del_init(&ksp
->ks_list
);
624 if (list_empty(&module
->ksm_kstat_list
))
625 kstat_delete_module(module
);
627 mutex_exit(&ksp
->ks_lock
);
629 mutex_exit(&kstat_module_lock
);
631 EXPORT_SYMBOL(__kstat_install
);
634 __kstat_delete(kstat_t
*ksp
)
636 kstat_module_t
*module
= ksp
->ks_owner
;
638 mutex_enter(&kstat_module_lock
);
639 list_del_init(&ksp
->ks_list
);
640 mutex_exit(&kstat_module_lock
);
643 remove_proc_entry(ksp
->ks_name
, module
->ksm_proc
);
645 /* Remove top level module directory if it's empty */
646 if (list_empty(&module
->ksm_kstat_list
))
647 kstat_delete_module(module
);
650 if (!(ksp
->ks_flags
& KSTAT_FLAG_VIRTUAL
))
651 kmem_free(ksp
->ks_data
, ksp
->ks_data_size
);
653 mutex_destroy(&ksp
->ks_lock
);
654 kmem_free(ksp
, sizeof(*ksp
));
658 EXPORT_SYMBOL(__kstat_delete
);
664 mutex_init(&kstat_module_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
665 INIT_LIST_HEAD(&kstat_module_list
);
674 ASSERT(list_empty(&kstat_module_list
));
675 mutex_destroy(&kstat_module_lock
);