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