1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5*f65e61c0Sahrens * Common Development and Distribution License (the "License"). 6*f65e61c0Sahrens * 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 /* 22*f65e61c0Sahrens * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 23fa9e4066Sahrens * Use is subject to license terms. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 26fa9e4066Sahrens #ifndef _SYS_ZAP_LEAF_H 27fa9e4066Sahrens #define _SYS_ZAP_LEAF_H 28fa9e4066Sahrens 29fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 30fa9e4066Sahrens 31fa9e4066Sahrens #ifdef __cplusplus 32fa9e4066Sahrens extern "C" { 33fa9e4066Sahrens #endif 34fa9e4066Sahrens 35fa9e4066Sahrens struct zap; 36fa9e4066Sahrens 37fa9e4066Sahrens #define ZAP_LEAF_MAGIC 0x2AB1EAF 38fa9e4066Sahrens 39fa9e4066Sahrens /* chunk size = 24 bytes */ 40*f65e61c0Sahrens #define ZAP_LEAF_CHUNKSIZE 24 41fa9e4066Sahrens 42*f65e61c0Sahrens /* 43*f65e61c0Sahrens * The amount of space available for chunks is: 44*f65e61c0Sahrens * block size (1<<l->l_bs) - hash entry size (2) * number of hash 45*f65e61c0Sahrens * entries - header space (2*chunksize) 46*f65e61c0Sahrens */ 47*f65e61c0Sahrens #define ZAP_LEAF_NUMCHUNKS(l) \ 48*f65e61c0Sahrens (((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \ 49*f65e61c0Sahrens ZAP_LEAF_CHUNKSIZE - 2) 50*f65e61c0Sahrens 51*f65e61c0Sahrens /* 52*f65e61c0Sahrens * The amount of space within the chunk available for the array is: 53*f65e61c0Sahrens * chunk size - space for type (1) - space for next pointer (2) 54*f65e61c0Sahrens */ 55*f65e61c0Sahrens #define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3) 56*f65e61c0Sahrens 57*f65e61c0Sahrens /* 58*f65e61c0Sahrens * The leaf hash table has block size / 2^5 (32) number of entries, 59*f65e61c0Sahrens * which should be more than enough for the maximum number of entries, 60*f65e61c0Sahrens * which is less than block size / CHUNKSIZE (24) / minimum number of 61*f65e61c0Sahrens * chunks per entry (3). 62*f65e61c0Sahrens */ 63*f65e61c0Sahrens #define ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5) 64*f65e61c0Sahrens #define ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l)) 65fa9e4066Sahrens 66*f65e61c0Sahrens /* 67*f65e61c0Sahrens * The chunks start immediately after the hash table. The end of the 68*f65e61c0Sahrens * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a 69*f65e61c0Sahrens * chunk_t. 70*f65e61c0Sahrens */ 71*f65e61c0Sahrens #define ZAP_LEAF_CHUNK(l, idx) \ 72*f65e61c0Sahrens ((zap_leaf_chunk_t *) \ 73*f65e61c0Sahrens ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx] 74*f65e61c0Sahrens #define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry) 75*f65e61c0Sahrens 76*f65e61c0Sahrens typedef enum zap_chunk_type { 77*f65e61c0Sahrens ZAP_CHUNK_FREE = 253, 78*f65e61c0Sahrens ZAP_CHUNK_ENTRY = 252, 79*f65e61c0Sahrens ZAP_CHUNK_ARRAY = 251, 80*f65e61c0Sahrens ZAP_CHUNK_TYPE_MAX = 250 81*f65e61c0Sahrens } zap_chunk_type_t; 82fa9e4066Sahrens 83fa9e4066Sahrens /* 84fa9e4066Sahrens * TAKE NOTE: 85fa9e4066Sahrens * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified. 86fa9e4066Sahrens */ 87fa9e4066Sahrens typedef struct zap_leaf_phys { 88fa9e4066Sahrens struct zap_leaf_header { 89fa9e4066Sahrens uint64_t lhr_block_type; /* ZBT_LEAF */ 90fa9e4066Sahrens uint64_t lhr_next; /* next block in leaf chain */ 91fa9e4066Sahrens uint64_t lhr_prefix; 92fa9e4066Sahrens uint32_t lhr_magic; /* ZAP_LEAF_MAGIC */ 93fa9e4066Sahrens uint16_t lhr_nfree; /* number free chunks */ 94fa9e4066Sahrens uint16_t lhr_nentries; /* number of entries */ 95fa9e4066Sahrens uint16_t lhr_prefix_len; 96fa9e4066Sahrens 97fa9e4066Sahrens #define lh_block_type l_phys->l_hdr.lhr_block_type 98fa9e4066Sahrens #define lh_magic l_phys->l_hdr.lhr_magic 99fa9e4066Sahrens #define lh_next l_phys->l_hdr.lhr_next 100fa9e4066Sahrens #define lh_prefix l_phys->l_hdr.lhr_prefix 101fa9e4066Sahrens #define lh_nfree l_phys->l_hdr.lhr_nfree 102fa9e4066Sahrens #define lh_prefix_len l_phys->l_hdr.lhr_prefix_len 103fa9e4066Sahrens #define lh_nentries l_phys->l_hdr.lhr_nentries 104fa9e4066Sahrens 105fa9e4066Sahrens /* above is accessable to zap, below is zap_leaf private */ 106fa9e4066Sahrens 107fa9e4066Sahrens uint16_t lh_freelist; /* chunk head of free list */ 108fa9e4066Sahrens uint8_t lh_pad2[12]; 109fa9e4066Sahrens } l_hdr; /* 2 24-byte chunks */ 110fa9e4066Sahrens 111*f65e61c0Sahrens /* 112*f65e61c0Sahrens * The header is followed by a hash table with 113*f65e61c0Sahrens * ZAP_LEAF_HASH_NUMENTRIES(zap) entries. The hash table is 114*f65e61c0Sahrens * followed by an array of ZAP_LEAF_NUMCHUNKS(zap) 115*f65e61c0Sahrens * zap_leaf_chunk structures. These structures are accessed 116*f65e61c0Sahrens * with the ZAP_LEAF_CHUNK() macro. 117*f65e61c0Sahrens */ 118*f65e61c0Sahrens 119*f65e61c0Sahrens uint16_t l_hash[1]; 120fa9e4066Sahrens } zap_leaf_phys_t; 121fa9e4066Sahrens 122*f65e61c0Sahrens typedef union zap_leaf_chunk { 123*f65e61c0Sahrens struct zap_leaf_entry { 124*f65e61c0Sahrens uint8_t le_type; /* always ZAP_CHUNK_ENTRY */ 125*f65e61c0Sahrens uint8_t le_int_size; /* size of ints */ 126*f65e61c0Sahrens uint16_t le_next; /* next entry in hash chain */ 127*f65e61c0Sahrens uint16_t le_name_chunk; /* first chunk of the name */ 128*f65e61c0Sahrens uint16_t le_name_length; /* bytes in name, incl null */ 129*f65e61c0Sahrens uint16_t le_value_chunk; /* first chunk of the value */ 130*f65e61c0Sahrens uint16_t le_value_length; /* value length in ints */ 131*f65e61c0Sahrens uint32_t le_cd; /* collision differentiator */ 132*f65e61c0Sahrens uint64_t le_hash; /* hash value of the name */ 133*f65e61c0Sahrens } l_entry; 134*f65e61c0Sahrens struct zap_leaf_array { 135*f65e61c0Sahrens uint8_t la_type; /* always ZAP_CHUNK_ARRAY */ 136*f65e61c0Sahrens uint8_t la_array[ZAP_LEAF_ARRAY_BYTES]; 137*f65e61c0Sahrens uint16_t la_next; /* next blk or CHAIN_END */ 138*f65e61c0Sahrens } l_array; 139*f65e61c0Sahrens struct zap_leaf_free { 140*f65e61c0Sahrens uint8_t lf_type; /* always ZAP_CHUNK_FREE */ 141*f65e61c0Sahrens uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES]; 142*f65e61c0Sahrens uint16_t lf_next; /* next in free list, or CHAIN_END */ 143*f65e61c0Sahrens } l_free; 144*f65e61c0Sahrens } zap_leaf_chunk_t; 145*f65e61c0Sahrens 146fa9e4066Sahrens typedef struct zap_leaf { 147fa9e4066Sahrens krwlock_t l_rwlock; /* only used on head of chain */ 148fa9e4066Sahrens uint64_t l_blkid; /* 1<<ZAP_BLOCK_SHIFT byte block off */ 149*f65e61c0Sahrens int l_bs; /* block size shift */ 150fa9e4066Sahrens struct zap_leaf *l_next; /* next in chain */ 151fa9e4066Sahrens dmu_buf_t *l_dbuf; 152fa9e4066Sahrens zap_leaf_phys_t *l_phys; 153fa9e4066Sahrens } zap_leaf_t; 154fa9e4066Sahrens 155fa9e4066Sahrens 156fa9e4066Sahrens typedef struct zap_entry_handle { 157fa9e4066Sahrens /* below is set by zap_leaf.c and is public to zap.c */ 158fa9e4066Sahrens uint64_t zeh_num_integers; 159fa9e4066Sahrens uint64_t zeh_hash; 160fa9e4066Sahrens uint32_t zeh_cd; 161fa9e4066Sahrens uint8_t zeh_integer_size; 162fa9e4066Sahrens 163fa9e4066Sahrens /* below is private to zap_leaf.c */ 164fa9e4066Sahrens uint16_t zeh_fakechunk; 165fa9e4066Sahrens uint16_t *zeh_chunkp; 166fa9e4066Sahrens zap_leaf_t *zeh_head_leaf; 167fa9e4066Sahrens zap_leaf_t *zeh_found_leaf; 168fa9e4066Sahrens } zap_entry_handle_t; 169fa9e4066Sahrens 170fa9e4066Sahrens /* 171fa9e4066Sahrens * Return a handle to the named entry, or ENOENT if not found. The hash 172fa9e4066Sahrens * value must equal zap_hash(name). 173fa9e4066Sahrens */ 174fa9e4066Sahrens extern int zap_leaf_lookup(zap_leaf_t *l, 175fa9e4066Sahrens const char *name, uint64_t h, zap_entry_handle_t *zeh); 176fa9e4066Sahrens 177fa9e4066Sahrens /* 178fa9e4066Sahrens * Return a handle to the entry with this hash+cd, or the entry with the 179fa9e4066Sahrens * next closest hash+cd. 180fa9e4066Sahrens */ 181fa9e4066Sahrens extern int zap_leaf_lookup_closest(zap_leaf_t *l, 182fa9e4066Sahrens uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh); 183fa9e4066Sahrens 184fa9e4066Sahrens /* 185fa9e4066Sahrens * Read the first num_integers in the attribute. Integer size 186fa9e4066Sahrens * conversion will be done without sign extension. Return EINVAL if 187fa9e4066Sahrens * integer_size is too small. Return EOVERFLOW if there are more than 188fa9e4066Sahrens * num_integers in the attribute. 189fa9e4066Sahrens */ 190fa9e4066Sahrens extern int zap_entry_read(const zap_entry_handle_t *zeh, 191fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, void *buf); 192fa9e4066Sahrens 193fa9e4066Sahrens extern int zap_entry_read_name(const zap_entry_handle_t *zeh, 194fa9e4066Sahrens uint16_t buflen, char *buf); 195fa9e4066Sahrens 196fa9e4066Sahrens /* 197fa9e4066Sahrens * Replace the value of an existing entry. 198fa9e4066Sahrens * 199fa9e4066Sahrens * zap_entry_update may fail if it runs out of space (ENOSPC). 200fa9e4066Sahrens */ 201fa9e4066Sahrens extern int zap_entry_update(zap_entry_handle_t *zeh, 202fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, const void *buf); 203fa9e4066Sahrens 204fa9e4066Sahrens /* 205fa9e4066Sahrens * Remove an entry. 206fa9e4066Sahrens */ 207fa9e4066Sahrens extern void zap_entry_remove(zap_entry_handle_t *zeh); 208fa9e4066Sahrens 209fa9e4066Sahrens /* 210fa9e4066Sahrens * Create an entry. An equal entry must not exist, and this entry must 211fa9e4066Sahrens * belong in this leaf (according to its hash value). Fills in the 212fa9e4066Sahrens * entry handle on success. Returns 0 on success or ENOSPC on failure. 213fa9e4066Sahrens */ 214fa9e4066Sahrens extern int zap_entry_create(zap_leaf_t *l, 215fa9e4066Sahrens const char *name, uint64_t h, uint32_t cd, 216fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, const void *buf, 217fa9e4066Sahrens zap_entry_handle_t *zeh); 218fa9e4066Sahrens 219fa9e4066Sahrens /* 220fa9e4066Sahrens * Other stuff. 221fa9e4066Sahrens */ 222fa9e4066Sahrens 223fa9e4066Sahrens extern void zap_leaf_init(zap_leaf_t *l); 224*f65e61c0Sahrens extern void zap_leaf_byteswap(zap_leaf_phys_t *buf, int len); 225fa9e4066Sahrens 226fa9e4066Sahrens extern zap_leaf_t *zap_leaf_split(struct zap *zap, zap_leaf_t *l, dmu_tx_t *tx); 227fa9e4066Sahrens 228fa9e4066Sahrens extern int zap_leaf_merge(zap_leaf_t *l, zap_leaf_t *sibling); 229fa9e4066Sahrens 230fa9e4066Sahrens extern zap_leaf_t *zap_leaf_chainmore(zap_leaf_t *l, zap_leaf_t *nl); 231fa9e4066Sahrens 232fa9e4066Sahrens extern int zap_leaf_advance(zap_leaf_t *l, zap_cursor_t *zc); 233fa9e4066Sahrens 234fa9e4066Sahrens extern void zap_stats_leaf(zap_t *zap, zap_leaf_t *l, zap_stats_t *zs); 235fa9e4066Sahrens 236fa9e4066Sahrens #ifdef __cplusplus 237fa9e4066Sahrens } 238fa9e4066Sahrens #endif 239fa9e4066Sahrens 240fa9e4066Sahrens #endif /* _SYS_ZAP_LEAF_H */ 241