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