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