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 2010 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_DNODE_H 27 #define _SYS_DNODE_H 28 29 #include <sys/zfs_context.h> 30 #include <sys/avl.h> 31 #include <sys/spa.h> 32 #include <sys/txg.h> 33 #include <sys/zio.h> 34 #include <sys/refcount.h> 35 #include <sys/dmu_zfetch.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 /* 42 * dnode_hold() flags. 43 */ 44 #define DNODE_MUST_BE_ALLOCATED 1 45 #define DNODE_MUST_BE_FREE 2 46 47 /* 48 * dnode_next_offset() flags. 49 */ 50 #define DNODE_FIND_HOLE 1 51 #define DNODE_FIND_BACKWARDS 2 52 #define DNODE_FIND_HAVELOCK 4 53 54 /* 55 * Fixed constants. 56 */ 57 #define DNODE_SHIFT 9 /* 512 bytes */ 58 #define DN_MIN_INDBLKSHIFT 10 /* 1k */ 59 #define DN_MAX_INDBLKSHIFT 14 /* 16k */ 60 #define DNODE_BLOCK_SHIFT 14 /* 16k */ 61 #define DNODE_CORE_SIZE 64 /* 64 bytes for dnode sans blkptrs */ 62 #define DN_MAX_OBJECT_SHIFT 48 /* 256 trillion (zfs_fid_t limit) */ 63 #define DN_MAX_OFFSET_SHIFT 64 /* 2^64 bytes in a dnode */ 64 65 /* 66 * dnode id flags 67 * 68 * Note: a file will never ever have its 69 * ids moved from bonus->spill 70 * and only in a crypto environment would it be on spill 71 */ 72 #define DN_ID_CHKED_BONUS 0x1 73 #define DN_ID_CHKED_SPILL 0x2 74 #define DN_ID_OLD_EXIST 0x4 75 #define DN_ID_NEW_EXIST 0x8 76 #define DN_ID_SYNC 0x10 77 78 /* 79 * Derived constants. 80 */ 81 #define DNODE_SIZE (1 << DNODE_SHIFT) 82 #define DN_MAX_NBLKPTR ((DNODE_SIZE - DNODE_CORE_SIZE) >> SPA_BLKPTRSHIFT) 83 #define DN_MAX_BONUSLEN (DNODE_SIZE - DNODE_CORE_SIZE - (1 << SPA_BLKPTRSHIFT)) 84 #define DN_MAX_OBJECT (1ULL << DN_MAX_OBJECT_SHIFT) 85 #define DN_ZERO_BONUSLEN (DN_MAX_BONUSLEN + 1) 86 #define DN_KILL_SPILLBLK (1) 87 88 #define DNODES_PER_BLOCK_SHIFT (DNODE_BLOCK_SHIFT - DNODE_SHIFT) 89 #define DNODES_PER_BLOCK (1ULL << DNODES_PER_BLOCK_SHIFT) 90 #define DNODES_PER_LEVEL_SHIFT (DN_MAX_INDBLKSHIFT - SPA_BLKPTRSHIFT) 91 #define DNODES_PER_LEVEL (1ULL << DNODES_PER_LEVEL_SHIFT) 92 93 /* The +2 here is a cheesy way to round up */ 94 #define DN_MAX_LEVELS (2 + ((DN_MAX_OFFSET_SHIFT - SPA_MINBLOCKSHIFT) / \ 95 (DN_MIN_INDBLKSHIFT - SPA_BLKPTRSHIFT))) 96 97 #define DN_BONUS(dnp) ((void*)((dnp)->dn_bonus + \ 98 (((dnp)->dn_nblkptr - 1) * sizeof (blkptr_t)))) 99 100 #define DN_USED_BYTES(dnp) (((dnp)->dn_flags & DNODE_FLAG_USED_BYTES) ? \ 101 (dnp)->dn_used : (dnp)->dn_used << SPA_MINBLOCKSHIFT) 102 103 #define EPB(blkshift, typeshift) (1 << (blkshift - typeshift)) 104 105 struct dmu_buf_impl; 106 struct objset; 107 struct zio; 108 109 enum dnode_dirtycontext { 110 DN_UNDIRTIED, 111 DN_DIRTY_OPEN, 112 DN_DIRTY_SYNC 113 }; 114 115 /* Is dn_used in bytes? if not, it's in multiples of SPA_MINBLOCKSIZE */ 116 #define DNODE_FLAG_USED_BYTES (1<<0) 117 #define DNODE_FLAG_USERUSED_ACCOUNTED (1<<1) 118 119 /* Does dnode have a SA spill blkptr in bonus? */ 120 #define DNODE_FLAG_SPILL_BLKPTR (1<<2) 121 122 typedef struct dnode_phys { 123 uint8_t dn_type; /* dmu_object_type_t */ 124 uint8_t dn_indblkshift; /* ln2(indirect block size) */ 125 uint8_t dn_nlevels; /* 1=dn_blkptr->data blocks */ 126 uint8_t dn_nblkptr; /* length of dn_blkptr */ 127 uint8_t dn_bonustype; /* type of data in bonus buffer */ 128 uint8_t dn_checksum; /* ZIO_CHECKSUM type */ 129 uint8_t dn_compress; /* ZIO_COMPRESS type */ 130 uint8_t dn_flags; /* DNODE_FLAG_* */ 131 uint16_t dn_datablkszsec; /* data block size in 512b sectors */ 132 uint16_t dn_bonuslen; /* length of dn_bonus */ 133 uint8_t dn_pad2[4]; 134 135 /* accounting is protected by dn_dirty_mtx */ 136 uint64_t dn_maxblkid; /* largest allocated block ID */ 137 uint64_t dn_used; /* bytes (or sectors) of disk space */ 138 139 uint64_t dn_pad3[4]; 140 141 blkptr_t dn_blkptr[1]; 142 uint8_t dn_bonus[DN_MAX_BONUSLEN - sizeof (blkptr_t)]; 143 blkptr_t dn_spill; 144 } dnode_phys_t; 145 146 typedef struct dnode { 147 /* 148 * dn_struct_rwlock protects the structure of the dnode, 149 * including the number of levels of indirection (dn_nlevels), 150 * dn_maxblkid, and dn_next_* 151 */ 152 krwlock_t dn_struct_rwlock; 153 154 /* Our link on dn_objset->os_dnodes list; protected by os_lock. */ 155 list_node_t dn_link; 156 157 /* immutable: */ 158 struct objset *dn_objset; 159 uint64_t dn_object; 160 struct dmu_buf_impl *dn_dbuf; 161 dnode_phys_t *dn_phys; /* pointer into dn->dn_dbuf->db.db_data */ 162 163 /* 164 * Copies of stuff in dn_phys. They're valid in the open 165 * context (eg. even before the dnode is first synced). 166 * Where necessary, these are protected by dn_struct_rwlock. 167 */ 168 dmu_object_type_t dn_type; /* object type */ 169 uint16_t dn_bonuslen; /* bonus length */ 170 uint8_t dn_bonustype; /* bonus type */ 171 uint8_t dn_nblkptr; /* number of blkptrs (immutable) */ 172 uint8_t dn_checksum; /* ZIO_CHECKSUM type */ 173 uint8_t dn_compress; /* ZIO_COMPRESS type */ 174 uint8_t dn_nlevels; 175 uint8_t dn_indblkshift; 176 uint8_t dn_datablkshift; /* zero if blksz not power of 2! */ 177 uint16_t dn_datablkszsec; /* in 512b sectors */ 178 uint32_t dn_datablksz; /* in bytes */ 179 uint64_t dn_maxblkid; 180 uint8_t dn_next_nblkptr[TXG_SIZE]; 181 uint8_t dn_next_nlevels[TXG_SIZE]; 182 uint8_t dn_next_indblkshift[TXG_SIZE]; 183 uint8_t dn_next_bonustype[TXG_SIZE]; 184 uint8_t dn_rm_spillblk[TXG_SIZE]; /* for removing spill blk */ 185 uint16_t dn_next_bonuslen[TXG_SIZE]; 186 uint32_t dn_next_blksz[TXG_SIZE]; /* next block size in bytes */ 187 188 /* protected by os_lock: */ 189 list_node_t dn_dirty_link[TXG_SIZE]; /* next on dataset's dirty */ 190 191 /* protected by dn_mtx: */ 192 kmutex_t dn_mtx; 193 list_t dn_dirty_records[TXG_SIZE]; 194 avl_tree_t dn_ranges[TXG_SIZE]; 195 uint64_t dn_allocated_txg; 196 uint64_t dn_free_txg; 197 uint64_t dn_assigned_txg; 198 kcondvar_t dn_notxholds; 199 enum dnode_dirtycontext dn_dirtyctx; 200 uint8_t *dn_dirtyctx_firstset; /* dbg: contents meaningless */ 201 202 /* protected by own devices */ 203 refcount_t dn_tx_holds; 204 refcount_t dn_holds; 205 206 kmutex_t dn_dbufs_mtx; 207 list_t dn_dbufs; /* linked list of descendent dbuf_t's */ 208 struct dmu_buf_impl *dn_bonus; /* bonus buffer dbuf */ 209 boolean_t dn_have_spill; /* have spill or are spilling */ 210 211 /* parent IO for current sync write */ 212 zio_t *dn_zio; 213 214 /* used in syncing context */ 215 uint64_t dn_oldused; /* old phys used bytes */ 216 uint64_t dn_oldflags; /* old phys dn_flags */ 217 uint64_t dn_olduid, dn_oldgid; 218 uint64_t dn_newuid, dn_newgid; 219 int dn_id_flags; 220 221 /* holds prefetch structure */ 222 struct zfetch dn_zfetch; 223 } dnode_t; 224 225 typedef struct free_range { 226 avl_node_t fr_node; 227 uint64_t fr_blkid; 228 uint64_t fr_nblks; 229 } free_range_t; 230 231 dnode_t *dnode_special_open(struct objset *dd, dnode_phys_t *dnp, 232 uint64_t object); 233 void dnode_special_close(dnode_t *dn); 234 235 void dnode_setbonuslen(dnode_t *dn, int newsize, dmu_tx_t *tx); 236 void dnode_setbonus_type(dnode_t *dn, dmu_object_type_t, dmu_tx_t *tx); 237 void dnode_rm_spill(dnode_t *dn, dmu_tx_t *tx); 238 239 int dnode_hold(struct objset *dd, uint64_t object, 240 void *ref, dnode_t **dnp); 241 int dnode_hold_impl(struct objset *dd, uint64_t object, int flag, 242 void *ref, dnode_t **dnp); 243 boolean_t dnode_add_ref(dnode_t *dn, void *ref); 244 void dnode_rele(dnode_t *dn, void *ref); 245 void dnode_setdirty(dnode_t *dn, dmu_tx_t *tx); 246 void dnode_sync(dnode_t *dn, dmu_tx_t *tx); 247 void dnode_allocate(dnode_t *dn, dmu_object_type_t ot, int blocksize, int ibs, 248 dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *tx); 249 void dnode_reallocate(dnode_t *dn, dmu_object_type_t ot, int blocksize, 250 dmu_object_type_t bonustype, int bonuslen, dmu_tx_t *tx); 251 void dnode_free(dnode_t *dn, dmu_tx_t *tx); 252 void dnode_byteswap(dnode_phys_t *dnp); 253 void dnode_buf_byteswap(void *buf, size_t size); 254 void dnode_verify(dnode_t *dn); 255 int dnode_set_blksz(dnode_t *dn, uint64_t size, int ibs, dmu_tx_t *tx); 256 uint64_t dnode_current_max_length(dnode_t *dn); 257 void dnode_free_range(dnode_t *dn, uint64_t off, uint64_t len, dmu_tx_t *tx); 258 void dnode_clear_range(dnode_t *dn, uint64_t blkid, 259 uint64_t nblks, dmu_tx_t *tx); 260 void dnode_diduse_space(dnode_t *dn, int64_t space); 261 void dnode_willuse_space(dnode_t *dn, int64_t space, dmu_tx_t *tx); 262 void dnode_new_blkid(dnode_t *dn, uint64_t blkid, dmu_tx_t *tx, boolean_t); 263 uint64_t dnode_block_freed(dnode_t *dn, uint64_t blkid); 264 void dnode_init(void); 265 void dnode_fini(void); 266 int dnode_next_offset(dnode_t *dn, int flags, uint64_t *off, 267 int minlvl, uint64_t blkfill, uint64_t txg); 268 void dnode_evict_dbufs(dnode_t *dn); 269 270 #ifdef ZFS_DEBUG 271 272 /* 273 * There should be a ## between the string literal and fmt, to make it 274 * clear that we're joining two strings together, but that piece of shit 275 * gcc doesn't support that preprocessor token. 276 */ 277 #define dprintf_dnode(dn, fmt, ...) do { \ 278 if (zfs_flags & ZFS_DEBUG_DPRINTF) { \ 279 char __db_buf[32]; \ 280 uint64_t __db_obj = (dn)->dn_object; \ 281 if (__db_obj == DMU_META_DNODE_OBJECT) \ 282 (void) strcpy(__db_buf, "mdn"); \ 283 else \ 284 (void) snprintf(__db_buf, sizeof (__db_buf), "%lld", \ 285 (u_longlong_t)__db_obj);\ 286 dprintf_ds((dn)->dn_objset->os_dsl_dataset, "obj=%s " fmt, \ 287 __db_buf, __VA_ARGS__); \ 288 } \ 289 _NOTE(CONSTCOND) } while (0) 290 291 #define DNODE_VERIFY(dn) dnode_verify(dn) 292 #define FREE_VERIFY(db, start, end, tx) free_verify(db, start, end, tx) 293 294 #else 295 296 #define dprintf_dnode(db, fmt, ...) 297 #define DNODE_VERIFY(dn) 298 #define FREE_VERIFY(db, start, end, tx) 299 300 #endif 301 302 #ifdef __cplusplus 303 } 304 #endif 305 306 #endif /* _SYS_DNODE_H */ 307