Multipath autoreplace, control enclosure LEDs, event rate limiting
[zfs.git] / include / sys / spa.h
blob3d0b962e68895379b4867bcbb4e249a06b1ec49b
1 /*
2 * CDDL HEADER START
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]
19 * CDDL HEADER END
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.
26 * Copyright 2013 Saso Kiselkov. All rights reserved.
29 #ifndef _SYS_SPA_H
30 #define _SYS_SPA_H
32 #include <sys/avl.h>
33 #include <sys/zfs_context.h>
34 #include <sys/kstat.h>
35 #include <sys/nvpair.h>
36 #include <sys/sysmacros.h>
37 #include <sys/types.h>
38 #include <sys/fs/zfs.h>
39 #include <sys/spa_checksum.h>
40 #include <sys/dmu.h>
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
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;
59 typedef struct zbookmark_phys zbookmark_phys_t;
61 struct dsl_pool;
62 struct dsl_dataset;
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 * Size of block to hold the configuration data (a packed nvlist)
127 #define SPA_CONFIG_BLOCKSIZE (1ULL << 14)
130 * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
131 * The ASIZE encoding should be at least 64 times larger (6 more bits)
132 * to support up to 4-way RAID-Z mirror mode with worst-case gang block
133 * overhead, three DVAs per bp, plus one more bit in case we do anything
134 * else that expands the ASIZE.
136 #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */
137 #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */
138 #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */
140 #define SPA_COMPRESSBITS 7
143 * All SPA data is represented by 128-bit data virtual addresses (DVAs).
144 * The members of the dva_t should be considered opaque outside the SPA.
146 typedef struct dva {
147 uint64_t dva_word[2];
148 } dva_t;
152 * Some checksums/hashes need a 256-bit initialization salt. This salt is kept
153 * secret and is suitable for use in MAC algorithms as the key.
155 typedef struct zio_cksum_salt {
156 uint8_t zcs_bytes[32];
157 } zio_cksum_salt_t;
160 * Each block is described by its DVAs, time of birth, checksum, etc.
161 * The word-by-word, bit-by-bit layout of the blkptr is as follows:
163 * 64 56 48 40 32 24 16 8 0
164 * +-------+-------+-------+-------+-------+-------+-------+-------+
165 * 0 | vdev1 | GRID | ASIZE |
166 * +-------+-------+-------+-------+-------+-------+-------+-------+
167 * 1 |G| offset1 |
168 * +-------+-------+-------+-------+-------+-------+-------+-------+
169 * 2 | vdev2 | GRID | ASIZE |
170 * +-------+-------+-------+-------+-------+-------+-------+-------+
171 * 3 |G| offset2 |
172 * +-------+-------+-------+-------+-------+-------+-------+-------+
173 * 4 | vdev3 | GRID | ASIZE |
174 * +-------+-------+-------+-------+-------+-------+-------+-------+
175 * 5 |G| offset3 |
176 * +-------+-------+-------+-------+-------+-------+-------+-------+
177 * 6 |BDX|lvl| type | cksum |E| comp| PSIZE | LSIZE |
178 * +-------+-------+-------+-------+-------+-------+-------+-------+
179 * 7 | padding |
180 * +-------+-------+-------+-------+-------+-------+-------+-------+
181 * 8 | padding |
182 * +-------+-------+-------+-------+-------+-------+-------+-------+
183 * 9 | physical birth txg |
184 * +-------+-------+-------+-------+-------+-------+-------+-------+
185 * a | logical birth txg |
186 * +-------+-------+-------+-------+-------+-------+-------+-------+
187 * b | fill count |
188 * +-------+-------+-------+-------+-------+-------+-------+-------+
189 * c | checksum[0] |
190 * +-------+-------+-------+-------+-------+-------+-------+-------+
191 * d | checksum[1] |
192 * +-------+-------+-------+-------+-------+-------+-------+-------+
193 * e | checksum[2] |
194 * +-------+-------+-------+-------+-------+-------+-------+-------+
195 * f | checksum[3] |
196 * +-------+-------+-------+-------+-------+-------+-------+-------+
198 * Legend:
200 * vdev virtual device ID
201 * offset offset into virtual device
202 * LSIZE logical size
203 * PSIZE physical size (after compression)
204 * ASIZE allocated size (including RAID-Z parity and gang block headers)
205 * GRID RAID-Z layout information (reserved for future use)
206 * cksum checksum function
207 * comp compression function
208 * G gang block indicator
209 * B byteorder (endianness)
210 * D dedup
211 * X encryption (on version 30, which is not supported)
212 * E blkptr_t contains embedded data (see below)
213 * lvl level of indirection
214 * type DMU object type
215 * phys birth txg of block allocation; zero if same as logical birth txg
216 * log. birth transaction group in which the block was logically born
217 * fill count number of non-zero blocks under this bp
218 * checksum[4] 256-bit checksum of the data this bp describes
222 * "Embedded" blkptr_t's don't actually point to a block, instead they
223 * have a data payload embedded in the blkptr_t itself. See the comment
224 * in blkptr.c for more details.
226 * The blkptr_t is laid out as follows:
228 * 64 56 48 40 32 24 16 8 0
229 * +-------+-------+-------+-------+-------+-------+-------+-------+
230 * 0 | payload |
231 * 1 | payload |
232 * 2 | payload |
233 * 3 | payload |
234 * 4 | payload |
235 * 5 | payload |
236 * +-------+-------+-------+-------+-------+-------+-------+-------+
237 * 6 |BDX|lvl| type | etype |E| comp| PSIZE| LSIZE |
238 * +-------+-------+-------+-------+-------+-------+-------+-------+
239 * 7 | payload |
240 * 8 | payload |
241 * 9 | payload |
242 * +-------+-------+-------+-------+-------+-------+-------+-------+
243 * a | logical birth txg |
244 * +-------+-------+-------+-------+-------+-------+-------+-------+
245 * b | payload |
246 * c | payload |
247 * d | payload |
248 * e | payload |
249 * f | payload |
250 * +-------+-------+-------+-------+-------+-------+-------+-------+
252 * Legend:
254 * payload contains the embedded data
255 * B (byteorder) byteorder (endianness)
256 * D (dedup) padding (set to zero)
257 * X encryption (set to zero; see above)
258 * E (embedded) set to one
259 * lvl indirection level
260 * type DMU object type
261 * etype how to interpret embedded data (BP_EMBEDDED_TYPE_*)
262 * comp compression function of payload
263 * PSIZE size of payload after compression, in bytes
264 * LSIZE logical size of payload, in bytes
265 * note that 25 bits is enough to store the largest
266 * "normal" BP's LSIZE (2^16 * 2^9) in bytes
267 * log. birth transaction group in which the block was logically born
269 * Note that LSIZE and PSIZE are stored in bytes, whereas for non-embedded
270 * bp's they are stored in units of SPA_MINBLOCKSHIFT.
271 * Generally, the generic BP_GET_*() macros can be used on embedded BP's.
272 * The B, D, X, lvl, type, and comp fields are stored the same as with normal
273 * BP's so the BP_SET_* macros can be used with them. etype, PSIZE, LSIZE must
274 * be set with the BPE_SET_* macros. BP_SET_EMBEDDED() should be called before
275 * other macros, as they assert that they are only used on BP's of the correct
276 * "embedded-ness".
279 #define BPE_GET_ETYPE(bp) \
280 (ASSERT(BP_IS_EMBEDDED(bp)), \
281 BF64_GET((bp)->blk_prop, 40, 8))
282 #define BPE_SET_ETYPE(bp, t) do { \
283 ASSERT(BP_IS_EMBEDDED(bp)); \
284 BF64_SET((bp)->blk_prop, 40, 8, t); \
285 _NOTE(CONSTCOND) } while (0)
287 #define BPE_GET_LSIZE(bp) \
288 (ASSERT(BP_IS_EMBEDDED(bp)), \
289 BF64_GET_SB((bp)->blk_prop, 0, 25, 0, 1))
290 #define BPE_SET_LSIZE(bp, x) do { \
291 ASSERT(BP_IS_EMBEDDED(bp)); \
292 BF64_SET_SB((bp)->blk_prop, 0, 25, 0, 1, x); \
293 _NOTE(CONSTCOND) } while (0)
295 #define BPE_GET_PSIZE(bp) \
296 (ASSERT(BP_IS_EMBEDDED(bp)), \
297 BF64_GET_SB((bp)->blk_prop, 25, 7, 0, 1))
298 #define BPE_SET_PSIZE(bp, x) do { \
299 ASSERT(BP_IS_EMBEDDED(bp)); \
300 BF64_SET_SB((bp)->blk_prop, 25, 7, 0, 1, x); \
301 _NOTE(CONSTCOND) } while (0)
303 typedef enum bp_embedded_type {
304 BP_EMBEDDED_TYPE_DATA,
305 BP_EMBEDDED_TYPE_RESERVED, /* Reserved for an unintegrated feature. */
306 NUM_BP_EMBEDDED_TYPES = BP_EMBEDDED_TYPE_RESERVED
307 } bp_embedded_type_t;
309 #define BPE_NUM_WORDS 14
310 #define BPE_PAYLOAD_SIZE (BPE_NUM_WORDS * sizeof (uint64_t))
311 #define BPE_IS_PAYLOADWORD(bp, wp) \
312 ((wp) != &(bp)->blk_prop && (wp) != &(bp)->blk_birth)
314 #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */
315 #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */
318 * A block is a hole when it has either 1) never been written to, or
319 * 2) is zero-filled. In both cases, ZFS can return all zeroes for all reads
320 * without physically allocating disk space. Holes are represented in the
321 * blkptr_t structure by zeroed blk_dva. Correct checking for holes is
322 * done through the BP_IS_HOLE macro. For holes, the logical size, level,
323 * DMU object type, and birth times are all also stored for holes that
324 * were written to at some point (i.e. were punched after having been filled).
326 typedef struct blkptr {
327 dva_t blk_dva[SPA_DVAS_PER_BP]; /* Data Virtual Addresses */
328 uint64_t blk_prop; /* size, compression, type, etc */
329 uint64_t blk_pad[2]; /* Extra space for the future */
330 uint64_t blk_phys_birth; /* txg when block was allocated */
331 uint64_t blk_birth; /* transaction group at birth */
332 uint64_t blk_fill; /* fill count */
333 zio_cksum_t blk_cksum; /* 256-bit checksum */
334 } blkptr_t;
337 * Macros to get and set fields in a bp or DVA.
339 #define DVA_GET_ASIZE(dva) \
340 BF64_GET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, SPA_MINBLOCKSHIFT, 0)
341 #define DVA_SET_ASIZE(dva, x) \
342 BF64_SET_SB((dva)->dva_word[0], 0, SPA_ASIZEBITS, \
343 SPA_MINBLOCKSHIFT, 0, x)
345 #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8)
346 #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x)
348 #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32)
349 #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x)
351 #define DVA_GET_OFFSET(dva) \
352 BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
353 #define DVA_SET_OFFSET(dva, x) \
354 BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
356 #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1)
357 #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x)
359 #define BP_GET_LSIZE(bp) \
360 (BP_IS_EMBEDDED(bp) ? \
361 (BPE_GET_ETYPE(bp) == BP_EMBEDDED_TYPE_DATA ? BPE_GET_LSIZE(bp) : 0): \
362 BF64_GET_SB((bp)->blk_prop, 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1))
363 #define BP_SET_LSIZE(bp, x) do { \
364 ASSERT(!BP_IS_EMBEDDED(bp)); \
365 BF64_SET_SB((bp)->blk_prop, \
366 0, SPA_LSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
367 _NOTE(CONSTCOND) } while (0)
369 #define BP_GET_PSIZE(bp) \
370 (BP_IS_EMBEDDED(bp) ? 0 : \
371 BF64_GET_SB((bp)->blk_prop, 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1))
372 #define BP_SET_PSIZE(bp, x) do { \
373 ASSERT(!BP_IS_EMBEDDED(bp)); \
374 BF64_SET_SB((bp)->blk_prop, \
375 16, SPA_PSIZEBITS, SPA_MINBLOCKSHIFT, 1, x); \
376 _NOTE(CONSTCOND) } while (0)
378 #define BP_GET_COMPRESS(bp) \
379 BF64_GET((bp)->blk_prop, 32, SPA_COMPRESSBITS)
380 #define BP_SET_COMPRESS(bp, x) \
381 BF64_SET((bp)->blk_prop, 32, SPA_COMPRESSBITS, x)
383 #define BP_IS_EMBEDDED(bp) BF64_GET((bp)->blk_prop, 39, 1)
384 #define BP_SET_EMBEDDED(bp, x) BF64_SET((bp)->blk_prop, 39, 1, x)
386 #define BP_GET_CHECKSUM(bp) \
387 (BP_IS_EMBEDDED(bp) ? ZIO_CHECKSUM_OFF : \
388 BF64_GET((bp)->blk_prop, 40, 8))
389 #define BP_SET_CHECKSUM(bp, x) do { \
390 ASSERT(!BP_IS_EMBEDDED(bp)); \
391 BF64_SET((bp)->blk_prop, 40, 8, x); \
392 _NOTE(CONSTCOND) } while (0)
394 #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8)
395 #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x)
397 #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5)
398 #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x)
400 #define BP_GET_DEDUP(bp) BF64_GET((bp)->blk_prop, 62, 1)
401 #define BP_SET_DEDUP(bp, x) BF64_SET((bp)->blk_prop, 62, 1, x)
403 #define BP_GET_BYTEORDER(bp) BF64_GET((bp)->blk_prop, 63, 1)
404 #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x)
406 #define BP_PHYSICAL_BIRTH(bp) \
407 (BP_IS_EMBEDDED(bp) ? 0 : \
408 (bp)->blk_phys_birth ? (bp)->blk_phys_birth : (bp)->blk_birth)
410 #define BP_SET_BIRTH(bp, logical, physical) \
412 ASSERT(!BP_IS_EMBEDDED(bp)); \
413 (bp)->blk_birth = (logical); \
414 (bp)->blk_phys_birth = ((logical) == (physical) ? 0 : (physical)); \
417 #define BP_GET_FILL(bp) (BP_IS_EMBEDDED(bp) ? 1 : (bp)->blk_fill)
419 #define BP_GET_ASIZE(bp) \
420 (BP_IS_EMBEDDED(bp) ? 0 : \
421 DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
422 DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
423 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
425 #define BP_GET_UCSIZE(bp) \
426 ((BP_GET_LEVEL(bp) > 0 || DMU_OT_IS_METADATA(BP_GET_TYPE(bp))) ? \
427 BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp))
429 #define BP_GET_NDVAS(bp) \
430 (BP_IS_EMBEDDED(bp) ? 0 : \
431 !!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
432 !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
433 !!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
435 #define BP_COUNT_GANG(bp) \
436 (BP_IS_EMBEDDED(bp) ? 0 : \
437 (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
438 DVA_GET_GANG(&(bp)->blk_dva[1]) + \
439 DVA_GET_GANG(&(bp)->blk_dva[2])))
441 #define DVA_EQUAL(dva1, dva2) \
442 ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
443 (dva1)->dva_word[0] == (dva2)->dva_word[0])
445 #define BP_EQUAL(bp1, bp2) \
446 (BP_PHYSICAL_BIRTH(bp1) == BP_PHYSICAL_BIRTH(bp2) && \
447 (bp1)->blk_birth == (bp2)->blk_birth && \
448 DVA_EQUAL(&(bp1)->blk_dva[0], &(bp2)->blk_dva[0]) && \
449 DVA_EQUAL(&(bp1)->blk_dva[1], &(bp2)->blk_dva[1]) && \
450 DVA_EQUAL(&(bp1)->blk_dva[2], &(bp2)->blk_dva[2]))
453 #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0)
455 #define BP_IDENTITY(bp) (ASSERT(!BP_IS_EMBEDDED(bp)), &(bp)->blk_dva[0])
456 #define BP_IS_GANG(bp) \
457 (BP_IS_EMBEDDED(bp) ? B_FALSE : DVA_GET_GANG(BP_IDENTITY(bp)))
458 #define DVA_IS_EMPTY(dva) ((dva)->dva_word[0] == 0ULL && \
459 (dva)->dva_word[1] == 0ULL)
460 #define BP_IS_HOLE(bp) \
461 (!BP_IS_EMBEDDED(bp) && DVA_IS_EMPTY(BP_IDENTITY(bp)))
463 /* BP_IS_RAIDZ(bp) assumes no block compression */
464 #define BP_IS_RAIDZ(bp) (DVA_GET_ASIZE(&(bp)->blk_dva[0]) > \
465 BP_GET_PSIZE(bp))
467 #define BP_ZERO(bp) \
469 (bp)->blk_dva[0].dva_word[0] = 0; \
470 (bp)->blk_dva[0].dva_word[1] = 0; \
471 (bp)->blk_dva[1].dva_word[0] = 0; \
472 (bp)->blk_dva[1].dva_word[1] = 0; \
473 (bp)->blk_dva[2].dva_word[0] = 0; \
474 (bp)->blk_dva[2].dva_word[1] = 0; \
475 (bp)->blk_prop = 0; \
476 (bp)->blk_pad[0] = 0; \
477 (bp)->blk_pad[1] = 0; \
478 (bp)->blk_phys_birth = 0; \
479 (bp)->blk_birth = 0; \
480 (bp)->blk_fill = 0; \
481 ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
484 #ifdef _BIG_ENDIAN
485 #define ZFS_HOST_BYTEORDER (0ULL)
486 #else
487 #define ZFS_HOST_BYTEORDER (1ULL)
488 #endif
490 #define BP_SHOULD_BYTESWAP(bp) (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
492 #define BP_SPRINTF_LEN 320
495 * This macro allows code sharing between zfs, libzpool, and mdb.
496 * 'func' is either snprintf() or mdb_snprintf().
497 * 'ws' (whitespace) can be ' ' for single-line format, '\n' for multi-line.
499 #define SNPRINTF_BLKPTR(func, ws, buf, size, bp, type, checksum, compress) \
501 static const char *copyname[] = \
502 { "zero", "single", "double", "triple" }; \
503 int len = 0; \
504 int copies = 0; \
505 int d; \
507 if (bp == NULL) { \
508 len += func(buf + len, size - len, "<NULL>"); \
509 } else if (BP_IS_HOLE(bp)) { \
510 len += func(buf + len, size - len, \
511 "HOLE [L%llu %s] " \
512 "size=%llxL birth=%lluL", \
513 (u_longlong_t)BP_GET_LEVEL(bp), \
514 type, \
515 (u_longlong_t)BP_GET_LSIZE(bp), \
516 (u_longlong_t)bp->blk_birth); \
517 } else if (BP_IS_EMBEDDED(bp)) { \
518 len = func(buf + len, size - len, \
519 "EMBEDDED [L%llu %s] et=%u %s " \
520 "size=%llxL/%llxP birth=%lluL", \
521 (u_longlong_t)BP_GET_LEVEL(bp), \
522 type, \
523 (int)BPE_GET_ETYPE(bp), \
524 compress, \
525 (u_longlong_t)BPE_GET_LSIZE(bp), \
526 (u_longlong_t)BPE_GET_PSIZE(bp), \
527 (u_longlong_t)bp->blk_birth); \
528 } else { \
529 for (d = 0; d < BP_GET_NDVAS(bp); d++) { \
530 const dva_t *dva = &bp->blk_dva[d]; \
531 if (DVA_IS_VALID(dva)) \
532 copies++; \
533 len += func(buf + len, size - len, \
534 "DVA[%d]=<%llu:%llx:%llx>%c", d, \
535 (u_longlong_t)DVA_GET_VDEV(dva), \
536 (u_longlong_t)DVA_GET_OFFSET(dva), \
537 (u_longlong_t)DVA_GET_ASIZE(dva), \
538 ws); \
540 if (BP_IS_GANG(bp) && \
541 DVA_GET_ASIZE(&bp->blk_dva[2]) <= \
542 DVA_GET_ASIZE(&bp->blk_dva[1]) / 2) \
543 copies--; \
544 len += func(buf + len, size - len, \
545 "[L%llu %s] %s %s %s %s %s %s%c" \
546 "size=%llxL/%llxP birth=%lluL/%lluP fill=%llu%c" \
547 "cksum=%llx:%llx:%llx:%llx", \
548 (u_longlong_t)BP_GET_LEVEL(bp), \
549 type, \
550 checksum, \
551 compress, \
552 BP_GET_BYTEORDER(bp) == 0 ? "BE" : "LE", \
553 BP_IS_GANG(bp) ? "gang" : "contiguous", \
554 BP_GET_DEDUP(bp) ? "dedup" : "unique", \
555 copyname[copies], \
556 ws, \
557 (u_longlong_t)BP_GET_LSIZE(bp), \
558 (u_longlong_t)BP_GET_PSIZE(bp), \
559 (u_longlong_t)bp->blk_birth, \
560 (u_longlong_t)BP_PHYSICAL_BIRTH(bp), \
561 (u_longlong_t)BP_GET_FILL(bp), \
562 ws, \
563 (u_longlong_t)bp->blk_cksum.zc_word[0], \
564 (u_longlong_t)bp->blk_cksum.zc_word[1], \
565 (u_longlong_t)bp->blk_cksum.zc_word[2], \
566 (u_longlong_t)bp->blk_cksum.zc_word[3]); \
568 ASSERT(len < size); \
571 #define BP_GET_BUFC_TYPE(bp) \
572 (((BP_GET_LEVEL(bp) > 0) || (DMU_OT_IS_METADATA(BP_GET_TYPE(bp)))) ? \
573 ARC_BUFC_METADATA : ARC_BUFC_DATA)
575 typedef enum spa_import_type {
576 SPA_IMPORT_EXISTING,
577 SPA_IMPORT_ASSEMBLE
578 } spa_import_type_t;
580 /* state manipulation functions */
581 extern int spa_open(const char *pool, spa_t **, void *tag);
582 extern int spa_open_rewind(const char *pool, spa_t **, void *tag,
583 nvlist_t *policy, nvlist_t **config);
584 extern int spa_get_stats(const char *pool, nvlist_t **config, char *altroot,
585 size_t buflen);
586 extern int spa_create(const char *pool, nvlist_t *config, nvlist_t *props,
587 nvlist_t *zplprops);
588 extern int spa_import_rootpool(char *devpath, char *devid);
589 extern int spa_import(char *pool, nvlist_t *config, nvlist_t *props,
590 uint64_t flags);
591 extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
592 extern int spa_destroy(char *pool);
593 extern int spa_export(char *pool, nvlist_t **oldconfig, boolean_t force,
594 boolean_t hardforce);
595 extern int spa_reset(char *pool);
596 extern void spa_async_request(spa_t *spa, int flag);
597 extern void spa_async_unrequest(spa_t *spa, int flag);
598 extern void spa_async_suspend(spa_t *spa);
599 extern void spa_async_resume(spa_t *spa);
600 extern spa_t *spa_inject_addref(char *pool);
601 extern void spa_inject_delref(spa_t *spa);
602 extern void spa_scan_stat_init(spa_t *spa);
603 extern int spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps);
605 #define SPA_ASYNC_CONFIG_UPDATE 0x01
606 #define SPA_ASYNC_REMOVE 0x02
607 #define SPA_ASYNC_PROBE 0x04
608 #define SPA_ASYNC_RESILVER_DONE 0x08
609 #define SPA_ASYNC_RESILVER 0x10
610 #define SPA_ASYNC_AUTOEXPAND 0x20
611 #define SPA_ASYNC_REMOVE_DONE 0x40
612 #define SPA_ASYNC_REMOVE_STOP 0x80
615 * Controls the behavior of spa_vdev_remove().
617 #define SPA_REMOVE_UNSPARE 0x01
618 #define SPA_REMOVE_DONE 0x02
620 /* device manipulation */
621 extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
622 extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
623 int replacing);
624 extern int spa_vdev_detach(spa_t *spa, uint64_t guid, uint64_t pguid,
625 int replace_done);
626 extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
627 extern boolean_t spa_vdev_remove_active(spa_t *spa);
628 extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
629 extern int spa_vdev_setfru(spa_t *spa, uint64_t guid, const char *newfru);
630 extern int spa_vdev_split_mirror(spa_t *spa, char *newname, nvlist_t *config,
631 nvlist_t *props, boolean_t exp);
633 /* spare state (which is global across all pools) */
634 extern void spa_spare_add(vdev_t *vd);
635 extern void spa_spare_remove(vdev_t *vd);
636 extern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt);
637 extern void spa_spare_activate(vdev_t *vd);
639 /* L2ARC state (which is global across all pools) */
640 extern void spa_l2cache_add(vdev_t *vd);
641 extern void spa_l2cache_remove(vdev_t *vd);
642 extern boolean_t spa_l2cache_exists(uint64_t guid, uint64_t *pool);
643 extern void spa_l2cache_activate(vdev_t *vd);
644 extern void spa_l2cache_drop(spa_t *spa);
646 /* scanning */
647 extern int spa_scan(spa_t *spa, pool_scan_func_t func);
648 extern int spa_scan_stop(spa_t *spa);
650 /* spa syncing */
651 extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
652 extern void spa_sync_allpools(void);
654 extern int zfs_sync_pass_deferred_free;
656 /* spa namespace global mutex */
657 extern kmutex_t spa_namespace_lock;
660 * SPA configuration functions in spa_config.c
663 #define SPA_CONFIG_UPDATE_POOL 0
664 #define SPA_CONFIG_UPDATE_VDEVS 1
666 extern void spa_config_sync(spa_t *, boolean_t, boolean_t);
667 extern void spa_config_load(void);
668 extern nvlist_t *spa_all_configs(uint64_t *);
669 extern void spa_config_set(spa_t *spa, nvlist_t *config);
670 extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
671 int getstats);
672 extern void spa_config_update(spa_t *spa, int what);
675 * Miscellaneous SPA routines in spa_misc.c
678 /* Namespace manipulation */
679 extern spa_t *spa_lookup(const char *name);
680 extern spa_t *spa_add(const char *name, nvlist_t *config, const char *altroot);
681 extern void spa_remove(spa_t *spa);
682 extern spa_t *spa_next(spa_t *prev);
684 /* Refcount functions */
685 extern void spa_open_ref(spa_t *spa, void *tag);
686 extern void spa_close(spa_t *spa, void *tag);
687 extern void spa_async_close(spa_t *spa, void *tag);
688 extern boolean_t spa_refcount_zero(spa_t *spa);
690 #define SCL_NONE 0x00
691 #define SCL_CONFIG 0x01
692 #define SCL_STATE 0x02
693 #define SCL_L2ARC 0x04 /* hack until L2ARC 2.0 */
694 #define SCL_ALLOC 0x08
695 #define SCL_ZIO 0x10
696 #define SCL_FREE 0x20
697 #define SCL_VDEV 0x40
698 #define SCL_LOCKS 7
699 #define SCL_ALL ((1 << SCL_LOCKS) - 1)
700 #define SCL_STATE_ALL (SCL_STATE | SCL_L2ARC | SCL_ZIO)
702 /* Historical pool statistics */
703 typedef struct spa_stats_history {
704 kmutex_t lock;
705 uint64_t count;
706 uint64_t size;
707 kstat_t *kstat;
708 void *private;
709 list_t list;
710 } spa_stats_history_t;
712 typedef struct spa_stats {
713 spa_stats_history_t read_history;
714 spa_stats_history_t txg_history;
715 spa_stats_history_t tx_assign_histogram;
716 spa_stats_history_t io_history;
717 } spa_stats_t;
719 typedef enum txg_state {
720 TXG_STATE_BIRTH = 0,
721 TXG_STATE_OPEN = 1,
722 TXG_STATE_QUIESCED = 2,
723 TXG_STATE_WAIT_FOR_SYNC = 3,
724 TXG_STATE_SYNCED = 4,
725 TXG_STATE_COMMITTED = 5,
726 } txg_state_t;
728 extern void spa_stats_init(spa_t *spa);
729 extern void spa_stats_destroy(spa_t *spa);
730 extern void spa_read_history_add(spa_t *spa, const zbookmark_phys_t *zb,
731 uint32_t aflags);
732 extern void spa_txg_history_add(spa_t *spa, uint64_t txg, hrtime_t birth_time);
733 extern int spa_txg_history_set(spa_t *spa, uint64_t txg,
734 txg_state_t completed_state, hrtime_t completed_time);
735 extern int spa_txg_history_set_io(spa_t *spa, uint64_t txg, uint64_t nread,
736 uint64_t nwritten, uint64_t reads, uint64_t writes, uint64_t ndirty);
737 extern void spa_tx_assign_add_nsecs(spa_t *spa, uint64_t nsecs);
739 /* Pool configuration locks */
740 extern int spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw);
741 extern void spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw);
742 extern void spa_config_exit(spa_t *spa, int locks, void *tag);
743 extern int spa_config_held(spa_t *spa, int locks, krw_t rw);
745 /* Pool vdev add/remove lock */
746 extern uint64_t spa_vdev_enter(spa_t *spa);
747 extern uint64_t spa_vdev_config_enter(spa_t *spa);
748 extern void spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg,
749 int error, char *tag);
750 extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
752 /* Pool vdev state change lock */
753 extern void spa_vdev_state_enter(spa_t *spa, int oplock);
754 extern int spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error);
756 /* Log state */
757 typedef enum spa_log_state {
758 SPA_LOG_UNKNOWN = 0, /* unknown log state */
759 SPA_LOG_MISSING, /* missing log(s) */
760 SPA_LOG_CLEAR, /* clear the log(s) */
761 SPA_LOG_GOOD, /* log(s) are good */
762 } spa_log_state_t;
764 extern spa_log_state_t spa_get_log_state(spa_t *spa);
765 extern void spa_set_log_state(spa_t *spa, spa_log_state_t state);
766 extern int spa_offline_log(spa_t *spa);
768 /* Log claim callback */
769 extern void spa_claim_notify(zio_t *zio);
770 extern void spa_deadman(void *);
772 /* Accessor functions */
773 extern boolean_t spa_shutting_down(spa_t *spa);
774 extern struct dsl_pool *spa_get_dsl(spa_t *spa);
775 extern boolean_t spa_is_initializing(spa_t *spa);
776 extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
777 extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
778 extern void spa_altroot(spa_t *, char *, size_t);
779 extern int spa_sync_pass(spa_t *spa);
780 extern char *spa_name(spa_t *spa);
781 extern uint64_t spa_guid(spa_t *spa);
782 extern uint64_t spa_load_guid(spa_t *spa);
783 extern uint64_t spa_last_synced_txg(spa_t *spa);
784 extern uint64_t spa_first_txg(spa_t *spa);
785 extern uint64_t spa_syncing_txg(spa_t *spa);
786 extern uint64_t spa_version(spa_t *spa);
787 extern pool_state_t spa_state(spa_t *spa);
788 extern spa_load_state_t spa_load_state(spa_t *spa);
789 extern uint64_t spa_freeze_txg(spa_t *spa);
790 extern uint64_t spa_get_asize(spa_t *spa, uint64_t lsize);
791 extern uint64_t spa_get_dspace(spa_t *spa);
792 extern uint64_t spa_get_slop_space(spa_t *spa);
793 extern void spa_update_dspace(spa_t *spa);
794 extern uint64_t spa_version(spa_t *spa);
795 extern boolean_t spa_deflate(spa_t *spa);
796 extern metaslab_class_t *spa_normal_class(spa_t *spa);
797 extern metaslab_class_t *spa_log_class(spa_t *spa);
798 extern void spa_evicting_os_register(spa_t *, objset_t *os);
799 extern void spa_evicting_os_deregister(spa_t *, objset_t *os);
800 extern void spa_evicting_os_wait(spa_t *spa);
801 extern int spa_max_replication(spa_t *spa);
802 extern int spa_prev_software_version(spa_t *spa);
803 extern uint8_t spa_get_failmode(spa_t *spa);
804 extern boolean_t spa_suspended(spa_t *spa);
805 extern uint64_t spa_bootfs(spa_t *spa);
806 extern uint64_t spa_delegation(spa_t *spa);
807 extern objset_t *spa_meta_objset(spa_t *spa);
808 extern uint64_t spa_deadman_synctime(spa_t *spa);
810 /* Miscellaneous support routines */
811 extern void spa_activate_mos_feature(spa_t *spa, const char *feature,
812 dmu_tx_t *tx);
813 extern void spa_deactivate_mos_feature(spa_t *spa, const char *feature);
814 extern int spa_rename(const char *oldname, const char *newname);
815 extern spa_t *spa_by_guid(uint64_t pool_guid, uint64_t device_guid);
816 extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
817 extern char *spa_strdup(const char *);
818 extern void spa_strfree(char *);
819 extern uint64_t spa_get_random(uint64_t range);
820 extern uint64_t spa_generate_guid(spa_t *spa);
821 extern void snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp);
822 extern void spa_freeze(spa_t *spa);
823 extern int spa_change_guid(spa_t *spa);
824 extern void spa_upgrade(spa_t *spa, uint64_t version);
825 extern void spa_evict_all(void);
826 extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid,
827 boolean_t l2cache);
828 extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
829 extern uint64_t dva_get_dsize_sync(spa_t *spa, const dva_t *dva);
830 extern uint64_t bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp);
831 extern uint64_t bp_get_dsize(spa_t *spa, const blkptr_t *bp);
832 extern boolean_t spa_has_slogs(spa_t *spa);
833 extern boolean_t spa_is_root(spa_t *spa);
834 extern boolean_t spa_writeable(spa_t *spa);
835 extern boolean_t spa_has_pending_synctask(spa_t *spa);
836 extern int spa_maxblocksize(spa_t *spa);
837 extern int spa_maxdnodesize(spa_t *spa);
838 extern void zfs_blkptr_verify(spa_t *spa, const blkptr_t *bp);
840 extern int spa_mode(spa_t *spa);
841 extern uint64_t strtonum(const char *str, char **nptr);
843 extern char *spa_his_ievent_table[];
845 extern void spa_history_create_obj(spa_t *spa, dmu_tx_t *tx);
846 extern int spa_history_get(spa_t *spa, uint64_t *offset, uint64_t *len_read,
847 char *his_buf);
848 extern int spa_history_log(spa_t *spa, const char *his_buf);
849 extern int spa_history_log_nvl(spa_t *spa, nvlist_t *nvl);
850 extern void spa_history_log_version(spa_t *spa, const char *operation);
851 extern void spa_history_log_internal(spa_t *spa, const char *operation,
852 dmu_tx_t *tx, const char *fmt, ...);
853 extern void spa_history_log_internal_ds(struct dsl_dataset *ds, const char *op,
854 dmu_tx_t *tx, const char *fmt, ...);
855 extern void spa_history_log_internal_dd(dsl_dir_t *dd, const char *operation,
856 dmu_tx_t *tx, const char *fmt, ...);
858 /* error handling */
859 struct zbookmark_phys;
860 extern void spa_log_error(spa_t *spa, zio_t *zio);
861 extern void zfs_ereport_post(const char *class, spa_t *spa, vdev_t *vd,
862 zio_t *zio, uint64_t stateoroffset, uint64_t length);
863 extern void zfs_post_remove(spa_t *spa, vdev_t *vd);
864 extern void zfs_post_state_change(spa_t *spa, vdev_t *vd, uint64_t laststate);
865 extern void zfs_post_autoreplace(spa_t *spa, vdev_t *vd);
866 extern void zfs_post_sysevent(spa_t *spa, vdev_t *vd, const char *name);
867 extern uint64_t spa_get_errlog_size(spa_t *spa);
868 extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
869 extern void spa_errlog_rotate(spa_t *spa);
870 extern void spa_errlog_drain(spa_t *spa);
871 extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
872 extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
874 /* vdev cache */
875 extern void vdev_cache_stat_init(void);
876 extern void vdev_cache_stat_fini(void);
878 /* Initialization and termination */
879 extern void spa_init(int flags);
880 extern void spa_fini(void);
881 extern void spa_boot_init(void);
883 /* properties */
884 extern int spa_prop_set(spa_t *spa, nvlist_t *nvp);
885 extern int spa_prop_get(spa_t *spa, nvlist_t **nvp);
886 extern void spa_prop_clear_bootfs(spa_t *spa, uint64_t obj, dmu_tx_t *tx);
887 extern void spa_configfile_set(spa_t *, nvlist_t *, boolean_t);
889 /* asynchronous event notification */
890 extern void spa_event_notify(spa_t *spa, vdev_t *vdev, const char *name);
892 #ifdef ZFS_DEBUG
893 #define dprintf_bp(bp, fmt, ...) do { \
894 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
895 char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP); \
896 snprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp)); \
897 dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf); \
898 kmem_free(__blkbuf, BP_SPRINTF_LEN); \
900 _NOTE(CONSTCOND) } while (0)
901 #else
902 #define dprintf_bp(bp, fmt, ...)
903 #endif
905 extern boolean_t spa_debug_enabled(spa_t *spa);
906 #define spa_dbgmsg(spa, ...) \
908 if (spa_debug_enabled(spa)) \
909 zfs_dbgmsg(__VA_ARGS__); \
912 extern int spa_mode_global; /* mode, e.g. FREAD | FWRITE */
914 #ifdef __cplusplus
916 #endif
918 #endif /* _SYS_SPA_H */