dmu.h revision 744947dc83c634d985ed3ad79ac9c5e28d1865fd
2fa9e406ahrens * CDDL HEADER START
3fa9e406ahrens *
4fa9e406ahrens * The contents of this file are subject to the terms of the
5ea8dc4beschrock * Common Development and Distribution License (the "License").
6ea8dc4beschrock * You may not use this file except in compliance with the License.
7fa9e406ahrens *
8fa9e406ahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e406ahrens * or
10fa9e406ahrens * See the License for the specific language governing permissions
11fa9e406ahrens * and limitations under the License.
12fa9e406ahrens *
13fa9e406ahrens * When distributing Covered Code, include this CDDL HEADER in each
14fa9e406ahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e406ahrens * If applicable, add the following below this CDDL HEADER, with the
16fa9e406ahrens * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e406ahrens * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e406ahrens *
19fa9e406ahrens * CDDL HEADER END
20fa9e406ahrens */
2294d1a21Tim Haley * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23fa9e406ahrens */
2555da60bMark J Musante/* Portions Copyright 2010 Robert Milkowski */
2655da60bMark J Musante
27fa9e406ahrens#ifndef	_SYS_DMU_H
28fa9e406ahrens#define	_SYS_DMU_H
31fa9e406ahrens * This file describes the interface that the DMU provides for its
32fa9e406ahrens * consumers.
33fa9e406ahrens *
34fa9e406ahrens * The DMU also interacts with the SPA.  That interface is described in
35fa9e406ahrens * dmu_spa.h.
36fa9e406ahrens */
38fa9e406ahrens#include <sys/inttypes.h>
39fa9e406ahrens#include <sys/types.h>
40fa9e406ahrens#include <sys/param.h>
41ecd6cf8marks#include <sys/cred.h>
4271eb053Chris Kirby#include <sys/time.h>
44fa9e406ahrens#ifdef	__cplusplus
45fa9e406ahrensextern "C" {
48fa9e406ahrensstruct uio;
49c242f9achunli zhang - Sun Microsystems - Irvine United Statesstruct xuio;
5044eda4dmaybeestruct page;
51fa9e406ahrensstruct vnode;
52fa9e406ahrensstruct spa;
53fa9e406ahrensstruct zilog;
54fa9e406ahrensstruct zio;
55fa9e406ahrensstruct blkptr;
56fa9e406ahrensstruct zap_cursor;
57fa9e406ahrensstruct dsl_dataset;
58fa9e406ahrensstruct dsl_pool;
59fa9e406ahrensstruct dnode;
60fa9e406ahrensstruct drr_begin;
61fa9e406ahrensstruct drr_end;
6244cd46cbillmstruct zbookmark;
6344cd46cbillmstruct spa;
64a2eea2eahrensstruct nvlist;
652fdbea2Aleksandr Guzovskiystruct arc_buf;
66b24ab67Jeff Bonwickstruct zio_prop;
670a586ceMark Shellenbaumstruct sa_handle;
69fa9e406ahrenstypedef struct objset objset_t;
70fa9e406ahrenstypedef struct dmu_tx dmu_tx_t;
71fa9e406ahrenstypedef struct dsl_dir dsl_dir_t;
73fa9e406ahrenstypedef enum dmu_object_type {
74fa9e406ahrens	DMU_OT_NONE,
75fa9e406ahrens	/* general: */
76fa9e406ahrens	DMU_OT_OBJECT_DIRECTORY,	/* ZAP */
77fa9e406ahrens	DMU_OT_OBJECT_ARRAY,		/* UINT64 */
78fa9e406ahrens	DMU_OT_PACKED_NVLIST,		/* UINT8 (XDR by nvlist_pack/unpack) */
79fa9e406ahrens	DMU_OT_PACKED_NVLIST_SIZE,	/* UINT64 */
80cde58dbMatthew Ahrens	DMU_OT_BPOBJ,			/* UINT64 */
81cde58dbMatthew Ahrens	DMU_OT_BPOBJ_HDR,		/* UINT64 */
82fa9e406ahrens	/* spa: */
83fa9e406ahrens	DMU_OT_SPACE_MAP_HEADER,	/* UINT64 */
84fa9e406ahrens	DMU_OT_SPACE_MAP,		/* UINT64 */
85fa9e406ahrens	/* zil: */
86fa9e406ahrens	DMU_OT_INTENT_LOG,		/* UINT64 */
87fa9e406ahrens	/* dmu: */
88fa9e406ahrens	DMU_OT_DNODE,			/* DNODE */
89fa9e406ahrens	DMU_OT_OBJSET,			/* OBJSET */
90fa9e406ahrens	/* dsl: */
911649cd4tabriz	DMU_OT_DSL_DIR,			/* UINT64 */
9287e5029ahrens	DMU_OT_DSL_DIR_CHILD_MAP,	/* ZAP */
9387e5029ahrens	DMU_OT_DSL_DS_SNAP_MAP,		/* ZAP */
94fa9e406ahrens	DMU_OT_DSL_PROPS,		/* ZAP */
951649cd4tabriz	DMU_OT_DSL_DATASET,		/* UINT64 */
96fa9e406ahrens	/* zpl: */
97fa9e406ahrens	DMU_OT_ZNODE,			/* ZNODE */
98da6c28aamw	DMU_OT_OLDACL,			/* Old ACL */
99fa9e406ahrens	DMU_OT_PLAIN_FILE_CONTENTS,	/* UINT8 */
100fa9e406ahrens	DMU_OT_DIRECTORY_CONTENTS,	/* ZAP */
101fa9e406ahrens	DMU_OT_MASTER_NODE,		/* ZAP */
102893a6d3ahrens	DMU_OT_UNLINKED_SET,		/* ZAP */
103fa9e406ahrens	/* zvol: */
104fa9e406ahrens	DMU_OT_ZVOL,			/* UINT8 */
105fa9e406ahrens	DMU_OT_ZVOL_PROP,		/* ZAP */
106fa9e406ahrens	/* other; for testing only! */
107fa9e406ahrens	DMU_OT_PLAIN_OTHER,		/* UINT8 */
108fa9e406ahrens	DMU_OT_UINT64_OTHER,		/* UINT64 */
109fa9e406ahrens	DMU_OT_ZAP_OTHER,		/* ZAP */
110ea8dc4beschrock	/* new object types: */
111ea8dc4beschrock	DMU_OT_ERROR_LOG,		/* ZAP */
11206eeb2aek	DMU_OT_SPA_HISTORY,		/* UINT8 */
11306eeb2aek	DMU_OT_SPA_HISTORY_OFFSETS,	/* spa_his_phys_t */
114b1b8ab3lling	DMU_OT_POOL_PROPS,		/* ZAP */
115ecd6cf8marks	DMU_OT_DSL_PERMS,		/* ZAP */
116da6c28aamw	DMU_OT_ACL,			/* ACL */
117da6c28aamw	DMU_OT_SYSACL,			/* SYSACL */
118da6c28aamw	DMU_OT_FUID,			/* FUID table (Packed NVLIST UINT8) */
119da6c28aamw	DMU_OT_FUID_SIZE,		/* FUID table size UINT64 */
120088f389ahrens	DMU_OT_NEXT_CLONES,		/* ZAP */
1213f9d6adLin Ling	DMU_OT_SCAN_QUEUE,		/* ZAP */
1221484342Matthew Ahrens	DMU_OT_USERGROUP_USED,		/* ZAP */
1231484342Matthew Ahrens	DMU_OT_USERGROUP_QUOTA,		/* ZAP */
124842727cChris Kirby	DMU_OT_USERREFS,		/* ZAP */
125b24ab67Jeff Bonwick	DMU_OT_DDT_ZAP,			/* ZAP */
126b24ab67Jeff Bonwick	DMU_OT_DDT_STATS,		/* ZAP */
1270a586ceMark Shellenbaum	DMU_OT_SA,			/* System attr */
1280a586ceMark Shellenbaum	DMU_OT_SA_MASTER_NODE,		/* ZAP */
1290a586ceMark Shellenbaum	DMU_OT_SA_ATTR_REGISTRATION,	/* ZAP */
1300a586ceMark Shellenbaum	DMU_OT_SA_ATTR_LAYOUTS,		/* ZAP */
1313f9d6adLin Ling	DMU_OT_SCAN_XLATE,		/* ZAP */
1323f9d6adLin Ling	DMU_OT_DEDUP,			/* fake dedup BP from ddt_bp_create() */
133cde58dbMatthew Ahrens	DMU_OT_DEADLIST,		/* ZAP */
134cde58dbMatthew Ahrens	DMU_OT_DEADLIST_HDR,		/* UINT64 */
135cde58dbMatthew Ahrens	DMU_OT_DSL_CLONES,		/* ZAP */
136cde58dbMatthew Ahrens	DMU_OT_BPOBJ_SUBOBJ,		/* UINT64 */
137fa9e406ahrens	DMU_OT_NUMTYPES
138fa9e406ahrens} dmu_object_type_t;
140fa9e406ahrenstypedef enum dmu_objset_type {
141fa9e406ahrens	DMU_OST_NONE,
142fa9e406ahrens	DMU_OST_META,
143fa9e406ahrens	DMU_OST_ZFS,
144fa9e406ahrens	DMU_OST_ZVOL,
145fa9e406ahrens	DMU_OST_OTHER,			/* For testing only! */
146fa9e406ahrens	DMU_OST_ANY,			/* Be careful! */
147fa9e406ahrens	DMU_OST_NUMTYPES
148fa9e406ahrens} dmu_objset_type_t;
150fa9e406ahrensvoid byteswap_uint64_array(void *buf, size_t size);
151fa9e406ahrensvoid byteswap_uint32_array(void *buf, size_t size);
152fa9e406ahrensvoid byteswap_uint16_array(void *buf, size_t size);
153fa9e406ahrensvoid byteswap_uint8_array(void *buf, size_t size);
154fa9e406ahrensvoid zap_byteswap(void *buf, size_t size);
155da6c28aamwvoid zfs_oldacl_byteswap(void *buf, size_t size);
156fa9e406ahrensvoid zfs_acl_byteswap(void *buf, size_t size);
157fa9e406ahrensvoid zfs_znode_byteswap(void *buf, size_t size);
1590b69c2fahrens#define	DS_FIND_SNAPSHOTS	(1<<0)
1600b69c2fahrens#define	DS_FIND_CHILDREN	(1<<1)
163fa9e406ahrens * The maximum number of bytes that can be accessed as part of one
164fa9e406ahrens * operation, including metadata.
165fa9e406ahrens */
166fa9e406ahrens#define	DMU_MAX_ACCESS (10<<20) /* 10MB */
167cdb0ab7maybee#define	DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */
1691484342Matthew Ahrens#define	DMU_USERUSED_OBJECT	(-1ULL)
1701484342Matthew Ahrens#define	DMU_GROUPUSED_OBJECT	(-2ULL)
171b24ab67Jeff Bonwick#define	DMU_DEADLIST_OBJECT	(-3ULL)
1721484342Matthew Ahrens
1740a586ceMark Shellenbaum * artificial blkids for bonus buffer and spill blocks
1750a586ceMark Shellenbaum */
1760a586ceMark Shellenbaum#define	DMU_BONUS_BLKID		(-1ULL)
1770a586ceMark Shellenbaum#define	DMU_SPILL_BLKID		(-2ULL)
1780a586ceMark Shellenbaum/*
179fa9e406ahrens * Public routines to create, destroy, open, and close objsets.
180fa9e406ahrens */
181503ad85Matthew Ahrensint dmu_objset_hold(const char *name, void *tag, objset_t **osp);
182503ad85Matthew Ahrensint dmu_objset_own(const char *name, dmu_objset_type_t type,
183503ad85Matthew Ahrens    boolean_t readonly, void *tag, objset_t **osp);
184503ad85Matthew Ahrensvoid dmu_objset_rele(objset_t *os, void *tag);
185503ad85Matthew Ahrensvoid dmu_objset_disown(objset_t *os, void *tag);
186503ad85Matthew Ahrensint dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp);
187503ad85Matthew Ahrens
1881934e92maybeeint dmu_objset_evict_dbufs(objset_t *os);
189ae46e4cMatthew Ahrensint dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
190ecd6cf8marks    void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
191ae46e4cMatthew Ahrensint dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin,
192ae46e4cMatthew Ahrens    uint64_t flags);
193842727cChris Kirbyint dmu_objset_destroy(const char *name, boolean_t defer);
194842727cChris Kirbyint dmu_snapshots_destroy(char *fsname, char *snapname, boolean_t defer);
195ea2f5b9Matthew Ahrensint dmu_objset_snapshot(char *fsname, char *snapname, struct nvlist *props,
196ea2f5b9Matthew Ahrens    boolean_t recursive);
197cdf5b4cmmusanteint dmu_objset_rename(const char *name, const char *newname,
198cdf5b4cmmusante    boolean_t recursive);
199fd13687Matthew Ahrensint dmu_objset_find(char *name, int func(const char *, void *), void *arg,
200fa9e406ahrens    int flags);
201fa9e406ahrensvoid dmu_objset_byteswap(void *buf, size_t size);
203fa9e406ahrenstypedef struct dmu_buf {
204fa9e406ahrens	uint64_t db_object;		/* object that this buffer is part of */
205fa9e406ahrens	uint64_t db_offset;		/* byte offset in this object */
206fa9e406ahrens	uint64_t db_size;		/* size of buffer in bytes */
207fa9e406ahrens	void *db_data;			/* data in buffer */
208fa9e406ahrens} dmu_buf_t;
210fa9e406ahrenstypedef void dmu_buf_evict_func_t(struct dmu_buf *db, void *user_ptr);
21399653d4eschrock * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
21499653d4eschrock */
215fa9e406ahrens#define	DMU_POOL_DIRECTORY_OBJECT	1
216fa9e406ahrens#define	DMU_POOL_CONFIG			"config"
217fa9e406ahrens#define	DMU_POOL_ROOT_DATASET		"root_dataset"
218cde58dbMatthew Ahrens#define	DMU_POOL_SYNC_BPOBJ		"sync_bplist"
219ea8dc4beschrock#define	DMU_POOL_ERRLOG_SCRUB		"errlog_scrub"
220ea8dc4beschrock#define	DMU_POOL_ERRLOG_LAST		"errlog_last"
22199653d4eschrock#define	DMU_POOL_SPARES			"spares"
22299653d4eschrock#define	DMU_POOL_DEFLATE		"deflate"
22306eeb2aek#define	DMU_POOL_HISTORY		"history"
224b1b8ab3lling#define	DMU_POOL_PROPS			"pool_props"
225fa94a07brendan#define	DMU_POOL_L2CACHE		"l2cache"
226ca45db4Chris Kirby#define	DMU_POOL_TMP_USERREFS		"tmp_userrefs"
227b24ab67Jeff Bonwick#define	DMU_POOL_DDT			"DDT-%s-%s-%s"
228b24ab67Jeff Bonwick#define	DMU_POOL_DDT_STATS		"DDT-statistics"
2293f9d6adLin Ling#define	DMU_POOL_CREATION_VERSION	"creation_version"
2303f9d6adLin Ling#define	DMU_POOL_SCAN			"scan"
231cde58dbMatthew Ahrens#define	DMU_POOL_FREE_BPOBJ		"free_bpobj"
234fa9e406ahrens * Allocate an object from this objset.  The range of object numbers
235fa9e406ahrens * available is (0, DN_MAX_OBJECT).  Object 0 is the meta-dnode.
236fa9e406ahrens *
237fa9e406ahrens * The transaction must be assigned to a txg.  The newly allocated
238fa9e406ahrens * object will be "held" in the transaction (ie. you can modify the
239fa9e406ahrens * newly allocated object in this transaction).
240fa9e406ahrens *
241fa9e406ahrens * dmu_object_alloc() chooses an object and returns it in *objectp.
242fa9e406ahrens *
243fa9e406ahrens * dmu_object_claim() allocates a specific object number.  If that
244fa9e406ahrens * number is already allocated, it fails and returns EEXIST.
245fa9e406ahrens *
246fa9e406ahrens * Return 0 on success, or ENOSPC or EEXIST as specified above.
247fa9e406ahrens */
248fa9e406ahrensuint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot,
249fa9e406ahrens    int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
250fa9e406ahrensint dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot,
251fa9e406ahrens    int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
252fa9e406ahrensint dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot,
2532bf405aMark Maybee    int blocksize, dmu_object_type_t bonustype, int bonuslen);
256fa9e406ahrens * Free an object from this objset.
257fa9e406ahrens *
258fa9e406ahrens * The object's data will be freed as well (ie. you don't need to call
259fa9e406ahrens * dmu_free(object, 0, -1, tx)).
260fa9e406ahrens *
261fa9e406ahrens * The object need not be held in the transaction.
262fa9e406ahrens *
263fa9e406ahrens * If there are any holds on this object's buffers (via dmu_buf_hold()),
264fa9e406ahrens * or tx holds on the object (via dmu_tx_hold_object()), you can not
265fa9e406ahrens * free it; it fails and returns EBUSY.
266fa9e406ahrens *
267fa9e406ahrens * If the object is not allocated, it fails and returns ENOENT.
268fa9e406ahrens *
269fa9e406ahrens * Return 0 on success, or EBUSY or ENOENT as specified above.
270fa9e406ahrens */
271fa9e406ahrensint dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx);
274fa9e406ahrens * Find the next allocated or free object.
275fa9e406ahrens *
276fa9e406ahrens * The objectp parameter is in-out.  It will be updated to be the next
2776754306ahrens * object which is allocated.  Ignore objects which have not been
2786754306ahrens * modified since txg.
279fa9e406ahrens *
280fa9e406ahrens * XXX Can only be called on a objset with no dirty data.
281fa9e406ahrens *
282fa9e406ahrens * Returns 0 on success, or ENOENT if there are no more objects.
283fa9e406ahrens */
2846754306ahrensint dmu_object_next(objset_t *os, uint64_t *objectp,
2856754306ahrens    boolean_t hole, uint64_t txg);
288fa9e406ahrens * Set the data blocksize for an object.
289fa9e406ahrens *
290fa9e406ahrens * The object cannot have any blocks allcated beyond the first.  If
291fa9e406ahrens * the first block is allocated already, the new size must be greater
292fa9e406ahrens * than the current block size.  If these conditions are not met,
293fa9e406ahrens * ENOTSUP will be returned.
294fa9e406ahrens *
295fa9e406ahrens * Returns 0 on success, or EBUSY if there are any holds on the object
296fa9e406ahrens * contents, or ENOTSUP as described above.
297fa9e406ahrens */
298fa9e406ahrensint dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size,
299fa9e406ahrens    int ibs, dmu_tx_t *tx);
302fa9e406ahrens * Set the checksum property on a dnode.  The new checksum algorithm will
303fa9e406ahrens * apply to all newly written blocks; existing blocks will not be affected.
304fa9e406ahrens */
305fa9e406ahrensvoid dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum,
306fa9e406ahrens    dmu_tx_t *tx);
309fa9e406ahrens * Set the compress property on a dnode.  The new compression algorithm will
310fa9e406ahrens * apply to all newly written blocks; existing blocks will not be affected.
311fa9e406ahrens */
312fa9e406ahrensvoid dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress,
313fa9e406ahrens    dmu_tx_t *tx);
316b24ab67Jeff Bonwick * Decide how to write a block: checksum, compression, number of copies, etc.
31744cd46cbillm */
318b24ab67Jeff Bonwick#define	WP_NOFILL	0x1
319b24ab67Jeff Bonwick#define	WP_DMU_SYNC	0x2
3200a586ceMark Shellenbaum#define	WP_SPILL	0x4
321b24ab67Jeff Bonwick
322b24ab67Jeff Bonwickvoid dmu_write_policy(objset_t *os, struct dnode *dn, int level, int wp,
323b24ab67Jeff Bonwick    struct zio_prop *zp);
325fa9e406ahrens * The bonus data is accessed more or less like a regular buffer.
326fa9e406ahrens * You must dmu_bonus_hold() to get the buffer, which will give you a
327fa9e406ahrens * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus
328fa9e406ahrens * data.  As with any normal buffer, you must call dmu_buf_read() to
329fa9e406ahrens * read db_data, dmu_buf_will_dirty() before modifying it, and the
330fa9e406ahrens * object must be held in an assigned transaction before calling
331fa9e406ahrens * dmu_buf_will_dirty.  You may use dmu_buf_set_user() on the bonus
332fa9e406ahrens * buffer as well.  You must release your hold with dmu_buf_rele().
333fa9e406ahrens */
334ea8dc4beschrockint dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **);
335fa9e406ahrensint dmu_bonus_max(void);
3361934e92maybeeint dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *);
3370a586ceMark Shellenbaumint dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *);
338744947dTom Ericksondmu_object_type_t dmu_get_bonustype(dmu_buf_t *);
3390a586ceMark Shellenbaumint dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *);
3400a586ceMark Shellenbaum
3410a586ceMark Shellenbaum/*
3420a586ceMark Shellenbaum * Special spill buffer support used by "SA" framework
3430a586ceMark Shellenbaum */
3440a586ceMark Shellenbaum
3450a586ceMark Shellenbaumint dmu_spill_hold_by_bonus(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
3460a586ceMark Shellenbaumint dmu_spill_hold_by_dnode(struct dnode *dn, uint32_t flags,
3470a586ceMark Shellenbaum    void *tag, dmu_buf_t **dbp);
3480a586ceMark Shellenbaumint dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
351fa9e406ahrens * Obtain the DMU buffer from the specified object which contains the
352fa9e406ahrens * specified offset.  dmu_buf_hold() puts a "hold" on the buffer, so
353fa9e406ahrens * that it will remain in memory.  You must release the hold with
354fa9e406ahrens * dmu_buf_rele().  You musn't access the dmu_buf_t after releasing your
355fa9e406ahrens * hold.  You must have a hold on any dmu_buf_t* you pass to the DMU.
356fa9e406ahrens *
357fa9e406ahrens * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill
358fa9e406ahrens * on the returned buffer before reading or writing the buffer's
359fa9e406ahrens * db_data.  The comments for those routines describe what particular
360fa9e406ahrens * operations are valid after calling them.
361fa9e406ahrens *
362fa9e406ahrens * The object number must be a valid, allocated object number.
363fa9e406ahrens */
364ea8dc4beschrockint dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset,
36547cb52dJeff Bonwick    void *tag, dmu_buf_t **, int flags);
366fa9e406ahrensvoid dmu_buf_add_ref(dmu_buf_t *db, void* tag);
367ea8dc4beschrockvoid dmu_buf_rele(dmu_buf_t *db, void *tag);
368fa9e406ahrensuint64_t dmu_buf_refcount(dmu_buf_t *db);
371fa9e406ahrens * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a
372fa9e406ahrens * range of an object.  A pointer to an array of dmu_buf_t*'s is
373fa9e406ahrens * returned (in *dbpp).
374fa9e406ahrens *
375fa9e406ahrens * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and
376fa9e406ahrens * frees the array.  The hold on the array of buffers MUST be released
377fa9e406ahrens * with dmu_buf_rele_array.  You can NOT release the hold on each buffer
378fa9e406ahrens * individually with dmu_buf_rele.
379fa9e406ahrens */
38013506d1maybeeint dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset,
38113506d1maybee    uint64_t length, int read, void *tag, int *numbufsp, dmu_buf_t ***dbpp);
382ea8dc4beschrockvoid dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag);
385fa9e406ahrens * Returns NULL on success, or the existing user ptr if it's already
386fa9e406ahrens * been set.
387fa9e406ahrens *
388fa9e406ahrens * user_ptr is for use by the user and can be obtained via dmu_buf_get_user().
389fa9e406ahrens *
390fa9e406ahrens * user_data_ptr_ptr should be NULL, or a pointer to a pointer which
391fa9e406ahrens * will be set to db->db_data when you are allowed to access it.  Note
392fa9e406ahrens * that db->db_data (the pointer) can change when you do dmu_buf_read(),
393fa9e406ahrens * dmu_buf_tryupgrade(), dmu_buf_will_dirty(), or dmu_buf_will_fill().
394fa9e406ahrens * *user_data_ptr_ptr will be set to the new value when it changes.
395fa9e406ahrens *
396fa9e406ahrens * If non-NULL, pageout func will be called when this buffer is being
397fa9e406ahrens * excised from the cache, so that you can clean up the data structure
398fa9e406ahrens * pointed to by user_ptr.
399fa9e406ahrens *
400fa9e406ahrens * dmu_evict_user() will call the pageout func for all buffers in a
401fa9e406ahrens * objset with a given pageout func.
402fa9e406ahrens */
403fa9e406ahrensvoid *dmu_buf_set_user(dmu_buf_t *db, void *user_ptr, void *user_data_ptr_ptr,
404fa9e406ahrens    dmu_buf_evict_func_t *pageout_func);
406fa9e406ahrens * set_user_ie is the same as set_user, but request immediate eviction
407fa9e406ahrens * when hold count goes to zero.
408fa9e406ahrens */
409fa9e406ahrensvoid *dmu_buf_set_user_ie(dmu_buf_t *db, void *user_ptr,
410fa9e406ahrens    void *user_data_ptr_ptr, dmu_buf_evict_func_t *pageout_func);
411fa9e406ahrensvoid *dmu_buf_update_user(dmu_buf_t *db_fake, void *old_user_ptr,
412fa9e406ahrens    void *user_ptr, void *user_data_ptr_ptr,
413fa9e406ahrens    dmu_buf_evict_func_t *pageout_func);
414fa9e406ahrensvoid dmu_evict_user(objset_t *os, dmu_buf_evict_func_t *func);
417fa9e406ahrens * Returns the user_ptr set with dmu_buf_set_user(), or NULL if not set.
418fa9e406ahrens */
419fa9e406ahrensvoid *dmu_buf_get_user(dmu_buf_t *db);
422fa9e406ahrens * Indicate that you are going to modify the buffer's data (db_data).
423fa9e406ahrens *
424fa9e406ahrens * The transaction (tx) must be assigned to a txg (ie. you've called
425fa9e406ahrens * dmu_tx_assign()).  The buffer's object must be held in the tx
426fa9e406ahrens * (ie. you've called dmu_tx_hold_object(tx, db->db_object)).
427fa9e406ahrens */
428fa9e406ahrensvoid dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx);
4313d69262Sanjeev Bagewadi * Tells if the given dbuf is freeable.
4323d69262Sanjeev Bagewadi */
4333d69262Sanjeev Bagewadiboolean_t dmu_buf_freeable(dmu_buf_t *);
4343d69262Sanjeev Bagewadi
4353d69262Sanjeev Bagewadi/*
436fa9e406ahrens * You must create a transaction, then hold the objects which you will
437fa9e406ahrens * (or might) modify as part of this transaction.  Then you must assign
438fa9e406ahrens * the transaction to a transaction group.  Once the transaction has
439fa9e406ahrens * been assigned, you can modify buffers which belong to held objects as
440fa9e406ahrens * part of this transaction.  You can't modify buffers before the
441fa9e406ahrens * transaction has been assigned; you can't modify buffers which don't
442fa9e406ahrens * belong to objects which this transaction holds; you can't hold
443fa9e406ahrens * objects once the transaction has been assigned.  You may hold an
444fa9e406ahrens * object which you are going to free (with dmu_object_free()), but you
445fa9e406ahrens * don't have to.
446fa9e406ahrens *
447fa9e406ahrens * You can abort the transaction before it has been assigned.
448fa9e406ahrens *
449fa9e406ahrens * Note that you may hold buffers (with dmu_buf_hold) at any time,
450fa9e406ahrens * regardless of transaction state.
451fa9e406ahrens */
453fa9e406ahrens#define	DMU_NEW_OBJECT	(-1ULL)
454fa9e406ahrens#define	DMU_OBJECT_END	(-1ULL)
456fa9e406ahrensdmu_tx_t *dmu_tx_create(objset_t *os);
457fa9e406ahrensvoid dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len);
458fa9e406ahrensvoid dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off,
459fa9e406ahrens    uint64_t len);
4601484342Matthew Ahrensvoid dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name);
461fa9e406ahrensvoid dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object);
4620a586ceMark Shellenbaumvoid dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object);
4630a586ceMark Shellenbaumvoid dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow);
4640a586ceMark Shellenbaumvoid dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size);
465fa9e406ahrensvoid dmu_tx_abort(dmu_tx_t *tx);
466fa9e406ahrensint dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how);
4678a2f1b9ahrensvoid dmu_tx_wait(dmu_tx_t *tx);
468fa9e406ahrensvoid dmu_tx_commit(dmu_tx_t *tx);
471d20e665Ricardo M. Correia * To register a commit callback, dmu_tx_callback_register() must be called.
472d20e665Ricardo M. Correia *
473d20e665Ricardo M. Correia * dcb_data is a pointer to caller private data that is passed on as a
474d20e665Ricardo M. Correia * callback parameter. The caller is responsible for properly allocating and
475d20e665Ricardo M. Correia * freeing it.
476d20e665Ricardo M. Correia *
477d20e665Ricardo M. Correia * When registering a callback, the transaction must be already created, but
478d20e665Ricardo M. Correia * it cannot be committed or aborted. It can be assigned to a txg or not.
479d20e665Ricardo M. Correia *
480d20e665Ricardo M. Correia * The callback will be called after the transaction has been safely written
481d20e665Ricardo M. Correia * to stable storage and will also be called if the dmu_tx is aborted.
482d20e665Ricardo M. Correia * If there is any error which prevents the transaction from being committed to
483d20e665Ricardo M. Correia * disk, the callback will be called with a value of error != 0.
484d20e665Ricardo M. Correia */
485d20e665Ricardo M. Correiatypedef void dmu_tx_callback_func_t(void *dcb_data, int error);
486d20e665Ricardo M. Correia
487d20e665Ricardo M. Correiavoid dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func,
488d20e665Ricardo M. Correia    void *dcb_data);
489d20e665Ricardo M. Correia
490d20e665Ricardo M. Correia/*
491fa9e406ahrens * Free up the data blocks for a defined range of a file.  If size is
492fa9e406ahrens * zero, the range from offset to end-of-file is freed.
493fa9e406ahrens */
494ea8dc4beschrockint dmu_free_range(objset_t *os, uint64_t object, uint64_t offset,
495fa9e406ahrens	uint64_t size, dmu_tx_t *tx);
496cdb0ab7maybeeint dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset,
497cdb0ab7maybee	uint64_t size);
498cdb0ab7maybeeint dmu_free_object(objset_t *os, uint64_t object);
501fa9e406ahrens * Convenience functions.
502fa9e406ahrens *
503fa9e406ahrens * Canfail routines will return 0 on success, or an errno if there is a
504fa9e406ahrens * nonrecoverable I/O error.
505fa9e406ahrens */
5067bfdf01Neil Perrin#define	DMU_READ_PREFETCH	0 /* prefetch */
5077bfdf01Neil Perrin#define	DMU_READ_NO_PREFETCH	1 /* don't prefetch */
508ea8dc4beschrockint dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
5097bfdf01Neil Perrin	void *buf, uint32_t flags);
510fa9e406ahrensvoid dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
511fa9e406ahrens	const void *buf, dmu_tx_t *tx);
51282c9918Tim Haleyvoid dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
51382c9918Tim Haley	dmu_tx_t *tx);
514feb08c6billmint dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size);
515feb08c6billmint dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size,
516feb08c6billm    dmu_tx_t *tx);
51794d1a21Tim Haleyint dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size,
51894d1a21Tim Haley    dmu_tx_t *tx);
51944eda4dmaybeeint dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset,
52044eda4dmaybee    uint64_t size, struct page *pp, dmu_tx_t *tx);
5212fdbea2Aleksandr Guzovskiystruct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size);
5222fdbea2Aleksandr Guzovskiyvoid dmu_return_arcbuf(struct arc_buf *buf);
5232fdbea2Aleksandr Guzovskiyvoid dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf,
5242fdbea2Aleksandr Guzovskiy    dmu_tx_t *tx);
525c242f9achunli zhang - Sun Microsystems - Irvine United Statesint dmu_xuio_init(struct xuio *uio, int niov);
526c242f9achunli zhang - Sun Microsystems - Irvine United Statesvoid dmu_xuio_fini(struct xuio *uio);
527c242f9achunli zhang - Sun Microsystems - Irvine United Statesint dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off,
528c242f9achunli zhang - Sun Microsystems - Irvine United States    size_t n);
529c242f9achunli zhang - Sun Microsystems - Irvine United Statesint dmu_xuio_cnt(struct xuio *uio);
530c242f9achunli zhang - Sun Microsystems - Irvine United Statesstruct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i);
531c242f9achunli zhang - Sun Microsystems - Irvine United Statesvoid dmu_xuio_clear(struct xuio *uio, int i);
532c242f9achunli zhang - Sun Microsystems - Irvine United Statesvoid xuio_stat_wbuf_copied();
533c242f9achunli zhang - Sun Microsystems - Irvine United Statesvoid xuio_stat_wbuf_nocopy();
535416e0cdekextern int zfs_prefetch_disable;
538fa9e406ahrens * Asynchronously try to read in the data.
539fa9e406ahrens */
540fa9e406ahrensvoid dmu_prefetch(objset_t *os, uint64_t object, uint64_t offset,
541fa9e406ahrens    uint64_t len);
543fa9e406ahrenstypedef struct dmu_object_info {
544b24ab67Jeff Bonwick	/* All sizes are in bytes unless otherwise indicated. */
545fa9e406ahrens	uint32_t doi_data_block_size;
546fa9e406ahrens	uint32_t doi_metadata_block_size;
547fa9e406ahrens	dmu_object_type_t doi_type;
548fa9e406ahrens	dmu_object_type_t doi_bonus_type;
549b24ab67Jeff Bonwick	uint64_t doi_bonus_size;
550fa9e406ahrens	uint8_t doi_indirection;		/* 2 = dnode->indirect->data */
551fa9e406ahrens	uint8_t doi_checksum;
552fa9e406ahrens	uint8_t doi_compress;
553fa9e406ahrens	uint8_t doi_pad[5];
554b24ab67Jeff Bonwick	uint64_t doi_physical_blocks_512;	/* data + metadata, 512b blks */
555b24ab67Jeff Bonwick	uint64_t doi_max_offset;
556b24ab67Jeff Bonwick	uint64_t doi_fill_count;		/* number of non-empty blocks */
557fa9e406ahrens} dmu_object_info_t;
559e45ce72ahrenstypedef void arc_byteswap_func_t(void *buf, size_t size);
561fa9e406ahrenstypedef struct dmu_object_type_info {
562e45ce72ahrens	arc_byteswap_func_t	*ot_byteswap;
563fa9e406ahrens	boolean_t		ot_metadata;
564fa9e406ahrens	char			*ot_name;
565fa9e406ahrens} dmu_object_type_info_t;
567fa9e406ahrensextern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES];
570fa9e406ahrens * Get information on a DMU object.
571fa9e406ahrens *
572fa9e406ahrens * Return 0 on success or ENOENT if object is not allocated.
573fa9e406ahrens *
574fa9e406ahrens * If doi is NULL, just indicates whether the object exists.
575fa9e406ahrens */
576fa9e406ahrensint dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi);
577fa9e406ahrensvoid dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi);
578fa9e406ahrensvoid dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi);
579fa9e406ahrensvoid dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize,
580fa9e406ahrens    u_longlong_t *nblk512);
582fa9e406ahrenstypedef struct dmu_objset_stats {
583a2eea2eahrens	uint64_t dds_num_clones; /* number of clones of this */
584a2eea2eahrens	uint64_t dds_creation_txg;
5853cb34c6ahrens	uint64_t dds_guid;
586fa9e406ahrens	dmu_objset_type_t dds_type;
587fa9e406ahrens	uint8_t dds_is_snapshot;
58831fd60dahrens	uint8_t dds_inconsistent;
5893cb34c6ahrens	char dds_origin[MAXNAMELEN];
590a2eea2eahrens} dmu_objset_stats_t;
593a2eea2eahrens * Get stats on a dataset.
594a2eea2eahrens */
595a2eea2eahrensvoid dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
598a2eea2eahrens * Add entries to the nvlist for all the objset's properties.  See
599a2eea2eahrens * zfs_prop_table[] and zfs(1m) for details on the properties.
600a2eea2eahrens */
601a2eea2eahrensvoid dmu_objset_stats(objset_t *os, struct nvlist *nv);
604a2eea2eahrens * Get the space usage statistics for statvfs().
605a2eea2eahrens *
606a2eea2eahrens * refdbytes is the amount of space "referenced" by this objset.
607a2eea2eahrens * availbytes is the amount of space available to this objset, taking
608a2eea2eahrens * into account quotas & reservations, assuming that no other objsets
609a2eea2eahrens * use the space first.  These values correspond to the 'referenced' and
610a2eea2eahrens * 'available' properties, described in the zfs(1m) manpage.
611a2eea2eahrens *
612a2eea2eahrens * usedobjs and availobjs are the number of objects currently allocated,
613a2eea2eahrens * and available.
614a2eea2eahrens */
615a2eea2eahrensvoid dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
616a2eea2eahrens    uint64_t *usedobjsp, uint64_t *availobjsp);
619a2eea2eahrens * The fsid_guid is a 56-bit ID that can change to avoid collisions.
620a2eea2eahrens * (Contrast with the ds_guid which is a 64-bit ID that will never
621a2eea2eahrens * change, so there is a small probability that it will collide.)
622fa9e406ahrens */
623a2eea2eahrensuint64_t dmu_objset_fsid_guid(objset_t *os);
62571eb053Chris Kirby/*
62671eb053Chris Kirby * Get the [cm]time for an objset's snapshot dir
62771eb053Chris Kirby */
62871eb053Chris Kirbytimestruc_t dmu_objset_snap_cmtime(objset_t *os);
62971eb053Chris Kirby
630fa9e406ahrensint dmu_objset_is_snapshot(objset_t *os);
632fa9e406ahrensextern struct spa *dmu_objset_spa(objset_t *os);
633fa9e406ahrensextern struct zilog *dmu_objset_zil(objset_t *os);
634fa9e406ahrensextern struct dsl_pool *dmu_objset_pool(objset_t *os);
635fa9e406ahrensextern struct dsl_dataset *dmu_objset_ds(objset_t *os);
636fa9e406ahrensextern void dmu_objset_name(objset_t *os, char *buf);
637fa9e406ahrensextern dmu_objset_type_t dmu_objset_type(objset_t *os);
638fa9e406ahrensextern uint64_t dmu_objset_id(objset_t *os);
63955da60bMark J Musanteextern uint64_t dmu_objset_syncprop(objset_t *os);
640e09fa4dNeil Perrinextern uint64_t dmu_objset_logbias(objset_t *os);
641fa9e406ahrensextern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name,
642b38f097ck    uint64_t *id, uint64_t *offp, boolean_t *case_conflict);
643ab04eb8timhextern int dmu_snapshot_realname(objset_t *os, char *name, char *real,
644ab04eb8timh    int maxlen, boolean_t *conflict);
64587e5029ahrensextern int dmu_dir_list_next(objset_t *os, int namelen, char *name,
64687e5029ahrens    uint64_t *idp, uint64_t *offp);
6471484342Matthew Ahrens
6489966ca1Matthew Ahrenstypedef int objset_used_cb_t(dmu_object_type_t bonustype,
6499966ca1Matthew Ahrens    void *bonus, uint64_t *userp, uint64_t *groupp);
6501484342Matthew Ahrensextern void dmu_objset_register_type(dmu_objset_type_t ost,
6511484342Matthew Ahrens    objset_used_cb_t *cb);
652f18faf3ekextern void dmu_objset_set_user(objset_t *os, void *user_ptr);
653f18faf3ekextern void *dmu_objset_get_user(objset_t *os);
656fa9e406ahrens * Return the txg number for the given assigned transaction.
657fa9e406ahrens */
65887e5029ahrensuint64_t dmu_tx_get_txg(dmu_tx_t *tx);
661fa9e406ahrens * Synchronous write.
662c5c6ffamaybee * If a parent zio is provided this function initiates a write on the
663c5c6ffamaybee * provided buffer as a child of the parent zio.
664da6c28aamw * In the absence of a parent zio, the write is completed synchronously.
665c5c6ffamaybee * At write completion, blk is filled with the bp of the written block.
666fa9e406ahrens * Note that while the data covered by this function will be on stable
667c5c6ffamaybee * storage when the write completes this new data does not become a
668fa9e406ahrens * permanent part of the file until the associated transaction commits.
669fa9e406ahrens */
670b24ab67Jeff Bonwick
671b24ab67Jeff Bonwick/*
672b24ab67Jeff Bonwick * {zfs,zvol,ztest}_get_done() args
673b24ab67Jeff Bonwick */
674b24ab67Jeff Bonwicktypedef struct zgd {
675b24ab67Jeff Bonwick	struct zilog	*zgd_zilog;
676b24ab67Jeff Bonwick	struct blkptr	*zgd_bp;
677b24ab67Jeff Bonwick	dmu_buf_t	*zgd_db;
678b24ab67Jeff Bonwick	struct rl	*zgd_rl;
679b24ab67Jeff Bonwick	void		*zgd_private;
680b24ab67Jeff Bonwick} zgd_t;
681b24ab67Jeff Bonwick
682b24ab67Jeff Bonwicktypedef void dmu_sync_cb_t(zgd_t *arg, int error);
683b24ab67Jeff Bonwickint dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd);
686fa9e406ahrens * Find the next hole or data block in file starting at *off
687fa9e406ahrens * Return found offset in *off. Return ESRCH for end of file.
688fa9e406ahrens */
689fa9e406ahrensint dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole,
690fa9e406ahrens    uint64_t *off);
693fa9e406ahrens * Initial setup and final teardown.
694fa9e406ahrens */
695fa9e406ahrensextern void dmu_init(void);
696fa9e406ahrensextern void dmu_fini(void);
698fa9e406ahrenstypedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp,
699fa9e406ahrens    uint64_t object, uint64_t offset, int len);
700fa9e406ahrensvoid dmu_traverse_objset(objset_t *os, uint64_t txg_start,
701fa9e406ahrens    dmu_traverse_cb_t cb, void *arg);
7033cb34c6ahrensint dmu_sendbackup(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin,
7043cb34c6ahrens    struct vnode *vp, offset_t *off);
7063cb34c6ahrenstypedef struct dmu_recv_cookie {
7073cb34c6ahrens	/*
7083cb34c6ahrens	 * This structure is opaque!
7093cb34c6ahrens	 *
7103cb34c6ahrens	 * If logical and real are different, we are recving the stream
7113cb34c6ahrens	 * into the "real" temporary clone, and then switching it with
7123cb34c6ahrens	 * the "logical" target.
7133cb34c6ahrens	 */
7143cb34c6ahrens	struct dsl_dataset *drc_logical_ds;
7153cb34c6ahrens	struct dsl_dataset *drc_real_ds;
7163cb34c6ahrens	struct drr_begin *drc_drrb;
7173cb34c6ahrens	char *drc_tosnap;
7189e69d7dLori Alt	char *drc_top_ds;
7193cb34c6ahrens	boolean_t drc_newfs;
7203cb34c6ahrens	boolean_t drc_force;
7213cb34c6ahrens} dmu_recv_cookie_t;
7239e69d7dLori Altint dmu_recv_begin(char *tofs, char *tosnap, char *topds, struct drr_begin *,
724f4b94bdMatthew Ahrens    boolean_t force, objset_t *origin, dmu_recv_cookie_t *);
725c99e4bdChris Kirbyint dmu_recv_stream(dmu_recv_cookie_t *drc, struct vnode *vp, offset_t *voffp,
726c99e4bdChris Kirby    int cleanup_fd, uint64_t *action_handlep);
7273cb34c6ahrensint dmu_recv_end(dmu_recv_cookie_t *drc);
729fa9e406ahrens/* CRC64 table */
730fa9e406ahrens#define	ZFS_CRC64_POLY	0xC96C5795D7870F42ULL	/* ECMA-182, reflected form */
731fa9e406ahrensextern uint64_t zfs_crc64_table[256];
733fa9e406ahrens#ifdef	__cplusplus
737fa9e406ahrens#endif	/* _SYS_DMU_H */