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