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) 2012, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2013 Steven Hartland. 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>
39 #include <sys/refcount.h>
49 #define DS_FLAG_INCONSISTENT (1ULL<<0)
50 #define DS_IS_INCONSISTENT(ds) \
51 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
54 * Do not allow this dataset to 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_FIELD_* are strings that are used in the "extensified" dataset zap object.
75 * They should be of the format <reverse-dns>:<field>.
79 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
80 * name lookups should be performed case-insensitively.
82 #define DS_FLAG_CI_DATASET (1ULL<<16)
84 #define DS_CREATE_FLAG_NODIRTY (1ULL<<24)
86 typedef struct dsl_dataset_phys
{
87 uint64_t ds_dir_obj
; /* DMU_OT_DSL_DIR */
88 uint64_t ds_prev_snap_obj
; /* DMU_OT_DSL_DATASET */
89 uint64_t ds_prev_snap_txg
;
90 uint64_t ds_next_snap_obj
; /* DMU_OT_DSL_DATASET */
91 uint64_t ds_snapnames_zapobj
; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
92 uint64_t ds_num_children
; /* clone/snap children; ==0 for head */
93 uint64_t ds_creation_time
; /* seconds since 1970 */
94 uint64_t ds_creation_txg
;
95 uint64_t ds_deadlist_obj
; /* DMU_OT_DEADLIST */
97 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
98 * include all blocks referenced by this dataset, including those
99 * shared with any other datasets.
101 uint64_t ds_referenced_bytes
;
102 uint64_t ds_compressed_bytes
;
103 uint64_t ds_uncompressed_bytes
;
104 uint64_t ds_unique_bytes
; /* only relevant to snapshots */
106 * The ds_fsid_guid is a 56-bit ID that can change to avoid
107 * collisions. The ds_guid is a 64-bit ID that will never
108 * change, so there is a small probability that it will collide.
110 uint64_t ds_fsid_guid
;
112 uint64_t ds_flags
; /* DS_FLAG_* */
114 uint64_t ds_next_clones_obj
; /* DMU_OT_DSL_CLONES */
115 uint64_t ds_props_obj
; /* DMU_OT_DSL_PROPS for snaps */
116 uint64_t ds_userrefs_obj
; /* DMU_OT_USERREFS */
117 uint64_t ds_pad
[5]; /* pad out to 320 bytes for good measure */
118 } dsl_dataset_phys_t
;
120 typedef struct dsl_dataset
{
122 struct dsl_dir
*ds_dir
;
123 dsl_dataset_phys_t
*ds_phys
;
126 uint64_t ds_fsid_guid
;
128 /* only used in syncing context, only valid for non-snapshots: */
129 struct dsl_dataset
*ds_prev
;
131 /* has internal locking: */
132 dsl_deadlist_t ds_deadlist
;
133 bplist_t ds_pending_deadlist
;
135 /* protected by lock on pool's dp_dirty_datasets list */
136 txg_node_t ds_dirty_link
;
137 list_node_t ds_synced_link
;
140 * ds_phys->ds_<accounting> is also protected by ds_lock.
141 * Protected by ds_lock:
145 uint64_t ds_userrefs
;
149 * Long holds prevent the ds from being destroyed; they allow the
150 * ds to remain held even after dropping the dp_config_rwlock.
151 * Owning counts as a long hold. See the comments above
152 * dsl_pool_hold() for details.
154 refcount_t ds_longholds
;
156 /* no locking; only for making guesses */
157 uint64_t ds_trysnap_txg
;
159 /* for objset_open() */
160 kmutex_t ds_opening_lock
;
162 uint64_t ds_reserved
; /* cached refreservation */
163 uint64_t ds_quota
; /* cached refquota */
165 kmutex_t ds_sendstream_lock
;
166 list_t ds_sendstreams
;
168 /* Protected by ds_lock; keep at end of struct for better locality */
169 char ds_snapname
[MAXNAMELEN
];
173 * The max length of a temporary tag prefix is the number of hex digits
174 * required to express UINT64_MAX plus one for the hyphen.
176 #define MAX_TAG_PREFIX_LEN 17
178 #define dsl_dataset_is_snapshot(ds) \
179 ((ds)->ds_phys->ds_num_children != 0)
181 #define DS_UNIQUE_IS_ACCURATE(ds) \
182 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
184 int dsl_dataset_hold(struct dsl_pool
*dp
, const char *name
, void *tag
,
185 dsl_dataset_t
**dsp
);
186 int dsl_dataset_hold_obj(struct dsl_pool
*dp
, uint64_t dsobj
, void *tag
,
188 void dsl_dataset_rele(dsl_dataset_t
*ds
, void *tag
);
189 int dsl_dataset_own(struct dsl_pool
*dp
, const char *name
,
190 void *tag
, dsl_dataset_t
**dsp
);
191 int dsl_dataset_own_obj(struct dsl_pool
*dp
, uint64_t dsobj
,
192 void *tag
, dsl_dataset_t
**dsp
);
193 void dsl_dataset_disown(dsl_dataset_t
*ds
, void *tag
);
194 void dsl_dataset_name(dsl_dataset_t
*ds
, char *name
);
195 boolean_t
dsl_dataset_tryown(dsl_dataset_t
*ds
, void *tag
);
196 uint64_t dsl_dataset_create_sync(dsl_dir_t
*pds
, const char *lastname
,
197 dsl_dataset_t
*origin
, uint64_t flags
, cred_t
*, dmu_tx_t
*);
198 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t
*dd
, dsl_dataset_t
*origin
,
199 uint64_t flags
, dmu_tx_t
*tx
);
200 int dsl_dataset_snapshot(nvlist_t
*snaps
, nvlist_t
*props
, nvlist_t
*errors
);
201 int dsl_dataset_promote(const char *name
, char *conflsnap
);
202 int dsl_dataset_rename_snapshot(const char *fsname
,
203 const char *oldsnapname
, const char *newsnapname
, boolean_t recursive
);
204 int dsl_dataset_snapshot_tmp(const char *fsname
, const char *snapname
,
205 minor_t cleanup_minor
, const char *htag
);
207 blkptr_t
*dsl_dataset_get_blkptr(dsl_dataset_t
*ds
);
208 void dsl_dataset_set_blkptr(dsl_dataset_t
*ds
, blkptr_t
*bp
, dmu_tx_t
*tx
);
210 spa_t
*dsl_dataset_get_spa(dsl_dataset_t
*ds
);
212 boolean_t
dsl_dataset_modified_since_snap(dsl_dataset_t
*ds
,
213 dsl_dataset_t
*snap
);
215 void dsl_dataset_sync(dsl_dataset_t
*os
, zio_t
*zio
, dmu_tx_t
*tx
);
217 void dsl_dataset_block_born(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
219 int dsl_dataset_block_kill(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
220 dmu_tx_t
*tx
, boolean_t async
);
221 boolean_t
dsl_dataset_block_freeable(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
223 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t
*ds
);
224 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
227 void dsl_dataset_dirty(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
228 void dsl_dataset_stats(dsl_dataset_t
*os
, nvlist_t
*nv
);
229 void dsl_dataset_fast_stat(dsl_dataset_t
*ds
, dmu_objset_stats_t
*stat
);
230 void dsl_dataset_space(dsl_dataset_t
*ds
,
231 uint64_t *refdbytesp
, uint64_t *availbytesp
,
232 uint64_t *usedobjsp
, uint64_t *availobjsp
);
233 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t
*ds
);
234 int dsl_dataset_space_written(dsl_dataset_t
*oldsnap
, dsl_dataset_t
*new,
235 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
236 int dsl_dataset_space_wouldfree(dsl_dataset_t
*firstsnap
, dsl_dataset_t
*last
,
237 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
238 boolean_t
dsl_dataset_is_dirty(dsl_dataset_t
*ds
);
240 int dsl_dsobj_to_dsname(char *pname
, uint64_t obj
, char *buf
);
242 int dsl_dataset_check_quota(dsl_dataset_t
*ds
, boolean_t check_quota
,
243 uint64_t asize
, uint64_t inflight
, uint64_t *used
,
245 int dsl_dataset_set_refquota(const char *dsname
, zprop_source_t source
,
247 int dsl_dataset_set_refreservation(const char *dsname
, zprop_source_t source
,
248 uint64_t reservation
);
250 boolean_t
dsl_dataset_is_before(dsl_dataset_t
*later
, dsl_dataset_t
*earlier
);
251 void dsl_dataset_long_hold(dsl_dataset_t
*ds
, void *tag
);
252 void dsl_dataset_long_rele(dsl_dataset_t
*ds
, void *tag
);
253 boolean_t
dsl_dataset_long_held(dsl_dataset_t
*ds
);
255 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t
*clone
,
256 dsl_dataset_t
*origin_head
, boolean_t force
, void *owner
, dmu_tx_t
*tx
);
257 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t
*clone
,
258 dsl_dataset_t
*origin_head
, dmu_tx_t
*tx
);
259 int dsl_dataset_snapshot_check_impl(dsl_dataset_t
*ds
, const char *snapname
,
260 dmu_tx_t
*tx
, boolean_t recv
);
261 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t
*ds
, const char *snapname
,
264 void dsl_dataset_remove_from_next_clones(dsl_dataset_t
*ds
, uint64_t obj
,
266 void dsl_dataset_recalc_head_uniq(dsl_dataset_t
*ds
);
267 int dsl_dataset_get_snapname(dsl_dataset_t
*ds
);
268 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
270 int dsl_dataset_snap_remove(dsl_dataset_t
*ds
, const char *name
, dmu_tx_t
*tx
);
271 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t
*ds
,
272 zprop_source_t source
, uint64_t value
, dmu_tx_t
*tx
);
273 int dsl_dataset_rollback(const char *fsname
, void *owner
, nvlist_t
*result
);
276 #define dprintf_ds(ds, fmt, ...) do { \
277 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
278 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_PUSHPAGE); \
279 dsl_dataset_name(ds, __ds_name); \
280 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
281 kmem_free(__ds_name, MAXNAMELEN); \
283 _NOTE(CONSTCOND) } while (0)
285 #define dprintf_ds(dd, fmt, ...)
292 #endif /* _SYS_DSL_DATASET_H */