xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/dsl_pool.h (revision aedf2b3bb56b025fcaf87b49ec6c8aeea07f16d7)
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 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_DSL_POOL_H
27 #define	_SYS_DSL_POOL_H
28 
29 #include <sys/spa.h>
30 #include <sys/txg.h>
31 #include <sys/txg_impl.h>
32 #include <sys/zfs_context.h>
33 #include <sys/zio.h>
34 #include <sys/dnode.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 struct objset;
41 struct dsl_dir;
42 struct dsl_dataset;
43 struct dsl_pool;
44 struct dmu_tx;
45 
46 enum scrub_func {
47 	SCRUB_FUNC_NONE,
48 	SCRUB_FUNC_CLEAN,
49 	SCRUB_FUNC_NUMFUNCS
50 };
51 
52 /* These macros are for indexing into the zfs_all_blkstats_t. */
53 #define	DMU_OT_DEFERRED	DMU_OT_NONE
54 #define	DMU_OT_TOTAL	DMU_OT_NUMTYPES
55 
56 typedef struct zfs_blkstat {
57 	uint64_t	zb_count;
58 	uint64_t	zb_asize;
59 	uint64_t	zb_lsize;
60 	uint64_t	zb_psize;
61 	uint64_t	zb_gangs;
62 	uint64_t	zb_ditto_2_of_2_samevdev;
63 	uint64_t	zb_ditto_2_of_3_samevdev;
64 	uint64_t	zb_ditto_3_of_3_samevdev;
65 } zfs_blkstat_t;
66 
67 typedef struct zfs_all_blkstats {
68 	zfs_blkstat_t	zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
69 } zfs_all_blkstats_t;
70 
71 
72 typedef struct dsl_pool {
73 	/* Immutable */
74 	spa_t *dp_spa;
75 	struct objset *dp_meta_objset;
76 	struct dsl_dir *dp_root_dir;
77 	struct dsl_dir *dp_mos_dir;
78 	struct dsl_dataset *dp_origin_snap;
79 	uint64_t dp_root_dir_obj;
80 	struct taskq *dp_vnrele_taskq;
81 
82 	/* No lock needed - sync context only */
83 	blkptr_t dp_meta_rootbp;
84 	list_t dp_synced_datasets;
85 	hrtime_t dp_read_overhead;
86 	uint64_t dp_throughput;
87 	uint64_t dp_write_limit;
88 	uint64_t dp_tmp_userrefs_obj;
89 
90 	/* Uses dp_lock */
91 	kmutex_t dp_lock;
92 	uint64_t dp_space_towrite[TXG_SIZE];
93 	uint64_t dp_tempreserved[TXG_SIZE];
94 
95 	enum scrub_func dp_scrub_func;
96 	uint64_t dp_scrub_queue_obj;
97 	uint64_t dp_scrub_min_txg;
98 	uint64_t dp_scrub_max_txg;
99 	zbookmark_t dp_scrub_bookmark;
100 	boolean_t dp_scrub_pausing;
101 	boolean_t dp_scrub_isresilver;
102 	uint64_t dp_scrub_start_time;
103 	kmutex_t dp_scrub_cancel_lock; /* protects dp_scrub_restart */
104 	boolean_t dp_scrub_restart;
105 	boolean_t dp_scrub_ditto;
106 
107 	/* Has its own locking */
108 	tx_state_t dp_tx;
109 	txg_list_t dp_dirty_datasets;
110 	txg_list_t dp_dirty_dirs;
111 	txg_list_t dp_sync_tasks;
112 
113 	/*
114 	 * Protects administrative changes (properties, namespace)
115 	 * It is only held for write in syncing context.  Therefore
116 	 * syncing context does not need to ever have it for read, since
117 	 * nobody else could possibly have it for write.
118 	 */
119 	krwlock_t dp_config_rwlock;
120 
121 	zfs_all_blkstats_t *dp_blkstats;
122 } dsl_pool_t;
123 
124 int dsl_pool_open(spa_t *spa, uint64_t txg, dsl_pool_t **dpp);
125 void dsl_pool_close(dsl_pool_t *dp);
126 dsl_pool_t *dsl_pool_create(spa_t *spa, nvlist_t *zplprops, uint64_t txg);
127 void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
128 void dsl_pool_sync_done(dsl_pool_t *dp, uint64_t txg);
129 int dsl_pool_sync_context(dsl_pool_t *dp);
130 uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, boolean_t netfree);
131 uint64_t dsl_pool_adjustedfree(dsl_pool_t *dp, boolean_t netfree);
132 int dsl_pool_tempreserve_space(dsl_pool_t *dp, uint64_t space, dmu_tx_t *tx);
133 void dsl_pool_tempreserve_clear(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
134 void dsl_pool_memory_pressure(dsl_pool_t *dp);
135 void dsl_pool_willuse_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
136 void dsl_free(dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp);
137 void dsl_pool_ds_destroyed(struct dsl_dataset *ds, struct dmu_tx *tx);
138 void dsl_pool_ds_snapshotted(struct dsl_dataset *ds, struct dmu_tx *tx);
139 void dsl_pool_ds_clone_swapped(struct dsl_dataset *ds1, struct dsl_dataset *ds2,
140     struct dmu_tx *tx);
141 void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
142 void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
143 
144 int dsl_pool_scrub_cancel(dsl_pool_t *dp);
145 int dsl_pool_scrub_clean(dsl_pool_t *dp);
146 void dsl_pool_scrub_sync(dsl_pool_t *dp, dmu_tx_t *tx);
147 void dsl_pool_scrub_restart(dsl_pool_t *dp);
148 
149 taskq_t *dsl_pool_vnrele_taskq(dsl_pool_t *dp);
150 
151 extern int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
152     const char *tag, uint64_t *now, dmu_tx_t *tx);
153 extern int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
154     const char *tag, dmu_tx_t *tx);
155 extern void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
156 
157 #ifdef	__cplusplus
158 }
159 #endif
160 
161 #endif /* _SYS_DSL_POOL_H */
162