Home | History | Annotate | Download | only in sys
      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 2007 Sun Microsystems, Inc.  All rights reserved.
     23  * Use is subject to license terms.
     24  */
     25 
     26 #ifndef	_SYS_DSL_DATASET_H
     27 #define	_SYS_DSL_DATASET_H
     28 
     29 #pragma ident	"@(#)dsl_dataset.h	1.14	07/10/29 SMI"
     30 
     31 #include <sys/dmu.h>
     32 #include <sys/spa.h>
     33 #include <sys/txg.h>
     34 #include <sys/zio.h>
     35 #include <sys/bplist.h>
     36 #include <sys/dsl_synctask.h>
     37 #include <sys/zfs_context.h>
     38 
     39 #ifdef	__cplusplus
     40 extern "C" {
     41 #endif
     42 
     43 struct dsl_dataset;
     44 struct dsl_dir;
     45 struct dsl_pool;
     46 
     47 typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *);
     48 
     49 #define	DS_FLAG_INCONSISTENT	(1ULL<<0)
     50 /*
     51  * NB: nopromote can not yet be set, but we want support for it in this
     52  * on-disk version, so that we don't need to upgrade for it later.  It
     53  * will be needed when we implement 'zfs split' (where the split off
     54  * clone should not be promoted).
     55  */
     56 #define	DS_FLAG_NOPROMOTE	(1ULL<<1)
     57 
     58 /*
     59  * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly
     60  * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE,
     61  * refquota/refreservations).
     62  */
     63 #define	DS_FLAG_UNIQUE_ACCURATE	(1ULL<<2)
     64 
     65 typedef struct dsl_dataset_phys {
     66 	uint64_t ds_dir_obj;
     67 	uint64_t ds_prev_snap_obj;
     68 	uint64_t ds_prev_snap_txg;
     69 	uint64_t ds_next_snap_obj;
     70 	uint64_t ds_snapnames_zapobj;	/* zap obj of snaps; ==0 for snaps */
     71 	uint64_t ds_num_children;	/* clone/snap children; ==0 for head */
     72 	uint64_t ds_creation_time;	/* seconds since 1970 */
     73 	uint64_t ds_creation_txg;
     74 	uint64_t ds_deadlist_obj;
     75 	uint64_t ds_used_bytes;
     76 	uint64_t ds_compressed_bytes;
     77 	uint64_t ds_uncompressed_bytes;
     78 	uint64_t ds_unique_bytes;	/* only relevant to snapshots */
     79 	/*
     80 	 * The ds_fsid_guid is a 56-bit ID that can change to avoid
     81 	 * collisions.  The ds_guid is a 64-bit ID that will never
     82 	 * change, so there is a small probability that it will collide.
     83 	 */
     84 	uint64_t ds_fsid_guid;
     85 	uint64_t ds_guid;
     86 	uint64_t ds_flags;
     87 	blkptr_t ds_bp;
     88 	uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */
     89 } dsl_dataset_phys_t;
     90 
     91 typedef struct dsl_dataset {
     92 	/* Immutable: */
     93 	struct dsl_dir *ds_dir;
     94 	dsl_dataset_phys_t *ds_phys;
     95 	dmu_buf_t *ds_dbuf;
     96 	uint64_t ds_object;
     97 	uint64_t ds_fsid_guid;
     98 
     99 	/* only used in syncing context: */
    100 	struct dsl_dataset *ds_prev; /* only valid for non-snapshots */
    101 
    102 	/* has internal locking: */
    103 	bplist_t ds_deadlist;
    104 
    105 	/* protected by lock on pool's dp_dirty_datasets list */
    106 	txg_node_t ds_dirty_link;
    107 	list_node_t ds_synced_link;
    108 
    109 	/*
    110 	 * ds_phys->ds_<accounting> is also protected by ds_lock.
    111 	 * Protected by ds_lock:
    112 	 */
    113 	kmutex_t ds_lock;
    114 	void *ds_user_ptr;
    115 	dsl_dataset_evict_func_t *ds_user_evict_func;
    116 	uint64_t ds_open_refcount;
    117 
    118 	/* no locking; only for making guesses */
    119 	uint64_t ds_trysnap_txg;
    120 
    121 	/* for objset_open() */
    122 	kmutex_t ds_opening_lock;
    123 
    124 	uint64_t ds_reserved;	/* cached refreservation */
    125 	uint64_t ds_quota;	/* cached refquota */
    126 
    127 	/* Protected by ds_lock; keep at end of struct for better locality */
    128 	char ds_snapname[MAXNAMELEN];
    129 } dsl_dataset_t;
    130 
    131 #define	dsl_dataset_is_snapshot(ds)	\
    132 	((ds)->ds_phys->ds_num_children != 0)
    133 
    134 #define	DS_UNIQUE_IS_ACCURATE(ds)	\
    135 	(((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
    136 
    137 int dsl_dataset_open_spa(spa_t *spa, const char *name, int mode,
    138     void *tag, dsl_dataset_t **dsp);
    139 int dsl_dataset_open(const char *name, int mode, void *tag,
    140     dsl_dataset_t **dsp);
    141 int dsl_dataset_open_obj(struct dsl_pool *dp, uint64_t dsobj,
    142     const char *tail, int mode, void *tag, dsl_dataset_t **);
    143 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
    144 void dsl_dataset_close(dsl_dataset_t *ds, int mode, void *tag);
    145 void dsl_dataset_downgrade(dsl_dataset_t *ds, int oldmode, int newmode);
    146 boolean_t dsl_dataset_tryupgrade(dsl_dataset_t *ds, int oldmode, int newmode);
    147 uint64_t dsl_dataset_create_sync_impl(dsl_dir_t *dd, dsl_dataset_t *origin,
    148     dmu_tx_t *tx);
    149 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds,
    150     const char *lastname, dsl_dataset_t *origin, cred_t *, dmu_tx_t *);
    151 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag);
    152 int dsl_snapshots_destroy(char *fsname, char *snapname);
    153 dsl_checkfunc_t dsl_dataset_destroy_check;
    154 dsl_syncfunc_t dsl_dataset_destroy_sync;
    155 dsl_checkfunc_t dsl_dataset_snapshot_check;
    156 dsl_syncfunc_t dsl_dataset_snapshot_sync;
    157 int dsl_dataset_rollback(dsl_dataset_t *ds, dmu_objset_type_t ost);
    158 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);
    159 int dsl_dataset_promote(const char *name);
    160 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
    161     boolean_t force);
    162 
    163 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds,
    164     void *p, dsl_dataset_evict_func_t func);
    165 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds);
    166 
    167 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
    168 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
    169 
    170 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
    171 
    172 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
    173 
    174 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
    175 
    176 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
    177 void dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio,
    178     dmu_tx_t *tx);
    179 int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth);
    180 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
    181 
    182 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
    183 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
    184 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
    185 void dsl_dataset_space(dsl_dataset_t *ds,
    186     uint64_t *refdbytesp, uint64_t *availbytesp,
    187     uint64_t *usedobjsp, uint64_t *availobjsp);
    188 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
    189 
    190 void dsl_dataset_create_root(struct dsl_pool *dp, uint64_t *ddobjp,
    191     dmu_tx_t *tx);
    192 
    193 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
    194 
    195 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
    196     uint64_t asize, uint64_t inflight, uint64_t *used);
    197 int dsl_dataset_set_quota(const char *dsname, uint64_t quota);
    198 void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr,
    199     dmu_tx_t *tx);
    200 int dsl_dataset_set_reservation(const char *dsname, uint64_t reservation);
    201 
    202 #ifdef ZFS_DEBUG
    203 #define	dprintf_ds(ds, fmt, ...) do { \
    204 	if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
    205 	char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
    206 	dsl_dataset_name(ds, __ds_name); \
    207 	dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
    208 	kmem_free(__ds_name, MAXNAMELEN); \
    209 	} \
    210 _NOTE(CONSTCOND) } while (0)
    211 #else
    212 #define	dprintf_ds(dd, fmt, ...)
    213 #endif
    214 
    215 #ifdef	__cplusplus
    216 }
    217 #endif
    218 
    219 #endif /* _SYS_DSL_DATASET_H */
    220