1 /* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23 */ 24 25 #ifndef _SYS_DSL_DATASET_H 26 #define _SYS_DSL_DATASET_H 27 28 #include <sys/dmu.h> 29 #include <sys/spa.h> 30 #include <sys/txg.h> 31 #include <sys/zio.h> 32 #include <sys/bplist.h> 33 #include <sys/dsl_synctask.h> 34 #include <sys/zfs_context.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 struct dsl_dataset; 41 struct dsl_dir; 42 struct dsl_pool; 43 44 #define DS_FLAG_INCONSISTENT (1ULL<<0) 45 #define DS_IS_INCONSISTENT(ds) \ 46 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT) 47 /* 48 * NB: nopromote can not yet be set, but we want support for it in this 49 * on-disk version, so that we don't need to upgrade for it later. It 50 * will be needed when we implement 'zfs split' (where the split off 51 * clone should not be promoted). 52 */ 53 #define DS_FLAG_NOPROMOTE (1ULL<<1) 54 55 /* 56 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly 57 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE, 58 * refquota/refreservations). 59 */ 60 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2) 61 62 /* 63 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called 64 * on a dataset. This allows the dataset to be destroyed using 'zfs release'. 65 */ 66 #define DS_FLAG_DEFER_DESTROY (1ULL<<3) 67 #define DS_IS_DEFER_DESTROY(ds) \ 68 ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY) 69 70 /* 71 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose 72 * name lookups should be performed case-insensitively. 73 */ 74 #define DS_FLAG_CI_DATASET (1ULL<<16) 75 76 typedef struct dsl_dataset_phys { 77 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */ 78 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */ 79 uint64_t ds_prev_snap_txg; 80 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */ 81 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */ 82 uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 83 uint64_t ds_creation_time; /* seconds since 1970 */ 84 uint64_t ds_creation_txg; 85 uint64_t ds_deadlist_obj; /* DMU_OT_BPLIST */ 86 uint64_t ds_used_bytes; 87 uint64_t ds_compressed_bytes; 88 uint64_t ds_uncompressed_bytes; 89 uint64_t ds_unique_bytes; /* only relevant to snapshots */ 90 /* 91 * The ds_fsid_guid is a 56-bit ID that can change to avoid 92 * collisions. The ds_guid is a 64-bit ID that will never 93 * change, so there is a small probability that it will collide. 94 */ 95 uint64_t ds_fsid_guid; 96 uint64_t ds_guid; 97 uint64_t ds_flags; /* DS_FLAG_* */ 98 blkptr_t ds_bp; 99 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */ 100 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */ 101 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */ 102 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */ 103 } dsl_dataset_phys_t; 104 105 typedef struct dsl_dataset { 106 /* Immutable: */ 107 struct dsl_dir *ds_dir; 108 dsl_dataset_phys_t *ds_phys; 109 dmu_buf_t *ds_dbuf; 110 uint64_t ds_object; 111 uint64_t ds_fsid_guid; 112 113 /* only used in syncing context, only valid for non-snapshots: */ 114 struct dsl_dataset *ds_prev; 115 116 /* has internal locking: */ 117 bplist_t ds_deadlist; 118 119 /* to protect against multiple concurrent incremental recv */ 120 kmutex_t ds_recvlock; 121 122 /* protected by lock on pool's dp_dirty_datasets list */ 123 txg_node_t ds_dirty_link; 124 list_node_t ds_synced_link; 125 126 /* 127 * ds_phys->ds_<accounting> is also protected by ds_lock. 128 * Protected by ds_lock: 129 */ 130 kmutex_t ds_lock; 131 objset_t *ds_objset; 132 uint64_t ds_userrefs; 133 134 /* 135 * ds_owner is protected by the ds_rwlock and the ds_lock 136 */ 137 krwlock_t ds_rwlock; 138 kcondvar_t ds_exclusive_cv; 139 void *ds_owner; 140 141 /* no locking; only for making guesses */ 142 uint64_t ds_trysnap_txg; 143 144 /* for objset_open() */ 145 kmutex_t ds_opening_lock; 146 147 uint64_t ds_reserved; /* cached refreservation */ 148 uint64_t ds_quota; /* cached refquota */ 149 150 /* Protected by ds_lock; keep at end of struct for better locality */ 151 char ds_snapname[MAXNAMELEN]; 152 } dsl_dataset_t; 153 154 struct dsl_ds_destroyarg { 155 dsl_dataset_t *ds; /* ds to destroy */ 156 dsl_dataset_t *rm_origin; /* also remove our origin? */ 157 boolean_t is_origin_rm; /* set if removing origin snap */ 158 boolean_t defer; /* destroy -d requested? */ 159 boolean_t releasing; /* destroying due to release? */ 160 boolean_t need_prep; /* do we need to retry due to EBUSY? */ 161 }; 162 163 #define dsl_dataset_is_snapshot(ds) \ 164 ((ds)->ds_phys->ds_num_children != 0) 165 166 #define DS_UNIQUE_IS_ACCURATE(ds) \ 167 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) 168 169 int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp); 170 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, 171 void *tag, dsl_dataset_t **); 172 int dsl_dataset_own(const char *name, boolean_t inconsistentok, 173 void *tag, dsl_dataset_t **dsp); 174 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, 175 boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp); 176 void dsl_dataset_name(dsl_dataset_t *ds, char *name); 177 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag); 178 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag); 179 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag); 180 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok, 181 void *tag); 182 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag); 183 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname, 184 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *); 185 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin, 186 uint64_t flags, dmu_tx_t *tx); 187 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer); 188 int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer); 189 dsl_checkfunc_t dsl_dataset_destroy_check; 190 dsl_syncfunc_t dsl_dataset_destroy_sync; 191 dsl_checkfunc_t dsl_dataset_snapshot_check; 192 dsl_syncfunc_t dsl_dataset_snapshot_sync; 193 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); 194 int dsl_dataset_promote(const char *name, char *conflsnap); 195 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 196 boolean_t force); 197 int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag, 198 boolean_t recursive, boolean_t temphold); 199 int dsl_dataset_user_release(char *dsname, char *snapname, char *htag, 200 boolean_t recursive); 201 int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj, 202 char *htag); 203 int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp); 204 205 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 206 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 207 208 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 209 210 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds); 211 212 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 213 214 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp, 215 dmu_tx_t *tx); 216 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp, 217 dmu_tx_t *tx, boolean_t async); 218 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth); 219 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 220 221 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 222 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 223 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 224 void dsl_dataset_space(dsl_dataset_t *ds, 225 uint64_t *refdbytesp, uint64_t *availbytesp, 226 uint64_t *usedobjsp, uint64_t *availobjsp); 227 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 228 229 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 230 231 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, 232 uint64_t asize, uint64_t inflight, uint64_t *used, 233 uint64_t *ref_rsrv); 234 int dsl_dataset_set_quota(const char *dsname, zprop_source_t source, 235 uint64_t quota); 236 dsl_syncfunc_t dsl_dataset_set_quota_sync; 237 int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source, 238 uint64_t reservation); 239 240 int dsl_destroy_inconsistent(const char *dsname, void *arg); 241 242 #ifdef ZFS_DEBUG 243 #define dprintf_ds(ds, fmt, ...) do { \ 244 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 245 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 246 dsl_dataset_name(ds, __ds_name); \ 247 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 248 kmem_free(__ds_name, MAXNAMELEN); \ 249 } \ 250 _NOTE(CONSTCOND) } while (0) 251 #else 252 #define dprintf_ds(dd, fmt, ...) 253 #endif 254 255 #ifdef __cplusplus 256 } 257 #endif 258 259 #endif /* _SYS_DSL_DATASET_H */ 260