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