xref: /freebsd/sys/contrib/openzfs/include/sys/dsl_pool.h (revision dbd5678dca91abcefe8d046aa2f9b66497a95ffb)
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 https://opensource.org/licenses/CDDL-1.0.
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2013, 2018 by Delphix. All rights reserved.
24  * Copyright 2016 Nexenta Systems, Inc.  All rights reserved.
25  */
26 
27 #ifndef	_SYS_DSL_POOL_H
28 #define	_SYS_DSL_POOL_H
29 
30 #include <sys/spa.h>
31 #include <sys/txg.h>
32 #include <sys/txg_impl.h>
33 #include <sys/zfs_context.h>
34 #include <sys/zio.h>
35 #include <sys/dnode.h>
36 #include <sys/ddt.h>
37 #include <sys/arc.h>
38 #include <sys/bpobj.h>
39 #include <sys/bptree.h>
40 #include <sys/rrwlock.h>
41 #include <sys/dsl_synctask.h>
42 #include <sys/mmp.h>
43 #include <sys/aggsum.h>
44 
45 #ifdef	__cplusplus
46 extern "C" {
47 #endif
48 
49 extern int zfs_txg_synctime_ms;
50 
51 struct objset;
52 struct dsl_dir;
53 struct dsl_dataset;
54 struct dsl_pool;
55 struct dmu_tx;
56 struct dsl_scan;
57 struct dsl_crypto_params;
58 struct dsl_deadlist;
59 
60 extern uint64_t zfs_dirty_data_max;
61 extern uint64_t zfs_dirty_data_max_max;
62 extern uint64_t zfs_wrlog_data_max;
63 extern uint_t zfs_dirty_data_max_percent;
64 extern uint_t zfs_dirty_data_max_max_percent;
65 extern uint_t zfs_delay_min_dirty_percent;
66 extern uint64_t zfs_delay_scale;
67 
68 /* These macros are for indexing into the zfs_all_blkstats_t. */
69 #define	DMU_OT_DEFERRED	DMU_OT_NONE
70 #define	DMU_OT_OTHER	DMU_OT_NUMTYPES /* place holder for DMU_OT() types */
71 #define	DMU_OT_TOTAL	(DMU_OT_NUMTYPES + 1)
72 
73 typedef struct zfs_blkstat {
74 	uint64_t	zb_count;
75 	uint64_t	zb_asize;
76 	uint64_t	zb_lsize;
77 	uint64_t	zb_psize;
78 	uint64_t	zb_gangs;
79 	uint64_t	zb_ditto_2_of_2_samevdev;
80 	uint64_t	zb_ditto_2_of_3_samevdev;
81 	uint64_t	zb_ditto_3_of_3_samevdev;
82 } zfs_blkstat_t;
83 
84 typedef struct zfs_all_blkstats {
85 	zfs_blkstat_t	zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
86 } zfs_all_blkstats_t;
87 
88 
89 typedef struct dsl_pool {
90 	/* Immutable */
91 	spa_t *dp_spa;
92 	struct objset *dp_meta_objset;
93 	struct dsl_dir *dp_root_dir;
94 	struct dsl_dir *dp_mos_dir;
95 	struct dsl_dir *dp_free_dir;
96 	struct dsl_dir *dp_leak_dir;
97 	struct dsl_dataset *dp_origin_snap;
98 	uint64_t dp_root_dir_obj;
99 	struct taskq *dp_zrele_taskq;
100 	struct taskq *dp_unlinked_drain_taskq;
101 
102 	/* No lock needed - sync context only */
103 	blkptr_t dp_meta_rootbp;
104 	uint64_t dp_tmp_userrefs_obj;
105 	bpobj_t dp_free_bpobj;
106 	uint64_t dp_bptree_obj;
107 	uint64_t dp_empty_bpobj;
108 	bpobj_t dp_obsolete_bpobj;
109 
110 	struct dsl_scan *dp_scan;
111 
112 	/* Uses dp_lock */
113 	kmutex_t dp_lock;
114 	kcondvar_t dp_spaceavail_cv;
115 	uint64_t dp_dirty_pertxg[TXG_SIZE];
116 	uint64_t dp_dirty_total;
117 	uint64_t dp_long_free_dirty_pertxg[TXG_SIZE];
118 	uint64_t dp_mos_used_delta;
119 	uint64_t dp_mos_compressed_delta;
120 	uint64_t dp_mos_uncompressed_delta;
121 
122 	aggsum_t dp_wrlog_pertxg[TXG_SIZE];
123 	aggsum_t dp_wrlog_total;
124 
125 	/*
126 	 * Time of most recently scheduled (furthest in the future)
127 	 * wakeup for delayed transactions.
128 	 */
129 	hrtime_t dp_last_wakeup;
130 
131 	/* Has its own locking */
132 	tx_state_t dp_tx;
133 	txg_list_t dp_dirty_datasets;
134 	txg_list_t dp_dirty_zilogs;
135 	txg_list_t dp_dirty_dirs;
136 	txg_list_t dp_sync_tasks;
137 	txg_list_t dp_early_sync_tasks;
138 	taskq_t *dp_sync_taskq;
139 	taskq_t *dp_zil_clean_taskq;
140 
141 	/*
142 	 * Protects administrative changes (properties, namespace)
143 	 *
144 	 * It is only held for write in syncing context.  Therefore
145 	 * syncing context does not need to ever have it for read, since
146 	 * nobody else could possibly have it for write.
147 	 */
148 	rrwlock_t dp_config_rwlock;
149 
150 	zfs_all_blkstats_t *dp_blkstats;
151 } dsl_pool_t;
152 
153 int dsl_pool_init(spa_t *spa, uint64_t txg, dsl_pool_t **dpp);
154 int dsl_pool_open(dsl_pool_t *dp);
155 void dsl_pool_close(dsl_pool_t *dp);
156 dsl_pool_t *dsl_pool_create(spa_t *spa, nvlist_t *zplprops,
157     struct dsl_crypto_params *dcp, uint64_t txg);
158 void dsl_pool_sync(dsl_pool_t *dp, uint64_t txg);
159 void dsl_pool_sync_done(dsl_pool_t *dp, uint64_t txg);
160 int dsl_pool_sync_context(dsl_pool_t *dp);
161 uint64_t dsl_pool_adjustedsize(dsl_pool_t *dp, zfs_space_check_t slop_policy);
162 uint64_t dsl_pool_unreserved_space(dsl_pool_t *dp,
163     zfs_space_check_t slop_policy);
164 uint64_t dsl_pool_deferred_space(dsl_pool_t *dp);
165 void dsl_pool_wrlog_count(dsl_pool_t *dp, int64_t size, uint64_t txg);
166 boolean_t dsl_pool_need_wrlog_delay(dsl_pool_t *dp);
167 void dsl_pool_dirty_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
168 void dsl_pool_undirty_space(dsl_pool_t *dp, int64_t space, uint64_t txg);
169 void dsl_free(dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp);
170 void dsl_free_sync(zio_t *pio, dsl_pool_t *dp, uint64_t txg,
171     const blkptr_t *bpp);
172 void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
173 void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
174 void dsl_pool_upgrade_dir_clones(dsl_pool_t *dp, dmu_tx_t *tx);
175 void dsl_pool_mos_diduse_space(dsl_pool_t *dp,
176     int64_t used, int64_t comp, int64_t uncomp);
177 void dsl_pool_ckpoint_diduse_space(dsl_pool_t *dp,
178     int64_t used, int64_t comp, int64_t uncomp);
179 boolean_t dsl_pool_need_dirty_delay(dsl_pool_t *dp);
180 void dsl_pool_config_enter(dsl_pool_t *dp, const void *tag);
181 void dsl_pool_config_enter_prio(dsl_pool_t *dp, const void *tag);
182 void dsl_pool_config_exit(dsl_pool_t *dp, const void *tag);
183 boolean_t dsl_pool_config_held(dsl_pool_t *dp);
184 boolean_t dsl_pool_config_held_writer(dsl_pool_t *dp);
185 
186 taskq_t *dsl_pool_zrele_taskq(dsl_pool_t *dp);
187 taskq_t *dsl_pool_unlinked_drain_taskq(dsl_pool_t *dp);
188 
189 int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
190     const char *tag, uint64_t now, dmu_tx_t *tx);
191 int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
192     const char *tag, dmu_tx_t *tx);
193 void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
194 int dsl_pool_open_special_dir(dsl_pool_t *dp, const char *name, dsl_dir_t **);
195 int dsl_pool_hold(const char *name, const void *tag, dsl_pool_t **dp);
196 void dsl_pool_rele(dsl_pool_t *dp, const void *tag);
197 
198 void dsl_pool_create_obsolete_bpobj(dsl_pool_t *dp, dmu_tx_t *tx);
199 void dsl_pool_destroy_obsolete_bpobj(dsl_pool_t *dp, dmu_tx_t *tx);
200 
201 #ifdef	__cplusplus
202 }
203 #endif
204 
205 #endif /* _SYS_DSL_POOL_H */
206