xref: /titanic_54/usr/src/boot/sys/cddl/boot/zfs/zfsimpl.h (revision 376c1df2259df18a52137f7451f98953ffd01484)
14a5d661aSToomas Soome /*-
24a5d661aSToomas Soome  * Copyright (c) 2002 McAfee, Inc.
34a5d661aSToomas Soome  * All rights reserved.
44a5d661aSToomas Soome  *
54a5d661aSToomas Soome  * This software was developed for the FreeBSD Project by Marshall
64a5d661aSToomas Soome  * Kirk McKusick and McAfee Research,, the Security Research Division of
74a5d661aSToomas Soome  * McAfee, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as
84a5d661aSToomas Soome  * part of the DARPA CHATS research program
94a5d661aSToomas Soome  *
104a5d661aSToomas Soome  * Redistribution and use in source and binary forms, with or without
114a5d661aSToomas Soome  * modification, are permitted provided that the following conditions
124a5d661aSToomas Soome  * are met:
134a5d661aSToomas Soome  * 1. Redistributions of source code must retain the above copyright
144a5d661aSToomas Soome  *    notice, this list of conditions and the following disclaimer.
154a5d661aSToomas Soome  * 2. Redistributions in binary form must reproduce the above copyright
164a5d661aSToomas Soome  *    notice, this list of conditions and the following disclaimer in the
174a5d661aSToomas Soome  *    documentation and/or other materials provided with the distribution.
184a5d661aSToomas Soome  *
194a5d661aSToomas Soome  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
204a5d661aSToomas Soome  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
214a5d661aSToomas Soome  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
224a5d661aSToomas Soome  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
234a5d661aSToomas Soome  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
244a5d661aSToomas Soome  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
254a5d661aSToomas Soome  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
264a5d661aSToomas Soome  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
274a5d661aSToomas Soome  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
284a5d661aSToomas Soome  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
294a5d661aSToomas Soome  * SUCH DAMAGE.
304a5d661aSToomas Soome  */
314a5d661aSToomas Soome /*
324a5d661aSToomas Soome  * CDDL HEADER START
334a5d661aSToomas Soome  *
344a5d661aSToomas Soome  * The contents of this file are subject to the terms of the
354a5d661aSToomas Soome  * Common Development and Distribution License (the "License").
364a5d661aSToomas Soome  * You may not use this file except in compliance with the License.
374a5d661aSToomas Soome  *
384a5d661aSToomas Soome  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
394a5d661aSToomas Soome  * or http://www.opensolaris.org/os/licensing.
404a5d661aSToomas Soome  * See the License for the specific language governing permissions
414a5d661aSToomas Soome  * and limitations under the License.
424a5d661aSToomas Soome  *
434a5d661aSToomas Soome  * When distributing Covered Code, include this CDDL HEADER in each
444a5d661aSToomas Soome  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
454a5d661aSToomas Soome  * If applicable, add the following below this CDDL HEADER, with the
464a5d661aSToomas Soome  * fields enclosed by brackets "[]" replaced with your own identifying
474a5d661aSToomas Soome  * information: Portions Copyright [yyyy] [name of copyright owner]
484a5d661aSToomas Soome  *
494a5d661aSToomas Soome  * CDDL HEADER END
504a5d661aSToomas Soome  */
514a5d661aSToomas Soome /*
524a5d661aSToomas Soome  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
534a5d661aSToomas Soome  * Use is subject to license terms.
544a5d661aSToomas Soome  */
554a5d661aSToomas Soome /*
564a5d661aSToomas Soome  * Copyright 2013 by Saso Kiselkov. All rights reserved.
574a5d661aSToomas Soome  */
584a5d661aSToomas Soome /*
594a5d661aSToomas Soome  * Copyright (c) 2013 by Delphix. All rights reserved.
604a5d661aSToomas Soome  */
614a5d661aSToomas Soome 
624a5d661aSToomas Soome #define	MAXNAMELEN	256
634a5d661aSToomas Soome 
644a5d661aSToomas Soome #define _NOTE(s)
654a5d661aSToomas Soome 
664a5d661aSToomas Soome typedef enum { B_FALSE, B_TRUE } boolean_t;
674a5d661aSToomas Soome 
684a5d661aSToomas Soome /* CRC64 table */
694a5d661aSToomas Soome #define	ZFS_CRC64_POLY	0xC96C5795D7870F42ULL	/* ECMA-182, reflected form */
704a5d661aSToomas Soome 
714a5d661aSToomas Soome /*
724a5d661aSToomas Soome  * Macros for various sorts of alignment and rounding when the alignment
734a5d661aSToomas Soome  * is known to be a power of 2.
744a5d661aSToomas Soome  */
754a5d661aSToomas Soome #define	P2ALIGN(x, align)		((x) & -(align))
764a5d661aSToomas Soome #define	P2PHASE(x, align)		((x) & ((align) - 1))
774a5d661aSToomas Soome #define	P2NPHASE(x, align)		(-(x) & ((align) - 1))
784a5d661aSToomas Soome #define	P2ROUNDUP(x, align)		(-(-(x) & -(align)))
794a5d661aSToomas Soome #define	P2END(x, align)			(-(~(x) & -(align)))
804a5d661aSToomas Soome #define	P2PHASEUP(x, align, phase)	((phase) - (((phase) - (x)) & -(align)))
814a5d661aSToomas Soome #define	P2BOUNDARY(off, len, align)	(((off) ^ ((off) + (len) - 1)) > (align) - 1)
824a5d661aSToomas Soome 
834a5d661aSToomas Soome /*
844a5d661aSToomas Soome  * General-purpose 32-bit and 64-bit bitfield encodings.
854a5d661aSToomas Soome  */
864a5d661aSToomas Soome #define	BF32_DECODE(x, low, len)	P2PHASE((x) >> (low), 1U << (len))
874a5d661aSToomas Soome #define	BF64_DECODE(x, low, len)	P2PHASE((x) >> (low), 1ULL << (len))
884a5d661aSToomas Soome #define	BF32_ENCODE(x, low, len)	(P2PHASE((x), 1U << (len)) << (low))
894a5d661aSToomas Soome #define	BF64_ENCODE(x, low, len)	(P2PHASE((x), 1ULL << (len)) << (low))
904a5d661aSToomas Soome 
914a5d661aSToomas Soome #define	BF32_GET(x, low, len)		BF32_DECODE(x, low, len)
924a5d661aSToomas Soome #define	BF64_GET(x, low, len)		BF64_DECODE(x, low, len)
934a5d661aSToomas Soome 
944a5d661aSToomas Soome #define	BF32_SET(x, low, len, val)	\
954a5d661aSToomas Soome 	((x) ^= BF32_ENCODE((x >> low) ^ (val), low, len))
964a5d661aSToomas Soome #define	BF64_SET(x, low, len, val)	\
974a5d661aSToomas Soome 	((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len))
984a5d661aSToomas Soome 
994a5d661aSToomas Soome #define	BF32_GET_SB(x, low, len, shift, bias)	\
1004a5d661aSToomas Soome 	((BF32_GET(x, low, len) + (bias)) << (shift))
1014a5d661aSToomas Soome #define	BF64_GET_SB(x, low, len, shift, bias)	\
1024a5d661aSToomas Soome 	((BF64_GET(x, low, len) + (bias)) << (shift))
1034a5d661aSToomas Soome 
1044a5d661aSToomas Soome #define	BF32_SET_SB(x, low, len, shift, bias, val)	\
1054a5d661aSToomas Soome 	BF32_SET(x, low, len, ((val) >> (shift)) - (bias))
1064a5d661aSToomas Soome #define	BF64_SET_SB(x, low, len, shift, bias, val)	\
1074a5d661aSToomas Soome 	BF64_SET(x, low, len, ((val) >> (shift)) - (bias))
1084a5d661aSToomas Soome 
1094a5d661aSToomas Soome /*
1104a5d661aSToomas Soome  * Macros to reverse byte order
1114a5d661aSToomas Soome  */
1124a5d661aSToomas Soome #define	BSWAP_8(x)	((x) & 0xff)
1134a5d661aSToomas Soome #define	BSWAP_16(x)	((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8))
1144a5d661aSToomas Soome #define	BSWAP_32(x)	((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16))
1154a5d661aSToomas Soome #define	BSWAP_64(x)	((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32))
1164a5d661aSToomas Soome 
1174a5d661aSToomas Soome #define	SPA_MINBLOCKSHIFT	9
1184a5d661aSToomas Soome #define	SPA_OLDMAXBLOCKSHIFT	17
1194a5d661aSToomas Soome #define	SPA_MAXBLOCKSHIFT	24
1204a5d661aSToomas Soome #define	SPA_MINBLOCKSIZE	(1ULL << SPA_MINBLOCKSHIFT)
1214a5d661aSToomas Soome #define	SPA_OLDMAXBLOCKSIZE	(1ULL << SPA_OLDMAXBLOCKSHIFT)
1224a5d661aSToomas Soome #define	SPA_MAXBLOCKSIZE	(1ULL << SPA_MAXBLOCKSHIFT)
1234a5d661aSToomas Soome 
1244a5d661aSToomas Soome /*
1254a5d661aSToomas Soome  * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
1264a5d661aSToomas Soome  * The ASIZE encoding should be at least 64 times larger (6 more bits)
1274a5d661aSToomas Soome  * to support up to 4-way RAID-Z mirror mode with worst-case gang block
1284a5d661aSToomas Soome  * overhead, three DVAs per bp, plus one more bit in case we do anything
1294a5d661aSToomas Soome  * else that expands the ASIZE.
1304a5d661aSToomas Soome  */
1314a5d661aSToomas Soome #define	SPA_LSIZEBITS		16	/* LSIZE up to 32M (2^16 * 512)	*/
1324a5d661aSToomas Soome #define	SPA_PSIZEBITS		16	/* PSIZE up to 32M (2^16 * 512)	*/
1334a5d661aSToomas Soome #define	SPA_ASIZEBITS		24	/* ASIZE up to 64 times larger	*/
1344a5d661aSToomas Soome 
1354a5d661aSToomas Soome /*
1364a5d661aSToomas Soome  * All SPA data is represented by 128-bit data virtual addresses (DVAs).
1374a5d661aSToomas Soome  * The members of the dva_t should be considered opaque outside the SPA.
1384a5d661aSToomas Soome  */
1394a5d661aSToomas Soome typedef struct dva {
1404a5d661aSToomas Soome 	uint64_t	dva_word[2];
1414a5d661aSToomas Soome } dva_t;
1424a5d661aSToomas Soome 
1434a5d661aSToomas Soome /*
1444a5d661aSToomas Soome  * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
1454a5d661aSToomas Soome  */
1464a5d661aSToomas Soome typedef struct zio_cksum {
1474a5d661aSToomas Soome 	uint64_t	zc_word[4];
1484a5d661aSToomas Soome } zio_cksum_t;
1494a5d661aSToomas Soome 
1504a5d661aSToomas Soome /*
1514a5d661aSToomas Soome  * Some checksums/hashes need a 256-bit initialization salt. This salt is kept
1524a5d661aSToomas Soome  * secret and is suitable for use in MAC algorithms as the key.
1534a5d661aSToomas Soome  */
1544a5d661aSToomas Soome typedef struct zio_cksum_salt {
1554a5d661aSToomas Soome 	uint8_t		zcs_bytes[32];
1564a5d661aSToomas Soome } zio_cksum_salt_t;
1574a5d661aSToomas Soome 
1584a5d661aSToomas Soome /*
1594a5d661aSToomas Soome  * Each block is described by its DVAs, time of birth, checksum, etc.
1604a5d661aSToomas Soome  * The word-by-word, bit-by-bit layout of the blkptr is as follows:
1614a5d661aSToomas Soome  *
1624a5d661aSToomas Soome  *	64	56	48	40	32	24	16	8	0
1634a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1644a5d661aSToomas Soome  * 0	|		vdev1		| GRID  |	  ASIZE		|
1654a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1664a5d661aSToomas Soome  * 1	|G|			 offset1				|
1674a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1684a5d661aSToomas Soome  * 2	|		vdev2		| GRID  |	  ASIZE		|
1694a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1704a5d661aSToomas Soome  * 3	|G|			 offset2				|
1714a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1724a5d661aSToomas Soome  * 4	|		vdev3		| GRID  |	  ASIZE		|
1734a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1744a5d661aSToomas Soome  * 5	|G|			 offset3				|
1754a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1764a5d661aSToomas Soome  * 6	|BDX|lvl| type	| cksum |E| comp|    PSIZE	|     LSIZE	|
1774a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1784a5d661aSToomas Soome  * 7	|			padding					|
1794a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1804a5d661aSToomas Soome  * 8	|			padding					|
1814a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1824a5d661aSToomas Soome  * 9	|			physical birth txg			|
1834a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1844a5d661aSToomas Soome  * a	|			logical birth txg			|
1854a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1864a5d661aSToomas Soome  * b	|			fill count				|
1874a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1884a5d661aSToomas Soome  * c	|			checksum[0]				|
1894a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1904a5d661aSToomas Soome  * d	|			checksum[1]				|
1914a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1924a5d661aSToomas Soome  * e	|			checksum[2]				|
1934a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1944a5d661aSToomas Soome  * f	|			checksum[3]				|
1954a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
1964a5d661aSToomas Soome  *
1974a5d661aSToomas Soome  * Legend:
1984a5d661aSToomas Soome  *
1994a5d661aSToomas Soome  * vdev		virtual device ID
2004a5d661aSToomas Soome  * offset	offset into virtual device
2014a5d661aSToomas Soome  * LSIZE	logical size
2024a5d661aSToomas Soome  * PSIZE	physical size (after compression)
2034a5d661aSToomas Soome  * ASIZE	allocated size (including RAID-Z parity and gang block headers)
2044a5d661aSToomas Soome  * GRID		RAID-Z layout information (reserved for future use)
2054a5d661aSToomas Soome  * cksum	checksum function
2064a5d661aSToomas Soome  * comp		compression function
2074a5d661aSToomas Soome  * G		gang block indicator
2084a5d661aSToomas Soome  * B		byteorder (endianness)
2094a5d661aSToomas Soome  * D		dedup
2104a5d661aSToomas Soome  * X		encryption (on version 30, which is not supported)
2114a5d661aSToomas Soome  * E		blkptr_t contains embedded data (see below)
2124a5d661aSToomas Soome  * lvl		level of indirection
2134a5d661aSToomas Soome  * type		DMU object type
2144a5d661aSToomas Soome  * phys birth	txg of block allocation; zero if same as logical birth txg
2154a5d661aSToomas Soome  * log. birth	transaction group in which the block was logically born
2164a5d661aSToomas Soome  * fill count	number of non-zero blocks under this bp
2174a5d661aSToomas Soome  * checksum[4]	256-bit checksum of the data this bp describes
2184a5d661aSToomas Soome  */
2194a5d661aSToomas Soome 
2204a5d661aSToomas Soome /*
2214a5d661aSToomas Soome  * "Embedded" blkptr_t's don't actually point to a block, instead they
2224a5d661aSToomas Soome  * have a data payload embedded in the blkptr_t itself.  See the comment
2234a5d661aSToomas Soome  * in blkptr.c for more details.
2244a5d661aSToomas Soome  *
2254a5d661aSToomas Soome  * The blkptr_t is laid out as follows:
2264a5d661aSToomas Soome  *
2274a5d661aSToomas Soome  *	64	56	48	40	32	24	16	8	0
2284a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
2294a5d661aSToomas Soome  * 0	|      payload                                                  |
2304a5d661aSToomas Soome  * 1	|      payload                                                  |
2314a5d661aSToomas Soome  * 2	|      payload                                                  |
2324a5d661aSToomas Soome  * 3	|      payload                                                  |
2334a5d661aSToomas Soome  * 4	|      payload                                                  |
2344a5d661aSToomas Soome  * 5	|      payload                                                  |
2354a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
2364a5d661aSToomas Soome  * 6	|BDX|lvl| type	| etype |E| comp| PSIZE|              LSIZE	|
2374a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
2384a5d661aSToomas Soome  * 7	|      payload                                                  |
2394a5d661aSToomas Soome  * 8	|      payload                                                  |
2404a5d661aSToomas Soome  * 9	|      payload                                                  |
2414a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
2424a5d661aSToomas Soome  * a	|			logical birth txg			|
2434a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
2444a5d661aSToomas Soome  * b	|      payload                                                  |
2454a5d661aSToomas Soome  * c	|      payload                                                  |
2464a5d661aSToomas Soome  * d	|      payload                                                  |
2474a5d661aSToomas Soome  * e	|      payload                                                  |
2484a5d661aSToomas Soome  * f	|      payload                                                  |
2494a5d661aSToomas Soome  *	+-------+-------+-------+-------+-------+-------+-------+-------+
2504a5d661aSToomas Soome  *
2514a5d661aSToomas Soome  * Legend:
2524a5d661aSToomas Soome  *
2534a5d661aSToomas Soome  * payload		contains the embedded data
2544a5d661aSToomas Soome  * B (byteorder)	byteorder (endianness)
2554a5d661aSToomas Soome  * D (dedup)		padding (set to zero)
2564a5d661aSToomas Soome  * X			encryption (set to zero; see above)
2574a5d661aSToomas Soome  * E (embedded)		set to one
2584a5d661aSToomas Soome  * lvl			indirection level
2594a5d661aSToomas Soome  * type			DMU object type
2604a5d661aSToomas Soome  * etype		how to interpret embedded data (BP_EMBEDDED_TYPE_*)
2614a5d661aSToomas Soome  * comp			compression function of payload
2624a5d661aSToomas Soome  * PSIZE		size of payload after compression, in bytes
2634a5d661aSToomas Soome  * LSIZE		logical size of payload, in bytes
2644a5d661aSToomas Soome  *			note that 25 bits is enough to store the largest
2654a5d661aSToomas Soome  *			"normal" BP's LSIZE (2^16 * 2^9) in bytes
2664a5d661aSToomas Soome  * log. birth		transaction group in which the block was logically born
2674a5d661aSToomas Soome  *
2684a5d661aSToomas Soome  * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
2694a5d661aSToomas Soome  * bp's they are stored in units of SPA_MINBLOCKSHIFT.
2704a5d661aSToomas Soome  * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
2714a5d661aSToomas Soome  * The B, D, X, lvl, type, and comp fields are stored the same as with normal
2724a5d661aSToomas Soome  * BP's so the BP_SET_* macros can be used with them.  etype, PSIZE, LSIZE must
2734a5d661aSToomas Soome  * be set with the BPE_SET_* macros.  BP_SET_EMBEDDED() should be called before
2744a5d661aSToomas Soome  * other macros, as they assert that they are only used on BP's of the correct
2754a5d661aSToomas Soome  * "embedded-ness".
2764a5d661aSToomas Soome  */
2774a5d661aSToomas Soome 
2784a5d661aSToomas Soome #define	BPE_GET_ETYPE(bp)	\
2794a5d661aSToomas Soome 	(ASSERT(BP_IS_EMBEDDED(bp)), \
2804a5d661aSToomas Soome 	BF64_GET((bp)->blk_prop, 40, 8))
2814a5d661aSToomas Soome #define	BPE_SET_ETYPE(bp, t)	do { \
2824a5d661aSToomas Soome 	ASSERT(BP_IS_EMBEDDED(bp)); \
2834a5d661aSToomas Soome 	BF64_SET((bp)->blk_prop, 40, 8, t); \
2844a5d661aSToomas Soome _NOTE(CONSTCOND) } while (0)
2854a5d661aSToomas Soome 
2864a5d661aSToomas Soome #define	BPE_GET_LSIZE(bp)	\
2874a5d661aSToomas Soome 	(ASSERT(BP_IS_EMBEDDED(bp)), \
2884a5d661aSToomas Soome 	BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
2894a5d661aSToomas Soome #define	BPE_SET_LSIZE(bp, x)	do { \
2904a5d661aSToomas Soome 	ASSERT(BP_IS_EMBEDDED(bp)); \
2914a5d661aSToomas Soome 	BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
2924a5d661aSToomas Soome _NOTE(CONSTCOND) } while (0)
2934a5d661aSToomas Soome 
2944a5d661aSToomas Soome #define	BPE_GET_PSIZE(bp)	\
2954a5d661aSToomas Soome 	(ASSERT(BP_IS_EMBEDDED(bp)), \
2964a5d661aSToomas Soome 	BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
2974a5d661aSToomas Soome #define	BPE_SET_PSIZE(bp, x)	do { \
2984a5d661aSToomas Soome 	ASSERT(BP_IS_EMBEDDED(bp)); \
2994a5d661aSToomas Soome 	BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
3004a5d661aSToomas Soome _NOTE(CONSTCOND) } while (0)
3014a5d661aSToomas Soome 
3024a5d661aSToomas Soome typedef enum bp_embedded_type {
3034a5d661aSToomas Soome 	BP_EMBEDDED_TYPE_DATA,
3044a5d661aSToomas Soome 	BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */
3054a5d661aSToomas Soome 	NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED
3064a5d661aSToomas Soome } bp_embedded_type_t;
3074a5d661aSToomas Soome 
3084a5d661aSToomas Soome #define	BPE_NUM_WORDS 14
3094a5d661aSToomas Soome #define	BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
3104a5d661aSToomas Soome #define	BPE_IS_PAYLOADWORD(bp, wp) \
3114a5d661aSToomas Soome 	((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
3124a5d661aSToomas Soome 
3134a5d661aSToomas Soome #define	SPA_BLKPTRSHIFT	7		/* blkptr_t is 128 bytes	*/
3144a5d661aSToomas Soome #define	SPA_DVAS_PER_BP	3		/* Number of DVAs in a bp	*/
3154a5d661aSToomas Soome 
3164a5d661aSToomas Soome typedef struct blkptr {
3174a5d661aSToomas Soome 	dva_t		blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
3184a5d661aSToomas Soome 	uint64_t	blk_prop;	/* size, compression, type, etc	    */
3194a5d661aSToomas Soome 	uint64_t	blk_pad[2];	/* Extra space for the future	    */
3204a5d661aSToomas Soome 	uint64_t	blk_phys_birth;	/* txg when block was allocated	    */
3214a5d661aSToomas Soome 	uint64_t	blk_birth;	/* transaction group at birth	    */
3224a5d661aSToomas Soome 	uint64_t	blk_fill;	/* fill count			    */
3234a5d661aSToomas Soome 	zio_cksum_t	blk_cksum;	/* 256-bit checksum		    */
3244a5d661aSToomas Soome } blkptr_t;
3254a5d661aSToomas Soome 
3264a5d661aSToomas Soome /*
3274a5d661aSToomas Soome  * Macros to get and set fields in a bp or DVA.
3284a5d661aSToomas Soome  */
3294a5d661aSToomas Soome #define	DVA_GET_ASIZE(dva)	\
3304a5d661aSToomas Soome 	BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
3314a5d661aSToomas Soome #define	DVA_SET_ASIZE(dva, x)	\
3324a5d661aSToomas Soome 	BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
3334a5d661aSToomas Soome 	SPA_MINBLOCKSHIFT, 0, x)
3344a5d661aSToomas Soome 
3354a5d661aSToomas Soome #define	DVA_GET_GRID(dva)	BF64_GET((dva)->dva_word[0], 24, 8)
3364a5d661aSToomas Soome #define	DVA_SET_GRID(dva, x)	BF64_SET((dva)->dva_word[0], 24, 8, x)
3374a5d661aSToomas Soome 
3384a5d661aSToomas Soome #define	DVA_GET_VDEV(dva)	BF64_GET((dva)->dva_word[0], 32, 32)
3394a5d661aSToomas Soome #define	DVA_SET_VDEV(dva, x)	BF64_SET((dva)->dva_word[0], 32, 32, x)
3404a5d661aSToomas Soome 
3414a5d661aSToomas Soome #define	DVA_GET_OFFSET(dva)	\
3424a5d661aSToomas Soome 	BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
3434a5d661aSToomas Soome #define	DVA_SET_OFFSET(dva, x)	\
3444a5d661aSToomas Soome 	BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
3454a5d661aSToomas Soome 
3464a5d661aSToomas Soome #define	DVA_GET_GANG(dva)	BF64_GET((dva)->dva_word[1], 63, 1)
3474a5d661aSToomas Soome #define	DVA_SET_GANG(dva, x)	BF64_SET((dva)->dva_word[1], 63, 1, x)
3484a5d661aSToomas Soome 
3494a5d661aSToomas Soome #define	BP_GET_LSIZE(bp)	\
3504a5d661aSToomas Soome 	(BP_IS_EMBEDDED(bp) ?	\
3514a5d661aSToomas Soome 	(BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
3524a5d661aSToomas Soome 	BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
3534a5d661aSToomas Soome #define	BP_SET_LSIZE(bp, x)	do { \
3544a5d661aSToomas Soome 	ASSERT(!BP_IS_EMBEDDED(bp)); \
3554a5d661aSToomas Soome 	BF64_SET_SB((bp)->blk_prop, \
3564a5d661aSToomas Soome 	    0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
3574a5d661aSToomas Soome _NOTE(CONSTCOND) } while (0)
3584a5d661aSToomas Soome 
3594a5d661aSToomas Soome #define	BP_GET_PSIZE(bp)	\
3604a5d661aSToomas Soome 	BF64_GET_SB((bp)->blk_prop, 16, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1)
3614a5d661aSToomas Soome #define	BP_SET_PSIZE(bp, x)	\
3624a5d661aSToomas Soome 	BF64_SET_SB((bp)->blk_prop, 16, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x)
3634a5d661aSToomas Soome 
3644a5d661aSToomas Soome #define	BP_GET_COMPRESS(bp)	BF64_GET((bp)->blk_prop, 32, 7)
3654a5d661aSToomas Soome #define	BP_SET_COMPRESS(bp, x)	BF64_SET((bp)->blk_prop, 32, 7, x)
3664a5d661aSToomas Soome 
3674a5d661aSToomas Soome #define	BP_GET_CHECKSUM(bp)	BF64_GET((bp)->blk_prop, 40, 8)
3684a5d661aSToomas Soome #define	BP_SET_CHECKSUM(bp, x)	BF64_SET((bp)->blk_prop, 40, 8, x)
3694a5d661aSToomas Soome 
3704a5d661aSToomas Soome #define	BP_GET_TYPE(bp)		BF64_GET((bp)->blk_prop, 48, 8)
3714a5d661aSToomas Soome #define	BP_SET_TYPE(bp, x)	BF64_SET((bp)->blk_prop, 48, 8, x)
3724a5d661aSToomas Soome 
3734a5d661aSToomas Soome #define	BP_GET_LEVEL(bp)	BF64_GET((bp)->blk_prop, 56, 5)
3744a5d661aSToomas Soome #define	BP_SET_LEVEL(bp, x)	BF64_SET((bp)->blk_prop, 56, 5, x)
3754a5d661aSToomas Soome 
3764a5d661aSToomas Soome #define	BP_IS_EMBEDDED(bp)	BF64_GET((bp)->blk_prop, 39, 1)
3774a5d661aSToomas Soome 
3784a5d661aSToomas Soome #define	BP_GET_DEDUP(bp)	BF64_GET((bp)->blk_prop, 62, 1)
3794a5d661aSToomas Soome #define	BP_SET_DEDUP(bp, x)	BF64_SET((bp)->blk_prop, 62, 1, x)
3804a5d661aSToomas Soome 
3814a5d661aSToomas Soome #define	BP_GET_BYTEORDER(bp)	BF64_GET((bp)->blk_prop, 63, 1)
3824a5d661aSToomas Soome #define	BP_SET_BYTEORDER(bp, x)	BF64_SET((bp)->blk_prop, 63, 1, x)
3834a5d661aSToomas Soome 
3844a5d661aSToomas Soome #define	BP_PHYSICAL_BIRTH(bp)		\
3854a5d661aSToomas Soome 	((bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
3864a5d661aSToomas Soome 
3874a5d661aSToomas Soome #define	BP_GET_ASIZE(bp)	\
3884a5d661aSToomas Soome 	(DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
3894a5d661aSToomas Soome 		DVA_GET_ASIZE(&(bp)->blk_dva[2]))
3904a5d661aSToomas Soome 
3914a5d661aSToomas Soome #define	BP_GET_UCSIZE(bp) \
3924a5d661aSToomas Soome 	((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \
3934a5d661aSToomas Soome 	BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp));
3944a5d661aSToomas Soome 
3954a5d661aSToomas Soome #define	BP_GET_NDVAS(bp)	\
3964a5d661aSToomas Soome 	(!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
3974a5d661aSToomas Soome 	!!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
3984a5d661aSToomas Soome 	!!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
3994a5d661aSToomas Soome 
4004a5d661aSToomas Soome #define	DVA_EQUAL(dva1, dva2)	\
4014a5d661aSToomas Soome 	((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
4024a5d661aSToomas Soome 	(dva1)->dva_word[0] == (dva2)->dva_word[0])
4034a5d661aSToomas Soome 
4044a5d661aSToomas Soome #define	ZIO_CHECKSUM_EQUAL(zc1, zc2) \
4054a5d661aSToomas Soome 	(0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
4064a5d661aSToomas Soome 	((zc1).zc_word[1] - (zc2).zc_word[1]) | \
4074a5d661aSToomas Soome 	((zc1).zc_word[2] - (zc2).zc_word[2]) | \
4084a5d661aSToomas Soome 	((zc1).zc_word[3] - (zc2).zc_word[3])))
4094a5d661aSToomas Soome 
4104a5d661aSToomas Soome 
4114a5d661aSToomas Soome #define	DVA_IS_VALID(dva)	(DVA_GET_ASIZE(dva) != 0)
4124a5d661aSToomas Soome 
4134a5d661aSToomas Soome #define	ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3)	\
4144a5d661aSToomas Soome {						\
4154a5d661aSToomas Soome 	(zcp)->zc_word[0] = w0;			\
4164a5d661aSToomas Soome 	(zcp)->zc_word[1] = w1;			\
4174a5d661aSToomas Soome 	(zcp)->zc_word[2] = w2;			\
4184a5d661aSToomas Soome 	(zcp)->zc_word[3] = w3;			\
4194a5d661aSToomas Soome }
4204a5d661aSToomas Soome 
4214a5d661aSToomas Soome #define	BP_IDENTITY(bp)		(&(bp)->blk_dva[0])
4224a5d661aSToomas Soome #define	BP_IS_GANG(bp)		DVA_GET_GANG(BP_IDENTITY(bp))
4234a5d661aSToomas Soome #define	DVA_IS_EMPTY(dva)	((dva)->dva_word[0] == 0ULL &&  \
4244a5d661aSToomas Soome 	(dva)->dva_word[1] == 0ULL)
4254a5d661aSToomas Soome #define	BP_IS_HOLE(bp)		DVA_IS_EMPTY(BP_IDENTITY(bp))
4264a5d661aSToomas Soome #define	BP_IS_OLDER(bp, txg)	(!BP_IS_HOLE(bp) && (bp)->blk_birth < (txg))
4274a5d661aSToomas Soome 
4284a5d661aSToomas Soome #define	BP_ZERO(bp)				\
4294a5d661aSToomas Soome {						\
4304a5d661aSToomas Soome 	(bp)->blk_dva[0].dva_word[0] = 0;	\
4314a5d661aSToomas Soome 	(bp)->blk_dva[0].dva_word[1] = 0;	\
4324a5d661aSToomas Soome 	(bp)->blk_dva[1].dva_word[0] = 0;	\
4334a5d661aSToomas Soome 	(bp)->blk_dva[1].dva_word[1] = 0;	\
4344a5d661aSToomas Soome 	(bp)->blk_dva[2].dva_word[0] = 0;	\
4354a5d661aSToomas Soome 	(bp)->blk_dva[2].dva_word[1] = 0;	\
4364a5d661aSToomas Soome 	(bp)->blk_prop = 0;			\
4374a5d661aSToomas Soome 	(bp)->blk_pad[0] = 0;			\
4384a5d661aSToomas Soome 	(bp)->blk_pad[1] = 0;			\
4394a5d661aSToomas Soome 	(bp)->blk_phys_birth = 0;		\
4404a5d661aSToomas Soome 	(bp)->blk_birth = 0;			\
4414a5d661aSToomas Soome 	(bp)->blk_fill = 0;			\
4424a5d661aSToomas Soome 	ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0);	\
4434a5d661aSToomas Soome }
4444a5d661aSToomas Soome 
4454a5d661aSToomas Soome #define	BPE_NUM_WORDS 14
4464a5d661aSToomas Soome #define	BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
4474a5d661aSToomas Soome #define	BPE_IS_PAYLOADWORD(bp, wp) \
4484a5d661aSToomas Soome 	((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
4494a5d661aSToomas Soome 
4504a5d661aSToomas Soome /*
4514a5d661aSToomas Soome  * Embedded checksum
4524a5d661aSToomas Soome  */
4534a5d661aSToomas Soome #define	ZEC_MAGIC	0x210da7ab10c7a11ULL
4544a5d661aSToomas Soome 
4554a5d661aSToomas Soome typedef struct zio_eck {
4564a5d661aSToomas Soome 	uint64_t	zec_magic;	/* for validation, endianness	*/
4574a5d661aSToomas Soome 	zio_cksum_t	zec_cksum;	/* 256-bit checksum		*/
4584a5d661aSToomas Soome } zio_eck_t;
4594a5d661aSToomas Soome 
4604a5d661aSToomas Soome /*
4614a5d661aSToomas Soome  * Gang block headers are self-checksumming and contain an array
4624a5d661aSToomas Soome  * of block pointers.
4634a5d661aSToomas Soome  */
4644a5d661aSToomas Soome #define	SPA_GANGBLOCKSIZE	SPA_MINBLOCKSIZE
4654a5d661aSToomas Soome #define	SPA_GBH_NBLKPTRS	((SPA_GANGBLOCKSIZE - \
4664a5d661aSToomas Soome 	sizeof (zio_eck_t)) / sizeof (blkptr_t))
4674a5d661aSToomas Soome #define	SPA_GBH_FILLER		((SPA_GANGBLOCKSIZE - \
4684a5d661aSToomas Soome 	sizeof (zio_eck_t) - \
4694a5d661aSToomas Soome 	(SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
4704a5d661aSToomas Soome 	sizeof (uint64_t))
4714a5d661aSToomas Soome 
4724a5d661aSToomas Soome typedef struct zio_gbh {
4734a5d661aSToomas Soome 	blkptr_t		zg_blkptr[SPA_GBH_NBLKPTRS];
4744a5d661aSToomas Soome 	uint64_t		zg_filler[SPA_GBH_FILLER];
4754a5d661aSToomas Soome 	zio_eck_t		zg_tail;
4764a5d661aSToomas Soome } zio_gbh_phys_t;
4774a5d661aSToomas Soome 
4784a5d661aSToomas Soome #define	VDEV_RAIDZ_MAXPARITY	3
4794a5d661aSToomas Soome 
4804a5d661aSToomas Soome #define	VDEV_PAD_SIZE		(8 << 10)
4814a5d661aSToomas Soome /* 2 padding areas (vl_pad1 and vl_pad2) to skip */
4824a5d661aSToomas Soome #define	VDEV_SKIP_SIZE		VDEV_PAD_SIZE * 2
4834a5d661aSToomas Soome #define	VDEV_PHYS_SIZE		(112 << 10)
4844a5d661aSToomas Soome #define	VDEV_UBERBLOCK_RING	(128 << 10)
4854a5d661aSToomas Soome 
4864a5d661aSToomas Soome #define	VDEV_UBERBLOCK_SHIFT(vd)	\
4874a5d661aSToomas Soome 	MAX((vd)->v_top->v_ashift, UBERBLOCK_SHIFT)
4884a5d661aSToomas Soome #define	VDEV_UBERBLOCK_COUNT(vd)	\
4894a5d661aSToomas Soome 	(VDEV_UBERBLOCK_RING >> VDEV_UBERBLOCK_SHIFT(vd))
4904a5d661aSToomas Soome #define	VDEV_UBERBLOCK_OFFSET(vd, n)	\
4914a5d661aSToomas Soome 	offsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT(vd)])
4924a5d661aSToomas Soome #define	VDEV_UBERBLOCK_SIZE(vd)		(1ULL << VDEV_UBERBLOCK_SHIFT(vd))
4934a5d661aSToomas Soome 
4944a5d661aSToomas Soome typedef struct vdev_phys {
4954a5d661aSToomas Soome 	char		vp_nvlist[VDEV_PHYS_SIZE - sizeof (zio_eck_t)];
4964a5d661aSToomas Soome 	zio_eck_t	vp_zbt;
4974a5d661aSToomas Soome } vdev_phys_t;
4984a5d661aSToomas Soome 
4994a5d661aSToomas Soome typedef struct vdev_label {
5004a5d661aSToomas Soome 	char		vl_pad1[VDEV_PAD_SIZE];			/*  8K  */
5014a5d661aSToomas Soome 	char		vl_pad2[VDEV_PAD_SIZE];			/*  8K  */
5024a5d661aSToomas Soome 	vdev_phys_t	vl_vdev_phys;				/* 112K	*/
5034a5d661aSToomas Soome 	char		vl_uberblock[VDEV_UBERBLOCK_RING];	/* 128K	*/
5044a5d661aSToomas Soome } vdev_label_t;							/* 256K total */
5054a5d661aSToomas Soome 
5064a5d661aSToomas Soome /*
5074a5d661aSToomas Soome  * vdev_dirty() flags
5084a5d661aSToomas Soome  */
5094a5d661aSToomas Soome #define	VDD_METASLAB	0x01
5104a5d661aSToomas Soome #define	VDD_DTL		0x02
5114a5d661aSToomas Soome 
5124a5d661aSToomas Soome /*
5134a5d661aSToomas Soome  * Size and offset of embedded boot loader region on each label.
5144a5d661aSToomas Soome  * The total size of the first two labels plus the boot area is 4MB.
5154a5d661aSToomas Soome  */
5164a5d661aSToomas Soome #define	VDEV_BOOT_OFFSET	(2 * sizeof (vdev_label_t))
5174a5d661aSToomas Soome #define	VDEV_BOOT_SIZE		(7ULL << 19)			/* 3.5M	*/
5184a5d661aSToomas Soome 
5194a5d661aSToomas Soome /*
5204a5d661aSToomas Soome  * Size of label regions at the start and end of each leaf device.
5214a5d661aSToomas Soome  */
5224a5d661aSToomas Soome #define	VDEV_LABEL_START_SIZE	(2 * sizeof (vdev_label_t) + VDEV_BOOT_SIZE)
5234a5d661aSToomas Soome #define	VDEV_LABEL_END_SIZE	(2 * sizeof (vdev_label_t))
5244a5d661aSToomas Soome #define	VDEV_LABELS		4
5254a5d661aSToomas Soome 
5264a5d661aSToomas Soome enum zio_checksum {
5274a5d661aSToomas Soome 	ZIO_CHECKSUM_INHERIT = 0,
5284a5d661aSToomas Soome 	ZIO_CHECKSUM_ON,
5294a5d661aSToomas Soome 	ZIO_CHECKSUM_OFF,
5304a5d661aSToomas Soome 	ZIO_CHECKSUM_LABEL,
5314a5d661aSToomas Soome 	ZIO_CHECKSUM_GANG_HEADER,
5324a5d661aSToomas Soome 	ZIO_CHECKSUM_ZILOG,
5334a5d661aSToomas Soome 	ZIO_CHECKSUM_FLETCHER_2,
5344a5d661aSToomas Soome 	ZIO_CHECKSUM_FLETCHER_4,
5354a5d661aSToomas Soome 	ZIO_CHECKSUM_SHA256,
5364a5d661aSToomas Soome 	ZIO_CHECKSUM_ZILOG2,
5374a5d661aSToomas Soome 	ZIO_CHECKSUM_NOPARITY,
5384a5d661aSToomas Soome 	ZIO_CHECKSUM_SHA512,
5394a5d661aSToomas Soome 	ZIO_CHECKSUM_SKEIN,
5404a5d661aSToomas Soome 	ZIO_CHECKSUM_EDONR,
5414a5d661aSToomas Soome 	ZIO_CHECKSUM_FUNCTIONS
5424a5d661aSToomas Soome };
5434a5d661aSToomas Soome 
5444a5d661aSToomas Soome #define	ZIO_CHECKSUM_ON_VALUE	ZIO_CHECKSUM_FLETCHER_4
5454a5d661aSToomas Soome #define	ZIO_CHECKSUM_DEFAULT	ZIO_CHECKSUM_ON
5464a5d661aSToomas Soome 
5474a5d661aSToomas Soome enum zio_compress {
5484a5d661aSToomas Soome 	ZIO_COMPRESS_INHERIT = 0,
5494a5d661aSToomas Soome 	ZIO_COMPRESS_ON,
5504a5d661aSToomas Soome 	ZIO_COMPRESS_OFF,
5514a5d661aSToomas Soome 	ZIO_COMPRESS_LZJB,
5524a5d661aSToomas Soome 	ZIO_COMPRESS_EMPTY,
5534a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_1,
5544a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_2,
5554a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_3,
5564a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_4,
5574a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_5,
5584a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_6,
5594a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_7,
5604a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_8,
5614a5d661aSToomas Soome 	ZIO_COMPRESS_GZIP_9,
5624a5d661aSToomas Soome 	ZIO_COMPRESS_ZLE,
5634a5d661aSToomas Soome 	ZIO_COMPRESS_LZ4,
5644a5d661aSToomas Soome 	ZIO_COMPRESS_FUNCTIONS
5654a5d661aSToomas Soome };
5664a5d661aSToomas Soome 
5674a5d661aSToomas Soome #define	ZIO_COMPRESS_ON_VALUE	ZIO_COMPRESS_LZJB
5684a5d661aSToomas Soome #define	ZIO_COMPRESS_DEFAULT	ZIO_COMPRESS_OFF
5694a5d661aSToomas Soome 
5704a5d661aSToomas Soome /* nvlist pack encoding */
5714a5d661aSToomas Soome #define	NV_ENCODE_NATIVE	0
5724a5d661aSToomas Soome #define	NV_ENCODE_XDR		1
5734a5d661aSToomas Soome 
5744a5d661aSToomas Soome typedef enum {
5754a5d661aSToomas Soome 	DATA_TYPE_UNKNOWN = 0,
5764a5d661aSToomas Soome 	DATA_TYPE_BOOLEAN,
5774a5d661aSToomas Soome 	DATA_TYPE_BYTE,
5784a5d661aSToomas Soome 	DATA_TYPE_INT16,
5794a5d661aSToomas Soome 	DATA_TYPE_UINT16,
5804a5d661aSToomas Soome 	DATA_TYPE_INT32,
5814a5d661aSToomas Soome 	DATA_TYPE_UINT32,
5824a5d661aSToomas Soome 	DATA_TYPE_INT64,
5834a5d661aSToomas Soome 	DATA_TYPE_UINT64,
5844a5d661aSToomas Soome 	DATA_TYPE_STRING,
5854a5d661aSToomas Soome 	DATA_TYPE_BYTE_ARRAY,
5864a5d661aSToomas Soome 	DATA_TYPE_INT16_ARRAY,
5874a5d661aSToomas Soome 	DATA_TYPE_UINT16_ARRAY,
5884a5d661aSToomas Soome 	DATA_TYPE_INT32_ARRAY,
5894a5d661aSToomas Soome 	DATA_TYPE_UINT32_ARRAY,
5904a5d661aSToomas Soome 	DATA_TYPE_INT64_ARRAY,
5914a5d661aSToomas Soome 	DATA_TYPE_UINT64_ARRAY,
5924a5d661aSToomas Soome 	DATA_TYPE_STRING_ARRAY,
5934a5d661aSToomas Soome 	DATA_TYPE_HRTIME,
5944a5d661aSToomas Soome 	DATA_TYPE_NVLIST,
5954a5d661aSToomas Soome 	DATA_TYPE_NVLIST_ARRAY,
5964a5d661aSToomas Soome 	DATA_TYPE_BOOLEAN_VALUE,
5974a5d661aSToomas Soome 	DATA_TYPE_INT8,
5984a5d661aSToomas Soome 	DATA_TYPE_UINT8,
5994a5d661aSToomas Soome 	DATA_TYPE_BOOLEAN_ARRAY,
6004a5d661aSToomas Soome 	DATA_TYPE_INT8_ARRAY,
6014a5d661aSToomas Soome 	DATA_TYPE_UINT8_ARRAY
6024a5d661aSToomas Soome } data_type_t;
6034a5d661aSToomas Soome 
6044a5d661aSToomas Soome /*
6054a5d661aSToomas Soome  * On-disk version number.
6064a5d661aSToomas Soome  */
6074a5d661aSToomas Soome #define	SPA_VERSION_1			1ULL
6084a5d661aSToomas Soome #define	SPA_VERSION_2			2ULL
6094a5d661aSToomas Soome #define	SPA_VERSION_3			3ULL
6104a5d661aSToomas Soome #define	SPA_VERSION_4			4ULL
6114a5d661aSToomas Soome #define	SPA_VERSION_5			5ULL
6124a5d661aSToomas Soome #define	SPA_VERSION_6			6ULL
6134a5d661aSToomas Soome #define	SPA_VERSION_7			7ULL
6144a5d661aSToomas Soome #define	SPA_VERSION_8			8ULL
6154a5d661aSToomas Soome #define	SPA_VERSION_9			9ULL
6164a5d661aSToomas Soome #define	SPA_VERSION_10			10ULL
6174a5d661aSToomas Soome #define	SPA_VERSION_11			11ULL
6184a5d661aSToomas Soome #define	SPA_VERSION_12			12ULL
6194a5d661aSToomas Soome #define	SPA_VERSION_13			13ULL
6204a5d661aSToomas Soome #define	SPA_VERSION_14			14ULL
6214a5d661aSToomas Soome #define	SPA_VERSION_15			15ULL
6224a5d661aSToomas Soome #define	SPA_VERSION_16			16ULL
6234a5d661aSToomas Soome #define	SPA_VERSION_17			17ULL
6244a5d661aSToomas Soome #define	SPA_VERSION_18			18ULL
6254a5d661aSToomas Soome #define	SPA_VERSION_19			19ULL
6264a5d661aSToomas Soome #define	SPA_VERSION_20			20ULL
6274a5d661aSToomas Soome #define	SPA_VERSION_21			21ULL
6284a5d661aSToomas Soome #define	SPA_VERSION_22			22ULL
6294a5d661aSToomas Soome #define	SPA_VERSION_23			23ULL
6304a5d661aSToomas Soome #define	SPA_VERSION_24			24ULL
6314a5d661aSToomas Soome #define	SPA_VERSION_25			25ULL
6324a5d661aSToomas Soome #define	SPA_VERSION_26			26ULL
6334a5d661aSToomas Soome #define	SPA_VERSION_27			27ULL
6344a5d661aSToomas Soome #define	SPA_VERSION_28			28ULL
6354a5d661aSToomas Soome #define	SPA_VERSION_5000		5000ULL
6364a5d661aSToomas Soome 
6374a5d661aSToomas Soome /*
6384a5d661aSToomas Soome  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
6394a5d661aSToomas Soome  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
6404a5d661aSToomas Soome  * and do the appropriate changes.  Also bump the version number in
6414a5d661aSToomas Soome  * usr/src/grub/capability.
6424a5d661aSToomas Soome  */
6434a5d661aSToomas Soome #define	SPA_VERSION			SPA_VERSION_5000
6444a5d661aSToomas Soome #define	SPA_VERSION_STRING		"5000"
6454a5d661aSToomas Soome 
6464a5d661aSToomas Soome /*
6474a5d661aSToomas Soome  * Symbolic names for the changes that caused a SPA_VERSION switch.
6484a5d661aSToomas Soome  * Used in the code when checking for presence or absence of a feature.
6494a5d661aSToomas Soome  * Feel free to define multiple symbolic names for each version if there
6504a5d661aSToomas Soome  * were multiple changes to on-disk structures during that version.
6514a5d661aSToomas Soome  *
6524a5d661aSToomas Soome  * NOTE: When checking the current SPA_VERSION in your code, be sure
6534a5d661aSToomas Soome  *       to use spa_version() since it reports the version of the
6544a5d661aSToomas Soome  *       last synced uberblock.  Checking the in-flight version can
6554a5d661aSToomas Soome  *       be dangerous in some cases.
6564a5d661aSToomas Soome  */
6574a5d661aSToomas Soome #define	SPA_VERSION_INITIAL		SPA_VERSION_1
6584a5d661aSToomas Soome #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
6594a5d661aSToomas Soome #define	SPA_VERSION_SPARES		SPA_VERSION_3
6604a5d661aSToomas Soome #define	SPA_VERSION_RAID6		SPA_VERSION_3
6614a5d661aSToomas Soome #define	SPA_VERSION_BPLIST_ACCOUNT	SPA_VERSION_3
6624a5d661aSToomas Soome #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
6634a5d661aSToomas Soome #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
6644a5d661aSToomas Soome #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
6654a5d661aSToomas Soome #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
6664a5d661aSToomas Soome #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
6674a5d661aSToomas Soome #define	SPA_VERSION_SLOGS		SPA_VERSION_7
6684a5d661aSToomas Soome #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
6694a5d661aSToomas Soome #define	SPA_VERSION_FUID		SPA_VERSION_9
6704a5d661aSToomas Soome #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
6714a5d661aSToomas Soome #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
6724a5d661aSToomas Soome #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
6734a5d661aSToomas Soome #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
6744a5d661aSToomas Soome #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
6754a5d661aSToomas Soome #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
6764a5d661aSToomas Soome #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
6774a5d661aSToomas Soome #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
6784a5d661aSToomas Soome #define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13
6794a5d661aSToomas Soome #define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14
6804a5d661aSToomas Soome #define SPA_VERSION_USERSPACE		SPA_VERSION_15
6814a5d661aSToomas Soome #define	SPA_VERSION_STMF_PROP		SPA_VERSION_16
6824a5d661aSToomas Soome #define	SPA_VERSION_RAIDZ3		SPA_VERSION_17
6834a5d661aSToomas Soome #define	SPA_VERSION_USERREFS		SPA_VERSION_18
6844a5d661aSToomas Soome #define	SPA_VERSION_HOLES		SPA_VERSION_19
6854a5d661aSToomas Soome #define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20
6864a5d661aSToomas Soome #define	SPA_VERSION_DEDUP		SPA_VERSION_21
6874a5d661aSToomas Soome #define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22
6884a5d661aSToomas Soome #define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23
6894a5d661aSToomas Soome #define	SPA_VERSION_SA			SPA_VERSION_24
6904a5d661aSToomas Soome #define	SPA_VERSION_SCAN		SPA_VERSION_25
6914a5d661aSToomas Soome #define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26
6924a5d661aSToomas Soome #define	SPA_VERSION_DEADLISTS		SPA_VERSION_26
6934a5d661aSToomas Soome #define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27
6944a5d661aSToomas Soome #define	SPA_VERSION_MULTI_REPLACE	SPA_VERSION_28
6954a5d661aSToomas Soome #define	SPA_VERSION_BEFORE_FEATURES	SPA_VERSION_28
6964a5d661aSToomas Soome #define	SPA_VERSION_FEATURES		SPA_VERSION_5000
6974a5d661aSToomas Soome 
6984a5d661aSToomas Soome #define	SPA_VERSION_IS_SUPPORTED(v) \
6994a5d661aSToomas Soome 	(((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
7004a5d661aSToomas Soome 	((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
7014a5d661aSToomas Soome 
7024a5d661aSToomas Soome /*
7034a5d661aSToomas Soome  * The following are configuration names used in the nvlist describing a pool's
7044a5d661aSToomas Soome  * configuration.
7054a5d661aSToomas Soome  */
7064a5d661aSToomas Soome #define	ZPOOL_CONFIG_VERSION		"version"
7074a5d661aSToomas Soome #define	ZPOOL_CONFIG_POOL_NAME		"name"
7084a5d661aSToomas Soome #define	ZPOOL_CONFIG_POOL_STATE		"state"
7094a5d661aSToomas Soome #define	ZPOOL_CONFIG_POOL_TXG		"txg"
7104a5d661aSToomas Soome #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
7114a5d661aSToomas Soome #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
7124a5d661aSToomas Soome #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
7134a5d661aSToomas Soome #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
7144a5d661aSToomas Soome #define	ZPOOL_CONFIG_TYPE		"type"
7154a5d661aSToomas Soome #define	ZPOOL_CONFIG_CHILDREN		"children"
7164a5d661aSToomas Soome #define	ZPOOL_CONFIG_ID			"id"
7174a5d661aSToomas Soome #define	ZPOOL_CONFIG_GUID		"guid"
7184a5d661aSToomas Soome #define	ZPOOL_CONFIG_PATH		"path"
7194a5d661aSToomas Soome #define	ZPOOL_CONFIG_DEVID		"devid"
7204a5d661aSToomas Soome #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
7214a5d661aSToomas Soome #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
7224a5d661aSToomas Soome #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
7234a5d661aSToomas Soome #define	ZPOOL_CONFIG_ASHIFT		"ashift"
7244a5d661aSToomas Soome #define	ZPOOL_CONFIG_ASIZE		"asize"
7254a5d661aSToomas Soome #define	ZPOOL_CONFIG_DTL		"DTL"
7264a5d661aSToomas Soome #define	ZPOOL_CONFIG_STATS		"stats"
7274a5d661aSToomas Soome #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
7284a5d661aSToomas Soome #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
7294a5d661aSToomas Soome #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
7304a5d661aSToomas Soome #define	ZPOOL_CONFIG_SPARES		"spares"
7314a5d661aSToomas Soome #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
7324a5d661aSToomas Soome #define	ZPOOL_CONFIG_NPARITY		"nparity"
7334a5d661aSToomas Soome #define	ZPOOL_CONFIG_HOSTID		"hostid"
7344a5d661aSToomas Soome #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
7354a5d661aSToomas Soome #define	ZPOOL_CONFIG_IS_LOG		"is_log"
7364a5d661aSToomas Soome #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp" /* not stored on disk */
7374a5d661aSToomas Soome #define	ZPOOL_CONFIG_FEATURES_FOR_READ	"features_for_read"
7384a5d661aSToomas Soome 
7394a5d661aSToomas Soome /*
7404a5d661aSToomas Soome  * The persistent vdev state is stored as separate values rather than a single
7414a5d661aSToomas Soome  * 'vdev_state' entry.  This is because a device can be in multiple states, such
7424a5d661aSToomas Soome  * as offline and degraded.
7434a5d661aSToomas Soome  */
7444a5d661aSToomas Soome #define	ZPOOL_CONFIG_OFFLINE            "offline"
7454a5d661aSToomas Soome #define	ZPOOL_CONFIG_FAULTED            "faulted"
7464a5d661aSToomas Soome #define	ZPOOL_CONFIG_DEGRADED           "degraded"
7474a5d661aSToomas Soome #define	ZPOOL_CONFIG_REMOVED            "removed"
7484a5d661aSToomas Soome #define	ZPOOL_CONFIG_FRU		"fru"
7494a5d661aSToomas Soome #define	ZPOOL_CONFIG_AUX_STATE		"aux_state"
7504a5d661aSToomas Soome 
7514a5d661aSToomas Soome #define	VDEV_TYPE_ROOT			"root"
7524a5d661aSToomas Soome #define	VDEV_TYPE_MIRROR		"mirror"
7534a5d661aSToomas Soome #define	VDEV_TYPE_REPLACING		"replacing"
7544a5d661aSToomas Soome #define	VDEV_TYPE_RAIDZ			"raidz"
7554a5d661aSToomas Soome #define	VDEV_TYPE_DISK			"disk"
7564a5d661aSToomas Soome #define	VDEV_TYPE_FILE			"file"
7574a5d661aSToomas Soome #define	VDEV_TYPE_MISSING		"missing"
7584a5d661aSToomas Soome #define	VDEV_TYPE_HOLE			"hole"
7594a5d661aSToomas Soome #define	VDEV_TYPE_SPARE			"spare"
7604a5d661aSToomas Soome #define	VDEV_TYPE_LOG			"log"
7614a5d661aSToomas Soome #define	VDEV_TYPE_L2CACHE		"l2cache"
7624a5d661aSToomas Soome 
7634a5d661aSToomas Soome /*
7644a5d661aSToomas Soome  * This is needed in userland to report the minimum necessary device size.
7654a5d661aSToomas Soome  */
7664a5d661aSToomas Soome #define	SPA_MINDEVSIZE		(64ULL << 20)
7674a5d661aSToomas Soome 
7684a5d661aSToomas Soome /*
7694a5d661aSToomas Soome  * The location of the pool configuration repository, shared between kernel and
7704a5d661aSToomas Soome  * userland.
7714a5d661aSToomas Soome  */
7724a5d661aSToomas Soome #define	ZPOOL_CACHE		"/boot/zfs/zpool.cache"
7734a5d661aSToomas Soome 
7744a5d661aSToomas Soome /*
7754a5d661aSToomas Soome  * vdev states are ordered from least to most healthy.
7764a5d661aSToomas Soome  * A vdev that's CANT_OPEN or below is considered unusable.
7774a5d661aSToomas Soome  */
7784a5d661aSToomas Soome typedef enum vdev_state {
7794a5d661aSToomas Soome 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
7804a5d661aSToomas Soome 	VDEV_STATE_CLOSED,	/* Not currently open			*/
7814a5d661aSToomas Soome 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
7824a5d661aSToomas Soome 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
7834a5d661aSToomas Soome 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
7844a5d661aSToomas Soome 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
7854a5d661aSToomas Soome 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
7864a5d661aSToomas Soome 	VDEV_STATE_HEALTHY	/* Presumed good			*/
7874a5d661aSToomas Soome } vdev_state_t;
7884a5d661aSToomas Soome 
7894a5d661aSToomas Soome /*
7904a5d661aSToomas Soome  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
7914a5d661aSToomas Soome  * of the vdev stats structure uses these constants to distinguish why.
7924a5d661aSToomas Soome  */
7934a5d661aSToomas Soome typedef enum vdev_aux {
7944a5d661aSToomas Soome 	VDEV_AUX_NONE,		/* no error				*/
7954a5d661aSToomas Soome 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
7964a5d661aSToomas Soome 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
7974a5d661aSToomas Soome 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
7984a5d661aSToomas Soome 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
7994a5d661aSToomas Soome 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
8004a5d661aSToomas Soome 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
8014a5d661aSToomas Soome 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
8024a5d661aSToomas Soome 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
8034a5d661aSToomas Soome 	VDEV_AUX_SPARED		/* hot spare used in another pool	*/
8044a5d661aSToomas Soome } vdev_aux_t;
8054a5d661aSToomas Soome 
8064a5d661aSToomas Soome /*
8074a5d661aSToomas Soome  * pool state.  The following states are written to disk as part of the normal
8084a5d661aSToomas Soome  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE.  The remaining states are
8094a5d661aSToomas Soome  * software abstractions used at various levels to communicate pool state.
8104a5d661aSToomas Soome  */
8114a5d661aSToomas Soome typedef enum pool_state {
8124a5d661aSToomas Soome 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
8134a5d661aSToomas Soome 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
8144a5d661aSToomas Soome 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
8154a5d661aSToomas Soome 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
8164a5d661aSToomas Soome 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
8174a5d661aSToomas Soome 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
8184a5d661aSToomas Soome 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
8194a5d661aSToomas Soome } pool_state_t;
8204a5d661aSToomas Soome 
8214a5d661aSToomas Soome /*
8224a5d661aSToomas Soome  * The uberblock version is incremented whenever an incompatible on-disk
8234a5d661aSToomas Soome  * format change is made to the SPA, DMU, or ZAP.
8244a5d661aSToomas Soome  *
8254a5d661aSToomas Soome  * Note: the first two fields should never be moved.  When a storage pool
8264a5d661aSToomas Soome  * is opened, the uberblock must be read off the disk before the version
8274a5d661aSToomas Soome  * can be checked.  If the ub_version field is moved, we may not detect
8284a5d661aSToomas Soome  * version mismatch.  If the ub_magic field is moved, applications that
8294a5d661aSToomas Soome  * expect the magic number in the first word won't work.
8304a5d661aSToomas Soome  */
8314a5d661aSToomas Soome #define	UBERBLOCK_MAGIC		0x00bab10c		/* oo-ba-bloc!	*/
8324a5d661aSToomas Soome #define	UBERBLOCK_SHIFT		10			/* up to 1K	*/
8334a5d661aSToomas Soome 
8344a5d661aSToomas Soome struct uberblock {
8354a5d661aSToomas Soome 	uint64_t	ub_magic;	/* UBERBLOCK_MAGIC		*/
8364a5d661aSToomas Soome 	uint64_t	ub_version;	/* SPA_VERSION			*/
8374a5d661aSToomas Soome 	uint64_t	ub_txg;		/* txg of last sync		*/
8384a5d661aSToomas Soome 	uint64_t	ub_guid_sum;	/* sum of all vdev guids	*/
8394a5d661aSToomas Soome 	uint64_t	ub_timestamp;	/* UTC time of last sync	*/
8404a5d661aSToomas Soome 	blkptr_t	ub_rootbp;	/* MOS objset_phys_t		*/
8414a5d661aSToomas Soome };
8424a5d661aSToomas Soome 
8434a5d661aSToomas Soome /*
8444a5d661aSToomas Soome  * Flags.
8454a5d661aSToomas Soome  */
8464a5d661aSToomas Soome #define	DNODE_MUST_BE_ALLOCATED	1
8474a5d661aSToomas Soome #define	DNODE_MUST_BE_FREE	2
8484a5d661aSToomas Soome 
8494a5d661aSToomas Soome /*
8504a5d661aSToomas Soome  * Fixed constants.
8514a5d661aSToomas Soome  */
8524a5d661aSToomas Soome #define	DNODE_SHIFT		9	/* 512 bytes */
8534a5d661aSToomas Soome #define	DN_MIN_INDBLKSHIFT	12	/* 4k */
8544a5d661aSToomas Soome #define	DN_MAX_INDBLKSHIFT	14	/* 16k */
8554a5d661aSToomas Soome #define	DNODE_BLOCK_SHIFT	14	/* 16k */
8564a5d661aSToomas Soome #define	DNODE_CORE_SIZE		64	/* 64 bytes for dnode sans blkptrs */
8574a5d661aSToomas Soome #define	DN_MAX_OBJECT_SHIFT	48	/* 256 trillion (zfs_fid_t limit) */
8584a5d661aSToomas Soome #define	DN_MAX_OFFSET_SHIFT	64	/* 2^64 bytes in a dnode */
8594a5d661aSToomas Soome 
8604a5d661aSToomas Soome /*
8614a5d661aSToomas Soome  * Derived constants.
8624a5d661aSToomas Soome  */
863*376c1df2SToomas Soome #define	DNODE_MIN_SIZE		(1 << DNODE_SHIFT)
864*376c1df2SToomas Soome #define	DNODE_MAX_SIZE		(1 << DNODE_BLOCK_SHIFT)
865*376c1df2SToomas Soome #define	DNODE_BLOCK_SIZE	(1 << DNODE_BLOCK_SHIFT)
866*376c1df2SToomas Soome #define	DNODE_MIN_SLOTS		(DNODE_MIN_SIZE >> DNODE_SHIFT)
867*376c1df2SToomas Soome #define	DNODE_MAX_SLOTS		(DNODE_MAX_SIZE >> DNODE_SHIFT)
868*376c1df2SToomas Soome #define	DN_BONUS_SIZE(dnsize)	((dnsize) - DNODE_CORE_SIZE - \
869*376c1df2SToomas Soome 	(1 << SPA_BLKPTRSHIFT))
870*376c1df2SToomas Soome #define	DN_SLOTS_TO_BONUSLEN(slots)	DN_BONUS_SIZE((slots) << DNODE_SHIFT)
871*376c1df2SToomas Soome #define	DN_OLD_MAX_BONUSLEN		(DN_BONUS_SIZE(DNODE_MIN_SIZE))
872*376c1df2SToomas Soome #define	DN_MAX_NBLKPTR		((DNODE_MIN_SIZE - DNODE_CORE_SIZE) >> \
873*376c1df2SToomas Soome 	SPA_BLKPTRSHIFT)
8744a5d661aSToomas Soome #define	DN_MAX_OBJECT		(1ULL << DN_MAX_OBJECT_SHIFT)
875*376c1df2SToomas Soome #define	DN_ZERO_BONUSLEN	(DN_BONUS_SIZE(DNODE_MAX_SIZE) + 1)
8764a5d661aSToomas Soome 
8774a5d661aSToomas Soome #define	DNODES_PER_BLOCK_SHIFT	(DNODE_BLOCK_SHIFT - DNODE_SHIFT)
8784a5d661aSToomas Soome #define	DNODES_PER_BLOCK	(1ULL << DNODES_PER_BLOCK_SHIFT)
8794a5d661aSToomas Soome #define	DNODES_PER_LEVEL_SHIFT	(DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT)
8804a5d661aSToomas Soome 
8814a5d661aSToomas Soome /* The +2 here is a cheesy way to round up */
8824a5d661aSToomas Soome #define	DN_MAX_LEVELS	(2 + ((DN_MAX_OFFSET_SHIFT - SPA_MINBLOCKSHIFT) / \
8834a5d661aSToomas Soome 	(DN_MIN_INDBLKSHIFT - SPA_BLKPTRSHIFT)))
8844a5d661aSToomas Soome 
8854a5d661aSToomas Soome #define	DN_BONUS(dnp)	((void*)((dnp)->dn_bonus + \
8864a5d661aSToomas Soome 	(((dnp)->dn_nblkptr - 1) * sizeof (blkptr_t))))
8874a5d661aSToomas Soome 
8884a5d661aSToomas Soome #define	DN_USED_BYTES(dnp) (((dnp)->dn_flags & DNODE_FLAG_USED_BYTES) ? \
8894a5d661aSToomas Soome 	(dnp)->dn_used : (dnp)->dn_used << SPA_MINBLOCKSHIFT)
8904a5d661aSToomas Soome 
8914a5d661aSToomas Soome #define	EPB(blkshift, typeshift)	(1 << (blkshift - typeshift))
8924a5d661aSToomas Soome 
8934a5d661aSToomas Soome /* Is dn_used in bytes?  if not, it's in multiples of SPA_MINBLOCKSIZE */
8944a5d661aSToomas Soome #define	DNODE_FLAG_USED_BYTES		(1<<0)
8954a5d661aSToomas Soome #define	DNODE_FLAG_USERUSED_ACCOUNTED	(1<<1)
8964a5d661aSToomas Soome 
8974a5d661aSToomas Soome /* Does dnode have a SA spill blkptr in bonus? */
8984a5d661aSToomas Soome #define	DNODE_FLAG_SPILL_BLKPTR	(1<<2)
8994a5d661aSToomas Soome 
9004a5d661aSToomas Soome typedef struct dnode_phys {
9014a5d661aSToomas Soome 	uint8_t dn_type;		/* dmu_object_type_t */
9024a5d661aSToomas Soome 	uint8_t dn_indblkshift;		/* ln2(indirect block size) */
9034a5d661aSToomas Soome 	uint8_t dn_nlevels;		/* 1=dn_blkptr->data blocks */
9044a5d661aSToomas Soome 	uint8_t dn_nblkptr;		/* length of dn_blkptr */
9054a5d661aSToomas Soome 	uint8_t dn_bonustype;		/* type of data in bonus buffer */
9064a5d661aSToomas Soome 	uint8_t	dn_checksum;		/* ZIO_CHECKSUM type */
9074a5d661aSToomas Soome 	uint8_t	dn_compress;		/* ZIO_COMPRESS type */
9084a5d661aSToomas Soome 	uint8_t dn_flags;		/* DNODE_FLAG_* */
9094a5d661aSToomas Soome 	uint16_t dn_datablkszsec;	/* data block size in 512b sectors */
9104a5d661aSToomas Soome 	uint16_t dn_bonuslen;		/* length of dn_bonus */
911*376c1df2SToomas Soome 	uint8_t dn_extra_slots;		/* # of subsequent slots consumed */
912*376c1df2SToomas Soome 	uint8_t dn_pad2[3];
9134a5d661aSToomas Soome 
9144a5d661aSToomas Soome 	/* accounting is protected by dn_dirty_mtx */
9154a5d661aSToomas Soome 	uint64_t dn_maxblkid;		/* largest allocated block ID */
9164a5d661aSToomas Soome 	uint64_t dn_used;		/* bytes (or sectors) of disk space */
9174a5d661aSToomas Soome 
9184a5d661aSToomas Soome 	uint64_t dn_pad3[4];
9194a5d661aSToomas Soome 
920*376c1df2SToomas Soome 	/*
921*376c1df2SToomas Soome 	 * The tail region is 448 bytes for a 512 byte dnode, and
922*376c1df2SToomas Soome 	 * correspondingly larger for larger dnode sizes. The spill
923*376c1df2SToomas Soome 	 * block pointer, when present, is always at the end of the tail
924*376c1df2SToomas Soome 	 * region. There are three ways this space may be used, using
925*376c1df2SToomas Soome 	 * a 512 byte dnode for this diagram:
926*376c1df2SToomas Soome 	 *
927*376c1df2SToomas Soome 	 * 0       64      128     192     256     320     384     448 (offset)
928*376c1df2SToomas Soome 	 * +---------------+---------------+---------------+-------+
929*376c1df2SToomas Soome 	 * | dn_blkptr[0]  | dn_blkptr[1]  | dn_blkptr[2]  | /     |
930*376c1df2SToomas Soome 	 * +---------------+---------------+---------------+-------+
931*376c1df2SToomas Soome 	 * | dn_blkptr[0]  | dn_bonus[0..319]                      |
932*376c1df2SToomas Soome 	 * +---------------+-----------------------+---------------+
933*376c1df2SToomas Soome 	 * | dn_blkptr[0]  | dn_bonus[0..191]      | dn_spill      |
934*376c1df2SToomas Soome 	 * +---------------+-----------------------+---------------+
935*376c1df2SToomas Soome 	 */
936*376c1df2SToomas Soome 	union {
937*376c1df2SToomas Soome 		blkptr_t dn_blkptr[1+DN_OLD_MAX_BONUSLEN/sizeof (blkptr_t)];
938*376c1df2SToomas Soome 		struct {
939*376c1df2SToomas Soome 			blkptr_t __dn_ignore1;
940*376c1df2SToomas Soome 			uint8_t dn_bonus[DN_OLD_MAX_BONUSLEN];
941*376c1df2SToomas Soome 		};
942*376c1df2SToomas Soome 		struct {
943*376c1df2SToomas Soome 			blkptr_t __dn_ignore2;
944*376c1df2SToomas Soome 			uint8_t __dn_ignore3[DN_OLD_MAX_BONUSLEN -
945*376c1df2SToomas Soome 			    sizeof (blkptr_t)];
9464a5d661aSToomas Soome 			blkptr_t dn_spill;
947*376c1df2SToomas Soome 		};
948*376c1df2SToomas Soome 	};
9494a5d661aSToomas Soome } dnode_phys_t;
9504a5d661aSToomas Soome 
951*376c1df2SToomas Soome #define	DN_SPILL_BLKPTR(dnp)	(blkptr_t *)((char *)(dnp) + \
952*376c1df2SToomas Soome 	(((dnp)->dn_extra_slots + 1) << DNODE_SHIFT) - (1 << SPA_BLKPTRSHIFT))
953*376c1df2SToomas Soome 
9544a5d661aSToomas Soome typedef enum dmu_object_byteswap {
9554a5d661aSToomas Soome 	DMU_BSWAP_UINT8,
9564a5d661aSToomas Soome 	DMU_BSWAP_UINT16,
9574a5d661aSToomas Soome 	DMU_BSWAP_UINT32,
9584a5d661aSToomas Soome 	DMU_BSWAP_UINT64,
9594a5d661aSToomas Soome 	DMU_BSWAP_ZAP,
9604a5d661aSToomas Soome 	DMU_BSWAP_DNODE,
9614a5d661aSToomas Soome 	DMU_BSWAP_OBJSET,
9624a5d661aSToomas Soome 	DMU_BSWAP_ZNODE,
9634a5d661aSToomas Soome 	DMU_BSWAP_OLDACL,
9644a5d661aSToomas Soome 	DMU_BSWAP_ACL,
9654a5d661aSToomas Soome 	/*
9664a5d661aSToomas Soome 	 * Allocating a new byteswap type number makes the on-disk format
9674a5d661aSToomas Soome 	 * incompatible with any other format that uses the same number.
9684a5d661aSToomas Soome 	 *
9694a5d661aSToomas Soome 	 * Data can usually be structured to work with one of the
9704a5d661aSToomas Soome 	 * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types.
9714a5d661aSToomas Soome 	 */
9724a5d661aSToomas Soome 	DMU_BSWAP_NUMFUNCS
9734a5d661aSToomas Soome } dmu_object_byteswap_t;
9744a5d661aSToomas Soome 
9754a5d661aSToomas Soome #define	DMU_OT_NEWTYPE 0x80
9764a5d661aSToomas Soome #define	DMU_OT_METADATA 0x40
9774a5d661aSToomas Soome #define	DMU_OT_BYTESWAP_MASK 0x3f
9784a5d661aSToomas Soome 
9794a5d661aSToomas Soome /*
9804a5d661aSToomas Soome  * Defines a uint8_t object type. Object types specify if the data
9814a5d661aSToomas Soome  * in the object is metadata (boolean) and how to byteswap the data
9824a5d661aSToomas Soome  * (dmu_object_byteswap_t).
9834a5d661aSToomas Soome  */
9844a5d661aSToomas Soome #define	DMU_OT(byteswap, metadata) \
9854a5d661aSToomas Soome 	(DMU_OT_NEWTYPE | \
9864a5d661aSToomas Soome 	((metadata) ? DMU_OT_METADATA : 0) | \
9874a5d661aSToomas Soome 	((byteswap) & DMU_OT_BYTESWAP_MASK))
9884a5d661aSToomas Soome 
9894a5d661aSToomas Soome typedef enum dmu_object_type {
9904a5d661aSToomas Soome 	DMU_OT_NONE,
9914a5d661aSToomas Soome 	/* general: */
9924a5d661aSToomas Soome 	DMU_OT_OBJECT_DIRECTORY,	/* ZAP */
9934a5d661aSToomas Soome 	DMU_OT_OBJECT_ARRAY,		/* UINT64 */
9944a5d661aSToomas Soome 	DMU_OT_PACKED_NVLIST,		/* UINT8 (XDR by nvlist_pack/unpack) */
9954a5d661aSToomas Soome 	DMU_OT_PACKED_NVLIST_SIZE,	/* UINT64 */
9964a5d661aSToomas Soome 	DMU_OT_BPLIST,			/* UINT64 */
9974a5d661aSToomas Soome 	DMU_OT_BPLIST_HDR,		/* UINT64 */
9984a5d661aSToomas Soome 	/* spa: */
9994a5d661aSToomas Soome 	DMU_OT_SPACE_MAP_HEADER,	/* UINT64 */
10004a5d661aSToomas Soome 	DMU_OT_SPACE_MAP,		/* UINT64 */
10014a5d661aSToomas Soome 	/* zil: */
10024a5d661aSToomas Soome 	DMU_OT_INTENT_LOG,		/* UINT64 */
10034a5d661aSToomas Soome 	/* dmu: */
10044a5d661aSToomas Soome 	DMU_OT_DNODE,			/* DNODE */
10054a5d661aSToomas Soome 	DMU_OT_OBJSET,			/* OBJSET */
10064a5d661aSToomas Soome 	/* dsl: */
10074a5d661aSToomas Soome 	DMU_OT_DSL_DIR,			/* UINT64 */
10084a5d661aSToomas Soome 	DMU_OT_DSL_DIR_CHILD_MAP,	/* ZAP */
10094a5d661aSToomas Soome 	DMU_OT_DSL_DS_SNAP_MAP,		/* ZAP */
10104a5d661aSToomas Soome 	DMU_OT_DSL_PROPS,		/* ZAP */
10114a5d661aSToomas Soome 	DMU_OT_DSL_DATASET,		/* UINT64 */
10124a5d661aSToomas Soome 	/* zpl: */
10134a5d661aSToomas Soome 	DMU_OT_ZNODE,			/* ZNODE */
10144a5d661aSToomas Soome 	DMU_OT_OLDACL,			/* Old ACL */
10154a5d661aSToomas Soome 	DMU_OT_PLAIN_FILE_CONTENTS,	/* UINT8 */
10164a5d661aSToomas Soome 	DMU_OT_DIRECTORY_CONTENTS,	/* ZAP */
10174a5d661aSToomas Soome 	DMU_OT_MASTER_NODE,		/* ZAP */
10184a5d661aSToomas Soome 	DMU_OT_UNLINKED_SET,		/* ZAP */
10194a5d661aSToomas Soome 	/* zvol: */
10204a5d661aSToomas Soome 	DMU_OT_ZVOL,			/* UINT8 */
10214a5d661aSToomas Soome 	DMU_OT_ZVOL_PROP,		/* ZAP */
10224a5d661aSToomas Soome 	/* other; for testing only! */
10234a5d661aSToomas Soome 	DMU_OT_PLAIN_OTHER,		/* UINT8 */
10244a5d661aSToomas Soome 	DMU_OT_UINT64_OTHER,		/* UINT64 */
10254a5d661aSToomas Soome 	DMU_OT_ZAP_OTHER,		/* ZAP */
10264a5d661aSToomas Soome 	/* new object types: */
10274a5d661aSToomas Soome 	DMU_OT_ERROR_LOG,		/* ZAP */
10284a5d661aSToomas Soome 	DMU_OT_SPA_HISTORY,		/* UINT8 */
10294a5d661aSToomas Soome 	DMU_OT_SPA_HISTORY_OFFSETS,	/* spa_his_phys_t */
10304a5d661aSToomas Soome 	DMU_OT_POOL_PROPS,		/* ZAP */
10314a5d661aSToomas Soome 	DMU_OT_DSL_PERMS,		/* ZAP */
10324a5d661aSToomas Soome 	DMU_OT_ACL,			/* ACL */
10334a5d661aSToomas Soome 	DMU_OT_SYSACL,			/* SYSACL */
10344a5d661aSToomas Soome 	DMU_OT_FUID,			/* FUID table (Packed NVLIST UINT8) */
10354a5d661aSToomas Soome 	DMU_OT_FUID_SIZE,		/* FUID table size UINT64 */
10364a5d661aSToomas Soome 	DMU_OT_NEXT_CLONES,		/* ZAP */
10374a5d661aSToomas Soome 	DMU_OT_SCAN_QUEUE,		/* ZAP */
10384a5d661aSToomas Soome 	DMU_OT_USERGROUP_USED,		/* ZAP */
10394a5d661aSToomas Soome 	DMU_OT_USERGROUP_QUOTA,		/* ZAP */
10404a5d661aSToomas Soome 	DMU_OT_USERREFS,		/* ZAP */
10414a5d661aSToomas Soome 	DMU_OT_DDT_ZAP,			/* ZAP */
10424a5d661aSToomas Soome 	DMU_OT_DDT_STATS,		/* ZAP */
10434a5d661aSToomas Soome 	DMU_OT_SA,			/* System attr */
10444a5d661aSToomas Soome 	DMU_OT_SA_MASTER_NODE,		/* ZAP */
10454a5d661aSToomas Soome 	DMU_OT_SA_ATTR_REGISTRATION,	/* ZAP */
10464a5d661aSToomas Soome 	DMU_OT_SA_ATTR_LAYOUTS,		/* ZAP */
10474a5d661aSToomas Soome 	DMU_OT_SCAN_XLATE,		/* ZAP */
10484a5d661aSToomas Soome 	DMU_OT_DEDUP,			/* fake dedup BP from ddt_bp_create() */
10494a5d661aSToomas Soome 	DMU_OT_NUMTYPES,
10504a5d661aSToomas Soome 
10514a5d661aSToomas Soome 	/*
10524a5d661aSToomas Soome 	 * Names for valid types declared with DMU_OT().
10534a5d661aSToomas Soome 	 */
10544a5d661aSToomas Soome 	DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE),
10554a5d661aSToomas Soome 	DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE),
10564a5d661aSToomas Soome 	DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE),
10574a5d661aSToomas Soome 	DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE),
10584a5d661aSToomas Soome 	DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE),
10594a5d661aSToomas Soome 	DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE),
10604a5d661aSToomas Soome 	DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE),
10614a5d661aSToomas Soome 	DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE),
10624a5d661aSToomas Soome 	DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE),
10634a5d661aSToomas Soome 	DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE)
10644a5d661aSToomas Soome } dmu_object_type_t;
10654a5d661aSToomas Soome 
10664a5d661aSToomas Soome typedef enum dmu_objset_type {
10674a5d661aSToomas Soome 	DMU_OST_NONE,
10684a5d661aSToomas Soome 	DMU_OST_META,
10694a5d661aSToomas Soome 	DMU_OST_ZFS,
10704a5d661aSToomas Soome 	DMU_OST_ZVOL,
10714a5d661aSToomas Soome 	DMU_OST_OTHER,			/* For testing only! */
10724a5d661aSToomas Soome 	DMU_OST_ANY,			/* Be careful! */
10734a5d661aSToomas Soome 	DMU_OST_NUMTYPES
10744a5d661aSToomas Soome } dmu_objset_type_t;
10754a5d661aSToomas Soome 
10764a5d661aSToomas Soome /*
10774a5d661aSToomas Soome  * header for all bonus and spill buffers.
10784a5d661aSToomas Soome  * The header has a fixed portion with a variable number
10794a5d661aSToomas Soome  * of "lengths" depending on the number of variable sized
10804a5d661aSToomas Soome  * attribues which are determined by the "layout number"
10814a5d661aSToomas Soome  */
10824a5d661aSToomas Soome 
10834a5d661aSToomas Soome #define	SA_MAGIC	0x2F505A  /* ZFS SA */
10844a5d661aSToomas Soome typedef struct sa_hdr_phys {
10854a5d661aSToomas Soome 	uint32_t sa_magic;
10864a5d661aSToomas Soome 	uint16_t sa_layout_info;  /* Encoded with hdrsize and layout number */
10874a5d661aSToomas Soome 	uint16_t sa_lengths[1];	/* optional sizes for variable length attrs */
10884a5d661aSToomas Soome 	/* ... Data follows the lengths.  */
10894a5d661aSToomas Soome } sa_hdr_phys_t;
10904a5d661aSToomas Soome 
10914a5d661aSToomas Soome /*
10924a5d661aSToomas Soome  * sa_hdr_phys -> sa_layout_info
10934a5d661aSToomas Soome  *
10944a5d661aSToomas Soome  * 16      10       0
10954a5d661aSToomas Soome  * +--------+-------+
10964a5d661aSToomas Soome  * | hdrsz  |layout |
10974a5d661aSToomas Soome  * +--------+-------+
10984a5d661aSToomas Soome  *
10994a5d661aSToomas Soome  * Bits 0-10 are the layout number
11004a5d661aSToomas Soome  * Bits 11-16 are the size of the header.
11014a5d661aSToomas Soome  * The hdrsize is the number * 8
11024a5d661aSToomas Soome  *
11034a5d661aSToomas Soome  * For example.
11044a5d661aSToomas Soome  * hdrsz of 1 ==> 8 byte header
11054a5d661aSToomas Soome  *          2 ==> 16 byte header
11064a5d661aSToomas Soome  *
11074a5d661aSToomas Soome  */
11084a5d661aSToomas Soome 
11094a5d661aSToomas Soome #define	SA_HDR_LAYOUT_NUM(hdr) BF32_GET(hdr->sa_layout_info, 0, 10)
11104a5d661aSToomas Soome #define	SA_HDR_SIZE(hdr) BF32_GET_SB(hdr->sa_layout_info, 10, 16, 3, 0)
11114a5d661aSToomas Soome #define	SA_HDR_LAYOUT_INFO_ENCODE(x, num, size) \
11124a5d661aSToomas Soome { \
11134a5d661aSToomas Soome 	BF32_SET_SB(x, 10, 6, 3, 0, size); \
11144a5d661aSToomas Soome 	BF32_SET(x, 0, 10, num); \
11154a5d661aSToomas Soome }
11164a5d661aSToomas Soome 
11174a5d661aSToomas Soome #define	SA_MODE_OFFSET		0
11184a5d661aSToomas Soome #define	SA_SIZE_OFFSET		8
11194a5d661aSToomas Soome #define	SA_GEN_OFFSET		16
11204a5d661aSToomas Soome #define	SA_UID_OFFSET		24
11214a5d661aSToomas Soome #define	SA_GID_OFFSET		32
11224a5d661aSToomas Soome #define	SA_PARENT_OFFSET	40
1123546a5316SToomas Soome #define	SA_SYMLINK_OFFSET	160
11244a5d661aSToomas Soome 
11254a5d661aSToomas Soome /*
11264a5d661aSToomas Soome  * Intent log header - this on disk structure holds fields to manage
11274a5d661aSToomas Soome  * the log.  All fields are 64 bit to easily handle cross architectures.
11284a5d661aSToomas Soome  */
11294a5d661aSToomas Soome typedef struct zil_header {
11304a5d661aSToomas Soome 	uint64_t zh_claim_txg;	/* txg in which log blocks were claimed */
11314a5d661aSToomas Soome 	uint64_t zh_replay_seq;	/* highest replayed sequence number */
11324a5d661aSToomas Soome 	blkptr_t zh_log;	/* log chain */
11334a5d661aSToomas Soome 	uint64_t zh_claim_seq;	/* highest claimed sequence number */
11344a5d661aSToomas Soome 	uint64_t zh_pad[5];
11354a5d661aSToomas Soome } zil_header_t;
11364a5d661aSToomas Soome 
11374a5d661aSToomas Soome #define	OBJSET_PHYS_SIZE 2048
11384a5d661aSToomas Soome 
11394a5d661aSToomas Soome typedef struct objset_phys {
11404a5d661aSToomas Soome 	dnode_phys_t os_meta_dnode;
11414a5d661aSToomas Soome 	zil_header_t os_zil_header;
11424a5d661aSToomas Soome 	uint64_t os_type;
11434a5d661aSToomas Soome 	uint64_t os_flags;
11444a5d661aSToomas Soome 	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
11454a5d661aSToomas Soome 	    sizeof (zil_header_t) - sizeof (uint64_t)*2];
11464a5d661aSToomas Soome 	dnode_phys_t os_userused_dnode;
11474a5d661aSToomas Soome 	dnode_phys_t os_groupused_dnode;
11484a5d661aSToomas Soome } objset_phys_t;
11494a5d661aSToomas Soome 
11504a5d661aSToomas Soome typedef struct dsl_dir_phys {
11514a5d661aSToomas Soome 	uint64_t dd_creation_time; /* not actually used */
11524a5d661aSToomas Soome 	uint64_t dd_head_dataset_obj;
11534a5d661aSToomas Soome 	uint64_t dd_parent_obj;
11544a5d661aSToomas Soome 	uint64_t dd_clone_parent_obj;
11554a5d661aSToomas Soome 	uint64_t dd_child_dir_zapobj;
11564a5d661aSToomas Soome 	/*
11574a5d661aSToomas Soome 	 * how much space our children are accounting for; for leaf
11584a5d661aSToomas Soome 	 * datasets, == physical space used by fs + snaps
11594a5d661aSToomas Soome 	 */
11604a5d661aSToomas Soome 	uint64_t dd_used_bytes;
11614a5d661aSToomas Soome 	uint64_t dd_compressed_bytes;
11624a5d661aSToomas Soome 	uint64_t dd_uncompressed_bytes;
11634a5d661aSToomas Soome 	/* Administrative quota setting */
11644a5d661aSToomas Soome 	uint64_t dd_quota;
11654a5d661aSToomas Soome 	/* Administrative reservation setting */
11664a5d661aSToomas Soome 	uint64_t dd_reserved;
11674a5d661aSToomas Soome 	uint64_t dd_props_zapobj;
11684a5d661aSToomas Soome 	uint64_t dd_pad[21]; /* pad out to 256 bytes for good measure */
11694a5d661aSToomas Soome } dsl_dir_phys_t;
11704a5d661aSToomas Soome 
11714a5d661aSToomas Soome typedef struct dsl_dataset_phys {
11724a5d661aSToomas Soome 	uint64_t ds_dir_obj;
11734a5d661aSToomas Soome 	uint64_t ds_prev_snap_obj;
11744a5d661aSToomas Soome 	uint64_t ds_prev_snap_txg;
11754a5d661aSToomas Soome 	uint64_t ds_next_snap_obj;
11764a5d661aSToomas Soome 	uint64_t ds_snapnames_zapobj;	/* zap obj of snaps; ==0 for snaps */
11774a5d661aSToomas Soome 	uint64_t ds_num_children;	/* clone/snap children; ==0 for head */
11784a5d661aSToomas Soome 	uint64_t ds_creation_time;	/* seconds since 1970 */
11794a5d661aSToomas Soome 	uint64_t ds_creation_txg;
11804a5d661aSToomas Soome 	uint64_t ds_deadlist_obj;
11814a5d661aSToomas Soome 	uint64_t ds_used_bytes;
11824a5d661aSToomas Soome 	uint64_t ds_compressed_bytes;
11834a5d661aSToomas Soome 	uint64_t ds_uncompressed_bytes;
11844a5d661aSToomas Soome 	uint64_t ds_unique_bytes;	/* only relevant to snapshots */
11854a5d661aSToomas Soome 	/*
11864a5d661aSToomas Soome 	 * The ds_fsid_guid is a 56-bit ID that can change to avoid
11874a5d661aSToomas Soome 	 * collisions.  The ds_guid is a 64-bit ID that will never
11884a5d661aSToomas Soome 	 * change, so there is a small probability that it will collide.
11894a5d661aSToomas Soome 	 */
11904a5d661aSToomas Soome 	uint64_t ds_fsid_guid;
11914a5d661aSToomas Soome 	uint64_t ds_guid;
11924a5d661aSToomas Soome 	uint64_t ds_flags;
11934a5d661aSToomas Soome 	blkptr_t ds_bp;
11944a5d661aSToomas Soome 	uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */
11954a5d661aSToomas Soome } dsl_dataset_phys_t;
11964a5d661aSToomas Soome 
11974a5d661aSToomas Soome /*
11984a5d661aSToomas Soome  * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
11994a5d661aSToomas Soome  */
12004a5d661aSToomas Soome #define	DMU_POOL_DIRECTORY_OBJECT	1
12014a5d661aSToomas Soome #define	DMU_POOL_CONFIG			"config"
12024a5d661aSToomas Soome #define	DMU_POOL_FEATURES_FOR_READ	"features_for_read"
12034a5d661aSToomas Soome #define	DMU_POOL_ROOT_DATASET		"root_dataset"
12044a5d661aSToomas Soome #define	DMU_POOL_SYNC_BPLIST		"sync_bplist"
12054a5d661aSToomas Soome #define	DMU_POOL_ERRLOG_SCRUB		"errlog_scrub"
12064a5d661aSToomas Soome #define	DMU_POOL_ERRLOG_LAST		"errlog_last"
12074a5d661aSToomas Soome #define	DMU_POOL_SPARES			"spares"
12084a5d661aSToomas Soome #define	DMU_POOL_DEFLATE		"deflate"
12094a5d661aSToomas Soome #define	DMU_POOL_HISTORY		"history"
12104a5d661aSToomas Soome #define	DMU_POOL_PROPS			"pool_props"
12114a5d661aSToomas Soome 
12124a5d661aSToomas Soome #define	ZAP_MAGIC 0x2F52AB2ABULL
12134a5d661aSToomas Soome 
12144a5d661aSToomas Soome #define	FZAP_BLOCK_SHIFT(zap)	((zap)->zap_block_shift)
12154a5d661aSToomas Soome 
12164a5d661aSToomas Soome #define	ZAP_MAXCD		(uint32_t)(-1)
12174a5d661aSToomas Soome #define	ZAP_HASHBITS		28
12184a5d661aSToomas Soome #define	MZAP_ENT_LEN		64
12194a5d661aSToomas Soome #define	MZAP_NAME_LEN		(MZAP_ENT_LEN - 8 - 4 - 2)
12204a5d661aSToomas Soome #define	MZAP_MAX_BLKSHIFT	SPA_MAXBLOCKSHIFT
12214a5d661aSToomas Soome #define	MZAP_MAX_BLKSZ		(1 << MZAP_MAX_BLKSHIFT)
12224a5d661aSToomas Soome 
12234a5d661aSToomas Soome typedef struct mzap_ent_phys {
12244a5d661aSToomas Soome 	uint64_t mze_value;
12254a5d661aSToomas Soome 	uint32_t mze_cd;
12264a5d661aSToomas Soome 	uint16_t mze_pad;	/* in case we want to chain them someday */
12274a5d661aSToomas Soome 	char mze_name[MZAP_NAME_LEN];
12284a5d661aSToomas Soome } mzap_ent_phys_t;
12294a5d661aSToomas Soome 
12304a5d661aSToomas Soome typedef struct mzap_phys {
12314a5d661aSToomas Soome 	uint64_t mz_block_type;	/* ZBT_MICRO */
12324a5d661aSToomas Soome 	uint64_t mz_salt;
12334a5d661aSToomas Soome 	uint64_t mz_pad[6];
12344a5d661aSToomas Soome 	mzap_ent_phys_t mz_chunk[1];
12354a5d661aSToomas Soome 	/* actually variable size depending on block size */
12364a5d661aSToomas Soome } mzap_phys_t;
12374a5d661aSToomas Soome 
12384a5d661aSToomas Soome /*
12394a5d661aSToomas Soome  * The (fat) zap is stored in one object. It is an array of
12404a5d661aSToomas Soome  * 1<<FZAP_BLOCK_SHIFT byte blocks. The layout looks like one of:
12414a5d661aSToomas Soome  *
12424a5d661aSToomas Soome  * ptrtbl fits in first block:
12434a5d661aSToomas Soome  * 	[zap_phys_t zap_ptrtbl_shift < 6] [zap_leaf_t] ...
12444a5d661aSToomas Soome  *
12454a5d661aSToomas Soome  * ptrtbl too big for first block:
12464a5d661aSToomas Soome  * 	[zap_phys_t zap_ptrtbl_shift >= 6] [zap_leaf_t] [ptrtbl] ...
12474a5d661aSToomas Soome  *
12484a5d661aSToomas Soome  */
12494a5d661aSToomas Soome 
12504a5d661aSToomas Soome #define	ZBT_LEAF		((1ULL << 63) + 0)
12514a5d661aSToomas Soome #define	ZBT_HEADER		((1ULL << 63) + 1)
12524a5d661aSToomas Soome #define	ZBT_MICRO		((1ULL << 63) + 3)
12534a5d661aSToomas Soome /* any other values are ptrtbl blocks */
12544a5d661aSToomas Soome 
12554a5d661aSToomas Soome /*
12564a5d661aSToomas Soome  * the embedded pointer table takes up half a block:
12574a5d661aSToomas Soome  * block size / entry size (2^3) / 2
12584a5d661aSToomas Soome  */
12594a5d661aSToomas Soome #define	ZAP_EMBEDDED_PTRTBL_SHIFT(zap) (FZAP_BLOCK_SHIFT(zap) - 3 - 1)
12604a5d661aSToomas Soome 
12614a5d661aSToomas Soome /*
12624a5d661aSToomas Soome  * The embedded pointer table starts half-way through the block.  Since
12634a5d661aSToomas Soome  * the pointer table itself is half the block, it starts at (64-bit)
12644a5d661aSToomas Soome  * word number (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap)).
12654a5d661aSToomas Soome  */
12664a5d661aSToomas Soome #define	ZAP_EMBEDDED_PTRTBL_ENT(zap, idx) \
12674a5d661aSToomas Soome 	((uint64_t *)(zap)->zap_phys) \
12684a5d661aSToomas Soome 	[(idx) + (1<<ZAP_EMBEDDED_PTRTBL_SHIFT(zap))]
12694a5d661aSToomas Soome 
12704a5d661aSToomas Soome /*
12714a5d661aSToomas Soome  * TAKE NOTE:
12724a5d661aSToomas Soome  * If zap_phys_t is modified, zap_byteswap() must be modified.
12734a5d661aSToomas Soome  */
12744a5d661aSToomas Soome typedef struct zap_phys {
12754a5d661aSToomas Soome 	uint64_t zap_block_type;	/* ZBT_HEADER */
12764a5d661aSToomas Soome 	uint64_t zap_magic;		/* ZAP_MAGIC */
12774a5d661aSToomas Soome 
12784a5d661aSToomas Soome 	struct zap_table_phys {
12794a5d661aSToomas Soome 		uint64_t zt_blk;	/* starting block number */
12804a5d661aSToomas Soome 		uint64_t zt_numblks;	/* number of blocks */
12814a5d661aSToomas Soome 		uint64_t zt_shift;	/* bits to index it */
12824a5d661aSToomas Soome 		uint64_t zt_nextblk;	/* next (larger) copy start block */
12834a5d661aSToomas Soome 		uint64_t zt_blks_copied; /* number source blocks copied */
12844a5d661aSToomas Soome 	} zap_ptrtbl;
12854a5d661aSToomas Soome 
12864a5d661aSToomas Soome 	uint64_t zap_freeblk;		/* the next free block */
12874a5d661aSToomas Soome 	uint64_t zap_num_leafs;		/* number of leafs */
12884a5d661aSToomas Soome 	uint64_t zap_num_entries;	/* number of entries */
12894a5d661aSToomas Soome 	uint64_t zap_salt;		/* salt to stir into hash function */
12904a5d661aSToomas Soome 	/*
12914a5d661aSToomas Soome 	 * This structure is followed by padding, and then the embedded
12924a5d661aSToomas Soome 	 * pointer table.  The embedded pointer table takes up second
12934a5d661aSToomas Soome 	 * half of the block.  It is accessed using the
12944a5d661aSToomas Soome 	 * ZAP_EMBEDDED_PTRTBL_ENT() macro.
12954a5d661aSToomas Soome 	 */
12964a5d661aSToomas Soome } zap_phys_t;
12974a5d661aSToomas Soome 
12984a5d661aSToomas Soome typedef struct zap_table_phys zap_table_phys_t;
12994a5d661aSToomas Soome 
13004a5d661aSToomas Soome typedef struct fat_zap {
13014a5d661aSToomas Soome 	int zap_block_shift;			/* block size shift */
13024a5d661aSToomas Soome 	zap_phys_t *zap_phys;
13034a5d661aSToomas Soome } fat_zap_t;
13044a5d661aSToomas Soome 
13054a5d661aSToomas Soome #define	ZAP_LEAF_MAGIC 0x2AB1EAF
13064a5d661aSToomas Soome 
13074a5d661aSToomas Soome /* chunk size = 24 bytes */
13084a5d661aSToomas Soome #define	ZAP_LEAF_CHUNKSIZE 24
13094a5d661aSToomas Soome 
13104a5d661aSToomas Soome /*
13114a5d661aSToomas Soome  * The amount of space available for chunks is:
13124a5d661aSToomas Soome  * block size (1<<l->l_bs) - hash entry size (2) * number of hash
13134a5d661aSToomas Soome  * entries - header space (2*chunksize)
13144a5d661aSToomas Soome  */
13154a5d661aSToomas Soome #define	ZAP_LEAF_NUMCHUNKS(l) \
13164a5d661aSToomas Soome 	(((1<<(l)->l_bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(l)) / \
13174a5d661aSToomas Soome 	ZAP_LEAF_CHUNKSIZE - 2)
13184a5d661aSToomas Soome 
13194a5d661aSToomas Soome /*
13204a5d661aSToomas Soome  * The amount of space within the chunk available for the array is:
13214a5d661aSToomas Soome  * chunk size - space for type (1) - space for next pointer (2)
13224a5d661aSToomas Soome  */
13234a5d661aSToomas Soome #define	ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)
13244a5d661aSToomas Soome 
13254a5d661aSToomas Soome #define	ZAP_LEAF_ARRAY_NCHUNKS(bytes) \
13264a5d661aSToomas Soome 	(((bytes)+ZAP_LEAF_ARRAY_BYTES-1)/ZAP_LEAF_ARRAY_BYTES)
13274a5d661aSToomas Soome 
13284a5d661aSToomas Soome /*
13294a5d661aSToomas Soome  * Low water mark:  when there are only this many chunks free, start
13304a5d661aSToomas Soome  * growing the ptrtbl.  Ideally, this should be larger than a
13314a5d661aSToomas Soome  * "reasonably-sized" entry.  20 chunks is more than enough for the
13324a5d661aSToomas Soome  * largest directory entry (MAXNAMELEN (256) byte name, 8-byte value),
13334a5d661aSToomas Soome  * while still being only around 3% for 16k blocks.
13344a5d661aSToomas Soome  */
13354a5d661aSToomas Soome #define	ZAP_LEAF_LOW_WATER (20)
13364a5d661aSToomas Soome 
13374a5d661aSToomas Soome /*
13384a5d661aSToomas Soome  * The leaf hash table has block size / 2^5 (32) number of entries,
13394a5d661aSToomas Soome  * which should be more than enough for the maximum number of entries,
13404a5d661aSToomas Soome  * which is less than block size / CHUNKSIZE (24) / minimum number of
13414a5d661aSToomas Soome  * chunks per entry (3).
13424a5d661aSToomas Soome  */
13434a5d661aSToomas Soome #define	ZAP_LEAF_HASH_SHIFT(l) ((l)->l_bs - 5)
13444a5d661aSToomas Soome #define	ZAP_LEAF_HASH_NUMENTRIES(l) (1 << ZAP_LEAF_HASH_SHIFT(l))
13454a5d661aSToomas Soome 
13464a5d661aSToomas Soome /*
13474a5d661aSToomas Soome  * The chunks start immediately after the hash table.  The end of the
13484a5d661aSToomas Soome  * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a
13494a5d661aSToomas Soome  * chunk_t.
13504a5d661aSToomas Soome  */
13514a5d661aSToomas Soome #define	ZAP_LEAF_CHUNK(l, idx) \
13524a5d661aSToomas Soome 	((zap_leaf_chunk_t *) \
13534a5d661aSToomas Soome 	((l)->l_phys->l_hash + ZAP_LEAF_HASH_NUMENTRIES(l)))[idx]
13544a5d661aSToomas Soome #define	ZAP_LEAF_ENTRY(l, idx) (&ZAP_LEAF_CHUNK(l, idx).l_entry)
13554a5d661aSToomas Soome 
13564a5d661aSToomas Soome typedef enum zap_chunk_type {
13574a5d661aSToomas Soome 	ZAP_CHUNK_FREE = 253,
13584a5d661aSToomas Soome 	ZAP_CHUNK_ENTRY = 252,
13594a5d661aSToomas Soome 	ZAP_CHUNK_ARRAY = 251,
13604a5d661aSToomas Soome 	ZAP_CHUNK_TYPE_MAX = 250
13614a5d661aSToomas Soome } zap_chunk_type_t;
13624a5d661aSToomas Soome 
13634a5d661aSToomas Soome /*
13644a5d661aSToomas Soome  * TAKE NOTE:
13654a5d661aSToomas Soome  * If zap_leaf_phys_t is modified, zap_leaf_byteswap() must be modified.
13664a5d661aSToomas Soome  */
13674a5d661aSToomas Soome typedef struct zap_leaf_phys {
13684a5d661aSToomas Soome 	struct zap_leaf_header {
13694a5d661aSToomas Soome 		uint64_t lh_block_type;		/* ZBT_LEAF */
13704a5d661aSToomas Soome 		uint64_t lh_pad1;
13714a5d661aSToomas Soome 		uint64_t lh_prefix;		/* hash prefix of this leaf */
13724a5d661aSToomas Soome 		uint32_t lh_magic;		/* ZAP_LEAF_MAGIC */
13734a5d661aSToomas Soome 		uint16_t lh_nfree;		/* number free chunks */
13744a5d661aSToomas Soome 		uint16_t lh_nentries;		/* number of entries */
13754a5d661aSToomas Soome 		uint16_t lh_prefix_len;		/* num bits used to id this */
13764a5d661aSToomas Soome 
13774a5d661aSToomas Soome /* above is accessable to zap, below is zap_leaf private */
13784a5d661aSToomas Soome 
13794a5d661aSToomas Soome 		uint16_t lh_freelist;		/* chunk head of free list */
13804a5d661aSToomas Soome 		uint8_t lh_pad2[12];
13814a5d661aSToomas Soome 	} l_hdr; /* 2 24-byte chunks */
13824a5d661aSToomas Soome 
13834a5d661aSToomas Soome 	/*
13844a5d661aSToomas Soome 	 * The header is followed by a hash table with
13854a5d661aSToomas Soome 	 * ZAP_LEAF_HASH_NUMENTRIES(zap) entries.  The hash table is
13864a5d661aSToomas Soome 	 * followed by an array of ZAP_LEAF_NUMCHUNKS(zap)
13874a5d661aSToomas Soome 	 * zap_leaf_chunk structures.  These structures are accessed
13884a5d661aSToomas Soome 	 * with the ZAP_LEAF_CHUNK() macro.
13894a5d661aSToomas Soome 	 */
13904a5d661aSToomas Soome 
13914a5d661aSToomas Soome 	uint16_t l_hash[1];
13924a5d661aSToomas Soome } zap_leaf_phys_t;
13934a5d661aSToomas Soome 
13944a5d661aSToomas Soome typedef union zap_leaf_chunk {
13954a5d661aSToomas Soome 	struct zap_leaf_entry {
13964a5d661aSToomas Soome 		uint8_t le_type; 		/* always ZAP_CHUNK_ENTRY */
13974a5d661aSToomas Soome 		uint8_t le_value_intlen;	/* size of ints */
13984a5d661aSToomas Soome 		uint16_t le_next;		/* next entry in hash chain */
13994a5d661aSToomas Soome 		uint16_t le_name_chunk;		/* first chunk of the name */
14004a5d661aSToomas Soome 		uint16_t le_name_numints;	/* bytes in name, incl null */
14014a5d661aSToomas Soome 		uint16_t le_value_chunk;	/* first chunk of the value */
14024a5d661aSToomas Soome 		uint16_t le_value_numints;	/* value length in ints */
14034a5d661aSToomas Soome 		uint32_t le_cd;			/* collision differentiator */
14044a5d661aSToomas Soome 		uint64_t le_hash;		/* hash value of the name */
14054a5d661aSToomas Soome 	} l_entry;
14064a5d661aSToomas Soome 	struct zap_leaf_array {
14074a5d661aSToomas Soome 		uint8_t la_type;		/* always ZAP_CHUNK_ARRAY */
14084a5d661aSToomas Soome 		uint8_t la_array[ZAP_LEAF_ARRAY_BYTES];
14094a5d661aSToomas Soome 		uint16_t la_next;		/* next blk or CHAIN_END */
14104a5d661aSToomas Soome 	} l_array;
14114a5d661aSToomas Soome 	struct zap_leaf_free {
14124a5d661aSToomas Soome 		uint8_t lf_type;		/* always ZAP_CHUNK_FREE */
14134a5d661aSToomas Soome 		uint8_t lf_pad[ZAP_LEAF_ARRAY_BYTES];
14144a5d661aSToomas Soome 		uint16_t lf_next;	/* next in free list, or CHAIN_END */
14154a5d661aSToomas Soome 	} l_free;
14164a5d661aSToomas Soome } zap_leaf_chunk_t;
14174a5d661aSToomas Soome 
14184a5d661aSToomas Soome typedef struct zap_leaf {
14194a5d661aSToomas Soome 	int l_bs;			/* block size shift */
14204a5d661aSToomas Soome 	zap_leaf_phys_t *l_phys;
14214a5d661aSToomas Soome } zap_leaf_t;
14224a5d661aSToomas Soome 
14234a5d661aSToomas Soome /*
14244a5d661aSToomas Soome  * Define special zfs pflags
14254a5d661aSToomas Soome  */
14264a5d661aSToomas Soome #define	ZFS_XATTR	0x1		/* is an extended attribute */
14274a5d661aSToomas Soome #define	ZFS_INHERIT_ACE	0x2		/* ace has inheritable ACEs */
14284a5d661aSToomas Soome #define	ZFS_ACL_TRIVIAL 0x4		/* files ACL is trivial */
14294a5d661aSToomas Soome 
14304a5d661aSToomas Soome #define	MASTER_NODE_OBJ	1
14314a5d661aSToomas Soome 
14324a5d661aSToomas Soome /*
14334a5d661aSToomas Soome  * special attributes for master node.
14344a5d661aSToomas Soome  */
14354a5d661aSToomas Soome 
14364a5d661aSToomas Soome #define	ZFS_FSID		"FSID"
14374a5d661aSToomas Soome #define	ZFS_UNLINKED_SET	"DELETE_QUEUE"
14384a5d661aSToomas Soome #define	ZFS_ROOT_OBJ		"ROOT"
14394a5d661aSToomas Soome #define	ZPL_VERSION_OBJ		"VERSION"
14404a5d661aSToomas Soome #define	ZFS_PROP_BLOCKPERPAGE	"BLOCKPERPAGE"
14414a5d661aSToomas Soome #define	ZFS_PROP_NOGROWBLOCKS	"NOGROWBLOCKS"
14424a5d661aSToomas Soome 
14434a5d661aSToomas Soome #define	ZFS_FLAG_BLOCKPERPAGE	0x1
14444a5d661aSToomas Soome #define	ZFS_FLAG_NOGROWBLOCKS	0x2
14454a5d661aSToomas Soome 
14464a5d661aSToomas Soome /*
14474a5d661aSToomas Soome  * ZPL version - rev'd whenever an incompatible on-disk format change
14484a5d661aSToomas Soome  * occurs.  Independent of SPA/DMU/ZAP versioning.
14494a5d661aSToomas Soome  */
14504a5d661aSToomas Soome 
14514a5d661aSToomas Soome #define	ZPL_VERSION		1ULL
14524a5d661aSToomas Soome 
14534a5d661aSToomas Soome /*
14544a5d661aSToomas Soome  * The directory entry has the type (currently unused on Solaris) in the
14554a5d661aSToomas Soome  * top 4 bits, and the object number in the low 48 bits.  The "middle"
14564a5d661aSToomas Soome  * 12 bits are unused.
14574a5d661aSToomas Soome  */
14584a5d661aSToomas Soome #define	ZFS_DIRENT_TYPE(de) BF64_GET(de, 60, 4)
14594a5d661aSToomas Soome #define	ZFS_DIRENT_OBJ(de) BF64_GET(de, 0, 48)
14604a5d661aSToomas Soome #define	ZFS_DIRENT_MAKE(type, obj) (((uint64_t)type << 60) | obj)
14614a5d661aSToomas Soome 
14624a5d661aSToomas Soome typedef struct ace {
14634a5d661aSToomas Soome 	uid_t		a_who;		/* uid or gid */
14644a5d661aSToomas Soome 	uint32_t	a_access_mask;	/* read,write,... */
14654a5d661aSToomas Soome 	uint16_t	a_flags;	/* see below */
14664a5d661aSToomas Soome 	uint16_t	a_type;		/* allow or deny */
14674a5d661aSToomas Soome } ace_t;
14684a5d661aSToomas Soome 
14694a5d661aSToomas Soome #define ACE_SLOT_CNT	6
14704a5d661aSToomas Soome 
14714a5d661aSToomas Soome typedef struct zfs_znode_acl {
14724a5d661aSToomas Soome 	uint64_t	z_acl_extern_obj;	  /* ext acl pieces */
14734a5d661aSToomas Soome 	uint32_t	z_acl_count;		  /* Number of ACEs */
14744a5d661aSToomas Soome 	uint16_t	z_acl_version;		  /* acl version */
14754a5d661aSToomas Soome 	uint16_t	z_acl_pad;		  /* pad */
14764a5d661aSToomas Soome 	ace_t		z_ace_data[ACE_SLOT_CNT]; /* 6 standard ACEs */
14774a5d661aSToomas Soome } zfs_znode_acl_t;
14784a5d661aSToomas Soome 
14794a5d661aSToomas Soome /*
14804a5d661aSToomas Soome  * This is the persistent portion of the znode.  It is stored
14814a5d661aSToomas Soome  * in the "bonus buffer" of the file.  Short symbolic links
14824a5d661aSToomas Soome  * are also stored in the bonus buffer.
14834a5d661aSToomas Soome  */
14844a5d661aSToomas Soome typedef struct znode_phys {
14854a5d661aSToomas Soome 	uint64_t zp_atime[2];		/*  0 - last file access time */
14864a5d661aSToomas Soome 	uint64_t zp_mtime[2];		/* 16 - last file modification time */
14874a5d661aSToomas Soome 	uint64_t zp_ctime[2];		/* 32 - last file change time */
14884a5d661aSToomas Soome 	uint64_t zp_crtime[2];		/* 48 - creation time */
14894a5d661aSToomas Soome 	uint64_t zp_gen;		/* 64 - generation (txg of creation) */
14904a5d661aSToomas Soome 	uint64_t zp_mode;		/* 72 - file mode bits */
14914a5d661aSToomas Soome 	uint64_t zp_size;		/* 80 - size of file */
14924a5d661aSToomas Soome 	uint64_t zp_parent;		/* 88 - directory parent (`..') */
14934a5d661aSToomas Soome 	uint64_t zp_links;		/* 96 - number of links to file */
14944a5d661aSToomas Soome 	uint64_t zp_xattr;		/* 104 - DMU object for xattrs */
14954a5d661aSToomas Soome 	uint64_t zp_rdev;		/* 112 - dev_t for VBLK & VCHR files */
14964a5d661aSToomas Soome 	uint64_t zp_flags;		/* 120 - persistent flags */
14974a5d661aSToomas Soome 	uint64_t zp_uid;		/* 128 - file owner */
14984a5d661aSToomas Soome 	uint64_t zp_gid;		/* 136 - owning group */
14994a5d661aSToomas Soome 	uint64_t zp_pad[4];		/* 144 - future */
15004a5d661aSToomas Soome 	zfs_znode_acl_t zp_acl;		/* 176 - 263 ACL */
15014a5d661aSToomas Soome 	/*
15024a5d661aSToomas Soome 	 * Data may pad out any remaining bytes in the znode buffer, eg:
15034a5d661aSToomas Soome 	 *
15044a5d661aSToomas Soome 	 * |<---------------------- dnode_phys (512) ------------------------>|
15054a5d661aSToomas Soome 	 * |<-- dnode (192) --->|<----------- "bonus" buffer (320) ---------->|
15064a5d661aSToomas Soome 	 *			|<---- znode (264) ---->|<---- data (56) ---->|
15074a5d661aSToomas Soome 	 *
15084a5d661aSToomas Soome 	 * At present, we only use this space to store symbolic links.
15094a5d661aSToomas Soome 	 */
15104a5d661aSToomas Soome } znode_phys_t;
15114a5d661aSToomas Soome 
15124a5d661aSToomas Soome /*
15134a5d661aSToomas Soome  * In-core vdev representation.
15144a5d661aSToomas Soome  */
15154a5d661aSToomas Soome struct vdev;
15164a5d661aSToomas Soome typedef int vdev_phys_read_t(struct vdev *vdev, void *priv,
15174a5d661aSToomas Soome     off_t offset, void *buf, size_t bytes);
15184a5d661aSToomas Soome typedef int vdev_read_t(struct vdev *vdev, const blkptr_t *bp,
15194a5d661aSToomas Soome     void *buf, off_t offset, size_t bytes);
15204a5d661aSToomas Soome 
15214a5d661aSToomas Soome typedef STAILQ_HEAD(vdev_list, vdev) vdev_list_t;
15224a5d661aSToomas Soome 
15234a5d661aSToomas Soome typedef struct vdev {
15244a5d661aSToomas Soome 	STAILQ_ENTRY(vdev) v_childlink;	/* link in parent's child list */
15254a5d661aSToomas Soome 	STAILQ_ENTRY(vdev) v_alllink;	/* link in global vdev list */
15264a5d661aSToomas Soome 	vdev_list_t	v_children;	/* children of this vdev */
15274a5d661aSToomas Soome 	const char	*v_name;	/* vdev name */
15284a5d661aSToomas Soome 	const char	*v_phys_path;	/* vdev bootpath */
15294a5d661aSToomas Soome 	const char	*v_devid;	/* vdev devid */
15304a5d661aSToomas Soome 	uint64_t	v_guid;		/* vdev guid */
15314a5d661aSToomas Soome 	int		v_id;		/* index in parent */
15324a5d661aSToomas Soome 	int		v_ashift;	/* offset to block shift */
15334a5d661aSToomas Soome 	int		v_nparity;	/* # parity for raidz */
15344a5d661aSToomas Soome 	struct vdev	*v_top;		/* parent vdev */
15354a5d661aSToomas Soome 	int		v_nchildren;	/* # children */
15364a5d661aSToomas Soome 	vdev_state_t	v_state;	/* current state */
15374a5d661aSToomas Soome 	vdev_phys_read_t *v_phys_read;	/* read from raw leaf vdev */
15384a5d661aSToomas Soome 	vdev_read_t	*v_read;	/* read from vdev */
15394a5d661aSToomas Soome 	void		*v_read_priv;	/* private data for read function */
15404a5d661aSToomas Soome } vdev_t;
15414a5d661aSToomas Soome 
15424a5d661aSToomas Soome /*
15434a5d661aSToomas Soome  * In-core pool representation.
15444a5d661aSToomas Soome  */
15454a5d661aSToomas Soome typedef STAILQ_HEAD(spa_list, spa) spa_list_t;
15464a5d661aSToomas Soome 
15474a5d661aSToomas Soome typedef struct spa {
15484a5d661aSToomas Soome 	STAILQ_ENTRY(spa) spa_link;	/* link in global pool list */
15494a5d661aSToomas Soome 	char		*spa_name;	/* pool name */
15504a5d661aSToomas Soome 	uint64_t	spa_guid;	/* pool guid */
15514a5d661aSToomas Soome 	uint64_t	spa_txg;	/* most recent transaction */
15524a5d661aSToomas Soome 	struct uberblock spa_uberblock;	/* best uberblock so far */
15534a5d661aSToomas Soome 	vdev_list_t	spa_vdevs;	/* list of all toplevel vdevs */
15544a5d661aSToomas Soome 	objset_phys_t	spa_mos;	/* MOS for this pool */
15554a5d661aSToomas Soome 	int		spa_inited;	/* initialized */
15564a5d661aSToomas Soome } spa_t;
15574a5d661aSToomas Soome 
15584a5d661aSToomas Soome static void decode_embedded_bp_compressed(const blkptr_t *, void *);
1559