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 2007 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 typedef struct dsl_dataset_phys { 59 uint64_t ds_dir_obj; 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 */ 72 /* 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. 76 */ 77 uint64_t ds_fsid_guid; 78 uint64_t ds_guid; 79 uint64_t ds_flags; 80 blkptr_t ds_bp; 81 uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */ 82 } dsl_dataset_phys_t; 83 84 typedef struct dsl_dataset { 85 /* Immutable: */ 86 struct dsl_dir *ds_dir; 87 dsl_dataset_phys_t *ds_phys; 88 dmu_buf_t *ds_dbuf; 89 uint64_t ds_object; 90 uint64_t ds_fsid_guid; 91 92 /* only used in syncing context: */ 93 struct dsl_dataset *ds_prev; /* only valid for non-snapshots */ 94 95 /* has internal locking: */ 96 bplist_t ds_deadlist; 97 98 /* protected by lock on pool's dp_dirty_datasets list */ 99 txg_node_t ds_dirty_link; 100 list_node_t ds_synced_link; 101 102 /* 103 * ds_phys->ds_<accounting> is also protected by ds_lock. 104 * Protected by ds_lock: 105 */ 106 kmutex_t ds_lock; 107 void *ds_user_ptr; 108 dsl_dataset_evict_func_t *ds_user_evict_func; 109 uint64_t ds_open_refcount; 110 111 /* no locking; only for making guesses */ 112 uint64_t ds_trysnap_txg; 113 114 /* for objset_open() */ 115 kmutex_t ds_opening_lock; 116 117 /* Protected by ds_lock; keep at end of struct for better locality */ 118 char ds_snapname[MAXNAMELEN]; 119 } dsl_dataset_t; 120 121 #define dsl_dataset_is_snapshot(ds) \ 122 ((ds)->ds_phys->ds_num_children != 0) 123 124 int dsl_dataset_open_spa(spa_t *spa, const char *name, int mode, 125 void *tag, dsl_dataset_t **dsp); 126 int dsl_dataset_open(const char *name, int mode, void *tag, 127 dsl_dataset_t **dsp); 128 int dsl_dataset_open_obj(struct dsl_pool *dp, uint64_t dsobj, 129 const char *tail, int mode, void *tag, dsl_dataset_t **); 130 void dsl_dataset_name(dsl_dataset_t *ds, char *name); 131 void dsl_dataset_close(dsl_dataset_t *ds, int mode, void *tag); 132 uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, 133 const char *lastname, dsl_dataset_t *clone_parent, dmu_tx_t *tx); 134 int dsl_dataset_destroy(const char *name); 135 int dsl_snapshots_destroy(char *fsname, char *snapname); 136 dsl_checkfunc_t dsl_dataset_snapshot_check; 137 dsl_syncfunc_t dsl_dataset_snapshot_sync; 138 int dsl_dataset_rollback(dsl_dataset_t *ds); 139 int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); 140 int dsl_dataset_promote(const char *name); 141 142 void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds, 143 void *p, dsl_dataset_evict_func_t func); 144 void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds); 145 146 blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 147 void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 148 149 spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 150 151 void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 152 153 void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 154 void dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio, 155 dmu_tx_t *tx); 156 int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth); 157 uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 158 159 void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 160 void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 161 void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 162 void dsl_dataset_space(dsl_dataset_t *ds, 163 uint64_t *refdbytesp, uint64_t *availbytesp, 164 uint64_t *usedobjsp, uint64_t *availobjsp); 165 uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 166 167 void dsl_dataset_create_root(struct dsl_pool *dp, uint64_t *ddobjp, 168 dmu_tx_t *tx); 169 170 int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 171 172 #ifdef ZFS_DEBUG 173 #define dprintf_ds(ds, fmt, ...) do { \ 174 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 175 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 176 dsl_dataset_name(ds, __ds_name); \ 177 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 178 kmem_free(__ds_name, MAXNAMELEN); \ 179 } \ 180 _NOTE(CONSTCOND) } while (0) 181 #else 182 #define dprintf_ds(dd, fmt, ...) 183 #endif 184 185 #ifdef __cplusplus 186 } 187 #endif 188 189 #endif /* _SYS_DSL_DATASET_H */ 190