dsl_dataset.h revision 310512
1132718Skan/* 272562Sobrien * CDDL HEADER START 3169689Skan * 4169689Skan * The contents of this file are subject to the terms of the 550397Sobrien * Common Development and Distribution License (the "License"). 6132718Skan * You may not use this file except in compliance with the License. 750397Sobrien * 850397Sobrien * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9132718Skan * or http://www.opensolaris.org/os/licensing. 1050397Sobrien * See the License for the specific language governing permissions 11132718Skan * and limitations under the License. 1250397Sobrien * 1350397Sobrien * When distributing Covered Code, include this CDDL HEADER in each 1450397Sobrien * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 1550397Sobrien * If applicable, add the following below this CDDL HEADER, with the 16132718Skan * fields enclosed by brackets "[]" replaced with your own identifying 1750397Sobrien * information: Portions Copyright [yyyy] [name of copyright owner] 1850397Sobrien * 1950397Sobrien * CDDL HEADER END 2050397Sobrien */ 2150397Sobrien/* 22132718Skan * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23169689Skan * Copyright (c) 2011, 2015 by Delphix. All rights reserved. 24169689Skan * Copyright (c) 2013, Joyent, Inc. All rights reserved. 2550397Sobrien * Copyright (c) 2013 Steven Hartland. All rights reserved. 2650397Sobrien * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. 2750397Sobrien * Copyright (c) 2014 Integros [integros.com] 28132718Skan */ 29132718Skan 3050397Sobrien#ifndef _SYS_DSL_DATASET_H 3150397Sobrien#define _SYS_DSL_DATASET_H 3250397Sobrien 3350397Sobrien#include <sys/dmu.h> 3450397Sobrien#include <sys/spa.h> 3550397Sobrien#include <sys/txg.h> 36169689Skan#include <sys/zio.h> 3750397Sobrien#include <sys/bplist.h> 3850397Sobrien#include <sys/dsl_synctask.h> 3950397Sobrien#include <sys/zfs_context.h> 4050397Sobrien#include <sys/dsl_deadlist.h> 4190075Sobrien#include <sys/refcount.h> 4250397Sobrien#include <sys/rrwlock.h> 4390075Sobrien#include <zfeature_common.h> 4450397Sobrien 4550397Sobrien#ifdef __cplusplus 4690075Sobrienextern "C" { 4790075Sobrien#endif 4890075Sobrien 4990075Sobrienstruct dsl_dataset; 5090075Sobrienstruct dsl_dir; 51132718Skanstruct dsl_pool; 52169689Skan 53169689Skan#define DS_FLAG_INCONSISTENT (1ULL<<0) 5450397Sobrien#define DS_IS_INCONSISTENT(ds) \ 55169689Skan (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT) 56169689Skan 57169689Skan/* 58169689Skan * Do not allow this dataset to be promoted. 59169689Skan */ 60169689Skan#define DS_FLAG_NOPROMOTE (1ULL<<1) 61169689Skan 62169689Skan/* 63169689Skan * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly 64169689Skan * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE, 65169689Skan * refquota/refreservations). 66169689Skan */ 67169689Skan#define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2) 68169689Skan 69169689Skan/* 70169689Skan * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called 71169689Skan * on a dataset. This allows the dataset to be destroyed using 'zfs release'. 72169689Skan */ 73169689Skan#define DS_FLAG_DEFER_DESTROY (1ULL<<3) 74169689Skan#define DS_IS_DEFER_DESTROY(ds) \ 75169689Skan (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY) 76169689Skan 77169689Skan/* 78169689Skan * DS_FIELD_* are strings that are used in the "extensified" dataset zap object. 7950397Sobrien * They should be of the format <reverse-dns>:<field>. 80169689Skan */ 81169689Skan 82169689Skan/* 83169689Skan * This field's value is the object ID of a zap object which contains the 84169689Skan * bookmarks of this dataset. If it is present, then this dataset is counted 85169689Skan * in the refcount of the SPA_FEATURES_BOOKMARKS feature. 86169689Skan */ 87169689Skan#define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks" 88169689Skan 89169689Skan/* 90169689Skan * These fields are set on datasets that are in the middle of a resumable 91169689Skan * receive, and allow the sender to resume the send if it is interrupted. 92169689Skan */ 93169689Skan#define DS_FIELD_RESUME_FROMGUID "com.delphix:resume_fromguid" 94169689Skan#define DS_FIELD_RESUME_TONAME "com.delphix:resume_toname" 95169689Skan#define DS_FIELD_RESUME_TOGUID "com.delphix:resume_toguid" 96169689Skan#define DS_FIELD_RESUME_OBJECT "com.delphix:resume_object" 97169689Skan#define DS_FIELD_RESUME_OFFSET "com.delphix:resume_offset" 98169689Skan#define DS_FIELD_RESUME_BYTES "com.delphix:resume_bytes" 99169689Skan#define DS_FIELD_RESUME_EMBEDOK "com.delphix:resume_embedok" 100169689Skan 101169689Skan/* 102169689Skan * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose 10350397Sobrien * name lookups should be performed case-insensitively. 104169689Skan */ 105169689Skan#define DS_FLAG_CI_DATASET (1ULL<<16) 106169689Skan 107169689Skan#define DS_CREATE_FLAG_NODIRTY (1ULL<<24) 108169689Skan 109169689Skantypedef struct dsl_dataset_phys { 110169689Skan uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */ 111169689Skan uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */ 112169689Skan uint64_t ds_prev_snap_txg; 113169689Skan uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */ 114169689Skan uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */ 115169689Skan uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 116169689Skan uint64_t ds_creation_time; /* seconds since 1970 */ 117169689Skan uint64_t ds_creation_txg; 118169689Skan uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */ 119169689Skan /* 120169689Skan * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes 121169689Skan * include all blocks referenced by this dataset, including those 122169689Skan * shared with any other datasets. 123169689Skan */ 124169689Skan uint64_t ds_referenced_bytes; 125169689Skan uint64_t ds_compressed_bytes; 126169689Skan uint64_t ds_uncompressed_bytes; 127169689Skan uint64_t ds_unique_bytes; /* only relevant to snapshots */ 128169689Skan /* 129169689Skan * The ds_fsid_guid is a 56-bit ID that can change to avoid 130169689Skan * collisions. The ds_guid is a 64-bit ID that will never 131169689Skan * change, so there is a small probability that it will collide. 132169689Skan */ 133169689Skan uint64_t ds_fsid_guid; 134169689Skan uint64_t ds_guid; 135169689Skan uint64_t ds_flags; /* DS_FLAG_* */ 136169689Skan blkptr_t ds_bp; 137169689Skan uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */ 138169689Skan uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */ 139169689Skan uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */ 140169689Skan uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */ 141169689Skan} dsl_dataset_phys_t; 142169689Skan 143169689Skantypedef struct dsl_dataset { 144169689Skan dmu_buf_user_t ds_dbu; 145169689Skan rrwlock_t ds_bp_rwlock; /* Protects ds_phys->ds_bp */ 146169689Skan 147169689Skan /* Immutable: */ 148169689Skan struct dsl_dir *ds_dir; 149169689Skan dmu_buf_t *ds_dbuf; 150169689Skan uint64_t ds_object; 151169689Skan uint64_t ds_fsid_guid; 152169689Skan boolean_t ds_is_snapshot; 153169689Skan 154169689Skan /* only used in syncing context, only valid for non-snapshots: */ 155169689Skan struct dsl_dataset *ds_prev; 156169689Skan uint64_t ds_bookmarks; /* DMU_OTN_ZAP_METADATA */ 157169689Skan 158169689Skan /* has internal locking: */ 159169689Skan dsl_deadlist_t ds_deadlist; 160169689Skan bplist_t ds_pending_deadlist; 161169689Skan 162169689Skan /* protected by lock on pool's dp_dirty_datasets list */ 163169689Skan txg_node_t ds_dirty_link; 164169689Skan list_node_t ds_synced_link; 165169689Skan 166169689Skan /* 167169689Skan * ds_phys->ds_<accounting> is also protected by ds_lock. 168169689Skan * Protected by ds_lock: 169169689Skan */ 170169689Skan kmutex_t ds_lock; 171169689Skan objset_t *ds_objset; 172169689Skan uint64_t ds_userrefs; 173169689Skan void *ds_owner; 174169689Skan 175169689Skan /* 176169689Skan * Long holds prevent the ds from being destroyed; they allow the 177169689Skan * ds to remain held even after dropping the dp_config_rwlock. 178169689Skan * Owning counts as a long hold. See the comments above 179169689Skan * dsl_pool_hold() for details. 180169689Skan */ 181169689Skan refcount_t ds_longholds; 182169689Skan 183169689Skan /* no locking; only for making guesses */ 184169689Skan uint64_t ds_trysnap_txg; 185169689Skan 186169689Skan /* for objset_open() */ 187169689Skan kmutex_t ds_opening_lock; 188169689Skan 189169689Skan uint64_t ds_reserved; /* cached refreservation */ 190169689Skan uint64_t ds_quota; /* cached refquota */ 191169689Skan 192169689Skan kmutex_t ds_sendstream_lock; 193169689Skan list_t ds_sendstreams; 194169689Skan 195169689Skan /* 196169689Skan * When in the middle of a resumable receive, tracks how much 197169689Skan * progress we have made. 198169689Skan */ 199169689Skan uint64_t ds_resume_object[TXG_SIZE]; 200169689Skan uint64_t ds_resume_offset[TXG_SIZE]; 201169689Skan uint64_t ds_resume_bytes[TXG_SIZE]; 202169689Skan 203169689Skan /* Protected by our dsl_dir's dd_lock */ 204169689Skan list_t ds_prop_cbs; 205169689Skan 206169689Skan /* 207169689Skan * For ZFEATURE_FLAG_PER_DATASET features, set if this dataset 208169689Skan * uses this feature. 209169689Skan */ 210169689Skan uint8_t ds_feature_inuse[SPA_FEATURES]; 211169689Skan 212169689Skan /* 213169689Skan * Set if we need to activate the feature on this dataset this txg 214169689Skan * (used only in syncing context). 215169689Skan */ 216169689Skan uint8_t ds_feature_activation_needed[SPA_FEATURES]; 217169689Skan 218169689Skan /* Protected by ds_lock; keep at end of struct for better locality */ 219169689Skan char ds_snapname[ZFS_MAX_DATASET_NAME_LEN]; 220169689Skan} dsl_dataset_t; 221169689Skan 222169689Skaninline dsl_dataset_phys_t * 223169689Skandsl_dataset_phys(dsl_dataset_t *ds) 224169689Skan{ 225169689Skan return (ds->ds_dbuf->db_data); 226169689Skan} 227169689Skan 228169689Skan/* 229169689Skan * The max length of a temporary tag prefix is the number of hex digits 230169689Skan * required to express UINT64_MAX plus one for the hyphen. 231169689Skan */ 232169689Skan#define MAX_TAG_PREFIX_LEN 17 233169689Skan 234169689Skan#define dsl_dataset_is_snapshot(ds) \ 235169689Skan (dsl_dataset_phys(ds)->ds_num_children != 0) 236169689Skan 23750397Sobrien#define DS_UNIQUE_IS_ACCURATE(ds) \ 23850397Sobrien ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) 23950397Sobrien 240169689Skanint dsl_dataset_hold(struct dsl_pool *dp, const char *name, void *tag, 241169689Skan dsl_dataset_t **dsp); 242169689Skanboolean_t dsl_dataset_try_add_ref(struct dsl_pool *dp, dsl_dataset_t *ds, 24350397Sobrien void *tag); 24450397Sobrienint dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, void *tag, 245132718Skan dsl_dataset_t **); 246132718Skanvoid dsl_dataset_rele(dsl_dataset_t *ds, void *tag); 24750397Sobrienint dsl_dataset_own(struct dsl_pool *dp, const char *name, 24896263Sobrien void *tag, dsl_dataset_t **dsp); 24996263Sobrienint dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, 25090075Sobrien void *tag, dsl_dataset_t **dsp); 25190075Sobrienvoid dsl_dataset_disown(dsl_dataset_t *ds, void *tag); 252169689Skanvoid dsl_dataset_name(dsl_dataset_t *ds, char *name); 253169689Skanboolean_t dsl_dataset_tryown(dsl_dataset_t *ds, void *tag); 254169689Skanint dsl_dataset_namelen(dsl_dataset_t *ds); 255169689Skanboolean_t dsl_dataset_has_owner(dsl_dataset_t *ds); 256169689Skanuint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname, 257169689Skan dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *); 25850397Sobrienuint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin, 25950397Sobrien uint64_t flags, dmu_tx_t *tx); 260169689Skanint dsl_dataset_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t *errors); 26150397Sobrienint dsl_dataset_promote(const char *name, char *conflsnap); 26296263Sobrienint dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 26396263Sobrien boolean_t force); 26496263Sobrienint dsl_dataset_rename_snapshot(const char *fsname, 26596263Sobrien const char *oldsnapname, const char *newsnapname, boolean_t recursive); 26650397Sobrienint dsl_dataset_snapshot_tmp(const char *fsname, const char *snapname, 26750397Sobrien minor_t cleanup_minor, const char *htag); 26850397Sobrien 26950397Sobrienblkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 27050397Sobrien 27150397Sobrienspa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 27250397Sobrien 27350397Sobrienboolean_t dsl_dataset_modified_since_snap(dsl_dataset_t *ds, 27450397Sobrien dsl_dataset_t *snap); 27550397Sobrien 27650397Sobrienvoid dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 27750397Sobrienvoid dsl_dataset_sync_done(dsl_dataset_t *os, dmu_tx_t *tx); 27850397Sobrien 27950397Sobrienvoid dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp, 28050397Sobrien dmu_tx_t *tx); 28190075Sobrienint dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp, 28290075Sobrien dmu_tx_t *tx, boolean_t async); 28390075Sobrienboolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp, 28490075Sobrien uint64_t blk_birth); 28590075Sobrienuint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 28690075Sobrien 28790075Sobrienvoid dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 28890075Sobrienvoid dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 28990075Sobrienvoid dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 29090075Sobrienvoid dsl_dataset_space(dsl_dataset_t *ds, 29190075Sobrien uint64_t *refdbytesp, uint64_t *availbytesp, 29290075Sobrien uint64_t *usedobjsp, uint64_t *availobjsp); 29390075Sobrienuint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 29490075Sobrienint dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new, 29590075Sobrien uint64_t *usedp, uint64_t *compp, uint64_t *uncompp); 29690075Sobrienint dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last, 29790075Sobrien uint64_t *usedp, uint64_t *compp, uint64_t *uncompp); 29890075Sobrienboolean_t dsl_dataset_is_dirty(dsl_dataset_t *ds); 299132718Skan 300132718Skanint dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 301132718Skan 302132718Skanint dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, 303169689Skan uint64_t asize, uint64_t inflight, uint64_t *used, 304169689Skan uint64_t *ref_rsrv); 305169689Skanint dsl_dataset_set_refquota(const char *dsname, zprop_source_t source, 306169689Skan uint64_t quota); 307169689Skanint dsl_dataset_set_refreservation(const char *dsname, zprop_source_t source, 308169689Skan uint64_t reservation); 309169689Skan 310169689Skanboolean_t dsl_dataset_is_before(dsl_dataset_t *later, dsl_dataset_t *earlier, 311169689Skan uint64_t earlier_txg); 312132718Skanvoid dsl_dataset_long_hold(dsl_dataset_t *ds, void *tag); 313132718Skanvoid dsl_dataset_long_rele(dsl_dataset_t *ds, void *tag); 314169689Skanboolean_t dsl_dataset_long_held(dsl_dataset_t *ds); 315169689Skan 31650397Sobrienint dsl_dataset_clone_swap_check_impl(dsl_dataset_t *clone, 317169689Skan dsl_dataset_t *origin_head, boolean_t force, void *owner, dmu_tx_t *tx); 318169689Skanvoid dsl_dataset_clone_swap_sync_impl(dsl_dataset_t *clone, 319169689Skan dsl_dataset_t *origin_head, dmu_tx_t *tx); 320169689Skanint dsl_dataset_snapshot_check_impl(dsl_dataset_t *ds, const char *snapname, 321169689Skan dmu_tx_t *tx, boolean_t recv, uint64_t cnt, cred_t *cr); 322132718Skanvoid dsl_dataset_snapshot_sync_impl(dsl_dataset_t *ds, const char *snapname, 32350397Sobrien dmu_tx_t *tx); 324169689Skan 325169689Skanvoid dsl_dataset_remove_from_next_clones(dsl_dataset_t *ds, uint64_t obj, 326169689Skan dmu_tx_t *tx); 327169689Skanvoid dsl_dataset_recalc_head_uniq(dsl_dataset_t *ds); 328132718Skanint dsl_dataset_get_snapname(dsl_dataset_t *ds); 329132718Skanint dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name, 330132718Skan uint64_t *value); 331132718Skanint dsl_dataset_snap_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx, 33250397Sobrien boolean_t adj_cnt); 333132718Skanvoid dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t *ds, 334132718Skan zprop_source_t source, uint64_t value, dmu_tx_t *tx); 33552284Sobrienvoid dsl_dataset_zapify(dsl_dataset_t *ds, dmu_tx_t *tx); 336132718Skanboolean_t dsl_dataset_is_zapified(dsl_dataset_t *ds); 337132718Skanboolean_t dsl_dataset_has_resume_receive_state(dsl_dataset_t *ds); 338132718Skanint dsl_dataset_rollback(const char *fsname, void *owner, nvlist_t *result); 339169689Skan 340132718Skanvoid dsl_dataset_deactivate_feature(uint64_t dsobj, 341132718Skan spa_feature_t f, dmu_tx_t *tx); 342132718Skan 343169689Skan#ifdef ZFS_DEBUG 344169689Skan#define dprintf_ds(ds, fmt, ...) do { \ 345169689Skan if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 346169689Skan char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \ 347169689Skan dsl_dataset_name(ds, __ds_name); \ 348169689Skan dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 34990075Sobrien kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \ 350169689Skan } \ 35190075Sobrien_NOTE(CONSTCOND) } while (0) 35252284Sobrien#else 353132718Skan#define dprintf_ds(dd, fmt, ...) 354132718Skan#endif 355132718Skan 356132718Skan#ifdef __cplusplus 35796263Sobrien} 358132718Skan#endif 359132718Skan 360132718Skan#endif /* _SYS_DSL_DATASET_H */ 361132718Skan