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