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