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) 2011 by Delphix. All rights reserved.
24 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
25 */
26
27 #ifndef _SYS_DSL_DATASET_H
28 #define _SYS_DSL_DATASET_H
29
30 #include <sys/dmu.h>
31 #include <sys/spa.h>
32 #include <sys/txg.h>
33 #include <sys/zio.h>
34 #include <sys/bplist.h>
35 #include <sys/dsl_synctask.h>
36 #include <sys/zfs_context.h>
37 #include <sys/dsl_deadlist.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 #define DS_FLAG_INCONSISTENT (1ULL<<0)
48 #define DS_IS_INCONSISTENT(ds) \
49 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT)
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 /*
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_FLAG_CI_DATASET is set if the dataset contains a file system whose
75 * name lookups should be performed case-insensitively.
76 */
77 #define DS_FLAG_CI_DATASET (1ULL<<16)
78
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_DEADLIST */
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 */
93 /*
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.
97 */
98 uint64_t ds_fsid_guid;
99 uint64_t ds_guid;
100 uint64_t ds_flags; /* DS_FLAG_* */
101 blkptr_t ds_bp;
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;
107
108 typedef struct dsl_dataset {
109 /* Immutable: */
110 struct dsl_dir *ds_dir;
111 dsl_dataset_phys_t *ds_phys;
112 dmu_buf_t *ds_dbuf;
113 uint64_t ds_object;
114 uint64_t ds_fsid_guid;
115
116 /* only used in syncing context, only valid for non-snapshots: */
117 struct dsl_dataset *ds_prev;
118
119 /* has internal locking: */
120 dsl_deadlist_t ds_deadlist;
121 bplist_t ds_pending_deadlist;
122
123 /* to protect against multiple concurrent incremental recv */
124 kmutex_t ds_recvlock;
125
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;
129
130 /*
131 * ds_phys->ds_<accounting> is also protected by ds_lock.
132 * Protected by ds_lock:
133 */
134 kmutex_t ds_lock;
135 objset_t *ds_objset;
136 uint64_t ds_userrefs;
137
138 /*
139 * ds_owner is protected by the ds_rwlock and the ds_lock
140 */
141 krwlock_t ds_rwlock;
142 kcondvar_t ds_exclusive_cv;
143 void *ds_owner;
144
145 /* no locking; only for making guesses */
146 uint64_t ds_trysnap_txg;
147
148 /* for objset_open() */
149 kmutex_t ds_opening_lock;
150
151 uint64_t ds_reserved; /* cached refreservation */
152 uint64_t ds_quota; /* cached refquota */
153
154 kmutex_t ds_sendstream_lock;
155 list_t ds_sendstreams;
156
157 /* Protected by ds_lock; keep at end of struct for better locality */
158 char ds_snapname[MAXNAMELEN];
159 } dsl_dataset_t;
160
161 struct dsl_ds_destroyarg {
162 dsl_dataset_t *ds; /* ds to destroy */
163 dsl_dataset_t *rm_origin; /* also remove our origin? */
164 boolean_t is_origin_rm; /* set if removing origin snap */
165 boolean_t defer; /* destroy -d requested? */
166 boolean_t releasing; /* destroying due to release? */
167 boolean_t need_prep; /* do we need to retry due to EBUSY? */
168 };
169
170 /*
171 * The max length of a temporary tag prefix is the number of hex digits
172 * required to express UINT64_MAX plus one for the hyphen.
173 */
174 #define MAX_TAG_PREFIX_LEN 17
175
176 struct dsl_ds_holdarg {
177 dsl_sync_task_group_t *dstg;
178 char *htag;
179 char *snapname;
180 boolean_t recursive;
181 boolean_t gotone;
182 boolean_t temphold;
183 char failed[MAXPATHLEN];
184 };
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(const char *name, void *tag, dsl_dataset_t **dsp);
193 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,
194 void *tag, dsl_dataset_t **);
195 int dsl_dataset_own(const char *name, boolean_t inconsistentok,
196 void *tag, dsl_dataset_t **dsp);
197 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
198 boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp);
199 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
200 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
201 void dsl_dataset_disown(dsl_dataset_t *ds, void *tag);
202 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);
203 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,
204 void *tag);
205 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag);
206 void dsl_register_onexit_hold_cleanup(dsl_dataset_t *ds, const char *htag,
207 minor_t minor);
208 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
209 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
210 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
211 uint64_t flags, dmu_tx_t *tx);
212 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer);
213 int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);
214 dsl_checkfunc_t dsl_dataset_destroy_check;
215 dsl_syncfunc_t dsl_dataset_destroy_sync;
216 dsl_checkfunc_t dsl_dataset_snapshot_check;
217 dsl_syncfunc_t dsl_dataset_snapshot_sync;
218 dsl_syncfunc_t dsl_dataset_user_hold_sync;
219 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);
220 int dsl_dataset_promote(const char *name, char *conflsnap);
221 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
222 boolean_t force);
223 int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag,
224 boolean_t recursive, boolean_t temphold, int cleanup_fd);
225 int dsl_dataset_user_hold_for_send(dsl_dataset_t *ds, char *htag,
226 boolean_t temphold);
227 int dsl_dataset_user_release(char *dsname, char *snapname, char *htag,
228 boolean_t recursive);
229 int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj,
230 char *htag, boolean_t retry);
231 int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp);
232
233 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
234 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
235
236 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
237
238 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
239
240 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
241
242 void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp,
243 dmu_tx_t *tx);
244 int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp,
245 dmu_tx_t *tx, boolean_t async);
246 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp,
247 uint64_t blk_birth);
248 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
249
250 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
251 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
252 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
253 void dsl_dataset_space(dsl_dataset_t *ds,
254 uint64_t *refdbytesp, uint64_t *availbytesp,
255 uint64_t *usedobjsp, uint64_t *availobjsp);
256 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
257 int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new,
258 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
259 int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last,
260 uint64_t *usedp, uint64_t *compp, uint64_t *uncompp);
261
262 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
263
264 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
265 uint64_t asize, uint64_t inflight, uint64_t *used,
266 uint64_t *ref_rsrv);
267 int dsl_dataset_set_quota(const char *dsname, zprop_source_t source,
268 uint64_t quota);
269 dsl_syncfunc_t dsl_dataset_set_quota_sync;
270 int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source,
271 uint64_t reservation);
272
273 int dsl_destroy_inconsistent(const char *dsname, void *arg);
274
275 #ifdef ZFS_DEBUG
276 #define dprintf_ds(ds, fmt, ...) do { \
277 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
278 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
279 dsl_dataset_name(ds, __ds_name); \
280 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
281 kmem_free(__ds_name, MAXNAMELEN); \
282 } \
283 _NOTE(CONSTCOND) } while (0)
284 #else
285 #define dprintf_ds(dd, fmt, ...)
286 #endif
287
288 #ifdef __cplusplus
289 }
290 #endif
291
292 #endif /* _SYS_DSL_DATASET_H */