1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5ea8dc4b6Seschrock * Common Development and Distribution License (the "License"). 6ea8dc4b6Seschrock * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21fa9e4066Sahrens /* 22ea8dc4b6Seschrock * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 23fa9e4066Sahrens * Use is subject to license terms. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 26fa9e4066Sahrens #ifndef _SYS_DSL_DATASET_H 27fa9e4066Sahrens #define _SYS_DSL_DATASET_H 28fa9e4066Sahrens 29fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 30fa9e4066Sahrens 31fa9e4066Sahrens #include <sys/dmu.h> 32fa9e4066Sahrens #include <sys/spa.h> 33fa9e4066Sahrens #include <sys/txg.h> 34fa9e4066Sahrens #include <sys/bplist.h> 351d452cf5Sahrens #include <sys/dsl_synctask.h> 36fa9e4066Sahrens #include <sys/zfs_context.h> 37fa9e4066Sahrens 38fa9e4066Sahrens #ifdef __cplusplus 39fa9e4066Sahrens extern "C" { 40fa9e4066Sahrens #endif 41fa9e4066Sahrens 42fa9e4066Sahrens struct dsl_dataset; 43fa9e4066Sahrens struct dsl_dir; 44fa9e4066Sahrens struct dsl_pool; 45fa9e4066Sahrens 46fa9e4066Sahrens typedef void dsl_dataset_evict_func_t(struct dsl_dataset *, void *); 47fa9e4066Sahrens 4899653d4eSeschrock #define DS_FLAG_INCONSISTENT (1ULL<<0) 4999653d4eSeschrock /* 5099653d4eSeschrock * NB: nopromote can not yet be set, but we want support for it in this 5199653d4eSeschrock * on-disk version, so that we don't need to upgrade for it later. It 5299653d4eSeschrock * will be needed when we implement 'zfs split' (where the split off 5399653d4eSeschrock * clone should not be promoted). 5499653d4eSeschrock */ 5599653d4eSeschrock #define DS_FLAG_NOPROMOTE (1ULL<<1) 5699653d4eSeschrock 57fa9e4066Sahrens typedef struct dsl_dataset_phys { 58fa9e4066Sahrens uint64_t ds_dir_obj; 59fa9e4066Sahrens uint64_t ds_prev_snap_obj; 60fa9e4066Sahrens uint64_t ds_prev_snap_txg; 61fa9e4066Sahrens uint64_t ds_next_snap_obj; 62fa9e4066Sahrens uint64_t ds_snapnames_zapobj; /* zap obj of snaps; ==0 for snaps */ 63fa9e4066Sahrens uint64_t ds_num_children; /* clone/snap children; ==0 for head */ 64fa9e4066Sahrens uint64_t ds_creation_time; /* seconds since 1970 */ 65fa9e4066Sahrens uint64_t ds_creation_txg; 66fa9e4066Sahrens uint64_t ds_deadlist_obj; 67fa9e4066Sahrens uint64_t ds_used_bytes; 68fa9e4066Sahrens uint64_t ds_compressed_bytes; 69fa9e4066Sahrens uint64_t ds_uncompressed_bytes; 70fa9e4066Sahrens uint64_t ds_unique_bytes; /* only relavent to snapshots */ 71fa9e4066Sahrens /* 72fa9e4066Sahrens * The ds_fsid_guid is a 56-bit ID that can change to avoid 73fa9e4066Sahrens * collisions. The ds_guid is a 64-bit ID that will never 74fa9e4066Sahrens * change, so there is a small probability that it will collide. 75fa9e4066Sahrens */ 76fa9e4066Sahrens uint64_t ds_fsid_guid; 77fa9e4066Sahrens uint64_t ds_guid; 7899653d4eSeschrock uint64_t ds_flags; 79fa9e4066Sahrens blkptr_t ds_bp; 8099653d4eSeschrock uint64_t ds_pad[8]; /* pad out to 320 bytes for good measure */ 81fa9e4066Sahrens } dsl_dataset_phys_t; 82fa9e4066Sahrens 83fa9e4066Sahrens typedef struct dsl_dataset { 84fa9e4066Sahrens /* Immutable: */ 85fa9e4066Sahrens struct dsl_dir *ds_dir; 86fa9e4066Sahrens dsl_dataset_phys_t *ds_phys; 87fa9e4066Sahrens dmu_buf_t *ds_dbuf; 88fa9e4066Sahrens uint64_t ds_object; 89fa9e4066Sahrens 90fa9e4066Sahrens /* only used in syncing context: */ 91fa9e4066Sahrens struct dsl_dataset *ds_prev; /* only valid for non-snapshots */ 92fa9e4066Sahrens 93fa9e4066Sahrens /* has internal locking: */ 94fa9e4066Sahrens bplist_t ds_deadlist; 95fa9e4066Sahrens 96fa9e4066Sahrens /* protected by lock on pool's dp_dirty_datasets list */ 97fa9e4066Sahrens txg_node_t ds_dirty_link; 98fa9e4066Sahrens list_node_t ds_synced_link; 99fa9e4066Sahrens 100fa9e4066Sahrens /* 101fa9e4066Sahrens * ds_phys->ds_<accounting> is also protected by ds_lock. 102fa9e4066Sahrens * Protected by ds_lock: 103fa9e4066Sahrens */ 104fa9e4066Sahrens kmutex_t ds_lock; 105fa9e4066Sahrens void *ds_user_ptr; 106fa9e4066Sahrens dsl_dataset_evict_func_t *ds_user_evict_func; 107fa9e4066Sahrens uint64_t ds_open_refcount; 108fa9e4066Sahrens 1091d452cf5Sahrens /* no locking; only for making guesses */ 1101d452cf5Sahrens uint64_t ds_trysnap_txg; 1111d452cf5Sahrens 112fa9e4066Sahrens /* Protected by ds_lock; keep at end of struct for better locality */ 113fa9e4066Sahrens char ds_snapname[MAXNAMELEN]; 114fa9e4066Sahrens } dsl_dataset_t; 115fa9e4066Sahrens 116fa9e4066Sahrens #define dsl_dataset_is_snapshot(ds) \ 117fa9e4066Sahrens ((ds)->ds_phys->ds_num_children != 0) 118fa9e4066Sahrens 119fa9e4066Sahrens int dsl_dataset_open_spa(spa_t *spa, const char *name, int mode, 120fa9e4066Sahrens void *tag, dsl_dataset_t **dsp); 121fa9e4066Sahrens int dsl_dataset_open(const char *name, int mode, void *tag, 122fa9e4066Sahrens dsl_dataset_t **dsp); 123ea8dc4b6Seschrock int dsl_dataset_open_obj(struct dsl_pool *dp, uint64_t dsobj, 124ea8dc4b6Seschrock const char *tail, int mode, void *tag, dsl_dataset_t **); 125fa9e4066Sahrens void dsl_dataset_name(dsl_dataset_t *ds, char *name); 126fa9e4066Sahrens void dsl_dataset_close(dsl_dataset_t *ds, int mode, void *tag); 1271d452cf5Sahrens uint64_t dsl_dataset_create_sync(dsl_dir_t *pds, 128fa9e4066Sahrens const char *lastname, dsl_dataset_t *clone_parent, dmu_tx_t *tx); 129fa9e4066Sahrens int dsl_dataset_destroy(const char *name); 1301d452cf5Sahrens int dsl_snapshots_destroy(char *fsname, char *snapname); 1311d452cf5Sahrens dsl_checkfunc_t dsl_dataset_snapshot_check; 1321d452cf5Sahrens dsl_syncfunc_t dsl_dataset_snapshot_sync; 1331d452cf5Sahrens int dsl_dataset_rollback(dsl_dataset_t *ds); 134fa9e4066Sahrens int dsl_dataset_rename(const char *name, const char *newname); 13599653d4eSeschrock int dsl_dataset_promote(const char *name); 136fa9e4066Sahrens 137fa9e4066Sahrens void *dsl_dataset_set_user_ptr(dsl_dataset_t *ds, 138fa9e4066Sahrens void *p, dsl_dataset_evict_func_t func); 139fa9e4066Sahrens void *dsl_dataset_get_user_ptr(dsl_dataset_t *ds); 140fa9e4066Sahrens 141fa9e4066Sahrens void dsl_dataset_get_blkptr(dsl_dataset_t *ds, blkptr_t *bp); 142fa9e4066Sahrens void dsl_dataset_set_blkptr(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 143fa9e4066Sahrens 144fa9e4066Sahrens spa_t *dsl_dataset_get_spa(dsl_dataset_t *ds); 145fa9e4066Sahrens 146fa9e4066Sahrens void dsl_dataset_sync(dsl_dataset_t *os, dmu_tx_t *tx); 147fa9e4066Sahrens 148fa9e4066Sahrens void dsl_dataset_block_born(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 149fa9e4066Sahrens void dsl_dataset_block_kill(dsl_dataset_t *ds, blkptr_t *bp, dmu_tx_t *tx); 150ea8dc4b6Seschrock int dsl_dataset_block_freeable(dsl_dataset_t *ds, uint64_t blk_birth); 151ea8dc4b6Seschrock uint64_t dsl_dataset_prev_snap_txg(dsl_dataset_t *ds); 152fa9e4066Sahrens 153fa9e4066Sahrens void dsl_dataset_dirty(dsl_dataset_t *ds, dmu_tx_t *tx); 154*a2eea2e1Sahrens void dsl_dataset_stats(dsl_dataset_t *os, nvlist_t *nv); 155*a2eea2e1Sahrens void dsl_dataset_fast_stat(dsl_dataset_t *ds, dmu_objset_stats_t *stat); 156*a2eea2e1Sahrens void dsl_dataset_space(dsl_dataset_t *ds, 157*a2eea2e1Sahrens uint64_t *refdbytesp, uint64_t *availbytesp, 158*a2eea2e1Sahrens uint64_t *usedobjsp, uint64_t *availobjsp); 159*a2eea2e1Sahrens uint64_t dsl_dataset_fsid_guid(dsl_dataset_t *ds); 160fa9e4066Sahrens 161fa9e4066Sahrens void dsl_dataset_create_root(struct dsl_pool *dp, uint64_t *ddobjp, 162fa9e4066Sahrens dmu_tx_t *tx); 163fa9e4066Sahrens 164fa9e4066Sahrens #ifdef ZFS_DEBUG 165fa9e4066Sahrens #define dprintf_ds(ds, fmt, ...) do { \ 166fa9e4066Sahrens if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 167fa9e4066Sahrens char *__ds_name = kmem_alloc(MAXNAMELEN, KM_SLEEP); \ 168fa9e4066Sahrens dsl_dataset_name(ds, __ds_name); \ 169fa9e4066Sahrens dprintf("ds=%s " fmt, __ds_name, __VA_ARGS__); \ 170fa9e4066Sahrens kmem_free(__ds_name, MAXNAMELEN); \ 171fa9e4066Sahrens } \ 172fa9e4066Sahrens _NOTE(CONSTCOND) } while (0) 173fa9e4066Sahrens #else 174fa9e4066Sahrens #define dprintf_ds(dd, fmt, ...) 175fa9e4066Sahrens #endif 176fa9e4066Sahrens 177fa9e4066Sahrens #ifdef __cplusplus 178fa9e4066Sahrens } 179fa9e4066Sahrens #endif 180fa9e4066Sahrens 181fa9e4066Sahrens #endif /* _SYS_DSL_DATASET_H */ 182