include/sys/dsl_dataset.h

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