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