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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011, 2018 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright 2013 DEY Storage Systems, Inc.
28 * Copyright 2014 HybridCluster. All rights reserved.
29 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
30 * Copyright 2013 Saso Kiselkov. All rights reserved.
31 * Copyright (c) 2017, Intel Corporation.
32 * Copyright (c) 2014 Integros [integros.com]
35 /* Portions Copyright 2010 Robert Milkowski */
41 * This file describes the interface that the DMU provides for its
44 * The DMU also interacts with the SPA. That interface is described in
48 #include <sys/zfs_context.h>
50 #include <sys/fs/zfs.h>
51 #include <sys/zio_compress.h>
52 #include <sys/zio_priority.h>
72 struct zbookmark_phys;
81 typedef struct objset objset_t;
82 typedef struct dmu_tx dmu_tx_t;
83 typedef struct dsl_dir dsl_dir_t;
84 typedef struct dnode dnode_t;
86 typedef enum dmu_object_byteswap {
98 * Allocating a new byteswap type number makes the on-disk format
99 * incompatible with any other format that uses the same number.
101 * Data can usually be structured to work with one of the
102 * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types.
105 } dmu_object_byteswap_t;
107 #define DMU_OT_NEWTYPE 0x80
108 #define DMU_OT_METADATA 0x40
109 #define DMU_OT_BYTESWAP_MASK 0x3f
112 * Defines a uint8_t object type. Object types specify if the data
113 * in the object is metadata (boolean) and how to byteswap the data
114 * (dmu_object_byteswap_t). All of the types created by this method
115 * are cached in the dbuf metadata cache.
117 #define DMU_OT(byteswap, metadata) \
119 ((metadata) ? DMU_OT_METADATA : 0) | \
120 ((byteswap) & DMU_OT_BYTESWAP_MASK))
122 #define DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \
123 ((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \
124 (ot) < DMU_OT_NUMTYPES)
126 #define DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \
127 ((ot) & DMU_OT_METADATA) : \
128 dmu_ot[(ot)].ot_metadata)
130 #define DMU_OT_IS_DDT(ot) \
131 ((ot) == DMU_OT_DDT_ZAP)
133 #define DMU_OT_IS_ZIL(ot) \
134 ((ot) == DMU_OT_INTENT_LOG)
136 /* Note: ztest uses DMU_OT_UINT64_OTHER as a proxy for file blocks */
137 #define DMU_OT_IS_FILE(ot) \
138 ((ot) == DMU_OT_PLAIN_FILE_CONTENTS || (ot) == DMU_OT_UINT64_OTHER)
140 #define DMU_OT_IS_METADATA_CACHED(ot) (((ot) & DMU_OT_NEWTYPE) ? \
141 B_TRUE : dmu_ot[(ot)].ot_dbuf_metadata_cache)
144 * These object types use bp_fill != 1 for their L0 bp's. Therefore they can't
145 * have their data embedded (i.e. use a BP_IS_EMBEDDED() bp), because bp_fill
146 * is repurposed for embedded BPs.
148 #define DMU_OT_HAS_FILL(ot) \
149 ((ot) == DMU_OT_DNODE || (ot) == DMU_OT_OBJSET)
151 #define DMU_OT_BYTESWAP(ot) (((ot) & DMU_OT_NEWTYPE) ? \
152 ((ot) & DMU_OT_BYTESWAP_MASK) : \
153 dmu_ot[(ot)].ot_byteswap)
155 typedef enum dmu_object_type {
158 DMU_OT_OBJECT_DIRECTORY, /* ZAP */
159 DMU_OT_OBJECT_ARRAY, /* UINT64 */
160 DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */
161 DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */
162 DMU_OT_BPOBJ, /* UINT64 */
163 DMU_OT_BPOBJ_HDR, /* UINT64 */
165 DMU_OT_SPACE_MAP_HEADER, /* UINT64 */
166 DMU_OT_SPACE_MAP, /* UINT64 */
168 DMU_OT_INTENT_LOG, /* UINT64 */
170 DMU_OT_DNODE, /* DNODE */
171 DMU_OT_OBJSET, /* OBJSET */
173 DMU_OT_DSL_DIR, /* UINT64 */
174 DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */
175 DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */
176 DMU_OT_DSL_PROPS, /* ZAP */
177 DMU_OT_DSL_DATASET, /* UINT64 */
179 DMU_OT_ZNODE, /* ZNODE */
180 DMU_OT_OLDACL, /* Old ACL */
181 DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */
182 DMU_OT_DIRECTORY_CONTENTS, /* ZAP */
183 DMU_OT_MASTER_NODE, /* ZAP */
184 DMU_OT_UNLINKED_SET, /* ZAP */
186 DMU_OT_ZVOL, /* UINT8 */
187 DMU_OT_ZVOL_PROP, /* ZAP */
188 /* other; for testing only! */
189 DMU_OT_PLAIN_OTHER, /* UINT8 */
190 DMU_OT_UINT64_OTHER, /* UINT64 */
191 DMU_OT_ZAP_OTHER, /* ZAP */
192 /* new object types: */
193 DMU_OT_ERROR_LOG, /* ZAP */
194 DMU_OT_SPA_HISTORY, /* UINT8 */
195 DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */
196 DMU_OT_POOL_PROPS, /* ZAP */
197 DMU_OT_DSL_PERMS, /* ZAP */
198 DMU_OT_ACL, /* ACL */
199 DMU_OT_SYSACL, /* SYSACL */
200 DMU_OT_FUID, /* FUID table (Packed NVLIST UINT8) */
201 DMU_OT_FUID_SIZE, /* FUID table size UINT64 */
202 DMU_OT_NEXT_CLONES, /* ZAP */
203 DMU_OT_SCAN_QUEUE, /* ZAP */
204 DMU_OT_USERGROUP_USED, /* ZAP */
205 DMU_OT_USERGROUP_QUOTA, /* ZAP */
206 DMU_OT_USERREFS, /* ZAP */
207 DMU_OT_DDT_ZAP, /* ZAP */
208 DMU_OT_DDT_STATS, /* ZAP */
209 DMU_OT_SA, /* System attr */
210 DMU_OT_SA_MASTER_NODE, /* ZAP */
211 DMU_OT_SA_ATTR_REGISTRATION, /* ZAP */
212 DMU_OT_SA_ATTR_LAYOUTS, /* ZAP */
213 DMU_OT_SCAN_XLATE, /* ZAP */
214 DMU_OT_DEDUP, /* fake dedup BP from ddt_bp_create() */
215 DMU_OT_DEADLIST, /* ZAP */
216 DMU_OT_DEADLIST_HDR, /* UINT64 */
217 DMU_OT_DSL_CLONES, /* ZAP */
218 DMU_OT_BPOBJ_SUBOBJ, /* UINT64 */
220 * Do not allocate new object types here. Doing so makes the on-disk
221 * format incompatible with any other format that uses the same object
224 * When creating an object which does not have one of the above types
225 * use the DMU_OTN_* type with the correct byteswap and metadata
228 * The DMU_OTN_* types do not have entries in the dmu_ot table,
229 * use the DMU_OT_IS_METDATA() and DMU_OT_BYTESWAP() macros instead
230 * use the DMU_OT_IS_METADATA() and DMU_OT_BYTESWAP() macros instead
231 * of indexing into dmu_ot directly (this works for both DMU_OT_* types
232 * and DMU_OTN_* types).
237 * Names for valid types declared with DMU_OT().
239 DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE),
240 DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE),
241 DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE),
242 DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE),
243 DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE),
244 DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE),
245 DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE),
246 DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE),
247 DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE),
248 DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE),
252 * These flags are intended to be used to specify the "txg_how"
253 * parameter when calling the dmu_tx_assign() function. See the comment
254 * above dmu_tx_assign() for more details on the meaning of these flags.
256 #define TXG_NOWAIT (0ULL)
257 #define TXG_WAIT (1ULL<<0)
258 #define TXG_NOTHROTTLE (1ULL<<1)
260 void byteswap_uint64_array(void *buf, size_t size);
261 void byteswap_uint32_array(void *buf, size_t size);
262 void byteswap_uint16_array(void *buf, size_t size);
263 void byteswap_uint8_array(void *buf, size_t size);
264 void zap_byteswap(void *buf, size_t size);
265 void zfs_oldacl_byteswap(void *buf, size_t size);
266 void zfs_acl_byteswap(void *buf, size_t size);
267 void zfs_znode_byteswap(void *buf, size_t size);
269 #define DS_FIND_SNAPSHOTS (1<<0)
270 #define DS_FIND_CHILDREN (1<<1)
271 #define DS_FIND_SERIALIZE (1<<2)
274 * The maximum number of bytes that can be accessed as part of one
275 * operation, including metadata.
277 #define DMU_MAX_ACCESS (32 * 1024 * 1024) /* 32MB */
278 #define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */
280 #define DMU_USERUSED_OBJECT (-1ULL)
281 #define DMU_GROUPUSED_OBJECT (-2ULL)
284 * artificial blkids for bonus buffer and spill blocks
286 #define DMU_BONUS_BLKID (-1ULL)
287 #define DMU_SPILL_BLKID (-2ULL)
289 * Public routines to create, destroy, open, and close objsets.
291 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
292 int dmu_objset_own(const char *name, dmu_objset_type_t type,
293 boolean_t readonly, void *tag, objset_t **osp);
294 void dmu_objset_rele(objset_t *os, void *tag);
295 void dmu_objset_disown(objset_t *os, void *tag);
296 int dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp);
298 void dmu_objset_evict_dbufs(objset_t *os);
299 int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
300 void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
301 int dmu_get_recursive_snaps_nvl(char *fsname, const char *snapname,
302 struct nvlist *snaps);
303 int dmu_objset_clone(const char *name, const char *origin);
304 int dsl_destroy_snapshots_nvl(struct nvlist *snaps, boolean_t defer,
305 struct nvlist *errlist);
306 int dmu_objset_snapshot_one(const char *fsname, const char *snapname);
307 int dmu_objset_snapshot_tmp(const char *, const char *, int);
308 int dmu_objset_find(char *name, int func(const char *, void *), void *arg,
310 void dmu_objset_byteswap(void *buf, size_t size);
311 int dsl_dataset_rename_snapshot(const char *fsname,
312 const char *oldsnapname, const char *newsnapname, boolean_t recursive);
313 int dmu_objset_remap_indirects(const char *fsname);
315 typedef struct dmu_buf {
316 uint64_t db_object; /* object that this buffer is part of */
317 uint64_t db_offset; /* byte offset in this object */
318 uint64_t db_size; /* size of buffer in bytes */
319 void *db_data; /* data in buffer */
323 * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
325 #define DMU_POOL_DIRECTORY_OBJECT 1
326 #define DMU_POOL_CONFIG "config"
327 #define DMU_POOL_FEATURES_FOR_WRITE "features_for_write"
328 #define DMU_POOL_FEATURES_FOR_READ "features_for_read"
329 #define DMU_POOL_FEATURE_DESCRIPTIONS "feature_descriptions"
330 #define DMU_POOL_FEATURE_ENABLED_TXG "feature_enabled_txg"
331 #define DMU_POOL_ROOT_DATASET "root_dataset"
332 #define DMU_POOL_SYNC_BPOBJ "sync_bplist"
333 #define DMU_POOL_ERRLOG_SCRUB "errlog_scrub"
334 #define DMU_POOL_ERRLOG_LAST "errlog_last"
335 #define DMU_POOL_SPARES "spares"
336 #define DMU_POOL_DEFLATE "deflate"
337 #define DMU_POOL_HISTORY "history"
338 #define DMU_POOL_PROPS "pool_props"
339 #define DMU_POOL_L2CACHE "l2cache"
340 #define DMU_POOL_TMP_USERREFS "tmp_userrefs"
341 #define DMU_POOL_DDT "DDT-%s-%s-%s"
342 #define DMU_POOL_DDT_STATS "DDT-statistics"
343 #define DMU_POOL_CREATION_VERSION "creation_version"
344 #define DMU_POOL_SCAN "scan"
345 #define DMU_POOL_FREE_BPOBJ "free_bpobj"
346 #define DMU_POOL_BPTREE_OBJ "bptree_obj"
347 #define DMU_POOL_EMPTY_BPOBJ "empty_bpobj"
348 #define DMU_POOL_CHECKSUM_SALT "org.illumos:checksum_salt"
349 #define DMU_POOL_VDEV_ZAP_MAP "com.delphix:vdev_zap_map"
350 #define DMU_POOL_REMOVING "com.delphix:removing"
351 #define DMU_POOL_OBSOLETE_BPOBJ "com.delphix:obsolete_bpobj"
352 #define DMU_POOL_CONDENSING_INDIRECT "com.delphix:condensing_indirect"
353 #define DMU_POOL_ZPOOL_CHECKPOINT "com.delphix:zpool_checkpoint"
356 * Allocate an object from this objset. The range of object numbers
357 * available is (0, DN_MAX_OBJECT). Object 0 is the meta-dnode.
359 * The transaction must be assigned to a txg. The newly allocated
360 * object will be "held" in the transaction (ie. you can modify the
361 * newly allocated object in this transaction).
363 * dmu_object_alloc() chooses an object and returns it in *objectp.
365 * dmu_object_claim() allocates a specific object number. If that
366 * number is already allocated, it fails and returns EEXIST.
368 * Return 0 on success, or ENOSPC or EEXIST as specified above.
370 uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot,
371 int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
372 uint64_t dmu_object_alloc_ibs(objset_t *os, dmu_object_type_t ot, int blocksize,
373 int indirect_blockshift,
374 dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *tx);
375 uint64_t dmu_object_alloc_dnsize(objset_t *os, dmu_object_type_t ot,
376 int blocksize, dmu_object_type_t bonus_type, int bonus_len,
377 int dnodesize, dmu_tx_t *tx);
378 int dmu_object_claim_dnsize(objset_t *os, uint64_t object, dmu_object_type_t ot,
379 int blocksize, dmu_object_type_t bonus_type, int bonus_len,
380 int dnodesize, dmu_tx_t *tx);
381 int dmu_object_reclaim_dnsize(objset_t *os, uint64_t object,
382 dmu_object_type_t ot, int blocksize, dmu_object_type_t bonustype,
383 int bonuslen, int dnodesize, dmu_tx_t *txp);
384 int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot,
385 int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
386 int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot,
387 int blocksize, dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *txp);
390 * Free an object from this objset.
392 * The object's data will be freed as well (ie. you don't need to call
393 * dmu_free(object, 0, -1, tx)).
395 * The object need not be held in the transaction.
397 * If there are any holds on this object's buffers (via dmu_buf_hold()),
398 * or tx holds on the object (via dmu_tx_hold_object()), you can not
399 * free it; it fails and returns EBUSY.
401 * If the object is not allocated, it fails and returns ENOENT.
403 * Return 0 on success, or EBUSY or ENOENT as specified above.
405 int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx);
408 * Find the next allocated or free object.
410 * The objectp parameter is in-out. It will be updated to be the next
411 * object which is allocated. Ignore objects which have not been
412 * modified since txg.
414 * XXX Can only be called on a objset with no dirty data.
416 * Returns 0 on success, or ENOENT if there are no more objects.
418 int dmu_object_next(objset_t *os, uint64_t *objectp,
419 boolean_t hole, uint64_t txg);
422 * Set the data blocksize for an object.
424 * The object cannot have any blocks allcated beyond the first. If
425 * the first block is allocated already, the new size must be greater
426 * than the current block size. If these conditions are not met,
427 * ENOTSUP will be returned.
429 * Returns 0 on success, or EBUSY if there are any holds on the object
430 * contents, or ENOTSUP as described above.
432 int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size,
433 int ibs, dmu_tx_t *tx);
436 * Set the checksum property on a dnode. The new checksum algorithm will
437 * apply to all newly written blocks; existing blocks will not be affected.
439 void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum,
443 * Set the compress property on a dnode. The new compression algorithm will
444 * apply to all newly written blocks; existing blocks will not be affected.
446 void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress,
449 int dmu_object_remap_indirects(objset_t *os, uint64_t object, uint64_t txg);
452 dmu_write_embedded(objset_t *os, uint64_t object, uint64_t offset,
453 void *data, uint8_t etype, uint8_t comp, int uncompressed_size,
454 int compressed_size, int byteorder, dmu_tx_t *tx);
457 * Decide how to write a block: checksum, compression, number of copies, etc.
459 #define WP_NOFILL 0x1
460 #define WP_DMU_SYNC 0x2
463 void dmu_write_policy(objset_t *os, dnode_t *dn, int level, int wp,
464 struct zio_prop *zp);
466 * The bonus data is accessed more or less like a regular buffer.
467 * You must dmu_bonus_hold() to get the buffer, which will give you a
468 * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus
469 * data. As with any normal buffer, you must call dmu_buf_will_dirty()
470 * before modifying it, and the
471 * object must be held in an assigned transaction before calling
472 * dmu_buf_will_dirty. You may use dmu_buf_set_user() on the bonus
473 * buffer as well. You must release your hold with dmu_buf_rele().
475 * Returns ENOENT, EIO, or 0.
477 int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **);
478 int dmu_bonus_max(void);
479 int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *);
480 int dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *);
481 dmu_object_type_t dmu_get_bonustype(dmu_buf_t *);
482 int dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *);
485 * Special spill buffer support used by "SA" framework
488 int dmu_spill_hold_by_bonus(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
489 int dmu_spill_hold_by_dnode(dnode_t *dn, uint32_t flags,
490 void *tag, dmu_buf_t **dbp);
491 int dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
494 * Obtain the DMU buffer from the specified object which contains the
495 * specified offset. dmu_buf_hold() puts a "hold" on the buffer, so
496 * that it will remain in memory. You must release the hold with
497 * dmu_buf_rele(). You musn't access the dmu_buf_t after releasing your
498 * hold. You must have a hold on any dmu_buf_t* you pass to the DMU.
500 * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill
501 * on the returned buffer before reading or writing the buffer's
502 * db_data. The comments for those routines describe what particular
503 * operations are valid after calling them.
505 * The object number must be a valid, allocated object number.
507 int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset,
508 void *tag, dmu_buf_t **, int flags);
509 int dmu_buf_hold_by_dnode(dnode_t *dn, uint64_t offset,
510 void *tag, dmu_buf_t **dbp, int flags);
513 * Add a reference to a dmu buffer that has already been held via
514 * dmu_buf_hold() in the current context.
516 void dmu_buf_add_ref(dmu_buf_t *db, void* tag);
519 * Attempt to add a reference to a dmu buffer that is in an unknown state,
520 * using a pointer that may have been invalidated by eviction processing.
521 * The request will succeed if the passed in dbuf still represents the
522 * same os/object/blkid, is ineligible for eviction, and has at least
523 * one hold by a user other than the syncer.
525 boolean_t dmu_buf_try_add_ref(dmu_buf_t *, objset_t *os, uint64_t object,
526 uint64_t blkid, void *tag);
528 void dmu_buf_rele(dmu_buf_t *db, void *tag);
529 uint64_t dmu_buf_refcount(dmu_buf_t *db);
532 * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a
533 * range of an object. A pointer to an array of dmu_buf_t*'s is
534 * returned (in *dbpp).
536 * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and
537 * frees the array. The hold on the array of buffers MUST be released
538 * with dmu_buf_rele_array. You can NOT release the hold on each buffer
539 * individually with dmu_buf_rele.
541 int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset,
542 uint64_t length, boolean_t read, void *tag,
543 int *numbufsp, dmu_buf_t ***dbpp);
544 int dmu_buf_hold_array_by_dnode(dnode_t *dn, uint64_t offset, uint64_t length,
545 boolean_t read, void *tag, int *numbufsp, dmu_buf_t ***dbpp,
547 void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag);
549 typedef void dmu_buf_evict_func_t(void *user_ptr);
552 * A DMU buffer user object may be associated with a dbuf for the
553 * duration of its lifetime. This allows the user of a dbuf (client)
554 * to attach private data to a dbuf (e.g. in-core only data such as a
555 * dnode_children_t, zap_t, or zap_leaf_t) and be optionally notified
556 * when that dbuf has been evicted. Clients typically respond to the
557 * eviction notification by freeing their private data, thus ensuring
558 * the same lifetime for both dbuf and private data.
560 * The mapping from a dmu_buf_user_t to any client private data is the
561 * client's responsibility. All current consumers of the API with private
562 * data embed a dmu_buf_user_t as the first member of the structure for
563 * their private data. This allows conversions between the two types
564 * with a simple cast. Since the DMU buf user API never needs access
565 * to the private data, other strategies can be employed if necessary
566 * or convenient for the client (e.g. using container_of() to do the
567 * conversion for private data that cannot have the dmu_buf_user_t as
570 * Eviction callbacks are executed without the dbuf mutex held or any
571 * other type of mechanism to guarantee that the dbuf is still available.
572 * For this reason, users must assume the dbuf has already been freed
573 * and not reference the dbuf from the callback context.
575 * Users requesting "immediate eviction" are notified as soon as the dbuf
576 * is only referenced by dirty records (dirties == holds). Otherwise the
577 * notification occurs after eviction processing for the dbuf begins.
579 typedef struct dmu_buf_user {
581 * Asynchronous user eviction callback state.
583 taskq_ent_t dbu_tqent;
586 * This instance's eviction function pointers.
588 * dbu_evict_func_sync is called synchronously and then
589 * dbu_evict_func_async is executed asynchronously on a taskq.
591 dmu_buf_evict_func_t *dbu_evict_func_sync;
592 dmu_buf_evict_func_t *dbu_evict_func_async;
595 * Pointer to user's dbuf pointer. NULL for clients that do
596 * not associate a dbuf with their user data.
598 * The dbuf pointer is cleared upon eviction so as to catch
599 * use-after-evict bugs in clients.
601 dmu_buf_t **dbu_clear_on_evict_dbufp;
606 * Initialize the given dmu_buf_user_t instance with the eviction function
607 * evict_func, to be called when the user is evicted.
609 * NOTE: This function should only be called once on a given dmu_buf_user_t.
610 * To allow enforcement of this, dbu must already be zeroed on entry.
614 dmu_buf_init_user(dmu_buf_user_t *dbu, dmu_buf_evict_func_t *evict_func_sync,
615 dmu_buf_evict_func_t *evict_func_async, dmu_buf_t **clear_on_evict_dbufp)
617 ASSERT(dbu->dbu_evict_func_sync == NULL);
618 ASSERT(dbu->dbu_evict_func_async == NULL);
620 /* must have at least one evict func */
621 IMPLY(evict_func_sync == NULL, evict_func_async != NULL);
622 dbu->dbu_evict_func_sync = evict_func_sync;
623 dbu->dbu_evict_func_async = evict_func_async;
625 dbu->dbu_clear_on_evict_dbufp = clear_on_evict_dbufp;
630 * Attach user data to a dbuf and mark it for normal (when the dbuf's
631 * data is cleared or its reference count goes to zero) eviction processing.
633 * Returns NULL on success, or the existing user if another user currently
636 void *dmu_buf_set_user(dmu_buf_t *db, dmu_buf_user_t *user);
639 * Attach user data to a dbuf and mark it for immediate (its dirty and
640 * reference counts are equal) eviction processing.
642 * Returns NULL on success, or the existing user if another user currently
645 void *dmu_buf_set_user_ie(dmu_buf_t *db, dmu_buf_user_t *user);
648 * Replace the current user of a dbuf.
650 * If given the current user of a dbuf, replaces the dbuf's user with
651 * "new_user" and returns the user data pointer that was replaced.
652 * Otherwise returns the current, and unmodified, dbuf user pointer.
654 void *dmu_buf_replace_user(dmu_buf_t *db,
655 dmu_buf_user_t *old_user, dmu_buf_user_t *new_user);
658 * Remove the specified user data for a DMU buffer.
660 * Returns the user that was removed on success, or the current user if
661 * another user currently owns the buffer.
663 void *dmu_buf_remove_user(dmu_buf_t *db, dmu_buf_user_t *user);
666 * Returns the user data (dmu_buf_user_t *) associated with this dbuf.
668 void *dmu_buf_get_user(dmu_buf_t *db);
670 objset_t *dmu_buf_get_objset(dmu_buf_t *db);
671 dnode_t *dmu_buf_dnode_enter(dmu_buf_t *db);
672 void dmu_buf_dnode_exit(dmu_buf_t *db);
674 /* Block until any in-progress dmu buf user evictions complete. */
675 void dmu_buf_user_evict_wait(void);
678 * Returns the blkptr associated with this dbuf, or NULL if not set.
680 struct blkptr *dmu_buf_get_blkptr(dmu_buf_t *db);
683 * Indicate that you are going to modify the buffer's data (db_data).
685 * The transaction (tx) must be assigned to a txg (ie. you've called
686 * dmu_tx_assign()). The buffer's object must be held in the tx
687 * (ie. you've called dmu_tx_hold_object(tx, db->db_object)).
689 void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx);
692 * You must create a transaction, then hold the objects which you will
693 * (or might) modify as part of this transaction. Then you must assign
694 * the transaction to a transaction group. Once the transaction has
695 * been assigned, you can modify buffers which belong to held objects as
696 * part of this transaction. You can't modify buffers before the
697 * transaction has been assigned; you can't modify buffers which don't
698 * belong to objects which this transaction holds; you can't hold
699 * objects once the transaction has been assigned. You may hold an
700 * object which you are going to free (with dmu_object_free()), but you
703 * You can abort the transaction before it has been assigned.
705 * Note that you may hold buffers (with dmu_buf_hold) at any time,
706 * regardless of transaction state.
709 #define DMU_NEW_OBJECT (-1ULL)
710 #define DMU_OBJECT_END (-1ULL)
712 dmu_tx_t *dmu_tx_create(objset_t *os);
713 void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len);
714 void dmu_tx_hold_write_by_dnode(dmu_tx_t *tx, dnode_t *dn, uint64_t off,
716 void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off,
718 void dmu_tx_hold_free_by_dnode(dmu_tx_t *tx, dnode_t *dn, uint64_t off,
720 void dmu_tx_hold_remap_l1indirect(dmu_tx_t *tx, uint64_t object);
721 void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name);
722 void dmu_tx_hold_zap_by_dnode(dmu_tx_t *tx, dnode_t *dn, int add,
724 void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object);
725 void dmu_tx_hold_bonus_by_dnode(dmu_tx_t *tx, dnode_t *dn);
726 void dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object);
727 void dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow);
728 void dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size);
729 void dmu_tx_abort(dmu_tx_t *tx);
730 int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how);
731 void dmu_tx_wait(dmu_tx_t *tx);
732 void dmu_tx_commit(dmu_tx_t *tx);
733 void dmu_tx_mark_netfree(dmu_tx_t *tx);
736 * To register a commit callback, dmu_tx_callback_register() must be called.
738 * dcb_data is a pointer to caller private data that is passed on as a
739 * callback parameter. The caller is responsible for properly allocating and
742 * When registering a callback, the transaction must be already created, but
743 * it cannot be committed or aborted. It can be assigned to a txg or not.
745 * The callback will be called after the transaction has been safely written
746 * to stable storage and will also be called if the dmu_tx is aborted.
747 * If there is any error which prevents the transaction from being committed to
748 * disk, the callback will be called with a value of error != 0.
750 typedef void dmu_tx_callback_func_t(void *dcb_data, int error);
752 void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func,
756 * Free up the data blocks for a defined range of a file. If size is
757 * -1, the range from offset to end-of-file is freed.
759 int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset,
760 uint64_t size, dmu_tx_t *tx);
761 int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset,
763 int dmu_free_long_object(objset_t *os, uint64_t object);
766 * Convenience functions.
768 * Canfail routines will return 0 on success, or an errno if there is a
769 * nonrecoverable I/O error.
771 #define DMU_READ_PREFETCH 0 /* prefetch */
772 #define DMU_READ_NO_PREFETCH 1 /* don't prefetch */
773 int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
774 void *buf, uint32_t flags);
775 int dmu_read_by_dnode(dnode_t *dn, uint64_t offset, uint64_t size, void *buf,
777 void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
778 const void *buf, dmu_tx_t *tx);
779 void dmu_write_by_dnode(dnode_t *dn, uint64_t offset, uint64_t size,
780 const void *buf, dmu_tx_t *tx);
781 void dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
783 int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size);
784 int dmu_read_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size);
785 int dmu_read_uio_dnode(dnode_t *dn, struct uio *uio, uint64_t size);
786 int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size,
788 int dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size,
790 int dmu_write_uio_dnode(dnode_t *dn, struct uio *uio, uint64_t size,
794 int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset,
795 uint64_t size, struct page *pp, dmu_tx_t *tx);
797 int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset,
798 uint64_t size, struct vm_page **ppa, dmu_tx_t *tx);
799 int dmu_read_pages(objset_t *os, uint64_t object, vm_page_t *ma, int count,
800 int *rbehind, int *rahead, int last_size);
803 struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size);
804 void dmu_return_arcbuf(struct arc_buf *buf);
805 void dmu_assign_arcbuf_dnode(dnode_t *handle, uint64_t offset,
806 struct arc_buf *buf, dmu_tx_t *tx);
807 void dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf,
809 int dmu_xuio_init(struct xuio *uio, int niov);
810 void dmu_xuio_fini(struct xuio *uio);
811 int dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off,
813 int dmu_xuio_cnt(struct xuio *uio);
814 struct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i);
815 void dmu_xuio_clear(struct xuio *uio, int i);
816 void xuio_stat_wbuf_copied(void);
817 void xuio_stat_wbuf_nocopy(void);
819 extern boolean_t zfs_prefetch_disable;
820 extern int zfs_max_recordsize;
823 * Asynchronously try to read in the data.
825 void dmu_prefetch(objset_t *os, uint64_t object, int64_t level, uint64_t offset,
826 uint64_t len, enum zio_priority pri);
828 typedef struct dmu_object_info {
829 /* All sizes are in bytes unless otherwise indicated. */
830 uint32_t doi_data_block_size;
831 uint32_t doi_metadata_block_size;
832 dmu_object_type_t doi_type;
833 dmu_object_type_t doi_bonus_type;
834 uint64_t doi_bonus_size;
835 uint8_t doi_indirection; /* 2 = dnode->indirect->data */
836 uint8_t doi_checksum;
837 uint8_t doi_compress;
840 uint64_t doi_dnodesize;
841 uint64_t doi_physical_blocks_512; /* data + metadata, 512b blks */
842 uint64_t doi_max_offset;
843 uint64_t doi_fill_count; /* number of non-empty blocks */
846 typedef void arc_byteswap_func_t(void *buf, size_t size);
848 typedef struct dmu_object_type_info {
849 dmu_object_byteswap_t ot_byteswap;
850 boolean_t ot_metadata;
851 boolean_t ot_dbuf_metadata_cache;
853 } dmu_object_type_info_t;
855 typedef struct dmu_object_byteswap_info {
856 arc_byteswap_func_t *ob_func;
858 } dmu_object_byteswap_info_t;
860 extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES];
861 extern const dmu_object_byteswap_info_t dmu_ot_byteswap[DMU_BSWAP_NUMFUNCS];
864 * Get information on a DMU object.
866 * Return 0 on success or ENOENT if object is not allocated.
868 * If doi is NULL, just indicates whether the object exists.
870 int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi);
871 void __dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi);
872 /* Like dmu_object_info, but faster if you have a held dnode in hand. */
873 void dmu_object_info_from_dnode(dnode_t *dn, dmu_object_info_t *doi);
874 /* Like dmu_object_info, but faster if you have a held dbuf in hand. */
875 void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi);
877 * Like dmu_object_info_from_db, but faster still when you only care about
878 * the size. This is specifically optimized for zfs_getattr().
880 void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize,
881 u_longlong_t *nblk512);
883 void dmu_object_dnsize_from_db(dmu_buf_t *db, int *dnsize);
885 typedef struct dmu_objset_stats {
886 uint64_t dds_num_clones; /* number of clones of this */
887 uint64_t dds_creation_txg;
889 dmu_objset_type_t dds_type;
890 uint8_t dds_is_snapshot;
891 uint8_t dds_inconsistent;
892 char dds_origin[ZFS_MAX_DATASET_NAME_LEN];
893 } dmu_objset_stats_t;
896 * Get stats on a dataset.
898 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
901 * Add entries to the nvlist for all the objset's properties. See
902 * zfs_prop_table[] and zfs(1m) for details on the properties.
904 void dmu_objset_stats(objset_t *os, struct nvlist *nv);
907 * Get the space usage statistics for statvfs().
909 * refdbytes is the amount of space "referenced" by this objset.
910 * availbytes is the amount of space available to this objset, taking
911 * into account quotas & reservations, assuming that no other objsets
912 * use the space first. These values correspond to the 'referenced' and
913 * 'available' properties, described in the zfs(1m) manpage.
915 * usedobjs and availobjs are the number of objects currently allocated,
918 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
919 uint64_t *usedobjsp, uint64_t *availobjsp);
922 * The fsid_guid is a 56-bit ID that can change to avoid collisions.
923 * (Contrast with the ds_guid which is a 64-bit ID that will never
924 * change, so there is a small probability that it will collide.)
926 uint64_t dmu_objset_fsid_guid(objset_t *os);
929 * Get the [cm]time for an objset's snapshot dir
931 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
933 int dmu_objset_is_snapshot(objset_t *os);
935 extern struct spa *dmu_objset_spa(objset_t *os);
936 extern struct zilog *dmu_objset_zil(objset_t *os);
937 extern struct dsl_pool *dmu_objset_pool(objset_t *os);
938 extern struct dsl_dataset *dmu_objset_ds(objset_t *os);
939 extern void dmu_objset_name(objset_t *os, char *buf);
940 extern dmu_objset_type_t dmu_objset_type(objset_t *os);
941 extern uint64_t dmu_objset_id(objset_t *os);
942 extern uint64_t dmu_objset_dnodesize(objset_t *os);
943 extern zfs_sync_type_t dmu_objset_syncprop(objset_t *os);
944 extern zfs_logbias_op_t dmu_objset_logbias(objset_t *os);
945 extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name,
946 uint64_t *id, uint64_t *offp, boolean_t *case_conflict);
947 extern int dmu_snapshot_realname(objset_t *os, char *name, char *real,
948 int maxlen, boolean_t *conflict);
949 extern int dmu_dir_list_next(objset_t *os, int namelen, char *name,
950 uint64_t *idp, uint64_t *offp);
952 typedef int objset_used_cb_t(dmu_object_type_t bonustype,
953 void *bonus, uint64_t *userp, uint64_t *groupp);
954 extern void dmu_objset_register_type(dmu_objset_type_t ost,
955 objset_used_cb_t *cb);
956 extern void dmu_objset_set_user(objset_t *os, void *user_ptr);
957 extern void *dmu_objset_get_user(objset_t *os);
960 * Return the txg number for the given assigned transaction.
962 uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
966 * If a parent zio is provided this function initiates a write on the
967 * provided buffer as a child of the parent zio.
968 * In the absence of a parent zio, the write is completed synchronously.
969 * At write completion, blk is filled with the bp of the written block.
970 * Note that while the data covered by this function will be on stable
971 * storage when the write completes this new data does not become a
972 * permanent part of the file until the associated transaction commits.
976 * {zfs,zvol,ztest}_get_done() args
980 struct blkptr *zgd_bp;
982 struct locked_range *zgd_lr;
986 typedef void dmu_sync_cb_t(zgd_t *arg, int error);
987 int dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd);
990 * Find the next hole or data block in file starting at *off
991 * Return found offset in *off. Return ESRCH for end of file.
993 int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole,
997 * Check if a DMU object has any dirty blocks. If so, sync out
998 * all pending transaction groups. Otherwise, this function
999 * does not alter DMU state. This could be improved to only sync
1000 * out the necessary transaction groups for this particular
1003 int dmu_object_wait_synced(objset_t *os, uint64_t object);
1006 * Initial setup and final teardown.
1008 extern void dmu_init(void);
1009 extern void dmu_fini(void);
1011 typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp,
1012 uint64_t object, uint64_t offset, int len);
1013 void dmu_traverse_objset(objset_t *os, uint64_t txg_start,
1014 dmu_traverse_cb_t cb, void *arg);
1015 int dmu_diff(const char *tosnap_name, const char *fromsnap_name,
1016 struct file *fp, offset_t *offp);
1019 #define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */
1020 extern uint64_t zfs_crc64_table[256];
1022 extern int zfs_mdcomp_disable;
1028 #endif /* _SYS_DMU_H */