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.
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.
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]
22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 #ifndef _SYS_DSL_DATASET_H
27 #define _SYS_DSL_DATASET_H
29 #pragma ident "%Z%%M% %I% %E% SMI"
35 #include <sys/bplist.h>
36 #include <sys/dsl_synctask.h>
37 #include <sys/zfs_context.h>
47 typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *);
49 #define DS_FLAG_INCONSISTENT (1ULL<<0)
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).
56 #define DS_FLAG_NOPROMOTE (1ULL<<1)
58 typedef struct dsl_dataset_phys {
60 uint64_t ds_prev_snap_obj;
61 uint64_t ds_prev_snap_txg;
62 uint64_t ds_next_snap_obj;
63 uint64_t ds_snapnames_zapobj; /* zap obj of snaps; ==0 for snaps */
64 uint64_t ds_num_children; /* clone/snap children; ==0 for head */
65 uint64_t ds_creation_time; /* seconds since 1970 */
66 uint64_t ds_creation_txg;
67 uint64_t ds_deadlist_obj;
68 uint64_t ds_used_bytes;
69 uint64_t ds_compressed_bytes;
70 uint64_t ds_uncompressed_bytes;
71 uint64_t ds_unique_bytes; /* only relevant to snapshots */
73 * The ds_fsid_guid is a 56-bit ID that can change to avoid
74 * collisions. The ds_guid is a 64-bit ID that will never
75 * change, so there is a small probability that it will collide.
77 uint64_t ds_fsid_guid;
81 uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */
84 typedef struct dsl_dataset {
86 struct dsl_dir *ds_dir;
87 dsl_dataset_phys_t *ds_phys;
91 /* only used in syncing context: */
92 struct dsl_dataset *ds_prev; /* only valid for non-snapshots */
94 /* has internal locking: */
97 /* protected by lock on pool's dp_dirty_datasets list */
98 txg_node_t ds_dirty_link;
99 list_node_t ds_synced_link;
102 * ds_phys->ds_<accounting> is also protected by ds_lock.
103 * Protected by ds_lock:
107 dsl_dataset_evict_func_t *ds_user_evict_func;
108 uint64_t ds_open_refcount;
110 /* no locking; only for making guesses */
111 uint64_t ds_trysnap_txg;
113 /* Protected by ds_lock; keep at end of struct for better locality */
114 char ds_snapname[MAXNAMELEN];
117 #define dsl_dataset_is_snapshot(ds) \
118 ((ds)->ds_phys->ds_num_children != 0)
120 int dsl_dataset_open_spa(spa_t *spa, const char *name, int mode,
121 void *tag, dsl_dataset_t **dsp);
122 int dsl_dataset_open(const char *name, int mode, void *tag,
123 dsl_dataset_t **dsp);
124 int dsl_dataset_open_obj(struct dsl_pool *dp, uint64_t dsobj,
125 const char *tail, int mode, void *tag, dsl_dataset_t **);
126 void dsl_dataset_name(dsl_dataset_t *ds, char *name);
127 void dsl_dataset_close(dsl_dataset_t *ds, int mode, void *tag);
128 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds,
129 const char *lastname, dsl_dataset_t *clone_parent, dmu_tx_t *tx);
130 int dsl_dataset_destroy(const char *name);
131 int dsl_snapshots_destroy(char *fsname, char *snapname);
132 dsl_checkfunc_t dsl_dataset_snapshot_check;
133 dsl_syncfunc_t dsl_dataset_snapshot_sync;
134 int dsl_dataset_rollback(dsl_dataset_t *ds);
135 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive);
136 int dsl_dataset_promote(const char *name);
138 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds,
139 void *p, dsl_dataset_evict_func_t func);
140 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds);
142 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds);
143 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
145 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds);
147 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx);
149 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx);
150 void dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio,
152 int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth);
153 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds);
155 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx);
156 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv);
157 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat);
158 void dsl_dataset_space(dsl_dataset_t *ds,
159 uint64_t *refdbytesp, uint64_t *availbytesp,
160 uint64_t *usedobjsp, uint64_t *availobjsp);
161 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds);
163 void dsl_dataset_create_root(struct dsl_pool *dp, uint64_t *ddobjp,
166 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf);
169 #define dprintf_ds(ds, fmt, ...) do { \
170 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \
171 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \
172 dsl_dataset_name(ds, __ds_name); \
173 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \
174 kmem_free(__ds_name, MAXNAMELEN); \
176 _NOTE(CONSTCOND) } while (0)
178 #define dprintf_ds(dd, fmt, ...)
185 #endif /* _SYS_DSL_DATASET_H */