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_EMBEDOK "com.delphix:resume_embedok"
 112
 113 /*
 114  * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
 115  * name lookups should be performed case-insensitively.
 116  */
 117 #define DS_FLAG_CI_DATASET      (1ULL<<16)
 118
 119 #define DS_CREATE_FLAG_NODIRTY  (1ULL<<24)
 120
 121 typedef struct dsl_dataset_phys {
 122         uint64_t ds_dir_obj;            /* DMU_OT_DSL_DIR */
 123         uint64_t ds_prev_snap_obj;      /* DMU_OT_DSL_DATASET */
 124         uint64_t ds_prev_snap_txg;
 125         uint64_t ds_next_snap_obj;      /* DMU_OT_DSL_DATASET */
 126         uint64_t ds_snapnames_zapobj;   /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
 127         uint64_t ds_num_children;       /* clone/snap children; ==0 for head */
 128         uint64_t ds_creation_time;      /* seconds since 1970 */
 129         uint64_t ds_creation_txg;
 130         uint64_t ds_deadlist_obj;       /* DMU_OT_DEADLIST */
 131         /*
 132          * ds_referenced_bytes, ds_compressed_bytes, and ds_uncompressed_bytes
 133          * include all blocks referenced by this dataset, including those
 134          * shared with any other datasets.
 135          */
 136         uint64_t ds_referenced_bytes;
 137         uint64_t ds_compressed_bytes;
 138         uint64_t ds_uncompressed_bytes;
 139         uint64_t ds_unique_bytes;       /* only relevant to snapshots */
 140         /*
 141          * The ds_fsid_guid is a 56-bit ID that can change to avoid
 142          * collisions.  The ds_guid is a 64-bit ID that will never
 143          * change, so there is a small probability that it will collide.
 144          */
 145         uint64_t ds_fsid_guid;
 146         uint64_t ds_guid;
 147         uint64_t ds_flags;              /* DS_FLAG_* */
 148         blkptr_t ds_bp;
 149         uint64_t ds_next_clones_obj;    /* DMU_OT_DSL_CLONES */
 150         uint64_t ds_props_obj;          /* DMU_OT_DSL_PROPS for snaps */
 151         uint64_t ds_userrefs_obj;       /* DMU_OT_USERREFS */
 152         uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
 153 } dsl_dataset_phys_t;
 154
 155 typedef struct dsl_dataset {
 156         dmu_buf_user_t ds_dbu;
 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 int dsl_dataset_hold(struct dsl_pool *dp, const char *name, void *tag,
 252     dsl_dataset_t **dsp);
 253 boolean_t dsl_dataset_try_add_ref(struct dsl_pool *dp, dsl_dataset_t *ds,
 254     void *tag);
 255 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, void *tag,
 256     dsl_dataset_t **);
 257 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
 258 int dsl_dataset_own(struct dsl_pool *dp, const char *name,
 259     void *tag, dsl_dataset_t **dsp);
 260 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
 261     void *tag, dsl_dataset_t **dsp);
 262 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
 263 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
 264 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, void *tag);
 265 int dsl_dataset_namelen(dsl_dataset_t *ds);
 266 boolean_t dsl_dataset_has_owner(dsl_dataset_t *ds);
 267 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
 268     dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
 269 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
 270     uint64_t flags, dmu_tx_t *tx);
 271 int dsl_dataset_snapshot(nvlist_t *snaps, nvlist_t *props, nvlist_t *errors);
 272 int dsl_dataset_promote(const char *name, char *conflsnap);
 273 int dsl_dataset_rename_snapshot(const char *fsname,
 274     const char *oldsnapname, const char *newsnapname, boolean_t recursive);
 275 int dsl_dataset_snapshot_tmp(const char *fsname, const char *snapname,
 276     minor_t cleanup_minor, const char *htag);
 277
 278 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
 279 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
 280
 281 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
 282
 283 boolean_t dsl_dataset_modified_since_snap(dsl_dataset_t *ds,
 284     dsl_dataset_t *snap);
 285
 286 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
 287
 288 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
 289     dmu_tx_t *tx);
 290 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
 291     dmu_tx_t *tx, boolean_t async);
 292 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
 293     uint64_t blk_birth);
 294 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
 295 int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
 296     uint64_t *value);
 297
 298 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
 299 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
 300 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
 301 void dsl_dataset_space(dsl_dataset_t *ds,
 302     uint64_t *refdbytesp, uint64_t *availbytesp,
 303     uint64_t *usedobjsp, uint64_t *availobjsp);
 304 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
 305 int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
 306     uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
 307 int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
 308     uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
 309 boolean_t dsl_dataset_is_dirty(dsl_dataset_t *ds);
 310
 311 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
 312
 313 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
 314     uint64_t asize, uint64_t inflight, uint64_t *used,
 315     uint64_t *ref_rsrv);
 316 int dsl_dataset_set_refquota(const char *dsname, zprop_source_t source,
 317     uint64_t quota);
 318 int dsl_dataset_set_refreservation(const char *dsname, zprop_source_t source,
 319     uint64_t reservation);
 320
 321 boolean_t dsl_dataset_is_before(dsl_dataset_t *later, dsl_dataset_t *earlier,
 322     uint64_t earlier_txg);
 323 void dsl_dataset_long_hold(dsl_dataset_t *ds, void *tag);
 324 void dsl_dataset_long_rele(dsl_dataset_t *ds, void *tag);
 325 boolean_t dsl_dataset_long_held(dsl_dataset_t *ds);
 326
 327 int dsl_dataset_clone_swap_check_impl(dsl_dataset_t *clone,
 328     dsl_dataset_t *origin_head, boolean_t force, void *owner, dmu_tx_t *tx);
 329 void dsl_dataset_clone_swap_sync_impl(dsl_dataset_t *clone,
 330     dsl_dataset_t *origin_head, dmu_tx_t *tx);
 331 int dsl_dataset_snapshot_check_impl(dsl_dataset_t *ds, const char *snapname,
 332     dmu_tx_t *tx, boolean_t recv, uint64_t cnt, cred_t *cr);
 333 void dsl_dataset_snapshot_sync_impl(dsl_dataset_t *ds, const char *snapname,
 334     dmu_tx_t *tx);
 335
 336 void dsl_dataset_remove_from_next_clones(dsl_dataset_t *ds, uint64_t obj,
 337     dmu_tx_t *tx);
 338 void dsl_dataset_recalc_head_uniq(dsl_dataset_t *ds);
 339 int dsl_dataset_get_snapname(dsl_dataset_t *ds);
 340 int dsl_dataset_snap_lookup(dsl_dataset_t *ds, const char *name,
 341     uint64_t *value);
 342 int dsl_dataset_snap_remove(dsl_dataset_t *ds, const char *name, dmu_tx_t *tx,
 343     boolean_t adj_cnt);
 344 void dsl_dataset_set_refreservation_sync_impl(dsl_dataset_t *ds,
 345     zprop_source_t source, uint64_t value, dmu_tx_t *tx);
 346 void dsl_dataset_zapify(dsl_dataset_t *ds, dmu_tx_t *tx);
 347 boolean_t dsl_dataset_is_zapified(dsl_dataset_t *ds);
 348 boolean_t dsl_dataset_has_resume_receive_state(dsl_dataset_t *ds);
 349 int dsl_dataset_rollback(const char *fsname, void *owner, nvlist_t *result);
 350
 351 void dsl_dataset_deactivate_feature(uint64_t dsobj,
 352     spa_feature_t f, dmu_tx_t *tx);
 353
 354 #ifdef ZFS_DEBUG
 355 #define dprintf_ds(ds, fmt, ...) do { \
 356         if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
 357         char *__ds_name = kmem_alloc(ZFS_MAX_DATASET_NAME_LEN, KM_SLEEP); \
 358         dsl_dataset_name(ds, __ds_name); \
 359         dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
 360         kmem_free(__ds_name, ZFS_MAX_DATASET_NAME_LEN); \
 361         } \
 362 _NOTE(CONSTCOND) } while (0)
 363 #else
 364 #define dprintf_ds(dd, fmt, ...)
 365 #endif
 366
 367 #ifdef  __cplusplus
 368 }
 369 #endif
 370
 371 #endif /* _SYS_DSL_DATASET_H */