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