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, 2014 by Delphix. All rights reserved.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
32 #include <sys/zfs_context.h>
33 #include <sys/kstat.h>
34 #include <sys/nvpair.h>
35 #include <sys/sysmacros.h>
36 #include <sys/types.h>
37 #include <sys/fs/zfs.h>
44 * Forward references that lots of things need.
46 typedef struct spa spa_t
;
47 typedef struct vdev vdev_t
;
48 typedef struct metaslab metaslab_t
;
49 typedef struct metaslab_group metaslab_group_t
;
50 typedef struct metaslab_class metaslab_class_t
;
51 typedef struct zio zio_t
;
52 typedef struct zilog zilog_t
;
53 typedef struct spa_aux_vdev spa_aux_vdev_t
;
54 typedef struct ddt ddt_t
;
55 typedef struct ddt_entry ddt_entry_t
;
56 typedef struct zbookmark_phys zbookmark_phys_t
;
62 * General-purpose 32-bit and 64-bit bitfield encodings.
64 #define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len))
65 #define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len))
66 #define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low))
67 #define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low))
69 #define BF32_GET(x, low, len) BF32_DECODE(x, low, len)
70 #define BF64_GET(x, low, len) BF64_DECODE(x, low, len)
72 #define BF32_SET(x, low, len, val) do { \
73 ASSERT3U(val, <, 1U << (len)); \
74 ASSERT3U(low + len, <=, 32); \
75 (x) ^= BF32_ENCODE((x >> low) ^ (val), low, len); \
76 _NOTE(CONSTCOND) } while (0)
78 #define BF64_SET(x, low, len, val) do { \
79 ASSERT3U(val, <, 1ULL << (len)); \
80 ASSERT3U(low + len, <=, 64); \
81 ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len)); \
82 _NOTE(CONSTCOND) } while (0)
84 #define BF32_GET_SB(x, low, len, shift, bias) \
85 ((BF32_GET(x, low, len) + (bias)) << (shift))
86 #define BF64_GET_SB(x, low, len, shift, bias) \
87 ((BF64_GET(x, low, len) + (bias)) << (shift))
89 #define BF32_SET_SB(x, low, len, shift, bias, val) do { \
90 ASSERT(IS_P2ALIGNED(val, 1U << shift)); \
91 ASSERT3S((val) >> (shift), >=, bias); \
92 BF32_SET(x, low, len, ((val) >> (shift)) - (bias)); \
93 _NOTE(CONSTCOND) } while (0)
94 #define BF64_SET_SB(x, low, len, shift, bias, val) do { \
95 ASSERT(IS_P2ALIGNED(val, 1ULL << shift)); \
96 ASSERT3S((val) >> (shift), >=, bias); \
97 BF64_SET(x, low, len, ((val) >> (shift)) - (bias)); \
98 _NOTE(CONSTCOND) } while (0)
101 * We currently support nine block sizes, from 512 bytes to 128K.
102 * We could go higher, but the benefits are near-zero and the cost
103 * of COWing a giant block to modify one byte would become excessive.
105 #define SPA_MINBLOCKSHIFT 9
106 #define SPA_MAXBLOCKSHIFT 17
107 #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT)
108 #define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT)
110 #define SPA_BLOCKSIZES (SPA_MAXBLOCKSHIFT - SPA_MINBLOCKSHIFT + 1)
113 * Size of block to hold the configuration data (a packed nvlist)
115 #define SPA_CONFIG_BLOCKSIZE (1ULL << 14)
118 * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
119 * The ASIZE encoding should be at least 64 times larger (6 more bits)
120 * to support up to 4-way RAID-Z mirror mode with worst-case gang block
121 * overhead, three DVAs per bp, plus one more bit in case we do anything
122 * else that expands the ASIZE.
124 #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */
125 #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */
126 #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */
129 * All SPA data is represented by 128-bit data virtual addresses (DVAs).
130 * The members of the dva_t should be considered opaque outside the SPA.
133 uint64_t dva_word
[2];
137 * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
139 typedef struct zio_cksum
{
144 * Each block is described by its DVAs, time of birth, checksum, etc.
145 * The word-by-word, bit-by-bit layout of the blkptr is as follows:
147 * 64 56 48 40 32 24 16 8 0
148 * +-------+-------+-------+-------+-------+-------+-------+-------+
149 * 0 | vdev1 | GRID | ASIZE |
150 * +-------+-------+-------+-------+-------+-------+-------+-------+
152 * +-------+-------+-------+-------+-------+-------+-------+-------+
153 * 2 | vdev2 | GRID | ASIZE |
154 * +-------+-------+-------+-------+-------+-------+-------+-------+
156 * +-------+-------+-------+-------+-------+-------+-------+-------+
157 * 4 | vdev3 | GRID | ASIZE |
158 * +-------+-------+-------+-------+-------+-------+-------+-------+
160 * +-------+-------+-------+-------+-------+-------+-------+-------+
161 * 6 |BDX|lvl| type | cksum |E| comp| PSIZE | LSIZE |
162 * +-------+-------+-------+-------+-------+-------+-------+-------+
164 * +-------+-------+-------+-------+-------+-------+-------+-------+
166 * +-------+-------+-------+-------+-------+-------+-------+-------+
167 * 9 | physical birth txg |
168 * +-------+-------+-------+-------+-------+-------+-------+-------+
169 * a | logical birth txg |
170 * +-------+-------+-------+-------+-------+-------+-------+-------+
172 * +-------+-------+-------+-------+-------+-------+-------+-------+
174 * +-------+-------+-------+-------+-------+-------+-------+-------+
176 * +-------+-------+-------+-------+-------+-------+-------+-------+
178 * +-------+-------+-------+-------+-------+-------+-------+-------+
180 * +-------+-------+-------+-------+-------+-------+-------+-------+
184 * vdev virtual device ID
185 * offset offset into virtual device
187 * PSIZE physical size (after compression)
188 * ASIZE allocated size (including RAID-Z parity and gang block headers)
189 * GRID RAID-Z layout information (reserved for future use)
190 * cksum checksum function
191 * comp compression function
192 * G gang block indicator
193 * B byteorder (endianness)
195 * X encryption (on version 30, which is not supported)
196 * E blkptr_t contains embedded data (see below)
197 * lvl level of indirection
198 * type DMU object type
199 * phys birth txg of block allocation; zero if same as logical birth txg
200 * log. birth transaction group in which the block was logically born
201 * fill count number of non-zero blocks under this bp
202 * checksum[4] 256-bit checksum of the data this bp describes
206 * "Embedded" blkptr_t's don't actually point to a block, instead they
207 * have a data payload embedded in the blkptr_t itself. See the comment
208 * in blkptr.c for more details.
210 * The blkptr_t is laid out as follows:
212 * 64 56 48 40 32 24 16 8 0
213 * +-------+-------+-------+-------+-------+-------+-------+-------+
220 * +-------+-------+-------+-------+-------+-------+-------+-------+
221 * 6 |BDX|lvl| type | etype |E| comp| PSIZE| LSIZE |
222 * +-------+-------+-------+-------+-------+-------+-------+-------+
226 * +-------+-------+-------+-------+-------+-------+-------+-------+
227 * a | logical birth txg |
228 * +-------+-------+-------+-------+-------+-------+-------+-------+
234 * +-------+-------+-------+-------+-------+-------+-------+-------+
238 * payload contains the embedded data
239 * B (byteorder) byteorder (endianness)
240 * D (dedup) padding (set to zero)
241 * X encryption (set to zero; see above)
242 * E (embedded) set to one
243 * lvl indirection level
244 * type DMU object type
245 * etype how to interpret embedded data (BP_EMBEDDED_TYPE_*)
246 * comp compression function of payload
247 * PSIZE size of payload after compression, in bytes
248 * LSIZE logical size of payload, in bytes
249 * note that 25 bits is enough to store the largest
250 * "normal" BP's LSIZE (2^16 * 2^9) in bytes
251 * log. birth transaction group in which the block was logically born
253 * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
254 * bp's they are stored in units of SPA_MINBLOCKSHIFT.
255 * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
256 * The B, D, X, lvl, type, and comp fields are stored the same as with normal
257 * BP's so the BP_SET_* macros can be used with them. etype, PSIZE, LSIZE must
258 * be set with the BPE_SET_* macros. BP_SET_EMBEDDED() should be called before
259 * other macros, as they assert that they are only used on BP's of the correct
263 #define BPE_GET_ETYPE(bp) \
264 (ASSERT(BP_IS_EMBEDDED(bp)), \
265 BF64_GET((bp)->blk_prop, 40, 8))
266 #define BPE_SET_ETYPE(bp, t) do { \
267 ASSERT(BP_IS_EMBEDDED(bp)); \
268 BF64_SET((bp)->blk_prop, 40, 8, t); \
269 _NOTE(CONSTCOND) } while (0)
271 #define BPE_GET_LSIZE(bp) \
272 (ASSERT(BP_IS_EMBEDDED(bp)), \
273 BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
274 #define BPE_SET_LSIZE(bp, x) do { \
275 ASSERT(BP_IS_EMBEDDED(bp)); \
276 BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
277 _NOTE(CONSTCOND) } while (0)
279 #define BPE_GET_PSIZE(bp) \
280 (ASSERT(BP_IS_EMBEDDED(bp)), \
281 BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
282 #define BPE_SET_PSIZE(bp, x) do { \
283 ASSERT(BP_IS_EMBEDDED(bp)); \
284 BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
285 _NOTE(CONSTCOND) } while (0)
287 typedef enum bp_embedded_type
{
288 BP_EMBEDDED_TYPE_DATA
,
289 BP_EMBEDDED_TYPE_RESERVED
, /* Reserved for an unintegrated feature. */
290 NUM_BP_EMBEDDED_TYPES
= BP_EMBEDDED_TYPE_RESERVED
291 } bp_embedded_type_t
;
293 #define BPE_NUM_WORDS 14
294 #define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
295 #define BPE_IS_PAYLOADWORD(bp, wp) \
296 ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
298 #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */
299 #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */
302 * A block is a hole when it has either 1) never been written to, or
303 * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
304 * without physically allocating disk space. Holes are represented in the
305 * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
306 * done through the BP_IS_HOLE macro. For holes, the logical size, level,
307 * DMU object type, and birth times are all also stored for holes that
308 * were written to at some point (i.e. were punched after having been filled).
310 typedef struct blkptr
{
311 dva_t blk_dva
[SPA_DVAS_PER_BP
]; /* Data Virtual Addresses */
312 uint64_t blk_prop
; /* size, compression, type, etc */
313 uint64_t blk_pad
[2]; /* Extra space for the future */
314 uint64_t blk_phys_birth
; /* txg when block was allocated */
315 uint64_t blk_birth
; /* transaction group at birth */
316 uint64_t blk_fill
; /* fill count */
317 zio_cksum_t blk_cksum
; /* 256-bit checksum */
321 * Macros to get and set fields in a bp or DVA.
323 #define DVA_GET_ASIZE(dva) \
324 BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
325 #define DVA_SET_ASIZE(dva, x) \
326 BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
327 SPA_MINBLOCKSHIFT, 0, x)
329 #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8)
330 #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x)
332 #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32)
333 #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x)
335 #define DVA_GET_OFFSET(dva) \
336 BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
337 #define DVA_SET_OFFSET(dva, x) \
338 BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
340 #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1)
341 #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x)
343 #define BP_GET_LSIZE(bp) \
344 (BP_IS_EMBEDDED(bp) ? \
345 (BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
346 BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
347 #define BP_SET_LSIZE(bp, x) do { \
348 ASSERT(!BP_IS_EMBEDDED(bp)); \
349 BF64_SET_SB((bp)->blk_prop, \
350 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
351 _NOTE(CONSTCOND) } while (0)
353 #define BP_GET_PSIZE(bp) \
354 (BP_IS_EMBEDDED(bp) ? 0 : \
355 BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1))
356 #define BP_SET_PSIZE(bp, x) do { \
357 ASSERT(!BP_IS_EMBEDDED(bp)); \
358 BF64_SET_SB((bp)->blk_prop, \
359 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
360 _NOTE(CONSTCOND) } while (0)
362 #define BP_GET_COMPRESS(bp) BF64_GET((bp)->blk_prop, 32, 7)
363 #define BP_SET_COMPRESS(bp, x) BF64_SET((bp)->blk_prop, 32, 7, x)
365 #define BP_IS_EMBEDDED(bp) BF64_GET((bp)->blk_prop, 39, 1)
366 #define BP_SET_EMBEDDED(bp, x) BF64_SET((bp)->blk_prop, 39, 1, x)
368 #define BP_GET_CHECKSUM(bp) \
369 (BP_IS_EMBEDDED(bp) ? ZIO_CHECKSUM_OFF : \
370 BF64_GET((bp)->blk_prop, 40, 8))
371 #define BP_SET_CHECKSUM(bp, x) do { \
372 ASSERT(!BP_IS_EMBEDDED(bp)); \
373 BF64_SET((bp)->blk_prop, 40, 8, x); \
374 _NOTE(CONSTCOND) } while (0)
376 #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8)
377 #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x)
379 #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5)
380 #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x)
382 #define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1)
383 #define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x)
385 #define BP_GET_BYTEORDER(bp) BF64_GET((bp)->blk_prop, 63, 1)
386 #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x)
388 #define BP_PHYSICAL_BIRTH(bp) \
389 (BP_IS_EMBEDDED(bp) ? 0 : \
390 (bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
392 #define BP_SET_BIRTH(bp, logical, physical) \
394 ASSERT(!BP_IS_EMBEDDED(bp)); \
395 (bp)->blk_birth = (logical); \
396 (bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
399 #define BP_GET_FILL(bp) (BP_IS_EMBEDDED(bp) ? 1 : (bp)->blk_fill)
401 #define BP_GET_ASIZE(bp) \
402 (BP_IS_EMBEDDED(bp) ? 0 : \
403 DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
404 DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
405 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
407 #define BP_GET_UCSIZE(bp) \
408 ((BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp))) ? \
409 BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
411 #define BP_GET_NDVAS(bp) \
412 (BP_IS_EMBEDDED(bp) ? 0 : \
413 !!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
414 !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
415 !!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
417 #define BP_COUNT_GANG(bp) \
418 (BP_IS_EMBEDDED(bp) ? 0 : \
419 (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
420 DVA_GET_GANG(&(bp)->blk_dva[1]) + \
421 DVA_GET_GANG(&(bp)->blk_dva[2])))
423 #define DVA_EQUAL(dva1, dva2) \
424 ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
425 (dva1)->dva_word[0] == (dva2)->dva_word[0])
427 #define BP_EQUAL(bp1, bp2) \
428 (BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) && \
429 (bp1)->blk_birth == (bp2)->blk_birth && \
430 DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) && \
431 DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) && \
432 DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
434 #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \
435 (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
436 ((zc1).zc_word[1] - (zc2).zc_word[1]) | \
437 ((zc1).zc_word[2] - (zc2).zc_word[2]) | \
438 ((zc1).zc_word[3] - (zc2).zc_word[3])))
440 #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0)
442 #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \
444 (zcp)->zc_word[0] = w0; \
445 (zcp)->zc_word[1] = w1; \
446 (zcp)->zc_word[2] = w2; \
447 (zcp)->zc_word[3] = w3; \
450 #define BP_IDENTITY(bp) (ASSERT(!BP_IS_EMBEDDED(bp)), &(bp)->blk_dva[0])
451 #define BP_IS_GANG(bp) \
452 (BP_IS_EMBEDDED(bp) ? B_FALSE : DVA_GET_GANG(BP_IDENTITY(bp)))
453 #define DVA_IS_EMPTY(dva) ((dva)->dva_word[0] == 0ULL && \
454 (dva)->dva_word[1] == 0ULL)
455 #define BP_IS_HOLE(bp) \
456 (!BP_IS_EMBEDDED(bp) && DVA_IS_EMPTY(BP_IDENTITY(bp)))
458 /* BP_IS_RAIDZ(bp) assumes no block compression */
459 #define BP_IS_RAIDZ(bp) (DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
462 #define BP_ZERO(bp) \
464 (bp)->blk_dva[0].dva_word[0] = 0; \
465 (bp)->blk_dva[0].dva_word[1] = 0; \
466 (bp)->blk_dva[1].dva_word[0] = 0; \
467 (bp)->blk_dva[1].dva_word[1] = 0; \
468 (bp)->blk_dva[2].dva_word[0] = 0; \
469 (bp)->blk_dva[2].dva_word[1] = 0; \
470 (bp)->blk_prop = 0; \
471 (bp)->blk_pad[0] = 0; \
472 (bp)->blk_pad[1] = 0; \
473 (bp)->blk_phys_birth = 0; \
474 (bp)->blk_birth = 0; \
475 (bp)->blk_fill = 0; \
476 ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
480 #define ZFS_HOST_BYTEORDER (0ULL)
482 #define ZFS_HOST_BYTEORDER (1ULL)
485 #define BP_SHOULD_BYTESWAP(bp) (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
487 #define BP_SPRINTF_LEN 320
490 * This macro allows code sharing between zfs, libzpool, and mdb.
491 * 'func' is either snprintf() or mdb_snprintf().
492 * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
494 #define SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
496 static const char *copyname[] = \
497 { "zero", "single", "double", "triple" }; \
503 len += func(buf + len, size - len, "<NULL>"); \
504 } else if (BP_IS_HOLE(bp)) { \
505 len += func(buf + len, size - len, \
507 "size=%llxL birth=%lluL", \
508 (u_longlong_t)BP_GET_LEVEL(bp), \
510 (u_longlong_t)BP_GET_LSIZE(bp), \
511 (u_longlong_t)bp->blk_birth); \
512 } else if (BP_IS_EMBEDDED(bp)) { \
513 len = func(buf + len, size - len, \
514 "EMBEDDED [L%llu %s] et=%u %s " \
515 "size=%llxL/%llxP birth=%lluL", \
516 (u_longlong_t)BP_GET_LEVEL(bp), \
518 (int)BPE_GET_ETYPE(bp), \
520 (u_longlong_t)BPE_GET_LSIZE(bp), \
521 (u_longlong_t)BPE_GET_PSIZE(bp), \
522 (u_longlong_t)bp->blk_birth); \
524 for (d = 0; d < BP_GET_NDVAS(bp); d++) { \
525 const dva_t *dva = &bp->blk_dva[d]; \
526 if (DVA_IS_VALID(dva)) \
528 len += func(buf + len, size - len, \
529 "DVA[%d]=<%llu:%llx:%llx>%c", d, \
530 (u_longlong_t)DVA_GET_VDEV(dva), \
531 (u_longlong_t)DVA_GET_OFFSET(dva), \
532 (u_longlong_t)DVA_GET_ASIZE(dva), \
535 if (BP_IS_GANG(bp) && \
536 DVA_GET_ASIZE(&bp->blk_dva[2]) <= \
537 DVA_GET_ASIZE(&bp->blk_dva[1]) / 2) \
539 len += func(buf + len, size - len, \
540 "[L%llu %s] %s %s %s %s %s %s%c" \
541 "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c" \
542 "cksum=%llx:%llx:%llx:%llx", \
543 (u_longlong_t)BP_GET_LEVEL(bp), \
547 BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE", \
548 BP_IS_GANG(bp) ? "gang" : "contiguous", \
549 BP_GET_DEDUP(bp) ? "dedup" : "unique", \
552 (u_longlong_t)BP_GET_LSIZE(bp), \
553 (u_longlong_t)BP_GET_PSIZE(bp), \
554 (u_longlong_t)bp->blk_birth, \
555 (u_longlong_t)BP_PHYSICAL_BIRTH(bp), \
556 (u_longlong_t)BP_GET_FILL(bp), \
558 (u_longlong_t)bp->blk_cksum.zc_word[0], \
559 (u_longlong_t)bp->blk_cksum.zc_word[1], \
560 (u_longlong_t)bp->blk_cksum.zc_word[2], \
561 (u_longlong_t)bp->blk_cksum.zc_word[3]); \
563 ASSERT(len < size); \
568 #define BP_GET_BUFC_TYPE(bp) \
569 (((BP_GET_LEVEL(bp) > 0) || (DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))) ? \
570 ARC_BUFC_METADATA : ARC_BUFC_DATA)
572 typedef enum spa_import_type
{
577 /* state manipulation functions */
578 extern int spa_open(const char *pool
, spa_t
**, void *tag
);
579 extern int spa_open_rewind(const char *pool
, spa_t
**, void *tag
,
580 nvlist_t
*policy
, nvlist_t
**config
);
581 extern int spa_get_stats(const char *pool
, nvlist_t
**config
, char *altroot
,
583 extern int spa_create(const char *pool
, nvlist_t
*config
, nvlist_t
*props
,
585 extern int spa_import_rootpool(char *devpath
, char *devid
);
586 extern int spa_import(char *pool
, nvlist_t
*config
, nvlist_t
*props
,
588 extern nvlist_t
*spa_tryimport(nvlist_t
*tryconfig
);
589 extern int spa_destroy(char *pool
);
590 extern int spa_export(char *pool
, nvlist_t
**oldconfig
, boolean_t force
,
591 boolean_t hardforce
);
592 extern int spa_reset(char *pool
);
593 extern void spa_async_request(spa_t
*spa
, int flag
);
594 extern void spa_async_unrequest(spa_t
*spa
, int flag
);
595 extern void spa_async_suspend(spa_t
*spa
);
596 extern void spa_async_resume(spa_t
*spa
);
597 extern spa_t
*spa_inject_addref(char *pool
);
598 extern void spa_inject_delref(spa_t
*spa
);
599 extern void spa_scan_stat_init(spa_t
*spa
);
600 extern int spa_scan_get_stats(spa_t
*spa
, pool_scan_stat_t
*ps
);
602 #define SPA_ASYNC_CONFIG_UPDATE 0x01
603 #define SPA_ASYNC_REMOVE 0x02
604 #define SPA_ASYNC_PROBE 0x04
605 #define SPA_ASYNC_RESILVER_DONE 0x08
606 #define SPA_ASYNC_RESILVER 0x10
607 #define SPA_ASYNC_AUTOEXPAND 0x20
608 #define SPA_ASYNC_REMOVE_DONE 0x40
609 #define SPA_ASYNC_REMOVE_STOP 0x80
612 * Controls the behavior of spa_vdev_remove().
614 #define SPA_REMOVE_UNSPARE 0x01
615 #define SPA_REMOVE_DONE 0x02
617 /* device manipulation */
618 extern int spa_vdev_add(spa_t
*spa
, nvlist_t
*nvroot
);
619 extern int spa_vdev_attach(spa_t
*spa
, uint64_t guid
, nvlist_t
*nvroot
,
621 extern int spa_vdev_detach(spa_t
*spa
, uint64_t guid
, uint64_t pguid
,
623 extern int spa_vdev_remove(spa_t
*spa
, uint64_t guid
, boolean_t unspare
);
624 extern boolean_t
spa_vdev_remove_active(spa_t
*spa
);
625 extern int spa_vdev_setpath(spa_t
*spa
, uint64_t guid
, const char *newpath
);
626 extern int spa_vdev_setfru(spa_t
*spa
, uint64_t guid
, const char *newfru
);
627 extern int spa_vdev_split_mirror(spa_t
*spa
, char *newname
, nvlist_t
*config
,
628 nvlist_t
*props
, boolean_t exp
);
630 /* spare state (which is global across all pools) */
631 extern void spa_spare_add(vdev_t
*vd
);
632 extern void spa_spare_remove(vdev_t
*vd
);
633 extern boolean_t
spa_spare_exists(uint64_t guid
, uint64_t *pool
, int *refcnt
);
634 extern void spa_spare_activate(vdev_t
*vd
);
636 /* L2ARC state (which is global across all pools) */
637 extern void spa_l2cache_add(vdev_t
*vd
);
638 extern void spa_l2cache_remove(vdev_t
*vd
);
639 extern boolean_t
spa_l2cache_exists(uint64_t guid
, uint64_t *pool
);
640 extern void spa_l2cache_activate(vdev_t
*vd
);
641 extern void spa_l2cache_drop(spa_t
*spa
);
644 extern int spa_scan(spa_t
*spa
, pool_scan_func_t func
);
645 extern int spa_scan_stop(spa_t
*spa
);
648 extern void spa_sync(spa_t
*spa
, uint64_t txg
); /* only for DMU use */
649 extern void spa_sync_allpools(void);
651 extern int zfs_sync_pass_deferred_free
;
653 /* spa namespace global mutex */
654 extern kmutex_t spa_namespace_lock
;
657 * SPA configuration functions in spa_config.c
660 #define SPA_CONFIG_UPDATE_POOL 0
661 #define SPA_CONFIG_UPDATE_VDEVS 1
663 extern void spa_config_sync(spa_t
*, boolean_t
, boolean_t
);
664 extern void spa_config_load(void);
665 extern nvlist_t
*spa_all_configs(uint64_t *);
666 extern void spa_config_set(spa_t
*spa
, nvlist_t
*config
);
667 extern nvlist_t
*spa_config_generate(spa_t
*spa
, vdev_t
*vd
, uint64_t txg
,
669 extern void spa_config_update(spa_t
*spa
, int what
);
672 * Miscellaneous SPA routines in spa_misc.c
675 /* Namespace manipulation */
676 extern spa_t
*spa_lookup(const char *name
);
677 extern spa_t
*spa_add(const char *name
, nvlist_t
*config
, const char *altroot
);
678 extern void spa_remove(spa_t
*spa
);
679 extern spa_t
*spa_next(spa_t
*prev
);
681 /* Refcount functions */
682 extern void spa_open_ref(spa_t
*spa
, void *tag
);
683 extern void spa_close(spa_t
*spa
, void *tag
);
684 extern void spa_async_close(spa_t
*spa
, void *tag
);
685 extern boolean_t
spa_refcount_zero(spa_t
*spa
);
687 #define SCL_NONE 0x00
688 #define SCL_CONFIG 0x01
689 #define SCL_STATE 0x02
690 #define SCL_L2ARC 0x04 /* hack until L2ARC 2.0 */
691 #define SCL_ALLOC 0x08
693 #define SCL_FREE 0x20
694 #define SCL_VDEV 0x40
696 #define SCL_ALL ((1 << SCL_LOCKS) - 1)
697 #define SCL_STATE_ALL (SCL_STATE | SCL_L2ARC | SCL_ZIO)
699 /* Historical pool statistics */
700 typedef struct spa_stats_history
{
707 } spa_stats_history_t
;
709 typedef struct spa_stats
{
710 spa_stats_history_t read_history
;
711 spa_stats_history_t txg_history
;
712 spa_stats_history_t tx_assign_histogram
;
713 spa_stats_history_t io_history
;
716 typedef enum txg_state
{
719 TXG_STATE_QUIESCED
= 2,
720 TXG_STATE_WAIT_FOR_SYNC
= 3,
721 TXG_STATE_SYNCED
= 4,
722 TXG_STATE_COMMITTED
= 5,
725 extern void spa_stats_init(spa_t
*spa
);
726 extern void spa_stats_destroy(spa_t
*spa
);
727 extern void spa_read_history_add(spa_t
*spa
, const zbookmark_phys_t
*zb
,
729 extern void spa_txg_history_add(spa_t
*spa
, uint64_t txg
, hrtime_t birth_time
);
730 extern int spa_txg_history_set(spa_t
*spa
, uint64_t txg
,
731 txg_state_t completed_state
, hrtime_t completed_time
);
732 extern int spa_txg_history_set_io(spa_t
*spa
, uint64_t txg
, uint64_t nread
,
733 uint64_t nwritten
, uint64_t reads
, uint64_t writes
, uint64_t ndirty
);
734 extern void spa_tx_assign_add_nsecs(spa_t
*spa
, uint64_t nsecs
);
736 /* Pool configuration locks */
737 extern int spa_config_tryenter(spa_t
*spa
, int locks
, void *tag
, krw_t rw
);
738 extern void spa_config_enter(spa_t
*spa
, int locks
, void *tag
, krw_t rw
);
739 extern void spa_config_exit(spa_t
*spa
, int locks
, void *tag
);
740 extern int spa_config_held(spa_t
*spa
, int locks
, krw_t rw
);
742 /* Pool vdev add/remove lock */
743 extern uint64_t spa_vdev_enter(spa_t
*spa
);
744 extern uint64_t spa_vdev_config_enter(spa_t
*spa
);
745 extern void spa_vdev_config_exit(spa_t
*spa
, vdev_t
*vd
, uint64_t txg
,
746 int error
, char *tag
);
747 extern int spa_vdev_exit(spa_t
*spa
, vdev_t
*vd
, uint64_t txg
, int error
);
749 /* Pool vdev state change lock */
750 extern void spa_vdev_state_enter(spa_t
*spa
, int oplock
);
751 extern int spa_vdev_state_exit(spa_t
*spa
, vdev_t
*vd
, int error
);
754 typedef enum spa_log_state
{
755 SPA_LOG_UNKNOWN
= 0, /* unknown log state */
756 SPA_LOG_MISSING
, /* missing log(s) */
757 SPA_LOG_CLEAR
, /* clear the log(s) */
758 SPA_LOG_GOOD
, /* log(s) are good */
761 extern spa_log_state_t
spa_get_log_state(spa_t
*spa
);
762 extern void spa_set_log_state(spa_t
*spa
, spa_log_state_t state
);
763 extern int spa_offline_log(spa_t
*spa
);
765 /* Log claim callback */
766 extern void spa_claim_notify(zio_t
*zio
);
767 extern void spa_deadman(void *);
769 /* Accessor functions */
770 extern boolean_t
spa_shutting_down(spa_t
*spa
);
771 extern struct dsl_pool
*spa_get_dsl(spa_t
*spa
);
772 extern boolean_t
spa_is_initializing(spa_t
*spa
);
773 extern blkptr_t
*spa_get_rootblkptr(spa_t
*spa
);
774 extern void spa_set_rootblkptr(spa_t
*spa
, const blkptr_t
*bp
);
775 extern void spa_altroot(spa_t
*, char *, size_t);
776 extern int spa_sync_pass(spa_t
*spa
);
777 extern char *spa_name(spa_t
*spa
);
778 extern uint64_t spa_guid(spa_t
*spa
);
779 extern uint64_t spa_load_guid(spa_t
*spa
);
780 extern uint64_t spa_last_synced_txg(spa_t
*spa
);
781 extern uint64_t spa_first_txg(spa_t
*spa
);
782 extern uint64_t spa_syncing_txg(spa_t
*spa
);
783 extern uint64_t spa_version(spa_t
*spa
);
784 extern pool_state_t
spa_state(spa_t
*spa
);
785 extern spa_load_state_t
spa_load_state(spa_t
*spa
);
786 extern uint64_t spa_freeze_txg(spa_t
*spa
);
787 extern uint64_t spa_get_asize(spa_t
*spa
, uint64_t lsize
);
788 extern uint64_t spa_get_dspace(spa_t
*spa
);
789 extern void spa_update_dspace(spa_t
*spa
);
790 extern uint64_t spa_version(spa_t
*spa
);
791 extern boolean_t
spa_deflate(spa_t
*spa
);
792 extern metaslab_class_t
*spa_normal_class(spa_t
*spa
);
793 extern metaslab_class_t
*spa_log_class(spa_t
*spa
);
794 extern void spa_evicting_os_register(spa_t
*, objset_t
*os
);
795 extern void spa_evicting_os_deregister(spa_t
*, objset_t
*os
);
796 extern void spa_evicting_os_wait(spa_t
*spa
);
797 extern int spa_max_replication(spa_t
*spa
);
798 extern int spa_prev_software_version(spa_t
*spa
);
799 extern uint8_t spa_get_failmode(spa_t
*spa
);
800 extern boolean_t
spa_suspended(spa_t
*spa
);
801 extern uint64_t spa_bootfs(spa_t
*spa
);
802 extern uint64_t spa_delegation(spa_t
*spa
);
803 extern objset_t
*spa_meta_objset(spa_t
*spa
);
804 extern uint64_t spa_deadman_synctime(spa_t
*spa
);
806 /* Miscellaneous support routines */
807 extern void spa_activate_mos_feature(spa_t
*spa
, const char *feature
,
809 extern void spa_deactivate_mos_feature(spa_t
*spa
, const char *feature
);
810 extern int spa_rename(const char *oldname
, const char *newname
);
811 extern spa_t
*spa_by_guid(uint64_t pool_guid
, uint64_t device_guid
);
812 extern boolean_t
spa_guid_exists(uint64_t pool_guid
, uint64_t device_guid
);
813 extern char *spa_strdup(const char *);
814 extern void spa_strfree(char *);
815 extern uint64_t spa_get_random(uint64_t range
);
816 extern uint64_t spa_generate_guid(spa_t
*spa
);
817 extern void snprintf_blkptr(char *buf
, size_t buflen
, const blkptr_t
*bp
);
818 extern void spa_freeze(spa_t
*spa
);
819 extern int spa_change_guid(spa_t
*spa
);
820 extern void spa_upgrade(spa_t
*spa
, uint64_t version
);
821 extern void spa_evict_all(void);
822 extern vdev_t
*spa_lookup_by_guid(spa_t
*spa
, uint64_t guid
,
824 extern boolean_t
spa_has_spare(spa_t
*, uint64_t guid
);
825 extern uint64_t dva_get_dsize_sync(spa_t
*spa
, const dva_t
*dva
);
826 extern uint64_t bp_get_dsize_sync(spa_t
*spa
, const blkptr_t
*bp
);
827 extern uint64_t bp_get_dsize(spa_t
*spa
, const blkptr_t
*bp
);
828 extern boolean_t
spa_has_slogs(spa_t
*spa
);
829 extern boolean_t
spa_is_root(spa_t
*spa
);
830 extern boolean_t
spa_writeable(spa_t
*spa
);
831 extern boolean_t
spa_has_pending_synctask(spa_t
*spa
);
833 extern int spa_mode(spa_t
*spa
);
834 extern uint64_t strtonum(const char *str
, char **nptr
);
836 extern char *spa_his_ievent_table
[];
838 extern void spa_history_create_obj(spa_t
*spa
, dmu_tx_t
*tx
);
839 extern int spa_history_get(spa_t
*spa
, uint64_t *offset
, uint64_t *len_read
,
841 extern int spa_history_log(spa_t
*spa
, const char *his_buf
);
842 extern int spa_history_log_nvl(spa_t
*spa
, nvlist_t
*nvl
);
843 extern void spa_history_log_version(spa_t
*spa
, const char *operation
);
844 extern void spa_history_log_internal(spa_t
*spa
, const char *operation
,
845 dmu_tx_t
*tx
, const char *fmt
, ...);
846 extern void spa_history_log_internal_ds(struct dsl_dataset
*ds
, const char *op
,
847 dmu_tx_t
*tx
, const char *fmt
, ...);
848 extern void spa_history_log_internal_dd(dsl_dir_t
*dd
, const char *operation
,
849 dmu_tx_t
*tx
, const char *fmt
, ...);
852 struct zbookmark_phys
;
853 extern void spa_log_error(spa_t
*spa
, zio_t
*zio
);
854 extern void zfs_ereport_post(const char *class, spa_t
*spa
, vdev_t
*vd
,
855 zio_t
*zio
, uint64_t stateoroffset
, uint64_t length
);
856 extern void zfs_post_remove(spa_t
*spa
, vdev_t
*vd
);
857 extern void zfs_post_state_change(spa_t
*spa
, vdev_t
*vd
);
858 extern void zfs_post_autoreplace(spa_t
*spa
, vdev_t
*vd
);
859 extern uint64_t spa_get_errlog_size(spa_t
*spa
);
860 extern int spa_get_errlog(spa_t
*spa
, void *uaddr
, size_t *count
);
861 extern void spa_errlog_rotate(spa_t
*spa
);
862 extern void spa_errlog_drain(spa_t
*spa
);
863 extern void spa_errlog_sync(spa_t
*spa
, uint64_t txg
);
864 extern void spa_get_errlists(spa_t
*spa
, avl_tree_t
*last
, avl_tree_t
*scrub
);
867 extern void vdev_cache_stat_init(void);
868 extern void vdev_cache_stat_fini(void);
870 /* Initialization and termination */
871 extern void spa_init(int flags
);
872 extern void spa_fini(void);
873 extern void spa_boot_init(void);
876 extern int spa_prop_set(spa_t
*spa
, nvlist_t
*nvp
);
877 extern int spa_prop_get(spa_t
*spa
, nvlist_t
**nvp
);
878 extern void spa_prop_clear_bootfs(spa_t
*spa
, uint64_t obj
, dmu_tx_t
*tx
);
879 extern void spa_configfile_set(spa_t
*, nvlist_t
*, boolean_t
);
881 /* asynchronous event notification */
882 extern void spa_event_notify(spa_t
*spa
, vdev_t
*vdev
, const char *name
);
885 #define dprintf_bp(bp, fmt, ...) do { \
886 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
887 char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP); \
888 snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp)); \
889 dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf); \
890 kmem_free(__blkbuf, BP_SPRINTF_LEN); \
892 _NOTE(CONSTCOND) } while (0)
894 #define dprintf_bp(bp, fmt, ...)
897 extern boolean_t
spa_debug_enabled(spa_t
*spa
);
898 #define spa_dbgmsg(spa, ...) \
900 if (spa_debug_enabled(spa)) \
901 zfs_dbgmsg(__VA_ARGS__); \
904 extern int spa_mode_global
; /* mode, e.g. FREAD | FWRITE */
910 #endif /* _SYS_SPA_H */