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) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright (c) 2013, 2016 by Delphix. All rights reserved. 25 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. 26 * Copyright (c) 2014 Integros [integros.com] 27 * Copyright 2017 Nexenta Systems, Inc. 28 */ 29 30 #ifndef _SYS_ZAP_IMPL_H 31 #define _SYS_ZAP_IMPL_H 32 33 #include <sys/zap.h> 34 #include <sys/zfs_context.h> 35 #include <sys/avl.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 extern int fzap_default_block_shift; 42 43 #define ZAP_MAGIC 0x2F52AB2ABULL 44 45 #define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_f.zap_block_shift) 46 47 #define MZAP_ENT_LEN 64 48 #define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2) 49 #define MZAP_MAX_BLKSZ SPA_OLD_MAXBLOCKSIZE 50 51 #define ZAP_NEED_CD (-1U) 52 53 typedef struct mzap_ent_phys { 54 uint64_t mze_value; 55 uint32_t mze_cd; 56 uint16_t mze_pad; /* in case we want to chain them someday */ 57 char mze_name[MZAP_NAME_LEN]; 58 } mzap_ent_phys_t; 59 60 typedef struct mzap_phys { 61 uint64_t mz_block_type; /* ZBT_MICRO */ 62 uint64_t mz_salt; 63 uint64_t mz_normflags; 64 uint64_t mz_pad[5]; 65 mzap_ent_phys_t mz_chunk[1]; 66 /* actually variable size depending on block size */ 67 } mzap_phys_t; 68 69 typedef struct mzap_ent { 70 avl_node_t mze_node; 71 int mze_chunkid; 72 uint64_t mze_hash; 73 uint32_t mze_cd; /* copy from mze_phys->mze_cd */ 74 } mzap_ent_t; 75 76 #define MZE_PHYS(zap, mze) \ 77 (&zap_m_phys(zap)->mz_chunk[(mze)->mze_chunkid]) 78 79 /* 80 * The (fat) zap is stored in one object. It is an array of 81 * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of: 82 * 83 * ptrtbl fits in first block: 84 * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ... 85 * 86 * ptrtbl too big for first block: 87 * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ... 88 * 89 */ 90 91 struct dmu_buf; 92 struct zap_leaf; 93 94 #define ZBT_LEAF ((1ULL << 63) + 0) 95 #define ZBT_HEADER ((1ULL << 63) + 1) 96 #define ZBT_MICRO ((1ULL << 63) + 3) 97 /* any other values are ptrtbl blocks */ 98 99 /* 100 * the embedded pointer table takes up half a block: 101 * block size / entry size (2^3) / 2 102 */ 103 #define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1) 104 105 /* 106 * The embedded pointer table starts half-way through the block. Since 107 * the pointer table itself is half the block, it starts at (64-bit) 108 * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)). 109 */ 110 #define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \ 111 ((uint64_t *)zap_f_phys(zap)) \ 112 [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))] 113 114 /* 115 * TAKE NOTE: 116 * If zap_phys_t is modified, zap_byteswap() must be modified. 117 */ 118 typedef struct zap_phys { 119 uint64_t zap_block_type; /* ZBT_HEADER */ 120 uint64_t zap_magic; /* ZAP_MAGIC */ 121 122 struct zap_table_phys { 123 uint64_t zt_blk; /* starting block number */ 124 uint64_t zt_numblks; /* number of blocks */ 125 uint64_t zt_shift; /* bits to index it */ 126 uint64_t zt_nextblk; /* next (larger) copy start block */ 127 uint64_t zt_blks_copied; /* number source blocks copied */ 128 } zap_ptrtbl; 129 130 uint64_t zap_freeblk; /* the next free block */ 131 uint64_t zap_num_leafs; /* number of leafs */ 132 uint64_t zap_num_entries; /* number of entries */ 133 uint64_t zap_salt; /* salt to stir into hash function */ 134 uint64_t zap_normflags; /* flags for u8_textprep_str() */ 135 uint64_t zap_flags; /* zap_flags_t */ 136 /* 137 * This structure is followed by padding, and then the embedded 138 * pointer table. The embedded pointer table takes up second 139 * half of the block. It is accessed using the 140 * ZAP_EMBEDDED_PTRTBL_ENT() macro. 141 */ 142 } zap_phys_t; 143 144 typedef struct zap_table_phys zap_table_phys_t; 145 146 typedef struct zap { 147 dmu_buf_user_t zap_dbu; 148 objset_t *zap_objset; 149 uint64_t zap_object; 150 struct dmu_buf *zap_dbuf; 151 krwlock_t zap_rwlock; 152 boolean_t zap_ismicro; 153 int zap_normflags; 154 uint64_t zap_salt; 155 union { 156 struct { 157 /* 158 * zap_num_entries_mtx protects 159 * zap_num_entries 160 */ 161 kmutex_t zap_num_entries_mtx; 162 int zap_block_shift; 163 } zap_fat; 164 struct { 165 int16_t zap_num_entries; 166 int16_t zap_num_chunks; 167 int16_t zap_alloc_next; 168 avl_tree_t zap_avl; 169 } zap_micro; 170 } zap_u; 171 } zap_t; 172 173 inline zap_phys_t * 174 zap_f_phys(zap_t *zap) 175 { 176 return (zap->zap_dbuf->db_data); 177 } 178 179 inline mzap_phys_t * 180 zap_m_phys(zap_t *zap) 181 { 182 return (zap->zap_dbuf->db_data); 183 } 184 185 typedef struct zap_name { 186 zap_t *zn_zap; 187 int zn_key_intlen; 188 const void *zn_key_orig; 189 int zn_key_orig_numints; 190 const void *zn_key_norm; 191 int zn_key_norm_numints; 192 uint64_t zn_hash; 193 matchtype_t zn_matchtype; 194 int zn_normflags; 195 char zn_normbuf[ZAP_MAXNAMELEN]; 196 } zap_name_t; 197 198 #define zap_f zap_u.zap_fat 199 #define zap_m zap_u.zap_micro 200 201 boolean_t zap_match(zap_name_t *zn, const char *matchname); 202 int zap_lockdir(objset_t *os, uint64_t obj, dmu_tx_t *tx, 203 krw_t lti, boolean_t fatreader, boolean_t adding, void *tag, zap_t **zapp); 204 void zap_unlockdir(zap_t *zap, void *tag); 205 void zap_evict_sync(void *dbu); 206 zap_name_t *zap_name_alloc(zap_t *zap, const char *key, matchtype_t mt); 207 void zap_name_free(zap_name_t *zn); 208 int zap_hashbits(zap_t *zap); 209 uint32_t zap_maxcd(zap_t *zap); 210 uint64_t zap_getflags(zap_t *zap); 211 212 #define ZAP_HASH_IDX(hash, n) (((n) == 0) ? 0 : ((hash) >> (64 - (n)))) 213 214 void fzap_byteswap(void *buf, size_t size); 215 int fzap_count(zap_t *zap, uint64_t *count); 216 int fzap_lookup(zap_name_t *zn, 217 uint64_t integer_size, uint64_t num_integers, void *buf, 218 char *realname, int rn_len, boolean_t *normalization_conflictp); 219 void fzap_prefetch(zap_name_t *zn); 220 int fzap_add(zap_name_t *zn, uint64_t integer_size, uint64_t num_integers, 221 const void *val, void *tag, dmu_tx_t *tx); 222 int fzap_update(zap_name_t *zn, 223 int integer_size, uint64_t num_integers, const void *val, 224 void *tag, dmu_tx_t *tx); 225 int fzap_length(zap_name_t *zn, 226 uint64_t *integer_size, uint64_t *num_integers); 227 int fzap_remove(zap_name_t *zn, dmu_tx_t *tx); 228 int fzap_cursor_retrieve(zap_t *zap, zap_cursor_t *zc, zap_attribute_t *za); 229 void fzap_get_stats(zap_t *zap, zap_stats_t *zs); 230 void zap_put_leaf(struct zap_leaf *l); 231 232 int fzap_add_cd(zap_name_t *zn, 233 uint64_t integer_size, uint64_t num_integers, 234 const void *val, uint32_t cd, void *tag, dmu_tx_t *tx); 235 void fzap_upgrade(zap_t *zap, dmu_tx_t *tx, zap_flags_t flags); 236 237 #ifdef __cplusplus 238 } 239 #endif 240 241 #endif /* _SYS_ZAP_IMPL_H */ 242