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