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, 2018 by Delphix. All rights reserved.
24 * Copyright (c) 2013 Steven Hartland. All rights reserved.
25 * Copyright (c) 2014 Spectra Logic Corporation, 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>
40 #include <sys/rrwlock.h>
41 #include <sys/dsl_crypt.h>
42 #include <zfeature_common.h>
51 struct dsl_crypto_params
;
52 struct dsl_key_mapping
;
54 #define DS_FLAG_INCONSISTENT (1ULL<<0)
55 #define DS_IS_INCONSISTENT(ds) \
56 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT)
59 * Do not allow this dataset to be promoted.
61 #define DS_FLAG_NOPROMOTE (1ULL<<1)
64 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
65 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
66 * refquota/refreservations).
68 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
71 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
72 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
74 #define DS_FLAG_DEFER_DESTROY (1ULL<<3)
75 #define DS_IS_DEFER_DESTROY(ds) \
76 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY)
79 * DS_FIELD_* are strings that are used in the "extensified" dataset zap object.
80 * They should be of the format <reverse-dns>:<field>.
84 * This field's value is the object ID of a zap object which contains the
85 * bookmarks of this dataset. If it is present, then this dataset is counted
86 * in the refcount of the SPA_FEATURES_BOOKMARKS feature.
88 #define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks"
91 * This field is present (with value=0) if this dataset may contain large
92 * dnodes (>512B). If it is present, then this dataset is counted in the
93 * refcount of the SPA_FEATURE_LARGE_DNODE feature.
95 #define DS_FIELD_LARGE_DNODE "org.zfsonlinux:large_dnode"
98 * These fields are set on datasets that are in the middle of a resumable
99 * receive, and allow the sender to resume the send if it is interrupted.
101 #define DS_FIELD_RESUME_FROMGUID "com.delphix:resume_fromguid"
102 #define DS_FIELD_RESUME_TONAME "com.delphix:resume_toname"
103 #define DS_FIELD_RESUME_TOGUID "com.delphix:resume_toguid"
104 #define DS_FIELD_RESUME_OBJECT "com.delphix:resume_object"
105 #define DS_FIELD_RESUME_OFFSET "com.delphix:resume_offset"
106 #define DS_FIELD_RESUME_BYTES "com.delphix:resume_bytes"
107 #define DS_FIELD_RESUME_LARGEBLOCK "com.delphix:resume_largeblockok"
108 #define DS_FIELD_RESUME_EMBEDOK "com.delphix:resume_embedok"
109 #define DS_FIELD_RESUME_COMPRESSOK "com.delphix:resume_compressok"
110 #define DS_FIELD_RESUME_RAWOK "com.datto:resume_rawok"
113 * This field is set to the object number of the remap deadlist if one exists.
115 #define DS_FIELD_REMAP_DEADLIST "com.delphix:remap_deadlist"
118 * This field is set to the ivset guid for encrypted snapshots. This is used
119 * for validating raw receives.
121 #define DS_FIELD_IVSET_GUID "com.datto:ivset_guid"
124 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
125 * name lookups should be performed case-insensitively.
127 #define DS_FLAG_CI_DATASET (1ULL<<16)
129 #define DS_CREATE_FLAG_NODIRTY (1ULL<<24)
131 typedef struct dsl_dataset_phys
{
132 uint64_t ds_dir_obj
; /* DMU_OT_DSL_DIR */
133 uint64_t ds_prev_snap_obj
; /* DMU_OT_DSL_DATASET */
134 uint64_t ds_prev_snap_txg
;
135 uint64_t ds_next_snap_obj
; /* DMU_OT_DSL_DATASET */
136 uint64_t ds_snapnames_zapobj
; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
137 uint64_t ds_num_children
; /* clone/snap children; ==0 for head */
138 uint64_t ds_creation_time
; /* seconds since 1970 */
139 uint64_t ds_creation_txg
;
140 uint64_t ds_deadlist_obj
; /* DMU_OT_DEADLIST */
142 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
143 * include all blocks referenced by this dataset, including those
144 * shared with any other datasets.
146 uint64_t ds_referenced_bytes
;
147 uint64_t ds_compressed_bytes
;
148 uint64_t ds_uncompressed_bytes
;
149 uint64_t ds_unique_bytes
; /* only relevant to snapshots */
151 * The ds_fsid_guid is a 56-bit ID that can change to avoid
152 * collisions. The ds_guid is a 64-bit ID that will never
153 * change, so there is a small probability that it will collide.
155 uint64_t ds_fsid_guid
;
157 uint64_t ds_flags
; /* DS_FLAG_* */
159 uint64_t ds_next_clones_obj
; /* DMU_OT_DSL_CLONES */
160 uint64_t ds_props_obj
; /* DMU_OT_DSL_PROPS for snaps */
161 uint64_t ds_userrefs_obj
; /* DMU_OT_USERREFS */
162 uint64_t ds_pad
[5]; /* pad out to 320 bytes for good measure */
163 } dsl_dataset_phys_t
;
165 typedef struct dsl_dataset
{
166 dmu_buf_user_t ds_dbu
;
167 rrwlock_t ds_bp_rwlock
; /* Protects ds_phys->ds_bp */
170 struct dsl_dir
*ds_dir
;
173 uint64_t ds_fsid_guid
;
174 boolean_t ds_is_snapshot
;
175 struct dsl_key_mapping
*ds_key_mapping
;
177 /* only used in syncing context, only valid for non-snapshots: */
178 struct dsl_dataset
*ds_prev
;
179 uint64_t ds_bookmarks
; /* DMU_OTN_ZAP_METADATA */
181 /* has internal locking: */
182 dsl_deadlist_t ds_deadlist
;
183 bplist_t ds_pending_deadlist
;
186 * The remap deadlist contains blocks (DVA's, really) that are
187 * referenced by the previous snapshot and point to indirect vdevs,
188 * but in this dataset they have been remapped to point to concrete
189 * (or at least, less-indirect) vdevs. In other words, the
190 * physical DVA is referenced by the previous snapshot but not by
191 * this dataset. Logically, the DVA continues to be referenced,
192 * but we are using a different (less indirect) physical DVA.
193 * This deadlist is used to determine when physical DVAs that
194 * point to indirect vdevs are no longer referenced anywhere,
195 * and thus should be marked obsolete.
197 * This is only used if SPA_FEATURE_OBSOLETE_COUNTS is enabled.
199 dsl_deadlist_t ds_remap_deadlist
;
200 /* protects creation of the ds_remap_deadlist */
201 kmutex_t ds_remap_deadlist_lock
;
203 /* protected by lock on pool's dp_dirty_datasets list */
204 txg_node_t ds_dirty_link
;
205 list_node_t ds_synced_link
;
208 * ds_phys->ds_<accounting> is also protected by ds_lock.
209 * Protected by ds_lock:
213 uint64_t ds_userrefs
;
217 * Long holds prevent the ds from being destroyed; they allow the
218 * ds to remain held even after dropping the dp_config_rwlock.
219 * Owning counts as a long hold. See the comments above
220 * dsl_pool_hold() for details.
222 zfs_refcount_t ds_longholds
;
224 /* no locking; only for making guesses */
225 uint64_t ds_trysnap_txg
;
227 /* for objset_open() */
228 kmutex_t ds_opening_lock
;
230 uint64_t ds_reserved
; /* cached refreservation */
231 uint64_t ds_quota
; /* cached refquota */
233 kmutex_t ds_sendstream_lock
;
234 list_t ds_sendstreams
;
237 * When in the middle of a resumable receive, tracks how much
238 * progress we have made.
240 uint64_t ds_resume_object
[TXG_SIZE
];
241 uint64_t ds_resume_offset
[TXG_SIZE
];
242 uint64_t ds_resume_bytes
[TXG_SIZE
];
244 /* Protected by our dsl_dir's dd_lock */
248 * For ZFEATURE_FLAG_PER_DATASET features, set if this dataset
251 void *ds_feature
[SPA_FEATURES
];
254 * Set if we need to activate the feature on this dataset this txg
255 * (used only in syncing context).
257 void *ds_feature_activation
[SPA_FEATURES
];
259 /* Protected by ds_lock; keep at end of struct for better locality */
260 char ds_snapname
[ZFS_MAX_DATASET_NAME_LEN
];
263 static inline dsl_dataset_phys_t
*
264 dsl_dataset_phys(dsl_dataset_t
*ds
)
266 return (ds
->ds_dbuf
->db_data
);
269 typedef struct dsl_dataset_promote_arg
{
270 const char *ddpa_clonename
;
271 dsl_dataset_t
*ddpa_clone
;
272 list_t shared_snaps
, origin_snaps
, clone_snaps
;
273 dsl_dataset_t
*origin_origin
; /* origin of the origin */
274 uint64_t used
, comp
, uncomp
, unique
, cloneusedsnap
, originusedsnap
;
277 } dsl_dataset_promote_arg_t
;
279 typedef struct dsl_dataset_rollback_arg
{
280 const char *ddra_fsname
;
281 const char *ddra_tosnap
;
283 nvlist_t
*ddra_result
;
284 } dsl_dataset_rollback_arg_t
;
286 typedef struct dsl_dataset_snapshot_arg
{
287 nvlist_t
*ddsa_snaps
;
288 nvlist_t
*ddsa_props
;
289 nvlist_t
*ddsa_errors
;
291 } dsl_dataset_snapshot_arg_t
;
294 * The max length of a temporary tag prefix is the number of hex digits
295 * required to express UINT64_MAX plus one for the hyphen.
297 #define MAX_TAG_PREFIX_LEN 17
299 #define dsl_dataset_is_snapshot(ds) \
300 (dsl_dataset_phys(ds)->ds_num_children != 0)
302 #define DS_UNIQUE_IS_ACCURATE(ds) \
303 ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
305 /* flags for holding the dataset */
306 typedef enum ds_hold_flags
{
307 DS_HOLD_FLAG_DECRYPT
= 1 << 0 /* needs access to encrypted data */
310 int dsl_dataset_hold(struct dsl_pool
*dp
, const char *name
, void *tag
,
311 dsl_dataset_t
**dsp
);
312 int dsl_dataset_hold_flags(struct dsl_pool
*dp
, const char *name
,
313 ds_hold_flags_t flags
, void *tag
, dsl_dataset_t
**dsp
);
314 boolean_t
dsl_dataset_try_add_ref(struct dsl_pool
*dp
, dsl_dataset_t
*ds
,
316 int dsl_dataset_create_key_mapping(dsl_dataset_t
*ds
);
317 int dsl_dataset_hold_obj(struct dsl_pool
*dp
, uint64_t dsobj
, void *tag
,
319 int dsl_dataset_hold_obj_flags(struct dsl_pool
*dp
, uint64_t dsobj
,
320 ds_hold_flags_t flags
, void *tag
, dsl_dataset_t
**);
321 void dsl_dataset_remove_key_mapping(dsl_dataset_t
*ds
);
322 void dsl_dataset_rele(dsl_dataset_t
*ds
, void *tag
);
323 void dsl_dataset_rele_flags(dsl_dataset_t
*ds
, ds_hold_flags_t flags
,
325 int dsl_dataset_own(struct dsl_pool
*dp
, const char *name
,
326 ds_hold_flags_t flags
, void *tag
, dsl_dataset_t
**dsp
);
327 int dsl_dataset_own_obj(struct dsl_pool
*dp
, uint64_t dsobj
,
328 ds_hold_flags_t flags
, void *tag
, dsl_dataset_t
**dsp
);
329 void dsl_dataset_disown(dsl_dataset_t
*ds
, ds_hold_flags_t flags
, void *tag
);
330 void dsl_dataset_name(dsl_dataset_t
*ds
, char *name
);
331 int dsl_dataset_namelen(dsl_dataset_t
*ds
);
332 boolean_t
dsl_dataset_has_owner(dsl_dataset_t
*ds
);
333 boolean_t
dsl_dataset_tryown(dsl_dataset_t
*ds
, void *tag
);
334 uint64_t dsl_dataset_create_sync(dsl_dir_t
*pds
, const char *lastname
,
335 dsl_dataset_t
*origin
, uint64_t flags
, cred_t
*,
336 struct dsl_crypto_params
*, dmu_tx_t
*);
337 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t
*dd
, dsl_dataset_t
*origin
,
338 struct dsl_crypto_params
*dcp
, uint64_t flags
, dmu_tx_t
*tx
);
339 void dsl_dataset_snapshot_sync(void *arg
, dmu_tx_t
*tx
);
340 int dsl_dataset_snapshot_check(void *arg
, dmu_tx_t
*tx
);
341 int dsl_dataset_snapshot(nvlist_t
*snaps
, nvlist_t
*props
, nvlist_t
*errors
);
342 void dsl_dataset_promote_sync(void *arg
, dmu_tx_t
*tx
);
343 int dsl_dataset_promote_check(void *arg
, dmu_tx_t
*tx
);
344 int dsl_dataset_promote(const char *name
, char *conflsnap
);
345 int dsl_dataset_rename_snapshot(const char *fsname
,
346 const char *oldsnapname
, const char *newsnapname
, boolean_t recursive
);
347 int dsl_dataset_snapshot_tmp(const char *fsname
, const char *snapname
,
348 minor_t cleanup_minor
, const char *htag
);
350 blkptr_t
*dsl_dataset_get_blkptr(dsl_dataset_t
*ds
);
352 spa_t
*dsl_dataset_get_spa(dsl_dataset_t
*ds
);
354 boolean_t
dsl_dataset_modified_since_snap(dsl_dataset_t
*ds
,
355 dsl_dataset_t
*snap
);
357 void dsl_dataset_sync(dsl_dataset_t
*ds
, zio_t
*zio
, dmu_tx_t
*tx
);
358 void dsl_dataset_sync_done(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
360 void dsl_dataset_block_born(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
362 int dsl_dataset_block_kill(dsl_dataset_t
*ds
, const blkptr_t
*bp
,
363 dmu_tx_t
*tx
, boolean_t async
);
364 void dsl_dataset_block_remapped(dsl_dataset_t
*ds
, uint64_t vdev
,
365 uint64_t offset
, uint64_t size
, uint64_t birth
, dmu_tx_t
*tx
);
366 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
369 void dsl_dataset_dirty(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
371 int get_clones_stat_impl(dsl_dataset_t
*ds
, nvlist_t
*val
);
372 char *get_receive_resume_stats_impl(dsl_dataset_t
*ds
);
373 char *get_child_receive_stats(dsl_dataset_t
*ds
);
374 uint64_t dsl_get_refratio(dsl_dataset_t
*ds
);
375 uint64_t dsl_get_logicalreferenced(dsl_dataset_t
*ds
);
376 uint64_t dsl_get_compressratio(dsl_dataset_t
*ds
);
377 uint64_t dsl_get_used(dsl_dataset_t
*ds
);
378 uint64_t dsl_get_creation(dsl_dataset_t
*ds
);
379 uint64_t dsl_get_creationtxg(dsl_dataset_t
*ds
);
380 uint64_t dsl_get_refquota(dsl_dataset_t
*ds
);
381 uint64_t dsl_get_refreservation(dsl_dataset_t
*ds
);
382 uint64_t dsl_get_guid(dsl_dataset_t
*ds
);
383 uint64_t dsl_get_unique(dsl_dataset_t
*ds
);
384 uint64_t dsl_get_objsetid(dsl_dataset_t
*ds
);
385 uint64_t dsl_get_userrefs(dsl_dataset_t
*ds
);
386 uint64_t dsl_get_defer_destroy(dsl_dataset_t
*ds
);
387 uint64_t dsl_get_referenced(dsl_dataset_t
*ds
);
388 uint64_t dsl_get_numclones(dsl_dataset_t
*ds
);
389 uint64_t dsl_get_inconsistent(dsl_dataset_t
*ds
);
390 uint64_t dsl_get_available(dsl_dataset_t
*ds
);
391 int dsl_get_written(dsl_dataset_t
*ds
, uint64_t *written
);
392 int dsl_get_prev_snap(dsl_dataset_t
*ds
, char *snap
);
393 int dsl_get_mountpoint(dsl_dataset_t
*ds
, const char *dsname
, char *value
,
396 void get_clones_stat(dsl_dataset_t
*ds
, nvlist_t
*nv
);
397 void dsl_dataset_stats(dsl_dataset_t
*os
, nvlist_t
*nv
);
399 void dsl_dataset_fast_stat(dsl_dataset_t
*ds
, dmu_objset_stats_t
*stat
);
400 void dsl_dataset_space(dsl_dataset_t
*ds
,
401 uint64_t *refdbytesp
, uint64_t *availbytesp
,
402 uint64_t *usedobjsp
, uint64_t *availobjsp
);
403 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t
*ds
);
404 int dsl_dataset_space_written(dsl_dataset_t
*oldsnap
, dsl_dataset_t
*new,
405 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
406 int dsl_dataset_space_wouldfree(dsl_dataset_t
*firstsnap
, dsl_dataset_t
*last
,
407 uint64_t *usedp
, uint64_t *compp
, uint64_t *uncompp
);
409 int dsl_dsobj_to_dsname(char *pname
, uint64_t obj
, char *buf
);
411 int dsl_dataset_check_quota(dsl_dataset_t
*ds
, boolean_t check_quota
,
412 uint64_t asize
, uint64_t inflight
, uint64_t *used
,
414 int dsl_dataset_set_refquota(const char *dsname
, zprop_source_t source
,
416 int dsl_dataset_set_refreservation(const char *dsname
, zprop_source_t source
,
417 uint64_t reservation
);
419 boolean_t
dsl_dataset_is_before(dsl_dataset_t
*later
, dsl_dataset_t
*earlier
,
420 uint64_t earlier_txg
);
421 void dsl_dataset_long_hold(dsl_dataset_t
*ds
, void *tag
);
422 void dsl_dataset_long_rele(dsl_dataset_t
*ds
, void *tag
);
423 boolean_t
dsl_dataset_long_held(dsl_dataset_t
*ds
);
425 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t
*clone
,
426 dsl_dataset_t
*origin_head
, boolean_t force
, void *owner
, dmu_tx_t
*tx
);
427 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t
*clone
,
428 dsl_dataset_t
*origin_head
, dmu_tx_t
*tx
);
429 int dsl_dataset_snapshot_check_impl(dsl_dataset_t
*ds
, const char *snapname
,
430 dmu_tx_t
*tx
, boolean_t recv
, uint64_t cnt
, cred_t
*cr
);
431 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t
*ds
, const char *snapname
,
434 void dsl_dataset_remove_from_next_clones(dsl_dataset_t
*ds
, uint64_t obj
,
436 void dsl_dataset_recalc_head_uniq(dsl_dataset_t
*ds
);
437 int dsl_dataset_get_snapname(dsl_dataset_t
*ds
);
438 int dsl_dataset_snap_lookup(dsl_dataset_t
*ds
, const char *name
,
440 int dsl_dataset_snap_remove(dsl_dataset_t
*ds
, const char *name
, dmu_tx_t
*tx
,
442 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t
*ds
,
443 zprop_source_t source
, uint64_t value
, dmu_tx_t
*tx
);
444 void dsl_dataset_zapify(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
445 boolean_t
dsl_dataset_is_zapified(dsl_dataset_t
*ds
);
446 boolean_t
dsl_dataset_has_resume_receive_state(dsl_dataset_t
*ds
);
448 int dsl_dataset_rollback_check(void *arg
, dmu_tx_t
*tx
);
449 void dsl_dataset_rollback_sync(void *arg
, dmu_tx_t
*tx
);
450 int dsl_dataset_rollback(const char *fsname
, const char *tosnap
, void *owner
,
453 uint64_t dsl_dataset_get_remap_deadlist_object(dsl_dataset_t
*ds
);
454 void dsl_dataset_create_remap_deadlist(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
455 boolean_t
dsl_dataset_remap_deadlist_exists(dsl_dataset_t
*ds
);
456 void dsl_dataset_destroy_remap_deadlist(dsl_dataset_t
*ds
, dmu_tx_t
*tx
);
458 void dsl_dataset_activate_feature(uint64_t dsobj
, spa_feature_t f
, void *arg
,
460 void dsl_dataset_deactivate_feature(dsl_dataset_t
*ds
, spa_feature_t f
,
462 boolean_t
dsl_dataset_feature_is_active(dsl_dataset_t
*ds
, spa_feature_t f
);
463 boolean_t
dsl_dataset_get_uint64_array_feature(dsl_dataset_t
*ds
,
464 spa_feature_t f
, uint64_t *outlength
, uint64_t **outp
);
467 #define dprintf_ds(ds, fmt, ...) do { \
468 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
469 char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \
470 dsl_dataset_name(ds, __ds_name); \
471 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
472 kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \
474 _NOTE(CONSTCOND) } while (0)
476 #define dprintf_ds(dd, fmt, ...)
483 #endif /* _SYS_DSL_DATASET_H */