2 * GRUB -- GRand Unified Bootloader
3 * Copyright (C) 1999,2000,2001,2002,2003,2004,2009 Free Software Foundation, Inc.
4 * Copyright 2010 Sun Microsystems, Inc.
6 * GRUB is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef GRUB_ZFS_SPA_HEADER
21 #define GRUB_ZFS_SPA_HEADER 1
23 #define grub_zfs_to_cpu16(x,a) (((a) == GRUB_ZFS_BIG_ENDIAN) ? \
25 : grub_le_to_cpu16(x))
26 #define grub_cpu_to_zfs16(x,a) (((a) == GRUB_ZFS_BIG_ENDIAN) ? \
28 : grub_cpu_to_le16(x))
30 #define grub_zfs_to_cpu32(x,a) (((a) == GRUB_ZFS_BIG_ENDIAN) ? \
32 : grub_le_to_cpu32(x))
33 #define grub_cpu_to_zfs32(x,a) (((a) == GRUB_ZFS_BIG_ENDIAN) ? \
35 : grub_cpu_to_le32(x))
37 #define grub_zfs_to_cpu64(x,a) (((a) == GRUB_ZFS_BIG_ENDIAN) \
38 ? grub_be_to_cpu64(x) \
39 : grub_le_to_cpu64(x))
40 #define grub_cpu_to_zfs64(x,a) (((a) == GRUB_ZFS_BIG_ENDIAN) ? grub_cpu_to_be64(x) \
41 : grub_cpu_to_le64(x))
44 * General-purpose 32-bit and 64-bit bitfield encodings.
46 #define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len))
47 #define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len))
48 #define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low))
49 #define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low))
51 #define BF32_GET(x, low, len) BF32_DECODE(x, low, len)
52 #define BF64_GET(x, low, len) BF64_DECODE(x, low, len)
54 #define BF32_SET(x, low, len, val) \
55 ((x) ^= BF32_ENCODE((x >> low) ^ (val), low, len))
56 #define BF64_SET(x, low, len, val) \
57 ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len))
59 #define BF32_GET_SB(x, low, len, shift, bias) \
60 ((BF32_GET(x, low, len) + (bias)) << (shift))
61 #define BF64_GET_SB(x, low, len, shift, bias) \
62 ((BF64_GET(x, low, len) + (bias)) << (shift))
64 #define BF32_SET_SB(x, low, len, shift, bias, val) \
65 BF32_SET(x, low, len, ((val) >> (shift)) - (bias))
66 #define BF64_SET_SB(x, low, len, shift, bias, val) \
67 BF64_SET(x, low, len, ((val) >> (shift)) - (bias))
69 #define SPA_MINBLOCKSHIFT 9
70 #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT)
73 * Size of block to hold the configuration data (a packed nvlist)
75 #define SPA_CONFIG_BLOCKSIZE (1 << 14)
78 * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
79 * The ASIZE encoding should be at least 64 times larger (6 more bits)
80 * to support up to 4-way RAID-Z mirror mode with worst-case gang block
81 * overhead, three DVAs per bp, plus one more bit in case we do anything
82 * else that expands the ASIZE.
84 #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */
85 #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */
86 #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */
89 * All SPA data is represented by 128-bit data virtual addresses (DVAs).
90 * The members of the dva_t should be considered opaque outside the SPA.
93 grub_uint64_t dva_word
[2];
97 * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
99 typedef struct zio_cksum
{
102 grub_uint64_t zc_word
[4];
105 grub_uint32_t zc_cut_cksum
[5];
106 grub_uint32_t zc_mac
[3];
112 * Each block is described by its DVAs, time of birth, checksum, etc.
113 * The word-by-word, bit-by-bit layout of the blkptr is as follows:
115 * 64 56 48 40 32 24 16 8 0
116 * +-------+-------+-------+-------+-------+-------+-------+-------+
117 * 0 | vdev1 | GRID | ASIZE |
118 * +-------+-------+-------+-------+-------+-------+-------+-------+
120 * +-------+-------+-------+-------+-------+-------+-------+-------+
121 * 2 | vdev2 | GRID | ASIZE |
122 * +-------+-------+-------+-------+-------+-------+-------+-------+
124 * +-------+-------+-------+-------+-------+-------+-------+-------+
125 * 4 | vdev3 | GRID | ASIZE |
126 * +-------+-------+-------+-------+-------+-------+-------+-------+
128 * +-------+-------+-------+-------+-------+-------+-------+-------+
129 * 6 |BDX|lvl| type | cksum | comp | PSIZE | LSIZE |
130 * +-------+-------+-------+-------+-------+-------+-------+-------+
132 * +-------+-------+-------+-------+-------+-------+-------+-------+
134 * +-------+-------+-------+-------+-------+-------+-------+-------+
135 * 9 | physical birth txg |
136 * +-------+-------+-------+-------+-------+-------+-------+-------+
137 * a | logical birth txg |
138 * +-------+-------+-------+-------+-------+-------+-------+-------+
140 * +-------+-------+-------+-------+-------+-------+-------+-------+
142 * +-------+-------+-------+-------+-------+-------+-------+-------+
144 * +-------+-------+-------+-------+-------+-------+-------+-------+
146 * +-------+-------+-------+-------+-------+-------+-------+-------+
148 * +-------+-------+-------+-------+-------+-------+-------+-------+
152 * vdev virtual device ID
153 * offset offset into virtual device
155 * PSIZE physical size (after compression)
156 * ASIZE allocated size (including RAID-Z parity and gang block headers)
157 * GRID RAID-Z layout information (reserved for future use)
158 * cksum checksum function
159 * comp compression function
160 * G gang block indicator
161 * B byteorder (endianness)
164 * lvl level of indirection
165 * type DMU object type
166 * phys birth txg of block allocation; zero if same as logical birth txg
167 * log. birth transaction group in which the block was logically born
168 * fill count number of non-zero blocks under this bp
169 * checksum[4] 256-bit checksum of the data this bp describes
171 #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */
172 #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */
174 typedef struct blkptr
{
175 dva_t blk_dva
[SPA_DVAS_PER_BP
]; /* Data Virtual Addresses */
176 grub_uint64_t blk_prop
; /* size, compression, type, etc */
177 grub_uint64_t blk_pad
[2]; /* Extra space for the future */
178 grub_uint64_t blk_phys_birth
; /* txg when block was allocated */
179 grub_uint64_t blk_birth
; /* transaction group at birth */
180 grub_uint64_t blk_fill
; /* fill count */
181 zio_cksum_t blk_cksum
; /* 256-bit checksum */
185 * Macros to get and set fields in a bp or DVA.
187 #define DVA_GET_ASIZE(dva) \
188 BF64_GET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0)
189 #define DVA_SET_ASIZE(dva, x) \
190 BF64_SET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0, x)
192 #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8)
193 #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x)
195 #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32)
196 #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x)
198 #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1)
199 #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x)
201 #define BP_GET_LSIZE(bp) \
202 BF64_GET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1)
203 #define BP_SET_LSIZE(bp, x) \
204 BF64_SET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1, x)
206 #define BP_GET_COMPRESS(bp) BF64_GET((bp)->blk_prop, 32, 8)
207 #define BP_SET_COMPRESS(bp, x) BF64_SET((bp)->blk_prop, 32, 8, x)
209 #define BP_GET_CHECKSUM(bp) BF64_GET((bp)->blk_prop, 40, 8)
210 #define BP_SET_CHECKSUM(bp, x) BF64_SET((bp)->blk_prop, 40, 8, x)
212 #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8)
213 #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x)
215 #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5)
216 #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x)
218 #define BP_GET_PROP_BIT_61(bp) BF64_GET((bp)->blk_prop, 61, 1)
219 #define BP_SET_PROP_BIT_61(bp, x) BF64_SET((bp)->blk_prop, 61, 1, x)
221 #define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1)
222 #define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x)
224 #define BP_GET_BYTEORDER(bp) (0 - BF64_GET((bp)->blk_prop, 63, 1))
225 #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x)
227 #define BP_PHYSICAL_BIRTH(bp) \
228 ((bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
230 #define BP_SET_BIRTH(bp, logical, physical) \
232 (bp)->blk_birth = (logical); \
233 (bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
236 #define BP_GET_ASIZE(bp) \
237 (DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
238 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
240 #define BP_GET_UCSIZE(bp) \
241 ((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \
242 BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp));
244 #define BP_GET_NDVAS(bp) \
245 (!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
246 !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
247 !!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
249 #define BP_COUNT_GANG(bp) \
250 (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
251 DVA_GET_GANG(&(bp)->blk_dva[1]) + \
252 DVA_GET_GANG(&(bp)->blk_dva[2]))
254 #define DVA_EQUAL(dva1, dva2) \
255 ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
256 (dva1)->dva_word[0] == (dva2)->dva_word[0])
258 #define BP_EQUAL(bp1, bp2) \
259 (BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) && \
260 DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) && \
261 DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) && \
262 DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
264 #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \
265 (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
266 ((zc1).zc_word[1] - (zc2).zc_word[1]) | \
267 ((zc1).zc_word[2] - (zc2).zc_word[2]) | \
268 ((zc1).zc_word[3] - (zc2).zc_word[3])))
270 #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0)
272 #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \
274 (zcp)->zc_word[0] = w0; \
275 (zcp)->zc_word[1] = w1; \
276 (zcp)->zc_word[2] = w2; \
277 (zcp)->zc_word[3] = w3; \
280 #define BP_IDENTITY(bp) (&(bp)->blk_dva[0])
281 #define BP_IS_GANG(bp) DVA_GET_GANG(BP_IDENTITY(bp))
282 #define BP_IS_HOLE(bp) ((bp)->blk_birth == 0)
284 /* BP_IS_RAIDZ(bp) assumes no block compression */
285 #define BP_IS_RAIDZ(bp) (DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
288 #define BP_ZERO(bp) \
290 (bp)->blk_dva[0].dva_word[0] = 0; \
291 (bp)->blk_dva[0].dva_word[1] = 0; \
292 (bp)->blk_dva[1].dva_word[0] = 0; \
293 (bp)->blk_dva[1].dva_word[1] = 0; \
294 (bp)->blk_dva[2].dva_word[0] = 0; \
295 (bp)->blk_dva[2].dva_word[1] = 0; \
296 (bp)->blk_prop = 0; \
297 (bp)->blk_pad[0] = 0; \
298 (bp)->blk_pad[1] = 0; \
299 (bp)->blk_phys_birth = 0; \
300 (bp)->blk_birth = 0; \
301 (bp)->blk_fill = 0; \
302 ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
305 #define BP_SPRINTF_LEN 320
307 #endif /* ! GRUB_ZFS_SPA_HEADER */