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