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