1 /*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21 /*
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 */
24
25 #ifndef _SYS_ZAP_IMPL_H
26 #define _SYS_ZAP_IMPL_H
27
28 #include <sys/zap.h>
29 #include <sys/zfs_context.h>
30 #include <sys/avl.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 extern int fzap_default_block_shift;
37
38 #define ZAP_MAGIC 0x2F52AB2ABULL
39
40 #define FZAP_BLOCK_SHIFT(zap) ((zap)->zap_f.zap_block_shift)
41
42 #define MZAP_ENT_LEN 64
43 #define MZAP_NAME_LEN (MZAP_ENT_LEN - 8 - 4 - 2)
44 #define MZAP_MAX_BLKSHIFT SPA_MAXBLOCKSHIFT
45 #define MZAP_MAX_BLKSZ (1 << MZAP_MAX_BLKSHIFT)
46
47 #define ZAP_NEED_CD (-1U)
48
49 typedef struct mzap_ent_phys {
50 uint64_t mze_value;
51 uint32_t mze_cd;
52 uint16_t mze_pad; /* in case we want to chain them someday */
53 char mze_name[MZAP_NAME_LEN];
54 } mzap_ent_phys_t;
55
56 typedef struct mzap_phys {
57 uint64_t mz_block_type; /* ZBT_MICRO */
58 uint64_t mz_salt;
59 uint64_t mz_normflags;
60 uint64_t mz_pad[5];
61 mzap_ent_phys_t mz_chunk[1];
62 /* actually variable size depending on block size */
63 } mzap_phys_t;
64
65 typedef struct mzap_ent {
66 avl_node_t mze_node;
67 int mze_chunkid;
68 uint64_t mze_hash;
69 uint32_t mze_cd; /* copy from mze_phys->mze_cd */
70 } mzap_ent_t;
71
72 #define MZE_PHYS(zap, mze) \
73 (&(zap)->zap_m.zap_phys->mz_chunk[(mze)->mze_chunkid])
74
75 /*
76 * The (fat) zap is stored in one object. It is an array of
77 * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of:
78 *
79 * ptrtbl fits in first block:
80 * [zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ...
81 *
82 * ptrtbl too big for first block:
83 * [zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ...
84 *
85 */
86
87 struct dmu_buf;
88 struct zap_leaf;
89
90 #define ZBT_LEAF ((1ULL << 63) + 0)
91 #define ZBT_HEADER ((1ULL << 63) + 1)
92 #define ZBT_MICRO ((1ULL << 63) + 3)
93 /* any other values are ptrtbl blocks */
94
95 /*
96 * the embedded pointer table takes up half a block:
97 * block size / entry size (2^3) / 2
98 */
99 #define ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1)
100
101 /*
102 * The embedded pointer table starts half-way through the block. Since
103 * the pointer table itself is half the block, it starts at (64-bit)
104 * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)).
105 */
106 #define ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \
107 ((uint64_t *)(zap)->zap_f.zap_phys) \
108 [(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))]
109
110 /*
111 * TAKE NOTE:
112 * If zap_phys_t is modified, zap_byteswap() must be modified.
113 */
114 typedef struct zap_phys {
115 uint64_t zap_block_type; /* ZBT_HEADER */
116 uint64_t zap_magic; /* ZAP_MAGIC */
117
118 struct zap_table_phys {
119 uint64_t zt_blk; /* starting block number */
120 uint64_t zt_numblks; /* number of blocks */
121 uint64_t zt_shift; /* bits to index it */
122 uint64_t zt_nextblk; /* next (larger) copy start block */
123 uint64_t zt_blks_copied; /* number source blocks copied */
124 } zap_ptrtbl;
125
126 uint64_t zap_freeblk; /* the next free block */
127 uint64_t zap_num_leafs; /* number of leafs */
128 uint64_t zap_num_entries; /* number of entries */
129 uint64_t zap_salt; /* salt to stir into hash function */
130 uint64_t zap_normflags; /* flags for u8_textprep_str() */
131 uint64_t zap_flags; /* zap_flags_t */
132 /*
133 * This structure is followed by padding, and then the embedded
134 * pointer table. The embedded pointer table takes up second
135 * half of the block. It is accessed using the
136 * ZAP_EMBEDDED_PTRTBL_ENT() macro.
137 */
138 } zap_phys_t;
139
140 typedef struct zap_table_phys zap_table_phys_t;
141
142 typedef struct zap {
143 objset_t *zap_objset;
144 uint64_t zap_object;
145 struct dmu_buf *zap_dbuf;
146 krwlock_t zap_rwlock;
147 boolean_t zap_ismicro;
148 int zap_normflags;
149 uint64_t zap_salt;
150 union {
151 struct {
152 zap_phys_t *zap_phys;
153
154 /*
155 * zap_num_entries_mtx protects
156 * zap_num_entries
157 */
158 kmutex_t zap_num_entries_mtx;
159 int zap_block_shift;
160 } zap_fat;
161 struct {
162 mzap_phys_t *zap_phys;
163 int16_t zap_num_entries;
164 int16_t zap_num_chunks;
165 int16_t zap_alloc_next;
166 avl_tree_t zap_avl;
167 } zap_micro;
168 } zap_u;
169 } zap_t;
170
171 typedef struct zap_name {
172 zap_t *zn_zap;
173 int zn_key_intlen;
174 const void *zn_key_orig;
175 int zn_key_orig_numints;
176 const void *zn_key_norm;
177 int zn_key_norm_numints;
178 uint64_t zn_hash;
179 matchtype_t zn_matchtype;
180 char zn_normbuf[ZAP_MAXNAMELEN];
181 } zap_name_t;
182
183 #define zap_f zap_u.zap_fat
184 #define zap_m zap_u.zap_micro
185
186 boolean_t zap_match(zap_name_t *zn, const char *matchname);
187 int zap_lockdir(objset_t *os, uint64_t obj, dmu_tx_t *tx,
188 krw_t lti, boolean_t fatreader, boolean_t adding, zap_t **zapp);
189 void zap_unlockdir(zap_t *zap);
190 void zap_evict(dmu_buf_t *db, void *vmzap);
191 zap_name_t *zap_name_alloc(zap_t *zap, const char *key, matchtype_t mt);
192 void zap_name_free(zap_name_t *zn);
193 int zap_hashbits(zap_t *zap);
194 uint32_t zap_maxcd(zap_t *zap);
195 uint64_t zap_getflags(zap_t *zap);
196
197 #define ZAP_HASH_IDX(hash, n) (((n) == 0) ? 0 : ((hash) >> (64 - (n))))
198
199 void fzap_byteswap(void *buf, size_t size);
200 int fzap_count(zap_t *zap, uint64_t *count);
201 int fzap_lookup(zap_name_t *zn,
202 uint64_t integer_size, uint64_t num_integers, void *buf,
203 char *realname, int rn_len, boolean_t *normalization_conflictp);
204 void fzap_prefetch(zap_name_t *zn);
205 int fzap_count_write(zap_name_t *zn, int add, uint64_t *towrite,
206 uint64_t *tooverwrite);
207 int fzap_add(zap_name_t *zn, uint64_t integer_size, uint64_t num_integers,
208 const void *val, dmu_tx_t *tx);
209 int fzap_update(zap_name_t *zn,
210 int integer_size, uint64_t num_integers, const void *val, dmu_tx_t *tx);
211 int fzap_length(zap_name_t *zn,
212 uint64_t *integer_size, uint64_t *num_integers);
213 int fzap_remove(zap_name_t *zn, dmu_tx_t *tx);
214 int fzap_cursor_retrieve(zap_t *zap, zap_cursor_t *zc, zap_attribute_t *za);
215 void fzap_get_stats(zap_t *zap, zap_stats_t *zs);
216 void zap_put_leaf(struct zap_leaf *l);
217
218 int fzap_add_cd(zap_name_t *zn,
219 uint64_t integer_size, uint64_t num_integers,
220 const void *val, uint32_t cd, dmu_tx_t *tx);
221 void fzap_upgrade(zap_t *zap, dmu_tx_t *tx, zap_flags_t flags);
222 int fzap_cursor_move_to_key(zap_cursor_t *zc, zap_name_t *zn);
223
224 #ifdef __cplusplus
225 }
226 #endif
227
228 #endif /* _SYS_ZAP_IMPL_H */