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 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #include <sys/dmu.h> 32 #include <sys/spa.h> 33 #include <sys/txg.h> 34 #include <sys/zio.h> 35 #include <sys/bplist.h> 36 #include <sys/dsl_synctask.h> 37 #include <sys/zfs_context.h> 38 39 #ifdef __cplusplus 40 extern "C" { 41 #endif 42 43 struct dsl_dataset; 44 struct dsl_dir; 45 struct dsl_pool; 46 47 typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *); 48 49 #define DS_FLAG_INCONSISTENT (1ULL<<0) 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; 73 uint64_t ds_prev_snap_obj; 74 uint64_t ds_prev_snap_txg; 75 uint64_t ds_next_snap_obj; 76 uint64_t ds_snapnames_zapobj; /* zap obj of snaps; ==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; 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; 93 blkptr_t ds_bp; 94 uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */ 95 } dsl_dataset_phys_t; 96 97 typedef struct dsl_dataset { 98 /* Immutable: */ 99 struct dsl_dir *ds_dir; 100 dsl_dataset_phys_t *ds_phys; 101 dmu_buf_t *ds_dbuf; 102 uint64_t ds_object; 103 uint64_t ds_fsid_guid; 104 105 /* only used in syncing context: */ 106 struct dsl_dataset *ds_prev; /* only valid for non-snapshots */ 107 108 /* has internal locking: */ 109 bplist_t ds_deadlist; 110 111 /* protected by lock on pool's dp_dirty_datasets list */ 112 txg_node_t ds_dirty_link; 113 list_node_t ds_synced_link; 114 115 /* 116 * ds_phys->ds_<accounting> is also protected by ds_lock. 117 * Protected by ds_lock: 118 */ 119 kmutex_t ds_lock; 120 void *ds_user_ptr; 121 dsl_dataset_evict_func_t *ds_user_evict_func; 122 uint64_t ds_open_refcount; 123 124 /* no locking; only for making guesses */ 125 uint64_t ds_trysnap_txg; 126 127 /* for objset_open() */ 128 kmutex_t ds_opening_lock; 129 130 uint64_t ds_reserved; /* cached refreservation */ 131 uint64_t ds_quota; /* cached refquota */ 132 133 /* Protected by ds_lock; keep at end of struct for better locality */ 134 char ds_snapname[MAXNAMELEN]; 135 } dsl_dataset_t; 136 137 #define dsl_dataset_is_snapshot(ds) \ 138 ((ds)->ds_phys->ds_num_children != 0) 139 140 #define DS_UNIQUE_IS_ACCURATE(ds) \ 141 (((ds)->ds_phys->ds_flags & DS_FLAG_UNIQUE_ACCURATE) != 0) 142 143 int dsl_dataset_open_spa(spa_t *spa, const char *name, int mode, 144 void *tag, dsl_dataset_t **dsp); 145 int dsl_dataset_open(const char *name, int mode, void *tag, 146 dsl_dataset_t **dsp); 147 int dsl_dataset_open_obj(struct dsl_pool *dp, uint64_t dsobj, 148 const char *tail, int mode, void *tag, dsl_dataset_t **); 149 void dsl_dataset_name(dsl_dataset_t *ds, char *name); 150 void dsl_dataset_close(dsl_dataset_t *ds, int mode, void *tag); 151 void dsl_dataset_downgrade(dsl_dataset_t *ds, int oldmode, int newmode); 152 boolean_t dsl_dataset_tryupgrade(dsl_dataset_t *ds, int oldmode, int newmode); 153 uint64_t dsl_dataset_create_sync_impl(dsl_dir_t *dd, dsl_dataset_t *origin, 154 uint64_t flags, dmu_tx_t *tx); 155 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, 156 const char *lastname, dsl_dataset_t *origin, uint64_t flags, 157 cred_t *, dmu_tx_t *); 158 int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag); 159 int dsl_snapshots_destroy(char *fsname, char *snapname); 160 dsl_checkfunc_t dsl_dataset_destroy_check; 161 dsl_syncfunc_t dsl_dataset_destroy_sync; 162 dsl_checkfunc_t dsl_dataset_snapshot_check; 163 dsl_syncfunc_t dsl_dataset_snapshot_sync; 164 int dsl_dataset_rollback(dsl_dataset_t *ds, dmu_objset_type_t ost); 165 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); 166 int dsl_dataset_promote(const char *name); 167 int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 168 boolean_t force); 169 170 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds, 171 void *p, dsl_dataset_evict_func_t func); 172 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds); 173 174 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 175 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 176 177 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 178 179 boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds); 180 181 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 182 183 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 184 void dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio, 185 dmu_tx_t *tx); 186 int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth); 187 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 188 189 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 190 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 191 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 192 void dsl_dataset_space(dsl_dataset_t *ds, 193 uint64_t *refdbytesp, uint64_t *availbytesp, 194 uint64_t *usedobjsp, uint64_t *availobjsp); 195 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 196 197 void dsl_dataset_create_root(struct dsl_pool *dp, uint64_t *ddobjp, 198 dmu_tx_t *tx); 199 200 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 201 202 int dsl_dataset_check_quota(dsl_dataset_t *ds, boolean_t check_quota, 203 uint64_t asize, uint64_t inflight, uint64_t *used, 204 uint64_t *ref_rsrv); 205 int dsl_dataset_set_quota(const char *dsname, uint64_t quota); 206 void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr, 207 dmu_tx_t *tx); 208 int dsl_dataset_set_reservation(const char *dsname, uint64_t reservation); 209 void dsl_dataset_set_flags(dsl_dataset_t *ds, uint64_t flags); 210 211 #ifdef ZFS_DEBUG 212 #define dprintf_ds(ds, fmt, ...) do { \ 213 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 214 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 215 dsl_dataset_name(ds, __ds_name); \ 216 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 217 kmem_free(__ds_name, MAXNAMELEN); \ 218 } \ 219 _NOTE(CONSTCOND) } while (0) 220 #else 221 #define dprintf_ds(dd, fmt, ...) 222 #endif 223 224 #ifdef __cplusplus 225 } 226 #endif 227 228 #endif /* _SYS_DSL_DATASET_H */ 229