Home | History | Annotate | Download | only in sys
      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_DMU_OBJSET_H
     27 #define	_SYS_DMU_OBJSET_H
     28 
     29 #include <sys/spa.h>
     30 #include <sys/arc.h>
     31 #include <sys/txg.h>
     32 #include <sys/zfs_context.h>
     33 #include <sys/dnode.h>
     34 #include <sys/zio.h>
     35 #include <sys/zil.h>
     36 
     37 #ifdef	__cplusplus
     38 extern "C" {
     39 #endif
     40 
     41 struct dsl_dataset;
     42 struct dmu_tx;
     43 
     44 #define	OBJSET_PHYS_SIZE 2048
     45 #define	OBJSET_OLD_PHYS_SIZE 1024
     46 
     47 #define	OBJSET_FLAG_USERACCOUNTING_COMPLETE	(1ULL<<0)
     48 
     49 typedef struct objset_phys {
     50 	dnode_phys_t os_meta_dnode;
     51 	zil_header_t os_zil_header;
     52 	uint64_t os_type;
     53 	uint64_t os_flags;
     54 	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
     55 	    sizeof (zil_header_t) - sizeof (uint64_t)*2];
     56 	dnode_phys_t os_userused_dnode;
     57 	dnode_phys_t os_groupused_dnode;
     58 } objset_phys_t;
     59 
     60 struct objset {
     61 	/* Immutable: */
     62 	struct dsl_dataset *os_dsl_dataset;
     63 	spa_t *os_spa;
     64 	arc_buf_t *os_phys_buf;
     65 	objset_phys_t *os_phys;
     66 	dnode_t *os_meta_dnode;
     67 	dnode_t *os_userused_dnode;
     68 	dnode_t *os_groupused_dnode;
     69 	zilog_t *os_zil;
     70 
     71 	/* can change, under dsl_dir's locks: */
     72 	uint8_t os_checksum;
     73 	uint8_t os_compress;
     74 	uint8_t os_copies;
     75 	uint8_t os_dedup_checksum;
     76 	uint8_t os_dedup_verify;
     77 	uint8_t os_logbias;
     78 	uint8_t os_primary_cache;
     79 	uint8_t os_secondary_cache;
     80 
     81 	/* no lock needed: */
     82 	struct dmu_tx *os_synctx; /* XXX sketchy */
     83 	blkptr_t *os_rootbp;
     84 	zil_header_t os_zil_header;
     85 	list_t os_synced_dnodes;
     86 	uint64_t os_flags;
     87 
     88 	/* Protected by os_obj_lock */
     89 	kmutex_t os_obj_lock;
     90 	uint64_t os_obj_next;
     91 
     92 	/* Protected by os_lock */
     93 	kmutex_t os_lock;
     94 	list_t os_dirty_dnodes[TXG_SIZE];
     95 	list_t os_free_dnodes[TXG_SIZE];
     96 	list_t os_dnodes;
     97 	list_t os_downgraded_dbufs;
     98 
     99 	/* stuff we store for the user */
    100 	kmutex_t os_user_ptr_lock;
    101 	void *os_user_ptr;
    102 };
    103 
    104 #define	DMU_META_OBJSET		0
    105 #define	DMU_META_DNODE_OBJECT	0
    106 #define	DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
    107 
    108 #define	DMU_OS_IS_L2CACHEABLE(os)				\
    109 	((os)->os_secondary_cache == ZFS_CACHE_ALL ||		\
    110 	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
    111 
    112 /* called from zpl */
    113 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
    114 int dmu_objset_own(const char *name, dmu_objset_type_t type,
    115     boolean_t readonly, void *tag, objset_t **osp);
    116 void dmu_objset_rele(objset_t *os, void *tag);
    117 void dmu_objset_disown(objset_t *os, void *tag);
    118 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
    119 
    120 int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
    121     void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
    122 int dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin,
    123     uint64_t flags);
    124 int dmu_objset_destroy(const char *name, boolean_t defer);
    125 int dmu_objset_snapshot(char *fsname, char *snapname, nvlist_t *props,
    126     boolean_t recursive);
    127 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
    128 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
    129 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
    130     uint64_t *usedobjsp, uint64_t *availobjsp);
    131 uint64_t dmu_objset_fsid_guid(objset_t *os);
    132 int dmu_objset_find(char *name, int func(char *, void *), void *arg,
    133     int flags);
    134 int dmu_objset_find_spa(spa_t *spa, const char *name,
    135     int func(spa_t *, uint64_t, const char *, void *), void *arg, int flags);
    136 int dmu_objset_prefetch(char *name, void *arg);
    137 void dmu_objset_byteswap(void *buf, size_t size);
    138 int dmu_objset_evict_dbufs(objset_t *os);
    139 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
    140 
    141 /* called from dsl */
    142 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
    143 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
    144 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
    145     blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
    146 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
    147     objset_t **osp);
    148 void dmu_objset_evict(objset_t *os);
    149 void dmu_objset_do_userquota_callbacks(objset_t *os, dmu_tx_t *tx);
    150 boolean_t dmu_objset_userused_enabled(objset_t *os);
    151 int dmu_objset_userspace_upgrade(objset_t *os);
    152 boolean_t dmu_objset_userspace_present(objset_t *os);
    153 
    154 #ifdef	__cplusplus
    155 }
    156 #endif
    157 
    158 #endif /* _SYS_DMU_OBJSET_H */
    159