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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2013 by Delphix. All rights reserved.
24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2013 Steven Hartland. All rights reserved.
26 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
29 #ifndef _SYS_DSL_DATASET_H
30 #define _SYS_DSL_DATASET_H
36 #include <sys/bplist.h>
37 #include <sys/dsl_synctask.h>
38 #include <sys/zfs_context.h>
39 #include <sys/dsl_deadlist.h>
40 #include <sys/refcount.h>
50 #define DS_FLAG_INCONSISTENT (1ULL<<0)
51 #define DS_IS_INCONSISTENT(ds) \
52 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT)
55 * Do not allow this dataset to be promoted.
57 #define DS_FLAG_NOPROMOTE (1ULL<<1)
60 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
61 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
62 * refquota/refreservations).
64 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
67 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
68 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
70 #define DS_FLAG_DEFER_DESTROY (1ULL<<3)
71 #define DS_IS_DEFER_DESTROY(ds) \
72 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY)
75 * DS_FIELD_* are strings that are used in the "extensified" dataset zap object.
76 * They should be of the format <reverse-dns>:<field>.
80 * This field's value is the object ID of a zap object which contains the
81 * bookmarks of this dataset. If it is present, then this dataset is counted
82 * in the refcount of the SPA_FEATURES_BOOKMARKS feature.
84 #define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks"
87 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
88 * name lookups should be performed case-insensitively.
90 #define DS_FLAG_CI_DATASET (1ULL<<16)
92 #define DS_CREATE_FLAG_NODIRTY (1ULL<<24)
94 typedef struct dsl_dataset_phys {
95 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */
96 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */
97 uint64_t ds_prev_snap_txg;
98 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */
99 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
100 uint64_t ds_num_children; /* clone/snap children; ==0 for head */
101 uint64_t ds_creation_time; /* seconds since 1970 */
102 uint64_t ds_creation_txg;
103 uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */
105 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
106 * include all blocks referenced by this dataset, including those
107 * shared with any other datasets.
109 uint64_t ds_referenced_bytes;
110 uint64_t ds_compressed_bytes;
111 uint64_t ds_uncompressed_bytes;
112 uint64_t ds_unique_bytes; /* only relevant to snapshots */
114 * The ds_fsid_guid is a 56-bit ID that can change to avoid
115 * collisions. The ds_guid is a 64-bit ID that will never
116 * change, so there is a small probability that it will collide.
118 uint64_t ds_fsid_guid;
120 uint64_t ds_flags; /* DS_FLAG_* */
122 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */
123 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */
124 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */
125 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
126 } dsl_dataset_phys_t;
128 typedef struct dsl_dataset {
129 dmu_buf_user_t ds_dbu;
132 struct dsl_dir *ds_dir;
135 uint64_t ds_fsid_guid;
136 boolean_t ds_is_snapshot;
138 /* only used in syncing context, only valid for non-snapshots: */
139 struct dsl_dataset *ds_prev;
140 uint64_t ds_bookmarks; /* DMU_OTN_ZAP_METADATA */
142 /* has internal locking: */
143 dsl_deadlist_t ds_deadlist;
144 bplist_t ds_pending_deadlist;
146 /* protected by lock on pool's dp_dirty_datasets list */
147 txg_node_t ds_dirty_link;
148 list_node_t ds_synced_link;
151 * ds_phys->ds_<accounting> is also protected by ds_lock.
152 * Protected by ds_lock:
156 uint64_t ds_userrefs;
160 * Long holds prevent the ds from being destroyed; they allow the
161 * ds to remain held even after dropping the dp_config_rwlock.
162 * Owning counts as a long hold. See the comments above
163 * dsl_pool_hold() for details.
165 refcount_t ds_longholds;
167 /* no locking; only for making guesses */
168 uint64_t ds_trysnap_txg;
170 /* for objset_open() */
171 kmutex_t ds_opening_lock;
173 uint64_t ds_reserved; /* cached refreservation */
174 uint64_t ds_quota; /* cached refquota */
176 kmutex_t ds_sendstream_lock;
177 list_t ds_sendstreams;
179 /* Protected by ds_lock; keep at end of struct for better locality */
180 char ds_snapname[MAXNAMELEN];
183 static inline dsl_dataset_phys_t *
184 dsl_dataset_phys(dsl_dataset_t *ds)
186 return (ds->ds_dbuf->db_data);
190 * The max length of a temporary tag prefix is the number of hex digits
191 * required to express UINT64_MAX plus one for the hyphen.
193 #define MAX_TAG_PREFIX_LEN 17
195 #define DS_UNIQUE_IS_ACCURATE(ds) \
196 ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
198 int dsl_dataset_hold(struct dsl_pool *dp, const char *name, void *tag,
199 dsl_dataset_t **dsp);
200 boolean_t dsl_dataset_try_add_ref(struct dsl_pool *dp, dsl_dataset_t *ds,
202 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, void *tag,
204 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
205 int dsl_dataset_own(struct dsl_pool *dp, const char *name,
206 void *tag, dsl_dataset_t **dsp);
207 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
208 void *tag, dsl_dataset_t **dsp);
209 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
210 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
211 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, void *tag);
212 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
213 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
214 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
215 uint64_t flags, dmu_tx_t *tx);
216 int dsl_dataset_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t *errors);
217 int dsl_dataset_promote(const char *name, char *conflsnap);
218 int dsl_dataset_rename_snapshot(const char *fsname,
219 const char *oldsnapname, const char *newsnapname, boolean_t recursive);
220 int dsl_dataset_snapshot_tmp(const char *fsname, const char *snapname,
221 minor_t cleanup_minor, const char *htag);
223 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
224 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
226 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
228 boolean_t dsl_dataset_modified_since_snap(dsl_dataset_t *ds,
229 dsl_dataset_t *snap);
231 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
233 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
235 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
236 dmu_tx_t *tx, boolean_t async);
237 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
239 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
240 int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
243 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
244 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
245 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
246 void dsl_dataset_space(dsl_dataset_t *ds,
247 uint64_t *refdbytesp, uint64_t *availbytesp,
248 uint64_t *usedobjsp, uint64_t *availobjsp);
249 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
250 int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
251 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
252 int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
253 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
254 boolean_t dsl_dataset_is_dirty(dsl_dataset_t *ds);
256 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
258 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
259 uint64_t asize, uint64_t inflight, uint64_t *used,
261 int dsl_dataset_set_refquota(const char *dsname, zprop_source_t source,
263 int dsl_dataset_set_refreservation(const char *dsname, zprop_source_t source,
264 uint64_t reservation);
266 boolean_t dsl_dataset_is_before(dsl_dataset_t *later, dsl_dataset_t *earlier,
267 uint64_t earlier_txg);
268 void dsl_dataset_long_hold(dsl_dataset_t *ds, void *tag);
269 void dsl_dataset_long_rele(dsl_dataset_t *ds, void *tag);
270 boolean_t dsl_dataset_long_held(dsl_dataset_t *ds);
272 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t *clone,
273 dsl_dataset_t *origin_head, boolean_t force, void *owner, dmu_tx_t *tx);
274 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t *clone,
275 dsl_dataset_t *origin_head, dmu_tx_t *tx);
276 int dsl_dataset_snapshot_check_impl(dsl_dataset_t *ds, const char *snapname,
277 dmu_tx_t *tx, boolean_t recv, uint64_t cnt, cred_t *cr);
278 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t *ds, const char *snapname,
281 void dsl_dataset_remove_from_next_clones(dsl_dataset_t *ds, uint64_t obj,
283 void dsl_dataset_recalc_head_uniq(dsl_dataset_t *ds);
284 int dsl_dataset_get_snapname(dsl_dataset_t *ds);
285 int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
287 int dsl_dataset_snap_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx,
289 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t *ds,
290 zprop_source_t source, uint64_t value, dmu_tx_t *tx);
291 void dsl_dataset_zapify(dsl_dataset_t *ds, dmu_tx_t *tx);
292 int dsl_dataset_rollback(const char *fsname, void *owner, nvlist_t *result);
295 #define dprintf_ds(ds, fmt, ...) do { \
296 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
297 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
298 dsl_dataset_name(ds, __ds_name); \
299 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
300 kmem_free(__ds_name, MAXNAMELEN); \
302 _NOTE(CONSTCOND) } while (0)
304 #define dprintf_ds(dd, fmt, ...)
311 #endif /* _SYS_DSL_DATASET_H */