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, 2017 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 * Copyright (c) 2014 Integros [integros.com]
27 * Copyright 2016 Nexenta Systems, Inc. All rights reserved.
28 */
29
30 /* Portions Copyright 2010 Robert Milkowski */
31
32 #ifndef _SYS_DMU_OBJSET_H
33 #define _SYS_DMU_OBJSET_H
34
35 #include <sys/spa.h>
36 #include <sys/special_impl.h>
37 #include <sys/arc.h>
38 #include <sys/txg.h>
39 #include <sys/zfs_context.h>
40 #include <sys/dnode.h>
41 #include <sys/zio.h>
42 #include <sys/zil.h>
43 #include <sys/sa.h>
44 #include <sys/zfs_ioctl.h>
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 extern krwlock_t os_lock;
51
52 struct dsl_pool;
53 struct dsl_dataset;
54 struct dmu_tx;
55
56 #define OBJSET_PHYS_SIZE 2048
57 #define OBJSET_OLD_PHYS_SIZE 1024
58
59 #define OBJSET_BUF_HAS_USERUSED(buf) \
60 (arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE)
61
62 #define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL<<0)
63
64 typedef struct objset_phys {
65 dnode_phys_t os_meta_dnode;
66 zil_header_t os_zil_header;
67 uint64_t os_type;
68 uint64_t os_flags;
69 char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 -
70 sizeof (zil_header_t) - sizeof (uint64_t)*2];
71 dnode_phys_t os_userused_dnode;
72 dnode_phys_t os_groupused_dnode;
73 } objset_phys_t;
74
75 #define OBJSET_PROP_UNINITIALIZED ((uint64_t)-1)
76 struct objset {
77 /* Immutable: */
78 struct dsl_dataset *os_dsl_dataset;
79 spa_t *os_spa;
80 arc_buf_t *os_phys_buf;
81 objset_phys_t *os_phys;
82 /*
83 * The following "special" dnodes have no parent, are exempt
84 * from dnode_move(), and are not recorded in os_dnodes, but they
85 * root their descendents in this objset using handles anyway, so
86 * that all access to dnodes from dbufs consistently uses handles.
87 */
88 dnode_handle_t os_meta_dnode;
89 dnode_handle_t os_userused_dnode;
90 dnode_handle_t os_groupused_dnode;
91 zilog_t *os_zil;
92
93 list_node_t os_evicting_node;
94
95 /* can change, under dsl_dir's locks: */
96 enum zio_checksum os_checksum;
97 enum zio_compress os_compress;
98 boolean_t os_smartcomp_enabled;
99 uint8_t os_copies;
100 enum zio_checksum os_dedup_checksum;
101 boolean_t os_dedup_verify;
102 zfs_logbias_op_t os_logbias;
103 zfs_cache_type_t os_primary_cache;
104 zfs_cache_type_t os_secondary_cache;
105 zfs_sync_type_t os_sync;
106 zfs_redundant_metadata_type_t os_redundant_metadata;
107 int os_recordsize;
108 uint64_t os_zpl_meta_to_special;
109 zfs_wbc_mode_t os_wbc_mode;
110 uint64_t os_wbc_root_ds_obj;
111 uint64_t os_wbc_off_txg;
112 /*
113 * The next four values are used as a cache of whatever's on disk, and
114 * are initialized the first time these properties are queried. Before
115 * being initialized with their real values, their values are
116 * OBJSET_PROP_UNINITIALIZED.
117 */
118 uint64_t os_version;
119 uint64_t os_normalization;
120 uint64_t os_utf8only;
121 uint64_t os_casesensitivity;
122
123 /*
124 * Pointer is constant; the blkptr it points to is protected by
125 * os_dsl_dataset->ds_bp_rwlock
126 */
127 blkptr_t *os_rootbp;
128
129 /* no lock needed: */
130 struct dmu_tx *os_synctx; /* XXX sketchy */
131 zil_header_t os_zil_header;
132 multilist_t *os_synced_dnodes;
133 uint64_t os_flags;
134 uint64_t os_freed_dnodes;
135 boolean_t os_rescan_dnodes;
136
137 /* Protected by os_obj_lock */
138 kmutex_t os_obj_lock;
139 uint64_t os_obj_next;
140
141 /* Protected by os_lock */
142 kmutex_t os_lock;
143 multilist_t *os_dirty_dnodes[TXG_SIZE];
144 list_t os_dnodes;
145 list_t os_downgraded_dbufs;
146
147 /* Protects changes to DMU_{USER,GROUP}USED_OBJECT */
148 kmutex_t os_userused_lock;
149
150 /* stuff we store for the user */
151 kmutex_t os_user_ptr_lock;
152 void *os_user_ptr;
153 sa_os_t *os_sa;
154 };
155
156 #define DMU_META_OBJSET 0
157 #define DMU_META_DNODE_OBJECT 0
158 #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0)
159 #define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode)
160 #define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode)
161 #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode)
162
163 #define DMU_OS_IS_L2CACHEABLE(os) \
164 ((os)->os_secondary_cache == ZFS_CACHE_ALL || \
165 (os)->os_secondary_cache == ZFS_CACHE_METADATA || \
166 (os)->os_secondary_cache == ZFS_CACHE_DATA)
167
168 #define DMU_OS_IS_L2COMPRESSIBLE(os) (zfs_mdcomp_disable == B_FALSE)
169
170 /* called from zpl */
171 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
172 int dmu_objset_own(const char *name, dmu_objset_type_t type,
173 boolean_t readonly, void *tag, objset_t **osp);
174 int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj,
175 dmu_objset_type_t type, boolean_t readonly, void *tag, objset_t **osp);
176 void dmu_objset_refresh_ownership(objset_t *os, void *tag);
177 void dmu_objset_rele(objset_t *os, void *tag);
178 void dmu_objset_disown(objset_t *os, void *tag);
179 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp);
180
181 void dmu_objset_stats(objset_t *os, nvlist_t *nv);
182 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
183 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
184 uint64_t *usedobjsp, uint64_t *availobjsp);
185 uint64_t dmu_objset_fsid_guid(objset_t *os);
186 int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj,
187 int func(struct dsl_pool *, struct dsl_dataset *, void *),
188 void *arg, int flags);
189 int dmu_objset_prefetch(const char *name, void *arg);
190 void dmu_objset_evict_dbufs(objset_t *os);
191 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
192
193 /* called from dsl */
194 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx);
195 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg);
196 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds,
197 blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx);
198 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp,
199 objset_t **osp);
200 void dmu_objset_evict(objset_t *os);
201 void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx);
202 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx);
203 boolean_t dmu_objset_userused_enabled(objset_t *os);
204 int dmu_objset_userspace_upgrade(objset_t *os);
205 boolean_t dmu_objset_userspace_present(objset_t *os);
206 int dmu_fsname(const char *snapname, char *buf);
207
208 void dmu_objset_evict_done(objset_t *os);
209 void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx);
210
211 void dmu_objset_init(void);
212 void dmu_objset_fini(void);
213
214 #ifdef __cplusplus
215 }
216 #endif
217
218 #endif /* _SYS_DMU_OBJSET_H */