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 * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2016 by Delphix. All rights reserved. 24 */ 25 26 #ifndef _SYS_DDT_H 27 #define _SYS_DDT_H 28 29 #include <sys/sysmacros.h> 30 #include <sys/types.h> 31 #include <sys/fs/zfs.h> 32 #include <sys/zio.h> 33 #include <sys/dmu.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 struct abd; 40 41 /* 42 * On-disk DDT formats, in the desired search order (newest version first). 43 */ 44 enum ddt_type { 45 DDT_TYPE_ZAP = 0, 46 DDT_TYPES 47 }; 48 49 /* 50 * DDT classes, in the desired search order (highest replication level first). 51 */ 52 enum ddt_class { 53 DDT_CLASS_DITTO = 0, 54 DDT_CLASS_DUPLICATE, 55 DDT_CLASS_UNIQUE, 56 DDT_CLASSES 57 }; 58 59 #define DDT_TYPE_CURRENT 0 60 61 #define DDT_COMPRESS_BYTEORDER_MASK 0x80 62 #define DDT_COMPRESS_FUNCTION_MASK 0x7f 63 64 /* 65 * On-disk ddt entry: key (name) and physical storage (value). 66 */ 67 typedef struct ddt_key { 68 zio_cksum_t ddk_cksum; /* 256-bit block checksum */ 69 /* 70 * Encoded with logical & physical size, and compression, as follows: 71 * +-------+-------+-------+-------+-------+-------+-------+-------+ 72 * | 0 | 0 | 0 | comp | PSIZE | LSIZE | 73 * +-------+-------+-------+-------+-------+-------+-------+-------+ 74 */ 75 uint64_t ddk_prop; 76 } ddt_key_t; 77 78 #define DDK_GET_LSIZE(ddk) \ 79 BF64_GET_SB((ddk)->ddk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1) 80 #define DDK_SET_LSIZE(ddk, x) \ 81 BF64_SET_SB((ddk)->ddk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1, x) 82 83 #define DDK_GET_PSIZE(ddk) \ 84 BF64_GET_SB((ddk)->ddk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1) 85 #define DDK_SET_PSIZE(ddk, x) \ 86 BF64_SET_SB((ddk)->ddk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1, x) 87 88 #define DDK_GET_COMPRESS(ddk) BF64_GET((ddk)->ddk_prop, 32, 8) 89 #define DDK_SET_COMPRESS(ddk, x) BF64_SET((ddk)->ddk_prop, 32, 8, x) 90 91 #define DDT_KEY_WORDS (sizeof (ddt_key_t) / sizeof (uint64_t)) 92 93 typedef struct ddt_phys { 94 dva_t ddp_dva[SPA_DVAS_PER_BP]; 95 uint64_t ddp_refcnt; 96 uint64_t ddp_phys_birth; 97 } ddt_phys_t; 98 99 enum ddt_phys_type { 100 DDT_PHYS_DITTO = 0, 101 DDT_PHYS_SINGLE = 1, 102 DDT_PHYS_DOUBLE = 2, 103 DDT_PHYS_TRIPLE = 3, 104 DDT_PHYS_TYPES 105 }; 106 107 /* 108 * In-core ddt entry 109 */ 110 struct ddt_entry { 111 ddt_key_t dde_key; 112 ddt_phys_t dde_phys[DDT_PHYS_TYPES]; 113 zio_t *dde_lead_zio[DDT_PHYS_TYPES]; 114 struct abd *dde_repair_abd; 115 enum ddt_type dde_type; 116 enum ddt_class dde_class; 117 uint8_t dde_loading; 118 uint8_t dde_loaded; 119 kcondvar_t dde_cv; 120 avl_node_t dde_node; 121 }; 122 123 /* 124 * In-core ddt 125 */ 126 struct ddt { 127 kmutex_t ddt_lock; 128 avl_tree_t ddt_tree; 129 avl_tree_t ddt_repair_tree; 130 enum zio_checksum ddt_checksum; 131 spa_t *ddt_spa; 132 objset_t *ddt_os; 133 uint64_t ddt_stat_object; 134 uint64_t ddt_object[DDT_TYPES][DDT_CLASSES]; 135 ddt_histogram_t ddt_histogram[DDT_TYPES][DDT_CLASSES]; 136 ddt_histogram_t ddt_histogram_cache[DDT_TYPES][DDT_CLASSES]; 137 ddt_object_t ddt_object_stats[DDT_TYPES][DDT_CLASSES]; 138 avl_node_t ddt_node; 139 }; 140 141 /* 142 * In-core and on-disk bookmark for DDT walks 143 */ 144 typedef struct ddt_bookmark { 145 uint64_t ddb_class; 146 uint64_t ddb_type; 147 uint64_t ddb_checksum; 148 uint64_t ddb_cursor; 149 } ddt_bookmark_t; 150 151 /* 152 * Ops vector to access a specific DDT object type. 153 */ 154 typedef struct ddt_ops { 155 char ddt_op_name[32]; 156 int (*ddt_op_create)(objset_t *os, uint64_t *object, dmu_tx_t *tx, 157 boolean_t prehash); 158 int (*ddt_op_destroy)(objset_t *os, uint64_t object, dmu_tx_t *tx); 159 int (*ddt_op_lookup)(objset_t *os, uint64_t object, ddt_entry_t *dde); 160 void (*ddt_op_prefetch)(objset_t *os, uint64_t object, 161 ddt_entry_t *dde); 162 int (*ddt_op_update)(objset_t *os, uint64_t object, ddt_entry_t *dde, 163 dmu_tx_t *tx); 164 int (*ddt_op_remove)(objset_t *os, uint64_t object, ddt_entry_t *dde, 165 dmu_tx_t *tx); 166 int (*ddt_op_walk)(objset_t *os, uint64_t object, ddt_entry_t *dde, 167 uint64_t *walk); 168 uint64_t (*ddt_op_count)(objset_t *os, uint64_t object); 169 } ddt_ops_t; 170 171 #define DDT_NAMELEN 80 172 173 extern void ddt_object_name(ddt_t *ddt, enum ddt_type type, 174 enum ddt_class class, char *name); 175 extern int ddt_object_walk(ddt_t *ddt, enum ddt_type type, 176 enum ddt_class class, uint64_t *walk, ddt_entry_t *dde); 177 extern uint64_t ddt_object_count(ddt_t *ddt, enum ddt_type type, 178 enum ddt_class class); 179 extern int ddt_object_info(ddt_t *ddt, enum ddt_type type, 180 enum ddt_class class, dmu_object_info_t *); 181 extern boolean_t ddt_object_exists(ddt_t *ddt, enum ddt_type type, 182 enum ddt_class class); 183 184 extern void ddt_bp_fill(const ddt_phys_t *ddp, blkptr_t *bp, 185 uint64_t txg); 186 extern void ddt_bp_create(enum zio_checksum checksum, const ddt_key_t *ddk, 187 const ddt_phys_t *ddp, blkptr_t *bp); 188 189 extern void ddt_key_fill(ddt_key_t *ddk, const blkptr_t *bp); 190 191 extern void ddt_phys_fill(ddt_phys_t *ddp, const blkptr_t *bp); 192 extern void ddt_phys_clear(ddt_phys_t *ddp); 193 extern void ddt_phys_addref(ddt_phys_t *ddp); 194 extern void ddt_phys_decref(ddt_phys_t *ddp); 195 extern void ddt_phys_free(ddt_t *ddt, ddt_key_t *ddk, ddt_phys_t *ddp, 196 uint64_t txg); 197 extern ddt_phys_t *ddt_phys_select(const ddt_entry_t *dde, const blkptr_t *bp); 198 extern uint64_t ddt_phys_total_refcnt(const ddt_entry_t *dde); 199 200 extern void ddt_stat_add(ddt_stat_t *dst, const ddt_stat_t *src, uint64_t neg); 201 202 extern void ddt_histogram_add(ddt_histogram_t *dst, const ddt_histogram_t *src); 203 extern void ddt_histogram_stat(ddt_stat_t *dds, const ddt_histogram_t *ddh); 204 extern boolean_t ddt_histogram_empty(const ddt_histogram_t *ddh); 205 extern void ddt_get_dedup_object_stats(spa_t *spa, ddt_object_t *ddo); 206 extern void ddt_get_dedup_histogram(spa_t *spa, ddt_histogram_t *ddh); 207 extern void ddt_get_dedup_stats(spa_t *spa, ddt_stat_t *dds_total); 208 209 extern uint64_t ddt_get_dedup_dspace(spa_t *spa); 210 extern uint64_t ddt_get_pool_dedup_ratio(spa_t *spa); 211 212 extern int ddt_ditto_copies_needed(ddt_t *ddt, ddt_entry_t *dde, 213 ddt_phys_t *ddp_willref); 214 extern int ddt_ditto_copies_present(ddt_entry_t *dde); 215 216 extern size_t ddt_compress(void *src, uchar_t *dst, size_t s_len, size_t d_len); 217 extern void ddt_decompress(uchar_t *src, void *dst, size_t s_len, size_t d_len); 218 219 extern ddt_t *ddt_select(spa_t *spa, const blkptr_t *bp); 220 extern void ddt_enter(ddt_t *ddt); 221 extern void ddt_exit(ddt_t *ddt); 222 extern ddt_entry_t *ddt_lookup(ddt_t *ddt, const blkptr_t *bp, boolean_t add); 223 extern void ddt_prefetch(spa_t *spa, const blkptr_t *bp); 224 extern void ddt_remove(ddt_t *ddt, ddt_entry_t *dde); 225 226 extern boolean_t ddt_class_contains(spa_t *spa, enum ddt_class max_class, 227 const blkptr_t *bp); 228 229 extern ddt_entry_t *ddt_repair_start(ddt_t *ddt, const blkptr_t *bp); 230 extern void ddt_repair_done(ddt_t *ddt, ddt_entry_t *dde); 231 232 extern int ddt_entry_compare(const void *x1, const void *x2); 233 234 extern void ddt_create(spa_t *spa); 235 extern int ddt_load(spa_t *spa); 236 extern void ddt_unload(spa_t *spa); 237 extern void ddt_sync(spa_t *spa, uint64_t txg); 238 extern int ddt_walk(spa_t *spa, ddt_bookmark_t *ddb, ddt_entry_t *dde); 239 extern int ddt_object_update(ddt_t *ddt, enum ddt_type type, 240 enum ddt_class class, ddt_entry_t *dde, dmu_tx_t *tx); 241 242 extern const ddt_ops_t ddt_zap_ops; 243 244 #ifdef __cplusplus 245 } 246 #endif 247 248 #endif /* _SYS_DDT_H */ 249