xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/spa_impl.h (revision 394707299ee511c373a7a164a534980fb01d39d0)
1 /*
2  * CDDL HEADER START
3  *
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.
7  *
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.
12  *
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]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_SPA_IMPL_H
27 #define	_SYS_SPA_IMPL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/spa.h>
32 #include <sys/vdev.h>
33 #include <sys/metaslab.h>
34 #include <sys/dmu.h>
35 #include <sys/dsl_pool.h>
36 #include <sys/uberblock_impl.h>
37 #include <sys/zfs_context.h>
38 #include <sys/avl.h>
39 #include <sys/refcount.h>
40 #include <sys/bplist.h>
41 
42 #ifdef	__cplusplus
43 extern "C" {
44 #endif
45 
46 typedef struct spa_config_lock {
47 	kmutex_t	scl_lock;
48 	refcount_t	scl_count;
49 	kthread_t	*scl_writer;
50 	kcondvar_t	scl_cv;
51 } spa_config_lock_t;
52 
53 typedef struct spa_error_entry {
54 	zbookmark_t	se_bookmark;
55 	char		*se_name;
56 	avl_node_t	se_avl;
57 } spa_error_entry_t;
58 
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 */
65 } spa_history_phys_t;
66 
67 typedef struct spa_props {
68 	nvlist_t	*spa_props_nvp;
69 	list_node_t	spa_list_node;
70 } spa_props_t;
71 
72 struct spa {
73 	/*
74 	 * Fields protected by spa_namespace_lock.
75 	 */
76 	char		*spa_name;		/* pool name */
77 	avl_node_t	spa_avl;		/* node in spa_namespace_avl */
78 	nvlist_t	*spa_config;		/* last synced config */
79 	nvlist_t	*spa_config_syncing;	/* currently syncing config */
80 	uint64_t	spa_config_txg;		/* txg of last config change */
81 	kmutex_t	spa_config_cache_lock;	/* for spa_config RW_READER */
82 	int		spa_sync_pass;		/* iterate-to-convergence */
83 	int		spa_state;		/* pool state */
84 	int		spa_inject_ref;		/* injection references */
85 	uint8_t		spa_traverse_wanted;	/* traverse lock wanted */
86 	uint8_t		spa_sync_on;		/* sync threads are running */
87 	spa_load_state_t spa_load_state;	/* current load operation */
88 	taskq_t		*spa_zio_issue_taskq[ZIO_TYPES];
89 	taskq_t		*spa_zio_intr_taskq[ZIO_TYPES];
90 	dsl_pool_t	*spa_dsl_pool;
91 	metaslab_class_t *spa_normal_class;	/* normal data class */
92 	uint64_t	spa_first_txg;		/* first txg after spa_open() */
93 	uint64_t	spa_final_txg;		/* txg of export/destroy */
94 	uint64_t	spa_freeze_txg;		/* freeze pool at this txg */
95 	objset_t	*spa_meta_objset;	/* copy of dp->dp_meta_objset */
96 	txg_list_t	spa_vdev_txg_list;	/* per-txg dirty vdev list */
97 	vdev_t		*spa_root_vdev;		/* top-level vdev container */
98 	uint64_t	spa_load_guid;		/* initial guid for spa_load */
99 	list_t		spa_dirty_list;		/* vdevs with dirty labels */
100 	uint64_t	spa_spares_object;	/* MOS object for spare list */
101 	nvlist_t	*spa_sparelist;		/* cached spare config */
102 	vdev_t		**spa_spares;		/* available hot spares */
103 	int		spa_nspares;		/* number of hot spares */
104 	boolean_t	spa_sync_spares;	/* sync the spares list */
105 	uint64_t	spa_config_object;	/* MOS object for pool config */
106 	uint64_t	spa_syncing_txg;	/* txg currently syncing */
107 	uint64_t	spa_sync_bplist_obj;	/* object for deferred frees */
108 	bplist_t	spa_sync_bplist;	/* deferred-free bplist */
109 	krwlock_t	spa_traverse_lock;	/* traverse vs. spa_sync() */
110 	uberblock_t	spa_ubsync;		/* last synced uberblock */
111 	uberblock_t	spa_uberblock;		/* current uberblock */
112 	kmutex_t	spa_scrub_lock;		/* resilver/scrub lock */
113 	kthread_t	*spa_scrub_thread;	/* scrub/resilver thread */
114 	traverse_handle_t *spa_scrub_th;	/* scrub traverse handle */
115 	uint64_t	spa_scrub_restart_txg;	/* need to restart */
116 	uint64_t	spa_scrub_mintxg;	/* min txg we'll scrub */
117 	uint64_t	spa_scrub_maxtxg;	/* max txg we'll scrub */
118 	uint64_t	spa_scrub_inflight;	/* in-flight scrub I/Os */
119 	uint64_t	spa_scrub_maxinflight;	/* max in-flight scrub I/Os */
120 	uint64_t	spa_scrub_errors;	/* scrub I/O error count */
121 	int		spa_scrub_suspended;	/* tell scrubber to suspend */
122 	kcondvar_t	spa_scrub_cv;		/* scrub thread state change */
123 	kcondvar_t	spa_scrub_io_cv;	/* scrub I/O completion */
124 	uint8_t		spa_scrub_stop;		/* tell scrubber to stop */
125 	uint8_t		spa_scrub_active;	/* active or suspended? */
126 	uint8_t		spa_scrub_type;		/* type of scrub we're doing */
127 	uint8_t		spa_scrub_finished;	/* indicator to rotate logs */
128 	kmutex_t	spa_async_lock;		/* protect async state */
129 	kthread_t	*spa_async_thread;	/* thread doing async task */
130 	int		spa_async_suspended;	/* async tasks suspended */
131 	kcondvar_t	spa_async_cv;		/* wait for thread_exit() */
132 	uint16_t	spa_async_tasks;	/* async task mask */
133 	char		*spa_root;		/* alternate root directory */
134 	kmutex_t	spa_uberblock_lock;	/* vdev_uberblock_load_done() */
135 	uint64_t	spa_ena;		/* spa-wide ereport ENA */
136 	boolean_t	spa_last_open_failed;	/* true if last open faled */
137 	kmutex_t	spa_errlog_lock;	/* error log lock */
138 	uint64_t	spa_errlog_last;	/* last error log object */
139 	uint64_t	spa_errlog_scrub;	/* scrub error log object */
140 	kmutex_t	spa_errlist_lock;	/* error list/ereport lock */
141 	avl_tree_t	spa_errlist_last;	/* last error list */
142 	avl_tree_t	spa_errlist_scrub;	/* scrub error list */
143 	uint64_t	spa_deflate;		/* should we deflate? */
144 	uint64_t	spa_history;		/* history object */
145 	kmutex_t	spa_history_lock;	/* history lock */
146 	vdev_t		*spa_pending_vdev;	/* pending vdev additions */
147 	nvlist_t	**spa_pending_spares;	/* pending spare additions */
148 	uint_t		spa_pending_nspares;	/* # pending spares */
149 	kmutex_t	spa_props_lock;		/* property lock */
150 	uint64_t	spa_pool_props_object;	/* object for properties */
151 	uint64_t	spa_bootfs;		/* default boot filesystem */
152 	/*
153 	 * spa_refcnt must be the last element because it changes size based on
154 	 * compilation options.  In order for the MDB module to function
155 	 * correctly, the other fields must remain in the same location.
156 	 */
157 	spa_config_lock_t spa_config_lock;	/* configuration changes */
158 	refcount_t	spa_refcount;		/* number of opens */
159 };
160 
161 extern const char *spa_config_dir;
162 extern kmutex_t spa_namespace_lock;
163 
164 #ifdef	__cplusplus
165 }
166 #endif
167 
168 #endif	/* _SYS_SPA_IMPL_H */
169