Home | History | Annotate | Download | only in sys
      1    789    ahrens /*
      2    789    ahrens  * CDDL HEADER START
      3    789    ahrens  *
      4    789    ahrens  * The contents of this file are subject to the terms of the
      5   1544  eschrock  * Common Development and Distribution License (the "License").
      6   1544  eschrock  * You may not use this file except in compliance with the License.
      7    789    ahrens  *
      8    789    ahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9    789    ahrens  * or http://www.opensolaris.org/os/licensing.
     10    789    ahrens  * See the License for the specific language governing permissions
     11    789    ahrens  * and limitations under the License.
     12    789    ahrens  *
     13    789    ahrens  * When distributing Covered Code, include this CDDL HEADER in each
     14    789    ahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15    789    ahrens  * If applicable, add the following below this CDDL HEADER, with the
     16    789    ahrens  * fields enclosed by brackets "[]" replaced with your own identifying
     17    789    ahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
     18    789    ahrens  *
     19    789    ahrens  * CDDL HEADER END
     20    789    ahrens  */
     21    789    ahrens /*
     22   9653   Sanjeev  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
     23    789    ahrens  * Use is subject to license terms.
     24    789    ahrens  */
     25    789    ahrens 
     26    789    ahrens #ifndef	_SYS_DSL_DATASET_H
     27    789    ahrens #define	_SYS_DSL_DATASET_H
     28    789    ahrens 
     29    789    ahrens #include <sys/dmu.h>
     30    789    ahrens #include <sys/spa.h>
     31    789    ahrens #include <sys/txg.h>
     32   3547    maybee #include <sys/zio.h>
     33    789    ahrens #include <sys/bplist.h>
     34   2199    ahrens #include <sys/dsl_synctask.h>
     35    789    ahrens #include <sys/zfs_context.h>
     36    789    ahrens 
     37    789    ahrens #ifdef	__cplusplus
     38    789    ahrens extern "C" {
     39    789    ahrens #endif
     40    789    ahrens 
     41    789    ahrens struct dsl_dataset;
     42    789    ahrens struct dsl_dir;
     43    789    ahrens struct dsl_pool;
     44    789    ahrens 
     45   2082  eschrock #define	DS_FLAG_INCONSISTENT	(1ULL<<0)
     46   6689    maybee #define	DS_IS_INCONSISTENT(ds)	\
     47   6689    maybee 	((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
     48   2082  eschrock /*
     49   2082  eschrock  * NB: nopromote can not yet be set, but we want support for it in this
     50   2082  eschrock  * on-disk version, so that we don't need to upgrade for it later.  It
     51   2082  eschrock  * will be needed when we implement 'zfs split' (where the split off
     52   2082  eschrock  * clone should not be promoted).
     53   2082  eschrock  */
     54   2082  eschrock #define	DS_FLAG_NOPROMOTE	(1ULL<<1)
     55   5378  ck153898 
     56   5378  ck153898 /*
     57   5378  ck153898  * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
     58   5378  ck153898  * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
     59   5378  ck153898  * refquota/refreservations).
     60   5378  ck153898  */
     61   5378  ck153898 #define	DS_FLAG_UNIQUE_ACCURATE	(1ULL<<2)
     62   6492      timh 
     63   6492      timh /*
     64  10242     chris  * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
     65  10242     chris  * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
     66  10242     chris  */
     67  10242     chris #define	DS_FLAG_DEFER_DESTROY	(1ULL<<3)
     68  10242     chris #define	DS_IS_DEFER_DESTROY(ds)	\
     69  10242     chris 	((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)
     70  10242     chris 
     71  10242     chris /*
     72   6492      timh  * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
     73   6492      timh  * name lookups should be performed case-insensitively.
     74   6492      timh  */
     75   6492      timh #define	DS_FLAG_CI_DATASET	(1ULL<<16)
     76   2082  eschrock 
     77    789    ahrens typedef struct dsl_dataset_phys {
     78   7046    ahrens 	uint64_t ds_dir_obj;		/* DMU_OT_DSL_DIR */
     79   7046    ahrens 	uint64_t ds_prev_snap_obj;	/* DMU_OT_DSL_DATASET */
     80    789    ahrens 	uint64_t ds_prev_snap_txg;
     81   7046    ahrens 	uint64_t ds_next_snap_obj;	/* DMU_OT_DSL_DATASET */
     82   7046    ahrens 	uint64_t ds_snapnames_zapobj;	/* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
     83    789    ahrens 	uint64_t ds_num_children;	/* clone/snap children; ==0 for head */
     84    789    ahrens 	uint64_t ds_creation_time;	/* seconds since 1970 */
     85    789    ahrens 	uint64_t ds_creation_txg;
     86   7046    ahrens 	uint64_t ds_deadlist_obj;	/* DMU_OT_BPLIST */
     87    789    ahrens 	uint64_t ds_used_bytes;
     88    789    ahrens 	uint64_t ds_compressed_bytes;
     89    789    ahrens 	uint64_t ds_uncompressed_bytes;
     90   3517  mp204432 	uint64_t ds_unique_bytes;	/* only relevant to snapshots */
     91    789    ahrens 	/*
     92    789    ahrens 	 * The ds_fsid_guid is a 56-bit ID that can change to avoid
     93    789    ahrens 	 * collisions.  The ds_guid is a 64-bit ID that will never
     94    789    ahrens 	 * change, so there is a small probability that it will collide.
     95    789    ahrens 	 */
     96    789    ahrens 	uint64_t ds_fsid_guid;
     97    789    ahrens 	uint64_t ds_guid;
     98   7046    ahrens 	uint64_t ds_flags;		/* DS_FLAG_* */
     99    789    ahrens 	blkptr_t ds_bp;
    100   7265    ahrens 	uint64_t ds_next_clones_obj;	/* DMU_OT_DSL_CLONES */
    101   7265    ahrens 	uint64_t ds_props_obj;		/* DMU_OT_DSL_PROPS for snaps */
    102  10242     chris 	uint64_t ds_userrefs_obj;	/* DMU_OT_USERREFS */
    103  10242     chris 	uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
    104    789    ahrens } dsl_dataset_phys_t;
    105    789    ahrens 
    106    789    ahrens typedef struct dsl_dataset {
    107    789    ahrens 	/* Immutable: */
    108    789    ahrens 	struct dsl_dir *ds_dir;
    109    789    ahrens 	dsl_dataset_phys_t *ds_phys;
    110    789    ahrens 	dmu_buf_t *ds_dbuf;
    111    789    ahrens 	uint64_t ds_object;
    112   4787    ahrens 	uint64_t ds_fsid_guid;
    113    789    ahrens 
    114   7390   Matthew 	/* only used in syncing context, only valid for non-snapshots: */
    115   7390   Matthew 	struct dsl_dataset *ds_prev;
    116   7390   Matthew 	uint64_t ds_origin_txg;
    117    789    ahrens 
    118    789    ahrens 	/* has internal locking: */
    119    789    ahrens 	bplist_t ds_deadlist;
    120  10204   Matthew 
    121  10204   Matthew 	/* to protect against multiple concurrent incremental recv */
    122  10204   Matthew 	kmutex_t ds_recvlock;
    123    789    ahrens 
    124    789    ahrens 	/* protected by lock on pool's dp_dirty_datasets list */
    125    789    ahrens 	txg_node_t ds_dirty_link;
    126    789    ahrens 	list_node_t ds_synced_link;
    127    789    ahrens 
    128    789    ahrens 	/*
    129    789    ahrens 	 * ds_phys->ds_<accounting> is also protected by ds_lock.
    130    789    ahrens 	 * Protected by ds_lock:
    131    789    ahrens 	 */
    132    789    ahrens 	kmutex_t ds_lock;
    133  10298   Matthew 	objset_t *ds_objset;
    134  10242     chris 	uint64_t ds_userrefs;
    135   6689    maybee 
    136   6689    maybee 	/*
    137   6689    maybee 	 * ds_owner is protected by the ds_rwlock and the ds_lock
    138   6689    maybee 	 */
    139   6689    maybee 	krwlock_t ds_rwlock;
    140   6689    maybee 	kcondvar_t ds_exclusive_cv;
    141   6689    maybee 	void *ds_owner;
    142    789    ahrens 
    143   2199    ahrens 	/* no locking; only for making guesses */
    144   2199    ahrens 	uint64_t ds_trysnap_txg;
    145   4787    ahrens 
    146   4787    ahrens 	/* for objset_open() */
    147   4787    ahrens 	kmutex_t ds_opening_lock;
    148   2199    ahrens 
    149   5378  ck153898 	uint64_t ds_reserved;	/* cached refreservation */
    150   5378  ck153898 	uint64_t ds_quota;	/* cached refquota */
    151   5378  ck153898 
    152    789    ahrens 	/* Protected by ds_lock; keep at end of struct for better locality */
    153    789    ahrens 	char ds_snapname[MAXNAMELEN];
    154    789    ahrens } dsl_dataset_t;
    155  10242     chris 
    156  10242     chris struct dsl_ds_destroyarg {
    157  10242     chris 	dsl_dataset_t *ds;		/* ds to destroy */
    158  10242     chris 	dsl_dataset_t *rm_origin;	/* also remove our origin? */
    159  10242     chris 	boolean_t is_origin_rm;		/* set if removing origin snap */
    160  10242     chris 	boolean_t defer;		/* destroy -d requested? */
    161  10242     chris 	boolean_t releasing;		/* destroying due to release? */
    162  10242     chris 	boolean_t need_prep;		/* do we need to retry due to EBUSY? */
    163  10242     chris };
    164    789    ahrens 
    165    789    ahrens #define	dsl_dataset_is_snapshot(ds)	\
    166    789    ahrens 	((ds)->ds_phys->ds_num_children != 0)
    167   5378  ck153898 
    168   5378  ck153898 #define	DS_UNIQUE_IS_ACCURATE(ds)	\
    169   5378  ck153898 	(((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
    170    789    ahrens 
    171   6689    maybee int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp);
    172   6689    maybee int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,
    173   6689    maybee     void *tag, dsl_dataset_t **);
    174  10298   Matthew int dsl_dataset_own(const char *name, boolean_t inconsistentok,
    175  10298   Matthew     void *tag, dsl_dataset_t **dsp);
    176   6689    maybee int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
    177  10298   Matthew     boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp);
    178    789    ahrens void dsl_dataset_name(dsl_dataset_t *ds, char *name);
    179   6689    maybee void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
    180  10298   Matthew void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
    181   7046    ahrens void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);
    182   6689    maybee boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,
    183  10298   Matthew     void *tag);
    184  10298   Matthew void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag);
    185   6689    maybee uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
    186   6689    maybee     dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
    187   7046    ahrens uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
    188   7046    ahrens     uint64_t flags, dmu_tx_t *tx);
    189  10242     chris int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer);
    190  10242     chris int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);
    191   5367    ahrens dsl_checkfunc_t dsl_dataset_destroy_check;
    192   5367    ahrens dsl_syncfunc_t dsl_dataset_destroy_sync;
    193   2199    ahrens dsl_checkfunc_t dsl_dataset_snapshot_check;
    194   2199    ahrens dsl_syncfunc_t dsl_dataset_snapshot_sync;
    195   4007  mmusante int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);
    196  10588      Eric int dsl_dataset_promote(const char *name, char *conflsnap);
    197   5367    ahrens int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
    198   5367    ahrens     boolean_t force);
    199  10242     chris int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag,
    200  10342     chris     boolean_t recursive, boolean_t temphold);
    201  10242     chris int dsl_dataset_user_release(char *dsname, char *snapname, char *htag,
    202  10242     chris     boolean_t recursive);
    203  10342     chris int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj,
    204  10342     chris     char *htag);
    205  10242     chris int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp);
    206    789    ahrens 
    207   3547    maybee blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
    208    789    ahrens void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
    209    789    ahrens 
    210    789    ahrens spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
    211   5326  ek110237 
    212   5326  ek110237 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
    213    789    ahrens 
    214   3547    maybee void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
    215    789    ahrens 
    216  10922      Jeff void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
    217   3547    maybee     dmu_tx_t *tx);
    218  10922      Jeff int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
    219  10922      Jeff     dmu_tx_t *tx, boolean_t async);
    220   9653   Sanjeev boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth);
    221   1544  eschrock uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
    222    789    ahrens 
    223    789    ahrens void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
    224   2885    ahrens void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
    225   2885    ahrens void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
    226   2885    ahrens void dsl_dataset_space(dsl_dataset_t *ds,
    227   2885    ahrens     uint64_t *refdbytesp, uint64_t *availbytesp,
    228   2885    ahrens     uint64_t *usedobjsp, uint64_t *availobjsp);
    229   2885    ahrens uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
    230    789    ahrens 
    231   3912     lling int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
    232   3912     lling 
    233   5378  ck153898 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
    234   5831  ck153898     uint64_t asize, uint64_t inflight, uint64_t *used,
    235   5831  ck153898     uint64_t *ref_rsrv);
    236  11022       Tom int dsl_dataset_set_quota(const char *dsname, zprop_source_t source,
    237  11022       Tom     uint64_t quota);
    238   5378  ck153898 void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr,
    239   5378  ck153898     dmu_tx_t *tx);
    240  11022       Tom int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source,
    241  11022       Tom     uint64_t reservation);
    242   5378  ck153898 
    243  10298   Matthew int dsl_destroy_inconsistent(char *dsname, void *arg);
    244  10298   Matthew 
    245    789    ahrens #ifdef ZFS_DEBUG
    246    789    ahrens #define	dprintf_ds(ds, fmt, ...) do { \
    247    789    ahrens 	if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
    248    789    ahrens 	char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
    249    789    ahrens 	dsl_dataset_name(ds, __ds_name); \
    250    789    ahrens 	dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
    251    789    ahrens 	kmem_free(__ds_name, MAXNAMELEN); \
    252    789    ahrens 	} \
    253    789    ahrens _NOTE(CONSTCOND) } while (0)
    254    789    ahrens #else
    255    789    ahrens #define	dprintf_ds(dd, fmt, ...)
    256    789    ahrens #endif
    257    789    ahrens 
    258    789    ahrens #ifdef	__cplusplus
    259    789    ahrens }
    260    789    ahrens #endif
    261    789    ahrens 
    262    789    ahrens #endif /* _SYS_DSL_DATASET_H */
    263