1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5ea8dc4b6Seschrock * Common Development and Distribution License (the "License"). 6ea8dc4b6Seschrock * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21ad135b5dSChristopher Siden 22fa9e4066Sahrens /* 2394d1a210STim Haley * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24ad135b5dSChristopher Siden * Copyright (c) 2012 by Delphix. All rights reserved. 25ec5cf9d5SAlexander Stetsenko * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 264e3c9f44SBill Pijewski * Copyright (c) 2012, Joyent, Inc. All rights reserved. 27ec5cf9d5SAlexander Stetsenko */ 28fa9e4066Sahrens 2955da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */ 3055da60b9SMark J Musante 31fa9e4066Sahrens #ifndef _SYS_DMU_H 32fa9e4066Sahrens #define _SYS_DMU_H 33fa9e4066Sahrens 34fa9e4066Sahrens /* 35fa9e4066Sahrens * This file describes the interface that the DMU provides for its 36fa9e4066Sahrens * consumers. 37fa9e4066Sahrens * 38fa9e4066Sahrens * The DMU also interacts with the SPA. That interface is described in 39fa9e4066Sahrens * dmu_spa.h. 40fa9e4066Sahrens */ 41fa9e4066Sahrens 42fa9e4066Sahrens #include <sys/inttypes.h> 43fa9e4066Sahrens #include <sys/types.h> 44fa9e4066Sahrens #include <sys/param.h> 45ecd6cf80Smarks #include <sys/cred.h> 4671eb0538SChris Kirby #include <sys/time.h> 474445fffbSMatthew Ahrens #include <sys/fs/zfs.h> 48fa9e4066Sahrens 49fa9e4066Sahrens #ifdef __cplusplus 50fa9e4066Sahrens extern "C" { 51fa9e4066Sahrens #endif 52fa9e4066Sahrens 53fa9e4066Sahrens struct uio; 54c242f9a0Schunli zhang - Sun Microsystems - Irvine United States struct xuio; 5544eda4d7Smaybee struct page; 56fa9e4066Sahrens struct vnode; 57fa9e4066Sahrens struct spa; 58fa9e4066Sahrens struct zilog; 59fa9e4066Sahrens struct zio; 60fa9e4066Sahrens struct blkptr; 61fa9e4066Sahrens struct zap_cursor; 62fa9e4066Sahrens struct dsl_dataset; 63fa9e4066Sahrens struct dsl_pool; 64fa9e4066Sahrens struct dnode; 65fa9e4066Sahrens struct drr_begin; 66fa9e4066Sahrens struct drr_end; 6744cd46caSbillm struct zbookmark; 6844cd46caSbillm struct spa; 69a2eea2e1Sahrens struct nvlist; 702fdbea25SAleksandr Guzovskiy struct arc_buf; 71b24ab676SJeff Bonwick struct zio_prop; 720a586ceaSMark Shellenbaum struct sa_handle; 73fa9e4066Sahrens 74fa9e4066Sahrens typedef struct objset objset_t; 75fa9e4066Sahrens typedef struct dmu_tx dmu_tx_t; 76fa9e4066Sahrens typedef struct dsl_dir dsl_dir_t; 77fa9e4066Sahrens 78ad135b5dSChristopher Siden typedef enum dmu_object_byteswap { 79ad135b5dSChristopher Siden DMU_BSWAP_UINT8, 80ad135b5dSChristopher Siden DMU_BSWAP_UINT16, 81ad135b5dSChristopher Siden DMU_BSWAP_UINT32, 82ad135b5dSChristopher Siden DMU_BSWAP_UINT64, 83ad135b5dSChristopher Siden DMU_BSWAP_ZAP, 84ad135b5dSChristopher Siden DMU_BSWAP_DNODE, 85ad135b5dSChristopher Siden DMU_BSWAP_OBJSET, 86ad135b5dSChristopher Siden DMU_BSWAP_ZNODE, 87ad135b5dSChristopher Siden DMU_BSWAP_OLDACL, 88ad135b5dSChristopher Siden DMU_BSWAP_ACL, 89ad135b5dSChristopher Siden /* 90ad135b5dSChristopher Siden * Allocating a new byteswap type number makes the on-disk format 91ad135b5dSChristopher Siden * incompatible with any other format that uses the same number. 92ad135b5dSChristopher Siden * 93ad135b5dSChristopher Siden * Data can usually be structured to work with one of the 94ad135b5dSChristopher Siden * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types. 95ad135b5dSChristopher Siden */ 96ad135b5dSChristopher Siden DMU_BSWAP_NUMFUNCS 97ad135b5dSChristopher Siden } dmu_object_byteswap_t; 98ad135b5dSChristopher Siden 99ad135b5dSChristopher Siden #define DMU_OT_NEWTYPE 0x80 100ad135b5dSChristopher Siden #define DMU_OT_METADATA 0x40 101ad135b5dSChristopher Siden #define DMU_OT_BYTESWAP_MASK 0x3f 102ad135b5dSChristopher Siden 103ad135b5dSChristopher Siden /* 104ad135b5dSChristopher Siden * Defines a uint8_t object type. Object types specify if the data 105ad135b5dSChristopher Siden * in the object is metadata (boolean) and how to byteswap the data 106ad135b5dSChristopher Siden * (dmu_object_byteswap_t). 107ad135b5dSChristopher Siden */ 108ad135b5dSChristopher Siden #define DMU_OT(byteswap, metadata) \ 109ad135b5dSChristopher Siden (DMU_OT_NEWTYPE | \ 110ad135b5dSChristopher Siden ((metadata) ? DMU_OT_METADATA : 0) | \ 111ad135b5dSChristopher Siden ((byteswap) & DMU_OT_BYTESWAP_MASK)) 112ad135b5dSChristopher Siden 113ad135b5dSChristopher Siden #define DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \ 114ad135b5dSChristopher Siden ((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \ 115ad135b5dSChristopher Siden (ot) < DMU_OT_NUMTYPES) 116ad135b5dSChristopher Siden 117ad135b5dSChristopher Siden #define DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \ 118ad135b5dSChristopher Siden ((ot) & DMU_OT_METADATA) : \ 119ad135b5dSChristopher Siden dmu_ot[(ot)].ot_metadata) 120ad135b5dSChristopher Siden 121ad135b5dSChristopher Siden #define DMU_OT_BYTESWAP(ot) (((ot) & DMU_OT_NEWTYPE) ? \ 122ad135b5dSChristopher Siden ((ot) & DMU_OT_BYTESWAP_MASK) : \ 123ad135b5dSChristopher Siden dmu_ot[(ot)].ot_byteswap) 124ad135b5dSChristopher Siden 125fa9e4066Sahrens typedef enum dmu_object_type { 126fa9e4066Sahrens DMU_OT_NONE, 127fa9e4066Sahrens /* general: */ 128fa9e4066Sahrens DMU_OT_OBJECT_DIRECTORY, /* ZAP */ 129fa9e4066Sahrens DMU_OT_OBJECT_ARRAY, /* UINT64 */ 130fa9e4066Sahrens DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */ 131fa9e4066Sahrens DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */ 132cde58dbcSMatthew Ahrens DMU_OT_BPOBJ, /* UINT64 */ 133cde58dbcSMatthew Ahrens DMU_OT_BPOBJ_HDR, /* UINT64 */ 134fa9e4066Sahrens /* spa: */ 135fa9e4066Sahrens DMU_OT_SPACE_MAP_HEADER, /* UINT64 */ 136fa9e4066Sahrens DMU_OT_SPACE_MAP, /* UINT64 */ 137fa9e4066Sahrens /* zil: */ 138fa9e4066Sahrens DMU_OT_INTENT_LOG, /* UINT64 */ 139fa9e4066Sahrens /* dmu: */ 140fa9e4066Sahrens DMU_OT_DNODE, /* DNODE */ 141fa9e4066Sahrens DMU_OT_OBJSET, /* OBJSET */ 142fa9e4066Sahrens /* dsl: */ 1431649cd4bStabriz DMU_OT_DSL_DIR, /* UINT64 */ 14487e5029aSahrens DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */ 14587e5029aSahrens DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */ 146fa9e4066Sahrens DMU_OT_DSL_PROPS, /* ZAP */ 1471649cd4bStabriz DMU_OT_DSL_DATASET, /* UINT64 */ 148fa9e4066Sahrens /* zpl: */ 149fa9e4066Sahrens DMU_OT_ZNODE, /* ZNODE */ 150da6c28aaSamw DMU_OT_OLDACL, /* Old ACL */ 151fa9e4066Sahrens DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */ 152fa9e4066Sahrens DMU_OT_DIRECTORY_CONTENTS, /* ZAP */ 153fa9e4066Sahrens DMU_OT_MASTER_NODE, /* ZAP */ 154893a6d32Sahrens DMU_OT_UNLINKED_SET, /* ZAP */ 155fa9e4066Sahrens /* zvol: */ 156fa9e4066Sahrens DMU_OT_ZVOL, /* UINT8 */ 157fa9e4066Sahrens DMU_OT_ZVOL_PROP, /* ZAP */ 158fa9e4066Sahrens /* other; for testing only! */ 159fa9e4066Sahrens DMU_OT_PLAIN_OTHER, /* UINT8 */ 160fa9e4066Sahrens DMU_OT_UINT64_OTHER, /* UINT64 */ 161fa9e4066Sahrens DMU_OT_ZAP_OTHER, /* ZAP */ 162ea8dc4b6Seschrock /* new object types: */ 163ea8dc4b6Seschrock DMU_OT_ERROR_LOG, /* ZAP */ 16406eeb2adSek DMU_OT_SPA_HISTORY, /* UINT8 */ 16506eeb2adSek DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */ 166b1b8ab34Slling DMU_OT_POOL_PROPS, /* ZAP */ 167ecd6cf80Smarks DMU_OT_DSL_PERMS, /* ZAP */ 168da6c28aaSamw DMU_OT_ACL, /* ACL */ 169da6c28aaSamw DMU_OT_SYSACL, /* SYSACL */ 170da6c28aaSamw DMU_OT_FUID, /* FUID table (Packed NVLIST UINT8) */ 171da6c28aaSamw DMU_OT_FUID_SIZE, /* FUID table size UINT64 */ 172088f3894Sahrens DMU_OT_NEXT_CLONES, /* ZAP */ 1733f9d6ad7SLin Ling DMU_OT_SCAN_QUEUE, /* ZAP */ 17414843421SMatthew Ahrens DMU_OT_USERGROUP_USED, /* ZAP */ 17514843421SMatthew Ahrens DMU_OT_USERGROUP_QUOTA, /* ZAP */ 176842727c2SChris Kirby DMU_OT_USERREFS, /* ZAP */ 177b24ab676SJeff Bonwick DMU_OT_DDT_ZAP, /* ZAP */ 178b24ab676SJeff Bonwick DMU_OT_DDT_STATS, /* ZAP */ 1790a586ceaSMark Shellenbaum DMU_OT_SA, /* System attr */ 1800a586ceaSMark Shellenbaum DMU_OT_SA_MASTER_NODE, /* ZAP */ 1810a586ceaSMark Shellenbaum DMU_OT_SA_ATTR_REGISTRATION, /* ZAP */ 1820a586ceaSMark Shellenbaum DMU_OT_SA_ATTR_LAYOUTS, /* ZAP */ 1833f9d6ad7SLin Ling DMU_OT_SCAN_XLATE, /* ZAP */ 1843f9d6ad7SLin Ling DMU_OT_DEDUP, /* fake dedup BP from ddt_bp_create() */ 185cde58dbcSMatthew Ahrens DMU_OT_DEADLIST, /* ZAP */ 186cde58dbcSMatthew Ahrens DMU_OT_DEADLIST_HDR, /* UINT64 */ 187cde58dbcSMatthew Ahrens DMU_OT_DSL_CLONES, /* ZAP */ 188cde58dbcSMatthew Ahrens DMU_OT_BPOBJ_SUBOBJ, /* UINT64 */ 189ad135b5dSChristopher Siden /* 190ad135b5dSChristopher Siden * Do not allocate new object types here. Doing so makes the on-disk 191ad135b5dSChristopher Siden * format incompatible with any other format that uses the same object 192ad135b5dSChristopher Siden * type number. 193ad135b5dSChristopher Siden * 194ad135b5dSChristopher Siden * When creating an object which does not have one of the above types 195ad135b5dSChristopher Siden * use the DMU_OTN_* type with the correct byteswap and metadata 196ad135b5dSChristopher Siden * values. 197ad135b5dSChristopher Siden * 198ad135b5dSChristopher Siden * The DMU_OTN_* types do not have entries in the dmu_ot table, 199ad135b5dSChristopher Siden * use the DMU_OT_IS_METDATA() and DMU_OT_BYTESWAP() macros instead 200ad135b5dSChristopher Siden * of indexing into dmu_ot directly (this works for both DMU_OT_* types 201ad135b5dSChristopher Siden * and DMU_OTN_* types). 202ad135b5dSChristopher Siden */ 203ad135b5dSChristopher Siden DMU_OT_NUMTYPES, 204ad135b5dSChristopher Siden 205ad135b5dSChristopher Siden /* 206ad135b5dSChristopher Siden * Names for valid types declared with DMU_OT(). 207ad135b5dSChristopher Siden */ 208ad135b5dSChristopher Siden DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE), 209ad135b5dSChristopher Siden DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE), 210ad135b5dSChristopher Siden DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE), 211ad135b5dSChristopher Siden DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE), 212ad135b5dSChristopher Siden DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE), 213ad135b5dSChristopher Siden DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE), 214ad135b5dSChristopher Siden DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE), 215ad135b5dSChristopher Siden DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE), 216ad135b5dSChristopher Siden DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE), 217ad135b5dSChristopher Siden DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE), 218fa9e4066Sahrens } dmu_object_type_t; 219fa9e4066Sahrens 220fa9e4066Sahrens void byteswap_uint64_array(void *buf, size_t size); 221fa9e4066Sahrens void byteswap_uint32_array(void *buf, size_t size); 222fa9e4066Sahrens void byteswap_uint16_array(void *buf, size_t size); 223fa9e4066Sahrens void byteswap_uint8_array(void *buf, size_t size); 224fa9e4066Sahrens void zap_byteswap(void *buf, size_t size); 225da6c28aaSamw void zfs_oldacl_byteswap(void *buf, size_t size); 226fa9e4066Sahrens void zfs_acl_byteswap(void *buf, size_t size); 227fa9e4066Sahrens void zfs_znode_byteswap(void *buf, size_t size); 228fa9e4066Sahrens 2290b69c2f0Sahrens #define DS_FIND_SNAPSHOTS (1<<0) 2300b69c2f0Sahrens #define DS_FIND_CHILDREN (1<<1) 231fa9e4066Sahrens 232fa9e4066Sahrens /* 233fa9e4066Sahrens * The maximum number of bytes that can be accessed as part of one 234fa9e4066Sahrens * operation, including metadata. 235fa9e4066Sahrens */ 236fa9e4066Sahrens #define DMU_MAX_ACCESS (10<<20) /* 10MB */ 237cdb0ab79Smaybee #define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */ 238fa9e4066Sahrens 23914843421SMatthew Ahrens #define DMU_USERUSED_OBJECT (-1ULL) 24014843421SMatthew Ahrens #define DMU_GROUPUSED_OBJECT (-2ULL) 241b24ab676SJeff Bonwick #define DMU_DEADLIST_OBJECT (-3ULL) 24214843421SMatthew Ahrens 2430a586ceaSMark Shellenbaum /* 2440a586ceaSMark Shellenbaum * artificial blkids for bonus buffer and spill blocks 2450a586ceaSMark Shellenbaum */ 2460a586ceaSMark Shellenbaum #define DMU_BONUS_BLKID (-1ULL) 2470a586ceaSMark Shellenbaum #define DMU_SPILL_BLKID (-2ULL) 248fa9e4066Sahrens /* 249fa9e4066Sahrens * Public routines to create, destroy, open, and close objsets. 250fa9e4066Sahrens */ 251503ad85cSMatthew Ahrens int dmu_objset_hold(const char *name, void *tag, objset_t **osp); 252503ad85cSMatthew Ahrens int dmu_objset_own(const char *name, dmu_objset_type_t type, 253503ad85cSMatthew Ahrens boolean_t readonly, void *tag, objset_t **osp); 254503ad85cSMatthew Ahrens void dmu_objset_rele(objset_t *os, void *tag); 255503ad85cSMatthew Ahrens void dmu_objset_disown(objset_t *os, void *tag); 256503ad85cSMatthew Ahrens int dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp); 257503ad85cSMatthew Ahrens 2581934e92fSmaybee int dmu_objset_evict_dbufs(objset_t *os); 259ae46e4c7SMatthew Ahrens int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags, 260ecd6cf80Smarks void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg); 261ae46e4c7SMatthew Ahrens int dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin, 262ae46e4c7SMatthew Ahrens uint64_t flags); 263842727c2SChris Kirby int dmu_objset_destroy(const char *name, boolean_t defer); 2644445fffbSMatthew Ahrens int dmu_snapshots_destroy_nvl(struct nvlist *snaps, boolean_t defer, 2654445fffbSMatthew Ahrens struct nvlist *errlist); 2664445fffbSMatthew Ahrens int dmu_objset_snapshot(struct nvlist *snaps, struct nvlist *, struct nvlist *); 2674445fffbSMatthew Ahrens int dmu_objset_snapshot_one(const char *fsname, const char *snapname); 2684445fffbSMatthew Ahrens int dmu_objset_snapshot_tmp(const char *, const char *, int); 269cdf5b4caSmmusante int dmu_objset_rename(const char *name, const char *newname, 270cdf5b4caSmmusante boolean_t recursive); 271fd136879SMatthew Ahrens int dmu_objset_find(char *name, int func(const char *, void *), void *arg, 272fa9e4066Sahrens int flags); 273fa9e4066Sahrens void dmu_objset_byteswap(void *buf, size_t size); 274fa9e4066Sahrens 275fa9e4066Sahrens typedef struct dmu_buf { 276fa9e4066Sahrens uint64_t db_object; /* object that this buffer is part of */ 277fa9e4066Sahrens uint64_t db_offset; /* byte offset in this object */ 278fa9e4066Sahrens uint64_t db_size; /* size of buffer in bytes */ 279fa9e4066Sahrens void *db_data; /* data in buffer */ 280fa9e4066Sahrens } dmu_buf_t; 281fa9e4066Sahrens 282fa9e4066Sahrens typedef void dmu_buf_evict_func_t(struct dmu_buf *db, void *user_ptr); 283fa9e4066Sahrens 28499653d4eSeschrock /* 28599653d4eSeschrock * The names of zap entries in the DIRECTORY_OBJECT of the MOS. 28699653d4eSeschrock */ 287fa9e4066Sahrens #define DMU_POOL_DIRECTORY_OBJECT 1 288fa9e4066Sahrens #define DMU_POOL_CONFIG "config" 289ad135b5dSChristopher Siden #define DMU_POOL_FEATURES_FOR_WRITE "features_for_write" 290ad135b5dSChristopher Siden #define DMU_POOL_FEATURES_FOR_READ "features_for_read" 291ad135b5dSChristopher Siden #define DMU_POOL_FEATURE_DESCRIPTIONS "feature_descriptions" 292fa9e4066Sahrens #define DMU_POOL_ROOT_DATASET "root_dataset" 293cde58dbcSMatthew Ahrens #define DMU_POOL_SYNC_BPOBJ "sync_bplist" 294ea8dc4b6Seschrock #define DMU_POOL_ERRLOG_SCRUB "errlog_scrub" 295ea8dc4b6Seschrock #define DMU_POOL_ERRLOG_LAST "errlog_last" 29699653d4eSeschrock #define DMU_POOL_SPARES "spares" 29799653d4eSeschrock #define DMU_POOL_DEFLATE "deflate" 29806eeb2adSek #define DMU_POOL_HISTORY "history" 299b1b8ab34Slling #define DMU_POOL_PROPS "pool_props" 300fa94a07fSbrendan #define DMU_POOL_L2CACHE "l2cache" 301ca45db41SChris Kirby #define DMU_POOL_TMP_USERREFS "tmp_userrefs" 302b24ab676SJeff Bonwick #define DMU_POOL_DDT "DDT-%s-%s-%s" 303b24ab676SJeff Bonwick #define DMU_POOL_DDT_STATS "DDT-statistics" 3043f9d6ad7SLin Ling #define DMU_POOL_CREATION_VERSION "creation_version" 3053f9d6ad7SLin Ling #define DMU_POOL_SCAN "scan" 306cde58dbcSMatthew Ahrens #define DMU_POOL_FREE_BPOBJ "free_bpobj" 307ad135b5dSChristopher Siden #define DMU_POOL_BPTREE_OBJ "bptree_obj" 308f1745736SMatthew Ahrens #define DMU_POOL_EMPTY_BPOBJ "empty_bpobj" 309088f3894Sahrens 310fa9e4066Sahrens /* 311fa9e4066Sahrens * Allocate an object from this objset. The range of object numbers 312fa9e4066Sahrens * available is (0, DN_MAX_OBJECT). Object 0 is the meta-dnode. 313fa9e4066Sahrens * 314fa9e4066Sahrens * The transaction must be assigned to a txg. The newly allocated 315fa9e4066Sahrens * object will be "held" in the transaction (ie. you can modify the 316fa9e4066Sahrens * newly allocated object in this transaction). 317fa9e4066Sahrens * 318fa9e4066Sahrens * dmu_object_alloc() chooses an object and returns it in *objectp. 319fa9e4066Sahrens * 320fa9e4066Sahrens * dmu_object_claim() allocates a specific object number. If that 321fa9e4066Sahrens * number is already allocated, it fails and returns EEXIST. 322fa9e4066Sahrens * 323fa9e4066Sahrens * Return 0 on success, or ENOSPC or EEXIST as specified above. 324fa9e4066Sahrens */ 325fa9e4066Sahrens uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot, 326fa9e4066Sahrens int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx); 327fa9e4066Sahrens int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot, 328fa9e4066Sahrens int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx); 329fa9e4066Sahrens int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot, 3302bf405a2SMark Maybee int blocksize, dmu_object_type_t bonustype, int bonuslen); 331fa9e4066Sahrens 332fa9e4066Sahrens /* 333fa9e4066Sahrens * Free an object from this objset. 334fa9e4066Sahrens * 335fa9e4066Sahrens * The object's data will be freed as well (ie. you don't need to call 336fa9e4066Sahrens * dmu_free(object, 0, -1, tx)). 337fa9e4066Sahrens * 338fa9e4066Sahrens * The object need not be held in the transaction. 339fa9e4066Sahrens * 340fa9e4066Sahrens * If there are any holds on this object's buffers (via dmu_buf_hold()), 341fa9e4066Sahrens * or tx holds on the object (via dmu_tx_hold_object()), you can not 342fa9e4066Sahrens * free it; it fails and returns EBUSY. 343fa9e4066Sahrens * 344fa9e4066Sahrens * If the object is not allocated, it fails and returns ENOENT. 345fa9e4066Sahrens * 346fa9e4066Sahrens * Return 0 on success, or EBUSY or ENOENT as specified above. 347fa9e4066Sahrens */ 348fa9e4066Sahrens int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx); 349fa9e4066Sahrens 350fa9e4066Sahrens /* 351fa9e4066Sahrens * Find the next allocated or free object. 352fa9e4066Sahrens * 353fa9e4066Sahrens * The objectp parameter is in-out. It will be updated to be the next 3546754306eSahrens * object which is allocated. Ignore objects which have not been 3556754306eSahrens * modified since txg. 356fa9e4066Sahrens * 357fa9e4066Sahrens * XXX Can only be called on a objset with no dirty data. 358fa9e4066Sahrens * 359fa9e4066Sahrens * Returns 0 on success, or ENOENT if there are no more objects. 360fa9e4066Sahrens */ 3616754306eSahrens int dmu_object_next(objset_t *os, uint64_t *objectp, 3626754306eSahrens boolean_t hole, uint64_t txg); 363fa9e4066Sahrens 364fa9e4066Sahrens /* 365fa9e4066Sahrens * Set the data blocksize for an object. 366fa9e4066Sahrens * 367fa9e4066Sahrens * The object cannot have any blocks allcated beyond the first. If 368fa9e4066Sahrens * the first block is allocated already, the new size must be greater 369fa9e4066Sahrens * than the current block size. If these conditions are not met, 370fa9e4066Sahrens * ENOTSUP will be returned. 371fa9e4066Sahrens * 372fa9e4066Sahrens * Returns 0 on success, or EBUSY if there are any holds on the object 373fa9e4066Sahrens * contents, or ENOTSUP as described above. 374fa9e4066Sahrens */ 375fa9e4066Sahrens int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size, 376fa9e4066Sahrens int ibs, dmu_tx_t *tx); 377fa9e4066Sahrens 378fa9e4066Sahrens /* 379fa9e4066Sahrens * Set the checksum property on a dnode. The new checksum algorithm will 380fa9e4066Sahrens * apply to all newly written blocks; existing blocks will not be affected. 381fa9e4066Sahrens */ 382fa9e4066Sahrens void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum, 383fa9e4066Sahrens dmu_tx_t *tx); 384fa9e4066Sahrens 385fa9e4066Sahrens /* 386fa9e4066Sahrens * Set the compress property on a dnode. The new compression algorithm will 387fa9e4066Sahrens * apply to all newly written blocks; existing blocks will not be affected. 388fa9e4066Sahrens */ 389fa9e4066Sahrens void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress, 390fa9e4066Sahrens dmu_tx_t *tx); 391fa9e4066Sahrens 39244cd46caSbillm /* 393b24ab676SJeff Bonwick * Decide how to write a block: checksum, compression, number of copies, etc. 39444cd46caSbillm */ 395b24ab676SJeff Bonwick #define WP_NOFILL 0x1 396b24ab676SJeff Bonwick #define WP_DMU_SYNC 0x2 3970a586ceaSMark Shellenbaum #define WP_SPILL 0x4 398b24ab676SJeff Bonwick 399b24ab676SJeff Bonwick void dmu_write_policy(objset_t *os, struct dnode *dn, int level, int wp, 400b24ab676SJeff Bonwick struct zio_prop *zp); 401fa9e4066Sahrens /* 402fa9e4066Sahrens * The bonus data is accessed more or less like a regular buffer. 403fa9e4066Sahrens * You must dmu_bonus_hold() to get the buffer, which will give you a 404fa9e4066Sahrens * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus 405fa9e4066Sahrens * data. As with any normal buffer, you must call dmu_buf_read() to 406fa9e4066Sahrens * read db_data, dmu_buf_will_dirty() before modifying it, and the 407fa9e4066Sahrens * object must be held in an assigned transaction before calling 408fa9e4066Sahrens * dmu_buf_will_dirty. You may use dmu_buf_set_user() on the bonus 409fa9e4066Sahrens * buffer as well. You must release your hold with dmu_buf_rele(). 410fa9e4066Sahrens */ 411ea8dc4b6Seschrock int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **); 412fa9e4066Sahrens int dmu_bonus_max(void); 4131934e92fSmaybee int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *); 4140a586ceaSMark Shellenbaum int dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *); 415744947dcSTom Erickson dmu_object_type_t dmu_get_bonustype(dmu_buf_t *); 4160a586ceaSMark Shellenbaum int dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *); 4170a586ceaSMark Shellenbaum 4180a586ceaSMark Shellenbaum /* 4190a586ceaSMark Shellenbaum * Special spill buffer support used by "SA" framework 4200a586ceaSMark Shellenbaum */ 4210a586ceaSMark Shellenbaum 4220a586ceaSMark Shellenbaum int dmu_spill_hold_by_bonus(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp); 4230a586ceaSMark Shellenbaum int dmu_spill_hold_by_dnode(struct dnode *dn, uint32_t flags, 4240a586ceaSMark Shellenbaum void *tag, dmu_buf_t **dbp); 4250a586ceaSMark Shellenbaum int dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp); 426fa9e4066Sahrens 427fa9e4066Sahrens /* 428fa9e4066Sahrens * Obtain the DMU buffer from the specified object which contains the 429fa9e4066Sahrens * specified offset. dmu_buf_hold() puts a "hold" on the buffer, so 430fa9e4066Sahrens * that it will remain in memory. You must release the hold with 431fa9e4066Sahrens * dmu_buf_rele(). You musn't access the dmu_buf_t after releasing your 432fa9e4066Sahrens * hold. You must have a hold on any dmu_buf_t* you pass to the DMU. 433fa9e4066Sahrens * 434fa9e4066Sahrens * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill 435fa9e4066Sahrens * on the returned buffer before reading or writing the buffer's 436fa9e4066Sahrens * db_data. The comments for those routines describe what particular 437fa9e4066Sahrens * operations are valid after calling them. 438fa9e4066Sahrens * 439fa9e4066Sahrens * The object number must be a valid, allocated object number. 440fa9e4066Sahrens */ 441ea8dc4b6Seschrock int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset, 44247cb52daSJeff Bonwick void *tag, dmu_buf_t **, int flags); 443fa9e4066Sahrens void dmu_buf_add_ref(dmu_buf_t *db, void* tag); 444ea8dc4b6Seschrock void dmu_buf_rele(dmu_buf_t *db, void *tag); 445fa9e4066Sahrens uint64_t dmu_buf_refcount(dmu_buf_t *db); 446fa9e4066Sahrens 447fa9e4066Sahrens /* 448fa9e4066Sahrens * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a 449fa9e4066Sahrens * range of an object. A pointer to an array of dmu_buf_t*'s is 450fa9e4066Sahrens * returned (in *dbpp). 451fa9e4066Sahrens * 452fa9e4066Sahrens * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and 453fa9e4066Sahrens * frees the array. The hold on the array of buffers MUST be released 454fa9e4066Sahrens * with dmu_buf_rele_array. You can NOT release the hold on each buffer 455fa9e4066Sahrens * individually with dmu_buf_rele. 456fa9e4066Sahrens */ 45713506d1eSmaybee int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset, 45813506d1eSmaybee uint64_t length, int read, void *tag, int *numbufsp, dmu_buf_t ***dbpp); 459ea8dc4b6Seschrock void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag); 460fa9e4066Sahrens 461fa9e4066Sahrens /* 462fa9e4066Sahrens * Returns NULL on success, or the existing user ptr if it's already 463fa9e4066Sahrens * been set. 464fa9e4066Sahrens * 465fa9e4066Sahrens * user_ptr is for use by the user and can be obtained via dmu_buf_get_user(). 466fa9e4066Sahrens * 467fa9e4066Sahrens * user_data_ptr_ptr should be NULL, or a pointer to a pointer which 468fa9e4066Sahrens * will be set to db->db_data when you are allowed to access it. Note 469fa9e4066Sahrens * that db->db_data (the pointer) can change when you do dmu_buf_read(), 470fa9e4066Sahrens * dmu_buf_tryupgrade(), dmu_buf_will_dirty(), or dmu_buf_will_fill(). 471fa9e4066Sahrens * *user_data_ptr_ptr will be set to the new value when it changes. 472fa9e4066Sahrens * 473fa9e4066Sahrens * If non-NULL, pageout func will be called when this buffer is being 474fa9e4066Sahrens * excised from the cache, so that you can clean up the data structure 475fa9e4066Sahrens * pointed to by user_ptr. 476fa9e4066Sahrens * 477fa9e4066Sahrens * dmu_evict_user() will call the pageout func for all buffers in a 478fa9e4066Sahrens * objset with a given pageout func. 479fa9e4066Sahrens */ 480fa9e4066Sahrens void *dmu_buf_set_user(dmu_buf_t *db, void *user_ptr, void *user_data_ptr_ptr, 481fa9e4066Sahrens dmu_buf_evict_func_t *pageout_func); 482fa9e4066Sahrens /* 483fa9e4066Sahrens * set_user_ie is the same as set_user, but request immediate eviction 484fa9e4066Sahrens * when hold count goes to zero. 485fa9e4066Sahrens */ 486fa9e4066Sahrens void *dmu_buf_set_user_ie(dmu_buf_t *db, void *user_ptr, 487fa9e4066Sahrens void *user_data_ptr_ptr, dmu_buf_evict_func_t *pageout_func); 488fa9e4066Sahrens void *dmu_buf_update_user(dmu_buf_t *db_fake, void *old_user_ptr, 489fa9e4066Sahrens void *user_ptr, void *user_data_ptr_ptr, 490fa9e4066Sahrens dmu_buf_evict_func_t *pageout_func); 491fa9e4066Sahrens void dmu_evict_user(objset_t *os, dmu_buf_evict_func_t *func); 492fa9e4066Sahrens 493fa9e4066Sahrens /* 494fa9e4066Sahrens * Returns the user_ptr set with dmu_buf_set_user(), or NULL if not set. 495fa9e4066Sahrens */ 496fa9e4066Sahrens void *dmu_buf_get_user(dmu_buf_t *db); 497fa9e4066Sahrens 498*80901aeaSGeorge Wilson /* 499*80901aeaSGeorge Wilson * Returns the blkptr associated with this dbuf, or NULL if not set. 500*80901aeaSGeorge Wilson */ 501*80901aeaSGeorge Wilson struct blkptr *dmu_buf_get_blkptr(dmu_buf_t *db); 502*80901aeaSGeorge Wilson 503fa9e4066Sahrens /* 504fa9e4066Sahrens * Indicate that you are going to modify the buffer's data (db_data). 505fa9e4066Sahrens * 506fa9e4066Sahrens * The transaction (tx) must be assigned to a txg (ie. you've called 507fa9e4066Sahrens * dmu_tx_assign()). The buffer's object must be held in the tx 508fa9e4066Sahrens * (ie. you've called dmu_tx_hold_object(tx, db->db_object)). 509fa9e4066Sahrens */ 510fa9e4066Sahrens void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx); 511fa9e4066Sahrens 5123d692628SSanjeev Bagewadi /* 5133d692628SSanjeev Bagewadi * Tells if the given dbuf is freeable. 5143d692628SSanjeev Bagewadi */ 5153d692628SSanjeev Bagewadi boolean_t dmu_buf_freeable(dmu_buf_t *); 5163d692628SSanjeev Bagewadi 517fa9e4066Sahrens /* 518fa9e4066Sahrens * You must create a transaction, then hold the objects which you will 519fa9e4066Sahrens * (or might) modify as part of this transaction. Then you must assign 520fa9e4066Sahrens * the transaction to a transaction group. Once the transaction has 521fa9e4066Sahrens * been assigned, you can modify buffers which belong to held objects as 522fa9e4066Sahrens * part of this transaction. You can't modify buffers before the 523fa9e4066Sahrens * transaction has been assigned; you can't modify buffers which don't 524fa9e4066Sahrens * belong to objects which this transaction holds; you can't hold 525fa9e4066Sahrens * objects once the transaction has been assigned. You may hold an 526fa9e4066Sahrens * object which you are going to free (with dmu_object_free()), but you 527fa9e4066Sahrens * don't have to. 528fa9e4066Sahrens * 529fa9e4066Sahrens * You can abort the transaction before it has been assigned. 530fa9e4066Sahrens * 531fa9e4066Sahrens * Note that you may hold buffers (with dmu_buf_hold) at any time, 532fa9e4066Sahrens * regardless of transaction state. 533fa9e4066Sahrens */ 534fa9e4066Sahrens 535fa9e4066Sahrens #define DMU_NEW_OBJECT (-1ULL) 536fa9e4066Sahrens #define DMU_OBJECT_END (-1ULL) 537fa9e4066Sahrens 538fa9e4066Sahrens dmu_tx_t *dmu_tx_create(objset_t *os); 539fa9e4066Sahrens void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len); 540fa9e4066Sahrens void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off, 541fa9e4066Sahrens uint64_t len); 54214843421SMatthew Ahrens void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name); 543fa9e4066Sahrens void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object); 5440a586ceaSMark Shellenbaum void dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object); 5450a586ceaSMark Shellenbaum void dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow); 5460a586ceaSMark Shellenbaum void dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size); 547fa9e4066Sahrens void dmu_tx_abort(dmu_tx_t *tx); 548fa9e4066Sahrens int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how); 5498a2f1b91Sahrens void dmu_tx_wait(dmu_tx_t *tx); 550fa9e4066Sahrens void dmu_tx_commit(dmu_tx_t *tx); 551fa9e4066Sahrens 552d20e665cSRicardo M. Correia /* 553d20e665cSRicardo M. Correia * To register a commit callback, dmu_tx_callback_register() must be called. 554d20e665cSRicardo M. Correia * 555d20e665cSRicardo M. Correia * dcb_data is a pointer to caller private data that is passed on as a 556d20e665cSRicardo M. Correia * callback parameter. The caller is responsible for properly allocating and 557d20e665cSRicardo M. Correia * freeing it. 558d20e665cSRicardo M. Correia * 559d20e665cSRicardo M. Correia * When registering a callback, the transaction must be already created, but 560d20e665cSRicardo M. Correia * it cannot be committed or aborted. It can be assigned to a txg or not. 561d20e665cSRicardo M. Correia * 562d20e665cSRicardo M. Correia * The callback will be called after the transaction has been safely written 563d20e665cSRicardo M. Correia * to stable storage and will also be called if the dmu_tx is aborted. 564d20e665cSRicardo M. Correia * If there is any error which prevents the transaction from being committed to 565d20e665cSRicardo M. Correia * disk, the callback will be called with a value of error != 0. 566d20e665cSRicardo M. Correia */ 567d20e665cSRicardo M. Correia typedef void dmu_tx_callback_func_t(void *dcb_data, int error); 568d20e665cSRicardo M. Correia 569d20e665cSRicardo M. Correia void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func, 570d20e665cSRicardo M. Correia void *dcb_data); 571d20e665cSRicardo M. Correia 572fa9e4066Sahrens /* 573fa9e4066Sahrens * Free up the data blocks for a defined range of a file. If size is 574ad135b5dSChristopher Siden * -1, the range from offset to end-of-file is freed. 575fa9e4066Sahrens */ 576ea8dc4b6Seschrock int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset, 577fa9e4066Sahrens uint64_t size, dmu_tx_t *tx); 578cdb0ab79Smaybee int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset, 579cdb0ab79Smaybee uint64_t size); 580cdb0ab79Smaybee int dmu_free_object(objset_t *os, uint64_t object); 581fa9e4066Sahrens 582fa9e4066Sahrens /* 583fa9e4066Sahrens * Convenience functions. 584fa9e4066Sahrens * 585fa9e4066Sahrens * Canfail routines will return 0 on success, or an errno if there is a 586fa9e4066Sahrens * nonrecoverable I/O error. 587fa9e4066Sahrens */ 5887bfdf011SNeil Perrin #define DMU_READ_PREFETCH 0 /* prefetch */ 5897bfdf011SNeil Perrin #define DMU_READ_NO_PREFETCH 1 /* don't prefetch */ 590ea8dc4b6Seschrock int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, 5917bfdf011SNeil Perrin void *buf, uint32_t flags); 592fa9e4066Sahrens void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, 593fa9e4066Sahrens const void *buf, dmu_tx_t *tx); 59482c9918fSTim Haley void dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, 59582c9918fSTim Haley dmu_tx_t *tx); 596feb08c6bSbillm int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size); 597feb08c6bSbillm int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size, 598feb08c6bSbillm dmu_tx_t *tx); 59994d1a210STim Haley int dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size, 60094d1a210STim Haley dmu_tx_t *tx); 60144eda4d7Smaybee int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset, 60244eda4d7Smaybee uint64_t size, struct page *pp, dmu_tx_t *tx); 6032fdbea25SAleksandr Guzovskiy struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size); 6042fdbea25SAleksandr Guzovskiy void dmu_return_arcbuf(struct arc_buf *buf); 6052fdbea25SAleksandr Guzovskiy void dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf, 6062fdbea25SAleksandr Guzovskiy dmu_tx_t *tx); 607c242f9a0Schunli zhang - Sun Microsystems - Irvine United States int dmu_xuio_init(struct xuio *uio, int niov); 608c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void dmu_xuio_fini(struct xuio *uio); 609c242f9a0Schunli zhang - Sun Microsystems - Irvine United States int dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off, 610c242f9a0Schunli zhang - Sun Microsystems - Irvine United States size_t n); 611c242f9a0Schunli zhang - Sun Microsystems - Irvine United States int dmu_xuio_cnt(struct xuio *uio); 612c242f9a0Schunli zhang - Sun Microsystems - Irvine United States struct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i); 613c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void dmu_xuio_clear(struct xuio *uio, int i); 614c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void xuio_stat_wbuf_copied(); 615c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void xuio_stat_wbuf_nocopy(); 616fa9e4066Sahrens 617416e0cd8Sek extern int zfs_prefetch_disable; 618416e0cd8Sek 619fa9e4066Sahrens /* 620fa9e4066Sahrens * Asynchronously try to read in the data. 621fa9e4066Sahrens */ 622fa9e4066Sahrens void dmu_prefetch(objset_t *os, uint64_t object, uint64_t offset, 623fa9e4066Sahrens uint64_t len); 624fa9e4066Sahrens 625fa9e4066Sahrens typedef struct dmu_object_info { 626b24ab676SJeff Bonwick /* All sizes are in bytes unless otherwise indicated. */ 627fa9e4066Sahrens uint32_t doi_data_block_size; 628fa9e4066Sahrens uint32_t doi_metadata_block_size; 629fa9e4066Sahrens dmu_object_type_t doi_type; 630fa9e4066Sahrens dmu_object_type_t doi_bonus_type; 631b24ab676SJeff Bonwick uint64_t doi_bonus_size; 632fa9e4066Sahrens uint8_t doi_indirection; /* 2 = dnode->indirect->data */ 633fa9e4066Sahrens uint8_t doi_checksum; 634fa9e4066Sahrens uint8_t doi_compress; 635fa9e4066Sahrens uint8_t doi_pad[5]; 636b24ab676SJeff Bonwick uint64_t doi_physical_blocks_512; /* data + metadata, 512b blks */ 637b24ab676SJeff Bonwick uint64_t doi_max_offset; 638b24ab676SJeff Bonwick uint64_t doi_fill_count; /* number of non-empty blocks */ 639fa9e4066Sahrens } dmu_object_info_t; 640fa9e4066Sahrens 641e45ce728Sahrens typedef void arc_byteswap_func_t(void *buf, size_t size); 642e45ce728Sahrens 643fa9e4066Sahrens typedef struct dmu_object_type_info { 644ad135b5dSChristopher Siden dmu_object_byteswap_t ot_byteswap; 645fa9e4066Sahrens boolean_t ot_metadata; 646fa9e4066Sahrens char *ot_name; 647fa9e4066Sahrens } dmu_object_type_info_t; 648fa9e4066Sahrens 649ad135b5dSChristopher Siden typedef struct dmu_object_byteswap_info { 650ad135b5dSChristopher Siden arc_byteswap_func_t *ob_func; 651ad135b5dSChristopher Siden char *ob_name; 652ad135b5dSChristopher Siden } dmu_object_byteswap_info_t; 653ad135b5dSChristopher Siden 654fa9e4066Sahrens extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES]; 655ad135b5dSChristopher Siden extern const dmu_object_byteswap_info_t dmu_ot_byteswap[DMU_BSWAP_NUMFUNCS]; 656fa9e4066Sahrens 657fa9e4066Sahrens /* 658fa9e4066Sahrens * Get information on a DMU object. 659fa9e4066Sahrens * 660fa9e4066Sahrens * Return 0 on success or ENOENT if object is not allocated. 661fa9e4066Sahrens * 662fa9e4066Sahrens * If doi is NULL, just indicates whether the object exists. 663fa9e4066Sahrens */ 664fa9e4066Sahrens int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi); 665fa9e4066Sahrens void dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi); 666fa9e4066Sahrens void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi); 667fa9e4066Sahrens void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize, 668fa9e4066Sahrens u_longlong_t *nblk512); 669fa9e4066Sahrens 670fa9e4066Sahrens typedef struct dmu_objset_stats { 671a2eea2e1Sahrens uint64_t dds_num_clones; /* number of clones of this */ 672a2eea2e1Sahrens uint64_t dds_creation_txg; 6733cb34c60Sahrens uint64_t dds_guid; 674fa9e4066Sahrens dmu_objset_type_t dds_type; 675fa9e4066Sahrens uint8_t dds_is_snapshot; 67631fd60d3Sahrens uint8_t dds_inconsistent; 6773cb34c60Sahrens char dds_origin[MAXNAMELEN]; 678a2eea2e1Sahrens } dmu_objset_stats_t; 679fa9e4066Sahrens 680a2eea2e1Sahrens /* 681a2eea2e1Sahrens * Get stats on a dataset. 682a2eea2e1Sahrens */ 683a2eea2e1Sahrens void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat); 684fa9e4066Sahrens 685a2eea2e1Sahrens /* 686a2eea2e1Sahrens * Add entries to the nvlist for all the objset's properties. See 687a2eea2e1Sahrens * zfs_prop_table[] and zfs(1m) for details on the properties. 688a2eea2e1Sahrens */ 689a2eea2e1Sahrens void dmu_objset_stats(objset_t *os, struct nvlist *nv); 690fa9e4066Sahrens 691a2eea2e1Sahrens /* 692a2eea2e1Sahrens * Get the space usage statistics for statvfs(). 693a2eea2e1Sahrens * 694a2eea2e1Sahrens * refdbytes is the amount of space "referenced" by this objset. 695a2eea2e1Sahrens * availbytes is the amount of space available to this objset, taking 696a2eea2e1Sahrens * into account quotas & reservations, assuming that no other objsets 697a2eea2e1Sahrens * use the space first. These values correspond to the 'referenced' and 698a2eea2e1Sahrens * 'available' properties, described in the zfs(1m) manpage. 699a2eea2e1Sahrens * 700a2eea2e1Sahrens * usedobjs and availobjs are the number of objects currently allocated, 701a2eea2e1Sahrens * and available. 702a2eea2e1Sahrens */ 703a2eea2e1Sahrens void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp, 704a2eea2e1Sahrens uint64_t *usedobjsp, uint64_t *availobjsp); 705fa9e4066Sahrens 706fa9e4066Sahrens /* 707a2eea2e1Sahrens * The fsid_guid is a 56-bit ID that can change to avoid collisions. 708a2eea2e1Sahrens * (Contrast with the ds_guid which is a 64-bit ID that will never 709a2eea2e1Sahrens * change, so there is a small probability that it will collide.) 710fa9e4066Sahrens */ 711a2eea2e1Sahrens uint64_t dmu_objset_fsid_guid(objset_t *os); 712fa9e4066Sahrens 71371eb0538SChris Kirby /* 71471eb0538SChris Kirby * Get the [cm]time for an objset's snapshot dir 71571eb0538SChris Kirby */ 71671eb0538SChris Kirby timestruc_t dmu_objset_snap_cmtime(objset_t *os); 71771eb0538SChris Kirby 718fa9e4066Sahrens int dmu_objset_is_snapshot(objset_t *os); 719fa9e4066Sahrens 720fa9e4066Sahrens extern struct spa *dmu_objset_spa(objset_t *os); 721fa9e4066Sahrens extern struct zilog *dmu_objset_zil(objset_t *os); 722fa9e4066Sahrens extern struct dsl_pool *dmu_objset_pool(objset_t *os); 723fa9e4066Sahrens extern struct dsl_dataset *dmu_objset_ds(objset_t *os); 724fa9e4066Sahrens extern void dmu_objset_name(objset_t *os, char *buf); 725fa9e4066Sahrens extern dmu_objset_type_t dmu_objset_type(objset_t *os); 726fa9e4066Sahrens extern uint64_t dmu_objset_id(objset_t *os); 72755da60b9SMark J Musante extern uint64_t dmu_objset_syncprop(objset_t *os); 728e09fa4daSNeil Perrin extern uint64_t dmu_objset_logbias(objset_t *os); 729fa9e4066Sahrens extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name, 730b38f0970Sck uint64_t *id, uint64_t *offp, boolean_t *case_conflict); 731ab04eb8eStimh extern int dmu_snapshot_realname(objset_t *os, char *name, char *real, 732ab04eb8eStimh int maxlen, boolean_t *conflict); 73387e5029aSahrens extern int dmu_dir_list_next(objset_t *os, int namelen, char *name, 73487e5029aSahrens uint64_t *idp, uint64_t *offp); 73514843421SMatthew Ahrens 7369966ca11SMatthew Ahrens typedef int objset_used_cb_t(dmu_object_type_t bonustype, 7379966ca11SMatthew Ahrens void *bonus, uint64_t *userp, uint64_t *groupp); 73814843421SMatthew Ahrens extern void dmu_objset_register_type(dmu_objset_type_t ost, 73914843421SMatthew Ahrens objset_used_cb_t *cb); 740f18faf3fSek extern void dmu_objset_set_user(objset_t *os, void *user_ptr); 741f18faf3fSek extern void *dmu_objset_get_user(objset_t *os); 742fa9e4066Sahrens 743fa9e4066Sahrens /* 744fa9e4066Sahrens * Return the txg number for the given assigned transaction. 745fa9e4066Sahrens */ 74687e5029aSahrens uint64_t dmu_tx_get_txg(dmu_tx_t *tx); 747fa9e4066Sahrens 748fa9e4066Sahrens /* 749fa9e4066Sahrens * Synchronous write. 750c5c6ffa0Smaybee * If a parent zio is provided this function initiates a write on the 751c5c6ffa0Smaybee * provided buffer as a child of the parent zio. 752da6c28aaSamw * In the absence of a parent zio, the write is completed synchronously. 753c5c6ffa0Smaybee * At write completion, blk is filled with the bp of the written block. 754fa9e4066Sahrens * Note that while the data covered by this function will be on stable 755c5c6ffa0Smaybee * storage when the write completes this new data does not become a 756fa9e4066Sahrens * permanent part of the file until the associated transaction commits. 757fa9e4066Sahrens */ 758b24ab676SJeff Bonwick 759b24ab676SJeff Bonwick /* 760b24ab676SJeff Bonwick * {zfs,zvol,ztest}_get_done() args 761b24ab676SJeff Bonwick */ 762b24ab676SJeff Bonwick typedef struct zgd { 763b24ab676SJeff Bonwick struct zilog *zgd_zilog; 764b24ab676SJeff Bonwick struct blkptr *zgd_bp; 765b24ab676SJeff Bonwick dmu_buf_t *zgd_db; 766b24ab676SJeff Bonwick struct rl *zgd_rl; 767b24ab676SJeff Bonwick void *zgd_private; 768b24ab676SJeff Bonwick } zgd_t; 769b24ab676SJeff Bonwick 770b24ab676SJeff Bonwick typedef void dmu_sync_cb_t(zgd_t *arg, int error); 771b24ab676SJeff Bonwick int dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd); 772fa9e4066Sahrens 773fa9e4066Sahrens /* 774fa9e4066Sahrens * Find the next hole or data block in file starting at *off 775fa9e4066Sahrens * Return found offset in *off. Return ESRCH for end of file. 776fa9e4066Sahrens */ 777fa9e4066Sahrens int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole, 778fa9e4066Sahrens uint64_t *off); 779fa9e4066Sahrens 780fa9e4066Sahrens /* 781fa9e4066Sahrens * Initial setup and final teardown. 782fa9e4066Sahrens */ 783fa9e4066Sahrens extern void dmu_init(void); 784fa9e4066Sahrens extern void dmu_fini(void); 785fa9e4066Sahrens 786fa9e4066Sahrens typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp, 787fa9e4066Sahrens uint64_t object, uint64_t offset, int len); 788fa9e4066Sahrens void dmu_traverse_objset(objset_t *os, uint64_t txg_start, 789fa9e4066Sahrens dmu_traverse_cb_t cb, void *arg); 790fa9e4066Sahrens 7914445fffbSMatthew Ahrens int dmu_send(objset_t *tosnap, objset_t *fromsnap, 7924e3c9f44SBill Pijewski int outfd, struct vnode *vp, offset_t *off); 7934445fffbSMatthew Ahrens int dmu_send_estimate(objset_t *tosnap, objset_t *fromsnap, uint64_t *sizep); 7943cb34c60Sahrens 7953cb34c60Sahrens typedef struct dmu_recv_cookie { 7963cb34c60Sahrens /* 7973cb34c60Sahrens * This structure is opaque! 7983cb34c60Sahrens * 7993cb34c60Sahrens * If logical and real are different, we are recving the stream 8003cb34c60Sahrens * into the "real" temporary clone, and then switching it with 8013cb34c60Sahrens * the "logical" target. 8023cb34c60Sahrens */ 8033cb34c60Sahrens struct dsl_dataset *drc_logical_ds; 8043cb34c60Sahrens struct dsl_dataset *drc_real_ds; 8053cb34c60Sahrens struct drr_begin *drc_drrb; 8063cb34c60Sahrens char *drc_tosnap; 8079e69d7d0SLori Alt char *drc_top_ds; 8083cb34c60Sahrens boolean_t drc_newfs; 8093cb34c60Sahrens boolean_t drc_force; 810ec5cf9d5SAlexander Stetsenko struct avl_tree *drc_guid_to_ds_map; 8113cb34c60Sahrens } dmu_recv_cookie_t; 8123cb34c60Sahrens 8139e69d7d0SLori Alt int dmu_recv_begin(char *tofs, char *tosnap, char *topds, struct drr_begin *, 814f4b94bdeSMatthew Ahrens boolean_t force, objset_t *origin, dmu_recv_cookie_t *); 815c99e4bdcSChris Kirby int dmu_recv_stream(dmu_recv_cookie_t *drc, struct vnode *vp, offset_t *voffp, 816c99e4bdcSChris Kirby int cleanup_fd, uint64_t *action_handlep); 8173cb34c60Sahrens int dmu_recv_end(dmu_recv_cookie_t *drc); 818fa9e4066Sahrens 81999d5e173STim Haley int dmu_diff(objset_t *tosnap, objset_t *fromsnap, struct vnode *vp, 82099d5e173STim Haley offset_t *off); 82199d5e173STim Haley 822fa9e4066Sahrens /* CRC64 table */ 823fa9e4066Sahrens #define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */ 824fa9e4066Sahrens extern uint64_t zfs_crc64_table[256]; 825fa9e4066Sahrens 826fa9e4066Sahrens #ifdef __cplusplus 827fa9e4066Sahrens } 828fa9e4066Sahrens #endif 829fa9e4066Sahrens 830fa9e4066Sahrens #endif /* _SYS_DMU_H */ 831