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) 2011 by Delphix. All rights reserved.
28 #ifndef _SYS_DSL_DATASET_H
29 #define _SYS_DSL_DATASET_H
35 #include <sys/bplist.h>
36 #include <sys/dsl_synctask.h>
37 #include <sys/zfs_context.h>
38 #include <sys/dsl_deadlist.h>
48 #define DS_FLAG_INCONSISTENT (1ULL<<0)
49 #define DS_IS_INCONSISTENT(ds) \
50 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
52 * NB: nopromote can not yet be set, but we want support for it in this
53 * on-disk version, so that we don't need to upgrade for it later. It
54 * will be needed when we implement 'zfs split' (where the split off
55 * clone should not 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 ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)
75 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
76 * name lookups should be performed case-insensitively.
78 #define DS_FLAG_CI_DATASET (1ULL<<16)
80 typedef struct dsl_dataset_phys {
81 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */
82 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */
83 uint64_t ds_prev_snap_txg;
84 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */
85 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
86 uint64_t ds_num_children; /* clone/snap children; ==0 for head */
87 uint64_t ds_creation_time; /* seconds since 1970 */
88 uint64_t ds_creation_txg;
89 uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */
90 uint64_t ds_used_bytes;
91 uint64_t ds_compressed_bytes;
92 uint64_t ds_uncompressed_bytes;
93 uint64_t ds_unique_bytes; /* only relevant to snapshots */
95 * The ds_fsid_guid is a 56-bit ID that can change to avoid
96 * collisions. The ds_guid is a 64-bit ID that will never
97 * change, so there is a small probability that it will collide.
99 uint64_t ds_fsid_guid;
101 uint64_t ds_flags; /* DS_FLAG_* */
103 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */
104 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */
105 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */
106 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
107 } dsl_dataset_phys_t;
109 typedef struct dsl_dataset {
111 struct dsl_dir *ds_dir;
112 dsl_dataset_phys_t *ds_phys;
115 uint64_t ds_fsid_guid;
117 /* only used in syncing context, only valid for non-snapshots: */
118 struct dsl_dataset *ds_prev;
120 /* has internal locking: */
121 dsl_deadlist_t ds_deadlist;
122 bplist_t ds_pending_deadlist;
124 /* to protect against multiple concurrent incremental recv */
125 kmutex_t ds_recvlock;
127 /* protected by lock on pool's dp_dirty_datasets list */
128 txg_node_t ds_dirty_link;
129 list_node_t ds_synced_link;
132 * ds_phys->ds_<accounting> is also protected by ds_lock.
133 * Protected by ds_lock:
137 uint64_t ds_userrefs;
140 * ds_owner is protected by the ds_rwlock and the ds_lock
143 kcondvar_t ds_exclusive_cv;
146 /* no locking; only for making guesses */
147 uint64_t ds_trysnap_txg;
149 /* for objset_open() */
150 kmutex_t ds_opening_lock;
152 uint64_t ds_reserved; /* cached refreservation */
153 uint64_t ds_quota; /* cached refquota */
155 /* Protected by ds_lock; keep at end of struct for better locality */
156 char ds_snapname[MAXNAMELEN];
159 struct dsl_ds_destroyarg {
160 dsl_dataset_t *ds; /* ds to destroy */
161 dsl_dataset_t *rm_origin; /* also remove our origin? */
162 boolean_t is_origin_rm; /* set if removing origin snap */
163 boolean_t defer; /* destroy -d requested? */
164 boolean_t releasing; /* destroying due to release? */
165 boolean_t need_prep; /* do we need to retry due to EBUSY? */
169 * The max length of a temporary tag prefix is the number of hex digits
170 * required to express UINT64_MAX plus one for the hyphen.
172 #define MAX_TAG_PREFIX_LEN 17
174 struct dsl_ds_holdarg {
175 dsl_sync_task_group_t *dstg;
181 char failed[MAXPATHLEN];
185 * Flags for dsl_dataset_rename().
187 #define ZFS_RENAME_RECURSIVE 0x01
188 #define ZFS_RENAME_ALLOW_MOUNTED 0x02
190 #define dsl_dataset_is_snapshot(ds) \
191 ((ds)->ds_phys->ds_num_children != 0)
193 #define DS_UNIQUE_IS_ACCURATE(ds) \
194 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
196 int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp);
197 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,
198 void *tag, dsl_dataset_t **);
199 int dsl_dataset_own(const char *name, boolean_t inconsistentok,
200 void *tag, dsl_dataset_t **dsp);
201 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
202 boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp);
203 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
204 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
205 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
206 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);
207 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,
209 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag);
210 void dsl_register_onexit_hold_cleanup(dsl_dataset_t *ds, const char *htag,
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_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer);
217 int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);
218 dsl_checkfunc_t dsl_dataset_destroy_check;
219 dsl_syncfunc_t dsl_dataset_destroy_sync;
220 dsl_checkfunc_t dsl_dataset_snapshot_check;
221 dsl_syncfunc_t dsl_dataset_snapshot_sync;
222 dsl_syncfunc_t dsl_dataset_user_hold_sync;
223 int dsl_dataset_rename(char *name, const char *newname, int flags);
224 int dsl_dataset_promote(const char *name, char *conflsnap);
225 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
227 int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag,
228 boolean_t recursive, boolean_t temphold, int cleanup_fd);
229 int dsl_dataset_user_hold_for_send(dsl_dataset_t *ds, char *htag,
231 int dsl_dataset_user_release(char *dsname, char *snapname, char *htag,
232 boolean_t recursive);
233 int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj,
234 char *htag, boolean_t retry);
235 int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp);
237 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
238 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
240 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
242 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
244 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
246 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
248 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
249 dmu_tx_t *tx, boolean_t async);
250 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
252 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
254 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
255 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
256 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
257 void dsl_dataset_space(dsl_dataset_t *ds,
258 uint64_t *refdbytesp, uint64_t *availbytesp,
259 uint64_t *usedobjsp, uint64_t *availobjsp);
260 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
261 int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
262 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
263 int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
264 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
266 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
268 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
269 uint64_t asize, uint64_t inflight, uint64_t *used,
271 int dsl_dataset_set_quota(const char *dsname, zprop_source_t source,
273 dsl_syncfunc_t dsl_dataset_set_quota_sync;
274 int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source,
275 uint64_t reservation);
277 int dsl_destroy_inconsistent(const char *dsname, void *arg);
280 #define dprintf_ds(ds, fmt, ...) do { \
281 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
282 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
283 dsl_dataset_name(ds, __ds_name); \
284 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
285 kmem_free(__ds_name, MAXNAMELEN); \
287 _NOTE(CONSTCOND) } while (0)
289 #define dprintf_ds(dd, fmt, ...)
296 #endif /* _SYS_DSL_DATASET_H */