]> git.proxmox.com Git - mirror_zfs.git/blame - include/sys/dmu.h
OpenZFS 9337 - zfs get all is slow due to uncached metadata
[mirror_zfs.git] / include / sys / dmu.h
CommitLineData
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.
82644107 23 * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
632a242e 24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
37abac6d 25 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
6c59307a 26 * Copyright 2014 HybridCluster. All rights reserved.
0c66c32d 27 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
3c67d83a 28 * Copyright 2013 Saso Kiselkov. All rights reserved.
34dc7c2f
BB
29 */
30
428870ff
BB
31/* Portions Copyright 2010 Robert Milkowski */
32
34dc7c2f
BB
33#ifndef _SYS_DMU_H
34#define _SYS_DMU_H
35
34dc7c2f
BB
36/*
37 * This file describes the interface that the DMU provides for its
38 * consumers.
39 *
40 * The DMU also interacts with the SPA. That interface is described in
41 * dmu_spa.h.
42 */
43
0c66c32d 44#include <sys/zfs_context.h>
34dc7c2f 45#include <sys/inttypes.h>
34dc7c2f 46#include <sys/cred.h>
6f1ffb06 47#include <sys/fs/zfs.h>
2aa34383 48#include <sys/zio_compress.h>
fcff0f35 49#include <sys/zio_priority.h>
59e6e7ca 50#include <sys/uio.h>
34dc7c2f
BB
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
34dc7c2f
BB
56struct page;
57struct vnode;
58struct spa;
59struct zilog;
60struct zio;
61struct blkptr;
62struct zap_cursor;
63struct dsl_dataset;
64struct dsl_pool;
65struct dnode;
66struct drr_begin;
67struct drr_end;
5dbd68a3 68struct zbookmark_phys;
34dc7c2f
BB
69struct spa;
70struct nvlist;
9babb374 71struct arc_buf;
428870ff
BB
72struct zio_prop;
73struct sa_handle;
b5256303 74struct dsl_crypto_params;
34dc7c2f
BB
75
76typedef struct objset objset_t;
77typedef struct dmu_tx dmu_tx_t;
78typedef struct dsl_dir dsl_dir_t;
2bce8049 79typedef struct dnode dnode_t;
34dc7c2f 80
9ae529ec
CS
81typedef enum dmu_object_byteswap {
82 DMU_BSWAP_UINT8,
83 DMU_BSWAP_UINT16,
84 DMU_BSWAP_UINT32,
85 DMU_BSWAP_UINT64,
86 DMU_BSWAP_ZAP,
87 DMU_BSWAP_DNODE,
88 DMU_BSWAP_OBJSET,
89 DMU_BSWAP_ZNODE,
90 DMU_BSWAP_OLDACL,
91 DMU_BSWAP_ACL,
92 /*
93 * Allocating a new byteswap type number makes the on-disk format
94 * incompatible with any other format that uses the same number.
95 *
96 * Data can usually be structured to work with one of the
97 * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types.
98 */
99 DMU_BSWAP_NUMFUNCS
100} dmu_object_byteswap_t;
101
102#define DMU_OT_NEWTYPE 0x80
103#define DMU_OT_METADATA 0x40
b5256303
TC
104#define DMU_OT_ENCRYPTED 0x20
105#define DMU_OT_BYTESWAP_MASK 0x1f
9ae529ec
CS
106
107/*
108 * Defines a uint8_t object type. Object types specify if the data
109 * in the object is metadata (boolean) and how to byteswap the data
2e5dc449
MA
110 * (dmu_object_byteswap_t). All of the types created by this method
111 * are cached in the dbuf metadata cache.
9ae529ec 112 */
b5256303 113#define DMU_OT(byteswap, metadata, encrypted) \
9ae529ec
CS
114 (DMU_OT_NEWTYPE | \
115 ((metadata) ? DMU_OT_METADATA : 0) | \
b5256303 116 ((encrypted) ? DMU_OT_ENCRYPTED : 0) | \
9ae529ec
CS
117 ((byteswap) & DMU_OT_BYTESWAP_MASK))
118
119#define DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \
120 ((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \
121 (ot) < DMU_OT_NUMTYPES)
122
2e5dc449
MA
123#define DMU_OT_IS_METADATA_CACHED(ot) (((ot) & DMU_OT_NEWTYPE) ? \
124 B_TRUE : dmu_ot[(ot)].ot_dbuf_metadata_cache)
125
5c27ec10
MA
126/*
127 * MDB doesn't have dmu_ot; it defines these macros itself.
128 */
129#ifndef ZFS_MDB
130#define DMU_OT_IS_METADATA_IMPL(ot) (dmu_ot[ot].ot_metadata)
131#define DMU_OT_IS_ENCRYPTED_IMPL(ot) (dmu_ot[ot].ot_encrypt)
132#define DMU_OT_BYTESWAP_IMPL(ot) (dmu_ot[ot].ot_byteswap)
133#endif
134
9ae529ec
CS
135#define DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \
136 ((ot) & DMU_OT_METADATA) : \
5c27ec10 137 DMU_OT_IS_METADATA_IMPL(ot))
9ae529ec 138
b5256303
TC
139#define DMU_OT_IS_ENCRYPTED(ot) (((ot) & DMU_OT_NEWTYPE) ? \
140 ((ot) & DMU_OT_ENCRYPTED) : \
5c27ec10 141 DMU_OT_IS_ENCRYPTED_IMPL(ot))
b5256303 142
9b67f605
MA
143/*
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.
147 */
148#define DMU_OT_HAS_FILL(ot) \
149 ((ot) == DMU_OT_DNODE || (ot) == DMU_OT_OBJSET)
150
9ae529ec
CS
151#define DMU_OT_BYTESWAP(ot) (((ot) & DMU_OT_NEWTYPE) ? \
152 ((ot) & DMU_OT_BYTESWAP_MASK) : \
5c27ec10 153 DMU_OT_BYTESWAP_IMPL(ot))
9ae529ec 154
34dc7c2f
BB
155typedef enum dmu_object_type {
156 DMU_OT_NONE,
157 /* general: */
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 */
428870ff
BB
162 DMU_OT_BPOBJ, /* UINT64 */
163 DMU_OT_BPOBJ_HDR, /* UINT64 */
34dc7c2f
BB
164 /* spa: */
165 DMU_OT_SPACE_MAP_HEADER, /* UINT64 */
166 DMU_OT_SPACE_MAP, /* UINT64 */
167 /* zil: */
168 DMU_OT_INTENT_LOG, /* UINT64 */
169 /* dmu: */
170 DMU_OT_DNODE, /* DNODE */
171 DMU_OT_OBJSET, /* OBJSET */
172 /* dsl: */
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 */
178 /* zpl: */
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 */
185 /* zvol: */
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 */
b128c09f 202 DMU_OT_NEXT_CLONES, /* ZAP */
428870ff 203 DMU_OT_SCAN_QUEUE, /* ZAP */
9babb374
BB
204 DMU_OT_USERGROUP_USED, /* ZAP */
205 DMU_OT_USERGROUP_QUOTA, /* ZAP */
45d1cae3 206 DMU_OT_USERREFS, /* ZAP */
428870ff
BB
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 */
9ae529ec
CS
219 /*
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
222 * type number.
223 *
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
226 * values.
227 *
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 * of indexing into dmu_ot directly (this works for both DMU_OT_* types
231 * and DMU_OTN_* types).
232 */
233 DMU_OT_NUMTYPES,
234
235 /*
236 * Names for valid types declared with DMU_OT().
237 */
b5256303
TC
238 DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE, B_FALSE),
239 DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE, B_FALSE),
240 DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE, B_FALSE),
241 DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE, B_FALSE),
242 DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE, B_FALSE),
243 DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE, B_FALSE),
244 DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE, B_FALSE),
245 DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE, B_FALSE),
246 DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE, B_FALSE),
247 DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE, B_FALSE),
248
249 DMU_OTN_UINT8_ENC_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE, B_TRUE),
250 DMU_OTN_UINT8_ENC_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE, B_TRUE),
251 DMU_OTN_UINT16_ENC_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE, B_TRUE),
252 DMU_OTN_UINT16_ENC_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE, B_TRUE),
253 DMU_OTN_UINT32_ENC_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE, B_TRUE),
254 DMU_OTN_UINT32_ENC_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE, B_TRUE),
255 DMU_OTN_UINT64_ENC_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE, B_TRUE),
256 DMU_OTN_UINT64_ENC_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE, B_TRUE),
257 DMU_OTN_ZAP_ENC_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE, B_TRUE),
258 DMU_OTN_ZAP_ENC_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE, B_TRUE),
34dc7c2f
BB
259} dmu_object_type_t;
260
0735ecb3
PS
261/*
262 * These flags are intended to be used to specify the "txg_how"
263 * parameter when calling the dmu_tx_assign() function. See the comment
264 * above dmu_tx_assign() for more details on the meaning of these flags.
265 */
266#define TXG_NOWAIT (0ULL)
267#define TXG_WAIT (1ULL<<0)
268#define TXG_NOTHROTTLE (1ULL<<1)
13fe0198 269
34dc7c2f
BB
270void byteswap_uint64_array(void *buf, size_t size);
271void byteswap_uint32_array(void *buf, size_t size);
272void byteswap_uint16_array(void *buf, size_t size);
273void byteswap_uint8_array(void *buf, size_t size);
274void zap_byteswap(void *buf, size_t size);
275void zfs_oldacl_byteswap(void *buf, size_t size);
276void zfs_acl_byteswap(void *buf, size_t size);
277void zfs_znode_byteswap(void *buf, size_t size);
278
34dc7c2f
BB
279#define DS_FIND_SNAPSHOTS (1<<0)
280#define DS_FIND_CHILDREN (1<<1)
9c43027b 281#define DS_FIND_SERIALIZE (1<<2)
34dc7c2f
BB
282
283/*
284 * The maximum number of bytes that can be accessed as part of one
285 * operation, including metadata.
286 */
f1512ee6 287#define DMU_MAX_ACCESS (64 * 1024 * 1024) /* 64MB */
b128c09f 288#define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */
34dc7c2f 289
9babb374
BB
290#define DMU_USERUSED_OBJECT (-1ULL)
291#define DMU_GROUPUSED_OBJECT (-2ULL)
9c5167d1 292#define DMU_PROJECTUSED_OBJECT (-3ULL)
9babb374 293
1de321e6 294/*
9c5167d1 295 * Zap prefix for object accounting in DMU_{USER,GROUP,PROJECT}USED_OBJECT.
1de321e6
JX
296 */
297#define DMU_OBJACCT_PREFIX "obj-"
298#define DMU_OBJACCT_PREFIX_LEN 4
299
428870ff
BB
300/*
301 * artificial blkids for bonus buffer and spill blocks
302 */
303#define DMU_BONUS_BLKID (-1ULL)
304#define DMU_SPILL_BLKID (-2ULL)
b5256303 305
34dc7c2f
BB
306/*
307 * Public routines to create, destroy, open, and close objsets.
308 */
b5256303
TC
309typedef void dmu_objset_create_sync_func_t(objset_t *os, void *arg,
310 cred_t *cr, dmu_tx_t *tx);
311
428870ff
BB
312int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
313int dmu_objset_own(const char *name, dmu_objset_type_t type,
b5256303 314 boolean_t readonly, boolean_t key_required, void *tag, objset_t **osp);
428870ff 315void dmu_objset_rele(objset_t *os, void *tag);
b5256303 316void dmu_objset_disown(objset_t *os, boolean_t key_required, void *tag);
428870ff
BB
317int dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp);
318
13fe0198 319void dmu_objset_evict_dbufs(objset_t *os);
428870ff 320int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
b5256303
TC
321 struct dsl_crypto_params *dcp, dmu_objset_create_sync_func_t func,
322 void *arg);
13fe0198
MA
323int dmu_objset_clone(const char *name, const char *origin);
324int dsl_destroy_snapshots_nvl(struct nvlist *snaps, boolean_t defer,
6f1ffb06 325 struct nvlist *errlist);
6f1ffb06
MA
326int dmu_objset_snapshot_one(const char *fsname, const char *snapname);
327int dmu_objset_snapshot_tmp(const char *, const char *, int);
428870ff 328int dmu_objset_find(char *name, int func(const char *, void *), void *arg,
34dc7c2f
BB
329 int flags);
330void dmu_objset_byteswap(void *buf, size_t size);
13fe0198
MA
331int dsl_dataset_rename_snapshot(const char *fsname,
332 const char *oldsnapname, const char *newsnapname, boolean_t recursive);
a1d477c2 333int dmu_objset_remap_indirects(const char *fsname);
34dc7c2f
BB
334
335typedef struct dmu_buf {
336 uint64_t db_object; /* object that this buffer is part of */
337 uint64_t db_offset; /* byte offset in this object */
338 uint64_t db_size; /* size of buffer in bytes */
339 void *db_data; /* data in buffer */
340} dmu_buf_t;
341
34dc7c2f
BB
342/*
343 * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
344 */
345#define DMU_POOL_DIRECTORY_OBJECT 1
346#define DMU_POOL_CONFIG "config"
9ae529ec
CS
347#define DMU_POOL_FEATURES_FOR_WRITE "features_for_write"
348#define DMU_POOL_FEATURES_FOR_READ "features_for_read"
349#define DMU_POOL_FEATURE_DESCRIPTIONS "feature_descriptions"
b0bc7a84 350#define DMU_POOL_FEATURE_ENABLED_TXG "feature_enabled_txg"
34dc7c2f 351#define DMU_POOL_ROOT_DATASET "root_dataset"
428870ff 352#define DMU_POOL_SYNC_BPOBJ "sync_bplist"
34dc7c2f
BB
353#define DMU_POOL_ERRLOG_SCRUB "errlog_scrub"
354#define DMU_POOL_ERRLOG_LAST "errlog_last"
355#define DMU_POOL_SPARES "spares"
356#define DMU_POOL_DEFLATE "deflate"
357#define DMU_POOL_HISTORY "history"
358#define DMU_POOL_PROPS "pool_props"
359#define DMU_POOL_L2CACHE "l2cache"
428870ff
BB
360#define DMU_POOL_TMP_USERREFS "tmp_userrefs"
361#define DMU_POOL_DDT "DDT-%s-%s-%s"
362#define DMU_POOL_DDT_STATS "DDT-statistics"
363#define DMU_POOL_CREATION_VERSION "creation_version"
364#define DMU_POOL_SCAN "scan"
365#define DMU_POOL_FREE_BPOBJ "free_bpobj"
9ae529ec 366#define DMU_POOL_BPTREE_OBJ "bptree_obj"
753c3839 367#define DMU_POOL_EMPTY_BPOBJ "empty_bpobj"
3c67d83a 368#define DMU_POOL_CHECKSUM_SALT "org.illumos:checksum_salt"
e0ab3ab5 369#define DMU_POOL_VDEV_ZAP_MAP "com.delphix:vdev_zap_map"
a1d477c2
MA
370#define DMU_POOL_REMOVING "com.delphix:removing"
371#define DMU_POOL_OBSOLETE_BPOBJ "com.delphix:obsolete_bpobj"
372#define DMU_POOL_CONDENSING_INDIRECT "com.delphix:condensing_indirect"
d2734cce 373#define DMU_POOL_ZPOOL_CHECKPOINT "com.delphix:zpool_checkpoint"
b128c09f 374
34dc7c2f
BB
375/*
376 * Allocate an object from this objset. The range of object numbers
377 * available is (0, DN_MAX_OBJECT). Object 0 is the meta-dnode.
378 *
379 * The transaction must be assigned to a txg. The newly allocated
380 * object will be "held" in the transaction (ie. you can modify the
381 * newly allocated object in this transaction).
382 *
383 * dmu_object_alloc() chooses an object and returns it in *objectp.
384 *
385 * dmu_object_claim() allocates a specific object number. If that
386 * number is already allocated, it fails and returns EEXIST.
387 *
388 * Return 0 on success, or ENOSPC or EEXIST as specified above.
389 */
390uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot,
391 int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
50c957f7
NB
392uint64_t dmu_object_alloc_dnsize(objset_t *os, dmu_object_type_t ot,
393 int blocksize, dmu_object_type_t bonus_type, int bonus_len,
394 int dnodesize, dmu_tx_t *tx);
34dc7c2f
BB
395int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot,
396 int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
50c957f7
NB
397int dmu_object_claim_dnsize(objset_t *os, uint64_t object, dmu_object_type_t ot,
398 int blocksize, dmu_object_type_t bonus_type, int bonus_len,
399 int dnodesize, dmu_tx_t *tx);
34dc7c2f 400int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot,
6c59307a 401 int blocksize, dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *txp);
50c957f7
NB
402int dmu_object_reclaim_dnsize(objset_t *os, uint64_t object,
403 dmu_object_type_t ot, int blocksize, dmu_object_type_t bonustype,
404 int bonuslen, int dnodesize, dmu_tx_t *txp);
34dc7c2f
BB
405
406/*
407 * Free an object from this objset.
408 *
409 * The object's data will be freed as well (ie. you don't need to call
410 * dmu_free(object, 0, -1, tx)).
411 *
412 * The object need not be held in the transaction.
413 *
414 * If there are any holds on this object's buffers (via dmu_buf_hold()),
415 * or tx holds on the object (via dmu_tx_hold_object()), you can not
416 * free it; it fails and returns EBUSY.
417 *
418 * If the object is not allocated, it fails and returns ENOENT.
419 *
420 * Return 0 on success, or EBUSY or ENOENT as specified above.
421 */
422int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx);
423
424/*
425 * Find the next allocated or free object.
426 *
427 * The objectp parameter is in-out. It will be updated to be the next
428 * object which is allocated. Ignore objects which have not been
429 * modified since txg.
430 *
431 * XXX Can only be called on a objset with no dirty data.
432 *
433 * Returns 0 on success, or ENOENT if there are no more objects.
434 */
435int dmu_object_next(objset_t *os, uint64_t *objectp,
436 boolean_t hole, uint64_t txg);
437
b5256303
TC
438/*
439 * Set the number of levels on a dnode. nlevels must be greater than the
440 * current number of levels or an EINVAL will be returned.
441 */
442int dmu_object_set_nlevels(objset_t *os, uint64_t object, int nlevels,
443 dmu_tx_t *tx);
444
34dc7c2f
BB
445/*
446 * Set the data blocksize for an object.
447 *
448 * The object cannot have any blocks allcated beyond the first. If
449 * the first block is allocated already, the new size must be greater
450 * than the current block size. If these conditions are not met,
451 * ENOTSUP will be returned.
452 *
453 * Returns 0 on success, or EBUSY if there are any holds on the object
454 * contents, or ENOTSUP as described above.
455 */
456int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size,
457 int ibs, dmu_tx_t *tx);
458
ae76f45c
TC
459/*
460 * Manually set the maxblkid on a dnode. This will adjust nlevels accordingly
461 * to accommodate the change.
462 */
463int dmu_object_set_maxblkid(objset_t *os, uint64_t object, uint64_t maxblkid,
464 dmu_tx_t *tx);
465
34dc7c2f
BB
466/*
467 * Set the checksum property on a dnode. The new checksum algorithm will
468 * apply to all newly written blocks; existing blocks will not be affected.
469 */
470void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum,
471 dmu_tx_t *tx);
472
473/*
474 * Set the compress property on a dnode. The new compression algorithm will
475 * apply to all newly written blocks; existing blocks will not be affected.
476 */
477void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress,
478 dmu_tx_t *tx);
479
9b840763 480
a1d477c2
MA
481int dmu_object_remap_indirects(objset_t *os, uint64_t object, uint64_t txg);
482
9b840763 483void dmu_write_embedded(objset_t *os, uint64_t object, uint64_t offset,
9b67f605
MA
484 void *data, uint8_t etype, uint8_t comp, int uncompressed_size,
485 int compressed_size, int byteorder, dmu_tx_t *tx);
486
34dc7c2f 487/*
428870ff 488 * Decide how to write a block: checksum, compression, number of copies, etc.
34dc7c2f 489 */
428870ff
BB
490#define WP_NOFILL 0x1
491#define WP_DMU_SYNC 0x2
492#define WP_SPILL 0x4
493
82644107
MA
494void dmu_write_policy(objset_t *os, dnode_t *dn, int level, int wp,
495 struct zio_prop *zp);
b5256303 496
34dc7c2f
BB
497/*
498 * The bonus data is accessed more or less like a regular buffer.
499 * You must dmu_bonus_hold() to get the buffer, which will give you a
500 * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus
a1d477c2
MA
501 * data. As with any normal buffer, you must call dmu_buf_will_dirty()
502 * before modifying it, and the
34dc7c2f
BB
503 * object must be held in an assigned transaction before calling
504 * dmu_buf_will_dirty. You may use dmu_buf_set_user() on the bonus
4e95cc99 505 * buffer as well. You must release what you hold with dmu_buf_rele().
e49f1e20
WA
506 *
507 * Returns ENOENT, EIO, or 0.
34dc7c2f 508 */
b5256303
TC
509int dmu_bonus_hold_impl(objset_t *os, uint64_t object, void *tag,
510 uint32_t flags, dmu_buf_t **dbp);
34dc7c2f
BB
511int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **);
512int dmu_bonus_max(void);
513int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *);
428870ff 514int dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *);
572e2857 515dmu_object_type_t dmu_get_bonustype(dmu_buf_t *);
428870ff
BB
516int dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *);
517
518/*
519 * Special spill buffer support used by "SA" framework
520 */
521
e7504d7a
TC
522int dmu_spill_hold_by_bonus(dmu_buf_t *bonus, uint32_t flags, void *tag,
523 dmu_buf_t **dbp);
2bce8049 524int dmu_spill_hold_by_dnode(dnode_t *dn, uint32_t flags,
428870ff
BB
525 void *tag, dmu_buf_t **dbp);
526int dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
34dc7c2f
BB
527
528/*
529 * Obtain the DMU buffer from the specified object which contains the
530 * specified offset. dmu_buf_hold() puts a "hold" on the buffer, so
531 * that it will remain in memory. You must release the hold with
4e95cc99
JE
532 * dmu_buf_rele(). You must not access the dmu_buf_t after releasing
533 * what you hold. You must have a hold on any dmu_buf_t* you pass to the DMU.
34dc7c2f
BB
534 *
535 * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill
536 * on the returned buffer before reading or writing the buffer's
537 * db_data. The comments for those routines describe what particular
538 * operations are valid after calling them.
539 *
540 * The object number must be a valid, allocated object number.
541 */
542int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset,
428870ff 543 void *tag, dmu_buf_t **, int flags);
2bce8049
MA
544int dmu_buf_hold_by_dnode(dnode_t *dn, uint64_t offset,
545 void *tag, dmu_buf_t **dbp, int flags);
6ebebace
JG
546
547/*
548 * Add a reference to a dmu buffer that has already been held via
549 * dmu_buf_hold() in the current context.
550 */
34dc7c2f 551void dmu_buf_add_ref(dmu_buf_t *db, void* tag);
6ebebace
JG
552
553/*
554 * Attempt to add a reference to a dmu buffer that is in an unknown state,
555 * using a pointer that may have been invalidated by eviction processing.
556 * The request will succeed if the passed in dbuf still represents the
557 * same os/object/blkid, is ineligible for eviction, and has at least
558 * one hold by a user other than the syncer.
559 */
560boolean_t dmu_buf_try_add_ref(dmu_buf_t *, objset_t *os, uint64_t object,
561 uint64_t blkid, void *tag);
562
34dc7c2f
BB
563void dmu_buf_rele(dmu_buf_t *db, void *tag);
564uint64_t dmu_buf_refcount(dmu_buf_t *db);
cd32e5db 565uint64_t dmu_buf_user_refcount(dmu_buf_t *db);
34dc7c2f
BB
566
567/*
568 * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a
569 * range of an object. A pointer to an array of dmu_buf_t*'s is
570 * returned (in *dbpp).
571 *
572 * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and
573 * frees the array. The hold on the array of buffers MUST be released
574 * with dmu_buf_rele_array. You can NOT release the hold on each buffer
575 * individually with dmu_buf_rele.
576 */
577int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset,
7f60329a
MA
578 uint64_t length, boolean_t read, void *tag,
579 int *numbufsp, dmu_buf_t ***dbpp);
34dc7c2f
BB
580void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag);
581
0c66c32d
JG
582typedef void dmu_buf_evict_func_t(void *user_ptr);
583
34dc7c2f 584/*
0c66c32d
JG
585 * A DMU buffer user object may be associated with a dbuf for the
586 * duration of its lifetime. This allows the user of a dbuf (client)
587 * to attach private data to a dbuf (e.g. in-core only data such as a
588 * dnode_children_t, zap_t, or zap_leaf_t) and be optionally notified
589 * when that dbuf has been evicted. Clients typically respond to the
590 * eviction notification by freeing their private data, thus ensuring
591 * the same lifetime for both dbuf and private data.
34dc7c2f 592 *
0c66c32d
JG
593 * The mapping from a dmu_buf_user_t to any client private data is the
594 * client's responsibility. All current consumers of the API with private
595 * data embed a dmu_buf_user_t as the first member of the structure for
596 * their private data. This allows conversions between the two types
597 * with a simple cast. Since the DMU buf user API never needs access
598 * to the private data, other strategies can be employed if necessary
599 * or convenient for the client (e.g. using container_of() to do the
600 * conversion for private data that cannot have the dmu_buf_user_t as
601 * its first member).
34dc7c2f 602 *
0c66c32d
JG
603 * Eviction callbacks are executed without the dbuf mutex held or any
604 * other type of mechanism to guarantee that the dbuf is still available.
605 * For this reason, users must assume the dbuf has already been freed
606 * and not reference the dbuf from the callback context.
34dc7c2f 607 *
0c66c32d
JG
608 * Users requesting "immediate eviction" are notified as soon as the dbuf
609 * is only referenced by dirty records (dirties == holds). Otherwise the
610 * notification occurs after eviction processing for the dbuf begins.
34dc7c2f 611 */
0c66c32d
JG
612typedef struct dmu_buf_user {
613 /*
614 * Asynchronous user eviction callback state.
615 */
616 taskq_ent_t dbu_tqent;
617
39efbde7
GM
618 /*
619 * This instance's eviction function pointers.
620 *
621 * dbu_evict_func_sync is called synchronously and then
622 * dbu_evict_func_async is executed asynchronously on a taskq.
623 */
624 dmu_buf_evict_func_t *dbu_evict_func_sync;
625 dmu_buf_evict_func_t *dbu_evict_func_async;
0c66c32d
JG
626#ifdef ZFS_DEBUG
627 /*
628 * Pointer to user's dbuf pointer. NULL for clients that do
629 * not associate a dbuf with their user data.
630 *
631 * The dbuf pointer is cleared upon eviction so as to catch
632 * use-after-evict bugs in clients.
633 */
634 dmu_buf_t **dbu_clear_on_evict_dbufp;
635#endif
636} dmu_buf_user_t;
637
34dc7c2f 638/*
0c66c32d
JG
639 * Initialize the given dmu_buf_user_t instance with the eviction function
640 * evict_func, to be called when the user is evicted.
641 *
642 * NOTE: This function should only be called once on a given dmu_buf_user_t.
643 * To allow enforcement of this, dbu must already be zeroed on entry.
34dc7c2f 644 */
c4434877 645/*ARGSUSED*/
0c66c32d 646static inline void
39efbde7
GM
647dmu_buf_init_user(dmu_buf_user_t *dbu, dmu_buf_evict_func_t *evict_func_sync,
648 dmu_buf_evict_func_t *evict_func_async, dmu_buf_t **clear_on_evict_dbufp)
0c66c32d 649{
39efbde7
GM
650 ASSERT(dbu->dbu_evict_func_sync == NULL);
651 ASSERT(dbu->dbu_evict_func_async == NULL);
652
653 /* must have at least one evict func */
654 IMPLY(evict_func_sync == NULL, evict_func_async != NULL);
655 dbu->dbu_evict_func_sync = evict_func_sync;
656 dbu->dbu_evict_func_async = evict_func_async;
f467b05a 657 taskq_init_ent(&dbu->dbu_tqent);
0c66c32d
JG
658#ifdef ZFS_DEBUG
659 dbu->dbu_clear_on_evict_dbufp = clear_on_evict_dbufp;
660#endif
661}
34dc7c2f
BB
662
663/*
0c66c32d
JG
664 * Attach user data to a dbuf and mark it for normal (when the dbuf's
665 * data is cleared or its reference count goes to zero) eviction processing.
666 *
667 * Returns NULL on success, or the existing user if another user currently
668 * owns the buffer.
669 */
670void *dmu_buf_set_user(dmu_buf_t *db, dmu_buf_user_t *user);
671
672/*
673 * Attach user data to a dbuf and mark it for immediate (its dirty and
674 * reference counts are equal) eviction processing.
675 *
676 * Returns NULL on success, or the existing user if another user currently
677 * owns the buffer.
678 */
679void *dmu_buf_set_user_ie(dmu_buf_t *db, dmu_buf_user_t *user);
680
681/*
682 * Replace the current user of a dbuf.
683 *
684 * If given the current user of a dbuf, replaces the dbuf's user with
685 * "new_user" and returns the user data pointer that was replaced.
686 * Otherwise returns the current, and unmodified, dbuf user pointer.
687 */
688void *dmu_buf_replace_user(dmu_buf_t *db,
689 dmu_buf_user_t *old_user, dmu_buf_user_t *new_user);
690
691/*
692 * Remove the specified user data for a DMU buffer.
693 *
694 * Returns the user that was removed on success, or the current user if
695 * another user currently owns the buffer.
696 */
697void *dmu_buf_remove_user(dmu_buf_t *db, dmu_buf_user_t *user);
698
699/*
700 * Returns the user data (dmu_buf_user_t *) associated with this dbuf.
34dc7c2f
BB
701 */
702void *dmu_buf_get_user(dmu_buf_t *db);
703
8bea9815 704objset_t *dmu_buf_get_objset(dmu_buf_t *db);
2bce8049
MA
705dnode_t *dmu_buf_dnode_enter(dmu_buf_t *db);
706void dmu_buf_dnode_exit(dmu_buf_t *db);
8bea9815 707
0c66c32d
JG
708/* Block until any in-progress dmu buf user evictions complete. */
709void dmu_buf_user_evict_wait(void);
710
03c6040b
GW
711/*
712 * Returns the blkptr associated with this dbuf, or NULL if not set.
713 */
714struct blkptr *dmu_buf_get_blkptr(dmu_buf_t *db);
715
34dc7c2f
BB
716/*
717 * Indicate that you are going to modify the buffer's data (db_data).
718 *
719 * The transaction (tx) must be assigned to a txg (ie. you've called
720 * dmu_tx_assign()). The buffer's object must be held in the tx
721 * (ie. you've called dmu_tx_hold_object(tx, db->db_object)).
722 */
723void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx);
0c03d21a
MA
724void dmu_buf_set_crypt_params(dmu_buf_t *db_fake, boolean_t byteorder,
725 const uint8_t *salt, const uint8_t *iv, const uint8_t *mac, dmu_tx_t *tx);
34dc7c2f
BB
726
727/*
728 * You must create a transaction, then hold the objects which you will
729 * (or might) modify as part of this transaction. Then you must assign
730 * the transaction to a transaction group. Once the transaction has
731 * been assigned, you can modify buffers which belong to held objects as
732 * part of this transaction. You can't modify buffers before the
733 * transaction has been assigned; you can't modify buffers which don't
734 * belong to objects which this transaction holds; you can't hold
735 * objects once the transaction has been assigned. You may hold an
736 * object which you are going to free (with dmu_object_free()), but you
737 * don't have to.
738 *
739 * You can abort the transaction before it has been assigned.
740 *
741 * Note that you may hold buffers (with dmu_buf_hold) at any time,
742 * regardless of transaction state.
743 */
744
745#define DMU_NEW_OBJECT (-1ULL)
746#define DMU_OBJECT_END (-1ULL)
747
748dmu_tx_t *dmu_tx_create(objset_t *os);
749void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len);
0eef1bde 750void dmu_tx_hold_write_by_dnode(dmu_tx_t *tx, dnode_t *dn, uint64_t off,
751 int len);
34dc7c2f
BB
752void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off,
753 uint64_t len);
0eef1bde 754void dmu_tx_hold_free_by_dnode(dmu_tx_t *tx, dnode_t *dn, uint64_t off,
755 uint64_t len);
a1d477c2 756void dmu_tx_hold_remap_l1indirect(dmu_tx_t *tx, uint64_t object);
9babb374 757void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name);
0eef1bde 758void dmu_tx_hold_zap_by_dnode(dmu_tx_t *tx, dnode_t *dn, int add,
759 const char *name);
34dc7c2f 760void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object);
0eef1bde 761void dmu_tx_hold_bonus_by_dnode(dmu_tx_t *tx, dnode_t *dn);
428870ff
BB
762void dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object);
763void dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow);
764void dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size);
34dc7c2f 765void dmu_tx_abort(dmu_tx_t *tx);
0735ecb3 766int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how);
34dc7c2f
BB
767void dmu_tx_wait(dmu_tx_t *tx);
768void dmu_tx_commit(dmu_tx_t *tx);
19d55079 769void dmu_tx_mark_netfree(dmu_tx_t *tx);
34dc7c2f 770
428870ff
BB
771/*
772 * To register a commit callback, dmu_tx_callback_register() must be called.
773 *
774 * dcb_data is a pointer to caller private data that is passed on as a
775 * callback parameter. The caller is responsible for properly allocating and
776 * freeing it.
777 *
778 * When registering a callback, the transaction must be already created, but
779 * it cannot be committed or aborted. It can be assigned to a txg or not.
780 *
781 * The callback will be called after the transaction has been safely written
782 * to stable storage and will also be called if the dmu_tx is aborted.
783 * If there is any error which prevents the transaction from being committed to
784 * disk, the callback will be called with a value of error != 0.
823d48bf 785 *
786 * When multiple callbacks are registered to the transaction, the callbacks
787 * will be called in reverse order to let Lustre, the only user of commit
788 * callback currently, take the fast path of its commit callback handling.
428870ff
BB
789 */
790typedef void dmu_tx_callback_func_t(void *dcb_data, int error);
791
792void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func,
793 void *dcb_data);
823d48bf 794void dmu_tx_do_callbacks(list_t *cb_list, int error);
428870ff 795
34dc7c2f
BB
796/*
797 * Free up the data blocks for a defined range of a file. If size is
9ae529ec 798 * -1, the range from offset to end-of-file is freed.
34dc7c2f
BB
799 */
800int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset,
440a3eb9 801 uint64_t size, dmu_tx_t *tx);
b128c09f 802int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset,
440a3eb9 803 uint64_t size);
b663a23d 804int dmu_free_long_object(objset_t *os, uint64_t object);
34dc7c2f
BB
805
806/*
807 * Convenience functions.
808 *
809 * Canfail routines will return 0 on success, or an errno if there is a
810 * nonrecoverable I/O error.
811 */
9babb374
BB
812#define DMU_READ_PREFETCH 0 /* prefetch */
813#define DMU_READ_NO_PREFETCH 1 /* don't prefetch */
b5256303 814#define DMU_READ_NO_DECRYPT 2 /* don't decrypt */
34dc7c2f 815int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
9babb374 816 void *buf, uint32_t flags);
0eef1bde 817int dmu_read_by_dnode(dnode_t *dn, uint64_t offset, uint64_t size, void *buf,
818 uint32_t flags);
34dc7c2f
BB
819void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
820 const void *buf, dmu_tx_t *tx);
0eef1bde 821void dmu_write_by_dnode(dnode_t *dn, uint64_t offset, uint64_t size,
822 const void *buf, dmu_tx_t *tx);
b128c09f
BB
823void dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
824 dmu_tx_t *tx);
60101509 825#ifdef _KERNEL
61e90960 826#include <linux/blkdev_compat.h>
872e8d26 827int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size);
804e0504 828int dmu_read_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size);
5228cf01 829int dmu_read_uio_dnode(dnode_t *dn, struct uio *uio, uint64_t size);
872e8d26
BB
830int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size,
831 dmu_tx_t *tx);
832int dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size,
833 dmu_tx_t *tx);
5228cf01
RY
834int dmu_write_uio_dnode(dnode_t *dn, struct uio *uio, uint64_t size,
835 dmu_tx_t *tx);
872e8d26 836#endif
9babb374
BB
837struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size);
838void dmu_return_arcbuf(struct arc_buf *buf);
440a3eb9
TC
839void dmu_assign_arcbuf_by_dnode(dnode_t *dn, uint64_t offset,
840 struct arc_buf *buf, dmu_tx_t *tx);
841void dmu_assign_arcbuf_by_dbuf(dmu_buf_t *handle, uint64_t offset,
842 struct arc_buf *buf, dmu_tx_t *tx);
843#define dmu_assign_arcbuf dmu_assign_arcbuf_by_dbuf
b5256303
TC
844void dmu_copy_from_buf(objset_t *os, uint64_t object, uint64_t offset,
845 dmu_buf_t *handle, dmu_tx_t *tx);
5a6765cf 846#ifdef HAVE_UIO_ZEROCOPY
428870ff
BB
847int dmu_xuio_init(struct xuio *uio, int niov);
848void dmu_xuio_fini(struct xuio *uio);
849int dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off,
850 size_t n);
851int dmu_xuio_cnt(struct xuio *uio);
852struct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i);
853void dmu_xuio_clear(struct xuio *uio, int i);
5a6765cf 854#endif /* HAVE_UIO_ZEROCOPY */
0bc8fd78
BB
855void xuio_stat_wbuf_copied(void);
856void xuio_stat_wbuf_nocopy(void);
34dc7c2f
BB
857
858extern int zfs_prefetch_disable;
f1512ee6 859extern int zfs_max_recordsize;
34dc7c2f
BB
860
861/*
862 * Asynchronously try to read in the data.
863 */
fcff0f35
PD
864void dmu_prefetch(objset_t *os, uint64_t object, int64_t level, uint64_t offset,
865 uint64_t len, enum zio_priority pri);
34dc7c2f
BB
866
867typedef struct dmu_object_info {
428870ff 868 /* All sizes are in bytes unless otherwise indicated. */
34dc7c2f
BB
869 uint32_t doi_data_block_size;
870 uint32_t doi_metadata_block_size;
34dc7c2f
BB
871 dmu_object_type_t doi_type;
872 dmu_object_type_t doi_bonus_type;
428870ff 873 uint64_t doi_bonus_size;
34dc7c2f
BB
874 uint8_t doi_indirection; /* 2 = dnode->indirect->data */
875 uint8_t doi_checksum;
876 uint8_t doi_compress;
6c59307a
MA
877 uint8_t doi_nblkptr;
878 uint8_t doi_pad[4];
50c957f7 879 uint64_t doi_dnodesize;
428870ff
BB
880 uint64_t doi_physical_blocks_512; /* data + metadata, 512b blks */
881 uint64_t doi_max_offset;
882 uint64_t doi_fill_count; /* number of non-empty blocks */
34dc7c2f
BB
883} dmu_object_info_t;
884
b01615d5 885typedef void (*const arc_byteswap_func_t)(void *buf, size_t size);
34dc7c2f
BB
886
887typedef struct dmu_object_type_info {
9ae529ec 888 dmu_object_byteswap_t ot_byteswap;
34dc7c2f 889 boolean_t ot_metadata;
2e5dc449 890 boolean_t ot_dbuf_metadata_cache;
b5256303 891 boolean_t ot_encrypt;
34dc7c2f
BB
892 char *ot_name;
893} dmu_object_type_info_t;
894
b01615d5
RY
895typedef const struct dmu_object_byteswap_info {
896 arc_byteswap_func_t ob_func;
9ae529ec
CS
897 char *ob_name;
898} dmu_object_byteswap_info_t;
899
34dc7c2f 900extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES];
9ae529ec 901extern const dmu_object_byteswap_info_t dmu_ot_byteswap[DMU_BSWAP_NUMFUNCS];
34dc7c2f
BB
902
903/*
904 * Get information on a DMU object.
905 *
906 * Return 0 on success or ENOENT if object is not allocated.
907 *
908 * If doi is NULL, just indicates whether the object exists.
909 */
910int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi);
e0b0ca98 911void __dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi);
e49f1e20 912/* Like dmu_object_info, but faster if you have a held dnode in hand. */
2bce8049 913void dmu_object_info_from_dnode(dnode_t *dn, dmu_object_info_t *doi);
e49f1e20 914/* Like dmu_object_info, but faster if you have a held dbuf in hand. */
34dc7c2f 915void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi);
e49f1e20
WA
916/*
917 * Like dmu_object_info_from_db, but faster still when you only care about
918 * the size. This is specifically optimized for zfs_getattr().
919 */
34dc7c2f
BB
920void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize,
921 u_longlong_t *nblk512);
922
50c957f7
NB
923void dmu_object_dnsize_from_db(dmu_buf_t *db, int *dnsize);
924
34dc7c2f
BB
925typedef struct dmu_objset_stats {
926 uint64_t dds_num_clones; /* number of clones of this */
927 uint64_t dds_creation_txg;
928 uint64_t dds_guid;
929 dmu_objset_type_t dds_type;
930 uint8_t dds_is_snapshot;
931 uint8_t dds_inconsistent;
eca7b760 932 char dds_origin[ZFS_MAX_DATASET_NAME_LEN];
34dc7c2f
BB
933} dmu_objset_stats_t;
934
935/*
936 * Get stats on a dataset.
937 */
938void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
939
940/*
941 * Add entries to the nvlist for all the objset's properties. See
942 * zfs_prop_table[] and zfs(1m) for details on the properties.
943 */
944void dmu_objset_stats(objset_t *os, struct nvlist *nv);
945
946/*
947 * Get the space usage statistics for statvfs().
948 *
949 * refdbytes is the amount of space "referenced" by this objset.
950 * availbytes is the amount of space available to this objset, taking
951 * into account quotas & reservations, assuming that no other objsets
952 * use the space first. These values correspond to the 'referenced' and
953 * 'available' properties, described in the zfs(1m) manpage.
954 *
955 * usedobjs and availobjs are the number of objects currently allocated,
956 * and available.
957 */
958void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
959 uint64_t *usedobjsp, uint64_t *availobjsp);
960
961/*
962 * The fsid_guid is a 56-bit ID that can change to avoid collisions.
963 * (Contrast with the ds_guid which is a 64-bit ID that will never
964 * change, so there is a small probability that it will collide.)
965 */
966uint64_t dmu_objset_fsid_guid(objset_t *os);
967
428870ff
BB
968/*
969 * Get the [cm]time for an objset's snapshot dir
970 */
6413c95f 971inode_timespec_t dmu_objset_snap_cmtime(objset_t *os);
428870ff 972
34dc7c2f
BB
973int dmu_objset_is_snapshot(objset_t *os);
974
975extern struct spa *dmu_objset_spa(objset_t *os);
976extern struct zilog *dmu_objset_zil(objset_t *os);
977extern struct dsl_pool *dmu_objset_pool(objset_t *os);
978extern struct dsl_dataset *dmu_objset_ds(objset_t *os);
979extern void dmu_objset_name(objset_t *os, char *buf);
980extern dmu_objset_type_t dmu_objset_type(objset_t *os);
981extern uint64_t dmu_objset_id(objset_t *os);
50c957f7 982extern uint64_t dmu_objset_dnodesize(objset_t *os);
faf0f58c
MA
983extern zfs_sync_type_t dmu_objset_syncprop(objset_t *os);
984extern zfs_logbias_op_t dmu_objset_logbias(objset_t *os);
34dc7c2f
BB
985extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name,
986 uint64_t *id, uint64_t *offp, boolean_t *case_conflict);
6772fb67 987extern int dmu_snapshot_lookup(objset_t *os, const char *name, uint64_t *val);
34dc7c2f
BB
988extern int dmu_snapshot_realname(objset_t *os, char *name, char *real,
989 int maxlen, boolean_t *conflict);
990extern int dmu_dir_list_next(objset_t *os, int namelen, char *name,
991 uint64_t *idp, uint64_t *offp);
9babb374 992
428870ff 993typedef int objset_used_cb_t(dmu_object_type_t bonustype,
9c5167d1 994 void *bonus, uint64_t *userp, uint64_t *groupp, uint64_t *projectp);
9babb374
BB
995extern void dmu_objset_register_type(dmu_objset_type_t ost,
996 objset_used_cb_t *cb);
34dc7c2f
BB
997extern void dmu_objset_set_user(objset_t *os, void *user_ptr);
998extern void *dmu_objset_get_user(objset_t *os);
999
1000/*
1001 * Return the txg number for the given assigned transaction.
1002 */
1003uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
1004
1005/*
1006 * Synchronous write.
1007 * If a parent zio is provided this function initiates a write on the
1008 * provided buffer as a child of the parent zio.
1009 * In the absence of a parent zio, the write is completed synchronously.
1010 * At write completion, blk is filled with the bp of the written block.
1011 * Note that while the data covered by this function will be on stable
1012 * storage when the write completes this new data does not become a
1013 * permanent part of the file until the associated transaction commits.
1014 */
428870ff
BB
1015
1016/*
1017 * {zfs,zvol,ztest}_get_done() args
1018 */
1019typedef struct zgd {
1ce23dca 1020 struct lwb *zgd_lwb;
428870ff
BB
1021 struct blkptr *zgd_bp;
1022 dmu_buf_t *zgd_db;
1023 struct rl *zgd_rl;
1024 void *zgd_private;
1025} zgd_t;
1026
1027typedef void dmu_sync_cb_t(zgd_t *arg, int error);
1028int dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd);
34dc7c2f
BB
1029
1030/*
1031 * Find the next hole or data block in file starting at *off
1032 * Return found offset in *off. Return ESRCH for end of file.
1033 */
1034int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole,
1035 uint64_t *off);
1036
1037/*
1038 * Initial setup and final teardown.
1039 */
1040extern void dmu_init(void);
1041extern void dmu_fini(void);
1042
1043typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp,
1044 uint64_t object, uint64_t offset, int len);
1045void dmu_traverse_objset(objset_t *os, uint64_t txg_start,
1046 dmu_traverse_cb_t cb, void *arg);
1047
13fe0198
MA
1048int dmu_diff(const char *tosnap_name, const char *fromsnap_name,
1049 struct vnode *vp, offset_t *offp);
572e2857 1050
34dc7c2f
BB
1051/* CRC64 table */
1052#define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */
1053extern uint64_t zfs_crc64_table[256];
1054
1055#ifdef __cplusplus
1056}
1057#endif
1058
1059#endif /* _SYS_DMU_H */