sys/kern/subr_devstat.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 #include <sys/param.h>
  35 #include <sys/kernel.h>
  36 #include <sys/systm.h>
  37 #include <sys/bio.h>
  38 #include <sys/devicestat.h>
  39 #include <sys/sdt.h>
  40 #include <sys/sysctl.h>
  41 #include <sys/malloc.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/conf.h>
  45 #include <vm/vm.h>
  46 #include <vm/pmap.h>
  47
  48 #include <machine/atomic.h>
  49
  50 SDT_PROVIDER_DEFINE(io);
  51
  52 SDT_PROBE_DEFINE2(io, , , start, "struct bio *", "struct devstat *");
  53 SDT_PROBE_DEFINE2(io, , , done, "struct bio *", "struct devstat *");
  54 SDT_PROBE_DEFINE2(io, , , wait__start, "struct bio *",
  55     "struct devstat *");
  56 SDT_PROBE_DEFINE2(io, , , wait__done, "struct bio *",
  57     "struct devstat *");
  58
  59 #define DTRACE_DEVSTAT_START()          SDT_PROBE2(io, , , start, NULL, ds)
  60 #define DTRACE_DEVSTAT_BIO_START()      SDT_PROBE2(io, , , start, bp, ds)
  61 #define DTRACE_DEVSTAT_DONE()           SDT_PROBE2(io, , , done, NULL, ds)
  62 #define DTRACE_DEVSTAT_BIO_DONE()       SDT_PROBE2(io, , , done, bp, ds)
  63 #define DTRACE_DEVSTAT_WAIT_START()     SDT_PROBE2(io, , , wait__start, NULL, ds)
  64 #define DTRACE_DEVSTAT_WAIT_DONE()      SDT_PROBE2(io, , , wait__done, NULL, ds)
  65
  66 static int devstat_num_devs;
  67 static long devstat_generation = 1;
  68 static int devstat_version = DEVSTAT_VERSION;
  69 static int devstat_current_devnumber;
  70 static struct mtx devstat_mutex;
  71 MTX_SYSINIT(devstat_mutex, &devstat_mutex, "devstat", MTX_DEF);
  72
  73 static struct devstatlist device_statq = STAILQ_HEAD_INITIALIZER(device_statq);
  74 static struct devstat *devstat_alloc(void);
  75 static void devstat_free(struct devstat *);
  76 static void devstat_add_entry(struct devstat *ds, const void *dev_name,
  77                        int unit_number, uint32_t block_size,
  78                        devstat_support_flags flags,
  79                        devstat_type_flags device_type,
  80                        devstat_priority priority);
  81
  82 /*
  83  * Allocate a devstat and initialize it
  84  */
  85 struct devstat *
  86 devstat_new_entry(const void *dev_name,
  87                   int unit_number, uint32_t block_size,
  88                   devstat_support_flags flags,
  89                   devstat_type_flags device_type,
  90                   devstat_priority priority)
  91 {
  92         struct devstat *ds;
  93
  94         mtx_assert(&devstat_mutex, MA_NOTOWNED);
  95
  96         ds = devstat_alloc();
  97         mtx_lock(&devstat_mutex);
  98         if (unit_number == -1) {
  99                 ds->unit_number = unit_number;
 100                 ds->id = dev_name;
 101                 binuptime(&ds->creation_time);
 102                 devstat_generation++;
 103         } else {
 104                 devstat_add_entry(ds, dev_name, unit_number, block_size,
 105                                   flags, device_type, priority);
 106         }
 107         mtx_unlock(&devstat_mutex);
 108         return (ds);
 109 }
 110
 111 /*
 112  * Take a malloced and zeroed devstat structure given to us, fill it in
 113  * and add it to the queue of devices.
 114  */
 115 static void
 116 devstat_add_entry(struct devstat *ds, const void *dev_name,
 117                   int unit_number, uint32_t block_size,
 118                   devstat_support_flags flags,
 119                   devstat_type_flags device_type,
 120                   devstat_priority priority)
 121 {
 122         struct devstatlist *devstat_head;
 123         struct devstat *ds_tmp;
 124
 125         mtx_assert(&devstat_mutex, MA_OWNED);
 126         devstat_num_devs++;
 127
 128         devstat_head = &device_statq;
 129
 130         /*
 131          * Priority sort.  Each driver passes in its priority when it adds
 132          * its devstat entry.  Drivers are sorted first by priority, and
 133          * then by probe order.
 134          *
 135          * For the first device, we just insert it, since the priority
 136          * doesn't really matter yet.  Subsequent devices are inserted into
 137          * the list using the order outlined above.
 138          */
 139         if (devstat_num_devs == 1)
 140                 STAILQ_INSERT_TAIL(devstat_head, ds, dev_links);
 141         else {
 142                 STAILQ_FOREACH(ds_tmp, devstat_head, dev_links) {
 143                         struct devstat *ds_next;
 144
 145                         ds_next = STAILQ_NEXT(ds_tmp, dev_links);
 146
 147                         /*
 148                          * If we find a break between higher and lower
 149                          * priority items, and if this item fits in the
 150                          * break, insert it.  This also applies if the
 151                          * "lower priority item" is the end of the list.
 152                          */
 153                         if ((priority <= ds_tmp->priority)
 154                          && ((ds_next == NULL)
 155                            || (priority > ds_next->priority))) {
 156                                 STAILQ_INSERT_AFTER(devstat_head, ds_tmp, ds,
 157                                                     dev_links);
 158                                 break;
 159                         } else if (priority > ds_tmp->priority) {
 160                                 /*
 161                                  * If this is the case, we should be able
 162                                  * to insert ourselves at the head of the
 163                                  * list.  If we can't, something is wrong.
 164                                  */
 165                                 if (ds_tmp == STAILQ_FIRST(devstat_head)) {
 166                                         STAILQ_INSERT_HEAD(devstat_head,
 167                                                            ds, dev_links);
 168                                         break;
 169                                 } else {
 170                                         STAILQ_INSERT_TAIL(devstat_head,
 171                                                            ds, dev_links);
 172                                         printf("devstat_add_entry: HELP! "
 173                                                "sorting problem detected "
 174                                                "for name %p unit %d\n",
 175                                                dev_name, unit_number);
 176                                         break;
 177                                 }
 178                         }
 179                 }
 180         }
 181
 182         ds->device_number = devstat_current_devnumber++;
 183         ds->unit_number = unit_number;
 184         strlcpy(ds->device_name, dev_name, DEVSTAT_NAME_LEN);
 185         ds->block_size = block_size;
 186         ds->flags = flags;
 187         ds->device_type = device_type;
 188         ds->priority = priority;
 189         binuptime(&ds->creation_time);
 190         devstat_generation++;
 191 }
 192
 193 /*
 194  * Remove a devstat structure from the list of devices.
 195  */
 196 void
 197 devstat_remove_entry(struct devstat *ds)
 198 {
 199         struct devstatlist *devstat_head;
 200
 201         mtx_assert(&devstat_mutex, MA_NOTOWNED);
 202         if (ds == NULL)
 203                 return;
 204
 205         mtx_lock(&devstat_mutex);
 206
 207         devstat_head = &device_statq;
 208
 209         /* Remove this entry from the devstat queue */
 210         atomic_add_acq_int(&ds->sequence1, 1);
 211         if (ds->unit_number != -1) {
 212                 devstat_num_devs--;
 213                 STAILQ_REMOVE(devstat_head, ds, devstat, dev_links);
 214         }
 215         devstat_free(ds);
 216         devstat_generation++;
 217         mtx_unlock(&devstat_mutex);
 218 }
 219
 220 /*
 221  * Record a transaction start.
 222  *
 223  * See comments for devstat_end_transaction().  Ordering is very important
 224  * here.
 225  */
 226 void
 227 devstat_start_transaction(struct devstat *ds, const struct bintime *now)
 228 {
 229
 230         mtx_assert(&devstat_mutex, MA_NOTOWNED);
 231
 232         /* sanity check */
 233         if (ds == NULL)
 234                 return;
 235
 236         atomic_add_acq_int(&ds->sequence1, 1);
 237         /*
 238          * We only want to set the start time when we are going from idle
 239          * to busy.  The start time is really the start of the latest busy
 240          * period.
 241          */
 242         if (ds->start_count == ds->end_count) {
 243                 if (now != NULL)
 244                         ds->busy_from = *now;
 245                 else
 246                         binuptime(&ds->busy_from);
 247         }
 248         ds->start_count++;
 249         atomic_add_rel_int(&ds->sequence0, 1);
 250         DTRACE_DEVSTAT_START();
 251 }
 252
 253 void
 254 devstat_start_transaction_bio(struct devstat *ds, struct bio *bp)
 255 {
 256
 257         mtx_assert(&devstat_mutex, MA_NOTOWNED);
 258
 259         /* sanity check */
 260         if (ds == NULL)
 261                 return;
 262
 263         binuptime(&bp->bio_t0);
 264         devstat_start_transaction_bio_t0(ds, bp);
 265 }
 266
 267 void
 268 devstat_start_transaction_bio_t0(struct devstat *ds, struct bio *bp)
 269 {
 270
 271         /* sanity check */
 272         if (ds == NULL)
 273                 return;
 274
 275         devstat_start_transaction(ds, &bp->bio_t0);
 276         DTRACE_DEVSTAT_BIO_START();
 277 }
 278
 279 /*
 280  * Record the ending of a transaction, and incrment the various counters.
 281  *
 282  * Ordering in this function, and in devstat_start_transaction() is VERY
 283  * important.  The idea here is to run without locks, so we are very
 284  * careful to only modify some fields on the way "down" (i.e. at
 285  * transaction start) and some fields on the way "up" (i.e. at transaction
 286  * completion).  One exception is busy_from, which we only modify in
 287  * devstat_start_transaction() when there are no outstanding transactions,
 288  * and thus it can't be modified in devstat_end_transaction()
 289  * simultaneously.
 290  *
 291  * The sequence0 and sequence1 fields are provided to enable an application
 292  * spying on the structures with mmap(2) to tell when a structure is in a
 293  * consistent state or not.
 294  *
 295  * For this to work 100% reliably, it is important that the two fields
 296  * are at opposite ends of the structure and that they are incremented
 297  * in the opposite order of how a memcpy(3) in userland would copy them.
 298  * We assume that the copying happens front to back, but there is actually
 299  * no way short of writing your own memcpy(3) replacement to guarantee
 300  * this will be the case.
 301  *
 302  * In addition to this, being a kind of locks, they must be updated with
 303  * atomic instructions using appropriate memory barriers.
 304  */
 305 void
 306 devstat_end_transaction(struct devstat *ds, uint32_t bytes,
 307                         devstat_tag_type tag_type, devstat_trans_flags flags,
 308                         const struct bintime *now, const struct bintime *then)
 309 {
 310         struct bintime dt, lnow;
 311
 312         /* sanity check */
 313         if (ds == NULL)
 314                 return;
 315
 316         if (now == NULL) {
 317                 binuptime(&lnow);
 318                 now = &lnow;
 319         }
 320
 321         atomic_add_acq_int(&ds->sequence1, 1);
 322         /* Update byte and operations counts */
 323         ds->bytes[flags] += bytes;
 324         ds->operations[flags]++;
 325
 326         /*
 327          * Keep a count of the various tag types sent.
 328          */
 329         if ((ds->flags & DEVSTAT_NO_ORDERED_TAGS) == 0 &&
 330             tag_type != DEVSTAT_TAG_NONE)
 331                 ds->tag_types[tag_type]++;
 332
 333         if (then != NULL) {
 334                 /* Update duration of operations */
 335                 dt = *now;
 336                 bintime_sub(&dt, then);
 337                 bintime_add(&ds->duration[flags], &dt);
 338         }
 339
 340         /* Accumulate busy time */
 341         dt = *now;
 342         bintime_sub(&dt, &ds->busy_from);
 343         bintime_add(&ds->busy_time, &dt);
 344         ds->busy_from = *now;
 345
 346         ds->end_count++;
 347         atomic_add_rel_int(&ds->sequence0, 1);
 348         DTRACE_DEVSTAT_DONE();
 349 }
 350
 351 void
 352 devstat_end_transaction_bio(struct devstat *ds, const struct bio *bp)
 353 {
 354
 355         devstat_end_transaction_bio_bt(ds, bp, NULL);
 356 }
 357
 358 void
 359 devstat_end_transaction_bio_bt(struct devstat *ds, const struct bio *bp,
 360     const struct bintime *now)
 361 {
 362         devstat_trans_flags flg;
 363         devstat_tag_type tag;
 364
 365         /* sanity check */
 366         if (ds == NULL)
 367                 return;
 368
 369         if (bp->bio_flags & BIO_ORDERED)
 370                 tag = DEVSTAT_TAG_ORDERED;
 371         else
 372                 tag = DEVSTAT_TAG_SIMPLE;
 373         if (bp->bio_cmd == BIO_DELETE)
 374                 flg = DEVSTAT_FREE;
 375         else if ((bp->bio_cmd == BIO_READ)
 376               || ((bp->bio_cmd == BIO_ZONE)
 377                && (bp->bio_zone.zone_cmd == DISK_ZONE_REPORT_ZONES)))
 378                 flg = DEVSTAT_READ;
 379         else if (bp->bio_cmd == BIO_WRITE)
 380                 flg = DEVSTAT_WRITE;
 381         else
 382                 flg = DEVSTAT_NO_DATA;
 383
 384         devstat_end_transaction(ds, bp->bio_bcount - bp->bio_resid,
 385                                 tag, flg, now, &bp->bio_t0);
 386         DTRACE_DEVSTAT_BIO_DONE();
 387 }
 388
 389 /*
 390  * This is the sysctl handler for the devstat package.  The data pushed out
 391  * on the kern.devstat.all sysctl variable consists of the current devstat
 392  * generation number, and then an array of devstat structures, one for each
 393  * device in the system.
 394  *
 395  * This is more cryptic that obvious, but basically we neither can nor
 396  * want to hold the devstat_mutex for any amount of time, so we grab it
 397  * only when we need to and keep an eye on devstat_generation all the time.
 398  */
 399 static int
 400 sysctl_devstat(SYSCTL_HANDLER_ARGS)
 401 {
 402         int error;
 403         long mygen;
 404         struct devstat *nds;
 405
 406         mtx_assert(&devstat_mutex, MA_NOTOWNED);
 407
 408         /*
 409          * XXX devstat_generation should really be "volatile" but that
 410          * XXX freaks out the sysctl macro below.  The places where we
 411          * XXX change it and inspect it are bracketed in the mutex which
 412          * XXX guarantees us proper write barriers.  I don't believe the
 413          * XXX compiler is allowed to optimize mygen away across calls
 414          * XXX to other functions, so the following is belived to be safe.
 415          */
 416         mygen = devstat_generation;
 417
 418         error = SYSCTL_OUT(req, &mygen, sizeof(mygen));
 419
 420         if (devstat_num_devs == 0)
 421                 return(0);
 422
 423         if (error != 0)
 424                 return (error);
 425
 426         mtx_lock(&devstat_mutex);
 427         nds = STAILQ_FIRST(&device_statq);
 428         if (mygen != devstat_generation)
 429                 error = EBUSY;
 430         mtx_unlock(&devstat_mutex);
 431
 432         if (error != 0)
 433                 return (error);
 434
 435         for (;nds != NULL;) {
 436                 error = SYSCTL_OUT(req, nds, sizeof(struct devstat));
 437                 if (error != 0)
 438                         return (error);
 439                 mtx_lock(&devstat_mutex);
 440                 if (mygen != devstat_generation)
 441                         error = EBUSY;
 442                 else
 443                         nds = STAILQ_NEXT(nds, dev_links);
 444                 mtx_unlock(&devstat_mutex);
 445                 if (error != 0)
 446                         return (error);
 447         }
 448         return(error);
 449 }
 450
 451 /*
 452  * Sysctl entries for devstat.  The first one is a node that all the rest
 453  * hang off of.
 454  */
 455 static SYSCTL_NODE(_kern, OID_AUTO, devstat, CTLFLAG_RD, NULL,
 456     "Device Statistics");
 457
 458 SYSCTL_PROC(_kern_devstat, OID_AUTO, all, CTLFLAG_RD|CTLTYPE_OPAQUE,
 459     NULL, 0, sysctl_devstat, "S,devstat", "All devices in the devstat list");
 460 /*
 461  * Export the number of devices in the system so that userland utilities
 462  * can determine how much memory to allocate to hold all the devices.
 463  */
 464 SYSCTL_INT(_kern_devstat, OID_AUTO, numdevs, CTLFLAG_RD,
 465     &devstat_num_devs, 0, "Number of devices in the devstat list");
 466 SYSCTL_LONG(_kern_devstat, OID_AUTO, generation, CTLFLAG_RD,
 467     &devstat_generation, 0, "Devstat list generation");
 468 SYSCTL_INT(_kern_devstat, OID_AUTO, version, CTLFLAG_RD,
 469     &devstat_version, 0, "Devstat list version number");
 470
 471 /*
 472  * Allocator for struct devstat structures.  We sub-allocate these from pages
 473  * which we get from malloc.  These pages are exported for mmap(2)'ing through
 474  * a miniature device driver
 475  */
 476
 477 #define statsperpage (PAGE_SIZE / sizeof(struct devstat))
 478
 479 static d_mmap_t devstat_mmap;
 480
 481 static struct cdevsw devstat_cdevsw = {
 482         .d_version =    D_VERSION,
 483         .d_mmap =       devstat_mmap,
 484         .d_name =       "devstat",
 485 };
 486
 487 struct statspage {
 488         TAILQ_ENTRY(statspage)  list;
 489         struct devstat          *stat;
 490         u_int                   nfree;
 491 };
 492
 493 static TAILQ_HEAD(, statspage)  pagelist = TAILQ_HEAD_INITIALIZER(pagelist);
 494 static MALLOC_DEFINE(M_DEVSTAT, "devstat", "Device statistics");
 495
 496 static int
 497 devstat_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
 498     int nprot, vm_memattr_t *memattr)
 499 {
 500         struct statspage *spp;
 501
 502         if (nprot != VM_PROT_READ)
 503                 return (-1);
 504         mtx_lock(&devstat_mutex);
 505         TAILQ_FOREACH(spp, &pagelist, list) {
 506                 if (offset == 0) {
 507                         *paddr = vtophys(spp->stat);
 508                         mtx_unlock(&devstat_mutex);
 509                         return (0);
 510                 }
 511                 offset -= PAGE_SIZE;
 512         }
 513         mtx_unlock(&devstat_mutex);
 514         return (-1);
 515 }
 516
 517 static struct devstat *
 518 devstat_alloc(void)
 519 {
 520         struct devstat *dsp;
 521         struct statspage *spp, *spp2;
 522         u_int u;
 523         static int once;
 524
 525         mtx_assert(&devstat_mutex, MA_NOTOWNED);
 526         if (!once) {
 527                 make_dev_credf(MAKEDEV_ETERNAL | MAKEDEV_CHECKNAME,
 528                     &devstat_cdevsw, 0, NULL, UID_ROOT, GID_WHEEL, 0444,
 529                     DEVSTAT_DEVICE_NAME);
 530                 once = 1;
 531         }
 532         spp2 = NULL;
 533         mtx_lock(&devstat_mutex);
 534         for (;;) {
 535                 TAILQ_FOREACH(spp, &pagelist, list) {
 536                         if (spp->nfree > 0)
 537                                 break;
 538                 }
 539                 if (spp != NULL)
 540                         break;
 541                 mtx_unlock(&devstat_mutex);
 542                 spp2 = malloc(sizeof *spp, M_DEVSTAT, M_ZERO | M_WAITOK);
 543                 spp2->stat = malloc(PAGE_SIZE, M_DEVSTAT, M_ZERO | M_WAITOK);
 544                 spp2->nfree = statsperpage;
 545
 546                 /*
 547                  * If free statspages were added while the lock was released
 548                  * just reuse them.
 549                  */
 550                 mtx_lock(&devstat_mutex);
 551                 TAILQ_FOREACH(spp, &pagelist, list)
 552                         if (spp->nfree > 0)
 553                                 break;
 554                 if (spp == NULL) {
 555                         spp = spp2;
 556
 557                         /*
 558                          * It would make more sense to add the new page at the
 559                          * head but the order on the list determine the
 560                          * sequence of the mapping so we can't do that.
 561                          */
 562                         TAILQ_INSERT_TAIL(&pagelist, spp, list);
 563                 } else
 564                         break;
 565         }
 566         dsp = spp->stat;
 567         for (u = 0; u < statsperpage; u++) {
 568                 if (dsp->allocated == 0)
 569                         break;
 570                 dsp++;
 571         }
 572         spp->nfree--;
 573         dsp->allocated = 1;
 574         mtx_unlock(&devstat_mutex);
 575         if (spp2 != NULL && spp2 != spp) {
 576                 free(spp2->stat, M_DEVSTAT);
 577                 free(spp2, M_DEVSTAT);
 578         }
 579         return (dsp);
 580 }
 581
 582 static void
 583 devstat_free(struct devstat *dsp)
 584 {
 585         struct statspage *spp;
 586
 587         mtx_assert(&devstat_mutex, MA_OWNED);
 588         bzero(dsp, sizeof *dsp);
 589         TAILQ_FOREACH(spp, &pagelist, list) {
 590                 if (dsp >= spp->stat && dsp < (spp->stat + statsperpage)) {
 591                         spp->nfree++;
 592                         return;
 593                 }
 594         }
 595 }
 596
 597 SYSCTL_INT(_debug_sizeof, OID_AUTO, devstat, CTLFLAG_RD,
 598     SYSCTL_NULL_INT_PTR, sizeof(struct devstat), "sizeof(struct devstat)");