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 (c) 2014 Spectra Logic Corporation, All rights reserved.
26 * Copyright 2013 Saso Kiselkov. All rights reserved.
27 * Copyright (c) 2016 Actifio, Inc. All rights reserved.
28 * Copyright (c) 2017 Datto Inc.
31 #ifndef _SYS_SPA_IMPL_H
32 #define _SYS_SPA_IMPL_H
36 #include <sys/metaslab.h>
38 #include <sys/dsl_pool.h>
39 #include <sys/uberblock_impl.h>
40 #include <sys/zfs_context.h>
42 #include <sys/refcount.h>
43 #include <sys/bplist.h>
44 #include <sys/bpobj.h>
45 #include <sys/dsl_crypt.h>
46 #include <sys/zfeature.h>
47 #include <zfeature_common.h>
53 typedef struct spa_error_entry
{
54 zbookmark_phys_t se_bookmark
;
59 typedef struct spa_history_phys
{
60 uint64_t sh_pool_create_len
; /* ending offset of zpool create */
61 uint64_t sh_phys_max_off
; /* physical EOF */
62 uint64_t sh_bof
; /* logical BOF */
63 uint64_t sh_eof
; /* logical EOF */
64 uint64_t sh_records_lost
; /* num of records overwritten */
68 uint64_t sav_object
; /* MOS object for device list */
69 nvlist_t
*sav_config
; /* cached device config */
70 vdev_t
**sav_vdevs
; /* devices */
71 int sav_count
; /* number devices */
72 boolean_t sav_sync
; /* sync the device list */
73 nvlist_t
**sav_pending
; /* pending device additions */
74 uint_t sav_npending
; /* # pending devices */
77 typedef struct spa_config_lock
{
79 kthread_t
*scl_writer
;
85 typedef struct spa_config_dirent
{
88 } spa_config_dirent_t
;
90 typedef enum zio_taskq_type
{
94 ZIO_TASKQ_INTERRUPT_HIGH
,
99 * State machine for the zpool-poolname process. The states transitions
100 * are done as follows:
103 * PROC_NONE -> PROC_CREATED spa_activate()
104 * PROC_CREATED -> PROC_ACTIVE spa_thread()
105 * PROC_ACTIVE -> PROC_DEACTIVATE spa_deactivate()
106 * PROC_DEACTIVATE -> PROC_GONE spa_thread()
107 * PROC_GONE -> PROC_NONE spa_deactivate()
109 typedef enum spa_proc_state
{
110 SPA_PROC_NONE
, /* spa_proc = &p0, no process created */
111 SPA_PROC_CREATED
, /* spa_activate() has proc, is waiting */
112 SPA_PROC_ACTIVE
, /* taskqs created, spa_proc set */
113 SPA_PROC_DEACTIVATE
, /* spa_deactivate() requests process exit */
114 SPA_PROC_GONE
/* spa_thread() is exiting, spa_proc = &p0 */
117 typedef struct spa_taskqs
{
119 taskq_t
**stqs_taskq
;
122 typedef enum spa_all_vdev_zap_action
{
124 AVZ_ACTION_DESTROY
, /* Destroy all per-vdev ZAPs and the AVZ. */
125 AVZ_ACTION_REBUILD
, /* Populate the new AVZ, see spa_avz_rebuild */
126 AVZ_ACTION_INITIALIZE
131 * Fields protected by spa_namespace_lock.
133 char spa_name
[ZFS_MAX_DATASET_NAME_LEN
]; /* pool name */
134 char *spa_comment
; /* comment */
135 avl_node_t spa_avl
; /* node in spa_namespace_avl */
136 nvlist_t
*spa_config
; /* last synced config */
137 nvlist_t
*spa_config_syncing
; /* currently syncing config */
138 nvlist_t
*spa_config_splitting
; /* config for splitting */
139 nvlist_t
*spa_load_info
; /* info and errors from load */
140 uint64_t spa_config_txg
; /* txg of last config change */
141 int spa_sync_pass
; /* iterate-to-convergence */
142 pool_state_t spa_state
; /* pool state */
143 int spa_inject_ref
; /* injection references */
144 uint8_t spa_sync_on
; /* sync threads are running */
145 spa_load_state_t spa_load_state
; /* current load operation */
146 uint64_t spa_import_flags
; /* import specific flags */
147 spa_taskqs_t spa_zio_taskq
[ZIO_TYPES
][ZIO_TASKQ_TYPES
];
148 dsl_pool_t
*spa_dsl_pool
;
149 boolean_t spa_is_initializing
; /* true while opening pool */
150 metaslab_class_t
*spa_normal_class
; /* normal data class */
151 metaslab_class_t
*spa_log_class
; /* intent log data class */
152 uint64_t spa_first_txg
; /* first txg after spa_open() */
153 uint64_t spa_final_txg
; /* txg of export/destroy */
154 uint64_t spa_freeze_txg
; /* freeze pool at this txg */
155 uint64_t spa_load_max_txg
; /* best initial ub_txg */
156 uint64_t spa_claim_max_txg
; /* highest claimed birth txg */
157 timespec_t spa_loaded_ts
; /* 1st successful open time */
158 objset_t
*spa_meta_objset
; /* copy of dp->dp_meta_objset */
159 kmutex_t spa_evicting_os_lock
; /* Evicting objset list lock */
160 list_t spa_evicting_os_list
; /* Objsets being evicted. */
161 kcondvar_t spa_evicting_os_cv
; /* Objset Eviction Completion */
162 txg_list_t spa_vdev_txg_list
; /* per-txg dirty vdev list */
163 vdev_t
*spa_root_vdev
; /* top-level vdev container */
164 int spa_min_ashift
; /* of vdevs in normal class */
165 int spa_max_ashift
; /* of vdevs in normal class */
166 uint64_t spa_config_guid
; /* config pool guid */
167 uint64_t spa_load_guid
; /* spa_load initialized guid */
168 uint64_t spa_last_synced_guid
; /* last synced guid */
169 list_t spa_config_dirty_list
; /* vdevs with dirty config */
170 list_t spa_state_dirty_list
; /* vdevs with dirty state */
171 kmutex_t spa_alloc_lock
;
172 avl_tree_t spa_alloc_tree
;
173 spa_aux_vdev_t spa_spares
; /* hot spares */
174 spa_aux_vdev_t spa_l2cache
; /* L2ARC cache devices */
175 nvlist_t
*spa_label_features
; /* Features for reading MOS */
176 uint64_t spa_config_object
; /* MOS object for pool config */
177 uint64_t spa_config_generation
; /* config generation number */
178 uint64_t spa_syncing_txg
; /* txg currently syncing */
179 bpobj_t spa_deferred_bpobj
; /* deferred-free bplist */
180 bplist_t spa_free_bplist
[TXG_SIZE
]; /* bplist of stuff to free */
181 zio_cksum_salt_t spa_cksum_salt
; /* secret salt for cksum */
182 /* checksum context templates */
183 kmutex_t spa_cksum_tmpls_lock
;
184 void *spa_cksum_tmpls
[ZIO_CHECKSUM_FUNCTIONS
];
185 uberblock_t spa_ubsync
; /* last synced uberblock */
186 uberblock_t spa_uberblock
; /* current uberblock */
187 boolean_t spa_extreme_rewind
; /* rewind past deferred frees */
188 uint64_t spa_last_io
; /* lbolt of last non-scan I/O */
189 kmutex_t spa_scrub_lock
; /* resilver/scrub lock */
190 uint64_t spa_scrub_inflight
; /* in-flight scrub I/Os */
191 kcondvar_t spa_scrub_io_cv
; /* scrub I/O completion */
192 uint8_t spa_scrub_active
; /* active or suspended? */
193 uint8_t spa_scrub_type
; /* type of scrub we're doing */
194 uint8_t spa_scrub_finished
; /* indicator to rotate logs */
195 uint8_t spa_scrub_started
; /* started since last boot */
196 uint8_t spa_scrub_reopen
; /* scrub doing vdev_reopen */
197 uint64_t spa_scan_pass_start
; /* start time per pass/reboot */
198 uint64_t spa_scan_pass_scrub_pause
; /* scrub pause time */
199 uint64_t spa_scan_pass_scrub_spent_paused
; /* total paused */
200 uint64_t spa_scan_pass_exam
; /* examined bytes per pass */
201 kmutex_t spa_async_lock
; /* protect async state */
202 kthread_t
*spa_async_thread
; /* thread doing async task */
203 int spa_async_suspended
; /* async tasks suspended */
204 kcondvar_t spa_async_cv
; /* wait for thread_exit() */
205 uint16_t spa_async_tasks
; /* async task mask */
206 char *spa_root
; /* alternate root directory */
207 uint64_t spa_ena
; /* spa-wide ereport ENA */
208 int spa_last_open_failed
; /* error if last open failed */
209 uint64_t spa_last_ubsync_txg
; /* "best" uberblock txg */
210 uint64_t spa_last_ubsync_txg_ts
; /* timestamp from that ub */
211 uint64_t spa_load_txg
; /* ub txg that loaded */
212 uint64_t spa_load_txg_ts
; /* timestamp from that ub */
213 uint64_t spa_load_meta_errors
; /* verify metadata err count */
214 uint64_t spa_load_data_errors
; /* verify data err count */
215 uint64_t spa_verify_min_txg
; /* start txg of verify scrub */
216 kmutex_t spa_errlog_lock
; /* error log lock */
217 uint64_t spa_errlog_last
; /* last error log object */
218 uint64_t spa_errlog_scrub
; /* scrub error log object */
219 kmutex_t spa_errlist_lock
; /* error list/ereport lock */
220 avl_tree_t spa_errlist_last
; /* last error list */
221 avl_tree_t spa_errlist_scrub
; /* scrub error list */
222 uint64_t spa_deflate
; /* should we deflate? */
223 uint64_t spa_history
; /* history object */
224 kmutex_t spa_history_lock
; /* history lock */
225 vdev_t
*spa_pending_vdev
; /* pending vdev additions */
226 kmutex_t spa_props_lock
; /* property lock */
227 uint64_t spa_pool_props_object
; /* object for properties */
228 uint64_t spa_bootfs
; /* default boot filesystem */
229 uint64_t spa_failmode
; /* failure mode for the pool */
230 uint64_t spa_delegation
; /* delegation on/off */
231 list_t spa_config_list
; /* previous cache file(s) */
232 /* per-CPU array of root of async I/O: */
233 zio_t
**spa_async_zio_root
;
234 zio_t
*spa_suspend_zio_root
; /* root of all suspended I/O */
235 kmutex_t spa_suspend_lock
; /* protects suspend_zio_root */
236 kcondvar_t spa_suspend_cv
; /* notification of resume */
237 uint8_t spa_suspended
; /* pool is suspended */
238 uint8_t spa_claiming
; /* pool is doing zil_claim() */
239 boolean_t spa_debug
; /* debug enabled? */
240 boolean_t spa_is_root
; /* pool is root */
241 int spa_minref
; /* num refs when first opened */
242 int spa_mode
; /* FREAD | FWRITE */
243 spa_log_state_t spa_log_state
; /* log state */
244 uint64_t spa_autoexpand
; /* lun expansion on/off */
245 ddt_t
*spa_ddt
[ZIO_CHECKSUM_FUNCTIONS
]; /* in-core DDTs */
246 uint64_t spa_ddt_stat_object
; /* DDT statistics */
247 uint64_t spa_dedup_dspace
; /* Cache get_dedup_dspace() */
248 uint64_t spa_dedup_ditto
; /* dedup ditto threshold */
249 uint64_t spa_dedup_checksum
; /* default dedup checksum */
250 uint64_t spa_dspace
; /* dspace in normal class */
251 kmutex_t spa_vdev_top_lock
; /* dueling offline/remove */
252 kmutex_t spa_proc_lock
; /* protects spa_proc* */
253 kcondvar_t spa_proc_cv
; /* spa_proc_state transitions */
254 spa_proc_state_t spa_proc_state
; /* see definition */
255 proc_t
*spa_proc
; /* "zpool-poolname" process */
256 uint64_t spa_did
; /* if procp != p0, did of t1 */
257 boolean_t spa_autoreplace
; /* autoreplace set in open */
258 int spa_vdev_locks
; /* locks grabbed */
259 uint64_t spa_creation_version
; /* version at pool creation */
260 uint64_t spa_prev_software_version
; /* See ub_software_version */
261 uint64_t spa_feat_for_write_obj
; /* required to write to pool */
262 uint64_t spa_feat_for_read_obj
; /* required to read from pool */
263 uint64_t spa_feat_desc_obj
; /* Feature descriptions */
264 uint64_t spa_feat_enabled_txg_obj
; /* Feature enabled txg */
265 kmutex_t spa_feat_stats_lock
; /* protects spa_feat_stats */
266 nvlist_t
*spa_feat_stats
; /* Cache of enabled features */
267 /* cache feature refcounts */
268 uint64_t spa_feat_refcount_cache
[SPA_FEATURES
];
269 taskqid_t spa_deadman_tqid
; /* Task id */
270 uint64_t spa_deadman_calls
; /* number of deadman calls */
271 hrtime_t spa_sync_starttime
; /* starting time of spa_sync */
272 uint64_t spa_deadman_synctime
; /* deadman expiration timer */
273 uint64_t spa_all_vdev_zaps
; /* ZAP of per-vd ZAP obj #s */
274 spa_avz_action_t spa_avz_action
; /* destroy/rebuild AVZ? */
275 uint64_t spa_errata
; /* errata issues detected */
276 spa_stats_t spa_stats
; /* assorted spa statistics */
277 spa_keystore_t spa_keystore
; /* loaded crypto keys */
278 hrtime_t spa_ccw_fail_time
; /* Conf cache write fail time */
279 taskq_t
*spa_zvol_taskq
; /* Taskq for minor management */
280 uint64_t spa_multihost
; /* multihost aware (mmp) */
281 mmp_thread_t spa_mmp
; /* multihost mmp thread */
284 * spa_refcount & spa_config_lock must be the last elements
285 * because refcount_t changes size based on compilation options.
286 * In order for the MDB module to function correctly, the other
287 * fields must remain in the same location.
289 spa_config_lock_t spa_config_lock
[SCL_LOCKS
]; /* config changes */
290 refcount_t spa_refcount
; /* number of opens */
292 taskq_t
*spa_upgrade_taskq
; /* taskq for upgrade jobs */
295 extern char *spa_config_path
;
297 extern void spa_taskq_dispatch_ent(spa_t
*spa
, zio_type_t t
, zio_taskq_type_t q
,
298 task_func_t
*func
, void *arg
, uint_t flags
, taskq_ent_t
*ent
);
299 extern void spa_taskq_dispatch_sync(spa_t
*, zio_type_t t
, zio_taskq_type_t q
,
300 task_func_t
*func
, void *arg
, uint_t flags
);
307 #endif /* _SYS_SPA_IMPL_H */