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