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 */ 21*ad135b5dSChristopher Siden 22fa9e4066Sahrens /* 2394d1a210STim Haley * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24*ad135b5dSChristopher 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> 47fa9e4066Sahrens 48fa9e4066Sahrens #ifdef __cplusplus 49fa9e4066Sahrens extern "C" { 50fa9e4066Sahrens #endif 51fa9e4066Sahrens 52fa9e4066Sahrens struct uio; 53c242f9a0Schunli zhang - Sun Microsystems - Irvine United States struct xuio; 5444eda4d7Smaybee struct page; 55fa9e4066Sahrens struct vnode; 56fa9e4066Sahrens struct spa; 57fa9e4066Sahrens struct zilog; 58fa9e4066Sahrens struct zio; 59fa9e4066Sahrens struct blkptr; 60fa9e4066Sahrens struct zap_cursor; 61fa9e4066Sahrens struct dsl_dataset; 62fa9e4066Sahrens struct dsl_pool; 63fa9e4066Sahrens struct dnode; 64fa9e4066Sahrens struct drr_begin; 65fa9e4066Sahrens struct drr_end; 6644cd46caSbillm struct zbookmark; 6744cd46caSbillm struct spa; 68a2eea2e1Sahrens struct nvlist; 692fdbea25SAleksandr Guzovskiy struct arc_buf; 70b24ab676SJeff Bonwick struct zio_prop; 710a586ceaSMark Shellenbaum struct sa_handle; 72fa9e4066Sahrens 73fa9e4066Sahrens typedef struct objset objset_t; 74fa9e4066Sahrens typedef struct dmu_tx dmu_tx_t; 75fa9e4066Sahrens typedef struct dsl_dir dsl_dir_t; 76fa9e4066Sahrens 77*ad135b5dSChristopher Siden typedef enum dmu_object_byteswap { 78*ad135b5dSChristopher Siden DMU_BSWAP_UINT8, 79*ad135b5dSChristopher Siden DMU_BSWAP_UINT16, 80*ad135b5dSChristopher Siden DMU_BSWAP_UINT32, 81*ad135b5dSChristopher Siden DMU_BSWAP_UINT64, 82*ad135b5dSChristopher Siden DMU_BSWAP_ZAP, 83*ad135b5dSChristopher Siden DMU_BSWAP_DNODE, 84*ad135b5dSChristopher Siden DMU_BSWAP_OBJSET, 85*ad135b5dSChristopher Siden DMU_BSWAP_ZNODE, 86*ad135b5dSChristopher Siden DMU_BSWAP_OLDACL, 87*ad135b5dSChristopher Siden DMU_BSWAP_ACL, 88*ad135b5dSChristopher Siden /* 89*ad135b5dSChristopher Siden * Allocating a new byteswap type number makes the on-disk format 90*ad135b5dSChristopher Siden * incompatible with any other format that uses the same number. 91*ad135b5dSChristopher Siden * 92*ad135b5dSChristopher Siden * Data can usually be structured to work with one of the 93*ad135b5dSChristopher Siden * DMU_BSWAP_UINT* or DMU_BSWAP_ZAP types. 94*ad135b5dSChristopher Siden */ 95*ad135b5dSChristopher Siden DMU_BSWAP_NUMFUNCS 96*ad135b5dSChristopher Siden } dmu_object_byteswap_t; 97*ad135b5dSChristopher Siden 98*ad135b5dSChristopher Siden #define DMU_OT_NEWTYPE 0x80 99*ad135b5dSChristopher Siden #define DMU_OT_METADATA 0x40 100*ad135b5dSChristopher Siden #define DMU_OT_BYTESWAP_MASK 0x3f 101*ad135b5dSChristopher Siden 102*ad135b5dSChristopher Siden /* 103*ad135b5dSChristopher Siden * Defines a uint8_t object type. Object types specify if the data 104*ad135b5dSChristopher Siden * in the object is metadata (boolean) and how to byteswap the data 105*ad135b5dSChristopher Siden * (dmu_object_byteswap_t). 106*ad135b5dSChristopher Siden */ 107*ad135b5dSChristopher Siden #define DMU_OT(byteswap, metadata) \ 108*ad135b5dSChristopher Siden (DMU_OT_NEWTYPE | \ 109*ad135b5dSChristopher Siden ((metadata) ? DMU_OT_METADATA : 0) | \ 110*ad135b5dSChristopher Siden ((byteswap) & DMU_OT_BYTESWAP_MASK)) 111*ad135b5dSChristopher Siden 112*ad135b5dSChristopher Siden #define DMU_OT_IS_VALID(ot) (((ot) & DMU_OT_NEWTYPE) ? \ 113*ad135b5dSChristopher Siden ((ot) & DMU_OT_BYTESWAP_MASK) < DMU_BSWAP_NUMFUNCS : \ 114*ad135b5dSChristopher Siden (ot) < DMU_OT_NUMTYPES) 115*ad135b5dSChristopher Siden 116*ad135b5dSChristopher Siden #define DMU_OT_IS_METADATA(ot) (((ot) & DMU_OT_NEWTYPE) ? \ 117*ad135b5dSChristopher Siden ((ot) & DMU_OT_METADATA) : \ 118*ad135b5dSChristopher Siden dmu_ot[(ot)].ot_metadata) 119*ad135b5dSChristopher Siden 120*ad135b5dSChristopher Siden #define DMU_OT_BYTESWAP(ot) (((ot) & DMU_OT_NEWTYPE) ? \ 121*ad135b5dSChristopher Siden ((ot) & DMU_OT_BYTESWAP_MASK) : \ 122*ad135b5dSChristopher Siden dmu_ot[(ot)].ot_byteswap) 123*ad135b5dSChristopher Siden 124fa9e4066Sahrens typedef enum dmu_object_type { 125fa9e4066Sahrens DMU_OT_NONE, 126fa9e4066Sahrens /* general: */ 127fa9e4066Sahrens DMU_OT_OBJECT_DIRECTORY, /* ZAP */ 128fa9e4066Sahrens DMU_OT_OBJECT_ARRAY, /* UINT64 */ 129fa9e4066Sahrens DMU_OT_PACKED_NVLIST, /* UINT8 (XDR by nvlist_pack/unpack) */ 130fa9e4066Sahrens DMU_OT_PACKED_NVLIST_SIZE, /* UINT64 */ 131cde58dbcSMatthew Ahrens DMU_OT_BPOBJ, /* UINT64 */ 132cde58dbcSMatthew Ahrens DMU_OT_BPOBJ_HDR, /* UINT64 */ 133fa9e4066Sahrens /* spa: */ 134fa9e4066Sahrens DMU_OT_SPACE_MAP_HEADER, /* UINT64 */ 135fa9e4066Sahrens DMU_OT_SPACE_MAP, /* UINT64 */ 136fa9e4066Sahrens /* zil: */ 137fa9e4066Sahrens DMU_OT_INTENT_LOG, /* UINT64 */ 138fa9e4066Sahrens /* dmu: */ 139fa9e4066Sahrens DMU_OT_DNODE, /* DNODE */ 140fa9e4066Sahrens DMU_OT_OBJSET, /* OBJSET */ 141fa9e4066Sahrens /* dsl: */ 1421649cd4bStabriz DMU_OT_DSL_DIR, /* UINT64 */ 14387e5029aSahrens DMU_OT_DSL_DIR_CHILD_MAP, /* ZAP */ 14487e5029aSahrens DMU_OT_DSL_DS_SNAP_MAP, /* ZAP */ 145fa9e4066Sahrens DMU_OT_DSL_PROPS, /* ZAP */ 1461649cd4bStabriz DMU_OT_DSL_DATASET, /* UINT64 */ 147fa9e4066Sahrens /* zpl: */ 148fa9e4066Sahrens DMU_OT_ZNODE, /* ZNODE */ 149da6c28aaSamw DMU_OT_OLDACL, /* Old ACL */ 150fa9e4066Sahrens DMU_OT_PLAIN_FILE_CONTENTS, /* UINT8 */ 151fa9e4066Sahrens DMU_OT_DIRECTORY_CONTENTS, /* ZAP */ 152fa9e4066Sahrens DMU_OT_MASTER_NODE, /* ZAP */ 153893a6d32Sahrens DMU_OT_UNLINKED_SET, /* ZAP */ 154fa9e4066Sahrens /* zvol: */ 155fa9e4066Sahrens DMU_OT_ZVOL, /* UINT8 */ 156fa9e4066Sahrens DMU_OT_ZVOL_PROP, /* ZAP */ 157fa9e4066Sahrens /* other; for testing only! */ 158fa9e4066Sahrens DMU_OT_PLAIN_OTHER, /* UINT8 */ 159fa9e4066Sahrens DMU_OT_UINT64_OTHER, /* UINT64 */ 160fa9e4066Sahrens DMU_OT_ZAP_OTHER, /* ZAP */ 161ea8dc4b6Seschrock /* new object types: */ 162ea8dc4b6Seschrock DMU_OT_ERROR_LOG, /* ZAP */ 16306eeb2adSek DMU_OT_SPA_HISTORY, /* UINT8 */ 16406eeb2adSek DMU_OT_SPA_HISTORY_OFFSETS, /* spa_his_phys_t */ 165b1b8ab34Slling DMU_OT_POOL_PROPS, /* ZAP */ 166ecd6cf80Smarks DMU_OT_DSL_PERMS, /* ZAP */ 167da6c28aaSamw DMU_OT_ACL, /* ACL */ 168da6c28aaSamw DMU_OT_SYSACL, /* SYSACL */ 169da6c28aaSamw DMU_OT_FUID, /* FUID table (Packed NVLIST UINT8) */ 170da6c28aaSamw DMU_OT_FUID_SIZE, /* FUID table size UINT64 */ 171088f3894Sahrens DMU_OT_NEXT_CLONES, /* ZAP */ 1723f9d6ad7SLin Ling DMU_OT_SCAN_QUEUE, /* ZAP */ 17314843421SMatthew Ahrens DMU_OT_USERGROUP_USED, /* ZAP */ 17414843421SMatthew Ahrens DMU_OT_USERGROUP_QUOTA, /* ZAP */ 175842727c2SChris Kirby DMU_OT_USERREFS, /* ZAP */ 176b24ab676SJeff Bonwick DMU_OT_DDT_ZAP, /* ZAP */ 177b24ab676SJeff Bonwick DMU_OT_DDT_STATS, /* ZAP */ 1780a586ceaSMark Shellenbaum DMU_OT_SA, /* System attr */ 1790a586ceaSMark Shellenbaum DMU_OT_SA_MASTER_NODE, /* ZAP */ 1800a586ceaSMark Shellenbaum DMU_OT_SA_ATTR_REGISTRATION, /* ZAP */ 1810a586ceaSMark Shellenbaum DMU_OT_SA_ATTR_LAYOUTS, /* ZAP */ 1823f9d6ad7SLin Ling DMU_OT_SCAN_XLATE, /* ZAP */ 1833f9d6ad7SLin Ling DMU_OT_DEDUP, /* fake dedup BP from ddt_bp_create() */ 184cde58dbcSMatthew Ahrens DMU_OT_DEADLIST, /* ZAP */ 185cde58dbcSMatthew Ahrens DMU_OT_DEADLIST_HDR, /* UINT64 */ 186cde58dbcSMatthew Ahrens DMU_OT_DSL_CLONES, /* ZAP */ 187cde58dbcSMatthew Ahrens DMU_OT_BPOBJ_SUBOBJ, /* UINT64 */ 188*ad135b5dSChristopher Siden /* 189*ad135b5dSChristopher Siden * Do not allocate new object types here. Doing so makes the on-disk 190*ad135b5dSChristopher Siden * format incompatible with any other format that uses the same object 191*ad135b5dSChristopher Siden * type number. 192*ad135b5dSChristopher Siden * 193*ad135b5dSChristopher Siden * When creating an object which does not have one of the above types 194*ad135b5dSChristopher Siden * use the DMU_OTN_* type with the correct byteswap and metadata 195*ad135b5dSChristopher Siden * values. 196*ad135b5dSChristopher Siden * 197*ad135b5dSChristopher Siden * The DMU_OTN_* types do not have entries in the dmu_ot table, 198*ad135b5dSChristopher Siden * use the DMU_OT_IS_METDATA() and DMU_OT_BYTESWAP() macros instead 199*ad135b5dSChristopher Siden * of indexing into dmu_ot directly (this works for both DMU_OT_* types 200*ad135b5dSChristopher Siden * and DMU_OTN_* types). 201*ad135b5dSChristopher Siden */ 202*ad135b5dSChristopher Siden DMU_OT_NUMTYPES, 203*ad135b5dSChristopher Siden 204*ad135b5dSChristopher Siden /* 205*ad135b5dSChristopher Siden * Names for valid types declared with DMU_OT(). 206*ad135b5dSChristopher Siden */ 207*ad135b5dSChristopher Siden DMU_OTN_UINT8_DATA = DMU_OT(DMU_BSWAP_UINT8, B_FALSE), 208*ad135b5dSChristopher Siden DMU_OTN_UINT8_METADATA = DMU_OT(DMU_BSWAP_UINT8, B_TRUE), 209*ad135b5dSChristopher Siden DMU_OTN_UINT16_DATA = DMU_OT(DMU_BSWAP_UINT16, B_FALSE), 210*ad135b5dSChristopher Siden DMU_OTN_UINT16_METADATA = DMU_OT(DMU_BSWAP_UINT16, B_TRUE), 211*ad135b5dSChristopher Siden DMU_OTN_UINT32_DATA = DMU_OT(DMU_BSWAP_UINT32, B_FALSE), 212*ad135b5dSChristopher Siden DMU_OTN_UINT32_METADATA = DMU_OT(DMU_BSWAP_UINT32, B_TRUE), 213*ad135b5dSChristopher Siden DMU_OTN_UINT64_DATA = DMU_OT(DMU_BSWAP_UINT64, B_FALSE), 214*ad135b5dSChristopher Siden DMU_OTN_UINT64_METADATA = DMU_OT(DMU_BSWAP_UINT64, B_TRUE), 215*ad135b5dSChristopher Siden DMU_OTN_ZAP_DATA = DMU_OT(DMU_BSWAP_ZAP, B_FALSE), 216*ad135b5dSChristopher Siden DMU_OTN_ZAP_METADATA = DMU_OT(DMU_BSWAP_ZAP, B_TRUE), 217fa9e4066Sahrens } dmu_object_type_t; 218fa9e4066Sahrens 219fa9e4066Sahrens typedef enum dmu_objset_type { 220fa9e4066Sahrens DMU_OST_NONE, 221fa9e4066Sahrens DMU_OST_META, 222fa9e4066Sahrens DMU_OST_ZFS, 223fa9e4066Sahrens DMU_OST_ZVOL, 224fa9e4066Sahrens DMU_OST_OTHER, /* For testing only! */ 225fa9e4066Sahrens DMU_OST_ANY, /* Be careful! */ 226fa9e4066Sahrens DMU_OST_NUMTYPES 227fa9e4066Sahrens } dmu_objset_type_t; 228fa9e4066Sahrens 229fa9e4066Sahrens void byteswap_uint64_array(void *buf, size_t size); 230fa9e4066Sahrens void byteswap_uint32_array(void *buf, size_t size); 231fa9e4066Sahrens void byteswap_uint16_array(void *buf, size_t size); 232fa9e4066Sahrens void byteswap_uint8_array(void *buf, size_t size); 233fa9e4066Sahrens void zap_byteswap(void *buf, size_t size); 234da6c28aaSamw void zfs_oldacl_byteswap(void *buf, size_t size); 235fa9e4066Sahrens void zfs_acl_byteswap(void *buf, size_t size); 236fa9e4066Sahrens void zfs_znode_byteswap(void *buf, size_t size); 237fa9e4066Sahrens 2380b69c2f0Sahrens #define DS_FIND_SNAPSHOTS (1<<0) 2390b69c2f0Sahrens #define DS_FIND_CHILDREN (1<<1) 240fa9e4066Sahrens 241fa9e4066Sahrens /* 242fa9e4066Sahrens * The maximum number of bytes that can be accessed as part of one 243fa9e4066Sahrens * operation, including metadata. 244fa9e4066Sahrens */ 245fa9e4066Sahrens #define DMU_MAX_ACCESS (10<<20) /* 10MB */ 246cdb0ab79Smaybee #define DMU_MAX_DELETEBLKCNT (20480) /* ~5MB of indirect blocks */ 247fa9e4066Sahrens 24814843421SMatthew Ahrens #define DMU_USERUSED_OBJECT (-1ULL) 24914843421SMatthew Ahrens #define DMU_GROUPUSED_OBJECT (-2ULL) 250b24ab676SJeff Bonwick #define DMU_DEADLIST_OBJECT (-3ULL) 25114843421SMatthew Ahrens 2520a586ceaSMark Shellenbaum /* 2530a586ceaSMark Shellenbaum * artificial blkids for bonus buffer and spill blocks 2540a586ceaSMark Shellenbaum */ 2550a586ceaSMark Shellenbaum #define DMU_BONUS_BLKID (-1ULL) 2560a586ceaSMark Shellenbaum #define DMU_SPILL_BLKID (-2ULL) 257fa9e4066Sahrens /* 258fa9e4066Sahrens * Public routines to create, destroy, open, and close objsets. 259fa9e4066Sahrens */ 260503ad85cSMatthew Ahrens int dmu_objset_hold(const char *name, void *tag, objset_t **osp); 261503ad85cSMatthew Ahrens int dmu_objset_own(const char *name, dmu_objset_type_t type, 262503ad85cSMatthew Ahrens boolean_t readonly, void *tag, objset_t **osp); 263503ad85cSMatthew Ahrens void dmu_objset_rele(objset_t *os, void *tag); 264503ad85cSMatthew Ahrens void dmu_objset_disown(objset_t *os, void *tag); 265503ad85cSMatthew Ahrens int dmu_objset_open_ds(struct dsl_dataset *ds, objset_t **osp); 266503ad85cSMatthew Ahrens 2671934e92fSmaybee int dmu_objset_evict_dbufs(objset_t *os); 268ae46e4c7SMatthew Ahrens int dmu_objset_create(const char *name, dmu_objset_type_t type, uint64_t flags, 269ecd6cf80Smarks void (*func)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx), void *arg); 270ae46e4c7SMatthew Ahrens int dmu_objset_clone(const char *name, struct dsl_dataset *clone_origin, 271ae46e4c7SMatthew Ahrens uint64_t flags); 272842727c2SChris Kirby int dmu_objset_destroy(const char *name, boolean_t defer); 27319b94df9SMatthew Ahrens int dmu_snapshots_destroy_nvl(struct nvlist *snaps, boolean_t defer, char *); 27499d5e173STim Haley int dmu_objset_snapshot(char *fsname, char *snapname, char *tag, 27599d5e173STim Haley struct nvlist *props, boolean_t recursive, boolean_t temporary, int fd); 276cdf5b4caSmmusante int dmu_objset_rename(const char *name, const char *newname, 277cdf5b4caSmmusante boolean_t recursive); 278fd136879SMatthew Ahrens int dmu_objset_find(char *name, int func(const char *, void *), void *arg, 279fa9e4066Sahrens int flags); 280fa9e4066Sahrens void dmu_objset_byteswap(void *buf, size_t size); 281fa9e4066Sahrens 282fa9e4066Sahrens typedef struct dmu_buf { 283fa9e4066Sahrens uint64_t db_object; /* object that this buffer is part of */ 284fa9e4066Sahrens uint64_t db_offset; /* byte offset in this object */ 285fa9e4066Sahrens uint64_t db_size; /* size of buffer in bytes */ 286fa9e4066Sahrens void *db_data; /* data in buffer */ 287fa9e4066Sahrens } dmu_buf_t; 288fa9e4066Sahrens 289fa9e4066Sahrens typedef void dmu_buf_evict_func_t(struct dmu_buf *db, void *user_ptr); 290fa9e4066Sahrens 29199653d4eSeschrock /* 29299653d4eSeschrock * The names of zap entries in the DIRECTORY_OBJECT of the MOS. 29399653d4eSeschrock */ 294fa9e4066Sahrens #define DMU_POOL_DIRECTORY_OBJECT 1 295fa9e4066Sahrens #define DMU_POOL_CONFIG "config" 296*ad135b5dSChristopher Siden #define DMU_POOL_FEATURES_FOR_WRITE "features_for_write" 297*ad135b5dSChristopher Siden #define DMU_POOL_FEATURES_FOR_READ "features_for_read" 298*ad135b5dSChristopher Siden #define DMU_POOL_FEATURE_DESCRIPTIONS "feature_descriptions" 299fa9e4066Sahrens #define DMU_POOL_ROOT_DATASET "root_dataset" 300cde58dbcSMatthew Ahrens #define DMU_POOL_SYNC_BPOBJ "sync_bplist" 301ea8dc4b6Seschrock #define DMU_POOL_ERRLOG_SCRUB "errlog_scrub" 302ea8dc4b6Seschrock #define DMU_POOL_ERRLOG_LAST "errlog_last" 30399653d4eSeschrock #define DMU_POOL_SPARES "spares" 30499653d4eSeschrock #define DMU_POOL_DEFLATE "deflate" 30506eeb2adSek #define DMU_POOL_HISTORY "history" 306b1b8ab34Slling #define DMU_POOL_PROPS "pool_props" 307fa94a07fSbrendan #define DMU_POOL_L2CACHE "l2cache" 308ca45db41SChris Kirby #define DMU_POOL_TMP_USERREFS "tmp_userrefs" 309b24ab676SJeff Bonwick #define DMU_POOL_DDT "DDT-%s-%s-%s" 310b24ab676SJeff Bonwick #define DMU_POOL_DDT_STATS "DDT-statistics" 3113f9d6ad7SLin Ling #define DMU_POOL_CREATION_VERSION "creation_version" 3123f9d6ad7SLin Ling #define DMU_POOL_SCAN "scan" 313cde58dbcSMatthew Ahrens #define DMU_POOL_FREE_BPOBJ "free_bpobj" 314*ad135b5dSChristopher Siden #define DMU_POOL_BPTREE_OBJ "bptree_obj" 315088f3894Sahrens 316fa9e4066Sahrens /* 317fa9e4066Sahrens * Allocate an object from this objset. The range of object numbers 318fa9e4066Sahrens * available is (0, DN_MAX_OBJECT). Object 0 is the meta-dnode. 319fa9e4066Sahrens * 320fa9e4066Sahrens * The transaction must be assigned to a txg. The newly allocated 321fa9e4066Sahrens * object will be "held" in the transaction (ie. you can modify the 322fa9e4066Sahrens * newly allocated object in this transaction). 323fa9e4066Sahrens * 324fa9e4066Sahrens * dmu_object_alloc() chooses an object and returns it in *objectp. 325fa9e4066Sahrens * 326fa9e4066Sahrens * dmu_object_claim() allocates a specific object number. If that 327fa9e4066Sahrens * number is already allocated, it fails and returns EEXIST. 328fa9e4066Sahrens * 329fa9e4066Sahrens * Return 0 on success, or ENOSPC or EEXIST as specified above. 330fa9e4066Sahrens */ 331fa9e4066Sahrens uint64_t dmu_object_alloc(objset_t *os, dmu_object_type_t ot, 332fa9e4066Sahrens int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx); 333fa9e4066Sahrens int dmu_object_claim(objset_t *os, uint64_t object, dmu_object_type_t ot, 334fa9e4066Sahrens int blocksize, dmu_object_type_t bonus_type, int bonus_len, dmu_tx_t *tx); 335fa9e4066Sahrens int dmu_object_reclaim(objset_t *os, uint64_t object, dmu_object_type_t ot, 3362bf405a2SMark Maybee int blocksize, dmu_object_type_t bonustype, int bonuslen); 337fa9e4066Sahrens 338fa9e4066Sahrens /* 339fa9e4066Sahrens * Free an object from this objset. 340fa9e4066Sahrens * 341fa9e4066Sahrens * The object's data will be freed as well (ie. you don't need to call 342fa9e4066Sahrens * dmu_free(object, 0, -1, tx)). 343fa9e4066Sahrens * 344fa9e4066Sahrens * The object need not be held in the transaction. 345fa9e4066Sahrens * 346fa9e4066Sahrens * If there are any holds on this object's buffers (via dmu_buf_hold()), 347fa9e4066Sahrens * or tx holds on the object (via dmu_tx_hold_object()), you can not 348fa9e4066Sahrens * free it; it fails and returns EBUSY. 349fa9e4066Sahrens * 350fa9e4066Sahrens * If the object is not allocated, it fails and returns ENOENT. 351fa9e4066Sahrens * 352fa9e4066Sahrens * Return 0 on success, or EBUSY or ENOENT as specified above. 353fa9e4066Sahrens */ 354fa9e4066Sahrens int dmu_object_free(objset_t *os, uint64_t object, dmu_tx_t *tx); 355fa9e4066Sahrens 356fa9e4066Sahrens /* 357fa9e4066Sahrens * Find the next allocated or free object. 358fa9e4066Sahrens * 359fa9e4066Sahrens * The objectp parameter is in-out. It will be updated to be the next 3606754306eSahrens * object which is allocated. Ignore objects which have not been 3616754306eSahrens * modified since txg. 362fa9e4066Sahrens * 363fa9e4066Sahrens * XXX Can only be called on a objset with no dirty data. 364fa9e4066Sahrens * 365fa9e4066Sahrens * Returns 0 on success, or ENOENT if there are no more objects. 366fa9e4066Sahrens */ 3676754306eSahrens int dmu_object_next(objset_t *os, uint64_t *objectp, 3686754306eSahrens boolean_t hole, uint64_t txg); 369fa9e4066Sahrens 370fa9e4066Sahrens /* 371fa9e4066Sahrens * Set the data blocksize for an object. 372fa9e4066Sahrens * 373fa9e4066Sahrens * The object cannot have any blocks allcated beyond the first. If 374fa9e4066Sahrens * the first block is allocated already, the new size must be greater 375fa9e4066Sahrens * than the current block size. If these conditions are not met, 376fa9e4066Sahrens * ENOTSUP will be returned. 377fa9e4066Sahrens * 378fa9e4066Sahrens * Returns 0 on success, or EBUSY if there are any holds on the object 379fa9e4066Sahrens * contents, or ENOTSUP as described above. 380fa9e4066Sahrens */ 381fa9e4066Sahrens int dmu_object_set_blocksize(objset_t *os, uint64_t object, uint64_t size, 382fa9e4066Sahrens int ibs, dmu_tx_t *tx); 383fa9e4066Sahrens 384fa9e4066Sahrens /* 385fa9e4066Sahrens * Set the checksum property on a dnode. The new checksum algorithm will 386fa9e4066Sahrens * apply to all newly written blocks; existing blocks will not be affected. 387fa9e4066Sahrens */ 388fa9e4066Sahrens void dmu_object_set_checksum(objset_t *os, uint64_t object, uint8_t checksum, 389fa9e4066Sahrens dmu_tx_t *tx); 390fa9e4066Sahrens 391fa9e4066Sahrens /* 392fa9e4066Sahrens * Set the compress property on a dnode. The new compression algorithm will 393fa9e4066Sahrens * apply to all newly written blocks; existing blocks will not be affected. 394fa9e4066Sahrens */ 395fa9e4066Sahrens void dmu_object_set_compress(objset_t *os, uint64_t object, uint8_t compress, 396fa9e4066Sahrens dmu_tx_t *tx); 397fa9e4066Sahrens 39844cd46caSbillm /* 399b24ab676SJeff Bonwick * Decide how to write a block: checksum, compression, number of copies, etc. 40044cd46caSbillm */ 401b24ab676SJeff Bonwick #define WP_NOFILL 0x1 402b24ab676SJeff Bonwick #define WP_DMU_SYNC 0x2 4030a586ceaSMark Shellenbaum #define WP_SPILL 0x4 404b24ab676SJeff Bonwick 405b24ab676SJeff Bonwick void dmu_write_policy(objset_t *os, struct dnode *dn, int level, int wp, 406b24ab676SJeff Bonwick struct zio_prop *zp); 407fa9e4066Sahrens /* 408fa9e4066Sahrens * The bonus data is accessed more or less like a regular buffer. 409fa9e4066Sahrens * You must dmu_bonus_hold() to get the buffer, which will give you a 410fa9e4066Sahrens * dmu_buf_t with db_offset==-1ULL, and db_size = the size of the bonus 411fa9e4066Sahrens * data. As with any normal buffer, you must call dmu_buf_read() to 412fa9e4066Sahrens * read db_data, dmu_buf_will_dirty() before modifying it, and the 413fa9e4066Sahrens * object must be held in an assigned transaction before calling 414fa9e4066Sahrens * dmu_buf_will_dirty. You may use dmu_buf_set_user() on the bonus 415fa9e4066Sahrens * buffer as well. You must release your hold with dmu_buf_rele(). 416fa9e4066Sahrens */ 417ea8dc4b6Seschrock int dmu_bonus_hold(objset_t *os, uint64_t object, void *tag, dmu_buf_t **); 418fa9e4066Sahrens int dmu_bonus_max(void); 4191934e92fSmaybee int dmu_set_bonus(dmu_buf_t *, int, dmu_tx_t *); 4200a586ceaSMark Shellenbaum int dmu_set_bonustype(dmu_buf_t *, dmu_object_type_t, dmu_tx_t *); 421744947dcSTom Erickson dmu_object_type_t dmu_get_bonustype(dmu_buf_t *); 4220a586ceaSMark Shellenbaum int dmu_rm_spill(objset_t *, uint64_t, dmu_tx_t *); 4230a586ceaSMark Shellenbaum 4240a586ceaSMark Shellenbaum /* 4250a586ceaSMark Shellenbaum * Special spill buffer support used by "SA" framework 4260a586ceaSMark Shellenbaum */ 4270a586ceaSMark Shellenbaum 4280a586ceaSMark Shellenbaum int dmu_spill_hold_by_bonus(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp); 4290a586ceaSMark Shellenbaum int dmu_spill_hold_by_dnode(struct dnode *dn, uint32_t flags, 4300a586ceaSMark Shellenbaum void *tag, dmu_buf_t **dbp); 4310a586ceaSMark Shellenbaum int dmu_spill_hold_existing(dmu_buf_t *bonus, void *tag, dmu_buf_t **dbp); 432fa9e4066Sahrens 433fa9e4066Sahrens /* 434fa9e4066Sahrens * Obtain the DMU buffer from the specified object which contains the 435fa9e4066Sahrens * specified offset. dmu_buf_hold() puts a "hold" on the buffer, so 436fa9e4066Sahrens * that it will remain in memory. You must release the hold with 437fa9e4066Sahrens * dmu_buf_rele(). You musn't access the dmu_buf_t after releasing your 438fa9e4066Sahrens * hold. You must have a hold on any dmu_buf_t* you pass to the DMU. 439fa9e4066Sahrens * 440fa9e4066Sahrens * You must call dmu_buf_read, dmu_buf_will_dirty, or dmu_buf_will_fill 441fa9e4066Sahrens * on the returned buffer before reading or writing the buffer's 442fa9e4066Sahrens * db_data. The comments for those routines describe what particular 443fa9e4066Sahrens * operations are valid after calling them. 444fa9e4066Sahrens * 445fa9e4066Sahrens * The object number must be a valid, allocated object number. 446fa9e4066Sahrens */ 447ea8dc4b6Seschrock int dmu_buf_hold(objset_t *os, uint64_t object, uint64_t offset, 44847cb52daSJeff Bonwick void *tag, dmu_buf_t **, int flags); 449fa9e4066Sahrens void dmu_buf_add_ref(dmu_buf_t *db, void* tag); 450ea8dc4b6Seschrock void dmu_buf_rele(dmu_buf_t *db, void *tag); 451fa9e4066Sahrens uint64_t dmu_buf_refcount(dmu_buf_t *db); 452fa9e4066Sahrens 453fa9e4066Sahrens /* 454fa9e4066Sahrens * dmu_buf_hold_array holds the DMU buffers which contain all bytes in a 455fa9e4066Sahrens * range of an object. A pointer to an array of dmu_buf_t*'s is 456fa9e4066Sahrens * returned (in *dbpp). 457fa9e4066Sahrens * 458fa9e4066Sahrens * dmu_buf_rele_array releases the hold on an array of dmu_buf_t*'s, and 459fa9e4066Sahrens * frees the array. The hold on the array of buffers MUST be released 460fa9e4066Sahrens * with dmu_buf_rele_array. You can NOT release the hold on each buffer 461fa9e4066Sahrens * individually with dmu_buf_rele. 462fa9e4066Sahrens */ 46313506d1eSmaybee int dmu_buf_hold_array_by_bonus(dmu_buf_t *db, uint64_t offset, 46413506d1eSmaybee uint64_t length, int read, void *tag, int *numbufsp, dmu_buf_t ***dbpp); 465ea8dc4b6Seschrock void dmu_buf_rele_array(dmu_buf_t **, int numbufs, void *tag); 466fa9e4066Sahrens 467fa9e4066Sahrens /* 468fa9e4066Sahrens * Returns NULL on success, or the existing user ptr if it's already 469fa9e4066Sahrens * been set. 470fa9e4066Sahrens * 471fa9e4066Sahrens * user_ptr is for use by the user and can be obtained via dmu_buf_get_user(). 472fa9e4066Sahrens * 473fa9e4066Sahrens * user_data_ptr_ptr should be NULL, or a pointer to a pointer which 474fa9e4066Sahrens * will be set to db->db_data when you are allowed to access it. Note 475fa9e4066Sahrens * that db->db_data (the pointer) can change when you do dmu_buf_read(), 476fa9e4066Sahrens * dmu_buf_tryupgrade(), dmu_buf_will_dirty(), or dmu_buf_will_fill(). 477fa9e4066Sahrens * *user_data_ptr_ptr will be set to the new value when it changes. 478fa9e4066Sahrens * 479fa9e4066Sahrens * If non-NULL, pageout func will be called when this buffer is being 480fa9e4066Sahrens * excised from the cache, so that you can clean up the data structure 481fa9e4066Sahrens * pointed to by user_ptr. 482fa9e4066Sahrens * 483fa9e4066Sahrens * dmu_evict_user() will call the pageout func for all buffers in a 484fa9e4066Sahrens * objset with a given pageout func. 485fa9e4066Sahrens */ 486fa9e4066Sahrens void *dmu_buf_set_user(dmu_buf_t *db, void *user_ptr, void *user_data_ptr_ptr, 487fa9e4066Sahrens dmu_buf_evict_func_t *pageout_func); 488fa9e4066Sahrens /* 489fa9e4066Sahrens * set_user_ie is the same as set_user, but request immediate eviction 490fa9e4066Sahrens * when hold count goes to zero. 491fa9e4066Sahrens */ 492fa9e4066Sahrens void *dmu_buf_set_user_ie(dmu_buf_t *db, void *user_ptr, 493fa9e4066Sahrens void *user_data_ptr_ptr, dmu_buf_evict_func_t *pageout_func); 494fa9e4066Sahrens void *dmu_buf_update_user(dmu_buf_t *db_fake, void *old_user_ptr, 495fa9e4066Sahrens void *user_ptr, void *user_data_ptr_ptr, 496fa9e4066Sahrens dmu_buf_evict_func_t *pageout_func); 497fa9e4066Sahrens void dmu_evict_user(objset_t *os, dmu_buf_evict_func_t *func); 498fa9e4066Sahrens 499fa9e4066Sahrens /* 500fa9e4066Sahrens * Returns the user_ptr set with dmu_buf_set_user(), or NULL if not set. 501fa9e4066Sahrens */ 502fa9e4066Sahrens void *dmu_buf_get_user(dmu_buf_t *db); 503fa9e4066Sahrens 504fa9e4066Sahrens /* 505fa9e4066Sahrens * Indicate that you are going to modify the buffer's data (db_data). 506fa9e4066Sahrens * 507fa9e4066Sahrens * The transaction (tx) must be assigned to a txg (ie. you've called 508fa9e4066Sahrens * dmu_tx_assign()). The buffer's object must be held in the tx 509fa9e4066Sahrens * (ie. you've called dmu_tx_hold_object(tx, db->db_object)). 510fa9e4066Sahrens */ 511fa9e4066Sahrens void dmu_buf_will_dirty(dmu_buf_t *db, dmu_tx_t *tx); 512fa9e4066Sahrens 5133d692628SSanjeev Bagewadi /* 5143d692628SSanjeev Bagewadi * Tells if the given dbuf is freeable. 5153d692628SSanjeev Bagewadi */ 5163d692628SSanjeev Bagewadi boolean_t dmu_buf_freeable(dmu_buf_t *); 5173d692628SSanjeev Bagewadi 518fa9e4066Sahrens /* 519fa9e4066Sahrens * You must create a transaction, then hold the objects which you will 520fa9e4066Sahrens * (or might) modify as part of this transaction. Then you must assign 521fa9e4066Sahrens * the transaction to a transaction group. Once the transaction has 522fa9e4066Sahrens * been assigned, you can modify buffers which belong to held objects as 523fa9e4066Sahrens * part of this transaction. You can't modify buffers before the 524fa9e4066Sahrens * transaction has been assigned; you can't modify buffers which don't 525fa9e4066Sahrens * belong to objects which this transaction holds; you can't hold 526fa9e4066Sahrens * objects once the transaction has been assigned. You may hold an 527fa9e4066Sahrens * object which you are going to free (with dmu_object_free()), but you 528fa9e4066Sahrens * don't have to. 529fa9e4066Sahrens * 530fa9e4066Sahrens * You can abort the transaction before it has been assigned. 531fa9e4066Sahrens * 532fa9e4066Sahrens * Note that you may hold buffers (with dmu_buf_hold) at any time, 533fa9e4066Sahrens * regardless of transaction state. 534fa9e4066Sahrens */ 535fa9e4066Sahrens 536fa9e4066Sahrens #define DMU_NEW_OBJECT (-1ULL) 537fa9e4066Sahrens #define DMU_OBJECT_END (-1ULL) 538fa9e4066Sahrens 539fa9e4066Sahrens dmu_tx_t *dmu_tx_create(objset_t *os); 540fa9e4066Sahrens void dmu_tx_hold_write(dmu_tx_t *tx, uint64_t object, uint64_t off, int len); 541fa9e4066Sahrens void dmu_tx_hold_free(dmu_tx_t *tx, uint64_t object, uint64_t off, 542fa9e4066Sahrens uint64_t len); 54314843421SMatthew Ahrens void dmu_tx_hold_zap(dmu_tx_t *tx, uint64_t object, int add, const char *name); 544fa9e4066Sahrens void dmu_tx_hold_bonus(dmu_tx_t *tx, uint64_t object); 5450a586ceaSMark Shellenbaum void dmu_tx_hold_spill(dmu_tx_t *tx, uint64_t object); 5460a586ceaSMark Shellenbaum void dmu_tx_hold_sa(dmu_tx_t *tx, struct sa_handle *hdl, boolean_t may_grow); 5470a586ceaSMark Shellenbaum void dmu_tx_hold_sa_create(dmu_tx_t *tx, int total_size); 548fa9e4066Sahrens void dmu_tx_abort(dmu_tx_t *tx); 549fa9e4066Sahrens int dmu_tx_assign(dmu_tx_t *tx, uint64_t txg_how); 5508a2f1b91Sahrens void dmu_tx_wait(dmu_tx_t *tx); 551fa9e4066Sahrens void dmu_tx_commit(dmu_tx_t *tx); 552fa9e4066Sahrens 553d20e665cSRicardo M. Correia /* 554d20e665cSRicardo M. Correia * To register a commit callback, dmu_tx_callback_register() must be called. 555d20e665cSRicardo M. Correia * 556d20e665cSRicardo M. Correia * dcb_data is a pointer to caller private data that is passed on as a 557d20e665cSRicardo M. Correia * callback parameter. The caller is responsible for properly allocating and 558d20e665cSRicardo M. Correia * freeing it. 559d20e665cSRicardo M. Correia * 560d20e665cSRicardo M. Correia * When registering a callback, the transaction must be already created, but 561d20e665cSRicardo M. Correia * it cannot be committed or aborted. It can be assigned to a txg or not. 562d20e665cSRicardo M. Correia * 563d20e665cSRicardo M. Correia * The callback will be called after the transaction has been safely written 564d20e665cSRicardo M. Correia * to stable storage and will also be called if the dmu_tx is aborted. 565d20e665cSRicardo M. Correia * If there is any error which prevents the transaction from being committed to 566d20e665cSRicardo M. Correia * disk, the callback will be called with a value of error != 0. 567d20e665cSRicardo M. Correia */ 568d20e665cSRicardo M. Correia typedef void dmu_tx_callback_func_t(void *dcb_data, int error); 569d20e665cSRicardo M. Correia 570d20e665cSRicardo M. Correia void dmu_tx_callback_register(dmu_tx_t *tx, dmu_tx_callback_func_t *dcb_func, 571d20e665cSRicardo M. Correia void *dcb_data); 572d20e665cSRicardo M. Correia 573fa9e4066Sahrens /* 574fa9e4066Sahrens * Free up the data blocks for a defined range of a file. If size is 575*ad135b5dSChristopher Siden * -1, the range from offset to end-of-file is freed. 576fa9e4066Sahrens */ 577ea8dc4b6Seschrock int dmu_free_range(objset_t *os, uint64_t object, uint64_t offset, 578fa9e4066Sahrens uint64_t size, dmu_tx_t *tx); 579cdb0ab79Smaybee int dmu_free_long_range(objset_t *os, uint64_t object, uint64_t offset, 580cdb0ab79Smaybee uint64_t size); 581cdb0ab79Smaybee int dmu_free_object(objset_t *os, uint64_t object); 582fa9e4066Sahrens 583fa9e4066Sahrens /* 584fa9e4066Sahrens * Convenience functions. 585fa9e4066Sahrens * 586fa9e4066Sahrens * Canfail routines will return 0 on success, or an errno if there is a 587fa9e4066Sahrens * nonrecoverable I/O error. 588fa9e4066Sahrens */ 5897bfdf011SNeil Perrin #define DMU_READ_PREFETCH 0 /* prefetch */ 5907bfdf011SNeil Perrin #define DMU_READ_NO_PREFETCH 1 /* don't prefetch */ 591ea8dc4b6Seschrock int dmu_read(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, 5927bfdf011SNeil Perrin void *buf, uint32_t flags); 593fa9e4066Sahrens void dmu_write(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, 594fa9e4066Sahrens const void *buf, dmu_tx_t *tx); 59582c9918fSTim Haley void dmu_prealloc(objset_t *os, uint64_t object, uint64_t offset, uint64_t size, 59682c9918fSTim Haley dmu_tx_t *tx); 597feb08c6bSbillm int dmu_read_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size); 598feb08c6bSbillm int dmu_write_uio(objset_t *os, uint64_t object, struct uio *uio, uint64_t size, 599feb08c6bSbillm dmu_tx_t *tx); 60094d1a210STim Haley int dmu_write_uio_dbuf(dmu_buf_t *zdb, struct uio *uio, uint64_t size, 60194d1a210STim Haley dmu_tx_t *tx); 60244eda4d7Smaybee int dmu_write_pages(objset_t *os, uint64_t object, uint64_t offset, 60344eda4d7Smaybee uint64_t size, struct page *pp, dmu_tx_t *tx); 6042fdbea25SAleksandr Guzovskiy struct arc_buf *dmu_request_arcbuf(dmu_buf_t *handle, int size); 6052fdbea25SAleksandr Guzovskiy void dmu_return_arcbuf(struct arc_buf *buf); 6062fdbea25SAleksandr Guzovskiy void dmu_assign_arcbuf(dmu_buf_t *handle, uint64_t offset, struct arc_buf *buf, 6072fdbea25SAleksandr Guzovskiy dmu_tx_t *tx); 608c242f9a0Schunli zhang - Sun Microsystems - Irvine United States int dmu_xuio_init(struct xuio *uio, int niov); 609c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void dmu_xuio_fini(struct xuio *uio); 610c242f9a0Schunli zhang - Sun Microsystems - Irvine United States int dmu_xuio_add(struct xuio *uio, struct arc_buf *abuf, offset_t off, 611c242f9a0Schunli zhang - Sun Microsystems - Irvine United States size_t n); 612c242f9a0Schunli zhang - Sun Microsystems - Irvine United States int dmu_xuio_cnt(struct xuio *uio); 613c242f9a0Schunli zhang - Sun Microsystems - Irvine United States struct arc_buf *dmu_xuio_arcbuf(struct xuio *uio, int i); 614c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void dmu_xuio_clear(struct xuio *uio, int i); 615c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void xuio_stat_wbuf_copied(); 616c242f9a0Schunli zhang - Sun Microsystems - Irvine United States void xuio_stat_wbuf_nocopy(); 617fa9e4066Sahrens 618416e0cd8Sek extern int zfs_prefetch_disable; 619416e0cd8Sek 620fa9e4066Sahrens /* 621fa9e4066Sahrens * Asynchronously try to read in the data. 622fa9e4066Sahrens */ 623fa9e4066Sahrens void dmu_prefetch(objset_t *os, uint64_t object, uint64_t offset, 624fa9e4066Sahrens uint64_t len); 625fa9e4066Sahrens 626fa9e4066Sahrens typedef struct dmu_object_info { 627b24ab676SJeff Bonwick /* All sizes are in bytes unless otherwise indicated. */ 628fa9e4066Sahrens uint32_t doi_data_block_size; 629fa9e4066Sahrens uint32_t doi_metadata_block_size; 630fa9e4066Sahrens dmu_object_type_t doi_type; 631fa9e4066Sahrens dmu_object_type_t doi_bonus_type; 632b24ab676SJeff Bonwick uint64_t doi_bonus_size; 633fa9e4066Sahrens uint8_t doi_indirection; /* 2 = dnode->indirect->data */ 634fa9e4066Sahrens uint8_t doi_checksum; 635fa9e4066Sahrens uint8_t doi_compress; 636fa9e4066Sahrens uint8_t doi_pad[5]; 637b24ab676SJeff Bonwick uint64_t doi_physical_blocks_512; /* data + metadata, 512b blks */ 638b24ab676SJeff Bonwick uint64_t doi_max_offset; 639b24ab676SJeff Bonwick uint64_t doi_fill_count; /* number of non-empty blocks */ 640fa9e4066Sahrens } dmu_object_info_t; 641fa9e4066Sahrens 642e45ce728Sahrens typedef void arc_byteswap_func_t(void *buf, size_t size); 643e45ce728Sahrens 644fa9e4066Sahrens typedef struct dmu_object_type_info { 645*ad135b5dSChristopher Siden dmu_object_byteswap_t ot_byteswap; 646fa9e4066Sahrens boolean_t ot_metadata; 647fa9e4066Sahrens char *ot_name; 648fa9e4066Sahrens } dmu_object_type_info_t; 649fa9e4066Sahrens 650*ad135b5dSChristopher Siden typedef struct dmu_object_byteswap_info { 651*ad135b5dSChristopher Siden arc_byteswap_func_t *ob_func; 652*ad135b5dSChristopher Siden char *ob_name; 653*ad135b5dSChristopher Siden } dmu_object_byteswap_info_t; 654*ad135b5dSChristopher Siden 655fa9e4066Sahrens extern const dmu_object_type_info_t dmu_ot[DMU_OT_NUMTYPES]; 656*ad135b5dSChristopher Siden extern const dmu_object_byteswap_info_t dmu_ot_byteswap[DMU_BSWAP_NUMFUNCS]; 657fa9e4066Sahrens 658fa9e4066Sahrens /* 659fa9e4066Sahrens * Get information on a DMU object. 660fa9e4066Sahrens * 661fa9e4066Sahrens * Return 0 on success or ENOENT if object is not allocated. 662fa9e4066Sahrens * 663fa9e4066Sahrens * If doi is NULL, just indicates whether the object exists. 664fa9e4066Sahrens */ 665fa9e4066Sahrens int dmu_object_info(objset_t *os, uint64_t object, dmu_object_info_t *doi); 666fa9e4066Sahrens void dmu_object_info_from_dnode(struct dnode *dn, dmu_object_info_t *doi); 667fa9e4066Sahrens void dmu_object_info_from_db(dmu_buf_t *db, dmu_object_info_t *doi); 668fa9e4066Sahrens void dmu_object_size_from_db(dmu_buf_t *db, uint32_t *blksize, 669fa9e4066Sahrens u_longlong_t *nblk512); 670fa9e4066Sahrens 671fa9e4066Sahrens typedef struct dmu_objset_stats { 672a2eea2e1Sahrens uint64_t dds_num_clones; /* number of clones of this */ 673a2eea2e1Sahrens uint64_t dds_creation_txg; 6743cb34c60Sahrens uint64_t dds_guid; 675fa9e4066Sahrens dmu_objset_type_t dds_type; 676fa9e4066Sahrens uint8_t dds_is_snapshot; 67731fd60d3Sahrens uint8_t dds_inconsistent; 6783cb34c60Sahrens char dds_origin[MAXNAMELEN]; 679a2eea2e1Sahrens } dmu_objset_stats_t; 680fa9e4066Sahrens 681a2eea2e1Sahrens /* 682a2eea2e1Sahrens * Get stats on a dataset. 683a2eea2e1Sahrens */ 684a2eea2e1Sahrens void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat); 685fa9e4066Sahrens 686a2eea2e1Sahrens /* 687a2eea2e1Sahrens * Add entries to the nvlist for all the objset's properties. See 688a2eea2e1Sahrens * zfs_prop_table[] and zfs(1m) for details on the properties. 689a2eea2e1Sahrens */ 690a2eea2e1Sahrens void dmu_objset_stats(objset_t *os, struct nvlist *nv); 691fa9e4066Sahrens 692a2eea2e1Sahrens /* 693a2eea2e1Sahrens * Get the space usage statistics for statvfs(). 694a2eea2e1Sahrens * 695a2eea2e1Sahrens * refdbytes is the amount of space "referenced" by this objset. 696a2eea2e1Sahrens * availbytes is the amount of space available to this objset, taking 697a2eea2e1Sahrens * into account quotas & reservations, assuming that no other objsets 698a2eea2e1Sahrens * use the space first. These values correspond to the 'referenced' and 699a2eea2e1Sahrens * 'available' properties, described in the zfs(1m) manpage. 700a2eea2e1Sahrens * 701a2eea2e1Sahrens * usedobjs and availobjs are the number of objects currently allocated, 702a2eea2e1Sahrens * and available. 703a2eea2e1Sahrens */ 704a2eea2e1Sahrens void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp, 705a2eea2e1Sahrens uint64_t *usedobjsp, uint64_t *availobjsp); 706fa9e4066Sahrens 707fa9e4066Sahrens /* 708a2eea2e1Sahrens * The fsid_guid is a 56-bit ID that can change to avoid collisions. 709a2eea2e1Sahrens * (Contrast with the ds_guid which is a 64-bit ID that will never 710a2eea2e1Sahrens * change, so there is a small probability that it will collide.) 711fa9e4066Sahrens */ 712a2eea2e1Sahrens uint64_t dmu_objset_fsid_guid(objset_t *os); 713fa9e4066Sahrens 71471eb0538SChris Kirby /* 71571eb0538SChris Kirby * Get the [cm]time for an objset's snapshot dir 71671eb0538SChris Kirby */ 71771eb0538SChris Kirby timestruc_t dmu_objset_snap_cmtime(objset_t *os); 71871eb0538SChris Kirby 719fa9e4066Sahrens int dmu_objset_is_snapshot(objset_t *os); 720fa9e4066Sahrens 721fa9e4066Sahrens extern struct spa *dmu_objset_spa(objset_t *os); 722fa9e4066Sahrens extern struct zilog *dmu_objset_zil(objset_t *os); 723fa9e4066Sahrens extern struct dsl_pool *dmu_objset_pool(objset_t *os); 724fa9e4066Sahrens extern struct dsl_dataset *dmu_objset_ds(objset_t *os); 725fa9e4066Sahrens extern void dmu_objset_name(objset_t *os, char *buf); 726fa9e4066Sahrens extern dmu_objset_type_t dmu_objset_type(objset_t *os); 727fa9e4066Sahrens extern uint64_t dmu_objset_id(objset_t *os); 72855da60b9SMark J Musante extern uint64_t dmu_objset_syncprop(objset_t *os); 729e09fa4daSNeil Perrin extern uint64_t dmu_objset_logbias(objset_t *os); 730fa9e4066Sahrens extern int dmu_snapshot_list_next(objset_t *os, int namelen, char *name, 731b38f0970Sck uint64_t *id, uint64_t *offp, boolean_t *case_conflict); 732ab04eb8eStimh extern int dmu_snapshot_realname(objset_t *os, char *name, char *real, 733ab04eb8eStimh int maxlen, boolean_t *conflict); 73487e5029aSahrens extern int dmu_dir_list_next(objset_t *os, int namelen, char *name, 73587e5029aSahrens uint64_t *idp, uint64_t *offp); 73614843421SMatthew Ahrens 7379966ca11SMatthew Ahrens typedef int objset_used_cb_t(dmu_object_type_t bonustype, 7389966ca11SMatthew Ahrens void *bonus, uint64_t *userp, uint64_t *groupp); 73914843421SMatthew Ahrens extern void dmu_objset_register_type(dmu_objset_type_t ost, 74014843421SMatthew Ahrens objset_used_cb_t *cb); 741f18faf3fSek extern void dmu_objset_set_user(objset_t *os, void *user_ptr); 742f18faf3fSek extern void *dmu_objset_get_user(objset_t *os); 743fa9e4066Sahrens 744fa9e4066Sahrens /* 745fa9e4066Sahrens * Return the txg number for the given assigned transaction. 746fa9e4066Sahrens */ 74787e5029aSahrens uint64_t dmu_tx_get_txg(dmu_tx_t *tx); 748fa9e4066Sahrens 749fa9e4066Sahrens /* 750fa9e4066Sahrens * Synchronous write. 751c5c6ffa0Smaybee * If a parent zio is provided this function initiates a write on the 752c5c6ffa0Smaybee * provided buffer as a child of the parent zio. 753da6c28aaSamw * In the absence of a parent zio, the write is completed synchronously. 754c5c6ffa0Smaybee * At write completion, blk is filled with the bp of the written block. 755fa9e4066Sahrens * Note that while the data covered by this function will be on stable 756c5c6ffa0Smaybee * storage when the write completes this new data does not become a 757fa9e4066Sahrens * permanent part of the file until the associated transaction commits. 758fa9e4066Sahrens */ 759b24ab676SJeff Bonwick 760b24ab676SJeff Bonwick /* 761b24ab676SJeff Bonwick * {zfs,zvol,ztest}_get_done() args 762b24ab676SJeff Bonwick */ 763b24ab676SJeff Bonwick typedef struct zgd { 764b24ab676SJeff Bonwick struct zilog *zgd_zilog; 765b24ab676SJeff Bonwick struct blkptr *zgd_bp; 766b24ab676SJeff Bonwick dmu_buf_t *zgd_db; 767b24ab676SJeff Bonwick struct rl *zgd_rl; 768b24ab676SJeff Bonwick void *zgd_private; 769b24ab676SJeff Bonwick } zgd_t; 770b24ab676SJeff Bonwick 771b24ab676SJeff Bonwick typedef void dmu_sync_cb_t(zgd_t *arg, int error); 772b24ab676SJeff Bonwick int dmu_sync(struct zio *zio, uint64_t txg, dmu_sync_cb_t *done, zgd_t *zgd); 773fa9e4066Sahrens 774fa9e4066Sahrens /* 775fa9e4066Sahrens * Find the next hole or data block in file starting at *off 776fa9e4066Sahrens * Return found offset in *off. Return ESRCH for end of file. 777fa9e4066Sahrens */ 778fa9e4066Sahrens int dmu_offset_next(objset_t *os, uint64_t object, boolean_t hole, 779fa9e4066Sahrens uint64_t *off); 780fa9e4066Sahrens 781fa9e4066Sahrens /* 782fa9e4066Sahrens * Initial setup and final teardown. 783fa9e4066Sahrens */ 784fa9e4066Sahrens extern void dmu_init(void); 785fa9e4066Sahrens extern void dmu_fini(void); 786fa9e4066Sahrens 787fa9e4066Sahrens typedef void (*dmu_traverse_cb_t)(objset_t *os, void *arg, struct blkptr *bp, 788fa9e4066Sahrens uint64_t object, uint64_t offset, int len); 789fa9e4066Sahrens void dmu_traverse_objset(objset_t *os, uint64_t txg_start, 790fa9e4066Sahrens dmu_traverse_cb_t cb, void *arg); 791fa9e4066Sahrens 7924e3c9f44SBill Pijewski int dmu_send(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorigin, 7934e3c9f44SBill Pijewski int outfd, struct vnode *vp, offset_t *off); 79419b94df9SMatthew Ahrens int dmu_send_estimate(objset_t *tosnap, objset_t *fromsnap, boolean_t fromorign, 79519b94df9SMatthew Ahrens uint64_t *sizep); 7963cb34c60Sahrens 7973cb34c60Sahrens typedef struct dmu_recv_cookie { 7983cb34c60Sahrens /* 7993cb34c60Sahrens * This structure is opaque! 8003cb34c60Sahrens * 8013cb34c60Sahrens * If logical and real are different, we are recving the stream 8023cb34c60Sahrens * into the "real" temporary clone, and then switching it with 8033cb34c60Sahrens * the "logical" target. 8043cb34c60Sahrens */ 8053cb34c60Sahrens struct dsl_dataset *drc_logical_ds; 8063cb34c60Sahrens struct dsl_dataset *drc_real_ds; 8073cb34c60Sahrens struct drr_begin *drc_drrb; 8083cb34c60Sahrens char *drc_tosnap; 8099e69d7d0SLori Alt char *drc_top_ds; 8103cb34c60Sahrens boolean_t drc_newfs; 8113cb34c60Sahrens boolean_t drc_force; 812ec5cf9d5SAlexander Stetsenko struct avl_tree *drc_guid_to_ds_map; 8133cb34c60Sahrens } dmu_recv_cookie_t; 8143cb34c60Sahrens 8159e69d7d0SLori Alt int dmu_recv_begin(char *tofs, char *tosnap, char *topds, struct drr_begin *, 816f4b94bdeSMatthew Ahrens boolean_t force, objset_t *origin, dmu_recv_cookie_t *); 817c99e4bdcSChris Kirby int dmu_recv_stream(dmu_recv_cookie_t *drc, struct vnode *vp, offset_t *voffp, 818c99e4bdcSChris Kirby int cleanup_fd, uint64_t *action_handlep); 8193cb34c60Sahrens int dmu_recv_end(dmu_recv_cookie_t *drc); 820fa9e4066Sahrens 82199d5e173STim Haley int dmu_diff(objset_t *tosnap, objset_t *fromsnap, struct vnode *vp, 82299d5e173STim Haley offset_t *off); 82399d5e173STim Haley 824fa9e4066Sahrens /* CRC64 table */ 825fa9e4066Sahrens #define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */ 826fa9e4066Sahrens extern uint64_t zfs_crc64_table[256]; 827fa9e4066Sahrens 828fa9e4066Sahrens #ifdef __cplusplus 829fa9e4066Sahrens } 830fa9e4066Sahrens #endif 831fa9e4066Sahrens 832fa9e4066Sahrens #endif /* _SYS_DMU_H */ 833