xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/ddt.h (revision 30f608a433ef7b19cb4981bba0a0f7ccd7c92d03)
1b24ab676SJeff Bonwick /*
2b24ab676SJeff Bonwick  * CDDL HEADER START
3b24ab676SJeff Bonwick  *
4b24ab676SJeff Bonwick  * The contents of this file are subject to the terms of the
5b24ab676SJeff Bonwick  * Common Development and Distribution License (the "License").
6b24ab676SJeff Bonwick  * You may not use this file except in compliance with the License.
7b24ab676SJeff Bonwick  *
8b24ab676SJeff Bonwick  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9b24ab676SJeff Bonwick  * or http://www.opensolaris.org/os/licensing.
10b24ab676SJeff Bonwick  * See the License for the specific language governing permissions
11b24ab676SJeff Bonwick  * and limitations under the License.
12b24ab676SJeff Bonwick  *
13b24ab676SJeff Bonwick  * When distributing Covered Code, include this CDDL HEADER in each
14b24ab676SJeff Bonwick  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15b24ab676SJeff Bonwick  * If applicable, add the following below this CDDL HEADER, with the
16b24ab676SJeff Bonwick  * fields enclosed by brackets "[]" replaced with your own identifying
17b24ab676SJeff Bonwick  * information: Portions Copyright [yyyy] [name of copyright owner]
18b24ab676SJeff Bonwick  *
19b24ab676SJeff Bonwick  * CDDL HEADER END
20b24ab676SJeff Bonwick  */
21b24ab676SJeff Bonwick /*
22*30f608a4SGeorge Wilson  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
23b24ab676SJeff Bonwick  * Use is subject to license terms.
24b24ab676SJeff Bonwick  */
25b24ab676SJeff Bonwick 
26b24ab676SJeff Bonwick #ifndef _SYS_DDT_H
27b24ab676SJeff Bonwick #define	_SYS_DDT_H
28b24ab676SJeff Bonwick 
29b24ab676SJeff Bonwick #include <sys/sysmacros.h>
30b24ab676SJeff Bonwick #include <sys/types.h>
31b24ab676SJeff Bonwick #include <sys/fs/zfs.h>
32b24ab676SJeff Bonwick #include <sys/zio.h>
33b24ab676SJeff Bonwick #include <sys/dmu.h>
34b24ab676SJeff Bonwick 
35b24ab676SJeff Bonwick #ifdef	__cplusplus
36b24ab676SJeff Bonwick extern "C" {
37b24ab676SJeff Bonwick #endif
38b24ab676SJeff Bonwick 
39b24ab676SJeff Bonwick /*
40b24ab676SJeff Bonwick  * On-disk DDT formats, in the desired search order (newest version first).
41b24ab676SJeff Bonwick  */
42b24ab676SJeff Bonwick enum ddt_type {
43b24ab676SJeff Bonwick 	DDT_TYPE_ZAP = 0,
44b24ab676SJeff Bonwick 	DDT_TYPES
45b24ab676SJeff Bonwick };
46b24ab676SJeff Bonwick 
47b24ab676SJeff Bonwick /*
48b24ab676SJeff Bonwick  * DDT classes, in the desired search order (highest replication level first).
49b24ab676SJeff Bonwick  */
50b24ab676SJeff Bonwick enum ddt_class {
51b24ab676SJeff Bonwick 	DDT_CLASS_DITTO = 0,
52b24ab676SJeff Bonwick 	DDT_CLASS_DUPLICATE,
53b24ab676SJeff Bonwick 	DDT_CLASS_UNIQUE,
54b24ab676SJeff Bonwick 	DDT_CLASSES
55b24ab676SJeff Bonwick };
56b24ab676SJeff Bonwick 
57b24ab676SJeff Bonwick #define	DDT_TYPE_CURRENT		0
58b24ab676SJeff Bonwick 
59b24ab676SJeff Bonwick #define	DDT_COMPRESS_BYTEORDER_MASK	0x80
60b24ab676SJeff Bonwick #define	DDT_COMPRESS_FUNCTION_MASK	0x7f
61b24ab676SJeff Bonwick 
62b24ab676SJeff Bonwick /*
63b24ab676SJeff Bonwick  * On-disk ddt entry:  key (name) and physical storage (value).
64b24ab676SJeff Bonwick  */
65b24ab676SJeff Bonwick typedef struct ddt_key {
66b24ab676SJeff Bonwick 	zio_cksum_t	ddk_cksum;	/* 256-bit block checksum */
67b24ab676SJeff Bonwick 	uint64_t	ddk_prop;	/* LSIZE, PSIZE, compression */
68b24ab676SJeff Bonwick } ddt_key_t;
69b24ab676SJeff Bonwick 
70b24ab676SJeff Bonwick /*
71b24ab676SJeff Bonwick  * ddk_prop layout:
72b24ab676SJeff Bonwick  *
73b24ab676SJeff Bonwick  *	+-------+-------+-------+-------+-------+-------+-------+-------+
74b24ab676SJeff Bonwick  *	|   0	|   0	|   0	| comp	|     PSIZE	|     LSIZE	|
75b24ab676SJeff Bonwick  *	+-------+-------+-------+-------+-------+-------+-------+-------+
76b24ab676SJeff Bonwick  */
77b24ab676SJeff Bonwick #define	DDK_GET_LSIZE(ddk)	\
78b24ab676SJeff Bonwick 	BF64_GET_SB((ddk)->ddk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1)
79b24ab676SJeff Bonwick #define	DDK_SET_LSIZE(ddk, x)	\
80b24ab676SJeff Bonwick 	BF64_SET_SB((ddk)->ddk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1, x)
81b24ab676SJeff Bonwick 
82b24ab676SJeff Bonwick #define	DDK_GET_PSIZE(ddk)	\
83b24ab676SJeff Bonwick 	BF64_GET_SB((ddk)->ddk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1)
84b24ab676SJeff Bonwick #define	DDK_SET_PSIZE(ddk, x)	\
85b24ab676SJeff Bonwick 	BF64_SET_SB((ddk)->ddk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1, x)
86b24ab676SJeff Bonwick 
87b24ab676SJeff Bonwick #define	DDK_GET_COMPRESS(ddk)		BF64_GET((ddk)->ddk_prop, 32, 8)
88b24ab676SJeff Bonwick #define	DDK_SET_COMPRESS(ddk, x)	BF64_SET((ddk)->ddk_prop, 32, 8, x)
89b24ab676SJeff Bonwick 
90b24ab676SJeff Bonwick #define	DDT_KEY_WORDS	(sizeof (ddt_key_t) / sizeof (uint64_t))
91b24ab676SJeff Bonwick 
92b24ab676SJeff Bonwick typedef struct ddt_phys {
93b24ab676SJeff Bonwick 	dva_t		ddp_dva[SPA_DVAS_PER_BP];
94b24ab676SJeff Bonwick 	uint64_t	ddp_refcnt;
95b24ab676SJeff Bonwick 	uint64_t	ddp_phys_birth;
96b24ab676SJeff Bonwick } ddt_phys_t;
97b24ab676SJeff Bonwick 
98b24ab676SJeff Bonwick enum ddt_phys_type {
99b24ab676SJeff Bonwick 	DDT_PHYS_DITTO = 0,
100b24ab676SJeff Bonwick 	DDT_PHYS_SINGLE = 1,
101b24ab676SJeff Bonwick 	DDT_PHYS_DOUBLE = 2,
102b24ab676SJeff Bonwick 	DDT_PHYS_TRIPLE = 3,
103b24ab676SJeff Bonwick 	DDT_PHYS_TYPES
104*30f608a4SGeorge Wilson };
105b24ab676SJeff Bonwick 
106b24ab676SJeff Bonwick /*
107b24ab676SJeff Bonwick  * In-core ddt entry
108b24ab676SJeff Bonwick  */
109b24ab676SJeff Bonwick struct ddt_entry {
110b24ab676SJeff Bonwick 	ddt_key_t	dde_key;
111b24ab676SJeff Bonwick 	ddt_phys_t	dde_phys[DDT_PHYS_TYPES];
112b24ab676SJeff Bonwick 	zio_t		*dde_lead_zio[DDT_PHYS_TYPES];
113b24ab676SJeff Bonwick 	void		*dde_repair_data;
114b24ab676SJeff Bonwick 	enum ddt_type	dde_type;
115b24ab676SJeff Bonwick 	enum ddt_class	dde_class;
116b24ab676SJeff Bonwick 	uint8_t		dde_loading;
117b24ab676SJeff Bonwick 	uint8_t		dde_loaded;
118b24ab676SJeff Bonwick 	kcondvar_t	dde_cv;
119b24ab676SJeff Bonwick 	avl_node_t	dde_node;
120b24ab676SJeff Bonwick };
121b24ab676SJeff Bonwick 
122b24ab676SJeff Bonwick /*
123b24ab676SJeff Bonwick  * In-core ddt
124b24ab676SJeff Bonwick  */
125b24ab676SJeff Bonwick struct ddt {
126b24ab676SJeff Bonwick 	kmutex_t	ddt_lock;
127b24ab676SJeff Bonwick 	avl_tree_t	ddt_tree;
128b24ab676SJeff Bonwick 	avl_tree_t	ddt_repair_tree;
129b24ab676SJeff Bonwick 	enum zio_checksum ddt_checksum;
130b24ab676SJeff Bonwick 	spa_t		*ddt_spa;
131b24ab676SJeff Bonwick 	objset_t	*ddt_os;
132b24ab676SJeff Bonwick 	uint64_t	ddt_stat_object;
133b24ab676SJeff Bonwick 	uint64_t	ddt_object[DDT_TYPES][DDT_CLASSES];
134b24ab676SJeff Bonwick 	ddt_histogram_t	ddt_histogram[DDT_TYPES][DDT_CLASSES];
135*30f608a4SGeorge Wilson 	ddt_histogram_t	ddt_histogram_cache[DDT_TYPES][DDT_CLASSES];
136*30f608a4SGeorge Wilson 	ddt_object_t	ddt_object_stats[DDT_TYPES][DDT_CLASSES];
137b24ab676SJeff Bonwick 	avl_node_t	ddt_node;
138b24ab676SJeff Bonwick };
139b24ab676SJeff Bonwick 
140bbfd46c4SJeff Bonwick /*
141bbfd46c4SJeff Bonwick  * In-core and on-disk bookmark for DDT walks
142bbfd46c4SJeff Bonwick  */
143bbfd46c4SJeff Bonwick typedef struct ddt_bookmark {
144bbfd46c4SJeff Bonwick 	uint64_t	ddb_class;
145bbfd46c4SJeff Bonwick 	uint64_t	ddb_type;
146bbfd46c4SJeff Bonwick 	uint64_t	ddb_checksum;
147bbfd46c4SJeff Bonwick 	uint64_t	ddb_cursor;
148bbfd46c4SJeff Bonwick } ddt_bookmark_t;
149bbfd46c4SJeff Bonwick 
150bbfd46c4SJeff Bonwick /*
151bbfd46c4SJeff Bonwick  * Ops vector to access a specific DDT object type.
152bbfd46c4SJeff Bonwick  */
153b24ab676SJeff Bonwick typedef struct ddt_ops {
154b24ab676SJeff Bonwick 	char ddt_op_name[32];
155b24ab676SJeff Bonwick 	int (*ddt_op_create)(objset_t *os, uint64_t *object, dmu_tx_t *tx,
156b24ab676SJeff Bonwick 	    boolean_t prehash);
157b24ab676SJeff Bonwick 	int (*ddt_op_destroy)(objset_t *os, uint64_t object, dmu_tx_t *tx);
158b24ab676SJeff Bonwick 	int (*ddt_op_lookup)(objset_t *os, uint64_t object, ddt_entry_t *dde);
159b24ab676SJeff Bonwick 	int (*ddt_op_update)(objset_t *os, uint64_t object, ddt_entry_t *dde,
160b24ab676SJeff Bonwick 	    dmu_tx_t *tx);
161b24ab676SJeff Bonwick 	int (*ddt_op_remove)(objset_t *os, uint64_t object, ddt_entry_t *dde,
162b24ab676SJeff Bonwick 	    dmu_tx_t *tx);
163b24ab676SJeff Bonwick 	int (*ddt_op_walk)(objset_t *os, uint64_t object, ddt_entry_t *dde,
164b24ab676SJeff Bonwick 	    uint64_t *walk);
165b24ab676SJeff Bonwick 	uint64_t (*ddt_op_count)(objset_t *os, uint64_t object);
166b24ab676SJeff Bonwick } ddt_ops_t;
167b24ab676SJeff Bonwick 
168b24ab676SJeff Bonwick #define	DDT_NAMELEN	80
169b24ab676SJeff Bonwick 
170b24ab676SJeff Bonwick extern void ddt_object_name(ddt_t *ddt, enum ddt_type type,
171b24ab676SJeff Bonwick     enum ddt_class class, char *name);
172b24ab676SJeff Bonwick extern int ddt_object_walk(ddt_t *ddt, enum ddt_type type,
173bbfd46c4SJeff Bonwick     enum ddt_class class, uint64_t *walk, ddt_entry_t *dde);
174b24ab676SJeff Bonwick extern uint64_t ddt_object_count(ddt_t *ddt, enum ddt_type type,
175b24ab676SJeff Bonwick     enum ddt_class class);
176b24ab676SJeff Bonwick extern int ddt_object_info(ddt_t *ddt, enum ddt_type type,
177b24ab676SJeff Bonwick     enum ddt_class class, dmu_object_info_t *);
178b24ab676SJeff Bonwick extern boolean_t ddt_object_exists(ddt_t *ddt, enum ddt_type type,
179b24ab676SJeff Bonwick     enum ddt_class class);
180b24ab676SJeff Bonwick 
181b24ab676SJeff Bonwick extern void ddt_bp_fill(const ddt_phys_t *ddp, blkptr_t *bp,
182b24ab676SJeff Bonwick     uint64_t txg);
183bbfd46c4SJeff Bonwick extern void ddt_bp_create(enum zio_checksum checksum, const ddt_key_t *ddk,
184b24ab676SJeff Bonwick     const ddt_phys_t *ddp, blkptr_t *bp);
185b24ab676SJeff Bonwick 
186b24ab676SJeff Bonwick extern void ddt_key_fill(ddt_key_t *ddk, const blkptr_t *bp);
187b24ab676SJeff Bonwick 
188b24ab676SJeff Bonwick extern void ddt_phys_fill(ddt_phys_t *ddp, const blkptr_t *bp);
189b24ab676SJeff Bonwick extern void ddt_phys_clear(ddt_phys_t *ddp);
190b24ab676SJeff Bonwick extern void ddt_phys_addref(ddt_phys_t *ddp);
191b24ab676SJeff Bonwick extern void ddt_phys_decref(ddt_phys_t *ddp);
192b24ab676SJeff Bonwick extern void ddt_phys_free(ddt_t *ddt, ddt_key_t *ddk, ddt_phys_t *ddp,
193b24ab676SJeff Bonwick     uint64_t txg);
194b24ab676SJeff Bonwick extern ddt_phys_t *ddt_phys_select(const ddt_entry_t *dde, const blkptr_t *bp);
195b24ab676SJeff Bonwick extern uint64_t ddt_phys_total_refcnt(const ddt_entry_t *dde);
196b24ab676SJeff Bonwick 
197b24ab676SJeff Bonwick extern void ddt_stat_add(ddt_stat_t *dst, const ddt_stat_t *src, uint64_t neg);
198b24ab676SJeff Bonwick 
199b24ab676SJeff Bonwick extern void ddt_histogram_add(ddt_histogram_t *dst, const ddt_histogram_t *src);
200b24ab676SJeff Bonwick extern void ddt_histogram_stat(ddt_stat_t *dds, const ddt_histogram_t *ddh);
201b24ab676SJeff Bonwick extern boolean_t ddt_histogram_empty(const ddt_histogram_t *ddh);
2029eb19f4dSGeorge Wilson extern void ddt_get_dedup_object_stats(spa_t *spa, ddt_object_t *ddo);
2039eb19f4dSGeorge Wilson extern void ddt_get_dedup_histogram(spa_t *spa, ddt_histogram_t *ddh);
2049eb19f4dSGeorge Wilson extern void ddt_get_dedup_stats(spa_t *spa, ddt_stat_t *dds_total);
205b24ab676SJeff Bonwick 
206485bbbf5SGeorge Wilson extern uint64_t ddt_get_dedup_dspace(spa_t *spa);
207b24ab676SJeff Bonwick extern uint64_t ddt_get_pool_dedup_ratio(spa_t *spa);
208b24ab676SJeff Bonwick 
209b24ab676SJeff Bonwick extern int ddt_ditto_copies_needed(ddt_t *ddt, ddt_entry_t *dde,
210b24ab676SJeff Bonwick     ddt_phys_t *ddp_willref);
211b24ab676SJeff Bonwick extern int ddt_ditto_copies_present(ddt_entry_t *dde);
212b24ab676SJeff Bonwick 
213b24ab676SJeff Bonwick extern size_t ddt_compress(void *src, uchar_t *dst, size_t s_len, size_t d_len);
214b24ab676SJeff Bonwick extern void ddt_decompress(uchar_t *src, void *dst, size_t s_len, size_t d_len);
215b24ab676SJeff Bonwick 
216b24ab676SJeff Bonwick extern ddt_t *ddt_select(spa_t *spa, const blkptr_t *bp);
217b24ab676SJeff Bonwick extern void ddt_enter(ddt_t *ddt);
218b24ab676SJeff Bonwick extern void ddt_exit(ddt_t *ddt);
219b24ab676SJeff Bonwick extern ddt_entry_t *ddt_lookup(ddt_t *ddt, const blkptr_t *bp, boolean_t add);
220b24ab676SJeff Bonwick extern void ddt_remove(ddt_t *ddt, ddt_entry_t *dde);
221b24ab676SJeff Bonwick 
222bbfd46c4SJeff Bonwick extern boolean_t ddt_class_contains(spa_t *spa, enum ddt_class max_class,
223bbfd46c4SJeff Bonwick     const blkptr_t *bp);
224bbfd46c4SJeff Bonwick 
225b24ab676SJeff Bonwick extern ddt_entry_t *ddt_repair_start(ddt_t *ddt, const blkptr_t *bp);
226b24ab676SJeff Bonwick extern void ddt_repair_done(ddt_t *ddt, ddt_entry_t *dde);
227b24ab676SJeff Bonwick 
228b24ab676SJeff Bonwick extern int ddt_entry_compare(const void *x1, const void *x2);
229b24ab676SJeff Bonwick 
230b24ab676SJeff Bonwick extern void ddt_create(spa_t *spa);
231b24ab676SJeff Bonwick extern int ddt_load(spa_t *spa);
232b24ab676SJeff Bonwick extern void ddt_unload(spa_t *spa);
233b24ab676SJeff Bonwick extern void ddt_sync(spa_t *spa, uint64_t txg);
234bbfd46c4SJeff Bonwick extern int ddt_walk(spa_t *spa, ddt_bookmark_t *ddb, ddt_entry_t *dde);
235b24ab676SJeff Bonwick 
236b24ab676SJeff Bonwick extern const ddt_ops_t ddt_zap_ops;
237b24ab676SJeff Bonwick 
238b24ab676SJeff Bonwick #ifdef	__cplusplus
239b24ab676SJeff Bonwick }
240b24ab676SJeff Bonwick #endif
241b24ab676SJeff Bonwick 
242b24ab676SJeff Bonwick #endif	/* _SYS_DDT_H */
243