module/zfs/ddt.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 /*
  23  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
  24  */
  25
  26 #include <sys/zfs_context.h>
  27 #include <sys/spa.h>
  28 #include <sys/spa_impl.h>
  29 #include <sys/zio.h>
  30 #include <sys/ddt.h>
  31 #include <sys/zap.h>
  32 #include <sys/dmu_tx.h>
  33 #include <sys/arc.h>
  34 #include <sys/dsl_pool.h>
  35 #include <sys/zio_checksum.h>
  36 #include <sys/zio_compress.h>
  37 #include <sys/dsl_scan.h>
  38
  39 /*
  40  * Enable/disable prefetching of dedup-ed blocks which are going to be freed.
  41  */
  42 int zfs_dedup_prefetch = 1;
  43
  44 static const ddt_ops_t *ddt_ops[DDT_TYPES] = {
  45         &ddt_zap_ops,
  46 };
  47
  48 static const char *ddt_class_name[DDT_CLASSES] = {
  49         "ditto",
  50         "duplicate",
  51         "unique",
  52 };
  53
  54 static void
  55 ddt_object_create(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
  56     dmu_tx_t *tx)
  57 {
  58         spa_t *spa = ddt->ddt_spa;
  59         objset_t *os = ddt->ddt_os;
  60         uint64_t *objectp = &ddt->ddt_object[type][class];
  61         boolean_t prehash = zio_checksum_table[ddt->ddt_checksum].ci_dedup;
  62         char name[DDT_NAMELEN];
  63
  64         ddt_object_name(ddt, type, class, name);
  65
  66         ASSERT(*objectp == 0);
  67         VERIFY(ddt_ops[type]->ddt_op_create(os, objectp, tx, prehash) == 0);
  68         ASSERT(*objectp != 0);
  69
  70         VERIFY(zap_add(os, DMU_POOL_DIRECTORY_OBJECT, name,
  71             sizeof (uint64_t), 1, objectp, tx) == 0);
  72
  73         VERIFY(zap_add(os, spa->spa_ddt_stat_object, name,
  74             sizeof (uint64_t), sizeof (ddt_histogram_t) / sizeof (uint64_t),
  75             &ddt->ddt_histogram[type][class], tx) == 0);
  76 }
  77
  78 static void
  79 ddt_object_destroy(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
  80     dmu_tx_t *tx)
  81 {
  82         spa_t *spa = ddt->ddt_spa;
  83         objset_t *os = ddt->ddt_os;
  84         uint64_t *objectp = &ddt->ddt_object[type][class];
  85         char name[DDT_NAMELEN];
  86
  87         ddt_object_name(ddt, type, class, name);
  88
  89         ASSERT(*objectp != 0);
  90         ASSERT(ddt_object_count(ddt, type, class) == 0);
  91         ASSERT(ddt_histogram_empty(&ddt->ddt_histogram[type][class]));
  92         VERIFY(zap_remove(os, DMU_POOL_DIRECTORY_OBJECT, name, tx) == 0);
  93         VERIFY(zap_remove(os, spa->spa_ddt_stat_object, name, tx) == 0);
  94         VERIFY(ddt_ops[type]->ddt_op_destroy(os, *objectp, tx) == 0);
  95         bzero(&ddt->ddt_object_stats[type][class], sizeof (ddt_object_t));
  96
  97         *objectp = 0;
  98 }
  99
 100 static int
 101 ddt_object_load(ddt_t *ddt, enum ddt_type type, enum ddt_class class)
 102 {
 103         ddt_object_t *ddo = &ddt->ddt_object_stats[type][class];
 104         dmu_object_info_t doi;
 105         char name[DDT_NAMELEN];
 106         int error;
 107
 108         ddt_object_name(ddt, type, class, name);
 109
 110         error = zap_lookup(ddt->ddt_os, DMU_POOL_DIRECTORY_OBJECT, name,
 111             sizeof (uint64_t), 1, &ddt->ddt_object[type][class]);
 112
 113         if (error)
 114                 return (error);
 115
 116         error = zap_lookup(ddt->ddt_os, ddt->ddt_spa->spa_ddt_stat_object, name,
 117             sizeof (uint64_t), sizeof (ddt_histogram_t) / sizeof (uint64_t),
 118             &ddt->ddt_histogram[type][class]);
 119
 120         /*
 121          * Seed the cached statistics.
 122          */
 123         VERIFY(ddt_object_info(ddt, type, class, &doi) == 0);
 124
 125         ddo->ddo_count = ddt_object_count(ddt, type, class);
 126         ddo->ddo_dspace = doi.doi_physical_blocks_512 << 9;
 127         ddo->ddo_mspace = doi.doi_fill_count * doi.doi_data_block_size;
 128
 129         ASSERT(error == 0);
 130         return (error);
 131 }
 132
 133 static void
 134 ddt_object_sync(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 135     dmu_tx_t *tx)
 136 {
 137         ddt_object_t *ddo = &ddt->ddt_object_stats[type][class];
 138         dmu_object_info_t doi;
 139         char name[DDT_NAMELEN];
 140
 141         ddt_object_name(ddt, type, class, name);
 142
 143         VERIFY(zap_update(ddt->ddt_os, ddt->ddt_spa->spa_ddt_stat_object, name,
 144             sizeof (uint64_t), sizeof (ddt_histogram_t) / sizeof (uint64_t),
 145             &ddt->ddt_histogram[type][class], tx) == 0);
 146
 147         /*
 148          * Cache DDT statistics; this is the only time they'll change.
 149          */
 150         VERIFY(ddt_object_info(ddt, type, class, &doi) == 0);
 151
 152         ddo->ddo_count = ddt_object_count(ddt, type, class);
 153         ddo->ddo_dspace = doi.doi_physical_blocks_512 << 9;
 154         ddo->ddo_mspace = doi.doi_fill_count * doi.doi_data_block_size;
 155 }
 156
 157 static int
 158 ddt_object_lookup(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 159     ddt_entry_t *dde)
 160 {
 161         if (!ddt_object_exists(ddt, type, class))
 162                 return (ENOENT);
 163
 164         return (ddt_ops[type]->ddt_op_lookup(ddt->ddt_os,
 165             ddt->ddt_object[type][class], dde));
 166 }
 167
 168 static void
 169 ddt_object_prefetch(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 170     ddt_entry_t *dde)
 171 {
 172         if (!ddt_object_exists(ddt, type, class))
 173                 return;
 174
 175         ddt_ops[type]->ddt_op_prefetch(ddt->ddt_os,
 176             ddt->ddt_object[type][class], dde);
 177 }
 178
 179 int
 180 ddt_object_update(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 181     ddt_entry_t *dde, dmu_tx_t *tx)
 182 {
 183         ASSERT(ddt_object_exists(ddt, type, class));
 184
 185         return (ddt_ops[type]->ddt_op_update(ddt->ddt_os,
 186             ddt->ddt_object[type][class], dde, tx));
 187 }
 188
 189 static int
 190 ddt_object_remove(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 191     ddt_entry_t *dde, dmu_tx_t *tx)
 192 {
 193         ASSERT(ddt_object_exists(ddt, type, class));
 194
 195         return (ddt_ops[type]->ddt_op_remove(ddt->ddt_os,
 196             ddt->ddt_object[type][class], dde, tx));
 197 }
 198
 199 int
 200 ddt_object_walk(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 201     uint64_t *walk, ddt_entry_t *dde)
 202 {
 203         ASSERT(ddt_object_exists(ddt, type, class));
 204
 205         return (ddt_ops[type]->ddt_op_walk(ddt->ddt_os,
 206             ddt->ddt_object[type][class], dde, walk));
 207 }
 208
 209 uint64_t
 210 ddt_object_count(ddt_t *ddt, enum ddt_type type, enum ddt_class class)
 211 {
 212         ASSERT(ddt_object_exists(ddt, type, class));
 213
 214         return (ddt_ops[type]->ddt_op_count(ddt->ddt_os,
 215             ddt->ddt_object[type][class]));
 216 }
 217
 218 int
 219 ddt_object_info(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 220     dmu_object_info_t *doi)
 221 {
 222         if (!ddt_object_exists(ddt, type, class))
 223                 return (ENOENT);
 224
 225         return (dmu_object_info(ddt->ddt_os, ddt->ddt_object[type][class],
 226             doi));
 227 }
 228
 229 boolean_t
 230 ddt_object_exists(ddt_t *ddt, enum ddt_type type, enum ddt_class class)
 231 {
 232         return (!!ddt->ddt_object[type][class]);
 233 }
 234
 235 void
 236 ddt_object_name(ddt_t *ddt, enum ddt_type type, enum ddt_class class,
 237     char *name)
 238 {
 239         (void) sprintf(name, DMU_POOL_DDT,
 240             zio_checksum_table[ddt->ddt_checksum].ci_name,
 241             ddt_ops[type]->ddt_op_name, ddt_class_name[class]);
 242 }
 243
 244 void
 245 ddt_bp_fill(const ddt_phys_t *ddp, blkptr_t *bp, uint64_t txg)
 246 {
 247         int d;
 248         ASSERT(txg != 0);
 249
 250         for (d = 0; d < SPA_DVAS_PER_BP; d++)
 251                 bp->blk_dva[d] = ddp->ddp_dva[d];
 252         BP_SET_BIRTH(bp, txg, ddp->ddp_phys_birth);
 253 }
 254
 255 void
 256 ddt_bp_create(enum zio_checksum checksum,
 257     const ddt_key_t *ddk, const ddt_phys_t *ddp, blkptr_t *bp)
 258 {
 259         BP_ZERO(bp);
 260
 261         if (ddp != NULL)
 262                 ddt_bp_fill(ddp, bp, ddp->ddp_phys_birth);
 263
 264         bp->blk_cksum = ddk->ddk_cksum;
 265         bp->blk_fill = 1;
 266
 267         BP_SET_LSIZE(bp, DDK_GET_LSIZE(ddk));
 268         BP_SET_PSIZE(bp, DDK_GET_PSIZE(ddk));
 269         BP_SET_COMPRESS(bp, DDK_GET_COMPRESS(ddk));
 270         BP_SET_CHECKSUM(bp, checksum);
 271         BP_SET_TYPE(bp, DMU_OT_DEDUP);
 272         BP_SET_LEVEL(bp, 0);
 273         BP_SET_DEDUP(bp, 0);
 274         BP_SET_BYTEORDER(bp, ZFS_HOST_BYTEORDER);
 275 }
 276
 277 void
 278 ddt_key_fill(ddt_key_t *ddk, const blkptr_t *bp)
 279 {
 280         ddk->ddk_cksum = bp->blk_cksum;
 281         ddk->ddk_prop = 0;
 282
 283         DDK_SET_LSIZE(ddk, BP_GET_LSIZE(bp));
 284         DDK_SET_PSIZE(ddk, BP_GET_PSIZE(bp));
 285         DDK_SET_COMPRESS(ddk, BP_GET_COMPRESS(bp));
 286 }
 287
 288 void
 289 ddt_phys_fill(ddt_phys_t *ddp, const blkptr_t *bp)
 290 {
 291         int d;
 292         ASSERT(ddp->ddp_phys_birth == 0);
 293
 294         for (d = 0; d < SPA_DVAS_PER_BP; d++)
 295                 ddp->ddp_dva[d] = bp->blk_dva[d];
 296         ddp->ddp_phys_birth = BP_PHYSICAL_BIRTH(bp);
 297 }
 298
 299 void
 300 ddt_phys_clear(ddt_phys_t *ddp)
 301 {
 302         bzero(ddp, sizeof (*ddp));
 303 }
 304
 305 void
 306 ddt_phys_addref(ddt_phys_t *ddp)
 307 {
 308         ddp->ddp_refcnt++;
 309 }
 310
 311 void
 312 ddt_phys_decref(ddt_phys_t *ddp)
 313 {
 314         ASSERT((int64_t)ddp->ddp_refcnt > 0);
 315         ddp->ddp_refcnt--;
 316 }
 317
 318 void
 319 ddt_phys_free(ddt_t *ddt, ddt_key_t *ddk, ddt_phys_t *ddp, uint64_t txg)
 320 {
 321         blkptr_t blk;
 322
 323         ddt_bp_create(ddt->ddt_checksum, ddk, ddp, &blk);
 324         ddt_phys_clear(ddp);
 325         zio_free(ddt->ddt_spa, txg, &blk);
 326 }
 327
 328 ddt_phys_t *
 329 ddt_phys_select(const ddt_entry_t *dde, const blkptr_t *bp)
 330 {
 331         ddt_phys_t *ddp = (ddt_phys_t *)dde->dde_phys;
 332         int p;
 333
 334         for (p = 0; p < DDT_PHYS_TYPES; p++, ddp++) {
 335                 if (DVA_EQUAL(BP_IDENTITY(bp), &ddp->ddp_dva[0]) &&
 336                     BP_PHYSICAL_BIRTH(bp) == ddp->ddp_phys_birth)
 337                         return (ddp);
 338         }
 339         return (NULL);
 340 }
 341
 342 uint64_t
 343 ddt_phys_total_refcnt(const ddt_entry_t *dde)
 344 {
 345         uint64_t refcnt = 0;
 346         int p;
 347
 348         for (p = DDT_PHYS_SINGLE; p <= DDT_PHYS_TRIPLE; p++)
 349                 refcnt += dde->dde_phys[p].ddp_refcnt;
 350
 351         return (refcnt);
 352 }
 353
 354 static void
 355 ddt_stat_generate(ddt_t *ddt, ddt_entry_t *dde, ddt_stat_t *dds)
 356 {
 357         spa_t *spa = ddt->ddt_spa;
 358         ddt_phys_t *ddp = dde->dde_phys;
 359         ddt_key_t *ddk = &dde->dde_key;
 360         uint64_t lsize = DDK_GET_LSIZE(ddk);
 361         uint64_t psize = DDK_GET_PSIZE(ddk);
 362         int p, d;
 363
 364         bzero(dds, sizeof (*dds));
 365
 366         for (p = 0; p < DDT_PHYS_TYPES; p++, ddp++) {
 367                 uint64_t dsize = 0;
 368                 uint64_t refcnt = ddp->ddp_refcnt;
 369
 370                 if (ddp->ddp_phys_birth == 0)
 371                         continue;
 372
 373                 for (d = 0; d < SPA_DVAS_PER_BP; d++)
 374                         dsize += dva_get_dsize_sync(spa, &ddp->ddp_dva[d]);
 375
 376                 dds->dds_blocks += 1;
 377                 dds->dds_lsize += lsize;
 378                 dds->dds_psize += psize;
 379                 dds->dds_dsize += dsize;
 380
 381                 dds->dds_ref_blocks += refcnt;
 382                 dds->dds_ref_lsize += lsize * refcnt;
 383                 dds->dds_ref_psize += psize * refcnt;
 384                 dds->dds_ref_dsize += dsize * refcnt;
 385         }
 386 }
 387
 388 void
 389 ddt_stat_add(ddt_stat_t *dst, const ddt_stat_t *src, uint64_t neg)
 390 {
 391         const uint64_t *s = (const uint64_t *)src;
 392         uint64_t *d = (uint64_t *)dst;
 393         uint64_t *d_end = (uint64_t *)(dst + 1);
 394
 395         ASSERT(neg == 0 || neg == -1ULL);       /* add or subtract */
 396
 397         while (d < d_end)
 398                 *d++ += (*s++ ^ neg) - neg;
 399 }
 400
 401 static void
 402 ddt_stat_update(ddt_t *ddt, ddt_entry_t *dde, uint64_t neg)
 403 {
 404         ddt_stat_t dds;
 405         ddt_histogram_t *ddh;
 406         int bucket;
 407
 408         ddt_stat_generate(ddt, dde, &dds);
 409
 410         bucket = highbit(dds.dds_ref_blocks) - 1;
 411         ASSERT(bucket >= 0);
 412
 413         ddh = &ddt->ddt_histogram[dde->dde_type][dde->dde_class];
 414
 415         ddt_stat_add(&ddh->ddh_stat[bucket], &dds, neg);
 416 }
 417
 418 void
 419 ddt_histogram_add(ddt_histogram_t *dst, const ddt_histogram_t *src)
 420 {
 421         int h;
 422
 423         for (h = 0; h < 64; h++)
 424                 ddt_stat_add(&dst->ddh_stat[h], &src->ddh_stat[h], 0);
 425 }
 426
 427 void
 428 ddt_histogram_stat(ddt_stat_t *dds, const ddt_histogram_t *ddh)
 429 {
 430         int h;
 431
 432         bzero(dds, sizeof (*dds));
 433
 434         for (h = 0; h < 64; h++)
 435                 ddt_stat_add(dds, &ddh->ddh_stat[h], 0);
 436 }
 437
 438 boolean_t
 439 ddt_histogram_empty(const ddt_histogram_t *ddh)
 440 {
 441         const uint64_t *s = (const uint64_t *)ddh;
 442         const uint64_t *s_end = (const uint64_t *)(ddh + 1);
 443
 444         while (s < s_end)
 445                 if (*s++ != 0)
 446                         return (B_FALSE);
 447
 448         return (B_TRUE);
 449 }
 450
 451 void
 452 ddt_get_dedup_object_stats(spa_t *spa, ddt_object_t *ddo_total)
 453 {
 454         enum zio_checksum c;
 455         enum ddt_type type;
 456         enum ddt_class class;
 457
 458         /* Sum the statistics we cached in ddt_object_sync(). */
 459         for (c = 0; c < ZIO_CHECKSUM_FUNCTIONS; c++) {
 460                 ddt_t *ddt = spa->spa_ddt[c];
 461                 for (type = 0; type < DDT_TYPES; type++) {
 462                         for (class = 0; class < DDT_CLASSES;
 463                             class++) {
 464                                 ddt_object_t *ddo =
 465                                     &ddt->ddt_object_stats[type][class];
 466                                 ddo_total->ddo_count += ddo->ddo_count;
 467                                 ddo_total->ddo_dspace += ddo->ddo_dspace;
 468                                 ddo_total->ddo_mspace += ddo->ddo_mspace;
 469                         }
 470                 }
 471         }
 472
 473         /* ... and compute the averages. */
 474         if (ddo_total->ddo_count != 0) {
 475                 ddo_total->ddo_dspace /= ddo_total->ddo_count;
 476                 ddo_total->ddo_mspace /= ddo_total->ddo_count;
 477         }
 478 }
 479
 480 void
 481 ddt_get_dedup_histogram(spa_t *spa, ddt_histogram_t *ddh)
 482 {
 483         enum zio_checksum c;
 484         enum ddt_type type;
 485         enum ddt_class class;
 486
 487         for (c = 0; c < ZIO_CHECKSUM_FUNCTIONS; c++) {
 488                 ddt_t *ddt = spa->spa_ddt[c];
 489                 for (type = 0; type < DDT_TYPES; type++) {
 490                         for (class = 0; class < DDT_CLASSES;
 491                             class++) {
 492                                 ddt_histogram_add(ddh,
 493                                     &ddt->ddt_histogram_cache[type][class]);
 494                         }
 495                 }
 496         }
 497 }
 498
 499 void
 500 ddt_get_dedup_stats(spa_t *spa, ddt_stat_t *dds_total)
 501 {
 502         ddt_histogram_t *ddh_total;
 503
 504         /* XXX: Move to a slab */
 505         ddh_total = kmem_zalloc(sizeof (ddt_histogram_t), KM_SLEEP);
 506         ddt_get_dedup_histogram(spa, ddh_total);
 507         ddt_histogram_stat(dds_total, ddh_total);
 508         kmem_free(ddh_total, sizeof (ddt_histogram_t));
 509 }
 510
 511 uint64_t
 512 ddt_get_dedup_dspace(spa_t *spa)
 513 {
 514         ddt_stat_t dds_total = { 0 };
 515
 516         ddt_get_dedup_stats(spa, &dds_total);
 517         return (dds_total.dds_ref_dsize - dds_total.dds_dsize);
 518 }
 519
 520 uint64_t
 521 ddt_get_pool_dedup_ratio(spa_t *spa)
 522 {
 523         ddt_stat_t dds_total = { 0 };
 524
 525         ddt_get_dedup_stats(spa, &dds_total);
 526         if (dds_total.dds_dsize == 0)
 527                 return (100);
 528
 529         return (dds_total.dds_ref_dsize * 100 / dds_total.dds_dsize);
 530 }
 531
 532 int
 533 ddt_ditto_copies_needed(ddt_t *ddt, ddt_entry_t *dde, ddt_phys_t *ddp_willref)
 534 {
 535         spa_t *spa = ddt->ddt_spa;
 536         uint64_t total_refcnt = 0;
 537         uint64_t ditto = spa->spa_dedup_ditto;
 538         int total_copies = 0;
 539         int desired_copies = 0;
 540         int p;
 541
 542         for (p = DDT_PHYS_SINGLE; p <= DDT_PHYS_TRIPLE; p++) {
 543                 ddt_phys_t *ddp = &dde->dde_phys[p];
 544                 zio_t *zio = dde->dde_lead_zio[p];
 545                 uint64_t refcnt = ddp->ddp_refcnt;      /* committed refs */
 546                 if (zio != NULL)
 547                         refcnt += zio->io_parent_count; /* pending refs */
 548                 if (ddp == ddp_willref)
 549                         refcnt++;                       /* caller's ref */
 550                 if (refcnt != 0) {
 551                         total_refcnt += refcnt;
 552                         total_copies += p;
 553                 }
 554         }
 555
 556         if (ditto == 0 || ditto > UINT32_MAX)
 557                 ditto = UINT32_MAX;
 558
 559         if (total_refcnt >= 1)
 560                 desired_copies++;
 561         if (total_refcnt >= ditto)
 562                 desired_copies++;
 563         if (total_refcnt >= ditto * ditto)
 564                 desired_copies++;
 565
 566         return (MAX(desired_copies, total_copies) - total_copies);
 567 }
 568
 569 int
 570 ddt_ditto_copies_present(ddt_entry_t *dde)
 571 {
 572         ddt_phys_t *ddp = &dde->dde_phys[DDT_PHYS_DITTO];
 573         dva_t *dva = ddp->ddp_dva;
 574         int copies = 0 - DVA_GET_GANG(dva);
 575         int d;
 576
 577         for (d = 0; d < SPA_DVAS_PER_BP; d++, dva++)
 578                 if (DVA_IS_VALID(dva))
 579                         copies++;
 580
 581         ASSERT(copies >= 0 && copies < SPA_DVAS_PER_BP);
 582
 583         return (copies);
 584 }
 585
 586 size_t
 587 ddt_compress(void *src, uchar_t *dst, size_t s_len, size_t d_len)
 588 {
 589         uchar_t *version = dst++;
 590         int cpfunc = ZIO_COMPRESS_ZLE;
 591         zio_compress_info_t *ci = &zio_compress_table[cpfunc];
 592         size_t c_len;
 593
 594         ASSERT(d_len >= s_len + 1);     /* no compression plus version byte */
 595
 596         c_len = ci->ci_compress(src, dst, s_len, d_len - 1, ci->ci_level);
 597
 598         if (c_len == s_len) {
 599                 cpfunc = ZIO_COMPRESS_OFF;
 600                 bcopy(src, dst, s_len);
 601         }
 602
 603         *version = (ZFS_HOST_BYTEORDER & DDT_COMPRESS_BYTEORDER_MASK) | cpfunc;
 604
 605         return (c_len + 1);
 606 }
 607
 608 void
 609 ddt_decompress(uchar_t *src, void *dst, size_t s_len, size_t d_len)
 610 {
 611         uchar_t version = *src++;
 612         int cpfunc = version & DDT_COMPRESS_FUNCTION_MASK;
 613         zio_compress_info_t *ci = &zio_compress_table[cpfunc];
 614
 615         if (ci->ci_decompress != NULL)
 616                 (void) ci->ci_decompress(src, dst, s_len, d_len, ci->ci_level);
 617         else
 618                 bcopy(src, dst, d_len);
 619
 620         if ((version ^ ZFS_HOST_BYTEORDER) & DDT_COMPRESS_BYTEORDER_MASK)
 621                 byteswap_uint64_array(dst, d_len);
 622 }
 623
 624 ddt_t *
 625 ddt_select_by_checksum(spa_t *spa, enum zio_checksum c)
 626 {
 627         return (spa->spa_ddt[c]);
 628 }
 629
 630 ddt_t *
 631 ddt_select(spa_t *spa, const blkptr_t *bp)
 632 {
 633         return (spa->spa_ddt[BP_GET_CHECKSUM(bp)]);
 634 }
 635
 636 void
 637 ddt_enter(ddt_t *ddt)
 638 {
 639         mutex_enter(&ddt->ddt_lock);
 640 }
 641
 642 void
 643 ddt_exit(ddt_t *ddt)
 644 {
 645         mutex_exit(&ddt->ddt_lock);
 646 }
 647
 648 static ddt_entry_t *
 649 ddt_alloc(const ddt_key_t *ddk)
 650 {
 651         ddt_entry_t *dde;
 652
 653         /* XXX: Move to a slab */
 654         dde = kmem_zalloc(sizeof (ddt_entry_t), KM_SLEEP);
 655         cv_init(&dde->dde_cv, NULL, CV_DEFAULT, NULL);
 656
 657         dde->dde_key = *ddk;
 658
 659         return (dde);
 660 }
 661
 662 static void
 663 ddt_free(ddt_entry_t *dde)
 664 {
 665         int p;
 666
 667         ASSERT(!dde->dde_loading);
 668
 669         for (p = 0; p < DDT_PHYS_TYPES; p++)
 670                 ASSERT(dde->dde_lead_zio[p] == NULL);
 671
 672         if (dde->dde_repair_data != NULL)
 673                 zio_buf_free(dde->dde_repair_data,
 674                     DDK_GET_PSIZE(&dde->dde_key));
 675
 676         cv_destroy(&dde->dde_cv);
 677         kmem_free(dde, sizeof (*dde));
 678 }
 679
 680 void
 681 ddt_remove(ddt_t *ddt, ddt_entry_t *dde)
 682 {
 683         ASSERT(MUTEX_HELD(&ddt->ddt_lock));
 684
 685         avl_remove(&ddt->ddt_tree, dde);
 686         ddt_free(dde);
 687 }
 688
 689 ddt_entry_t *
 690 ddt_lookup(ddt_t *ddt, const blkptr_t *bp, boolean_t add)
 691 {
 692         ddt_entry_t *dde, dde_search;
 693         enum ddt_type type;
 694         enum ddt_class class;
 695         avl_index_t where;
 696         int error;
 697
 698         ASSERT(MUTEX_HELD(&ddt->ddt_lock));
 699
 700         ddt_key_fill(&dde_search.dde_key, bp);
 701
 702         dde = avl_find(&ddt->ddt_tree, &dde_search, &where);
 703         if (dde == NULL) {
 704                 if (!add)
 705                         return (NULL);
 706                 dde = ddt_alloc(&dde_search.dde_key);
 707                 avl_insert(&ddt->ddt_tree, dde, where);
 708         }
 709
 710         while (dde->dde_loading)
 711                 cv_wait(&dde->dde_cv, &ddt->ddt_lock);
 712
 713         if (dde->dde_loaded)
 714                 return (dde);
 715
 716         dde->dde_loading = B_TRUE;
 717
 718         ddt_exit(ddt);
 719
 720         error = ENOENT;
 721
 722         for (type = 0; type < DDT_TYPES; type++) {
 723                 for (class = 0; class < DDT_CLASSES; class++) {
 724                         error = ddt_object_lookup(ddt, type, class, dde);
 725                         if (error != ENOENT)
 726                                 break;
 727                 }
 728                 if (error != ENOENT)
 729                         break;
 730         }
 731
 732         ASSERT(error == 0 || error == ENOENT);
 733
 734         ddt_enter(ddt);
 735
 736         ASSERT(dde->dde_loaded == B_FALSE);
 737         ASSERT(dde->dde_loading == B_TRUE);
 738
 739         dde->dde_type = type;   /* will be DDT_TYPES if no entry found */
 740         dde->dde_class = class; /* will be DDT_CLASSES if no entry found */
 741         dde->dde_loaded = B_TRUE;
 742         dde->dde_loading = B_FALSE;
 743
 744         if (error == 0)
 745                 ddt_stat_update(ddt, dde, -1ULL);
 746
 747         cv_broadcast(&dde->dde_cv);
 748
 749         return (dde);
 750 }
 751
 752 void
 753 ddt_prefetch(spa_t *spa, const blkptr_t *bp)
 754 {
 755         ddt_t *ddt;
 756         ddt_entry_t dde;
 757         enum ddt_type type;
 758         enum ddt_class class;
 759
 760         if (!zfs_dedup_prefetch || bp == NULL || !BP_GET_DEDUP(bp))
 761                 return;
 762
 763         /*
 764          * We only remove the DDT once all tables are empty and only
 765          * prefetch dedup blocks when there are entries in the DDT.
 766          * Thus no locking is required as the DDT can't disappear on us.
 767          */
 768         ddt = ddt_select(spa, bp);
 769         ddt_key_fill(&dde.dde_key, bp);
 770
 771         for (type = 0; type < DDT_TYPES; type++) {
 772                 for (class = 0; class < DDT_CLASSES; class++) {
 773                         ddt_object_prefetch(ddt, type, class, &dde);
 774                 }
 775         }
 776 }
 777
 778 int
 779 ddt_entry_compare(const void *x1, const void *x2)
 780 {
 781         const ddt_entry_t *dde1 = x1;
 782         const ddt_entry_t *dde2 = x2;
 783         const uint64_t *u1 = (const uint64_t *)&dde1->dde_key;
 784         const uint64_t *u2 = (const uint64_t *)&dde2->dde_key;
 785         int i;
 786
 787         for (i = 0; i < DDT_KEY_WORDS; i++) {
 788                 if (u1[i] < u2[i])
 789                         return (-1);
 790                 if (u1[i] > u2[i])
 791                         return (1);
 792         }
 793
 794         return (0);
 795 }
 796
 797 static ddt_t *
 798 ddt_table_alloc(spa_t *spa, enum zio_checksum c)
 799 {
 800         ddt_t *ddt;
 801
 802         /* XXX: Move to a slab */
 803         ddt = kmem_zalloc(sizeof (*ddt), KM_SLEEP | KM_NODEBUG);
 804
 805         mutex_init(&ddt->ddt_lock, NULL, MUTEX_DEFAULT, NULL);
 806         avl_create(&ddt->ddt_tree, ddt_entry_compare,
 807             sizeof (ddt_entry_t), offsetof(ddt_entry_t, dde_node));
 808         avl_create(&ddt->ddt_repair_tree, ddt_entry_compare,
 809             sizeof (ddt_entry_t), offsetof(ddt_entry_t, dde_node));
 810         ddt->ddt_checksum = c;
 811         ddt->ddt_spa = spa;
 812         ddt->ddt_os = spa->spa_meta_objset;
 813
 814         return (ddt);
 815 }
 816
 817 static void
 818 ddt_table_free(ddt_t *ddt)
 819 {
 820         ASSERT(avl_numnodes(&ddt->ddt_tree) == 0);
 821         ASSERT(avl_numnodes(&ddt->ddt_repair_tree) == 0);
 822         avl_destroy(&ddt->ddt_tree);
 823         avl_destroy(&ddt->ddt_repair_tree);
 824         mutex_destroy(&ddt->ddt_lock);
 825         kmem_free(ddt, sizeof (*ddt));
 826 }
 827
 828 void
 829 ddt_create(spa_t *spa)
 830 {
 831         enum zio_checksum c;
 832
 833         spa->spa_dedup_checksum = ZIO_DEDUPCHECKSUM;
 834
 835         for (c = 0; c < ZIO_CHECKSUM_FUNCTIONS; c++)
 836                 spa->spa_ddt[c] = ddt_table_alloc(spa, c);
 837 }
 838
 839 int
 840 ddt_load(spa_t *spa)
 841 {
 842         enum zio_checksum c;
 843         enum ddt_type type;
 844         enum ddt_class class;
 845         int error;
 846
 847         ddt_create(spa);
 848
 849         error = zap_lookup(spa->spa_meta_objset, DMU_POOL_DIRECTORY_OBJECT,
 850             DMU_POOL_DDT_STATS, sizeof (uint64_t), 1,
 851             &spa->spa_ddt_stat_object);
 852
 853         if (error)
 854                 return (error == ENOENT ? 0 : error);
 855
 856         for (c = 0; c < ZIO_CHECKSUM_FUNCTIONS; c++) {
 857                 ddt_t *ddt = spa->spa_ddt[c];
 858                 for (type = 0; type < DDT_TYPES; type++) {
 859                         for (class = 0; class < DDT_CLASSES;
 860                             class++) {
 861                                 error = ddt_object_load(ddt, type, class);
 862                                 if (error != 0 && error != ENOENT)
 863                                         return (error);
 864                         }
 865                 }
 866
 867                 /*
 868                  * Seed the cached histograms.
 869                  */
 870                 bcopy(ddt->ddt_histogram, &ddt->ddt_histogram_cache,
 871                     sizeof (ddt->ddt_histogram));
 872         }
 873
 874         return (0);
 875 }
 876
 877 void
 878 ddt_unload(spa_t *spa)
 879 {
 880         enum zio_checksum c;
 881
 882         for (c = 0; c < ZIO_CHECKSUM_FUNCTIONS; c++) {
 883                 if (spa->spa_ddt[c]) {
 884                         ddt_table_free(spa->spa_ddt[c]);
 885                         spa->spa_ddt[c] = NULL;
 886                 }
 887         }
 888 }
 889
 890 boolean_t
 891 ddt_class_contains(spa_t *spa, enum ddt_class max_class, const blkptr_t *bp)
 892 {
 893         ddt_t *ddt;
 894         ddt_entry_t *dde;
 895         enum ddt_type type;
 896         enum ddt_class class;
 897
 898         if (!BP_GET_DEDUP(bp))
 899                 return (B_FALSE);
 900
 901         if (max_class == DDT_CLASS_UNIQUE)
 902                 return (B_TRUE);
 903
 904         ddt = spa->spa_ddt[BP_GET_CHECKSUM(bp)];
 905         dde = kmem_alloc(sizeof(ddt_entry_t), KM_SLEEP);
 906
 907         ddt_key_fill(&(dde->dde_key), bp);
 908
 909         for (type = 0; type < DDT_TYPES; type++) {
 910                 for (class = 0; class <= max_class; class++) {
 911                         if (ddt_object_lookup(ddt, type, class, dde) == 0) {
 912                                 kmem_free(dde, sizeof(ddt_entry_t));
 913                                 return (B_TRUE);
 914                         }
 915                 }
 916         }
 917
 918         kmem_free(dde, sizeof(ddt_entry_t));
 919         return (B_FALSE);
 920 }
 921
 922 ddt_entry_t *
 923 ddt_repair_start(ddt_t *ddt, const blkptr_t *bp)
 924 {
 925         ddt_key_t ddk;
 926         ddt_entry_t *dde;
 927         enum ddt_type type;
 928         enum ddt_class class;
 929
 930         ddt_key_fill(&ddk, bp);
 931
 932         dde = ddt_alloc(&ddk);
 933
 934         for (type = 0; type < DDT_TYPES; type++) {
 935                 for (class = 0; class < DDT_CLASSES; class++) {
 936                         /*
 937                          * We can only do repair if there are multiple copies
 938                          * of the block.  For anything in the UNIQUE class,
 939                          * there's definitely only one copy, so don't even try.
 940                          */
 941                         if (class != DDT_CLASS_UNIQUE &&
 942                             ddt_object_lookup(ddt, type, class, dde) == 0)
 943                                 return (dde);
 944                 }
 945         }
 946
 947         bzero(dde->dde_phys, sizeof (dde->dde_phys));
 948
 949         return (dde);
 950 }
 951
 952 void
 953 ddt_repair_done(ddt_t *ddt, ddt_entry_t *dde)
 954 {
 955         avl_index_t where;
 956
 957         ddt_enter(ddt);
 958
 959         if (dde->dde_repair_data != NULL && spa_writeable(ddt->ddt_spa) &&
 960             avl_find(&ddt->ddt_repair_tree, dde, &where) == NULL)
 961                 avl_insert(&ddt->ddt_repair_tree, dde, where);
 962         else
 963                 ddt_free(dde);
 964
 965         ddt_exit(ddt);
 966 }
 967
 968 static void
 969 ddt_repair_entry_done(zio_t *zio)
 970 {
 971         ddt_entry_t *rdde = zio->io_private;
 972
 973         ddt_free(rdde);
 974 }
 975
 976 static void
 977 ddt_repair_entry(ddt_t *ddt, ddt_entry_t *dde, ddt_entry_t *rdde, zio_t *rio)
 978 {
 979         ddt_phys_t *ddp = dde->dde_phys;
 980         ddt_phys_t *rddp = rdde->dde_phys;
 981         ddt_key_t *ddk = &dde->dde_key;
 982         ddt_key_t *rddk = &rdde->dde_key;
 983         zio_t *zio;
 984         blkptr_t blk;
 985         int p;
 986
 987         zio = zio_null(rio, rio->io_spa, NULL,
 988             ddt_repair_entry_done, rdde, rio->io_flags);
 989
 990         for (p = 0; p < DDT_PHYS_TYPES; p++, ddp++, rddp++) {
 991                 if (ddp->ddp_phys_birth == 0 ||
 992                     ddp->ddp_phys_birth != rddp->ddp_phys_birth ||
 993                     bcmp(ddp->ddp_dva, rddp->ddp_dva, sizeof (ddp->ddp_dva)))
 994                         continue;
 995                 ddt_bp_create(ddt->ddt_checksum, ddk, ddp, &blk);
 996                 zio_nowait(zio_rewrite(zio, zio->io_spa, 0, &blk,
 997                     rdde->dde_repair_data, DDK_GET_PSIZE(rddk), NULL, NULL,
 998                     ZIO_PRIORITY_SYNC_WRITE, ZIO_DDT_CHILD_FLAGS(zio), NULL));
 999         }
1000
1001         zio_nowait(zio);
1002 }
1003
1004 static void
1005 ddt_repair_table(ddt_t *ddt, zio_t *rio)
1006 {
1007         spa_t *spa = ddt->ddt_spa;
1008         ddt_entry_t *dde, *rdde_next, *rdde;
1009         avl_tree_t *t = &ddt->ddt_repair_tree;
1010         blkptr_t blk;
1011
1012         if (spa_sync_pass(spa) > 1)
1013                 return;
1014
1015         ddt_enter(ddt);
1016         for (rdde = avl_first(t); rdde != NULL; rdde = rdde_next) {
1017                 rdde_next = AVL_NEXT(t, rdde);
1018                 avl_remove(&ddt->ddt_repair_tree, rdde);
1019                 ddt_exit(ddt);
1020                 ddt_bp_create(ddt->ddt_checksum, &rdde->dde_key, NULL, &blk);
1021                 dde = ddt_repair_start(ddt, &blk);
1022                 ddt_repair_entry(ddt, dde, rdde, rio);
1023                 ddt_repair_done(ddt, dde);
1024                 ddt_enter(ddt);
1025         }
1026         ddt_exit(ddt);
1027 }
1028
1029 static void
1030 ddt_sync_entry(ddt_t *ddt, ddt_entry_t *dde, dmu_tx_t *tx, uint64_t txg)
1031 {
1032         dsl_pool_t *dp = ddt->ddt_spa->spa_dsl_pool;
1033         ddt_phys_t *ddp = dde->dde_phys;
1034         ddt_key_t *ddk = &dde->dde_key;
1035         enum ddt_type otype = dde->dde_type;
1036         enum ddt_type ntype = DDT_TYPE_CURRENT;
1037         enum ddt_class oclass = dde->dde_class;
1038         enum ddt_class nclass;
1039         uint64_t total_refcnt = 0;
1040         int p;
1041
1042         ASSERT(dde->dde_loaded);
1043         ASSERT(!dde->dde_loading);
1044
1045         for (p = 0; p < DDT_PHYS_TYPES; p++, ddp++) {
1046                 ASSERT(dde->dde_lead_zio[p] == NULL);
1047                 ASSERT((int64_t)ddp->ddp_refcnt >= 0);
1048                 if (ddp->ddp_phys_birth == 0) {
1049                         ASSERT(ddp->ddp_refcnt == 0);
1050                         continue;
1051                 }
1052                 if (p == DDT_PHYS_DITTO) {
1053                         if (ddt_ditto_copies_needed(ddt, dde, NULL) == 0)
1054                                 ddt_phys_free(ddt, ddk, ddp, txg);
1055                         continue;
1056                 }
1057                 if (ddp->ddp_refcnt == 0)
1058                         ddt_phys_free(ddt, ddk, ddp, txg);
1059                 total_refcnt += ddp->ddp_refcnt;
1060         }
1061
1062         if (dde->dde_phys[DDT_PHYS_DITTO].ddp_phys_birth != 0)
1063                 nclass = DDT_CLASS_DITTO;
1064         else if (total_refcnt > 1)
1065                 nclass = DDT_CLASS_DUPLICATE;
1066         else
1067                 nclass = DDT_CLASS_UNIQUE;
1068
1069         if (otype != DDT_TYPES &&
1070             (otype != ntype || oclass != nclass || total_refcnt == 0)) {
1071                 VERIFY(ddt_object_remove(ddt, otype, oclass, dde, tx) == 0);
1072                 ASSERT(ddt_object_lookup(ddt, otype, oclass, dde) == ENOENT);
1073         }
1074
1075         if (total_refcnt != 0) {
1076                 dde->dde_type = ntype;
1077                 dde->dde_class = nclass;
1078                 ddt_stat_update(ddt, dde, 0);
1079                 if (!ddt_object_exists(ddt, ntype, nclass))
1080                         ddt_object_create(ddt, ntype, nclass, tx);
1081                 VERIFY(ddt_object_update(ddt, ntype, nclass, dde, tx) == 0);
1082
1083                 /*
1084                  * If the class changes, the order that we scan this bp
1085                  * changes.  If it decreases, we could miss it, so
1086                  * scan it right now.  (This covers both class changing
1087                  * while we are doing ddt_walk(), and when we are
1088                  * traversing.)
1089                  */
1090                 if (nclass < oclass) {
1091                         dsl_scan_ddt_entry(dp->dp_scan,
1092                             ddt->ddt_checksum, dde, tx);
1093                 }
1094         }
1095 }
1096
1097 static void
1098 ddt_sync_table(ddt_t *ddt, dmu_tx_t *tx, uint64_t txg)
1099 {
1100         spa_t *spa = ddt->ddt_spa;
1101         ddt_entry_t *dde;
1102         void *cookie = NULL;
1103         enum ddt_type type;
1104         enum ddt_class class;
1105
1106         if (avl_numnodes(&ddt->ddt_tree) == 0)
1107                 return;
1108
1109         ASSERT(spa->spa_uberblock.ub_version >= SPA_VERSION_DEDUP);
1110
1111         if (spa->spa_ddt_stat_object == 0) {
1112                 spa->spa_ddt_stat_object = zap_create(ddt->ddt_os,
1113                     DMU_OT_DDT_STATS, DMU_OT_NONE, 0, tx);
1114                 VERIFY(zap_add(ddt->ddt_os, DMU_POOL_DIRECTORY_OBJECT,
1115                     DMU_POOL_DDT_STATS, sizeof (uint64_t), 1,
1116                     &spa->spa_ddt_stat_object, tx) == 0);
1117         }
1118
1119         while ((dde = avl_destroy_nodes(&ddt->ddt_tree, &cookie)) != NULL) {
1120                 ddt_sync_entry(ddt, dde, tx, txg);
1121                 ddt_free(dde);
1122         }
1123
1124         for (type = 0; type < DDT_TYPES; type++) {
1125                 uint64_t count = 0;
1126                 for (class = 0; class < DDT_CLASSES; class++) {
1127                         if (ddt_object_exists(ddt, type, class)) {
1128                                 ddt_object_sync(ddt, type, class, tx);
1129                                 count += ddt_object_count(ddt, type, class);
1130                         }
1131                 }
1132                 for (class = 0; class < DDT_CLASSES; class++) {
1133                         if (count == 0 && ddt_object_exists(ddt, type, class))
1134                                 ddt_object_destroy(ddt, type, class, tx);
1135                 }
1136         }
1137
1138         bcopy(ddt->ddt_histogram, &ddt->ddt_histogram_cache,
1139             sizeof (ddt->ddt_histogram));
1140 }
1141
1142 void
1143 ddt_sync(spa_t *spa, uint64_t txg)
1144 {
1145         dmu_tx_t *tx;
1146         zio_t *rio = zio_root(spa, NULL, NULL,
1147             ZIO_FLAG_CANFAIL | ZIO_FLAG_SPECULATIVE);
1148         enum zio_checksum c;
1149
1150         ASSERT(spa_syncing_txg(spa) == txg);
1151
1152         tx = dmu_tx_create_assigned(spa->spa_dsl_pool, txg);
1153
1154         for (c = 0; c < ZIO_CHECKSUM_FUNCTIONS; c++) {
1155                 ddt_t *ddt = spa->spa_ddt[c];
1156                 if (ddt == NULL)
1157                         continue;
1158                 ddt_sync_table(ddt, tx, txg);
1159                 ddt_repair_table(ddt, rio);
1160         }
1161
1162         (void) zio_wait(rio);
1163
1164         dmu_tx_commit(tx);
1165 }
1166
1167 int
1168 ddt_walk(spa_t *spa, ddt_bookmark_t *ddb, ddt_entry_t *dde)
1169 {
1170         do {
1171                 do {
1172                         do {
1173                                 ddt_t *ddt = spa->spa_ddt[ddb->ddb_checksum];
1174                                 int error = ENOENT;
1175                                 if (ddt_object_exists(ddt, ddb->ddb_type,
1176                                     ddb->ddb_class)) {
1177                                         error = ddt_object_walk(ddt,
1178                                             ddb->ddb_type, ddb->ddb_class,
1179                                             &ddb->ddb_cursor, dde);
1180                                 }
1181                                 dde->dde_type = ddb->ddb_type;
1182                                 dde->dde_class = ddb->ddb_class;
1183                                 if (error == 0)
1184                                         return (0);
1185                                 if (error != ENOENT)
1186                                         return (error);
1187                                 ddb->ddb_cursor = 0;
1188                         } while (++ddb->ddb_checksum < ZIO_CHECKSUM_FUNCTIONS);
1189                         ddb->ddb_checksum = 0;
1190                 } while (++ddb->ddb_type < DDT_TYPES);
1191                 ddb->ddb_type = 0;
1192         } while (++ddb->ddb_class < DDT_CLASSES);
1193
1194         return (ENOENT);
1195 }
1196
1197 #if defined(_KERNEL) && defined(HAVE_SPL)
1198 module_param(zfs_dedup_prefetch, int, 0644);
1199 MODULE_PARM_DESC(zfs_dedup_prefetch,"Enable prefetching dedup-ed blks");
1200 #endif