1 /*
2  *  GRUB  --  GRand Unified Bootloader
3  *  Copyright (C) 1999,2000,2001,2002,2003,2004  Free Software Foundation, Inc.
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2 of the License, or
8  *  (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; if not, write to the Free Software
17  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19 /*
20  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
21  * Use is subject to license terms.
22  */
23 
24 #ifndef	_SYS_ZAP_IMPL_H
25 #define	_SYS_ZAP_IMPL_H
26 
27 #pragma ident	"%Z%%M%	%I%	%E% SMI"
28 
29 #define	ZAP_MAGIC 0x2F52AB2ABULL
30 
31 #define	ZAP_HASHBITS		28
32 #define	MZAP_ENT_LEN		64
33 #define	MZAP_NAME_LEN		(MZAP_ENT_LEN - 8 - 4 - 2)
34 #define	MZAP_MAX_BLKSHIFT	SPA_MAXBLOCKSHIFT
35 #define	MZAP_MAX_BLKSZ		(1 << MZAP_MAX_BLKSHIFT)
36 
37 typedef struct mzap_ent_phys {
38 	uint64_t mze_value;
39 	uint32_t mze_cd;
40 	uint16_t mze_pad;	/* in case we want to chain them someday */
41 	char mze_name[MZAP_NAME_LEN];
42 } mzap_ent_phys_t;
43 
44 typedef struct mzap_phys {
45 	uint64_t mz_block_type;	/* ZBT_MICRO */
46 	uint64_t mz_salt;
47 	uint64_t mz_pad[6];
48 	mzap_ent_phys_t mz_chunk[1];
49 	/* actually variable size depending on block size */
50 } mzap_phys_t;
51 
52 /*
53  * The (fat) zap is stored in one object. It is an array of
54  * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of:
55  *
56  * ptrtbl fits in first block:
57  * 	[zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ...
58  *
59  * ptrtbl too big for first block:
60  * 	[zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ...
61  *
62  */
63 
64 #define	ZBT_LEAF		((1ULL << 63) + 0)
65 #define	ZBT_HEADER		((1ULL << 63) + 1)
66 #define	ZBT_MICRO		((1ULL << 63) + 3)
67 /* any other values are ptrtbl blocks */
68 
69 /*
70  * the embedded pointer table takes up half a block:
71  * block size / entry size (2^3) / 2
72  */
73 #define	ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1)
74 
75 /*
76  * The embedded pointer table starts half-way through the block.  Since
77  * the pointer table itself is half the block, it starts at (64-bit)
78  * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)).
79  */
80 #define	ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \
81 	((uint64_t *)(zap)->zap_f.zap_phys) \
82 	[(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))]
83 
84 /*
85  * TAKE NOTE:
86  * If zap_phys_t is modified, zap_byteswap() must be modified.
87  */
88 typedef struct zap_phys {
89 	uint64_t zap_block_type;	/* ZBT_HEADER */
90 	uint64_t zap_magic;		/* ZAP_MAGIC */
91 
92 	struct zap_table_phys {
93 		uint64_t zt_blk;	/* starting block number */
94 		uint64_t zt_numblks;	/* number of blocks */
95 		uint64_t zt_shift;	/* bits to index it */
96 		uint64_t zt_nextblk;	/* next (larger) copy start block */
97 		uint64_t zt_blks_copied; /* number source blocks copied */
98 	} zap_ptrtbl;
99 
100 	uint64_t zap_freeblk;		/* the next free block */
101 	uint64_t zap_num_leafs;		/* number of leafs */
102 	uint64_t zap_num_entries;	/* number of entries */
103 	uint64_t zap_salt;		/* salt to stir into hash function */
104 	/*
105 	 * This structure is followed by padding, and then the embedded
106 	 * pointer table.  The embedded pointer table takes up second
107 	 * half of the block.  It is accessed using the
108 	 * ZAP_EMBEDDED_PTRTBL_ENT() macro.
109 	 */
110 } zap_phys_t;
111 
112 #endif /* _SYS_ZAP_IMPL_H */
113