spa.h revision 770499e185d15678ccb0be57ebc626ad18d93383
1fa9e406ahrens/*
2fa9e406ahrens * CDDL HEADER START
3fa9e406ahrens *
4fa9e406ahrens * The contents of this file are subject to the terms of the
5ea8dc4beschrock * Common Development and Distribution License (the "License").
6ea8dc4beschrock * You may not use this file except in compliance with the License.
7fa9e406ahrens *
8fa9e406ahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e406ahrens * or http://www.opensolaris.org/os/licensing.
10fa9e406ahrens * See the License for the specific language governing permissions
11fa9e406ahrens * and limitations under the License.
12fa9e406ahrens *
13fa9e406ahrens * When distributing Covered Code, include this CDDL HEADER in each
14fa9e406ahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e406ahrens * If applicable, add the following below this CDDL HEADER, with the
16fa9e406ahrens * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e406ahrens * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e406ahrens *
19fa9e406ahrens * CDDL HEADER END
20fa9e406ahrens */
21fa9e406ahrens/*
223f9d6adLin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
234ba5b96Dan Kimmel * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
24e9103aaGarrett D'Amore * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
25bc9014eJustin Gibbs * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
2645818eeMatthew Ahrens * Copyright 2013 Saso Kiselkov. All rights reserved.
27c3d26abMatthew Ahrens * Copyright (c) 2014 Integros [integros.com]
28fa9e406ahrens */
29fa9e406ahrens
30fa9e406ahrens#ifndef _SYS_SPA_H
31fa9e406ahrens#define	_SYS_SPA_H
32fa9e406ahrens
33fa9e406ahrens#include <sys/avl.h>
34fa9e406ahrens#include <sys/zfs_context.h>
35fa9e406ahrens#include <sys/nvpair.h>
36fa9e406ahrens#include <sys/sysmacros.h>
37fa9e406ahrens#include <sys/types.h>
38fa9e406ahrens#include <sys/fs/zfs.h>
394ba5b96Dan Kimmel#include <sys/dmu.h>
40fa9e406ahrens
41fa9e406ahrens#ifdef	__cplusplus
42fa9e406ahrensextern "C" {
43fa9e406ahrens#endif
44fa9e406ahrens
45fa9e406ahrens/*
46fa9e406ahrens * Forward references that lots of things need.
47fa9e406ahrens */
48fa9e406ahrenstypedef struct spa spa_t;
49fa9e406ahrenstypedef struct vdev vdev_t;
50fa9e406ahrenstypedef struct metaslab metaslab_t;
51b24ab67Jeff Bonwicktypedef struct metaslab_group metaslab_group_t;
52b24ab67Jeff Bonwicktypedef struct metaslab_class metaslab_class_t;
53b24ab67Jeff Bonwicktypedef struct zio zio_t;
54fa9e406ahrenstypedef struct zilog zilog_t;
55fa94a07brendantypedef struct spa_aux_vdev spa_aux_vdev_t;
56b24ab67Jeff Bonwicktypedef struct ddt ddt_t;
57b24ab67Jeff Bonwicktypedef struct ddt_entry ddt_entry_t;
58fa9e406ahrensstruct dsl_pool;
594445fffMatthew Ahrensstruct dsl_dataset;
60fa9e406ahrens
61fa9e406ahrens/*
62fa9e406ahrens * General-purpose 32-bit and 64-bit bitfield encodings.
63fa9e406ahrens */
64fa9e406ahrens#define	BF32_DECODE(x, low, len)	P2PHASE((x) >> (low), 1U << (len))
65fa9e406ahrens#define	BF64_DECODE(x, low, len)	P2PHASE((x) >> (low), 1ULL << (len))
66fa9e406ahrens#define	BF32_ENCODE(x, low, len)	(P2PHASE((x), 1U << (len)) << (low))
67fa9e406ahrens#define	BF64_ENCODE(x, low, len)	(P2PHASE((x), 1ULL << (len)) << (low))
68fa9e406ahrens
69fa9e406ahrens#define	BF32_GET(x, low, len)		BF32_DECODE(x, low, len)
70fa9e406ahrens#define	BF64_GET(x, low, len)		BF64_DECODE(x, low, len)
71fa9e406ahrens
7243466aaMax Grossman#define	BF32_SET(x, low, len, val) do { \
7343466aaMax Grossman	ASSERT3U(val, <, 1U << (len)); \
7443466aaMax Grossman	ASSERT3U(low + len, <=, 32); \
7543466aaMax Grossman	(x) ^= BF32_ENCODE((x >> low) ^ (val), low, len); \
7643466aaMax Grossman_NOTE(CONSTCOND) } while (0)
7743466aaMax Grossman
7843466aaMax Grossman#define	BF64_SET(x, low, len, val) do { \
7943466aaMax Grossman	ASSERT3U(val, <, 1ULL << (len)); \
8043466aaMax Grossman	ASSERT3U(low + len, <=, 64); \
8143466aaMax Grossman	((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)); \
8243466aaMax Grossman_NOTE(CONSTCOND) } while (0)
83fa9e406ahrens
84fa9e406ahrens#define	BF32_GET_SB(x, low, len, shift, bias)	\
85fa9e406ahrens	((BF32_GET(x, low, len) + (bias)) << (shift))
86fa9e406ahrens#define	BF64_GET_SB(x, low, len, shift, bias)	\
87fa9e406ahrens	((BF64_GET(x, low, len) + (bias)) << (shift))
88fa9e406ahrens
8943466aaMax Grossman#define	BF32_SET_SB(x, low, len, shift, bias, val) do { \
9043466aaMax Grossman	ASSERT(IS_P2ALIGNED(val, 1U << shift)); \
9143466aaMax Grossman	ASSERT3S((val) >> (shift), >=, bias); \
9243466aaMax Grossman	BF32_SET(x, low, len, ((val) >> (shift)) - (bias)); \
9343466aaMax Grossman_NOTE(CONSTCOND) } while (0)
9443466aaMax Grossman#define	BF64_SET_SB(x, low, len, shift, bias, val) do { \
9543466aaMax Grossman	ASSERT(IS_P2ALIGNED(val, 1ULL << shift)); \
9643466aaMax Grossman	ASSERT3S((val) >> (shift), >=, bias); \
9743466aaMax Grossman	BF64_SET(x, low, len, ((val) >> (shift)) - (bias)); \
9843466aaMax Grossman_NOTE(CONSTCOND) } while (0)
99fa9e406ahrens
100fa9e406ahrens/*
101b515258Matthew Ahrens * We currently support block sizes from 512 bytes to 16MB.
102b515258Matthew Ahrens * The benefits of larger blocks, and thus larger IO, need to be weighed
103b515258Matthew Ahrens * against the cost of COWing a giant block to modify one byte, and the
104b515258Matthew Ahrens * large latency of reading or writing a large block.
105b515258Matthew Ahrens *
106b515258Matthew Ahrens * Note that although blocks up to 16MB are supported, the recordsize
107b515258Matthew Ahrens * property can not be set larger than zfs_max_recordsize (default 1MB).
108b515258Matthew Ahrens * See the comment near zfs_max_recordsize in dsl_dataset.c for details.
109b515258Matthew Ahrens *
110b515258Matthew Ahrens * Note that although the LSIZE field of the blkptr_t can store sizes up
111b515258Matthew Ahrens * to 32MB, the dnode's dn_datablkszsec can only store sizes up to
112b515258Matthew Ahrens * 32MB - 512 bytes.  Therefore, we limit SPA_MAXBLOCKSIZE to 16MB.
113fa9e406ahrens */
114fa9e406ahrens#define	SPA_MINBLOCKSHIFT	9
115b515258Matthew Ahrens#define	SPA_OLD_MAXBLOCKSHIFT	17
116b515258Matthew Ahrens#define	SPA_MAXBLOCKSHIFT	24
117fa9e406ahrens#define	SPA_MINBLOCKSIZE	(1ULL << SPA_MINBLOCKSHIFT)
118b515258Matthew Ahrens#define	SPA_OLD_MAXBLOCKSIZE	(1ULL << SPA_OLD_MAXBLOCKSHIFT)
119fa9e406ahrens#define	SPA_MAXBLOCKSIZE	(1ULL << SPA_MAXBLOCKSHIFT)
120fa9e406ahrens
121fa9e406ahrens/*
122f7991baTim Haley * Size of block to hold the configuration data (a packed nvlist)
123f7991baTim Haley */
124ad135b5Christopher Siden#define	SPA_CONFIG_BLOCKSIZE	(1ULL << 14)
125f7991baTim Haley
126f7991baTim Haley/*
127fa9e406ahrens * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
128fa9e406ahrens * The ASIZE encoding should be at least 64 times larger (6 more bits)
129fa9e406ahrens * to support up to 4-way RAID-Z mirror mode with worst-case gang block
130fa9e406ahrens * overhead, three DVAs per bp, plus one more bit in case we do anything
131fa9e406ahrens * else that expands the ASIZE.
132fa9e406ahrens */
133fa9e406ahrens#define	SPA_LSIZEBITS		16	/* LSIZE up to 32M (2^16 * 512)	*/
134fa9e406ahrens#define	SPA_PSIZEBITS		16	/* PSIZE up to 32M (2^16 * 512)	*/
135fa9e406ahrens#define	SPA_ASIZEBITS		24	/* ASIZE up to 64 times larger	*/
136fa9e406ahrens
137dcbf3bdGeorge Wilson#define	SPA_COMPRESSBITS	7
138dcbf3bdGeorge Wilson
139fa9e406ahrens/*
140fa9e406ahrens * All SPA data is represented by 128-bit data virtual addresses (DVAs).
141fa9e406ahrens * The members of the dva_t should be considered opaque outside the SPA.
142fa9e406ahrens */
143fa9e406ahrenstypedef struct dva {
144fa9e406ahrens	uint64_t	dva_word[2];
145fa9e406ahrens} dva_t;
146fa9e406ahrens
147fa9e406ahrens/*
148fa9e406ahrens * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
149fa9e406ahrens */
150fa9e406ahrenstypedef struct zio_cksum {
151fa9e406ahrens	uint64_t	zc_word[4];
152fa9e406ahrens} zio_cksum_t;
153fa9e406ahrens
154fa9e406ahrens/*
15545818eeMatthew Ahrens * Some checksums/hashes need a 256-bit initialization salt. This salt is kept
15645818eeMatthew Ahrens * secret and is suitable for use in MAC algorithms as the key.
15745818eeMatthew Ahrens */
15845818eeMatthew Ahrenstypedef struct zio_cksum_salt {
15945818eeMatthew Ahrens	uint8_t		zcs_bytes[32];
16045818eeMatthew Ahrens} zio_cksum_salt_t;
16145818eeMatthew Ahrens
16245818eeMatthew Ahrens/*
163fa9e406ahrens * Each block is described by its DVAs, time of birth, checksum, etc.
164fa9e406ahrens * The word-by-word, bit-by-bit layout of the blkptr is as follows:
165fa9e406ahrens *
166fa9e406ahrens *	64	56	48	40	32	24	16	8	0
167fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
168fa9e406ahrens * 0	|		vdev1		| GRID  |	  ASIZE		|
169fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
170fa9e406ahrens * 1	|G|			 offset1				|
171fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
172fa9e406ahrens * 2	|		vdev2		| GRID  |	  ASIZE		|
173fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
174fa9e406ahrens * 3	|G|			 offset2				|
175fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
176fa9e406ahrens * 4	|		vdev3		| GRID  |	  ASIZE		|
177fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
178fa9e406ahrens * 5	|G|			 offset3				|
179fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
1805d7b4d4Matthew Ahrens * 6	|BDX|lvl| type	| cksum |E| comp|    PSIZE	|     LSIZE	|
181fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
182fa9e406ahrens * 7	|			padding					|
183fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
184fa9e406ahrens * 8	|			padding					|
185fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
186b24ab67Jeff Bonwick * 9	|			physical birth txg			|
187fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
188b24ab67Jeff Bonwick * a	|			logical birth txg			|
189fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
190fa9e406ahrens * b	|			fill count				|
191fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
192fa9e406ahrens * c	|			checksum[0]				|
193fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
194fa9e406ahrens * d	|			checksum[1]				|
195fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
196fa9e406ahrens * e	|			checksum[2]				|
197fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
198fa9e406ahrens * f	|			checksum[3]				|
199fa9e406ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
200fa9e406ahrens *
201fa9e406ahrens * Legend:
202fa9e406ahrens *
203fa9e406ahrens * vdev		virtual device ID
204fa9e406ahrens * offset	offset into virtual device
205fa9e406ahrens * LSIZE	logical size
206fa9e406ahrens * PSIZE	physical size (after compression)
207fa9e406ahrens * ASIZE	allocated size (including RAID-Z parity and gang block headers)
208fa9e406ahrens * GRID		RAID-Z layout information (reserved for future use)
209fa9e406ahrens * cksum	checksum function
210fa9e406ahrens * comp		compression function
211fa9e406ahrens * G		gang block indicator
212b24ab67Jeff Bonwick * B		byteorder (endianness)
213b24ab67Jeff Bonwick * D		dedup
2145d7b4d4Matthew Ahrens * X		encryption (on version 30, which is not supported)
2155d7b4d4Matthew Ahrens * E		blkptr_t contains embedded data (see below)
216fa9e406ahrens * lvl		level of indirection
217b24ab67Jeff Bonwick * type		DMU object type
218b24ab67Jeff Bonwick * phys birth	txg of block allocation; zero if same as logical birth txg
219b24ab67Jeff Bonwick * log. birth	transaction group in which the block was logically born
220fa9e406ahrens * fill count	number of non-zero blocks under this bp
221fa9e406ahrens * checksum[4]	256-bit checksum of the data this bp describes
222fa9e406ahrens */
2235d7b4d4Matthew Ahrens
2245d7b4d4Matthew Ahrens/*
2255d7b4d4Matthew Ahrens * "Embedded" blkptr_t's don't actually point to a block, instead they
2265d7b4d4Matthew Ahrens * have a data payload embedded in the blkptr_t itself.  See the comment
2275d7b4d4Matthew Ahrens * in blkptr.c for more details.
2285d7b4d4Matthew Ahrens *
2295d7b4d4Matthew Ahrens * The blkptr_t is laid out as follows:
2305d7b4d4Matthew Ahrens *
2315d7b4d4Matthew Ahrens *	64	56	48	40	32	24	16	8	0
2325d7b4d4Matthew Ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
2335d7b4d4Matthew Ahrens * 0	|      payload                                                  |
2345d7b4d4Matthew Ahrens * 1	|      payload                                                  |
2355d7b4d4Matthew Ahrens * 2	|      payload                                                  |
2365d7b4d4Matthew Ahrens * 3	|      payload                                                  |
2375d7b4d4Matthew Ahrens * 4	|      payload                                                  |
2385d7b4d4Matthew Ahrens * 5	|      payload                                                  |
2395d7b4d4Matthew Ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
2405d7b4d4Matthew Ahrens * 6	|BDX|lvl| type	| etype |E| comp| PSIZE|              LSIZE	|
2415d7b4d4Matthew Ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
2425d7b4d4Matthew Ahrens * 7	|      payload                                                  |
2435d7b4d4Matthew Ahrens * 8	|      payload                                                  |
2445d7b4d4Matthew Ahrens * 9	|      payload                                                  |
2455d7b4d4Matthew Ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
2465d7b4d4Matthew Ahrens * a	|			logical birth txg			|
2475d7b4d4Matthew Ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
2485d7b4d4Matthew Ahrens * b	|      payload                                                  |
2495d7b4d4Matthew Ahrens * c	|      payload                                                  |
2505d7b4d4Matthew Ahrens * d	|      payload                                                  |
2515d7b4d4Matthew Ahrens * e	|      payload                                                  |
2525d7b4d4Matthew Ahrens * f	|      payload                                                  |
2535d7b4d4Matthew Ahrens *	+-------+-------+-------+-------+-------+-------+-------+-------+
2545d7b4d4Matthew Ahrens *
2555d7b4d4Matthew Ahrens * Legend:
2565d7b4d4Matthew Ahrens *
2575d7b4d4Matthew Ahrens * payload		contains the embedded data
2585d7b4d4Matthew Ahrens * B (byteorder)	byteorder (endianness)
2595d7b4d4Matthew Ahrens * D (dedup)		padding (set to zero)
2605d7b4d4Matthew Ahrens * X			encryption (set to zero; see above)
2615d7b4d4Matthew Ahrens * E (embedded)		set to one
2625d7b4d4Matthew Ahrens * lvl			indirection level
2635d7b4d4Matthew Ahrens * type			DMU object type
2645d7b4d4Matthew Ahrens * etype		how to interpret embedded data (BP_EMBEDDED_TYPE_*)
2655d7b4d4Matthew Ahrens * comp			compression function of payload
2665d7b4d4Matthew Ahrens * PSIZE		size of payload after compression, in bytes
2675d7b4d4Matthew Ahrens * LSIZE		logical size of payload, in bytes
2685d7b4d4Matthew Ahrens *			note that 25 bits is enough to store the largest
2695d7b4d4Matthew Ahrens *			"normal" BP's LSIZE (2^16 * 2^9) in bytes
2705d7b4d4Matthew Ahrens * log. birth		transaction group in which the block was logically born
2715d7b4d4Matthew Ahrens *
2725d7b4d4Matthew Ahrens * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
2735d7b4d4Matthew Ahrens * bp's they are stored in units of SPA_MINBLOCKSHIFT.
2745d7b4d4Matthew Ahrens * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
2755d7b4d4Matthew Ahrens * The B, D, X, lvl, type, and comp fields are stored the same as with normal
2765d7b4d4Matthew Ahrens * BP's so the BP_SET_* macros can be used with them.  etype, PSIZE, LSIZE must
2775d7b4d4Matthew Ahrens * be set with the BPE_SET_* macros.  BP_SET_EMBEDDED() should be called before
2785d7b4d4Matthew Ahrens * other macros, as they assert that they are only used on BP's of the correct
2795d7b4d4Matthew Ahrens * "embedded-ness".
2805d7b4d4Matthew Ahrens */
2815d7b4d4Matthew Ahrens
2825d7b4d4Matthew Ahrens#define	BPE_GET_ETYPE(bp)	\
2835d7b4d4Matthew Ahrens	(ASSERT(BP_IS_EMBEDDED(bp)), \
2845d7b4d4Matthew Ahrens	BF64_GET((bp)->blk_prop, 40, 8))
2855d7b4d4Matthew Ahrens#define	BPE_SET_ETYPE(bp, t)	do { \
2865d7b4d4Matthew Ahrens	ASSERT(BP_IS_EMBEDDED(bp)); \
2875d7b4d4Matthew Ahrens	BF64_SET((bp)->blk_prop, 40, 8, t); \
2885d7b4d4Matthew Ahrens_NOTE(CONSTCOND) } while (0)
2895d7b4d4Matthew Ahrens
2905d7b4d4Matthew Ahrens#define	BPE_GET_LSIZE(bp)	\
2915d7b4d4Matthew Ahrens	(ASSERT(BP_IS_EMBEDDED(bp)), \
2925d7b4d4Matthew Ahrens	BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
2935d7b4d4Matthew Ahrens#define	BPE_SET_LSIZE(bp, x)	do { \
2945d7b4d4Matthew Ahrens	ASSERT(BP_IS_EMBEDDED(bp)); \
2955d7b4d4Matthew Ahrens	BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
2965d7b4d4Matthew Ahrens_NOTE(CONSTCOND) } while (0)
2975d7b4d4Matthew Ahrens
2985d7b4d4Matthew Ahrens#define	BPE_GET_PSIZE(bp)	\
2995d7b4d4Matthew Ahrens	(ASSERT(BP_IS_EMBEDDED(bp)), \
3005d7b4d4Matthew Ahrens	BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
3015d7b4d4Matthew Ahrens#define	BPE_SET_PSIZE(bp, x)	do { \
3025d7b4d4Matthew Ahrens	ASSERT(BP_IS_EMBEDDED(bp)); \
3035d7b4d4Matthew Ahrens	BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
3045d7b4d4Matthew Ahrens_NOTE(CONSTCOND) } while (0)
3055d7b4d4Matthew Ahrens
3065d7b4d4Matthew Ahrenstypedef enum bp_embedded_type {
3075d7b4d4Matthew Ahrens	BP_EMBEDDED_TYPE_DATA,
3085d7b4d4Matthew Ahrens	BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */
3095d7b4d4Matthew Ahrens	NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED
3105d7b4d4Matthew Ahrens} bp_embedded_type_t;
3115d7b4d4Matthew Ahrens
3125d7b4d4Matthew Ahrens#define	BPE_NUM_WORDS 14
3135d7b4d4Matthew Ahrens#define	BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
3145d7b4d4Matthew Ahrens#define	BPE_IS_PAYLOADWORD(bp, wp) \
3155d7b4d4Matthew Ahrens	((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
3165d7b4d4Matthew Ahrens
317fa9e406ahrens#define	SPA_BLKPTRSHIFT	7		/* blkptr_t is 128 bytes	*/
318fa9e406ahrens#define	SPA_DVAS_PER_BP	3		/* Number of DVAs in a bp	*/
319fa9e406ahrens
32043466aaMax Grossman/*
32143466aaMax Grossman * A block is a hole when it has either 1) never been written to, or
32243466aaMax Grossman * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
32343466aaMax Grossman * without physically allocating disk space. Holes are represented in the
32443466aaMax Grossman * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
32543466aaMax Grossman * done through the BP_IS_HOLE macro. For holes, the logical size, level,
32643466aaMax Grossman * DMU object type, and birth times are all also stored for holes that
32743466aaMax Grossman * were written to at some point (i.e. were punched after having been filled).
32843466aaMax Grossman */
329b24ab67Jeff Bonwicktypedef struct blkptr {
330b24ab67Jeff Bonwick	dva_t		blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
331b24ab67Jeff Bonwick	uint64_t	blk_prop;	/* size, compression, type, etc	    */
332b24ab67Jeff Bonwick	uint64_t	blk_pad[2];	/* Extra space for the future	    */
333b24ab67Jeff Bonwick	uint64_t	blk_phys_birth;	/* txg when block was allocated	    */
334b24ab67Jeff Bonwick	uint64_t	blk_birth;	/* transaction group at birth	    */
335b24ab67Jeff Bonwick	uint64_t	blk_fill;	/* fill count			    */
336b24ab67Jeff Bonwick	zio_cksum_t	blk_cksum;	/* 256-bit checksum		    */
337b24ab67Jeff Bonwick} blkptr_t;
338b24ab67Jeff Bonwick
339fa9e406ahrens/*
340fa9e406ahrens * Macros to get and set fields in a bp or DVA.
341fa9e406ahrens */
342fa9e406ahrens#define	DVA_GET_ASIZE(dva)	\
34343466aaMax Grossman	BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
344fa9e406ahrens#define	DVA_SET_ASIZE(dva, x)	\
34543466aaMax Grossman	BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
34643466aaMax Grossman	SPA_MINBLOCKSHIFT, 0, x)
347fa9e406ahrens
348fa9e406ahrens#define	DVA_GET_GRID(dva)	BF64_GET((dva)->dva_word[0], 24, 8)
349fa9e406ahrens#define	DVA_SET_GRID(dva, x)	BF64_SET((dva)->dva_word[0], 24, 8, x)
350fa9e406ahrens
351fa9e406ahrens#define	DVA_GET_VDEV(dva)	BF64_GET((dva)->dva_word[0], 32, 32)
352fa9e406ahrens#define	DVA_SET_VDEV(dva, x)	BF64_SET((dva)->dva_word[0], 32, 32, x)
353fa9e406ahrens
354fa9e406ahrens#define	DVA_GET_OFFSET(dva)	\
355fa9e406ahrens	BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
356fa9e406ahrens#define	DVA_SET_OFFSET(dva, x)	\
357fa9e406ahrens	BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
358fa9e406ahrens
359fa9e406ahrens#define	DVA_GET_GANG(dva)	BF64_GET((dva)->dva_word[1], 63, 1)
360fa9e406ahrens#define	DVA_SET_GANG(dva, x)	BF64_SET((dva)->dva_word[1], 63, 1, x)
361fa9e406ahrens
362fa9e406ahrens#define	BP_GET_LSIZE(bp)	\
3635d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ?	\
3645d7b4d4Matthew Ahrens	(BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
3655d7b4d4Matthew Ahrens	BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
3665d7b4d4Matthew Ahrens#define	BP_SET_LSIZE(bp, x)	do { \
3675d7b4d4Matthew Ahrens	ASSERT(!BP_IS_EMBEDDED(bp)); \
3685d7b4d4Matthew Ahrens	BF64_SET_SB((bp)->blk_prop, \
3695d7b4d4Matthew Ahrens	    0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
3705d7b4d4Matthew Ahrens_NOTE(CONSTCOND) } while (0)
371fa9e406ahrens
372fa9e406ahrens#define	BP_GET_PSIZE(bp)	\
3735d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? 0 : \
3745d7b4d4Matthew Ahrens	BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1))
3755d7b4d4Matthew Ahrens#define	BP_SET_PSIZE(bp, x)	do { \
3765d7b4d4Matthew Ahrens	ASSERT(!BP_IS_EMBEDDED(bp)); \
3775d7b4d4Matthew Ahrens	BF64_SET_SB((bp)->blk_prop, \
3785d7b4d4Matthew Ahrens	    16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
3795d7b4d4Matthew Ahrens_NOTE(CONSTCOND) } while (0)
3805d7b4d4Matthew Ahrens
381dcbf3bdGeorge Wilson#define	BP_GET_COMPRESS(bp)		\
382dcbf3bdGeorge Wilson	BF64_GET((bp)->blk_prop, 32, SPA_COMPRESSBITS)
383dcbf3bdGeorge Wilson#define	BP_SET_COMPRESS(bp, x)		\
384dcbf3bdGeorge Wilson	BF64_SET((bp)->blk_prop, 32, SPA_COMPRESSBITS, x)
385fa9e406ahrens
3865d7b4d4Matthew Ahrens#define	BP_IS_EMBEDDED(bp)		BF64_GET((bp)->blk_prop, 39, 1)
3875d7b4d4Matthew Ahrens#define	BP_SET_EMBEDDED(bp, x)		BF64_SET((bp)->blk_prop, 39, 1, x)
388b24ab67Jeff Bonwick
3895d7b4d4Matthew Ahrens#define	BP_GET_CHECKSUM(bp)		\
3905d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? ZIO_CHECKSUM_OFF : \
3915d7b4d4Matthew Ahrens	BF64_GET((bp)->blk_prop, 40, 8))
3925d7b4d4Matthew Ahrens#define	BP_SET_CHECKSUM(bp, x)		do { \
3935d7b4d4Matthew Ahrens	ASSERT(!BP_IS_EMBEDDED(bp)); \
3945d7b4d4Matthew Ahrens	BF64_SET((bp)->blk_prop, 40, 8, x); \
3955d7b4d4Matthew Ahrens_NOTE(CONSTCOND) } while (0)
396b24ab67Jeff Bonwick
397b24ab67Jeff Bonwick#define	BP_GET_TYPE(bp)			BF64_GET((bp)->blk_prop, 48, 8)
398b24ab67Jeff Bonwick#define	BP_SET_TYPE(bp, x)		BF64_SET((bp)->blk_prop, 48, 8, x)
399fa9e406ahrens
400b24ab67Jeff Bonwick#define	BP_GET_LEVEL(bp)		BF64_GET((bp)->blk_prop, 56, 5)
401b24ab67Jeff Bonwick#define	BP_SET_LEVEL(bp, x)		BF64_SET((bp)->blk_prop, 56, 5, x)
402fa9e406ahrens
403b24ab67Jeff Bonwick#define	BP_GET_DEDUP(bp)		BF64_GET((bp)->blk_prop, 62, 1)
404b24ab67Jeff Bonwick#define	BP_SET_DEDUP(bp, x)		BF64_SET((bp)->blk_prop, 62, 1, x)
405fa9e406ahrens
40643466aaMax Grossman#define	BP_GET_BYTEORDER(bp)		BF64_GET((bp)->blk_prop, 63, 1)
407b24ab67Jeff Bonwick#define	BP_SET_BYTEORDER(bp, x)		BF64_SET((bp)->blk_prop, 63, 1, x)
408b24ab67Jeff Bonwick
409b24ab67Jeff Bonwick#define	BP_PHYSICAL_BIRTH(bp)		\
4105d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? 0 : \
4115d7b4d4Matthew Ahrens	(bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
412b24ab67Jeff Bonwick
413b24ab67Jeff Bonwick#define	BP_SET_BIRTH(bp, logical, physical)	\
414b24ab67Jeff Bonwick{						\
4155d7b4d4Matthew Ahrens	ASSERT(!BP_IS_EMBEDDED(bp));		\
416b24ab67Jeff Bonwick	(bp)->blk_birth = (logical);		\
417b24ab67Jeff Bonwick	(bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
418b24ab67Jeff Bonwick}
419fa9e406ahrens
4205d7b4d4Matthew Ahrens#define	BP_GET_FILL(bp) (BP_IS_EMBEDDED(bp) ? 1 : (bp)->blk_fill)
4215d7b4d4Matthew Ahrens
422770499eDan Kimmel#define	BP_IS_METADATA(bp)	\
423770499eDan Kimmel	(BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))
424770499eDan Kimmel
425fa9e406ahrens#define	BP_GET_ASIZE(bp)	\
4265d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? 0 : \
4275d7b4d4Matthew Ahrens	DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
4285d7b4d4Matthew Ahrens	DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
4295d7b4d4Matthew Ahrens	DVA_GET_ASIZE(&(bp)->blk_dva[2]))
43099653d4eschrock
431770499eDan Kimmel#define	BP_GET_UCSIZE(bp)	\
432770499eDan Kimmel	(BP_IS_METADATA(bp) ? BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
433fa9e406ahrens
43444cd46cbillm#define	BP_GET_NDVAS(bp)	\
4355d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? 0 : \
4365d7b4d4Matthew Ahrens	!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
43744cd46cbillm	!!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
43844cd46cbillm	!!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
43944cd46cbillm
44044cd46cbillm#define	BP_COUNT_GANG(bp)	\
4415d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? 0 : \
44244cd46cbillm	(DVA_GET_GANG(&(bp)->blk_dva[0]) + \
44344cd46cbillm	DVA_GET_GANG(&(bp)->blk_dva[1]) + \
4445d7b4d4Matthew Ahrens	DVA_GET_GANG(&(bp)->blk_dva[2])))
44544cd46cbillm
446fa9e406ahrens#define	DVA_EQUAL(dva1, dva2)	\
447fa9e406ahrens	((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
448fa9e406ahrens	(dva1)->dva_word[0] == (dva2)->dva_word[0])
449fa9e406ahrens
450b24ab67Jeff Bonwick#define	BP_EQUAL(bp1, bp2)	\
451b24ab67Jeff Bonwick	(BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) &&	\
4525d7b4d4Matthew Ahrens	(bp1)->blk_birth == (bp2)->blk_birth &&			\
453b24ab67Jeff Bonwick	DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) &&	\
454b24ab67Jeff Bonwick	DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) &&	\
455b24ab67Jeff Bonwick	DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
456b24ab67Jeff Bonwick
4576b4acc8ahrens#define	ZIO_CHECKSUM_EQUAL(zc1, zc2) \
4586b4acc8ahrens	(0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
4596b4acc8ahrens	((zc1).zc_word[1] - (zc2).zc_word[1]) | \
4606b4acc8ahrens	((zc1).zc_word[2] - (zc2).zc_word[2]) | \
4616b4acc8ahrens	((zc1).zc_word[3] - (zc2).zc_word[3])))
4626b4acc8ahrens
46398110f0Matthew Ahrens#define	ZIO_CHECKSUM_IS_ZERO(zc) \
46498110f0Matthew Ahrens	(0 == ((zc)->zc_word[0] | (zc)->zc_word[1] | \
46598110f0Matthew Ahrens	(zc)->zc_word[2] | (zc)->zc_word[3]))
46698110f0Matthew Ahrens
46798110f0Matthew Ahrens#define	ZIO_CHECKSUM_BSWAP(zcp)					\
46898110f0Matthew Ahrens{								\
46998110f0Matthew Ahrens	(zcp)->zc_word[0] = BSWAP_64((zcp)->zc_word[0]);	\
47098110f0Matthew Ahrens	(zcp)->zc_word[1] = BSWAP_64((zcp)->zc_word[1]);	\
47198110f0Matthew Ahrens	(zcp)->zc_word[2] = BSWAP_64((zcp)->zc_word[2]);	\
47298110f0Matthew Ahrens	(zcp)->zc_word[3] = BSWAP_64((zcp)->zc_word[3]);	\
47398110f0Matthew Ahrens}
47498110f0Matthew Ahrens
47598110f0Matthew Ahrens
476fa9e406ahrens#define	DVA_IS_VALID(dva)	(DVA_GET_ASIZE(dva) != 0)
477fa9e406ahrens
478fa9e406ahrens#define	ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3)	\
479fa9e406ahrens{						\
480fa9e406ahrens	(zcp)->zc_word[0] = w0;			\
481fa9e406ahrens	(zcp)->zc_word[1] = w1;			\
482fa9e406ahrens	(zcp)->zc_word[2] = w2;			\
483fa9e406ahrens	(zcp)->zc_word[3] = w3;			\
484fa9e406ahrens}
485fa9e406ahrens
4865d7b4d4Matthew Ahrens#define	BP_IDENTITY(bp)		(ASSERT(!BP_IS_EMBEDDED(bp)), &(bp)->blk_dva[0])
4875d7b4d4Matthew Ahrens#define	BP_IS_GANG(bp)		\
4885d7b4d4Matthew Ahrens	(BP_IS_EMBEDDED(bp) ? B_FALSE : DVA_GET_GANG(BP_IDENTITY(bp)))
48943466aaMax Grossman#define	DVA_IS_EMPTY(dva)	((dva)->dva_word[0] == 0ULL &&	\
49043466aaMax Grossman				(dva)->dva_word[1] == 0ULL)
4915d7b4d4Matthew Ahrens#define	BP_IS_HOLE(bp) \
4925d7b4d4Matthew Ahrens	(!BP_IS_EMBEDDED(bp) && DVA_IS_EMPTY(BP_IDENTITY(bp)))
493fa9e406ahrens
4946e1f5caNeil Perrin/* BP_IS_RAIDZ(bp) assumes no block compression */
4956e1f5caNeil Perrin#define	BP_IS_RAIDZ(bp)		(DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
4966e1f5caNeil Perrin				BP_GET_PSIZE(bp))
4976e1f5caNeil Perrin
498e14bb32Jeff Bonwick#define	BP_ZERO(bp)				\
499fa9e406ahrens{						\
500fa9e406ahrens	(bp)->blk_dva[0].dva_word[0] = 0;	\
501fa9e406ahrens	(bp)->blk_dva[0].dva_word[1] = 0;	\
502fa9e406ahrens	(bp)->blk_dva[1].dva_word[0] = 0;	\
503fa9e406ahrens	(bp)->blk_dva[1].dva_word[1] = 0;	\
504fa9e406ahrens	(bp)->blk_dva[2].dva_word[0] = 0;	\
505fa9e406ahrens	(bp)->blk_dva[2].dva_word[1] = 0;	\
506fa9e406ahrens	(bp)->blk_prop = 0;			\
507fa9e406ahrens	(bp)->blk_pad[0] = 0;			\
508fa9e406ahrens	(bp)->blk_pad[1] = 0;			\
509b24ab67Jeff Bonwick	(bp)->blk_phys_birth = 0;		\
510e14bb32Jeff Bonwick	(bp)->blk_birth = 0;			\
511fa9e406ahrens	(bp)->blk_fill = 0;			\
512fa9e406ahrens	ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0);	\
513fa9e406ahrens}
514fa9e406ahrens
515fa9e406ahrens#ifdef _BIG_ENDIAN
516fa9e406ahrens#define	ZFS_HOST_BYTEORDER	(0ULL)
517fa9e406ahrens#else
51843466aaMax Grossman#define	ZFS_HOST_BYTEORDER	(1ULL)
519fa9e406ahrens#endif
520fa9e406ahrens
521fa9e406ahrens#define	BP_SHOULD_BYTESWAP(bp)	(BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
522fa9e406ahrens
52344cd46cbillm#define	BP_SPRINTF_LEN	320
524fbabab8maybee
525b24ab67Jeff Bonwick/*
526b24ab67Jeff Bonwick * This macro allows code sharing between zfs, libzpool, and mdb.
527b24ab67Jeff Bonwick * 'func' is either snprintf() or mdb_snprintf().
528b24ab67Jeff Bonwick * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
529b24ab67Jeff Bonwick */
53043466aaMax Grossman#define	SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
531b24ab67Jeff Bonwick{									\
532b24ab67Jeff Bonwick	static const char *copyname[] =					\
533b24ab67Jeff Bonwick	    { "zero", "single", "double", "triple" };			\
534b24ab67Jeff Bonwick	int len = 0;							\
535b24ab67Jeff Bonwick	int copies = 0;							\
536b24ab67Jeff Bonwick									\
537b24ab67Jeff Bonwick	if (bp == NULL) {						\
53843466aaMax Grossman		len += func(buf + len, size - len, "<NULL>");		\
539b24ab67Jeff Bonwick	} else if (BP_IS_HOLE(bp)) {					\
54070163acPrakash Surya		len += func(buf + len, size - len,			\
54170163acPrakash Surya		    "HOLE [L%llu %s] "					\
54270163acPrakash Surya		    "size=%llxL birth=%lluL",				\
54370163acPrakash Surya		    (u_longlong_t)BP_GET_LEVEL(bp),			\
54470163acPrakash Surya		    type,						\
54570163acPrakash Surya		    (u_longlong_t)BP_GET_LSIZE(bp),			\
54670163acPrakash Surya		    (u_longlong_t)bp->blk_birth);			\
5475d7b4d4Matthew Ahrens	} else if (BP_IS_EMBEDDED(bp)) {				\
5485d7b4d4Matthew Ahrens		len = func(buf + len, size - len,			\
5495d7b4d4Matthew Ahrens		    "EMBEDDED [L%llu %s] et=%u %s "			\
5505d7b4d4Matthew Ahrens		    "size=%llxL/%llxP birth=%lluL",			\
5515d7b4d4Matthew Ahrens		    (u_longlong_t)BP_GET_LEVEL(bp),			\
5525d7b4d4Matthew Ahrens		    type,						\
5535d7b4d4Matthew Ahrens		    (int)BPE_GET_ETYPE(bp),				\
5545d7b4d4Matthew Ahrens		    compress,						\
5555d7b4d4Matthew Ahrens		    (u_longlong_t)BPE_GET_LSIZE(bp),			\
5565d7b4d4Matthew Ahrens		    (u_longlong_t)BPE_GET_PSIZE(bp),			\
5575d7b4d4Matthew Ahrens		    (u_longlong_t)bp->blk_birth);			\
558b24ab67Jeff Bonwick	} else {							\
559b24ab67Jeff Bonwick		for (int d = 0; d < BP_GET_NDVAS(bp); d++) {		\
560b24ab67Jeff Bonwick			const dva_t *dva = &bp->blk_dva[d];		\
561b24ab67Jeff Bonwick			if (DVA_IS_VALID(dva))				\
562b24ab67Jeff Bonwick				copies++;				\
563b24ab67Jeff Bonwick			len += func(buf + len, size - len,		\
564b24ab67Jeff Bonwick			    "DVA[%d]=<%llu:%llx:%llx>%c", d,		\
565b24ab67Jeff Bonwick			    (u_longlong_t)DVA_GET_VDEV(dva),		\
566b24ab67Jeff Bonwick			    (u_longlong_t)DVA_GET_OFFSET(dva),		\
567b24ab67Jeff Bonwick			    (u_longlong_t)DVA_GET_ASIZE(dva),		\
568b24ab67Jeff Bonwick			    ws);					\
569b24ab67Jeff Bonwick		}							\
570b24ab67Jeff Bonwick		if (BP_IS_GANG(bp) &&					\
571b24ab67Jeff Bonwick		    DVA_GET_ASIZE(&bp->blk_dva[2]) <=			\
572b24ab67Jeff Bonwick		    DVA_GET_ASIZE(&bp->blk_dva[1]) / 2)			\
573b24ab67Jeff Bonwick			copies--;					\
574b24ab67Jeff Bonwick		len += func(buf + len, size - len,			\
575b24ab67Jeff Bonwick		    "[L%llu %s] %s %s %s %s %s %s%c"			\
576b24ab67Jeff Bonwick		    "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c"	\
577b24ab67Jeff Bonwick		    "cksum=%llx:%llx:%llx:%llx",			\
578b24ab67Jeff Bonwick		    (u_longlong_t)BP_GET_LEVEL(bp),			\
579b24ab67Jeff Bonwick		    type,						\
580b24ab67Jeff Bonwick		    checksum,						\
581b24ab67Jeff Bonwick		    compress,						\
582b24ab67Jeff Bonwick		    BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE",		\
583b24ab67Jeff Bonwick		    BP_IS_GANG(bp) ? "gang" : "contiguous",		\
584b24ab67Jeff Bonwick		    BP_GET_DEDUP(bp) ? "dedup" : "unique",		\
585b24ab67Jeff Bonwick		    copyname[copies],					\
586b24ab67Jeff Bonwick		    ws,							\
587b24ab67Jeff Bonwick		    (u_longlong_t)BP_GET_LSIZE(bp),			\
588b24ab67Jeff Bonwick		    (u_longlong_t)BP_GET_PSIZE(bp),			\
589b24ab67Jeff Bonwick		    (u_longlong_t)bp->blk_birth,			\
590b24ab67Jeff Bonwick		    (u_longlong_t)BP_PHYSICAL_BIRTH(bp),		\
5915d7b4d4Matthew Ahrens		    (u_longlong_t)BP_GET_FILL(bp),			\
592b24ab67Jeff Bonwick		    ws,							\
593b24ab67Jeff Bonwick		    (u_longlong_t)bp->blk_cksum.zc_word[0],		\
594b24ab67Jeff Bonwick		    (u_longlong_t)bp->blk_cksum.zc_word[1],		\
595b24ab67Jeff Bonwick		    (u_longlong_t)bp->blk_cksum.zc_word[2],		\
596b24ab67Jeff Bonwick		    (u_longlong_t)bp->blk_cksum.zc_word[3]);		\
597b24ab67Jeff Bonwick	}								\
598b24ab67Jeff Bonwick	ASSERT(len < size);						\
599b24ab67Jeff Bonwick}
600b24ab67Jeff Bonwick
601ad23a2djohansen#define	BP_GET_BUFC_TYPE(bp)						\
602770499eDan Kimmel	(BP_IS_METADATA(bp) ? ARC_BUFC_METADATA : ARC_BUFC_DATA)
603fa9e406ahrens
6041195e68Mark J Musantetypedef enum spa_import_type {
6051195e68Mark J Musante	SPA_IMPORT_EXISTING,
6061195e68Mark J Musante	SPA_IMPORT_ASSEMBLE
6071195e68Mark J Musante} spa_import_type_t;
6081195e68Mark J Musante
609fa9e406ahrens/* state manipulation functions */
610fa9e406ahrensextern int spa_open(const char *pool, spa_t **, void *tag);
611468c413Tim Haleyextern int spa_open_rewind(const char *pool, spa_t **, void *tag,
612468c413Tim Haley    nvlist_t *policy, nvlist_t **config);
613ad135b5Christopher Sidenextern int spa_get_stats(const char *pool, nvlist_t **config, char *altroot,
614ad135b5Christopher Siden    size_t buflen);
615990b485llingextern int spa_create(const char *pool, nvlist_t *config, nvlist_t *props,
6164445fffMatthew Ahrens    nvlist_t *zplprops);
617051aabetaylorextern int spa_import_rootpool(char *devpath, char *devid);
6184b964adGeorge Wilsonextern int spa_import(const char *pool, nvlist_t *config, nvlist_t *props,
6194b964adGeorge Wilson    uint64_t flags);
620fa9e406ahrensextern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
621fa9e406ahrensextern int spa_destroy(char *pool);
622394ab0cGeorge Wilsonextern int spa_export(char *pool, nvlist_t **oldconfig, boolean_t force,
623394ab0cGeorge Wilson    boolean_t hardforce);
624ea8dc4beschrockextern int spa_reset(char *pool);
625ea8dc4beschrockextern void spa_async_request(spa_t *spa, int flag);
626088f389ahrensextern void spa_async_unrequest(spa_t *spa, int flag);
627ea8dc4beschrockextern void spa_async_suspend(spa_t *spa);
628ea8dc4beschrockextern void spa_async_resume(spa_t *spa);
629ea8dc4beschrockextern spa_t *spa_inject_addref(char *pool);
630ea8dc4beschrockextern void spa_inject_delref(spa_t *spa);
6313f9d6adLin Lingextern void spa_scan_stat_init(spa_t *spa);
6323f9d6adLin Lingextern int spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps);
633ea8dc4beschrock
634e14bb32Jeff Bonwick#define	SPA_ASYNC_CONFIG_UPDATE	0x01
635e14bb32Jeff Bonwick#define	SPA_ASYNC_REMOVE	0x02
636e14bb32Jeff Bonwick#define	SPA_ASYNC_PROBE		0x04
637e14bb32Jeff Bonwick#define	SPA_ASYNC_RESILVER_DONE	0x08
638e14bb32Jeff Bonwick#define	SPA_ASYNC_RESILVER	0x10
639573ca77George Wilson#define	SPA_ASYNC_AUTOEXPAND	0x20
6403f9d6adLin Ling#define	SPA_ASYNC_REMOVE_DONE	0x40
6413f9d6adLin Ling#define	SPA_ASYNC_REMOVE_STOP	0x80
6423f9d6adLin Ling
6433f9d6adLin Ling/*
6443f9d6adLin Ling * Controls the behavior of spa_vdev_remove().
6453f9d6adLin Ling */
6463f9d6adLin Ling#define	SPA_REMOVE_UNSPARE	0x01
6473f9d6adLin Ling#define	SPA_REMOVE_DONE		0x02
648fa9e406ahrens
649fa9e406ahrens/* device manipulation */
650fa9e406ahrensextern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
651ea8dc4beschrockextern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
652fa9e406ahrens    int replacing);
6538ad4d6dJeff Bonwickextern int spa_vdev_detach(spa_t *spa, uint64_t guid, uint64_t pguid,
6548ad4d6dJeff Bonwick    int replace_done);
65599653d4eschrockextern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
6563f9d6adLin Lingextern boolean_t spa_vdev_remove_active(spa_t *spa);
657c67d967eschrockextern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
6586809eb4Eric Schrockextern int spa_vdev_setfru(spa_t *spa, uint64_t guid, const char *newfru);
6591195e68Mark J Musanteextern int spa_vdev_split_mirror(spa_t *spa, char *newname, nvlist_t *config,
6601195e68Mark J Musante    nvlist_t *props, boolean_t exp);
661fa9e406ahrens
66299653d4eschrock/* spare state (which is global across all pools) */
66339c2341eschrockextern void spa_spare_add(vdev_t *vd);
66439c2341eschrockextern void spa_spare_remove(vdev_t *vd);
66589a89ebllingextern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt);
66639c2341eschrockextern void spa_spare_activate(vdev_t *vd);
66799653d4eschrock
668fa94a07brendan/* L2ARC state (which is global across all pools) */
669fa94a07brendanextern void spa_l2cache_add(vdev_t *vd);
670fa94a07brendanextern void spa_l2cache_remove(vdev_t *vd);
671fa94a07brendanextern boolean_t spa_l2cache_exists(uint64_t guid, uint64_t *pool);
672fa94a07brendanextern void spa_l2cache_activate(vdev_t *vd);
673fa94a07brendanextern void spa_l2cache_drop(spa_t *spa);
674fa94a07brendan
6753f9d6adLin Ling/* scanning */
6763f9d6adLin Lingextern int spa_scan(spa_t *spa, pool_scan_func_t func);
6773f9d6adLin Lingextern int spa_scan_stop(spa_t *spa);
678fa9e406ahrens
679fa9e406ahrens/* spa syncing */
680fa9e406ahrensextern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
681fa9e406ahrensextern void spa_sync_allpools(void);
682fa9e406ahrens
6833a737e0brendan/* spa namespace global mutex */
6843a737e0brendanextern kmutex_t spa_namespace_lock;
6853a737e0brendan
686fa9e406ahrens/*
687fa9e406ahrens * SPA configuration functions in spa_config.c
688fa9e406ahrens */
6890373e76bonwick
6900373e76bonwick#define	SPA_CONFIG_UPDATE_POOL	0
6910373e76bonwick#define	SPA_CONFIG_UPDATE_VDEVS	1
6920373e76bonwick
693c5904d1eschrockextern void spa_config_sync(spa_t *, boolean_t, boolean_t);
694fa9e406ahrensextern void spa_config_load(void);
695fa9e406ahrensextern nvlist_t *spa_all_configs(uint64_t *);
696fa9e406ahrensextern void spa_config_set(spa_t *spa, nvlist_t *config);
697fa9e406ahrensextern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
698fa9e406ahrens    int getstats);
6990373e76bonwickextern void spa_config_update(spa_t *spa, int what);
700fa9e406ahrens
701fa9e406ahrens/*
702fa9e406ahrens * Miscellaneous SPA routines in spa_misc.c
703fa9e406ahrens */
704fa9e406ahrens
705fa9e406ahrens/* Namespace manipulation */
706fa9e406ahrensextern spa_t *spa_lookup(const char *name);
707468c413Tim Haleyextern spa_t *spa_add(const char *name, nvlist_t *config, const char *altroot);
708fa9e406ahrensextern void spa_remove(spa_t *spa);
709fa9e406ahrensextern spa_t *spa_next(spa_t *prev);
710fa9e406ahrens
711fa9e406ahrens/* Refcount functions */
712fa9e406ahrensextern void spa_open_ref(spa_t *spa, void *tag);
713fa9e406ahrensextern void spa_close(spa_t *spa, void *tag);
714bc9014eJustin Gibbsextern void spa_async_close(spa_t *spa, void *tag);
715fa9e406ahrensextern boolean_t spa_refcount_zero(spa_t *spa);
716fa9e406ahrens
7178f18d1fGeorge Wilson#define	SCL_NONE	0x00
718e14bb32Jeff Bonwick#define	SCL_CONFIG	0x01
719e14bb32Jeff Bonwick#define	SCL_STATE	0x02
720e14bb32Jeff Bonwick#define	SCL_L2ARC	0x04		/* hack until L2ARC 2.0 */
721e14bb32Jeff Bonwick#define	SCL_ALLOC	0x08
722e14bb32Jeff Bonwick#define	SCL_ZIO		0x10
723e14bb32Jeff Bonwick#define	SCL_FREE	0x20
724e14bb32Jeff Bonwick#define	SCL_VDEV	0x40
725e14bb32Jeff Bonwick#define	SCL_LOCKS	7
726e14bb32Jeff Bonwick#define	SCL_ALL		((1 << SCL_LOCKS) - 1)
727e14bb32Jeff Bonwick#define	SCL_STATE_ALL	(SCL_STATE | SCL_L2ARC | SCL_ZIO)
728e14bb32Jeff Bonwick
729e14bb32Jeff Bonwick/* Pool configuration locks */
730e14bb32Jeff Bonwickextern int spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw);
731e14bb32Jeff Bonwickextern void spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw);
732e14bb32Jeff Bonwickextern void spa_config_exit(spa_t *spa, int locks, void *tag);
733e14bb32Jeff Bonwickextern int spa_config_held(spa_t *spa, int locks, krw_t rw);
734fa9e406ahrens
735fa9e406ahrens/* Pool vdev add/remove lock */
736fa9e406ahrensextern uint64_t spa_vdev_enter(spa_t *spa);
73788ecc94George Wilsonextern uint64_t spa_vdev_config_enter(spa_t *spa);
73888ecc94George Wilsonextern void spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg,
73988ecc94George Wilson    int error, char *tag);
740fa9e406ahrensextern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
741fa9e406ahrens
742e14bb32Jeff Bonwick/* Pool vdev state change lock */
7438f18d1fGeorge Wilsonextern void spa_vdev_state_enter(spa_t *spa, int oplock);
744e14bb32Jeff Bonwickextern int spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error);
745e14bb32Jeff Bonwick
746b24ab67Jeff Bonwick/* Log state */
747b24ab67Jeff Bonwicktypedef enum spa_log_state {
748b24ab67Jeff Bonwick	SPA_LOG_UNKNOWN = 0,	/* unknown log state */
749b24ab67Jeff Bonwick	SPA_LOG_MISSING,	/* missing log(s) */
750b24ab67Jeff Bonwick	SPA_LOG_CLEAR,		/* clear the log(s) */
751b24ab67Jeff Bonwick	SPA_LOG_GOOD,		/* log(s) are good */
752b24ab67Jeff Bonwick} spa_log_state_t;
753b24ab67Jeff Bonwick
754b24ab67Jeff Bonwickextern spa_log_state_t spa_get_log_state(spa_t *spa);
755b24ab67Jeff Bonwickextern void spa_set_log_state(spa_t *spa, spa_log_state_t state);
7561195e68Mark J Musanteextern int spa_offline_log(spa_t *spa);
757b24ab67Jeff Bonwick
758b24ab67Jeff Bonwick/* Log claim callback */
759b24ab67Jeff Bonwickextern void spa_claim_notify(zio_t *zio);
760b24ab67Jeff Bonwick
761fa9e406ahrens/* Accessor functions */
76288b7b0fMatthew Ahrensextern boolean_t spa_shutting_down(spa_t *spa);
763fa9e406ahrensextern struct dsl_pool *spa_get_dsl(spa_t *spa);
764ad135b5Christopher Sidenextern boolean_t spa_is_initializing(spa_t *spa);
765fa9e406ahrensextern blkptr_t *spa_get_rootblkptr(spa_t *spa);
766fa9e406ahrensextern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
767fa9e406ahrensextern void spa_altroot(spa_t *, char *, size_t);
768fa9e406ahrensextern int spa_sync_pass(spa_t *spa);
769fa9e406ahrensextern char *spa_name(spa_t *spa);
770fa9e406ahrensextern uint64_t spa_guid(spa_t *spa);
771e9103aaGarrett D'Amoreextern uint64_t spa_load_guid(spa_t *spa);
772fa9e406ahrensextern uint64_t spa_last_synced_txg(spa_t *spa);
773fa9e406ahrensextern uint64_t spa_first_txg(spa_t *spa);
774b24ab67Jeff Bonwickextern uint64_t spa_syncing_txg(spa_t *spa);
7753991b53George Wilsonextern uint64_t spa_final_dirty_txg(spa_t *spa);
77699653d4eschrockextern uint64_t spa_version(spa_t *spa);
77788b7b0fMatthew Ahrensextern pool_state_t spa_state(spa_t *spa);
778b16da2eGeorge Wilsonextern spa_load_state_t spa_load_state(spa_t *spa);
779fa9e406ahrensextern uint64_t spa_freeze_txg(spa_t *spa);
78061e255cMatthew Ahrensextern uint64_t spa_get_worst_case_asize(spa_t *spa, uint64_t lsize);
781485bbbfGeorge Wilsonextern uint64_t spa_get_dspace(spa_t *spa);
782c39f2c8Christopher Sidenextern uint64_t spa_get_slop_space(spa_t *spa);
783485bbbfGeorge Wilsonextern void spa_update_dspace(spa_t *spa);
78444cd46cbillmextern uint64_t spa_version(spa_t *spa);
785b24ab67Jeff Bonwickextern boolean_t spa_deflate(spa_t *spa);
786b24ab67Jeff Bonwickextern metaslab_class_t *spa_normal_class(spa_t *spa);
787b24ab67Jeff Bonwickextern metaslab_class_t *spa_log_class(spa_t *spa);
788bc9014eJustin Gibbsextern void spa_evicting_os_register(spa_t *, objset_t *os);
789bc9014eJustin Gibbsextern void spa_evicting_os_deregister(spa_t *, objset_t *os);
790bc9014eJustin Gibbsextern void spa_evicting_os_wait(spa_t *spa);
79144cd46cbillmextern int spa_max_replication(spa_t *spa);
7923f9d6adLin Lingextern int spa_prev_software_version(spa_t *spa);
793fa9e406ahrensextern int spa_busy(void);
7940a4e951gwextern uint8_t spa_get_failmode(spa_t *spa);
795e14bb32Jeff Bonwickextern boolean_t spa_suspended(spa_t *spa);
796b24ab67Jeff Bonwickextern uint64_t spa_bootfs(spa_t *spa);
797b24ab67Jeff Bonwickextern uint64_t spa_delegation(spa_t *spa);
798b24ab67Jeff Bonwickextern objset_t *spa_meta_objset(spa_t *spa);
799283b846George.Wilsonextern uint64_t spa_deadman_synctime(spa_t *spa);
800fa9e406ahrens
801fa9e406ahrens/* Miscellaneous support routines */
80243466aaMax Grossmanextern void spa_activate_mos_feature(spa_t *spa, const char *feature,
80343466aaMax Grossman    dmu_tx_t *tx);
804ad135b5Christopher Sidenextern void spa_deactivate_mos_feature(spa_t *spa, const char *feature);
805fa9e406ahrensextern int spa_rename(const char *oldname, const char *newname);
806f9af39bGeorge Wilsonextern spa_t *spa_by_guid(uint64_t pool_guid, uint64_t device_guid);
807fa9e406ahrensextern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
808fa9e406ahrensextern char *spa_strdup(const char *);
809fa9e406ahrensextern void spa_strfree(char *);
810fa9e406ahrensextern uint64_t spa_get_random(uint64_t range);
8111195e68Mark J Musanteextern uint64_t spa_generate_guid(spa_t *spa);
81243466aaMax Grossmanextern void snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp);
813fa9e406ahrensextern void spa_freeze(spa_t *spa);
814e9103aaGarrett D'Amoreextern int spa_change_guid(spa_t *spa);
815990b485llingextern void spa_upgrade(spa_t *spa, uint64_t version);
816fa9e406ahrensextern void spa_evict_all(void);
817c5904d1eschrockextern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid,
818c5904d1eschrock    boolean_t l2cache);
81999653d4eschrockextern boolean_t spa_has_spare(spa_t *, uint64_t guid);
820b24ab67Jeff Bonwickextern uint64_t dva_get_dsize_sync(spa_t *spa, const dva_t *dva);
821b24ab67Jeff Bonwickextern uint64_t bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp);
822b24ab67Jeff Bonwickextern uint64_t bp_get_dsize(spa_t *spa, const blkptr_t *bp);
8236ce0521perrinextern boolean_t spa_has_slogs(spa_t *spa);
824bf82a41eschrockextern boolean_t spa_is_root(spa_t *spa);
8258ad4d6dJeff Bonwickextern boolean_t spa_writeable(spa_t *spa);
82673527f4Alex Reeceextern boolean_t spa_has_pending_synctask(spa_t *spa);
827b515258Matthew Ahrensextern int