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 * Copyright (c) 2011, 2015 by Delphix. All rights reserved. 24 * Copyright (c) 2013, Joyent, Inc. All rights reserved. 25 * Copyright (c) 2013 Steven Hartland. All rights reserved. 26 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. 27 */ 28 29 #ifndef _SYS_DSL_DATASET_H 30 #define _SYS_DSL_DATASET_H 31 32 #include <sys/dmu.h> 33 #include <sys/spa.h> 34 #include <sys/txg.h> 35 #include <sys/zio.h> 36 #include <sys/bplist.h> 37 #include <sys/dsl_synctask.h> 38 #include <sys/zfs_context.h> 39 #include <sys/dsl_deadlist.h> 40 #include <sys/refcount.h> 41 #include <zfeature_common.h> 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 struct dsl_dataset; 48 struct dsl_dir; 49 struct dsl_pool; 50 51 #define DS_FLAG_INCONSISTENT (1ULL<<0) 52 #define DS_IS_INCONSISTENT(ds) \ 53 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_INCONSISTENT) 54 55 /* 56 * Do not allow this dataset to be promoted. 57 */ 58 #define DS_FLAG_NOPROMOTE (1ULL<<1) 59 60 /* 61 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly 62 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE, 63 * refquota/refreservations). 64 */ 65 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2) 66 67 /* 68 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called 69 * on a dataset. This allows the dataset to be destroyed using 'zfs release'. 70 */ 71 #define DS_FLAG_DEFER_DESTROY (1ULL<<3) 72 #define DS_IS_DEFER_DESTROY(ds) \ 73 (dsl_dataset_phys(ds)->ds_flags & DS_FLAG_DEFER_DESTROY) 74 75 /* 76 * DS_FIELD_* are strings that are used in the "extensified" dataset zap object. 77 * They should be of the format <reverse-dns>:<field>. 78 */ 79 80 /* 81 * This field's value is the object ID of a zap object which contains the 82 * bookmarks of this dataset. If it is present, then this dataset is counted 83 * in the refcount of the SPA_FEATURES_BOOKMARKS feature. 84 */ 85 #define DS_FIELD_BOOKMARK_NAMES "com.delphix:bookmarks" 86 87 /* 88 * This field is present (with value=0) if this dataset may contain large 89 * blocks (>128KB). If it is present, then this dataset 90 * is counted in the refcount of the SPA_FEATURE_LARGE_BLOCKS feature. 91 */ 92 #define DS_FIELD_LARGE_BLOCKS "org.open-zfs:large_blocks" 93 94 /* 95 * These fields are set on datasets that are in the middle of a resumable 96 * receive, and allow the sender to resume the send if it is interrupted. 97 */ 98 #define DS_FIELD_RESUME_FROMGUID "com.delphix:resume_fromguid" 99 #define DS_FIELD_RESUME_TONAME "com.delphix:resume_toname" 100 #define DS_FIELD_RESUME_TOGUID "com.delphix:resume_toguid" 101 #define DS_FIELD_RESUME_OBJECT "com.delphix:resume_object" 102 #define DS_FIELD_RESUME_OFFSET "com.delphix:resume_offset" 103 #define DS_FIELD_RESUME_BYTES "com.delphix:resume_bytes" 104 #define DS_FIELD_RESUME_EMBEDOK "com.delphix:resume_embedok" 105 106 /* 107 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose 108 * name lookups should be performed case-insensitively. 109 */ 110 #define DS_FLAG_CI_DATASET (1ULL<<16) 111 112 #define DS_CREATE_FLAG_NODIRTY (1ULL<<24) 113 114 typedef struct dsl_dataset_phys { 115 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */ 116 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */ 117 uint64_t ds_prev_snap_txg; 118 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */ 119 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */ 120 uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 121 uint64_t ds_creation_time; /* seconds since 1970 */ 122 uint64_t ds_creation_txg; 123 uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */ 124 /* 125 * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes 126 * include all blocks referenced by this dataset, including those 127 * shared with any other datasets. 128 */ 129 uint64_t ds_referenced_bytes; 130 uint64_t ds_compressed_bytes; 131 uint64_t ds_uncompressed_bytes; 132 uint64_t ds_unique_bytes; /* only relevant to snapshots */ 133 /* 134 * The ds_fsid_guid is a 56-bit ID that can change to avoid 135 * collisions. The ds_guid is a 64-bit ID that will never 136 * change, so there is a small probability that it will collide. 137 */ 138 uint64_t ds_fsid_guid; 139 uint64_t ds_guid; 140 uint64_t ds_flags; /* DS_FLAG_* */ 141 blkptr_t ds_bp; 142 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */ 143 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */ 144 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */ 145 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */ 146 } dsl_dataset_phys_t; 147 148 typedef struct dsl_dataset { 149 dmu_buf_user_t ds_dbu; 150 151 /* Immutable: */ 152 struct dsl_dir *ds_dir; 153 dmu_buf_t *ds_dbuf; 154 uint64_t ds_object; 155 uint64_t ds_fsid_guid; 156 boolean_t ds_is_snapshot; 157 158 /* only used in syncing context, only valid for non-snapshots: */ 159 struct dsl_dataset *ds_prev; 160 uint64_t ds_bookmarks; /* DMU_OTN_ZAP_METADATA */ 161 162 /* has internal locking: */ 163 dsl_deadlist_t ds_deadlist; 164 bplist_t ds_pending_deadlist; 165 166 /* protected by lock on pool's dp_dirty_datasets list */ 167 txg_node_t ds_dirty_link; 168 list_node_t ds_synced_link; 169 170 /* 171 * ds_phys->ds_<accounting> is also protected by ds_lock. 172 * Protected by ds_lock: 173 */ 174 kmutex_t ds_lock; 175 objset_t *ds_objset; 176 uint64_t ds_userrefs; 177 void *ds_owner; 178 179 /* 180 * Long holds prevent the ds from being destroyed; they allow the 181 * ds to remain held even after dropping the dp_config_rwlock. 182 * Owning counts as a long hold. See the comments above 183 * dsl_pool_hold() for details. 184 */ 185 refcount_t ds_longholds; 186 187 /* no locking; only for making guesses */ 188 uint64_t ds_trysnap_txg; 189 190 /* for objset_open() */ 191 kmutex_t ds_opening_lock; 192 193 uint64_t ds_reserved; /* cached refreservation */ 194 uint64_t ds_quota; /* cached refquota */ 195 196 kmutex_t ds_sendstream_lock; 197 list_t ds_sendstreams; 198 199 /* 200 * When in the middle of a resumable receive, tracks how much 201 * progress we have made. 202 */ 203 uint64_t ds_resume_object[TXG_SIZE]; 204 uint64_t ds_resume_offset[TXG_SIZE]; 205 uint64_t ds_resume_bytes[TXG_SIZE]; 206 207 /* Protected by our dsl_dir's dd_lock */ 208 list_t ds_prop_cbs; 209 210 /* 211 * For ZFEATURE_FLAG_PER_DATASET features, set if this dataset 212 * uses this feature. 213 */ 214 uint8_t ds_feature_inuse[SPA_FEATURES]; 215 216 /* 217 * Set if we need to activate the feature on this dataset this txg 218 * (used only in syncing context). 219 */ 220 uint8_t ds_feature_activation_needed[SPA_FEATURES]; 221 222 /* Protected by ds_lock; keep at end of struct for better locality */ 223 char ds_snapname[MAXNAMELEN]; 224 } dsl_dataset_t; 225 226 inline dsl_dataset_phys_t * 227 dsl_dataset_phys(dsl_dataset_t *ds) 228 { 229 return (ds->ds_dbuf->db_data); 230 } 231 232 /* 233 * The max length of a temporary tag prefix is the number of hex digits 234 * required to express UINT64_MAX plus one for the hyphen. 235 */ 236 #define MAX_TAG_PREFIX_LEN 17 237 238 #define dsl_dataset_is_snapshot(ds) \ 239 (dsl_dataset_phys(ds)->ds_num_children != 0) 240 241 #define DS_UNIQUE_IS_ACCURATE(ds) \ 242 ((dsl_dataset_phys(ds)->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) 243 244 int dsl_dataset_hold(struct dsl_pool *dp, const char *name, void *tag, 245 dsl_dataset_t **dsp); 246 boolean_t dsl_dataset_try_add_ref(struct dsl_pool *dp, dsl_dataset_t *ds, 247 void *tag); 248 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, void *tag, 249 dsl_dataset_t **); 250 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag); 251 int dsl_dataset_own(struct dsl_pool *dp, const char *name, 252 void *tag, dsl_dataset_t **dsp); 253 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, 254 void *tag, dsl_dataset_t **dsp); 255 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag); 256 void dsl_dataset_name(dsl_dataset_t *ds, char *name); 257 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, void *tag); 258 boolean_t dsl_dataset_has_owner(dsl_dataset_t *ds); 259 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname, 260 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *); 261 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin, 262 uint64_t flags, dmu_tx_t *tx); 263 int dsl_dataset_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t *errors); 264 int dsl_dataset_promote(const char *name, char *conflsnap); 265 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 266 boolean_t force); 267 int dsl_dataset_rename_snapshot(const char *fsname, 268 const char *oldsnapname, const char *newsnapname, boolean_t recursive); 269 int dsl_dataset_snapshot_tmp(const char *fsname, const char *snapname, 270 minor_t cleanup_minor, const char *htag); 271 272 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 273 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 274 275 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 276 277 boolean_t dsl_dataset_modified_since_snap(dsl_dataset_t *ds, 278 dsl_dataset_t *snap); 279 280 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 281 282 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp, 283 dmu_tx_t *tx); 284 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp, 285 dmu_tx_t *tx, boolean_t async); 286 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp, 287 uint64_t blk_birth); 288 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 289 290 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 291 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 292 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 293 void dsl_dataset_space(dsl_dataset_t *ds, 294 uint64_t *refdbytesp, uint64_t *availbytesp, 295 uint64_t *usedobjsp, uint64_t *availobjsp); 296 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 297 int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new, 298 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp); 299 int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last, 300 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp); 301 boolean_t dsl_dataset_is_dirty(dsl_dataset_t *ds); 302 303 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 304 305 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, 306 uint64_t asize, uint64_t inflight, uint64_t *used, 307 uint64_t *ref_rsrv); 308 int dsl_dataset_set_refquota(const char *dsname, zprop_source_t source, 309 uint64_t quota); 310 int dsl_dataset_set_refreservation(const char *dsname, zprop_source_t source, 311 uint64_t reservation); 312 313 boolean_t dsl_dataset_is_before(dsl_dataset_t *later, dsl_dataset_t *earlier, 314 uint64_t earlier_txg); 315 void dsl_dataset_long_hold(dsl_dataset_t *ds, void *tag); 316 void dsl_dataset_long_rele(dsl_dataset_t *ds, void *tag); 317 boolean_t dsl_dataset_long_held(dsl_dataset_t *ds); 318 319 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t *clone, 320 dsl_dataset_t *origin_head, boolean_t force, void *owner, dmu_tx_t *tx); 321 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t *clone, 322 dsl_dataset_t *origin_head, dmu_tx_t *tx); 323 int dsl_dataset_snapshot_check_impl(dsl_dataset_t *ds, const char *snapname, 324 dmu_tx_t *tx, boolean_t recv, uint64_t cnt, cred_t *cr); 325 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t *ds, const char *snapname, 326 dmu_tx_t *tx); 327 328 void dsl_dataset_remove_from_next_clones(dsl_dataset_t *ds, uint64_t obj, 329 dmu_tx_t *tx); 330 void dsl_dataset_recalc_head_uniq(dsl_dataset_t *ds); 331 int dsl_dataset_get_snapname(dsl_dataset_t *ds); 332 int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name, 333 uint64_t *value); 334 int dsl_dataset_snap_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx, 335 boolean_t adj_cnt); 336 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t *ds, 337 zprop_source_t source, uint64_t value, dmu_tx_t *tx); 338 void dsl_dataset_zapify(dsl_dataset_t *ds, dmu_tx_t *tx); 339 boolean_t dsl_dataset_is_zapified(dsl_dataset_t *ds); 340 boolean_t dsl_dataset_has_resume_receive_state(dsl_dataset_t *ds); 341 int dsl_dataset_rollback(const char *fsname, void *owner, nvlist_t *result); 342 343 void dsl_dataset_deactivate_feature(uint64_t dsobj, 344 spa_feature_t f, dmu_tx_t *tx); 345 346 #ifdef ZFS_DEBUG 347 #define dprintf_ds(ds, fmt, ...) do { \ 348 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 349 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 350 dsl_dataset_name(ds, __ds_name); \ 351 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 352 kmem_free(__ds_name, MAXNAMELEN); \ 353 } \ 354 _NOTE(CONSTCOND) } while (0) 355 #else 356 #define dprintf_ds(dd, fmt, ...) 357 #endif 358 359 #ifdef __cplusplus 360 } 361 #endif 362 363 #endif /* _SYS_DSL_DATASET_H */ 364