xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/dmu_objset.h (revision 7f73c863fa99612e79b9e6bc08bdead3802f8a05)
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_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 struct objset_impl;
44 
45 typedef struct objset_phys {
46 	dnode_phys_t os_meta_dnode;
47 	zil_header_t os_zil_header;
48 	uint64_t os_type;
49 	char os_pad[1024 - sizeof (dnode_phys_t) - sizeof (zil_header_t) -
50 	    sizeof (uint64_t)];
51 } objset_phys_t;
52 
53 struct objset {
54 	struct objset_impl *os;
55 	int os_mode;
56 };
57 
58 typedef struct objset_impl {
59 	/* Immutable: */
60 	struct dsl_dataset *os_dsl_dataset;
61 	spa_t *os_spa;
62 	arc_buf_t *os_phys_buf;
63 	objset_phys_t *os_phys;
64 	dnode_t *os_meta_dnode;
65 	zilog_t *os_zil;
66 	objset_t os;
67 	uint8_t os_checksum;	/* can change, under dsl_dir's locks */
68 	uint8_t os_compress;	/* can change, under dsl_dir's locks */
69 	uint8_t os_copies;	/* can change, under dsl_dir's locks */
70 	uint8_t os_primary_cache;	/* can change, under dsl_dir's locks */
71 	uint8_t os_secondary_cache;	/* can change, under dsl_dir's locks */
72 
73 	/* no lock needed: */
74 	struct dmu_tx *os_synctx; /* XXX sketchy */
75 	blkptr_t *os_rootbp;
76 	zil_header_t os_zil_header;
77 
78 	/* Protected by os_obj_lock */
79 	kmutex_t os_obj_lock;
80 	uint64_t os_obj_next;
81 
82 	/* Protected by os_lock */
83 	kmutex_t os_lock;
84 	list_t os_dirty_dnodes[TXG_SIZE];
85 	list_t os_free_dnodes[TXG_SIZE];
86 	list_t os_dnodes;
87 	list_t os_downgraded_dbufs;
88 
89 	/* stuff we store for the user */
90 	kmutex_t os_user_ptr_lock;
91 	void *os_user_ptr;
92 } objset_impl_t;
93 
94 #define	DMU_META_DNODE_OBJECT	0
95 
96 #define	DMU_OS_IS_L2CACHEABLE(os)				\
97 	((os)->os_secondary_cache == ZFS_CACHE_ALL ||		\
98 	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
99 
100 /* called from zpl */
101 int dmu_objset_open(const char *name, dmu_objset_type_t type, int mode,
102     objset_t **osp);
103 void dmu_objset_close(objset_t *os);
104 int dmu_objset_create(const char *name, dmu_objset_type_t type,
105     objset_t *clone_parent, uint64_t flags,
106     void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
107 int dmu_objset_destroy(const char *name);
108 int dmu_objset_rollback(objset_t *os);
109 int dmu_objset_snapshot(char *fsname, char *snapname, boolean_t recursive);
110 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
111 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
112 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
113     uint64_t *usedobjsp, uint64_t *availobjsp);
114 uint64_t dmu_objset_fsid_guid(objset_t *os);
115 int dmu_objset_find(char *name, int func(char *, void *), void *arg,
116     int flags);
117 int dmu_objset_find_spa(spa_t *spa, const char *name,
118     int func(spa_t *, uint64_t, const char *, void *), void *arg, int flags);
119 int dmu_objset_prefetch(char *name, void *arg);
120 void dmu_objset_byteswap(void *buf, size_t size);
121 int dmu_objset_evict_dbufs(objset_t *os);
122 
123 /* called from dsl */
124 void dmu_objset_sync(objset_impl_t *os, zio_t *zio, dmu_tx_t *tx);
125 objset_impl_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
126     blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
127 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
128     objset_impl_t **osip);
129 void dmu_objset_evict(struct dsl_dataset *ds, void *arg);
130 
131 #ifdef	__cplusplus
132 }
133 #endif
134 
135 #endif /* _SYS_DMU_OBJSET_H */
136