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, 2016 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 (c) 2017 Datto Inc.
35 #include <sys/zfs_context.h>
36 #include <sys/nvpair.h>
37 #include <sys/sysmacros.h>
38 #include <sys/types.h>
39 #include <sys/fs/zfs.h>
47 * Forward references that lots of things need.
49 typedef struct spa spa_t;
50 typedef struct vdev vdev_t;
51 typedef struct metaslab metaslab_t;
52 typedef struct metaslab_group metaslab_group_t;
53 typedef struct metaslab_class metaslab_class_t;
54 typedef struct zio zio_t;
55 typedef struct zilog zilog_t;
56 typedef struct spa_aux_vdev spa_aux_vdev_t;
57 typedef struct ddt ddt_t;
58 typedef struct ddt_entry ddt_entry_t;
63 * General-purpose 32-bit and 64-bit bitfield encodings.
65 #define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len))
66 #define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len))
67 #define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low))
68 #define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low))
70 #define BF32_GET(x, low, len) BF32_DECODE(x, low, len)
71 #define BF64_GET(x, low, len) BF64_DECODE(x, low, len)
73 #define BF32_SET(x, low, len, val) do { \
74 ASSERT3U(val, <, 1U << (len)); \
75 ASSERT3U(low + len, <=, 32); \
76 (x) ^= BF32_ENCODE((x >> low) ^ (val), low, len); \
77 _NOTE(CONSTCOND) } while (0)
79 #define BF64_SET(x, low, len, val) do { \
80 ASSERT3U(val, <, 1ULL << (len)); \
81 ASSERT3U(low + len, <=, 64); \
82 ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)); \
83 _NOTE(CONSTCOND) } while (0)
85 #define BF32_GET_SB(x, low, len, shift, bias) \
86 ((BF32_GET(x, low, len) + (bias)) << (shift))
87 #define BF64_GET_SB(x, low, len, shift, bias) \
88 ((BF64_GET(x, low, len) + (bias)) << (shift))
90 #define BF32_SET_SB(x, low, len, shift, bias, val) do { \
91 ASSERT(IS_P2ALIGNED(val, 1U << shift)); \
92 ASSERT3S((val) >> (shift), >=, bias); \
93 BF32_SET(x, low, len, ((val) >> (shift)) - (bias)); \
94 _NOTE(CONSTCOND) } while (0)
95 #define BF64_SET_SB(x, low, len, shift, bias, val) do { \
96 ASSERT(IS_P2ALIGNED(val, 1ULL << shift)); \
97 ASSERT3S((val) >> (shift), >=, bias); \
98 BF64_SET(x, low, len, ((val) >> (shift)) - (bias)); \
99 _NOTE(CONSTCOND) } while (0)
102 * We currently support block sizes from 512 bytes to 16MB.
103 * The benefits of larger blocks, and thus larger IO, need to be weighed
104 * against the cost of COWing a giant block to modify one byte, and the
105 * large latency of reading or writing a large block.
107 * Note that although blocks up to 16MB are supported, the recordsize
108 * property can not be set larger than zfs_max_recordsize (default 1MB).
109 * See the comment near zfs_max_recordsize in dsl_dataset.c for details.
111 * Note that although the LSIZE field of the blkptr_t can store sizes up
112 * to 32MB, the dnode's dn_datablkszsec can only store sizes up to
113 * 32MB - 512 bytes. Therefore, we limit SPA_MAXBLOCKSIZE to 16MB.
115 #define SPA_MINBLOCKSHIFT 9
116 #define SPA_OLD_MAXBLOCKSHIFT 17
117 #define SPA_MAXBLOCKSHIFT 24
118 #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT)
119 #define SPA_OLD_MAXBLOCKSIZE (1ULL << SPA_OLD_MAXBLOCKSHIFT)
120 #define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT)
123 * Default maximum supported logical ashift.
125 * The current 8k allocation block size limit is due to the 8k
126 * aligned/sized operations performed by vdev_probe() on
127 * vdev_label->vl_pad2. Using another "safe region" for these tests
128 * would allow the limit to be raised to 16k, at the expense of
129 * only having 8 available uberblocks in the label area.
131 #define SPA_MAXASHIFT 13
134 * Default minimum supported logical ashift.
136 #define SPA_MINASHIFT SPA_MINBLOCKSHIFT
139 * Size of block to hold the configuration data (a packed nvlist)
141 #define SPA_CONFIG_BLOCKSIZE (1ULL << 14)
144 * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
145 * The ASIZE encoding should be at least 64 times larger (6 more bits)
146 * to support up to 4-way RAID-Z mirror mode with worst-case gang block
147 * overhead, three DVAs per bp, plus one more bit in case we do anything
148 * else that expands the ASIZE.
150 #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */
151 #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */
152 #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */
154 #define SPA_COMPRESSBITS 7
157 * All SPA data is represented by 128-bit data virtual addresses (DVAs).
158 * The members of the dva_t should be considered opaque outside the SPA.
161 uint64_t dva_word[2];
165 * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
167 typedef struct zio_cksum {
172 * Some checksums/hashes need a 256-bit initialization salt. This salt is kept
173 * secret and is suitable for use in MAC algorithms as the key.
175 typedef struct zio_cksum_salt {
176 uint8_t zcs_bytes[32];
180 * Each block is described by its DVAs, time of birth, checksum, etc.
181 * The word-by-word, bit-by-bit layout of the blkptr is as follows:
183 * 64 56 48 40 32 24 16 8 0
184 * +-------+-------+-------+-------+-------+-------+-------+-------+
185 * 0 | vdev1 | GRID | ASIZE |
186 * +-------+-------+-------+-------+-------+-------+-------+-------+
188 * +-------+-------+-------+-------+-------+-------+-------+-------+
189 * 2 | vdev2 | GRID | ASIZE |
190 * +-------+-------+-------+-------+-------+-------+-------+-------+
192 * +-------+-------+-------+-------+-------+-------+-------+-------+
193 * 4 | vdev3 | GRID | ASIZE |
194 * +-------+-------+-------+-------+-------+-------+-------+-------+
196 * +-------+-------+-------+-------+-------+-------+-------+-------+
197 * 6 |BDX|lvl| type | cksum |E| comp| PSIZE | LSIZE |
198 * +-------+-------+-------+-------+-------+-------+-------+-------+
200 * +-------+-------+-------+-------+-------+-------+-------+-------+
202 * +-------+-------+-------+-------+-------+-------+-------+-------+
203 * 9 | physical birth txg |
204 * +-------+-------+-------+-------+-------+-------+-------+-------+
205 * a | logical birth txg |
206 * +-------+-------+-------+-------+-------+-------+-------+-------+
208 * +-------+-------+-------+-------+-------+-------+-------+-------+
210 * +-------+-------+-------+-------+-------+-------+-------+-------+
212 * +-------+-------+-------+-------+-------+-------+-------+-------+
214 * +-------+-------+-------+-------+-------+-------+-------+-------+
216 * +-------+-------+-------+-------+-------+-------+-------+-------+
220 * vdev virtual device ID
221 * offset offset into virtual device
223 * PSIZE physical size (after compression)
224 * ASIZE allocated size (including RAID-Z parity and gang block headers)
225 * GRID RAID-Z layout information (reserved for future use)
226 * cksum checksum function
227 * comp compression function
228 * G gang block indicator
229 * B byteorder (endianness)
231 * X encryption (on version 30, which is not supported)
232 * E blkptr_t contains embedded data (see below)
233 * lvl level of indirection
234 * type DMU object type
235 * phys birth txg of block allocation; zero if same as logical birth txg
236 * log. birth transaction group in which the block was logically born
237 * fill count number of non-zero blocks under this bp
238 * checksum[4] 256-bit checksum of the data this bp describes
242 * "Embedded" blkptr_t's don't actually point to a block, instead they
243 * have a data payload embedded in the blkptr_t itself. See the comment
244 * in blkptr.c for more details.
246 * The blkptr_t is laid out as follows:
248 * 64 56 48 40 32 24 16 8 0
249 * +-------+-------+-------+-------+-------+-------+-------+-------+
256 * +-------+-------+-------+-------+-------+-------+-------+-------+
257 * 6 |BDX|lvl| type | etype |E| comp| PSIZE| LSIZE |
258 * +-------+-------+-------+-------+-------+-------+-------+-------+
262 * +-------+-------+-------+-------+-------+-------+-------+-------+
263 * a | logical birth txg |
264 * +-------+-------+-------+-------+-------+-------+-------+-------+
270 * +-------+-------+-------+-------+-------+-------+-------+-------+
274 * payload contains the embedded data
275 * B (byteorder) byteorder (endianness)
276 * D (dedup) padding (set to zero)
277 * X encryption (set to zero; see above)
278 * E (embedded) set to one
279 * lvl indirection level
280 * type DMU object type
281 * etype how to interpret embedded data (BP_EMBEDDED_TYPE_*)
282 * comp compression function of payload
283 * PSIZE size of payload after compression, in bytes
284 * LSIZE logical size of payload, in bytes
285 * note that 25 bits is enough to store the largest
286 * "normal" BP's LSIZE (2^16 * 2^9) in bytes
287 * log. birth transaction group in which the block was logically born
289 * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
290 * bp's they are stored in units of SPA_MINBLOCKSHIFT.
291 * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
292 * The B, D, X, lvl, type, and comp fields are stored the same as with normal
293 * BP's so the BP_SET_* macros can be used with them. etype, PSIZE, LSIZE must
294 * be set with the BPE_SET_* macros. BP_SET_EMBEDDED() should be called before
295 * other macros, as they assert that they are only used on BP's of the correct
299 #define BPE_GET_ETYPE(bp) \
300 (ASSERT(BP_IS_EMBEDDED(bp)), \
301 BF64_GET((bp)->blk_prop, 40, 8))
302 #define BPE_SET_ETYPE(bp, t) do { \
303 ASSERT(BP_IS_EMBEDDED(bp)); \
304 BF64_SET((bp)->blk_prop, 40, 8, t); \
305 _NOTE(CONSTCOND) } while (0)
307 #define BPE_GET_LSIZE(bp) \
308 (ASSERT(BP_IS_EMBEDDED(bp)), \
309 BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
310 #define BPE_SET_LSIZE(bp, x) do { \
311 ASSERT(BP_IS_EMBEDDED(bp)); \
312 BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
313 _NOTE(CONSTCOND) } while (0)
315 #define BPE_GET_PSIZE(bp) \
316 (ASSERT(BP_IS_EMBEDDED(bp)), \
317 BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
318 #define BPE_SET_PSIZE(bp, x) do { \
319 ASSERT(BP_IS_EMBEDDED(bp)); \
320 BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
321 _NOTE(CONSTCOND) } while (0)
323 typedef enum bp_embedded_type {
324 BP_EMBEDDED_TYPE_DATA,
325 BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */
326 NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED
327 } bp_embedded_type_t;
329 #define BPE_NUM_WORDS 14
330 #define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
331 #define BPE_IS_PAYLOADWORD(bp, wp) \
332 ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
334 #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */
335 #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */
338 * A block is a hole when it has either 1) never been written to, or
339 * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
340 * without physically allocating disk space. Holes are represented in the
341 * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
342 * done through the BP_IS_HOLE macro. For holes, the logical size, level,
343 * DMU object type, and birth times are all also stored for holes that
344 * were written to at some point (i.e. were punched after having been filled).
346 typedef struct blkptr {
347 dva_t blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
348 uint64_t blk_prop; /* size, compression, type, etc */
349 uint64_t blk_pad[2]; /* Extra space for the future */
350 uint64_t blk_phys_birth; /* txg when block was allocated */
351 uint64_t blk_birth; /* transaction group at birth */
352 uint64_t blk_fill; /* fill count */
353 zio_cksum_t blk_cksum; /* 256-bit checksum */
357 * Macros to get and set fields in a bp or DVA.
359 #define DVA_GET_ASIZE(dva) \
360 BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
361 #define DVA_SET_ASIZE(dva, x) \
362 BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
363 SPA_MINBLOCKSHIFT, 0, x)
365 #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8)
366 #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x)
368 #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32)
369 #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x)
371 #define DVA_GET_OFFSET(dva) \
372 BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
373 #define DVA_SET_OFFSET(dva, x) \
374 BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
376 #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1)
377 #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x)
379 #define BP_GET_LSIZE(bp) \
380 (BP_IS_EMBEDDED(bp) ? \
381 (BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
382 BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
383 #define BP_SET_LSIZE(bp, x) do { \
384 ASSERT(!BP_IS_EMBEDDED(bp)); \
385 BF64_SET_SB((bp)->blk_prop, \
386 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
387 _NOTE(CONSTCOND) } while (0)
389 #define BP_GET_PSIZE(bp) \
390 (BP_IS_EMBEDDED(bp) ? 0 : \
391 BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1))
392 #define BP_SET_PSIZE(bp, x) do { \
393 ASSERT(!BP_IS_EMBEDDED(bp)); \
394 BF64_SET_SB((bp)->blk_prop, \
395 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
396 _NOTE(CONSTCOND) } while (0)
398 #define BP_GET_COMPRESS(bp) \
399 BF64_GET((bp)->blk_prop, 32, SPA_COMPRESSBITS)
400 #define BP_SET_COMPRESS(bp, x) \
401 BF64_SET((bp)->blk_prop, 32, SPA_COMPRESSBITS, x)
403 #define BP_IS_EMBEDDED(bp) BF64_GET((bp)->blk_prop, 39, 1)
404 #define BP_SET_EMBEDDED(bp, x) BF64_SET((bp)->blk_prop, 39, 1, x)
406 #define BP_GET_CHECKSUM(bp) \
407 (BP_IS_EMBEDDED(bp) ? ZIO_CHECKSUM_OFF : \
408 BF64_GET((bp)->blk_prop, 40, 8))
409 #define BP_SET_CHECKSUM(bp, x) do { \
410 ASSERT(!BP_IS_EMBEDDED(bp)); \
411 BF64_SET((bp)->blk_prop, 40, 8, x); \
412 _NOTE(CONSTCOND) } while (0)
414 #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8)
415 #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x)
417 #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5)
418 #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x)
420 #define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1)
421 #define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x)
423 #define BP_GET_BYTEORDER(bp) BF64_GET((bp)->blk_prop, 63, 1)
424 #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x)
426 #define BP_PHYSICAL_BIRTH(bp) \
427 (BP_IS_EMBEDDED(bp) ? 0 : \
428 (bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
430 #define BP_SET_BIRTH(bp, logical, physical) \
432 ASSERT(!BP_IS_EMBEDDED(bp)); \
433 (bp)->blk_birth = (logical); \
434 (bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
437 #define BP_GET_FILL(bp) (BP_IS_EMBEDDED(bp) ? 1 : (bp)->blk_fill)
439 #define BP_IS_METADATA(bp) \
440 (BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))
442 #define BP_GET_ASIZE(bp) \
443 (BP_IS_EMBEDDED(bp) ? 0 : \
444 DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
445 DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
446 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
448 #define BP_GET_UCSIZE(bp) \
449 (BP_IS_METADATA(bp) ? BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
451 #define BP_GET_NDVAS(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]))
457 #define BP_COUNT_GANG(bp) \
458 (BP_IS_EMBEDDED(bp) ? 0 : \
459 (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
460 DVA_GET_GANG(&(bp)->blk_dva[1]) + \
461 DVA_GET_GANG(&(bp)->blk_dva[2])))
463 #define DVA_EQUAL(dva1, dva2) \
464 ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
465 (dva1)->dva_word[0] == (dva2)->dva_word[0])
467 #define BP_EQUAL(bp1, bp2) \
468 (BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) && \
469 (bp1)->blk_birth == (bp2)->blk_birth && \
470 DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) && \
471 DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) && \
472 DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
474 #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \
475 (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
476 ((zc1).zc_word[1] - (zc2).zc_word[1]) | \
477 ((zc1).zc_word[2] - (zc2).zc_word[2]) | \
478 ((zc1).zc_word[3] - (zc2).zc_word[3])))
480 #define ZIO_CHECKSUM_IS_ZERO(zc) \
481 (0 == ((zc)->zc_word[0] | (zc)->zc_word[1] | \
482 (zc)->zc_word[2] | (zc)->zc_word[3]))
484 #define ZIO_CHECKSUM_BSWAP(zcp) \
486 (zcp)->zc_word[0] = BSWAP_64((zcp)->zc_word[0]); \
487 (zcp)->zc_word[1] = BSWAP_64((zcp)->zc_word[1]); \
488 (zcp)->zc_word[2] = BSWAP_64((zcp)->zc_word[2]); \
489 (zcp)->zc_word[3] = BSWAP_64((zcp)->zc_word[3]); \
493 #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0)
495 #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \
497 (zcp)->zc_word[0] = w0; \
498 (zcp)->zc_word[1] = w1; \
499 (zcp)->zc_word[2] = w2; \
500 (zcp)->zc_word[3] = w3; \
503 #define BP_IDENTITY(bp) (ASSERT(!BP_IS_EMBEDDED(bp)), &(bp)->blk_dva[0])
504 #define BP_IS_GANG(bp) \
505 (BP_IS_EMBEDDED(bp) ? B_FALSE : DVA_GET_GANG(BP_IDENTITY(bp)))
506 #define DVA_IS_EMPTY(dva) ((dva)->dva_word[0] == 0ULL && \
507 (dva)->dva_word[1] == 0ULL)
508 #define BP_IS_HOLE(bp) \
509 (!BP_IS_EMBEDDED(bp) && DVA_IS_EMPTY(BP_IDENTITY(bp)))
511 /* BP_IS_RAIDZ(bp) assumes no block compression */
512 #define BP_IS_RAIDZ(bp) (DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
515 #define BP_ZERO(bp) \
517 (bp)->blk_dva[0].dva_word[0] = 0; \
518 (bp)->blk_dva[0].dva_word[1] = 0; \
519 (bp)->blk_dva[1].dva_word[0] = 0; \
520 (bp)->blk_dva[1].dva_word[1] = 0; \
521 (bp)->blk_dva[2].dva_word[0] = 0; \
522 (bp)->blk_dva[2].dva_word[1] = 0; \
523 (bp)->blk_prop = 0; \
524 (bp)->blk_pad[0] = 0; \
525 (bp)->blk_pad[1] = 0; \
526 (bp)->blk_phys_birth = 0; \
527 (bp)->blk_birth = 0; \
528 (bp)->blk_fill = 0; \
529 ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
532 #if BYTE_ORDER == _BIG_ENDIAN
533 #define ZFS_HOST_BYTEORDER (0ULL)
535 #define ZFS_HOST_BYTEORDER (1ULL)
538 #define BP_SHOULD_BYTESWAP(bp) (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
540 #define BP_SPRINTF_LEN 320
543 * This macro allows code sharing between zfs, libzpool, and mdb.
544 * 'func' is either snprintf() or mdb_snprintf().
545 * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
547 #define SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
549 static const char *copyname[] = \
550 { "zero", "single", "double", "triple" }; \
555 len += func(buf + len, size - len, "<NULL>"); \
556 } else if (BP_IS_HOLE(bp)) { \
557 len += func(buf + len, size - len, \
559 "size=%llxL birth=%lluL", \
560 (u_longlong_t)BP_GET_LEVEL(bp), \
562 (u_longlong_t)BP_GET_LSIZE(bp), \
563 (u_longlong_t)bp->blk_birth); \
564 } else if (BP_IS_EMBEDDED(bp)) { \
565 len = func(buf + len, size - len, \
566 "EMBEDDED [L%llu %s] et=%u %s " \
567 "size=%llxL/%llxP birth=%lluL", \
568 (u_longlong_t)BP_GET_LEVEL(bp), \
570 (int)BPE_GET_ETYPE(bp), \
572 (u_longlong_t)BPE_GET_LSIZE(bp), \
573 (u_longlong_t)BPE_GET_PSIZE(bp), \
574 (u_longlong_t)bp->blk_birth); \
576 for (int d = 0; d < BP_GET_NDVAS(bp); d++) { \
577 const dva_t *dva = &bp->blk_dva[d]; \
578 if (DVA_IS_VALID(dva)) \
580 len += func(buf + len, size - len, \
581 "DVA[%d]=<%llu:%llx:%llx>%c", d, \
582 (u_longlong_t)DVA_GET_VDEV(dva), \
583 (u_longlong_t)DVA_GET_OFFSET(dva), \
584 (u_longlong_t)DVA_GET_ASIZE(dva), \
587 if (BP_IS_GANG(bp) && \
588 DVA_GET_ASIZE(&bp->blk_dva[2]) <= \
589 DVA_GET_ASIZE(&bp->blk_dva[1]) / 2) \
591 len += func(buf + len, size - len, \
592 "[L%llu %s] %s %s %s %s %s %s%c" \
593 "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c" \
594 "cksum=%llx:%llx:%llx:%llx", \
595 (u_longlong_t)BP_GET_LEVEL(bp), \
599 BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE", \
600 BP_IS_GANG(bp) ? "gang" : "contiguous", \
601 BP_GET_DEDUP(bp) ? "dedup" : "unique", \
604 (u_longlong_t)BP_GET_LSIZE(bp), \
605 (u_longlong_t)BP_GET_PSIZE(bp), \
606 (u_longlong_t)bp->blk_birth, \
607 (u_longlong_t)BP_PHYSICAL_BIRTH(bp), \
608 (u_longlong_t)BP_GET_FILL(bp), \
610 (u_longlong_t)bp->blk_cksum.zc_word[0], \
611 (u_longlong_t)bp->blk_cksum.zc_word[1], \
612 (u_longlong_t)bp->blk_cksum.zc_word[2], \
613 (u_longlong_t)bp->blk_cksum.zc_word[3]); \
615 ASSERT(len < size); \
618 #define BP_GET_BUFC_TYPE(bp) \
619 (BP_IS_METADATA(bp) ? ARC_BUFC_METADATA : ARC_BUFC_DATA)
621 typedef enum spa_import_type {
626 /* state manipulation functions */
627 extern int spa_open(const char *pool, spa_t **, void *tag);
628 extern int spa_open_rewind(const char *pool, spa_t **, void *tag,
629 nvlist_t *policy, nvlist_t **config);
630 extern int spa_get_stats(const char *pool, nvlist_t **config, char *altroot,
632 extern int spa_create(const char *pool, nvlist_t *config, nvlist_t *props,
635 extern int spa_import_rootpool(char *devpath, char *devid);
637 extern int spa_import_rootpool(const char *name);
639 extern int spa_import(const char *pool, nvlist_t *config, nvlist_t *props,
641 extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
642 extern int spa_destroy(char *pool);
643 extern int spa_export(char *pool, nvlist_t **oldconfig, boolean_t force,
644 boolean_t hardforce);
645 extern int spa_reset(char *pool);
646 extern void spa_async_request(spa_t *spa, int flag);
647 extern void spa_async_unrequest(spa_t *spa, int flag);
648 extern void spa_async_suspend(spa_t *spa);
649 extern void spa_async_resume(spa_t *spa);
650 extern spa_t *spa_inject_addref(char *pool);
651 extern void spa_inject_delref(spa_t *spa);
652 extern void spa_scan_stat_init(spa_t *spa);
653 extern int spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps);
655 #define SPA_ASYNC_CONFIG_UPDATE 0x01
656 #define SPA_ASYNC_REMOVE 0x02
657 #define SPA_ASYNC_PROBE 0x04
658 #define SPA_ASYNC_RESILVER_DONE 0x08
659 #define SPA_ASYNC_RESILVER 0x10
660 #define SPA_ASYNC_AUTOEXPAND 0x20
661 #define SPA_ASYNC_REMOVE_DONE 0x40
662 #define SPA_ASYNC_REMOVE_STOP 0x80
665 * Controls the behavior of spa_vdev_remove().
667 #define SPA_REMOVE_UNSPARE 0x01
668 #define SPA_REMOVE_DONE 0x02
670 /* device manipulation */
671 extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
672 extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
674 extern int spa_vdev_detach(spa_t *spa, uint64_t guid, uint64_t pguid,
676 extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
677 extern boolean_t spa_vdev_remove_active(spa_t *spa);
678 extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
679 extern int spa_vdev_setfru(spa_t *spa, uint64_t guid, const char *newfru);
680 extern int spa_vdev_split_mirror(spa_t *spa, char *newname, nvlist_t *config,
681 nvlist_t *props, boolean_t exp);
683 /* spare state (which is global across all pools) */
684 extern void spa_spare_add(vdev_t *vd);
685 extern void spa_spare_remove(vdev_t *vd);
686 extern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt);
687 extern void spa_spare_activate(vdev_t *vd);
689 /* L2ARC state (which is global across all pools) */
690 extern void spa_l2cache_add(vdev_t *vd);
691 extern void spa_l2cache_remove(vdev_t *vd);
692 extern boolean_t spa_l2cache_exists(uint64_t guid, uint64_t *pool);
693 extern void spa_l2cache_activate(vdev_t *vd);
694 extern void spa_l2cache_drop(spa_t *spa);
697 extern int spa_scan(spa_t *spa, pool_scan_func_t func);
698 extern int spa_scan_stop(spa_t *spa);
699 extern int spa_scrub_pause_resume(spa_t *spa, pool_scrub_cmd_t flag);
702 extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
703 extern void spa_sync_allpools(void);
705 /* spa namespace global mutex */
706 extern kmutex_t spa_namespace_lock;
709 * SPA configuration functions in spa_config.c
712 #define SPA_CONFIG_UPDATE_POOL 0
713 #define SPA_CONFIG_UPDATE_VDEVS 1
715 extern void spa_config_sync(spa_t *, boolean_t, boolean_t);
716 extern void spa_config_load(void);
717 extern nvlist_t *spa_all_configs(uint64_t *);
718 extern void spa_config_set(spa_t *spa, nvlist_t *config);
719 extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
721 extern void spa_config_update(spa_t *spa, int what);
724 * Miscellaneous SPA routines in spa_misc.c
727 /* Namespace manipulation */
728 extern spa_t *spa_lookup(const char *name);
729 extern spa_t *spa_add(const char *name, nvlist_t *config, const char *altroot);
730 extern void spa_remove(spa_t *spa);
731 extern spa_t *spa_next(spa_t *prev);
733 /* Refcount functions */
734 extern void spa_open_ref(spa_t *spa, void *tag);
735 extern void spa_close(spa_t *spa, void *tag);
736 extern void spa_async_close(spa_t *spa, void *tag);
737 extern boolean_t spa_refcount_zero(spa_t *spa);
739 #define SCL_NONE 0x00
740 #define SCL_CONFIG 0x01
741 #define SCL_STATE 0x02
742 #define SCL_L2ARC 0x04 /* hack until L2ARC 2.0 */
743 #define SCL_ALLOC 0x08
745 #define SCL_FREE 0x20
746 #define SCL_VDEV 0x40
748 #define SCL_ALL ((1 << SCL_LOCKS) - 1)
749 #define SCL_STATE_ALL (SCL_STATE | SCL_L2ARC | SCL_ZIO)
751 /* Pool configuration locks */
752 extern int spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw);
753 extern void spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw);
754 extern void spa_config_exit(spa_t *spa, int locks, void *tag);
755 extern int spa_config_held(spa_t *spa, int locks, krw_t rw);
757 /* Pool vdev add/remove lock */
758 extern uint64_t spa_vdev_enter(spa_t *spa);
759 extern uint64_t spa_vdev_config_enter(spa_t *spa);
760 extern void spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg,
761 int error, char *tag);
762 extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
764 /* Pool vdev state change lock */
765 extern void spa_vdev_state_enter(spa_t *spa, int oplock);
766 extern int spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error);
769 typedef enum spa_log_state {
770 SPA_LOG_UNKNOWN = 0, /* unknown log state */
771 SPA_LOG_MISSING, /* missing log(s) */
772 SPA_LOG_CLEAR, /* clear the log(s) */
773 SPA_LOG_GOOD, /* log(s) are good */
776 extern spa_log_state_t spa_get_log_state(spa_t *spa);
777 extern void spa_set_log_state(spa_t *spa, spa_log_state_t state);
778 extern int spa_offline_log(spa_t *spa);
780 /* Log claim callback */
781 extern void spa_claim_notify(zio_t *zio);
783 /* Accessor functions */
784 extern boolean_t spa_shutting_down(spa_t *spa);
785 extern struct dsl_pool *spa_get_dsl(spa_t *spa);
786 extern boolean_t spa_is_initializing(spa_t *spa);
787 extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
788 extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
789 extern void spa_altroot(spa_t *, char *, size_t);
790 extern int spa_sync_pass(spa_t *spa);
791 extern char *spa_name(spa_t *spa);
792 extern uint64_t spa_guid(spa_t *spa);
793 extern uint64_t spa_load_guid(spa_t *spa);
794 extern uint64_t spa_last_synced_txg(spa_t *spa);
795 extern uint64_t spa_first_txg(spa_t *spa);
796 extern uint64_t spa_syncing_txg(spa_t *spa);
797 extern uint64_t spa_final_dirty_txg(spa_t *spa);
798 extern uint64_t spa_version(spa_t *spa);
799 extern pool_state_t spa_state(spa_t *spa);
800 extern spa_load_state_t spa_load_state(spa_t *spa);
801 extern uint64_t spa_freeze_txg(spa_t *spa);
802 extern uint64_t spa_get_worst_case_asize(spa_t *spa, uint64_t lsize);
803 extern uint64_t spa_get_dspace(spa_t *spa);
804 extern uint64_t spa_get_slop_space(spa_t *spa);
805 extern void spa_update_dspace(spa_t *spa);
806 extern uint64_t spa_version(spa_t *spa);
807 extern boolean_t spa_deflate(spa_t *spa);
808 extern metaslab_class_t *spa_normal_class(spa_t *spa);
809 extern metaslab_class_t *spa_log_class(spa_t *spa);
810 extern void spa_evicting_os_register(spa_t *, objset_t *os);
811 extern void spa_evicting_os_deregister(spa_t *, objset_t *os);
812 extern void spa_evicting_os_wait(spa_t *spa);
813 extern int spa_max_replication(spa_t *spa);
814 extern int spa_prev_software_version(spa_t *spa);
815 extern int spa_busy(void);
816 extern uint8_t spa_get_failmode(spa_t *spa);
817 extern boolean_t spa_suspended(spa_t *spa);
818 extern uint64_t spa_bootfs(spa_t *spa);
819 extern uint64_t spa_delegation(spa_t *spa);
820 extern objset_t *spa_meta_objset(spa_t *spa);
821 extern uint64_t spa_deadman_synctime(spa_t *spa);
823 /* Miscellaneous support routines */
824 extern void spa_activate_mos_feature(spa_t *spa, const char *feature,
826 extern void spa_deactivate_mos_feature(spa_t *spa, const char *feature);
827 extern int spa_rename(const char *oldname, const char *newname);
828 extern spa_t *spa_by_guid(uint64_t pool_guid, uint64_t device_guid);
829 extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
830 extern char *spa_strdup(const char *);
831 extern void spa_strfree(char *);
832 extern uint64_t spa_get_random(uint64_t range);
833 extern uint64_t spa_generate_guid(spa_t *spa);
834 extern void snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp);
835 extern void spa_freeze(spa_t *spa);
836 extern int spa_change_guid(spa_t *spa);
837 extern void spa_upgrade(spa_t *spa, uint64_t version);
838 extern void spa_evict_all(void);
839 extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid,
841 extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
842 extern uint64_t dva_get_dsize_sync(spa_t *spa, const dva_t *dva);
843 extern uint64_t bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp);
844 extern uint64_t bp_get_dsize(spa_t *spa, const blkptr_t *bp);
845 extern boolean_t spa_has_slogs(spa_t *spa);
846 extern boolean_t spa_is_root(spa_t *spa);
847 extern boolean_t spa_writeable(spa_t *spa);
848 extern boolean_t spa_has_pending_synctask(spa_t *spa);
849 extern int spa_maxblocksize(spa_t *spa);
850 extern void zfs_blkptr_verify(spa_t *spa, const blkptr_t *bp);
852 extern int spa_mode(spa_t *spa);
853 extern uint64_t zfs_strtonum(const char *str, char **nptr);
855 extern char *spa_his_ievent_table[];
857 extern void spa_history_create_obj(spa_t *spa, dmu_tx_t *tx);
858 extern int spa_history_get(spa_t *spa, uint64_t *offset, uint64_t *len_read,
860 extern int spa_history_log(spa_t *spa, const char *his_buf);
861 extern int spa_history_log_nvl(spa_t *spa, nvlist_t *nvl);
862 extern void spa_history_log_version(spa_t *spa, const char *operation);
863 extern void spa_history_log_internal(spa_t *spa, const char *operation,
864 dmu_tx_t *tx, const char *fmt, ...);
865 extern void spa_history_log_internal_ds(struct dsl_dataset *ds, const char *op,
866 dmu_tx_t *tx, const char *fmt, ...);
867 extern void spa_history_log_internal_dd(dsl_dir_t *dd, const char *operation,
868 dmu_tx_t *tx, const char *fmt, ...);
871 struct zbookmark_phys;
872 extern void spa_log_error(spa_t *spa, zio_t *zio);
873 extern void zfs_ereport_post(const char *cls, spa_t *spa, vdev_t *vd,
874 zio_t *zio, uint64_t stateoroffset, uint64_t length);
875 extern void zfs_post_remove(spa_t *spa, vdev_t *vd);
876 extern void zfs_post_state_change(spa_t *spa, vdev_t *vd);
877 extern void zfs_post_autoreplace(spa_t *spa, vdev_t *vd);
878 extern uint64_t spa_get_errlog_size(spa_t *spa);
879 extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
880 extern void spa_errlog_rotate(spa_t *spa);
881 extern void spa_errlog_drain(spa_t *spa);
882 extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
883 extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
886 extern void vdev_cache_stat_init(void);
887 extern void vdev_cache_stat_fini(void);
889 /* Initialization and termination */
890 extern void spa_init(int flags);
891 extern void spa_fini(void);
892 extern void spa_boot_init();
895 extern int spa_prop_set(spa_t *spa, nvlist_t *nvp);
896 extern int spa_prop_get(spa_t *spa, nvlist_t **nvp);
897 extern void spa_prop_clear_bootfs(spa_t *spa, uint64_t obj, dmu_tx_t *tx);
898 extern void spa_configfile_set(spa_t *, nvlist_t *, boolean_t);
900 /* asynchronous event notification */
901 extern void spa_event_notify(spa_t *spa, vdev_t *vdev, const char *name);
904 #define dprintf_bp(bp, fmt, ...) do { \
905 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
906 char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP); \
907 snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp)); \
908 dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf); \
909 kmem_free(__blkbuf, BP_SPRINTF_LEN); \
911 _NOTE(CONSTCOND) } while (0)
913 #define dprintf_bp(bp, fmt, ...)
916 extern boolean_t spa_debug_enabled(spa_t *spa);
917 #define spa_dbgmsg(spa, ...) \
919 if (spa_debug_enabled(spa)) \
920 zfs_dbgmsg(__VA_ARGS__); \
923 extern int spa_mode_global; /* mode, e.g. FREAD | FWRITE */
929 #endif /* _SYS_SPA_H */