4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 #ifndef _SYS_ZAP_IMPL_H
27 #define _SYS_ZAP_IMPL_H
30 #include <sys/zfs_context.h>
37 extern int fzap_default_block_shift;
39 #define ZAP_MAGIC 0x2F52AB2ABULL
41 #define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_f.zap_block_shift)
43 #define ZAP_MAXCD (uint32_t)(-1)
44 #define ZAP_HASHBITS 28
45 #define MZAP_ENT_LEN 64
46 #define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2)
47 #define MZAP_MAX_BLKSHIFT SPA_MAXBLOCKSHIFT
48 #define MZAP_MAX_BLKSZ (1 << MZAP_MAX_BLKSHIFT)
50 typedef struct mzap_ent_phys {
53 uint16_t mze_pad; /* in case we want to chain them someday */
54 char mze_name[MZAP_NAME_LEN];
57 typedef struct mzap_phys {
58 uint64_t mz_block_type; /* ZBT_MICRO */
60 uint64_t mz_normflags;
62 mzap_ent_phys_t mz_chunk[1];
63 /* actually variable size depending on block size */
66 typedef struct mzap_ent {
70 mzap_ent_phys_t mze_phys;
75 * The (fat) zap is stored in one object. It is an array of
76 * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of:
78 * ptrtbl fits in first block:
79 * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ...
81 * ptrtbl too big for first block:
82 * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ...
89 #define ZBT_LEAF ((1ULL << 63) + 0)
90 #define ZBT_HEADER ((1ULL << 63) + 1)
91 #define ZBT_MICRO ((1ULL << 63) + 3)
92 /* any other values are ptrtbl blocks */
95 * the embedded pointer table takes up half a block:
96 * block size / entry size (2^3) / 2
98 #define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1)
101 * The embedded pointer table starts half-way through the block. Since
102 * the pointer table itself is half the block, it starts at (64-bit)
103 * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)).
105 #define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \
106 ((uint64_t *)(zap)->zap_f.zap_phys) \
107 [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))]
111 * If zap_phys_t is modified, zap_byteswap() must be modified.
113 typedef struct zap_phys {
114 uint64_t zap_block_type; /* ZBT_HEADER */
115 uint64_t zap_magic; /* ZAP_MAGIC */
117 struct zap_table_phys {
118 uint64_t zt_blk; /* starting block number */
119 uint64_t zt_numblks; /* number of blocks */
120 uint64_t zt_shift; /* bits to index it */
121 uint64_t zt_nextblk; /* next (larger) copy start block */
122 uint64_t zt_blks_copied; /* number source blocks copied */
125 uint64_t zap_freeblk; /* the next free block */
126 uint64_t zap_num_leafs; /* number of leafs */
127 uint64_t zap_num_entries; /* number of entries */
128 uint64_t zap_salt; /* salt to stir into hash function */
129 uint64_t zap_normflags; /* flags for u8_textprep_str() */
131 * This structure is followed by padding, and then the embedded
132 * pointer table. The embedded pointer table takes up second
133 * half of the block. It is accessed using the
134 * ZAP_EMBEDDED_PTRTBL_ENT() macro.
138 typedef struct zap_table_phys zap_table_phys_t;
141 objset_t *zap_objset;
143 struct dmu_buf *zap_dbuf;
144 krwlock_t zap_rwlock;
145 boolean_t zap_ismicro;
150 zap_phys_t *zap_phys;
153 * zap_num_entries_mtx protects
156 kmutex_t zap_num_entries_mtx;
160 mzap_phys_t *zap_phys;
161 int16_t zap_num_entries;
162 int16_t zap_num_chunks;
163 int16_t zap_alloc_next;
169 typedef struct zap_name {
171 const char *zn_name_orij;
173 matchtype_t zn_matchtype;
174 const char *zn_name_norm;
175 char zn_normbuf[ZAP_MAXNAMELEN];
178 #define zap_f zap_u.zap_fat
179 #define zap_m zap_u.zap_micro
181 boolean_t zap_match(zap_name_t *zn, const char *matchname);
182 int zap_lockdir(objset_t *os, uint64_t obj, dmu_tx_t *tx,
183 krw_t lti, boolean_t fatreader, boolean_t adding, zap_t **zapp);
184 void zap_unlockdir(zap_t *zap);
185 void zap_evict(dmu_buf_t *db, void *vmzap);
186 zap_name_t *zap_name_alloc(zap_t *zap, const char *name, matchtype_t mt);
187 void zap_name_free(zap_name_t *zn);
189 #define ZAP_HASH_IDX(hash, n) (((n) == 0) ? 0 : ((hash) >> (64 - (n))))
191 void fzap_byteswap(void *buf, size_t size);
192 int fzap_count(zap_t *zap, uint64_t *count);
193 int fzap_lookup(zap_name_t *zn,
194 uint64_t integer_size, uint64_t num_integers, void *buf,
195 char *realname, int rn_len, boolean_t *normalization_conflictp);
196 int fzap_count_write(zap_name_t *zn, int add, uint64_t *towrite,
197 uint64_t *tooverwrite);
198 int fzap_add(zap_name_t *zn, uint64_t integer_size, uint64_t num_integers,
199 const void *val, dmu_tx_t *tx);
200 int fzap_update(zap_name_t *zn,
201 int integer_size, uint64_t num_integers, const void *val, dmu_tx_t *tx);
202 int fzap_length(zap_name_t *zn,
203 uint64_t *integer_size, uint64_t *num_integers);
204 int fzap_remove(zap_name_t *zn, dmu_tx_t *tx);
205 int fzap_cursor_retrieve(zap_t *zap, zap_cursor_t *zc, zap_attribute_t *za);
206 void fzap_get_stats(zap_t *zap, zap_stats_t *zs);
207 void zap_put_leaf(struct zap_leaf *l);
209 int fzap_add_cd(zap_name_t *zn,
210 uint64_t integer_size, uint64_t num_integers,
211 const void *val, uint32_t cd, dmu_tx_t *tx);
212 void fzap_upgrade(zap_t *zap, dmu_tx_t *tx);
218 #endif /* _SYS_ZAP_IMPL_H */