1*fa9e4066Sahrens /* 2*fa9e4066Sahrens * CDDL HEADER START 3*fa9e4066Sahrens * 4*fa9e4066Sahrens * The contents of this file are subject to the terms of the 5*fa9e4066Sahrens * Common Development and Distribution License, Version 1.0 only 6*fa9e4066Sahrens * (the "License"). You may not use this file except in compliance 7*fa9e4066Sahrens * with the License. 8*fa9e4066Sahrens * 9*fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 11*fa9e4066Sahrens * See the License for the specific language governing permissions 12*fa9e4066Sahrens * and limitations under the License. 13*fa9e4066Sahrens * 14*fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 15*fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 17*fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 18*fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 19*fa9e4066Sahrens * 20*fa9e4066Sahrens * CDDL HEADER END 21*fa9e4066Sahrens */ 22*fa9e4066Sahrens /* 23*fa9e4066Sahrens * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24*fa9e4066Sahrens * Use is subject to license terms. 25*fa9e4066Sahrens */ 26*fa9e4066Sahrens 27*fa9e4066Sahrens #ifndef _SYS_ZAP_LEAF_H 28*fa9e4066Sahrens #define _SYS_ZAP_LEAF_H 29*fa9e4066Sahrens 30*fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 31*fa9e4066Sahrens 32*fa9e4066Sahrens #ifdef __cplusplus 33*fa9e4066Sahrens extern "C" { 34*fa9e4066Sahrens #endif 35*fa9e4066Sahrens 36*fa9e4066Sahrens struct zap; 37*fa9e4066Sahrens 38*fa9e4066Sahrens #define ZAP_LEAF_MAGIC 0x2AB1EAF 39*fa9e4066Sahrens 40*fa9e4066Sahrens /* chunk size = 24 bytes */ 41*fa9e4066Sahrens 42*fa9e4066Sahrens #define ZAP_LEAF_NUMCHUNKS 5118 43*fa9e4066Sahrens #define ZAP_LEAF_ARRAY_BYTES 21 44*fa9e4066Sahrens #define ZAP_LEAF_HASH_SHIFT 12 45*fa9e4066Sahrens #define ZAP_LEAF_HASH_NUMENTRIES (1 << ZAP_LEAF_HASH_SHIFT) 46*fa9e4066Sahrens #define ZAP_LLA_DATA_BYTES ((1 << ZAP_BLOCK_SHIFT) - 16) 47*fa9e4066Sahrens 48*fa9e4066Sahrens typedef enum zap_entry_type { 49*fa9e4066Sahrens ZAP_LEAF_FREE = 253, 50*fa9e4066Sahrens ZAP_LEAF_ENTRY = 252, 51*fa9e4066Sahrens ZAP_LEAF_ARRAY = 251, 52*fa9e4066Sahrens ZAP_LEAF_TYPE_MAX = 250 53*fa9e4066Sahrens } zap_entry_type_t; 54*fa9e4066Sahrens 55*fa9e4066Sahrens /* 56*fa9e4066Sahrens * TAKE NOTE: 57*fa9e4066Sahrens * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified. 58*fa9e4066Sahrens */ 59*fa9e4066Sahrens typedef struct zap_leaf_phys { 60*fa9e4066Sahrens struct zap_leaf_header { 61*fa9e4066Sahrens uint64_t lhr_block_type; /* ZBT_LEAF */ 62*fa9e4066Sahrens uint64_t lhr_next; /* next block in leaf chain */ 63*fa9e4066Sahrens uint64_t lhr_prefix; 64*fa9e4066Sahrens uint32_t lhr_magic; /* ZAP_LEAF_MAGIC */ 65*fa9e4066Sahrens uint16_t lhr_nfree; /* number free chunks */ 66*fa9e4066Sahrens uint16_t lhr_nentries; /* number of entries */ 67*fa9e4066Sahrens uint16_t lhr_prefix_len; 68*fa9e4066Sahrens 69*fa9e4066Sahrens #define lh_block_type l_phys->l_hdr.lhr_block_type 70*fa9e4066Sahrens #define lh_magic l_phys->l_hdr.lhr_magic 71*fa9e4066Sahrens #define lh_next l_phys->l_hdr.lhr_next 72*fa9e4066Sahrens #define lh_prefix l_phys->l_hdr.lhr_prefix 73*fa9e4066Sahrens #define lh_nfree l_phys->l_hdr.lhr_nfree 74*fa9e4066Sahrens #define lh_prefix_len l_phys->l_hdr.lhr_prefix_len 75*fa9e4066Sahrens #define lh_nentries l_phys->l_hdr.lhr_nentries 76*fa9e4066Sahrens 77*fa9e4066Sahrens /* above is accessable to zap, below is zap_leaf private */ 78*fa9e4066Sahrens 79*fa9e4066Sahrens uint16_t lh_freelist; /* chunk head of free list */ 80*fa9e4066Sahrens uint8_t lh_pad2[12]; 81*fa9e4066Sahrens } l_hdr; /* 2 24-byte chunks */ 82*fa9e4066Sahrens 83*fa9e4066Sahrens uint16_t l_hash[ZAP_LEAF_HASH_NUMENTRIES]; 84*fa9e4066Sahrens /* 170 24-byte chunks plus 16 bytes leftover space */ 85*fa9e4066Sahrens 86*fa9e4066Sahrens union zap_leaf_chunk { 87*fa9e4066Sahrens struct zap_leaf_entry { 88*fa9e4066Sahrens uint8_t le_type; /* always ZAP_LEAF_ENTRY */ 89*fa9e4066Sahrens uint8_t le_int_size; /* size of ints */ 90*fa9e4066Sahrens uint16_t le_next; /* next entry in hash chain */ 91*fa9e4066Sahrens uint16_t le_name_chunk; /* first chunk of the name */ 92*fa9e4066Sahrens uint16_t le_name_length; /* bytes in name, incl null */ 93*fa9e4066Sahrens uint16_t le_value_chunk; /* first chunk of the value */ 94*fa9e4066Sahrens uint16_t le_value_length; /* value length in ints */ 95*fa9e4066Sahrens uint32_t le_cd; /* collision differentiator */ 96*fa9e4066Sahrens uint64_t le_hash; /* hash value of the name */ 97*fa9e4066Sahrens } l_entry; 98*fa9e4066Sahrens struct zap_leaf_array { 99*fa9e4066Sahrens uint8_t la_type; 100*fa9e4066Sahrens uint8_t la_array[ZAP_LEAF_ARRAY_BYTES]; 101*fa9e4066Sahrens uint16_t la_next; /* next blk or CHAIN_END */ 102*fa9e4066Sahrens } l_array; 103*fa9e4066Sahrens struct zap_leaf_free { 104*fa9e4066Sahrens uint8_t lf_type; /* always ZAP_LEAF_FREE */ 105*fa9e4066Sahrens uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES]; 106*fa9e4066Sahrens uint16_t lf_next; /* next in free list, or CHAIN_END */ 107*fa9e4066Sahrens } l_free; 108*fa9e4066Sahrens } l_chunk[ZAP_LEAF_NUMCHUNKS]; 109*fa9e4066Sahrens } zap_leaf_phys_t; 110*fa9e4066Sahrens 111*fa9e4066Sahrens typedef struct zap_leaf { 112*fa9e4066Sahrens krwlock_t l_rwlock; /* only used on head of chain */ 113*fa9e4066Sahrens uint64_t l_blkid; /* 1<<ZAP_BLOCK_SHIFT byte block off */ 114*fa9e4066Sahrens struct zap_leaf *l_next; /* next in chain */ 115*fa9e4066Sahrens dmu_buf_t *l_dbuf; 116*fa9e4066Sahrens zap_leaf_phys_t *l_phys; 117*fa9e4066Sahrens } zap_leaf_t; 118*fa9e4066Sahrens 119*fa9e4066Sahrens 120*fa9e4066Sahrens typedef struct zap_entry_handle { 121*fa9e4066Sahrens /* below is set by zap_leaf.c and is public to zap.c */ 122*fa9e4066Sahrens uint64_t zeh_num_integers; 123*fa9e4066Sahrens uint64_t zeh_hash; 124*fa9e4066Sahrens uint32_t zeh_cd; 125*fa9e4066Sahrens uint8_t zeh_integer_size; 126*fa9e4066Sahrens 127*fa9e4066Sahrens /* below is private to zap_leaf.c */ 128*fa9e4066Sahrens uint16_t zeh_fakechunk; 129*fa9e4066Sahrens uint16_t *zeh_chunkp; 130*fa9e4066Sahrens zap_leaf_t *zeh_head_leaf; 131*fa9e4066Sahrens zap_leaf_t *zeh_found_leaf; 132*fa9e4066Sahrens } zap_entry_handle_t; 133*fa9e4066Sahrens 134*fa9e4066Sahrens /* 135*fa9e4066Sahrens * Return a handle to the named entry, or ENOENT if not found. The hash 136*fa9e4066Sahrens * value must equal zap_hash(name). 137*fa9e4066Sahrens */ 138*fa9e4066Sahrens extern int zap_leaf_lookup(zap_leaf_t *l, 139*fa9e4066Sahrens const char *name, uint64_t h, zap_entry_handle_t *zeh); 140*fa9e4066Sahrens 141*fa9e4066Sahrens /* 142*fa9e4066Sahrens * Return a handle to the entry with this hash+cd, or the entry with the 143*fa9e4066Sahrens * next closest hash+cd. 144*fa9e4066Sahrens */ 145*fa9e4066Sahrens extern int zap_leaf_lookup_closest(zap_leaf_t *l, 146*fa9e4066Sahrens uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh); 147*fa9e4066Sahrens 148*fa9e4066Sahrens /* 149*fa9e4066Sahrens * Read the first num_integers in the attribute. Integer size 150*fa9e4066Sahrens * conversion will be done without sign extension. Return EINVAL if 151*fa9e4066Sahrens * integer_size is too small. Return EOVERFLOW if there are more than 152*fa9e4066Sahrens * num_integers in the attribute. 153*fa9e4066Sahrens */ 154*fa9e4066Sahrens extern int zap_entry_read(const zap_entry_handle_t *zeh, 155*fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, void *buf); 156*fa9e4066Sahrens 157*fa9e4066Sahrens extern int zap_entry_read_name(const zap_entry_handle_t *zeh, 158*fa9e4066Sahrens uint16_t buflen, char *buf); 159*fa9e4066Sahrens 160*fa9e4066Sahrens /* 161*fa9e4066Sahrens * Replace the value of an existing entry. 162*fa9e4066Sahrens * 163*fa9e4066Sahrens * zap_entry_update may fail if it runs out of space (ENOSPC). 164*fa9e4066Sahrens */ 165*fa9e4066Sahrens extern int zap_entry_update(zap_entry_handle_t *zeh, 166*fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, const void *buf); 167*fa9e4066Sahrens 168*fa9e4066Sahrens /* 169*fa9e4066Sahrens * Remove an entry. 170*fa9e4066Sahrens */ 171*fa9e4066Sahrens extern void zap_entry_remove(zap_entry_handle_t *zeh); 172*fa9e4066Sahrens 173*fa9e4066Sahrens /* 174*fa9e4066Sahrens * Create an entry. An equal entry must not exist, and this entry must 175*fa9e4066Sahrens * belong in this leaf (according to its hash value). Fills in the 176*fa9e4066Sahrens * entry handle on success. Returns 0 on success or ENOSPC on failure. 177*fa9e4066Sahrens */ 178*fa9e4066Sahrens extern int zap_entry_create(zap_leaf_t *l, 179*fa9e4066Sahrens const char *name, uint64_t h, uint32_t cd, 180*fa9e4066Sahrens uint8_t integer_size, uint64_t num_integers, const void *buf, 181*fa9e4066Sahrens zap_entry_handle_t *zeh); 182*fa9e4066Sahrens 183*fa9e4066Sahrens /* 184*fa9e4066Sahrens * Other stuff. 185*fa9e4066Sahrens */ 186*fa9e4066Sahrens 187*fa9e4066Sahrens extern void zap_leaf_init(zap_leaf_t *l); 188*fa9e4066Sahrens extern void zap_leaf_byteswap(zap_leaf_phys_t *buf); 189*fa9e4066Sahrens 190*fa9e4066Sahrens extern zap_leaf_t *zap_leaf_split(struct zap *zap, zap_leaf_t *l, dmu_tx_t *tx); 191*fa9e4066Sahrens 192*fa9e4066Sahrens extern int zap_leaf_merge(zap_leaf_t *l, zap_leaf_t *sibling); 193*fa9e4066Sahrens 194*fa9e4066Sahrens extern zap_leaf_t *zap_leaf_chainmore(zap_leaf_t *l, zap_leaf_t *nl); 195*fa9e4066Sahrens 196*fa9e4066Sahrens extern int zap_leaf_advance(zap_leaf_t *l, zap_cursor_t *zc); 197*fa9e4066Sahrens 198*fa9e4066Sahrens extern void zap_stats_leaf(zap_t *zap, zap_leaf_t *l, zap_stats_t *zs); 199*fa9e4066Sahrens 200*fa9e4066Sahrens #ifdef __cplusplus 201*fa9e4066Sahrens } 202*fa9e4066Sahrens #endif 203*fa9e4066Sahrens 204*fa9e4066Sahrens #endif /* _SYS_ZAP_LEAF_H */ 205