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 2007 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
29 #pragma ident "%Z%%M% %I% %E% SMI"
32 #include <sys/zfs_context.h>
33 #include <sys/nvpair.h>
34 #include <sys/sysmacros.h>
35 #include <sys/types.h>
36 #include <sys/fs/zfs.h>
43 * Forward references that lots of things need.
45 typedef struct spa spa_t;
46 typedef struct vdev vdev_t;
47 typedef struct metaslab metaslab_t;
48 typedef struct zilog zilog_t;
49 typedef struct traverse_handle traverse_handle_t;
53 * General-purpose 32-bit and 64-bit bitfield encodings.
55 #define BF32_DECODE(x, low, len) P2PHASE((x) >> (low), 1U << (len))
56 #define BF64_DECODE(x, low, len) P2PHASE((x) >> (low), 1ULL << (len))
57 #define BF32_ENCODE(x, low, len) (P2PHASE((x), 1U << (len)) << (low))
58 #define BF64_ENCODE(x, low, len) (P2PHASE((x), 1ULL << (len)) << (low))
60 #define BF32_GET(x, low, len) BF32_DECODE(x, low, len)
61 #define BF64_GET(x, low, len) BF64_DECODE(x, low, len)
63 #define BF32_SET(x, low, len, val) \
64 ((x) ^= BF32_ENCODE((x >> low) ^ (val), low, len))
65 #define BF64_SET(x, low, len, val) \
66 ((x) ^= BF64_ENCODE((x >> low) ^ (val), low, len))
68 #define BF32_GET_SB(x, low, len, shift, bias) \
69 ((BF32_GET(x, low, len) + (bias)) << (shift))
70 #define BF64_GET_SB(x, low, len, shift, bias) \
71 ((BF64_GET(x, low, len) + (bias)) << (shift))
73 #define BF32_SET_SB(x, low, len, shift, bias, val) \
74 BF32_SET(x, low, len, ((val) >> (shift)) - (bias))
75 #define BF64_SET_SB(x, low, len, shift, bias, val) \
76 BF64_SET(x, low, len, ((val) >> (shift)) - (bias))
79 * We currently support nine block sizes, from 512 bytes to 128K.
80 * We could go higher, but the benefits are near-zero and the cost
81 * of COWing a giant block to modify one byte would become excessive.
83 #define SPA_MINBLOCKSHIFT 9
84 #define SPA_MAXBLOCKSHIFT 17
85 #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT)
86 #define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT)
88 #define SPA_BLOCKSIZES (SPA_MAXBLOCKSHIFT - SPA_MINBLOCKSHIFT + 1)
91 * The DVA size encodings for LSIZE and PSIZE support blocks up to 32MB.
92 * The ASIZE encoding should be at least 64 times larger (6 more bits)
93 * to support up to 4-way RAID-Z mirror mode with worst-case gang block
94 * overhead, three DVAs per bp, plus one more bit in case we do anything
95 * else that expands the ASIZE.
97 #define SPA_LSIZEBITS 16 /* LSIZE up to 32M (2^16 * 512) */
98 #define SPA_PSIZEBITS 16 /* PSIZE up to 32M (2^16 * 512) */
99 #define SPA_ASIZEBITS 24 /* ASIZE up to 64 times larger */
102 * All SPA data is represented by 128-bit data virtual addresses (DVAs).
103 * The members of the dva_t should be considered opaque outside the SPA.
106 uint64_t dva_word[2];
110 * Each block has a 256-bit checksum -- strong enough for cryptographic hashes.
112 typedef struct zio_cksum {
117 * Each block is described by its DVAs, time of birth, checksum, etc.
118 * The word-by-word, bit-by-bit layout of the blkptr is as follows:
120 * 64 56 48 40 32 24 16 8 0
121 * +-------+-------+-------+-------+-------+-------+-------+-------+
122 * 0 | vdev1 | GRID | ASIZE |
123 * +-------+-------+-------+-------+-------+-------+-------+-------+
125 * +-------+-------+-------+-------+-------+-------+-------+-------+
126 * 2 | vdev2 | GRID | ASIZE |
127 * +-------+-------+-------+-------+-------+-------+-------+-------+
129 * +-------+-------+-------+-------+-------+-------+-------+-------+
130 * 4 | vdev3 | GRID | ASIZE |
131 * +-------+-------+-------+-------+-------+-------+-------+-------+
133 * +-------+-------+-------+-------+-------+-------+-------+-------+
134 * 6 |E| lvl | type | cksum | comp | PSIZE | LSIZE |
135 * +-------+-------+-------+-------+-------+-------+-------+-------+
137 * +-------+-------+-------+-------+-------+-------+-------+-------+
139 * +-------+-------+-------+-------+-------+-------+-------+-------+
141 * +-------+-------+-------+-------+-------+-------+-------+-------+
143 * +-------+-------+-------+-------+-------+-------+-------+-------+
145 * +-------+-------+-------+-------+-------+-------+-------+-------+
147 * +-------+-------+-------+-------+-------+-------+-------+-------+
149 * +-------+-------+-------+-------+-------+-------+-------+-------+
151 * +-------+-------+-------+-------+-------+-------+-------+-------+
153 * +-------+-------+-------+-------+-------+-------+-------+-------+
157 * vdev virtual device ID
158 * offset offset into virtual device
160 * PSIZE physical size (after compression)
161 * ASIZE allocated size (including RAID-Z parity and gang block headers)
162 * GRID RAID-Z layout information (reserved for future use)
163 * cksum checksum function
164 * comp compression function
165 * G gang block indicator
167 * type DMU object type
168 * lvl level of indirection
169 * birth txg transaction group in which the block was born
170 * fill count number of non-zero blocks under this bp
171 * checksum[4] 256-bit checksum of the data this bp describes
173 typedef struct blkptr {
174 dva_t blk_dva[3]; /* 128-bit Data Virtual Address */
175 uint64_t blk_prop; /* size, compression, type, etc */
176 uint64_t blk_pad[3]; /* Extra space for the future */
177 uint64_t blk_birth; /* transaction group at birth */
178 uint64_t blk_fill; /* fill count */
179 zio_cksum_t blk_cksum; /* 256-bit checksum */
182 #define SPA_BLKPTRSHIFT 7 /* blkptr_t is 128 bytes */
183 #define SPA_DVAS_PER_BP 3 /* Number of DVAs in a bp */
186 * Macros to get and set fields in a bp or DVA.
188 #define DVA_GET_ASIZE(dva) \
189 BF64_GET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0)
190 #define DVA_SET_ASIZE(dva, x) \
191 BF64_SET_SB((dva)->dva_word[0], 0, 24, SPA_MINBLOCKSHIFT, 0, x)
193 #define DVA_GET_GRID(dva) BF64_GET((dva)->dva_word[0], 24, 8)
194 #define DVA_SET_GRID(dva, x) BF64_SET((dva)->dva_word[0], 24, 8, x)
196 #define DVA_GET_VDEV(dva) BF64_GET((dva)->dva_word[0], 32, 32)
197 #define DVA_SET_VDEV(dva, x) BF64_SET((dva)->dva_word[0], 32, 32, x)
199 #define DVA_GET_OFFSET(dva) \
200 BF64_GET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0)
201 #define DVA_SET_OFFSET(dva, x) \
202 BF64_SET_SB((dva)->dva_word[1], 0, 63, SPA_MINBLOCKSHIFT, 0, x)
204 #define DVA_GET_GANG(dva) BF64_GET((dva)->dva_word[1], 63, 1)
205 #define DVA_SET_GANG(dva, x) BF64_SET((dva)->dva_word[1], 63, 1, x)
207 #define BP_GET_LSIZE(bp) \
208 (BP_IS_HOLE(bp) ? 0 : \
209 BF64_GET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1))
210 #define BP_SET_LSIZE(bp, x) \
211 BF64_SET_SB((bp)->blk_prop, 0, 16, SPA_MINBLOCKSHIFT, 1, x)
213 #define BP_GET_PSIZE(bp) \
214 BF64_GET_SB((bp)->blk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1)
215 #define BP_SET_PSIZE(bp, x) \
216 BF64_SET_SB((bp)->blk_prop, 16, 16, SPA_MINBLOCKSHIFT, 1, x)
218 #define BP_GET_COMPRESS(bp) BF64_GET((bp)->blk_prop, 32, 8)
219 #define BP_SET_COMPRESS(bp, x) BF64_SET((bp)->blk_prop, 32, 8, x)
221 #define BP_GET_CHECKSUM(bp) BF64_GET((bp)->blk_prop, 40, 8)
222 #define BP_SET_CHECKSUM(bp, x) BF64_SET((bp)->blk_prop, 40, 8, x)
224 #define BP_GET_TYPE(bp) BF64_GET((bp)->blk_prop, 48, 8)
225 #define BP_SET_TYPE(bp, x) BF64_SET((bp)->blk_prop, 48, 8, x)
227 #define BP_GET_LEVEL(bp) BF64_GET((bp)->blk_prop, 56, 5)
228 #define BP_SET_LEVEL(bp, x) BF64_SET((bp)->blk_prop, 56, 5, x)
230 #define BP_GET_BYTEORDER(bp) (0 - BF64_GET((bp)->blk_prop, 63, 1))
231 #define BP_SET_BYTEORDER(bp, x) BF64_SET((bp)->blk_prop, 63, 1, x)
233 #define BP_GET_ASIZE(bp) \
234 (DVA_GET_ASIZE(&(bp)->blk_dva[0]) + DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
235 DVA_GET_ASIZE(&(bp)->blk_dva[2]))
237 #define BP_GET_UCSIZE(bp) \
238 ((BP_GET_LEVEL(bp) > 0 || dmu_ot[BP_GET_TYPE(bp)].ot_metadata) ? \
239 BP_GET_PSIZE(bp) : BP_GET_LSIZE(bp));
241 #define BP_GET_NDVAS(bp) \
242 (!!DVA_GET_ASIZE(&(bp)->blk_dva[0]) + \
243 !!DVA_GET_ASIZE(&(bp)->blk_dva[1]) + \
244 !!DVA_GET_ASIZE(&(bp)->blk_dva[2]))
246 #define BP_COUNT_GANG(bp) \
247 (DVA_GET_GANG(&(bp)->blk_dva[0]) + \
248 DVA_GET_GANG(&(bp)->blk_dva[1]) + \
249 DVA_GET_GANG(&(bp)->blk_dva[2]))
251 #define DVA_EQUAL(dva1, dva2) \
252 ((dva1)->dva_word[1] == (dva2)->dva_word[1] && \
253 (dva1)->dva_word[0] == (dva2)->dva_word[0])
255 #define ZIO_CHECKSUM_EQUAL(zc1, zc2) \
256 (0 == (((zc1).zc_word[0] - (zc2).zc_word[0]) | \
257 ((zc1).zc_word[1] - (zc2).zc_word[1]) | \
258 ((zc1).zc_word[2] - (zc2).zc_word[2]) | \
259 ((zc1).zc_word[3] - (zc2).zc_word[3])))
262 #define DVA_IS_VALID(dva) (DVA_GET_ASIZE(dva) != 0)
264 #define ZIO_SET_CHECKSUM(zcp, w0, w1, w2, w3) \
266 (zcp)->zc_word[0] = w0; \
267 (zcp)->zc_word[1] = w1; \
268 (zcp)->zc_word[2] = w2; \
269 (zcp)->zc_word[3] = w3; \
272 #define BP_IDENTITY(bp) (&(bp)->blk_dva[0])
273 #define BP_IS_GANG(bp) DVA_GET_GANG(BP_IDENTITY(bp))
274 #define BP_IS_HOLE(bp) ((bp)->blk_birth == 0)
275 #define BP_IS_OLDER(bp, txg) (!BP_IS_HOLE(bp) && (bp)->blk_birth < (txg))
277 #define BP_ZERO(bp) \
279 (bp)->blk_dva[0].dva_word[0] = 0; \
280 (bp)->blk_dva[0].dva_word[1] = 0; \
281 (bp)->blk_dva[1].dva_word[0] = 0; \
282 (bp)->blk_dva[1].dva_word[1] = 0; \
283 (bp)->blk_dva[2].dva_word[0] = 0; \
284 (bp)->blk_dva[2].dva_word[1] = 0; \
285 (bp)->blk_prop = 0; \
286 (bp)->blk_pad[0] = 0; \
287 (bp)->blk_pad[1] = 0; \
288 (bp)->blk_pad[2] = 0; \
289 (bp)->blk_birth = 0; \
290 (bp)->blk_fill = 0; \
291 ZIO_SET_CHECKSUM(&(bp)->blk_cksum, 0, 0, 0, 0); \
295 * Note: the byteorder is either 0 or -1, both of which are palindromes.
296 * This simplifies the endianness handling a bit.
298 #if BYTE_ORDER == _BIG_ENDIAN
299 #define ZFS_HOST_BYTEORDER (0ULL)
301 #define ZFS_HOST_BYTEORDER (-1ULL)
304 #define BP_SHOULD_BYTESWAP(bp) (BP_GET_BYTEORDER(bp) != ZFS_HOST_BYTEORDER)
306 #define BP_SPRINTF_LEN 320
310 #define BP_GET_BUFC_TYPE(bp) \
311 (((BP_GET_LEVEL(bp) > 0) || (dmu_ot[BP_GET_TYPE(bp)].ot_metadata)) ? \
312 ARC_BUFC_METADATA : ARC_BUFC_DATA);
314 * Routines found in spa.c
317 /* state manipulation functions */
318 extern int spa_open(const char *pool, spa_t **, void *tag);
319 extern int spa_get_stats(const char *pool, nvlist_t **config,
320 char *altroot, size_t buflen);
321 extern int spa_create(const char *pool, nvlist_t *config, const char *altroot);
322 extern int spa_import(const char *pool, nvlist_t *config, const char *altroot);
323 extern nvlist_t *spa_tryimport(nvlist_t *tryconfig);
324 extern int spa_destroy(char *pool);
325 extern int spa_export(char *pool, nvlist_t **oldconfig);
326 extern int spa_reset(char *pool);
327 extern void spa_async_request(spa_t *spa, int flag);
328 extern void spa_async_suspend(spa_t *spa);
329 extern void spa_async_resume(spa_t *spa);
330 extern spa_t *spa_inject_addref(char *pool);
331 extern void spa_inject_delref(spa_t *spa);
333 #define SPA_ASYNC_REOPEN 0x01
334 #define SPA_ASYNC_REPLACE_DONE 0x02
335 #define SPA_ASYNC_SCRUB 0x04
336 #define SPA_ASYNC_RESILVER 0x08
337 #define SPA_ASYNC_CONFIG_UPDATE 0x10
339 /* device manipulation */
340 extern int spa_vdev_add(spa_t *spa, nvlist_t *nvroot);
341 extern int spa_vdev_attach(spa_t *spa, uint64_t guid, nvlist_t *nvroot,
343 extern int spa_vdev_detach(spa_t *spa, uint64_t guid, int replace_done);
344 extern int spa_vdev_remove(spa_t *spa, uint64_t guid, boolean_t unspare);
345 extern int spa_vdev_setpath(spa_t *spa, uint64_t guid, const char *newpath);
347 /* spare state (which is global across all pools) */
348 extern void spa_spare_add(vdev_t *vd);
349 extern void spa_spare_remove(vdev_t *vd);
350 extern boolean_t spa_spare_exists(uint64_t guid, uint64_t *pool);
351 extern void spa_spare_activate(vdev_t *vd);
354 extern int spa_scrub(spa_t *spa, pool_scrub_type_t type, boolean_t force);
355 extern void spa_scrub_suspend(spa_t *spa);
356 extern void spa_scrub_resume(spa_t *spa);
357 extern void spa_scrub_restart(spa_t *spa, uint64_t txg);
360 extern void spa_sync(spa_t *spa, uint64_t txg); /* only for DMU use */
361 extern void spa_sync_allpools(void);
364 * SPA configuration functions in spa_config.c
367 #define SPA_CONFIG_UPDATE_POOL 0
368 #define SPA_CONFIG_UPDATE_VDEVS 1
370 extern void spa_config_sync(void);
371 extern void spa_config_load(void);
372 extern nvlist_t *spa_all_configs(uint64_t *);
373 extern void spa_config_set(spa_t *spa, nvlist_t *config);
374 extern nvlist_t *spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg,
376 extern void spa_config_update(spa_t *spa, int what);
379 * Miscellaneous SPA routines in spa_misc.c
382 /* Namespace manipulation */
383 extern spa_t *spa_lookup(const char *name);
384 extern spa_t *spa_add(const char *name, const char *altroot);
385 extern void spa_remove(spa_t *spa);
386 extern spa_t *spa_next(spa_t *prev);
388 /* Refcount functions */
389 extern void spa_open_ref(spa_t *spa, void *tag);
390 extern void spa_close(spa_t *spa, void *tag);
391 extern boolean_t spa_refcount_zero(spa_t *spa);
393 /* Pool configuration lock */
394 extern void spa_config_enter(spa_t *spa, krw_t rw, void *tag);
395 extern void spa_config_exit(spa_t *spa, void *tag);
396 extern boolean_t spa_config_held(spa_t *spa, krw_t rw);
398 /* Pool vdev add/remove lock */
399 extern uint64_t spa_vdev_enter(spa_t *spa);
400 extern int spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error);
402 /* Accessor functions */
403 extern krwlock_t *spa_traverse_rwlock(spa_t *spa);
404 extern int spa_traverse_wanted(spa_t *spa);
405 extern struct dsl_pool *spa_get_dsl(spa_t *spa);
406 extern blkptr_t *spa_get_rootblkptr(spa_t *spa);
407 extern void spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp);
408 extern void spa_altroot(spa_t *, char *, size_t);
409 extern int spa_sync_pass(spa_t *spa);
410 extern char *spa_name(spa_t *spa);
411 extern uint64_t spa_guid(spa_t *spa);
412 extern uint64_t spa_last_synced_txg(spa_t *spa);
413 extern uint64_t spa_first_txg(spa_t *spa);
414 extern uint64_t spa_version(spa_t *spa);
415 extern int spa_state(spa_t *spa);
416 extern uint64_t spa_freeze_txg(spa_t *spa);
417 struct metaslab_class;
418 extern struct metaslab_class *spa_metaslab_class_select(spa_t *spa);
419 extern uint64_t spa_get_alloc(spa_t *spa);
420 extern uint64_t spa_get_space(spa_t *spa);
421 extern uint64_t spa_get_dspace(spa_t *spa);
422 extern uint64_t spa_get_asize(spa_t *spa, uint64_t lsize);
423 extern uint64_t spa_version(spa_t *spa);
424 extern int spa_max_replication(spa_t *spa);
425 extern int spa_busy(void);
427 /* Miscellaneous support routines */
428 extern int spa_rename(const char *oldname, const char *newname);
429 extern boolean_t spa_guid_exists(uint64_t pool_guid, uint64_t device_guid);
430 extern char *spa_strdup(const char *);
431 extern void spa_strfree(char *);
432 extern uint64_t spa_get_random(uint64_t range);
433 extern void sprintf_blkptr(char *buf, int len, const blkptr_t *bp);
434 extern void spa_freeze(spa_t *spa);
435 extern void spa_upgrade(spa_t *spa);
436 extern void spa_evict_all(void);
437 extern vdev_t *spa_lookup_by_guid(spa_t *spa, uint64_t guid);
438 extern boolean_t spa_has_spare(spa_t *, uint64_t guid);
439 extern uint64_t bp_get_dasize(spa_t *spa, const blkptr_t *bp);
441 /* history logging */
442 extern void spa_history_create_obj(spa_t *spa, dmu_tx_t *tx);
443 extern int spa_history_get(spa_t *spa, uint64_t *offset, uint64_t *len_read,
445 extern int spa_history_log(spa_t *spa, const char *his_buf,
446 uint64_t pool_create);
451 extern void spa_log_error(spa_t *spa, struct zio *zio);
452 extern void zfs_ereport_post(const char *class, spa_t *spa, vdev_t *vd,
453 struct zio *zio, uint64_t stateoroffset, uint64_t length);
454 extern void zfs_post_ok(spa_t *spa, vdev_t *vd);
455 extern uint64_t spa_get_errlog_size(spa_t *spa);
456 extern int spa_get_errlog(spa_t *spa, void *uaddr, size_t *count);
457 extern void spa_errlog_rotate(spa_t *spa);
458 extern void spa_errlog_drain(spa_t *spa);
459 extern void spa_errlog_sync(spa_t *spa, uint64_t txg);
460 extern void spa_get_errlists(spa_t *spa, avl_tree_t *last, avl_tree_t *scrub);
462 /* Initialization and termination */
463 extern void spa_init(int flags);
464 extern void spa_fini(void);
467 extern int spa_set_props(spa_t *spa, nvlist_t *nvp);
468 extern int spa_get_props(spa_t *spa, nvlist_t **nvp);
469 extern void spa_clear_bootfs(spa_t *spa, uint64_t obj, dmu_tx_t *tx);
470 extern boolean_t spa_has_bootfs(spa_t *spa);
473 #define dprintf_bp(bp, fmt, ...) do { \
474 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
475 char *__blkbuf = kmem_alloc(BP_SPRINTF_LEN, KM_SLEEP); \
476 sprintf_blkptr(__blkbuf, BP_SPRINTF_LEN, (bp)); \
477 dprintf(fmt " %s\n", __VA_ARGS__, __blkbuf); \
478 kmem_free(__blkbuf, BP_SPRINTF_LEN); \
480 _NOTE(CONSTCOND) } while (0)
482 #define dprintf_bp(bp, fmt, ...)
485 extern int spa_mode; /* mode, e.g. FREAD | FWRITE */
491 #endif /* _SYS_SPA_H */