Print this page
3742 zfs comments need cleaner, more consistent style
Submitted by:   Will Andrews <willa@spectralogic.com>
Submitted by:   Alan Somers <alans@spectralogic.com>
Reviewed by:    Matthew Ahrens <mahrens@delphix.com>
Reviewed by:    George Wilson <george.wilson@delphix.com>
Reviewed by:    Eric Schrock <eric.schrock@delphix.com>


  84 #define ZAP_LEAF_CHUNK(l, idx) \
  85         ((zap_leaf_chunk_t *) \
  86         ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx]
  87 #define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry)
  88 
  89 typedef enum zap_chunk_type {
  90         ZAP_CHUNK_FREE = 253,
  91         ZAP_CHUNK_ENTRY = 252,
  92         ZAP_CHUNK_ARRAY = 251,
  93         ZAP_CHUNK_TYPE_MAX = 250
  94 } zap_chunk_type_t;
  95 
  96 #define ZLF_ENTRIES_CDSORTED (1<<0)
  97 
  98 /*
  99  * TAKE NOTE:
 100  * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified.
 101  */
 102 typedef struct zap_leaf_phys {
 103         struct zap_leaf_header {

 104                 uint64_t lh_block_type;         /* ZBT_LEAF */
 105                 uint64_t lh_pad1;
 106                 uint64_t lh_prefix;             /* hash prefix of this leaf */
 107                 uint32_t lh_magic;              /* ZAP_LEAF_MAGIC */
 108                 uint16_t lh_nfree;              /* number free chunks */
 109                 uint16_t lh_nentries;           /* number of entries */
 110                 uint16_t lh_prefix_len;         /* num bits used to id this */
 111 
 112 /* above is accessable to zap, below is zap_leaf private */
 113 
 114                 uint16_t lh_freelist;           /* chunk head of free list */
 115                 uint8_t lh_flags;               /* ZLF_* flags */
 116                 uint8_t lh_pad2[11];
 117         } l_hdr; /* 2 24-byte chunks */
 118 
 119         /*
 120          * The header is followed by a hash table with
 121          * ZAP_LEAF_HASH_NUMENTRIES(zap) entries.  The hash table is
 122          * followed by an array of ZAP_LEAF_NUMCHUNKS(zap)
 123          * zap_leaf_chunk structures.  These structures are accessed
 124          * with the ZAP_LEAF_CHUNK() macro.
 125          */
 126 
 127         uint16_t l_hash[1];
 128 } zap_leaf_phys_t;
 129 
 130 typedef union zap_leaf_chunk {
 131         struct zap_leaf_entry {
 132                 uint8_t le_type;                /* always ZAP_CHUNK_ENTRY */
 133                 uint8_t le_value_intlen;        /* size of value's ints */


 144                 uint8_t la_array[ZAP_LEAF_ARRAY_BYTES];
 145                 uint16_t la_next;               /* next blk or CHAIN_END */
 146         } l_array;
 147         struct zap_leaf_free {
 148                 uint8_t lf_type;                /* always ZAP_CHUNK_FREE */
 149                 uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES];
 150                 uint16_t lf_next;       /* next in free list, or CHAIN_END */
 151         } l_free;
 152 } zap_leaf_chunk_t;
 153 
 154 typedef struct zap_leaf {
 155         krwlock_t l_rwlock;
 156         uint64_t l_blkid;               /* 1<<ZAP_BLOCK_SHIFT byte block off */
 157         int l_bs;                       /* block size shift */
 158         dmu_buf_t *l_dbuf;
 159         zap_leaf_phys_t *l_phys;
 160 } zap_leaf_t;
 161 
 162 
 163 typedef struct zap_entry_handle {
 164         /* below is set by zap_leaf.c and is public to zap.c */
 165         uint64_t zeh_num_integers;
 166         uint64_t zeh_hash;
 167         uint32_t zeh_cd;
 168         uint8_t zeh_integer_size;
 169 
 170         /* below is private to zap_leaf.c */
 171         uint16_t zeh_fakechunk;
 172         uint16_t *zeh_chunkp;
 173         zap_leaf_t *zeh_leaf;
 174 } zap_entry_handle_t;
 175 
 176 /*
 177  * Return a handle to the named entry, or ENOENT if not found.  The hash
 178  * value must equal zap_hash(name).
 179  */
 180 extern int zap_leaf_lookup(zap_leaf_t *l,
 181     struct zap_name *zn, zap_entry_handle_t *zeh);
 182 
 183 /*
 184  * Return a handle to the entry with this hash+cd, or the entry with the
 185  * next closest hash+cd.
 186  */
 187 extern int zap_leaf_lookup_closest(zap_leaf_t *l,
 188     uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh);
 189 
 190 /*
 191  * Read the first num_integers in the attribute.  Integer size
 192  * conversion will be done without sign extension.  Return EINVAL if
 193  * integer_size is too small.  Return EOVERFLOW if there are more than
 194  * num_integers in the attribute.
 195  */
 196 extern int zap_entry_read(const zap_entry_handle_t *zeh,
 197     uint8_t integer_size, uint64_t num_integers, void *buf);
 198 
 199 extern int zap_entry_read_name(struct zap *zap, const zap_entry_handle_t *zeh,
 200     uint16_t buflen, char *buf);
 201 
 202 /*
 203  * Replace the value of an existing entry.
 204  *
 205  * zap_entry_update may fail if it runs out of space (ENOSPC).
 206  */
 207 extern int zap_entry_update(zap_entry_handle_t *zeh,
 208     uint8_t integer_size, uint64_t num_integers, const void *buf);
 209 
 210 /*
 211  * Remove an entry.
 212  */
 213 extern void zap_entry_remove(zap_entry_handle_t *zeh);
 214 
 215 /*
 216  * Create an entry. An equal entry must not exist, and this entry must
 217  * belong in this leaf (according to its hash value).  Fills in the
 218  * entry handle on success.  Returns 0 on success or ENOSPC on failure.
 219  */
 220 extern int zap_entry_create(zap_leaf_t *l, struct zap_name *zn, uint32_t cd,
 221     uint8_t integer_size, uint64_t num_integers, const void *buf,
 222     zap_entry_handle_t *zeh);
 223 
 224 /*
 225  * Return true if there are additional entries with the same normalized
 226  * form.
 227  */
 228 extern boolean_t zap_entry_normalization_conflict(zap_entry_handle_t *zeh,
 229     struct zap_name *zn, const char *name, struct zap *zap);
 230 
 231 /*
 232  * Other stuff.
 233  */
 234 
 235 extern void zap_leaf_init(zap_leaf_t *l, boolean_t sort);
 236 extern void zap_leaf_byteswap(zap_leaf_phys_t *buf, int len);
 237 extern void zap_leaf_split(zap_leaf_t *l, zap_leaf_t *nl, boolean_t sort);
 238 extern void zap_leaf_stats(struct zap *zap, zap_leaf_t *l,
 239     struct zap_stats *zs);
 240 
 241 #ifdef  __cplusplus
 242 }
 243 #endif
 244 
 245 #endif /* _SYS_ZAP_LEAF_H */


  84 #define ZAP_LEAF_CHUNK(l, idx) \
  85         ((zap_leaf_chunk_t *) \
  86         ((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx]
  87 #define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry)
  88 
  89 typedef enum zap_chunk_type {
  90         ZAP_CHUNK_FREE = 253,
  91         ZAP_CHUNK_ENTRY = 252,
  92         ZAP_CHUNK_ARRAY = 251,
  93         ZAP_CHUNK_TYPE_MAX = 250
  94 } zap_chunk_type_t;
  95 
  96 #define ZLF_ENTRIES_CDSORTED (1<<0)
  97 
  98 /*
  99  * TAKE NOTE:
 100  * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified.
 101  */
 102 typedef struct zap_leaf_phys {
 103         struct zap_leaf_header {
 104                 /* Public to ZAP */
 105                 uint64_t lh_block_type;         /* ZBT_LEAF */
 106                 uint64_t lh_pad1;
 107                 uint64_t lh_prefix;             /* hash prefix of this leaf */
 108                 uint32_t lh_magic;              /* ZAP_LEAF_MAGIC */
 109                 uint16_t lh_nfree;              /* number free chunks */
 110                 uint16_t lh_nentries;           /* number of entries */
 111                 uint16_t lh_prefix_len;         /* num bits used to id this */
 112 
 113                 /* Private to zap_leaf */

 114                 uint16_t lh_freelist;           /* chunk head of free list */
 115                 uint8_t lh_flags;               /* ZLF_* flags */
 116                 uint8_t lh_pad2[11];
 117         } l_hdr; /* 2 24-byte chunks */
 118 
 119         /*
 120          * The header is followed by a hash table with
 121          * ZAP_LEAF_HASH_NUMENTRIES(zap) entries.  The hash table is
 122          * followed by an array of ZAP_LEAF_NUMCHUNKS(zap)
 123          * zap_leaf_chunk structures.  These structures are accessed
 124          * with the ZAP_LEAF_CHUNK() macro.
 125          */
 126 
 127         uint16_t l_hash[1];
 128 } zap_leaf_phys_t;
 129 
 130 typedef union zap_leaf_chunk {
 131         struct zap_leaf_entry {
 132                 uint8_t le_type;                /* always ZAP_CHUNK_ENTRY */
 133                 uint8_t le_value_intlen;        /* size of value's ints */


 144                 uint8_t la_array[ZAP_LEAF_ARRAY_BYTES];
 145                 uint16_t la_next;               /* next blk or CHAIN_END */
 146         } l_array;
 147         struct zap_leaf_free {
 148                 uint8_t lf_type;                /* always ZAP_CHUNK_FREE */
 149                 uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES];
 150                 uint16_t lf_next;       /* next in free list, or CHAIN_END */
 151         } l_free;
 152 } zap_leaf_chunk_t;
 153 
 154 typedef struct zap_leaf {
 155         krwlock_t l_rwlock;
 156         uint64_t l_blkid;               /* 1<<ZAP_BLOCK_SHIFT byte block off */
 157         int l_bs;                       /* block size shift */
 158         dmu_buf_t *l_dbuf;
 159         zap_leaf_phys_t *l_phys;
 160 } zap_leaf_t;
 161 
 162 
 163 typedef struct zap_entry_handle {
 164         /* Set by zap_leaf and public to ZAP */
 165         uint64_t zeh_num_integers;
 166         uint64_t zeh_hash;
 167         uint32_t zeh_cd;
 168         uint8_t zeh_integer_size;
 169 
 170         /* Private to zap_leaf */
 171         uint16_t zeh_fakechunk;
 172         uint16_t *zeh_chunkp;
 173         zap_leaf_t *zeh_leaf;
 174 } zap_entry_handle_t;
 175 
 176 /*
 177  * Return a handle to the named entry, or ENOENT if not found.  The hash
 178  * value must equal zap_hash(name).
 179  */
 180 extern int zap_leaf_lookup(zap_leaf_t *l,
 181     struct zap_name *zn, zap_entry_handle_t *zeh);
 182 
 183 /*
 184  * Return a handle to the entry with this hash+cd, or the entry with the
 185  * next closest hash+cd.
 186  */
 187 extern int zap_leaf_lookup_closest(zap_leaf_t *l,
 188     uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh);
 189 
 190 /*
 191  * Read the first num_integers in the attribute.  Integer size
 192  * conversion will be done without sign extension.  Return EINVAL if
 193  * integer_size is too small.  Return EOVERFLOW if there are more than
 194  * num_integers in the attribute.
 195  */
 196 extern int zap_entry_read(const zap_entry_handle_t *zeh,
 197     uint8_t integer_size, uint64_t num_integers, void *buf);
 198 
 199 extern int zap_entry_read_name(struct zap *zap, const zap_entry_handle_t *zeh,
 200     uint16_t buflen, char *buf);
 201 
 202 /*
 203  * Replace the value of an existing entry.
 204  *
 205  * May fail if it runs out of space (ENOSPC).
 206  */
 207 extern int zap_entry_update(zap_entry_handle_t *zeh,
 208     uint8_t integer_size, uint64_t num_integers, const void *buf);
 209 
 210 /*
 211  * Remove an entry.
 212  */
 213 extern void zap_entry_remove(zap_entry_handle_t *zeh);
 214 
 215 /*
 216  * Create an entry. An equal entry must not exist, and this entry must
 217  * belong in this leaf (according to its hash value).  Fills in the
 218  * entry handle on success.  Returns 0 on success or ENOSPC on failure.
 219  */
 220 extern int zap_entry_create(zap_leaf_t *l, struct zap_name *zn, uint32_t cd,
 221     uint8_t integer_size, uint64_t num_integers, const void *buf,
 222     zap_entry_handle_t *zeh);
 223 
 224 /* Determine whether there is another entry with the same normalized form. */



 225 extern boolean_t zap_entry_normalization_conflict(zap_entry_handle_t *zeh,
 226     struct zap_name *zn, const char *name, struct zap *zap);
 227 
 228 /*
 229  * Other stuff.
 230  */
 231 
 232 extern void zap_leaf_init(zap_leaf_t *l, boolean_t sort);
 233 extern void zap_leaf_byteswap(zap_leaf_phys_t *buf, int len);
 234 extern void zap_leaf_split(zap_leaf_t *l, zap_leaf_t *nl, boolean_t sort);
 235 extern void zap_leaf_stats(struct zap *zap, zap_leaf_t *l,
 236     struct zap_stats *zs);
 237 
 238 #ifdef  __cplusplus
 239 }
 240 #endif
 241 
 242 #endif /* _SYS_ZAP_LEAF_H */