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, see <http://www.gnu.org/licenses/>.
17  */
18 /*
19  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
20  * Use is subject to license terms.
21  */
22 #ifndef _FSYS_ZFS_H
23 #define	_FSYS_ZFS_H
24 
25 #ifdef	FSYS_ZFS
26 
27 #ifndef	FSIMAGE
28 typedef unsigned long long uint64_t;
29 typedef unsigned int uint32_t;
30 typedef unsigned short uint16_t;
31 typedef unsigned char uint8_t;
32 typedef unsigned char uchar_t;
33 
34 #if defined(_LP64) || defined(_I32LPx)
35 typedef	unsigned long size_t;
36 #else
37 typedef	unsigned int size_t;
38 #endif
39 #else
40 #include "fsi_zfs.h"
41 #endif	/* !FSIMAGE */
42 
43 #include <zfs-include/zfs.h>
44 #include <zfs-include/dmu.h>
45 #include <zfs-include/spa.h>
46 #include <zfs-include/zio.h>
47 #include <zfs-include/zio_checksum.h>
48 #include <zfs-include/vdev_impl.h>
49 #include <zfs-include/zap_impl.h>
50 #include <zfs-include/zap_leaf.h>
51 #include <zfs-include/uberblock_impl.h>
52 #include <zfs-include/dnode.h>
53 #include <zfs-include/dsl_dir.h>
54 #include <zfs-include/zfs_acl.h>
55 #include <zfs-include/zfs_znode.h>
56 #include <zfs-include/dsl_dataset.h>
57 #include <zfs-include/zil.h>
58 #include <zfs-include/dmu_objset.h>
59 #include <zfs-include/sa_impl.h>
60 
61 /*
62  * Global Memory addresses to store MOS and DNODE data
63  */
64 #define	MOS		((dnode_phys_t *)\
65 	(RAW_ADDR((mbi.mem_upper << 10) + 0x100000) - ZFS_SCRATCH_SIZE))
66 #define	DNODE		(MOS+1) /* move sizeof(dnode_phys_t) bytes */
67 #define	ZFS_SCRATCH	((char *)(DNODE+1))
68 
69 /*
70  * Verify dnode type.
71  * Can only be used in functions returning non-0 for failure.
72  */
73 #define	VERIFY_DN_TYPE(dnp, type) \
74 	if ((type) != DMU_OT_NONE && (dnp)->dn_type != (type)) { \
75 		return (ERR_FSYS_CORRUPT); \
76 	}
77 
78 /*
79  * Verify object set type.
80  * Can only be used in functions returning 0 for failure.
81  */
82 #define	VERIFY_OS_TYPE(osp, type) \
83 	if ((type) != DMU_OST_NONE && (osp)->os_type != (type)) { \
84 		errnum = ERR_FSYS_CORRUPT; \
85 		return (0); \
86 	}
87 
88 #define	ZPOOL_PROP_BOOTFS		"bootfs"
89 
90 /* General macros */
91 #define	BSWAP_8(x)	((x) & 0xff)
92 #define	BSWAP_16(x)	((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8))
93 #define	BSWAP_32(x)	((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16))
94 #define	BSWAP_64(x)	((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32))
95 #define	P2ROUNDUP(x, align)	(-(-(x) & -(align)))
96 
97 /*
98  * XXX Match these macro up with real zfs once we have nvlist support so that we
99  * can support large sector disks.
100  */
101 #define	UBERBLOCK_SIZE		(1ULL << UBERBLOCK_SHIFT)
102 #define	VDEV_UBERBLOCK_SHIFT	UBERBLOCK_SHIFT
103 #include <stddef.h>
104 #define	VDEV_UBERBLOCK_OFFSET(n) \
105 offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT])
106 
107 typedef struct uberblock uberblock_t;
108 
109 /* XXX Uberblock_phys_t is no longer in the kernel zfs */
110 typedef struct uberblock_phys {
111 	uberblock_t	ubp_uberblock;
112 	char		ubp_pad[UBERBLOCK_SIZE - sizeof (uberblock_t) -
113 				sizeof (zio_eck_t)];
114 	zio_eck_t	ubp_zec;
115 } uberblock_phys_t;
116 
117 /*
118  * Macros to get fields in a bp or DVA.
119  */
120 #define	P2PHASE(x, align)		((x) & ((align) - 1))
121 #define	DVA_OFFSET_TO_PHYS_SECTOR(offset) \
122 	((offset + VDEV_LABEL_START_SIZE) >> SPA_MINBLOCKSHIFT)
123 
124 /*
125  * return x rounded down to an align boundary
126  * eg, P2ALIGN(1200, 1024) == 1024 (1*align)
127  * eg, P2ALIGN(1024, 1024) == 1024 (1*align)
128  * eg, P2ALIGN(0x1234, 0x100) == 0x1200 (0x12*align)
129  * eg, P2ALIGN(0x5600, 0x100) == 0x5600 (0x56*align)
130  */
131 #define	P2ALIGN(x, align)		((x) & -(align))
132 
133 /*
134  * For nvlist manipulation. (from nvpair.h)
135  */
136 #define	NV_ENCODE_NATIVE	0
137 #define	NV_ENCODE_XDR		1
138 #define	HOST_ENDIAN		1	/* for x86 machine */
139 #define	DATA_TYPE_UINT64	8
140 #define	DATA_TYPE_STRING	9
141 #define	DATA_TYPE_NVLIST	19
142 #define	DATA_TYPE_NVLIST_ARRAY	20
143 
144 /*
145  * Decompression Entry - lzjb
146  */
147 #ifndef	NBBY
148 #define	NBBY	8
149 #endif
150 
151 typedef int zfs_decomp_func_t(void *s_start, void *d_start, size_t s_len,
152 			size_t d_len);
153 typedef struct decomp_entry {
154 	char *name;
155 	zfs_decomp_func_t *decomp_func;
156 } decomp_entry_t;
157 
158 /*
159  * FAT ZAP data structures
160  */
161 #define	ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */
162 #define	ZAP_HASH_IDX(hash, n)	(((n) == 0) ? 0 : ((hash) >> (64 - (n))))
163 #define	CHAIN_END	0xffff	/* end of the chunk chain */
164 
165 /*
166  * The amount of space within the chunk available for the array is:
167  * chunk size - space for type (1) - space for next pointer (2)
168  */
169 #define	ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)
170 
171 #define	ZAP_LEAF_HASH_SHIFT(bs)	(bs - 5)
172 #define	ZAP_LEAF_HASH_NUMENTRIES(bs) (1 << ZAP_LEAF_HASH_SHIFT(bs))
173 #define	LEAF_HASH(bs, h) \
174 	((ZAP_LEAF_HASH_NUMENTRIES(bs)-1) & \
175 	((h) >> (64 - ZAP_LEAF_HASH_SHIFT(bs)-l->l_hdr.lh_prefix_len)))
176 
177 /*
178  * The amount of space available for chunks is:
179  * block size shift - hash entry size (2) * number of hash
180  * entries - header space (2*chunksize)
181  */
182 #define	ZAP_LEAF_NUMCHUNKS(bs) \
183 	(((1<<bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(bs)) / \
184 	ZAP_LEAF_CHUNKSIZE - 2)
185 
186 /*
187  * The chunks start immediately after the hash table.  The end of the
188  * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a
189  * chunk_t.
190  */
191 #define	ZAP_LEAF_CHUNK(l, bs, idx) \
192 	((zap_leaf_chunk_t *)(l->l_hash + ZAP_LEAF_HASH_NUMENTRIES(bs)))[idx]
193 #define	ZAP_LEAF_ENTRY(l, bs, idx) (&ZAP_LEAF_CHUNK(l, bs, idx).l_entry)
194 
195 extern void fletcher_2_native(const void *, uint64_t, zio_cksum_t *);
196 extern void fletcher_2_byteswap(const void *, uint64_t, zio_cksum_t *);
197 extern void fletcher_4_native(const void *, uint64_t, zio_cksum_t *);
198 extern void fletcher_4_byteswap(const void *, uint64_t, zio_cksum_t *);
199 extern void zio_checksum_SHA256(const void *, uint64_t, zio_cksum_t *);
200 extern int lzjb_decompress(void *, void *, size_t, size_t);
201 
202 #endif	/* FSYS_ZFS */
203 
204 #endif /* !_FSYS_ZFS_H */
205