dsl_dataset.h revision a7a845e4bf22fd1b2a284729ccd95c7370a0438c
c636315472e4f87313af7be30b7fbcad4b8ca8a4Stephen Gallagher * CDDL HEADER START
8b1f525acd20f36c836e827de3c251088961c5d9Stephen Gallagher * The contents of this file are subject to the terms of the
8b1f525acd20f36c836e827de3c251088961c5d9Stephen Gallagher * Common Development and Distribution License (the "License").
8b1f525acd20f36c836e827de3c251088961c5d9Stephen Gallagher * You may not use this file except in compliance with the License.
8b1f525acd20f36c836e827de3c251088961c5d9Stephen Gallagher * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher * or http://www.opensolaris.org/os/licensing.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * See the License for the specific language governing permissions
df4cc3a83c5d6700b6a09ff96cb4a6b1949b1aa9Stephen Gallagher * and limitations under the License.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * When distributing Covered Code, include this CDDL HEADER in each
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * If applicable, add the following below this CDDL HEADER, with the
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * fields enclosed by brackets "[]" replaced with your own identifying
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * information: Portions Copyright [yyyy] [name of copyright owner]
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * CDDL HEADER END
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Copyright (c) 2012 by Delphix. All rights reserved.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Copyright (c) 2012, Joyent, Inc. All rights reserved.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Copyright (c) 2013 Steven Hartland. All rights reserved.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Note: nopromote can not yet be set, but we want support for it in this
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * on-disk version, so that we don't need to upgrade for it later.
4dd615c01357b8715711aad6820ba9595d3ad377Stephen Gallagher * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
4dd615c01357b8715711aad6820ba9595d3ad377Stephen Gallagher * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
c737e1444fb186e349e59bfa9dac4995b720b4b1Jan Zeleny ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * name lookups should be performed case-insensitively.
2827b0d03f7b6bafa504d22a5d7ca39cbda048b3Pavel Březina uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_num_children; /* clone/snap children; ==0 for head */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_creation_time; /* seconds since 1970 */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * include all blocks referenced by this dataset, including those
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * shared with any other datasets.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_unique_bytes; /* only relevant to snapshots */
4dd615c01357b8715711aad6820ba9595d3ad377Stephen Gallagher * The ds_fsid_guid is a 56-bit ID that can change to avoid
fe60346714a73ac3987f786731389320633dd245Pavel Březina * collisions. The ds_guid is a 64-bit ID that will never
4dd615c01357b8715711aad6820ba9595d3ad377Stephen Gallagher * change, so there is a small probability that it will collide.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallaghertypedef struct dsl_dataset {
bf5a808fa92007c325c3996e79694badfab201d4Stephen Gallagher /* Immutable: */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* only used in syncing context, only valid for non-snapshots: */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* has internal locking: */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* protected by lock on pool's dp_dirty_datasets list */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * ds_phys->ds_<accounting> is also protected by ds_lock.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Protected by ds_lock:
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * Long holds prevent the ds from being destroyed; they allow the
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * ds to remain held even after dropping the dp_config_rwlock.
69aaef8719c5cf33ed1c4090fa313ba281bf8a02Jakub Hrozek * Owning counts as a long hold. See the comments above
69aaef8719c5cf33ed1c4090fa313ba281bf8a02Jakub Hrozek * dsl_pool_hold() for details.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* no locking; only for making guesses */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* for objset_open() */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t ds_reserved; /* cached refreservation */
667db40da4db362d7ca0a1f7f1c4ba40fb71795aJakub Hrozek /* Protected by ds_lock; keep at end of struct for better locality */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * The max length of a temporary tag prefix is the number of hex digits
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher * required to express UINT64_MAX plus one for the hyphen.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_hold(struct dsl_pool *dp, const char *name, void *tag,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, void *tag,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_own(struct dsl_pool *dp, const char *name,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_name(dsl_dataset_t *ds, char *name);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherboolean_t dsl_dataset_tryown(dsl_dataset_t *ds, void *tag);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagheruint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagheruint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t *errors);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_promote(const char *name, char *conflsnap);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_rename_snapshot(const char *fsname,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *oldsnapname, const char *newsnapname, boolean_t recursive);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_snapshot_tmp(const char *fsname, const char *snapname,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherblkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherboolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherboolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagheruint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t *refdbytesp, uint64_t *availbytesp,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t *usedobjsp, uint64_t *availobjsp);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagheruint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherboolean_t dsl_dataset_is_dirty(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uint64_t asize, uint64_t inflight, uint64_t *used,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_set_refquota(const char *dsname, zprop_source_t source,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_set_refreservation(const char *dsname, zprop_source_t source,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherboolean_t dsl_dataset_is_before(dsl_dataset_t *later, dsl_dataset_t *earlier);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_long_hold(dsl_dataset_t *ds, void *tag);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_long_rele(dsl_dataset_t *ds, void *tag);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherboolean_t dsl_dataset_long_held(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_clone_swap_check_impl(dsl_dataset_t *clone,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher dsl_dataset_t *origin_head, boolean_t force);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_clone_swap_sync_impl(dsl_dataset_t *clone,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher dsl_dataset_t *origin_head, dmu_tx_t *tx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_snapshot_check_impl(dsl_dataset_t *ds, const char *snapname,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_snapshot_sync_impl(dsl_dataset_t *ds, const char *snapname,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_remove_from_next_clones(dsl_dataset_t *ds, uint64_t obj,
fe2091327ff44f80d6681c261494e4432404e9baStephen Gallagherint dsl_dataset_get_snapname(dsl_dataset_t *ds);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_snap_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t *ds,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher zprop_source_t source, uint64_t value, dmu_tx_t *tx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint dsl_dataset_rollback(const char *fsname);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
fe2091327ff44f80d6681c261494e4432404e9baStephen Gallagher#endif /* _SYS_DSL_DATASET_H */