[mirror_zfs.git] / include / sys / zap_leaf.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
 */

#ifndef	_SYS_ZAP_LEAF_H
#define	_SYS_ZAP_LEAF_H

#include <sys/zap.h>

#ifdef	__cplusplus
extern "C" {
#endif

struct zap;
struct zap_name;
struct zap_stats;

#define	ZAP_LEAF_MAGIC 0x2AB1EAF

/* chunk size = 24 bytes */
#define	ZAP_LEAF_CHUNKSIZE 24

/*
 * The amount of space available for chunks is:
 * block size (1<<l->l_bs) - hash entry size (2) * number of hash
 * entries - header space (2*chunksize)
 */
#define	ZAP_LEAF_NUMCHUNKS(l) \
	(((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \
	ZAP_LEAF_CHUNKSIZE - 2)

/*
 * The amount of space within the chunk available for the array is:
 * chunk size - space for type (1) - space for next pointer (2)
 */
#define	ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)

#define	ZAP_LEAF_ARRAY_NCHUNKS(bytes) \
	(((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES)

/*
 * Low water mark:  when there are only this many chunks free, start
 * growing the ptrtbl.  Ideally, this should be larger than a
 * "reasonably-sized" entry.  20 chunks is more than enough for the
 * largest directory entry (MAXNAMELEN (256) byte name, 8-byte value),
 * while still being only around 3% for 16k blocks.
 */
#define	ZAP_LEAF_LOW_WATER (20)

/*
 * The leaf hash table has block size / 2^5 (32) number of entries,
 * which should be more than enough for the maximum number of entries,
 * which is less than block size / CHUNKSIZE (24) / minimum number of
 * chunks per entry (3).
 */
#define	ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5)
#define	ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l))

/*
 * The chunks start immediately after the hash table.  The end of the
 * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a
 * chunk_t.
 */
#define	ZAP_LEAF_CHUNK(l, idx) \
	((zap_leaf_chunk_t *) \
	(zap_leaf_phys(l)->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx]
#define	ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry)

typedef enum zap_chunk_type {
	ZAP_CHUNK_FREE = 253,
	ZAP_CHUNK_ENTRY = 252,
	ZAP_CHUNK_ARRAY = 251,
	ZAP_CHUNK_TYPE_MAX = 250
} zap_chunk_type_t;

#define	ZLF_ENTRIES_CDSORTED (1<<0)

/*
 * TAKE NOTE:
 * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified.
 */
typedef struct zap_leaf_phys {
	struct zap_leaf_header {
		/* Public to ZAP */
		uint64_t lh_block_type;		/* ZBT_LEAF */
		uint64_t lh_pad1;
		uint64_t lh_prefix;		/* hash prefix of this leaf */
		uint32_t lh_magic;		/* ZAP_LEAF_MAGIC */
		uint16_t lh_nfree;		/* number free chunks */
		uint16_t lh_nentries;		/* number of entries */
		uint16_t lh_prefix_len;		/* num bits used to id this */

		/* Private to zap_leaf */
		uint16_t lh_freelist;		/* chunk head of free list */
		uint8_t lh_flags;		/* ZLF_* flags */
		uint8_t lh_pad2[11];
	} l_hdr; /* 2 24-byte chunks */

	/*
	 * The header is followed by a hash table with
	 * ZAP_LEAF_HASH_NUMENTRIES(zap) entries.  The hash table is
	 * followed by an array of ZAP_LEAF_NUMCHUNKS(zap)
	 * zap_leaf_chunk structures.  These structures are accessed
	 * with the ZAP_LEAF_CHUNK() macro.
	 */

	uint16_t l_hash[1];
} zap_leaf_phys_t;

typedef union zap_leaf_chunk {
	struct zap_leaf_entry {
		uint8_t le_type; 		/* always ZAP_CHUNK_ENTRY */
		uint8_t le_value_intlen;	/* size of value's ints */
		uint16_t le_next;		/* next entry in hash chain */
		uint16_t le_name_chunk;		/* first chunk of the name */
		uint16_t le_name_numints;	/* ints in name (incl null) */
		uint16_t le_value_chunk;	/* first chunk of the value */
		uint16_t le_value_numints;	/* value length in ints */
		uint32_t le_cd;			/* collision differentiator */
		uint64_t le_hash;		/* hash value of the name */
	} l_entry;
	struct zap_leaf_array {
		uint8_t la_type;		/* always ZAP_CHUNK_ARRAY */
		uint8_t la_array[ZAP_LEAF_ARRAY_BYTES];
		uint16_t la_next;		/* next blk or CHAIN_END */
	} l_array;
	struct zap_leaf_free {
		uint8_t lf_type;		/* always ZAP_CHUNK_FREE */
		uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES];
		uint16_t lf_next;	/* next in free list, or CHAIN_END */
	} l_free;
} zap_leaf_chunk_t;

typedef struct zap_leaf {
	dmu_buf_user_t l_dbu;
	krwlock_t l_rwlock;
	uint64_t l_blkid;		/* 1<<ZAP_BLOCK_SHIFT byte block off */
	int l_bs;			/* block size shift */
	dmu_buf_t *l_dbuf;
} zap_leaf_t;

static inline zap_leaf_phys_t *
zap_leaf_phys(zap_leaf_t *l)
{
	return (l->l_dbuf->db_data);
}

typedef struct zap_entry_handle {
	/* Set by zap_leaf and public to ZAP */
	uint64_t zeh_num_integers;
	uint64_t zeh_hash;
	uint32_t zeh_cd;
	uint8_t zeh_integer_size;

	/* Private to zap_leaf */
	uint16_t zeh_fakechunk;
	uint16_t *zeh_chunkp;
	zap_leaf_t *zeh_leaf;
} zap_entry_handle_t;

/*
 * Return a handle to the named entry, or ENOENT if not found.  The hash
 * value must equal zap_hash(name).
 */
extern int zap_leaf_lookup(zap_leaf_t *l,
    struct zap_name *zn, zap_entry_handle_t *zeh);

/*
 * Return a handle to the entry with this hash+cd, or the entry with the
 * next closest hash+cd.
 */
extern int zap_leaf_lookup_closest(zap_leaf_t *l,
    uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh);

/*
 * Read the first num_integers in the attribute.  Integer size
 * conversion will be done without sign extension.  Return EINVAL if
 * integer_size is too small.  Return EOVERFLOW if there are more than
 * num_integers in the attribute.
 */
extern int zap_entry_read(const zap_entry_handle_t *zeh,
    uint8_t integer_size, uint64_t num_integers, void *buf);

extern int zap_entry_read_name(struct zap *zap, const zap_entry_handle_t *zeh,
    uint16_t buflen, char *buf);

/*
 * Replace the value of an existing entry.
 *
 * May fail if it runs out of space (ENOSPC).
 */
extern int zap_entry_update(zap_entry_handle_t *zeh,
    uint8_t integer_size, uint64_t num_integers, const void *buf);

/*
 * Remove an entry.
 */
extern void zap_entry_remove(zap_entry_handle_t *zeh);

/*
 * Create an entry. An equal entry must not exist, and this entry must
 * belong in this leaf (according to its hash value).  Fills in the
 * entry handle on success.  Returns 0 on success or ENOSPC on failure.
 */
extern int zap_entry_create(zap_leaf_t *l, struct zap_name *zn, uint32_t cd,
    uint8_t integer_size, uint64_t num_integers, const void *buf,
    zap_entry_handle_t *zeh);

/* Determine whether there is another entry with the same normalized form. */
extern boolean_t zap_entry_normalization_conflict(zap_entry_handle_t *zeh,
    struct zap_name *zn, const char *name, struct zap *zap);

/*
 * Other stuff.
 */

extern void zap_leaf_init(zap_leaf_t *l, boolean_t sort);
extern void zap_leaf_byteswap(zap_leaf_phys_t *buf, int len);
extern void zap_leaf_split(zap_leaf_t *l, zap_leaf_t *nl, boolean_t sort);
extern void zap_leaf_stats(struct zap *zap, zap_leaf_t *l,
    struct zap_stats *zs);

#ifdef	__cplusplus
}
#endif

#endif /* _SYS_ZAP_LEAF_H */
Commit	Line	Data
34dc7c2f BB	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	/*
428870ff	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
0c66c32d	23	* Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
34dc7c2f BB	24	*/
	25
	26	#ifndef _SYS_ZAP_LEAF_H
	27	#define _SYS_ZAP_LEAF_H
	28
428870ff	29	#include <sys/zap.h>
34dc7c2f BB	30
	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
	35	struct zap;
428870ff BB	36	struct zap_name;
428870ff BB	37	struct zap_stats;
34dc7c2f BB	38
	39	#define ZAP_LEAF_MAGIC 0x2AB1EAF
	40
	41	/* chunk size = 24 bytes */
	42	#define ZAP_LEAF_CHUNKSIZE 24
	43
	44	/*
	45	* The amount of space available for chunks is:
	46	* block size (1<<l->l_bs) - hash entry size (2) * number of hash
	47	* entries - header space (2*chunksize)
	48	*/
	49	#define ZAP_LEAF_NUMCHUNKS(l) \
	50	(((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \
	51	ZAP_LEAF_CHUNKSIZE - 2)
	52
	53	/*
	54	* The amount of space within the chunk available for the array is:
	55	* chunk size - space for type (1) - space for next pointer (2)
	56	*/
	57	#define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)
	58
	59	#define ZAP_LEAF_ARRAY_NCHUNKS(bytes) \
	60	(((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES)
	61
	62	/*
	63	* Low water mark: when there are only this many chunks free, start
	64	* growing the ptrtbl. Ideally, this should be larger than a
	65	* "reasonably-sized" entry. 20 chunks is more than enough for the
	66	* largest directory entry (MAXNAMELEN (256) byte name, 8-byte value),
	67	* while still being only around 3% for 16k blocks.
	68	*/
	69	#define ZAP_LEAF_LOW_WATER (20)
	70
	71	/*
	72	* The leaf hash table has block size / 2^5 (32) number of entries,
	73	* which should be more than enough for the maximum number of entries,
	74	* which is less than block size / CHUNKSIZE (24) / minimum number of
	75	* chunks per entry (3).
	76	*/
	77	#define ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5)
	78	#define ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l))
	79
	80	/*
	81	* The chunks start immediately after the hash table. The end of the
	82	* hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a
	83	* chunk_t.
	84	*/
	85	#define ZAP_LEAF_CHUNK(l, idx) \
	86	((zap_leaf_chunk_t *) \
d683ddbb	87	(zap_leaf_phys(l)->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx]
34dc7c2f BB	88	#define ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry)
	89
	90	typedef enum zap_chunk_type {
	91	ZAP_CHUNK_FREE = 253,
	92	ZAP_CHUNK_ENTRY = 252,
	93	ZAP_CHUNK_ARRAY = 251,
	94	ZAP_CHUNK_TYPE_MAX = 250
	95	} zap_chunk_type_t;
	96
	97	#define ZLF_ENTRIES_CDSORTED (1<<0)
	98
	99	/*
	100	* TAKE NOTE:
	101	* If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified.
	102	*/
	103	typedef struct zap_leaf_phys {
	104	struct zap_leaf_header {
d3cc8b15	105	/* Public to ZAP */
34dc7c2f BB	106	uint64_t lh_block_type; /* ZBT_LEAF */
	107	uint64_t lh_pad1;
	108	uint64_t lh_prefix; /* hash prefix of this leaf */
	109	uint32_t lh_magic; /* ZAP_LEAF_MAGIC */
	110	uint16_t lh_nfree; /* number free chunks */
	111	uint16_t lh_nentries; /* number of entries */
	112	uint16_t lh_prefix_len; /* num bits used to id this */
	113
d3cc8b15	114	/* Private to zap_leaf */
34dc7c2f BB	115	uint16_t lh_freelist; /* chunk head of free list */
	116	uint8_t lh_flags; /* ZLF_* flags */
	117	uint8_t lh_pad2[11];
	118	} l_hdr; /* 2 24-byte chunks */
	119
	120	/*
	121	* The header is followed by a hash table with
	122	* ZAP_LEAF_HASH_NUMENTRIES(zap) entries. The hash table is
	123	* followed by an array of ZAP_LEAF_NUMCHUNKS(zap)
	124	* zap_leaf_chunk structures. These structures are accessed
	125	* with the ZAP_LEAF_CHUNK() macro.
	126	*/
	127
	128	uint16_t l_hash[1];
	129	} zap_leaf_phys_t;
	130
	131	typedef union zap_leaf_chunk {
	132	struct zap_leaf_entry {
	133	uint8_t le_type; /* always ZAP_CHUNK_ENTRY */
428870ff	134	uint8_t le_value_intlen; /* size of value's ints */
34dc7c2f BB	135	uint16_t le_next; /* next entry in hash chain */
34dc7c2f BB	136	uint16_t le_name_chunk; /* first chunk of the name */
428870ff	137	uint16_t le_name_numints; /* ints in name (incl null) */
34dc7c2f	138	uint16_t le_value_chunk; /* first chunk of the value */
428870ff	139	uint16_t le_value_numints; /* value length in ints */
34dc7c2f BB	140	uint32_t le_cd; /* collision differentiator */
	141	uint64_t le_hash; /* hash value of the name */
	142	} l_entry;
	143	struct zap_leaf_array {
	144	uint8_t la_type; /* always ZAP_CHUNK_ARRAY */
	145	uint8_t la_array[ZAP_LEAF_ARRAY_BYTES];
	146	uint16_t la_next; /* next blk or CHAIN_END */
	147	} l_array;
	148	struct zap_leaf_free {
	149	uint8_t lf_type; /* always ZAP_CHUNK_FREE */
	150	uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES];
	151	uint16_t lf_next; /* next in free list, or CHAIN_END */
	152	} l_free;
	153	} zap_leaf_chunk_t;
	154
	155	typedef struct zap_leaf {
0c66c32d	156	dmu_buf_user_t l_dbu;
b128c09f	157	krwlock_t l_rwlock;
34dc7c2f BB	158	uint64_t l_blkid; /* 1<<ZAP_BLOCK_SHIFT byte block off */
	159	int l_bs; /* block size shift */
	160	dmu_buf_t *l_dbuf;
34dc7c2f BB	161	} zap_leaf_t;
34dc7c2f BB	162
d683ddbb JG	163	static inline zap_leaf_phys_t *
	164	zap_leaf_phys(zap_leaf_t *l)
	165	{
	166	return (l->l_dbuf->db_data);
	167	}
34dc7c2f BB	168
34dc7c2f BB	169	typedef struct zap_entry_handle {
d3cc8b15	170	/* Set by zap_leaf and public to ZAP */
34dc7c2f BB	171	uint64_t zeh_num_integers;
	172	uint64_t zeh_hash;
	173	uint32_t zeh_cd;
	174	uint8_t zeh_integer_size;
	175
d3cc8b15	176	/* Private to zap_leaf */
34dc7c2f BB	177	uint16_t zeh_fakechunk;
	178	uint16_t *zeh_chunkp;
	179	zap_leaf_t *zeh_leaf;
	180	} zap_entry_handle_t;
	181
	182	/*
	183	* Return a handle to the named entry, or ENOENT if not found. The hash
	184	* value must equal zap_hash(name).
	185	*/
	186	extern int zap_leaf_lookup(zap_leaf_t *l,
428870ff	187	struct zap_name zn, zap_entry_handle_t zeh);
34dc7c2f BB	188
	189	/*
	190	* Return a handle to the entry with this hash+cd, or the entry with the
	191	* next closest hash+cd.
	192	*/
	193	extern int zap_leaf_lookup_closest(zap_leaf_t *l,
	194	uint64_t hash, uint32_t cd, zap_entry_handle_t *zeh);
	195
	196	/*
	197	* Read the first num_integers in the attribute. Integer size
	198	* conversion will be done without sign extension. Return EINVAL if
	199	* integer_size is too small. Return EOVERFLOW if there are more than
	200	* num_integers in the attribute.
	201	*/
	202	extern int zap_entry_read(const zap_entry_handle_t *zeh,
428870ff	203	uint8_t integer_size, uint64_t num_integers, void *buf);
34dc7c2f	204
428870ff BB	205	extern int zap_entry_read_name(struct zap zap, const zap_entry_handle_t zeh,
428870ff BB	206	uint16_t buflen, char *buf);
34dc7c2f BB	207
	208	/*
	209	* Replace the value of an existing entry.
	210	*
d3cc8b15	211	* May fail if it runs out of space (ENOSPC).
34dc7c2f BB	212	*/
34dc7c2f BB	213	extern int zap_entry_update(zap_entry_handle_t *zeh,
428870ff	214	uint8_t integer_size, uint64_t num_integers, const void *buf);
34dc7c2f BB	215
	216	/*
	217	* Remove an entry.
	218	*/
	219	extern void zap_entry_remove(zap_entry_handle_t *zeh);
	220
	221	/*
	222	* Create an entry. An equal entry must not exist, and this entry must
	223	* belong in this leaf (according to its hash value). Fills in the
	224	* entry handle on success. Returns 0 on success or ENOSPC on failure.
	225	*/
428870ff BB	226	extern int zap_entry_create(zap_leaf_t l, struct zap_name zn, uint32_t cd,
	227	uint8_t integer_size, uint64_t num_integers, const void *buf,
	228	zap_entry_handle_t *zeh);
34dc7c2f	229
d3cc8b15	230	/* Determine whether there is another entry with the same normalized form. */
34dc7c2f	231	extern boolean_t zap_entry_normalization_conflict(zap_entry_handle_t *zeh,
428870ff	232	struct zap_name zn, const char name, struct zap *zap);
34dc7c2f BB	233
	234	/*
	235	* Other stuff.
	236	*/
	237
	238	extern void zap_leaf_init(zap_leaf_t *l, boolean_t sort);
	239	extern void zap_leaf_byteswap(zap_leaf_phys_t *buf, int len);
	240	extern void zap_leaf_split(zap_leaf_t l, zap_leaf_t nl, boolean_t sort);
428870ff BB	241	extern void zap_leaf_stats(struct zap zap, zap_leaf_t l,
428870ff BB	242	struct zap_stats *zs);
34dc7c2f BB	243
	244	#ifdef __cplusplus
	245	}
	246	#endif
	247
	248	#endif /* _SYS_ZAP_LEAF_H */