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