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) 2011, 2014 by Delphix. 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 <sys/rrwlock.h>
42 #include <zfeature_common.h>
52 #define DS_FLAG_INCONSISTENT (1ULL<<0)
53 #define DS_IS_INCONSISTENT(ds) \
54 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT)
57 * Do not allow this dataset to be promoted.
59 #define DS_FLAG_NOPROMOTE (1ULL<<1)
62 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
63 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
64 * refquota/refreservations).
66 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
69 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
70 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
72 #define DS_FLAG_DEFER_DESTROY (1ULL<<3)
73 #define DS_IS_DEFER_DESTROY(ds) \
74 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY)
77 * DS_FIELD_* are strings that are used in the "extensified" dataset zap object.
78 * They should be of the format <reverse-dns>:<field>.
82 * This field's value is the object ID of a zap object which contains the
83 * bookmarks of this dataset. If it is present, then this dataset is counted
84 * in the refcount of the SPA_FEATURES_BOOKMARKS feature.
86 #define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks"
89 * This field is present (with value=0) if this dataset may contain large
90 * dnodes (>512B). If it is present, then this dataset is counted in the
91 * refcount of the SPA_FEATURE_LARGE_DNODE feature.
93 #define DS_FIELD_LARGE_DNODE "org.zfsonlinux:large_dnode"
96 * These fields are set on datasets that are in the middle of a resumable
97 * receive, and allow the sender to resume the send if it is interrupted.
99 #define DS_FIELD_RESUME_FROMGUID "com.delphix:resume_fromguid"
100 #define DS_FIELD_RESUME_TONAME "com.delphix:resume_toname"
101 #define DS_FIELD_RESUME_TOGUID "com.delphix:resume_toguid"
102 #define DS_FIELD_RESUME_OBJECT "com.delphix:resume_object"
103 #define DS_FIELD_RESUME_OFFSET "com.delphix:resume_offset"
104 #define DS_FIELD_RESUME_BYTES "com.delphix:resume_bytes"
105 #define DS_FIELD_RESUME_LARGEBLOCK "com.delphix:resume_largeblockok"
106 #define DS_FIELD_RESUME_EMBEDOK "com.delphix:resume_embedok"
107 #define DS_FIELD_RESUME_COMPRESSOK "com.delphix:resume_compressok"
110 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
111 * name lookups should be performed case-insensitively.
113 #define DS_FLAG_CI_DATASET (1ULL<<16)
115 #define DS_CREATE_FLAG_NODIRTY (1ULL<<24)
117 typedef struct dsl_dataset_phys
{
118 uint64_t ds_dir_obj
; /* DMU_OT_DSL_DIR */
119 uint64_t ds_prev_snap_obj
; /* DMU_OT_DSL_DATASET */
120 uint64_t ds_prev_snap_txg
;
121 uint64_t ds_next_snap_obj
; /* DMU_OT_DSL_DATASET */
122 uint64_t ds_snapnames_zapobj
; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
123 uint64_t ds_num_children
; /* clone/snap children; ==0 for head */
124 uint64_t ds_creation_time
; /* seconds since 1970 */
125 uint64_t ds_creation_txg
;
126 uint64_t ds_deadlist_obj
; /* DMU_OT_DEADLIST */
128 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
129 * include all blocks referenced by this dataset, including those
130 * shared with any other datasets.
132 uint64_t ds_referenced_bytes
;
133 uint64_t ds_compressed_bytes
;
134 uint64_t ds_uncompressed_bytes
;
135 uint64_t ds_unique_bytes
; /* only relevant to snapshots */
137 * The ds_fsid_guid is a 56-bit ID that can change to avoid
138 * collisions. The ds_guid is a 64-bit ID that will never
139 * change, so there is a small probability that it will collide.
141 uint64_t ds_fsid_guid
;
143 uint64_t ds_flags
; /* DS_FLAG_* */
145 uint64_t ds_next_clones_obj
; /* DMU_OT_DSL_CLONES */
146 uint64_t ds_props_obj
; /* DMU_OT_DSL_PROPS for snaps */
147 uint64_t ds_userrefs_obj
; /* DMU_OT_USERREFS */
148 uint64_t ds_pad
[5]; /* pad out to 320 bytes for good measure */
149 } dsl_dataset_phys_t
;
151 typedef struct dsl_dataset
{
152 dmu_buf_user_t ds_dbu
;
153 rrwlock_t ds_bp_rwlock
; /* Protects ds_phys->ds_bp */
156 struct dsl_dir
*ds_dir
;
159 uint64_t ds_fsid_guid
;
160 boolean_t ds_is_snapshot
;
162 /* only used in syncing context, only valid for non-snapshots: */
163 struct dsl_dataset
*ds_prev
;
164 uint64_t ds_bookmarks
; /* DMU_OTN_ZAP_METADATA */
166 /* has internal locking: */
167 dsl_deadlist_t ds_deadlist
;
168 bplist_t ds_pending_deadlist
;
170 /* protected by lock on pool's dp_dirty_datasets list */
171 txg_node_t ds_dirty_link
;
172 list_node_t ds_synced_link
;
175 * ds_phys->ds_<accounting> is also protected by ds_lock.
176 * Protected by ds_lock:
180 uint64_t ds_userrefs
;
184 * Long holds prevent the ds from being destroyed; they allow the
185 * ds to remain held even after dropping the dp_config_rwlock.
186 * Owning counts as a long hold. See the comments above
187 * dsl_pool_hold() for details.
189 refcount_t ds_longholds
;
191 /* no locking; only for making guesses */
192 uint64_t ds_trysnap_txg
;
194 /* for objset_open() */
195 kmutex_t ds_opening_lock
;
197 uint64_t ds_reserved
; /* cached refreservation */
198 uint64_t ds_quota
; /* cached refquota */
200 kmutex_t ds_sendstream_lock
;
201 list_t ds_sendstreams
;
204 * When in the middle of a resumable receive, tracks how much
205 * progress we have made.
207 uint64_t ds_resume_object
[TXG_SIZE
];
208 uint64_t ds_resume_offset
[TXG_SIZE
];
209 uint64_t ds_resume_bytes
[TXG_SIZE
];
211 /* Protected by our dsl_dir's dd_lock */
215 * For ZFEATURE_FLAG_PER_DATASET features, set if this dataset
218 uint8_t ds_feature_inuse
[SPA_FEATURES
];
221 * Set if we need to activate the feature on this dataset this txg
222 * (used only in syncing context).
224 uint8_t ds_feature_activation_needed
[SPA_FEATURES
];
226 /* Protected by ds_lock; keep at end of struct for better locality */
227 char ds_snapname
[ZFS_MAX_DATASET_NAME_LEN
];
230 static inline dsl_dataset_phys_t
*
231 dsl_dataset_phys(dsl_dataset_t
*ds
)
233 return (ds
->ds_dbuf
->db_data
);
237 * The max length of a temporary tag prefix is the number of hex digits
238 * required to express UINT64_MAX plus one for the hyphen.
240 #define MAX_TAG_PREFIX_LEN 17
242 #define dsl_dataset_is_snapshot(ds) \
243 (dsl_dataset_phys(ds)->ds_num_children != 0)
245 #define DS_UNIQUE_IS_ACCURATE(ds) \
246 ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
248 int dsl_dataset_hold(struct dsl_pool
*dp
, const char *name
, void *tag
,
249 dsl_dataset_t
**dsp
);
250 boolean_t
dsl_dataset_try_add_ref(struct dsl_pool
*dp
, dsl_dataset_t
*ds
,
252 int dsl_dataset_hold_obj(struct dsl_pool
*dp
, uint64_t dsobj
, void *tag
,
254 void dsl_dataset_rele(dsl_dataset_t
*ds
, void *tag
);
255 int dsl_dataset_own(struct dsl_pool
*dp
, const char *name
,
256 void *tag
, dsl_dataset_t
**dsp
);
257 int dsl_dataset_own_obj(struct dsl_pool
*dp
, uint64_t dsobj
,
258 void *tag
, dsl_dataset_t
**dsp
);
259 void dsl_dataset_disown(dsl_dataset_t
*ds
, void *tag
);
260 void dsl_dataset_name(dsl_dataset_t
*ds
, char *name
);
261 boolean_t
dsl_dataset_tryown(dsl_dataset_t
*ds
, void *tag
);
262 int dsl_dataset_namelen(dsl_dataset_t
*ds
);
263 boolean_t
dsl_dataset_has_owner(dsl_dataset_t
*ds
);
264 uint64_t dsl_dataset_create_sync(dsl_dir_t
*pds
, const char *lastname
,
265 dsl_dataset_t
*origin
, uint64_t flags
, cred_t
*, dmu_tx_t
*);
266 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t
*dd
, dsl_dataset_t
*origin
,
267 uint64_t flags
, dmu_tx_t
*tx
);
268 int dsl_dataset_snapshot(nvlist_t
*snaps
, nvlist_t
*props
, nvlist_t
*errors
);
269 int dsl_dataset_promote(const char *name
, char *conflsnap
);
270 int dsl_dataset_rename_snapshot(const char *fsname
,
271 const char *oldsnapname
, const char *newsnapname
, boolean_t recursive
);
272 int dsl_dataset_snapshot_tmp(const char *fsname
, const char *snapname
,
273 minor_t cleanup_minor
, const char *htag
);
275 blkptr_t
*dsl_dataset_get_blkptr(dsl_dataset_t
*ds
);
277 spa_t
*dsl_dataset_get_spa(dsl_dataset_t
*ds
);
279 boolean_t
dsl_dataset_modified_since_snap(dsl_dataset_t
*ds
,
280 dsl_dataset_t
*snap
);
282 void dsl_dataset_sync(dsl_dataset_t
*ds
, zio_t
*zio
, dmu_tx_t
*tx
);
283 void dsl_dataset_sync_done(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
285 void dsl_dataset_block_born(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
287 int dsl_dataset_block_kill(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
288 dmu_tx_t
*tx
, boolean_t async
);
289 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
292 void dsl_dataset_dirty(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
293 void dsl_dataset_stats(dsl_dataset_t
*ds
, nvlist_t
*nv
);
294 void dsl_dataset_fast_stat(dsl_dataset_t
*ds
, dmu_objset_stats_t
*stat
);
295 void dsl_dataset_space(dsl_dataset_t
*ds
,
296 uint64_t *refdbytesp
, uint64_t *availbytesp
,
297 uint64_t *usedobjsp
, uint64_t *availobjsp
);
298 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t
*ds
);
299 int dsl_dataset_space_written(dsl_dataset_t
*oldsnap
, dsl_dataset_t
*new,
300 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
301 int dsl_dataset_space_wouldfree(dsl_dataset_t
*firstsnap
, dsl_dataset_t
*last
,
302 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
303 boolean_t
dsl_dataset_is_dirty(dsl_dataset_t
*ds
);
305 int dsl_dsobj_to_dsname(char *pname
, uint64_t obj
, char *buf
);
307 int dsl_dataset_check_quota(dsl_dataset_t
*ds
, boolean_t check_quota
,
308 uint64_t asize
, uint64_t inflight
, uint64_t *used
,
310 int dsl_dataset_set_refquota(const char *dsname
, zprop_source_t source
,
312 int dsl_dataset_set_refreservation(const char *dsname
, zprop_source_t source
,
313 uint64_t reservation
);
315 boolean_t
dsl_dataset_is_before(dsl_dataset_t
*later
, dsl_dataset_t
*earlier
,
316 uint64_t earlier_txg
);
317 void dsl_dataset_long_hold(dsl_dataset_t
*ds
, void *tag
);
318 void dsl_dataset_long_rele(dsl_dataset_t
*ds
, void *tag
);
319 boolean_t
dsl_dataset_long_held(dsl_dataset_t
*ds
);
321 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t
*clone
,
322 dsl_dataset_t
*origin_head
, boolean_t force
, void *owner
, dmu_tx_t
*tx
);
323 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t
*clone
,
324 dsl_dataset_t
*origin_head
, dmu_tx_t
*tx
);
325 int dsl_dataset_snapshot_check_impl(dsl_dataset_t
*ds
, const char *snapname
,
326 dmu_tx_t
*tx
, boolean_t recv
, uint64_t cnt
, cred_t
*cr
);
327 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t
*ds
, const char *snapname
,
330 void dsl_dataset_remove_from_next_clones(dsl_dataset_t
*ds
, uint64_t obj
,
332 void dsl_dataset_recalc_head_uniq(dsl_dataset_t
*ds
);
333 int dsl_dataset_get_snapname(dsl_dataset_t
*ds
);
334 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
336 int dsl_dataset_snap_remove(dsl_dataset_t
*ds
, const char *name
, dmu_tx_t
*tx
,
338 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t
*ds
,
339 zprop_source_t source
, uint64_t value
, dmu_tx_t
*tx
);
340 void dsl_dataset_zapify(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
341 boolean_t
dsl_dataset_is_zapified(dsl_dataset_t
*ds
);
342 boolean_t
dsl_dataset_has_resume_receive_state(dsl_dataset_t
*ds
);
343 int dsl_dataset_rollback(const char *fsname
, const char *tosnap
, void *owner
,
346 void dsl_dataset_deactivate_feature(uint64_t dsobj
,
347 spa_feature_t f
, dmu_tx_t
*tx
);
350 #define dprintf_ds(ds, fmt, ...) do { \
351 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
352 char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \
353 dsl_dataset_name(ds, __ds_name); \
354 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
355 kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \
357 _NOTE(CONSTCOND) } while (0)
359 #define dprintf_ds(dd, fmt, ...)
366 #endif /* _SYS_DSL_DATASET_H */