initial commit
[freebsd-arm:freebsd-arm.git] / cddl / contrib / opensolaris / uts / common / fs / zfs / sys / dsl_dataset.h
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25
26 #ifndef _SYS_DSL_DATASET_H
27 #define _SYS_DSL_DATASET_H
28
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>
36
37 #ifdef  __cplusplus
38 extern "C" {
39 #endif
40
41 struct dsl_dataset;
42 struct dsl_dir;
43 struct dsl_pool;
44
45 typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *);
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_CI_DATASET is set if the dataset contains a file system whose
67  * name lookups should be performed case-insensitively.
68  */
69 #define DS_FLAG_CI_DATASET      (1ULL<<16)
70
71 typedef struct dsl_dataset_phys {
72         uint64_t ds_dir_obj;            /* DMU_OT_DSL_DIR */
73         uint64_t ds_prev_snap_obj;      /* DMU_OT_DSL_DATASET */
74         uint64_t ds_prev_snap_txg;
75         uint64_t ds_next_snap_obj;      /* DMU_OT_DSL_DATASET */
76         uint64_t ds_snapnames_zapobj;   /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */
77         uint64_t ds_num_children;       /* clone/snap children; ==0 for head */
78         uint64_t ds_creation_time;      /* seconds since 1970 */
79         uint64_t ds_creation_txg;
80         uint64_t ds_deadlist_obj;       /* DMU_OT_BPLIST */
81         uint64_t ds_used_bytes;
82         uint64_t ds_compressed_bytes;
83         uint64_t ds_uncompressed_bytes;
84         uint64_t ds_unique_bytes;       /* only relevant to snapshots */
85         /*
86          * The ds_fsid_guid is a 56-bit ID that can change to avoid
87          * collisions.  The ds_guid is a 64-bit ID that will never
88          * change, so there is a small probability that it will collide.
89          */
90         uint64_t ds_fsid_guid;
91         uint64_t ds_guid;
92         uint64_t ds_flags;              /* DS_FLAG_* */
93         blkptr_t ds_bp;
94         uint64_t ds_next_clones_obj;    /* DMU_OT_DSL_CLONES */
95         uint64_t ds_props_obj;          /* DMU_OT_DSL_PROPS for snaps */
96         uint64_t ds_pad[6]; /* pad out to 320 bytes for good measure */
97 } dsl_dataset_phys_t;
98
99 typedef struct dsl_dataset {
100         /* Immutable: */
101         struct dsl_dir *ds_dir;
102         dsl_dataset_phys_t *ds_phys;
103         dmu_buf_t *ds_dbuf;
104         uint64_t ds_object;
105         uint64_t ds_fsid_guid;
106
107         /* only used in syncing context, only valid for non-snapshots: */
108         struct dsl_dataset *ds_prev;
109         uint64_t ds_origin_txg;
110
111         /* has internal locking: */
112         bplist_t ds_deadlist;
113
114         /* protected by lock on pool's dp_dirty_datasets list */
115         txg_node_t ds_dirty_link;
116         list_node_t ds_synced_link;
117
118         /*
119          * ds_phys->ds_<accounting> is also protected by ds_lock.
120          * Protected by ds_lock:
121          */
122         kmutex_t ds_lock;
123         void *ds_user_ptr;
124         dsl_dataset_evict_func_t *ds_user_evict_func;
125
126         /*
127          * ds_owner is protected by the ds_rwlock and the ds_lock
128          */
129         krwlock_t ds_rwlock;
130         kcondvar_t ds_exclusive_cv;
131         void *ds_owner;
132
133         /* no locking; only for making guesses */
134         uint64_t ds_trysnap_txg;
135
136         /* for objset_open() */
137         kmutex_t ds_opening_lock;
138
139         uint64_t ds_reserved;   /* cached refreservation */
140         uint64_t ds_quota;      /* cached refquota */
141
142         /* Protected by ds_lock; keep at end of struct for better locality */
143         char ds_snapname[MAXNAMELEN];
144 } dsl_dataset_t;
145
146 #define dsl_dataset_is_snapshot(ds)     \
147         ((ds)->ds_phys->ds_num_children != 0)
148
149 #define DS_UNIQUE_IS_ACCURATE(ds)       \
150         (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0)
151
152 int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp);
153 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj,
154     void *tag, dsl_dataset_t **);
155 int dsl_dataset_own(const char *name, int flags, void *owner,
156     dsl_dataset_t **dsp);
157 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj,
158     int flags, void *owner, dsl_dataset_t **);
159 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
160 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag);
161 void dsl_dataset_disown(dsl_dataset_t *ds, void *owner);
162 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag);
163 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok,
164     void *owner);
165 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *owner);
166 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname,
167     dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *);
168 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin,
169     uint64_t flags, dmu_tx_t *tx);
170 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag);
171 int dsl_snapshots_destroy(char *fsname, char *snapname);
172 dsl_checkfunc_t dsl_dataset_destroy_check;
173 dsl_syncfunc_t dsl_dataset_destroy_sync;
174 dsl_checkfunc_t dsl_dataset_snapshot_check;
175 dsl_syncfunc_t dsl_dataset_snapshot_sync;
176 int dsl_dataset_rollback(dsl_dataset_t *ds, dmu_objset_type_t ost);
177 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);
178 int dsl_dataset_promote(const char *name);
179 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head,
180     boolean_t force);
181
182 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds,
183     void *p, dsl_dataset_evict_func_t func);
184 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds);
185
186 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
187 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
188
189 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
190
191 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds);
192
193 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
194
195 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
196 int dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio,
197     dmu_tx_t *tx);
198 int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth);
199 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
200
201 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
202 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
203 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
204 void dsl_dataset_space(dsl_dataset_t *ds,
205     uint64_t *refdbytesp, uint64_t *availbytesp,
206     uint64_t *usedobjsp, uint64_t *availobjsp);
207 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
208
209 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
210
211 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota,
212     uint64_t asize, uint64_t inflight, uint64_t *used,
213     uint64_t *ref_rsrv);
214 int dsl_dataset_set_quota(const char *dsname, uint64_t quota);
215 void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr,
216     dmu_tx_t *tx);
217 int dsl_dataset_set_reservation(const char *dsname, uint64_t reservation);
218 void dsl_dataset_set_flags(dsl_dataset_t *ds, uint64_t flags);
219 int64_t dsl_dataset_new_refreservation(dsl_dataset_t *ds, uint64_t reservation,
220     dmu_tx_t *tx);
221
222 #ifdef ZFS_DEBUG
223 #define dprintf_ds(ds, fmt, ...) do { \
224         if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
225         char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
226         dsl_dataset_name(ds, __ds_name); \
227         dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
228         kmem_free(__ds_name, MAXNAMELEN); \
229         } \
230 _NOTE(CONSTCOND) } while (0)
231 #else
232 #define dprintf_ds(dd, fmt, ...)
233 #endif
234
235 #ifdef  __cplusplus
236 }
237 #endif
238
239 #endif /* _SYS_DSL_DATASET_H */