1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2011, 2018 by Delphix. All rights reserved.
24  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
25  * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
26  * Copyright 2013 Saso Kiselkov. All rights reserved.
27  * Copyright (c) 2014 Integros [integros.com]
28  * Copyright 2017 Joyent, Inc.
29  * Copyright (c) 2017 Datto Inc.
30  * Copyright (c) 2017, Intel Corporation.
31  */
32 
33 #ifndef _SYS_SPA_H
34 #define	_SYS_SPA_H
35 
36 #include <sys/avl.h>
37 #include <sys/zfs_context.h>
38 #include <sys/nvpair.h>
39 #include <sys/sysevent.h>
40 #include <sys/sysmacros.h>
41 #include <sys/types.h>
42 #include <sys/fs/zfs.h>
43 #include <sys/dmu.h>
44 
45 #ifdef	__cplusplus
46 extern "C" {
47 #endif
48 
49 /*
50  * Forward references that lots of things need.
51  */
52 typedef struct spa spa_t;
53 typedef struct vdev vdev_t;
54 typedef struct metaslab metaslab_t;
55 typedef struct metaslab_group metaslab_group_t;
56 typedef struct metaslab_class metaslab_class_t;
57 typedef struct zio zio_t;
58 typedef struct zilog zilog_t;
59 typedef struct spa_aux_vdev spa_aux_vdev_t;
60 typedef struct ddt ddt_t;
61 typedef struct ddt_entry ddt_entry_t;
62 struct dsl_pool;
63 struct dsl_dataset;
64 
65 /*
66  * General-purpose 32-bit and 64-bit bitfield encodings.
67  */
68 #define	BF32_DECODE(x, low, len)	P2PHASE((x) >> (low), 1U << (len))
69 #define	BF64_DECODE(x, low, len)	P2PHASE((x) >> (low), 1ULL << (len))
70 #define	BF32_ENCODE(x, low, len)	(P2PHASE((x), 1U << (len)) << (low))
71 #define	BF64_ENCODE(x, low, len)	(P2PHASE((x), 1ULL << (len)) << (low))
72 
73 #define	BF32_GET(x, low, len)		BF32_DECODE(x, low, len)
74 #define	BF64_GET(x, low, len)		BF64_DECODE(x, low, len)
75 
76 #define	BF32_SET(x, low, len, val) do { \
77 	ASSERT3U(val, <, 1U << (len)); \
78 	ASSERT3U(low + len, <=, 32); \
79 	(x) ^= BF32_ENCODE((x >> low) ^ (val), low, len); \
80 _NOTE(CONSTCOND) } while (0)
81 
82 #define	BF64_SET(x, low, len, val) do { \
83 	ASSERT3U(val, <, 1ULL << (len)); \
84 	ASSERT3U(low + len, <=, 64); \
85 	((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)); \
86 _NOTE(CONSTCOND) } while (0)
87 
88 #define	BF32_GET_SB(x, low, len, shift, bias)	\
89 	((BF32_GET(x, low, len) + (bias)) << (shift))
90 #define	BF64_GET_SB(x, low, len, shift, bias)	\
91 	((BF64_GET(x, low, len) + (bias)) << (shift))
92 
93 #define	BF32_SET_SB(x, low, len, shift, bias, val) do { \
94 	ASSERT(IS_P2ALIGNED(val, 1U << shift)); \
95 	ASSERT3S((val) >> (shift), >=, bias); \
96 	BF32_SET(x, low, len, ((val) >> (shift)) - (bias)); \
97 _NOTE(CONSTCOND) } while (0)
98 #define	BF64_SET_SB(x, low, len, shift, bias, val) do { \
99 	ASSERT(IS_P2ALIGNED(val, 1ULL << shift)); \
100 	ASSERT3S((val) >> (shift), >=, bias); \
101 	BF64_SET(x, low, len, ((val) >> (shift)) - (bias)); \
102 _NOTE(CONSTCOND) } while (0)
103 
104 /*
105  * We currently support block sizes from 512 bytes to 16MB.
106  * The benefits of larger blocks, and thus larger IO, need to be weighed
107  * against the cost of COWing a giant block to modify one byte, and the
108  * large latency of reading or writing a large block.
109  *
110  * Note that although blocks up to 16MB are supported, the recordsize
111  * property can not be set larger than zfs_max_recordsize (default 1MB).
112  * See the comment near zfs_max_recordsize in dsl_dataset.c for details.
113  *
114  * Note that although the LSIZE field of the blkptr_t can store sizes up
115  * to 32MB, the dnode's dn_datablkszsec can only store sizes up to
116  * 32MB - 512 bytes.  Therefore, we limit SPA_MAXBLOCKSIZE to 16MB.
117  */
118 #define	SPA_MINBLOCKSHIFT	9
119 #define	SPA_OLD_MAXBLOCKSHIFT	17
120 #define	SPA_MAXBLOCKSHIFT	24
121 #define	SPA_MINBLOCKSIZE	(1ULL << SPA_MINBLOCKSHIFT)
122 #define	SPA_OLD_MAXBLOCKSIZE	(1ULL << SPA_OLD_MAXBLOCKSHIFT)
123 #define	SPA_MAXBLOCKSIZE	(1ULL << SPA_MAXBLOCKSHIFT)
124 
125 /*
126  * Default maximum supported logical ashift.
127  *
128  * The current 8k allocation block size limit is due to the 8k
129  * aligned/sized operations performed by vdev_probe() on
130  * vdev_label->vl_pad2.  Using another "safe region" for these tests
131  * would allow the limit to be raised to 16k, at the expense of
132  * only having 8 available uberblocks in the label area.
133  */
134 #define	SPA_MAXASHIFT		13
135 
136 /*
137  * Default minimum supported logical ashift.
138  */
139 #define SPA_MINASHIFT		SPA_MINBLOCKSHIFT
140 
141 /*
142  * Size of block to hold the configuration data (a packed nvlist)
143  */
144 #define	SPA_CONFIG_BLOCKSIZE	(1ULL << 14)
145 
146 /*
147  * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
148  * The ASIZE encoding should be at least 64 times larger (6 more bits)
149  * to support up to 4-way RAID-Z mirror mode with worst-case gang block
150  * overhead, three DVAs per bp, plus one more bit in case we do anything
151  * else that expands the ASIZE.
152  */
153 #define	SPA_LSIZEBITS		16	/* LSIZE up to 32M (2^16 * 512)	*/
154 #define	SPA_PSIZEBITS		16	/* PSIZE up to 32M (2^16 * 512)	*/
155 #define	SPA_ASIZEBITS		24	/* ASIZE up to 64 times larger	*/
156 
157 #define	SPA_COMPRESSBITS	7
158 #define	SPA_VDEVBITS		24
159 
160 /*
161  * All SPA data is represented by 128-bit data virtual addresses (DVAs).
162  * The members of the dva_t should be considered opaque outside the SPA.
163  */
164 typedef struct dva {
165 	uint64_t	dva_word[2];
166 } dva_t;
167 
168 /*
169  * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
170  */
171 typedef struct zio_cksum {
172 	uint64_t	zc_word[4];
173 } zio_cksum_t;
174 
175 /*
176  * Some checksums/hashes need a 256-bit initialization salt. This salt is kept
177  * secret and is suitable for use in MAC algorithms as the key.
178  */
179 typedef struct zio_cksum_salt {
180 	uint8_t		zcs_bytes[32];
181 } zio_cksum_salt_t;
182 
183 /*
184  * Each block is described by its DVAs, time of birth, checksum, etc.
185  * The word-by-word, bit-by-bit layout of the blkptr is as follows:
186  *
187  *	64	56	48	40	32	24	16	8	0
188  *	+-------+-------+-------+-------+-------+-------+-------+-------+
189  * 0	|  pad  |	  vdev1         | GRID  |	  ASIZE		|
190  *	+-------+-------+-------+-------+-------+-------+-------+-------+
191  * 1	|G|			 offset1				|
192  *	+-------+-------+-------+-------+-------+-------+-------+-------+
193  * 2	|  pad  |	  vdev2         | GRID  |	  ASIZE		|
194  *	+-------+-------+-------+-------+-------+-------+-------+-------+
195  * 3	|G|			 offset2				|
196  *	+-------+-------+-------+-------+-------+-------+-------+-------+
197  * 4	|  pad  |	  vdev3         | GRID  |	  ASIZE		|
198  *	+-------+-------+-------+-------+-------+-------+-------+-------+
199  * 5	|G|			 offset3				|
200  *	+-------+-------+-------+-------+-------+-------+-------+-------+
201  * 6	|BDX|lvl| type	| cksum |E| comp|    PSIZE	|     LSIZE	|
202  *	+-------+-------+-------+-------+-------+-------+-------+-------+
203  * 7	|			padding					|
204  *	+-------+-------+-------+-------+-------+-------+-------+-------+
205  * 8	|			padding					|
206  *	+-------+-------+-------+-------+-------+-------+-------+-------+
207  * 9	|			physical birth txg			|
208  *	+-------+-------+-------+-------+-------+-------+-------+-------+
209  * a	|			logical birth txg			|
210  *	+-------+-------+-------+-------+-------+-------+-------+-------+
211  * b	|			fill count				|
212  *	+-------+-------+-------+-------+-------+-------+-------+-------+
213  * c	|			checksum[0]				|
214  *	+-------+-------+-------+-------+-------+-------+-------+-------+
215  * d	|			checksum[1]				|
216  *	+-------+-------+-------+-------+-------+-------+-------+-------+
217  * e	|			checksum[2]				|
218  *	+-------+-------+-------+-------+-------+-------+-------+-------+
219  * f	|			checksum[3]				|
220  *	+-------+-------+-------+-------+-------+-------+-------+-------+
221  *
222  * Legend:
223  *
224  * vdev		virtual device ID
225  * offset	offset into virtual device
226  * LSIZE	logical size
227  * PSIZE	physical size (after compression)
228  * ASIZE	allocated size (including RAID-Z parity and gang block headers)
229  * GRID		RAID-Z layout information (reserved for future use)
230  * cksum	checksum function
231  * comp		compression function
232  * G		gang block indicator
233  * B		byteorder (endianness)
234  * D		dedup
235  * X		encryption (on version 30, which is not supported)
236  * E		blkptr_t contains embedded data (see below)
237  * lvl		level of indirection
238  * type		DMU object type
239  * phys birth	txg when dva[0] was written; zero if same as logical birth txg
240  *              note that typically all the dva's would be written in this
241  *              txg, but they could be different if they were moved by
242  *              device removal.
243  * log. birth	transaction group in which the block was logically born
244  * fill count	number of non-zero blocks under this bp
245  * checksum[4]	256-bit checksum of the data this bp describes
246  */
247 
248 /*
249  * "Embedded" blkptr_t's don't actually point to a block, instead they
250  * have a data payload embedded in the blkptr_t itself.  See the comment
251  * in blkptr.c for more details.
252  *
253  * The blkptr_t is laid out as follows:
254  *
255  *	64	56	48	40	32	24	16	8	0
256  *	+-------+-------+-------+-------+-------+-------+-------+-------+
257  * 0	|      payload                                                  |
258  * 1	|      payload                                                  |
259  * 2	|      payload                                                  |
260  * 3	|      payload                                                  |
261  * 4	|      payload                                                  |
262  * 5	|      payload                                                  |
263  *	+-------+-------+-------+-------+-------+-------+-------+-------+
264  * 6	|BDX|lvl| type	| etype |E| comp| PSIZE|              LSIZE	|
265  *	+-------+-------+-------+-------+-------+-------+-------+-------+
266  * 7	|      payload                                                  |
267  * 8	|      payload                                                  |
268  * 9	|      payload                                                  |
269  *	+-------+-------+-------+-------+-------+-------+-------+-------+
270  * a	|			logical birth txg			|
271  *	+-------+-------+-------+-------+-------+-------+-------+-------+
272  * b	|      payload                                                  |
273  * c	|      payload                                                  |
274  * d	|      payload                                                  |
275  * e	|      payload                                                  |
276  * f	|      payload                                                  |
277  *	+-------+-------+-------+-------+-------+-------+-------+-------+
278  *
279  * Legend:
280  *
281  * payload		contains the embedded data
282  * B (byteorder)	byteorder (endianness)
283  * D (dedup)		padding (set to zero)
284  * X			encryption (set to zero; see above)
285  * E (embedded)		set to one
286  * lvl			indirection level
287  * type			DMU object type
288  * etype		how to interpret embedded data (BP_EMBEDDED_TYPE_*)
289  * comp			compression function of payload
290  * PSIZE		size of payload after compression, in bytes
291  * LSIZE		logical size of payload, in bytes
292  *			note that 25 bits is enough to store the largest
293  *			"normal" BP's LSIZE (2^16 * 2^9) in bytes
294  * log. birth		transaction group in which the block was logically born
295  *
296  * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
297  * bp's they are stored in units of SPA_MINBLOCKSHIFT.
298  * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
299  * The B, D, X, lvl, type, and comp fields are stored the same as with normal
300  * BP's so the BP_SET_* macros can be used with them.  etype, PSIZE, LSIZE must
301  * be set with the BPE_SET_* macros.  BP_SET_EMBEDDED() should be called before
302  * other macros, as they assert that they are only used on BP's of the correct
303  * "embedded-ness".
304  */
305 
306 #define	BPE_GET_ETYPE(bp)	\
307 	(ASSERT(BP_IS_EMBEDDED(bp)), \
308 	BF64_GET((bp)->blk_prop, 40, 8))
309 #define	BPE_SET_ETYPE(bp, t)	do { \
310 	ASSERT(BP_IS_EMBEDDED(bp)); \
311 	BF64_SET((bp)->blk_prop, 40, 8, t); \
312 _NOTE(CONSTCOND) } while (0)
313 
314 #define	BPE_GET_LSIZE(bp)	\
315 	(ASSERT(BP_IS_EMBEDDED(bp)), \
316 	BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
317 #define	BPE_SET_LSIZE(bp, x)	do { \
318 	ASSERT(BP_IS_EMBEDDED(bp)); \
319 	BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
320 _NOTE(CONSTCOND) } while (0)
321 
322 #define	BPE_GET_PSIZE(bp)	\
323 	(ASSERT(BP_IS_EMBEDDED(bp)), \
324 	BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
325 #define	BPE_SET_PSIZE(bp, x)	do { \
326 	ASSERT(BP_IS_EMBEDDED(bp)); \
327 	BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
328 _NOTE(CONSTCOND) } while (0)
329 
330 typedef enum bp_embedded_type {
331 	BP_EMBEDDED_TYPE_DATA,
332 	BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */
333 	NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED
334 } bp_embedded_type_t;
335 
336 #define	BPE_NUM_WORDS 14
337 #define	BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
338 #define	BPE_IS_PAYLOADWORD(bp, wp) \
339 	((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
340 
341 #define	SPA_BLKPTRSHIFT	7		/* blkptr_t is 128 bytes	*/
342 #define	SPA_DVAS_PER_BP	3		/* Number of DVAs in a bp	*/
343 #define	SPA_SYNC_MIN_VDEVS 3		/* min vdevs to update during sync */
344 
345 /*
346  * A block is a hole when it has either 1) never been written to, or
347  * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
348  * without physically allocating disk space. Holes are represented in the
349  * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
350  * done through the BP_IS_HOLE macro. For holes, the logical size, level,
351  * DMU object type, and birth times are all also stored for holes that
352  * were written to at some point (i.e. were punched after having been filled).
353  */
354 typedef struct blkptr {
355 	dva_t		blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
356 	uint64_t	blk_prop;	/* size, compression, type, etc	    */
357 	uint64_t	blk_pad[2];	/* Extra space for the future	    */
358 	uint64_t	blk_phys_birth;	/* txg when block was allocated	    */
359 	uint64_t	blk_birth;	/* transaction group at birth	    */
360 	uint64_t	blk_fill;	/* fill count			    */
361 	zio_cksum_t	blk_cksum;	/* 256-bit checksum		    */
362 } blkptr_t;
363 
364 /*
365  * Macros to get and set fields in a bp or DVA.
366  */
367 #define	DVA_GET_ASIZE(dva)	\
368 	BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
369 #define	DVA_SET_ASIZE(dva, x)	\
370 	BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
371 	SPA_MINBLOCKSHIFT, 0, x)
372 
373 #define	DVA_GET_GRID(dva)	BF64_GET((dva)->dva_word[0], 24, 8)
374 #define	DVA_SET_GRID(dva, x)	BF64_SET((dva)->dva_word[0], 24, 8, x)
375 
376 #define	DVA_GET_VDEV(dva)	BF64_GET((dva)->dva_word[0], 32, SPA_VDEVBITS)
377 #define	DVA_SET_VDEV(dva, x)	\
378 	BF64_SET((dva)->dva_word[0], 32, SPA_VDEVBITS, x)
379 
380 #define	DVA_GET_OFFSET(dva)	\
381 	BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
382 #define	DVA_SET_OFFSET(dva, x)	\
383 	BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
384 
385 #define	DVA_GET_GANG(dva)	BF64_GET((dva)->dva_word[1], 63, 1)
386 #define	DVA_SET_GANG(dva, x)	BF64_SET((dva)->dva_word[1], 63, 1, x)
387 
388 #define	BP_GET_LSIZE(bp)	\
389 	(BP_IS_EMBEDDED(bp) ?	\
390 	(BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
391 	BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
392 #define	BP_SET_LSIZE(bp, x)	do { \
393 	ASSERT(!BP_IS_EMBEDDED(bp)); \
394 	BF64_SET_SB((bp)->blk_prop, \
395 	    0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
396 _NOTE(CONSTCOND) } while (0)
397 
398 #define	BP_GET_PSIZE(bp)	\
399 	(BP_IS_EMBEDDED(bp) ? 0 : \
400 	BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1))
401 #define	BP_SET_PSIZE(bp, x)	do { \
402 	ASSERT(!BP_IS_EMBEDDED(bp)); \
403 	BF64_SET_SB((bp)->blk_prop, \
404 	    16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
405 _NOTE(CONSTCOND) } while (0)
406 
407 #define	BP_GET_COMPRESS(bp)		\
408 	BF64_GET((bp)->blk_prop, 32, SPA_COMPRESSBITS)
409 #define	BP_SET_COMPRESS(bp, x)		\
410 	BF64_SET((bp)->blk_prop, 32, SPA_COMPRESSBITS, x)
411 
412 #define	BP_IS_EMBEDDED(bp)		BF64_GET((bp)->blk_prop, 39, 1)
413 #define	BP_SET_EMBEDDED(bp, x)		BF64_SET((bp)->blk_prop, 39, 1, x)
414 
415 #define	BP_GET_CHECKSUM(bp)		\
416 	(BP_IS_EMBEDDED(bp) ? ZIO_CHECKSUM_OFF : \
417 	BF64_GET((bp)->blk_prop, 40, 8))
418 #define	BP_SET_CHECKSUM(bp, x)		do { \
419 	ASSERT(!BP_IS_EMBEDDED(bp)); \
420 	BF64_SET((bp)->blk_prop, 40, 8, x); \
421 _NOTE(CONSTCOND) } while (0)
422 
423 #define	BP_GET_TYPE(bp)			BF64_GET((bp)->blk_prop, 48, 8)
424 #define	BP_SET_TYPE(bp, x)		BF64_SET((bp)->blk_prop, 48, 8, x)
425 
426 #define	BP_GET_LEVEL(bp)		BF64_GET((bp)->blk_prop, 56, 5)
427 #define	BP_SET_LEVEL(bp, x)		BF64_SET((bp)->blk_prop, 56, 5, x)
428 
429 #define	BP_GET_DEDUP(bp)		BF64_GET((bp)->blk_prop, 62, 1)
430 #define	BP_SET_DEDUP(bp, x)		BF64_SET((bp)->blk_prop, 62, 1, x)
431 
432 #define	BP_GET_BYTEORDER(bp)		BF64_GET((bp)->blk_prop, 63, 1)
433 #define	BP_SET_BYTEORDER(bp, x)		BF64_SET((bp)->blk_prop, 63, 1, x)
434 
435 #define	BP_PHYSICAL_BIRTH(bp)		\
436 	(BP_IS_EMBEDDED(bp) ? 0 : \
437 	(bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
438 
439 #define	BP_SET_BIRTH(bp, logical, physical)	\
440 {						\
441 	ASSERT(!BP_IS_EMBEDDED(bp));		\
442 	(bp)->blk_birth = (logical);		\
443 	(bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
444 }
445 
446 #define	BP_GET_FILL(bp) (BP_IS_EMBEDDED(bp) ? 1 : (bp)->blk_fill)
447 
448 #define	BP_IS_METADATA(bp)	\
449 	(BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))
450 
451 #define	BP_GET_ASIZE(bp)	\
452 	(BP_IS_EMBEDDED(bp) ? 0 : \
453 	DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
454 	DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
455 	DVA_GET_ASIZE(&(bp)->blk_dva[2]))
456 
457 #define	BP_GET_UCSIZE(bp)	\
458 	(BP_IS_METADATA(bp) ? BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
459 
460 #define	BP_GET_NDVAS(bp)	\
461 	(BP_IS_EMBEDDED(bp) ? 0 : \
462 	!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
463 	!!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
464 	!!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
465 
466 #define	BP_COUNT_GANG(bp)	\
467 	(BP_IS_EMBEDDED(bp) ? 0 : \
468 	(DVA_GET_GANG(&(bp)->blk_dva[0]) + \
469 	DVA_GET_GANG(&(bp)->blk_dva[1]) + \
470 	DVA_GET_GANG(&(bp)->blk_dva[2])))
471 
472 #define	DVA_EQUAL(dva1, dva2)	\
473 	((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
474 	(dva1)->dva_word[0] == (dva2)->dva_word[0])
475 
476 #define	BP_EQUAL(bp1, bp2)	\
477 	(BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) &&	\
478 	(bp1)->blk_birth == (bp2)->blk_birth &&			\
479 	DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) &&	\
480 	DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) &&	\
481 	DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
482 
483 #define	ZIO_CHECKSUM_EQUAL(zc1, zc2) \
484 	(0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
485 	((zc1).zc_word[1] - (zc2).zc_word[1]) | \
486 	((zc1).zc_word[2] - (zc2).zc_word[2]) | \
487 	((zc1).zc_word[3] - (zc2).zc_word[3])))
488 
489 #define	ZIO_CHECKSUM_IS_ZERO(zc) \
490 	(0 == ((zc)->zc_word[0] | (zc)->zc_word[1] | \
491 	(zc)->zc_word[2] | (zc)->zc_word[3]))
492 
493 #define	ZIO_CHECKSUM_BSWAP(zcp)					\
494 {								\
495 	(zcp)->zc_word[0] = BSWAP_64((zcp)->zc_word[0]);	\
496 	(zcp)->zc_word[1] = BSWAP_64((zcp)->zc_word[1]);	\
497 	(zcp)->zc_word[2] = BSWAP_64((zcp)->zc_word[2]);	\
498 	(zcp)->zc_word[3] = BSWAP_64((zcp)->zc_word[3]);	\
499 }
500 
501 
502 #define	DVA_IS_VALID(dva)	(DVA_GET_ASIZE(dva) != 0)
503 
504 #define	ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3)	\
505 {						\
506 	(zcp)->zc_word[0] = w0;			\
507 	(zcp)->zc_word[1] = w1;			\
508 	(zcp)->zc_word[2] = w2;			\
509 	(zcp)->zc_word[3] = w3;			\
510 }
511 
512 #define	BP_IDENTITY(bp)		(ASSERT(!BP_IS_EMBEDDED(bp)), &(bp)->blk_dva[0])
513 #define	BP_IS_GANG(bp)		\
514 	(BP_IS_EMBEDDED(bp) ? B_FALSE : DVA_GET_GANG(BP_IDENTITY(bp)))
515 #define	DVA_IS_EMPTY(dva)	((dva)->dva_word[0] == 0ULL &&	\
516 				(dva)->dva_word[1] == 0ULL)
517 #define	BP_IS_HOLE(bp) \
518 	(!BP_IS_EMBEDDED(bp) && DVA_IS_EMPTY(BP_IDENTITY(bp)))
519 
520 /* BP_IS_RAIDZ(bp) assumes no block compression */
521 #define	BP_IS_RAIDZ(bp)		(DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
522 				BP_GET_PSIZE(bp))
523 
524 #define	BP_ZERO(bp)				\
525 {						\
526 	(bp)->blk_dva[0].dva_word[0] = 0;	\
527 	(bp)->blk_dva[0].dva_word[1] = 0;	\
528 	(bp)->blk_dva[1].dva_word[0] = 0;	\
529 	(bp)->blk_dva[1].dva_word[1] = 0;	\
530 	(bp)->blk_dva[2].dva_word[0] = 0;	\
531 	(bp)->blk_dva[2].dva_word[1] = 0;	\
532 	(bp)->blk_prop = 0;			\
533 	(bp)->blk_pad[0] = 0;			\
534 	(bp)->blk_pad[1] = 0;			\
535 	(bp)->blk_phys_birth = 0;		\
536 	(bp)->blk_birth = 0;			\
537 	(bp)->blk_fill = 0;			\
538 	ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0);	\
539 }
540 
541 #if BYTE_ORDER == _BIG_ENDIAN
542 #define	ZFS_HOST_BYTEORDER	(0ULL)
543 #else
544 #define	ZFS_HOST_BYTEORDER	(1ULL)
545 #endif
546 
547 #define	BP_SHOULD_BYTESWAP(bp)	(BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
548 
549 #define	BP_SPRINTF_LEN	320
550 
551 /*
552  * This macro allows code sharing between zfs, libzpool, and mdb.
553  * 'func' is either snprintf() or mdb_snprintf().
554  * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
555  */
556 #define	SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
557 {									\
558 	static const char *copyname[] =					\
559 	    { "zero", "single", "double", "triple" };			\
560 	int len = 0;							\
561 	int copies = 0;							\
562 									\
563 	if (bp == NULL) {						\
564 		len += func(buf + len, size - len, "<NULL>");		\
565 	} else if (BP_IS_HOLE(bp)) {					\
566 		len += func(buf + len, size - len,			\
567 		    "HOLE [L%llu %s] "					\
568 		    "size=%llxL birth=%lluL",				\
569 		    (u_longlong_t)BP_GET_LEVEL(bp),			\
570 		    type,						\
571 		    (u_longlong_t)BP_GET_LSIZE(bp),			\
572 		    (u_longlong_t)bp->blk_birth);			\
573 	} else if (BP_IS_EMBEDDED(bp)) {				\
574 		len = func(buf + len, size - len,			\
575 		    "EMBEDDED [L%llu %s] et=%u %s "			\
576 		    "size=%llxL/%llxP birth=%lluL",			\
577 		    (u_longlong_t)BP_GET_LEVEL(bp),			\
578 		    type,						\
579 		    (int)BPE_GET_ETYPE(bp),				\
580 		    compress,						\
581 		    (u_longlong_t)BPE_GET_LSIZE(bp),			\
582 		    (u_longlong_t)BPE_GET_PSIZE(bp),			\
583 		    (u_longlong_t)bp->blk_birth);			\
584 	} else {							\
585 		for (int d = 0; d < BP_GET_NDVAS(bp); d++) {		\
586 			const dva_t *dva = &bp->blk_dva[d];		\
587 			if (DVA_IS_VALID(dva))				\
588 				copies++;				\
589 			len += func(buf + len, size - len,		\
590 			    "DVA[%d]=<%llu:%llx:%llx>%c", d,		\
591 			    (u_longlong_t)DVA_GET_VDEV(dva),		\
592 			    (u_longlong_t)DVA_GET_OFFSET(dva),		\
593 			    (u_longlong_t)DVA_GET_ASIZE(dva),		\
594 			    ws);					\
595 		}							\
596 		if (BP_IS_GANG(bp) &&					\
597 		    DVA_GET_ASIZE(&bp->blk_dva[2]) <=			\
598 		    DVA_GET_ASIZE(&bp->blk_dva[1]) / 2)			\
599 			copies--;					\
600 		len += func(buf + len, size - len,			\
601 		    "[L%llu %s] %s %s %s %s %s %s%c"			\
602 		    "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c"	\
603 		    "cksum=%llx:%llx:%llx:%llx",			\
604 		    (u_longlong_t)BP_GET_LEVEL(bp),			\
605 		    type,						\
606 		    checksum,						\
607 		    compress,						\
608 		    BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE",		\
609 		    BP_IS_GANG(bp) ? "gang" : "contiguous",		\
610 		    BP_GET_DEDUP(bp) ? "dedup" : "unique",		\
611 		    copyname[copies],					\
612 		    ws,							\
613 		    (u_longlong_t)BP_GET_LSIZE(bp),			\
614 		    (u_longlong_t)BP_GET_PSIZE(bp),			\
615 		    (u_longlong_t)bp->blk_birth,			\
616 		    (u_longlong_t)BP_PHYSICAL_BIRTH(bp),		\
617 		    (u_longlong_t)BP_GET_FILL(bp),			\
618 		    ws,							\
619 		    (u_longlong_t)bp->blk_cksum.zc_word[0],		\
620 		    (u_longlong_t)bp->blk_cksum.zc_word[1],		\
621 		    (u_longlong_t)bp->blk_cksum.zc_word[2],		\
622 		    (u_longlong_t)bp->blk_cksum.zc_word[3]);		\
623 	}								\
624 	ASSERT(len < size);						\
625 }
626 
627 #define	BP_GET_BUFC_TYPE(bp)						\
628 	(BP_IS_METADATA(bp) ? ARC_BUFC_METADATA : ARC_BUFC_DATA)
629 
630 typedef enum spa_import_type {
631 	SPA_IMPORT_EXISTING,
632 	SPA_IMPORT_ASSEMBLE
633 } spa_import_type_t;
634 
635 /* state manipulation functions */
636 extern int spa_open(const char *pool, spa_t **, void *tag);
637 extern int spa_open_rewind(const char *pool, spa_t **, void *tag,
638     nvlist_t *policy, nvlist_t **config);
639 extern int spa_get_stats(const char *pool, nvlist_t **config, char *altroot,
640     size_t buflen);
641 extern int spa_create(const char *pool, nvlist_t *config, nvlist_t *props,
642     nvlist_t *zplprops);
643 #ifdef illumos
644 extern int spa_import_rootpool(char *devpath, char *devid);
645 #else
646 extern int spa_import_rootpool(const char *name);
647 #endif
648 extern int spa_import(const char *pool, nvlist_t *config, nvlist_t *props,
649     uint64_t flags);
650 extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
651 extern int spa_destroy(char *pool);
652 extern int spa_checkpoint(const char *pool);
653 extern int spa_checkpoint_discard(const char *pool);
654 extern int spa_export(char *pool, nvlist_t **oldconfig, boolean_t force,
655     boolean_t hardforce);
656 extern int spa_reset(char *pool);
657 extern void spa_async_request(spa_t *spa, int flag);
658 extern void spa_async_unrequest(spa_t *spa, int flag);
659 extern void spa_async_suspend(spa_t *spa);
660 extern void spa_async_resume(spa_t *spa);
661 extern spa_t *spa_inject_addref(char *pool);
662 extern void spa_inject_delref(spa_t *spa);
663 extern void spa_scan_stat_init(spa_t *spa);
664 extern int spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps);
665 
666 #define	SPA_ASYNC_CONFIG_UPDATE	0x01
667 #define	SPA_ASYNC_REMOVE	0x02
668 #define	SPA_ASYNC_PROBE		0x04
669 #define	SPA_ASYNC_RESILVER_DONE	0x08
670 #define	SPA_ASYNC_RESILVER	0x10
671 #define	SPA_ASYNC_AUTOEXPAND	0x20
672 #define	SPA_ASYNC_REMOVE_DONE	0x40
673 #define	SPA_ASYNC_REMOVE_STOP	0x80
674 #define	SPA_ASYNC_INITIALIZE_RESTART	0x100
675 
676 /*
677  * Controls the behavior of spa_vdev_remove().
678  */
679 #define	SPA_REMOVE_UNSPARE	0x01
680 #define	SPA_REMOVE_DONE		0x02
681 
682 /* device manipulation */
683 extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
684 extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
685     int replacing);
686 extern int spa_vdev_detach(spa_t *spa, uint64_t guid, uint64_t pguid,
687     int replace_done);
688 extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
689 extern boolean_t spa_vdev_remove_active(spa_t *spa);
690 extern int spa_vdev_initialize(spa_t *spa, uint64_t guid, uint64_t cmd_type);
691 extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
692 extern int spa_vdev_setfru(spa_t *spa, uint64_t guid, const char *newfru);
693 extern int spa_vdev_split_mirror(spa_t *spa, char *newname, nvlist_t *config,
694     nvlist_t *props, boolean_t exp);
695 
696 /* spare state (which is global across all pools) */
697 extern void spa_spare_add(vdev_t *vd);
698 extern void spa_spare_remove(vdev_t *vd);
699 extern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt);
700 extern void spa_spare_activate(vdev_t *vd);
701 
702 /* L2ARC state (which is global across all pools) */
703 extern void spa_l2cache_add(vdev_t *vd);
704 extern void spa_l2cache_remove(vdev_t *vd);
705 extern boolean_t spa_l2cache_exists(uint64_t guid, uint64_t *pool);
706 extern void spa_l2cache_activate(vdev_t *vd);
707 extern void spa_l2cache_drop(spa_t *spa);
708 
709 /* scanning */
710 extern int spa_scan(spa_t *spa, pool_scan_func_t func);
711 extern int spa_scan_stop(spa_t *spa);
712 extern int spa_scrub_pause_resume(spa_t *spa, pool_scrub_cmd_t flag);
713 
714 /* spa syncing */
715 extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
716 extern void spa_sync_allpools(void);
717 
718 /* spa namespace global mutex */
719 extern kmutex_t spa_namespace_lock;
720 
721 /*
722  * SPA configuration functions in spa_config.c
723  */
724 
725 #define	SPA_CONFIG_UPDATE_POOL	0
726 #define	SPA_CONFIG_UPDATE_VDEVS	1
727 
728 extern void spa_write_cachefile(spa_t *, boolean_t, boolean_t);
729 extern void spa_config_load(void);
730 extern nvlist_t *spa_all_configs(uint64_t *);
731 extern void spa_config_set(spa_t *spa, nvlist_t *config);
732 extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
733     int getstats);
734 extern void spa_config_update(spa_t *spa, int what);
735 
736 /*
737  * Miscellaneous SPA routines in spa_misc.c
738  */
739 
740 /* Namespace manipulation */
741 extern spa_t *spa_lookup(const char *name);
742 extern spa_t *spa_add(const char *name, nvlist_t *config, const char *altroot);
743 extern void spa_remove(spa_t *spa);
744 extern spa_t *spa_next(spa_t *prev);
745 
746 /* Refcount functions */
747 extern void spa_open_ref(spa_t *spa, void *tag);
748 extern void spa_close(spa_t *spa, void *tag);
749 extern void spa_async_close(spa_t *spa, void *tag);
750 extern boolean_t spa_refcount_zero(spa_t *spa);
751 
752 #define	SCL_NONE	0x00
753 #define	SCL_CONFIG	0x01
754 #define	SCL_STATE	0x02
755 #define	SCL_L2ARC	0x04		/* hack until L2ARC 2.0 */
756 #define	SCL_ALLOC	0x08
757 #define	SCL_ZIO		0x10
758 #define	SCL_FREE	0x20
759 #define	SCL_VDEV	0x40
760 #define	SCL_LOCKS	7
761 #define	SCL_ALL		((1 << SCL_LOCKS) - 1)
762 #define	SCL_STATE_ALL	(SCL_STATE | SCL_L2ARC | SCL_ZIO)
763 
764 /* Pool configuration locks */
765 extern int spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw);
766 extern void spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw);
767 extern void spa_config_exit(spa_t *spa, int locks, void *tag);
768 extern int spa_config_held(spa_t *spa, int locks, krw_t rw);
769 
770 /* Pool vdev add/remove lock */
771 extern uint64_t spa_vdev_enter(spa_t *spa);
772 extern uint64_t spa_vdev_config_enter(spa_t *spa);
773 extern void spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg,
774     int error, char *tag);
775 extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
776 
777 /* Pool vdev state change lock */
778 extern void spa_vdev_state_enter(spa_t *spa, int oplock);
779 extern int spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error);
780 
781 /* Log state */
782 typedef enum spa_log_state {
783 	SPA_LOG_UNKNOWN = 0,	/* unknown log state */
784 	SPA_LOG_MISSING,	/* missing log(s) */
785 	SPA_LOG_CLEAR,		/* clear the log(s) */
786 	SPA_LOG_GOOD,		/* log(s) are good */
787 } spa_log_state_t;
788 
789 extern spa_log_state_t spa_get_log_state(spa_t *spa);
790 extern void spa_set_log_state(spa_t *spa, spa_log_state_t state);
791 extern int spa_reset_logs(spa_t *spa);
792 
793 /* Log claim callback */
794 extern void spa_claim_notify(zio_t *zio);
795 
796 /* Accessor functions */
797 extern boolean_t spa_shutting_down(spa_t *spa);
798 extern struct dsl_pool *spa_get_dsl(spa_t *spa);
799 extern boolean_t spa_is_initializing(spa_t *spa);
800 extern boolean_t spa_indirect_vdevs_loaded(spa_t *spa);
801 extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
802 extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
803 extern void spa_altroot(spa_t *, char *, size_t);
804 extern int spa_sync_pass(spa_t *spa);
805 extern char *spa_name(spa_t *spa);
806 extern uint64_t spa_guid(spa_t *spa);
807 extern uint64_t spa_load_guid(spa_t *spa);
808 extern uint64_t spa_last_synced_txg(spa_t *spa);
809 extern uint64_t spa_first_txg(spa_t *spa);
810 extern uint64_t spa_syncing_txg(spa_t *spa);
811 extern uint64_t spa_final_dirty_txg(spa_t *spa);
812 extern uint64_t spa_version(spa_t *spa);
813 extern pool_state_t spa_state(spa_t *spa);
814 extern spa_load_state_t spa_load_state(spa_t *spa);
815 extern uint64_t spa_freeze_txg(spa_t *spa);
816 extern uint64_t spa_get_worst_case_asize(spa_t *spa, uint64_t lsize);
817 extern uint64_t spa_get_dspace(spa_t *spa);
818 extern uint64_t spa_get_checkpoint_space(spa_t *spa);
819 extern uint64_t spa_get_slop_space(spa_t *spa);
820 extern void spa_update_dspace(spa_t *spa);
821 extern uint64_t spa_version(spa_t *spa);
822 extern boolean_t spa_deflate(spa_t *spa);
823 extern metaslab_class_t *spa_normal_class(spa_t *spa);
824 extern metaslab_class_t *spa_log_class(spa_t *spa);
825 extern metaslab_class_t *spa_special_class(spa_t *spa);
826 extern metaslab_class_t *spa_dedup_class(spa_t *spa);
827 extern metaslab_class_t *spa_preferred_class(spa_t *spa, uint64_t size,
828     dmu_object_type_t objtype, uint_t level, uint_t special_smallblk);
829 
830 extern void spa_evicting_os_register(spa_t *, objset_t *os);
831 extern void spa_evicting_os_deregister(spa_t *, objset_t *os);
832 extern void spa_evicting_os_wait(spa_t *spa);
833 extern int spa_max_replication(spa_t *spa);
834 extern int spa_prev_software_version(spa_t *spa);
835 extern int spa_busy(void);
836 extern uint8_t spa_get_failmode(spa_t *spa);
837 extern boolean_t spa_suspended(spa_t *spa);
838 extern uint64_t spa_bootfs(spa_t *spa);
839 extern uint64_t spa_delegation(spa_t *spa);
840 extern objset_t *spa_meta_objset(spa_t *spa);
841 extern uint64_t spa_deadman_synctime(spa_t *spa);
842 extern struct proc *spa_proc(spa_t *spa);
843 extern uint64_t spa_dirty_data(spa_t *spa);
844 
845 /* Miscellaneous support routines */
846 extern void spa_load_failed(spa_t *spa, const char *fmt, ...);
847 extern void spa_load_note(spa_t *spa, const char *fmt, ...);
848 extern void spa_activate_mos_feature(spa_t *spa, const char *feature,
849     dmu_tx_t *tx);
850 extern void spa_deactivate_mos_feature(spa_t *spa, const char *feature);
851 extern spa_t *spa_by_guid(uint64_t pool_guid, uint64_t device_guid);
852 extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
853 extern char *spa_strdup(const char *);
854 extern void spa_strfree(char *);
855 extern uint64_t spa_get_random(uint64_t range);
856 extern uint64_t spa_generate_guid(spa_t *spa);
857 extern void snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp);
858 extern void spa_freeze(spa_t *spa);
859 extern int spa_change_guid(spa_t *spa);
860 extern void spa_upgrade(spa_t *spa, uint64_t version);
861 extern void spa_evict_all(void);
862 extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid,
863     boolean_t l2cache);
864 extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
865 extern uint64_t dva_get_dsize_sync(spa_t *spa, const dva_t *dva);
866 extern uint64_t bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp);
867 extern uint64_t bp_get_dsize(spa_t *spa, const blkptr_t *bp);
868 extern boolean_t spa_has_slogs(spa_t *spa);
869 extern boolean_t spa_is_root(spa_t *spa);
870 extern boolean_t spa_writeable(spa_t *spa);
871 extern boolean_t spa_has_pending_synctask(spa_t *spa);
872 extern int spa_maxblocksize(spa_t *spa);
873 extern int spa_maxdnodesize(spa_t *spa);
874 extern boolean_t spa_multihost(spa_t *spa);
875 extern unsigned long spa_get_hostid(void);
876 extern boolean_t spa_has_checkpoint(spa_t *spa);
877 extern boolean_t spa_importing_readonly_checkpoint(spa_t *spa);
878 extern boolean_t spa_suspend_async_destroy(spa_t *spa);
879 extern uint64_t spa_min_claim_txg(spa_t *spa);
880 extern void zfs_blkptr_verify(spa_t *spa, const blkptr_t *bp);
881 extern boolean_t zfs_dva_valid(spa_t *spa, const dva_t *dva,
882     const blkptr_t *bp);
883 typedef void (*spa_remap_cb_t)(uint64_t vdev, uint64_t offset, uint64_t size,
884     void *arg);
885 extern boolean_t spa_remap_blkptr(spa_t *spa, blkptr_t *bp,
886     spa_remap_cb_t callback, void *arg);
887 extern uint64_t spa_get_last_removal_txg(spa_t *spa);
888 extern boolean_t spa_trust_config(spa_t *spa);
889 extern uint64_t spa_missing_tvds_allowed(spa_t *spa);
890 extern void spa_set_missing_tvds(spa_t *spa, uint64_t missing);
891 extern boolean_t spa_top_vdevs_spacemap_addressable(spa_t *spa);
892 extern void spa_activate_allocation_classes(spa_t *, dmu_tx_t *);
893 
894 extern int spa_mode(spa_t *spa);
895 extern uint64_t zfs_strtonum(const char *str, char **nptr);
896 
897 extern char *spa_his_ievent_table[];
898 
899 extern void spa_history_create_obj(spa_t *spa, dmu_tx_t *tx);
900 extern int spa_history_get(spa_t *spa, uint64_t *offset, uint64_t *len_read,
901     char *his_buf);
902 extern int spa_history_log(spa_t *spa, const char *his_buf);
903 extern int spa_history_log_nvl(spa_t *spa, nvlist_t *nvl);
904 extern void spa_history_log_version(spa_t *spa, const char *operation);
905 extern void spa_history_log_internal(spa_t *spa, const char *operation,
906     dmu_tx_t *tx, const char *fmt, ...);
907 extern void spa_history_log_internal_ds(struct dsl_dataset *ds, const char *op,
908     dmu_tx_t *tx, const char *fmt, ...);
909 extern void spa_history_log_internal_dd(dsl_dir_t *dd, const char *operation,
910     dmu_tx_t *tx, const char *fmt, ...);
911 
912 /* error handling */
913 struct zbookmark_phys;
914 extern void spa_log_error(spa_t *spa, zio_t *zio);
915 extern void zfs_ereport_post(const char *cls, spa_t *spa, vdev_t *vd,
916     zio_t *zio, uint64_t stateoroffset, uint64_t length);
917 extern void zfs_post_remove(spa_t *spa, vdev_t *vd);
918 extern void zfs_post_state_change(spa_t *spa, vdev_t *vd);
919 extern void zfs_post_autoreplace(spa_t *spa, vdev_t *vd);
920 extern uint64_t spa_get_errlog_size(spa_t *spa);
921 extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
922 extern void spa_errlog_rotate(spa_t *spa);
923 extern void spa_errlog_drain(spa_t *spa);
924 extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
925 extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
926 
927 /* vdev cache */
928 extern void vdev_cache_stat_init(void);
929 extern void vdev_cache_stat_fini(void);
930 
931 /* Initialization and termination */
932 extern void spa_init(int flags);
933 extern void spa_fini(void);
934 extern void spa_boot_init(void);
935 
936 /* properties */
937 extern int spa_prop_set(spa_t *spa, nvlist_t *nvp);
938 extern int spa_prop_get(spa_t *spa, nvlist_t **nvp);
939 extern void spa_prop_clear_bootfs(spa_t *spa, uint64_t obj, dmu_tx_t *tx);
940 extern void spa_configfile_set(spa_t *, nvlist_t *, boolean_t);
941 
942 /* asynchronous event notification */
943 extern void spa_event_notify(spa_t *spa, vdev_t *vdev, nvlist_t *hist_nvl,
944     const char *name);
945 extern sysevent_t *spa_event_create(spa_t *spa, vdev_t *vd, nvlist_t *hist_nvl,
946     const char *name);
947 extern void spa_event_post(sysevent_t *ev);
948 extern void spa_event_discard(sysevent_t *ev);
949 
950 #ifdef ZFS_DEBUG
951 #define	dprintf_bp(bp, fmt, ...) do {				\
952 	if (zfs_flags & ZFS_DEBUG_DPRINTF) {			\
953 	char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP);	\
954 	snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp));	\
955 	dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf);		\
956 	kmem_free(__blkbuf, BP_SPRINTF_LEN);			\
957 	} \
958 _NOTE(CONSTCOND) } while (0)
959 #else
960 #define	dprintf_bp(bp, fmt, ...)
961 #endif
962 
963 extern int spa_mode_global;			/* mode, e.g. FREAD | FWRITE */
964 
965 #ifdef	__cplusplus
966 }
967 #endif
968 
969 #endif	/* _SYS_SPA_H */
970