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 /* 22*da6c28aaSamw * Copyright 2007 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 */ 40f65e61c0Sahrens #define ZAP_LEAF_CHUNKSIZE 24 41fa9e4066Sahrens 42f65e61c0Sahrens /* 43f65e61c0Sahrens * The amount of space available for chunks is: 44f65e61c0Sahrens * block size (1<<l->l_bs) - hash entry size (2) * number of hash 45f65e61c0Sahrens * entries - header space (2*chunksize) 46f65e61c0Sahrens */ 47f65e61c0Sahrens #define ZAP_LEAF_NUMCHUNKS(l) \ 48f65e61c0Sahrens (((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \ 49f65e61c0Sahrens ZAP_LEAF_CHUNKSIZE - 2) 50f65e61c0Sahrens 51f65e61c0Sahrens /* 52f65e61c0Sahrens * The amount of space within the chunk available for the array is: 53f65e61c0Sahrens * chunk size - space for type (1) - space for next pointer (2) 54f65e61c0Sahrens */ 55f65e61c0Sahrens #define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3) 56f65e61c0Sahrens 5766328dd3Sahrens #define ZAP_LEAF_ARRAY_NCHUNKS(bytes) \ 5866328dd3Sahrens (((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES) 5966328dd3Sahrens 6066328dd3Sahrens /* 6166328dd3Sahrens * Low water mark: when there are only this many chunks free, start 6266328dd3Sahrens * growing the ptrtbl. Ideally, this should be larger than a 6366328dd3Sahrens * "reasonably-sized" entry. 20 chunks is more than enough for the 6466328dd3Sahrens * largest directory entry (MAXNAMELEN (256) byte name, 8-byte value), 6566328dd3Sahrens * while still being only around 3% for 16k blocks. 6666328dd3Sahrens */ 6766328dd3Sahrens #define ZAP_LEAF_LOW_WATER (20) 6866328dd3Sahrens 69f65e61c0Sahrens /* 70f65e61c0Sahrens * The leaf hash table has block size / 2^5 (32) number of entries, 71f65e61c0Sahrens * which should be more than enough for the maximum number of entries, 72f65e61c0Sahrens * which is less than block size / CHUNKSIZE (24) / minimum number of 73f65e61c0Sahrens * chunks per entry (3). 74f65e61c0Sahrens */ 75f65e61c0Sahrens #define ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5) 76f65e61c0Sahrens #define ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l)) 77fa9e4066Sahrens 78f65e61c0Sahrens /* 79f65e61c0Sahrens * The chunks start immediately after the hash table. The end of the 80f65e61c0Sahrens * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a 81f65e61c0Sahrens * chunk_t. 82f65e61c0Sahrens */ 83f65e61c0Sahrens #define ZAP_LEAF_CHUNK(l, idx) \ 84f65e61c0Sahrens ((zap_leaf_chunk_t *) \ 85f65e61c0Sahrens ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx] 86f65e61c0Sahrens #define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry) 87f65e61c0Sahrens 88f65e61c0Sahrens typedef enum zap_chunk_type { 89f65e61c0Sahrens ZAP_CHUNK_FREE = 253, 90f65e61c0Sahrens ZAP_CHUNK_ENTRY = 252, 91f65e61c0Sahrens ZAP_CHUNK_ARRAY = 251, 92f65e61c0Sahrens ZAP_CHUNK_TYPE_MAX = 250 93f65e61c0Sahrens } zap_chunk_type_t; 94fa9e4066Sahrens 95*da6c28aaSamw #define ZLF_ENTRIES_CDSORTED (1<<0) 96*da6c28aaSamw 97fa9e4066Sahrens /* 98fa9e4066Sahrens * TAKE NOTE: 99fa9e4066Sahrens * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified. 100fa9e4066Sahrens */ 101fa9e4066Sahrens typedef struct zap_leaf_phys { 102fa9e4066Sahrens struct zap_leaf_header { 10366328dd3Sahrens uint64_t lh_block_type; /* ZBT_LEAF */ 10466328dd3Sahrens uint64_t lh_pad1; 10566328dd3Sahrens uint64_t lh_prefix; /* hash prefix of this leaf */ 10666328dd3Sahrens uint32_t lh_magic; /* ZAP_LEAF_MAGIC */ 10766328dd3Sahrens uint16_t lh_nfree; /* number free chunks */ 10866328dd3Sahrens uint16_t lh_nentries; /* number of entries */ 10966328dd3Sahrens uint16_t lh_prefix_len; /* num bits used to id this */ 110fa9e4066Sahrens 111fa9e4066Sahrens /* above is accessable to zap, below is zap_leaf private */ 112fa9e4066Sahrens 113fa9e4066Sahrens uint16_t lh_freelist; /* chunk head of free list */ 114*da6c28aaSamw uint8_t lh_flags; /* ZLF_* flags */ 115*da6c28aaSamw uint8_t lh_pad2[11]; 116fa9e4066Sahrens } l_hdr; /* 2 24-byte chunks */ 117fa9e4066Sahrens 118f65e61c0Sahrens /* 119f65e61c0Sahrens * The header is followed by a hash table with 120f65e61c0Sahrens * ZAP_LEAF_HASH_NUMENTRIES(zap) entries. The hash table is 121f65e61c0Sahrens * followed by an array of ZAP_LEAF_NUMCHUNKS(zap) 122f65e61c0Sahrens * zap_leaf_chunk structures. These structures are accessed 123f65e61c0Sahrens * with the ZAP_LEAF_CHUNK() macro. 124f65e61c0Sahrens */ 125f65e61c0Sahrens 126f65e61c0Sahrens uint16_t l_hash[1]; 127fa9e4066Sahrens } zap_leaf_phys_t; 128fa9e4066Sahrens 129f65e61c0Sahrens typedef union zap_leaf_chunk { 130f65e61c0Sahrens struct zap_leaf_entry { 131f65e61c0Sahrens uint8_t le_type; /* always ZAP_CHUNK_ENTRY */ 132f65e61c0Sahrens uint8_t le_int_size; /* size of ints */ 133f65e61c0Sahrens uint16_t le_next; /* next entry in hash chain */ 134f65e61c0Sahrens uint16_t le_name_chunk; /* first chunk of the name */ 135f65e61c0Sahrens uint16_t le_name_length; /* bytes in name, incl null */ 136f65e61c0Sahrens uint16_t le_value_chunk; /* first chunk of the value */ 137f65e61c0Sahrens uint16_t le_value_length; /* value length in ints */ 138f65e61c0Sahrens uint32_t le_cd; /* collision differentiator */ 139f65e61c0Sahrens uint64_t le_hash; /* hash value of the name */ 140f65e61c0Sahrens } l_entry; 141f65e61c0Sahrens struct zap_leaf_array { 142f65e61c0Sahrens uint8_t la_type; /* always ZAP_CHUNK_ARRAY */ 143f65e61c0Sahrens uint8_t la_array[ZAP_LEAF_ARRAY_BYTES]; 144f65e61c0Sahrens uint16_t la_next; /* next blk or CHAIN_END */ 145f65e61c0Sahrens } l_array; 146f65e61c0Sahrens struct zap_leaf_free { 147f65e61c0Sahrens uint8_t lf_type; /* always ZAP_CHUNK_FREE */ 148f65e61c0Sahrens uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES]; 149f65e61c0Sahrens uint16_t lf_next; /* next in free list, or CHAIN_END */ 150f65e61c0Sahrens } l_free; 151f65e61c0Sahrens } zap_leaf_chunk_t; 152f65e61c0Sahrens 153fa9e4066Sahrens typedef struct zap_leaf { 154fa9e4066Sahrens krwlock_t l_rwlock; /* only used on head of chain */ 155fa9e4066Sahrens uint64_t l_blkid; /* 1<<ZAP_BLOCK_SHIFT byte block off */ 156f65e61c0Sahrens int l_bs; /* block size shift */ 157fa9e4066Sahrens dmu_buf_t *l_dbuf; 158fa9e4066Sahrens zap_leaf_phys_t *l_phys; 159fa9e4066Sahrens } zap_leaf_t; 160fa9e4066Sahrens 161fa9e4066Sahrens 162fa9e4066Sahrens typedef struct zap_entry_handle { 163fa9e4066Sahrens /* below is set by zap_leaf.c and is public to zap.c */ 164fa9e4066Sahrens uint64_t zeh_num_integers; 165fa9e4066Sahrens uint64_t zeh_hash; 166fa9e4066Sahrens uint32_t zeh_cd; 167fa9e4066Sahrens uint8_t zeh_integer_size; 168fa9e4066Sahrens 169fa9e4066Sahrens /* below is private to zap_leaf.c */ 170fa9e4066Sahrens uint16_t zeh_fakechunk; 171fa9e4066Sahrens uint16_t *zeh_chunkp; 17266328dd3Sahrens zap_leaf_t *zeh_leaf; 173fa9e4066Sahrens } zap_entry_handle_t; 174fa9e4066Sahrens 175fa9e4066Sahrens /* 176fa9e4066Sahrens * Return a handle to the named entry, or ENOENT if not found. The hash 177fa9e4066Sahrens * value must equal zap_hash(name). 178fa9e4066Sahrens */ 179fa9e4066Sahrens extern int zap_leaf_lookup(zap_leaf_t *l, 180*da6c28aaSamw zap_name_t *zn, zap_entry_handle_t *zeh); 181fa9e4066Sahrens 182fa9e4066Sahrens /* 183fa9e4066Sahrens * Return a handle to the entry with this hash+cd, or the entry with the 184fa9e4066Sahrens * next closest hash+cd. 185fa9e4066Sahrens */ 186fa9e4066Sahrens extern int zap_leaf_lookup_closest(zap_leaf_t *l, 187fa9e4066Sahrens uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh); 188fa9e4066Sahrens 189fa9e4066Sahrens /* 190fa9e4066Sahrens * Read the first num_integers in the attribute. Integer size 191fa9e4066Sahrens * conversion will be done without sign extension. Return EINVAL if 192fa9e4066Sahrens * integer_size is too small. Return EOVERFLOW if there are more than 193fa9e4066Sahrens * num_integers in the attribute. 194fa9e4066Sahrens */ 195fa9e4066Sahrens extern int zap_entry_read(const zap_entry_handle_t *zeh, 196fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, void *buf); 197fa9e4066Sahrens 198fa9e4066Sahrens extern int zap_entry_read_name(const zap_entry_handle_t *zeh, 199fa9e4066Sahrens uint16_t buflen, char *buf); 200fa9e4066Sahrens 201fa9e4066Sahrens /* 202fa9e4066Sahrens * Replace the value of an existing entry. 203fa9e4066Sahrens * 204fa9e4066Sahrens * zap_entry_update may fail if it runs out of space (ENOSPC). 205fa9e4066Sahrens */ 206fa9e4066Sahrens extern int zap_entry_update(zap_entry_handle_t *zeh, 207fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, const void *buf); 208fa9e4066Sahrens 209fa9e4066Sahrens /* 210fa9e4066Sahrens * Remove an entry. 211fa9e4066Sahrens */ 212fa9e4066Sahrens extern void zap_entry_remove(zap_entry_handle_t *zeh); 213fa9e4066Sahrens 214fa9e4066Sahrens /* 215fa9e4066Sahrens * Create an entry. An equal entry must not exist, and this entry must 216fa9e4066Sahrens * belong in this leaf (according to its hash value). Fills in the 217fa9e4066Sahrens * entry handle on success. Returns 0 on success or ENOSPC on failure. 218fa9e4066Sahrens */ 219fa9e4066Sahrens extern int zap_entry_create(zap_leaf_t *l, 220fa9e4066Sahrens const char *name, uint64_t h, uint32_t cd, 221fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, const void *buf, 222fa9e4066Sahrens zap_entry_handle_t *zeh); 223fa9e4066Sahrens 224*da6c28aaSamw /* 225*da6c28aaSamw * Return true if there are additional entries with the same normalized 226*da6c28aaSamw * form. 227*da6c28aaSamw */ 228*da6c28aaSamw extern boolean_t zap_entry_normalization_conflict(zap_entry_handle_t *zeh, 229*da6c28aaSamw zap_name_t *zn, const char *name, zap_t *zap); 230*da6c28aaSamw 231fa9e4066Sahrens /* 232fa9e4066Sahrens * Other stuff. 233fa9e4066Sahrens */ 234fa9e4066Sahrens 235*da6c28aaSamw extern void zap_leaf_init(zap_leaf_t *l, int version); 236f65e61c0Sahrens extern void zap_leaf_byteswap(zap_leaf_phys_t *buf, int len); 237*da6c28aaSamw extern void zap_leaf_split(zap_leaf_t *l, zap_leaf_t *nl, int version); 23866328dd3Sahrens extern void zap_leaf_stats(zap_t *zap, zap_leaf_t *l, zap_stats_t *zs); 239fa9e4066Sahrens 240fa9e4066Sahrens #ifdef __cplusplus 241fa9e4066Sahrens } 242fa9e4066Sahrens #endif 243fa9e4066Sahrens 244fa9e4066Sahrens #endif /* _SYS_ZAP_LEAF_H */ 245