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