1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5ea8dc4b6Seschrock * Common Development and Distribution License (the "License"). 6ea8dc4b6Seschrock * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21fa9e4066Sahrens /* 223f9d6ad7SLin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23fa9e4066Sahrens */ 24fa9e4066Sahrens 25fa9e4066Sahrens #ifndef _SYS_DSL_DATASET_H 26fa9e4066Sahrens #define _SYS_DSL_DATASET_H 27fa9e4066Sahrens 28fa9e4066Sahrens #include <sys/dmu.h> 29fa9e4066Sahrens #include <sys/spa.h> 30fa9e4066Sahrens #include <sys/txg.h> 31c717a561Smaybee #include <sys/zio.h> 32fa9e4066Sahrens #include <sys/bplist.h> 331d452cf5Sahrens #include <sys/dsl_synctask.h> 34fa9e4066Sahrens #include <sys/zfs_context.h> 35*cde58dbcSMatthew Ahrens #include <sys/dsl_deadlist.h> 36fa9e4066Sahrens 37fa9e4066Sahrens #ifdef __cplusplus 38fa9e4066Sahrens extern "C" { 39fa9e4066Sahrens #endif 40fa9e4066Sahrens 41fa9e4066Sahrens struct dsl_dataset; 42fa9e4066Sahrens struct dsl_dir; 43fa9e4066Sahrens struct dsl_pool; 44fa9e4066Sahrens 4599653d4eSeschrock #define DS_FLAG_INCONSISTENT (1ULL<<0) 46745cd3c5Smaybee #define DS_IS_INCONSISTENT(ds) \ 47745cd3c5Smaybee ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT) 4899653d4eSeschrock /* 4999653d4eSeschrock * NB: nopromote can not yet be set, but we want support for it in this 5099653d4eSeschrock * on-disk version, so that we don't need to upgrade for it later. It 5199653d4eSeschrock * will be needed when we implement 'zfs split' (where the split off 5299653d4eSeschrock * clone should not be promoted). 5399653d4eSeschrock */ 5499653d4eSeschrock #define DS_FLAG_NOPROMOTE (1ULL<<1) 5599653d4eSeschrock 56a9799022Sck /* 57a9799022Sck * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly 58a9799022Sck * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE, 59a9799022Sck * refquota/refreservations). 60a9799022Sck */ 61a9799022Sck #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2) 62a9799022Sck 63842727c2SChris Kirby /* 64842727c2SChris Kirby * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called 65842727c2SChris Kirby * on a dataset. This allows the dataset to be destroyed using 'zfs release'. 66842727c2SChris Kirby */ 67842727c2SChris Kirby #define DS_FLAG_DEFER_DESTROY (1ULL<<3) 68842727c2SChris Kirby #define DS_IS_DEFER_DESTROY(ds) \ 69842727c2SChris Kirby ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY) 70842727c2SChris Kirby 71ab04eb8eStimh /* 72ab04eb8eStimh * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose 73ab04eb8eStimh * name lookups should be performed case-insensitively. 74ab04eb8eStimh */ 75ab04eb8eStimh #define DS_FLAG_CI_DATASET (1ULL<<16) 76ab04eb8eStimh 77fa9e4066Sahrens typedef struct dsl_dataset_phys { 78088f3894Sahrens uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */ 79088f3894Sahrens uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */ 80fa9e4066Sahrens uint64_t ds_prev_snap_txg; 81088f3894Sahrens uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */ 82088f3894Sahrens uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */ 83fa9e4066Sahrens uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 84fa9e4066Sahrens uint64_t ds_creation_time; /* seconds since 1970 */ 85fa9e4066Sahrens uint64_t ds_creation_txg; 86*cde58dbcSMatthew Ahrens uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */ 87fa9e4066Sahrens uint64_t ds_used_bytes; 88fa9e4066Sahrens uint64_t ds_compressed_bytes; 89fa9e4066Sahrens uint64_t ds_uncompressed_bytes; 9063360950Smp uint64_t ds_unique_bytes; /* only relevant to snapshots */ 91fa9e4066Sahrens /* 92fa9e4066Sahrens * The ds_fsid_guid is a 56-bit ID that can change to avoid 93fa9e4066Sahrens * collisions. The ds_guid is a 64-bit ID that will never 94fa9e4066Sahrens * change, so there is a small probability that it will collide. 95fa9e4066Sahrens */ 96fa9e4066Sahrens uint64_t ds_fsid_guid; 97fa9e4066Sahrens uint64_t ds_guid; 98088f3894Sahrens uint64_t ds_flags; /* DS_FLAG_* */ 99fa9e4066Sahrens blkptr_t ds_bp; 100bb0ade09Sahrens uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */ 101bb0ade09Sahrens uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */ 102842727c2SChris Kirby uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */ 103842727c2SChris Kirby uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */ 104fa9e4066Sahrens } dsl_dataset_phys_t; 105fa9e4066Sahrens 106fa9e4066Sahrens typedef struct dsl_dataset { 107fa9e4066Sahrens /* Immutable: */ 108fa9e4066Sahrens struct dsl_dir *ds_dir; 109fa9e4066Sahrens dsl_dataset_phys_t *ds_phys; 110fa9e4066Sahrens dmu_buf_t *ds_dbuf; 111fa9e4066Sahrens uint64_t ds_object; 11291ebeef5Sahrens uint64_t ds_fsid_guid; 113fa9e4066Sahrens 11474e7dc98SMatthew Ahrens /* only used in syncing context, only valid for non-snapshots: */ 11574e7dc98SMatthew Ahrens struct dsl_dataset *ds_prev; 116fa9e4066Sahrens 117fa9e4066Sahrens /* has internal locking: */ 118*cde58dbcSMatthew Ahrens dsl_deadlist_t ds_deadlist; 119*cde58dbcSMatthew Ahrens bplist_t ds_pending_deadlist; 120fa9e4066Sahrens 121f4b94bdeSMatthew Ahrens /* to protect against multiple concurrent incremental recv */ 122f4b94bdeSMatthew Ahrens kmutex_t ds_recvlock; 123f4b94bdeSMatthew Ahrens 124fa9e4066Sahrens /* protected by lock on pool's dp_dirty_datasets list */ 125fa9e4066Sahrens txg_node_t ds_dirty_link; 126fa9e4066Sahrens list_node_t ds_synced_link; 127fa9e4066Sahrens 128fa9e4066Sahrens /* 129fa9e4066Sahrens * ds_phys->ds_<accounting> is also protected by ds_lock. 130fa9e4066Sahrens * Protected by ds_lock: 131fa9e4066Sahrens */ 132fa9e4066Sahrens kmutex_t ds_lock; 133503ad85cSMatthew Ahrens objset_t *ds_objset; 134842727c2SChris Kirby uint64_t ds_userrefs; 135745cd3c5Smaybee 136745cd3c5Smaybee /* 137745cd3c5Smaybee * ds_owner is protected by the ds_rwlock and the ds_lock 138745cd3c5Smaybee */ 139745cd3c5Smaybee krwlock_t ds_rwlock; 140745cd3c5Smaybee kcondvar_t ds_exclusive_cv; 141745cd3c5Smaybee void *ds_owner; 142fa9e4066Sahrens 1431d452cf5Sahrens /* no locking; only for making guesses */ 1441d452cf5Sahrens uint64_t ds_trysnap_txg; 1451d452cf5Sahrens 14691ebeef5Sahrens /* for objset_open() */ 14791ebeef5Sahrens kmutex_t ds_opening_lock; 14891ebeef5Sahrens 149a9799022Sck uint64_t ds_reserved; /* cached refreservation */ 150a9799022Sck uint64_t ds_quota; /* cached refquota */ 151a9799022Sck 152fa9e4066Sahrens /* Protected by ds_lock; keep at end of struct for better locality */ 153fa9e4066Sahrens char ds_snapname[MAXNAMELEN]; 154fa9e4066Sahrens } dsl_dataset_t; 155fa9e4066Sahrens 156842727c2SChris Kirby struct dsl_ds_destroyarg { 157842727c2SChris Kirby dsl_dataset_t *ds; /* ds to destroy */ 158842727c2SChris Kirby dsl_dataset_t *rm_origin; /* also remove our origin? */ 159842727c2SChris Kirby boolean_t is_origin_rm; /* set if removing origin snap */ 160842727c2SChris Kirby boolean_t defer; /* destroy -d requested? */ 161842727c2SChris Kirby boolean_t releasing; /* destroying due to release? */ 162842727c2SChris Kirby boolean_t need_prep; /* do we need to retry due to EBUSY? */ 163842727c2SChris Kirby }; 164842727c2SChris Kirby 165*cde58dbcSMatthew Ahrens #define dsl_dataset_is_snapshot(ds) \ 166fa9e4066Sahrens ((ds)->ds_phys->ds_num_children != 0) 167fa9e4066Sahrens 168a9799022Sck #define DS_UNIQUE_IS_ACCURATE(ds) \ 169a9799022Sck (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) 170a9799022Sck 171745cd3c5Smaybee int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp); 172745cd3c5Smaybee int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, 173745cd3c5Smaybee void *tag, dsl_dataset_t **); 174503ad85cSMatthew Ahrens int dsl_dataset_own(const char *name, boolean_t inconsistentok, 175503ad85cSMatthew Ahrens void *tag, dsl_dataset_t **dsp); 176745cd3c5Smaybee int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, 177503ad85cSMatthew Ahrens boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp); 178fa9e4066Sahrens void dsl_dataset_name(dsl_dataset_t *ds, char *name); 179745cd3c5Smaybee void dsl_dataset_rele(dsl_dataset_t *ds, void *tag); 180503ad85cSMatthew Ahrens void dsl_dataset_disown(dsl_dataset_t *ds, void *tag); 181088f3894Sahrens void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag); 182745cd3c5Smaybee boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok, 183503ad85cSMatthew Ahrens void *tag); 184503ad85cSMatthew Ahrens void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag); 185745cd3c5Smaybee uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname, 186745cd3c5Smaybee dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *); 187088f3894Sahrens uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin, 188088f3894Sahrens uint64_t flags, dmu_tx_t *tx); 189842727c2SChris Kirby int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer); 190842727c2SChris Kirby int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer); 1913cb34c60Sahrens dsl_checkfunc_t dsl_dataset_destroy_check; 1923cb34c60Sahrens dsl_syncfunc_t dsl_dataset_destroy_sync; 1931d452cf5Sahrens dsl_checkfunc_t dsl_dataset_snapshot_check; 1941d452cf5Sahrens dsl_syncfunc_t dsl_dataset_snapshot_sync; 195cdf5b4caSmmusante int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); 196681d9761SEric Taylor int dsl_dataset_promote(const char *name, char *conflsnap); 1973cb34c60Sahrens int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 1983cb34c60Sahrens boolean_t force); 199842727c2SChris Kirby int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag, 200ca45db41SChris Kirby boolean_t recursive, boolean_t temphold); 201842727c2SChris Kirby int dsl_dataset_user_release(char *dsname, char *snapname, char *htag, 202842727c2SChris Kirby boolean_t recursive); 203ca45db41SChris Kirby int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj, 204ca45db41SChris Kirby char *htag); 205842727c2SChris Kirby int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp); 206fa9e4066Sahrens 207c717a561Smaybee blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 208fa9e4066Sahrens void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 209fa9e4066Sahrens 210fa9e4066Sahrens spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 211fa9e4066Sahrens 212f18faf3fSek boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds); 213f18faf3fSek 214c717a561Smaybee void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 215fa9e4066Sahrens 216b24ab676SJeff Bonwick void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp, 217c717a561Smaybee dmu_tx_t *tx); 218b24ab676SJeff Bonwick int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp, 219b24ab676SJeff Bonwick dmu_tx_t *tx, boolean_t async); 220c7cd2421SGeorge Wilson boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp, 221c7cd2421SGeorge Wilson uint64_t blk_birth); 222ea8dc4b6Seschrock uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 223fa9e4066Sahrens 224fa9e4066Sahrens void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 225a2eea2e1Sahrens void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 226a2eea2e1Sahrens void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 227a2eea2e1Sahrens void dsl_dataset_space(dsl_dataset_t *ds, 228a2eea2e1Sahrens uint64_t *refdbytesp, uint64_t *availbytesp, 229a2eea2e1Sahrens uint64_t *usedobjsp, uint64_t *availobjsp); 230a2eea2e1Sahrens uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 231fa9e4066Sahrens 232b1b8ab34Slling int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 233b1b8ab34Slling 234a9799022Sck int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, 2359082849eSck uint64_t asize, uint64_t inflight, uint64_t *used, 2369082849eSck uint64_t *ref_rsrv); 23792241e0bSTom Erickson int dsl_dataset_set_quota(const char *dsname, zprop_source_t source, 23892241e0bSTom Erickson uint64_t quota); 2393f9d6ad7SLin Ling dsl_syncfunc_t dsl_dataset_set_quota_sync; 24092241e0bSTom Erickson int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source, 24192241e0bSTom Erickson uint64_t reservation); 242a9799022Sck 243fd136879SMatthew Ahrens int dsl_destroy_inconsistent(const char *dsname, void *arg); 244503ad85cSMatthew Ahrens 245fa9e4066Sahrens #ifdef ZFS_DEBUG 246fa9e4066Sahrens #define dprintf_ds(ds, fmt, ...) do { \ 247fa9e4066Sahrens if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 248fa9e4066Sahrens char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 249fa9e4066Sahrens dsl_dataset_name(ds, __ds_name); \ 250fa9e4066Sahrens dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 251fa9e4066Sahrens kmem_free(__ds_name, MAXNAMELEN); \ 252fa9e4066Sahrens } \ 253fa9e4066Sahrens _NOTE(CONSTCOND) } while (0) 254fa9e4066Sahrens #else 255fa9e4066Sahrens #define dprintf_ds(dd, fmt, ...) 256fa9e4066Sahrens #endif 257fa9e4066Sahrens 258fa9e4066Sahrens #ifdef __cplusplus 259fa9e4066Sahrens } 260fa9e4066Sahrens #endif 261fa9e4066Sahrens 262fa9e4066Sahrens #endif /* _SYS_DSL_DATASET_H */ 263