include/sys/dmu.h

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