1 /* 2 * Copyright (c) 2007 The DragonFly Project. All rights reserved. 3 * 4 * This code is derived from software contributed to The DragonFly Project 5 * by Matthew Dillon <dillon@backplane.com> 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * 3. Neither the name of The DragonFly Project nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific, prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * $DragonFly: src/sys/vfs/hammer/hammer_disk.h,v 1.55 2008/11/13 02:18:43 dillon Exp $ 35 */ 36 37 #ifndef VFS_HAMMER_DISK_H_ 38 #define VFS_HAMMER_DISK_H_ 39 40 #ifndef _SYS_UUID_H_ 41 #include <sys/uuid.h> 42 #endif 43 44 /* 45 * The structures below represent the on-disk format for a HAMMER 46 * filesystem. Note that all fields for on-disk structures are naturally 47 * aligned. The host endian format is used - compatibility is possible 48 * if the implementation detects reversed endian and adjusts data accordingly. 49 * 50 * Most of HAMMER revolves around the concept of an object identifier. An 51 * obj_id is a 64 bit quantity which uniquely identifies a filesystem object 52 * FOR THE ENTIRE LIFE OF THE FILESYSTEM. This uniqueness allows backups 53 * and mirrors to retain varying amounts of filesystem history by removing 54 * any possibility of conflict through identifier reuse. 55 * 56 * A HAMMER filesystem may span multiple volumes. 57 * 58 * A HAMMER filesystem uses a 16K filesystem buffer size. All filesystem 59 * I/O is done in multiples of 16K. Most buffer-sized headers such as those 60 * used by volumes, super-clusters, clusters, and basic filesystem buffers 61 * use fixed-sized A-lists which are heavily dependant on HAMMER_BUFSIZE. 62 * 63 * 64K X-bufs are used for blocks >= a file's 1MB mark. 64 * 65 * Per-volume storage limit: 52 bits 4096 TB 66 * Per-Zone storage limit: 59 bits 512 KTB (due to blockmap) 67 * Per-filesystem storage limit: 60 bits 1 MTB 68 */ 69 #define HAMMER_BUFSIZE 16384 70 #define HAMMER_XBUFSIZE 65536 71 #define HAMMER_XDEMARC (1024 * 1024) 72 #define HAMMER_BUFMASK (HAMMER_BUFSIZE - 1) 73 #define HAMMER_XBUFMASK (HAMMER_XBUFSIZE - 1) 74 #define HAMMER_BUFFER_BITS 14 75 76 #if (1 << HAMMER_BUFFER_BITS) != HAMMER_BUFSIZE 77 #error "HAMMER_BUFFER_BITS BROKEN" 78 #endif 79 80 #define HAMMER_BUFSIZE64 ((u_int64_t)HAMMER_BUFSIZE) 81 #define HAMMER_BUFMASK64 ((u_int64_t)HAMMER_BUFMASK) 82 83 #define HAMMER_XBUFSIZE64 ((u_int64_t)HAMMER_XBUFSIZE) 84 #define HAMMER_XBUFMASK64 ((u_int64_t)HAMMER_XBUFMASK) 85 86 #define HAMMER_OFF_ZONE_MASK 0xF000000000000000ULL /* zone portion */ 87 #define HAMMER_OFF_VOL_MASK 0x0FF0000000000000ULL /* volume portion */ 88 #define HAMMER_OFF_SHORT_MASK 0x000FFFFFFFFFFFFFULL /* offset portion */ 89 #define HAMMER_OFF_LONG_MASK 0x0FFFFFFFFFFFFFFFULL /* offset portion */ 90 #define HAMMER_OFF_SHORT_REC_MASK 0x000FFFFFFF000000ULL /* recovery boundary */ 91 #define HAMMER_OFF_LONG_REC_MASK 0x0FFFFFFFFF000000ULL /* recovery boundary */ 92 #define HAMMER_RECOVERY_BND 0x0000000001000000ULL 93 94 /* 95 * The current limit of volumes that can make up a HAMMER FS 96 */ 97 #define HAMMER_MAX_VOLUMES 256 98 99 /* 100 * Hammer transction ids are 64 bit unsigned integers and are usually 101 * synchronized with the time of day in nanoseconds. 102 * 103 * Hammer offsets are used for FIFO indexing and embed a cycle counter 104 * and volume number in addition to the offset. Most offsets are required 105 * to be 64-byte aligned. 106 */ 107 typedef u_int64_t hammer_tid_t; 108 typedef u_int64_t hammer_off_t; 109 typedef u_int32_t hammer_seq_t; 110 typedef u_int32_t hammer_crc_t; 111 112 #define HAMMER_MIN_TID 0ULL /* unsigned */ 113 #define HAMMER_MAX_TID 0xFFFFFFFFFFFFFFFFULL /* unsigned */ 114 #define HAMMER_MIN_KEY -0x8000000000000000LL /* signed */ 115 #define HAMMER_MAX_KEY 0x7FFFFFFFFFFFFFFFLL /* signed */ 116 #define HAMMER_MIN_OBJID HAMMER_MIN_KEY /* signed */ 117 #define HAMMER_MAX_OBJID HAMMER_MAX_KEY /* signed */ 118 #define HAMMER_MIN_RECTYPE 0x0U /* unsigned */ 119 #define HAMMER_MAX_RECTYPE 0xFFFFU /* unsigned */ 120 #define HAMMER_MIN_OFFSET 0ULL /* unsigned */ 121 #define HAMMER_MAX_OFFSET 0xFFFFFFFFFFFFFFFFULL /* unsigned */ 122 123 /* 124 * hammer_off_t has several different encodings. Note that not all zones 125 * encode a vol_no. 126 * 127 * zone 0: reserved for sanity 128 * zone 1 (z,v,o): raw volume relative (offset 0 is the volume header) 129 * zone 2 (z,v,o): raw buffer relative (offset 0 is the first buffer) 130 * zone 3 (z,o): undo fifo - actually fixed phys array in vol hdr 131 * zone 4 (z,v,o): freemap - only real blockmap 132 * zone 8 (z,v,o): B-Tree - actually zone-2 address 133 * zone 9 (z,v,o): Record - actually zone-2 address 134 * zone 10 (z,v,o): Large-data - actually zone-2 address 135 * zone 15: reserved for sanity 136 * 137 * layer1/layer2 direct map: 138 * zzzzvvvvvvvvoooo oooooooooooooooo oooooooooooooooo oooooooooooooooo 139 * ----111111111111 1111112222222222 222222222ooooooo oooooooooooooooo 140 */ 141 142 #define HAMMER_ZONE_RAW_VOLUME 0x1000000000000000ULL 143 #define HAMMER_ZONE_RAW_BUFFER 0x2000000000000000ULL 144 #define HAMMER_ZONE_UNDO 0x3000000000000000ULL 145 #define HAMMER_ZONE_FREEMAP 0x4000000000000000ULL 146 #define HAMMER_ZONE_RESERVED05 0x5000000000000000ULL 147 #define HAMMER_ZONE_RESERVED06 0x6000000000000000ULL 148 #define HAMMER_ZONE_RESERVED07 0x7000000000000000ULL 149 #define HAMMER_ZONE_BTREE 0x8000000000000000ULL 150 #define HAMMER_ZONE_META 0x9000000000000000ULL 151 #define HAMMER_ZONE_LARGE_DATA 0xA000000000000000ULL 152 #define HAMMER_ZONE_SMALL_DATA 0xB000000000000000ULL 153 #define HAMMER_ZONE_RESERVED0C 0xC000000000000000ULL 154 #define HAMMER_ZONE_RESERVED0D 0xD000000000000000ULL 155 #define HAMMER_ZONE_RESERVED0E 0xE000000000000000ULL 156 #define HAMMER_ZONE_UNAVAIL 0xF000000000000000ULL 157 158 #define HAMMER_ZONE_RAW_VOLUME_INDEX 1 159 #define HAMMER_ZONE_RAW_BUFFER_INDEX 2 160 #define HAMMER_ZONE_UNDO_INDEX 3 161 #define HAMMER_ZONE_FREEMAP_INDEX 4 162 #define HAMMER_ZONE_BTREE_INDEX 8 163 #define HAMMER_ZONE_META_INDEX 9 164 #define HAMMER_ZONE_LARGE_DATA_INDEX 10 165 #define HAMMER_ZONE_SMALL_DATA_INDEX 11 166 #define HAMMER_ZONE_UNAVAIL_INDEX 15 /* unavailable */ 167 168 #define HAMMER_MAX_ZONES 16 169 170 #define HAMMER_VOL_ENCODE(vol_no) \ 171 ((hammer_off_t)((vol_no) & 255) << 52) 172 #define HAMMER_VOL_DECODE(ham_off) \ 173 (int32_t)(((hammer_off_t)(ham_off) >> 52) & 255) 174 #define HAMMER_ZONE_DECODE(ham_off) \ 175 (int32_t)(((hammer_off_t)(ham_off) >> 60)) 176 #define HAMMER_ZONE_ENCODE(zone, ham_off) \ 177 (((hammer_off_t)(zone) << 60) | (ham_off)) 178 #define HAMMER_SHORT_OFF_ENCODE(offset) \ 179 ((hammer_off_t)(offset) & HAMMER_OFF_SHORT_MASK) 180 #define HAMMER_LONG_OFF_ENCODE(offset) \ 181 ((hammer_off_t)(offset) & HAMMER_OFF_LONG_MASK) 182 183 #define HAMMER_ENCODE_RAW_VOLUME(vol_no, offset) \ 184 (HAMMER_ZONE_RAW_VOLUME | \ 185 HAMMER_VOL_ENCODE(vol_no) | \ 186 HAMMER_SHORT_OFF_ENCODE(offset)) 187 188 #define HAMMER_ENCODE_RAW_BUFFER(vol_no, offset) \ 189 (HAMMER_ZONE_RAW_BUFFER | \ 190 HAMMER_VOL_ENCODE(vol_no) | \ 191 HAMMER_SHORT_OFF_ENCODE(offset)) 192 193 #define HAMMER_ENCODE_FREEMAP(vol_no, offset) \ 194 (HAMMER_ZONE_FREEMAP | \ 195 HAMMER_VOL_ENCODE(vol_no) | \ 196 HAMMER_SHORT_OFF_ENCODE(offset)) 197 198 /* 199 * Large-Block backing store 200 * 201 * A blockmap is a two-level map which translates a blockmap-backed zone 202 * offset into a raw zone 2 offset. Each layer handles 18 bits. The 8M 203 * large-block size is 23 bits so two layers gives us 23+18+18 = 59 bits 204 * of address space. 205 * 206 * When using hinting for a blockmap lookup, the hint is lost when the 207 * scan leaves the HINTBLOCK, which is typically several LARGEBLOCK's. 208 * HINTBLOCK is a heuristic. 209 */ 210 #define HAMMER_HINTBLOCK_SIZE (HAMMER_LARGEBLOCK_SIZE * 4) 211 #define HAMMER_HINTBLOCK_MASK64 ((u_int64_t)HAMMER_HINTBLOCK_SIZE - 1) 212 #define HAMMER_LARGEBLOCK_SIZE (8192 * 1024) 213 #define HAMMER_LARGEBLOCK_OVERFILL (6144 * 1024) 214 #define HAMMER_LARGEBLOCK_SIZE64 ((u_int64_t)HAMMER_LARGEBLOCK_SIZE) 215 #define HAMMER_LARGEBLOCK_MASK (HAMMER_LARGEBLOCK_SIZE - 1) 216 #define HAMMER_LARGEBLOCK_MASK64 ((u_int64_t)HAMMER_LARGEBLOCK_SIZE - 1) 217 #define HAMMER_LARGEBLOCK_BITS 23 218 #if (1 << HAMMER_LARGEBLOCK_BITS) != HAMMER_LARGEBLOCK_SIZE 219 #error "HAMMER_LARGEBLOCK_BITS BROKEN" 220 #endif 221 222 #define HAMMER_BUFFERS_PER_LARGEBLOCK \ 223 (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE) 224 #define HAMMER_BUFFERS_PER_LARGEBLOCK_MASK \ 225 (HAMMER_BUFFERS_PER_LARGEBLOCK - 1) 226 #define HAMMER_BUFFERS_PER_LARGEBLOCK_MASK64 \ 227 ((hammer_off_t)HAMMER_BUFFERS_PER_LARGEBLOCK_MASK) 228 229 /* 230 * Maximum number of mirrors operating in master mode (multi-master 231 * clustering and mirroring). 232 */ 233 #define HAMMER_MAX_MASTERS 16 234 235 /* 236 * The blockmap is somewhat of a degenerate structure. HAMMER only actually 237 * uses it in its original incarnation to implement the free-map. 238 * 239 * zone:1 raw volume (no blockmap) 240 * zone:2 raw buffer (no blockmap) 241 * zone:3 undo-map (direct layer2 array in volume header) 242 * zone:4 free-map (the only real blockmap) 243 * zone:8-15 zone id used to classify big-block only, address is actually 244 * a zone-2 address. 245 */ 246 struct hammer_blockmap { 247 hammer_off_t phys_offset; /* zone-2 physical offset */ 248 hammer_off_t first_offset; /* zone-X logical offset (zone 3) */ 249 hammer_off_t next_offset; /* zone-X logical offset */ 250 hammer_off_t alloc_offset; /* zone-X logical offset */ 251 u_int32_t reserved01; 252 hammer_crc_t entry_crc; 253 }; 254 255 typedef struct hammer_blockmap *hammer_blockmap_t; 256 257 #define HAMMER_BLOCKMAP_CRCSIZE \ 258 offsetof(struct hammer_blockmap, entry_crc) 259 260 /* 261 * The blockmap is a 2-layer entity made up of big-blocks. The first layer 262 * contains 262144 32-byte entries (18 bits), the second layer contains 263 * 524288 16-byte entries (19 bits), representing 8MB (23 bit) blockmaps. 264 * 18+19+23 = 60 bits. The top four bits are the zone id. 265 * 266 * Currently only the freemap utilizes both layers in all their glory. 267 * All primary data/meta-data zones actually encode a zone-2 address 268 * requiring no real blockmap translation. 269 * 270 * The freemap uses the upper 8 bits of layer-1 to identify the volume, 271 * thus any space allocated via the freemap can be directly translated 272 * to a zone:2 (or zone:8-15) address. 273 * 274 * zone-X blockmap offset: [z:4][layer1:18][layer2:19][bigblock:23] 275 */ 276 struct hammer_blockmap_layer1 { 277 hammer_off_t blocks_free; /* big-blocks free */ 278 hammer_off_t phys_offset; /* UNAVAIL or zone-2 */ 279 hammer_off_t reserved01; 280 hammer_crc_t layer2_crc; /* xor'd crc's of HAMMER_BLOCKSIZE */ 281 /* (not yet used) */ 282 hammer_crc_t layer1_crc; /* MUST BE LAST FIELD OF STRUCTURE*/ 283 }; 284 285 typedef struct hammer_blockmap_layer1 *hammer_blockmap_layer1_t; 286 287 #define HAMMER_LAYER1_CRCSIZE \ 288 offsetof(struct hammer_blockmap_layer1, layer1_crc) 289 290 struct hammer_blockmap_layer2 { 291 u_int8_t zone; /* typed allocation zone */ 292 u_int8_t unused01; 293 u_int16_t unused02; 294 u_int32_t append_off; /* allocatable space index */ 295 u_int32_t bytes_free; /* bytes free within this bigblock */ 296 hammer_crc_t entry_crc; 297 }; 298 299 typedef struct hammer_blockmap_layer2 *hammer_blockmap_layer2_t; 300 301 #define HAMMER_LAYER2_CRCSIZE \ 302 offsetof(struct hammer_blockmap_layer2, entry_crc) 303 304 #define HAMMER_BLOCKMAP_FREE 0ULL 305 #define HAMMER_BLOCKMAP_UNAVAIL ((hammer_off_t)-1LL) 306 307 #define HAMMER_BLOCKMAP_RADIX1 /* 262144 (18) */ \ 308 (HAMMER_LARGEBLOCK_SIZE / sizeof(struct hammer_blockmap_layer1)) 309 #define HAMMER_BLOCKMAP_RADIX2 /* 524288 (19) */ \ 310 (HAMMER_LARGEBLOCK_SIZE / sizeof(struct hammer_blockmap_layer2)) 311 312 #define HAMMER_BLOCKMAP_RADIX1_PERBUFFER \ 313 (HAMMER_BLOCKMAP_RADIX1 / (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE)) 314 #define HAMMER_BLOCKMAP_RADIX2_PERBUFFER \ 315 (HAMMER_BLOCKMAP_RADIX2 / (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE)) 316 317 #define HAMMER_BLOCKMAP_LAYER1 /* 18+19+23 */ \ 318 (HAMMER_BLOCKMAP_RADIX1 * HAMMER_BLOCKMAP_LAYER2) 319 #define HAMMER_BLOCKMAP_LAYER2 /* 19+23 - 4TB */ \ 320 (HAMMER_BLOCKMAP_RADIX2 * HAMMER_LARGEBLOCK_SIZE64) 321 322 #define HAMMER_BLOCKMAP_LAYER1_MASK (HAMMER_BLOCKMAP_LAYER1 - 1) 323 #define HAMMER_BLOCKMAP_LAYER2_MASK (HAMMER_BLOCKMAP_LAYER2 - 1) 324 325 /* 326 * byte offset within layer1 or layer2 big-block for the entry representing 327 * a zone-2 physical offset. 328 */ 329 #define HAMMER_BLOCKMAP_LAYER1_OFFSET(zone2_offset) \ 330 (((zone2_offset) & HAMMER_BLOCKMAP_LAYER1_MASK) / \ 331 HAMMER_BLOCKMAP_LAYER2 * sizeof(struct hammer_blockmap_layer1)) 332 333 #define HAMMER_BLOCKMAP_LAYER2_OFFSET(zone2_offset) \ 334 (((zone2_offset) & HAMMER_BLOCKMAP_LAYER2_MASK) / \ 335 HAMMER_LARGEBLOCK_SIZE64 * sizeof(struct hammer_blockmap_layer2)) 336 337 /* 338 * HAMMER UNDO parameters. The UNDO fifo is mapped directly in the volume 339 * header with an array of layer2 structures. A maximum of (128x8MB) = 1GB 340 * may be reserved. The size of the undo fifo is usually set a newfs time 341 * but can be adjusted if the filesystem is taken offline. 342 */ 343 344 #define HAMMER_UNDO_LAYER2 128 /* max layer2 undo mapping entries */ 345 346 /* 347 * All on-disk HAMMER structures which make up elements of the UNDO FIFO 348 * contain a hammer_fifo_head and hammer_fifo_tail structure. This structure 349 * contains all the information required to validate the fifo element 350 * and to scan the fifo in either direction. The head is typically embedded 351 * in higher level hammer on-disk structures while the tail is typically 352 * out-of-band. hdr_size is the size of the whole mess, including the tail. 353 * 354 * All undo structures are guaranteed to not cross a 16K filesystem 355 * buffer boundary. Most undo structures are fairly small. Data spaces 356 * are not immediately reused by HAMMER so file data is not usually recorded 357 * as part of an UNDO. 358 * 359 * PAD elements are allowed to take up only 8 bytes of space as a special 360 * case, containing only hdr_signature, hdr_type, and hdr_size fields, 361 * and with the tail overloaded onto the head structure for 8 bytes total. 362 * 363 * Every undo record has a sequence number. This number is unrelated to 364 * transaction ids and instead collects the undo transactions associated 365 * with a single atomic operation. A larger transactional operation, such 366 * as a remove(), may consist of several smaller atomic operations 367 * representing raw meta-data operations. 368 */ 369 #define HAMMER_HEAD_ONDISK_SIZE 32 370 #define HAMMER_HEAD_ALIGN 8 371 #define HAMMER_HEAD_ALIGN_MASK (HAMMER_HEAD_ALIGN - 1) 372 #define HAMMER_TAIL_ONDISK_SIZE 8 373 #define HAMMER_HEAD_DOALIGN(bytes) \ 374 (((bytes) + HAMMER_HEAD_ALIGN_MASK) & ~HAMMER_HEAD_ALIGN_MASK) 375 376 struct hammer_fifo_head { 377 u_int16_t hdr_signature; 378 u_int16_t hdr_type; 379 u_int32_t hdr_size; /* aligned size of the whole mess */ 380 u_int32_t reserved01; /* (0) reserved for future use */ 381 hammer_crc_t hdr_crc; /* XOR crc up to field w/ crc after field */ 382 }; 383 384 #define HAMMER_FIFO_HEAD_CRCOFF offsetof(struct hammer_fifo_head, hdr_crc) 385 386 struct hammer_fifo_tail { 387 u_int16_t tail_signature; 388 u_int16_t tail_type; 389 u_int32_t tail_size; /* aligned size of the whole mess */ 390 }; 391 392 typedef struct hammer_fifo_head *hammer_fifo_head_t; 393 typedef struct hammer_fifo_tail *hammer_fifo_tail_t; 394 395 /* 396 * Fifo header types. 397 */ 398 #define HAMMER_HEAD_TYPE_PAD (0x0040U|HAMMER_HEAD_FLAG_FREE) 399 #define HAMMER_HEAD_TYPE_VOL 0x0041U /* Volume (dummy header) */ 400 #define HAMMER_HEAD_TYPE_BTREE 0x0042U /* B-Tree node */ 401 #define HAMMER_HEAD_TYPE_UNDO 0x0043U /* random UNDO information */ 402 #define HAMMER_HEAD_TYPE_DELETE 0x0044U /* record deletion */ 403 #define HAMMER_HEAD_TYPE_RECORD 0x0045U /* Filesystem record */ 404 405 #define HAMMER_HEAD_FLAG_FREE 0x8000U /* Indicates object freed */ 406 407 #define HAMMER_HEAD_SIGNATURE 0xC84EU 408 #define HAMMER_TAIL_SIGNATURE 0xC74FU 409 410 #define HAMMER_HEAD_SEQ_BEG 0x80000000U 411 #define HAMMER_HEAD_SEQ_END 0x40000000U 412 #define HAMMER_HEAD_SEQ_MASK 0x3FFFFFFFU 413 414 /* 415 * Misc FIFO structures. 416 */ 417 struct hammer_fifo_undo { 418 struct hammer_fifo_head head; 419 hammer_off_t undo_offset; /* zone-1 offset */ 420 int32_t undo_data_bytes; 421 int32_t undo_reserved01; 422 /* followed by data */ 423 }; 424 425 typedef struct hammer_fifo_undo *hammer_fifo_undo_t; 426 427 struct hammer_fifo_buf_commit { 428 hammer_off_t undo_offset; 429 }; 430 431 /* 432 * Volume header types 433 */ 434 #define HAMMER_FSBUF_VOLUME 0xC8414D4DC5523031ULL /* HAMMER01 */ 435 #define HAMMER_FSBUF_VOLUME_REV 0x313052C54D4D41C8ULL /* (reverse endian) */ 436 437 /* 438 * The B-Tree structures need hammer_fsbuf_head. 439 */ 440 #include "hammer_btree.h" 441 442 /* 443 * HAMMER Volume header 444 * 445 * A HAMMER filesystem is built from any number of block devices, Each block 446 * device contains a volume header followed by however many buffers fit 447 * into the volume. 448 * 449 * One of the volumes making up a HAMMER filesystem is the master, the 450 * rest are slaves. It does not have to be volume #0. 451 * 452 * The volume header takes up an entire 16K filesystem buffer and may 453 * represent up to 64KTB (65536 TB) of space. 454 * 455 * Special field notes: 456 * 457 * vol_bot_beg - offset of boot area (mem_beg - bot_beg bytes) 458 * vol_mem_beg - offset of memory log (clu_beg - mem_beg bytes) 459 * vol_buf_beg - offset of the first buffer. 460 * 461 * The memory log area allows a kernel to cache new records and data 462 * in memory without allocating space in the actual filesystem to hold 463 * the records and data. In the event that a filesystem becomes full, 464 * any records remaining in memory can be flushed to the memory log 465 * area. This allows the kernel to immediately return success. 466 */ 467 468 #define HAMMER_BOOT_MINBYTES (32*1024) 469 #define HAMMER_BOOT_NOMBYTES (64LL*1024*1024) 470 #define HAMMER_BOOT_MAXBYTES (256LL*1024*1024) 471 472 #define HAMMER_MEM_MINBYTES (256*1024) 473 #define HAMMER_MEM_NOMBYTES (1LL*1024*1024*1024) 474 #define HAMMER_MEM_MAXBYTES (64LL*1024*1024*1024) 475 476 struct hammer_volume_ondisk { 477 u_int64_t vol_signature;/* Signature */ 478 479 int64_t vol_bot_beg; /* byte offset of boot area or 0 */ 480 int64_t vol_mem_beg; /* byte offset of memory log or 0 */ 481 int64_t vol_buf_beg; /* byte offset of first buffer in volume */ 482 int64_t vol_buf_end; /* byte offset of volume EOF (on buf bndry) */ 483 int64_t vol_locked; /* reserved clusters are >= this offset */ 484 485 uuid_t vol_fsid; /* identify filesystem */ 486 uuid_t vol_fstype; /* identify filesystem type */ 487 char vol_name[64]; /* Name of volume */ 488 489 int32_t vol_no; /* volume number within filesystem */ 490 int32_t vol_count; /* number of volumes making up FS */ 491 492 u_int32_t vol_version; /* version control information */ 493 hammer_crc_t vol_crc; /* header crc */ 494 u_int32_t vol_flags; /* volume flags */ 495 u_int32_t vol_rootvol; /* which volume is the root volume? */ 496 497 int32_t vol_reserved04; 498 int32_t vol_reserved05; 499 u_int32_t vol_reserved06; 500 u_int32_t vol_reserved07; 501 502 int32_t vol_blocksize; /* for statfs only */ 503 int32_t vol_reserved08; 504 int64_t vol_nblocks; /* total allocatable hammer bufs */ 505 506 /* 507 * These fields are initialized and space is reserved in every 508 * volume making up a HAMMER filesytem, but only the master volume 509 * contains valid data. 510 */ 511 int64_t vol0_stat_bigblocks; /* total bigblocks when fs is empty */ 512 int64_t vol0_stat_freebigblocks;/* number of free bigblocks */ 513 int64_t vol0_stat_bytes; /* for statfs only */ 514 int64_t vol0_stat_inodes; /* for statfs only */ 515 int64_t vol0_stat_records; /* total records in filesystem */ 516 hammer_off_t vol0_btree_root; /* B-Tree root */ 517 hammer_tid_t vol0_next_tid; /* highest partially synchronized TID */ 518 hammer_off_t vol0_unused03; 519 520 /* 521 * Blockmaps for zones. Not all zones use a blockmap. Note that 522 * the entire root blockmap is cached in the hammer_mount structure. 523 */ 524 struct hammer_blockmap vol0_blockmap[HAMMER_MAX_ZONES]; 525 526 /* 527 * Array of zone-2 addresses for undo FIFO. 528 */ 529 hammer_off_t vol0_undo_array[HAMMER_UNDO_LAYER2]; 530 531 }; 532 533 typedef struct hammer_volume_ondisk *hammer_volume_ondisk_t; 534 535 #define HAMMER_VOLF_VALID 0x0001 /* valid entry */ 536 #define HAMMER_VOLF_OPEN 0x0002 /* volume is open */ 537 #define HAMMER_VOLF_NEEDFLUSH 0x0004 /* volume needs flush */ 538 539 #define HAMMER_VOL_CRCSIZE1 \ 540 offsetof(struct hammer_volume_ondisk, vol_crc) 541 #define HAMMER_VOL_CRCSIZE2 \ 542 (sizeof(struct hammer_volume_ondisk) - HAMMER_VOL_CRCSIZE1 - \ 543 sizeof(hammer_crc_t)) 544 545 #define HAMMER_VOL_VERSION_MIN 1 /* minimum supported version */ 546 #define HAMMER_VOL_VERSION_DEFAULT 1 /* newfs default version */ 547 #define HAMMER_VOL_VERSION_WIP 3 /* version >= this is WIP */ 548 #define HAMMER_VOL_VERSION_MAX 2 /* maximum supported version */ 549 550 #define HAMMER_VOL_VERSION_ONE 1 551 #define HAMMER_VOL_VERSION_TWO 2 /* new dirent layout (2.3+) */ 552 /* 553 * Record types are fairly straightforward. The B-Tree includes the record 554 * type in its index sort. 555 */ 556 #define HAMMER_RECTYPE_UNKNOWN 0 557 #define HAMMER_RECTYPE_LOWEST 1 /* lowest record type avail */ 558 #define HAMMER_RECTYPE_INODE 1 /* inode in obj_id space */ 559 #define HAMMER_RECTYPE_UNUSED02 2 560 #define HAMMER_RECTYPE_UNUSED03 3 561 #define HAMMER_RECTYPE_DATA 0x0010 562 #define HAMMER_RECTYPE_DIRENTRY 0x0011 563 #define HAMMER_RECTYPE_DB 0x0012 564 #define HAMMER_RECTYPE_EXT 0x0013 /* ext attributes */ 565 #define HAMMER_RECTYPE_FIX 0x0014 /* fixed attribute */ 566 #define HAMMER_RECTYPE_PFS 0x0015 /* PFS management */ 567 #define HAMMER_RECTYPE_MOVED 0x8000 /* special recovery flag */ 568 #define HAMMER_RECTYPE_MAX 0xFFFF 569 570 #define HAMMER_RECTYPE_CLEAN_START HAMMER_RECTYPE_EXT 571 572 #define HAMMER_FIXKEY_SYMLINK 1 573 574 #define HAMMER_OBJTYPE_UNKNOWN 0 /* (never exists on-disk) */ 575 #define HAMMER_OBJTYPE_DIRECTORY 1 576 #define HAMMER_OBJTYPE_REGFILE 2 577 #define HAMMER_OBJTYPE_DBFILE 3 578 #define HAMMER_OBJTYPE_FIFO 4 579 #define HAMMER_OBJTYPE_CDEV 5 580 #define HAMMER_OBJTYPE_BDEV 6 581 #define HAMMER_OBJTYPE_SOFTLINK 7 582 #define HAMMER_OBJTYPE_PSEUDOFS 8 /* pseudo filesystem obj */ 583 #define HAMMER_OBJTYPE_SOCKET 9 584 585 /* 586 * HAMMER inode attribute data 587 * 588 * The data reference for a HAMMER inode points to this structure. Any 589 * modifications to the contents of this structure will result in a 590 * replacement operation. 591 * 592 * parent_obj_id is only valid for directories (which cannot be hard-linked), 593 * and specifies the parent directory obj_id. This field will also be set 594 * for non-directory inodes as a recovery aid, but can wind up holding 595 * stale information. However, since object id's are not reused, the worse 596 * that happens is that the recovery code is unable to use it. 597 * 598 * NOTE: Future note on directory hardlinks. We can implement a record type 599 * which allows us to point to multiple parent directories. 600 * 601 * NOTE: atime is stored in the inode's B-Tree element and not in the inode 602 * data. This allows the atime to be updated without having to lay down a 603 * new record. 604 */ 605 struct hammer_inode_data { 606 u_int16_t version; /* inode data version */ 607 u_int16_t mode; /* basic unix permissions */ 608 u_int32_t uflags; /* chflags */ 609 u_int32_t rmajor; /* used by device nodes */ 610 u_int32_t rminor; /* used by device nodes */ 611 u_int64_t ctime; 612 int64_t parent_obj_id; /* parent directory obj_id */ 613 uuid_t uid; 614 uuid_t gid; 615 616 u_int8_t obj_type; 617 u_int8_t cap_flags; /* capability support flags (extension) */ 618 u_int16_t reserved02; 619 u_int32_t reserved03; /* RESERVED FOR POSSIBLE FUTURE BIRTHTIME */ 620 u_int64_t nlinks; /* hard links */ 621 u_int64_t size; /* filesystem object size */ 622 union { 623 struct { 624 char reserved06[16]; 625 u_int32_t parent_obj_localization; 626 u_int32_t integrity_crc; 627 } obj; 628 char symlink[24]; /* HAMMER_INODE_BASESYMLEN */ 629 } ext; 630 u_int64_t mtime; /* mtime must be second-to-last */ 631 u_int64_t atime; /* atime must be last */ 632 }; 633 634 /* 635 * Neither mtime nor atime upates are CRCd by the B-Tree element. 636 * mtime updates have UNDO, atime updates do not. 637 */ 638 #define HAMMER_ITIMES_BASE(ino_data) (&(ino_data)->mtime) 639 #define HAMMER_ITIMES_BYTES (sizeof(u_int64_t) * 2) 640 641 #define HAMMER_INODE_CRCSIZE \ 642 offsetof(struct hammer_inode_data, mtime) 643 644 #define HAMMER_INODE_DATA_VERSION 1 645 #define HAMMER_OBJID_ROOT 1 646 #define HAMMER_INODE_BASESYMLEN 24 /* see ext.symlink */ 647 648 /* 649 * Capability & implementation flags. 650 * 651 * DIR_LOCAL_INO - Use inode B-Tree localization for directory entries. 652 */ 653 #define HAMMER_INODE_CAP_DIRHASH_MASK 0x03 /* directory: hash algorithm */ 654 #define HAMMER_INODE_CAP_DIRHASH_ALG0 0x00 655 #define HAMMER_INODE_CAP_DIRHASH_ALG1 0x01 656 #define HAMMER_INODE_CAP_DIRHASH_ALG2 0x02 657 #define HAMMER_INODE_CAP_DIRHASH_ALG3 0x03 658 #define HAMMER_INODE_CAP_DIR_LOCAL_INO 0x04 /* use inode localization */ 659 660 /* 661 * A HAMMER directory entry associates a HAMMER filesystem object with a 662 * namespace. It is possible to hook into a pseudo-filesystem (with its 663 * own inode numbering space) in the filesystem by setting the high 664 * 16 bits of the localization field. The low 16 bits must be 0 and 665 * are reserved for future use. 666 * 667 * Directory entries are indexed with a 128 bit namekey rather then an 668 * offset. A portion of the namekey is an iterator/randomizer to deal 669 * with collisions. 670 * 671 * NOTE: base.base.obj_type from the related B-Tree leaf entry holds 672 * the filesystem object type of obj_id, e.g. a den_type equivalent. 673 * It is not stored in hammer_entry_data. 674 * 675 * NOTE: den_name / the filename data reference is NOT terminated with \0. 676 */ 677 struct hammer_entry_data { 678 int64_t obj_id; /* object being referenced */ 679 u_int32_t localization; /* identify pseudo-filesystem */ 680 u_int32_t reserved02; 681 char name[16]; /* name (extended) */ 682 }; 683 684 #define HAMMER_ENTRY_NAME_OFF offsetof(struct hammer_entry_data, name[0]) 685 #define HAMMER_ENTRY_SIZE(nlen) offsetof(struct hammer_entry_data, name[nlen]) 686 687 /* 688 * Symlink data which does not fit in the inode is stored in a separte 689 * FIX type record. 690 */ 691 struct hammer_symlink_data { 692 char name[16]; 693 }; 694 695 #define HAMMER_SYMLINK_NAME_OFF offsetof(struct hammer_symlink_data, name[0]) 696 697 /* 698 * The root inode for the primary filesystem and root inode for any 699 * pseudo-fs may be tagged with an optional data structure using 700 * HAMMER_RECTYPE_FIX/HAMMER_FIXKEY_PSEUDOFS. This structure allows 701 * the node to be used as a mirroring master or slave. 702 * 703 * When operating as a slave CD's into the node automatically become read-only 704 * and as-of sync_end_tid. 705 * 706 * When operating as a master the read PFSD info sets sync_end_tid to 707 * the most recently flushed TID. 708 * 709 * sync_low_tid is not yet used but will represent the highest pruning 710 * end-point, after which full history is available. 711 */ 712 struct hammer_pseudofs_data { 713 hammer_tid_t sync_low_tid; /* full history beyond this point */ 714 hammer_tid_t sync_beg_tid; /* earliest tid w/ full history avail */ 715 hammer_tid_t sync_end_tid; /* current synchronizatoin point */ 716 u_int64_t sync_beg_ts; /* real-time of last completed sync */ 717 u_int64_t sync_end_ts; /* initiation of current sync cycle */ 718 uuid_t shared_uuid; /* shared uuid (match required) */ 719 uuid_t unique_uuid; /* unique uuid of this master/slave */ 720 int32_t reserved01; /* reserved for future master_id */ 721 int32_t mirror_flags; /* misc flags */ 722 char label[64]; /* filesystem space label */ 723 char snapshots[64]; /* softlink dir for pruning */ 724 int16_t prune_time; /* how long to spend pruning */ 725 int16_t prune_freq; /* how often we prune */ 726 int16_t reblock_time; /* how long to spend reblocking */ 727 int16_t reblock_freq; /* how often we reblock */ 728 int32_t snapshot_freq; /* how often we create a snapshot */ 729 int32_t prune_min; /* do not prune recent history */ 730 int32_t prune_max; /* do not retain history beyond here */ 731 int32_t reserved[16]; 732 }; 733 734 typedef struct hammer_pseudofs_data *hammer_pseudofs_data_t; 735 736 #define HAMMER_PFSD_SLAVE 0x00000001 737 #define HAMMER_PFSD_DELETED 0x80000000 738 739 /* 740 * Rollup various structures embedded as record data 741 */ 742 union hammer_data_ondisk { 743 struct hammer_entry_data entry; 744 struct hammer_inode_data inode; 745 struct hammer_symlink_data symlink; 746 struct hammer_pseudofs_data pfsd; 747 }; 748 749 typedef union hammer_data_ondisk *hammer_data_ondisk_t; 750 751 #endif 752