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