2 * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * Links to Illumos.org for more information on kstat function:
27 * [1] https://illumos.org/man/1M/kstat
28 * [2] https://illumos.org/man/9f/kstat_create
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/types.h>
35 #include <sys/param.h>
36 #include <sys/kernel.h>
37 #include <sys/systm.h>
38 #include <sys/malloc.h>
39 #include <sys/sysctl.h>
40 #include <sys/kstat.h>
43 static MALLOC_DEFINE(M_KSTAT, "kstat_data", "Kernel statistics");
45 SYSCTL_ROOT_NODE(OID_AUTO, kstat, CTLFLAG_RW, 0, "Kernel statistics");
48 __kstat_set_raw_ops(kstat_t *ksp,
49 int (*headers)(char *buf, size_t size),
50 int (*data)(char *buf, size_t size, void *data),
51 void *(*addr)(kstat_t *ksp, loff_t index))
53 ksp->ks_raw_ops.headers = headers;
54 ksp->ks_raw_ops.data = data;
55 ksp->ks_raw_ops.addr = addr;
59 kstat_default_update(kstat_t *ksp, int rw)
63 if (rw == KSTAT_WRITE)
70 kstat_resize_raw(kstat_t *ksp)
72 if (ksp->ks_raw_bufsize == KSTAT_RAW_MAX)
75 free(ksp->ks_raw_buf, M_TEMP);
76 ksp->ks_raw_bufsize = MIN(ksp->ks_raw_bufsize * 2, KSTAT_RAW_MAX);
77 ksp->ks_raw_buf = malloc(ksp->ks_raw_bufsize, M_TEMP, M_WAITOK);
83 kstat_raw_default_addr(kstat_t *ksp, loff_t n)
86 return (ksp->ks_data);
91 kstat_sysctl(SYSCTL_HANDLER_ARGS)
98 /* Select the correct element */
100 /* Update the aggsums before reading */
101 (void) ksp->ks_update(ksp, KSTAT_READ);
102 val = ksent->value.ui64;
104 return (sysctl_handle_64(oidp, &val, 0, req));
108 kstat_sysctl_string(SYSCTL_HANDLER_ARGS)
111 kstat_named_t *ksent = ksp->ks_data;
115 /* Select the correct element */
117 /* Update the aggsums before reading */
118 (void) ksp->ks_update(ksp, KSTAT_READ);
119 val = KSTAT_NAMED_STR_PTR(ksent);
120 len = KSTAT_NAMED_STR_BUFLEN(ksent);
123 return (sysctl_handle_string(oidp, val, len, req));
127 kstat_sysctl_io(SYSCTL_HANDLER_ARGS)
131 kstat_io_t *kip = ksp->ks_data;
134 sb = sbuf_new_auto();
137 /* Update the aggsums before reading */
138 (void) ksp->ks_update(ksp, KSTAT_READ);
140 /* though wlentime & friends are signed, they will never be negative */
142 "%-8llu %-8llu %-8u %-8u %-8llu %-8llu "
143 "%-8llu %-8llu %-8llu %-8llu %-8u %-8u\n",
144 kip->nread, kip->nwritten,
145 kip->reads, kip->writes,
146 kip->wtime, kip->wlentime, kip->wlastupdate,
147 kip->rtime, kip->rlentime, kip->rlastupdate,
148 kip->wcnt, kip->rcnt);
149 rc = sbuf_finish(sb);
151 rc = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb));
157 kstat_sysctl_raw(SYSCTL_HANDLER_ARGS)
162 void *(*addr_op)(kstat_t *ksp, loff_t index);
165 sb = sbuf_new_auto();
169 if (ksp->ks_raw_ops.addr)
170 addr_op = ksp->ks_raw_ops.addr;
172 addr_op = kstat_raw_default_addr;
174 mutex_enter(ksp->ks_lock);
176 /* Update the aggsums before reading */
177 (void) ksp->ks_update(ksp, KSTAT_READ);
179 ksp->ks_raw_bufsize = PAGE_SIZE;
180 ksp->ks_raw_buf = malloc(PAGE_SIZE, M_TEMP, M_WAITOK);
184 if (ksp->ks_raw_ops.headers) {
185 rc = ksp->ks_raw_ops.headers(
186 ksp->ks_raw_buf, ksp->ks_raw_bufsize);
187 if (rc == ENOMEM && !kstat_resize_raw(ksp))
188 goto restart_headers;
190 sbuf_printf(sb, "%s", ksp->ks_raw_buf);
193 while ((data = addr_op(ksp, n)) != NULL) {
195 if (ksp->ks_raw_ops.data) {
196 rc = ksp->ks_raw_ops.data(ksp->ks_raw_buf,
197 ksp->ks_raw_bufsize, data);
198 if (rc == ENOMEM && !kstat_resize_raw(ksp))
201 sbuf_printf(sb, "%s", ksp->ks_raw_buf);
204 ASSERT(ksp->ks_ndata == 1);
205 sbuf_hexdump(sb, ksp->ks_data,
206 ksp->ks_data_size, NULL, 0);
210 free(ksp->ks_raw_buf, M_TEMP);
211 mutex_exit(ksp->ks_lock);
212 rc = sbuf_finish(sb);
214 rc = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb));
220 __kstat_create(const char *module, int instance, const char *name,
221 const char *class, uchar_t ks_type, uint_t ks_ndata, uchar_t flags)
223 struct sysctl_oid *root;
226 KASSERT(instance == 0, ("instance=%d", instance));
227 if ((ks_type == KSTAT_TYPE_INTR) || (ks_type == KSTAT_TYPE_IO))
228 ASSERT(ks_ndata == 1);
231 * Allocate the main structure. We don't need to copy module/class/name
232 * stuff in here, because it is only used for sysctl node creation
233 * done in this function.
235 ksp = malloc(sizeof (*ksp), M_KSTAT, M_WAITOK|M_ZERO);
237 ksp->ks_crtime = gethrtime();
238 ksp->ks_snaptime = ksp->ks_crtime;
239 ksp->ks_instance = instance;
240 strncpy(ksp->ks_name, name, KSTAT_STRLEN);
241 strncpy(ksp->ks_class, class, KSTAT_STRLEN);
242 ksp->ks_type = ks_type;
243 ksp->ks_flags = flags;
244 ksp->ks_update = kstat_default_update;
246 mutex_init(&ksp->ks_private_lock, NULL, MUTEX_DEFAULT, NULL);
247 ksp->ks_lock = &ksp->ks_private_lock;
249 switch (ksp->ks_type) {
252 ksp->ks_data_size = ks_ndata;
254 case KSTAT_TYPE_NAMED:
255 ksp->ks_ndata = ks_ndata;
256 ksp->ks_data_size = ks_ndata * sizeof (kstat_named_t);
258 case KSTAT_TYPE_INTR:
259 ksp->ks_ndata = ks_ndata;
260 ksp->ks_data_size = ks_ndata * sizeof (kstat_intr_t);
263 ksp->ks_ndata = ks_ndata;
264 ksp->ks_data_size = ks_ndata * sizeof (kstat_io_t);
266 case KSTAT_TYPE_TIMER:
267 ksp->ks_ndata = ks_ndata;
268 ksp->ks_data_size = ks_ndata * sizeof (kstat_timer_t);
271 panic("Undefined kstat type %d\n", ksp->ks_type);
274 if (ksp->ks_flags & KSTAT_FLAG_VIRTUAL) {
277 ksp->ks_data = kmem_zalloc(ksp->ks_data_size, KM_SLEEP);
278 if (ksp->ks_data == NULL) {
279 kmem_free(ksp, sizeof (*ksp));
284 * Create sysctl tree for those statistics:
286 * kstat.<module>.<class>.<name>.
288 sysctl_ctx_init(&ksp->ks_sysctl_ctx);
289 root = SYSCTL_ADD_NODE(&ksp->ks_sysctl_ctx,
290 SYSCTL_STATIC_CHILDREN(_kstat), OID_AUTO, module, CTLFLAG_RW, 0,
293 printf("%s: Cannot create kstat.%s tree!\n", __func__, module);
294 sysctl_ctx_free(&ksp->ks_sysctl_ctx);
298 root = SYSCTL_ADD_NODE(&ksp->ks_sysctl_ctx, SYSCTL_CHILDREN(root),
299 OID_AUTO, class, CTLFLAG_RW, 0, "");
301 printf("%s: Cannot create kstat.%s.%s tree!\n", __func__,
303 sysctl_ctx_free(&ksp->ks_sysctl_ctx);
307 if (ksp->ks_type == KSTAT_TYPE_NAMED) {
308 root = SYSCTL_ADD_NODE(&ksp->ks_sysctl_ctx,
309 SYSCTL_CHILDREN(root),
310 OID_AUTO, name, CTLFLAG_RW, 0, "");
312 printf("%s: Cannot create kstat.%s.%s.%s tree!\n",
313 __func__, module, class, name);
314 sysctl_ctx_free(&ksp->ks_sysctl_ctx);
320 ksp->ks_sysctl_root = root;
326 kstat_install_named(kstat_t *ksp)
328 kstat_named_t *ksent;
332 ksent = ksp->ks_data;
334 VERIFY((ksp->ks_flags & KSTAT_FLAG_VIRTUAL) || ksent != NULL);
339 for (int i = 0; i < ksp->ks_ndata; i++, ksent++) {
340 if (ksent->data_type != 0) {
341 typelast = ksent->data_type;
342 namelast = ksent->name;
345 case KSTAT_DATA_CHAR:
346 /* Not Implemented */
348 case KSTAT_DATA_INT32:
349 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
350 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
352 CTLTYPE_S32 | CTLFLAG_RD, ksp, i,
353 kstat_sysctl, "I", namelast);
355 case KSTAT_DATA_UINT32:
356 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
357 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
359 CTLTYPE_U32 | CTLFLAG_RD, ksp, i,
360 kstat_sysctl, "IU", namelast);
362 case KSTAT_DATA_INT64:
363 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
364 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
366 CTLTYPE_S64 | CTLFLAG_RD, ksp, i,
367 kstat_sysctl, "Q", namelast);
369 case KSTAT_DATA_UINT64:
370 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
371 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
373 CTLTYPE_U64 | CTLFLAG_RD, ksp, i,
374 kstat_sysctl, "QU", namelast);
376 case KSTAT_DATA_LONG:
377 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
378 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
380 CTLTYPE_LONG | CTLFLAG_RD, ksp, i,
381 kstat_sysctl, "L", namelast);
383 case KSTAT_DATA_ULONG:
384 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
385 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
387 CTLTYPE_ULONG | CTLFLAG_RD, ksp, i,
388 kstat_sysctl, "LU", namelast);
390 case KSTAT_DATA_STRING:
391 SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
392 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
394 CTLTYPE_STRING | CTLFLAG_RD, ksp, i,
395 kstat_sysctl_string, "A", namelast);
398 panic("unsupported type: %d", typelast);
406 kstat_install(kstat_t *ksp)
408 struct sysctl_oid *root;
410 if (ksp->ks_ndata == UINT32_MAX)
411 VERIFY(ksp->ks_type == KSTAT_TYPE_RAW);
413 switch (ksp->ks_type) {
414 case KSTAT_TYPE_NAMED:
415 return (kstat_install_named(ksp));
418 if (ksp->ks_raw_ops.data) {
419 root = SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
420 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
421 OID_AUTO, ksp->ks_name,
422 CTLTYPE_STRING | CTLFLAG_RD, ksp, 0,
423 kstat_sysctl_raw, "A", ksp->ks_name);
425 root = SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
426 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
427 OID_AUTO, ksp->ks_name,
428 CTLTYPE_OPAQUE | CTLFLAG_RD, ksp, 0,
429 kstat_sysctl_raw, "", ksp->ks_name);
431 VERIFY(root != NULL);
434 root = SYSCTL_ADD_PROC(&ksp->ks_sysctl_ctx,
435 SYSCTL_CHILDREN(ksp->ks_sysctl_root),
436 OID_AUTO, ksp->ks_name,
437 CTLTYPE_STRING | CTLFLAG_RD, ksp, 0,
438 kstat_sysctl_io, "A", ksp->ks_name);
440 case KSTAT_TYPE_TIMER:
441 case KSTAT_TYPE_INTR:
443 panic("unsupported kstat type %d\n", ksp->ks_type);
445 ksp->ks_sysctl_root = root;
450 kstat_delete(kstat_t *ksp)
453 sysctl_ctx_free(&ksp->ks_sysctl_ctx);
455 mutex_destroy(&ksp->ks_private_lock);
460 kstat_waitq_enter(kstat_io_t *kiop)
466 delta = new - kiop->wlastupdate;
467 kiop->wlastupdate = new;
470 kiop->wlentime += delta * wcnt;
471 kiop->wtime += delta;
476 kstat_waitq_exit(kstat_io_t *kiop)
482 delta = new - kiop->wlastupdate;
483 kiop->wlastupdate = new;
485 ASSERT((int)wcnt > 0);
486 kiop->wlentime += delta * wcnt;
487 kiop->wtime += delta;
491 kstat_runq_enter(kstat_io_t *kiop)
497 delta = new - kiop->rlastupdate;
498 kiop->rlastupdate = new;
501 kiop->rlentime += delta * rcnt;
502 kiop->rtime += delta;
507 kstat_runq_exit(kstat_io_t *kiop)
513 delta = new - kiop->rlastupdate;
514 kiop->rlastupdate = new;
516 ASSERT((int)rcnt > 0);
517 kiop->rlentime += delta * rcnt;
518 kiop->rtime += delta;