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