sys/boot/common/bcache.c

   1 /*-
   2  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
   3  * Copyright 2015 Toomas Soome <tsoome@me.com>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 #include <sys/param.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 /*
  33  * Simple hashed block cache
  34  */
  35
  36 #include <sys/stdint.h>
  37
  38 #include <stand.h>
  39 #include <string.h>
  40 #include <strings.h>
  41
  42 #include "bootstrap.h"
  43
  44 /* #define BCACHE_DEBUG */
  45
  46 #ifdef BCACHE_DEBUG
  47 # define DEBUG(fmt, args...)    printf("%s: " fmt "\n" , __func__ , ## args)
  48 #else
  49 # define DEBUG(fmt, args...)
  50 #endif
  51
  52 struct bcachectl
  53 {
  54     daddr_t     bc_blkno;
  55     int         bc_count;
  56 };
  57
  58 /*
  59  * bcache per device node. cache is allocated on device first open and freed
  60  * on last close, to save memory. The issue there is the size; biosdisk
  61  * supports up to 31 (0x1f) devices. Classic setup would use single disk
  62  * to boot from, but this has changed with zfs.
  63  */
  64 struct bcache {
  65     struct bcachectl    *bcache_ctl;
  66     caddr_t             bcache_data;
  67     u_int               bcache_nblks;
  68     size_t              ra;
  69 };
  70
  71 static u_int bcache_total_nblks;        /* set by bcache_init */
  72 static u_int bcache_blksize;            /* set by bcache_init */
  73 static u_int bcache_numdev;             /* set by bcache_add_dev */
  74 /* statistics */
  75 static u_int bcache_units;      /* number of devices with cache */
  76 static u_int bcache_unit_nblks; /* nblocks per unit */
  77 static u_int bcache_hits;
  78 static u_int bcache_misses;
  79 static u_int bcache_ops;
  80 static u_int bcache_bypasses;
  81 static u_int bcache_bcount;
  82 static u_int bcache_rablks;
  83
  84 #define BHASH(bc, blkno)        ((blkno) & ((bc)->bcache_nblks - 1))
  85 #define BCACHE_LOOKUP(bc, blkno)        \
  86         ((bc)->bcache_ctl[BHASH((bc), (blkno))].bc_blkno != (blkno))
  87 #define BCACHE_READAHEAD        256
  88 #define BCACHE_MINREADAHEAD     32
  89
  90 static void     bcache_invalidate(struct bcache *bc, daddr_t blkno);
  91 static void     bcache_insert(struct bcache *bc, daddr_t blkno);
  92 static void     bcache_free_instance(struct bcache *bc);
  93
  94 /*
  95  * Initialise the cache for (nblks) of (bsize).
  96  */
  97 void
  98 bcache_init(u_int nblks, size_t bsize)
  99 {
 100     /* set up control data */
 101     bcache_total_nblks = nblks;
 102     bcache_blksize = bsize;
 103 }
 104
 105 /*
 106  * add number of devices to bcache. we have to divide cache space
 107  * between the devices, so bcache_add_dev() can be used to set up the
 108  * number. The issue is, we need to get the number before actual allocations.
 109  * bcache_add_dev() is supposed to be called from device init() call, so the
 110  * assumption is, devsw dv_init is called for plain devices first, and
 111  * for zfs, last.
 112  */
 113 void
 114 bcache_add_dev(int devices)
 115 {
 116     bcache_numdev += devices;
 117 }
 118
 119 void *
 120 bcache_allocate(void)
 121 {
 122     u_int i;
 123     struct bcache *bc = malloc(sizeof (struct bcache));
 124     int disks = bcache_numdev;
 125
 126     if (disks == 0)
 127         disks = 1;      /* safe guard */
 128
 129     if (bc == NULL) {
 130         errno = ENOMEM;
 131         return (bc);
 132     }
 133
 134     /*
 135      * the bcache block count must be power of 2 for hash function
 136      */
 137     i = fls(disks) - 1;         /* highbit - 1 */
 138     if (disks > (1 << i))       /* next power of 2 */
 139         i++;
 140
 141     bc->bcache_nblks = bcache_total_nblks >> i;
 142     bcache_unit_nblks = bc->bcache_nblks;
 143     bc->bcache_data = malloc(bc->bcache_nblks * bcache_blksize);
 144     if (bc->bcache_data == NULL) {
 145         /* dont error out yet. fall back to 32 blocks and try again */
 146         bc->bcache_nblks = 32;
 147         bc->bcache_data = malloc(bc->bcache_nblks * bcache_blksize);
 148     }
 149
 150     bc->bcache_ctl = malloc(bc->bcache_nblks * sizeof(struct bcachectl));
 151
 152     if ((bc->bcache_data == NULL) || (bc->bcache_ctl == NULL)) {
 153         bcache_free_instance(bc);
 154         errno = ENOMEM;
 155         return(NULL);
 156     }
 157
 158     /* Flush the cache */
 159     for (i = 0; i < bc->bcache_nblks; i++) {
 160         bc->bcache_ctl[i].bc_count = -1;
 161         bc->bcache_ctl[i].bc_blkno = -1;
 162     }
 163     bcache_units++;
 164     bc->ra = BCACHE_READAHEAD;  /* optimistic read ahead */
 165     return (bc);
 166 }
 167
 168 void
 169 bcache_free(void *cache)
 170 {
 171     struct bcache *bc = cache;
 172
 173     if (bc == NULL)
 174         return;
 175
 176     bcache_free_instance(bc);
 177     bcache_units--;
 178 }
 179
 180 /*
 181  * Handle a write request; write directly to the disk, and populate the
 182  * cache with the new values.
 183  */
 184 static int
 185 write_strategy(void *devdata, int rw, daddr_t blk, size_t size,
 186     char *buf, size_t *rsize)
 187 {
 188     struct bcache_devdata       *dd = (struct bcache_devdata *)devdata;
 189     struct bcache               *bc = dd->dv_cache;
 190     daddr_t                     i, nblk;
 191
 192     nblk = size / bcache_blksize;
 193
 194     /* Invalidate the blocks being written */
 195     for (i = 0; i < nblk; i++) {
 196         bcache_invalidate(bc, blk + i);
 197     }
 198
 199     /* Write the blocks */
 200     return (dd->dv_strategy(dd->dv_devdata, rw, blk, size, buf, rsize));
 201 }
 202
 203 /*
 204  * Handle a read request; fill in parts of the request that can
 205  * be satisfied by the cache, use the supplied strategy routine to do
 206  * device I/O and then use the I/O results to populate the cache.
 207  */
 208 static int
 209 read_strategy(void *devdata, int rw, daddr_t blk, size_t size,
 210     char *buf, size_t *rsize)
 211 {
 212     struct bcache_devdata       *dd = (struct bcache_devdata *)devdata;
 213     struct bcache               *bc = dd->dv_cache;
 214     size_t                      i, nblk, p_size, r_size, complete, ra;
 215     int                         result;
 216     daddr_t                     p_blk;
 217     caddr_t                     p_buf;
 218
 219     if (bc == NULL) {
 220         errno = ENODEV;
 221         return (-1);
 222     }
 223
 224     if (rsize != NULL)
 225         *rsize = 0;
 226
 227     nblk = size / bcache_blksize;
 228     if (nblk == 0 && size != 0)
 229         nblk++;
 230     result = 0;
 231     complete = 1;
 232
 233     /* Satisfy any cache hits up front, break on first miss */
 234     for (i = 0; i < nblk; i++) {
 235         if (BCACHE_LOOKUP(bc, (daddr_t)(blk + i))) {
 236             bcache_misses += (nblk - i);
 237             complete = 0;
 238             if (nblk - i > BCACHE_MINREADAHEAD && bc->ra > BCACHE_MINREADAHEAD)
 239                 bc->ra >>= 1;   /* reduce read ahead */
 240             break;
 241         } else {
 242             bcache_hits++;
 243         }
 244     }
 245
 246    if (complete) {      /* whole set was in cache, return it */
 247         if (bc->ra < BCACHE_READAHEAD)
 248                 bc->ra <<= 1;   /* increase read ahead */
 249         bcopy(bc->bcache_data + (bcache_blksize * BHASH(bc, blk)), buf, size);
 250         goto done;
 251    }
 252
 253     /*
 254      * Fill in any misses. From check we have i pointing to first missing
 255      * block, read in all remaining blocks + readahead.
 256      * We have space at least for nblk - i before bcache wraps.
 257      */
 258     p_blk = blk + i;
 259     p_buf = bc->bcache_data + (bcache_blksize * BHASH(bc, p_blk));
 260     r_size = bc->bcache_nblks - BHASH(bc, p_blk); /* remaining blocks */
 261
 262     p_size = MIN(r_size, nblk - i);     /* read at least those blocks */
 263
 264     ra = bc->bcache_nblks - BHASH(bc, p_blk + p_size);
 265     if (ra != bc->bcache_nblks) { /* do we have RA space? */
 266         ra = MIN(bc->ra, ra);
 267         p_size += ra;
 268     }
 269
 270     /* invalidate bcache */
 271     for (i = 0; i < p_size; i++) {
 272         bcache_invalidate(bc, p_blk + i);
 273     }
 274
 275     r_size = 0;
 276     /*
 277      * with read-ahead, it may happen we are attempting to read past
 278      * disk end, as bcache has no information about disk size.
 279      * in such case we should get partial read if some blocks can be
 280      * read or error, if no blocks can be read.
 281      * in either case we should return the data in bcache and only
 282      * return error if there is no data.
 283      */
 284     result = dd->dv_strategy(dd->dv_devdata, rw, p_blk,
 285         p_size * bcache_blksize, p_buf, &r_size);
 286
 287     r_size /= bcache_blksize;
 288     for (i = 0; i < r_size; i++)
 289         bcache_insert(bc, p_blk + i);
 290
 291     /* update ra statistics */
 292     if (r_size != 0) {
 293         if (r_size < p_size)
 294             bcache_rablks += (p_size - r_size);
 295         else
 296             bcache_rablks += ra;
 297     }
 298
 299     /* check how much data can we copy */
 300     for (i = 0; i < nblk; i++) {
 301         if (BCACHE_LOOKUP(bc, (daddr_t)(blk + i)))
 302             break;
 303     }
 304
 305     if (size > i * bcache_blksize)
 306         size = i * bcache_blksize;
 307
 308     if (size != 0) {
 309         bcopy(bc->bcache_data + (bcache_blksize * BHASH(bc, blk)), buf, size);
 310         result = 0;
 311     }
 312
 313  done:
 314     if ((result == 0) && (rsize != NULL))
 315         *rsize = size;
 316     return(result);
 317 }
 318
 319 /*
 320  * Requests larger than 1/2 cache size will be bypassed and go
 321  * directly to the disk.  XXX tune this.
 322  */
 323 int
 324 bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size,
 325     char *buf, size_t *rsize)
 326 {
 327     struct bcache_devdata       *dd = (struct bcache_devdata *)devdata;
 328     struct bcache               *bc = dd->dv_cache;
 329     u_int bcache_nblks = 0;
 330     int nblk, cblk, ret;
 331     size_t csize, isize, total;
 332
 333     bcache_ops++;
 334
 335     if (bc != NULL)
 336         bcache_nblks = bc->bcache_nblks;
 337
 338     /* bypass large requests, or when the cache is inactive */
 339     if (bc == NULL ||
 340         ((size * 2 / bcache_blksize) > bcache_nblks)) {
 341         DEBUG("bypass %d from %d", size / bcache_blksize, blk);
 342         bcache_bypasses++;
 343         return (dd->dv_strategy(dd->dv_devdata, rw, blk, size, buf, rsize));
 344     }
 345
 346     switch (rw) {
 347     case F_READ:
 348         nblk = size / bcache_blksize;
 349         if (size != 0 && nblk == 0)
 350             nblk++;     /* read at least one block */
 351
 352         ret = 0;
 353         total = 0;
 354         while(size) {
 355             cblk = bcache_nblks - BHASH(bc, blk); /* # of blocks left */
 356             cblk = MIN(cblk, nblk);
 357
 358             if (size <= bcache_blksize)
 359                 csize = size;
 360             else
 361                 csize = cblk * bcache_blksize;
 362
 363             ret = read_strategy(devdata, rw, blk, csize, buf+total, &isize);
 364
 365             /*
 366              * we may have error from read ahead, if we have read some data
 367              * return partial read.
 368              */
 369             if (ret != 0 || isize == 0) {
 370                 if (total != 0)
 371                     ret = 0;
 372                 break;
 373             }
 374             blk += isize / bcache_blksize;
 375             total += isize;
 376             size -= isize;
 377             nblk = size / bcache_blksize;
 378         }
 379
 380         if (rsize)
 381             *rsize = total;
 382
 383         return (ret);
 384     case F_WRITE:
 385         return write_strategy(devdata, rw, blk, size, buf, rsize);
 386     }
 387     return -1;
 388 }
 389
 390 /*
 391  * Free allocated bcache instance
 392  */
 393 static void
 394 bcache_free_instance(struct bcache *bc)
 395 {
 396     if (bc != NULL) {
 397         if (bc->bcache_ctl)
 398             free(bc->bcache_ctl);
 399         if (bc->bcache_data)
 400             free(bc->bcache_data);
 401         free(bc);
 402     }
 403 }
 404
 405 /*
 406  * Insert a block into the cache.
 407  */
 408 static void
 409 bcache_insert(struct bcache *bc, daddr_t blkno)
 410 {
 411     u_int       cand;
 412
 413     cand = BHASH(bc, blkno);
 414
 415     DEBUG("insert blk %llu -> %u # %d", blkno, cand, bcache_bcount);
 416     bc->bcache_ctl[cand].bc_blkno = blkno;
 417     bc->bcache_ctl[cand].bc_count = bcache_bcount++;
 418 }
 419
 420 /*
 421  * Invalidate a block from the cache.
 422  */
 423 static void
 424 bcache_invalidate(struct bcache *bc, daddr_t blkno)
 425 {
 426     u_int       i;
 427
 428     i = BHASH(bc, blkno);
 429     if (bc->bcache_ctl[i].bc_blkno == blkno) {
 430         bc->bcache_ctl[i].bc_count = -1;
 431         bc->bcache_ctl[i].bc_blkno = -1;
 432         DEBUG("invalidate blk %llu", blkno);
 433     }
 434 }
 435
 436 #ifndef BOOT2
 437 COMMAND_SET(bcachestat, "bcachestat", "get disk block cache stats", command_bcache);
 438
 439 static int
 440 command_bcache(int argc, char *argv[])
 441 {
 442     if (argc != 1) {
 443         command_errmsg = "wrong number of arguments";
 444         return(CMD_ERROR);
 445     }
 446
 447     printf("\ncache blocks: %d\n", bcache_total_nblks);
 448     printf("cache blocksz: %d\n", bcache_blksize);
 449     printf("cache readahead: %d\n", bcache_rablks);
 450     printf("unit cache blocks: %d\n", bcache_unit_nblks);
 451     printf("cached units: %d\n", bcache_units);
 452     printf("%d ops  %d bypasses  %d hits  %d misses\n", bcache_ops,
 453         bcache_bypasses, bcache_hits, bcache_misses);
 454     return(CMD_OK);
 455 }
 456 #endif