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