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