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/>.
24 * Solaris Porting Layer (SPL) Kstat Implementation.
27 #include <linux/seq_file.h>
28 #include <sys/kstat.h>
30 #include <sys/cmn_err.h>
31 #include <sys/sysmacros.h>
34 #define PDE_DATA(x) (PDE(x)->data)
37 static kmutex_t kstat_module_lock
;
38 static struct list_head kstat_module_list
;
39 static kid_t kstat_id
;
42 kstat_resize_raw(kstat_t
*ksp
)
44 if (ksp
->ks_raw_bufsize
== KSTAT_RAW_MAX
)
47 vmem_free(ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
);
48 ksp
->ks_raw_bufsize
= MIN(ksp
->ks_raw_bufsize
* 2, KSTAT_RAW_MAX
);
49 ksp
->ks_raw_buf
= vmem_alloc(ksp
->ks_raw_bufsize
, KM_SLEEP
);
55 kstat_waitq_enter(kstat_io_t
*kiop
)
61 delta
= new - kiop
->wlastupdate
;
62 kiop
->wlastupdate
= new;
65 kiop
->wlentime
+= delta
* wcnt
;
69 EXPORT_SYMBOL(kstat_waitq_enter
);
72 kstat_waitq_exit(kstat_io_t
*kiop
)
78 delta
= new - kiop
->wlastupdate
;
79 kiop
->wlastupdate
= new;
81 ASSERT((int)wcnt
> 0);
82 kiop
->wlentime
+= delta
* wcnt
;
85 EXPORT_SYMBOL(kstat_waitq_exit
);
88 kstat_runq_enter(kstat_io_t
*kiop
)
94 delta
= new - kiop
->rlastupdate
;
95 kiop
->rlastupdate
= new;
98 kiop
->rlentime
+= delta
* rcnt
;
102 EXPORT_SYMBOL(kstat_runq_enter
);
105 kstat_runq_exit(kstat_io_t
*kiop
)
111 delta
= new - kiop
->rlastupdate
;
112 kiop
->rlastupdate
= new;
114 ASSERT((int)rcnt
> 0);
115 kiop
->rlentime
+= delta
* rcnt
;
116 kiop
->rtime
+= delta
;
118 EXPORT_SYMBOL(kstat_runq_exit
);
121 kstat_seq_show_headers(struct seq_file
*f
)
123 kstat_t
*ksp
= (kstat_t
*)f
->private;
126 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
128 seq_printf(f
, "%d %d 0x%02x %d %d %lld %lld\n",
129 ksp
->ks_kid
, ksp
->ks_type
, ksp
->ks_flags
,
130 ksp
->ks_ndata
, (int)ksp
->ks_data_size
,
131 ksp
->ks_crtime
, ksp
->ks_snaptime
);
133 switch (ksp
->ks_type
) {
136 if (ksp
->ks_raw_ops
.headers
) {
137 rc
= ksp
->ks_raw_ops
.headers(
138 ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
);
139 if (rc
== ENOMEM
&& !kstat_resize_raw(ksp
))
142 seq_puts(f
, ksp
->ks_raw_buf
);
144 seq_printf(f
, "raw data\n");
147 case KSTAT_TYPE_NAMED
:
148 seq_printf(f
, "%-31s %-4s %s\n",
149 "name", "type", "data");
151 case KSTAT_TYPE_INTR
:
152 seq_printf(f
, "%-8s %-8s %-8s %-8s %-8s\n",
153 "hard", "soft", "watchdog",
154 "spurious", "multsvc");
158 "%-8s %-8s %-8s %-8s %-8s %-8s "
159 "%-8s %-8s %-8s %-8s %-8s %-8s\n",
160 "nread", "nwritten", "reads", "writes",
161 "wtime", "wlentime", "wupdate",
162 "rtime", "rlentime", "rupdate",
165 case KSTAT_TYPE_TIMER
:
168 "%-8s %-8s %-8s %-8s %-8s\n",
169 "name", "events", "elapsed",
170 "min", "max", "start", "stop");
173 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
180 kstat_seq_show_raw(struct seq_file
*f
, unsigned char *p
, int l
)
185 seq_printf(f
, "%03x:", i
);
187 for (j
= 0; j
< 16; j
++) {
188 if (i
* 16 + j
>= l
) {
193 seq_printf(f
, " %02x", (unsigned char)p
[i
* 16 + j
]);
202 kstat_seq_show_named(struct seq_file
*f
, kstat_named_t
*knp
)
204 seq_printf(f
, "%-31s %-4d ", knp
->name
, knp
->data_type
);
206 switch (knp
->data_type
) {
207 case KSTAT_DATA_CHAR
:
208 knp
->value
.c
[15] = '\0'; /* NULL terminate */
209 seq_printf(f
, "%-16s", knp
->value
.c
);
212 * NOTE - We need to be more careful able what tokens are
213 * used for each arch, for now this is correct for x86_64.
215 case KSTAT_DATA_INT32
:
216 seq_printf(f
, "%d", knp
->value
.i32
);
218 case KSTAT_DATA_UINT32
:
219 seq_printf(f
, "%u", knp
->value
.ui32
);
221 case KSTAT_DATA_INT64
:
222 seq_printf(f
, "%lld", (signed long long)knp
->value
.i64
);
224 case KSTAT_DATA_UINT64
:
225 seq_printf(f
, "%llu",
226 (unsigned long long)knp
->value
.ui64
);
228 case KSTAT_DATA_LONG
:
229 seq_printf(f
, "%ld", knp
->value
.l
);
231 case KSTAT_DATA_ULONG
:
232 seq_printf(f
, "%lu", knp
->value
.ul
);
234 case KSTAT_DATA_STRING
:
235 KSTAT_NAMED_STR_PTR(knp
)
236 [KSTAT_NAMED_STR_BUFLEN(knp
)-1] = '\0';
237 seq_printf(f
, "%s", KSTAT_NAMED_STR_PTR(knp
));
240 PANIC("Undefined kstat data type %d\n", knp
->data_type
);
249 kstat_seq_show_intr(struct seq_file
*f
, kstat_intr_t
*kip
)
251 seq_printf(f
, "%-8u %-8u %-8u %-8u %-8u\n",
252 kip
->intrs
[KSTAT_INTR_HARD
],
253 kip
->intrs
[KSTAT_INTR_SOFT
],
254 kip
->intrs
[KSTAT_INTR_WATCHDOG
],
255 kip
->intrs
[KSTAT_INTR_SPURIOUS
],
256 kip
->intrs
[KSTAT_INTR_MULTSVC
]);
262 kstat_seq_show_io(struct seq_file
*f
, kstat_io_t
*kip
)
265 "%-8llu %-8llu %-8u %-8u %-8lld %-8lld "
266 "%-8lld %-8lld %-8lld %-8lld %-8u %-8u\n",
267 kip
->nread
, kip
->nwritten
,
268 kip
->reads
, kip
->writes
,
269 kip
->wtime
, kip
->wlentime
, kip
->wlastupdate
,
270 kip
->rtime
, kip
->rlentime
, kip
->rlastupdate
,
271 kip
->wcnt
, kip
->rcnt
);
277 kstat_seq_show_timer(struct seq_file
*f
, kstat_timer_t
*ktp
)
280 "%-31s %-8llu %-8lld %-8lld %-8lld %-8lld %-8lld\n",
281 ktp
->name
, ktp
->num_events
, ktp
->elapsed_time
,
282 ktp
->min_time
, ktp
->max_time
,
283 ktp
->start_time
, ktp
->stop_time
);
289 kstat_seq_show(struct seq_file
*f
, void *p
)
291 kstat_t
*ksp
= (kstat_t
*)f
->private;
294 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
296 switch (ksp
->ks_type
) {
299 if (ksp
->ks_raw_ops
.data
) {
300 rc
= ksp
->ks_raw_ops
.data(
301 ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
, p
);
302 if (rc
== ENOMEM
&& !kstat_resize_raw(ksp
))
305 seq_puts(f
, ksp
->ks_raw_buf
);
307 ASSERT(ksp
->ks_ndata
== 1);
308 rc
= kstat_seq_show_raw(f
, ksp
->ks_data
,
312 case KSTAT_TYPE_NAMED
:
313 rc
= kstat_seq_show_named(f
, (kstat_named_t
*)p
);
315 case KSTAT_TYPE_INTR
:
316 rc
= kstat_seq_show_intr(f
, (kstat_intr_t
*)p
);
319 rc
= kstat_seq_show_io(f
, (kstat_io_t
*)p
);
321 case KSTAT_TYPE_TIMER
:
322 rc
= kstat_seq_show_timer(f
, (kstat_timer_t
*)p
);
325 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
332 kstat_default_update(kstat_t
*ksp
, int rw
)
336 if (rw
== KSTAT_WRITE
)
343 kstat_seq_data_addr(kstat_t
*ksp
, loff_t n
)
347 switch (ksp
->ks_type
) {
349 if (ksp
->ks_raw_ops
.addr
)
350 rc
= ksp
->ks_raw_ops
.addr(ksp
, n
);
354 case KSTAT_TYPE_NAMED
:
355 rc
= ksp
->ks_data
+ n
* sizeof (kstat_named_t
);
357 case KSTAT_TYPE_INTR
:
358 rc
= ksp
->ks_data
+ n
* sizeof (kstat_intr_t
);
361 rc
= ksp
->ks_data
+ n
* sizeof (kstat_io_t
);
363 case KSTAT_TYPE_TIMER
:
364 rc
= ksp
->ks_data
+ n
* sizeof (kstat_timer_t
);
367 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
374 kstat_seq_start(struct seq_file
*f
, loff_t
*pos
)
377 kstat_t
*ksp
= (kstat_t
*)f
->private;
378 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
380 mutex_enter(ksp
->ks_lock
);
382 if (ksp
->ks_type
== KSTAT_TYPE_RAW
) {
383 ksp
->ks_raw_bufsize
= PAGE_SIZE
;
384 ksp
->ks_raw_buf
= vmem_alloc(ksp
->ks_raw_bufsize
, KM_SLEEP
);
387 /* Dynamically update kstat, on error existing kstats are used */
388 (void) ksp
->ks_update(ksp
, KSTAT_READ
);
390 ksp
->ks_snaptime
= gethrtime();
392 if (!(ksp
->ks_flags
& KSTAT_FLAG_NO_HEADERS
) && !n
&&
393 kstat_seq_show_headers(f
))
396 if (n
>= ksp
->ks_ndata
)
399 return (kstat_seq_data_addr(ksp
, n
));
403 kstat_seq_next(struct seq_file
*f
, void *p
, loff_t
*pos
)
405 kstat_t
*ksp
= (kstat_t
*)f
->private;
406 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
409 if (*pos
>= ksp
->ks_ndata
)
412 return (kstat_seq_data_addr(ksp
, *pos
));
416 kstat_seq_stop(struct seq_file
*f
, void *v
)
418 kstat_t
*ksp
= (kstat_t
*)f
->private;
419 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
421 if (ksp
->ks_type
== KSTAT_TYPE_RAW
)
422 vmem_free(ksp
->ks_raw_buf
, ksp
->ks_raw_bufsize
);
424 mutex_exit(ksp
->ks_lock
);
427 static struct seq_operations kstat_seq_ops
= {
428 .show
= kstat_seq_show
,
429 .start
= kstat_seq_start
,
430 .next
= kstat_seq_next
,
431 .stop
= kstat_seq_stop
,
434 static kstat_module_t
*
435 kstat_find_module(char *name
)
437 kstat_module_t
*module
;
439 list_for_each_entry(module
, &kstat_module_list
, ksm_module_list
) {
440 if (strncmp(name
, module
->ksm_name
, KSTAT_STRLEN
) == 0)
447 static kstat_module_t
*
448 kstat_create_module(char *name
)
450 kstat_module_t
*module
;
451 struct proc_dir_entry
*pde
;
453 pde
= proc_mkdir(name
, proc_spl_kstat
);
457 module
= kmem_alloc(sizeof (kstat_module_t
), KM_SLEEP
);
458 module
->ksm_proc
= pde
;
459 strlcpy(module
->ksm_name
, name
, KSTAT_STRLEN
+1);
460 INIT_LIST_HEAD(&module
->ksm_kstat_list
);
461 list_add_tail(&module
->ksm_module_list
, &kstat_module_list
);
468 kstat_delete_module(kstat_module_t
*module
)
470 ASSERT(list_empty(&module
->ksm_kstat_list
));
471 remove_proc_entry(module
->ksm_name
, proc_spl_kstat
);
472 list_del(&module
->ksm_module_list
);
473 kmem_free(module
, sizeof (kstat_module_t
));
477 proc_kstat_open(struct inode
*inode
, struct file
*filp
)
482 rc
= seq_open(filp
, &kstat_seq_ops
);
486 f
= filp
->private_data
;
487 f
->private = PDE_DATA(inode
);
493 proc_kstat_write(struct file
*filp
, const char __user
*buf
, size_t len
,
496 struct seq_file
*f
= filp
->private_data
;
497 kstat_t
*ksp
= f
->private;
500 ASSERT(ksp
->ks_magic
== KS_MAGIC
);
502 mutex_enter(ksp
->ks_lock
);
503 rc
= ksp
->ks_update(ksp
, KSTAT_WRITE
);
504 mutex_exit(ksp
->ks_lock
);
513 static struct file_operations proc_kstat_operations
= {
514 .open
= proc_kstat_open
,
515 .write
= proc_kstat_write
,
518 .release
= seq_release
,
522 __kstat_set_raw_ops(kstat_t
*ksp
,
523 int (*headers
)(char *buf
, size_t size
),
524 int (*data
)(char *buf
, size_t size
, void *data
),
525 void *(*addr
)(kstat_t
*ksp
, loff_t index
))
527 ksp
->ks_raw_ops
.headers
= headers
;
528 ksp
->ks_raw_ops
.data
= data
;
529 ksp
->ks_raw_ops
.addr
= addr
;
531 EXPORT_SYMBOL(__kstat_set_raw_ops
);
534 kstat_proc_entry_init(kstat_proc_entry_t
*kpep
, const char *module
,
537 kpep
->kpe_owner
= NULL
;
538 kpep
->kpe_proc
= NULL
;
539 INIT_LIST_HEAD(&kpep
->kpe_list
);
540 strncpy(kpep
->kpe_module
, module
, KSTAT_STRLEN
);
541 strncpy(kpep
->kpe_name
, name
, KSTAT_STRLEN
);
543 EXPORT_SYMBOL(kstat_proc_entry_init
);
546 __kstat_create(const char *ks_module
, int ks_instance
, const char *ks_name
,
547 const char *ks_class
, uchar_t ks_type
, uint_t ks_ndata
,
553 ASSERT(ks_instance
== 0);
556 if ((ks_type
== KSTAT_TYPE_INTR
) || (ks_type
== KSTAT_TYPE_IO
))
557 ASSERT(ks_ndata
== 1);
559 ksp
= kmem_zalloc(sizeof (*ksp
), KM_SLEEP
);
563 mutex_enter(&kstat_module_lock
);
564 ksp
->ks_kid
= kstat_id
;
566 mutex_exit(&kstat_module_lock
);
568 ksp
->ks_magic
= KS_MAGIC
;
569 mutex_init(&ksp
->ks_private_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
570 ksp
->ks_lock
= &ksp
->ks_private_lock
;
572 ksp
->ks_crtime
= gethrtime();
573 ksp
->ks_snaptime
= ksp
->ks_crtime
;
574 ksp
->ks_instance
= ks_instance
;
575 strncpy(ksp
->ks_class
, ks_class
, KSTAT_STRLEN
);
576 ksp
->ks_type
= ks_type
;
577 ksp
->ks_flags
= ks_flags
;
578 ksp
->ks_update
= kstat_default_update
;
579 ksp
->ks_private
= NULL
;
580 ksp
->ks_raw_ops
.headers
= NULL
;
581 ksp
->ks_raw_ops
.data
= NULL
;
582 ksp
->ks_raw_ops
.addr
= NULL
;
583 ksp
->ks_raw_buf
= NULL
;
584 ksp
->ks_raw_bufsize
= 0;
585 kstat_proc_entry_init(&ksp
->ks_proc
, ks_module
, ks_name
);
587 switch (ksp
->ks_type
) {
590 ksp
->ks_data_size
= ks_ndata
;
592 case KSTAT_TYPE_NAMED
:
593 ksp
->ks_ndata
= ks_ndata
;
594 ksp
->ks_data_size
= ks_ndata
* sizeof (kstat_named_t
);
596 case KSTAT_TYPE_INTR
:
597 ksp
->ks_ndata
= ks_ndata
;
598 ksp
->ks_data_size
= ks_ndata
* sizeof (kstat_intr_t
);
601 ksp
->ks_ndata
= ks_ndata
;
602 ksp
->ks_data_size
= ks_ndata
* sizeof (kstat_io_t
);
604 case KSTAT_TYPE_TIMER
:
605 ksp
->ks_ndata
= ks_ndata
;
606 ksp
->ks_data_size
= ks_ndata
* sizeof (kstat_timer_t
);
609 PANIC("Undefined kstat type %d\n", ksp
->ks_type
);
612 if (ksp
->ks_flags
& KSTAT_FLAG_VIRTUAL
) {
615 ksp
->ks_data
= kmem_zalloc(ksp
->ks_data_size
, KM_SLEEP
);
616 if (ksp
->ks_data
== NULL
) {
617 kmem_free(ksp
, sizeof (*ksp
));
624 EXPORT_SYMBOL(__kstat_create
);
627 kstat_detect_collision(kstat_proc_entry_t
*kpep
)
629 kstat_module_t
*module
;
630 kstat_proc_entry_t
*tmp
;
634 parent
= kmem_asprintf("%s", kpep
->kpe_module
);
636 if ((cp
= strrchr(parent
, '/')) == NULL
) {
642 if ((module
= kstat_find_module(parent
)) != NULL
) {
643 list_for_each_entry(tmp
, &module
->ksm_kstat_list
, kpe_list
) {
644 if (strncmp(tmp
->kpe_name
, cp
+1, KSTAT_STRLEN
) == 0) {
656 * Add a file to the proc filesystem under the kstat namespace (i.e.
657 * /proc/spl/kstat/). The file need not necessarily be implemented as a
661 kstat_proc_entry_install(kstat_proc_entry_t
*kpep
,
662 const struct file_operations
*file_ops
, void *data
)
664 kstat_module_t
*module
;
665 kstat_proc_entry_t
*tmp
;
669 mutex_enter(&kstat_module_lock
);
671 module
= kstat_find_module(kpep
->kpe_module
);
672 if (module
== NULL
) {
673 if (kstat_detect_collision(kpep
) != 0) {
674 cmn_err(CE_WARN
, "kstat_create('%s', '%s'): namespace" \
675 " collision", kpep
->kpe_module
, kpep
->kpe_name
);
678 module
= kstat_create_module(kpep
->kpe_module
);
684 * Only one entry by this name per-module, on failure the module
685 * shouldn't be deleted because we know it has at least one entry.
687 list_for_each_entry(tmp
, &module
->ksm_kstat_list
, kpe_list
) {
688 if (strncmp(tmp
->kpe_name
, kpep
->kpe_name
, KSTAT_STRLEN
) == 0)
692 list_add_tail(&kpep
->kpe_list
, &module
->ksm_kstat_list
);
694 kpep
->kpe_owner
= module
;
695 kpep
->kpe_proc
= proc_create_data(kpep
->kpe_name
, 0644,
696 module
->ksm_proc
, file_ops
, data
);
697 if (kpep
->kpe_proc
== NULL
) {
698 list_del_init(&kpep
->kpe_list
);
699 if (list_empty(&module
->ksm_kstat_list
))
700 kstat_delete_module(module
);
703 mutex_exit(&kstat_module_lock
);
706 EXPORT_SYMBOL(kstat_proc_entry_install
);
709 __kstat_install(kstat_t
*ksp
)
712 kstat_proc_entry_install(&ksp
->ks_proc
, &proc_kstat_operations
, ksp
);
714 EXPORT_SYMBOL(__kstat_install
);
717 kstat_proc_entry_delete(kstat_proc_entry_t
*kpep
)
719 kstat_module_t
*module
= kpep
->kpe_owner
;
721 remove_proc_entry(kpep
->kpe_name
, module
->ksm_proc
);
723 mutex_enter(&kstat_module_lock
);
724 list_del_init(&kpep
->kpe_list
);
727 * Remove top level module directory if it wasn't empty before, but now
730 if (kpep
->kpe_proc
&& list_empty(&module
->ksm_kstat_list
))
731 kstat_delete_module(module
);
732 mutex_exit(&kstat_module_lock
);
735 EXPORT_SYMBOL(kstat_proc_entry_delete
);
738 __kstat_delete(kstat_t
*ksp
)
740 kstat_proc_entry_delete(&ksp
->ks_proc
);
742 if (!(ksp
->ks_flags
& KSTAT_FLAG_VIRTUAL
))
743 kmem_free(ksp
->ks_data
, ksp
->ks_data_size
);
746 mutex_destroy(&ksp
->ks_private_lock
);
747 kmem_free(ksp
, sizeof (*ksp
));
749 EXPORT_SYMBOL(__kstat_delete
);
754 mutex_init(&kstat_module_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
755 INIT_LIST_HEAD(&kstat_module_list
);
763 ASSERT(list_empty(&kstat_module_list
));
764 mutex_destroy(&kstat_module_lock
);