dsl_dataset.h revision 7046:361307ae060d
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 40extern "C" { 41#endif 42 43struct dsl_dataset; 44struct dsl_dir; 45struct dsl_pool; 46 47typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *); 48 49#define DS_FLAG_INCONSISTENT (1ULL<<0) 50#define DS_IS_INCONSISTENT(ds) \ 51 ((ds)->ds_phys->ds_flags & DS_FLAG_INCONSISTENT) 52/* 53 * NB: nopromote can not yet be set, but we want support for it in this 54 * on-disk version, so that we don't need to upgrade for it later. It 55 * will be needed when we implement 'zfs split' (where the split off 56 * clone should not be promoted). 57 */ 58#define DS_FLAG_NOPROMOTE (1ULL<<1) 59 60/* 61 * DS_FLAG_UNIQUE_ACCURATE is set if ds_unique_bytes has been correctly 62 * calculated for head datasets (starting with SPA_VERSION_UNIQUE_ACCURATE, 63 * refquota/refreservations). 64 */ 65#define DS_FLAG_UNIQUE_ACCURATE (1ULL<<2) 66 67/* 68 * DS_FLAG_CI_DATASET is set if the dataset contains a file system whose 69 * name lookups should be performed case-insensitively. 70 */ 71#define DS_FLAG_CI_DATASET (1ULL<<16) 72 73typedef struct dsl_dataset_phys { 74 uint64_t ds_dir_obj; /* DMU_OT_DSL_DIR */ 75 uint64_t ds_prev_snap_obj; /* DMU_OT_DSL_DATASET */ 76 uint64_t ds_prev_snap_txg; 77 uint64_t ds_next_snap_obj; /* DMU_OT_DSL_DATASET */ 78 uint64_t ds_snapnames_zapobj; /* DMU_OT_DSL_DS_SNAP_MAP 0 for snaps */ 79 uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 80 uint64_t ds_creation_time; /* seconds since 1970 */ 81 uint64_t ds_creation_txg; 82 uint64_t ds_deadlist_obj; /* DMU_OT_BPLIST */ 83 uint64_t ds_used_bytes; 84 uint64_t ds_compressed_bytes; 85 uint64_t ds_uncompressed_bytes; 86 uint64_t ds_unique_bytes; /* only relevant to snapshots */ 87 /* 88 * The ds_fsid_guid is a 56-bit ID that can change to avoid 89 * collisions. The ds_guid is a 64-bit ID that will never 90 * change, so there is a small probability that it will collide. 91 */ 92 uint64_t ds_fsid_guid; 93 uint64_t ds_guid; 94 uint64_t ds_flags; /* DS_FLAG_* */ 95 blkptr_t ds_bp; 96 uint64_t ds_next_clones_obj; /* DMU_OT_DSL_NEXT_CLONES */ 97 uint64_t ds_pad[7]; /* pad out to 320 bytes for good measure */ 98} dsl_dataset_phys_t; 99 100typedef struct dsl_dataset { 101 /* Immutable: */ 102 struct dsl_dir *ds_dir; 103 dsl_dataset_phys_t *ds_phys; 104 dmu_buf_t *ds_dbuf; 105 uint64_t ds_object; 106 uint64_t ds_fsid_guid; 107 108 /* only used in syncing context: */ 109 struct dsl_dataset *ds_prev; /* only valid for non-snapshots */ 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 152int dsl_dataset_hold(const char *name, void *tag, dsl_dataset_t **dsp); 153int dsl_dataset_hold_obj(struct dsl_pool *dp, uint64_t dsobj, 154 void *tag, dsl_dataset_t **); 155int dsl_dataset_own(const char *name, int flags, void *owner, 156 dsl_dataset_t **dsp); 157int dsl_dataset_own_obj(struct dsl_pool *dp, uint64_t dsobj, 158 int flags, void *owner, dsl_dataset_t **); 159void dsl_dataset_name(dsl_dataset_t *ds, char *name); 160void dsl_dataset_rele(dsl_dataset_t *ds, void *tag); 161void dsl_dataset_disown(dsl_dataset_t *ds, void *owner); 162void dsl_dataset_drop_ref(dsl_dataset_t *ds, void *tag); 163boolean_t dsl_dataset_tryown(dsl_dataset_t *ds, boolean_t inconsistentok, 164 void *owner); 165void dsl_dataset_make_exclusive(dsl_dataset_t *ds, void *owner); 166uint64_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 *); 168uint64_t dsl_dataset_create_sync_dd(dsl_dir_t *dd, dsl_dataset_t *origin, 169 uint64_t flags, dmu_tx_t *tx); 170int dsl_dataset_destroy(dsl_dataset_t *ds, void *tag); 171int dsl_snapshots_destroy(char *fsname, char *snapname); 172dsl_checkfunc_t dsl_dataset_destroy_check; 173dsl_syncfunc_t dsl_dataset_destroy_sync; 174dsl_checkfunc_t dsl_dataset_snapshot_check; 175dsl_syncfunc_t dsl_dataset_snapshot_sync; 176int dsl_dataset_rollback(dsl_dataset_t *ds, dmu_objset_type_t ost); 177int dsl_dataset_rename(char *name, const char *newname, boolean_t recursive); 178int dsl_dataset_promote(const char *name); 179int dsl_dataset_clone_swap(dsl_dataset_t *clone, dsl_dataset_t *origin_head, 180 boolean_t force); 181 182void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds, 183 void *p, dsl_dataset_evict_func_t func); 184void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds); 185 186blkptr_t *dsl_dataset_get_blkptr(dsl_dataset_t *ds); 187void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 188 189spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 190 191boolean_t dsl_dataset_modified_since_lastsnap(dsl_dataset_t *ds); 192 193void dsl_dataset_sync(dsl_dataset_t *os, zio_t *zio, dmu_tx_t *tx); 194 195void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 196int dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, zio_t *pio, 197 dmu_tx_t *tx); 198int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth); 199uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 200 201void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 202void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 203void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 204void dsl_dataset_space(dsl_dataset_t *ds, 205 uint64_t *refdbytesp, uint64_t *availbytesp, 206 uint64_t *usedobjsp, uint64_t *availobjsp); 207uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 208 209int dsl_dsobj_to_dsname(char *pname, uint64_t obj, char *buf); 210 211int 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); 214int dsl_dataset_set_quota(const char *dsname, uint64_t quota); 215void dsl_dataset_set_quota_sync(void *arg1, void *arg2, cred_t *cr, 216 dmu_tx_t *tx); 217int dsl_dataset_set_reservation(const char *dsname, uint64_t reservation); 218void dsl_dataset_set_flags(dsl_dataset_t *ds, uint64_t flags); 219 220#ifdef ZFS_DEBUG 221#define dprintf_ds(ds, fmt, ...) do { \ 222 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 223 char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 224 dsl_dataset_name(ds, __ds_name); \ 225 dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 226 kmem_free(__ds_name, MAXNAMELEN); \ 227 } \ 228_NOTE(CONSTCOND) } while (0) 229#else 230#define dprintf_ds(dd, fmt, ...) 231#endif 232 233#ifdef __cplusplus 234} 235#endif 236 237#endif /* _SYS_DSL_DATASET_H */ 238