1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2012, 2018 by Delphix. All rights reserved. 24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 25 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. 26 * Copyright (c) 2014 Integros [integros.com] 27 */ 28 29 /* Portions Copyright 2010 Robert Milkowski */ 30 31 #ifndef _SYS_DMU_OBJSET_H 32 #define _SYS_DMU_OBJSET_H 33 34 #include <sys/spa.h> 35 #include <sys/arc.h> 36 #include <sys/txg.h> 37 #include <sys/zfs_context.h> 38 #include <sys/dnode.h> 39 #include <sys/zio.h> 40 #include <sys/zil.h> 41 #include <sys/sa.h> 42 #include <sys/zfs_ioctl.h> 43 44 #ifdef __cplusplus 45 extern "C" { 46 #endif 47 48 extern krwlock_t os_lock; 49 50 struct dsl_pool; 51 struct dsl_dataset; 52 struct dmu_tx; 53 54 #define OBJSET_PHYS_SIZE 2048 55 #define OBJSET_OLD_PHYS_SIZE 1024 56 57 #define OBJSET_BUF_HAS_USERUSED(buf) \ 58 (arc_buf_size(buf) > OBJSET_OLD_PHYS_SIZE) 59 60 #define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL<<0) 61 62 /* all flags are currently non-portable */ 63 #define OBJSET_CRYPT_PORTABLE_FLAGS_MASK (0) 64 65 typedef struct objset_phys { 66 dnode_phys_t os_meta_dnode; 67 zil_header_t os_zil_header; 68 uint64_t os_type; 69 uint64_t os_flags; 70 uint8_t os_portable_mac[ZIO_OBJSET_MAC_LEN]; 71 uint8_t os_local_mac[ZIO_OBJSET_MAC_LEN]; 72 char os_pad[OBJSET_PHYS_SIZE - sizeof (dnode_phys_t)*3 - 73 sizeof (zil_header_t) - sizeof (uint64_t)*2 - 74 2*ZIO_OBJSET_MAC_LEN]; 75 dnode_phys_t os_userused_dnode; 76 dnode_phys_t os_groupused_dnode; 77 } objset_phys_t; 78 79 #define OBJSET_PROP_UNINITIALIZED ((uint64_t)-1) 80 struct objset { 81 /* Immutable: */ 82 struct dsl_dataset *os_dsl_dataset; 83 spa_t *os_spa; 84 arc_buf_t *os_phys_buf; 85 objset_phys_t *os_phys; 86 boolean_t os_encrypted; 87 88 /* 89 * The following "special" dnodes have no parent, are exempt 90 * from dnode_move(), and are not recorded in os_dnodes, but they 91 * root their descendents in this objset using handles anyway, so 92 * that all access to dnodes from dbufs consistently uses handles. 93 */ 94 dnode_handle_t os_meta_dnode; 95 dnode_handle_t os_userused_dnode; 96 dnode_handle_t os_groupused_dnode; 97 zilog_t *os_zil; 98 99 list_node_t os_evicting_node; 100 101 /* can change, under dsl_dir's locks: */ 102 uint64_t os_dnodesize; /* default dnode size for new objects */ 103 enum zio_checksum os_checksum; 104 enum zio_compress os_compress; 105 uint8_t os_copies; 106 enum zio_checksum os_dedup_checksum; 107 boolean_t os_dedup_verify; 108 zfs_logbias_op_t os_logbias; 109 zfs_cache_type_t os_primary_cache; 110 zfs_cache_type_t os_secondary_cache; 111 zfs_sync_type_t os_sync; 112 zfs_redundant_metadata_type_t os_redundant_metadata; 113 int os_recordsize; 114 /* 115 * The next four values are used as a cache of whatever's on disk, and 116 * are initialized the first time these properties are queried. Before 117 * being initialized with their real values, their values are 118 * OBJSET_PROP_UNINITIALIZED. 119 */ 120 uint64_t os_version; 121 uint64_t os_normalization; 122 uint64_t os_utf8only; 123 uint64_t os_casesensitivity; 124 /* 125 * The largest zpl file block allowed in special class. 126 * cached here instead of zfsvfs for easier access. 127 */ 128 int os_zpl_special_smallblock; 129 130 /* 131 * Pointer is constant; the blkptr it points to is protected by 132 * os_dsl_dataset->ds_bp_rwlock 133 */ 134 blkptr_t *os_rootbp; 135 136 /* no lock needed: */ 137 struct dmu_tx *os_synctx; /* XXX sketchy */ 138 zil_header_t os_zil_header; 139 multilist_t *os_synced_dnodes; 140 uint64_t os_flags; 141 uint64_t os_freed_dnodes; 142 boolean_t os_rescan_dnodes; 143 boolean_t os_raw_receive; 144 145 /* os_phys_buf should be written raw next txg */ 146 boolean_t os_next_write_raw[TXG_SIZE]; 147 148 /* Protected by os_obj_lock */ 149 kmutex_t os_obj_lock; 150 uint64_t os_obj_next_chunk; 151 152 /* Per-CPU next object to allocate, protected by atomic ops. */ 153 uint64_t *os_obj_next_percpu; 154 int os_obj_next_percpu_len; 155 156 /* Protected by os_lock */ 157 kmutex_t os_lock; 158 multilist_t *os_dirty_dnodes[TXG_SIZE]; 159 list_t os_dnodes; 160 list_t os_downgraded_dbufs; 161 162 /* Protects changes to DMU_{USER,GROUP}USED_OBJECT */ 163 kmutex_t os_userused_lock; 164 165 /* stuff we store for the user */ 166 kmutex_t os_user_ptr_lock; 167 void *os_user_ptr; 168 sa_os_t *os_sa; 169 }; 170 171 #define DMU_META_OBJSET 0 172 #define DMU_META_DNODE_OBJECT 0 173 #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0) 174 #define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode) 175 #define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode) 176 #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode) 177 178 #define DMU_OS_IS_L2CACHEABLE(os) \ 179 ((os)->os_secondary_cache == ZFS_CACHE_ALL || \ 180 (os)->os_secondary_cache == ZFS_CACHE_METADATA) 181 182 #define DMU_OS_IS_L2COMPRESSIBLE(os) (zfs_mdcomp_disable == B_FALSE) 183 184 /* called from zpl */ 185 int dmu_objset_hold(const char *name, void *tag, objset_t **osp); 186 int dmu_objset_hold_flags(const char *name, boolean_t decrypt, void *tag, 187 objset_t **osp); 188 int dmu_objset_own(const char *name, dmu_objset_type_t type, 189 boolean_t readonly, boolean_t decrypt, void *tag, objset_t **osp); 190 int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj, 191 dmu_objset_type_t type, boolean_t readonly, boolean_t decrypt, 192 void *tag, objset_t **osp); 193 void dmu_objset_refresh_ownership(struct dsl_dataset *ds, 194 struct dsl_dataset **newds, boolean_t key_needed, void *tag); 195 void dmu_objset_rele(objset_t *os, void *tag); 196 void dmu_objset_rele_flags(objset_t *os, boolean_t decrypt, void *tag); 197 void dmu_objset_disown(objset_t *os, boolean_t decrypt, void *tag); 198 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp); 199 200 void dmu_objset_stats(objset_t *os, nvlist_t *nv); 201 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat); 202 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp, 203 uint64_t *usedobjsp, uint64_t *availobjsp); 204 uint64_t dmu_objset_fsid_guid(objset_t *os); 205 int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj, 206 int func(struct dsl_pool *, struct dsl_dataset *, void *), 207 void *arg, int flags); 208 int dmu_objset_prefetch(const char *name, void *arg); 209 void dmu_objset_evict_dbufs(objset_t *os); 210 timestruc_t dmu_objset_snap_cmtime(objset_t *os); 211 212 /* called from dsl */ 213 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx); 214 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg); 215 objset_t *dmu_objset_create_impl_dnstats(spa_t *spa, struct dsl_dataset *ds, 216 blkptr_t *bp, dmu_objset_type_t type, int levels, int blksz, int ibs, 217 dmu_tx_t *tx); 218 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds, 219 blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx); 220 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp, 221 objset_t **osp); 222 void dmu_objset_evict(objset_t *os); 223 void dmu_objset_do_userquota_updates(objset_t *os, dmu_tx_t *tx); 224 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx); 225 boolean_t dmu_objset_userused_enabled(objset_t *os); 226 int dmu_objset_userspace_upgrade(objset_t *os); 227 boolean_t dmu_objset_userspace_present(objset_t *os); 228 boolean_t dmu_objset_incompatible_encryption_version(objset_t *os); 229 int dmu_fsname(const char *snapname, char *buf); 230 231 void dmu_objset_evict_done(objset_t *os); 232 void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx); 233 234 void dmu_objset_init(void); 235 void dmu_objset_fini(void); 236 237 #ifdef __cplusplus 238 } 239 #endif 240 241 #endif /* _SYS_DMU_OBJSET_H */ 242