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.
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.
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]
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.
36 #include <sys/zfs_context.h>
37 #include <sys/nvpair.h>
38 #include <sys/sysevent.h>
39 #include <sys/sysmacros.h>
40 #include <sys/types.h>
41 #include <sys/fs/zfs.h>
49 * Forward references that lots of things need.
51 typedef struct spa spa_t;
52 typedef struct vdev vdev_t;
53 typedef struct metaslab metaslab_t;
54 typedef struct metaslab_group metaslab_group_t;
55 typedef struct metaslab_class metaslab_class_t;
56 typedef struct zio zio_t;
57 typedef struct zilog zilog_t;
58 typedef struct spa_aux_vdev spa_aux_vdev_t;
59 typedef struct ddt ddt_t;
60 typedef struct ddt_entry ddt_entry_t;
65 * General-purpose 32-bit and 64-bit bitfield encodings.
67 #define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len))
68 #define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len))
69 #define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low))
70 #define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low))
72 #define BF32_GET(x, low, len) BF32_DECODE(x, low, len)
73 #define BF64_GET(x, low, len) BF64_DECODE(x, low, len)
75 #define BF32_SET(x, low, len, val) do { \
76 ASSERT3U(val, <, 1U << (len)); \
77 ASSERT3U(low + len, <=, 32); \
78 (x) ^= BF32_ENCODE((x >> low) ^ (val), low, len); \
79 _NOTE(CONSTCOND) } while (0)
81 #define BF64_SET(x, low, len, val) do { \
82 ASSERT3U(val, <, 1ULL << (len)); \
83 ASSERT3U(low + len, <=, 64); \
84 ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)); \
85 _NOTE(CONSTCOND) } while (0)
87 #define BF32_GET_SB(x, low, len, shift, bias) \
88 ((BF32_GET(x, low, len) + (bias)) << (shift))
89 #define BF64_GET_SB(x, low, len, shift, bias) \
90 ((BF64_GET(x, low, len) + (bias)) << (shift))
92 #define BF32_SET_SB(x, low, len, shift, bias, val) do { \
93 ASSERT(IS_P2ALIGNED(val, 1U << shift)); \
94 ASSERT3S((val) >> (shift), >=, bias); \
95 BF32_SET(x, low, len, ((val) >> (shift)) - (bias)); \
96 _NOTE(CONSTCOND) } while (0)
97 #define BF64_SET_SB(x, low, len, shift, bias, val) do { \
98 ASSERT(IS_P2ALIGNED(val, 1ULL << shift)); \
99 ASSERT3S((val) >> (shift), >=, bias); \
100 BF64_SET(x, low, len, ((val) >> (shift)) - (bias)); \
101 _NOTE(CONSTCOND) } while (0)
104 * We currently support block sizes from 512 bytes to 16MB.
105 * The benefits of larger blocks, and thus larger IO, need to be weighed
106 * against the cost of COWing a giant block to modify one byte, and the
107 * large latency of reading or writing a large block.
109 * Note that although blocks up to 16MB are supported, the recordsize
110 * property can not be set larger than zfs_max_recordsize (default 1MB).
111 * See the comment near zfs_max_recordsize in dsl_dataset.c for details.
113 * Note that although the LSIZE field of the blkptr_t can store sizes up
114 * to 32MB, the dnode's dn_datablkszsec can only store sizes up to
115 * 32MB - 512 bytes. Therefore, we limit SPA_MAXBLOCKSIZE to 16MB.
117 #define SPA_MINBLOCKSHIFT 9
118 #define SPA_OLD_MAXBLOCKSHIFT 17
119 #define SPA_MAXBLOCKSHIFT 24
120 #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT)
121 #define SPA_OLD_MAXBLOCKSIZE (1ULL << SPA_OLD_MAXBLOCKSHIFT)
122 #define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT)
125 * Default maximum supported logical ashift.
127 * The current 8k allocation block size limit is due to the 8k
128 * aligned/sized operations performed by vdev_probe() on
129 * vdev_label->vl_pad2. Using another "safe region" for these tests
130 * would allow the limit to be raised to 16k, at the expense of
131 * only having 8 available uberblocks in the label area.
133 #define SPA_MAXASHIFT 13
136 * Default minimum supported logical ashift.
138 #define SPA_MINASHIFT SPA_MINBLOCKSHIFT
141 * Size of block to hold the configuration data (a packed nvlist)
143 #define SPA_CONFIG_BLOCKSIZE (1ULL << 14)
146 * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
147 * The ASIZE encoding should be at least 64 times larger (6 more bits)
148 * to support up to 4-way RAID-Z mirror mode with worst-case gang block
149 * overhead, three DVAs per bp, plus one more bit in case we do anything
150 * else that expands the ASIZE.
152 #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */
153 #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */
154 #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */
156 #define SPA_COMPRESSBITS 7
159 * All SPA data is represented by 128-bit data virtual addresses (DVAs).
160 * The members of the dva_t should be considered opaque outside the SPA.
163 uint64_t dva_word[2];
167 * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
169 typedef struct zio_cksum {
174 * Some checksums/hashes need a 256-bit initialization salt. This salt is kept
175 * secret and is suitable for use in MAC algorithms as the key.
177 typedef struct zio_cksum_salt {
178 uint8_t zcs_bytes[32];
182 * Each block is described by its DVAs, time of birth, checksum, etc.
183 * The word-by-word, bit-by-bit layout of the blkptr is as follows:
185 * 64 56 48 40 32 24 16 8 0
186 * +-------+-------+-------+-------+-------+-------+-------+-------+
187 * 0 | vdev1 | GRID | ASIZE |
188 * +-------+-------+-------+-------+-------+-------+-------+-------+
190 * +-------+-------+-------+-------+-------+-------+-------+-------+
191 * 2 | vdev2 | GRID | ASIZE |
192 * +-------+-------+-------+-------+-------+-------+-------+-------+
194 * +-------+-------+-------+-------+-------+-------+-------+-------+
195 * 4 | vdev3 | GRID | ASIZE |
196 * +-------+-------+-------+-------+-------+-------+-------+-------+
198 * +-------+-------+-------+-------+-------+-------+-------+-------+
199 * 6 |BDX|lvl| type | cksum |E| comp| PSIZE | LSIZE |
200 * +-------+-------+-------+-------+-------+-------+-------+-------+
202 * +-------+-------+-------+-------+-------+-------+-------+-------+
204 * +-------+-------+-------+-------+-------+-------+-------+-------+
205 * 9 | physical birth txg |
206 * +-------+-------+-------+-------+-------+-------+-------+-------+
207 * a | logical birth txg |
208 * +-------+-------+-------+-------+-------+-------+-------+-------+
210 * +-------+-------+-------+-------+-------+-------+-------+-------+
212 * +-------+-------+-------+-------+-------+-------+-------+-------+
214 * +-------+-------+-------+-------+-------+-------+-------+-------+
216 * +-------+-------+-------+-------+-------+-------+-------+-------+
218 * +-------+-------+-------+-------+-------+-------+-------+-------+
222 * vdev virtual device ID
223 * offset offset into virtual device
225 * PSIZE physical size (after compression)
226 * ASIZE allocated size (including RAID-Z parity and gang block headers)
227 * GRID RAID-Z layout information (reserved for future use)
228 * cksum checksum function
229 * comp compression function
230 * G gang block indicator
231 * B byteorder (endianness)
233 * X encryption (on version 30, which is not supported)
234 * E blkptr_t contains embedded data (see below)
235 * lvl level of indirection
236 * type DMU object type
237 * phys birth txg when dva[0] was written; zero if same as logical birth txg
238 * note that typically all the dva's would be written in this
239 * txg, but they could be different if they were moved by
241 * log. birth transaction group in which the block was logically born
242 * fill count number of non-zero blocks under this bp
243 * checksum[4] 256-bit checksum of the data this bp describes
247 * "Embedded" blkptr_t's don't actually point to a block, instead they
248 * have a data payload embedded in the blkptr_t itself. See the comment
249 * in blkptr.c for more details.
251 * The blkptr_t is laid out as follows:
253 * 64 56 48 40 32 24 16 8 0
254 * +-------+-------+-------+-------+-------+-------+-------+-------+
261 * +-------+-------+-------+-------+-------+-------+-------+-------+
262 * 6 |BDX|lvl| type | etype |E| comp| PSIZE| LSIZE |
263 * +-------+-------+-------+-------+-------+-------+-------+-------+
267 * +-------+-------+-------+-------+-------+-------+-------+-------+
268 * a | logical birth txg |
269 * +-------+-------+-------+-------+-------+-------+-------+-------+
275 * +-------+-------+-------+-------+-------+-------+-------+-------+
279 * payload contains the embedded data
280 * B (byteorder) byteorder (endianness)
281 * D (dedup) padding (set to zero)
282 * X encryption (set to zero; see above)
283 * E (embedded) set to one
284 * lvl indirection level
285 * type DMU object type
286 * etype how to interpret embedded data (BP_EMBEDDED_TYPE_*)
287 * comp compression function of payload
288 * PSIZE size of payload after compression, in bytes
289 * LSIZE logical size of payload, in bytes
290 * note that 25 bits is enough to store the largest
291 * "normal" BP's LSIZE (2^16 * 2^9) in bytes
292 * log. birth transaction group in which the block was logically born
294 * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
295 * bp's they are stored in units of SPA_MINBLOCKSHIFT.
296 * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
297 * The B, D, X, lvl, type, and comp fields are stored the same as with normal
298 * BP's so the BP_SET_* macros can be used with them. etype, PSIZE, LSIZE must
299 * be set with the BPE_SET_* macros. BP_SET_EMBEDDED() should be called before
300 * other macros, as they assert that they are only used on BP's of the correct
304 #define BPE_GET_ETYPE(bp) \
305 (ASSERT(BP_IS_EMBEDDED(bp)), \
306 BF64_GET((bp)->blk_prop, 40, 8))
307 #define BPE_SET_ETYPE(bp, t) do { \
308 ASSERT(BP_IS_EMBEDDED(bp)); \
309 BF64_SET((bp)->blk_prop, 40, 8, t); \
310 _NOTE(CONSTCOND) } while (0)
312 #define BPE_GET_LSIZE(bp) \
313 (ASSERT(BP_IS_EMBEDDED(bp)), \
314 BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
315 #define BPE_SET_LSIZE(bp, x) do { \
316 ASSERT(BP_IS_EMBEDDED(bp)); \
317 BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
318 _NOTE(CONSTCOND) } while (0)
320 #define BPE_GET_PSIZE(bp) \
321 (ASSERT(BP_IS_EMBEDDED(bp)), \
322 BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
323 #define BPE_SET_PSIZE(bp, x) do { \
324 ASSERT(BP_IS_EMBEDDED(bp)); \
325 BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
326 _NOTE(CONSTCOND) } while (0)
328 typedef enum bp_embedded_type {
329 BP_EMBEDDED_TYPE_DATA,
330 BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */
331 NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED
332 } bp_embedded_type_t;
334 #define BPE_NUM_WORDS 14
335 #define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
336 #define BPE_IS_PAYLOADWORD(bp, wp) \
337 ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
339 #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */
340 #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */
341 #define SPA_SYNC_MIN_VDEVS 3 /* min vdevs to update during sync */
344 * A block is a hole when it has either 1) never been written to, or
345 * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
346 * without physically allocating disk space. Holes are represented in the
347 * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
348 * done through the BP_IS_HOLE macro. For holes, the logical size, level,
349 * DMU object type, and birth times are all also stored for holes that
350 * were written to at some point (i.e. were punched after having been filled).
352 typedef struct blkptr {
353 dva_t blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
354 uint64_t blk_prop; /* size, compression, type, etc */
355 uint64_t blk_pad[2]; /* Extra space for the future */
356 uint64_t blk_phys_birth; /* txg when block was allocated */
357 uint64_t blk_birth; /* transaction group at birth */
358 uint64_t blk_fill; /* fill count */
359 zio_cksum_t blk_cksum; /* 256-bit checksum */
363 * Macros to get and set fields in a bp or DVA.
365 #define DVA_GET_ASIZE(dva) \
366 BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
367 #define DVA_SET_ASIZE(dva, x) \
368 BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
369 SPA_MINBLOCKSHIFT, 0, x)
371 #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8)
372 #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x)
374 #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32)
375 #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x)
377 #define DVA_GET_OFFSET(dva) \
378 BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
379 #define DVA_SET_OFFSET(dva, x) \
380 BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
382 #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1)
383 #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x)
385 #define BP_GET_LSIZE(bp) \
386 (BP_IS_EMBEDDED(bp) ? \
387 (BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
388 BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
389 #define BP_SET_LSIZE(bp, x) do { \
390 ASSERT(!BP_IS_EMBEDDED(bp)); \
391 BF64_SET_SB((bp)->blk_prop, \
392 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
393 _NOTE(CONSTCOND) } while (0)
395 #define BP_GET_PSIZE(bp) \
396 (BP_IS_EMBEDDED(bp) ? 0 : \
397 BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1))
398 #define BP_SET_PSIZE(bp, x) do { \
399 ASSERT(!BP_IS_EMBEDDED(bp)); \
400 BF64_SET_SB((bp)->blk_prop, \
401 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
402 _NOTE(CONSTCOND) } while (0)
404 #define BP_GET_COMPRESS(bp) \
405 BF64_GET((bp)->blk_prop, 32, SPA_COMPRESSBITS)
406 #define BP_SET_COMPRESS(bp, x) \
407 BF64_SET((bp)->blk_prop, 32, SPA_COMPRESSBITS, x)
409 #define BP_IS_EMBEDDED(bp) BF64_GET((bp)->blk_prop, 39, 1)
410 #define BP_SET_EMBEDDED(bp, x) BF64_SET((bp)->blk_prop, 39, 1, x)
412 #define BP_GET_CHECKSUM(bp) \
413 (BP_IS_EMBEDDED(bp) ? ZIO_CHECKSUM_OFF : \
414 BF64_GET((bp)->blk_prop, 40, 8))
415 #define BP_SET_CHECKSUM(bp, x) do { \
416 ASSERT(!BP_IS_EMBEDDED(bp)); \
417 BF64_SET((bp)->blk_prop, 40, 8, x); \
418 _NOTE(CONSTCOND) } while (0)
420 #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8)
421 #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x)
423 #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5)
424 #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x)
426 #define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1)
427 #define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x)
429 #define BP_GET_BYTEORDER(bp) BF64_GET((bp)->blk_prop, 63, 1)
430 #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x)
432 #define BP_PHYSICAL_BIRTH(bp) \
433 (BP_IS_EMBEDDED(bp) ? 0 : \
434 (bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
436 #define BP_SET_BIRTH(bp, logical, physical) \
438 ASSERT(!BP_IS_EMBEDDED(bp)); \
439 (bp)->blk_birth = (logical); \
440 (bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
443 #define BP_GET_FILL(bp) (BP_IS_EMBEDDED(bp) ? 1 : (bp)->blk_fill)
445 #define BP_IS_METADATA(bp) \
446 (BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))
448 #define BP_GET_ASIZE(bp) \
449 (BP_IS_EMBEDDED(bp) ? 0 : \
450 DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
451 DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
452 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
454 #define BP_GET_UCSIZE(bp) \
455 (BP_IS_METADATA(bp) ? BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
457 #define BP_GET_NDVAS(bp) \
458 (BP_IS_EMBEDDED(bp) ? 0 : \
459 !!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
460 !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
461 !!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
463 #define BP_COUNT_GANG(bp) \
464 (BP_IS_EMBEDDED(bp) ? 0 : \
465 (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
466 DVA_GET_GANG(&(bp)->blk_dva[1]) + \
467 DVA_GET_GANG(&(bp)->blk_dva[2])))
469 #define DVA_EQUAL(dva1, dva2) \
470 ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
471 (dva1)->dva_word[0] == (dva2)->dva_word[0])
473 #define BP_EQUAL(bp1, bp2) \
474 (BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) && \
475 (bp1)->blk_birth == (bp2)->blk_birth && \
476 DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) && \
477 DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) && \
478 DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
480 #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \
481 (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
482 ((zc1).zc_word[1] - (zc2).zc_word[1]) | \
483 ((zc1).zc_word[2] - (zc2).zc_word[2]) | \
484 ((zc1).zc_word[3] - (zc2).zc_word[3])))
486 #define ZIO_CHECKSUM_IS_ZERO(zc) \
487 (0 == ((zc)->zc_word[0] | (zc)->zc_word[1] | \
488 (zc)->zc_word[2] | (zc)->zc_word[3]))
490 #define ZIO_CHECKSUM_BSWAP(zcp) \
492 (zcp)->zc_word[0] = BSWAP_64((zcp)->zc_word[0]); \
493 (zcp)->zc_word[1] = BSWAP_64((zcp)->zc_word[1]); \
494 (zcp)->zc_word[2] = BSWAP_64((zcp)->zc_word[2]); \
495 (zcp)->zc_word[3] = BSWAP_64((zcp)->zc_word[3]); \
499 #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0)
501 #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \
503 (zcp)->zc_word[0] = w0; \
504 (zcp)->zc_word[1] = w1; \
505 (zcp)->zc_word[2] = w2; \
506 (zcp)->zc_word[3] = w3; \
509 #define BP_IDENTITY(bp) (ASSERT(!BP_IS_EMBEDDED(bp)), &(bp)->blk_dva[0])
510 #define BP_IS_GANG(bp) \
511 (BP_IS_EMBEDDED(bp) ? B_FALSE : DVA_GET_GANG(BP_IDENTITY(bp)))
512 #define DVA_IS_EMPTY(dva) ((dva)->dva_word[0] == 0ULL && \
513 (dva)->dva_word[1] == 0ULL)
514 #define BP_IS_HOLE(bp) \
515 (!BP_IS_EMBEDDED(bp) && DVA_IS_EMPTY(BP_IDENTITY(bp)))
517 /* BP_IS_RAIDZ(bp) assumes no block compression */
518 #define BP_IS_RAIDZ(bp) (DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
521 #define BP_ZERO(bp) \
523 (bp)->blk_dva[0].dva_word[0] = 0; \
524 (bp)->blk_dva[0].dva_word[1] = 0; \
525 (bp)->blk_dva[1].dva_word[0] = 0; \
526 (bp)->blk_dva[1].dva_word[1] = 0; \
527 (bp)->blk_dva[2].dva_word[0] = 0; \
528 (bp)->blk_dva[2].dva_word[1] = 0; \
529 (bp)->blk_prop = 0; \
530 (bp)->blk_pad[0] = 0; \
531 (bp)->blk_pad[1] = 0; \
532 (bp)->blk_phys_birth = 0; \
533 (bp)->blk_birth = 0; \
534 (bp)->blk_fill = 0; \
535 ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
538 #if BYTE_ORDER == _BIG_ENDIAN
539 #define ZFS_HOST_BYTEORDER (0ULL)
541 #define ZFS_HOST_BYTEORDER (1ULL)
544 #define BP_SHOULD_BYTESWAP(bp) (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
546 #define BP_SPRINTF_LEN 320
549 * This macro allows code sharing between zfs, libzpool, and mdb.
550 * 'func' is either snprintf() or mdb_snprintf().
551 * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
553 #define SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
555 static const char *copyname[] = \
556 { "zero", "single", "double", "triple" }; \
561 len += func(buf + len, size - len, "<NULL>"); \
562 } else if (BP_IS_HOLE(bp)) { \
563 len += func(buf + len, size - len, \
565 "size=%llxL birth=%lluL", \
566 (u_longlong_t)BP_GET_LEVEL(bp), \
568 (u_longlong_t)BP_GET_LSIZE(bp), \
569 (u_longlong_t)bp->blk_birth); \
570 } else if (BP_IS_EMBEDDED(bp)) { \
571 len = func(buf + len, size - len, \
572 "EMBEDDED [L%llu %s] et=%u %s " \
573 "size=%llxL/%llxP birth=%lluL", \
574 (u_longlong_t)BP_GET_LEVEL(bp), \
576 (int)BPE_GET_ETYPE(bp), \
578 (u_longlong_t)BPE_GET_LSIZE(bp), \
579 (u_longlong_t)BPE_GET_PSIZE(bp), \
580 (u_longlong_t)bp->blk_birth); \
582 for (int d = 0; d < BP_GET_NDVAS(bp); d++) { \
583 const dva_t *dva = &bp->blk_dva[d]; \
584 if (DVA_IS_VALID(dva)) \
586 len += func(buf + len, size - len, \
587 "DVA[%d]=<%llu:%llx:%llx>%c", d, \
588 (u_longlong_t)DVA_GET_VDEV(dva), \
589 (u_longlong_t)DVA_GET_OFFSET(dva), \
590 (u_longlong_t)DVA_GET_ASIZE(dva), \
593 if (BP_IS_GANG(bp) && \
594 DVA_GET_ASIZE(&bp->blk_dva[2]) <= \
595 DVA_GET_ASIZE(&bp->blk_dva[1]) / 2) \
597 len += func(buf + len, size - len, \
598 "[L%llu %s] %s %s %s %s %s %s%c" \
599 "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c" \
600 "cksum=%llx:%llx:%llx:%llx", \
601 (u_longlong_t)BP_GET_LEVEL(bp), \
605 BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE", \
606 BP_IS_GANG(bp) ? "gang" : "contiguous", \
607 BP_GET_DEDUP(bp) ? "dedup" : "unique", \
610 (u_longlong_t)BP_GET_LSIZE(bp), \
611 (u_longlong_t)BP_GET_PSIZE(bp), \
612 (u_longlong_t)bp->blk_birth, \
613 (u_longlong_t)BP_PHYSICAL_BIRTH(bp), \
614 (u_longlong_t)BP_GET_FILL(bp), \
616 (u_longlong_t)bp->blk_cksum.zc_word[0], \
617 (u_longlong_t)bp->blk_cksum.zc_word[1], \
618 (u_longlong_t)bp->blk_cksum.zc_word[2], \
619 (u_longlong_t)bp->blk_cksum.zc_word[3]); \
621 ASSERT(len < size); \
624 #define BP_GET_BUFC_TYPE(bp) \
625 (BP_IS_METADATA(bp) ? ARC_BUFC_METADATA : ARC_BUFC_DATA)
627 typedef enum spa_import_type {
632 /* state manipulation functions */
633 extern int spa_open(const char *pool, spa_t **, void *tag);
634 extern int spa_open_rewind(const char *pool, spa_t **, void *tag,
635 nvlist_t *policy, nvlist_t **config);
636 extern int spa_get_stats(const char *pool, nvlist_t **config, char *altroot,
638 extern int spa_create(const char *pool, nvlist_t *config, nvlist_t *props,
641 extern int spa_import_rootpool(char *devpath, char *devid);
643 extern int spa_import_rootpool(const char *name);
645 extern int spa_import(const char *pool, nvlist_t *config, nvlist_t *props,
647 extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
648 extern int spa_destroy(char *pool);
649 extern int spa_checkpoint(const char *pool);
650 extern int spa_checkpoint_discard(const char *pool);
651 extern int spa_export(char *pool, nvlist_t **oldconfig, boolean_t force,
652 boolean_t hardforce);
653 extern int spa_reset(char *pool);
654 extern void spa_async_request(spa_t *spa, int flag);
655 extern void spa_async_unrequest(spa_t *spa, int flag);
656 extern void spa_async_suspend(spa_t *spa);
657 extern void spa_async_resume(spa_t *spa);
658 extern spa_t *spa_inject_addref(char *pool);
659 extern void spa_inject_delref(spa_t *spa);
660 extern void spa_scan_stat_init(spa_t *spa);
661 extern int spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps);
663 #define SPA_ASYNC_CONFIG_UPDATE 0x01
664 #define SPA_ASYNC_REMOVE 0x02
665 #define SPA_ASYNC_PROBE 0x04
666 #define SPA_ASYNC_RESILVER_DONE 0x08
667 #define SPA_ASYNC_RESILVER 0x10
668 #define SPA_ASYNC_AUTOEXPAND 0x20
669 #define SPA_ASYNC_REMOVE_DONE 0x40
670 #define SPA_ASYNC_REMOVE_STOP 0x80
673 * Controls the behavior of spa_vdev_remove().
675 #define SPA_REMOVE_UNSPARE 0x01
676 #define SPA_REMOVE_DONE 0x02
678 /* device manipulation */
679 extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
680 extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
682 extern int spa_vdev_detach(spa_t *spa, uint64_t guid, uint64_t pguid,
684 extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
685 extern boolean_t spa_vdev_remove_active(spa_t *spa);
686 extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
687 extern int spa_vdev_setfru(spa_t *spa, uint64_t guid, const char *newfru);
688 extern int spa_vdev_split_mirror(spa_t *spa, char *newname, nvlist_t *config,
689 nvlist_t *props, boolean_t exp);
691 /* spare state (which is global across all pools) */
692 extern void spa_spare_add(vdev_t *vd);
693 extern void spa_spare_remove(vdev_t *vd);
694 extern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt);
695 extern void spa_spare_activate(vdev_t *vd);
697 /* L2ARC state (which is global across all pools) */
698 extern void spa_l2cache_add(vdev_t *vd);
699 extern void spa_l2cache_remove(vdev_t *vd);
700 extern boolean_t spa_l2cache_exists(uint64_t guid, uint64_t *pool);
701 extern void spa_l2cache_activate(vdev_t *vd);
702 extern void spa_l2cache_drop(spa_t *spa);
705 extern int spa_scan(spa_t *spa, pool_scan_func_t func);
706 extern int spa_scan_stop(spa_t *spa);
707 extern int spa_scrub_pause_resume(spa_t *spa, pool_scrub_cmd_t flag);
710 extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
711 extern void spa_sync_allpools(void);
713 /* spa namespace global mutex */
714 extern kmutex_t spa_namespace_lock;
717 * SPA configuration functions in spa_config.c
720 #define SPA_CONFIG_UPDATE_POOL 0
721 #define SPA_CONFIG_UPDATE_VDEVS 1
723 extern void spa_write_cachefile(spa_t *, boolean_t, boolean_t);
724 extern void spa_config_load(void);
725 extern nvlist_t *spa_all_configs(uint64_t *);
726 extern void spa_config_set(spa_t *spa, nvlist_t *config);
727 extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
729 extern void spa_config_update(spa_t *spa, int what);
732 * Miscellaneous SPA routines in spa_misc.c
735 /* Namespace manipulation */
736 extern spa_t *spa_lookup(const char *name);
737 extern spa_t *spa_add(const char *name, nvlist_t *config, const char *altroot);
738 extern void spa_remove(spa_t *spa);
739 extern spa_t *spa_next(spa_t *prev);
741 /* Refcount functions */
742 extern void spa_open_ref(spa_t *spa, void *tag);
743 extern void spa_close(spa_t *spa, void *tag);
744 extern void spa_async_close(spa_t *spa, void *tag);
745 extern boolean_t spa_refcount_zero(spa_t *spa);
747 #define SCL_NONE 0x00
748 #define SCL_CONFIG 0x01
749 #define SCL_STATE 0x02
750 #define SCL_L2ARC 0x04 /* hack until L2ARC 2.0 */
751 #define SCL_ALLOC 0x08
753 #define SCL_FREE 0x20
754 #define SCL_VDEV 0x40
756 #define SCL_ALL ((1 << SCL_LOCKS) - 1)
757 #define SCL_STATE_ALL (SCL_STATE | SCL_L2ARC | SCL_ZIO)
759 /* Pool configuration locks */
760 extern int spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw);
761 extern void spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw);
762 extern void spa_config_exit(spa_t *spa, int locks, void *tag);
763 extern int spa_config_held(spa_t *spa, int locks, krw_t rw);
765 /* Pool vdev add/remove lock */
766 extern uint64_t spa_vdev_enter(spa_t *spa);
767 extern uint64_t spa_vdev_config_enter(spa_t *spa);
768 extern void spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg,
769 int error, char *tag);
770 extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
772 /* Pool vdev state change lock */
773 extern void spa_vdev_state_enter(spa_t *spa, int oplock);
774 extern int spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error);
777 typedef enum spa_log_state {
778 SPA_LOG_UNKNOWN = 0, /* unknown log state */
779 SPA_LOG_MISSING, /* missing log(s) */
780 SPA_LOG_CLEAR, /* clear the log(s) */
781 SPA_LOG_GOOD, /* log(s) are good */
784 extern spa_log_state_t spa_get_log_state(spa_t *spa);
785 extern void spa_set_log_state(spa_t *spa, spa_log_state_t state);
786 extern int spa_reset_logs(spa_t *spa);
788 /* Log claim callback */
789 extern void spa_claim_notify(zio_t *zio);
791 /* Accessor functions */
792 extern boolean_t spa_shutting_down(spa_t *spa);
793 extern struct dsl_pool *spa_get_dsl(spa_t *spa);
794 extern boolean_t spa_is_initializing(spa_t *spa);
795 extern boolean_t spa_indirect_vdevs_loaded(spa_t *spa);
796 extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
797 extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
798 extern void spa_altroot(spa_t *, char *, size_t);
799 extern int spa_sync_pass(spa_t *spa);
800 extern char *spa_name(spa_t *spa);
801 extern uint64_t spa_guid(spa_t *spa);
802 extern uint64_t spa_load_guid(spa_t *spa);
803 extern uint64_t spa_last_synced_txg(spa_t *spa);
804 extern uint64_t spa_first_txg(spa_t *spa);
805 extern uint64_t spa_syncing_txg(spa_t *spa);
806 extern uint64_t spa_final_dirty_txg(spa_t *spa);
807 extern uint64_t spa_version(spa_t *spa);
808 extern pool_state_t spa_state(spa_t *spa);
809 extern spa_load_state_t spa_load_state(spa_t *spa);
810 extern uint64_t spa_freeze_txg(spa_t *spa);
811 extern uint64_t spa_get_worst_case_asize(spa_t *spa, uint64_t lsize);
812 extern uint64_t spa_get_dspace(spa_t *spa);
813 extern uint64_t spa_get_checkpoint_space(spa_t *spa);
814 extern uint64_t spa_get_slop_space(spa_t *spa);
815 extern void spa_update_dspace(spa_t *spa);
816 extern uint64_t spa_version(spa_t *spa);
817 extern boolean_t spa_deflate(spa_t *spa);
818 extern metaslab_class_t *spa_normal_class(spa_t *spa);
819 extern metaslab_class_t *spa_log_class(spa_t *spa);
820 extern void spa_evicting_os_register(spa_t *, objset_t *os);
821 extern void spa_evicting_os_deregister(spa_t *, objset_t *os);
822 extern void spa_evicting_os_wait(spa_t *spa);
823 extern int spa_max_replication(spa_t *spa);
824 extern int spa_prev_software_version(spa_t *spa);
825 extern int spa_busy(void);
826 extern uint8_t spa_get_failmode(spa_t *spa);
827 extern boolean_t spa_suspended(spa_t *spa);
828 extern uint64_t spa_bootfs(spa_t *spa);
829 extern uint64_t spa_delegation(spa_t *spa);
830 extern objset_t *spa_meta_objset(spa_t *spa);
831 extern uint64_t spa_deadman_synctime(spa_t *spa);
833 /* Miscellaneous support routines */
834 extern void spa_load_failed(spa_t *spa, const char *fmt, ...);
835 extern void spa_load_note(spa_t *spa, const char *fmt, ...);
836 extern void spa_activate_mos_feature(spa_t *spa, const char *feature,
838 extern void spa_deactivate_mos_feature(spa_t *spa, const char *feature);
839 extern int spa_rename(const char *oldname, const char *newname);
840 extern spa_t *spa_by_guid(uint64_t pool_guid, uint64_t device_guid);
841 extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
842 extern char *spa_strdup(const char *);
843 extern void spa_strfree(char *);
844 extern uint64_t spa_get_random(uint64_t range);
845 extern uint64_t spa_generate_guid(spa_t *spa);
846 extern void snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp);
847 extern void spa_freeze(spa_t *spa);
848 extern int spa_change_guid(spa_t *spa);
849 extern void spa_upgrade(spa_t *spa, uint64_t version);
850 extern void spa_evict_all(void);
851 extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid,
853 extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
854 extern uint64_t dva_get_dsize_sync(spa_t *spa, const dva_t *dva);
855 extern uint64_t bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp);
856 extern uint64_t bp_get_dsize(spa_t *spa, const blkptr_t *bp);
857 extern boolean_t spa_has_slogs(spa_t *spa);
858 extern boolean_t spa_is_root(spa_t *spa);
859 extern boolean_t spa_writeable(spa_t *spa);
860 extern boolean_t spa_has_pending_synctask(spa_t *spa);
861 extern int spa_maxblocksize(spa_t *spa);
862 extern boolean_t spa_has_checkpoint(spa_t *spa);
863 extern boolean_t spa_importing_readonly_checkpoint(spa_t *spa);
864 extern boolean_t spa_suspend_async_destroy(spa_t *spa);
865 extern uint64_t spa_min_claim_txg(spa_t *spa);
866 extern void zfs_blkptr_verify(spa_t *spa, const blkptr_t *bp);
867 extern boolean_t zfs_dva_valid(spa_t *spa, const dva_t *dva,
869 typedef void (*spa_remap_cb_t)(uint64_t vdev, uint64_t offset, uint64_t size,
871 extern boolean_t spa_remap_blkptr(spa_t *spa, blkptr_t *bp,
872 spa_remap_cb_t callback, void *arg);
873 extern uint64_t spa_get_last_removal_txg(spa_t *spa);
874 extern boolean_t spa_trust_config(spa_t *spa);
875 extern uint64_t spa_missing_tvds_allowed(spa_t *spa);
876 extern void spa_set_missing_tvds(spa_t *spa, uint64_t missing);
877 extern boolean_t spa_top_vdevs_spacemap_addressable(spa_t *spa);
879 extern int spa_mode(spa_t *spa);
880 extern uint64_t zfs_strtonum(const char *str, char **nptr);
882 extern char *spa_his_ievent_table[];
884 extern void spa_history_create_obj(spa_t *spa, dmu_tx_t *tx);
885 extern int spa_history_get(spa_t *spa, uint64_t *offset, uint64_t *len_read,
887 extern int spa_history_log(spa_t *spa, const char *his_buf);
888 extern int spa_history_log_nvl(spa_t *spa, nvlist_t *nvl);
889 extern void spa_history_log_version(spa_t *spa, const char *operation);
890 extern void spa_history_log_internal(spa_t *spa, const char *operation,
891 dmu_tx_t *tx, const char *fmt, ...);
892 extern void spa_history_log_internal_ds(struct dsl_dataset *ds, const char *op,
893 dmu_tx_t *tx, const char *fmt, ...);
894 extern void spa_history_log_internal_dd(dsl_dir_t *dd, const char *operation,
895 dmu_tx_t *tx, const char *fmt, ...);
898 struct zbookmark_phys;
899 extern void spa_log_error(spa_t *spa, zio_t *zio);
900 extern void zfs_ereport_post(const char *cls, spa_t *spa, vdev_t *vd,
901 zio_t *zio, uint64_t stateoroffset, uint64_t length);
902 extern void zfs_post_remove(spa_t *spa, vdev_t *vd);
903 extern void zfs_post_state_change(spa_t *spa, vdev_t *vd);
904 extern void zfs_post_autoreplace(spa_t *spa, vdev_t *vd);
905 extern uint64_t spa_get_errlog_size(spa_t *spa);
906 extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
907 extern void spa_errlog_rotate(spa_t *spa);
908 extern void spa_errlog_drain(spa_t *spa);
909 extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
910 extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
913 extern void vdev_cache_stat_init(void);
914 extern void vdev_cache_stat_fini(void);
916 /* Initialization and termination */
917 extern void spa_init(int flags);
918 extern void spa_fini(void);
919 extern void spa_boot_init(void);
922 extern int spa_prop_set(spa_t *spa, nvlist_t *nvp);
923 extern int spa_prop_get(spa_t *spa, nvlist_t **nvp);
924 extern void spa_prop_clear_bootfs(spa_t *spa, uint64_t obj, dmu_tx_t *tx);
925 extern void spa_configfile_set(spa_t *, nvlist_t *, boolean_t);
927 /* asynchronous event notification */
928 extern void spa_event_notify(spa_t *spa, vdev_t *vdev, nvlist_t *hist_nvl,
930 extern sysevent_t *spa_event_create(spa_t *spa, vdev_t *vd, nvlist_t *hist_nvl,
932 extern void spa_event_post(sysevent_t *ev);
933 extern void spa_event_discard(sysevent_t *ev);
936 #define dprintf_bp(bp, fmt, ...) do { \
937 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
938 char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP); \
939 snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp)); \
940 dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf); \
941 kmem_free(__blkbuf, BP_SPRINTF_LEN); \
943 _NOTE(CONSTCOND) } while (0)
945 #define dprintf_bp(bp, fmt, ...)
948 extern boolean_t spa_debug_enabled(spa_t *spa);
949 #define spa_dbgmsg(spa, ...) \
951 if (spa_debug_enabled(spa)) \
952 zfs_dbgmsg(__VA_ARGS__); \
955 extern int spa_mode_global; /* mode, e.g. FREAD | FWRITE */
961 #endif /* _SYS_SPA_H */