1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * This file and its contents are supplied under the terms of the 4 * Common Development and Distribution License ("CDDL"), version 1.0. 5 * You may only use this file in accordance with the terms of version 6 * 1.0 of the CDDL. 7 * 8 * A full copy of the text of the CDDL should have accompanied this 9 * source. A copy of the CDDL is also available via the Internet at 10 * https://opensource.org/license/CDDL-1.0. 11 */ 12 /* 13 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 14 * Copyright (c) 2012, 2018 by Delphix. All rights reserved. 15 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved. 16 * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved. 17 */ 18 19 /* Portions Copyright 2010 Robert Milkowski */ 20 21 #ifndef _SYS_DMU_OBJSET_H 22 #define _SYS_DMU_OBJSET_H 23 24 #include <sys/spa.h> 25 #include <sys/arc.h> 26 #include <sys/txg.h> 27 #include <sys/zfs_context.h> 28 #include <sys/dnode.h> 29 #include <sys/zio.h> 30 #include <sys/zil.h> 31 #include <sys/sa.h> 32 #include <sys/zfs_ioctl.h> 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 extern krwlock_t os_lock; 39 40 struct dsl_pool; 41 struct dsl_dataset; 42 struct dmu_tx; 43 44 #define OBJSET_PHYS_SIZE_V1 1024 45 #define OBJSET_PHYS_SIZE_V2 2048 46 #define OBJSET_PHYS_SIZE_V3 4096 47 48 #define OBJSET_BUF_HAS_USERUSED(buf) \ 49 (arc_buf_size(buf) >= OBJSET_PHYS_SIZE_V2) 50 #define OBJSET_BUF_HAS_PROJECTUSED(buf) \ 51 (arc_buf_size(buf) >= OBJSET_PHYS_SIZE_V3) 52 53 #define OBJSET_FLAG_USERACCOUNTING_COMPLETE (1ULL << 0) 54 #define OBJSET_FLAG_USEROBJACCOUNTING_COMPLETE (1ULL << 1) 55 #define OBJSET_FLAG_PROJECTQUOTA_COMPLETE (1ULL << 2) 56 57 /* 58 * This mask defines the set of flags which are "portable", meaning 59 * that they can be preserved when doing a raw encrypted zfs send. 60 * Flags included in this mask will be protected by os_portable_mac 61 * when the block of dnodes is encrypted. No portable flags currently 62 * exist. 63 */ 64 #define OBJSET_CRYPT_PORTABLE_FLAGS_MASK (0) 65 66 #if defined(__clang__) 67 #pragma clang diagnostic push 68 #pragma clang diagnostic ignored "-Wgnu-variable-sized-type-not-at-end" 69 #endif 70 typedef struct objset_phys { 71 dnode_phys_t os_meta_dnode; 72 zil_header_t os_zil_header; 73 uint64_t os_type; 74 uint64_t os_flags; 75 uint8_t os_portable_mac[ZIO_OBJSET_MAC_LEN]; 76 uint8_t os_local_mac[ZIO_OBJSET_MAC_LEN]; 77 char os_pad0[OBJSET_PHYS_SIZE_V2 - sizeof (dnode_phys_t)*3 - 78 sizeof (zil_header_t) - sizeof (uint64_t)*2 - 79 2*ZIO_OBJSET_MAC_LEN]; 80 dnode_phys_t os_userused_dnode; 81 dnode_phys_t os_groupused_dnode; 82 dnode_phys_t os_projectused_dnode; 83 char os_pad1[OBJSET_PHYS_SIZE_V3 - OBJSET_PHYS_SIZE_V2 - 84 sizeof (dnode_phys_t)]; 85 } objset_phys_t; 86 #if defined(__clang__) 87 #pragma clang diagnostic pop 88 #endif 89 90 typedef int (*dmu_objset_upgrade_cb_t)(objset_t *); 91 92 #define OBJSET_PROP_UNINITIALIZED ((uint64_t)-1) 93 struct objset { 94 /* Immutable: */ 95 struct dsl_dataset *os_dsl_dataset; 96 spa_t *os_spa; 97 arc_buf_t *os_phys_buf; 98 objset_phys_t *os_phys; 99 boolean_t os_encrypted; 100 101 /* 102 * The following "special" dnodes have no parent, are exempt 103 * from dnode_move(), and are not recorded in os_dnodes, but they 104 * root their descendents in this objset using handles anyway, so 105 * that all access to dnodes from dbufs consistently uses handles. 106 */ 107 dnode_handle_t os_meta_dnode; 108 dnode_handle_t os_userused_dnode; 109 dnode_handle_t os_groupused_dnode; 110 dnode_handle_t os_projectused_dnode; 111 zilog_t *os_zil; 112 113 list_node_t os_evicting_node; 114 115 /* can change, under dsl_dir's locks: */ 116 uint64_t os_dnodesize; /* default dnode size for new objects */ 117 enum zio_checksum os_checksum; 118 enum zio_compress os_compress; 119 uint8_t os_complevel; 120 uint8_t os_copies; 121 enum zio_checksum os_dedup_checksum; 122 boolean_t os_dedup_verify; 123 zfs_logbias_op_t os_logbias; 124 zfs_cache_type_t os_primary_cache; 125 zfs_cache_type_t os_secondary_cache; 126 zfs_prefetch_type_t os_prefetch; 127 zfs_sync_type_t os_sync; 128 zfs_direct_t os_direct; 129 zfs_redundant_metadata_type_t os_redundant_metadata; 130 uint64_t os_recordsize; 131 /* 132 * The next four values are used as a cache of whatever's on disk, and 133 * are initialized the first time these properties are queried. Before 134 * being initialized with their real values, their values are 135 * OBJSET_PROP_UNINITIALIZED. 136 */ 137 uint64_t os_version; 138 uint64_t os_normalization; 139 uint64_t os_utf8only; 140 uint64_t os_casesensitivity; 141 /* 142 * The largest zpl file block allowed in special class. 143 * cached here instead of zfsvfs for easier access. 144 */ 145 uint64_t os_zpl_special_smallblock; 146 147 /* 148 * Pointer is constant; the blkptr it points to is protected by 149 * os_dsl_dataset->ds_bp_rwlock 150 */ 151 blkptr_t *os_rootbp; 152 153 /* no lock needed: */ 154 struct dmu_tx *os_synctx; /* XXX sketchy */ 155 zil_header_t os_zil_header; 156 multilist_t os_synced_dnodes; 157 uint64_t os_flags; 158 uint64_t os_freed_dnodes; 159 boolean_t os_rescan_dnodes; 160 boolean_t os_raw_receive; 161 162 /* os_phys_buf should be written raw next txg */ 163 boolean_t os_next_write_raw[TXG_SIZE]; 164 165 /* Protected by os_obj_lock */ 166 kmutex_t os_obj_lock; 167 uint64_t os_obj_next_chunk; 168 169 /* Per-CPU next object to allocate, protected by atomic ops. */ 170 uint64_t *os_obj_next_percpu; 171 int os_obj_next_percpu_len; 172 173 /* Protected by os_lock */ 174 kmutex_t os_lock; 175 multilist_t os_dirty_dnodes[TXG_SIZE]; 176 list_t os_dnodes; 177 list_t os_downgraded_dbufs; 178 179 /* Protects changes to DMU_{USER,GROUP,PROJECT}USED_OBJECT */ 180 kmutex_t os_userused_lock; 181 182 /* stuff we store for the user */ 183 kmutex_t os_user_ptr_lock; 184 void *os_user_ptr; 185 sa_os_t *os_sa; 186 187 /* kernel thread to upgrade this dataset */ 188 kmutex_t os_upgrade_lock; 189 taskqid_t os_upgrade_id; 190 dmu_objset_upgrade_cb_t os_upgrade_cb; 191 boolean_t os_upgrade_exit; 192 int os_upgrade_status; 193 }; 194 195 #define DMU_META_OBJSET 0 196 #define DMU_META_DNODE_OBJECT 0 197 #define DMU_OBJECT_IS_SPECIAL(obj) ((int64_t)(obj) <= 0) 198 #define DMU_META_DNODE(os) ((os)->os_meta_dnode.dnh_dnode) 199 #define DMU_USERUSED_DNODE(os) ((os)->os_userused_dnode.dnh_dnode) 200 #define DMU_GROUPUSED_DNODE(os) ((os)->os_groupused_dnode.dnh_dnode) 201 #define DMU_PROJECTUSED_DNODE(os) ((os)->os_projectused_dnode.dnh_dnode) 202 203 /* called from zpl */ 204 int dmu_objset_hold(const char *name, const void *tag, objset_t **osp); 205 int dmu_objset_hold_flags(const char *name, boolean_t decrypt, const void *tag, 206 objset_t **osp); 207 int dmu_objset_own(const char *name, dmu_objset_type_t type, 208 boolean_t readonly, boolean_t decrypt, const void *tag, objset_t **osp); 209 int dmu_objset_own_obj(struct dsl_pool *dp, uint64_t obj, 210 dmu_objset_type_t type, boolean_t readonly, boolean_t decrypt, 211 const void *tag, objset_t **osp); 212 void dmu_objset_refresh_ownership(struct dsl_dataset *ds, 213 struct dsl_dataset **newds, boolean_t decrypt, const void *tag); 214 void dmu_objset_rele(objset_t *os, const void *tag); 215 void dmu_objset_rele_flags(objset_t *os, boolean_t decrypt, const void *tag); 216 void dmu_objset_disown(objset_t *os, boolean_t decrypt, const void *tag); 217 int dmu_objset_from_ds(struct dsl_dataset *ds, objset_t **osp); 218 219 void dmu_objset_stats(objset_t *os, nvlist_t *nv); 220 void dmu_objset_fast_stat(objset_t *os, dmu_objset_stats_t *stat); 221 void dmu_objset_space(objset_t *os, uint64_t *refdbytesp, uint64_t *availbytesp, 222 uint64_t *usedobjsp, uint64_t *availobjsp); 223 uint64_t dmu_objset_fsid_guid(objset_t *os); 224 int dmu_objset_find_dp(struct dsl_pool *dp, uint64_t ddobj, 225 int func(struct dsl_pool *, struct dsl_dataset *, void *), 226 void *arg, int flags); 227 void dmu_objset_evict_dbufs(objset_t *os); 228 inode_timespec_t dmu_objset_snap_cmtime(objset_t *os); 229 boolean_t dmu_objset_block_is_shared(objset_t *os, const blkptr_t *bp); 230 231 /* called from dsl */ 232 void dmu_objset_sync(objset_t *os, zio_t *zio, dmu_tx_t *tx); 233 boolean_t dmu_objset_is_dirty(objset_t *os, uint64_t txg); 234 objset_t *dmu_objset_create_impl_dnstats(spa_t *spa, struct dsl_dataset *ds, 235 blkptr_t *bp, dmu_objset_type_t type, int levels, int blksz, int ibs, 236 dmu_tx_t *tx); 237 objset_t *dmu_objset_create_impl(spa_t *spa, struct dsl_dataset *ds, 238 blkptr_t *bp, dmu_objset_type_t type, dmu_tx_t *tx); 239 int dmu_objset_open_impl(spa_t *spa, struct dsl_dataset *ds, blkptr_t *bp, 240 objset_t **osp); 241 void dmu_objset_evict(objset_t *os); 242 void dmu_objset_sync_done(objset_t *os, dmu_tx_t *tx); 243 void dmu_objset_userquota_get_ids(dnode_t *dn, boolean_t before, dmu_tx_t *tx); 244 boolean_t dmu_objset_userused_enabled(objset_t *os); 245 void dmu_objset_userspace_upgrade(objset_t *os); 246 boolean_t dmu_objset_userspace_present(objset_t *os); 247 boolean_t dmu_objset_userobjused_enabled(objset_t *os); 248 boolean_t dmu_objset_userobjspace_upgradable(objset_t *os); 249 boolean_t dmu_objset_userobjspace_present(objset_t *os); 250 boolean_t dmu_objset_incompatible_encryption_version(objset_t *os); 251 boolean_t dmu_objset_projectquota_enabled(objset_t *os); 252 boolean_t dmu_objset_projectquota_present(objset_t *os); 253 boolean_t dmu_objset_projectquota_upgradable(objset_t *os); 254 void dmu_objset_id_quota_upgrade(objset_t *os); 255 int dmu_get_file_info(objset_t *os, dmu_object_type_t bonustype, 256 const void *data, zfs_file_info_t *zfi); 257 258 int dmu_fsname(const char *snapname, char *buf); 259 260 void dmu_objset_evict_done(objset_t *os); 261 void dmu_objset_willuse_space(objset_t *os, int64_t space, dmu_tx_t *tx); 262 263 void dmu_objset_init(void); 264 void dmu_objset_fini(void); 265 266 #ifdef __cplusplus 267 } 268 #endif 269 270 #endif /* _SYS_DMU_OBJSET_H */ 271