xref: /openbmc/u-boot/include/zfs/zap_leaf.h (revision 4d3c95f5)
1*4d3c95f5SJorgen Lundman /*
2*4d3c95f5SJorgen Lundman  *  GRUB  --  GRand Unified Bootloader
3*4d3c95f5SJorgen Lundman  *  Copyright (C) 1999,2000,2001,2002,2003,2004  Free Software Foundation, Inc.
4*4d3c95f5SJorgen Lundman  *
5*4d3c95f5SJorgen Lundman  *  This program is free software; you can redistribute it and/or modify
6*4d3c95f5SJorgen Lundman  *  it under the terms of the GNU General Public License as published by
7*4d3c95f5SJorgen Lundman  *  the Free Software Foundation; either version 2 of the License, or
8*4d3c95f5SJorgen Lundman  *  (at your option) any later version.
9*4d3c95f5SJorgen Lundman  *
10*4d3c95f5SJorgen Lundman  *  This program is distributed in the hope that it will be useful,
11*4d3c95f5SJorgen Lundman  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12*4d3c95f5SJorgen Lundman  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13*4d3c95f5SJorgen Lundman  *  GNU General Public License for more details.
14*4d3c95f5SJorgen Lundman  *
15*4d3c95f5SJorgen Lundman  *  You should have received a copy of the GNU General Public License
16*4d3c95f5SJorgen Lundman  *  along with this program; if not, write to the Free Software
17*4d3c95f5SJorgen Lundman  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18*4d3c95f5SJorgen Lundman  */
19*4d3c95f5SJorgen Lundman /*
20*4d3c95f5SJorgen Lundman  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
21*4d3c95f5SJorgen Lundman  * Use is subject to license terms.
22*4d3c95f5SJorgen Lundman  */
23*4d3c95f5SJorgen Lundman 
24*4d3c95f5SJorgen Lundman #ifndef	_SYS_ZAP_LEAF_H
25*4d3c95f5SJorgen Lundman #define	_SYS_ZAP_LEAF_H
26*4d3c95f5SJorgen Lundman 
27*4d3c95f5SJorgen Lundman #define	ZAP_LEAF_MAGIC 0x2AB1EAF
28*4d3c95f5SJorgen Lundman 
29*4d3c95f5SJorgen Lundman /* chunk size = 24 bytes */
30*4d3c95f5SJorgen Lundman #define	ZAP_LEAF_CHUNKSIZE 24
31*4d3c95f5SJorgen Lundman 
32*4d3c95f5SJorgen Lundman /*
33*4d3c95f5SJorgen Lundman  * The amount of space within the chunk available for the array is:
34*4d3c95f5SJorgen Lundman  * chunk size - space for type (1) - space for next pointer (2)
35*4d3c95f5SJorgen Lundman  */
36*4d3c95f5SJorgen Lundman #define	ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)
37*4d3c95f5SJorgen Lundman 
38*4d3c95f5SJorgen Lundman typedef enum zap_chunk_type {
39*4d3c95f5SJorgen Lundman 	ZAP_CHUNK_FREE = 253,
40*4d3c95f5SJorgen Lundman 	ZAP_CHUNK_ENTRY = 252,
41*4d3c95f5SJorgen Lundman 	ZAP_CHUNK_ARRAY = 251,
42*4d3c95f5SJorgen Lundman 	ZAP_CHUNK_TYPE_MAX = 250
43*4d3c95f5SJorgen Lundman } zap_chunk_type_t;
44*4d3c95f5SJorgen Lundman 
45*4d3c95f5SJorgen Lundman /*
46*4d3c95f5SJorgen Lundman  * TAKE NOTE:
47*4d3c95f5SJorgen Lundman  * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified.
48*4d3c95f5SJorgen Lundman  */
49*4d3c95f5SJorgen Lundman typedef struct zap_leaf_phys {
50*4d3c95f5SJorgen Lundman 	struct zap_leaf_header {
51*4d3c95f5SJorgen Lundman 		uint64_t lh_block_type;		/* ZBT_LEAF */
52*4d3c95f5SJorgen Lundman 		uint64_t lh_pad1;
53*4d3c95f5SJorgen Lundman 		uint64_t lh_prefix;		/* hash prefix of this leaf */
54*4d3c95f5SJorgen Lundman 		uint32_t lh_magic;		/* ZAP_LEAF_MAGIC */
55*4d3c95f5SJorgen Lundman 		uint16_t lh_nfree;		/* number free chunks */
56*4d3c95f5SJorgen Lundman 		uint16_t lh_nentries;		/* number of entries */
57*4d3c95f5SJorgen Lundman 		uint16_t lh_prefix_len;		/* num bits used to id this */
58*4d3c95f5SJorgen Lundman 
59*4d3c95f5SJorgen Lundman 		/* above is accessable to zap, below is zap_leaf private */
60*4d3c95f5SJorgen Lundman 
61*4d3c95f5SJorgen Lundman 		uint16_t lh_freelist;		/* chunk head of free list */
62*4d3c95f5SJorgen Lundman 		uint8_t lh_pad2[12];
63*4d3c95f5SJorgen Lundman 	} l_hdr; /* 2 24-byte chunks */
64*4d3c95f5SJorgen Lundman 
65*4d3c95f5SJorgen Lundman 	/*
66*4d3c95f5SJorgen Lundman 	 * The header is followed by a hash table with
67*4d3c95f5SJorgen Lundman 	 * ZAP_LEAF_HASH_NUMENTRIES(zap) entries.  The hash table is
68*4d3c95f5SJorgen Lundman 	 * followed by an array of ZAP_LEAF_NUMCHUNKS(zap)
69*4d3c95f5SJorgen Lundman 	 * zap_leaf_chunk structures.  These structures are accessed
70*4d3c95f5SJorgen Lundman 	 * with the ZAP_LEAF_CHUNK() macro.
71*4d3c95f5SJorgen Lundman 	 */
72*4d3c95f5SJorgen Lundman 
73*4d3c95f5SJorgen Lundman 	uint16_t l_hash[1];
74*4d3c95f5SJorgen Lundman } zap_leaf_phys_t;
75*4d3c95f5SJorgen Lundman 
76*4d3c95f5SJorgen Lundman typedef union zap_leaf_chunk {
77*4d3c95f5SJorgen Lundman 	struct zap_leaf_entry {
78*4d3c95f5SJorgen Lundman 		uint8_t le_type;		/* always ZAP_CHUNK_ENTRY */
79*4d3c95f5SJorgen Lundman 		uint8_t le_int_size;		/* size of ints */
80*4d3c95f5SJorgen Lundman 		uint16_t le_next;		/* next entry in hash chain */
81*4d3c95f5SJorgen Lundman 		uint16_t le_name_chunk;		/* first chunk of the name */
82*4d3c95f5SJorgen Lundman 		uint16_t le_name_length;	/* bytes in name, incl null */
83*4d3c95f5SJorgen Lundman 		uint16_t le_value_chunk;	/* first chunk of the value */
84*4d3c95f5SJorgen Lundman 		uint16_t le_value_length;	/* value length in ints */
85*4d3c95f5SJorgen Lundman 		uint32_t le_cd;		/* collision differentiator */
86*4d3c95f5SJorgen Lundman 		uint64_t le_hash;		/* hash value of the name */
87*4d3c95f5SJorgen Lundman 	} l_entry;
88*4d3c95f5SJorgen Lundman 	struct zap_leaf_array {
89*4d3c95f5SJorgen Lundman 		uint8_t la_type;		/* always ZAP_CHUNK_ARRAY */
90*4d3c95f5SJorgen Lundman 		union {
91*4d3c95f5SJorgen Lundman 			uint8_t la_array[ZAP_LEAF_ARRAY_BYTES];
92*4d3c95f5SJorgen Lundman 			uint64_t la_array64;
93*4d3c95f5SJorgen Lundman 		} __attribute__ ((packed));
94*4d3c95f5SJorgen Lundman 		uint16_t la_next;		/* next blk or CHAIN_END */
95*4d3c95f5SJorgen Lundman 	} l_array;
96*4d3c95f5SJorgen Lundman 	struct zap_leaf_free {
97*4d3c95f5SJorgen Lundman 		uint8_t lf_type;		/* always ZAP_CHUNK_FREE */
98*4d3c95f5SJorgen Lundman 		uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES];
99*4d3c95f5SJorgen Lundman 		uint16_t lf_next;	/* next in free list, or CHAIN_END */
100*4d3c95f5SJorgen Lundman 	} l_free;
101*4d3c95f5SJorgen Lundman } zap_leaf_chunk_t;
102*4d3c95f5SJorgen Lundman 
103*4d3c95f5SJorgen Lundman #endif /* _SYS_ZAP_LEAF_H */
104