]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
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 | /* | |
428870ff | 22 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
330d06f9 | 23 | * Copyright (c) 2011 by Delphix. All rights reserved. |
34dc7c2f BB |
24 | */ |
25 | ||
26 | #ifndef _SYS_DSL_DATASET_H | |
27 | #define _SYS_DSL_DATASET_H | |
28 | ||
34dc7c2f BB |
29 | #include <sys/dmu.h> |
30 | #include <sys/spa.h> | |
31 | #include <sys/txg.h> | |
32 | #include <sys/zio.h> | |
33 | #include <sys/bplist.h> | |
34 | #include <sys/dsl_synctask.h> | |
35 | #include <sys/zfs_context.h> | |
428870ff | 36 | #include <sys/dsl_deadlist.h> |
34dc7c2f BB |
37 | |
38 | #ifdef __cplusplus | |
39 | extern "C" { | |
40 | #endif | |
41 | ||
42 | struct dsl_dataset; | |
43 | struct dsl_dir; | |
44 | struct dsl_pool; | |
45 | ||
34dc7c2f | 46 | #define DS_FLAG_INCONSISTENT (1ULL<<0) |
b128c09f BB |
47 | #define DS_IS_INCONSISTENT(ds) \ |
48 | ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT) | |
34dc7c2f BB |
49 | /* |
50 | * NB: nopromote can not yet be set, but we want support for it in this | |
51 | * on-disk version, so that we don't need to upgrade for it later. It | |
52 | * will be needed when we implement 'zfs split' (where the split off | |
53 | * clone should not be promoted). | |
54 | */ | |
55 | #define DS_FLAG_NOPROMOTE (1ULL<<1) | |
56 | ||
57 | /* | |
58 | * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly | |
59 | * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE, | |
60 | * refquota/refreservations). | |
61 | */ | |
62 | #define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2) | |
63 | ||
45d1cae3 BB |
64 | /* |
65 | * DS_FLAG_DEFER_DESTROY is set after 'zfs destroy -d' has been called | |
66 | * on a dataset. This allows the dataset to be destroyed using 'zfs release'. | |
67 | */ | |
68 | #define DS_FLAG_DEFER_DESTROY (1ULL<<3) | |
69 | #define DS_IS_DEFER_DESTROY(ds) \ | |
70 | ((ds)->ds_phys->ds_flags & DS_FLAG_DEFER_DESTROY) | |
71 | ||
34dc7c2f BB |
72 | /* |
73 | * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose | |
74 | * name lookups should be performed case-insensitively. | |
75 | */ | |
76 | #define DS_FLAG_CI_DATASET (1ULL<<16) | |
77 | ||
78 | typedef struct dsl_dataset_phys { | |
b128c09f BB |
79 | uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */ |
80 | uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */ | |
34dc7c2f | 81 | uint64_t ds_prev_snap_txg; |
b128c09f BB |
82 | uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */ |
83 | uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */ | |
34dc7c2f BB |
84 | uint64_t ds_num_children; /* clone/snap children; ==0 for head */ |
85 | uint64_t ds_creation_time; /* seconds since 1970 */ | |
86 | uint64_t ds_creation_txg; | |
428870ff | 87 | uint64_t ds_deadlist_obj; /* DMU_OT_DEADLIST */ |
34dc7c2f BB |
88 | uint64_t ds_used_bytes; |
89 | uint64_t ds_compressed_bytes; | |
90 | uint64_t ds_uncompressed_bytes; | |
91 | uint64_t ds_unique_bytes; /* only relevant to snapshots */ | |
92 | /* | |
93 | * The ds_fsid_guid is a 56-bit ID that can change to avoid | |
94 | * collisions. The ds_guid is a 64-bit ID that will never | |
95 | * change, so there is a small probability that it will collide. | |
96 | */ | |
97 | uint64_t ds_fsid_guid; | |
98 | uint64_t ds_guid; | |
b128c09f | 99 | uint64_t ds_flags; /* DS_FLAG_* */ |
34dc7c2f | 100 | blkptr_t ds_bp; |
b128c09f BB |
101 | uint64_t ds_next_clones_obj; /* DMU_OT_DSL_CLONES */ |
102 | uint64_t ds_props_obj; /* DMU_OT_DSL_PROPS for snaps */ | |
45d1cae3 BB |
103 | uint64_t ds_userrefs_obj; /* DMU_OT_USERREFS */ |
104 | uint64_t ds_pad[5]; /* pad out to 320 bytes for good measure */ | |
34dc7c2f BB |
105 | } dsl_dataset_phys_t; |
106 | ||
107 | typedef struct dsl_dataset { | |
108 | /* Immutable: */ | |
109 | struct dsl_dir *ds_dir; | |
110 | dsl_dataset_phys_t *ds_phys; | |
111 | dmu_buf_t *ds_dbuf; | |
112 | uint64_t ds_object; | |
113 | uint64_t ds_fsid_guid; | |
114 | ||
b128c09f BB |
115 | /* only used in syncing context, only valid for non-snapshots: */ |
116 | struct dsl_dataset *ds_prev; | |
34dc7c2f BB |
117 | |
118 | /* has internal locking: */ | |
428870ff BB |
119 | dsl_deadlist_t ds_deadlist; |
120 | bplist_t ds_pending_deadlist; | |
34dc7c2f | 121 | |
45d1cae3 BB |
122 | /* to protect against multiple concurrent incremental recv */ |
123 | kmutex_t ds_recvlock; | |
124 | ||
34dc7c2f BB |
125 | /* protected by lock on pool's dp_dirty_datasets list */ |
126 | txg_node_t ds_dirty_link; | |
127 | list_node_t ds_synced_link; | |
128 | ||
129 | /* | |
130 | * ds_phys->ds_<accounting> is also protected by ds_lock. | |
131 | * Protected by ds_lock: | |
132 | */ | |
133 | kmutex_t ds_lock; | |
428870ff | 134 | objset_t *ds_objset; |
45d1cae3 | 135 | uint64_t ds_userrefs; |
b128c09f BB |
136 | |
137 | /* | |
138 | * ds_owner is protected by the ds_rwlock and the ds_lock | |
139 | */ | |
140 | krwlock_t ds_rwlock; | |
141 | kcondvar_t ds_exclusive_cv; | |
142 | void *ds_owner; | |
34dc7c2f BB |
143 | |
144 | /* no locking; only for making guesses */ | |
145 | uint64_t ds_trysnap_txg; | |
146 | ||
147 | /* for objset_open() */ | |
148 | kmutex_t ds_opening_lock; | |
149 | ||
150 | uint64_t ds_reserved; /* cached refreservation */ | |
151 | uint64_t ds_quota; /* cached refquota */ | |
152 | ||
153 | /* Protected by ds_lock; keep at end of struct for better locality */ | |
154 | char ds_snapname[MAXNAMELEN]; | |
155 | } dsl_dataset_t; | |
156 | ||
45d1cae3 BB |
157 | struct dsl_ds_destroyarg { |
158 | dsl_dataset_t *ds; /* ds to destroy */ | |
159 | dsl_dataset_t *rm_origin; /* also remove our origin? */ | |
160 | boolean_t is_origin_rm; /* set if removing origin snap */ | |
161 | boolean_t defer; /* destroy -d requested? */ | |
162 | boolean_t releasing; /* destroying due to release? */ | |
163 | boolean_t need_prep; /* do we need to retry due to EBUSY? */ | |
164 | }; | |
165 | ||
572e2857 BB |
166 | /* |
167 | * The max length of a temporary tag prefix is the number of hex digits | |
168 | * required to express UINT64_MAX plus one for the hyphen. | |
169 | */ | |
170 | #define MAX_TAG_PREFIX_LEN 17 | |
171 | ||
172 | struct dsl_ds_holdarg { | |
173 | dsl_sync_task_group_t *dstg; | |
174 | char *htag; | |
175 | char *snapname; | |
176 | boolean_t recursive; | |
177 | boolean_t gotone; | |
178 | boolean_t temphold; | |
179 | char failed[MAXPATHLEN]; | |
180 | }; | |
181 | ||
428870ff | 182 | #define dsl_dataset_is_snapshot(ds) \ |
34dc7c2f BB |
183 | ((ds)->ds_phys->ds_num_children != 0) |
184 | ||
185 | #define DS_UNIQUE_IS_ACCURATE(ds) \ | |
186 | (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) | |
187 | ||
b128c09f BB |
188 | int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp); |
189 | int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, | |
190 | void *tag, dsl_dataset_t **); | |
428870ff BB |
191 | int dsl_dataset_own(const char *name, boolean_t inconsistentok, |
192 | void *tag, dsl_dataset_t **dsp); | |
b128c09f | 193 | int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, |
428870ff | 194 | boolean_t inconsistentok, void *tag, dsl_dataset_t **dsp); |
34dc7c2f | 195 | void dsl_dataset_name(dsl_dataset_t *ds, char *name); |
b128c09f | 196 | void dsl_dataset_rele(dsl_dataset_t *ds, void *tag); |
428870ff | 197 | void dsl_dataset_disown(dsl_dataset_t *ds, void *tag); |
b128c09f BB |
198 | void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag); |
199 | boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok, | |
428870ff BB |
200 | void *tag); |
201 | void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *tag); | |
572e2857 BB |
202 | void dsl_register_onexit_hold_cleanup(dsl_dataset_t *ds, const char *htag, |
203 | minor_t minor); | |
b128c09f BB |
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, | |
34dc7c2f | 207 | uint64_t flags, dmu_tx_t *tx); |
45d1cae3 BB |
208 | int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag, boolean_t defer); |
209 | int dsl_snapshots_destroy(char *fsname, char *snapname, boolean_t defer); | |
34dc7c2f BB |
210 | dsl_checkfunc_t dsl_dataset_destroy_check; |
211 | dsl_syncfunc_t dsl_dataset_destroy_sync; | |
212 | dsl_checkfunc_t dsl_dataset_snapshot_check; | |
213 | dsl_syncfunc_t dsl_dataset_snapshot_sync; | |
572e2857 | 214 | dsl_syncfunc_t dsl_dataset_user_hold_sync; |
34dc7c2f | 215 | int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); |
428870ff | 216 | int dsl_dataset_promote(const char *name, char *conflsnap); |
34dc7c2f BB |
217 | int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, |
218 | boolean_t force); | |
45d1cae3 | 219 | int dsl_dataset_user_hold(char *dsname, char *snapname, char *htag, |
572e2857 BB |
220 | boolean_t recursive, boolean_t temphold, int cleanup_fd); |
221 | int dsl_dataset_user_hold_for_send(dsl_dataset_t *ds, char *htag, | |
222 | boolean_t temphold); | |
45d1cae3 BB |
223 | int dsl_dataset_user_release(char *dsname, char *snapname, char *htag, |
224 | boolean_t recursive); | |
428870ff | 225 | int dsl_dataset_user_release_tmp(struct dsl_pool *dp, uint64_t dsobj, |
572e2857 | 226 | char *htag, boolean_t retry); |
45d1cae3 | 227 | int dsl_dataset_get_holds(const char *dsname, nvlist_t **nvp); |
34dc7c2f | 228 | |
34dc7c2f BB |
229 | blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); |
230 | void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); | |
231 | ||
232 | spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); | |
233 | ||
234 | boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds); | |
235 | ||
236 | void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); | |
237 | ||
428870ff | 238 | void dsl_dataset_block_born(dsl_dataset_t *ds, const blkptr_t *bp, |
34dc7c2f | 239 | dmu_tx_t *tx); |
428870ff BB |
240 | int dsl_dataset_block_kill(dsl_dataset_t *ds, const blkptr_t *bp, |
241 | dmu_tx_t *tx, boolean_t async); | |
242 | boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, const blkptr_t *bp, | |
243 | uint64_t blk_birth); | |
34dc7c2f BB |
244 | uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); |
245 | ||
246 | void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); | |
247 | void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); | |
248 | void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); | |
249 | void dsl_dataset_space(dsl_dataset_t *ds, | |
250 | uint64_t *refdbytesp, uint64_t *availbytesp, | |
251 | uint64_t *usedobjsp, uint64_t *availobjsp); | |
252 | uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); | |
330d06f9 MA |
253 | int dsl_dataset_space_written(dsl_dataset_t *oldsnap, dsl_dataset_t *new, |
254 | uint64_t *usedp, uint64_t *compp, uint64_t *uncompp); | |
255 | int dsl_dataset_space_wouldfree(dsl_dataset_t *firstsnap, dsl_dataset_t *last, | |
256 | uint64_t *usedp, uint64_t *compp, uint64_t *uncompp); | |
34dc7c2f | 257 | |
34dc7c2f BB |
258 | int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); |
259 | ||
260 | int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, | |
261 | uint64_t asize, uint64_t inflight, uint64_t *used, | |
262 | uint64_t *ref_rsrv); | |
428870ff BB |
263 | int dsl_dataset_set_quota(const char *dsname, zprop_source_t source, |
264 | uint64_t quota); | |
265 | dsl_syncfunc_t dsl_dataset_set_quota_sync; | |
266 | int dsl_dataset_set_reservation(const char *dsname, zprop_source_t source, | |
267 | uint64_t reservation); | |
268 | ||
269 | int dsl_destroy_inconsistent(const char *dsname, void *arg); | |
34dc7c2f BB |
270 | |
271 | #ifdef ZFS_DEBUG | |
272 | #define dprintf_ds(ds, fmt, ...) do { \ | |
273 | if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ | |
b8d06fca | 274 | char *__ds_name = kmem_alloc(MAXNAMELEN, KM_PUSHPAGE); \ |
34dc7c2f BB |
275 | dsl_dataset_name(ds, __ds_name); \ |
276 | dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ | |
277 | kmem_free(__ds_name, MAXNAMELEN); \ | |
278 | } \ | |
279 | _NOTE(CONSTCOND) } while (0) | |
280 | #else | |
281 | #define dprintf_ds(dd, fmt, ...) | |
282 | #endif | |
283 | ||
284 | #ifdef __cplusplus | |
285 | } | |
286 | #endif | |
287 | ||
288 | #endif /* _SYS_DSL_DATASET_H */ |