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, 2015 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>
41 #include <zfeature_common.h>
51 #define DS_FLAG_INCONSISTENT (1ULL<<0)
52 #define DS_IS_INCONSISTENT(ds) \
53 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT)
56 * Do not allow this dataset to 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 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY)
76 * DS_FIELD_* are strings that are used in the "extensified" dataset zap object.
77 * They should be of the format <reverse-dns>:<field>.
81 * This field's value is the object ID of a zap object which contains the
82 * bookmarks of this dataset. If it is present, then this dataset is counted
83 * in the refcount of the SPA_FEATURES_BOOKMARKS feature.
85 #define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks"
88 * This field is present (with value=0) if this dataset may contain large
89 * blocks (>128KB). If it is present, then this dataset
90 * is counted in the refcount of the SPA_FEATURE_LARGE_BLOCKS feature.
92 #define DS_FIELD_LARGE_BLOCKS "org.open-zfs:large_blocks"
95 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
96 * name lookups should be performed case-insensitively.
98 #define DS_FLAG_CI_DATASET (1ULL<<16)
100 #define DS_CREATE_FLAG_NODIRTY (1ULL<<24)
102 typedef struct dsl_dataset_phys
{
103 uint64_t ds_dir_obj
; /* DMU_OT_DSL_DIR */
104 uint64_t ds_prev_snap_obj
; /* DMU_OT_DSL_DATASET */
105 uint64_t ds_prev_snap_txg
;
106 uint64_t ds_next_snap_obj
; /* DMU_OT_DSL_DATASET */
107 uint64_t ds_snapnames_zapobj
; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
108 uint64_t ds_num_children
; /* clone/snap children; ==0 for head */
109 uint64_t ds_creation_time
; /* seconds since 1970 */
110 uint64_t ds_creation_txg
;
111 uint64_t ds_deadlist_obj
; /* DMU_OT_DEADLIST */
113 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
114 * include all blocks referenced by this dataset, including those
115 * shared with any other datasets.
117 uint64_t ds_referenced_bytes
;
118 uint64_t ds_compressed_bytes
;
119 uint64_t ds_uncompressed_bytes
;
120 uint64_t ds_unique_bytes
; /* only relevant to snapshots */
122 * The ds_fsid_guid is a 56-bit ID that can change to avoid
123 * collisions. The ds_guid is a 64-bit ID that will never
124 * change, so there is a small probability that it will collide.
126 uint64_t ds_fsid_guid
;
128 uint64_t ds_flags
; /* DS_FLAG_* */
130 uint64_t ds_next_clones_obj
; /* DMU_OT_DSL_CLONES */
131 uint64_t ds_props_obj
; /* DMU_OT_DSL_PROPS for snaps */
132 uint64_t ds_userrefs_obj
; /* DMU_OT_USERREFS */
133 uint64_t ds_pad
[5]; /* pad out to 320 bytes for good measure */
134 } dsl_dataset_phys_t
;
136 typedef struct dsl_dataset
{
137 dmu_buf_user_t ds_dbu
;
140 struct dsl_dir
*ds_dir
;
143 uint64_t ds_fsid_guid
;
144 boolean_t ds_is_snapshot
;
146 /* only used in syncing context, only valid for non-snapshots: */
147 struct dsl_dataset
*ds_prev
;
148 uint64_t ds_bookmarks
; /* DMU_OTN_ZAP_METADATA */
150 /* has internal locking: */
151 dsl_deadlist_t ds_deadlist
;
152 bplist_t ds_pending_deadlist
;
154 /* protected by lock on pool's dp_dirty_datasets list */
155 txg_node_t ds_dirty_link
;
156 list_node_t ds_synced_link
;
159 * ds_phys->ds_<accounting> is also protected by ds_lock.
160 * Protected by ds_lock:
164 uint64_t ds_userrefs
;
168 * Long holds prevent the ds from being destroyed; they allow the
169 * ds to remain held even after dropping the dp_config_rwlock.
170 * Owning counts as a long hold. See the comments above
171 * dsl_pool_hold() for details.
173 refcount_t ds_longholds
;
175 /* no locking; only for making guesses */
176 uint64_t ds_trysnap_txg
;
178 /* for objset_open() */
179 kmutex_t ds_opening_lock
;
181 uint64_t ds_reserved
; /* cached refreservation */
182 uint64_t ds_quota
; /* cached refquota */
184 kmutex_t ds_sendstream_lock
;
185 list_t ds_sendstreams
;
187 /* Protected by our dsl_dir's dd_lock */
191 * For ZFEATURE_FLAG_PER_DATASET features, set if this dataset
194 uint8_t ds_feature_inuse
[SPA_FEATURES
];
197 * Set if we need to activate the feature on this dataset this txg
198 * (used only in syncing context).
200 uint8_t ds_feature_activation_needed
[SPA_FEATURES
];
202 /* Protected by ds_lock; keep at end of struct for better locality */
203 char ds_snapname
[MAXNAMELEN
];
206 inline dsl_dataset_phys_t
*
207 dsl_dataset_phys(dsl_dataset_t
*ds
)
209 return (ds
->ds_dbuf
->db_data
);
213 * The max length of a temporary tag prefix is the number of hex digits
214 * required to express UINT64_MAX plus one for the hyphen.
216 #define MAX_TAG_PREFIX_LEN 17
218 #define dsl_dataset_is_snapshot(ds) \
219 (dsl_dataset_phys(ds)->ds_num_children != 0)
221 #define DS_UNIQUE_IS_ACCURATE(ds) \
222 ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
224 int dsl_dataset_hold(struct dsl_pool
*dp
, const char *name
, void *tag
,
225 dsl_dataset_t
**dsp
);
226 boolean_t
dsl_dataset_try_add_ref(struct dsl_pool
*dp
, dsl_dataset_t
*ds
,
228 int dsl_dataset_hold_obj(struct dsl_pool
*dp
, uint64_t dsobj
, void *tag
,
230 void dsl_dataset_rele(dsl_dataset_t
*ds
, void *tag
);
231 int dsl_dataset_own(struct dsl_pool
*dp
, const char *name
,
232 void *tag
, dsl_dataset_t
**dsp
);
233 int dsl_dataset_own_obj(struct dsl_pool
*dp
, uint64_t dsobj
,
234 void *tag
, dsl_dataset_t
**dsp
);
235 void dsl_dataset_disown(dsl_dataset_t
*ds
, void *tag
);
236 void dsl_dataset_name(dsl_dataset_t
*ds
, char *name
);
237 boolean_t
dsl_dataset_tryown(dsl_dataset_t
*ds
, void *tag
);
238 uint64_t dsl_dataset_create_sync(dsl_dir_t
*pds
, const char *lastname
,
239 dsl_dataset_t
*origin
, uint64_t flags
, cred_t
*, dmu_tx_t
*);
240 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t
*dd
, dsl_dataset_t
*origin
,
241 uint64_t flags
, dmu_tx_t
*tx
);
242 int dsl_dataset_snapshot(nvlist_t
*snaps
, nvlist_t
*props
, nvlist_t
*errors
);
243 int dsl_dataset_promote(const char *name
, char *conflsnap
);
244 int dsl_dataset_clone_swap(dsl_dataset_t
*clone
, dsl_dataset_t
*origin_head
,
246 int dsl_dataset_rename_snapshot(const char *fsname
,
247 const char *oldsnapname
, const char *newsnapname
, boolean_t recursive
);
248 int dsl_dataset_snapshot_tmp(const char *fsname
, const char *snapname
,
249 minor_t cleanup_minor
, const char *htag
);
251 blkptr_t
*dsl_dataset_get_blkptr(dsl_dataset_t
*ds
);
252 void dsl_dataset_set_blkptr(dsl_dataset_t
*ds
, blkptr_t
*bp
, dmu_tx_t
*tx
);
254 spa_t
*dsl_dataset_get_spa(dsl_dataset_t
*ds
);
256 boolean_t
dsl_dataset_modified_since_snap(dsl_dataset_t
*ds
,
257 dsl_dataset_t
*snap
);
259 void dsl_dataset_sync(dsl_dataset_t
*os
, zio_t
*zio
, dmu_tx_t
*tx
);
261 void dsl_dataset_block_born(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
263 int dsl_dataset_block_kill(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
264 dmu_tx_t
*tx
, boolean_t async
);
265 boolean_t
dsl_dataset_block_freeable(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
267 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t
*ds
);
269 void dsl_dataset_dirty(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
270 void dsl_dataset_stats(dsl_dataset_t
*os
, nvlist_t
*nv
);
271 void dsl_dataset_fast_stat(dsl_dataset_t
*ds
, dmu_objset_stats_t
*stat
);
272 void dsl_dataset_space(dsl_dataset_t
*ds
,
273 uint64_t *refdbytesp
, uint64_t *availbytesp
,
274 uint64_t *usedobjsp
, uint64_t *availobjsp
);
275 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t
*ds
);
276 int dsl_dataset_space_written(dsl_dataset_t
*oldsnap
, dsl_dataset_t
*new,
277 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
278 int dsl_dataset_space_wouldfree(dsl_dataset_t
*firstsnap
, dsl_dataset_t
*last
,
279 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
280 boolean_t
dsl_dataset_is_dirty(dsl_dataset_t
*ds
);
282 int dsl_dsobj_to_dsname(char *pname
, uint64_t obj
, char *buf
);
284 int dsl_dataset_check_quota(dsl_dataset_t
*ds
, boolean_t check_quota
,
285 uint64_t asize
, uint64_t inflight
, uint64_t *used
,
287 int dsl_dataset_set_refquota(const char *dsname
, zprop_source_t source
,
289 int dsl_dataset_set_refreservation(const char *dsname
, zprop_source_t source
,
290 uint64_t reservation
);
292 boolean_t
dsl_dataset_is_before(dsl_dataset_t
*later
, dsl_dataset_t
*earlier
,
293 uint64_t earlier_txg
);
294 void dsl_dataset_long_hold(dsl_dataset_t
*ds
, void *tag
);
295 void dsl_dataset_long_rele(dsl_dataset_t
*ds
, void *tag
);
296 boolean_t
dsl_dataset_long_held(dsl_dataset_t
*ds
);
298 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t
*clone
,
299 dsl_dataset_t
*origin_head
, boolean_t force
, void *owner
, dmu_tx_t
*tx
);
300 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t
*clone
,
301 dsl_dataset_t
*origin_head
, dmu_tx_t
*tx
);
302 int dsl_dataset_snapshot_check_impl(dsl_dataset_t
*ds
, const char *snapname
,
303 dmu_tx_t
*tx
, boolean_t recv
, uint64_t cnt
, cred_t
*cr
);
304 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t
*ds
, const char *snapname
,
307 void dsl_dataset_remove_from_next_clones(dsl_dataset_t
*ds
, uint64_t obj
,
309 void dsl_dataset_recalc_head_uniq(dsl_dataset_t
*ds
);
310 int dsl_dataset_get_snapname(dsl_dataset_t
*ds
);
311 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
313 int dsl_dataset_snap_remove(dsl_dataset_t
*ds
, const char *name
, dmu_tx_t
*tx
,
315 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t
*ds
,
316 zprop_source_t source
, uint64_t value
, dmu_tx_t
*tx
);
317 void dsl_dataset_zapify(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
318 int dsl_dataset_rollback(const char *fsname
, void *owner
, nvlist_t
*result
);
320 void dsl_dataset_deactivate_feature(uint64_t dsobj
,
321 spa_feature_t f
, dmu_tx_t
*tx
);
324 #define dprintf_ds(ds, fmt, ...) do { \
325 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
326 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
327 dsl_dataset_name(ds, __ds_name); \
328 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
329 kmem_free(__ds_name, MAXNAMELEN); \
331 _NOTE(CONSTCOND) } while (0)
333 #define dprintf_ds(dd, fmt, ...)
340 #endif /* _SYS_DSL_DATASET_H */