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) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>.
24 * All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. 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>
49 #define DS_FLAG_INCONSISTENT (1ULL<<0)
50 #define DS_IS_INCONSISTENT(ds) \
51 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
53 * NB: nopromote can not yet be set, but we want support for it in this
54 * on-disk version, so that we don't need to upgrade for it later. It
55 * will be needed when we implement 'zfs split' (where the split off
56 * clone should not be promoted).
58 #define DS_FLAG_NOPROMOTE (1ULL<<1)
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).
65 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
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'.
71 #define DS_FLAG_DEFER_DESTROY (1ULL<<3)
72 #define DS_IS_DEFER_DESTROY(ds) \
73 ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)
76 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
77 * name lookups should be performed case-insensitively.
79 #define DS_FLAG_CI_DATASET (1ULL<<16)
81 typedef struct dsl_dataset_phys {
82 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */
83 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */
84 uint64_t ds_prev_snap_txg;
85 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */
86 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
87 uint64_t ds_num_children; /* clone/snap children; ==0 for head */
88 uint64_t ds_creation_time; /* seconds since 1970 */
89 uint64_t ds_creation_txg;
90 uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */
92 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
93 * include all blocks referenced by this dataset, including those
94 * shared with any other datasets.
96 uint64_t ds_referenced_bytes;
97 uint64_t ds_compressed_bytes;
98 uint64_t ds_uncompressed_bytes;
99 uint64_t ds_unique_bytes; /* only relevant to snapshots */
101 * The ds_fsid_guid is a 56-bit ID that can change to avoid
102 * collisions. The ds_guid is a 64-bit ID that will never
103 * change, so there is a small probability that it will collide.
105 uint64_t ds_fsid_guid;
107 uint64_t ds_flags; /* DS_FLAG_* */
109 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */
110 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */
111 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */
112 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
113 } dsl_dataset_phys_t;
115 typedef struct dsl_dataset {
117 struct dsl_dir *ds_dir;
118 dsl_dataset_phys_t *ds_phys;
121 uint64_t ds_fsid_guid;
123 /* only used in syncing context, only valid for non-snapshots: */
124 struct dsl_dataset *ds_prev;
126 /* has internal locking: */
127 dsl_deadlist_t ds_deadlist;
128 bplist_t ds_pending_deadlist;
130 /* to protect against multiple concurrent incremental recv */
131 kmutex_t ds_recvlock;
133 /* protected by lock on pool's dp_dirty_datasets list */
134 txg_node_t ds_dirty_link;
135 list_node_t ds_synced_link;
138 * ds_phys->ds_<accounting> is also protected by ds_lock.
139 * Protected by ds_lock:
143 uint64_t ds_userrefs;
146 * ds_owner is protected by the ds_rwlock and the ds_lock
149 kcondvar_t ds_exclusive_cv;
152 /* no locking; only for making guesses */
153 uint64_t ds_trysnap_txg;
155 /* for objset_open() */
156 kmutex_t ds_opening_lock;
158 uint64_t ds_reserved; /* cached refreservation */
159 uint64_t ds_quota; /* cached refquota */
161 kmutex_t ds_sendstream_lock;
162 list_t ds_sendstreams;
164 /* Protected by ds_lock; keep at end of struct for better locality */
165 char ds_snapname[MAXNAMELEN];
168 struct dsl_ds_destroyarg {
169 dsl_dataset_t *ds; /* ds to destroy */
170 dsl_dataset_t *rm_origin; /* also remove our origin? */
171 boolean_t is_origin_rm; /* set if removing origin snap */
172 boolean_t defer; /* destroy -d requested? */
173 boolean_t releasing; /* destroying due to release? */
174 boolean_t need_prep; /* do we need to retry due to EBUSY? */
178 * The max length of a temporary tag prefix is the number of hex digits
179 * required to express UINT64_MAX plus one for the hyphen.
181 #define MAX_TAG_PREFIX_LEN 17
183 struct dsl_ds_holdarg {
184 dsl_sync_task_group_t *dstg;
190 char failed[MAXPATHLEN];
194 * Flags for dsl_dataset_rename().
196 #define ZFS_RENAME_RECURSIVE 0x01
197 #define ZFS_RENAME_ALLOW_MOUNTED 0x02
199 #define dsl_dataset_is_snapshot(ds) \
200 ((ds)->ds_phys->ds_num_children != 0)
202 #define DS_UNIQUE_IS_ACCURATE(ds) \
203 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
205 int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp);
206 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,
207 void *tag, dsl_dataset_t **);
208 int dsl_dataset_own(const char *name, boolean_t inconsistentok,
209 void *tag, dsl_dataset_t **dsp);
210 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
211 boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp);
212 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
213 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
214 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
215 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);
216 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,
218 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag);
219 void dsl_register_onexit_hold_cleanup(dsl_dataset_t *ds, const char *htag,
221 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
222 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
223 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
224 uint64_t flags, dmu_tx_t *tx);
225 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer);
226 int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);
227 dsl_checkfunc_t dsl_dataset_destroy_check;
228 dsl_syncfunc_t dsl_dataset_destroy_sync;
229 dsl_checkfunc_t dsl_dataset_snapshot_check;
230 dsl_syncfunc_t dsl_dataset_snapshot_sync;
231 dsl_syncfunc_t dsl_dataset_user_hold_sync;
232 int dsl_dataset_rename(char *name, const char *newname, int flags);
233 int dsl_dataset_promote(const char *name, char *conflsnap);
234 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
236 int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag,
237 boolean_t recursive, boolean_t temphold, int cleanup_fd);
238 int dsl_dataset_user_hold_for_send(dsl_dataset_t *ds, char *htag,
240 int dsl_dataset_user_release(char *dsname, char *snapname, char *htag,
241 boolean_t recursive);
242 int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj,
243 char *htag, boolean_t retry);
244 int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp);
246 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
247 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
249 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
251 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
253 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
255 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
257 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
258 dmu_tx_t *tx, boolean_t async);
259 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
261 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
263 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
264 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
265 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
266 void dsl_dataset_space(dsl_dataset_t *ds,
267 uint64_t *refdbytesp, uint64_t *availbytesp,
268 uint64_t *usedobjsp, uint64_t *availobjsp);
269 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
270 int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
271 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
272 int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
273 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
275 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
277 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
278 uint64_t asize, uint64_t inflight, uint64_t *used,
280 int dsl_dataset_set_quota(const char *dsname, zprop_source_t source,
282 dsl_syncfunc_t dsl_dataset_set_quota_sync;
283 int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source,
284 uint64_t reservation);
286 int dsl_destroy_inconsistent(const char *dsname, void *arg);
289 #define dprintf_ds(ds, fmt, ...) do { \
290 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
291 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
292 dsl_dataset_name(ds, __ds_name); \
293 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
294 kmem_free(__ds_name, MAXNAMELEN); \
296 _NOTE(CONSTCOND) } while (0)
298 #define dprintf_ds(dd, fmt, ...)
305 #endif /* _SYS_DSL_DATASET_H */