xref: /freebsd/sys/contrib/openzfs/include/sys/dsl_pool.h (revision 34f9f5680c9d5d5138e427ba3aeab0138cec3882)
1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3  * This file and its contents are supplied under the terms of the
4  * Common Development and Distribution License ("CDDL"), version 1.0.
5  * You may only use this file in accordance with the terms of version
6  * 1.0 of the CDDL.
7  *
8  * A full copy of the text of the CDDL should have accompanied this
9  * source.  A copy of the CDDL is also available via the Internet at
10  * https://opensource.org/license/CDDL-1.0.
11  */
12 /*
13  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
14  * Copyright (c) 2013, 2018 by Delphix. All rights reserved.
15  * Copyright 2016 Nexenta Systems, Inc.  All rights reserved.
16  */
17 
18 #ifndef	_SYS_DSL_POOL_H
19 #define	_SYS_DSL_POOL_H
20 
21 #include <sys/spa.h>
22 #include <sys/txg.h>
23 #include <sys/txg_impl.h>
24 #include <sys/zfs_context.h>
25 #include <sys/zio.h>
26 #include <sys/dnode.h>
27 #include <sys/ddt.h>
28 #include <sys/arc.h>
29 #include <sys/bpobj.h>
30 #include <sys/bptree.h>
31 #include <sys/rrwlock.h>
32 #include <sys/dsl_synctask.h>
33 #include <sys/mmp.h>
34 #include <sys/aggsum.h>
35 #include <sys/wmsum.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 extern int zfs_txg_synctime_ms;
42 
43 struct objset;
44 struct dsl_dir;
45 struct dsl_dataset;
46 struct dsl_pool;
47 struct dmu_tx;
48 struct dsl_scan;
49 struct dsl_crypto_params;
50 struct dsl_deadlist;
51 
52 extern uint64_t zfs_dirty_data_max;
53 extern uint64_t zfs_dirty_data_max_max;
54 extern uint64_t zfs_wrlog_data_max;
55 extern uint_t zfs_dirty_data_max_percent;
56 extern uint_t zfs_dirty_data_max_max_percent;
57 extern uint_t zfs_delay_min_dirty_percent;
58 extern uint_t zfs_vdev_async_write_active_min_dirty_percent;
59 extern uint_t zfs_vdev_async_write_active_max_dirty_percent;
60 extern uint64_t zfs_delay_scale;
61 
62 /* These macros are for indexing into the zfs_all_blkstats_t. */
63 #define	DMU_OT_DEFERRED	DMU_OT_NONE
64 #define	DMU_OT_OTHER	DMU_OT_NUMTYPES /* place holder for DMU_OT() types */
65 #define	DMU_OT_TOTAL	(DMU_OT_NUMTYPES + 1)
66 
67 typedef struct zfs_blkstat {
68 	uint64_t	zb_count;
69 	uint64_t	zb_asize;
70 	uint64_t	zb_lsize;
71 	uint64_t	zb_psize;
72 	uint64_t	zb_gangs;
73 	uint64_t	zb_ditto_2_of_2_samevdev;
74 	uint64_t	zb_ditto_2_of_3_samevdev;
75 	uint64_t	zb_ditto_3_of_3_samevdev;
76 } zfs_blkstat_t;
77 
78 typedef struct zfs_all_blkstats {
79 	zfs_blkstat_t	zab_type[DN_MAX_LEVELS + 1][DMU_OT_TOTAL + 1];
80 } zfs_all_blkstats_t;
81 
82 
83 typedef struct dsl_pool {
84 	/* Immutable */
85 	spa_t *dp_spa;
86 	struct objset *dp_meta_objset;
87 	struct dsl_dir *dp_root_dir;
88 	struct dsl_dir *dp_mos_dir;
89 	struct dsl_dir *dp_free_dir;
90 	struct dsl_dir *dp_leak_dir;
91 	struct dsl_dataset *dp_origin_snap;
92 	uint64_t dp_root_dir_obj;
93 	struct taskq *dp_zrele_taskq;
94 	struct taskq *dp_unlinked_drain_taskq;
95 
96 	/* No lock needed - sync context only */
97 	blkptr_t dp_meta_rootbp;
98 	uint64_t dp_tmp_userrefs_obj;
99 	bpobj_t dp_free_bpobj;
100 	uint64_t dp_bptree_obj;
101 	uint64_t dp_empty_bpobj;
102 	bpobj_t dp_obsolete_bpobj;
103 
104 	struct dsl_scan *dp_scan;
105 
106 	/* Updated with atomics, read without a lock */
107 	uint64_t dp_dirty_pertxg[TXG_SIZE];
108 	uint64_t dp_dirty_total;
109 	uint64_t dp_sync_reserve_pertxg[TXG_SIZE];
110 	uint64_t dp_sync_reserve_total;
111 
112 	/* Uses dp_lock */
113 	kmutex_t dp_lock;
114 	kcondvar_t dp_spaceavail_cv;
115 	uint64_t dp_dirty_waiters;	/* also read unlocked */
116 	uint64_t dp_long_free_dirty_pertxg[TXG_SIZE];
117 
118 	aggsum_t dp_wrlog_pertxg[TXG_SIZE];
119 	aggsum_t dp_wrlog_total;
120 
121 	wmsum_t dp_mos_used_delta;
122 	wmsum_t dp_mos_compressed_delta;
123 	wmsum_t dp_mos_uncompressed_delta;
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_dirty_mos_space(dsl_pool_t *dp, int64_t space, dmu_tx_t *tx);
169 void dsl_pool_undirty_space(dsl_pool_t *dp, int64_t space, uint64_t txg);
170 void dsl_pool_sync_reserve(dsl_pool_t *dp, uint64_t space, dmu_tx_t *tx);
171 void dsl_pool_sync_unreserve(dsl_pool_t *dp, uint64_t space, uint64_t txg);
172 void dsl_free(dsl_pool_t *dp, uint64_t txg, const blkptr_t *bpp);
173 void dsl_free_sync(zio_t *pio, dsl_pool_t *dp, uint64_t txg,
174     const blkptr_t *bpp);
175 void dsl_pool_create_origin(dsl_pool_t *dp, dmu_tx_t *tx);
176 void dsl_pool_upgrade_clones(dsl_pool_t *dp, dmu_tx_t *tx);
177 void dsl_pool_upgrade_dir_clones(dsl_pool_t *dp, dmu_tx_t *tx);
178 void dsl_pool_mos_diduse_space(dsl_pool_t *dp,
179     int64_t used, int64_t comp, int64_t uncomp);
180 void dsl_pool_ckpoint_diduse_space(dsl_pool_t *dp,
181     int64_t used, int64_t comp, int64_t uncomp);
182 boolean_t dsl_pool_need_dirty_delay(dsl_pool_t *dp);
183 void dsl_pool_config_enter(dsl_pool_t *dp, const void *tag);
184 void dsl_pool_config_enter_prio(dsl_pool_t *dp, const void *tag);
185 void dsl_pool_config_exit(dsl_pool_t *dp, const void *tag);
186 boolean_t dsl_pool_config_held(dsl_pool_t *dp);
187 boolean_t dsl_pool_config_held_writer(dsl_pool_t *dp);
188 
189 taskq_t *dsl_pool_zrele_taskq(dsl_pool_t *dp);
190 taskq_t *dsl_pool_unlinked_drain_taskq(dsl_pool_t *dp);
191 
192 int dsl_pool_user_hold(dsl_pool_t *dp, uint64_t dsobj,
193     const char *tag, uint64_t now, dmu_tx_t *tx);
194 int dsl_pool_user_release(dsl_pool_t *dp, uint64_t dsobj,
195     const char *tag, dmu_tx_t *tx);
196 void dsl_pool_clean_tmp_userrefs(dsl_pool_t *dp);
197 int dsl_pool_open_special_dir(dsl_pool_t *dp, const char *name, dsl_dir_t **);
198 int dsl_pool_hold(const char *name, const void *tag, dsl_pool_t **dp);
199 void dsl_pool_rele(dsl_pool_t *dp, const void *tag);
200 
201 void dsl_pool_create_obsolete_bpobj(dsl_pool_t *dp, dmu_tx_t *tx);
202 void dsl_pool_destroy_obsolete_bpobj(dsl_pool_t *dp, dmu_tx_t *tx);
203 
204 #ifdef	__cplusplus
205 }
206 #endif
207 
208 #endif /* _SYS_DSL_POOL_H */
209