xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/spa.h (revision e9dbad6f263d5570ed7ff5443ec5b958af8c24d7)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5ea8dc4b6Seschrock  * Common Development and Distribution License (the "License").
6ea8dc4b6Seschrock  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21fa9e4066Sahrens /*
22c67d9675Seschrock  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
23fa9e4066Sahrens  * Use is subject to license terms.
24fa9e4066Sahrens  */
25fa9e4066Sahrens 
26fa9e4066Sahrens #ifndef _SYS_SPA_H
27fa9e4066Sahrens #define	_SYS_SPA_H
28fa9e4066Sahrens 
29fa9e4066Sahrens #pragma ident	"%Z%%M%	%I%	%E% SMI"
30fa9e4066Sahrens 
31fa9e4066Sahrens #include <sys/avl.h>
32fa9e4066Sahrens #include <sys/zfs_context.h>
33fa9e4066Sahrens #include <sys/nvpair.h>
34fa9e4066Sahrens #include <sys/sysmacros.h>
35fa9e4066Sahrens #include <sys/types.h>
36fa9e4066Sahrens #include <sys/fs/zfs.h>
37fa9e4066Sahrens 
38fa9e4066Sahrens #ifdef	__cplusplus
39fa9e4066Sahrens extern "C" {
40fa9e4066Sahrens #endif
41fa9e4066Sahrens 
42fa9e4066Sahrens /*
43fa9e4066Sahrens  * Forward references that lots of things need.
44fa9e4066Sahrens  */
45fa9e4066Sahrens typedef struct spa spa_t;
46fa9e4066Sahrens typedef struct vdev vdev_t;
47fa9e4066Sahrens typedef struct metaslab metaslab_t;
48fa9e4066Sahrens typedef struct zilog zilog_t;
49fa9e4066Sahrens typedef struct traverse_handle traverse_handle_t;
50fa9e4066Sahrens struct dsl_pool;
51fa9e4066Sahrens 
52fa9e4066Sahrens /*
53fa9e4066Sahrens  * General-purpose 32-bit and 64-bit bitfield encodings.
54fa9e4066Sahrens  */
55fa9e4066Sahrens #define	BF32_DECODE(x, low, len)	P2PHASE((x) >> (low), 1U << (len))
56fa9e4066Sahrens #define	BF64_DECODE(x, low, len)	P2PHASE((x) >> (low), 1ULL << (len))
57fa9e4066Sahrens #define	BF32_ENCODE(x, low, len)	(P2PHASE((x), 1U << (len)) << (low))
58fa9e4066Sahrens #define	BF64_ENCODE(x, low, len)	(P2PHASE((x), 1ULL << (len)) << (low))
59fa9e4066Sahrens 
60fa9e4066Sahrens #define	BF32_GET(x, low, len)		BF32_DECODE(x, low, len)
61fa9e4066Sahrens #define	BF64_GET(x, low, len)		BF64_DECODE(x, low, len)
62fa9e4066Sahrens 
63fa9e4066Sahrens #define	BF32_SET(x, low, len, val)	\
64fa9e4066Sahrens 	((x) ^= BF32_ENCODE((x >> low) ^ val, low, len))
65fa9e4066Sahrens #define	BF64_SET(x, low, len, val)	\
66fa9e4066Sahrens 	((x) ^= BF64_ENCODE((x >> low) ^ val, low, len))
67fa9e4066Sahrens 
68fa9e4066Sahrens #define	BF32_GET_SB(x, low, len, shift, bias)	\
69fa9e4066Sahrens 	((BF32_GET(x, low, len) + (bias)) << (shift))
70fa9e4066Sahrens #define	BF64_GET_SB(x, low, len, shift, bias)	\
71fa9e4066Sahrens 	((BF64_GET(x, low, len) + (bias)) << (shift))
72fa9e4066Sahrens 
73fa9e4066Sahrens #define	BF32_SET_SB(x, low, len, shift, bias, val)	\
74fa9e4066Sahrens 	BF32_SET(x, low, len, ((val) >> (shift)) - (bias))
75fa9e4066Sahrens #define	BF64_SET_SB(x, low, len, shift, bias, val)	\
76fa9e4066Sahrens 	BF64_SET(x, low, len, ((val) >> (shift)) - (bias))
77fa9e4066Sahrens 
78fa9e4066Sahrens /*
79fa9e4066Sahrens  * We currently support nine block sizes, from 512 bytes to 128K.
80fa9e4066Sahrens  * We could go higher, but the benefits are near-zero and the cost
81fa9e4066Sahrens  * of COWing a giant block to modify one byte would become excessive.
82fa9e4066Sahrens  */
83fa9e4066Sahrens #define	SPA_MINBLOCKSHIFT	9
84fa9e4066Sahrens #define	SPA_MAXBLOCKSHIFT	17
85fa9e4066Sahrens #define	SPA_MINBLOCKSIZE	(1ULL << SPA_MINBLOCKSHIFT)
86fa9e4066Sahrens #define	SPA_MAXBLOCKSIZE	(1ULL << SPA_MAXBLOCKSHIFT)
87fa9e4066Sahrens 
88fa9e4066Sahrens #define	SPA_BLOCKSIZES		(SPA_MAXBLOCKSHIFT - SPA_MINBLOCKSHIFT + 1)
89fa9e4066Sahrens 
90fa9e4066Sahrens /*
91fa9e4066Sahrens  * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
92fa9e4066Sahrens  * The ASIZE encoding should be at least 64 times larger (6 more bits)
93fa9e4066Sahrens  * to support up to 4-way RAID-Z mirror mode with worst-case gang block
94fa9e4066Sahrens  * overhead, three DVAs per bp, plus one more bit in case we do anything
95fa9e4066Sahrens  * else that expands the ASIZE.
96fa9e4066Sahrens  */
97fa9e4066Sahrens #define	SPA_LSIZEBITS		16	/* LSIZE up to 32M (2^16 * 512)	*/
98fa9e4066Sahrens #define	SPA_PSIZEBITS		16	/* PSIZE up to 32M (2^16 * 512)	*/
99fa9e4066Sahrens #define	SPA_ASIZEBITS		24	/* ASIZE up to 64 times larger	*/
100fa9e4066Sahrens 
101fa9e4066Sahrens /*
102fa9e4066Sahrens  * All SPA data is represented by 128-bit data virtual addresses (DVAs).
103fa9e4066Sahrens  * The members of the dva_t should be considered opaque outside the SPA.
104fa9e4066Sahrens  */
105fa9e4066Sahrens typedef struct dva {
106fa9e4066Sahrens 	uint64_t	dva_word[2];
107fa9e4066Sahrens } dva_t;
108fa9e4066Sahrens 
109fa9e4066Sahrens /*
110fa9e4066Sahrens  * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
111fa9e4066Sahrens  */
112fa9e4066Sahrens typedef struct zio_cksum {
113fa9e4066Sahrens 	uint64_t	zc_word[4];
114fa9e4066Sahrens } zio_cksum_t;
115fa9e4066Sahrens 
116fa9e4066Sahrens /*
117fa9e4066Sahrens  * Each block is described by its DVAs, time of birth, checksum, etc.
118fa9e4066Sahrens  * The word-by-word, bit-by-bit layout of the blkptr is as follows:
119fa9e4066Sahrens  *
120fa9e4066Sahrens  *	64	56	48	40	32	24	16	8	0
121fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
122fa9e4066Sahrens  * 0	|		vdev1		| GRID  |	  ASIZE		|
123fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
124fa9e4066Sahrens  * 1	|G|			 offset1				|
125fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
126fa9e4066Sahrens  * 2	|		vdev2		| GRID  |	  ASIZE		|
127fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
128fa9e4066Sahrens  * 3	|G|			 offset2				|
129fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
130fa9e4066Sahrens  * 4	|		vdev3		| GRID  |	  ASIZE		|
131fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
132fa9e4066Sahrens  * 5	|G|			 offset3				|
133fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
134fa9e4066Sahrens  * 6	|E| lvl | type	| cksum | comp	|     PSIZE	|     LSIZE	|
135fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
136fa9e4066Sahrens  * 7	|			padding					|
137fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
138fa9e4066Sahrens  * 8	|			padding					|
139fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
140fa9e4066Sahrens  * 9	|			padding					|
141fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
142fa9e4066Sahrens  * a	|			birth txg				|
143fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
144fa9e4066Sahrens  * b	|			fill count				|
145fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
146fa9e4066Sahrens  * c	|			checksum[0]				|
147fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
148fa9e4066Sahrens  * d	|			checksum[1]				|
149fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
150fa9e4066Sahrens  * e	|			checksum[2]				|
151fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
152fa9e4066Sahrens  * f	|			checksum[3]				|
153fa9e4066Sahrens  *	+-------+-------+-------+-------+-------+-------+-------+-------+
154fa9e4066Sahrens  *
155fa9e4066Sahrens  * Legend:
156fa9e4066Sahrens  *
157fa9e4066Sahrens  * vdev		virtual device ID
158fa9e4066Sahrens  * offset	offset into virtual device
159fa9e4066Sahrens  * LSIZE	logical size
160fa9e4066Sahrens  * PSIZE	physical size (after compression)
161fa9e4066Sahrens  * ASIZE	allocated size (including RAID-Z parity and gang block headers)
162fa9e4066Sahrens  * GRID		RAID-Z layout information (reserved for future use)
163fa9e4066Sahrens  * cksum	checksum function
164fa9e4066Sahrens  * comp		compression function
165fa9e4066Sahrens  * G		gang block indicator
166fa9e4066Sahrens  * E		endianness
167fa9e4066Sahrens  * type		DMU object type
168fa9e4066Sahrens  * lvl		level of indirection
169fa9e4066Sahrens  * birth txg	transaction group in which the block was born
170fa9e4066Sahrens  * fill count	number of non-zero blocks under this bp
171fa9e4066Sahrens  * checksum[4]	256-bit checksum of the data this bp describes
172fa9e4066Sahrens  */
173fa9e4066Sahrens typedef struct blkptr {
174fa9e4066Sahrens 	dva_t		blk_dva[3];	/* 128-bit Data Virtual Address	*/
175fa9e4066Sahrens 	uint64_t	blk_prop;	/* size, compression, type, etc	*/
176fa9e4066Sahrens 	uint64_t	blk_pad[3];	/* Extra space for the future	*/
177fa9e4066Sahrens 	uint64_t	blk_birth;	/* transaction group at birth	*/
178fa9e4066Sahrens 	uint64_t	blk_fill;	/* fill count			*/
179fa9e4066Sahrens 	zio_cksum_t	blk_cksum;	/* 256-bit checksum		*/
180fa9e4066Sahrens } blkptr_t;
181fa9e4066Sahrens 
182fa9e4066Sahrens #define	SPA_BLKPTRSHIFT	7		/* blkptr_t is 128 bytes	*/
183fa9e4066Sahrens #define	SPA_DVAS_PER_BP	3		/* Number of DVAs in a bp	*/
184fa9e4066Sahrens 
185fa9e4066Sahrens /*
186fa9e4066Sahrens  * Macros to get and set fields in a bp or DVA.
187fa9e4066Sahrens  */
188fa9e4066Sahrens #define	DVA_GET_ASIZE(dva)	\
189fa9e4066Sahrens 	BF64_GET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0)
190fa9e4066Sahrens #define	DVA_SET_ASIZE(dva, x)	\
191fa9e4066Sahrens 	BF64_SET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0, x)
192fa9e4066Sahrens 
193fa9e4066Sahrens #define	DVA_GET_GRID(dva)	BF64_GET((dva)->dva_word[0], 24, 8)
194fa9e4066Sahrens #define	DVA_SET_GRID(dva, x)	BF64_SET((dva)->dva_word[0], 24, 8, x)
195fa9e4066Sahrens 
196fa9e4066Sahrens #define	DVA_GET_VDEV(dva)	BF64_GET((dva)->dva_word[0], 32, 32)
197fa9e4066Sahrens #define	DVA_SET_VDEV(dva, x)	BF64_SET((dva)->dva_word[0], 32, 32, x)
198fa9e4066Sahrens 
199fa9e4066Sahrens #define	DVA_GET_OFFSET(dva)	\
200fa9e4066Sahrens 	BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
201fa9e4066Sahrens #define	DVA_SET_OFFSET(dva, x)	\
202fa9e4066Sahrens 	BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
203fa9e4066Sahrens 
204fa9e4066Sahrens #define	DVA_GET_GANG(dva)	BF64_GET((dva)->dva_word[1], 63, 1)
205fa9e4066Sahrens #define	DVA_SET_GANG(dva, x)	BF64_SET((dva)->dva_word[1], 63, 1, x)
206fa9e4066Sahrens 
207fa9e4066Sahrens #define	BP_GET_LSIZE(bp)	\
208fa9e4066Sahrens 	(BP_IS_HOLE(bp) ? 0 : \
209fa9e4066Sahrens 	BF64_GET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1))
210fa9e4066Sahrens #define	BP_SET_LSIZE(bp, x)	\
211fa9e4066Sahrens 	BF64_SET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1, x)
212fa9e4066Sahrens 
213fa9e4066Sahrens #define	BP_GET_PSIZE(bp)	\
214fa9e4066Sahrens 	BF64_GET_SB((bp)->blk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1)
215fa9e4066Sahrens #define	BP_SET_PSIZE(bp, x)	\
216fa9e4066Sahrens 	BF64_SET_SB((bp)->blk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1, x)
217fa9e4066Sahrens 
218fa9e4066Sahrens #define	BP_GET_COMPRESS(bp)	BF64_GET((bp)->blk_prop, 32, 8)
219fa9e4066Sahrens #define	BP_SET_COMPRESS(bp, x)	BF64_SET((bp)->blk_prop, 32, 8, x)
220fa9e4066Sahrens 
221fa9e4066Sahrens #define	BP_GET_CHECKSUM(bp)	BF64_GET((bp)->blk_prop, 40, 8)
222fa9e4066Sahrens #define	BP_SET_CHECKSUM(bp, x)	BF64_SET((bp)->blk_prop, 40, 8, x)
223fa9e4066Sahrens 
224fa9e4066Sahrens #define	BP_GET_TYPE(bp)		BF64_GET((bp)->blk_prop, 48, 8)
225fa9e4066Sahrens #define	BP_SET_TYPE(bp, x)	BF64_SET((bp)->blk_prop, 48, 8, x)
226fa9e4066Sahrens 
227fa9e4066Sahrens #define	BP_GET_LEVEL(bp)	BF64_GET((bp)->blk_prop, 56, 5)
228fa9e4066Sahrens #define	BP_SET_LEVEL(bp, x)	BF64_SET((bp)->blk_prop, 56, 5, x)
229fa9e4066Sahrens 
230fa9e4066Sahrens #define	BP_GET_BYTEORDER(bp)	(0 - BF64_GET((bp)->blk_prop, 63, 1))
231fa9e4066Sahrens #define	BP_SET_BYTEORDER(bp, x)	BF64_SET((bp)->blk_prop, 63, 1, x)
232fa9e4066Sahrens 
233fa9e4066Sahrens #define	BP_GET_ASIZE(bp)	\
234fa9e4066Sahrens 	(DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
23599653d4eSeschrock 		DVA_GET_ASIZE(&(bp)->blk_dva[2]))
23699653d4eSeschrock 
23799653d4eSeschrock #define	BP_GET_UCSIZE(bp) \
23899653d4eSeschrock 	((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \
23999653d4eSeschrock 	BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp));
240fa9e4066Sahrens 
24144cd46caSbillm #define	BP_GET_NDVAS(bp)	\
24244cd46caSbillm 	(!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
24344cd46caSbillm 	!!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
24444cd46caSbillm 	!!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
24544cd46caSbillm 
24644cd46caSbillm #define	BP_COUNT_GANG(bp)	\
24744cd46caSbillm 	(DVA_GET_GANG(&(bp)->blk_dva[0]) + \
24844cd46caSbillm 	DVA_GET_GANG(&(bp)->blk_dva[1]) + \
24944cd46caSbillm 	DVA_GET_GANG(&(bp)->blk_dva[2]))
25044cd46caSbillm 
251fa9e4066Sahrens #define	DVA_EQUAL(dva1, dva2)	\
252fa9e4066Sahrens 	((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
253fa9e4066Sahrens 	(dva1)->dva_word[0] == (dva2)->dva_word[0])
254fa9e4066Sahrens 
255fa9e4066Sahrens #define	DVA_IS_VALID(dva)	(DVA_GET_ASIZE(dva) != 0)
256fa9e4066Sahrens 
257fa9e4066Sahrens #define	ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3)	\
258fa9e4066Sahrens {						\
259fa9e4066Sahrens 	(zcp)->zc_word[0] = w0;			\
260fa9e4066Sahrens 	(zcp)->zc_word[1] = w1;			\
261fa9e4066Sahrens 	(zcp)->zc_word[2] = w2;			\
262fa9e4066Sahrens 	(zcp)->zc_word[3] = w3;			\
263fa9e4066Sahrens }
264fa9e4066Sahrens 
265fa9e4066Sahrens #define	BP_IDENTITY(bp)		(&(bp)->blk_dva[0])
26644cd46caSbillm #define	BP_IS_GANG(bp)		DVA_GET_GANG(BP_IDENTITY(bp))
26744cd46caSbillm #define	BP_IS_HOLE(bp)		((bp)->blk_birth == 0)
268fa9e4066Sahrens 
269fa9e4066Sahrens #define	BP_ZERO(bp)				\
270fa9e4066Sahrens {						\
271fa9e4066Sahrens 	(bp)->blk_dva[0].dva_word[0] = 0;	\
272fa9e4066Sahrens 	(bp)->blk_dva[0].dva_word[1] = 0;	\
273fa9e4066Sahrens 	(bp)->blk_dva[1].dva_word[0] = 0;	\
274fa9e4066Sahrens 	(bp)->blk_dva[1].dva_word[1] = 0;	\
275fa9e4066Sahrens 	(bp)->blk_dva[2].dva_word[0] = 0;	\
276fa9e4066Sahrens 	(bp)->blk_dva[2].dva_word[1] = 0;	\
277fa9e4066Sahrens 	(bp)->blk_prop = 0;			\
278fa9e4066Sahrens 	(bp)->blk_pad[0] = 0;			\
279fa9e4066Sahrens 	(bp)->blk_pad[1] = 0;			\
280fa9e4066Sahrens 	(bp)->blk_pad[2] = 0;			\
281fa9e4066Sahrens 	(bp)->blk_birth = 0;			\
282fa9e4066Sahrens 	(bp)->blk_fill = 0;			\
283fa9e4066Sahrens 	ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0);	\
284fa9e4066Sahrens }
285fa9e4066Sahrens 
286fa9e4066Sahrens /*
287fa9e4066Sahrens  * Note: the byteorder is either 0 or -1, both of which are palindromes.
288fa9e4066Sahrens  * This simplifies the endianness handling a bit.
289fa9e4066Sahrens  */
290fa9e4066Sahrens #ifdef _BIG_ENDIAN
291fa9e4066Sahrens #define	ZFS_HOST_BYTEORDER	(0ULL)
292fa9e4066Sahrens #else
293fa9e4066Sahrens #define	ZFS_HOST_BYTEORDER	(-1ULL)
294fa9e4066Sahrens #endif
295fa9e4066Sahrens 
296fa9e4066Sahrens #define	BP_SHOULD_BYTESWAP(bp)	(BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
297fa9e4066Sahrens 
29844cd46caSbillm #define	BP_SPRINTF_LEN	320
299fbabab8fSmaybee 
300fa9e4066Sahrens #include <sys/dmu.h>
301fa9e4066Sahrens 
302fa9e4066Sahrens /*
303fa9e4066Sahrens  * Routines found in spa.c
304fa9e4066Sahrens  */
305fa9e4066Sahrens 
306fa9e4066Sahrens /* state manipulation functions */
307fa9e4066Sahrens extern int spa_open(const char *pool, spa_t **, void *tag);
308ea8dc4b6Seschrock extern int spa_get_stats(const char *pool, nvlist_t **config,
309ea8dc4b6Seschrock     char *altroot, size_t buflen);
3100373e76bSbonwick extern int spa_create(const char *pool, nvlist_t *config, const char *altroot);
3110373e76bSbonwick extern int spa_import(const char *pool, nvlist_t *config, const char *altroot);
312fa9e4066Sahrens extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
313fa9e4066Sahrens extern int spa_destroy(char *pool);
31444cd46caSbillm extern int spa_export(char *pool, nvlist_t **oldconfig);
315ea8dc4b6Seschrock extern int spa_reset(char *pool);
316ea8dc4b6Seschrock extern void spa_async_request(spa_t *spa, int flag);
317ea8dc4b6Seschrock extern void spa_async_suspend(spa_t *spa);
318ea8dc4b6Seschrock extern void spa_async_resume(spa_t *spa);
319ea8dc4b6Seschrock extern spa_t *spa_inject_addref(char *pool);
320ea8dc4b6Seschrock extern void spa_inject_delref(spa_t *spa);
321ea8dc4b6Seschrock 
322ea8dc4b6Seschrock #define	SPA_ASYNC_REOPEN	0x01
323ea8dc4b6Seschrock #define	SPA_ASYNC_REPLACE_DONE	0x02
324ea8dc4b6Seschrock #define	SPA_ASYNC_SCRUB		0x04
325ea8dc4b6Seschrock #define	SPA_ASYNC_RESILVER	0x08
3260373e76bSbonwick #define	SPA_ASYNC_CONFIG_UPDATE	0x10
327fa9e4066Sahrens 
328fa9e4066Sahrens /* device manipulation */
329fa9e4066Sahrens extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
330ea8dc4b6Seschrock extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
331fa9e4066Sahrens     int replacing);
332ea8dc4b6Seschrock extern int spa_vdev_detach(spa_t *spa, uint64_t guid, int replace_done);
33399653d4eSeschrock extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
334c67d9675Seschrock extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
335fa9e4066Sahrens 
33699653d4eSeschrock /* spare state (which is global across all pools) */
33799653d4eSeschrock extern void spa_spare_add(uint64_t guid);
33899653d4eSeschrock extern void spa_spare_remove(uint64_t guid);
33999653d4eSeschrock extern boolean_t spa_spare_inuse(uint64_t guid);
34099653d4eSeschrock 
341fa9e4066Sahrens /* scrubbing */
342fa9e4066Sahrens extern int spa_scrub(spa_t *spa, pool_scrub_type_t type, boolean_t force);
343fa9e4066Sahrens extern void spa_scrub_suspend(spa_t *spa);
344fa9e4066Sahrens extern void spa_scrub_resume(spa_t *spa);
345fa9e4066Sahrens extern void spa_scrub_restart(spa_t *spa, uint64_t txg);
346ea8dc4b6Seschrock extern void spa_scrub_throttle(spa_t *spa, int direction);
347fa9e4066Sahrens 
348fa9e4066Sahrens /* spa syncing */
349fa9e4066Sahrens extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
350fa9e4066Sahrens extern void spa_sync_allpools(void);
351fa9e4066Sahrens 
352fa9e4066Sahrens /*
353fa9e4066Sahrens  * SPA configuration functions in spa_config.c
354fa9e4066Sahrens  */
3550373e76bSbonwick 
3560373e76bSbonwick #define	SPA_CONFIG_UPDATE_POOL	0
3570373e76bSbonwick #define	SPA_CONFIG_UPDATE_VDEVS	1
3580373e76bSbonwick 
359fa9e4066Sahrens extern void spa_config_sync(void);
360fa9e4066Sahrens extern void spa_config_load(void);
361fa9e4066Sahrens extern nvlist_t *spa_all_configs(uint64_t *);
362fa9e4066Sahrens extern void spa_config_set(spa_t *spa, nvlist_t *config);
363fa9e4066Sahrens extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
364fa9e4066Sahrens     int getstats);
3650373e76bSbonwick extern void spa_config_update(spa_t *spa, int what);
366fa9e4066Sahrens 
367fa9e4066Sahrens /*
368fa9e4066Sahrens  * Miscellaneous SPA routines in spa_misc.c
369fa9e4066Sahrens  */
370fa9e4066Sahrens 
371fa9e4066Sahrens /* Namespace manipulation */
372fa9e4066Sahrens extern spa_t *spa_lookup(const char *name);
3730373e76bSbonwick extern spa_t *spa_add(const char *name, const char *altroot);
374fa9e4066Sahrens extern void spa_remove(spa_t *spa);
375fa9e4066Sahrens extern spa_t *spa_next(spa_t *prev);
376fa9e4066Sahrens 
377fa9e4066Sahrens /* Refcount functions */
378fa9e4066Sahrens extern void spa_open_ref(spa_t *spa, void *tag);
379fa9e4066Sahrens extern void spa_close(spa_t *spa, void *tag);
380fa9e4066Sahrens extern boolean_t spa_refcount_zero(spa_t *spa);
381fa9e4066Sahrens 
382fa9e4066Sahrens /* Pool configuration lock */
383ea8dc4b6Seschrock extern void spa_config_enter(spa_t *spa, krw_t rw, void *tag);
384ea8dc4b6Seschrock extern void spa_config_exit(spa_t *spa, void *tag);
385fa9e4066Sahrens extern boolean_t spa_config_held(spa_t *spa, krw_t rw);
386fa9e4066Sahrens 
387fa9e4066Sahrens /* Pool vdev add/remove lock */
388fa9e4066Sahrens extern uint64_t spa_vdev_enter(spa_t *spa);
389fa9e4066Sahrens extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
390fa9e4066Sahrens 
391fa9e4066Sahrens /* Accessor functions */
392fa9e4066Sahrens extern krwlock_t *spa_traverse_rwlock(spa_t *spa);
393fa9e4066Sahrens extern int spa_traverse_wanted(spa_t *spa);
394fa9e4066Sahrens extern struct dsl_pool *spa_get_dsl(spa_t *spa);
395fa9e4066Sahrens extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
396fa9e4066Sahrens extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
397fa9e4066Sahrens extern void spa_altroot(spa_t *, char *, size_t);
398fa9e4066Sahrens extern int spa_sync_pass(spa_t *spa);
399fa9e4066Sahrens extern char *spa_name(spa_t *spa);
400fa9e4066Sahrens extern uint64_t spa_guid(spa_t *spa);
401fa9e4066Sahrens extern uint64_t spa_last_synced_txg(spa_t *spa);
402fa9e4066Sahrens extern uint64_t spa_first_txg(spa_t *spa);
40399653d4eSeschrock extern uint64_t spa_version(spa_t *spa);
404fa9e4066Sahrens extern int spa_state(spa_t *spa);
405fa9e4066Sahrens extern uint64_t spa_freeze_txg(spa_t *spa);
406fa9e4066Sahrens struct metaslab_class;
407fa9e4066Sahrens extern struct metaslab_class *spa_metaslab_class_select(spa_t *spa);
408fa9e4066Sahrens extern uint64_t spa_get_alloc(spa_t *spa);
409fa9e4066Sahrens extern uint64_t spa_get_space(spa_t *spa);
41099653d4eSeschrock extern uint64_t spa_get_dspace(spa_t *spa);
411fa9e4066Sahrens extern uint64_t spa_get_asize(spa_t *spa, uint64_t lsize);
41244cd46caSbillm extern uint64_t spa_version(spa_t *spa);
41344cd46caSbillm extern int spa_max_replication(spa_t *spa);
414fa9e4066Sahrens extern int spa_busy(void);
415fa9e4066Sahrens 
416fa9e4066Sahrens /* Miscellaneous support routines */
417fa9e4066Sahrens extern int spa_rename(const char *oldname, const char *newname);
418fa9e4066Sahrens extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
419fa9e4066Sahrens extern char *spa_strdup(const char *);
420fa9e4066Sahrens extern void spa_strfree(char *);
421fa9e4066Sahrens extern uint64_t spa_get_random(uint64_t range);
422d80c45e0Sbonwick extern void sprintf_blkptr(char *buf, int len, const blkptr_t *bp);
423fa9e4066Sahrens extern void spa_freeze(spa_t *spa);
424eaca9bbdSeschrock extern void spa_upgrade(spa_t *spa);
425fa9e4066Sahrens extern void spa_evict_all(void);
426ea8dc4b6Seschrock extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid);
42799653d4eSeschrock extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
42899653d4eSeschrock extern uint64_t bp_get_dasize(spa_t *spa, const blkptr_t *bp);
429ea8dc4b6Seschrock 
430ea8dc4b6Seschrock /* error handling */
431ea8dc4b6Seschrock struct zbookmark;
432ea8dc4b6Seschrock struct zio;
433ea8dc4b6Seschrock extern void spa_log_error(spa_t *spa, struct zio *zio);
434ea8dc4b6Seschrock extern void zfs_ereport_post(const char *class, spa_t *spa, vdev_t *vd,
435ea8dc4b6Seschrock     struct zio *zio, uint64_t stateoroffset, uint64_t length);
436ea8dc4b6Seschrock extern void zfs_post_ok(spa_t *spa, vdev_t *vd);
437ea8dc4b6Seschrock extern uint64_t spa_get_errlog_size(spa_t *spa);
438ea8dc4b6Seschrock extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
439ea8dc4b6Seschrock extern void spa_errlog_rotate(spa_t *spa);
440ea8dc4b6Seschrock extern void spa_errlog_drain(spa_t *spa);
441ea8dc4b6Seschrock extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
442*e9dbad6fSeschrock extern int spa_bookmark_name(spa_t *spa, struct zbookmark *zb,
443*e9dbad6fSeschrock     nvlist_t *nvl);
444ea8dc4b6Seschrock extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
445fa9e4066Sahrens 
446fa9e4066Sahrens /* Initialization and termination */
447fa9e4066Sahrens extern void spa_init(int flags);
448fa9e4066Sahrens extern void spa_fini(void);
449fa9e4066Sahrens 
450fa9e4066Sahrens #ifdef ZFS_DEBUG
451fa9e4066Sahrens #define	dprintf_bp(bp, fmt, ...) do {			\
452fbabab8fSmaybee 	if (zfs_flags & ZFS_DEBUG_DPRINTF) { 		\
453fbabab8fSmaybee 	char __blkbuf[BP_SPRINTF_LEN];			\
454fbabab8fSmaybee 	sprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp));	\
455fa9e4066Sahrens 	dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf);	\
456fa9e4066Sahrens 	} \
457fa9e4066Sahrens _NOTE(CONSTCOND) } while (0)
458fa9e4066Sahrens #else
459fa9e4066Sahrens #define	dprintf_bp(bp, fmt, ...)
460fa9e4066Sahrens #endif
461fa9e4066Sahrens 
462fa9e4066Sahrens extern int spa_mode;			/* mode, e.g. FREAD | FWRITE */
463fa9e4066Sahrens 
464fa9e4066Sahrens #ifdef	__cplusplus
465fa9e4066Sahrens }
466fa9e4066Sahrens #endif
467fa9e4066Sahrens 
468fa9e4066Sahrens #endif	/* _SYS_SPA_H */
469