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/>.
23 * Solaris Porting Layer (SPL) Kstat Implementation.
25 * Links to Illumos.org for more information on kstat function:
26 * [1] https://illumos.org/man/1M/kstat
27 * [2] https://illumos.org/man/9f/kstat_create
30 #include <linux/seq_file.h>
31 #include <sys/kstat.h>
33 #include <sys/cmn_err.h>
34 #include <sys/sysmacros.h>
36 static kmutex_t kstat_module_lock;
37 static struct list_head kstat_module_list;
38 static kid_t kstat_id;
41 kstat_resize_raw(kstat_t *ksp)
43 if (ksp->ks_raw_bufsize == KSTAT_RAW_MAX)
46 vmem_free(ksp->ks_raw_buf, ksp->ks_raw_bufsize);
47 ksp->ks_raw_bufsize = MIN(ksp->ks_raw_bufsize * 2, KSTAT_RAW_MAX);
48 ksp->ks_raw_buf = vmem_alloc(ksp->ks_raw_bufsize, KM_SLEEP);
54 kstat_waitq_enter(kstat_io_t *kiop)
60 delta = new - kiop->wlastupdate;
61 kiop->wlastupdate = new;
64 kiop->wlentime += delta * wcnt;
68 EXPORT_SYMBOL(kstat_waitq_enter);
71 kstat_waitq_exit(kstat_io_t *kiop)
77 delta = new - kiop->wlastupdate;
78 kiop->wlastupdate = new;
80 ASSERT((int)wcnt > 0);
81 kiop->wlentime += delta * wcnt;
84 EXPORT_SYMBOL(kstat_waitq_exit);
87 kstat_runq_enter(kstat_io_t *kiop)
93 delta = new - kiop->rlastupdate;
94 kiop->rlastupdate = new;
97 kiop->rlentime += delta * rcnt;
101 EXPORT_SYMBOL(kstat_runq_enter);
104 kstat_runq_exit(kstat_io_t *kiop)
110 delta = new - kiop->rlastupdate;
111 kiop->rlastupdate = new;
113 ASSERT((int)rcnt > 0);
114 kiop->rlentime += delta * rcnt;
115 kiop->rtime += delta;
117 EXPORT_SYMBOL(kstat_runq_exit);
120 kstat_seq_show_headers(struct seq_file *f)
122 kstat_t *ksp = (kstat_t *)f->private;
125 ASSERT(ksp->ks_magic == KS_MAGIC);
127 seq_printf(f, "%d %d 0x%02x %d %d %lld %lld\n",
128 ksp->ks_kid, ksp->ks_type, ksp->ks_flags,
129 ksp->ks_ndata, (int)ksp->ks_data_size,
130 ksp->ks_crtime, ksp->ks_snaptime);
132 switch (ksp->ks_type) {
135 if (ksp->ks_raw_ops.headers) {
136 rc = ksp->ks_raw_ops.headers(
137 ksp->ks_raw_buf, ksp->ks_raw_bufsize);
138 if (rc == ENOMEM && !kstat_resize_raw(ksp))
141 seq_puts(f, ksp->ks_raw_buf);
143 seq_printf(f, "raw data\n");
146 case KSTAT_TYPE_NAMED:
147 seq_printf(f, "%-31s %-4s %s\n",
148 "name", "type", "data");
150 case KSTAT_TYPE_INTR:
151 seq_printf(f, "%-8s %-8s %-8s %-8s %-8s\n",
152 "hard", "soft", "watchdog",
153 "spurious", "multsvc");
157 "%-8s %-8s %-8s %-8s %-8s %-8s "
158 "%-8s %-8s %-8s %-8s %-8s %-8s\n",
159 "nread", "nwritten", "reads", "writes",
160 "wtime", "wlentime", "wupdate",
161 "rtime", "rlentime", "rupdate",
164 case KSTAT_TYPE_TIMER:
167 "%-8s %-8s %-8s %-8s %-8s\n",
168 "name", "events", "elapsed",
169 "min", "max", "start", "stop");
172 PANIC("Undefined kstat type %d\n", ksp->ks_type);
179 kstat_seq_show_raw(struct seq_file *f, unsigned char *p, int l)
184 seq_printf(f, "%03x:", i);
186 for (j = 0; j < 16; j++) {
187 if (i * 16 + j >= l) {
192 seq_printf(f, " %02x", (unsigned char)p[i * 16 + j]);
201 kstat_seq_show_named(struct seq_file *f, kstat_named_t *knp)
203 seq_printf(f, "%-31s %-4d ", knp->name, knp->data_type);
205 switch (knp->data_type) {
206 case KSTAT_DATA_CHAR:
207 knp->value.c[15] = '\0'; /* NULL terminate */
208 seq_printf(f, "%-16s", knp->value.c);
211 * NOTE - We need to be more careful able what tokens are
212 * used for each arch, for now this is correct for x86_64.
214 case KSTAT_DATA_INT32:
215 seq_printf(f, "%d", knp->value.i32);
217 case KSTAT_DATA_UINT32:
218 seq_printf(f, "%u", knp->value.ui32);
220 case KSTAT_DATA_INT64:
221 seq_printf(f, "%lld", (signed long long)knp->value.i64);
223 case KSTAT_DATA_UINT64:
224 seq_printf(f, "%llu",
225 (unsigned long long)knp->value.ui64);
227 case KSTAT_DATA_LONG:
228 seq_printf(f, "%ld", knp->value.l);
230 case KSTAT_DATA_ULONG:
231 seq_printf(f, "%lu", knp->value.ul);
233 case KSTAT_DATA_STRING:
234 KSTAT_NAMED_STR_PTR(knp)
235 [KSTAT_NAMED_STR_BUFLEN(knp)-1] = '\0';
236 seq_printf(f, "%s", KSTAT_NAMED_STR_PTR(knp));
239 PANIC("Undefined kstat data type %d\n", knp->data_type);
248 kstat_seq_show_intr(struct seq_file *f, kstat_intr_t *kip)
250 seq_printf(f, "%-8u %-8u %-8u %-8u %-8u\n",
251 kip->intrs[KSTAT_INTR_HARD],
252 kip->intrs[KSTAT_INTR_SOFT],
253 kip->intrs[KSTAT_INTR_WATCHDOG],
254 kip->intrs[KSTAT_INTR_SPURIOUS],
255 kip->intrs[KSTAT_INTR_MULTSVC]);
261 kstat_seq_show_io(struct seq_file *f, kstat_io_t *kip)
263 /* though wlentime & friends are signed, they will never be negative */
265 "%-8llu %-8llu %-8u %-8u %-8llu %-8llu "
266 "%-8llu %-8llu %-8llu %-8llu %-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 %-8llu %-8llu %-8llu %-8llu %-8llu\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 = NULL;
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 const kstat_proc_op_t proc_kstat_operations = {
514 #ifdef HAVE_PROC_OPS_STRUCT
515 .proc_open = proc_kstat_open,
516 .proc_write = proc_kstat_write,
517 .proc_read = seq_read,
518 .proc_lseek = seq_lseek,
519 .proc_release = seq_release,
521 .open = proc_kstat_open,
522 .write = proc_kstat_write,
525 .release = seq_release,
530 __kstat_set_raw_ops(kstat_t *ksp,
531 int (*headers)(char *buf, size_t size),
532 int (*data)(char *buf, size_t size, void *data),
533 void *(*addr)(kstat_t *ksp, loff_t index))
535 ksp->ks_raw_ops.headers = headers;
536 ksp->ks_raw_ops.data = data;
537 ksp->ks_raw_ops.addr = addr;
539 EXPORT_SYMBOL(__kstat_set_raw_ops);
542 kstat_proc_entry_init(kstat_proc_entry_t *kpep, const char *module,
545 kpep->kpe_owner = NULL;
546 kpep->kpe_proc = NULL;
547 INIT_LIST_HEAD(&kpep->kpe_list);
548 strncpy(kpep->kpe_module, module, KSTAT_STRLEN);
549 strncpy(kpep->kpe_name, name, KSTAT_STRLEN);
551 EXPORT_SYMBOL(kstat_proc_entry_init);
554 __kstat_create(const char *ks_module, int ks_instance, const char *ks_name,
555 const char *ks_class, uchar_t ks_type, uint_t ks_ndata,
561 ASSERT(ks_instance == 0);
564 if ((ks_type == KSTAT_TYPE_INTR) || (ks_type == KSTAT_TYPE_IO))
565 ASSERT(ks_ndata == 1);
567 ksp = kmem_zalloc(sizeof (*ksp), KM_SLEEP);
571 mutex_enter(&kstat_module_lock);
572 ksp->ks_kid = kstat_id;
574 mutex_exit(&kstat_module_lock);
576 ksp->ks_magic = KS_MAGIC;
577 mutex_init(&ksp->ks_private_lock, NULL, MUTEX_DEFAULT, NULL);
578 ksp->ks_lock = &ksp->ks_private_lock;
580 ksp->ks_crtime = gethrtime();
581 ksp->ks_snaptime = ksp->ks_crtime;
582 ksp->ks_instance = ks_instance;
583 strncpy(ksp->ks_class, ks_class, KSTAT_STRLEN);
584 ksp->ks_type = ks_type;
585 ksp->ks_flags = ks_flags;
586 ksp->ks_update = kstat_default_update;
587 ksp->ks_private = NULL;
588 ksp->ks_raw_ops.headers = NULL;
589 ksp->ks_raw_ops.data = NULL;
590 ksp->ks_raw_ops.addr = NULL;
591 ksp->ks_raw_buf = NULL;
592 ksp->ks_raw_bufsize = 0;
593 kstat_proc_entry_init(&ksp->ks_proc, ks_module, ks_name);
595 switch (ksp->ks_type) {
598 ksp->ks_data_size = ks_ndata;
600 case KSTAT_TYPE_NAMED:
601 ksp->ks_ndata = ks_ndata;
602 ksp->ks_data_size = ks_ndata * sizeof (kstat_named_t);
604 case KSTAT_TYPE_INTR:
605 ksp->ks_ndata = ks_ndata;
606 ksp->ks_data_size = ks_ndata * sizeof (kstat_intr_t);
609 ksp->ks_ndata = ks_ndata;
610 ksp->ks_data_size = ks_ndata * sizeof (kstat_io_t);
612 case KSTAT_TYPE_TIMER:
613 ksp->ks_ndata = ks_ndata;
614 ksp->ks_data_size = ks_ndata * sizeof (kstat_timer_t);
617 PANIC("Undefined kstat type %d\n", ksp->ks_type);
620 if (ksp->ks_flags & KSTAT_FLAG_VIRTUAL) {
623 ksp->ks_data = kmem_zalloc(ksp->ks_data_size, KM_SLEEP);
624 if (ksp->ks_data == NULL) {
625 kmem_free(ksp, sizeof (*ksp));
632 EXPORT_SYMBOL(__kstat_create);
635 kstat_detect_collision(kstat_proc_entry_t *kpep)
637 kstat_module_t *module;
638 kstat_proc_entry_t *tmp = NULL;
642 parent = kmem_asprintf("%s", kpep->kpe_module);
644 if ((cp = strrchr(parent, '/')) == NULL) {
645 kmem_strfree(parent);
650 if ((module = kstat_find_module(parent)) != NULL) {
651 list_for_each_entry(tmp, &module->ksm_kstat_list, kpe_list) {
652 if (strncmp(tmp->kpe_name, cp+1, KSTAT_STRLEN) == 0) {
653 kmem_strfree(parent);
659 kmem_strfree(parent);
664 * Add a file to the proc filesystem under the kstat namespace (i.e.
665 * /proc/spl/kstat/). The file need not necessarily be implemented as a
669 kstat_proc_entry_install(kstat_proc_entry_t *kpep, mode_t mode,
670 const kstat_proc_op_t *proc_ops, void *data)
672 kstat_module_t *module;
673 kstat_proc_entry_t *tmp = NULL;
677 mutex_enter(&kstat_module_lock);
679 module = kstat_find_module(kpep->kpe_module);
680 if (module == NULL) {
681 if (kstat_detect_collision(kpep) != 0) {
682 cmn_err(CE_WARN, "kstat_create('%s', '%s'): namespace" \
683 " collision", kpep->kpe_module, kpep->kpe_name);
686 module = kstat_create_module(kpep->kpe_module);
692 * Only one entry by this name per-module, on failure the module
693 * shouldn't be deleted because we know it has at least one entry.
695 list_for_each_entry(tmp, &module->ksm_kstat_list, kpe_list) {
696 if (strncmp(tmp->kpe_name, kpep->kpe_name, KSTAT_STRLEN) == 0)
700 list_add_tail(&kpep->kpe_list, &module->ksm_kstat_list);
702 kpep->kpe_owner = module;
703 kpep->kpe_proc = proc_create_data(kpep->kpe_name, mode,
704 module->ksm_proc, proc_ops, data);
705 if (kpep->kpe_proc == NULL) {
706 list_del_init(&kpep->kpe_list);
707 if (list_empty(&module->ksm_kstat_list))
708 kstat_delete_module(module);
711 mutex_exit(&kstat_module_lock);
714 EXPORT_SYMBOL(kstat_proc_entry_install);
717 __kstat_install(kstat_t *ksp)
721 /* Specify permission modes for different kstats */
722 if (strncmp(ksp->ks_proc.kpe_name, "dbufs", KSTAT_STRLEN) == 0) {
727 kstat_proc_entry_install(
728 &ksp->ks_proc, mode, &proc_kstat_operations, ksp);
730 EXPORT_SYMBOL(__kstat_install);
733 kstat_proc_entry_delete(kstat_proc_entry_t *kpep)
735 kstat_module_t *module = kpep->kpe_owner;
737 remove_proc_entry(kpep->kpe_name, module->ksm_proc);
739 mutex_enter(&kstat_module_lock);
740 list_del_init(&kpep->kpe_list);
743 * Remove top level module directory if it wasn't empty before, but now
746 if (kpep->kpe_proc && list_empty(&module->ksm_kstat_list))
747 kstat_delete_module(module);
748 mutex_exit(&kstat_module_lock);
751 EXPORT_SYMBOL(kstat_proc_entry_delete);
754 __kstat_delete(kstat_t *ksp)
756 kstat_proc_entry_delete(&ksp->ks_proc);
758 if (!(ksp->ks_flags & KSTAT_FLAG_VIRTUAL))
759 kmem_free(ksp->ks_data, ksp->ks_data_size);
762 mutex_destroy(&ksp->ks_private_lock);
763 kmem_free(ksp, sizeof (*ksp));
765 EXPORT_SYMBOL(__kstat_delete);
770 mutex_init(&kstat_module_lock, NULL, MUTEX_DEFAULT, NULL);
771 INIT_LIST_HEAD(&kstat_module_list);
779 ASSERT(list_empty(&kstat_module_list));
780 mutex_destroy(&kstat_module_lock);