]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
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 | /* | |
428870ff | 22 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
cc99f275 | 23 | * Copyright (c) 2012, 2018 by Delphix. All rights reserved. |
3a17a7a9 | 24 | * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. |
0c66c32d | 25 | * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. |
34dc7c2f BB |
26 | */ |
27 | ||
428870ff BB |
28 | /* Portions Copyright 2010 Robert Milkowski */ |
29 | ||
34dc7c2f BB |
30 | #ifndef _SYS_DMU_OBJSET_H |
31 | #define _SYS_DMU_OBJSET_H | |
32 | ||
34dc7c2f BB |
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> | |
428870ff | 40 | #include <sys/sa.h> |
2e5dc449 | 41 | #include <sys/zfs_ioctl.h> |
34dc7c2f BB |
42 | |
43 | #ifdef __cplusplus | |
44 | extern "C" { | |
45 | #endif | |
46 | ||
572e2857 BB |
47 | extern krwlock_t os_lock; |
48 | ||
13fe0198 | 49 | struct dsl_pool; |
34dc7c2f BB |
50 | struct dsl_dataset; |
51 | struct dmu_tx; | |
34dc7c2f | 52 | |
9c5167d1 NF |
53 | #define OBJSET_PHYS_SIZE_V1 1024 |
54 | #define OBJSET_PHYS_SIZE_V2 2048 | |
55 | #define OBJSET_PHYS_SIZE_V3 4096 | |
9babb374 | 56 | |
428870ff | 57 | #define OBJSET_BUF_HAS_USERUSED(buf) \ |
9c5167d1 NF |
58 | (arc_buf_size(buf) >= OBJSET_PHYS_SIZE_V2) |
59 | #define OBJSET_BUF_HAS_PROJECTUSED(buf) \ | |
60 | (arc_buf_size(buf) >= OBJSET_PHYS_SIZE_V3) | |
428870ff | 61 | |
9c5167d1 NF |
62 | #define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL << 0) |
63 | #define OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE (1ULL << 1) | |
64 | #define OBJSET_FLAG_PROJECTQUOTA_COMPLETE (1ULL << 2) | |
9babb374 | 65 | |
089fbf31 TC |
66 | /* |
67 | * This mask defines the set of flags which are "portable", meaning | |
68 | * that they can be preserved when doing a raw encrypted zfs send. | |
69 | * Flags included in this mask will be protected by os_portable_mac | |
70 | * when the block of dnodes is encrypted. No portable flags currently | |
71 | * exist. | |
72 | */ | |
b5256303 TC |
73 | #define OBJSET_CRYPT_PORTABLE_FLAGS_MASK (0) |
74 | ||
34dc7c2f BB |
75 | typedef struct objset_phys { |
76 | dnode_phys_t os_meta_dnode; | |
77 | zil_header_t os_zil_header; | |
78 | uint64_t os_type; | |
9babb374 | 79 | uint64_t os_flags; |
b5256303 TC |
80 | uint8_t os_portable_mac[ZIO_OBJSET_MAC_LEN]; |
81 | uint8_t os_local_mac[ZIO_OBJSET_MAC_LEN]; | |
9c5167d1 | 82 | char os_pad0[OBJSET_PHYS_SIZE_V2 - sizeof (dnode_phys_t)*3 - |
b5256303 TC |
83 | sizeof (zil_header_t) - sizeof (uint64_t)*2 - |
84 | 2*ZIO_OBJSET_MAC_LEN]; | |
9babb374 BB |
85 | dnode_phys_t os_userused_dnode; |
86 | dnode_phys_t os_groupused_dnode; | |
9c5167d1 NF |
87 | dnode_phys_t os_projectused_dnode; |
88 | char os_pad1[OBJSET_PHYS_SIZE_V3 - OBJSET_PHYS_SIZE_V2 - | |
89 | sizeof (dnode_phys_t)]; | |
34dc7c2f BB |
90 | } objset_phys_t; |
91 | ||
1de321e6 JX |
92 | typedef int (*dmu_objset_upgrade_cb_t)(objset_t *); |
93 | ||
2e5dc449 | 94 | #define OBJSET_PROP_UNINITIALIZED ((uint64_t)-1) |
34dc7c2f | 95 | struct objset { |
34dc7c2f BB |
96 | /* Immutable: */ |
97 | struct dsl_dataset *os_dsl_dataset; | |
98 | spa_t *os_spa; | |
99 | arc_buf_t *os_phys_buf; | |
100 | objset_phys_t *os_phys; | |
b5256303 TC |
101 | boolean_t os_encrypted; |
102 | ||
572e2857 | 103 | /* |
0c66c32d JG |
104 | * The following "special" dnodes have no parent, are exempt |
105 | * from dnode_move(), and are not recorded in os_dnodes, but they | |
106 | * root their descendents in this objset using handles anyway, so | |
107 | * that all access to dnodes from dbufs consistently uses handles. | |
572e2857 BB |
108 | */ |
109 | dnode_handle_t os_meta_dnode; | |
110 | dnode_handle_t os_userused_dnode; | |
111 | dnode_handle_t os_groupused_dnode; | |
9c5167d1 | 112 | dnode_handle_t os_projectused_dnode; |
34dc7c2f | 113 | zilog_t *os_zil; |
428870ff | 114 | |
0c66c32d JG |
115 | list_node_t os_evicting_node; |
116 | ||
428870ff | 117 | /* can change, under dsl_dir's locks: */ |
50c957f7 | 118 | uint64_t os_dnodesize; /* default dnode size for new objects */ |
faf0f58c MA |
119 | enum zio_checksum os_checksum; |
120 | enum zio_compress os_compress; | |
428870ff | 121 | uint8_t os_copies; |
faf0f58c MA |
122 | enum zio_checksum os_dedup_checksum; |
123 | boolean_t os_dedup_verify; | |
124 | zfs_logbias_op_t os_logbias; | |
125 | zfs_cache_type_t os_primary_cache; | |
126 | zfs_cache_type_t os_secondary_cache; | |
127 | zfs_sync_type_t os_sync; | |
128 | zfs_redundant_metadata_type_t os_redundant_metadata; | |
f1512ee6 | 129 | int os_recordsize; |
2e5dc449 MA |
130 | /* |
131 | * The next four values are used as a cache of whatever's on disk, and | |
132 | * are initialized the first time these properties are queried. Before | |
133 | * being initialized with their real values, their values are | |
134 | * OBJSET_PROP_UNINITIALIZED. | |
135 | */ | |
136 | uint64_t os_version; | |
137 | uint64_t os_normalization; | |
138 | uint64_t os_utf8only; | |
139 | uint64_t os_casesensitivity; | |
cc99f275 DB |
140 | /* |
141 | * The largest zpl file block allowed in special class. | |
142 | * cached here instead of zfsvfs for easier access. | |
143 | */ | |
144 | int os_zpl_special_smallblock; | |
34dc7c2f | 145 | |
cc9bb3e5 GM |
146 | /* |
147 | * Pointer is constant; the blkptr it points to is protected by | |
148 | * os_dsl_dataset->ds_bp_rwlock | |
149 | */ | |
150 | blkptr_t *os_rootbp; | |
151 | ||
34dc7c2f BB |
152 | /* no lock needed: */ |
153 | struct dmu_tx *os_synctx; /* XXX sketchy */ | |
b128c09f | 154 | zil_header_t os_zil_header; |
64fc7762 | 155 | multilist_t *os_synced_dnodes; |
9babb374 | 156 | uint64_t os_flags; |
68cbd56e NB |
157 | uint64_t os_freed_dnodes; |
158 | boolean_t os_rescan_dnodes; | |
0c03d21a | 159 | boolean_t os_raw_receive; |
34dc7c2f | 160 | |
b5256303 | 161 | /* os_phys_buf should be written raw next txg */ |
1b66810b | 162 | boolean_t os_next_write_raw[TXG_SIZE]; |
b5256303 | 163 | |
34dc7c2f BB |
164 | /* Protected by os_obj_lock */ |
165 | kmutex_t os_obj_lock; | |
dbeb8796 MA |
166 | uint64_t os_obj_next_chunk; |
167 | ||
168 | /* Per-CPU next object to allocate, protected by atomic ops. */ | |
169 | uint64_t *os_obj_next_percpu; | |
170 | int os_obj_next_percpu_len; | |
34dc7c2f BB |
171 | |
172 | /* Protected by os_lock */ | |
173 | kmutex_t os_lock; | |
64fc7762 | 174 | multilist_t *os_dirty_dnodes[TXG_SIZE]; |
34dc7c2f BB |
175 | list_t os_dnodes; |
176 | list_t os_downgraded_dbufs; | |
177 | ||
9c5167d1 | 178 | /* Protects changes to DMU_{USER,GROUP,PROJECT}USED_OBJECT */ |
64fc7762 MA |
179 | kmutex_t os_userused_lock; |
180 | ||
34dc7c2f BB |
181 | /* stuff we store for the user */ |
182 | kmutex_t os_user_ptr_lock; | |
183 | void *os_user_ptr; | |
428870ff | 184 | sa_os_t *os_sa; |
1de321e6 JX |
185 | |
186 | /* kernel thread to upgrade this dataset */ | |
187 | kmutex_t os_upgrade_lock; | |
188 | taskqid_t os_upgrade_id; | |
189 | dmu_objset_upgrade_cb_t os_upgrade_cb; | |
190 | boolean_t os_upgrade_exit; | |
191 | int os_upgrade_status; | |
428870ff BB |
192 | }; |
193 | ||
194 | #define DMU_META_OBJSET 0 | |
34dc7c2f | 195 | #define DMU_META_DNODE_OBJECT 0 |
9babb374 | 196 | #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0) |
572e2857 BB |
197 | #define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode) |
198 | #define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode) | |
199 | #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode) | |
9c5167d1 | 200 | #define DMU_PROJECTUSED_DNODE(os) ((os)->os_projectused_dnode.dnh_dnode) |
34dc7c2f | 201 | |
b128c09f BB |
202 | #define DMU_OS_IS_L2CACHEABLE(os) \ |
203 | ((os)->os_secondary_cache == ZFS_CACHE_ALL || \ | |
204 | (os)->os_secondary_cache == ZFS_CACHE_METADATA) | |
205 | ||
34dc7c2f | 206 | /* called from zpl */ |
428870ff | 207 | int dmu_objset_hold(const char *name, void *tag, objset_t **osp); |
b5256303 TC |
208 | int dmu_objset_hold_flags(const char *name, boolean_t decrypt, void *tag, |
209 | objset_t **osp); | |
428870ff | 210 | int dmu_objset_own(const char *name, dmu_objset_type_t type, |
b5256303 | 211 | boolean_t readonly, boolean_t decrypt, void *tag, objset_t **osp); |
9c43027b | 212 | int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj, |
b5256303 TC |
213 | dmu_objset_type_t type, boolean_t readonly, boolean_t decrypt, |
214 | void *tag, objset_t **osp); | |
5e00213e AG |
215 | void dmu_objset_refresh_ownership(struct dsl_dataset *ds, |
216 | struct dsl_dataset **newds, boolean_t decrypt, void *tag); | |
428870ff | 217 | void dmu_objset_rele(objset_t *os, void *tag); |
b5256303 TC |
218 | void dmu_objset_rele_flags(objset_t *os, boolean_t decrypt, void *tag); |
219 | void dmu_objset_disown(objset_t *os, boolean_t decrypt, void *tag); | |
428870ff BB |
220 | int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp); |
221 | ||
34dc7c2f BB |
222 | void dmu_objset_stats(objset_t *os, nvlist_t *nv); |
223 | void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat); | |
224 | void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp, | |
225 | uint64_t *usedobjsp, uint64_t *availobjsp); | |
226 | uint64_t dmu_objset_fsid_guid(objset_t *os); | |
13fe0198 MA |
227 | int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj, |
228 | int func(struct dsl_pool *, struct dsl_dataset *, void *), | |
229 | void *arg, int flags); | |
230 | void dmu_objset_evict_dbufs(objset_t *os); | |
6413c95f | 231 | inode_timespec_t dmu_objset_snap_cmtime(objset_t *os); |
34dc7c2f BB |
232 | |
233 | /* called from dsl */ | |
428870ff BB |
234 | void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx); |
235 | boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg); | |
b5256303 TC |
236 | objset_t *dmu_objset_create_impl_dnstats(spa_t *spa, struct dsl_dataset *ds, |
237 | blkptr_t *bp, dmu_objset_type_t type, int levels, int blksz, int ibs, | |
238 | dmu_tx_t *tx); | |
428870ff | 239 | objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds, |
34dc7c2f BB |
240 | blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx); |
241 | int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp, | |
428870ff BB |
242 | objset_t **osp); |
243 | void dmu_objset_evict(objset_t *os); | |
244 | void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx); | |
245 | void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx); | |
246 | boolean_t dmu_objset_userused_enabled(objset_t *os); | |
9babb374 BB |
247 | int dmu_objset_userspace_upgrade(objset_t *os); |
248 | boolean_t dmu_objset_userspace_present(objset_t *os); | |
1de321e6 | 249 | boolean_t dmu_objset_userobjused_enabled(objset_t *os); |
126ae9f4 | 250 | boolean_t dmu_objset_userobjspace_upgradable(objset_t *os); |
1de321e6 | 251 | boolean_t dmu_objset_userobjspace_present(objset_t *os); |
ae76f45c | 252 | boolean_t dmu_objset_incompatible_encryption_version(objset_t *os); |
9c5167d1 NF |
253 | boolean_t dmu_objset_projectquota_enabled(objset_t *os); |
254 | boolean_t dmu_objset_projectquota_present(objset_t *os); | |
255 | boolean_t dmu_objset_projectquota_upgradable(objset_t *os); | |
256 | void dmu_objset_id_quota_upgrade(objset_t *os); | |
1de321e6 | 257 | |
13fe0198 | 258 | int dmu_fsname(const char *snapname, char *buf); |
34dc7c2f | 259 | |
0c66c32d | 260 | void dmu_objset_evict_done(objset_t *os); |
3ec3bc21 | 261 | void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx); |
0c66c32d | 262 | |
572e2857 BB |
263 | void dmu_objset_init(void); |
264 | void dmu_objset_fini(void); | |
265 | ||
34dc7c2f BB |
266 | #ifdef __cplusplus |
267 | } | |
268 | #endif | |
269 | ||
270 | #endif /* _SYS_DMU_OBJSET_H */ |