]>
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. |
9ae529ec | 23 | * Copyright (c) 2012 by Delphix. All rights reserved. |
37abac6d | 24 | * Copyright (c) 2012, Joyent, Inc. All rights reserved. |
34dc7c2f BB |
25 | */ |
26 | ||
428870ff BB |
27 | /* Portions Copyright 2010 Robert Milkowski */ |
28 | ||
34dc7c2f BB |
29 | #ifndef _SYS_DMU_H |
30 | #define _SYS_DMU_H | |
31 | ||
34dc7c2f BB |
32 | /* |
33 | * This file describes the interface that the DMU provides for its | |
34 | * consumers. | |
35 | * | |
36 | * The DMU also interacts with the SPA. That interface is described in | |
37 | * dmu_spa.h. | |
38 | */ | |
39 | ||
40 | #include <sys/inttypes.h> | |
41 | #include <sys/types.h> | |
42 | #include <sys/param.h> | |
43 | #include <sys/cred.h> | |
428870ff | 44 | #include <sys/time.h> |
59e6e7ca | 45 | #include <sys/uio.h> |
34dc7c2f BB |
46 | |
47 | #ifdef __cplusplus | |
48 | extern "C" { | |
49 | #endif | |
50 | ||
34dc7c2f BB |
51 | struct page; |
52 | struct vnode; | |
53 | struct spa; | |
54 | struct zilog; | |
55 | struct zio; | |
56 | struct blkptr; | |
57 | struct zap_cursor; | |
58 | struct dsl_dataset; | |
59 | struct dsl_pool; | |
60 | struct dnode; | |
61 | struct drr_begin; | |
62 | struct drr_end; | |
63 | struct zbookmark; | |
64 | struct spa; | |
65 | struct nvlist; | |
9babb374 | 66 | struct arc_buf; |
428870ff BB |
67 | struct zio_prop; |
68 | struct sa_handle; | |
34dc7c2f BB |
69 | |
70 | typedef struct objset objset_t; | |
71 | typedef struct dmu_tx dmu_tx_t; | |
72 | typedef struct dsl_dir dsl_dir_t; | |
73 | ||
9ae529ec CS |
74 | typedef enum dmu_object_byteswap { |
75 | DMU_BSWAP_UINT8, | |
76 | DMU_BSWAP_UINT16, | |
77 | DMU_BSWAP_UINT32, | |
78 | DMU_BSWAP_UINT64, | |
79 | DMU_BSWAP_ZAP, | |
80 | DMU_BSWAP_DNODE, | |
81 | DMU_BSWAP_OBJSET, | |
82 | DMU_BSWAP_ZNODE, | |
83 | DMU_BSWAP_OLDACL, | |
84 | DMU_BSWAP_ACL, | |
85 | /* | |
86 | * Allocating a new byteswap type number makes the on-disk format | |
87 | * incompatible with any other format that uses the same number. | |
88 | * | |
89 | * Data can usually be structured to work with one of the | |
90 | * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types. | |
91 | */ | |
92 | DMU_BSWAP_NUMFUNCS | |
93 | } dmu_object_byteswap_t; | |
94 | ||
95 | #define DMU_OT_NEWTYPE 0x80 | |
96 | #define DMU_OT_METADATA 0x40 | |
97 | #define DMU_OT_BYTESWAP_MASK 0x3f | |
98 | ||
99 | /* | |
100 | * Defines a uint8_t object type. Object types specify if the data | |
101 | * in the object is metadata (boolean) and how to byteswap the data | |
102 | * (dmu_object_byteswap_t). | |
103 | */ | |
104 | #define DMU_OT(byteswap, metadata) \ | |
105 | (DMU_OT_NEWTYPE | \ | |
106 | ((metadata) ? DMU_OT_METADATA : 0) | \ | |
107 | ((byteswap) & DMU_OT_BYTESWAP_MASK)) | |
108 | ||
109 | #define DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \ | |
110 | ((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \ | |
111 | (ot) < DMU_OT_NUMTYPES) | |
112 | ||
113 | #define DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \ | |
114 | ((ot) & DMU_OT_METADATA) : \ | |
115 | dmu_ot[(int)(ot)].ot_metadata) | |
116 | ||
117 | #define DMU_OT_BYTESWAP(ot) (((ot) & DMU_OT_NEWTYPE) ? \ | |
118 | ((ot) & DMU_OT_BYTESWAP_MASK) : \ | |
119 | dmu_ot[(int)(ot)].ot_byteswap) | |
120 | ||
34dc7c2f BB |
121 | typedef enum dmu_object_type { |
122 | DMU_OT_NONE, | |
123 | /* general: */ | |
124 | DMU_OT_OBJECT_DIRECTORY, /* ZAP */ | |
125 | DMU_OT_OBJECT_ARRAY, /* UINT64 */ | |
126 | DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */ | |
127 | DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */ | |
428870ff BB |
128 | DMU_OT_BPOBJ, /* UINT64 */ |
129 | DMU_OT_BPOBJ_HDR, /* UINT64 */ | |
34dc7c2f BB |
130 | /* spa: */ |
131 | DMU_OT_SPACE_MAP_HEADER, /* UINT64 */ | |
132 | DMU_OT_SPACE_MAP, /* UINT64 */ | |
133 | /* zil: */ | |
134 | DMU_OT_INTENT_LOG, /* UINT64 */ | |
135 | /* dmu: */ | |
136 | DMU_OT_DNODE, /* DNODE */ | |
137 | DMU_OT_OBJSET, /* OBJSET */ | |
138 | /* dsl: */ | |
139 | DMU_OT_DSL_DIR, /* UINT64 */ | |
140 | DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */ | |
141 | DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */ | |
142 | DMU_OT_DSL_PROPS, /* ZAP */ | |
143 | DMU_OT_DSL_DATASET, /* UINT64 */ | |
144 | /* zpl: */ | |
145 | DMU_OT_ZNODE, /* ZNODE */ | |
146 | DMU_OT_OLDACL, /* Old ACL */ | |
147 | DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */ | |
148 | DMU_OT_DIRECTORY_CONTENTS, /* ZAP */ | |
149 | DMU_OT_MASTER_NODE, /* ZAP */ | |
150 | DMU_OT_UNLINKED_SET, /* ZAP */ | |
151 | /* zvol: */ | |
152 | DMU_OT_ZVOL, /* UINT8 */ | |
153 | DMU_OT_ZVOL_PROP, /* ZAP */ | |
154 | /* other; for testing only! */ | |
155 | DMU_OT_PLAIN_OTHER, /* UINT8 */ | |
156 | DMU_OT_UINT64_OTHER, /* UINT64 */ | |
157 | DMU_OT_ZAP_OTHER, /* ZAP */ | |
158 | /* new object types: */ | |
159 | DMU_OT_ERROR_LOG, /* ZAP */ | |
160 | DMU_OT_SPA_HISTORY, /* UINT8 */ | |
161 | DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */ | |
162 | DMU_OT_POOL_PROPS, /* ZAP */ | |
163 | DMU_OT_DSL_PERMS, /* ZAP */ | |
164 | DMU_OT_ACL, /* ACL */ | |
165 | DMU_OT_SYSACL, /* SYSACL */ | |
166 | DMU_OT_FUID, /* FUID table (Packed NVLIST UINT8) */ | |
167 | DMU_OT_FUID_SIZE, /* FUID table size UINT64 */ | |
b128c09f | 168 | DMU_OT_NEXT_CLONES, /* ZAP */ |
428870ff | 169 | DMU_OT_SCAN_QUEUE, /* ZAP */ |
9babb374 BB |
170 | DMU_OT_USERGROUP_USED, /* ZAP */ |
171 | DMU_OT_USERGROUP_QUOTA, /* ZAP */ | |
45d1cae3 | 172 | DMU_OT_USERREFS, /* ZAP */ |
428870ff BB |
173 | DMU_OT_DDT_ZAP, /* ZAP */ |
174 | DMU_OT_DDT_STATS, /* ZAP */ | |
175 | DMU_OT_SA, /* System attr */ | |
176 | DMU_OT_SA_MASTER_NODE, /* ZAP */ | |
177 | DMU_OT_SA_ATTR_REGISTRATION, /* ZAP */ | |
178 | DMU_OT_SA_ATTR_LAYOUTS, /* ZAP */ | |
179 | DMU_OT_SCAN_XLATE, /* ZAP */ | |
180 | DMU_OT_DEDUP, /* fake dedup BP from ddt_bp_create() */ | |
181 | DMU_OT_DEADLIST, /* ZAP */ | |
182 | DMU_OT_DEADLIST_HDR, /* UINT64 */ | |
183 | DMU_OT_DSL_CLONES, /* ZAP */ | |
184 | DMU_OT_BPOBJ_SUBOBJ, /* UINT64 */ | |
9ae529ec CS |
185 | /* |
186 | * Do not allocate new object types here. Doing so makes the on-disk | |
187 | * format incompatible with any other format that uses the same object | |
188 | * type number. | |
189 | * | |
190 | * When creating an object which does not have one of the above types | |
191 | * use the DMU_OTN_* type with the correct byteswap and metadata | |
192 | * values. | |
193 | * | |
194 | * The DMU_OTN_* types do not have entries in the dmu_ot table, | |
195 | * use the DMU_OT_IS_METDATA() and DMU_OT_BYTESWAP() macros instead | |
196 | * of indexing into dmu_ot directly (this works for both DMU_OT_* types | |
197 | * and DMU_OTN_* types). | |
198 | */ | |
199 | DMU_OT_NUMTYPES, | |
200 | ||
201 | /* | |
202 | * Names for valid types declared with DMU_OT(). | |
203 | */ | |
204 | DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE), | |
205 | DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE), | |
206 | DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE), | |
207 | DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE), | |
208 | DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE), | |
209 | DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE), | |
210 | DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE), | |
211 | DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE), | |
212 | DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE), | |
213 | DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE), | |
34dc7c2f BB |
214 | } dmu_object_type_t; |
215 | ||
216 | typedef enum dmu_objset_type { | |
217 | DMU_OST_NONE, | |
218 | DMU_OST_META, | |
219 | DMU_OST_ZFS, | |
220 | DMU_OST_ZVOL, | |
221 | DMU_OST_OTHER, /* For testing only! */ | |
222 | DMU_OST_ANY, /* Be careful! */ | |
223 | DMU_OST_NUMTYPES | |
224 | } dmu_objset_type_t; | |
225 | ||
226 | void byteswap_uint64_array(void *buf, size_t size); | |
227 | void byteswap_uint32_array(void *buf, size_t size); | |
228 | void byteswap_uint16_array(void *buf, size_t size); | |
229 | void byteswap_uint8_array(void *buf, size_t size); | |
230 | void zap_byteswap(void *buf, size_t size); | |
231 | void zfs_oldacl_byteswap(void *buf, size_t size); | |
232 | void zfs_acl_byteswap(void *buf, size_t size); | |
233 | void zfs_znode_byteswap(void *buf, size_t size); | |
234 | ||
34dc7c2f BB |
235 | #define DS_FIND_SNAPSHOTS (1<<0) |
236 | #define DS_FIND_CHILDREN (1<<1) | |
237 | ||
238 | /* | |
239 | * The maximum number of bytes that can be accessed as part of one | |
240 | * operation, including metadata. | |
241 | */ | |
242 | #define DMU_MAX_ACCESS (10<<20) /* 10MB */ | |
b128c09f | 243 | #define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */ |
34dc7c2f | 244 | |
9babb374 BB |
245 | #define DMU_USERUSED_OBJECT (-1ULL) |
246 | #define DMU_GROUPUSED_OBJECT (-2ULL) | |
428870ff | 247 | #define DMU_DEADLIST_OBJECT (-3ULL) |
9babb374 | 248 | |
428870ff BB |
249 | /* |
250 | * artificial blkids for bonus buffer and spill blocks | |
251 | */ | |
252 | #define DMU_BONUS_BLKID (-1ULL) | |
253 | #define DMU_SPILL_BLKID (-2ULL) | |
34dc7c2f BB |
254 | /* |
255 | * Public routines to create, destroy, open, and close objsets. | |
256 | */ | |
428870ff BB |
257 | int dmu_objset_hold(const char *name, void *tag, objset_t **osp); |
258 | int dmu_objset_own(const char *name, dmu_objset_type_t type, | |
259 | boolean_t readonly, void *tag, objset_t **osp); | |
260 | void dmu_objset_rele(objset_t *os, void *tag); | |
261 | void dmu_objset_disown(objset_t *os, void *tag); | |
262 | int dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp); | |
263 | ||
34dc7c2f | 264 | int dmu_objset_evict_dbufs(objset_t *os); |
428870ff | 265 | int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags, |
34dc7c2f | 266 | void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg); |
428870ff BB |
267 | int dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin, |
268 | uint64_t flags); | |
45d1cae3 | 269 | int dmu_objset_destroy(const char *name, boolean_t defer); |
330d06f9 | 270 | int dmu_snapshots_destroy_nvl(struct nvlist *snaps, boolean_t defer, char *); |
572e2857 BB |
271 | int dmu_objset_snapshot(char *fsname, char *snapname, char *tag, |
272 | struct nvlist *props, boolean_t recursive, boolean_t temporary, int fd); | |
34dc7c2f BB |
273 | int dmu_objset_rename(const char *name, const char *newname, |
274 | boolean_t recursive); | |
428870ff | 275 | int dmu_objset_find(char *name, int func(const char *, void *), void *arg, |
34dc7c2f BB |
276 | int flags); |
277 | void dmu_objset_byteswap(void *buf, size_t size); | |
278 | ||
279 | typedef struct dmu_buf { | |
280 | uint64_t db_object; /* object that this buffer is part of */ | |
281 | uint64_t db_offset; /* byte offset in this object */ | |
282 | uint64_t db_size; /* size of buffer in bytes */ | |
283 | void *db_data; /* data in buffer */ | |
284 | } dmu_buf_t; | |
285 | ||
286 | typedef void dmu_buf_evict_func_t(struct dmu_buf *db, void *user_ptr); | |
287 | ||
288 | /* | |
289 | * The names of zap entries in the DIRECTORY_OBJECT of the MOS. | |
290 | */ | |
291 | #define DMU_POOL_DIRECTORY_OBJECT 1 | |
292 | #define DMU_POOL_CONFIG "config" | |
9ae529ec CS |
293 | #define DMU_POOL_FEATURES_FOR_WRITE "features_for_write" |
294 | #define DMU_POOL_FEATURES_FOR_READ "features_for_read" | |
295 | #define DMU_POOL_FEATURE_DESCRIPTIONS "feature_descriptions" | |
34dc7c2f | 296 | #define DMU_POOL_ROOT_DATASET "root_dataset" |
428870ff | 297 | #define DMU_POOL_SYNC_BPOBJ "sync_bplist" |
34dc7c2f BB |
298 | #define DMU_POOL_ERRLOG_SCRUB "errlog_scrub" |
299 | #define DMU_POOL_ERRLOG_LAST "errlog_last" | |
300 | #define DMU_POOL_SPARES "spares" | |
301 | #define DMU_POOL_DEFLATE "deflate" | |
302 | #define DMU_POOL_HISTORY "history" | |
303 | #define DMU_POOL_PROPS "pool_props" | |
304 | #define DMU_POOL_L2CACHE "l2cache" | |
428870ff BB |
305 | #define DMU_POOL_TMP_USERREFS "tmp_userrefs" |
306 | #define DMU_POOL_DDT "DDT-%s-%s-%s" | |
307 | #define DMU_POOL_DDT_STATS "DDT-statistics" | |
308 | #define DMU_POOL_CREATION_VERSION "creation_version" | |
309 | #define DMU_POOL_SCAN "scan" | |
310 | #define DMU_POOL_FREE_BPOBJ "free_bpobj" | |
9ae529ec | 311 | #define DMU_POOL_BPTREE_OBJ "bptree_obj" |
b128c09f | 312 | |
34dc7c2f BB |
313 | /* |
314 | * Allocate an object from this objset. The range of object numbers | |
315 | * available is (0, DN_MAX_OBJECT). Object 0 is the meta-dnode. | |
316 | * | |
317 | * The transaction must be assigned to a txg. The newly allocated | |
318 | * object will be "held" in the transaction (ie. you can modify the | |
319 | * newly allocated object in this transaction). | |
320 | * | |
321 | * dmu_object_alloc() chooses an object and returns it in *objectp. | |
322 | * | |
323 | * dmu_object_claim() allocates a specific object number. If that | |
324 | * number is already allocated, it fails and returns EEXIST. | |
325 | * | |
326 | * Return 0 on success, or ENOSPC or EEXIST as specified above. | |
327 | */ | |
328 | uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot, | |
329 | int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx); | |
330 | int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot, | |
331 | int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx); | |
332 | int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot, | |
9babb374 | 333 | int blocksize, dmu_object_type_t bonustype, int bonuslen); |
34dc7c2f BB |
334 | |
335 | /* | |
336 | * Free an object from this objset. | |
337 | * | |
338 | * The object's data will be freed as well (ie. you don't need to call | |
339 | * dmu_free(object, 0, -1, tx)). | |
340 | * | |
341 | * The object need not be held in the transaction. | |
342 | * | |
343 | * If there are any holds on this object's buffers (via dmu_buf_hold()), | |
344 | * or tx holds on the object (via dmu_tx_hold_object()), you can not | |
345 | * free it; it fails and returns EBUSY. | |
346 | * | |
347 | * If the object is not allocated, it fails and returns ENOENT. | |
348 | * | |
349 | * Return 0 on success, or EBUSY or ENOENT as specified above. | |
350 | */ | |
351 | int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx); | |
352 | ||
353 | /* | |
354 | * Find the next allocated or free object. | |
355 | * | |
356 | * The objectp parameter is in-out. It will be updated to be the next | |
357 | * object which is allocated. Ignore objects which have not been | |
358 | * modified since txg. | |
359 | * | |
360 | * XXX Can only be called on a objset with no dirty data. | |
361 | * | |
362 | * Returns 0 on success, or ENOENT if there are no more objects. | |
363 | */ | |
364 | int dmu_object_next(objset_t *os, uint64_t *objectp, | |
365 | boolean_t hole, uint64_t txg); | |
366 | ||
367 | /* | |
368 | * Set the data blocksize for an object. | |
369 | * | |
370 | * The object cannot have any blocks allcated beyond the first. If | |
371 | * the first block is allocated already, the new size must be greater | |
372 | * than the current block size. If these conditions are not met, | |
373 | * ENOTSUP will be returned. | |
374 | * | |
375 | * Returns 0 on success, or EBUSY if there are any holds on the object | |
376 | * contents, or ENOTSUP as described above. | |
377 | */ | |
378 | int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size, | |
379 | int ibs, dmu_tx_t *tx); | |
380 | ||
381 | /* | |
382 | * Set the checksum property on a dnode. The new checksum algorithm will | |
383 | * apply to all newly written blocks; existing blocks will not be affected. | |
384 | */ | |
385 | void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum, | |
386 | dmu_tx_t *tx); | |
387 | ||
388 | /* | |
389 | * Set the compress property on a dnode. The new compression algorithm will | |
390 | * apply to all newly written blocks; existing blocks will not be affected. | |
391 | */ | |
392 | void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress, | |
393 | dmu_tx_t *tx); | |
394 | ||
395 | /* | |
428870ff | 396 | * Decide how to write a block: checksum, compression, number of copies, etc. |
34dc7c2f | 397 | */ |
428870ff BB |
398 | #define WP_NOFILL 0x1 |
399 | #define WP_DMU_SYNC 0x2 | |
400 | #define WP_SPILL 0x4 | |
401 | ||
402 | void dmu_write_policy(objset_t *os, struct dnode *dn, int level, int wp, | |
403 | struct zio_prop *zp); | |
34dc7c2f BB |
404 | /* |
405 | * The bonus data is accessed more or less like a regular buffer. | |
406 | * You must dmu_bonus_hold() to get the buffer, which will give you a | |
407 | * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus | |
408 | * data. As with any normal buffer, you must call dmu_buf_read() to | |
409 | * read db_data, dmu_buf_will_dirty() before modifying it, and the | |
410 | * object must be held in an assigned transaction before calling | |
411 | * dmu_buf_will_dirty. You may use dmu_buf_set_user() on the bonus | |
412 | * buffer as well. You must release your hold with dmu_buf_rele(). | |
413 | */ | |
414 | int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **); | |
415 | int dmu_bonus_max(void); | |
416 | int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *); | |
428870ff | 417 | int dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *); |
572e2857 | 418 | dmu_object_type_t dmu_get_bonustype(dmu_buf_t *); |
428870ff BB |
419 | int dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *); |
420 | ||
421 | /* | |
422 | * Special spill buffer support used by "SA" framework | |
423 | */ | |
424 | ||
425 | int dmu_spill_hold_by_bonus(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp); | |
426 | int dmu_spill_hold_by_dnode(struct dnode *dn, uint32_t flags, | |
427 | void *tag, dmu_buf_t **dbp); | |
428 | int dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp); | |
34dc7c2f BB |
429 | |
430 | /* | |
431 | * Obtain the DMU buffer from the specified object which contains the | |
432 | * specified offset. dmu_buf_hold() puts a "hold" on the buffer, so | |
433 | * that it will remain in memory. You must release the hold with | |
434 | * dmu_buf_rele(). You musn't access the dmu_buf_t after releasing your | |
435 | * hold. You must have a hold on any dmu_buf_t* you pass to the DMU. | |
436 | * | |
437 | * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill | |
438 | * on the returned buffer before reading or writing the buffer's | |
439 | * db_data. The comments for those routines describe what particular | |
440 | * operations are valid after calling them. | |
441 | * | |
442 | * The object number must be a valid, allocated object number. | |
443 | */ | |
444 | int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset, | |
428870ff | 445 | void *tag, dmu_buf_t **, int flags); |
34dc7c2f BB |
446 | void dmu_buf_add_ref(dmu_buf_t *db, void* tag); |
447 | void dmu_buf_rele(dmu_buf_t *db, void *tag); | |
448 | uint64_t dmu_buf_refcount(dmu_buf_t *db); | |
449 | ||
450 | /* | |
451 | * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a | |
452 | * range of an object. A pointer to an array of dmu_buf_t*'s is | |
453 | * returned (in *dbpp). | |
454 | * | |
455 | * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and | |
456 | * frees the array. The hold on the array of buffers MUST be released | |
457 | * with dmu_buf_rele_array. You can NOT release the hold on each buffer | |
458 | * individually with dmu_buf_rele. | |
459 | */ | |
460 | int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset, | |
461 | uint64_t length, int read, void *tag, int *numbufsp, dmu_buf_t ***dbpp); | |
462 | void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag); | |
463 | ||
464 | /* | |
465 | * Returns NULL on success, or the existing user ptr if it's already | |
466 | * been set. | |
467 | * | |
468 | * user_ptr is for use by the user and can be obtained via dmu_buf_get_user(). | |
469 | * | |
470 | * user_data_ptr_ptr should be NULL, or a pointer to a pointer which | |
471 | * will be set to db->db_data when you are allowed to access it. Note | |
472 | * that db->db_data (the pointer) can change when you do dmu_buf_read(), | |
473 | * dmu_buf_tryupgrade(), dmu_buf_will_dirty(), or dmu_buf_will_fill(). | |
474 | * *user_data_ptr_ptr will be set to the new value when it changes. | |
475 | * | |
476 | * If non-NULL, pageout func will be called when this buffer is being | |
477 | * excised from the cache, so that you can clean up the data structure | |
478 | * pointed to by user_ptr. | |
479 | * | |
480 | * dmu_evict_user() will call the pageout func for all buffers in a | |
481 | * objset with a given pageout func. | |
482 | */ | |
483 | void *dmu_buf_set_user(dmu_buf_t *db, void *user_ptr, void *user_data_ptr_ptr, | |
484 | dmu_buf_evict_func_t *pageout_func); | |
485 | /* | |
486 | * set_user_ie is the same as set_user, but request immediate eviction | |
487 | * when hold count goes to zero. | |
488 | */ | |
489 | void *dmu_buf_set_user_ie(dmu_buf_t *db, void *user_ptr, | |
490 | void *user_data_ptr_ptr, dmu_buf_evict_func_t *pageout_func); | |
491 | void *dmu_buf_update_user(dmu_buf_t *db_fake, void *old_user_ptr, | |
492 | void *user_ptr, void *user_data_ptr_ptr, | |
493 | dmu_buf_evict_func_t *pageout_func); | |
494 | void dmu_evict_user(objset_t *os, dmu_buf_evict_func_t *func); | |
495 | ||
496 | /* | |
497 | * Returns the user_ptr set with dmu_buf_set_user(), or NULL if not set. | |
498 | */ | |
499 | void *dmu_buf_get_user(dmu_buf_t *db); | |
500 | ||
501 | /* | |
502 | * Indicate that you are going to modify the buffer's data (db_data). | |
503 | * | |
504 | * The transaction (tx) must be assigned to a txg (ie. you've called | |
505 | * dmu_tx_assign()). The buffer's object must be held in the tx | |
506 | * (ie. you've called dmu_tx_hold_object(tx, db->db_object)). | |
507 | */ | |
508 | void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx); | |
509 | ||
9babb374 BB |
510 | /* |
511 | * Tells if the given dbuf is freeable. | |
512 | */ | |
513 | boolean_t dmu_buf_freeable(dmu_buf_t *); | |
514 | ||
34dc7c2f BB |
515 | /* |
516 | * You must create a transaction, then hold the objects which you will | |
517 | * (or might) modify as part of this transaction. Then you must assign | |
518 | * the transaction to a transaction group. Once the transaction has | |
519 | * been assigned, you can modify buffers which belong to held objects as | |
520 | * part of this transaction. You can't modify buffers before the | |
521 | * transaction has been assigned; you can't modify buffers which don't | |
522 | * belong to objects which this transaction holds; you can't hold | |
523 | * objects once the transaction has been assigned. You may hold an | |
524 | * object which you are going to free (with dmu_object_free()), but you | |
525 | * don't have to. | |
526 | * | |
527 | * You can abort the transaction before it has been assigned. | |
528 | * | |
529 | * Note that you may hold buffers (with dmu_buf_hold) at any time, | |
530 | * regardless of transaction state. | |
531 | */ | |
532 | ||
533 | #define DMU_NEW_OBJECT (-1ULL) | |
534 | #define DMU_OBJECT_END (-1ULL) | |
535 | ||
536 | dmu_tx_t *dmu_tx_create(objset_t *os); | |
537 | void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len); | |
538 | void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off, | |
539 | uint64_t len); | |
9babb374 | 540 | void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name); |
34dc7c2f | 541 | void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object); |
428870ff BB |
542 | void dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object); |
543 | void dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow); | |
544 | void dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size); | |
34dc7c2f BB |
545 | void dmu_tx_abort(dmu_tx_t *tx); |
546 | int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how); | |
547 | void dmu_tx_wait(dmu_tx_t *tx); | |
548 | void dmu_tx_commit(dmu_tx_t *tx); | |
549 | ||
428870ff BB |
550 | /* |
551 | * To register a commit callback, dmu_tx_callback_register() must be called. | |
552 | * | |
553 | * dcb_data is a pointer to caller private data that is passed on as a | |
554 | * callback parameter. The caller is responsible for properly allocating and | |
555 | * freeing it. | |
556 | * | |
557 | * When registering a callback, the transaction must be already created, but | |
558 | * it cannot be committed or aborted. It can be assigned to a txg or not. | |
559 | * | |
560 | * The callback will be called after the transaction has been safely written | |
561 | * to stable storage and will also be called if the dmu_tx is aborted. | |
562 | * If there is any error which prevents the transaction from being committed to | |
563 | * disk, the callback will be called with a value of error != 0. | |
564 | */ | |
565 | typedef void dmu_tx_callback_func_t(void *dcb_data, int error); | |
566 | ||
567 | void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func, | |
568 | void *dcb_data); | |
569 | ||
34dc7c2f BB |
570 | /* |
571 | * Free up the data blocks for a defined range of a file. If size is | |
9ae529ec | 572 | * -1, the range from offset to end-of-file is freed. |
34dc7c2f BB |
573 | */ |
574 | int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset, | |
575 | uint64_t size, dmu_tx_t *tx); | |
b128c09f BB |
576 | int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset, |
577 | uint64_t size); | |
578 | int dmu_free_object(objset_t *os, uint64_t object); | |
34dc7c2f BB |
579 | |
580 | /* | |
581 | * Convenience functions. | |
582 | * | |
583 | * Canfail routines will return 0 on success, or an errno if there is a | |
584 | * nonrecoverable I/O error. | |
585 | */ | |
9babb374 BB |
586 | #define DMU_READ_PREFETCH 0 /* prefetch */ |
587 | #define DMU_READ_NO_PREFETCH 1 /* don't prefetch */ | |
34dc7c2f | 588 | int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, |
9babb374 | 589 | void *buf, uint32_t flags); |
34dc7c2f BB |
590 | void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, |
591 | const void *buf, dmu_tx_t *tx); | |
b128c09f BB |
592 | void dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, |
593 | dmu_tx_t *tx); | |
60101509 | 594 | #ifdef _KERNEL |
61e90960 | 595 | #include <linux/blkdev_compat.h> |
60101509 | 596 | int dmu_read_req(objset_t *os, uint64_t object, struct request *req); |
872e8d26 BB |
597 | int dmu_write_req(objset_t *os, uint64_t object, struct request *req, |
598 | dmu_tx_t *tx); | |
599 | int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size); | |
600 | int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size, | |
601 | dmu_tx_t *tx); | |
602 | int dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size, | |
603 | dmu_tx_t *tx); | |
872e8d26 | 604 | #endif |
9babb374 BB |
605 | struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size); |
606 | void dmu_return_arcbuf(struct arc_buf *buf); | |
607 | void dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf, | |
608 | dmu_tx_t *tx); | |
428870ff BB |
609 | int dmu_xuio_init(struct xuio *uio, int niov); |
610 | void dmu_xuio_fini(struct xuio *uio); | |
611 | int dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off, | |
612 | size_t n); | |
613 | int dmu_xuio_cnt(struct xuio *uio); | |
614 | struct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i); | |
615 | void dmu_xuio_clear(struct xuio *uio, int i); | |
0bc8fd78 BB |
616 | void xuio_stat_wbuf_copied(void); |
617 | void xuio_stat_wbuf_nocopy(void); | |
34dc7c2f BB |
618 | |
619 | extern int zfs_prefetch_disable; | |
620 | ||
621 | /* | |
622 | * Asynchronously try to read in the data. | |
623 | */ | |
624 | void dmu_prefetch(objset_t *os, uint64_t object, uint64_t offset, | |
625 | uint64_t len); | |
626 | ||
627 | typedef struct dmu_object_info { | |
428870ff | 628 | /* All sizes are in bytes unless otherwise indicated. */ |
34dc7c2f BB |
629 | uint32_t doi_data_block_size; |
630 | uint32_t doi_metadata_block_size; | |
34dc7c2f BB |
631 | dmu_object_type_t doi_type; |
632 | dmu_object_type_t doi_bonus_type; | |
428870ff | 633 | uint64_t doi_bonus_size; |
34dc7c2f BB |
634 | uint8_t doi_indirection; /* 2 = dnode->indirect->data */ |
635 | uint8_t doi_checksum; | |
636 | uint8_t doi_compress; | |
637 | uint8_t doi_pad[5]; | |
428870ff BB |
638 | uint64_t doi_physical_blocks_512; /* data + metadata, 512b blks */ |
639 | uint64_t doi_max_offset; | |
640 | uint64_t doi_fill_count; /* number of non-empty blocks */ | |
34dc7c2f BB |
641 | } dmu_object_info_t; |
642 | ||
643 | typedef void arc_byteswap_func_t(void *buf, size_t size); | |
644 | ||
645 | typedef struct dmu_object_type_info { | |
9ae529ec | 646 | dmu_object_byteswap_t ot_byteswap; |
34dc7c2f BB |
647 | boolean_t ot_metadata; |
648 | char *ot_name; | |
649 | } dmu_object_type_info_t; | |
650 | ||
9ae529ec CS |
651 | typedef struct dmu_object_byteswap_info { |
652 | arc_byteswap_func_t *ob_func; | |
653 | char *ob_name; | |
654 | } dmu_object_byteswap_info_t; | |
655 | ||
34dc7c2f | 656 | extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES]; |
9ae529ec | 657 | extern const dmu_object_byteswap_info_t dmu_ot_byteswap[DMU_BSWAP_NUMFUNCS]; |
34dc7c2f BB |
658 | |
659 | /* | |
660 | * Get information on a DMU object. | |
661 | * | |
662 | * Return 0 on success or ENOENT if object is not allocated. | |
663 | * | |
664 | * If doi is NULL, just indicates whether the object exists. | |
665 | */ | |
666 | int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi); | |
667 | void dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi); | |
668 | void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi); | |
669 | void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize, | |
670 | u_longlong_t *nblk512); | |
671 | ||
672 | typedef struct dmu_objset_stats { | |
673 | uint64_t dds_num_clones; /* number of clones of this */ | |
674 | uint64_t dds_creation_txg; | |
675 | uint64_t dds_guid; | |
676 | dmu_objset_type_t dds_type; | |
677 | uint8_t dds_is_snapshot; | |
678 | uint8_t dds_inconsistent; | |
679 | char dds_origin[MAXNAMELEN]; | |
680 | } dmu_objset_stats_t; | |
681 | ||
682 | /* | |
683 | * Get stats on a dataset. | |
684 | */ | |
685 | void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat); | |
686 | ||
687 | /* | |
688 | * Add entries to the nvlist for all the objset's properties. See | |
689 | * zfs_prop_table[] and zfs(1m) for details on the properties. | |
690 | */ | |
691 | void dmu_objset_stats(objset_t *os, struct nvlist *nv); | |
692 | ||
693 | /* | |
694 | * Get the space usage statistics for statvfs(). | |
695 | * | |
696 | * refdbytes is the amount of space "referenced" by this objset. | |
697 | * availbytes is the amount of space available to this objset, taking | |
698 | * into account quotas & reservations, assuming that no other objsets | |
699 | * use the space first. These values correspond to the 'referenced' and | |
700 | * 'available' properties, described in the zfs(1m) manpage. | |
701 | * | |
702 | * usedobjs and availobjs are the number of objects currently allocated, | |
703 | * and available. | |
704 | */ | |
705 | void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp, | |
706 | uint64_t *usedobjsp, uint64_t *availobjsp); | |
707 | ||
708 | /* | |
709 | * The fsid_guid is a 56-bit ID that can change to avoid collisions. | |
710 | * (Contrast with the ds_guid which is a 64-bit ID that will never | |
711 | * change, so there is a small probability that it will collide.) | |
712 | */ | |
713 | uint64_t dmu_objset_fsid_guid(objset_t *os); | |
714 | ||
428870ff BB |
715 | /* |
716 | * Get the [cm]time for an objset's snapshot dir | |
717 | */ | |
718 | timestruc_t dmu_objset_snap_cmtime(objset_t *os); | |
719 | ||
34dc7c2f BB |
720 | int dmu_objset_is_snapshot(objset_t *os); |
721 | ||
722 | extern struct spa *dmu_objset_spa(objset_t *os); | |
723 | extern struct zilog *dmu_objset_zil(objset_t *os); | |
724 | extern struct dsl_pool *dmu_objset_pool(objset_t *os); | |
725 | extern struct dsl_dataset *dmu_objset_ds(objset_t *os); | |
726 | extern void dmu_objset_name(objset_t *os, char *buf); | |
727 | extern dmu_objset_type_t dmu_objset_type(objset_t *os); | |
728 | extern uint64_t dmu_objset_id(objset_t *os); | |
428870ff BB |
729 | extern uint64_t dmu_objset_syncprop(objset_t *os); |
730 | extern uint64_t dmu_objset_logbias(objset_t *os); | |
34dc7c2f BB |
731 | extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name, |
732 | uint64_t *id, uint64_t *offp, boolean_t *case_conflict); | |
ebe7e575 | 733 | extern int dmu_snapshot_id(objset_t *os, const char *snapname, uint64_t *idp); |
34dc7c2f BB |
734 | extern int dmu_snapshot_realname(objset_t *os, char *name, char *real, |
735 | int maxlen, boolean_t *conflict); | |
736 | extern int dmu_dir_list_next(objset_t *os, int namelen, char *name, | |
737 | uint64_t *idp, uint64_t *offp); | |
9babb374 | 738 | |
428870ff BB |
739 | typedef int objset_used_cb_t(dmu_object_type_t bonustype, |
740 | void *bonus, uint64_t *userp, uint64_t *groupp); | |
9babb374 BB |
741 | extern void dmu_objset_register_type(dmu_objset_type_t ost, |
742 | objset_used_cb_t *cb); | |
34dc7c2f BB |
743 | extern void dmu_objset_set_user(objset_t *os, void *user_ptr); |
744 | extern void *dmu_objset_get_user(objset_t *os); | |
745 | ||
746 | /* | |
747 | * Return the txg number for the given assigned transaction. | |
748 | */ | |
749 | uint64_t dmu_tx_get_txg(dmu_tx_t *tx); | |
750 | ||
751 | /* | |
752 | * Synchronous write. | |
753 | * If a parent zio is provided this function initiates a write on the | |
754 | * provided buffer as a child of the parent zio. | |
755 | * In the absence of a parent zio, the write is completed synchronously. | |
756 | * At write completion, blk is filled with the bp of the written block. | |
757 | * Note that while the data covered by this function will be on stable | |
758 | * storage when the write completes this new data does not become a | |
759 | * permanent part of the file until the associated transaction commits. | |
760 | */ | |
428870ff BB |
761 | |
762 | /* | |
763 | * {zfs,zvol,ztest}_get_done() args | |
764 | */ | |
765 | typedef struct zgd { | |
766 | struct zilog *zgd_zilog; | |
767 | struct blkptr *zgd_bp; | |
768 | dmu_buf_t *zgd_db; | |
769 | struct rl *zgd_rl; | |
770 | void *zgd_private; | |
771 | } zgd_t; | |
772 | ||
773 | typedef void dmu_sync_cb_t(zgd_t *arg, int error); | |
774 | int dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd); | |
34dc7c2f BB |
775 | |
776 | /* | |
777 | * Find the next hole or data block in file starting at *off | |
778 | * Return found offset in *off. Return ESRCH for end of file. | |
779 | */ | |
780 | int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole, | |
781 | uint64_t *off); | |
782 | ||
783 | /* | |
784 | * Initial setup and final teardown. | |
785 | */ | |
786 | extern void dmu_init(void); | |
787 | extern void dmu_fini(void); | |
788 | ||
789 | typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp, | |
790 | uint64_t object, uint64_t offset, int len); | |
791 | void dmu_traverse_objset(objset_t *os, uint64_t txg_start, | |
792 | dmu_traverse_cb_t cb, void *arg); | |
793 | ||
37abac6d BP |
794 | int dmu_send(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin, |
795 | int outfd, struct vnode *vp, offset_t *off); | |
330d06f9 MA |
796 | int dmu_send_estimate(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorign, |
797 | uint64_t *sizep); | |
34dc7c2f BB |
798 | |
799 | typedef struct dmu_recv_cookie { | |
800 | /* | |
801 | * This structure is opaque! | |
802 | * | |
803 | * If logical and real are different, we are recving the stream | |
804 | * into the "real" temporary clone, and then switching it with | |
805 | * the "logical" target. | |
806 | */ | |
807 | struct dsl_dataset *drc_logical_ds; | |
808 | struct dsl_dataset *drc_real_ds; | |
809 | struct drr_begin *drc_drrb; | |
810 | char *drc_tosnap; | |
428870ff | 811 | char *drc_top_ds; |
34dc7c2f BB |
812 | boolean_t drc_newfs; |
813 | boolean_t drc_force; | |
8d35c149 | 814 | struct avl_tree *drc_guid_to_ds_map; |
34dc7c2f BB |
815 | } dmu_recv_cookie_t; |
816 | ||
428870ff | 817 | int dmu_recv_begin(char *tofs, char *tosnap, char *topds, struct drr_begin *, |
45d1cae3 | 818 | boolean_t force, objset_t *origin, dmu_recv_cookie_t *); |
572e2857 BB |
819 | int dmu_recv_stream(dmu_recv_cookie_t *drc, struct vnode *vp, offset_t *voffp, |
820 | int cleanup_fd, uint64_t *action_handlep); | |
34dc7c2f | 821 | int dmu_recv_end(dmu_recv_cookie_t *drc); |
34dc7c2f | 822 | |
572e2857 BB |
823 | int dmu_diff(objset_t *tosnap, objset_t *fromsnap, struct vnode *vp, |
824 | offset_t *off); | |
825 | ||
34dc7c2f BB |
826 | /* CRC64 table */ |
827 | #define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */ | |
828 | extern uint64_t zfs_crc64_table[256]; | |
829 | ||
830 | #ifdef __cplusplus | |
831 | } | |
832 | #endif | |
833 | ||
834 | #endif /* _SYS_DMU_H */ |