sys/cddl/contrib/opensolaris/uts/common/fs/zfs/vdev_cache.c

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25 /*
  26  * Copyright (c) 2013, 2017 by Delphix. All rights reserved.
  27  */
  28
  29 #include <sys/zfs_context.h>
  30 #include <sys/spa.h>
  31 #include <sys/vdev_impl.h>
  32 #include <sys/zio.h>
  33 #include <sys/kstat.h>
  34 #include <sys/abd.h>
  35
  36 /*
  37  * Virtual device read-ahead caching.
  38  *
  39  * This file implements a simple LRU read-ahead cache.  When the DMU reads
  40  * a given block, it will often want other, nearby blocks soon thereafter.
  41  * We take advantage of this by reading a larger disk region and caching
  42  * the result.  In the best case, this can turn 128 back-to-back 512-byte
  43  * reads into a single 64k read followed by 127 cache hits; this reduces
  44  * latency dramatically.  In the worst case, it can turn an isolated 512-byte
  45  * read into a 64k read, which doesn't affect latency all that much but is
  46  * terribly wasteful of bandwidth.  A more intelligent version of the cache
  47  * could keep track of access patterns and not do read-ahead unless it sees
  48  * at least two temporally close I/Os to the same region.  Currently, only
  49  * metadata I/O is inflated.  A futher enhancement could take advantage of
  50  * more semantic information about the I/O.  And it could use something
  51  * faster than an AVL tree; that was chosen solely for convenience.
  52  *
  53  * There are five cache operations: allocate, fill, read, write, evict.
  54  *
  55  * (1) Allocate.  This reserves a cache entry for the specified region.
  56  *     We separate the allocate and fill operations so that multiple threads
  57  *     don't generate I/O for the same cache miss.
  58  *
  59  * (2) Fill.  When the I/O for a cache miss completes, the fill routine
  60  *     places the data in the previously allocated cache entry.
  61  *
  62  * (3) Read.  Read data from the cache.
  63  *
  64  * (4) Write.  Update cache contents after write completion.
  65  *
  66  * (5) Evict.  When allocating a new entry, we evict the oldest (LRU) entry
  67  *     if the total cache size exceeds zfs_vdev_cache_size.
  68  */
  69
  70 /*
  71  * These tunables are for performance analysis.
  72  */
  73 /*
  74  * All i/os smaller than zfs_vdev_cache_max will be turned into
  75  * 1<<zfs_vdev_cache_bshift byte reads by the vdev_cache (aka software
  76  * track buffer).  At most zfs_vdev_cache_size bytes will be kept in each
  77  * vdev's vdev_cache.
  78  *
  79  * TODO: Note that with the current ZFS code, it turns out that the
  80  * vdev cache is not helpful, and in some cases actually harmful.  It
  81  * is better if we disable this.  Once some time has passed, we should
  82  * actually remove this to simplify the code.  For now we just disable
  83  * it by setting the zfs_vdev_cache_size to zero.  Note that Solaris 11
  84  * has made these same changes.
  85  */
  86 int zfs_vdev_cache_max = 1<<14;                 /* 16KB */
  87 int zfs_vdev_cache_size = 0;
  88 int zfs_vdev_cache_bshift = 16;
  89
  90 #define VCBS (1 << zfs_vdev_cache_bshift)       /* 64KB */
  91
  92 SYSCTL_DECL(_vfs_zfs_vdev);
  93 SYSCTL_NODE(_vfs_zfs_vdev, OID_AUTO, cache, CTLFLAG_RW, 0, "ZFS VDEV Cache");
  94 SYSCTL_INT(_vfs_zfs_vdev_cache, OID_AUTO, max, CTLFLAG_RDTUN,
  95     &zfs_vdev_cache_max, 0, "Maximum I/O request size that increase read size");
  96 SYSCTL_INT(_vfs_zfs_vdev_cache, OID_AUTO, size, CTLFLAG_RDTUN,
  97     &zfs_vdev_cache_size, 0, "Size of VDEV cache");
  98 SYSCTL_INT(_vfs_zfs_vdev_cache, OID_AUTO, bshift, CTLFLAG_RDTUN,
  99     &zfs_vdev_cache_bshift, 0, "Turn too small requests into 1 << this value");
 100
 101 kstat_t *vdc_ksp = NULL;
 102
 103 typedef struct vdc_stats {
 104         kstat_named_t vdc_stat_delegations;
 105         kstat_named_t vdc_stat_hits;
 106         kstat_named_t vdc_stat_misses;
 107 } vdc_stats_t;
 108
 109 static vdc_stats_t vdc_stats = {
 110         { "delegations",        KSTAT_DATA_UINT64 },
 111         { "hits",               KSTAT_DATA_UINT64 },
 112         { "misses",             KSTAT_DATA_UINT64 }
 113 };
 114
 115 #define VDCSTAT_BUMP(stat)      atomic_inc_64(&vdc_stats.stat.value.ui64);
 116
 117 static int
 118 vdev_cache_offset_compare(const void *a1, const void *a2)
 119 {
 120         const vdev_cache_entry_t *ve1 = a1;
 121         const vdev_cache_entry_t *ve2 = a2;
 122
 123         if (ve1->ve_offset < ve2->ve_offset)
 124                 return (-1);
 125         if (ve1->ve_offset > ve2->ve_offset)
 126                 return (1);
 127         return (0);
 128 }
 129
 130 static int
 131 vdev_cache_lastused_compare(const void *a1, const void *a2)
 132 {
 133         const vdev_cache_entry_t *ve1 = a1;
 134         const vdev_cache_entry_t *ve2 = a2;
 135
 136         if (ve1->ve_lastused < ve2->ve_lastused)
 137                 return (-1);
 138         if (ve1->ve_lastused > ve2->ve_lastused)
 139                 return (1);
 140
 141         /*
 142          * Among equally old entries, sort by offset to ensure uniqueness.
 143          */
 144         return (vdev_cache_offset_compare(a1, a2));
 145 }
 146
 147 /*
 148  * Evict the specified entry from the cache.
 149  */
 150 static void
 151 vdev_cache_evict(vdev_cache_t *vc, vdev_cache_entry_t *ve)
 152 {
 153         ASSERT(MUTEX_HELD(&vc->vc_lock));
 154         ASSERT3P(ve->ve_fill_io, ==, NULL);
 155         ASSERT3P(ve->ve_abd, !=, NULL);
 156
 157         avl_remove(&vc->vc_lastused_tree, ve);
 158         avl_remove(&vc->vc_offset_tree, ve);
 159         abd_free(ve->ve_abd);
 160         kmem_free(ve, sizeof (vdev_cache_entry_t));
 161 }
 162
 163 /*
 164  * Allocate an entry in the cache.  At the point we don't have the data,
 165  * we're just creating a placeholder so that multiple threads don't all
 166  * go off and read the same blocks.
 167  */
 168 static vdev_cache_entry_t *
 169 vdev_cache_allocate(zio_t *zio)
 170 {
 171         vdev_cache_t *vc = &zio->io_vd->vdev_cache;
 172         uint64_t offset = P2ALIGN(zio->io_offset, VCBS);
 173         vdev_cache_entry_t *ve;
 174
 175         ASSERT(MUTEX_HELD(&vc->vc_lock));
 176
 177         if (zfs_vdev_cache_size == 0)
 178                 return (NULL);
 179
 180         /*
 181          * If adding a new entry would exceed the cache size,
 182          * evict the oldest entry (LRU).
 183          */
 184         if ((avl_numnodes(&vc->vc_lastused_tree) << zfs_vdev_cache_bshift) >
 185             zfs_vdev_cache_size) {
 186                 ve = avl_first(&vc->vc_lastused_tree);
 187                 if (ve->ve_fill_io != NULL)
 188                         return (NULL);
 189                 ASSERT3U(ve->ve_hits, !=, 0);
 190                 vdev_cache_evict(vc, ve);
 191         }
 192
 193         ve = kmem_zalloc(sizeof (vdev_cache_entry_t), KM_SLEEP);
 194         ve->ve_offset = offset;
 195         ve->ve_lastused = ddi_get_lbolt();
 196         ve->ve_abd = abd_alloc_for_io(VCBS, B_TRUE);
 197
 198         avl_add(&vc->vc_offset_tree, ve);
 199         avl_add(&vc->vc_lastused_tree, ve);
 200
 201         return (ve);
 202 }
 203
 204 static void
 205 vdev_cache_hit(vdev_cache_t *vc, vdev_cache_entry_t *ve, zio_t *zio)
 206 {
 207         uint64_t cache_phase = P2PHASE(zio->io_offset, VCBS);
 208
 209         ASSERT(MUTEX_HELD(&vc->vc_lock));
 210         ASSERT3P(ve->ve_fill_io, ==, NULL);
 211
 212         if (ve->ve_lastused != ddi_get_lbolt()) {
 213                 avl_remove(&vc->vc_lastused_tree, ve);
 214                 ve->ve_lastused = ddi_get_lbolt();
 215                 avl_add(&vc->vc_lastused_tree, ve);
 216         }
 217
 218         ve->ve_hits++;
 219         abd_copy_off(zio->io_abd, ve->ve_abd, 0, cache_phase, zio->io_size);
 220 }
 221
 222 /*
 223  * Fill a previously allocated cache entry with data.
 224  */
 225 static void
 226 vdev_cache_fill(zio_t *fio)
 227 {
 228         vdev_t *vd = fio->io_vd;
 229         vdev_cache_t *vc = &vd->vdev_cache;
 230         vdev_cache_entry_t *ve = fio->io_private;
 231         zio_t *pio;
 232
 233         ASSERT3U(fio->io_size, ==, VCBS);
 234
 235         /*
 236          * Add data to the cache.
 237          */
 238         mutex_enter(&vc->vc_lock);
 239
 240         ASSERT3P(ve->ve_fill_io, ==, fio);
 241         ASSERT3U(ve->ve_offset, ==, fio->io_offset);
 242         ASSERT3P(ve->ve_abd, ==, fio->io_abd);
 243
 244         ve->ve_fill_io = NULL;
 245
 246         /*
 247          * Even if this cache line was invalidated by a missed write update,
 248          * any reads that were queued up before the missed update are still
 249          * valid, so we can satisfy them from this line before we evict it.
 250          */
 251         zio_link_t *zl = NULL;
 252         while ((pio = zio_walk_parents(fio, &zl)) != NULL)
 253                 vdev_cache_hit(vc, ve, pio);
 254
 255         if (fio->io_error || ve->ve_missed_update)
 256                 vdev_cache_evict(vc, ve);
 257
 258         mutex_exit(&vc->vc_lock);
 259 }
 260
 261 /*
 262  * Read data from the cache.  Returns B_TRUE cache hit, B_FALSE on miss.
 263  */
 264 boolean_t
 265 vdev_cache_read(zio_t *zio)
 266 {
 267         vdev_cache_t *vc = &zio->io_vd->vdev_cache;
 268         vdev_cache_entry_t *ve, ve_search;
 269         uint64_t cache_offset = P2ALIGN(zio->io_offset, VCBS);
 270         uint64_t cache_phase = P2PHASE(zio->io_offset, VCBS);
 271         zio_t *fio;
 272
 273         ASSERT3U(zio->io_type, ==, ZIO_TYPE_READ);
 274
 275         if (zio->io_flags & ZIO_FLAG_DONT_CACHE)
 276                 return (B_FALSE);
 277
 278         if (zio->io_size > zfs_vdev_cache_max)
 279                 return (B_FALSE);
 280
 281         /*
 282          * If the I/O straddles two or more cache blocks, don't cache it.
 283          */
 284         if (P2BOUNDARY(zio->io_offset, zio->io_size, VCBS))
 285                 return (B_FALSE);
 286
 287         ASSERT3U(cache_phase + zio->io_size, <=, VCBS);
 288
 289         mutex_enter(&vc->vc_lock);
 290
 291         ve_search.ve_offset = cache_offset;
 292         ve = avl_find(&vc->vc_offset_tree, &ve_search, NULL);
 293
 294         if (ve != NULL) {
 295                 if (ve->ve_missed_update) {
 296                         mutex_exit(&vc->vc_lock);
 297                         return (B_FALSE);
 298                 }
 299
 300                 if ((fio = ve->ve_fill_io) != NULL) {
 301                         zio_vdev_io_bypass(zio);
 302                         zio_add_child(zio, fio);
 303                         mutex_exit(&vc->vc_lock);
 304                         VDCSTAT_BUMP(vdc_stat_delegations);
 305                         return (B_TRUE);
 306                 }
 307
 308                 vdev_cache_hit(vc, ve, zio);
 309                 zio_vdev_io_bypass(zio);
 310
 311                 mutex_exit(&vc->vc_lock);
 312                 VDCSTAT_BUMP(vdc_stat_hits);
 313                 return (B_TRUE);
 314         }
 315
 316         ve = vdev_cache_allocate(zio);
 317
 318         if (ve == NULL) {
 319                 mutex_exit(&vc->vc_lock);
 320                 return (B_FALSE);
 321         }
 322
 323         fio = zio_vdev_delegated_io(zio->io_vd, cache_offset,
 324             ve->ve_abd, VCBS, ZIO_TYPE_READ, ZIO_PRIORITY_NOW,
 325             ZIO_FLAG_DONT_CACHE, vdev_cache_fill, ve);
 326
 327         ve->ve_fill_io = fio;
 328         zio_vdev_io_bypass(zio);
 329         zio_add_child(zio, fio);
 330
 331         mutex_exit(&vc->vc_lock);
 332         zio_nowait(fio);
 333         VDCSTAT_BUMP(vdc_stat_misses);
 334
 335         return (B_TRUE);
 336 }
 337
 338 /*
 339  * Update cache contents upon write completion.
 340  */
 341 void
 342 vdev_cache_write(zio_t *zio)
 343 {
 344         vdev_cache_t *vc = &zio->io_vd->vdev_cache;
 345         vdev_cache_entry_t *ve, ve_search;
 346         uint64_t io_start = zio->io_offset;
 347         uint64_t io_end = io_start + zio->io_size;
 348         uint64_t min_offset = P2ALIGN(io_start, VCBS);
 349         uint64_t max_offset = P2ROUNDUP(io_end, VCBS);
 350         avl_index_t where;
 351
 352         ASSERT3U(zio->io_type, ==, ZIO_TYPE_WRITE);
 353
 354         mutex_enter(&vc->vc_lock);
 355
 356         ve_search.ve_offset = min_offset;
 357         ve = avl_find(&vc->vc_offset_tree, &ve_search, &where);
 358
 359         if (ve == NULL)
 360                 ve = avl_nearest(&vc->vc_offset_tree, where, AVL_AFTER);
 361
 362         while (ve != NULL && ve->ve_offset < max_offset) {
 363                 uint64_t start = MAX(ve->ve_offset, io_start);
 364                 uint64_t end = MIN(ve->ve_offset + VCBS, io_end);
 365
 366                 if (ve->ve_fill_io != NULL) {
 367                         ve->ve_missed_update = 1;
 368                 } else {
 369                         abd_copy_off(ve->ve_abd, zio->io_abd,
 370                             start - ve->ve_offset, start - io_start,
 371                             end - start);
 372                 }
 373                 ve = AVL_NEXT(&vc->vc_offset_tree, ve);
 374         }
 375         mutex_exit(&vc->vc_lock);
 376 }
 377
 378 void
 379 vdev_cache_purge(vdev_t *vd)
 380 {
 381         vdev_cache_t *vc = &vd->vdev_cache;
 382         vdev_cache_entry_t *ve;
 383
 384         mutex_enter(&vc->vc_lock);
 385         while ((ve = avl_first(&vc->vc_offset_tree)) != NULL)
 386                 vdev_cache_evict(vc, ve);
 387         mutex_exit(&vc->vc_lock);
 388 }
 389
 390 void
 391 vdev_cache_init(vdev_t *vd)
 392 {
 393         vdev_cache_t *vc = &vd->vdev_cache;
 394
 395         mutex_init(&vc->vc_lock, NULL, MUTEX_DEFAULT, NULL);
 396
 397         avl_create(&vc->vc_offset_tree, vdev_cache_offset_compare,
 398             sizeof (vdev_cache_entry_t),
 399             offsetof(struct vdev_cache_entry, ve_offset_node));
 400
 401         avl_create(&vc->vc_lastused_tree, vdev_cache_lastused_compare,
 402             sizeof (vdev_cache_entry_t),
 403             offsetof(struct vdev_cache_entry, ve_lastused_node));
 404 }
 405
 406 void
 407 vdev_cache_fini(vdev_t *vd)
 408 {
 409         vdev_cache_t *vc = &vd->vdev_cache;
 410
 411         vdev_cache_purge(vd);
 412
 413         avl_destroy(&vc->vc_offset_tree);
 414         avl_destroy(&vc->vc_lastused_tree);
 415
 416         mutex_destroy(&vc->vc_lock);
 417 }
 418
 419 void
 420 vdev_cache_stat_init(void)
 421 {
 422         vdc_ksp = kstat_create("zfs", 0, "vdev_cache_stats", "misc",
 423             KSTAT_TYPE_NAMED, sizeof (vdc_stats) / sizeof (kstat_named_t),
 424             KSTAT_FLAG_VIRTUAL);
 425         if (vdc_ksp != NULL) {
 426                 vdc_ksp->ks_data = &vdc_stats;
 427                 kstat_install(vdc_ksp);
 428         }
 429 }
 430
 431 void
 432 vdev_cache_stat_fini(void)
 433 {
 434         if (vdc_ksp != NULL) {
 435                 kstat_delete(vdc_ksp);
 436                 vdc_ksp = NULL;
 437         }
 438 }