]> git.proxmox.com Git - mirror_zfs.git/blame - include/sys/dsl_dataset.h
Illumos 6171 - dsl_prop_unregister() slows down dataset eviction.
[mirror_zfs.git] / include / sys / dsl_dataset.h
CommitLineData
34dc7c2f
BB
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/*
428870ff 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
241b5415 23 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
fcff0f35 24 * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
95fd54a1 25 * Copyright (c) 2013 Steven Hartland. All rights reserved.
0c66c32d 26 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
34dc7c2f
BB
27 */
28
29#ifndef _SYS_DSL_DATASET_H
30#define _SYS_DSL_DATASET_H
31
34dc7c2f
BB
32#include <sys/dmu.h>
33#include <sys/spa.h>
34#include <sys/txg.h>
35#include <sys/zio.h>
36#include <sys/bplist.h>
37#include <sys/dsl_synctask.h>
38#include <sys/zfs_context.h>
428870ff 39#include <sys/dsl_deadlist.h>
13fe0198 40#include <sys/refcount.h>
241b5415 41#include <zfeature_common.h>
34dc7c2f
BB
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
47struct dsl_dataset;
48struct dsl_dir;
49struct dsl_pool;
50
34dc7c2f 51#define DS_FLAG_INCONSISTENT (1ULL<<0)
b128c09f 52#define DS_IS_INCONSISTENT(ds) \
d683ddbb 53 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT)
fa86b5db 54
34dc7c2f 55/*
fa86b5db 56 * Do not allow this dataset to be promoted.
34dc7c2f
BB
57 */
58#define DS_FLAG_NOPROMOTE (1ULL<<1)
59
60/*
61 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
62 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
63 * refquota/refreservations).
64 */
65#define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
66
45d1cae3
BB
67/*
68 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
69 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
70 */
71#define DS_FLAG_DEFER_DESTROY (1ULL<<3)
72#define DS_IS_DEFER_DESTROY(ds) \
d683ddbb 73 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY)
45d1cae3 74
fa86b5db
MA
75/*
76 * DS_FIELD_* are strings that are used in the "extensified" dataset zap object.
77 * They should be of the format <reverse-dns>:<field>.
78 */
79
da536844
MA
80/*
81 * This field's value is the object ID of a zap object which contains the
82 * bookmarks of this dataset. If it is present, then this dataset is counted
83 * in the refcount of the SPA_FEATURES_BOOKMARKS feature.
84 */
85#define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks"
86
f1512ee6
MA
87/*
88 * This field is present (with value=0) if this dataset may contain large
89 * blocks (>128KB). If it is present, then this dataset
90 * is counted in the refcount of the SPA_FEATURE_LARGE_BLOCKS feature.
91 */
92#define DS_FIELD_LARGE_BLOCKS "org.open-zfs:large_blocks"
93
34dc7c2f
BB
94/*
95 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
96 * name lookups should be performed case-insensitively.
97 */
98#define DS_FLAG_CI_DATASET (1ULL<<16)
99
13fe0198
MA
100#define DS_CREATE_FLAG_NODIRTY (1ULL<<24)
101
34dc7c2f 102typedef struct dsl_dataset_phys {
b128c09f
BB
103 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */
104 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */
34dc7c2f 105 uint64_t ds_prev_snap_txg;
b128c09f
BB
106 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */
107 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
34dc7c2f
BB
108 uint64_t ds_num_children; /* clone/snap children; ==0 for head */
109 uint64_t ds_creation_time; /* seconds since 1970 */
110 uint64_t ds_creation_txg;
428870ff 111 uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */
9ae529ec
CS
112 /*
113 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
114 * include all blocks referenced by this dataset, including those
115 * shared with any other datasets.
116 */
117 uint64_t ds_referenced_bytes;
34dc7c2f
BB
118 uint64_t ds_compressed_bytes;
119 uint64_t ds_uncompressed_bytes;
120 uint64_t ds_unique_bytes; /* only relevant to snapshots */
121 /*
122 * The ds_fsid_guid is a 56-bit ID that can change to avoid
123 * collisions. The ds_guid is a 64-bit ID that will never
124 * change, so there is a small probability that it will collide.
125 */
126 uint64_t ds_fsid_guid;
127 uint64_t ds_guid;
b128c09f 128 uint64_t ds_flags; /* DS_FLAG_* */
34dc7c2f 129 blkptr_t ds_bp;
b128c09f
BB
130 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */
131 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */
45d1cae3
BB
132 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */
133 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
34dc7c2f
BB
134} dsl_dataset_phys_t;
135
136typedef struct dsl_dataset {
0c66c32d
JG
137 dmu_buf_user_t ds_dbu;
138
34dc7c2f
BB
139 /* Immutable: */
140 struct dsl_dir *ds_dir;
34dc7c2f
BB
141 dmu_buf_t *ds_dbuf;
142 uint64_t ds_object;
143 uint64_t ds_fsid_guid;
0c66c32d 144 boolean_t ds_is_snapshot;
34dc7c2f 145
b128c09f
BB
146 /* only used in syncing context, only valid for non-snapshots: */
147 struct dsl_dataset *ds_prev;
da536844 148 uint64_t ds_bookmarks; /* DMU_OTN_ZAP_METADATA */
34dc7c2f
BB
149
150 /* has internal locking: */
428870ff
BB
151 dsl_deadlist_t ds_deadlist;
152 bplist_t ds_pending_deadlist;
34dc7c2f
BB
153
154 /* protected by lock on pool's dp_dirty_datasets list */
155 txg_node_t ds_dirty_link;
156 list_node_t ds_synced_link;
157
158 /*
159 * ds_phys->ds_<accounting> is also protected by ds_lock.
160 * Protected by ds_lock:
161 */
162 kmutex_t ds_lock;
428870ff 163 objset_t *ds_objset;
45d1cae3 164 uint64_t ds_userrefs;
13fe0198 165 void *ds_owner;
b128c09f
BB
166
167 /*
13fe0198
MA
168 * Long holds prevent the ds from being destroyed; they allow the
169 * ds to remain held even after dropping the dp_config_rwlock.
170 * Owning counts as a long hold. See the comments above
171 * dsl_pool_hold() for details.
b128c09f 172 */
13fe0198 173 refcount_t ds_longholds;
34dc7c2f
BB
174
175 /* no locking; only for making guesses */
176 uint64_t ds_trysnap_txg;
177
178 /* for objset_open() */
179 kmutex_t ds_opening_lock;
180
181 uint64_t ds_reserved; /* cached refreservation */
182 uint64_t ds_quota; /* cached refquota */
183
37abac6d
BP
184 kmutex_t ds_sendstream_lock;
185 list_t ds_sendstreams;
186
0eb21616
JG
187 /* Protected by our dsl_dir's dd_lock */
188 list_t ds_prop_cbs;
189
241b5415
MA
190 /*
191 * For ZFEATURE_FLAG_PER_DATASET features, set if this dataset
192 * uses this feature.
193 */
194 uint8_t ds_feature_inuse[SPA_FEATURES];
195
196 /*
197 * Set if we need to activate the feature on this dataset this txg
198 * (used only in syncing context).
199 */
200 uint8_t ds_feature_activation_needed[SPA_FEATURES];
201
34dc7c2f
BB
202 /* Protected by ds_lock; keep at end of struct for better locality */
203 char ds_snapname[MAXNAMELEN];
204} dsl_dataset_t;
205
d683ddbb
JG
206static inline dsl_dataset_phys_t *
207dsl_dataset_phys(dsl_dataset_t *ds)
208{
209 return (ds->ds_dbuf->db_data);
210}
211
572e2857
BB
212/*
213 * The max length of a temporary tag prefix is the number of hex digits
214 * required to express UINT64_MAX plus one for the hyphen.
215 */
216#define MAX_TAG_PREFIX_LEN 17
217
5dc8b736
MG
218#define dsl_dataset_is_snapshot(ds) \
219 (dsl_dataset_phys(ds)->ds_num_children != 0)
220
34dc7c2f 221#define DS_UNIQUE_IS_ACCURATE(ds) \
d683ddbb 222 ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
34dc7c2f 223
13fe0198
MA
224int dsl_dataset_hold(struct dsl_pool *dp, const char *name, void *tag,
225 dsl_dataset_t **dsp);
6ebebace
JG
226boolean_t dsl_dataset_try_add_ref(struct dsl_pool *dp, dsl_dataset_t *ds,
227 void *tag);
13fe0198
MA
228int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, void *tag,
229 dsl_dataset_t **);
230void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
231int dsl_dataset_own(struct dsl_pool *dp, const char *name,
428870ff 232 void *tag, dsl_dataset_t **dsp);
b128c09f 233int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
13fe0198 234 void *tag, dsl_dataset_t **dsp);
428870ff 235void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
13fe0198
MA
236void dsl_dataset_name(dsl_dataset_t *ds, char *name);
237boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, void *tag);
b128c09f
BB
238uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
239 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
240uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
34dc7c2f 241 uint64_t flags, dmu_tx_t *tx);
13fe0198 242int dsl_dataset_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t *errors);
428870ff 243int dsl_dataset_promote(const char *name, char *conflsnap);
13fe0198
MA
244int dsl_dataset_rename_snapshot(const char *fsname,
245 const char *oldsnapname, const char *newsnapname, boolean_t recursive);
246int dsl_dataset_snapshot_tmp(const char *fsname, const char *snapname,
247 minor_t cleanup_minor, const char *htag);
34dc7c2f 248
34dc7c2f
BB
249blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
250void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
251
252spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
253
19580676
MA
254boolean_t dsl_dataset_modified_since_snap(dsl_dataset_t *ds,
255 dsl_dataset_t *snap);
34dc7c2f
BB
256
257void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
258
428870ff 259void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
34dc7c2f 260 dmu_tx_t *tx);
428870ff
BB
261int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
262 dmu_tx_t *tx, boolean_t async);
263boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
264 uint64_t blk_birth);
34dc7c2f 265uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
6772fb67
BB
266int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
267 uint64_t *value);
34dc7c2f
BB
268
269void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
270void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
271void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
272void dsl_dataset_space(dsl_dataset_t *ds,
273 uint64_t *refdbytesp, uint64_t *availbytesp,
274 uint64_t *usedobjsp, uint64_t *availobjsp);
275uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
330d06f9
MA
276int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
277 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
278int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
279 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
04434775 280boolean_t dsl_dataset_is_dirty(dsl_dataset_t *ds);
34dc7c2f 281
34dc7c2f
BB
282int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
283
284int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
285 uint64_t asize, uint64_t inflight, uint64_t *used,
286 uint64_t *ref_rsrv);
13fe0198 287int dsl_dataset_set_refquota(const char *dsname, zprop_source_t source,
428870ff 288 uint64_t quota);
13fe0198 289int dsl_dataset_set_refreservation(const char *dsname, zprop_source_t source,
428870ff
BB
290 uint64_t reservation);
291
da536844
MA
292boolean_t dsl_dataset_is_before(dsl_dataset_t *later, dsl_dataset_t *earlier,
293 uint64_t earlier_txg);
13fe0198
MA
294void dsl_dataset_long_hold(dsl_dataset_t *ds, void *tag);
295void dsl_dataset_long_rele(dsl_dataset_t *ds, void *tag);
296boolean_t dsl_dataset_long_held(dsl_dataset_t *ds);
297
298int dsl_dataset_clone_swap_check_impl(dsl_dataset_t *clone,
831baf06 299 dsl_dataset_t *origin_head, boolean_t force, void *owner, dmu_tx_t *tx);
13fe0198
MA
300void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t *clone,
301 dsl_dataset_t *origin_head, dmu_tx_t *tx);
302int dsl_dataset_snapshot_check_impl(dsl_dataset_t *ds, const char *snapname,
788eb90c 303 dmu_tx_t *tx, boolean_t recv, uint64_t cnt, cred_t *cr);
13fe0198
MA
304void dsl_dataset_snapshot_sync_impl(dsl_dataset_t *ds, const char *snapname,
305 dmu_tx_t *tx);
306
307void dsl_dataset_remove_from_next_clones(dsl_dataset_t *ds, uint64_t obj,
308 dmu_tx_t *tx);
309void dsl_dataset_recalc_head_uniq(dsl_dataset_t *ds);
310int dsl_dataset_get_snapname(dsl_dataset_t *ds);
311int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
312 uint64_t *value);
788eb90c
JJ
313int dsl_dataset_snap_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx,
314 boolean_t adj_cnt);
13fe0198
MA
315void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t *ds,
316 zprop_source_t source, uint64_t value, dmu_tx_t *tx);
da536844 317void dsl_dataset_zapify(dsl_dataset_t *ds, dmu_tx_t *tx);
46ba1e59 318int dsl_dataset_rollback(const char *fsname, void *owner, nvlist_t *result);
34dc7c2f 319
241b5415
MA
320void dsl_dataset_deactivate_feature(uint64_t dsobj,
321 spa_feature_t f, dmu_tx_t *tx);
322
34dc7c2f
BB
323#ifdef ZFS_DEBUG
324#define dprintf_ds(ds, fmt, ...) do { \
325 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
79c76d5b 326 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
34dc7c2f
BB
327 dsl_dataset_name(ds, __ds_name); \
328 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
329 kmem_free(__ds_name, MAXNAMELEN); \
330 } \
331_NOTE(CONSTCOND) } while (0)
332#else
333#define dprintf_ds(dd, fmt, ...)
334#endif
335
336#ifdef __cplusplus
337}
338#endif
339
340#endif /* _SYS_DSL_DATASET_H */