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 2009 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 /* to protect against multiple concurrent incremental recv */ 115 kmutex_t ds_recvlock; 116 117 /* protected by lock on pool's dp_dirty_datasets list */ 118 txg_node_t ds_dirty_link; 119 list_node_t ds_synced_link; 120 121 /* 122 * ds_phys->ds_<accounting> is also protected by ds_lock. 123 * Protected by ds_lock: 124 */ 125 kmutex_t ds_lock; 126 void *ds_user_ptr; 127 dsl_dataset_evict_func_t *ds_user_evict_func; 128 129 /* 130 * ds_owner is protected by the ds_rwlock and the ds_lock 131 */ 132 krwlock_t ds_rwlock; 133 kcondvar_t ds_exclusive_cv; 134 void *ds_owner; 135 136 /* no locking; only for making guesses */ 137 uint64_t ds_trysnap_txg; 138 139 /* for objset_open() */ 140 kmutex_t ds_opening_lock; 141 142 uint64_t ds_reserved; /* cached refreservation */ 143 uint64_t ds_quota; /* cached refquota */ 144 145 /* Protected by ds_lock; keep at end of struct for better locality */ 146 char ds_snapname[MAXNAMELEN]; 147 } dsl_dataset_t; 148 149 #define dsl_dataset_is_snapshot(ds) \ 150 ((ds)->ds_phys->ds_num_children != 0) 151 152 #define DS_UNIQUE_IS_ACCURATE(ds) \ 153 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) 154 155 int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp); 156 int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, 157 void *tag, dsl_dataset_t **); 158 int dsl_dataset_own(const char *name, int flags, void *owner, 159 dsl_dataset_t **dsp); 160 int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, 161 int flags, void *owner, dsl_dataset_t **); 162 void dsl_dataset_name(dsl_dataset_t *ds, char *name); 163 void dsl_dataset_rele(dsl_dataset_t *ds, void *tag); 164 void dsl_dataset_disown(dsl_dataset_t *ds, void *owner); 165 void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag); 166 boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok, 167 void *owner); 168 void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *owner); 169 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, const char *lastname, 170 dsl_dataset_t *origin, uint64_t flags, cred_t *, dmu_tx_t *); 171 uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin, 172 uint64_t flags, dmu_tx_t *tx); 173 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag); 174 int dsl_snapshots_destroy(char *fsname, char *snapname); 175 dsl_checkfunc_t dsl_dataset_destroy_check; 176 dsl_syncfunc_t dsl_dataset_destroy_sync; 177 dsl_checkfunc_t dsl_dataset_snapshot_check; 178 dsl_syncfunc_t dsl_dataset_snapshot_sync; 179 int dsl_dataset_rollback(dsl_dataset_t *ds, dmu_objset_type_t ost); 180 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); 181 int dsl_dataset_promote(const char *name); 182 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 183 boolean_t force); 184 185 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds, 186 void *p, dsl_dataset_evict_func_t func); 187 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds); 188 189 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 190 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 191 192 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 193 194 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds); 195 196 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 197 198 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 199 int dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio, 200 dmu_tx_t *tx); 201 boolean_t dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth); 202 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 203 204 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 205 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 206 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 207 void dsl_dataset_space(dsl_dataset_t *ds, 208 uint64_t *refdbytesp, uint64_t *availbytesp, 209 uint64_t *usedobjsp, uint64_t *availobjsp); 210 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 211 212 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 213 214 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, 215 uint64_t asize, uint64_t inflight, uint64_t *used, 216 uint64_t *ref_rsrv); 217 int dsl_dataset_set_quota(const char *dsname, uint64_t quota); 218 void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr, 219 dmu_tx_t *tx); 220 int dsl_dataset_set_reservation(const char *dsname, uint64_t reservation); 221 void dsl_dataset_set_flags(dsl_dataset_t *ds, uint64_t flags); 222 int64_t dsl_dataset_new_refreservation(dsl_dataset_t *ds, uint64_t reservation, 223 dmu_tx_t *tx); 224 225 #ifdef ZFS_DEBUG 226 #define dprintf_ds(ds, fmt, ...) do { \ 227 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 228 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 229 dsl_dataset_name(ds, __ds_name); \ 230 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 231 kmem_free(__ds_name, MAXNAMELEN); \ 232 } \ 233 _NOTE(CONSTCOND) } while (0) 234 #else 235 #define dprintf_ds(dd, fmt, ...) 236 #endif 237 238 #ifdef __cplusplus 239 } 240 #endif 241 242 #endif /* _SYS_DSL_DATASET_H */ 243