2 * Copyright (c) 2007 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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
34 * $DragonFly: src/sys/vfs/hammer/hammer_disk.h,v 1.55 2008/11/13 02:18:43 dillon Exp $
37 #ifndef VFS_HAMMER_DISK_H_
38 #define VFS_HAMMER_DISK_H_
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.
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.
56 * A HAMMER filesystem may span multiple volumes.
58 * A HAMMER filesystem uses a 16K filesystem buffer size. All filesystem
59 * I/O is done in multiples of 16K.
61 * 64K X-bufs are used for blocks >= a file's 1MB mark.
63 * Per-volume storage limit: 52 bits 4096 TB
64 * Per-Zone storage limit: 60 bits 1 MTB
65 * Per-filesystem storage limit: 60 bits 1 MTB
67 #define HAMMER_BUFSIZE 16384
68 #define HAMMER_XBUFSIZE 65536
69 #define HAMMER_HBUFSIZE (HAMMER_BUFSIZE / 2)
70 #define HAMMER_XDEMARC (1024 * 1024)
71 #define HAMMER_BUFMASK (HAMMER_BUFSIZE - 1)
72 #define HAMMER_XBUFMASK (HAMMER_XBUFSIZE - 1)
74 #define HAMMER_BUFSIZE64 ((uint64_t)HAMMER_BUFSIZE)
75 #define HAMMER_BUFMASK64 ((uint64_t)HAMMER_BUFMASK)
77 #define HAMMER_XBUFSIZE64 ((uint64_t)HAMMER_XBUFSIZE)
78 #define HAMMER_XBUFMASK64 ((uint64_t)HAMMER_XBUFMASK)
80 #define HAMMER_OFF_ZONE_MASK 0xF000000000000000ULL /* zone portion */
81 #define HAMMER_OFF_VOL_MASK 0x0FF0000000000000ULL /* volume portion */
82 #define HAMMER_OFF_SHORT_MASK 0x000FFFFFFFFFFFFFULL /* offset portion */
83 #define HAMMER_OFF_LONG_MASK 0x0FFFFFFFFFFFFFFFULL /* offset portion */
85 #define HAMMER_OFF_BAD ((hammer_off_t)-1)
88 * The current limit of volumes that can make up a HAMMER FS
90 #define HAMMER_MAX_VOLUMES 256
93 * Hammer transaction ids are 64 bit unsigned integers and are usually
94 * synchronized with the time of day in nanoseconds.
96 * Hammer offsets are used for FIFO indexing and embed a cycle counter
97 * and volume number in addition to the offset. Most offsets are required
98 * to be 16 KB aligned.
100 typedef uint64_t hammer_tid_t;
101 typedef uint64_t hammer_off_t;
102 typedef uint32_t hammer_crc_t;
104 #define HAMMER_MIN_TID 0ULL /* unsigned */
105 #define HAMMER_MAX_TID 0xFFFFFFFFFFFFFFFFULL /* unsigned */
106 #define HAMMER_MIN_KEY -0x8000000000000000LL /* signed */
107 #define HAMMER_MAX_KEY 0x7FFFFFFFFFFFFFFFLL /* signed */
108 #define HAMMER_MIN_OBJID HAMMER_MIN_KEY /* signed */
109 #define HAMMER_MAX_OBJID HAMMER_MAX_KEY /* signed */
110 #define HAMMER_MIN_RECTYPE 0x0U /* unsigned */
111 #define HAMMER_MAX_RECTYPE 0xFFFFU /* unsigned */
112 #define HAMMER_MIN_OFFSET 0ULL /* unsigned */
113 #define HAMMER_MAX_OFFSET 0xFFFFFFFFFFFFFFFFULL /* unsigned */
116 * hammer_off_t has several different encodings. Note that not all zones
117 * encode a vol_no. Zone bits are not a part of filesystem capacity.
119 * zone 0: available, a big-block that contains the offset is unused
120 * zone 1 (z,v,o): raw volume relative (offset 0 is the volume header)
121 * zone 2 (z,v,o): raw buffer relative (offset 0 is the first buffer)
122 * zone 3 (z,o): undo fifo - actually zone-2 address, fixed phys array in vol hdr
123 * zone 4 (z,v,o): freemap - only real blockmap
124 * zone 8 (z,v,o): B-Tree - actually zone-2 address
125 * zone 9 (z,v,o): meta - actually zone-2 address
126 * zone 10 (z,v,o): large-data - actually zone-2 address
127 * zone 11 (z,v,o): small-data - actually zone-2 address
128 * zone 15: unavailable, usually the offset is beyond volume size
130 * layer1/layer2 direct map:
131 * zzzzvvvvvvvvoooo oooooooooooooooo oooooooooooooooo oooooooooooooooo
132 * ----111111111111 1111112222222222 222222222ooooooo oooooooooooooooo
133 * <-----------------><------------------><---------------------->
134 * 18bits 19bits 23bits
135 * <------------------------------------------------------------->
136 * Maximum HAMMER filesystem capacity
137 * 2^18(layer1) * 2^19(layer2) * 2^23(big-block) = 2^60 = 1EB
140 #define HAMMER_ZONE_RAW_VOLUME 0x1000000000000000ULL
141 #define HAMMER_ZONE_RAW_BUFFER 0x2000000000000000ULL
142 #define HAMMER_ZONE_UNDO 0x3000000000000000ULL
143 #define HAMMER_ZONE_FREEMAP 0x4000000000000000ULL
144 #define HAMMER_ZONE_RESERVED05 0x5000000000000000ULL /* not used */
145 #define HAMMER_ZONE_RESERVED06 0x6000000000000000ULL /* not used */
146 #define HAMMER_ZONE_RESERVED07 0x7000000000000000ULL /* not used */
147 #define HAMMER_ZONE_BTREE 0x8000000000000000ULL
148 #define HAMMER_ZONE_META 0x9000000000000000ULL
149 #define HAMMER_ZONE_LARGE_DATA 0xA000000000000000ULL
150 #define HAMMER_ZONE_SMALL_DATA 0xB000000000000000ULL
151 #define HAMMER_ZONE_RESERVED0C 0xC000000000000000ULL /* not used */
152 #define HAMMER_ZONE_RESERVED0D 0xD000000000000000ULL /* not used */
153 #define HAMMER_ZONE_RESERVED0E 0xE000000000000000ULL /* not used */
154 #define HAMMER_ZONE_UNAVAIL 0xF000000000000000ULL
156 #define HAMMER_ZONE_RAW_VOLUME_INDEX 1
157 #define HAMMER_ZONE_RAW_BUFFER_INDEX 2
158 #define HAMMER_ZONE_UNDO_INDEX 3
159 #define HAMMER_ZONE_FREEMAP_INDEX 4
160 #define HAMMER_ZONE_BTREE_INDEX 8
161 #define HAMMER_ZONE_META_INDEX 9
162 #define HAMMER_ZONE_LARGE_DATA_INDEX 10
163 #define HAMMER_ZONE_SMALL_DATA_INDEX 11
164 #define HAMMER_ZONE_UNAVAIL_INDEX 15
166 #define HAMMER_MAX_ZONES 16
169 * Backend zones that are mapped to zone-2 (except for zone-3)
170 * starts from this index which is 8.
172 #define HAMMER_ZONE2_MAPPED_INDEX HAMMER_ZONE_BTREE_INDEX
174 #define HAMMER_ZONE_ENCODE(zone, ham_off) \
175 (((hammer_off_t)(zone) << 60) | (ham_off))
176 #define HAMMER_ZONE_DECODE(ham_off) \
177 (int32_t)(((hammer_off_t)(ham_off) >> 60))
179 #define HAMMER_VOL_ENCODE(vol_no) \
180 ((hammer_off_t)((vol_no) & 255) << 52)
181 #define HAMMER_VOL_DECODE(ham_off) \
182 (int32_t)(((hammer_off_t)(ham_off) >> 52) & 255)
184 #define HAMMER_OFF_SHORT_ENCODE(offset) \
185 ((hammer_off_t)(offset) & HAMMER_OFF_SHORT_MASK)
186 #define HAMMER_OFF_LONG_ENCODE(offset) \
187 ((hammer_off_t)(offset) & HAMMER_OFF_LONG_MASK)
189 #define HAMMER_ENCODE(zone, vol_no, offset) \
190 (((hammer_off_t)(zone) << 60) | \
191 HAMMER_VOL_ENCODE(vol_no) | \
192 HAMMER_OFF_SHORT_ENCODE(offset))
193 #define HAMMER_ENCODE_RAW_VOLUME(vol_no, offset) \
194 HAMMER_ENCODE(HAMMER_ZONE_RAW_VOLUME_INDEX, vol_no, offset)
195 #define HAMMER_ENCODE_RAW_BUFFER(vol_no, offset) \
196 HAMMER_ENCODE(HAMMER_ZONE_RAW_BUFFER_INDEX, vol_no, offset)
197 #define HAMMER_ENCODE_FREEMAP(vol_no, offset) \
198 HAMMER_ENCODE(HAMMER_ZONE_FREEMAP_INDEX, vol_no, offset)
201 * Translate a zone address to zone-X address.
203 #define hammer_xlate_to_zoneX(zone, offset) \
204 HAMMER_ZONE_ENCODE((zone), (offset) & ~HAMMER_OFF_ZONE_MASK)
205 #define hammer_xlate_to_zone2(offset) \
206 hammer_xlate_to_zoneX(HAMMER_ZONE_RAW_BUFFER_INDEX, (offset))
208 #define hammer_data_zone(data_len) \
209 (((data_len) >= HAMMER_BUFSIZE) ? \
210 HAMMER_ZONE_LARGE_DATA : \
211 HAMMER_ZONE_SMALL_DATA)
212 #define hammer_data_zone_index(data_len) \
213 (((data_len) >= HAMMER_BUFSIZE) ? \
214 HAMMER_ZONE_LARGE_DATA_INDEX : \
215 HAMMER_ZONE_SMALL_DATA_INDEX)
218 * Big-Block backing store
220 * A blockmap is a two-level map which translates a blockmap-backed zone
221 * offset into a raw zone 2 offset. The layer 1 handles 18 bits and the
222 * layer 2 handles 19 bits. The 8M big-block size is 23 bits so two
223 * layers gives us 18+19+23 = 60 bits of address space.
225 * When using hinting for a blockmap lookup, the hint is lost when the
226 * scan leaves the HINTBLOCK, which is typically several BIGBLOCK's.
227 * HINTBLOCK is a heuristic.
229 #define HAMMER_HINTBLOCK_SIZE (HAMMER_BIGBLOCK_SIZE * 4)
230 #define HAMMER_HINTBLOCK_MASK64 ((uint64_t)HAMMER_HINTBLOCK_SIZE - 1)
231 #define HAMMER_BIGBLOCK_SIZE (8192 * 1024)
232 #define HAMMER_BIGBLOCK_SIZE64 ((uint64_t)HAMMER_BIGBLOCK_SIZE)
233 #define HAMMER_BIGBLOCK_MASK (HAMMER_BIGBLOCK_SIZE - 1)
234 #define HAMMER_BIGBLOCK_MASK64 ((uint64_t)HAMMER_BIGBLOCK_SIZE - 1)
235 #define HAMMER_BIGBLOCK_BITS 23
237 #define HAMMER_BIGBLOCK_OVERFILL (6144 * 1024)
239 #if (1 << HAMMER_BIGBLOCK_BITS) != HAMMER_BIGBLOCK_SIZE
240 #error "HAMMER_BIGBLOCK_BITS BROKEN"
243 #define HAMMER_BUFFERS_PER_BIGBLOCK \
244 (HAMMER_BIGBLOCK_SIZE / HAMMER_BUFSIZE)
245 #define HAMMER_BUFFERS_PER_BIGBLOCK_MASK \
246 (HAMMER_BUFFERS_PER_BIGBLOCK - 1)
247 #define HAMMER_BUFFERS_PER_BIGBLOCK_MASK64 \
248 ((hammer_off_t)HAMMER_BUFFERS_PER_BIGBLOCK_MASK)
251 * Maximum number of mirrors operating in master mode (multi-master
252 * clustering and mirroring). Note that HAMMER1 does not support
253 * multi-master clustering as of 2015.
255 #define HAMMER_MAX_MASTERS 16
258 * The blockmap is somewhat of a degenerate structure. HAMMER only actually
259 * uses it in its original incarnation to implement the freemap.
261 * zone:1 raw volume (no blockmap)
262 * zone:2 raw buffer (no blockmap)
263 * zone:3 undomap (direct layer2 array in volume header)
264 * zone:4 freemap (the only real blockmap)
265 * zone:8-15 zone id used to classify big-block only, address is actually
268 struct hammer_blockmap {
269 hammer_off_t phys_offset; /* zone-2 physical offset */
270 hammer_off_t first_offset; /* zone-X logical offset (zone 3) */
271 hammer_off_t next_offset; /* zone-X logical offset */
272 hammer_off_t alloc_offset; /* zone-X logical offset */
274 hammer_crc_t entry_crc;
277 typedef struct hammer_blockmap *hammer_blockmap_t;
279 #define HAMMER_BLOCKMAP_CRCSIZE \
280 offsetof(struct hammer_blockmap, entry_crc)
283 * The blockmap is a 2-layer entity made up of big-blocks. The first layer
284 * contains 262144 32-byte entries (18 bits), the second layer contains
285 * 524288 16-byte entries (19 bits), representing 8MB (23 bit) blockmaps.
286 * 18+19+23 = 60 bits. The top four bits are the zone id.
288 * Currently only the freemap utilizes both layers in all their glory.
289 * All primary data/meta-data zones actually encode a zone-2 address
290 * requiring no real blockmap translation.
292 * The freemap uses the upper 8 bits of layer-1 to identify the volume,
293 * thus any space allocated via the freemap can be directly translated
294 * to a zone:2 (or zone:8-15) address.
296 * zone-X blockmap offset: [zone:4][layer1:18][layer2:19][big-block:23]
300 * 32 bytes layer1 entry for 8MB big-block.
301 * A big-block can hold 2^23 / 2^5 = 2^18 layer1 entries,
302 * which equals bits assigned for layer1 in zone-2 address.
304 struct hammer_blockmap_layer1 {
305 hammer_off_t blocks_free; /* big-blocks free */
306 hammer_off_t phys_offset; /* UNAVAIL or zone-2 */
307 hammer_off_t reserved01;
308 hammer_crc_t layer2_crc; /* xor'd crc's of HAMMER_BLOCKSIZE */
310 hammer_crc_t layer1_crc; /* MUST BE LAST FIELD OF STRUCTURE*/
313 typedef struct hammer_blockmap_layer1 *hammer_blockmap_layer1_t;
315 #define HAMMER_LAYER1_CRCSIZE \
316 offsetof(struct hammer_blockmap_layer1, layer1_crc)
319 * 16 bytes layer2 entry for 8MB big-blocks.
320 * A big-block can hold 2^23 / 2^4 = 2^19 layer2 entries,
321 * which equals bits assigned for layer2 in zone-2 address.
323 * NOTE: bytes_free is signed and can legally go negative if/when data
324 * de-dup occurs. This field will never go higher than
325 * HAMMER_BIGBLOCK_SIZE. If exactly HAMMER_BIGBLOCK_SIZE
326 * the big-block is completely free.
328 struct hammer_blockmap_layer2 {
329 uint8_t zone; /* typed allocation zone */
332 uint32_t append_off; /* allocatable space index */
333 int32_t bytes_free; /* bytes free within this big-block */
334 hammer_crc_t entry_crc;
337 typedef struct hammer_blockmap_layer2 *hammer_blockmap_layer2_t;
339 #define HAMMER_LAYER2_CRCSIZE \
340 offsetof(struct hammer_blockmap_layer2, entry_crc)
342 #define HAMMER_BLOCKMAP_UNAVAIL ((hammer_off_t)-1LL)
344 #define HAMMER_BLOCKMAP_RADIX1 /* 2^18 = 262144 */ \
345 (HAMMER_BIGBLOCK_SIZE / sizeof(struct hammer_blockmap_layer1))
346 #define HAMMER_BLOCKMAP_RADIX2 /* 2^19 = 524288 */ \
347 (HAMMER_BIGBLOCK_SIZE / sizeof(struct hammer_blockmap_layer2))
349 #define HAMMER_BLOCKMAP_LAYER1 /* 2^(18+19+23) = 1EB */ \
350 (HAMMER_BLOCKMAP_RADIX1 * HAMMER_BLOCKMAP_LAYER2)
351 #define HAMMER_BLOCKMAP_LAYER2 /* 2^(19+23) = 4TB */ \
352 (HAMMER_BLOCKMAP_RADIX2 * HAMMER_BIGBLOCK_SIZE64)
354 #define HAMMER_BLOCKMAP_LAYER1_MASK (HAMMER_BLOCKMAP_LAYER1 - 1)
355 #define HAMMER_BLOCKMAP_LAYER2_MASK (HAMMER_BLOCKMAP_LAYER2 - 1)
358 * Index within layer1 or layer2 big-block for the entry representing
359 * a zone-2 physical offset.
361 #define HAMMER_BLOCKMAP_LAYER1_INDEX(zone2_offset) \
362 (((zone2_offset) & HAMMER_BLOCKMAP_LAYER1_MASK) / \
363 HAMMER_BLOCKMAP_LAYER2)
365 #define HAMMER_BLOCKMAP_LAYER2_INDEX(zone2_offset) \
366 (((zone2_offset) & HAMMER_BLOCKMAP_LAYER2_MASK) / \
367 HAMMER_BIGBLOCK_SIZE64)
370 * Byte offset within layer1 or layer2 big-block for the entry representing
371 * a zone-2 physical offset. Multiply the index by sizeof(blockmap_layer).
373 #define HAMMER_BLOCKMAP_LAYER1_OFFSET(zone2_offset) \
374 (HAMMER_BLOCKMAP_LAYER1_INDEX(zone2_offset) * \
375 sizeof(struct hammer_blockmap_layer1))
377 #define HAMMER_BLOCKMAP_LAYER2_OFFSET(zone2_offset) \
378 (HAMMER_BLOCKMAP_LAYER2_INDEX(zone2_offset) * \
379 sizeof(struct hammer_blockmap_layer2))
382 * HAMMER UNDO parameters. The UNDO fifo is mapped directly in the volume
383 * header with an array of layer2 structures. A maximum of (128x8MB) = 1GB
384 * may be reserved. The size of the undo fifo is usually set a newfs time
385 * but can be adjusted if the filesystem is taken offline.
387 #define HAMMER_UNDO_LAYER2 128 /* max layer2 undo mapping entries */
390 * All on-disk HAMMER structures which make up elements of the UNDO FIFO
391 * contain a hammer_fifo_head and hammer_fifo_tail structure. This structure
392 * contains all the information required to validate the fifo element
393 * and to scan the fifo in either direction. The head is typically embedded
394 * in higher level hammer on-disk structures while the tail is typically
395 * out-of-band. hdr_size is the size of the whole mess, including the tail.
397 * All undo structures are guaranteed to not cross a 16K filesystem
398 * buffer boundary. Most undo structures are fairly small. Data spaces
399 * are not immediately reused by HAMMER so file data is not usually recorded
400 * as part of an UNDO.
402 * PAD elements are allowed to take up only 8 bytes of space as a special
403 * case, containing only hdr_signature, hdr_type, and hdr_size fields,
404 * and with the tail overloaded onto the head structure for 8 bytes total.
406 * Every undo record has a sequence number. This number is unrelated to
407 * transaction ids and instead collects the undo transactions associated
408 * with a single atomic operation. A larger transactional operation, such
409 * as a remove(), may consist of several smaller atomic operations
410 * representing raw meta-data operations.
412 * HAMMER VERSION 4 CHANGES
414 * In HAMMER version 4 the undo structure alignment is reduced from 16384
415 * to 512 bytes in order to ensure that each 512 byte sector begins with
416 * a header. The reserved01 field in the header is now a 32 bit sequence
417 * number. This allows the recovery code to detect missing sectors
418 * without relying on the 32-bit crc and to definitively identify the current
419 * undo sequence space without having to rely on information from the volume
420 * header. In addition, new REDO entries in the undo space are used to
421 * record write, write/extend, and transaction id updates.
423 * The grand result is:
425 * (1) The volume header no longer needs to be synchronized for most
426 * flush and fsync operations.
428 * (2) Most fsync operations need only lay down REDO records
430 * (3) Data overwrite for nohistory operations covered by REDO records
431 * can be supported (instead of rolling a new block allocation),
432 * by rolling UNDO for the prior contents of the data.
434 * HAMMER VERSION 5 CHANGES
436 * Hammer version 5 contains a minor adjustment making layer2's bytes_free
437 * field signed, allowing dedup to push it into the negative domain.
439 #define HAMMER_HEAD_ALIGN 8
440 #define HAMMER_HEAD_ALIGN_MASK (HAMMER_HEAD_ALIGN - 1)
441 #define HAMMER_HEAD_DOALIGN(bytes) \
442 (((bytes) + HAMMER_HEAD_ALIGN_MASK) & ~HAMMER_HEAD_ALIGN_MASK)
444 #define HAMMER_UNDO_ALIGN 512
445 #define HAMMER_UNDO_ALIGN64 ((uint64_t)512)
446 #define HAMMER_UNDO_MASK (HAMMER_UNDO_ALIGN - 1)
447 #define HAMMER_UNDO_MASK64 (HAMMER_UNDO_ALIGN64 - 1)
449 struct hammer_fifo_head {
450 uint16_t hdr_signature;
452 uint32_t hdr_size; /* Aligned size of the whole mess */
453 uint32_t hdr_seq; /* Sequence number */
454 hammer_crc_t hdr_crc; /* XOR crc up to field w/ crc after field */
457 #define HAMMER_FIFO_HEAD_CRCOFF offsetof(struct hammer_fifo_head, hdr_crc)
459 struct hammer_fifo_tail {
460 uint16_t tail_signature;
462 uint32_t tail_size; /* aligned size of the whole mess */
465 typedef struct hammer_fifo_head *hammer_fifo_head_t;
466 typedef struct hammer_fifo_tail *hammer_fifo_tail_t;
471 * NOTE: 0x8000U part of HAMMER_HEAD_TYPE_PAD can be removed if the HAMMER
472 * version ever gets bumped again. It exists only to keep compatibility with
475 #define HAMMER_HEAD_TYPE_PAD (0x0040U | 0x8000U)
476 #define HAMMER_HEAD_TYPE_DUMMY 0x0041U /* dummy entry w/seqno */
477 #define HAMMER_HEAD_TYPE_UNDO 0x0043U /* random UNDO information */
478 #define HAMMER_HEAD_TYPE_REDO 0x0044U /* data REDO / fast fsync */
480 #define HAMMER_HEAD_SIGNATURE 0xC84EU
481 #define HAMMER_TAIL_SIGNATURE 0xC74FU
484 * Misc FIFO structures.
486 * UNDO - Raw meta-data media updates.
488 struct hammer_fifo_undo {
489 struct hammer_fifo_head head;
490 hammer_off_t undo_offset; /* zone-1,2 offset */
491 int32_t undo_data_bytes;
492 int32_t undo_reserved01;
493 /* followed by data */
497 * REDO (HAMMER version 4+) - Logical file writes/truncates.
499 * REDOs contain information which will be duplicated in a later meta-data
500 * update, allowing fast write()+fsync() operations. REDOs can be ignored
501 * without harming filesystem integrity but must be processed if fsync()
502 * semantics are desired.
504 * Unlike UNDOs which are processed backwards within the recovery span,
505 * REDOs must be processed forwards starting further back (starting outside
506 * the recovery span).
508 * WRITE - Write logical file (with payload). Executed both
509 * out-of-span and in-span. Out-of-span WRITEs may be
510 * filtered out by TERMs.
512 * TRUNC - Truncate logical file (no payload). Executed both
513 * out-of-span and in-span. Out-of-span WRITEs may be
514 * filtered out by TERMs.
516 * TERM_* - Indicates meta-data was committed (if out-of-span) or
517 * will be rolled-back (in-span). Any out-of-span TERMs
518 * matching earlier WRITEs remove those WRITEs from
519 * consideration as they might conflict with a later data
520 * commit (which is not being rolled-back).
522 * SYNC - The earliest in-span SYNC (the last one when scanning
523 * backwards) tells the recovery code how far out-of-span
524 * it must go to run REDOs.
526 * NOTE: WRITEs do not always have matching TERMs even under
527 * perfect conditions because truncations might remove the
528 * buffers from consideration. I/O problems can also remove
529 * buffers from consideration.
531 * TRUNCSs do not always have matching TERMs because several
532 * truncations may be aggregated together into a single TERM.
534 struct hammer_fifo_redo {
535 struct hammer_fifo_head head;
536 int64_t redo_objid; /* file being written */
537 hammer_off_t redo_offset; /* logical offset in file */
538 int32_t redo_data_bytes;
540 uint32_t redo_localization;
541 uint32_t redo_reserved;
542 uint64_t redo_mtime; /* set mtime */
545 #define HAMMER_REDO_WRITE 0x00000001
546 #define HAMMER_REDO_TRUNC 0x00000002
547 #define HAMMER_REDO_TERM_WRITE 0x00000004
548 #define HAMMER_REDO_TERM_TRUNC 0x00000008
549 #define HAMMER_REDO_SYNC 0x00000010
551 union hammer_fifo_any {
552 struct hammer_fifo_head head;
553 struct hammer_fifo_undo undo;
554 struct hammer_fifo_redo redo;
557 typedef struct hammer_fifo_redo *hammer_fifo_redo_t;
558 typedef struct hammer_fifo_undo *hammer_fifo_undo_t;
559 typedef union hammer_fifo_any *hammer_fifo_any_t;
562 * Volume header types
564 #define HAMMER_FSBUF_VOLUME 0xC8414D4DC5523031ULL /* HAMMER01 */
565 #define HAMMER_FSBUF_VOLUME_REV 0x313052C54D4D41C8ULL /* (reverse endian) */
568 * HAMMER Volume header
570 * A HAMMER filesystem can be built from 1-256 block devices, each block
571 * device contains a volume header followed by however many buffers fit
574 * One of the volumes making up a HAMMER filesystem is the root volume.
575 * The root volume is always volume #0 which is the first block device path
576 * specified by newfs_hammer(8). All HAMMER volumes have a volume header,
577 * however the root volume may be the only volume that has valid values for
578 * some fields in the header.
580 * Special field notes:
582 * vol_bot_beg - offset of boot area (mem_beg - bot_beg bytes)
583 * vol_mem_beg - offset of memory log (clu_beg - mem_beg bytes)
584 * vol_buf_beg - offset of the first buffer.
586 * The memory log area allows a kernel to cache new records and data
587 * in memory without allocating space in the actual filesystem to hold
588 * the records and data. In the event that a filesystem becomes full,
589 * any records remaining in memory can be flushed to the memory log
590 * area. This allows the kernel to immediately return success.
594 * These macros are only used by userspace when userspace commands either
595 * initialize or add a new HAMMER volume.
597 #define HAMMER_BOOT_MINBYTES (32*1024)
598 #define HAMMER_BOOT_NOMBYTES (64LL*1024*1024)
599 #define HAMMER_BOOT_MAXBYTES (256LL*1024*1024)
601 #define HAMMER_MEM_MINBYTES (256*1024)
602 #define HAMMER_MEM_NOMBYTES (1LL*1024*1024*1024)
603 #define HAMMER_MEM_MAXBYTES (64LL*1024*1024*1024)
605 struct hammer_volume_ondisk {
606 uint64_t vol_signature; /* Signature */
608 int64_t vol_bot_beg; /* byte offset of boot area or 0 */
609 int64_t vol_mem_beg; /* byte offset of memory log or 0 */
610 int64_t vol_buf_beg; /* byte offset of first buffer in volume */
611 int64_t vol_buf_end; /* byte offset of volume EOF (on buf bndry) */
612 int64_t vol_locked; /* not used */
614 uuid_t vol_fsid; /* identify filesystem */
615 uuid_t vol_fstype; /* identify filesystem type */
616 char vol_name[64]; /* filesystem label */
618 int32_t vol_no; /* volume number within filesystem */
619 int32_t vol_count; /* number of volumes making up FS */
621 uint32_t vol_version; /* version control information */
622 hammer_crc_t vol_crc; /* header crc */
623 uint32_t vol_flags; /* volume flags */
624 uint32_t vol_rootvol; /* which volume is the root volume? */
626 int32_t vol_reserved04;
627 int32_t vol_reserved05;
628 uint32_t vol_reserved06;
629 uint32_t vol_reserved07;
631 int32_t vol_blocksize; /* for statfs only */
632 int32_t vol_reserved08;
633 int64_t vol_nblocks; /* total allocatable hammer bufs */
636 * These fields are initialized and space is reserved in every
637 * volume making up a HAMMER filesytem, but only the root volume
638 * contains valid data. Note that vol0_stat_bigblocks does not
639 * include big-blocks for freemap and undomap initially allocated
640 * by newfs_hammer(8).
642 int64_t vol0_stat_bigblocks; /* total big-blocks when fs is empty */
643 int64_t vol0_stat_freebigblocks;/* number of free big-blocks */
644 int64_t vol0_stat_bytes; /* for statfs only */
645 int64_t vol0_stat_inodes; /* for statfs only */
646 int64_t vol0_stat_records; /* total records in filesystem */
647 hammer_off_t vol0_btree_root; /* B-Tree root */
648 hammer_tid_t vol0_next_tid; /* highest partially synchronized TID */
649 hammer_off_t vol0_unused03;
652 * Blockmaps for zones. Not all zones use a blockmap. Note that
653 * the entire root blockmap is cached in the hammer_mount structure.
655 struct hammer_blockmap vol0_blockmap[HAMMER_MAX_ZONES];
658 * Array of zone-2 addresses for undo FIFO.
660 hammer_off_t vol0_undo_array[HAMMER_UNDO_LAYER2];
663 typedef struct hammer_volume_ondisk *hammer_volume_ondisk_t;
665 #define HAMMER_VOLF_NEEDFLUSH 0x0004 /* volume needs flush */
667 #define HAMMER_VOL_CRCSIZE1 \
668 offsetof(struct hammer_volume_ondisk, vol_crc)
669 #define HAMMER_VOL_CRCSIZE2 \
670 (sizeof(struct hammer_volume_ondisk) - HAMMER_VOL_CRCSIZE1 - \
671 sizeof(hammer_crc_t))
673 #define HAMMER_VOL_VERSION_MIN 1 /* minimum supported version */
674 #define HAMMER_VOL_VERSION_DEFAULT 6 /* newfs default version */
675 #define HAMMER_VOL_VERSION_WIP 7 /* version >= this is WIP */
676 #define HAMMER_VOL_VERSION_MAX 6 /* maximum supported version */
678 #define HAMMER_VOL_VERSION_ONE 1
679 #define HAMMER_VOL_VERSION_TWO 2 /* new dirent layout (2.3+) */
680 #define HAMMER_VOL_VERSION_THREE 3 /* new snapshot layout (2.5+) */
681 #define HAMMER_VOL_VERSION_FOUR 4 /* new undo/flush (2.5+) */
682 #define HAMMER_VOL_VERSION_FIVE 5 /* dedup (2.9+) */
683 #define HAMMER_VOL_VERSION_SIX 6 /* DIRHASH_ALG1 */
686 * Record types are fairly straightforward. The B-Tree includes the record
687 * type in its index sort.
689 #define HAMMER_RECTYPE_UNKNOWN 0x0000
690 #define HAMMER_RECTYPE_LOWEST 0x0001 /* lowest record type avail */
691 #define HAMMER_RECTYPE_INODE 0x0001 /* inode in obj_id space */
692 #define HAMMER_RECTYPE_DATA 0x0010
693 #define HAMMER_RECTYPE_DIRENTRY 0x0011
694 #define HAMMER_RECTYPE_DB 0x0012
695 #define HAMMER_RECTYPE_EXT 0x0013 /* ext attributes */
696 #define HAMMER_RECTYPE_FIX 0x0014 /* fixed attribute */
697 #define HAMMER_RECTYPE_PFS 0x0015 /* PFS management */
698 #define HAMMER_RECTYPE_SNAPSHOT 0x0016 /* Snapshot management */
699 #define HAMMER_RECTYPE_CONFIG 0x0017 /* hammer cleanup config */
700 #define HAMMER_RECTYPE_MAX 0xFFFF
702 #define HAMMER_RECTYPE_ENTRY_START (HAMMER_RECTYPE_INODE + 1)
703 #define HAMMER_RECTYPE_CLEAN_START HAMMER_RECTYPE_EXT
705 #define HAMMER_FIXKEY_SYMLINK 1
707 #define HAMMER_OBJTYPE_UNKNOWN 0 /* never exists on-disk as unknown */
708 #define HAMMER_OBJTYPE_DIRECTORY 1
709 #define HAMMER_OBJTYPE_REGFILE 2
710 #define HAMMER_OBJTYPE_DBFILE 3
711 #define HAMMER_OBJTYPE_FIFO 4
712 #define HAMMER_OBJTYPE_CDEV 5
713 #define HAMMER_OBJTYPE_BDEV 6
714 #define HAMMER_OBJTYPE_SOFTLINK 7
715 #define HAMMER_OBJTYPE_PSEUDOFS 8 /* pseudo filesystem obj */
716 #define HAMMER_OBJTYPE_SOCKET 9
719 * HAMMER inode attribute data
721 * The data reference for a HAMMER inode points to this structure. Any
722 * modifications to the contents of this structure will result in a
723 * replacement operation.
725 * parent_obj_id is only valid for directories (which cannot be hard-linked),
726 * and specifies the parent directory obj_id. This field will also be set
727 * for non-directory inodes as a recovery aid, but can wind up holding
728 * stale information. However, since object id's are not reused, the worse
729 * that happens is that the recovery code is unable to use it.
731 * NOTE: Future note on directory hardlinks. We can implement a record type
732 * which allows us to point to multiple parent directories.
734 struct hammer_inode_data {
735 uint16_t version; /* inode data version */
736 uint16_t mode; /* basic unix permissions */
737 uint32_t uflags; /* chflags */
738 uint32_t rmajor; /* used by device nodes */
739 uint32_t rminor; /* used by device nodes */
741 int64_t parent_obj_id; /* parent directory obj_id */
746 uint8_t cap_flags; /* capability support flags (extension) */
748 uint32_t reserved02; /* RESERVED FOR POSSIBLE FUTURE BIRTHTIME */
749 uint64_t nlinks; /* hard links */
750 uint64_t size; /* filesystem object size */
753 uint32_t reserved03[4];
754 uint32_t parent_obj_localization;
757 char symlink[24]; /* HAMMER_INODE_BASESYMLEN */
759 uint64_t mtime; /* mtime must be second-to-last */
760 uint64_t atime; /* atime must be last */
764 * Neither mtime nor atime upates are CRCd by the B-Tree element.
765 * mtime updates have UNDO, atime updates do not.
767 #define HAMMER_INODE_CRCSIZE \
768 offsetof(struct hammer_inode_data, mtime)
770 #define HAMMER_INODE_DATA_VERSION 1
771 #define HAMMER_OBJID_ROOT 1 /* root inodes # */
772 #define HAMMER_INODE_BASESYMLEN 24 /* see ext.symlink */
775 * Capability & implementation flags.
777 * HAMMER_INODE_CAP_DIR_LOCAL_INO - Use inode B-Tree localization
778 * for directory entries. Also see HAMMER_DIR_INODE_LOCALIZATION().
780 #define HAMMER_INODE_CAP_DIRHASH_MASK 0x03 /* directory: hash algorithm */
781 #define HAMMER_INODE_CAP_DIRHASH_ALG0 0x00
782 #define HAMMER_INODE_CAP_DIRHASH_ALG1 0x01
783 #define HAMMER_INODE_CAP_DIRHASH_ALG2 0x02
784 #define HAMMER_INODE_CAP_DIRHASH_ALG3 0x03
785 #define HAMMER_INODE_CAP_DIR_LOCAL_INO 0x04 /* use inode localization */
788 * A HAMMER directory entry associates a HAMMER filesystem object with a
789 * namespace. It is possible to hook into a pseudo-filesystem (with its
790 * own inode numbering space) in the filesystem by setting the high
791 * 16 bits of the localization field. The low 16 bits must be 0 and
792 * are reserved for future use.
794 * Directory entries are indexed with a 128 bit namekey rather then an
795 * offset. A portion of the namekey is an iterator/randomizer to deal
798 * NOTE: leaf.base.obj_type from the related B-Tree leaf entry holds
799 * the filesystem object type of obj_id, e.g. a den_type equivalent.
800 * It is not stored in hammer_entry_data.
802 * NOTE: name field / the filename data reference is NOT terminated with \0.
804 struct hammer_entry_data {
805 int64_t obj_id; /* object being referenced */
806 uint32_t localization; /* identify pseudo-filesystem */
808 char name[16]; /* name (extended) */
811 #define HAMMER_ENTRY_NAME_OFF offsetof(struct hammer_entry_data, name[0])
812 #define HAMMER_ENTRY_SIZE(nlen) offsetof(struct hammer_entry_data, name[nlen])
815 * Symlink data which does not fit in the inode is stored in a separate
818 struct hammer_symlink_data {
819 char name[16]; /* name (extended) */
822 #define HAMMER_SYMLINK_NAME_OFF offsetof(struct hammer_symlink_data, name[0])
825 * The root inode for the primary filesystem and root inode for any
826 * pseudo-fs may be tagged with an optional data structure using
827 * HAMMER_RECTYPE_PFS and localization id. This structure allows
828 * the node to be used as a mirroring master or slave.
830 * When operating as a slave CD's into the node automatically become read-only
831 * and as-of sync_end_tid.
833 * When operating as a master the read PFSD info sets sync_end_tid to
834 * the most recently flushed TID.
836 * sync_low_tid is not yet used but will represent the highest pruning
837 * end-point, after which full history is available.
839 * We need to pack this structure making it equally sized on both 32-bit and
840 * 64-bit machines as it is part of struct hammer_ioc_mrecord_pfs which is
841 * send over the wire in hammer mirror operations. Only on 64-bit machines
842 * the size of this struct differ when packed or not. This leads us to the
843 * situation where old 64-bit systems (using the non-packed structure),
844 * which were never able to mirror to/from 32-bit systems, are now no longer
845 * able to mirror to/from newer 64-bit systems (using the packed structure).
847 struct hammer_pseudofs_data {
848 hammer_tid_t sync_low_tid; /* full history beyond this point */
849 hammer_tid_t sync_beg_tid; /* earliest tid w/ full history avail */
850 hammer_tid_t sync_end_tid; /* current synchronizatoin point */
851 uint64_t sync_beg_ts; /* real-time of last completed sync */
852 uint64_t sync_end_ts; /* initiation of current sync cycle */
853 uuid_t shared_uuid; /* shared uuid (match required) */
854 uuid_t unique_uuid; /* unique uuid of this master/slave */
855 int32_t reserved01; /* reserved for future master_id */
856 int32_t mirror_flags; /* misc flags */
857 char label[64]; /* filesystem space label */
858 char snapshots[64]; /* softlink dir for pruning */
859 int32_t reserved02; /* was prune_{time,freq} */
860 int32_t reserved03; /* was reblock_{time,freq} */
861 int32_t reserved04; /* was snapshot_freq */
862 int32_t prune_min; /* do not prune recent history */
863 int32_t prune_max; /* do not retain history beyond here */
864 int32_t reserved[16];
867 typedef struct hammer_pseudofs_data *hammer_pseudofs_data_t;
869 #define HAMMER_PFSD_SLAVE 0x00000001
870 #define HAMMER_PFSD_DELETED 0x80000000
873 * Snapshot meta-data { Objid = HAMMER_OBJID_ROOT, Key = tid, rectype = SNAPSHOT }.
875 * Snapshot records replace the old <fs>/snapshots/<softlink> methodology. Snapshot
876 * records are mirrored but may be independantly managed once they are laid down on
879 * NOTE: The b-tree key is signed, the tid is not, so callers must still sort the
882 * NOTE: Reserved fields must be zero (as usual)
884 struct hammer_snapshot_data {
885 hammer_tid_t tid; /* the snapshot TID itself (== key) */
886 uint64_t ts; /* real-time when snapshot was made */
889 char label[64]; /* user-supplied description */
890 uint64_t reserved03[4];
894 * Config meta-data { ObjId = HAMMER_OBJID_ROOT, Key = 0, rectype = CONFIG }.
896 * Used to store the hammer cleanup config. This data is not mirrored.
898 struct hammer_config_data {
903 * Rollup various structures embedded as record data
905 union hammer_data_ondisk {
906 struct hammer_entry_data entry;
907 struct hammer_inode_data inode;
908 struct hammer_symlink_data symlink;
909 struct hammer_pseudofs_data pfsd;
910 struct hammer_snapshot_data snap;
911 struct hammer_config_data config;
914 typedef union hammer_data_ondisk *hammer_data_ondisk_t;
917 * Ondisk layout of B-Tree related structures
919 #include "hammer_btree.h"
921 #define HAMMER_DIR_INODE_LOCALIZATION(ino_data) \
922 (((ino_data)->cap_flags & HAMMER_INODE_CAP_DIR_LOCAL_INO) ? \
923 HAMMER_LOCALIZE_INODE : \
924 HAMMER_LOCALIZE_MISC)
926 #endif /* !VFS_HAMMER_DISK_H_ */