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 /*
  23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
  25  * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
  26  * Copyright (c) 2012, Joyent, Inc. All rights reserved.
  27  * Copyright 2013 DEY Storage Systems, Inc.
  28  */
  29
  30 /* Portions Copyright 2010 Robert Milkowski */
  31
  32 #ifndef _SYS_DMU_H
  33 #define _SYS_DMU_H
  34
  35 /*
  36  * This file describes the interface that the DMU provides for its
  37  * consumers.
  38  *
  39  * The DMU also interacts with the SPA.  That interface is described in
  40  * dmu_spa.h.
  41  */
  42
  43 #include <sys/types.h>
  44 #include <sys/param.h>
  45 #include <sys/cred.h>
  46 #include <sys/time.h>
  47 #include <sys/fs/zfs.h>
  48
  49 #ifdef  __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 struct uio;
  54 struct xuio;
  55 struct page;
  56 struct vnode;
  57 struct spa;
  58 struct zilog;
  59 struct zio;
  60 struct blkptr;
  61 struct zap_cursor;
  62 struct dsl_dataset;
  63 struct dsl_pool;
  64 struct dnode;
  65 struct drr_begin;
  66 struct drr_end;
  67 struct zbookmark;
  68 struct spa;
  69 struct nvlist;
  70 struct arc_buf;
  71 struct zio_prop;
  72 struct sa_handle;
  73 struct file;
  74
  75 typedef struct objset objset_t;
  76 typedef struct dmu_tx dmu_tx_t;
  77 typedef struct dsl_dir dsl_dir_t;
  78
  79 typedef enum dmu_object_byteswap {
  80         DMU_BSWAP_UINT8,
  81         DMU_BSWAP_UINT16,
  82         DMU_BSWAP_UINT32,
  83         DMU_BSWAP_UINT64,
  84         DMU_BSWAP_ZAP,
  85         DMU_BSWAP_DNODE,
  86         DMU_BSWAP_OBJSET,
  87         DMU_BSWAP_ZNODE,
  88         DMU_BSWAP_OLDACL,
  89         DMU_BSWAP_ACL,
  90         /*
  91          * Allocating a new byteswap type number makes the on-disk format
  92          * incompatible with any other format that uses the same number.
  93          *
  94          * Data can usually be structured to work with one of the
  95          * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types.
  96          */
  97         DMU_BSWAP_NUMFUNCS
  98 } dmu_object_byteswap_t;
  99
 100 #define DMU_OT_NEWTYPE 0x80
 101 #define DMU_OT_METADATA 0x40
 102 #define DMU_OT_BYTESWAP_MASK 0x3f
 103
 104 /*
 105  * Defines a uint8_t object type. Object types specify if the data
 106  * in the object is metadata (boolean) and how to byteswap the data
 107  * (dmu_object_byteswap_t).
 108  */
 109 #define DMU_OT(byteswap, metadata) \
 110         (DMU_OT_NEWTYPE | \
 111         ((metadata) ? DMU_OT_METADATA : 0) | \
 112         ((byteswap) & DMU_OT_BYTESWAP_MASK))
 113
 114 #define DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \
 115         ((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \
 116         (ot) < DMU_OT_NUMTYPES)
 117
 118 #define DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \
 119         ((ot) & DMU_OT_METADATA) : \
 120         dmu_ot[(ot)].ot_metadata)
 121
 122 /*
 123  * These object types use bp_fill != 1 for their L0 bp's. Therefore they can't
 124  * have their data embedded (i.e. use a BP_IS_EMBEDDED() bp), because bp_fill
 125  * is repurposed for embedded BPs.
 126  */
 127 #define DMU_OT_HAS_FILL(ot) \
 128         ((ot) == DMU_OT_DNODE || (ot) == DMU_OT_OBJSET)
 129
 130 #define DMU_OT_BYTESWAP(ot) (((ot) & DMU_OT_NEWTYPE) ? \
 131         ((ot) & DMU_OT_BYTESWAP_MASK) : \
 132         dmu_ot[(ot)].ot_byteswap)
 133
 134 typedef enum dmu_object_type {
 135         DMU_OT_NONE,
 136         /* general: */
 137         DMU_OT_OBJECT_DIRECTORY,        /* ZAP */
 138         DMU_OT_OBJECT_ARRAY,            /* UINT64 */
 139         DMU_OT_PACKED_NVLIST,           /* UINT8 (XDR by nvlist_pack/unpack) */
 140         DMU_OT_PACKED_NVLIST_SIZE,      /* UINT64 */
 141         DMU_OT_BPOBJ,                   /* UINT64 */
 142         DMU_OT_BPOBJ_HDR,               /* UINT64 */
 143         /* spa: */
 144         DMU_OT_SPACE_MAP_HEADER,        /* UINT64 */
 145         DMU_OT_SPACE_MAP,               /* UINT64 */
 146         /* zil: */
 147         DMU_OT_INTENT_LOG,              /* UINT64 */
 148         /* dmu: */
 149         DMU_OT_DNODE,                   /* DNODE */
 150         DMU_OT_OBJSET,                  /* OBJSET */
 151         /* dsl: */
 152         DMU_OT_DSL_DIR,                 /* UINT64 */
 153         DMU_OT_DSL_DIR_CHILD_MAP,       /* ZAP */
 154         DMU_OT_DSL_DS_SNAP_MAP,         /* ZAP */
 155         DMU_OT_DSL_PROPS,               /* ZAP */
 156         DMU_OT_DSL_DATASET,             /* UINT64 */
 157         /* zpl: */
 158         DMU_OT_ZNODE,                   /* ZNODE */
 159         DMU_OT_OLDACL,                  /* Old ACL */
 160         DMU_OT_PLAIN_FILE_CONTENTS,     /* UINT8 */
 161         DMU_OT_DIRECTORY_CONTENTS,      /* ZAP */
 162         DMU_OT_MASTER_NODE,             /* ZAP */
 163         DMU_OT_UNLINKED_SET,            /* ZAP */
 164         /* zvol: */
 165         DMU_OT_ZVOL,                    /* UINT8 */
 166         DMU_OT_ZVOL_PROP,               /* ZAP */
 167         /* other; for testing only! */
 168         DMU_OT_PLAIN_OTHER,             /* UINT8 */
 169         DMU_OT_UINT64_OTHER,            /* UINT64 */
 170         DMU_OT_ZAP_OTHER,               /* ZAP */
 171         /* new object types: */
 172         DMU_OT_ERROR_LOG,               /* ZAP */
 173         DMU_OT_SPA_HISTORY,             /* UINT8 */
 174         DMU_OT_SPA_HISTORY_OFFSETS,     /* spa_his_phys_t */
 175         DMU_OT_POOL_PROPS,              /* ZAP */
 176         DMU_OT_DSL_PERMS,               /* ZAP */
 177         DMU_OT_ACL,                     /* ACL */
 178         DMU_OT_SYSACL,                  /* SYSACL */
 179         DMU_OT_FUID,                    /* FUID table (Packed NVLIST UINT8) */
 180         DMU_OT_FUID_SIZE,               /* FUID table size UINT64 */
 181         DMU_OT_NEXT_CLONES,             /* ZAP */
 182         DMU_OT_SCAN_QUEUE,              /* ZAP */
 183         DMU_OT_USERGROUP_USED,          /* ZAP */
 184         DMU_OT_USERGROUP_QUOTA,         /* ZAP */
 185         DMU_OT_USERREFS,                /* ZAP */
 186         DMU_OT_DDT_ZAP,                 /* ZAP */
 187         DMU_OT_DDT_STATS,               /* ZAP */
 188         DMU_OT_SA,                      /* System attr */
 189         DMU_OT_SA_MASTER_NODE,          /* ZAP */
 190         DMU_OT_SA_ATTR_REGISTRATION,    /* ZAP */
 191         DMU_OT_SA_ATTR_LAYOUTS,         /* ZAP */
 192         DMU_OT_SCAN_XLATE,              /* ZAP */
 193         DMU_OT_DEDUP,                   /* fake dedup BP from ddt_bp_create() */
 194         DMU_OT_DEADLIST,                /* ZAP */
 195         DMU_OT_DEADLIST_HDR,            /* UINT64 */
 196         DMU_OT_DSL_CLONES,              /* ZAP */
 197         DMU_OT_BPOBJ_SUBOBJ,            /* UINT64 */
 198         /*
 199          * Do not allocate new object types here. Doing so makes the on-disk
 200          * format incompatible with any other format that uses the same object
 201          * type number.
 202          *
 203          * When creating an object which does not have one of the above types
 204          * use the DMU_OTN_* type with the correct byteswap and metadata
 205          * values.
 206          *
 207          * The DMU_OTN_* types do not have entries in the dmu_ot table,
 208          * use the DMU_OT_IS_METDATA() and DMU_OT_BYTESWAP() macros instead
 209          * of indexing into dmu_ot directly (this works for both DMU_OT_* types
 210          * and DMU_OTN_* types).
 211          */
 212         DMU_OT_NUMTYPES,
 213
 214         /*
 215          * Names for valid types declared with DMU_OT().
 216          */
 217         DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE),
 218         DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE),
 219         DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE),
 220         DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE),
 221         DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE),
 222         DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE),
 223         DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE),
 224         DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE),
 225         DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE),
 226         DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE),
 227 } dmu_object_type_t;
 228
 229 typedef enum txg_how {
 230         TXG_WAIT = 1,
 231         TXG_NOWAIT,
 232         TXG_WAITED,
 233 } txg_how_t;
 234
 235 void byteswap_uint64_array(void *buf, size_t size);
 236 void byteswap_uint32_array(void *buf, size_t size);
 237 void byteswap_uint16_array(void *buf, size_t size);
 238 void byteswap_uint8_array(void *buf, size_t size);
 239 void zap_byteswap(void *buf, size_t size);
 240 void zfs_oldacl_byteswap(void *buf, size_t size);
 241 void zfs_acl_byteswap(void *buf, size_t size);
 242 void zfs_znode_byteswap(void *buf, size_t size);
 243
 244 #define DS_FIND_SNAPSHOTS       (1<<0)
 245 #define DS_FIND_CHILDREN        (1<<1)
 246
 247 /*
 248  * The maximum number of bytes that can be accessed as part of one
 249  * operation, including metadata.
 250  */
 251 #define DMU_MAX_ACCESS (10<<20) /* 10MB */
 252 #define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */
 253
 254 #define DMU_USERUSED_OBJECT     (-1ULL)
 255 #define DMU_GROUPUSED_OBJECT    (-2ULL)
 256 #define DMU_DEADLIST_OBJECT     (-3ULL)
 257
 258 /*
 259  * artificial blkids for bonus buffer and spill blocks
 260  */
 261 #define DMU_BONUS_BLKID         (-1ULL)
 262 #define DMU_SPILL_BLKID         (-2ULL)
 263 /*
 264  * Public routines to create, destroy, open, and close objsets.
 265  */
 266 int dmu_objset_hold(const char *name, void *tag, objset_t **osp);
 267 int dmu_objset_own(const char *name, dmu_objset_type_t type,
 268     boolean_t readonly, void *tag, objset_t **osp);
 269 void dmu_objset_rele(objset_t *os, void *tag);
 270 void dmu_objset_disown(objset_t *os, void *tag);
 271 int dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp);
 272
 273 void dmu_objset_evict_dbufs(objset_t *os);
 274 int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags,
 275     void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg);
 276 int dmu_get_recursive_snaps_nvl(char *fsname, const char *snapname,
 277     struct nvlist *snaps);
 278 int dmu_objset_clone(const char *name, const char *origin);
 279 int dsl_destroy_snapshots_nvl(struct nvlist *snaps, boolean_t defer,
 280     struct nvlist *errlist);
 281 int dmu_objset_snapshot_one(const char *fsname, const char *snapname);
 282 int dmu_objset_snapshot_tmp(const char *, const char *, int);
 283 int dmu_objset_find(char *name, int func(const char *, void *), void *arg,
 284     int flags);
 285 void dmu_objset_byteswap(void *buf, size_t size);
 286 int dsl_dataset_rename_snapshot(const char *fsname,
 287     const char *oldsnapname, const char *newsnapname, boolean_t recursive);
 288
 289 typedef struct dmu_buf {
 290         uint64_t db_object;             /* object that this buffer is part of */
 291         uint64_t db_offset;             /* byte offset in this object */
 292         uint64_t db_size;               /* size of buffer in bytes */
 293         void *db_data;                  /* data in buffer */
 294 } dmu_buf_t;
 295
 296 typedef void dmu_buf_evict_func_t(struct dmu_buf *db, void *user_ptr);
 297
 298 /*
 299  * The names of zap entries in the DIRECTORY_OBJECT of the MOS.
 300  */
 301 #define DMU_POOL_DIRECTORY_OBJECT       1
 302 #define DMU_POOL_CONFIG                 "config"
 303 #define DMU_POOL_FEATURES_FOR_WRITE     "features_for_write"
 304 #define DMU_POOL_FEATURES_FOR_READ      "features_for_read"
 305 #define DMU_POOL_FEATURE_DESCRIPTIONS   "feature_descriptions"
 306 #define DMU_POOL_FEATURE_ENABLED_TXG    "feature_enabled_txg"
 307 #define DMU_POOL_ROOT_DATASET           "root_dataset"
 308 #define DMU_POOL_SYNC_BPOBJ             "sync_bplist"
 309 #define DMU_POOL_ERRLOG_SCRUB           "errlog_scrub"
 310 #define DMU_POOL_ERRLOG_LAST            "errlog_last"
 311 #define DMU_POOL_SPARES                 "spares"
 312 #define DMU_POOL_DEFLATE                "deflate"
 313 #define DMU_POOL_HISTORY                "history"
 314 #define DMU_POOL_PROPS                  "pool_props"
 315 #define DMU_POOL_L2CACHE                "l2cache"
 316 #define DMU_POOL_TMP_USERREFS           "tmp_userrefs"
 317 #define DMU_POOL_DDT                    "DDT-%s-%s-%s"
 318 #define DMU_POOL_DDT_STATS              "DDT-statistics"
 319 #define DMU_POOL_CREATION_VERSION       "creation_version"
 320 #define DMU_POOL_SCAN                   "scan"
 321 #define DMU_POOL_FREE_BPOBJ             "free_bpobj"
 322 #define DMU_POOL_BPTREE_OBJ             "bptree_obj"
 323 #define DMU_POOL_EMPTY_BPOBJ            "empty_bpobj"
 324
 325 /*
 326  * Allocate an object from this objset.  The range of object numbers
 327  * available is (0, DN_MAX_OBJECT).  Object 0 is the meta-dnode.
 328  *
 329  * The transaction must be assigned to a txg.  The newly allocated
 330  * object will be "held" in the transaction (ie. you can modify the
 331  * newly allocated object in this transaction).
 332  *
 333  * dmu_object_alloc() chooses an object and returns it in *objectp.
 334  *
 335  * dmu_object_claim() allocates a specific object number.  If that
 336  * number is already allocated, it fails and returns EEXIST.
 337  *
 338  * Return 0 on success, or ENOSPC or EEXIST as specified above.
 339  */
 340 uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot,
 341     int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
 342 int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot,
 343     int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx);
 344 int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot,
 345     int blocksize, dmu_object_type_t bonustype, int bonuslen);
 346
 347 /*
 348  * Free an object from this objset.
 349  *
 350  * The object's data will be freed as well (ie. you don't need to call
 351  * dmu_free(object, 0, -1, tx)).
 352  *
 353  * The object need not be held in the transaction.
 354  *
 355  * If there are any holds on this object's buffers (via dmu_buf_hold()),
 356  * or tx holds on the object (via dmu_tx_hold_object()), you can not
 357  * free it; it fails and returns EBUSY.
 358  *
 359  * If the object is not allocated, it fails and returns ENOENT.
 360  *
 361  * Return 0 on success, or EBUSY or ENOENT as specified above.
 362  */
 363 int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx);
 364
 365 /*
 366  * Find the next allocated or free object.
 367  *
 368  * The objectp parameter is in-out.  It will be updated to be the next
 369  * object which is allocated.  Ignore objects which have not been
 370  * modified since txg.
 371  *
 372  * XXX Can only be called on a objset with no dirty data.
 373  *
 374  * Returns 0 on success, or ENOENT if there are no more objects.
 375  */
 376 int dmu_object_next(objset_t *os, uint64_t *objectp,
 377     boolean_t hole, uint64_t txg);
 378
 379 /*
 380  * Set the data blocksize for an object.
 381  *
 382  * The object cannot have any blocks allcated beyond the first.  If
 383  * the first block is allocated already, the new size must be greater
 384  * than the current block size.  If these conditions are not met,
 385  * ENOTSUP will be returned.
 386  *
 387  * Returns 0 on success, or EBUSY if there are any holds on the object
 388  * contents, or ENOTSUP as described above.
 389  */
 390 int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size,
 391     int ibs, dmu_tx_t *tx);
 392
 393 /*
 394  * Set the checksum property on a dnode.  The new checksum algorithm will
 395  * apply to all newly written blocks; existing blocks will not be affected.
 396  */
 397 void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum,
 398     dmu_tx_t *tx);
 399
 400 /*
 401  * Set the compress property on a dnode.  The new compression algorithm will
 402  * apply to all newly written blocks; existing blocks will not be affected.
 403  */
 404 void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress,
 405     dmu_tx_t *tx);
 406
 407 void
 408 dmu_write_embedded(objset_t *os, uint64_t object, uint64_t offset,
 409     void *data, uint8_t etype, uint8_t comp, int uncompressed_size,
 410     int compressed_size, int byteorder, dmu_tx_t *tx);
 411
 412 /*
 413  * Decide how to write a block: checksum, compression, number of copies, etc.
 414  */
 415 #define WP_NOFILL       0x1
 416 #define WP_DMU_SYNC     0x2
 417 #define WP_SPILL        0x4
 418
 419 void dmu_write_policy(objset_t *os, struct dnode *dn, int level, int wp,
 420     struct zio_prop *zp);
 421 /*
 422  * The bonus data is accessed more or less like a regular buffer.
 423  * You must dmu_bonus_hold() to get the buffer, which will give you a
 424  * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus
 425  * data.  As with any normal buffer, you must call dmu_buf_read() to
 426  * read db_data, dmu_buf_will_dirty() before modifying it, and the
 427  * object must be held in an assigned transaction before calling
 428  * dmu_buf_will_dirty.  You may use dmu_buf_set_user() on the bonus
 429  * buffer as well.  You must release your hold with dmu_buf_rele().
 430  *
 431  * Returns ENOENT, EIO, or 0.
 432  */
 433 int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **);
 434 int dmu_bonus_max(void);
 435 int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *);
 436 int dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *);
 437 dmu_object_type_t dmu_get_bonustype(dmu_buf_t *);
 438 int dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *);
 439
 440 /*
 441  * Special spill buffer support used by "SA" framework
 442  */
 443
 444 int dmu_spill_hold_by_bonus(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
 445 int dmu_spill_hold_by_dnode(struct dnode *dn, uint32_t flags,
 446     void *tag, dmu_buf_t **dbp);
 447 int dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp);
 448
 449 /*
 450  * Obtain the DMU buffer from the specified object which contains the
 451  * specified offset.  dmu_buf_hold() puts a "hold" on the buffer, so
 452  * that it will remain in memory.  You must release the hold with
 453  * dmu_buf_rele().  You musn't access the dmu_buf_t after releasing your
 454  * hold.  You must have a hold on any dmu_buf_t* you pass to the DMU.
 455  *
 456  * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill
 457  * on the returned buffer before reading or writing the buffer's
 458  * db_data.  The comments for those routines describe what particular
 459  * operations are valid after calling them.
 460  *
 461  * The object number must be a valid, allocated object number.
 462  */
 463 int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset,
 464     void *tag, dmu_buf_t **, int flags);
 465 void dmu_buf_add_ref(dmu_buf_t *db, void* tag);
 466 void dmu_buf_rele(dmu_buf_t *db, void *tag);
 467 uint64_t dmu_buf_refcount(dmu_buf_t *db);
 468
 469 /*
 470  * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a
 471  * range of an object.  A pointer to an array of dmu_buf_t*'s is
 472  * returned (in *dbpp).
 473  *
 474  * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and
 475  * frees the array.  The hold on the array of buffers MUST be released
 476  * with dmu_buf_rele_array.  You can NOT release the hold on each buffer
 477  * individually with dmu_buf_rele.
 478  */
 479 int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset,
 480     uint64_t length, int read, void *tag, int *numbufsp, dmu_buf_t ***dbpp);
 481 void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag);
 482
 483 /*
 484  * Returns NULL on success, or the existing user ptr if it's already
 485  * been set.
 486  *
 487  * user_ptr is for use by the user and can be obtained via dmu_buf_get_user().
 488  *
 489  * user_data_ptr_ptr should be NULL, or a pointer to a pointer which
 490  * will be set to db->db_data when you are allowed to access it.  Note
 491  * that db->db_data (the pointer) can change when you do dmu_buf_read(),
 492  * dmu_buf_tryupgrade(), dmu_buf_will_dirty(), or dmu_buf_will_fill().
 493  * *user_data_ptr_ptr will be set to the new value when it changes.
 494  *
 495  * If non-NULL, pageout func will be called when this buffer is being
 496  * excised from the cache, so that you can clean up the data structure
 497  * pointed to by user_ptr.
 498  *
 499  * dmu_evict_user() will call the pageout func for all buffers in a
 500  * objset with a given pageout func.
 501  */
 502 void *dmu_buf_set_user(dmu_buf_t *db, void *user_ptr, void *user_data_ptr_ptr,
 503     dmu_buf_evict_func_t *pageout_func);
 504 /*
 505  * set_user_ie is the same as set_user, but request immediate eviction
 506  * when hold count goes to zero.
 507  */
 508 void *dmu_buf_set_user_ie(dmu_buf_t *db, void *user_ptr,
 509     void *user_data_ptr_ptr, dmu_buf_evict_func_t *pageout_func);
 510 void *dmu_buf_update_user(dmu_buf_t *db_fake, void *old_user_ptr,
 511     void *user_ptr, void *user_data_ptr_ptr,
 512     dmu_buf_evict_func_t *pageout_func);
 513 void dmu_evict_user(objset_t *os, dmu_buf_evict_func_t *func);
 514
 515 /*
 516  * Returns the user_ptr set with dmu_buf_set_user(), or NULL if not set.
 517  */
 518 void *dmu_buf_get_user(dmu_buf_t *db);
 519
 520 /*
 521  * Returns the blkptr associated with this dbuf, or NULL if not set.
 522  */
 523 struct blkptr *dmu_buf_get_blkptr(dmu_buf_t *db);
 524
 525 /*
 526  * Indicate that you are going to modify the buffer's data (db_data).
 527  *
 528  * The transaction (tx) must be assigned to a txg (ie. you've called
 529  * dmu_tx_assign()).  The buffer's object must be held in the tx
 530  * (ie. you've called dmu_tx_hold_object(tx, db->db_object)).
 531  */
 532 void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx);
 533
 534 /*
 535  * Tells if the given dbuf is freeable.
 536  */
 537 boolean_t dmu_buf_freeable(dmu_buf_t *);
 538
 539 /*
 540  * You must create a transaction, then hold the objects which you will
 541  * (or might) modify as part of this transaction.  Then you must assign
 542  * the transaction to a transaction group.  Once the transaction has
 543  * been assigned, you can modify buffers which belong to held objects as
 544  * part of this transaction.  You can't modify buffers before the
 545  * transaction has been assigned; you can't modify buffers which don't
 546  * belong to objects which this transaction holds; you can't hold
 547  * objects once the transaction has been assigned.  You may hold an
 548  * object which you are going to free (with dmu_object_free()), but you
 549  * don't have to.
 550  *
 551  * You can abort the transaction before it has been assigned.
 552  *
 553  * Note that you may hold buffers (with dmu_buf_hold) at any time,
 554  * regardless of transaction state.
 555  */
 556
 557 #define DMU_NEW_OBJECT  (-1ULL)
 558 #define DMU_OBJECT_END  (-1ULL)
 559
 560 dmu_tx_t *dmu_tx_create(objset_t *os);
 561 void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len);
 562 void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off,
 563     uint64_t len);
 564 void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name);
 565 void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object);
 566 void dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object);
 567 void dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow);
 568 void dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size);
 569 void dmu_tx_abort(dmu_tx_t *tx);
 570 int dmu_tx_assign(dmu_tx_t *tx, enum txg_how txg_how);
 571 void dmu_tx_wait(dmu_tx_t *tx);
 572 void dmu_tx_commit(dmu_tx_t *tx);
 573
 574 /*
 575  * To register a commit callback, dmu_tx_callback_register() must be called.
 576  *
 577  * dcb_data is a pointer to caller private data that is passed on as a
 578  * callback parameter. The caller is responsible for properly allocating and
 579  * freeing it.
 580  *
 581  * When registering a callback, the transaction must be already created, but
 582  * it cannot be committed or aborted. It can be assigned to a txg or not.
 583  *
 584  * The callback will be called after the transaction has been safely written
 585  * to stable storage and will also be called if the dmu_tx is aborted.
 586  * If there is any error which prevents the transaction from being committed to
 587  * disk, the callback will be called with a value of error != 0.
 588  */
 589 typedef void dmu_tx_callback_func_t(void *dcb_data, int error);
 590
 591 void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func,
 592     void *dcb_data);
 593
 594 /*
 595  * Free up the data blocks for a defined range of a file.  If size is
 596  * -1, the range from offset to end-of-file is freed.
 597  */
 598 int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset,
 599         uint64_t size, dmu_tx_t *tx);
 600 int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset,
 601         uint64_t size);
 602 int dmu_free_long_object(objset_t *os, uint64_t object);
 603
 604 /*
 605  * Convenience functions.
 606  *
 607  * Canfail routines will return 0 on success, or an errno if there is a
 608  * nonrecoverable I/O error.
 609  */
 610 #define DMU_READ_PREFETCH       0 /* prefetch */
 611 #define DMU_READ_NO_PREFETCH    1 /* don't prefetch */
 612 int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
 613         void *buf, uint32_t flags);
 614 void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
 615         const void *buf, dmu_tx_t *tx);
 616 void dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size,
 617         dmu_tx_t *tx);
 618 int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size);
 619 int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size,
 620     dmu_tx_t *tx);
 621 int dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size,
 622     dmu_tx_t *tx);
 623 #ifdef _KERNEL
 624 #ifdef sun
 625 int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset,
 626     uint64_t size, struct page *pp, dmu_tx_t *tx);
 627 #else
 628 int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset,
 629     uint64_t size, struct vm_page **ppa, dmu_tx_t *tx);
 630 #endif
 631 #endif
 632 struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size);
 633 void dmu_return_arcbuf(struct arc_buf *buf);
 634 void dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf,
 635     dmu_tx_t *tx);
 636 int dmu_xuio_init(struct xuio *uio, int niov);
 637 void dmu_xuio_fini(struct xuio *uio);
 638 int dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off,
 639     size_t n);
 640 int dmu_xuio_cnt(struct xuio *uio);
 641 struct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i);
 642 void dmu_xuio_clear(struct xuio *uio, int i);
 643 void xuio_stat_wbuf_copied();
 644 void xuio_stat_wbuf_nocopy();
 645
 646 extern int zfs_prefetch_disable;
 647
 648 /*
 649  * Asynchronously try to read in the data.
 650  */
 651 void dmu_prefetch(objset_t *os, uint64_t object, uint64_t offset,
 652     uint64_t len);
 653
 654 typedef struct dmu_object_info {
 655         /* All sizes are in bytes unless otherwise indicated. */
 656         uint32_t doi_data_block_size;
 657         uint32_t doi_metadata_block_size;
 658         dmu_object_type_t doi_type;
 659         dmu_object_type_t doi_bonus_type;
 660         uint64_t doi_bonus_size;
 661         uint8_t doi_indirection;                /* 2 = dnode->indirect->data */
 662         uint8_t doi_checksum;
 663         uint8_t doi_compress;
 664         uint8_t doi_pad[5];
 665         uint64_t doi_physical_blocks_512;       /* data + metadata, 512b blks */
 666         uint64_t doi_max_offset;
 667         uint64_t doi_fill_count;                /* number of non-empty blocks */
 668 } dmu_object_info_t;
 669
 670 typedef void arc_byteswap_func_t(void *buf, size_t size);
 671
 672 typedef struct dmu_object_type_info {
 673         dmu_object_byteswap_t   ot_byteswap;
 674         boolean_t               ot_metadata;
 675         char                    *ot_name;
 676 } dmu_object_type_info_t;
 677
 678 typedef struct dmu_object_byteswap_info {
 679         arc_byteswap_func_t     *ob_func;
 680         char                    *ob_name;
 681 } dmu_object_byteswap_info_t;
 682
 683 extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES];
 684 extern const dmu_object_byteswap_info_t dmu_ot_byteswap[DMU_BSWAP_NUMFUNCS];
 685
 686 /*
 687  * Get information on a DMU object.
 688  *
 689  * Return 0 on success or ENOENT if object is not allocated.
 690  *
 691  * If doi is NULL, just indicates whether the object exists.
 692  */
 693 int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi);
 694 /* Like dmu_object_info, but faster if you have a held dnode in hand. */
 695 void dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi);
 696 /* Like dmu_object_info, but faster if you have a held dbuf in hand. */
 697 void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi);
 698 /*
 699  * Like dmu_object_info_from_db, but faster still when you only care about
 700  * the size.  This is specifically optimized for zfs_getattr().
 701  */
 702 void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize,
 703     u_longlong_t *nblk512);
 704
 705 typedef struct dmu_objset_stats {
 706         uint64_t dds_num_clones; /* number of clones of this */
 707         uint64_t dds_creation_txg;
 708         uint64_t dds_guid;
 709         dmu_objset_type_t dds_type;
 710         uint8_t dds_is_snapshot;
 711         uint8_t dds_inconsistent;
 712         char dds_origin[MAXNAMELEN];
 713 } dmu_objset_stats_t;
 714
 715 /*
 716  * Get stats on a dataset.
 717  */
 718 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat);
 719
 720 /*
 721  * Add entries to the nvlist for all the objset's properties.  See
 722  * zfs_prop_table[] and zfs(1m) for details on the properties.
 723  */
 724 void dmu_objset_stats(objset_t *os, struct nvlist *nv);
 725
 726 /*
 727  * Get the space usage statistics for statvfs().
 728  *
 729  * refdbytes is the amount of space "referenced" by this objset.
 730  * availbytes is the amount of space available to this objset, taking
 731  * into account quotas & reservations, assuming that no other objsets
 732  * use the space first.  These values correspond to the 'referenced' and
 733  * 'available' properties, described in the zfs(1m) manpage.
 734  *
 735  * usedobjs and availobjs are the number of objects currently allocated,
 736  * and available.
 737  */
 738 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp,
 739     uint64_t *usedobjsp, uint64_t *availobjsp);
 740
 741 /*
 742  * The fsid_guid is a 56-bit ID that can change to avoid collisions.
 743  * (Contrast with the ds_guid which is a 64-bit ID that will never
 744  * change, so there is a small probability that it will collide.)
 745  */
 746 uint64_t dmu_objset_fsid_guid(objset_t *os);
 747
 748 /*
 749  * Get the [cm]time for an objset's snapshot dir
 750  */
 751 timestruc_t dmu_objset_snap_cmtime(objset_t *os);
 752
 753 int dmu_objset_is_snapshot(objset_t *os);
 754
 755 extern struct spa *dmu_objset_spa(objset_t *os);
 756 extern struct zilog *dmu_objset_zil(objset_t *os);
 757 extern struct dsl_pool *dmu_objset_pool(objset_t *os);
 758 extern struct dsl_dataset *dmu_objset_ds(objset_t *os);
 759 extern void dmu_objset_name(objset_t *os, char *buf);
 760 extern dmu_objset_type_t dmu_objset_type(objset_t *os);
 761 extern uint64_t dmu_objset_id(objset_t *os);
 762 extern zfs_sync_type_t dmu_objset_syncprop(objset_t *os);
 763 extern zfs_logbias_op_t dmu_objset_logbias(objset_t *os);
 764 extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name,
 765     uint64_t *id, uint64_t *offp, boolean_t *case_conflict);
 766 extern int dmu_snapshot_realname(objset_t *os, char *name, char *real,
 767     int maxlen, boolean_t *conflict);
 768 extern int dmu_dir_list_next(objset_t *os, int namelen, char *name,
 769     uint64_t *idp, uint64_t *offp);
 770
 771 typedef int objset_used_cb_t(dmu_object_type_t bonustype,
 772     void *bonus, uint64_t *userp, uint64_t *groupp);
 773 extern void dmu_objset_register_type(dmu_objset_type_t ost,
 774     objset_used_cb_t *cb);
 775 extern void dmu_objset_set_user(objset_t *os, void *user_ptr);
 776 extern void *dmu_objset_get_user(objset_t *os);
 777
 778 /*
 779  * Return the txg number for the given assigned transaction.
 780  */
 781 uint64_t dmu_tx_get_txg(dmu_tx_t *tx);
 782
 783 /*
 784  * Synchronous write.
 785  * If a parent zio is provided this function initiates a write on the
 786  * provided buffer as a child of the parent zio.
 787  * In the absence of a parent zio, the write is completed synchronously.
 788  * At write completion, blk is filled with the bp of the written block.
 789  * Note that while the data covered by this function will be on stable
 790  * storage when the write completes this new data does not become a
 791  * permanent part of the file until the associated transaction commits.
 792  */
 793
 794 /*
 795  * {zfs,zvol,ztest}_get_done() args
 796  */
 797 typedef struct zgd {
 798         struct zilog    *zgd_zilog;
 799         struct blkptr   *zgd_bp;
 800         dmu_buf_t       *zgd_db;
 801         struct rl       *zgd_rl;
 802         void            *zgd_private;
 803 } zgd_t;
 804
 805 typedef void dmu_sync_cb_t(zgd_t *arg, int error);
 806 int dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd);
 807
 808 /*
 809  * Find the next hole or data block in file starting at *off
 810  * Return found offset in *off. Return ESRCH for end of file.
 811  */
 812 int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole,
 813     uint64_t *off);
 814
 815 /*
 816  * Initial setup and final teardown.
 817  */
 818 extern void dmu_init(void);
 819 extern void dmu_fini(void);
 820
 821 typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp,
 822     uint64_t object, uint64_t offset, int len);
 823 void dmu_traverse_objset(objset_t *os, uint64_t txg_start,
 824     dmu_traverse_cb_t cb, void *arg);
 825 int dmu_diff(const char *tosnap_name, const char *fromsnap_name,
 826     struct file *fp, offset_t *offp);
 827
 828 /* CRC64 table */
 829 #define ZFS_CRC64_POLY  0xC96C5795D7870F42ULL   /* ECMA-182, reflected form */
 830 extern uint64_t zfs_crc64_table[256];
 831
 832 extern int zfs_mdcomp_disable;
 833
 834 #ifdef  __cplusplus
 835 }
 836 #endif
 837
 838 #endif  /* _SYS_DMU_H */