2 * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
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.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include "opt_kdtrace.h"
34 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/systm.h>
38 #include <sys/devicestat.h>
39 #include <sys/sysctl.h>
40 #include <sys/malloc.h>
42 #include <sys/mutex.h>
47 #include <machine/atomic.h>
50 #include <sys/dtrace_bsd.h>
52 dtrace_io_start_probe_func_t dtrace_io_start_probe;
53 dtrace_io_done_probe_func_t dtrace_io_done_probe;
54 dtrace_io_wait_start_probe_func_t dtrace_io_wait_start_probe;
55 dtrace_io_wait_done_probe_func_t dtrace_io_wait_done_probe;
57 uint32_t dtio_start_id;
58 uint32_t dtio_done_id;
59 uint32_t dtio_wait_start_id;
60 uint32_t dtio_wait_done_id;
62 #define DTRACE_DEVSTAT_START() \
63 if (dtrace_io_start_probe != NULL) \
64 (*dtrace_io_start_probe)(dtio_start_id, NULL, ds);
66 #define DTRACE_DEVSTAT_BIO_START() \
67 if (dtrace_io_start_probe != NULL) \
68 (*dtrace_io_start_probe)(dtio_start_id, bp, ds);
70 #define DTRACE_DEVSTAT_DONE() \
71 if (dtrace_io_done_probe != NULL) \
72 (*dtrace_io_done_probe)(dtio_done_id, NULL, ds);
74 #define DTRACE_DEVSTAT_BIO_DONE() \
75 if (dtrace_io_done_probe != NULL) \
76 (*dtrace_io_done_probe)(dtio_done_id, bp, ds);
78 #define DTRACE_DEVSTAT_WAIT_START() \
79 if (dtrace_io_wait_start_probe != NULL) \
80 (*dtrace_io_wait_start_probe)(dtio_wait_start_id, NULL, ds);
82 #define DTRACE_DEVSTAT_WAIT_DONE() \
83 if (dtrace_io_wait_done_probe != NULL) \
84 (*dtrace_io_wait_done_probe)(dtio_wait_done_id, NULL, ds);
86 #else /* ! KDTRACE_HOOKS */
88 #define DTRACE_DEVSTAT_START()
90 #define DTRACE_DEVSTAT_BIO_START()
92 #define DTRACE_DEVSTAT_DONE()
94 #define DTRACE_DEVSTAT_BIO_DONE()
96 #define DTRACE_DEVSTAT_WAIT_START()
98 #define DTRACE_DEVSTAT_WAIT_DONE()
99 #endif /* KDTRACE_HOOKS */
101 static int devstat_num_devs;
102 static long devstat_generation = 1;
103 static int devstat_version = DEVSTAT_VERSION;
104 static int devstat_current_devnumber;
105 static struct mtx devstat_mutex;
106 MTX_SYSINIT(devstat_mutex, &devstat_mutex, "devstat", MTX_DEF);
108 static struct devstatlist device_statq = STAILQ_HEAD_INITIALIZER(device_statq);
109 static struct devstat *devstat_alloc(void);
110 static void devstat_free(struct devstat *);
111 static void devstat_add_entry(struct devstat *ds, const void *dev_name,
112 int unit_number, uint32_t block_size,
113 devstat_support_flags flags,
114 devstat_type_flags device_type,
115 devstat_priority priority);
118 * Allocate a devstat and initialize it
121 devstat_new_entry(const void *dev_name,
122 int unit_number, uint32_t block_size,
123 devstat_support_flags flags,
124 devstat_type_flags device_type,
125 devstat_priority priority)
129 mtx_assert(&devstat_mutex, MA_NOTOWNED);
131 ds = devstat_alloc();
132 mtx_lock(&devstat_mutex);
133 if (unit_number == -1) {
135 binuptime(&ds->creation_time);
136 devstat_generation++;
138 devstat_add_entry(ds, dev_name, unit_number, block_size,
139 flags, device_type, priority);
141 mtx_unlock(&devstat_mutex);
146 * Take a malloced and zeroed devstat structure given to us, fill it in
147 * and add it to the queue of devices.
150 devstat_add_entry(struct devstat *ds, const void *dev_name,
151 int unit_number, uint32_t block_size,
152 devstat_support_flags flags,
153 devstat_type_flags device_type,
154 devstat_priority priority)
156 struct devstatlist *devstat_head;
157 struct devstat *ds_tmp;
159 mtx_assert(&devstat_mutex, MA_OWNED);
162 devstat_head = &device_statq;
165 * Priority sort. Each driver passes in its priority when it adds
166 * its devstat entry. Drivers are sorted first by priority, and
167 * then by probe order.
169 * For the first device, we just insert it, since the priority
170 * doesn't really matter yet. Subsequent devices are inserted into
171 * the list using the order outlined above.
173 if (devstat_num_devs == 1)
174 STAILQ_INSERT_TAIL(devstat_head, ds, dev_links);
176 STAILQ_FOREACH(ds_tmp, devstat_head, dev_links) {
177 struct devstat *ds_next;
179 ds_next = STAILQ_NEXT(ds_tmp, dev_links);
182 * If we find a break between higher and lower
183 * priority items, and if this item fits in the
184 * break, insert it. This also applies if the
185 * "lower priority item" is the end of the list.
187 if ((priority <= ds_tmp->priority)
188 && ((ds_next == NULL)
189 || (priority > ds_next->priority))) {
190 STAILQ_INSERT_AFTER(devstat_head, ds_tmp, ds,
193 } else if (priority > ds_tmp->priority) {
195 * If this is the case, we should be able
196 * to insert ourselves at the head of the
197 * list. If we can't, something is wrong.
199 if (ds_tmp == STAILQ_FIRST(devstat_head)) {
200 STAILQ_INSERT_HEAD(devstat_head,
204 STAILQ_INSERT_TAIL(devstat_head,
206 printf("devstat_add_entry: HELP! "
207 "sorting problem detected "
208 "for name %p unit %d\n",
209 dev_name, unit_number);
216 ds->device_number = devstat_current_devnumber++;
217 ds->unit_number = unit_number;
218 strlcpy(ds->device_name, dev_name, DEVSTAT_NAME_LEN);
219 ds->block_size = block_size;
221 ds->device_type = device_type;
222 ds->priority = priority;
223 binuptime(&ds->creation_time);
224 devstat_generation++;
228 * Remove a devstat structure from the list of devices.
231 devstat_remove_entry(struct devstat *ds)
233 struct devstatlist *devstat_head;
235 mtx_assert(&devstat_mutex, MA_NOTOWNED);
239 mtx_lock(&devstat_mutex);
241 devstat_head = &device_statq;
243 /* Remove this entry from the devstat queue */
244 atomic_add_acq_int(&ds->sequence1, 1);
245 if (ds->id == NULL) {
247 STAILQ_REMOVE(devstat_head, ds, devstat, dev_links);
250 devstat_generation++;
251 mtx_unlock(&devstat_mutex);
255 * Record a transaction start.
257 * See comments for devstat_end_transaction(). Ordering is very important
261 devstat_start_transaction(struct devstat *ds, struct bintime *now)
264 mtx_assert(&devstat_mutex, MA_NOTOWNED);
270 atomic_add_acq_int(&ds->sequence1, 1);
272 * We only want to set the start time when we are going from idle
273 * to busy. The start time is really the start of the latest busy
276 if (ds->start_count == ds->end_count) {
278 ds->busy_from = *now;
280 binuptime(&ds->busy_from);
283 atomic_add_rel_int(&ds->sequence0, 1);
284 DTRACE_DEVSTAT_START();
288 devstat_start_transaction_bio(struct devstat *ds, struct bio *bp)
291 mtx_assert(&devstat_mutex, MA_NOTOWNED);
297 binuptime(&bp->bio_t0);
298 devstat_start_transaction(ds, &bp->bio_t0);
299 DTRACE_DEVSTAT_BIO_START();
303 * Record the ending of a transaction, and incrment the various counters.
305 * Ordering in this function, and in devstat_start_transaction() is VERY
306 * important. The idea here is to run without locks, so we are very
307 * careful to only modify some fields on the way "down" (i.e. at
308 * transaction start) and some fields on the way "up" (i.e. at transaction
309 * completion). One exception is busy_from, which we only modify in
310 * devstat_start_transaction() when there are no outstanding transactions,
311 * and thus it can't be modified in devstat_end_transaction()
314 * The sequence0 and sequence1 fields are provided to enable an application
315 * spying on the structures with mmap(2) to tell when a structure is in a
316 * consistent state or not.
318 * For this to work 100% reliably, it is important that the two fields
319 * are at opposite ends of the structure and that they are incremented
320 * in the opposite order of how a memcpy(3) in userland would copy them.
321 * We assume that the copying happens front to back, but there is actually
322 * no way short of writing your own memcpy(3) replacement to guarantee
323 * this will be the case.
325 * In addition to this, being a kind of locks, they must be updated with
326 * atomic instructions using appropriate memory barriers.
329 devstat_end_transaction(struct devstat *ds, uint32_t bytes,
330 devstat_tag_type tag_type, devstat_trans_flags flags,
331 struct bintime *now, struct bintime *then)
333 struct bintime dt, lnow;
344 atomic_add_acq_int(&ds->sequence1, 1);
345 /* Update byte and operations counts */
346 ds->bytes[flags] += bytes;
347 ds->operations[flags]++;
350 * Keep a count of the various tag types sent.
352 if ((ds->flags & DEVSTAT_NO_ORDERED_TAGS) == 0 &&
353 tag_type != DEVSTAT_TAG_NONE)
354 ds->tag_types[tag_type]++;
357 /* Update duration of operations */
359 bintime_sub(&dt, then);
360 bintime_add(&ds->duration[flags], &dt);
363 /* Accumulate busy time */
365 bintime_sub(&dt, &ds->busy_from);
366 bintime_add(&ds->busy_time, &dt);
367 ds->busy_from = *now;
370 atomic_add_rel_int(&ds->sequence0, 1);
371 DTRACE_DEVSTAT_DONE();
375 devstat_end_transaction_bio(struct devstat *ds, struct bio *bp)
377 devstat_trans_flags flg;
383 if (bp->bio_cmd == BIO_DELETE)
385 else if (bp->bio_cmd == BIO_READ)
387 else if (bp->bio_cmd == BIO_WRITE)
390 flg = DEVSTAT_NO_DATA;
392 devstat_end_transaction(ds, bp->bio_bcount - bp->bio_resid,
393 DEVSTAT_TAG_SIMPLE, flg, NULL, &bp->bio_t0);
394 DTRACE_DEVSTAT_BIO_DONE();
398 * This is the sysctl handler for the devstat package. The data pushed out
399 * on the kern.devstat.all sysctl variable consists of the current devstat
400 * generation number, and then an array of devstat structures, one for each
401 * device in the system.
403 * This is more cryptic that obvious, but basically we neither can nor
404 * want to hold the devstat_mutex for any amount of time, so we grab it
405 * only when we need to and keep an eye on devstat_generation all the time.
408 sysctl_devstat(SYSCTL_HANDLER_ARGS)
414 mtx_assert(&devstat_mutex, MA_NOTOWNED);
417 * XXX devstat_generation should really be "volatile" but that
418 * XXX freaks out the sysctl macro below. The places where we
419 * XXX change it and inspect it are bracketed in the mutex which
420 * XXX guarantees us proper write barriers. I don't belive the
421 * XXX compiler is allowed to optimize mygen away across calls
422 * XXX to other functions, so the following is belived to be safe.
424 mygen = devstat_generation;
426 error = SYSCTL_OUT(req, &mygen, sizeof(mygen));
428 if (devstat_num_devs == 0)
434 mtx_lock(&devstat_mutex);
435 nds = STAILQ_FIRST(&device_statq);
436 if (mygen != devstat_generation)
438 mtx_unlock(&devstat_mutex);
443 for (;nds != NULL;) {
444 error = SYSCTL_OUT(req, nds, sizeof(struct devstat));
447 mtx_lock(&devstat_mutex);
448 if (mygen != devstat_generation)
451 nds = STAILQ_NEXT(nds, dev_links);
452 mtx_unlock(&devstat_mutex);
460 * Sysctl entries for devstat. The first one is a node that all the rest
463 static SYSCTL_NODE(_kern, OID_AUTO, devstat, CTLFLAG_RD, NULL,
464 "Device Statistics");
466 SYSCTL_PROC(_kern_devstat, OID_AUTO, all, CTLFLAG_RD|CTLTYPE_OPAQUE,
467 NULL, 0, sysctl_devstat, "S,devstat", "All devices in the devstat list");
469 * Export the number of devices in the system so that userland utilities
470 * can determine how much memory to allocate to hold all the devices.
472 SYSCTL_INT(_kern_devstat, OID_AUTO, numdevs, CTLFLAG_RD,
473 &devstat_num_devs, 0, "Number of devices in the devstat list");
474 SYSCTL_LONG(_kern_devstat, OID_AUTO, generation, CTLFLAG_RD,
475 &devstat_generation, 0, "Devstat list generation");
476 SYSCTL_INT(_kern_devstat, OID_AUTO, version, CTLFLAG_RD,
477 &devstat_version, 0, "Devstat list version number");
480 * Allocator for struct devstat structures. We sub-allocate these from pages
481 * which we get from malloc. These pages are exported for mmap(2)'ing through
482 * a miniature device driver
485 #define statsperpage (PAGE_SIZE / sizeof(struct devstat))
487 static d_mmap_t devstat_mmap;
489 static struct cdevsw devstat_cdevsw = {
490 .d_version = D_VERSION,
491 .d_flags = D_NEEDGIANT,
492 .d_mmap = devstat_mmap,
497 TAILQ_ENTRY(statspage) list;
498 struct devstat *stat;
502 static TAILQ_HEAD(, statspage) pagelist = TAILQ_HEAD_INITIALIZER(pagelist);
503 static MALLOC_DEFINE(M_DEVSTAT, "devstat", "Device statistics");
506 devstat_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
507 int nprot, vm_memattr_t *memattr)
509 struct statspage *spp;
511 if (nprot != VM_PROT_READ)
513 TAILQ_FOREACH(spp, &pagelist, list) {
515 *paddr = vtophys(spp->stat);
523 static struct devstat *
527 struct statspage *spp, *spp2;
531 mtx_assert(&devstat_mutex, MA_NOTOWNED);
533 make_dev_credf(MAKEDEV_ETERNAL | MAKEDEV_CHECKNAME,
534 &devstat_cdevsw, 0, NULL, UID_ROOT, GID_WHEEL, 0400,
535 DEVSTAT_DEVICE_NAME);
539 mtx_lock(&devstat_mutex);
541 TAILQ_FOREACH(spp, &pagelist, list) {
547 mtx_unlock(&devstat_mutex);
548 spp2 = malloc(sizeof *spp, M_DEVSTAT, M_ZERO | M_WAITOK);
549 spp2->stat = malloc(PAGE_SIZE, M_DEVSTAT, M_ZERO | M_WAITOK);
550 spp2->nfree = statsperpage;
553 * If free statspages were added while the lock was released
556 mtx_lock(&devstat_mutex);
557 TAILQ_FOREACH(spp, &pagelist, list)
564 * It would make more sense to add the new page at the
565 * head but the order on the list determine the
566 * sequence of the mapping so we can't do that.
568 TAILQ_INSERT_TAIL(&pagelist, spp, list);
573 for (u = 0; u < statsperpage; u++) {
574 if (dsp->allocated == 0)
580 mtx_unlock(&devstat_mutex);
581 if (spp2 != NULL && spp2 != spp) {
582 free(spp2->stat, M_DEVSTAT);
583 free(spp2, M_DEVSTAT);
589 devstat_free(struct devstat *dsp)
591 struct statspage *spp;
593 mtx_assert(&devstat_mutex, MA_OWNED);
594 bzero(dsp, sizeof *dsp);
595 TAILQ_FOREACH(spp, &pagelist, list) {
596 if (dsp >= spp->stat && dsp < (spp->stat + statsperpage)) {
603 SYSCTL_INT(_debug_sizeof, OID_AUTO, devstat, CTLFLAG_RD,
604 NULL, sizeof(struct devstat), "sizeof(struct devstat)");