sys/cddl/contrib/opensolaris/uts/common/fs/zfs/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 2009 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _SYS_DMU_H
  27 #define _SYS_DMU_H
  28
  29 #pragma ident   "%Z%%M% %I%     %E% SMI"
  30
  31 /*
  32  * This file describes the interface that the DMU provides for its
  33  * consumers.
  34  *
  35  * The DMU also interacts with the SPA.  That interface is described in
  36  * dmu_spa.h.
  37  */
  38
  39 #include <sys/types.h>
  40 #include <sys/param.h>
  41 #include <sys/cred.h>
  42
  43 #ifdef  __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 struct uio;
  48 struct page;
  49 struct vnode;
  50 struct spa;
  51 struct zilog;
  52 struct zio;
  53 struct blkptr;
  54 struct zap_cursor;
  55 struct dsl_dataset;
  56 struct dsl_pool;
  57 struct dnode;
  58 struct drr_begin;
  59 struct drr_end;
  60 struct zbookmark;
  61 struct spa;
  62 struct nvlist;
  63 struct objset_impl;
  64 struct arc_buf;
  65 struct file;
  66
  67 typedef struct objset objset_t;
  68 typedef struct dmu_tx dmu_tx_t;
  69 typedef struct dsl_dir dsl_dir_t;
  70
  71 typedef enum dmu_object_type {
  72         DMU_OT_NONE,
  73         /* general: */
  74         DMU_OT_OBJECT_DIRECTORY,        /* ZAP */
  75         DMU_OT_OBJECT_ARRAY,            /* UINT64 */
  76         DMU_OT_PACKED_NVLIST,           /* UINT8 (XDR by nvlist_pack/unpack) */
  77         DMU_OT_PACKED_NVLIST_SIZE,      /* UINT64 */
  78         DMU_OT_BPLIST,                  /* UINT64 */
  79         DMU_OT_BPLIST_HDR,              /* UINT64 */
  80         /* spa: */
  81         DMU_OT_SPACE_MAP_HEADER,        /* UINT64 */
  82         DMU_OT_SPACE_MAP,               /* UINT64 */
  83         /* zil: */
  84         DMU_OT_INTENT_LOG,              /* UINT64 */
  85         /* dmu: */
  86         DMU_OT_DNODE,                   /* DNODE */
  87         DMU_OT_OBJSET,                  /* OBJSET */
  88         /* dsl: */
  89         DMU_OT_DSL_DIR,                 /* UINT64 */
  90         DMU_OT_DSL_DIR_CHILD_MAP,       /* ZAP */
  91         DMU_OT_DSL_DS_SNAP_MAP,         /* ZAP */
  92         DMU_OT_DSL_PROPS,               /* ZAP */
  93         DMU_OT_DSL_DATASET,             /* UINT64 */
  94         /* zpl: */
  95         DMU_OT_ZNODE,                   /* ZNODE */
  96         DMU_OT_OLDACL,                  /* Old ACL */
  97         DMU_OT_PLAIN_FILE_CONTENTS,     /* UINT8 */
  98         DMU_OT_DIRECTORY_CONTENTS,      /* ZAP */
  99         DMU_OT_MASTER_NODE,             /* ZAP */
 100         DMU_OT_UNLINKED_SET,            /* ZAP */
 101         /* zvol: */
 102         DMU_OT_ZVOL,                    /* UINT8 */
 103         DMU_OT_ZVOL_PROP,               /* ZAP */
 104         /* other; for testing only! */
 105         DMU_OT_PLAIN_OTHER,             /* UINT8 */
 106         DMU_OT_UINT64_OTHER,            /* UINT64 */
 107         DMU_OT_ZAP_OTHER,               /* ZAP */
 108         /* new object types: */
 109         DMU_OT_ERROR_LOG,               /* ZAP */
 110         DMU_OT_SPA_HISTORY,             /* UINT8 */
 111         DMU_OT_SPA_HISTORY_OFFSETS,     /* spa_his_phys_t */
 112         DMU_OT_POOL_PROPS,              /* ZAP */
 113         DMU_OT_DSL_PERMS,               /* ZAP */
 114         DMU_OT_ACL,                     /* ACL */
 115         DMU_OT_SYSACL,                  /* SYSACL */
 116         DMU_OT_FUID,                    /* FUID table (Packed NVLIST UINT8) */
 117         DMU_OT_FUID_SIZE,               /* FUID table size UINT64 */
 118         DMU_OT_NEXT_CLONES,             /* ZAP */
 119         DMU_OT_SCRUB_QUEUE,             /* ZAP */
 120         DMU_OT_USERGROUP_USED,          /* ZAP */
 121         DMU_OT_USERGROUP_QUOTA,         /* ZAP */
 122         DMU_OT_NUMTYPES
 123 } dmu_object_type_t;
 124
 125 typedef enum dmu_objset_type {
 126         DMU_OST_NONE,
 127         DMU_OST_META,
 128         DMU_OST_ZFS,
 129         DMU_OST_ZVOL,
 130         DMU_OST_OTHER,                  /* For testing only! */
 131         DMU_OST_ANY,                    /* Be careful! */
 132         DMU_OST_NUMTYPES
 133 } dmu_objset_type_t;
 134
 135 void byteswap_uint64_array(void *buf, size_t size);
 136 void byteswap_uint32_array(void *buf, size_t size);
 137 void byteswap_uint16_array(void *buf, size_t size);
 138 void byteswap_uint8_array(void *buf, size_t size);
 139 void zap_byteswap(void *buf, size_t size);
 140 void zfs_oldacl_byteswap(void *buf, size_t size);
 141 void zfs_acl_byteswap(void *buf, size_t size);
 142 void zfs_znode_byteswap(void *buf, size_t size);
 143
 144 #define DS_MODE_NOHOLD          0       /* internal use only */
 145 #define DS_MODE_USER            1       /* simple access, no special needs */
 146 #define DS_MODE_OWNER           2       /* the "main" access, e.g. a mount */
 147 #define DS_MODE_TYPE_MASK       0x3
 148 #define DS_MODE_TYPE(x)         ((x) & DS_MODE_TYPE_MASK)
 149 #define DS_MODE_READONLY        0x8
 150 #define DS_MODE_IS_READONLY(x)  ((x) & DS_MODE_READONLY)
 151 #define DS_MODE_INCONSISTENT    0x10
 152 #define DS_MODE_IS_INCONSISTENT(x)      ((x) & DS_MODE_INCONSISTENT)
 153
 154 #define DS_FIND_SNAPSHOTS       (1<<0)
 155 #define DS_FIND_CHILDREN        (1<<1)
 156
 157 /*
 158  * The maximum number of bytes that can be accessed as part of one
 159  * operation, including metadata.
 160  */
 161 #define DMU_MAX_ACCESS (10<<20) /* 10MB */
 162 #define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */
 163
 164 #define DMU_USERUSED_OBJECT     (-1ULL)
 165 #define DMU_GROUPUSED_OBJECT    (-2ULL)
 166
 167 /*
 168  * Public routines to create, destroy, open, and close objsets.
 169  */
 170 int dmu_objset_open(const char *name, dmu_objset_type_t type, int mode,
 171     objset_t **osp);
 172 int dmu_objset_open_ds(struct dsl_dataset *ds, dmu_objset_type_t type,
 173     objset_t **osp);
 174 void dmu_objset_close(objset_t *os);
 175 int dmu_objset_evict_dbufs(objset_t *os);
 176 int dmu_objset_create(const char *name, dmu_objset_type_t type,
 177     objset_t *clone_parent, uint64_t flags,
 178     void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
 179 int dmu_objset_destroy(const char *name);
 180 int dmu_snapshots_destroy(char *fsname, char *snapname);
 181 int dmu_objset_rollback(objset_t *os);
 182 int dmu_objset_snapshot(char *fsname, char *snapname, struct nvlist *props,
 183     boolean_t recursive);
 184 int dmu_objset_rename(const char *name, const char *newname,
 185     boolean_t recursive);
 186 int dmu_objset_find(char *name, int func(char *, void *), void *arg,
 187     int flags);
 188 void dmu_objset_byteswap(void *buf, size_t size);
 189
 190 typedef struct dmu_buf {
 191         uint64_t db_object;             /* object that this buffer is part of */
 192         uint64_t db_offset;             /* byte offset in this object */
 193         uint64_t db_size;               /* size of buffer in bytes */
 194         void *db_data;                  /* data in buffer */
 195 } dmu_buf_t;
 196
 197 typedef void dmu_buf_evict_func_t(struct dmu_buf *db, void *user_ptr);
 198
 199 /*
 200  * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
 201  */
 202 #define DMU_POOL_DIRECTORY_OBJECT       1
 203 #define DMU_POOL_CONFIG                 "config"
 204 #define DMU_POOL_ROOT_DATASET           "root_dataset"
 205 #define DMU_POOL_SYNC_BPLIST            "sync_bplist"
 206 #define DMU_POOL_ERRLOG_SCRUB           "errlog_scrub"
 207 #define DMU_POOL_ERRLOG_LAST            "errlog_last"
 208 #define DMU_POOL_SPARES                 "spares"
 209 #define DMU_POOL_DEFLATE                "deflate"
 210 #define DMU_POOL_HISTORY                "history"
 211 #define DMU_POOL_PROPS                  "pool_props"
 212 #define DMU_POOL_L2CACHE                "l2cache"
 213
 214 /* 4x8 zbookmark_t */
 215 #define DMU_POOL_SCRUB_BOOKMARK         "scrub_bookmark"
 216 /* 1x8 zap obj DMU_OT_SCRUB_QUEUE */
 217 #define DMU_POOL_SCRUB_QUEUE            "scrub_queue"
 218 /* 1x8 txg */
 219 #define DMU_POOL_SCRUB_MIN_TXG          "scrub_min_txg"
 220 /* 1x8 txg */
 221 #define DMU_POOL_SCRUB_MAX_TXG          "scrub_max_txg"
 222 /* 1x4 enum scrub_func */
 223 #define DMU_POOL_SCRUB_FUNC             "scrub_func"
 224 /* 1x8 count */
 225 #define DMU_POOL_SCRUB_ERRORS           "scrub_errors"
 226
 227 /*
 228  * Allocate an object from this objset.  The range of object numbers
 229  * available is (0, DN_MAX_OBJECT).  Object 0 is the meta-dnode.
 230  *
 231  * The transaction must be assigned to a txg.  The newly allocated
 232  * object will be "held" in the transaction (ie. you can modify the
 233  * newly allocated object in this transaction).
 234  *
 235  * dmu_object_alloc() chooses an object and returns it in *objectp.
 236  *
 237  * dmu_object_claim() allocates a specific object number.  If that
 238  * number is already allocated, it fails and returns EEXIST.
 239  *
 240  * Return 0 on success, or ENOSPC or EEXIST as specified above.
 241  */
 242 uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot,
 243     int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
 244 int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot,
 245     int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
 246 int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot,
 247     int blocksize, dmu_object_type_t bonustype, int bonuslen);
 248
 249 /*
 250  * Free an object from this objset.
 251  *
 252  * The object's data will be freed as well (ie. you don't need to call
 253  * dmu_free(object, 0, -1, tx)).
 254  *
 255  * The object need not be held in the transaction.
 256  *
 257  * If there are any holds on this object's buffers (via dmu_buf_hold()),
 258  * or tx holds on the object (via dmu_tx_hold_object()), you can not
 259  * free it; it fails and returns EBUSY.
 260  *
 261  * If the object is not allocated, it fails and returns ENOENT.
 262  *
 263  * Return 0 on success, or EBUSY or ENOENT as specified above.
 264  */
 265 int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx);
 266
 267 /*
 268  * Find the next allocated or free object.
 269  *
 270  * The objectp parameter is in-out.  It will be updated to be the next
 271  * object which is allocated.  Ignore objects which have not been
 272  * modified since txg.
 273  *
 274  * XXX Can only be called on a objset with no dirty data.
 275  *
 276  * Returns 0 on success, or ENOENT if there are no more objects.
 277  */
 278 int dmu_object_next(objset_t *os, uint64_t *objectp,
 279     boolean_t hole, uint64_t txg);
 280
 281 /*
 282  * Set the data blocksize for an object.
 283  *
 284  * The object cannot have any blocks allcated beyond the first.  If
 285  * the first block is allocated already, the new size must be greater
 286  * than the current block size.  If these conditions are not met,
 287  * ENOTSUP will be returned.
 288  *
 289  * Returns 0 on success, or EBUSY if there are any holds on the object
 290  * contents, or ENOTSUP as described above.
 291  */
 292 int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size,
 293     int ibs, dmu_tx_t *tx);
 294
 295 /*
 296  * Set the checksum property on a dnode.  The new checksum algorithm will
 297  * apply to all newly written blocks; existing blocks will not be affected.
 298  */
 299 void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum,
 300     dmu_tx_t *tx);
 301
 302 /*
 303  * Set the compress property on a dnode.  The new compression algorithm will
 304  * apply to all newly written blocks; existing blocks will not be affected.
 305  */
 306 void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress,
 307     dmu_tx_t *tx);
 308
 309 /*
 310  * Decide how many copies of a given block we should make.  Can be from
 311  * 1 to SPA_DVAS_PER_BP.
 312  */
 313 int dmu_get_replication_level(struct objset_impl *, struct zbookmark *zb,
 314     dmu_object_type_t ot);
 315 /*
 316  * The bonus data is accessed more or less like a regular buffer.
 317  * You must dmu_bonus_hold() to get the buffer, which will give you a
 318  * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus
 319  * data.  As with any normal buffer, you must call dmu_buf_read() to
 320  * read db_data, dmu_buf_will_dirty() before modifying it, and the
 321  * object must be held in an assigned transaction before calling
 322  * dmu_buf_will_dirty.  You may use dmu_buf_set_user() on the bonus
 323  * buffer as well.  You must release your hold with dmu_buf_rele().
 324  */
 325 int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **);
 326 int dmu_bonus_max(void);
 327 int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *);
 328
 329 /*
 330  * Obtain the DMU buffer from the specified object which contains the
 331  * specified offset.  dmu_buf_hold() puts a "hold" on the buffer, so
 332  * that it will remain in memory.  You must release the hold with
 333  * dmu_buf_rele().  You musn't access the dmu_buf_t after releasing your
 334  * hold.  You must have a hold on any dmu_buf_t* you pass to the DMU.
 335  *
 336  * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill
 337  * on the returned buffer before reading or writing the buffer's
 338  * db_data.  The comments for those routines describe what particular
 339  * operations are valid after calling them.
 340  *
 341  * The object number must be a valid, allocated object number.
 342  */
 343 int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset,
 344     void *tag, dmu_buf_t **);
 345 void dmu_buf_add_ref(dmu_buf_t *db, void* tag);
 346 void dmu_buf_rele(dmu_buf_t *db, void *tag);
 347 uint64_t dmu_buf_refcount(dmu_buf_t *db);
 348
 349 /*
 350  * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a
 351  * range of an object.  A pointer to an array of dmu_buf_t*'s is
 352  * returned (in *dbpp).
 353  *
 354  * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and
 355  * frees the array.  The hold on the array of buffers MUST be released
 356  * with dmu_buf_rele_array.  You can NOT release the hold on each buffer
 357  * individually with dmu_buf_rele.
 358  */
 359 int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset,
 360     uint64_t length, int read, void *tag, int *numbufsp, dmu_buf_t ***dbpp);
 361 void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag);
 362
 363 /*
 364  * Returns NULL on success, or the existing user ptr if it's already
 365  * been set.
 366  *
 367  * user_ptr is for use by the user and can be obtained via dmu_buf_get_user().
 368  *
 369  * user_data_ptr_ptr should be NULL, or a pointer to a pointer which
 370  * will be set to db->db_data when you are allowed to access it.  Note
 371  * that db->db_data (the pointer) can change when you do dmu_buf_read(),
 372  * dmu_buf_tryupgrade(), dmu_buf_will_dirty(), or dmu_buf_will_fill().
 373  * *user_data_ptr_ptr will be set to the new value when it changes.
 374  *
 375  * If non-NULL, pageout func will be called when this buffer is being
 376  * excised from the cache, so that you can clean up the data structure
 377  * pointed to by user_ptr.
 378  *
 379  * dmu_evict_user() will call the pageout func for all buffers in a
 380  * objset with a given pageout func.
 381  */
 382 void *dmu_buf_set_user(dmu_buf_t *db, void *user_ptr, void *user_data_ptr_ptr,
 383     dmu_buf_evict_func_t *pageout_func);
 384 /*
 385  * set_user_ie is the same as set_user, but request immediate eviction
 386  * when hold count goes to zero.
 387  */
 388 void *dmu_buf_set_user_ie(dmu_buf_t *db, void *user_ptr,
 389     void *user_data_ptr_ptr, dmu_buf_evict_func_t *pageout_func);
 390 void *dmu_buf_update_user(dmu_buf_t *db_fake, void *old_user_ptr,
 391     void *user_ptr, void *user_data_ptr_ptr,
 392     dmu_buf_evict_func_t *pageout_func);
 393 void dmu_evict_user(objset_t *os, dmu_buf_evict_func_t *func);
 394
 395 /*
 396  * Returns the user_ptr set with dmu_buf_set_user(), or NULL if not set.
 397  */
 398 void *dmu_buf_get_user(dmu_buf_t *db);
 399
 400 /*
 401  * Indicate that you are going to modify the buffer's data (db_data).
 402  *
 403  * The transaction (tx) must be assigned to a txg (ie. you've called
 404  * dmu_tx_assign()).  The buffer's object must be held in the tx
 405  * (ie. you've called dmu_tx_hold_object(tx, db->db_object)).
 406  */
 407 void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx);
 408
 409 /*
 410  * Tells if the given dbuf is freeable.
 411  */
 412 boolean_t dmu_buf_freeable(dmu_buf_t *);
 413
 414 /*
 415  * You must create a transaction, then hold the objects which you will
 416  * (or might) modify as part of this transaction.  Then you must assign
 417  * the transaction to a transaction group.  Once the transaction has
 418  * been assigned, you can modify buffers which belong to held objects as
 419  * part of this transaction.  You can't modify buffers before the
 420  * transaction has been assigned; you can't modify buffers which don't
 421  * belong to objects which this transaction holds; you can't hold
 422  * objects once the transaction has been assigned.  You may hold an
 423  * object which you are going to free (with dmu_object_free()), but you
 424  * don't have to.
 425  *
 426  * You can abort the transaction before it has been assigned.
 427  *
 428  * Note that you may hold buffers (with dmu_buf_hold) at any time,
 429  * regardless of transaction state.
 430  */
 431
 432 #define DMU_NEW_OBJECT  (-1ULL)
 433 #define DMU_OBJECT_END  (-1ULL)
 434
 435 dmu_tx_t *dmu_tx_create(objset_t *os);
 436 void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len);
 437 void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off,
 438     uint64_t len);
 439 void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name);
 440 void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object);
 441 void dmu_tx_abort(dmu_tx_t *tx);
 442 int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how);
 443 void dmu_tx_wait(dmu_tx_t *tx);
 444 void dmu_tx_commit(dmu_tx_t *tx);
 445
 446 /*
 447  * Free up the data blocks for a defined range of a file.  If size is
 448  * zero, the range from offset to end-of-file is freed.
 449  */
 450 int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset,
 451         uint64_t size, dmu_tx_t *tx);
 452 int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset,
 453         uint64_t size);
 454 int dmu_free_object(objset_t *os, uint64_t object);
 455
 456 /*
 457  * Convenience functions.
 458  *
 459  * Canfail routines will return 0 on success, or an errno if there is a
 460  * nonrecoverable I/O error.
 461  */
 462 #define DMU_READ_PREFETCH       0 /* prefetch */
 463 #define DMU_READ_NO_PREFETCH    1 /* don't prefetch */
 464 int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
 465         void *buf, uint32_t flags);
 466 void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
 467         const void *buf, dmu_tx_t *tx);
 468 int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size);
 469 int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size,
 470     dmu_tx_t *tx);
 471 int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset,
 472     uint64_t size, struct page *pp, dmu_tx_t *tx);
 473 struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size);
 474 void dmu_return_arcbuf(struct arc_buf *buf);
 475 void dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf,
 476     dmu_tx_t *tx);
 477
 478 extern int zfs_prefetch_disable;
 479
 480 /*
 481  * Asynchronously try to read in the data.
 482  */
 483 void dmu_prefetch(objset_t *os, uint64_t object, uint64_t offset,
 484     uint64_t len);
 485
 486 typedef struct dmu_object_info {
 487         /* All sizes are in bytes. */
 488         uint32_t doi_data_block_size;
 489         uint32_t doi_metadata_block_size;
 490         uint64_t doi_bonus_size;
 491         dmu_object_type_t doi_type;
 492         dmu_object_type_t doi_bonus_type;
 493         uint8_t doi_indirection;                /* 2 = dnode->indirect->data */
 494         uint8_t doi_checksum;
 495         uint8_t doi_compress;
 496         uint8_t doi_pad[5];
 497         /* Values below are number of 512-byte blocks. */
 498         uint64_t doi_physical_blks;             /* data + metadata */
 499         uint64_t doi_max_block_offset;
 500 } dmu_object_info_t;
 501
 502 typedef void arc_byteswap_func_t(void *buf, size_t size);
 503
 504 typedef struct dmu_object_type_info {
 505         arc_byteswap_func_t     *ot_byteswap;
 506         boolean_t               ot_metadata;
 507         char                    *ot_name;
 508 } dmu_object_type_info_t;
 509
 510 extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES];
 511
 512 /*
 513  * Get information on a DMU object.
 514  *
 515  * Return 0 on success or ENOENT if object is not allocated.
 516  *
 517  * If doi is NULL, just indicates whether the object exists.
 518  */
 519 int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi);
 520 void dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi);
 521 void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi);
 522 void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize,
 523     u_longlong_t *nblk512);
 524
 525 typedef struct dmu_objset_stats {
 526         uint64_t dds_num_clones; /* number of clones of this */
 527         uint64_t dds_creation_txg;
 528         uint64_t dds_guid;
 529         dmu_objset_type_t dds_type;
 530         uint8_t dds_is_snapshot;
 531         uint8_t dds_inconsistent;
 532         char dds_origin[MAXNAMELEN];
 533 } dmu_objset_stats_t;
 534
 535 /*
 536  * Get stats on a dataset.
 537  */
 538 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
 539
 540 /*
 541  * Add entries to the nvlist for all the objset's properties.  See
 542  * zfs_prop_table[] and zfs(1m) for details on the properties.
 543  */
 544 void dmu_objset_stats(objset_t *os, struct nvlist *nv);
 545
 546 /*
 547  * Get the space usage statistics for statvfs().
 548  *
 549  * refdbytes is the amount of space "referenced" by this objset.
 550  * availbytes is the amount of space available to this objset, taking
 551  * into account quotas & reservations, assuming that no other objsets
 552  * use the space first.  These values correspond to the 'referenced' and
 553  * 'available' properties, described in the zfs(1m) manpage.
 554  *
 555  * usedobjs and availobjs are the number of objects currently allocated,
 556  * and available.
 557  */
 558 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
 559     uint64_t *usedobjsp, uint64_t *availobjsp);
 560
 561 /*
 562  * The fsid_guid is a 56-bit ID that can change to avoid collisions.
 563  * (Contrast with the ds_guid which is a 64-bit ID that will never
 564  * change, so there is a small probability that it will collide.)
 565  */
 566 uint64_t dmu_objset_fsid_guid(objset_t *os);
 567
 568 int dmu_objset_is_snapshot(objset_t *os);
 569
 570 extern struct spa *dmu_objset_spa(objset_t *os);
 571 extern struct zilog *dmu_objset_zil(objset_t *os);
 572 extern struct dsl_pool *dmu_objset_pool(objset_t *os);
 573 extern struct dsl_dataset *dmu_objset_ds(objset_t *os);
 574 extern void dmu_objset_name(objset_t *os, char *buf);
 575 extern dmu_objset_type_t dmu_objset_type(objset_t *os);
 576 extern uint64_t dmu_objset_id(objset_t *os);
 577 extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name,
 578     uint64_t *id, uint64_t *offp, boolean_t *case_conflict);
 579 extern int dmu_snapshot_realname(objset_t *os, char *name, char *real,
 580     int maxlen, boolean_t *conflict);
 581 extern int dmu_dir_list_next(objset_t *os, int namelen, char *name,
 582     uint64_t *idp, uint64_t *offp);
 583
 584 typedef void objset_used_cb_t(objset_t *os, dmu_object_type_t bonustype,
 585     void *oldbonus, void *newbonus, uint64_t oldused, uint64_t newused,
 586     dmu_tx_t *tx);
 587 extern void dmu_objset_register_type(dmu_objset_type_t ost,
 588     objset_used_cb_t *cb);
 589 extern void dmu_objset_set_user(objset_t *os, void *user_ptr);
 590 extern void *dmu_objset_get_user(objset_t *os);
 591
 592 /*
 593  * Return the txg number for the given assigned transaction.
 594  */
 595 uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
 596
 597 /*
 598  * Synchronous write.
 599  * If a parent zio is provided this function initiates a write on the
 600  * provided buffer as a child of the parent zio.
 601  * In the absence of a parent zio, the write is completed synchronously.
 602  * At write completion, blk is filled with the bp of the written block.
 603  * Note that while the data covered by this function will be on stable
 604  * storage when the write completes this new data does not become a
 605  * permanent part of the file until the associated transaction commits.
 606  */
 607 typedef void dmu_sync_cb_t(dmu_buf_t *db, void *arg);
 608 int dmu_sync(struct zio *zio, dmu_buf_t *db,
 609     struct blkptr *bp, uint64_t txg, dmu_sync_cb_t *done, void *arg);
 610
 611 /*
 612  * Find the next hole or data block in file starting at *off
 613  * Return found offset in *off. Return ESRCH for end of file.
 614  */
 615 int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole,
 616     uint64_t *off);
 617
 618 /*
 619  * Initial setup and final teardown.
 620  */
 621 extern void dmu_init(void);
 622 extern void dmu_fini(void);
 623
 624 typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp,
 625     uint64_t object, uint64_t offset, int len);
 626 void dmu_traverse_objset(objset_t *os, uint64_t txg_start,
 627     dmu_traverse_cb_t cb, void *arg);
 628
 629 int dmu_sendbackup(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin,
 630     struct file *fp, offset_t *off);
 631
 632 typedef struct dmu_recv_cookie {
 633         /*
 634          * This structure is opaque!
 635          *
 636          * If logical and real are different, we are recving the stream
 637          * into the "real" temporary clone, and then switching it with
 638          * the "logical" target.
 639          */
 640         struct dsl_dataset *drc_logical_ds;
 641         struct dsl_dataset *drc_real_ds;
 642         struct drr_begin *drc_drrb;
 643         char *drc_tosnap;
 644         boolean_t drc_newfs;
 645         boolean_t drc_force;
 646 } dmu_recv_cookie_t;
 647
 648 int dmu_recv_begin(char *tofs, char *tosnap, struct drr_begin *,
 649     boolean_t force, objset_t *origin, boolean_t online, dmu_recv_cookie_t *);
 650 int dmu_recv_stream(dmu_recv_cookie_t *drc, struct file *fp, offset_t *voffp);
 651 int dmu_recv_end(dmu_recv_cookie_t *drc);
 652 void dmu_recv_abort_cleanup(dmu_recv_cookie_t *drc);
 653
 654 /* CRC64 table */
 655 #define ZFS_CRC64_POLY  0xC96C5795D7870F42ULL   /* ECMA-182, reflected form */
 656 extern uint64_t zfs_crc64_table[256];
 657
 658 #ifdef  __cplusplus
 659 }
 660 #endif
 661
 662 #endif  /* _SYS_DMU_H */