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