Home | History | Annotate | Download | only in sys
      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 2007 Sun Microsystems, Inc.  All rights reserved.
     23  * Use is subject to license terms.
     24  */
     25 
     26 #ifndef	_SYS_ZAP_IMPL_H
     27 #define	_SYS_ZAP_IMPL_H
     28 
     29 #pragma ident	"@(#)zap_impl.h	1.9	07/10/30 SMI"
     30 
     31 #include <sys/zap.h>
     32 #include <sys/zfs_context.h>
     33 #include <sys/avl.h>
     34 
     35 #ifdef	__cplusplus
     36 extern "C" {
     37 #endif
     38 
     39 extern int fzap_default_block_shift;
     40 
     41 #define	ZAP_MAGIC 0x2F52AB2ABULL
     42 
     43 #define	FZAP_BLOCK_SHIFT(zap)	((zap)->zap_f.zap_block_shift)
     44 
     45 #define	ZAP_MAXCD		(uint32_t)(-1)
     46 #define	ZAP_HASHBITS		28
     47 #define	MZAP_ENT_LEN		64
     48 #define	MZAP_NAME_LEN		(MZAP_ENT_LEN - 8 - 4 - 2)
     49 #define	MZAP_MAX_BLKSHIFT	SPA_MAXBLOCKSHIFT
     50 #define	MZAP_MAX_BLKSZ		(1 << MZAP_MAX_BLKSHIFT)
     51 
     52 typedef struct mzap_ent_phys {
     53 	uint64_t mze_value;
     54 	uint32_t mze_cd;
     55 	uint16_t mze_pad;	/* in case we want to chain them someday */
     56 	char mze_name[MZAP_NAME_LEN];
     57 } mzap_ent_phys_t;
     58 
     59 typedef struct mzap_phys {
     60 	uint64_t mz_block_type;	/* ZBT_MICRO */
     61 	uint64_t mz_salt;
     62 	uint64_t mz_normflags;
     63 	uint64_t mz_pad[5];
     64 	mzap_ent_phys_t mz_chunk[1];
     65 	/* actually variable size depending on block size */
     66 } mzap_phys_t;
     67 
     68 typedef struct mzap_ent {
     69 	avl_node_t mze_node;
     70 	int mze_chunkid;
     71 	uint64_t mze_hash;
     72 	mzap_ent_phys_t mze_phys;
     73 } mzap_ent_t;
     74 
     75 
     76 /*
     77  * The (fat) zap is stored in one object. It is an array of
     78  * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of:
     79  *
     80  * ptrtbl fits in first block:
     81  * 	[zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ...
     82  *
     83  * ptrtbl too big for first block:
     84  * 	[zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ...
     85  *
     86  */
     87 
     88 struct dmu_buf;
     89 struct zap_leaf;
     90 
     91 #define	ZBT_LEAF		((1ULL << 63) + 0)
     92 #define	ZBT_HEADER		((1ULL << 63) + 1)
     93 #define	ZBT_MICRO		((1ULL << 63) + 3)
     94 /* any other values are ptrtbl blocks */
     95 
     96 /*
     97  * the embedded pointer table takes up half a block:
     98  * block size / entry size (2^3) / 2
     99  */
    100 #define	ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1)
    101 
    102 /*
    103  * The embedded pointer table starts half-way through the block.  Since
    104  * the pointer table itself is half the block, it starts at (64-bit)
    105  * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)).
    106  */
    107 #define	ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \
    108 	((uint64_t *)(zap)->zap_f.zap_phys) \
    109 	[(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))]
    110 
    111 /*
    112  * TAKE NOTE:
    113  * If zap_phys_t is modified, zap_byteswap() must be modified.
    114  */
    115 typedef struct zap_phys {
    116 	uint64_t zap_block_type;	/* ZBT_HEADER */
    117 	uint64_t zap_magic;		/* ZAP_MAGIC */
    118 
    119 	struct zap_table_phys {
    120 		uint64_t zt_blk;	/* starting block number */
    121 		uint64_t zt_numblks;	/* number of blocks */
    122 		uint64_t zt_shift;	/* bits to index it */
    123 		uint64_t zt_nextblk;	/* next (larger) copy start block */
    124 		uint64_t zt_blks_copied; /* number source blocks copied */
    125 	} zap_ptrtbl;
    126 
    127 	uint64_t zap_freeblk;		/* the next free block */
    128 	uint64_t zap_num_leafs;		/* number of leafs */
    129 	uint64_t zap_num_entries;	/* number of entries */
    130 	uint64_t zap_salt;		/* salt to stir into hash function */
    131 	uint64_t zap_normflags;		/* flags for u8_textprep_str() */
    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 	const char *zn_name_orij;
    174 	uint64_t zn_hash;
    175 	matchtype_t zn_matchtype;
    176 	const char *zn_name_norm;
    177 	char zn_normbuf[ZAP_MAXNAMELEN];
    178 } zap_name_t;
    179 
    180 #define	zap_f	zap_u.zap_fat
    181 #define	zap_m	zap_u.zap_micro
    182 
    183 boolean_t zap_match(zap_name_t *zn, const char *matchname);
    184 int zap_lockdir(objset_t *os, uint64_t obj, dmu_tx_t *tx,
    185     krw_t lti, boolean_t fatreader, boolean_t adding, zap_t **zapp);
    186 void zap_unlockdir(zap_t *zap);
    187 void zap_evict(dmu_buf_t *db, void *vmzap);
    188 zap_name_t *zap_name_alloc(zap_t *zap, const char *name, matchtype_t mt);
    189 void zap_name_free(zap_name_t *zn);
    190 
    191 #define	ZAP_HASH_IDX(hash, n) (((n) == 0) ? 0 : ((hash) >> (64 - (n))))
    192 
    193 void fzap_byteswap(void *buf, size_t size);
    194 int fzap_count(zap_t *zap, uint64_t *count);
    195 int fzap_lookup(zap_name_t *zn,
    196     uint64_t integer_size, uint64_t num_integers, void *buf,
    197     char *realname, int rn_len, boolean_t *normalization_conflictp);
    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);
    208 
    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);
    213 
    214 #ifdef	__cplusplus
    215 }
    216 #endif
    217 
    218 #endif /* _SYS_ZAP_IMPL_H */
    219