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