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