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, 2015 by Delphix. All rights reserved.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright 2013 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
26 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
27 * Copyright 2013 Saso Kiselkov. All rights reserved.
30 #include <sys/zfs_context.h>
31 #include <sys/spa_impl.h>
32 #include <sys/spa_boot.h>
34 #include <sys/zio_checksum.h>
35 #include <sys/zio_compress.h>
37 #include <sys/dmu_tx.h>
40 #include <sys/vdev_impl.h>
41 #include <sys/metaslab.h>
42 #include <sys/uberblock_impl.h>
45 #include <sys/unique.h>
46 #include <sys/dsl_pool.h>
47 #include <sys/dsl_dir.h>
48 #include <sys/dsl_prop.h>
49 #include <sys/dsl_scan.h>
50 #include <sys/fs/zfs.h>
51 #include <sys/metaslab_impl.h>
55 #include <sys/zfeature.h>
60 * There are four basic locks for managing spa_t structures:
62 * spa_namespace_lock (global mutex)
64 * This lock must be acquired to do any of the following:
66 * - Lookup a spa_t by name
67 * - Add or remove a spa_t from the namespace
68 * - Increase spa_refcount from non-zero
69 * - Check if spa_refcount is zero
71 * - add/remove/attach/detach devices
72 * - Held for the duration of create/destroy/import/export
74 * It does not need to handle recursion. A create or destroy may
75 * reference objects (files or zvols) in other pools, but by
76 * definition they must have an existing reference, and will never need
77 * to lookup a spa_t by name.
79 * spa_refcount (per-spa refcount_t protected by mutex)
81 * This reference count keep track of any active users of the spa_t. The
82 * spa_t cannot be destroyed or freed while this is non-zero. Internally,
83 * the refcount is never really 'zero' - opening a pool implicitly keeps
84 * some references in the DMU. Internally we check against spa_minref, but
85 * present the image of a zero/non-zero value to consumers.
87 * spa_config_lock[] (per-spa array of rwlocks)
89 * This protects the spa_t from config changes, and must be held in
90 * the following circumstances:
92 * - RW_READER to perform I/O to the spa
93 * - RW_WRITER to change the vdev config
95 * The locking order is fairly straightforward:
97 * spa_namespace_lock -> spa_refcount
99 * The namespace lock must be acquired to increase the refcount from 0
100 * or to check if it is zero.
102 * spa_refcount -> spa_config_lock[]
104 * There must be at least one valid reference on the spa_t to acquire
107 * spa_namespace_lock -> spa_config_lock[]
109 * The namespace lock must always be taken before the config lock.
112 * The spa_namespace_lock can be acquired directly and is globally visible.
114 * The namespace is manipulated using the following functions, all of which
115 * require the spa_namespace_lock to be held.
117 * spa_lookup() Lookup a spa_t by name.
119 * spa_add() Create a new spa_t in the namespace.
121 * spa_remove() Remove a spa_t from the namespace. This also
122 * frees up any memory associated with the spa_t.
124 * spa_next() Returns the next spa_t in the system, or the
125 * first if NULL is passed.
127 * spa_evict_all() Shutdown and remove all spa_t structures in
130 * spa_guid_exists() Determine whether a pool/device guid exists.
132 * The spa_refcount is manipulated using the following functions:
134 * spa_open_ref() Adds a reference to the given spa_t. Must be
135 * called with spa_namespace_lock held if the
136 * refcount is currently zero.
138 * spa_close() Remove a reference from the spa_t. This will
139 * not free the spa_t or remove it from the
140 * namespace. No locking is required.
142 * spa_refcount_zero() Returns true if the refcount is currently
143 * zero. Must be called with spa_namespace_lock
146 * The spa_config_lock[] is an array of rwlocks, ordered as follows:
147 * SCL_CONFIG > SCL_STATE > SCL_ALLOC > SCL_ZIO > SCL_FREE > SCL_VDEV.
148 * spa_config_lock[] is manipulated with spa_config_{enter,exit,held}().
150 * To read the configuration, it suffices to hold one of these locks as reader.
151 * To modify the configuration, you must hold all locks as writer. To modify
152 * vdev state without altering the vdev tree's topology (e.g. online/offline),
153 * you must hold SCL_STATE and SCL_ZIO as writer.
155 * We use these distinct config locks to avoid recursive lock entry.
156 * For example, spa_sync() (which holds SCL_CONFIG as reader) induces
157 * block allocations (SCL_ALLOC), which may require reading space maps
158 * from disk (dmu_read() -> zio_read() -> SCL_ZIO).
160 * The spa config locks cannot be normal rwlocks because we need the
161 * ability to hand off ownership. For example, SCL_ZIO is acquired
162 * by the issuing thread and later released by an interrupt thread.
163 * They do, however, obey the usual write-wanted semantics to prevent
164 * writer (i.e. system administrator) starvation.
166 * The lock acquisition rules are as follows:
169 * Protects changes to the vdev tree topology, such as vdev
170 * add/remove/attach/detach. Protects the dirty config list
171 * (spa_config_dirty_list) and the set of spares and l2arc devices.
174 * Protects changes to pool state and vdev state, such as vdev
175 * online/offline/fault/degrade/clear. Protects the dirty state list
176 * (spa_state_dirty_list) and global pool state (spa_state).
179 * Protects changes to metaslab groups and classes.
180 * Held as reader by metaslab_alloc() and metaslab_claim().
183 * Held by bp-level zios (those which have no io_vd upon entry)
184 * to prevent changes to the vdev tree. The bp-level zio implicitly
185 * protects all of its vdev child zios, which do not hold SCL_ZIO.
188 * Protects changes to metaslab groups and classes.
189 * Held as reader by metaslab_free(). SCL_FREE is distinct from
190 * SCL_ALLOC, and lower than SCL_ZIO, so that we can safely free
191 * blocks in zio_done() while another i/o that holds either
192 * SCL_ALLOC or SCL_ZIO is waiting for this i/o to complete.
195 * Held as reader to prevent changes to the vdev tree during trivial
196 * inquiries such as bp_get_dsize(). SCL_VDEV is distinct from the
197 * other locks, and lower than all of them, to ensure that it's safe
198 * to acquire regardless of caller context.
200 * In addition, the following rules apply:
202 * (a) spa_props_lock protects pool properties, spa_config and spa_config_list.
203 * The lock ordering is SCL_CONFIG > spa_props_lock.
205 * (b) I/O operations on leaf vdevs. For any zio operation that takes
206 * an explicit vdev_t argument -- such as zio_ioctl(), zio_read_phys(),
207 * or zio_write_phys() -- the caller must ensure that the config cannot
208 * cannot change in the interim, and that the vdev cannot be reopened.
209 * SCL_STATE as reader suffices for both.
211 * The vdev configuration is protected by spa_vdev_enter() / spa_vdev_exit().
213 * spa_vdev_enter() Acquire the namespace lock and the config lock
216 * spa_vdev_exit() Release the config lock, wait for all I/O
217 * to complete, sync the updated configs to the
218 * cache, and release the namespace lock.
220 * vdev state is protected by spa_vdev_state_enter() / spa_vdev_state_exit().
221 * Like spa_vdev_enter/exit, these are convenience wrappers -- the actual
222 * locking is, always, based on spa_namespace_lock and spa_config_lock[].
224 * spa_rename() is also implemented within this file since it requires
225 * manipulation of the namespace.
228 static avl_tree_t spa_namespace_avl;
229 kmutex_t spa_namespace_lock;
230 static kcondvar_t spa_namespace_cv;
231 static int spa_active_count;
232 int spa_max_replication_override = SPA_DVAS_PER_BP;
234 static kmutex_t spa_spare_lock;
235 static avl_tree_t spa_spare_avl;
236 static kmutex_t spa_l2cache_lock;
237 static avl_tree_t spa_l2cache_avl;
239 kmem_cache_t *spa_buffer_pool;
243 /* Everything except dprintf and spa is on by default in debug builds */
244 int zfs_flags = ~(ZFS_DEBUG_DPRINTF | ZFS_DEBUG_SPA);
249 TUNABLE_INT("debug.zfs_flags", &zfs_flags);
250 SYSCTL_INT(_debug, OID_AUTO, zfs_flags, CTLFLAG_RWTUN, &zfs_flags, 0,
254 * zfs_recover can be set to nonzero to attempt to recover from
255 * otherwise-fatal errors, typically caused by on-disk corruption. When
256 * set, calls to zfs_panic_recover() will turn into warning messages.
257 * This should only be used as a last resort, as it typically results
258 * in leaked space, or worse.
260 boolean_t zfs_recover = B_FALSE;
261 SYSCTL_DECL(_vfs_zfs);
262 TUNABLE_INT("vfs.zfs.recover", &zfs_recover);
263 SYSCTL_INT(_vfs_zfs, OID_AUTO, recover, CTLFLAG_RWTUN, &zfs_recover, 0,
264 "Try to recover from otherwise-fatal errors.");
267 * If destroy encounters an EIO while reading metadata (e.g. indirect
268 * blocks), space referenced by the missing metadata can not be freed.
269 * Normally this causes the background destroy to become "stalled", as
270 * it is unable to make forward progress. While in this stalled state,
271 * all remaining space to free from the error-encountering filesystem is
272 * "temporarily leaked". Set this flag to cause it to ignore the EIO,
273 * permanently leak the space from indirect blocks that can not be read,
274 * and continue to free everything else that it can.
276 * The default, "stalling" behavior is useful if the storage partially
277 * fails (i.e. some but not all i/os fail), and then later recovers. In
278 * this case, we will be able to continue pool operations while it is
279 * partially failed, and when it recovers, we can continue to free the
280 * space, with no leaks. However, note that this case is actually
283 * Typically pools either (a) fail completely (but perhaps temporarily,
284 * e.g. a top-level vdev going offline), or (b) have localized,
285 * permanent errors (e.g. disk returns the wrong data due to bit flip or
286 * firmware bug). In case (a), this setting does not matter because the
287 * pool will be suspended and the sync thread will not be able to make
288 * forward progress regardless. In case (b), because the error is
289 * permanent, the best we can do is leak the minimum amount of space,
290 * which is what setting this flag will do. Therefore, it is reasonable
291 * for this flag to normally be set, but we chose the more conservative
292 * approach of not setting it, so that there is no possibility of
293 * leaking space in the "partial temporary" failure case.
295 boolean_t zfs_free_leak_on_eio = B_FALSE;
298 * Expiration time in milliseconds. This value has two meanings. First it is
299 * used to determine when the spa_deadman() logic should fire. By default the
300 * spa_deadman() will fire if spa_sync() has not completed in 1000 seconds.
301 * Secondly, the value determines if an I/O is considered "hung". Any I/O that
302 * has not completed in zfs_deadman_synctime_ms is considered "hung" resulting
305 uint64_t zfs_deadman_synctime_ms = 1000000ULL;
306 TUNABLE_QUAD("vfs.zfs.deadman_synctime_ms", &zfs_deadman_synctime_ms);
307 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, deadman_synctime_ms, CTLFLAG_RDTUN,
308 &zfs_deadman_synctime_ms, 0,
309 "Stalled ZFS I/O expiration time in milliseconds");
312 * Check time in milliseconds. This defines the frequency at which we check
315 uint64_t zfs_deadman_checktime_ms = 5000ULL;
316 TUNABLE_QUAD("vfs.zfs.deadman_checktime_ms", &zfs_deadman_checktime_ms);
317 SYSCTL_UQUAD(_vfs_zfs, OID_AUTO, deadman_checktime_ms, CTLFLAG_RDTUN,
318 &zfs_deadman_checktime_ms, 0,
319 "Period of checks for stalled ZFS I/O in milliseconds");
322 * Default value of -1 for zfs_deadman_enabled is resolved in
325 int zfs_deadman_enabled = -1;
326 TUNABLE_INT("vfs.zfs.deadman_enabled", &zfs_deadman_enabled);
327 SYSCTL_INT(_vfs_zfs, OID_AUTO, deadman_enabled, CTLFLAG_RDTUN,
328 &zfs_deadman_enabled, 0, "Kernel panic on stalled ZFS I/O");
331 * The worst case is single-sector max-parity RAID-Z blocks, in which
332 * case the space requirement is exactly (VDEV_RAIDZ_MAXPARITY + 1)
333 * times the size; so just assume that. Add to this the fact that
334 * we can have up to 3 DVAs per bp, and one more factor of 2 because
335 * the block may be dittoed with up to 3 DVAs by ddt_sync(). All together,
337 * (VDEV_RAIDZ_MAXPARITY + 1) * SPA_DVAS_PER_BP * 2 == 24
339 int spa_asize_inflation = 24;
340 TUNABLE_INT("vfs.zfs.spa_asize_inflation", &spa_asize_inflation);
341 SYSCTL_INT(_vfs_zfs, OID_AUTO, spa_asize_inflation, CTLFLAG_RWTUN,
342 &spa_asize_inflation, 0, "Worst case inflation factor for single sector writes");
350 * If we are not i386 or amd64 or in a virtual machine,
351 * disable ZFS deadman thread by default
353 if (zfs_deadman_enabled == -1) {
354 #if defined(__amd64__) || defined(__i386__)
355 zfs_deadman_enabled = (vm_guest == VM_GUEST_NO) ? 1 : 0;
357 zfs_deadman_enabled = 0;
362 #endif /* !illumos */
365 * Normally, we don't allow the last 3.2% (1/(2^spa_slop_shift)) of space in
366 * the pool to be consumed. This ensures that we don't run the pool
367 * completely out of space, due to unaccounted changes (e.g. to the MOS).
368 * It also limits the worst-case time to allocate space. If we have
369 * less than this amount of free space, most ZPL operations (e.g. write,
370 * create) will return ENOSPC.
372 * Certain operations (e.g. file removal, most administrative actions) can
373 * use half the slop space. They will only return ENOSPC if less than half
374 * the slop space is free. Typically, once the pool has less than the slop
375 * space free, the user will use these operations to free up space in the pool.
376 * These are the operations that call dsl_pool_adjustedsize() with the netfree
377 * argument set to TRUE.
379 * A very restricted set of operations are always permitted, regardless of
380 * the amount of free space. These are the operations that call
381 * dsl_sync_task(ZFS_SPACE_CHECK_NONE), e.g. "zfs destroy". If these
382 * operations result in a net increase in the amount of space used,
383 * it is possible to run the pool completely out of space, causing it to
384 * be permanently read-only.
386 * See also the comments in zfs_space_check_t.
388 int spa_slop_shift = 5;
389 SYSCTL_INT(_vfs_zfs, OID_AUTO, spa_slop_shift, CTLFLAG_RWTUN,
391 "Shift value of reserved space (1/(2^spa_slop_shift)).");
394 * ==========================================================================
396 * ==========================================================================
399 spa_config_lock_init(spa_t *spa)
401 for (int i = 0; i < SCL_LOCKS; i++) {
402 spa_config_lock_t *scl = &spa->spa_config_lock[i];
403 mutex_init(&scl->scl_lock, NULL, MUTEX_DEFAULT, NULL);
404 cv_init(&scl->scl_cv, NULL, CV_DEFAULT, NULL);
405 refcount_create_untracked(&scl->scl_count);
406 scl->scl_writer = NULL;
407 scl->scl_write_wanted = 0;
412 spa_config_lock_destroy(spa_t *spa)
414 for (int i = 0; i < SCL_LOCKS; i++) {
415 spa_config_lock_t *scl = &spa->spa_config_lock[i];
416 mutex_destroy(&scl->scl_lock);
417 cv_destroy(&scl->scl_cv);
418 refcount_destroy(&scl->scl_count);
419 ASSERT(scl->scl_writer == NULL);
420 ASSERT(scl->scl_write_wanted == 0);
425 spa_config_tryenter(spa_t *spa, int locks, void *tag, krw_t rw)
427 for (int i = 0; i < SCL_LOCKS; i++) {
428 spa_config_lock_t *scl = &spa->spa_config_lock[i];
429 if (!(locks & (1 << i)))
431 mutex_enter(&scl->scl_lock);
432 if (rw == RW_READER) {
433 if (scl->scl_writer || scl->scl_write_wanted) {
434 mutex_exit(&scl->scl_lock);
435 spa_config_exit(spa, locks ^ (1 << i), tag);
439 ASSERT(scl->scl_writer != curthread);
440 if (!refcount_is_zero(&scl->scl_count)) {
441 mutex_exit(&scl->scl_lock);
442 spa_config_exit(spa, locks ^ (1 << i), tag);
445 scl->scl_writer = curthread;
447 (void) refcount_add(&scl->scl_count, tag);
448 mutex_exit(&scl->scl_lock);
454 spa_config_enter(spa_t *spa, int locks, void *tag, krw_t rw)
458 ASSERT3U(SCL_LOCKS, <, sizeof (wlocks_held) * NBBY);
460 for (int i = 0; i < SCL_LOCKS; i++) {
461 spa_config_lock_t *scl = &spa->spa_config_lock[i];
462 if (scl->scl_writer == curthread)
463 wlocks_held |= (1 << i);
464 if (!(locks & (1 << i)))
466 mutex_enter(&scl->scl_lock);
467 if (rw == RW_READER) {
468 while (scl->scl_writer || scl->scl_write_wanted) {
469 cv_wait(&scl->scl_cv, &scl->scl_lock);
472 ASSERT(scl->scl_writer != curthread);
473 while (!refcount_is_zero(&scl->scl_count)) {
474 scl->scl_write_wanted++;
475 cv_wait(&scl->scl_cv, &scl->scl_lock);
476 scl->scl_write_wanted--;
478 scl->scl_writer = curthread;
480 (void) refcount_add(&scl->scl_count, tag);
481 mutex_exit(&scl->scl_lock);
483 ASSERT(wlocks_held <= locks);
487 spa_config_exit(spa_t *spa, int locks, void *tag)
489 for (int i = SCL_LOCKS - 1; i >= 0; i--) {
490 spa_config_lock_t *scl = &spa->spa_config_lock[i];
491 if (!(locks & (1 << i)))
493 mutex_enter(&scl->scl_lock);
494 ASSERT(!refcount_is_zero(&scl->scl_count));
495 if (refcount_remove(&scl->scl_count, tag) == 0) {
496 ASSERT(scl->scl_writer == NULL ||
497 scl->scl_writer == curthread);
498 scl->scl_writer = NULL; /* OK in either case */
499 cv_broadcast(&scl->scl_cv);
501 mutex_exit(&scl->scl_lock);
506 spa_config_held(spa_t *spa, int locks, krw_t rw)
510 for (int i = 0; i < SCL_LOCKS; i++) {
511 spa_config_lock_t *scl = &spa->spa_config_lock[i];
512 if (!(locks & (1 << i)))
514 if ((rw == RW_READER && !refcount_is_zero(&scl->scl_count)) ||
515 (rw == RW_WRITER && scl->scl_writer == curthread))
516 locks_held |= 1 << i;
523 * ==========================================================================
524 * SPA namespace functions
525 * ==========================================================================
529 * Lookup the named spa_t in the AVL tree. The spa_namespace_lock must be held.
530 * Returns NULL if no matching spa_t is found.
533 spa_lookup(const char *name)
535 static spa_t search; /* spa_t is large; don't allocate on stack */
540 ASSERT(MUTEX_HELD(&spa_namespace_lock));
542 (void) strlcpy(search.spa_name, name, sizeof (search.spa_name));
545 * If it's a full dataset name, figure out the pool name and
548 cp = strpbrk(search.spa_name, "/@#");
552 spa = avl_find(&spa_namespace_avl, &search, &where);
558 * Fires when spa_sync has not completed within zfs_deadman_synctime_ms.
559 * If the zfs_deadman_enabled flag is set then it inspects all vdev queues
560 * looking for potentially hung I/Os.
563 spa_deadman(void *arg)
568 * Disable the deadman timer if the pool is suspended.
570 if (spa_suspended(spa)) {
572 VERIFY(cyclic_reprogram(spa->spa_deadman_cycid, CY_INFINITY));
574 /* Nothing. just don't schedule any future callouts. */
579 zfs_dbgmsg("slow spa_sync: started %llu seconds ago, calls %llu",
580 (gethrtime() - spa->spa_sync_starttime) / NANOSEC,
581 ++spa->spa_deadman_calls);
582 if (zfs_deadman_enabled)
583 vdev_deadman(spa->spa_root_vdev);
587 * Create an uninitialized spa_t with the given name. Requires
588 * spa_namespace_lock. The caller must ensure that the spa_t doesn't already
589 * exist by calling spa_lookup() first.
592 spa_add(const char *name, nvlist_t *config, const char *altroot)
595 spa_config_dirent_t *dp;
601 ASSERT(MUTEX_HELD(&spa_namespace_lock));
603 spa = kmem_zalloc(sizeof (spa_t), KM_SLEEP);
605 mutex_init(&spa->spa_async_lock, NULL, MUTEX_DEFAULT, NULL);
606 mutex_init(&spa->spa_errlist_lock, NULL, MUTEX_DEFAULT, NULL);
607 mutex_init(&spa->spa_errlog_lock, NULL, MUTEX_DEFAULT, NULL);
608 mutex_init(&spa->spa_evicting_os_lock, NULL, MUTEX_DEFAULT, NULL);
609 mutex_init(&spa->spa_history_lock, NULL, MUTEX_DEFAULT, NULL);
610 mutex_init(&spa->spa_proc_lock, NULL, MUTEX_DEFAULT, NULL);
611 mutex_init(&spa->spa_props_lock, NULL, MUTEX_DEFAULT, NULL);
612 mutex_init(&spa->spa_cksum_tmpls_lock, NULL, MUTEX_DEFAULT, NULL);
613 mutex_init(&spa->spa_scrub_lock, NULL, MUTEX_DEFAULT, NULL);
614 mutex_init(&spa->spa_suspend_lock, NULL, MUTEX_DEFAULT, NULL);
615 mutex_init(&spa->spa_vdev_top_lock, NULL, MUTEX_DEFAULT, NULL);
617 cv_init(&spa->spa_async_cv, NULL, CV_DEFAULT, NULL);
618 cv_init(&spa->spa_evicting_os_cv, NULL, CV_DEFAULT, NULL);
619 cv_init(&spa->spa_proc_cv, NULL, CV_DEFAULT, NULL);
620 cv_init(&spa->spa_scrub_io_cv, NULL, CV_DEFAULT, NULL);
621 cv_init(&spa->spa_suspend_cv, NULL, CV_DEFAULT, NULL);
623 for (int t = 0; t < TXG_SIZE; t++)
624 bplist_create(&spa->spa_free_bplist[t]);
626 (void) strlcpy(spa->spa_name, name, sizeof (spa->spa_name));
627 spa->spa_state = POOL_STATE_UNINITIALIZED;
628 spa->spa_freeze_txg = UINT64_MAX;
629 spa->spa_final_txg = UINT64_MAX;
630 spa->spa_load_max_txg = UINT64_MAX;
632 spa->spa_proc_state = SPA_PROC_NONE;
635 hdlr.cyh_func = spa_deadman;
637 hdlr.cyh_level = CY_LOW_LEVEL;
640 spa->spa_deadman_synctime = MSEC2NSEC(zfs_deadman_synctime_ms);
644 * This determines how often we need to check for hung I/Os after
645 * the cyclic has already fired. Since checking for hung I/Os is
646 * an expensive operation we don't want to check too frequently.
647 * Instead wait for 5 seconds before checking again.
649 when.cyt_interval = MSEC2NSEC(zfs_deadman_checktime_ms);
650 when.cyt_when = CY_INFINITY;
651 mutex_enter(&cpu_lock);
652 spa->spa_deadman_cycid = cyclic_add(&hdlr, &when);
653 mutex_exit(&cpu_lock);
656 callout_init(&spa->spa_deadman_cycid, CALLOUT_MPSAFE);
659 refcount_create(&spa->spa_refcount);
660 spa_config_lock_init(spa);
662 avl_add(&spa_namespace_avl, spa);
665 * Set the alternate root, if there is one.
668 spa->spa_root = spa_strdup(altroot);
673 * Every pool starts with the default cachefile
675 list_create(&spa->spa_config_list, sizeof (spa_config_dirent_t),
676 offsetof(spa_config_dirent_t, scd_link));
678 dp = kmem_zalloc(sizeof (spa_config_dirent_t), KM_SLEEP);
679 dp->scd_path = altroot ? NULL : spa_strdup(spa_config_path);
680 list_insert_head(&spa->spa_config_list, dp);
682 VERIFY(nvlist_alloc(&spa->spa_load_info, NV_UNIQUE_NAME,
685 if (config != NULL) {
688 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_FEATURES_FOR_READ,
690 VERIFY(nvlist_dup(features, &spa->spa_label_features,
694 VERIFY(nvlist_dup(config, &spa->spa_config, 0) == 0);
697 if (spa->spa_label_features == NULL) {
698 VERIFY(nvlist_alloc(&spa->spa_label_features, NV_UNIQUE_NAME,
702 spa->spa_debug = ((zfs_flags & ZFS_DEBUG_SPA) != 0);
704 spa->spa_min_ashift = INT_MAX;
705 spa->spa_max_ashift = 0;
708 * As a pool is being created, treat all features as disabled by
709 * setting SPA_FEATURE_DISABLED for all entries in the feature
712 for (int i = 0; i < SPA_FEATURES; i++) {
713 spa->spa_feat_refcount_cache[i] = SPA_FEATURE_DISABLED;
720 * Removes a spa_t from the namespace, freeing up any memory used. Requires
721 * spa_namespace_lock. This is called only after the spa_t has been closed and
725 spa_remove(spa_t *spa)
727 spa_config_dirent_t *dp;
729 ASSERT(MUTEX_HELD(&spa_namespace_lock));
730 ASSERT(spa->spa_state == POOL_STATE_UNINITIALIZED);
731 ASSERT3U(refcount_count(&spa->spa_refcount), ==, 0);
733 nvlist_free(spa->spa_config_splitting);
735 avl_remove(&spa_namespace_avl, spa);
736 cv_broadcast(&spa_namespace_cv);
739 spa_strfree(spa->spa_root);
743 while ((dp = list_head(&spa->spa_config_list)) != NULL) {
744 list_remove(&spa->spa_config_list, dp);
745 if (dp->scd_path != NULL)
746 spa_strfree(dp->scd_path);
747 kmem_free(dp, sizeof (spa_config_dirent_t));
750 list_destroy(&spa->spa_config_list);
752 nvlist_free(spa->spa_label_features);
753 nvlist_free(spa->spa_load_info);
754 spa_config_set(spa, NULL);
757 mutex_enter(&cpu_lock);
758 if (spa->spa_deadman_cycid != CYCLIC_NONE)
759 cyclic_remove(spa->spa_deadman_cycid);
760 mutex_exit(&cpu_lock);
761 spa->spa_deadman_cycid = CYCLIC_NONE;
764 callout_drain(&spa->spa_deadman_cycid);
768 refcount_destroy(&spa->spa_refcount);
770 spa_config_lock_destroy(spa);
772 for (int t = 0; t < TXG_SIZE; t++)
773 bplist_destroy(&spa->spa_free_bplist[t]);
775 zio_checksum_templates_free(spa);
777 cv_destroy(&spa->spa_async_cv);
778 cv_destroy(&spa->spa_evicting_os_cv);
779 cv_destroy(&spa->spa_proc_cv);
780 cv_destroy(&spa->spa_scrub_io_cv);
781 cv_destroy(&spa->spa_suspend_cv);
783 mutex_destroy(&spa->spa_async_lock);
784 mutex_destroy(&spa->spa_errlist_lock);
785 mutex_destroy(&spa->spa_errlog_lock);
786 mutex_destroy(&spa->spa_evicting_os_lock);
787 mutex_destroy(&spa->spa_history_lock);
788 mutex_destroy(&spa->spa_proc_lock);
789 mutex_destroy(&spa->spa_props_lock);
790 mutex_destroy(&spa->spa_cksum_tmpls_lock);
791 mutex_destroy(&spa->spa_scrub_lock);
792 mutex_destroy(&spa->spa_suspend_lock);
793 mutex_destroy(&spa->spa_vdev_top_lock);
795 kmem_free(spa, sizeof (spa_t));
799 * Given a pool, return the next pool in the namespace, or NULL if there is
800 * none. If 'prev' is NULL, return the first pool.
803 spa_next(spa_t *prev)
805 ASSERT(MUTEX_HELD(&spa_namespace_lock));
808 return (AVL_NEXT(&spa_namespace_avl, prev));
810 return (avl_first(&spa_namespace_avl));
814 * ==========================================================================
815 * SPA refcount functions
816 * ==========================================================================
820 * Add a reference to the given spa_t. Must have at least one reference, or
821 * have the namespace lock held.
824 spa_open_ref(spa_t *spa, void *tag)
826 ASSERT(refcount_count(&spa->spa_refcount) >= spa->spa_minref ||
827 MUTEX_HELD(&spa_namespace_lock));
828 (void) refcount_add(&spa->spa_refcount, tag);
832 * Remove a reference to the given spa_t. Must have at least one reference, or
833 * have the namespace lock held.
836 spa_close(spa_t *spa, void *tag)
838 ASSERT(refcount_count(&spa->spa_refcount) > spa->spa_minref ||
839 MUTEX_HELD(&spa_namespace_lock));
840 (void) refcount_remove(&spa->spa_refcount, tag);
844 * Remove a reference to the given spa_t held by a dsl dir that is
845 * being asynchronously released. Async releases occur from a taskq
846 * performing eviction of dsl datasets and dirs. The namespace lock
847 * isn't held and the hold by the object being evicted may contribute to
848 * spa_minref (e.g. dataset or directory released during pool export),
849 * so the asserts in spa_close() do not apply.
852 spa_async_close(spa_t *spa, void *tag)
854 (void) refcount_remove(&spa->spa_refcount, tag);
858 * Check to see if the spa refcount is zero. Must be called with
859 * spa_namespace_lock held. We really compare against spa_minref, which is the
860 * number of references acquired when opening a pool
863 spa_refcount_zero(spa_t *spa)
865 ASSERT(MUTEX_HELD(&spa_namespace_lock));
867 return (refcount_count(&spa->spa_refcount) == spa->spa_minref);
871 * ==========================================================================
872 * SPA spare and l2cache tracking
873 * ==========================================================================
877 * Hot spares and cache devices are tracked using the same code below,
878 * for 'auxiliary' devices.
881 typedef struct spa_aux {
889 spa_aux_compare(const void *a, const void *b)
891 const spa_aux_t *sa = a;
892 const spa_aux_t *sb = b;
894 if (sa->aux_guid < sb->aux_guid)
896 else if (sa->aux_guid > sb->aux_guid)
903 spa_aux_add(vdev_t *vd, avl_tree_t *avl)
909 search.aux_guid = vd->vdev_guid;
910 if ((aux = avl_find(avl, &search, &where)) != NULL) {
913 aux = kmem_zalloc(sizeof (spa_aux_t), KM_SLEEP);
914 aux->aux_guid = vd->vdev_guid;
916 avl_insert(avl, aux, where);
921 spa_aux_remove(vdev_t *vd, avl_tree_t *avl)
927 search.aux_guid = vd->vdev_guid;
928 aux = avl_find(avl, &search, &where);
932 if (--aux->aux_count == 0) {
933 avl_remove(avl, aux);
934 kmem_free(aux, sizeof (spa_aux_t));
935 } else if (aux->aux_pool == spa_guid(vd->vdev_spa)) {
936 aux->aux_pool = 0ULL;
941 spa_aux_exists(uint64_t guid, uint64_t *pool, int *refcnt, avl_tree_t *avl)
943 spa_aux_t search, *found;
945 search.aux_guid = guid;
946 found = avl_find(avl, &search, NULL);
950 *pool = found->aux_pool;
957 *refcnt = found->aux_count;
962 return (found != NULL);
966 spa_aux_activate(vdev_t *vd, avl_tree_t *avl)
968 spa_aux_t search, *found;
971 search.aux_guid = vd->vdev_guid;
972 found = avl_find(avl, &search, &where);
973 ASSERT(found != NULL);
974 ASSERT(found->aux_pool == 0ULL);
976 found->aux_pool = spa_guid(vd->vdev_spa);
980 * Spares are tracked globally due to the following constraints:
982 * - A spare may be part of multiple pools.
983 * - A spare may be added to a pool even if it's actively in use within
985 * - A spare in use in any pool can only be the source of a replacement if
986 * the target is a spare in the same pool.
988 * We keep track of all spares on the system through the use of a reference
989 * counted AVL tree. When a vdev is added as a spare, or used as a replacement
990 * spare, then we bump the reference count in the AVL tree. In addition, we set
991 * the 'vdev_isspare' member to indicate that the device is a spare (active or
992 * inactive). When a spare is made active (used to replace a device in the
993 * pool), we also keep track of which pool its been made a part of.
995 * The 'spa_spare_lock' protects the AVL tree. These functions are normally
996 * called under the spa_namespace lock as part of vdev reconfiguration. The
997 * separate spare lock exists for the status query path, which does not need to
998 * be completely consistent with respect to other vdev configuration changes.
1002 spa_spare_compare(const void *a, const void *b)
1004 return (spa_aux_compare(a, b));
1008 spa_spare_add(vdev_t *vd)
1010 mutex_enter(&spa_spare_lock);
1011 ASSERT(!vd->vdev_isspare);
1012 spa_aux_add(vd, &spa_spare_avl);
1013 vd->vdev_isspare = B_TRUE;
1014 mutex_exit(&spa_spare_lock);
1018 spa_spare_remove(vdev_t *vd)
1020 mutex_enter(&spa_spare_lock);
1021 ASSERT(vd->vdev_isspare);
1022 spa_aux_remove(vd, &spa_spare_avl);
1023 vd->vdev_isspare = B_FALSE;
1024 mutex_exit(&spa_spare_lock);
1028 spa_spare_exists(uint64_t guid, uint64_t *pool, int *refcnt)
1032 mutex_enter(&spa_spare_lock);
1033 found = spa_aux_exists(guid, pool, refcnt, &spa_spare_avl);
1034 mutex_exit(&spa_spare_lock);
1040 spa_spare_activate(vdev_t *vd)
1042 mutex_enter(&spa_spare_lock);
1043 ASSERT(vd->vdev_isspare);
1044 spa_aux_activate(vd, &spa_spare_avl);
1045 mutex_exit(&spa_spare_lock);
1049 * Level 2 ARC devices are tracked globally for the same reasons as spares.
1050 * Cache devices currently only support one pool per cache device, and so
1051 * for these devices the aux reference count is currently unused beyond 1.
1055 spa_l2cache_compare(const void *a, const void *b)
1057 return (spa_aux_compare(a, b));
1061 spa_l2cache_add(vdev_t *vd)
1063 mutex_enter(&spa_l2cache_lock);
1064 ASSERT(!vd->vdev_isl2cache);
1065 spa_aux_add(vd, &spa_l2cache_avl);
1066 vd->vdev_isl2cache = B_TRUE;
1067 mutex_exit(&spa_l2cache_lock);
1071 spa_l2cache_remove(vdev_t *vd)
1073 mutex_enter(&spa_l2cache_lock);
1074 ASSERT(vd->vdev_isl2cache);
1075 spa_aux_remove(vd, &spa_l2cache_avl);
1076 vd->vdev_isl2cache = B_FALSE;
1077 mutex_exit(&spa_l2cache_lock);
1081 spa_l2cache_exists(uint64_t guid, uint64_t *pool)
1085 mutex_enter(&spa_l2cache_lock);
1086 found = spa_aux_exists(guid, pool, NULL, &spa_l2cache_avl);
1087 mutex_exit(&spa_l2cache_lock);
1093 spa_l2cache_activate(vdev_t *vd)
1095 mutex_enter(&spa_l2cache_lock);
1096 ASSERT(vd->vdev_isl2cache);
1097 spa_aux_activate(vd, &spa_l2cache_avl);
1098 mutex_exit(&spa_l2cache_lock);
1102 * ==========================================================================
1104 * ==========================================================================
1108 * Lock the given spa_t for the purpose of adding or removing a vdev.
1109 * Grabs the global spa_namespace_lock plus the spa config lock for writing.
1110 * It returns the next transaction group for the spa_t.
1113 spa_vdev_enter(spa_t *spa)
1115 mutex_enter(&spa->spa_vdev_top_lock);
1116 mutex_enter(&spa_namespace_lock);
1117 return (spa_vdev_config_enter(spa));
1121 * Internal implementation for spa_vdev_enter(). Used when a vdev
1122 * operation requires multiple syncs (i.e. removing a device) while
1123 * keeping the spa_namespace_lock held.
1126 spa_vdev_config_enter(spa_t *spa)
1128 ASSERT(MUTEX_HELD(&spa_namespace_lock));
1130 spa_config_enter(spa, SCL_ALL, spa, RW_WRITER);
1132 return (spa_last_synced_txg(spa) + 1);
1136 * Used in combination with spa_vdev_config_enter() to allow the syncing
1137 * of multiple transactions without releasing the spa_namespace_lock.
1140 spa_vdev_config_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error, char *tag)
1142 ASSERT(MUTEX_HELD(&spa_namespace_lock));
1144 int config_changed = B_FALSE;
1146 ASSERT(txg > spa_last_synced_txg(spa));
1148 spa->spa_pending_vdev = NULL;
1151 * Reassess the DTLs.
1153 vdev_dtl_reassess(spa->spa_root_vdev, 0, 0, B_FALSE);
1155 if (error == 0 && !list_is_empty(&spa->spa_config_dirty_list)) {
1156 config_changed = B_TRUE;
1157 spa->spa_config_generation++;
1161 * Verify the metaslab classes.
1163 ASSERT(metaslab_class_validate(spa_normal_class(spa)) == 0);
1164 ASSERT(metaslab_class_validate(spa_log_class(spa)) == 0);
1166 spa_config_exit(spa, SCL_ALL, spa);
1169 * Panic the system if the specified tag requires it. This
1170 * is useful for ensuring that configurations are updated
1173 if (zio_injection_enabled)
1174 zio_handle_panic_injection(spa, tag, 0);
1177 * Note: this txg_wait_synced() is important because it ensures
1178 * that there won't be more than one config change per txg.
1179 * This allows us to use the txg as the generation number.
1182 txg_wait_synced(spa->spa_dsl_pool, txg);
1185 ASSERT(!vd->vdev_detached || vd->vdev_dtl_sm == NULL);
1186 spa_config_enter(spa, SCL_ALL, spa, RW_WRITER);
1188 spa_config_exit(spa, SCL_ALL, spa);
1192 * If the config changed, update the config cache.
1195 spa_config_sync(spa, B_FALSE, B_TRUE);
1199 * Unlock the spa_t after adding or removing a vdev. Besides undoing the
1200 * locking of spa_vdev_enter(), we also want make sure the transactions have
1201 * synced to disk, and then update the global configuration cache with the new
1205 spa_vdev_exit(spa_t *spa, vdev_t *vd, uint64_t txg, int error)
1207 spa_vdev_config_exit(spa, vd, txg, error, FTAG);
1208 mutex_exit(&spa_namespace_lock);
1209 mutex_exit(&spa->spa_vdev_top_lock);
1215 * Lock the given spa_t for the purpose of changing vdev state.
1218 spa_vdev_state_enter(spa_t *spa, int oplocks)
1220 int locks = SCL_STATE_ALL | oplocks;
1223 * Root pools may need to read of the underlying devfs filesystem
1224 * when opening up a vdev. Unfortunately if we're holding the
1225 * SCL_ZIO lock it will result in a deadlock when we try to issue
1226 * the read from the root filesystem. Instead we "prefetch"
1227 * the associated vnodes that we need prior to opening the
1228 * underlying devices and cache them so that we can prevent
1229 * any I/O when we are doing the actual open.
1231 if (spa_is_root(spa)) {
1232 int low = locks & ~(SCL_ZIO - 1);
1233 int high = locks & ~low;
1235 spa_config_enter(spa, high, spa, RW_WRITER);
1236 vdev_hold(spa->spa_root_vdev);
1237 spa_config_enter(spa, low, spa, RW_WRITER);
1239 spa_config_enter(spa, locks, spa, RW_WRITER);
1241 spa->spa_vdev_locks = locks;
1245 spa_vdev_state_exit(spa_t *spa, vdev_t *vd, int error)
1247 boolean_t config_changed = B_FALSE;
1249 if (vd != NULL || error == 0)
1250 vdev_dtl_reassess(vd ? vd->vdev_top : spa->spa_root_vdev,
1254 vdev_state_dirty(vd->vdev_top);
1255 config_changed = B_TRUE;
1256 spa->spa_config_generation++;
1259 if (spa_is_root(spa))
1260 vdev_rele(spa->spa_root_vdev);
1262 ASSERT3U(spa->spa_vdev_locks, >=, SCL_STATE_ALL);
1263 spa_config_exit(spa, spa->spa_vdev_locks, spa);
1266 * If anything changed, wait for it to sync. This ensures that,
1267 * from the system administrator's perspective, zpool(1M) commands
1268 * are synchronous. This is important for things like zpool offline:
1269 * when the command completes, you expect no further I/O from ZFS.
1272 txg_wait_synced(spa->spa_dsl_pool, 0);
1275 * If the config changed, update the config cache.
1277 if (config_changed) {
1278 mutex_enter(&spa_namespace_lock);
1279 spa_config_sync(spa, B_FALSE, B_TRUE);
1280 mutex_exit(&spa_namespace_lock);
1287 * ==========================================================================
1288 * Miscellaneous functions
1289 * ==========================================================================
1293 spa_activate_mos_feature(spa_t *spa, const char *feature, dmu_tx_t *tx)
1295 if (!nvlist_exists(spa->spa_label_features, feature)) {
1296 fnvlist_add_boolean(spa->spa_label_features, feature);
1298 * When we are creating the pool (tx_txg==TXG_INITIAL), we can't
1299 * dirty the vdev config because lock SCL_CONFIG is not held.
1300 * Thankfully, in this case we don't need to dirty the config
1301 * because it will be written out anyway when we finish
1302 * creating the pool.
1304 if (tx->tx_txg != TXG_INITIAL)
1305 vdev_config_dirty(spa->spa_root_vdev);
1310 spa_deactivate_mos_feature(spa_t *spa, const char *feature)
1312 if (nvlist_remove_all(spa->spa_label_features, feature) == 0)
1313 vdev_config_dirty(spa->spa_root_vdev);
1320 spa_rename(const char *name, const char *newname)
1326 * Lookup the spa_t and grab the config lock for writing. We need to
1327 * actually open the pool so that we can sync out the necessary labels.
1328 * It's OK to call spa_open() with the namespace lock held because we
1329 * allow recursive calls for other reasons.
1331 mutex_enter(&spa_namespace_lock);
1332 if ((err = spa_open(name, &spa, FTAG)) != 0) {
1333 mutex_exit(&spa_namespace_lock);
1337 spa_config_enter(spa, SCL_ALL, FTAG, RW_WRITER);
1339 avl_remove(&spa_namespace_avl, spa);
1340 (void) strlcpy(spa->spa_name, newname, sizeof (spa->spa_name));
1341 avl_add(&spa_namespace_avl, spa);
1344 * Sync all labels to disk with the new names by marking the root vdev
1345 * dirty and waiting for it to sync. It will pick up the new pool name
1348 vdev_config_dirty(spa->spa_root_vdev);
1350 spa_config_exit(spa, SCL_ALL, FTAG);
1352 txg_wait_synced(spa->spa_dsl_pool, 0);
1355 * Sync the updated config cache.
1357 spa_config_sync(spa, B_FALSE, B_TRUE);
1359 spa_close(spa, FTAG);
1361 mutex_exit(&spa_namespace_lock);
1367 * Return the spa_t associated with given pool_guid, if it exists. If
1368 * device_guid is non-zero, determine whether the pool exists *and* contains
1369 * a device with the specified device_guid.
1372 spa_by_guid(uint64_t pool_guid, uint64_t device_guid)
1375 avl_tree_t *t = &spa_namespace_avl;
1377 ASSERT(MUTEX_HELD(&spa_namespace_lock));
1379 for (spa = avl_first(t); spa != NULL; spa = AVL_NEXT(t, spa)) {
1380 if (spa->spa_state == POOL_STATE_UNINITIALIZED)
1382 if (spa->spa_root_vdev == NULL)
1384 if (spa_guid(spa) == pool_guid) {
1385 if (device_guid == 0)
1388 if (vdev_lookup_by_guid(spa->spa_root_vdev,
1389 device_guid) != NULL)
1393 * Check any devices we may be in the process of adding.
1395 if (spa->spa_pending_vdev) {
1396 if (vdev_lookup_by_guid(spa->spa_pending_vdev,
1397 device_guid) != NULL)
1407 * Determine whether a pool with the given pool_guid exists.
1410 spa_guid_exists(uint64_t pool_guid, uint64_t device_guid)
1412 return (spa_by_guid(pool_guid, device_guid) != NULL);
1416 spa_strdup(const char *s)
1422 new = kmem_alloc(len + 1, KM_SLEEP);
1430 spa_strfree(char *s)
1432 kmem_free(s, strlen(s) + 1);
1436 spa_get_random(uint64_t range)
1442 (void) random_get_pseudo_bytes((void *)&r, sizeof (uint64_t));
1448 spa_generate_guid(spa_t *spa)
1450 uint64_t guid = spa_get_random(-1ULL);
1453 while (guid == 0 || spa_guid_exists(spa_guid(spa), guid))
1454 guid = spa_get_random(-1ULL);
1456 while (guid == 0 || spa_guid_exists(guid, 0))
1457 guid = spa_get_random(-1ULL);
1464 snprintf_blkptr(char *buf, size_t buflen, const blkptr_t *bp)
1467 char *checksum = NULL;
1468 char *compress = NULL;
1471 if (BP_GET_TYPE(bp) & DMU_OT_NEWTYPE) {
1472 dmu_object_byteswap_t bswap =
1473 DMU_OT_BYTESWAP(BP_GET_TYPE(bp));
1474 (void) snprintf(type, sizeof (type), "bswap %s %s",
1475 DMU_OT_IS_METADATA(BP_GET_TYPE(bp)) ?
1476 "metadata" : "data",
1477 dmu_ot_byteswap[bswap].ob_name);
1479 (void) strlcpy(type, dmu_ot[BP_GET_TYPE(bp)].ot_name,
1482 if (!BP_IS_EMBEDDED(bp)) {
1484 zio_checksum_table[BP_GET_CHECKSUM(bp)].ci_name;
1486 compress = zio_compress_table[BP_GET_COMPRESS(bp)].ci_name;
1489 SNPRINTF_BLKPTR(snprintf, ' ', buf, buflen, bp, type, checksum,
1494 spa_freeze(spa_t *spa)
1496 uint64_t freeze_txg = 0;
1498 spa_config_enter(spa, SCL_ALL, FTAG, RW_WRITER);
1499 if (spa->spa_freeze_txg == UINT64_MAX) {
1500 freeze_txg = spa_last_synced_txg(spa) + TXG_SIZE;
1501 spa->spa_freeze_txg = freeze_txg;
1503 spa_config_exit(spa, SCL_ALL, FTAG);
1504 if (freeze_txg != 0)
1505 txg_wait_synced(spa_get_dsl(spa), freeze_txg);
1509 zfs_panic_recover(const char *fmt, ...)
1514 vcmn_err(zfs_recover ? CE_WARN : CE_PANIC, fmt, adx);
1519 * This is a stripped-down version of strtoull, suitable only for converting
1520 * lowercase hexadecimal numbers that don't overflow.
1523 zfs_strtonum(const char *str, char **nptr)
1529 while ((c = *str) != '\0') {
1530 if (c >= '0' && c <= '9')
1532 else if (c >= 'a' && c <= 'f')
1533 digit = 10 + c - 'a';
1544 *nptr = (char *)str;
1550 * ==========================================================================
1551 * Accessor functions
1552 * ==========================================================================
1556 spa_shutting_down(spa_t *spa)
1558 return (spa->spa_async_suspended);
1562 spa_get_dsl(spa_t *spa)
1564 return (spa->spa_dsl_pool);
1568 spa_is_initializing(spa_t *spa)
1570 return (spa->spa_is_initializing);
1574 spa_get_rootblkptr(spa_t *spa)
1576 return (&spa->spa_ubsync.ub_rootbp);
1580 spa_set_rootblkptr(spa_t *spa, const blkptr_t *bp)
1582 spa->spa_uberblock.ub_rootbp = *bp;
1586 spa_altroot(spa_t *spa, char *buf, size_t buflen)
1588 if (spa->spa_root == NULL)
1591 (void) strncpy(buf, spa->spa_root, buflen);
1595 spa_sync_pass(spa_t *spa)
1597 return (spa->spa_sync_pass);
1601 spa_name(spa_t *spa)
1603 return (spa->spa_name);
1607 spa_guid(spa_t *spa)
1609 dsl_pool_t *dp = spa_get_dsl(spa);
1613 * If we fail to parse the config during spa_load(), we can go through
1614 * the error path (which posts an ereport) and end up here with no root
1615 * vdev. We stash the original pool guid in 'spa_config_guid' to handle
1618 if (spa->spa_root_vdev == NULL)
1619 return (spa->spa_config_guid);
1621 guid = spa->spa_last_synced_guid != 0 ?
1622 spa->spa_last_synced_guid : spa->spa_root_vdev->vdev_guid;
1625 * Return the most recently synced out guid unless we're
1626 * in syncing context.
1628 if (dp && dsl_pool_sync_context(dp))
1629 return (spa->spa_root_vdev->vdev_guid);
1635 spa_load_guid(spa_t *spa)
1638 * This is a GUID that exists solely as a reference for the
1639 * purposes of the arc. It is generated at load time, and
1640 * is never written to persistent storage.
1642 return (spa->spa_load_guid);
1646 spa_last_synced_txg(spa_t *spa)
1648 return (spa->spa_ubsync.ub_txg);
1652 spa_first_txg(spa_t *spa)
1654 return (spa->spa_first_txg);
1658 spa_syncing_txg(spa_t *spa)
1660 return (spa->spa_syncing_txg);
1664 spa_state(spa_t *spa)
1666 return (spa->spa_state);
1670 spa_load_state(spa_t *spa)
1672 return (spa->spa_load_state);
1676 spa_freeze_txg(spa_t *spa)
1678 return (spa->spa_freeze_txg);
1683 spa_get_asize(spa_t *spa, uint64_t lsize)
1685 return (lsize * spa_asize_inflation);
1689 * Return the amount of slop space in bytes. It is 1/32 of the pool (3.2%),
1692 * See the comment above spa_slop_shift for details.
1695 spa_get_slop_space(spa_t *spa) {
1696 uint64_t space = spa_get_dspace(spa);
1697 return (MAX(space >> spa_slop_shift, SPA_MINDEVSIZE >> 1));
1701 spa_get_dspace(spa_t *spa)
1703 return (spa->spa_dspace);
1707 spa_update_dspace(spa_t *spa)
1709 spa->spa_dspace = metaslab_class_get_dspace(spa_normal_class(spa)) +
1710 ddt_get_dedup_dspace(spa);
1714 * Return the failure mode that has been set to this pool. The default
1715 * behavior will be to block all I/Os when a complete failure occurs.
1718 spa_get_failmode(spa_t *spa)
1720 return (spa->spa_failmode);
1724 spa_suspended(spa_t *spa)
1726 return (spa->spa_suspended);
1730 spa_version(spa_t *spa)
1732 return (spa->spa_ubsync.ub_version);
1736 spa_deflate(spa_t *spa)
1738 return (spa->spa_deflate);
1742 spa_normal_class(spa_t *spa)
1744 return (spa->spa_normal_class);
1748 spa_log_class(spa_t *spa)
1750 return (spa->spa_log_class);
1754 spa_evicting_os_register(spa_t *spa, objset_t *os)
1756 mutex_enter(&spa->spa_evicting_os_lock);
1757 list_insert_head(&spa->spa_evicting_os_list, os);
1758 mutex_exit(&spa->spa_evicting_os_lock);
1762 spa_evicting_os_deregister(spa_t *spa, objset_t *os)
1764 mutex_enter(&spa->spa_evicting_os_lock);
1765 list_remove(&spa->spa_evicting_os_list, os);
1766 cv_broadcast(&spa->spa_evicting_os_cv);
1767 mutex_exit(&spa->spa_evicting_os_lock);
1771 spa_evicting_os_wait(spa_t *spa)
1773 mutex_enter(&spa->spa_evicting_os_lock);
1774 while (!list_is_empty(&spa->spa_evicting_os_list))
1775 cv_wait(&spa->spa_evicting_os_cv, &spa->spa_evicting_os_lock);
1776 mutex_exit(&spa->spa_evicting_os_lock);
1778 dmu_buf_user_evict_wait();
1782 spa_max_replication(spa_t *spa)
1785 * As of SPA_VERSION == SPA_VERSION_DITTO_BLOCKS, we are able to
1786 * handle BPs with more than one DVA allocated. Set our max
1787 * replication level accordingly.
1789 if (spa_version(spa) < SPA_VERSION_DITTO_BLOCKS)
1791 return (MIN(SPA_DVAS_PER_BP, spa_max_replication_override));
1795 spa_prev_software_version(spa_t *spa)
1797 return (spa->spa_prev_software_version);
1801 spa_deadman_synctime(spa_t *spa)
1803 return (spa->spa_deadman_synctime);
1807 dva_get_dsize_sync(spa_t *spa, const dva_t *dva)
1809 uint64_t asize = DVA_GET_ASIZE(dva);
1810 uint64_t dsize = asize;
1812 ASSERT(spa_config_held(spa, SCL_ALL, RW_READER) != 0);
1814 if (asize != 0 && spa->spa_deflate) {
1815 uint64_t vdev = DVA_GET_VDEV(dva);
1816 vdev_t *vd = vdev_lookup_top(spa, vdev);
1819 "dva_get_dsize_sync(): bad DVA %llu:%llu",
1820 (u_longlong_t)vdev, (u_longlong_t)asize);
1822 dsize = (asize >> SPA_MINBLOCKSHIFT) * vd->vdev_deflate_ratio;
1829 bp_get_dsize_sync(spa_t *spa, const blkptr_t *bp)
1833 for (int d = 0; d < BP_GET_NDVAS(bp); d++)
1834 dsize += dva_get_dsize_sync(spa, &bp->blk_dva[d]);
1840 bp_get_dsize(spa_t *spa, const blkptr_t *bp)
1844 spa_config_enter(spa, SCL_VDEV, FTAG, RW_READER);
1846 for (int d = 0; d < BP_GET_NDVAS(bp); d++)
1847 dsize += dva_get_dsize_sync(spa, &bp->blk_dva[d]);
1849 spa_config_exit(spa, SCL_VDEV, FTAG);
1855 * ==========================================================================
1856 * Initialization and Termination
1857 * ==========================================================================
1861 spa_name_compare(const void *a1, const void *a2)
1863 const spa_t *s1 = a1;
1864 const spa_t *s2 = a2;
1867 s = strcmp(s1->spa_name, s2->spa_name);
1878 return (spa_active_count);
1888 EVENTHANDLER_DEFINE(mountroot, spa_boot_init, NULL, 0);
1894 mutex_init(&spa_namespace_lock, NULL, MUTEX_DEFAULT, NULL);
1895 mutex_init(&spa_spare_lock, NULL, MUTEX_DEFAULT, NULL);
1896 mutex_init(&spa_l2cache_lock, NULL, MUTEX_DEFAULT, NULL);
1897 cv_init(&spa_namespace_cv, NULL, CV_DEFAULT, NULL);
1899 avl_create(&spa_namespace_avl, spa_name_compare, sizeof (spa_t),
1900 offsetof(spa_t, spa_avl));
1902 avl_create(&spa_spare_avl, spa_spare_compare, sizeof (spa_aux_t),
1903 offsetof(spa_aux_t, aux_avl));
1905 avl_create(&spa_l2cache_avl, spa_l2cache_compare, sizeof (spa_aux_t),
1906 offsetof(spa_aux_t, aux_avl));
1908 spa_mode_global = mode;
1914 if (spa_mode_global != FREAD && dprintf_find_string("watch")) {
1915 arc_procfd = open("/proc/self/ctl", O_WRONLY);
1916 if (arc_procfd == -1) {
1917 perror("could not enable watchpoints: "
1918 "opening /proc/self/ctl failed: ");
1924 #endif /* illumos */
1932 vdev_cache_stat_init();
1935 zpool_feature_init();
1942 #endif /* !illumos */
1952 vdev_cache_stat_fini();
1961 avl_destroy(&spa_namespace_avl);
1962 avl_destroy(&spa_spare_avl);
1963 avl_destroy(&spa_l2cache_avl);
1965 cv_destroy(&spa_namespace_cv);
1966 mutex_destroy(&spa_namespace_lock);
1967 mutex_destroy(&spa_spare_lock);
1968 mutex_destroy(&spa_l2cache_lock);
1972 * Return whether this pool has slogs. No locking needed.
1973 * It's not a problem if the wrong answer is returned as it's only for
1974 * performance and not correctness
1977 spa_has_slogs(spa_t *spa)
1979 return (spa->spa_log_class->mc_rotor != NULL);
1983 spa_get_log_state(spa_t *spa)
1985 return (spa->spa_log_state);
1989 spa_set_log_state(spa_t *spa, spa_log_state_t state)
1991 spa->spa_log_state = state;
1995 spa_is_root(spa_t *spa)
1997 return (spa->spa_is_root);
2001 spa_writeable(spa_t *spa)
2003 return (!!(spa->spa_mode & FWRITE));
2007 * Returns true if there is a pending sync task in any of the current
2008 * syncing txg, the current quiescing txg, or the current open txg.
2011 spa_has_pending_synctask(spa_t *spa)
2013 return (!txg_all_lists_empty(&spa->spa_dsl_pool->dp_sync_tasks));
2017 spa_mode(spa_t *spa)
2019 return (spa->spa_mode);
2023 spa_bootfs(spa_t *spa)
2025 return (spa->spa_bootfs);
2029 spa_delegation(spa_t *spa)
2031 return (spa->spa_delegation);
2035 spa_meta_objset(spa_t *spa)
2037 return (spa->spa_meta_objset);
2041 spa_dedup_checksum(spa_t *spa)
2043 return (spa->spa_dedup_checksum);
2047 * Reset pool scan stat per scan pass (or reboot).
2050 spa_scan_stat_init(spa_t *spa)
2052 /* data not stored on disk */
2053 spa->spa_scan_pass_start = gethrestime_sec();
2054 spa->spa_scan_pass_exam = 0;
2055 vdev_scan_stat_init(spa->spa_root_vdev);
2059 * Get scan stats for zpool status reports
2062 spa_scan_get_stats(spa_t *spa, pool_scan_stat_t *ps)
2064 dsl_scan_t *scn = spa->spa_dsl_pool ? spa->spa_dsl_pool->dp_scan : NULL;
2066 if (scn == NULL || scn->scn_phys.scn_func == POOL_SCAN_NONE)
2067 return (SET_ERROR(ENOENT));
2068 bzero(ps, sizeof (pool_scan_stat_t));
2070 /* data stored on disk */
2071 ps->pss_func = scn->scn_phys.scn_func;
2072 ps->pss_start_time = scn->scn_phys.scn_start_time;
2073 ps->pss_end_time = scn->scn_phys.scn_end_time;
2074 ps->pss_to_examine = scn->scn_phys.scn_to_examine;
2075 ps->pss_examined = scn->scn_phys.scn_examined;
2076 ps->pss_to_process = scn->scn_phys.scn_to_process;
2077 ps->pss_processed = scn->scn_phys.scn_processed;
2078 ps->pss_errors = scn->scn_phys.scn_errors;
2079 ps->pss_state = scn->scn_phys.scn_state;
2081 /* data not stored on disk */
2082 ps->pss_pass_start = spa->spa_scan_pass_start;
2083 ps->pss_pass_exam = spa->spa_scan_pass_exam;
2089 spa_debug_enabled(spa_t *spa)
2091 return (spa->spa_debug);
2095 spa_maxblocksize(spa_t *spa)
2097 if (spa_feature_is_enabled(spa, SPA_FEATURE_LARGE_BLOCKS))
2098 return (SPA_MAXBLOCKSIZE);
2100 return (SPA_OLD_MAXBLOCKSIZE);