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) 2012 by Delphix. All rights reserved.
24 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 #ifndef _SYS_DSL_DATASET_H
28 #define _SYS_DSL_DATASET_H
34 #include <sys/bplist.h>
35 #include <sys/dsl_synctask.h>
36 #include <sys/zfs_context.h>
37 #include <sys/dsl_deadlist.h>
47 #define DS_FLAG_INCONSISTENT (1ULL<<0)
48 #define DS_IS_INCONSISTENT(ds) \
49 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
51 * NB: nopromote can not yet be set, but we want support for it in this
52 * on-disk version, so that we don't need to upgrade for it later. It
53 * will be needed when we implement 'zfs split' (where the split off
54 * clone should not be promoted).
56 #define DS_FLAG_NOPROMOTE (1ULL<<1)
59 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
60 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
61 * refquota/refreservations).
63 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
66 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
67 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
69 #define DS_FLAG_DEFER_DESTROY (1ULL<<3)
70 #define DS_IS_DEFER_DESTROY(ds) \
71 ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)
74 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
75 * name lookups should be performed case-insensitively.
77 #define DS_FLAG_CI_DATASET (1ULL<<16)
79 typedef struct dsl_dataset_phys
{
80 uint64_t ds_dir_obj
; /* DMU_OT_DSL_DIR */
81 uint64_t ds_prev_snap_obj
; /* DMU_OT_DSL_DATASET */
82 uint64_t ds_prev_snap_txg
;
83 uint64_t ds_next_snap_obj
; /* DMU_OT_DSL_DATASET */
84 uint64_t ds_snapnames_zapobj
; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
85 uint64_t ds_num_children
; /* clone/snap children; ==0 for head */
86 uint64_t ds_creation_time
; /* seconds since 1970 */
87 uint64_t ds_creation_txg
;
88 uint64_t ds_deadlist_obj
; /* DMU_OT_DEADLIST */
90 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
91 * include all blocks referenced by this dataset, including those
92 * shared with any other datasets.
94 uint64_t ds_referenced_bytes
;
95 uint64_t ds_compressed_bytes
;
96 uint64_t ds_uncompressed_bytes
;
97 uint64_t ds_unique_bytes
; /* only relevant to snapshots */
99 * The ds_fsid_guid is a 56-bit ID that can change to avoid
100 * collisions. The ds_guid is a 64-bit ID that will never
101 * change, so there is a small probability that it will collide.
103 uint64_t ds_fsid_guid
;
105 uint64_t ds_flags
; /* DS_FLAG_* */
107 uint64_t ds_next_clones_obj
; /* DMU_OT_DSL_CLONES */
108 uint64_t ds_props_obj
; /* DMU_OT_DSL_PROPS for snaps */
109 uint64_t ds_userrefs_obj
; /* DMU_OT_USERREFS */
110 uint64_t ds_pad
[5]; /* pad out to 320 bytes for good measure */
111 } dsl_dataset_phys_t
;
113 typedef struct dsl_dataset
{
115 struct dsl_dir
*ds_dir
;
116 dsl_dataset_phys_t
*ds_phys
;
119 uint64_t ds_fsid_guid
;
121 /* only used in syncing context, only valid for non-snapshots: */
122 struct dsl_dataset
*ds_prev
;
124 /* has internal locking: */
125 dsl_deadlist_t ds_deadlist
;
126 bplist_t ds_pending_deadlist
;
128 /* to protect against multiple concurrent incremental recv */
129 kmutex_t ds_recvlock
;
131 /* protected by lock on pool's dp_dirty_datasets list */
132 txg_node_t ds_dirty_link
;
133 list_node_t ds_synced_link
;
136 * ds_phys->ds_<accounting> is also protected by ds_lock.
137 * Protected by ds_lock:
141 uint64_t ds_userrefs
;
144 * ds_owner is protected by the ds_rwlock and the ds_lock
147 kcondvar_t ds_exclusive_cv
;
150 /* no locking; only for making guesses */
151 uint64_t ds_trysnap_txg
;
153 /* for objset_open() */
154 kmutex_t ds_opening_lock
;
156 uint64_t ds_reserved
; /* cached refreservation */
157 uint64_t ds_quota
; /* cached refquota */
159 kmutex_t ds_sendstream_lock
;
160 list_t ds_sendstreams
;
162 /* Protected by ds_lock; keep at end of struct for better locality */
163 char ds_snapname
[MAXNAMELEN
];
166 struct dsl_ds_destroyarg
{
167 dsl_dataset_t
*ds
; /* ds to destroy */
168 dsl_dataset_t
*rm_origin
; /* also remove our origin? */
169 boolean_t is_origin_rm
; /* set if removing origin snap */
170 boolean_t defer
; /* destroy -d requested? */
171 boolean_t releasing
; /* destroying due to release? */
172 boolean_t need_prep
; /* do we need to retry due to EBUSY? */
176 * The max length of a temporary tag prefix is the number of hex digits
177 * required to express UINT64_MAX plus one for the hyphen.
179 #define MAX_TAG_PREFIX_LEN 17
181 struct dsl_ds_holdarg
{
182 dsl_sync_task_group_t
*dstg
;
188 char failed
[MAXPATHLEN
];
191 #define dsl_dataset_is_snapshot(ds) \
192 ((ds)->ds_phys->ds_num_children != 0)
194 #define DS_UNIQUE_IS_ACCURATE(ds) \
195 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
197 int dsl_dataset_hold(const char *name
, void *tag
, dsl_dataset_t
**dsp
);
198 int dsl_dataset_hold_obj(struct dsl_pool
*dp
, uint64_t dsobj
,
199 void *tag
, dsl_dataset_t
**);
200 int dsl_dataset_own(const char *name
, boolean_t inconsistentok
,
201 void *tag
, dsl_dataset_t
**dsp
);
202 int dsl_dataset_own_obj(struct dsl_pool
*dp
, uint64_t dsobj
,
203 boolean_t inconsistentok
, void *tag
, dsl_dataset_t
**dsp
);
204 void dsl_dataset_name(dsl_dataset_t
*ds
, char *name
);
205 void dsl_dataset_rele(dsl_dataset_t
*ds
, void *tag
);
206 void dsl_dataset_disown(dsl_dataset_t
*ds
, void *tag
);
207 void dsl_dataset_drop_ref(dsl_dataset_t
*ds
, void *tag
);
208 boolean_t
dsl_dataset_tryown(dsl_dataset_t
*ds
, boolean_t inconsistentok
,
210 void dsl_dataset_make_exclusive(dsl_dataset_t
*ds
, void *tag
);
211 void dsl_register_onexit_hold_cleanup(dsl_dataset_t
*ds
, const char *htag
,
213 uint64_t dsl_dataset_create_sync(dsl_dir_t
*pds
, const char *lastname
,
214 dsl_dataset_t
*origin
, uint64_t flags
, cred_t
*, dmu_tx_t
*);
215 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t
*dd
, dsl_dataset_t
*origin
,
216 uint64_t flags
, dmu_tx_t
*tx
);
217 int dsl_dataset_destroy(dsl_dataset_t
*ds
, void *tag
, boolean_t defer
);
218 int dsl_snapshots_destroy(char *fsname
, char *snapname
, boolean_t defer
);
219 dsl_checkfunc_t dsl_dataset_destroy_check
;
220 dsl_syncfunc_t dsl_dataset_destroy_sync
;
221 dsl_checkfunc_t dsl_dataset_snapshot_check
;
222 dsl_syncfunc_t dsl_dataset_snapshot_sync
;
223 dsl_syncfunc_t dsl_dataset_user_hold_sync
;
224 int dsl_dataset_rename(char *name
, const char *newname
, boolean_t recursive
);
225 int dsl_dataset_promote(const char *name
, char *conflsnap
);
226 int dsl_dataset_clone_swap(dsl_dataset_t
*clone
, dsl_dataset_t
*origin_head
,
228 int dsl_dataset_user_hold(char *dsname
, char *snapname
, char *htag
,
229 boolean_t recursive
, boolean_t temphold
, int cleanup_fd
);
230 int dsl_dataset_user_hold_for_send(dsl_dataset_t
*ds
, char *htag
,
232 int dsl_dataset_user_release(char *dsname
, char *snapname
, char *htag
,
233 boolean_t recursive
);
234 int dsl_dataset_user_release_tmp(struct dsl_pool
*dp
, uint64_t dsobj
,
235 char *htag
, boolean_t retry
);
236 int dsl_dataset_get_holds(const char *dsname
, nvlist_t
**nvp
);
238 blkptr_t
*dsl_dataset_get_blkptr(dsl_dataset_t
*ds
);
239 void dsl_dataset_set_blkptr(dsl_dataset_t
*ds
, blkptr_t
*bp
, dmu_tx_t
*tx
);
241 spa_t
*dsl_dataset_get_spa(dsl_dataset_t
*ds
);
243 boolean_t
dsl_dataset_modified_since_lastsnap(dsl_dataset_t
*ds
);
245 void dsl_dataset_sync(dsl_dataset_t
*os
, zio_t
*zio
, dmu_tx_t
*tx
);
247 void dsl_dataset_block_born(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
249 int dsl_dataset_block_kill(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
250 dmu_tx_t
*tx
, boolean_t async
);
251 boolean_t
dsl_dataset_block_freeable(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
253 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t
*ds
);
254 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
257 void dsl_dataset_dirty(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
258 void dsl_dataset_stats(dsl_dataset_t
*os
, nvlist_t
*nv
);
259 void dsl_dataset_fast_stat(dsl_dataset_t
*ds
, dmu_objset_stats_t
*stat
);
260 void dsl_dataset_space(dsl_dataset_t
*ds
,
261 uint64_t *refdbytesp
, uint64_t *availbytesp
,
262 uint64_t *usedobjsp
, uint64_t *availobjsp
);
263 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t
*ds
);
264 int dsl_dataset_space_written(dsl_dataset_t
*oldsnap
, dsl_dataset_t
*new,
265 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
266 int dsl_dataset_space_wouldfree(dsl_dataset_t
*firstsnap
, dsl_dataset_t
*last
,
267 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
268 boolean_t
dsl_dataset_is_dirty(dsl_dataset_t
*ds
);
270 int dsl_dsobj_to_dsname(char *pname
, uint64_t obj
, char *buf
);
272 int dsl_dataset_check_quota(dsl_dataset_t
*ds
, boolean_t check_quota
,
273 uint64_t asize
, uint64_t inflight
, uint64_t *used
,
275 int dsl_dataset_set_quota(const char *dsname
, zprop_source_t source
,
277 dsl_syncfunc_t dsl_dataset_set_quota_sync
;
278 int dsl_dataset_set_reservation(const char *dsname
, zprop_source_t source
,
279 uint64_t reservation
);
281 int dsl_destroy_inconsistent(const char *dsname
, void *arg
);
284 #define dprintf_ds(ds, fmt, ...) do { \
285 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
286 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_PUSHPAGE); \
287 dsl_dataset_name(ds, __ds_name); \
288 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
289 kmem_free(__ds_name, MAXNAMELEN); \
291 _NOTE(CONSTCOND) } while (0)
293 #define dprintf_ds(dd, fmt, ...)
300 #endif /* _SYS_DSL_DATASET_H */