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.
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.
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]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 #ifndef _SYS_DSL_DATASET_H
27 #define _SYS_DSL_DATASET_H
33 #include <sys/bplist.h>
34 #include <sys/dsl_synctask.h>
35 #include <sys/zfs_context.h>
45 typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *);
47 #define DS_FLAG_INCONSISTENT (1ULL<<0)
48 #define DS_IS_INCONSISTENT(ds) \
49 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
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).
56 #define DS_FLAG_NOPROMOTE (1ULL<<1)
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).
63 #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2)
66 * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called
67 * on a dataset. This allows the dataset to be destroyed using 'zfs release'.
69 #define DS_FLAG_DEFER_DESTROY (1ULL<<3)
70 #define DS_IS_DEFER_DESTROY(ds) \
71 ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY)
74 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose
75 * name lookups should be performed case-insensitively.
77 #define DS_FLAG_CI_DATASET (1ULL<<16)
79 typedef struct dsl_dataset_phys {
80 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */
81 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */
82 uint64_t ds_prev_snap_txg;
83 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */
84 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
85 uint64_t ds_num_children; /* clone/snap children; ==0 for head */
86 uint64_t ds_creation_time; /* seconds since 1970 */
87 uint64_t ds_creation_txg;
88 uint64_t ds_deadlist_obj; /* DMU_OT_BPLIST */
89 uint64_t ds_used_bytes;
90 uint64_t ds_compressed_bytes;
91 uint64_t ds_uncompressed_bytes;
92 uint64_t ds_unique_bytes; /* only relevant to snapshots */
94 * The ds_fsid_guid is a 56-bit ID that can change to avoid
95 * collisions. The ds_guid is a 64-bit ID that will never
96 * change, so there is a small probability that it will collide.
98 uint64_t ds_fsid_guid;
100 uint64_t ds_flags; /* DS_FLAG_* */
102 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */
103 uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */
104 uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */
105 uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */
106 } dsl_dataset_phys_t;
108 typedef struct dsl_dataset {
110 struct dsl_dir *ds_dir;
111 dsl_dataset_phys_t *ds_phys;
114 uint64_t ds_fsid_guid;
116 /* only used in syncing context, only valid for non-snapshots: */
117 struct dsl_dataset *ds_prev;
118 uint64_t ds_origin_txg;
120 /* has internal locking: */
121 bplist_t ds_deadlist;
123 /* to protect against multiple concurrent incremental recv */
124 kmutex_t ds_recvlock;
126 /* protected by lock on pool's dp_dirty_datasets list */
127 txg_node_t ds_dirty_link;
128 list_node_t ds_synced_link;
131 * ds_phys->ds_<accounting> is also protected by ds_lock.
132 * Protected by ds_lock:
136 dsl_dataset_evict_func_t *ds_user_evict_func;
137 uint64_t ds_userrefs;
140 * ds_owner is protected by the ds_rwlock and the ds_lock
143 kcondvar_t ds_exclusive_cv;
146 /* no locking; only for making guesses */
147 uint64_t ds_trysnap_txg;
149 /* for objset_open() */
150 kmutex_t ds_opening_lock;
152 uint64_t ds_reserved; /* cached refreservation */
153 uint64_t ds_quota; /* cached refquota */
155 /* Protected by ds_lock; keep at end of struct for better locality */
156 char ds_snapname[MAXNAMELEN];
159 struct dsl_ds_destroyarg {
160 dsl_dataset_t *ds; /* ds to destroy */
161 dsl_dataset_t *rm_origin; /* also remove our origin? */
162 boolean_t is_origin_rm; /* set if removing origin snap */
163 boolean_t defer; /* destroy -d requested? */
164 boolean_t releasing; /* destroying due to release? */
165 boolean_t need_prep; /* do we need to retry due to EBUSY? */
168 #define dsl_dataset_is_snapshot(ds) \
169 ((ds)->ds_phys->ds_num_children != 0)
171 #define DS_UNIQUE_IS_ACCURATE(ds) \
172 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
174 int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp);
175 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,
176 void *tag, dsl_dataset_t **);
177 int dsl_dataset_own(const char *name, int flags, void *owner,
178 dsl_dataset_t **dsp);
179 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
180 int flags, void *owner, dsl_dataset_t **);
181 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
182 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
183 void dsl_dataset_disown(dsl_dataset_t *ds, void *owner);
184 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);
185 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,
187 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *owner);
188 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
189 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
190 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
191 uint64_t flags, dmu_tx_t *tx);
192 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer);
193 int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);
194 dsl_checkfunc_t dsl_dataset_destroy_check;
195 dsl_syncfunc_t dsl_dataset_destroy_sync;
196 dsl_checkfunc_t dsl_dataset_snapshot_check;
197 dsl_syncfunc_t dsl_dataset_snapshot_sync;
198 int dsl_dataset_rollback(dsl_dataset_t *ds, dmu_objset_type_t ost);
199 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);
200 int dsl_dataset_promote(const char *name);
201 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
203 int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag,
204 boolean_t recursive);
205 int dsl_dataset_user_release(char *dsname, char *snapname, char *htag,
206 boolean_t recursive);
207 int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp);
209 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds,
210 void *p, dsl_dataset_evict_func_t func);
211 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds);
213 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
214 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
216 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
218 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
220 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
222 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
223 int dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio,
225 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth);
226 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
228 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
229 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
230 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
231 void dsl_dataset_space(dsl_dataset_t *ds,
232 uint64_t *refdbytesp, uint64_t *availbytesp,
233 uint64_t *usedobjsp, uint64_t *availobjsp);
234 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
236 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
238 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
239 uint64_t asize, uint64_t inflight, uint64_t *used,
241 int dsl_dataset_set_quota(const char *dsname, uint64_t quota);
242 void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr,
244 int dsl_dataset_set_reservation(const char *dsname, uint64_t reservation);
245 void dsl_dataset_set_flags(dsl_dataset_t *ds, uint64_t flags);
246 int64_t dsl_dataset_new_refreservation(dsl_dataset_t *ds, uint64_t reservation,
250 #define dprintf_ds(ds, fmt, ...) do { \
251 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
252 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
253 dsl_dataset_name(ds, __ds_name); \
254 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
255 kmem_free(__ds_name, MAXNAMELEN); \
257 _NOTE(CONSTCOND) } while (0)
259 #define dprintf_ds(dd, fmt, ...)
266 #endif /* _SYS_DSL_DATASET_H */