xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/dmu_objset.h (revision 3b2aab18808792cbd248a12f1edf139b89833c13)
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2012 by Delphix. All rights reserved.
24  */
25 
26 /* Portions Copyright 2010 Robert Milkowski */
27 
28 #ifndef	_SYS_DMU_OBJSET_H
29 #define	_SYS_DMU_OBJSET_H
30 
31 #include <sys/spa.h>
32 #include <sys/arc.h>
33 #include <sys/txg.h>
34 #include <sys/zfs_context.h>
35 #include <sys/dnode.h>
36 #include <sys/zio.h>
37 #include <sys/zil.h>
38 #include <sys/sa.h>
39 
40 #ifdef	__cplusplus
41 extern "C" {
42 #endif
43 
44 extern krwlock_t os_lock;
45 
46 struct dsl_pool;
47 struct dsl_dataset;
48 struct dmu_tx;
49 
50 #define	OBJSET_PHYS_SIZE 2048
51 #define	OBJSET_OLD_PHYS_SIZE 1024
52 
53 #define	OBJSET_BUF_HAS_USERUSED(buf) \
54 	(arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)
55 
56 #define	OBJSET_FLAG_USERACCOUNTING_COMPLETE	(1ULL<<0)
57 
58 typedef struct objset_phys {
59 	dnode_phys_t os_meta_dnode;
60 	zil_header_t os_zil_header;
61 	uint64_t os_type;
62 	uint64_t os_flags;
63 	char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
64 	    sizeof (zil_header_t) - sizeof (uint64_t)*2];
65 	dnode_phys_t os_userused_dnode;
66 	dnode_phys_t os_groupused_dnode;
67 } objset_phys_t;
68 
69 struct objset {
70 	/* Immutable: */
71 	struct dsl_dataset *os_dsl_dataset;
72 	spa_t *os_spa;
73 	arc_buf_t *os_phys_buf;
74 	objset_phys_t *os_phys;
75 	/*
76 	 * The following "special" dnodes have no parent and are exempt from
77 	 * dnode_move(), but they root their descendents in this objset using
78 	 * handles anyway, so that all access to dnodes from dbufs consistently
79 	 * uses handles.
80 	 */
81 	dnode_handle_t os_meta_dnode;
82 	dnode_handle_t os_userused_dnode;
83 	dnode_handle_t os_groupused_dnode;
84 	zilog_t *os_zil;
85 
86 	/* can change, under dsl_dir's locks: */
87 	uint8_t os_checksum;
88 	uint8_t os_compress;
89 	uint8_t os_copies;
90 	uint8_t os_dedup_checksum;
91 	uint8_t os_dedup_verify;
92 	uint8_t os_logbias;
93 	uint8_t os_primary_cache;
94 	uint8_t os_secondary_cache;
95 	uint8_t os_sync;
96 
97 	/* no lock needed: */
98 	struct dmu_tx *os_synctx; /* XXX sketchy */
99 	blkptr_t *os_rootbp;
100 	zil_header_t os_zil_header;
101 	list_t os_synced_dnodes;
102 	uint64_t os_flags;
103 
104 	/* Protected by os_obj_lock */
105 	kmutex_t os_obj_lock;
106 	uint64_t os_obj_next;
107 
108 	/* Protected by os_lock */
109 	kmutex_t os_lock;
110 	list_t os_dirty_dnodes[TXG_SIZE];
111 	list_t os_free_dnodes[TXG_SIZE];
112 	list_t os_dnodes;
113 	list_t os_downgraded_dbufs;
114 
115 	/* stuff we store for the user */
116 	kmutex_t os_user_ptr_lock;
117 	void *os_user_ptr;
118 	sa_os_t *os_sa;
119 };
120 
121 #define	DMU_META_OBJSET		0
122 #define	DMU_META_DNODE_OBJECT	0
123 #define	DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
124 #define	DMU_META_DNODE(os)	((os)->os_meta_dnode.dnh_dnode)
125 #define	DMU_USERUSED_DNODE(os)	((os)->os_userused_dnode.dnh_dnode)
126 #define	DMU_GROUPUSED_DNODE(os)	((os)->os_groupused_dnode.dnh_dnode)
127 
128 #define	DMU_OS_IS_L2CACHEABLE(os)				\
129 	((os)->os_secondary_cache == ZFS_CACHE_ALL ||		\
130 	(os)->os_secondary_cache == ZFS_CACHE_METADATA)
131 
132 /* called from zpl */
133 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
134 int dmu_objset_own(const char *name, dmu_objset_type_t type,
135     boolean_t readonly, void *tag, objset_t **osp);
136 void dmu_objset_rele(objset_t *os, void *tag);
137 void dmu_objset_disown(objset_t *os, void *tag);
138 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
139 
140 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
141 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
142 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
143     uint64_t *usedobjsp, uint64_t *availobjsp);
144 uint64_t dmu_objset_fsid_guid(objset_t *os);
145 int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
146     int func(struct dsl_pool *, struct dsl_dataset *, void *),
147     void *arg, int flags);
148 int dmu_objset_prefetch(const char *name, void *arg);
149 void dmu_objset_evict_dbufs(objset_t *os);
150 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
151 
152 /* called from dsl */
153 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
154 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
155 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
156     blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
157 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
158     objset_t **osp);
159 void dmu_objset_evict(objset_t *os);
160 void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
161 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
162 boolean_t dmu_objset_userused_enabled(objset_t *os);
163 int dmu_objset_userspace_upgrade(objset_t *os);
164 boolean_t dmu_objset_userspace_present(objset_t *os);
165 int dmu_fsname(const char *snapname, char *buf);
166 
167 void dmu_objset_init(void);
168 void dmu_objset_fini(void);
169 
170 #ifdef	__cplusplus
171 }
172 #endif
173 
174 #endif /* _SYS_DMU_OBJSET_H */
175