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