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_
40 #include <sys/endian.h>
47 * The structures below represent the on-disk format for a HAMMER
48 * filesystem. Note that all fields for on-disk structures are naturally
49 * aligned. HAMMER uses little endian for fields in on-disk structures.
50 * HAMMER doesn't support big endian arch, but is planned.
52 * Most of HAMMER revolves around the concept of an object identifier. An
53 * obj_id is a 64 bit quantity which uniquely identifies a filesystem object
54 * FOR THE ENTIRE LIFE OF THE FILESYSTEM. This uniqueness allows backups
55 * and mirrors to retain varying amounts of filesystem history by removing
56 * any possibility of conflict through identifier reuse.
58 * A HAMMER filesystem may span multiple volumes.
60 * A HAMMER filesystem uses a 16K filesystem buffer size. All filesystem
61 * I/O is done in multiples of 16K.
63 * 64K X-bufs are used for blocks >= a file's 1MB mark.
65 * Per-volume storage limit: 52 bits 4096 TB
66 * Per-Zone storage limit: 60 bits 1 MTB
67 * Per-filesystem storage limit: 60 bits 1 MTB
69 #define HAMMER_BUFSIZE 16384
70 #define HAMMER_XBUFSIZE 65536
71 #define HAMMER_HBUFSIZE (HAMMER_BUFSIZE / 2)
72 #define HAMMER_XDEMARC (1024 * 1024)
73 #define HAMMER_BUFMASK (HAMMER_BUFSIZE - 1)
74 #define HAMMER_XBUFMASK (HAMMER_XBUFSIZE - 1)
76 #define HAMMER_BUFSIZE64 ((uint64_t)HAMMER_BUFSIZE)
77 #define HAMMER_BUFMASK64 ((uint64_t)HAMMER_BUFMASK)
79 #define HAMMER_XBUFSIZE64 ((uint64_t)HAMMER_XBUFSIZE)
80 #define HAMMER_XBUFMASK64 ((uint64_t)HAMMER_XBUFMASK)
82 #define HAMMER_OFF_ZONE_MASK 0xF000000000000000ULL /* zone portion */
83 #define HAMMER_OFF_VOL_MASK 0x0FF0000000000000ULL /* volume portion */
84 #define HAMMER_OFF_SHORT_MASK 0x000FFFFFFFFFFFFFULL /* offset portion */
85 #define HAMMER_OFF_LONG_MASK 0x0FFFFFFFFFFFFFFFULL /* offset portion */
87 #define HAMMER_OFF_BAD ((hammer_off_t)-1)
89 #define HAMMER_BUFSIZE_DOALIGN(offset) \
90 (((offset) + HAMMER_BUFMASK) & ~HAMMER_BUFMASK)
91 #define HAMMER_BUFSIZE64_DOALIGN(offset) \
92 (((offset) + HAMMER_BUFMASK64) & ~HAMMER_BUFMASK64)
94 #define HAMMER_XBUFSIZE_DOALIGN(offset) \
95 (((offset) + HAMMER_XBUFMASK) & ~HAMMER_XBUFMASK)
96 #define HAMMER_XBUFSIZE64_DOALIGN(offset) \
97 (((offset) + HAMMER_XBUFMASK64) & ~HAMMER_XBUFMASK64)
100 * The current limit of volumes that can make up a HAMMER FS
102 #define HAMMER_MAX_VOLUMES 256
105 * Reserved space for (future) header junk after the volume header.
107 #define HAMMER_MIN_VOL_JUNK (HAMMER_BUFSIZE * 16) /* 256 KB */
108 #define HAMMER_MAX_VOL_JUNK HAMMER_MIN_VOL_JUNK
109 #define HAMMER_VOL_JUNK_SIZE HAMMER_MIN_VOL_JUNK
112 * Hammer transaction ids are 64 bit unsigned integers and are usually
113 * synchronized with the time of day in nanoseconds.
115 * Hammer offsets are used for FIFO indexing and embed a cycle counter
116 * and volume number in addition to the offset. Most offsets are required
117 * to be 16 KB aligned.
119 typedef uint64_t hammer_tid_t;
120 typedef uint64_t hammer_off_t;
121 typedef uint32_t hammer_crc_t;
123 #define HAMMER_MIN_TID 0ULL /* unsigned */
124 #define HAMMER_MAX_TID 0xFFFFFFFFFFFFFFFFULL /* unsigned */
125 #define HAMMER_MIN_KEY -0x8000000000000000LL /* signed */
126 #define HAMMER_MAX_KEY 0x7FFFFFFFFFFFFFFFLL /* signed */
127 #define HAMMER_MIN_OBJID HAMMER_MIN_KEY /* signed */
128 #define HAMMER_MAX_OBJID HAMMER_MAX_KEY /* signed */
129 #define HAMMER_MIN_RECTYPE 0x0U /* unsigned */
130 #define HAMMER_MAX_RECTYPE 0xFFFFU /* unsigned */
131 #define HAMMER_MIN_OFFSET 0ULL /* unsigned */
132 #define HAMMER_MAX_OFFSET 0xFFFFFFFFFFFFFFFFULL /* unsigned */
135 * hammer_off_t has several different encodings. Note that not all zones
136 * encode a vol_no. Zone bits are not a part of filesystem capacity as
137 * the zone bits aren't directly or indirectly mapped to physical volumes.
139 * In other words, HAMMER's logical filesystem offset consists of 64 bits,
140 * but the filesystem is considered 60 bits filesystem, not 64 bits.
141 * The maximum filesystem capacity is 1EB, not 16EB.
143 * zone 0: available, a big-block that contains the offset is unused
144 * zone 1 (z,v,o): raw volume relative (offset 0 is the volume header)
145 * zone 2 (z,v,o): raw buffer relative (offset 0 is the first buffer)
146 * zone 3 (z,o): undo/redo fifo - fixed zone-2 offset array in volume header
147 * zone 4 (z,v,o): freemap - only real blockmap
148 * zone 8 (z,v,o): B-Tree - actually zone-2 address
149 * zone 9 (z,v,o): meta - actually zone-2 address
150 * zone 10 (z,v,o): large-data - actually zone-2 address
151 * zone 11 (z,v,o): small-data - actually zone-2 address
152 * zone 15: unavailable, usually the offset is beyond volume size
154 * layer1/layer2 direct map:
155 * Maximum HAMMER filesystem capacity from volume aspect
156 * 2^8(max volumes) * 2^52(max volume size) = 2^60 = 1EB (long offset)
157 * <------------------------------------------------------------->
158 * 8bits 52bits (short offset)
159 * <------><----------------------------------------------------->
160 * zzzzvvvvvvvvoooo oooooooooooooooo oooooooooooooooo oooooooooooooooo
161 * ----111111111111 1111112222222222 222222222ooooooo oooooooooooooooo
162 * <-----------------><------------------><---------------------->
163 * 18bits 19bits 23bits
164 * <------------------------------------------------------------->
165 * 2^18(layer1) * 2^19(layer2) * 2^23(big-block) = 2^60 = 1EB
166 * Maximum HAMMER filesystem capacity from blockmap aspect
169 * +-------------------------> offset 0 of a device/partition
170 * | volume header (1928 bytes)
171 * | the rest of header junk space (HAMMER_BUFSIZE aligned)
172 * +-------------------------> vol_bot_beg
173 * | boot area (HAMMER_BUFSIZE aligned)
174 * +-------------------------> vol_mem_beg
175 * | memory log (HAMMER_BUFSIZE aligned)
176 * +-------------------------> vol_buf_beg (physical offset of zone-2)
177 * | zone-4 big-block for layer1
178 * +-------------------------> vol_buf_beg + HAMMER_BIGBLOCK_SIZE
179 * | zone-4 big-blocks for layer2
180 * | ... (1 big-block per 4GB space)
181 * +-------------------------> vol_buf_beg + HAMMER_BIGBLOCK_SIZE * ...
182 * | zone-3 big-blocks for UNDO/REDO FIFO
183 * | ... (max 128 big-blocks)
184 * +-------------------------> vol_buf_beg + HAMMER_BIGBLOCK_SIZE * ...
185 * | zone-8 big-block for root B-Tree node/etc
186 * +-------------------------> vol_buf_beg + HAMMER_BIGBLOCK_SIZE * ...
187 * | zone-9 big-block for root inode/PFS#0/etc
188 * +-------------------------> vol_buf_beg + HAMMER_BIGBLOCK_SIZE * ...
189 * | zone-X big-blocks
190 * | ... (big-blocks for new zones after newfs_hammer)
195 * +-------------------------> vol_buf_end (HAMMER_BUFSIZE aligned)
196 * +-------------------------> end of a device/partition
198 * volume#N layout (N>0)
199 * +-------------------------> offset 0 of a device/partition
200 * | volume header (1928 bytes)
201 * | the rest of header junk space (HAMMER_BUFSIZE aligned)
202 * +-------------------------> vol_bot_beg
203 * | boot area (HAMMER_BUFSIZE aligned)
204 * +-------------------------> vol_mem_beg
205 * | memory log (HAMMER_BUFSIZE aligned)
206 * +-------------------------> vol_buf_beg (physical offset of zone-2)
207 * | zone-4 big-blocks for layer2
208 * | ... (1 big-block per 4GB space)
209 * +-------------------------> vol_buf_beg + HAMMER_BIGBLOCK_SIZE * ...
210 * | zone-X big-blocks
211 * | ... (unused until volume#(N-1) runs out of space)
216 * +-------------------------> vol_buf_end (HAMMER_BUFSIZE aligned)
217 * +-------------------------> end of a device/partition
220 #define HAMMER_ZONE_RAW_VOLUME 0x1000000000000000ULL
221 #define HAMMER_ZONE_RAW_BUFFER 0x2000000000000000ULL
222 #define HAMMER_ZONE_UNDO 0x3000000000000000ULL
223 #define HAMMER_ZONE_FREEMAP 0x4000000000000000ULL
224 #define HAMMER_ZONE_RESERVED05 0x5000000000000000ULL /* not used */
225 #define HAMMER_ZONE_RESERVED06 0x6000000000000000ULL /* not used */
226 #define HAMMER_ZONE_RESERVED07 0x7000000000000000ULL /* not used */
227 #define HAMMER_ZONE_BTREE 0x8000000000000000ULL
228 #define HAMMER_ZONE_META 0x9000000000000000ULL
229 #define HAMMER_ZONE_LARGE_DATA 0xA000000000000000ULL
230 #define HAMMER_ZONE_SMALL_DATA 0xB000000000000000ULL
231 #define HAMMER_ZONE_RESERVED0C 0xC000000000000000ULL /* not used */
232 #define HAMMER_ZONE_RESERVED0D 0xD000000000000000ULL /* not used */
233 #define HAMMER_ZONE_RESERVED0E 0xE000000000000000ULL /* not used */
234 #define HAMMER_ZONE_UNAVAIL 0xF000000000000000ULL
236 #define HAMMER_ZONE_RAW_VOLUME_INDEX 1
237 #define HAMMER_ZONE_RAW_BUFFER_INDEX 2
238 #define HAMMER_ZONE_UNDO_INDEX 3
239 #define HAMMER_ZONE_FREEMAP_INDEX 4
240 #define HAMMER_ZONE_BTREE_INDEX 8
241 #define HAMMER_ZONE_META_INDEX 9
242 #define HAMMER_ZONE_LARGE_DATA_INDEX 10
243 #define HAMMER_ZONE_SMALL_DATA_INDEX 11
244 #define HAMMER_ZONE_UNAVAIL_INDEX 15
246 #define HAMMER_MAX_ZONES 16
248 #define HAMMER_ZONE(offset) ((offset) & HAMMER_OFF_ZONE_MASK)
250 #define hammer_is_zone_raw_volume(offset) \
251 (HAMMER_ZONE(offset) == HAMMER_ZONE_RAW_VOLUME)
252 #define hammer_is_zone_raw_buffer(offset) \
253 (HAMMER_ZONE(offset) == HAMMER_ZONE_RAW_BUFFER)
254 #define hammer_is_zone_undo(offset) \
255 (HAMMER_ZONE(offset) == HAMMER_ZONE_UNDO)
256 #define hammer_is_zone_freemap(offset) \
257 (HAMMER_ZONE(offset) == HAMMER_ZONE_FREEMAP)
258 #define hammer_is_zone_btree(offset) \
259 (HAMMER_ZONE(offset) == HAMMER_ZONE_BTREE)
260 #define hammer_is_zone_meta(offset) \
261 (HAMMER_ZONE(offset) == HAMMER_ZONE_META)
262 #define hammer_is_zone_large_data(offset) \
263 (HAMMER_ZONE(offset) == HAMMER_ZONE_LARGE_DATA)
264 #define hammer_is_zone_small_data(offset) \
265 (HAMMER_ZONE(offset) == HAMMER_ZONE_SMALL_DATA)
266 #define hammer_is_zone_unavail(offset) \
267 (HAMMER_ZONE(offset) == HAMMER_ZONE_UNAVAIL)
268 #define hammer_is_zone_data(offset) \
269 (hammer_is_zone_large_data(offset) || hammer_is_zone_small_data(offset))
272 * Test if the zone is directly mapped to zone-2 offset via freemap.
274 #define hammer_is_zone2_mapped_index(zone) \
275 ((zone) >= HAMMER_ZONE_BTREE_INDEX && \
276 (zone) < HAMMER_MAX_ZONES)
278 * Test if the zone is directly mapped to zone-2 offset. The word
279 * directly here means the zone is neither RAW_VOLUME nor UNDO zone.
281 #define hammer_is_direct_mapped_index(zone) \
282 (((zone) == HAMMER_ZONE_RAW_BUFFER_INDEX) || \
283 ((zone) == HAMMER_ZONE_FREEMAP_INDEX) || \
284 hammer_is_zone2_mapped_index(zone))
286 #define HAMMER_ZONE_ENCODE(zone, ham_off) \
287 (((hammer_off_t)(zone) << 60) | (ham_off))
288 #define HAMMER_ZONE_DECODE(ham_off) \
289 ((int)(((hammer_off_t)(ham_off) >> 60)))
291 #define HAMMER_VOL_ENCODE(vol_no) \
292 ((hammer_off_t)((vol_no) & 255) << 52)
293 #define HAMMER_VOL_DECODE(ham_off) \
294 ((int)(((hammer_off_t)(ham_off) >> 52) & 255))
296 #define HAMMER_OFF_SHORT_ENCODE(offset) \
297 ((hammer_off_t)(offset) & HAMMER_OFF_SHORT_MASK)
298 #define HAMMER_OFF_LONG_ENCODE(offset) \
299 ((hammer_off_t)(offset) & HAMMER_OFF_LONG_MASK)
301 #define HAMMER_ENCODE(zone, vol_no, offset) \
302 (((hammer_off_t)(zone) << 60) | \
303 HAMMER_VOL_ENCODE(vol_no) | \
304 HAMMER_OFF_SHORT_ENCODE(offset))
305 #define HAMMER_ENCODE_RAW_VOLUME(vol_no, offset) \
306 HAMMER_ENCODE(HAMMER_ZONE_RAW_VOLUME_INDEX, vol_no, offset)
307 #define HAMMER_ENCODE_RAW_BUFFER(vol_no, offset) \
308 HAMMER_ENCODE(HAMMER_ZONE_RAW_BUFFER_INDEX, vol_no, offset)
309 #define HAMMER_ENCODE_UNDO(offset) \
310 HAMMER_ENCODE(HAMMER_ZONE_UNDO_INDEX, HAMMER_ROOT_VOLNO, offset)
311 #define HAMMER_ENCODE_FREEMAP(vol_no, offset) \
312 HAMMER_ENCODE(HAMMER_ZONE_FREEMAP_INDEX, vol_no, offset)
315 * Translate a zone address to zone-X address.
317 #define hammer_xlate_to_zoneX(zone, offset) \
318 HAMMER_ZONE_ENCODE((zone), (offset) & ~HAMMER_OFF_ZONE_MASK)
319 #define hammer_xlate_to_zone2(offset) \
320 hammer_xlate_to_zoneX(HAMMER_ZONE_RAW_BUFFER_INDEX, (offset))
322 #define hammer_data_zone(data_len) \
323 (((data_len) >= HAMMER_BUFSIZE) ? \
324 HAMMER_ZONE_LARGE_DATA : \
325 HAMMER_ZONE_SMALL_DATA)
326 #define hammer_data_zone_index(data_len) \
327 (((data_len) >= HAMMER_BUFSIZE) ? \
328 HAMMER_ZONE_LARGE_DATA_INDEX : \
329 HAMMER_ZONE_SMALL_DATA_INDEX)
332 * Big-Block backing store
334 * A blockmap is a two-level map which translates a blockmap-backed zone
335 * offset into a raw zone 2 offset. The layer 1 handles 18 bits and the
336 * layer 2 handles 19 bits. The 8M big-block size is 23 bits so two
337 * layers gives us 18+19+23 = 60 bits of address space.
339 * When using hinting for a blockmap lookup, the hint is lost when the
340 * scan leaves the HINTBLOCK, which is typically several BIGBLOCK's.
341 * HINTBLOCK is a heuristic.
343 #define HAMMER_HINTBLOCK_SIZE (HAMMER_BIGBLOCK_SIZE * 4)
344 #define HAMMER_HINTBLOCK_MASK64 ((uint64_t)HAMMER_HINTBLOCK_SIZE - 1)
345 #define HAMMER_BIGBLOCK_SIZE (8192 * 1024)
346 #define HAMMER_BIGBLOCK_SIZE64 ((uint64_t)HAMMER_BIGBLOCK_SIZE)
347 #define HAMMER_BIGBLOCK_MASK (HAMMER_BIGBLOCK_SIZE - 1)
348 #define HAMMER_BIGBLOCK_MASK64 ((uint64_t)HAMMER_BIGBLOCK_SIZE - 1)
349 #define HAMMER_BIGBLOCK_BITS 23
351 #define HAMMER_BIGBLOCK_OVERFILL (6144 * 1024)
353 #if (1 << HAMMER_BIGBLOCK_BITS) != HAMMER_BIGBLOCK_SIZE
354 #error "HAMMER_BIGBLOCK_BITS BROKEN"
357 #define HAMMER_BUFFERS_PER_BIGBLOCK \
358 (HAMMER_BIGBLOCK_SIZE / HAMMER_BUFSIZE)
359 #define HAMMER_BUFFERS_PER_BIGBLOCK_MASK \
360 (HAMMER_BUFFERS_PER_BIGBLOCK - 1)
361 #define HAMMER_BUFFERS_PER_BIGBLOCK_MASK64 \
362 ((hammer_off_t)HAMMER_BUFFERS_PER_BIGBLOCK_MASK)
364 #define HAMMER_BIGBLOCK_DOALIGN(offset) \
365 (((offset) + HAMMER_BIGBLOCK_MASK64) & ~HAMMER_BIGBLOCK_MASK64)
368 * Maximum number of mirrors operating in master mode (multi-master
369 * clustering and mirroring). Note that HAMMER1 does not support
370 * multi-master clustering as of 2015.
372 #define HAMMER_MAX_MASTERS 16
375 * The blockmap is somewhat of a degenerate structure. HAMMER only actually
376 * uses it in its original incarnation to implement the freemap.
378 * zone:1 raw volume (no blockmap)
379 * zone:2 raw buffer (no blockmap)
380 * zone:3 undomap (direct layer2 array in volume header)
381 * zone:4 freemap (the only real blockmap)
382 * zone:8-15 zone id used to classify big-block only, address is actually
385 typedef struct hammer_blockmap {
386 hammer_off_t phys_offset; /* zone-2 physical offset */
387 hammer_off_t first_offset; /* zone-X logical offset (zone 3) */
388 hammer_off_t next_offset; /* zone-X logical offset */
389 hammer_off_t alloc_offset; /* zone-X logical offset */
391 hammer_crc_t entry_crc;
392 } *hammer_blockmap_t;
394 #define HAMMER_BLOCKMAP_CRCSIZE \
395 offsetof(struct hammer_blockmap, entry_crc)
398 * The blockmap is a 2-layer entity made up of big-blocks. The first layer
399 * contains 262144 32-byte entries (18 bits), the second layer contains
400 * 524288 16-byte entries (19 bits), representing 8MB (23 bit) blockmaps.
401 * 18+19+23 = 60 bits. The top four bits are the zone id.
403 * Currently only the freemap utilizes both layers in all their glory.
404 * All primary data/meta-data zones actually encode a zone-2 address
405 * requiring no real blockmap translation.
407 * The freemap uses the upper 8 bits of layer-1 to identify the volume,
408 * thus any space allocated via the freemap can be directly translated
409 * to a zone:2 (or zone:8-15) address.
411 * zone-X blockmap offset: [zone:4][layer1:18][layer2:19][big-block:23]
415 * 32 bytes layer1 entry for 8MB big-block.
416 * A big-block can hold 2^23 / 2^5 = 2^18 layer1 entries,
417 * which equals bits assigned for layer1 in zone-2 address.
419 typedef struct hammer_blockmap_layer1 {
420 hammer_off_t blocks_free; /* big-blocks free */
421 hammer_off_t phys_offset; /* UNAVAIL or zone-2 */
422 hammer_off_t reserved01;
423 hammer_crc_t layer2_crc; /* xor'd crc's of HAMMER_BLOCKSIZE */
425 hammer_crc_t layer1_crc; /* MUST BE LAST FIELD OF STRUCTURE*/
426 } *hammer_blockmap_layer1_t;
428 #define HAMMER_LAYER1_CRCSIZE \
429 offsetof(struct hammer_blockmap_layer1, layer1_crc)
432 * 16 bytes layer2 entry for 8MB big-blocks.
433 * A big-block can hold 2^23 / 2^4 = 2^19 layer2 entries,
434 * which equals bits assigned for layer2 in zone-2 address.
436 * NOTE: bytes_free is signed and can legally go negative if/when data
437 * de-dup occurs. This field will never go higher than
438 * HAMMER_BIGBLOCK_SIZE. If exactly HAMMER_BIGBLOCK_SIZE
439 * the big-block is completely free.
441 typedef struct hammer_blockmap_layer2 {
442 uint8_t zone; /* typed allocation zone */
445 uint32_t append_off; /* allocatable space index */
446 int32_t bytes_free; /* bytes free within this big-block */
447 hammer_crc_t entry_crc;
448 } *hammer_blockmap_layer2_t;
450 #define HAMMER_LAYER2_CRCSIZE \
451 offsetof(struct hammer_blockmap_layer2, entry_crc)
453 #define HAMMER_BLOCKMAP_UNAVAIL ((hammer_off_t)-1LL)
455 #define HAMMER_BLOCKMAP_RADIX1 /* 2^18 = 262144 */ \
456 ((int)(HAMMER_BIGBLOCK_SIZE / sizeof(struct hammer_blockmap_layer1)))
457 #define HAMMER_BLOCKMAP_RADIX2 /* 2^19 = 524288 */ \
458 ((int)(HAMMER_BIGBLOCK_SIZE / sizeof(struct hammer_blockmap_layer2)))
460 #define HAMMER_BLOCKMAP_LAYER1 /* 2^(18+19+23) = 1EB */ \
461 (HAMMER_BLOCKMAP_RADIX1 * HAMMER_BLOCKMAP_LAYER2)
462 #define HAMMER_BLOCKMAP_LAYER2 /* 2^(19+23) = 4TB */ \
463 (HAMMER_BLOCKMAP_RADIX2 * HAMMER_BIGBLOCK_SIZE64)
465 #define HAMMER_BLOCKMAP_LAYER1_MASK (HAMMER_BLOCKMAP_LAYER1 - 1)
466 #define HAMMER_BLOCKMAP_LAYER2_MASK (HAMMER_BLOCKMAP_LAYER2 - 1)
468 #define HAMMER_BLOCKMAP_LAYER2_DOALIGN(offset) \
469 (((offset) + HAMMER_BLOCKMAP_LAYER2_MASK) & \
470 ~HAMMER_BLOCKMAP_LAYER2_MASK)
473 * Index within layer1 or layer2 big-block for the entry representing
474 * a zone-2 physical offset.
476 #define HAMMER_BLOCKMAP_LAYER1_INDEX(zone2_offset) \
477 ((int)(((zone2_offset) & HAMMER_BLOCKMAP_LAYER1_MASK) / \
478 HAMMER_BLOCKMAP_LAYER2))
480 #define HAMMER_BLOCKMAP_LAYER2_INDEX(zone2_offset) \
481 ((int)(((zone2_offset) & HAMMER_BLOCKMAP_LAYER2_MASK) / \
482 HAMMER_BIGBLOCK_SIZE64))
485 * Byte offset within layer1 or layer2 big-block for the entry representing
486 * a zone-2 physical offset. Multiply the index by sizeof(blockmap_layer).
488 #define HAMMER_BLOCKMAP_LAYER1_OFFSET(zone2_offset) \
489 (HAMMER_BLOCKMAP_LAYER1_INDEX(zone2_offset) * \
490 sizeof(struct hammer_blockmap_layer1))
492 #define HAMMER_BLOCKMAP_LAYER2_OFFSET(zone2_offset) \
493 (HAMMER_BLOCKMAP_LAYER2_INDEX(zone2_offset) * \
494 sizeof(struct hammer_blockmap_layer2))
497 * HAMMER UNDO parameters. The UNDO fifo is mapped directly in the volume
498 * header with an array of zone-2 offsets. A maximum of (128x8MB) = 1GB,
499 * and minimum of (64x8MB) = 512MB may be reserved. The size of the undo
500 * fifo is usually set a newfs time.
502 #define HAMMER_MIN_UNDO_BIGBLOCKS 64
503 #define HAMMER_MAX_UNDO_BIGBLOCKS 128
506 * All on-disk HAMMER structures which make up elements of the UNDO FIFO
507 * contain a hammer_fifo_head and hammer_fifo_tail structure. This structure
508 * contains all the information required to validate the fifo element
509 * and to scan the fifo in either direction. The head is typically embedded
510 * in higher level hammer on-disk structures while the tail is typically
511 * out-of-band. hdr_size is the size of the whole mess, including the tail.
513 * All undo structures are guaranteed to not cross a 16K filesystem
514 * buffer boundary. Most undo structures are fairly small. Data spaces
515 * are not immediately reused by HAMMER so file data is not usually recorded
516 * as part of an UNDO.
518 * PAD elements are allowed to take up only 8 bytes of space as a special
519 * case, containing only hdr_signature, hdr_type, and hdr_size fields,
520 * and with the tail overloaded onto the head structure for 8 bytes total.
522 * Every undo record has a sequence number. This number is unrelated to
523 * transaction ids and instead collects the undo transactions associated
524 * with a single atomic operation. A larger transactional operation, such
525 * as a remove(), may consist of several smaller atomic operations
526 * representing raw meta-data operations.
528 * HAMMER VERSION 4 CHANGES
530 * In HAMMER version 4 the undo structure alignment is reduced from 16384
531 * to 512 bytes in order to ensure that each 512 byte sector begins with
532 * a header. The hdr_seq field in the header is a 32 bit sequence number
533 * which allows the recovery code to detect missing sectors
534 * without relying on the 32-bit crc and to definitively identify the current
535 * undo sequence space without having to rely on information from the volume
536 * header. In addition, new REDO entries in the undo space are used to
537 * record write, write/extend, and transaction id updates.
539 * The grand result is:
541 * (1) The volume header no longer needs to be synchronized for most
542 * flush and fsync operations.
544 * (2) Most fsync operations need only lay down REDO records
546 * (3) Data overwrite for nohistory operations covered by REDO records
547 * can be supported (instead of rolling a new block allocation),
548 * by rolling UNDO for the prior contents of the data.
550 * HAMMER VERSION 5 CHANGES
552 * Hammer version 5 contains a minor adjustment making layer2's bytes_free
553 * field signed, allowing dedup to push it into the negative domain.
555 #define HAMMER_HEAD_ALIGN 8
556 #define HAMMER_HEAD_ALIGN_MASK (HAMMER_HEAD_ALIGN - 1)
557 #define HAMMER_HEAD_DOALIGN(bytes) \
558 (((bytes) + HAMMER_HEAD_ALIGN_MASK) & ~HAMMER_HEAD_ALIGN_MASK)
560 #define HAMMER_UNDO_ALIGN 512
561 #define HAMMER_UNDO_ALIGN64 ((uint64_t)512)
562 #define HAMMER_UNDO_MASK (HAMMER_UNDO_ALIGN - 1)
563 #define HAMMER_UNDO_MASK64 (HAMMER_UNDO_ALIGN64 - 1)
565 typedef struct hammer_fifo_head {
566 uint16_t hdr_signature;
568 uint32_t hdr_size; /* Aligned size of the whole mess */
569 uint32_t hdr_seq; /* Sequence number */
570 hammer_crc_t hdr_crc; /* XOR crc up to field w/ crc after field */
571 } *hammer_fifo_head_t;
573 #define HAMMER_FIFO_HEAD_CRCOFF offsetof(struct hammer_fifo_head, hdr_crc)
575 typedef struct hammer_fifo_tail {
576 uint16_t tail_signature;
578 uint32_t tail_size; /* aligned size of the whole mess */
579 } *hammer_fifo_tail_t;
584 * NOTE: 0x8000U part of HAMMER_HEAD_TYPE_PAD can be removed if the HAMMER
585 * version ever gets bumped again. It exists only to keep compatibility with
588 #define HAMMER_HEAD_TYPE_PAD (0x0040U | 0x8000U)
589 #define HAMMER_HEAD_TYPE_DUMMY 0x0041U /* dummy entry w/seqno */
590 #define HAMMER_HEAD_TYPE_UNDO 0x0043U /* random UNDO information */
591 #define HAMMER_HEAD_TYPE_REDO 0x0044U /* data REDO / fast fsync */
593 #define HAMMER_HEAD_SIGNATURE 0xC84EU
594 #define HAMMER_TAIL_SIGNATURE 0xC74FU
597 * Misc FIFO structures.
599 * UNDO - Raw meta-data media updates.
601 typedef struct hammer_fifo_undo {
602 struct hammer_fifo_head head;
603 hammer_off_t undo_offset; /* zone-1,2 offset */
604 int32_t undo_data_bytes;
605 int32_t undo_reserved01;
606 /* followed by data */
607 } *hammer_fifo_undo_t;
610 * REDO (HAMMER version 4+) - Logical file writes/truncates.
612 * REDOs contain information which will be duplicated in a later meta-data
613 * update, allowing fast write()+fsync() operations. REDOs can be ignored
614 * without harming filesystem integrity but must be processed if fsync()
615 * semantics are desired.
617 * Unlike UNDOs which are processed backwards within the recovery span,
618 * REDOs must be processed forwards starting further back (starting outside
619 * the recovery span).
621 * WRITE - Write logical file (with payload). Executed both
622 * out-of-span and in-span. Out-of-span WRITEs may be
623 * filtered out by TERMs.
625 * TRUNC - Truncate logical file (no payload). Executed both
626 * out-of-span and in-span. Out-of-span WRITEs may be
627 * filtered out by TERMs.
629 * TERM_* - Indicates meta-data was committed (if out-of-span) or
630 * will be rolled-back (in-span). Any out-of-span TERMs
631 * matching earlier WRITEs remove those WRITEs from
632 * consideration as they might conflict with a later data
633 * commit (which is not being rolled-back).
635 * SYNC - The earliest in-span SYNC (the last one when scanning
636 * backwards) tells the recovery code how far out-of-span
637 * it must go to run REDOs.
639 * NOTE: WRITEs do not always have matching TERMs even under
640 * perfect conditions because truncations might remove the
641 * buffers from consideration. I/O problems can also remove
642 * buffers from consideration.
644 * TRUNCSs do not always have matching TERMs because several
645 * truncations may be aggregated together into a single TERM.
647 typedef struct hammer_fifo_redo {
648 struct hammer_fifo_head head;
649 int64_t redo_objid; /* file being written */
650 hammer_off_t redo_offset; /* logical offset in file */
651 int32_t redo_data_bytes;
653 uint32_t redo_localization;
654 uint32_t redo_reserved;
655 uint64_t redo_mtime; /* set mtime */
656 } *hammer_fifo_redo_t;
658 #define HAMMER_REDO_WRITE 0x00000001
659 #define HAMMER_REDO_TRUNC 0x00000002
660 #define HAMMER_REDO_TERM_WRITE 0x00000004
661 #define HAMMER_REDO_TERM_TRUNC 0x00000008
662 #define HAMMER_REDO_SYNC 0x00000010
664 typedef union hammer_fifo_any {
665 struct hammer_fifo_head head;
666 struct hammer_fifo_undo undo;
667 struct hammer_fifo_redo redo;
668 } *hammer_fifo_any_t;
671 * Volume header types
673 #define HAMMER_FSBUF_VOLUME 0xC8414D4DC5523031ULL /* HAMMER01 */
674 #define HAMMER_FSBUF_VOLUME_REV 0x313052C54D4D41C8ULL /* (reverse endian) */
677 * HAMMER Volume header
679 * A HAMMER filesystem can be built from 1-256 block devices, each block
680 * device contains a volume header followed by however many buffers fit
683 * One of the volumes making up a HAMMER filesystem is the root volume.
684 * The root volume is always volume #0 which is the first block device path
685 * specified by newfs_hammer(8). All HAMMER volumes have a volume header,
686 * however the root volume may be the only volume that has valid values for
687 * some fields in the header.
689 * Special field notes:
691 * vol_bot_beg - offset of boot area (mem_beg - bot_beg bytes)
692 * vol_mem_beg - offset of memory log (buf_beg - mem_beg bytes)
693 * vol_buf_beg - offset of the first buffer in volume
694 * vol_buf_end - offset of volume EOF (on buffer boundary)
696 * The memory log area allows a kernel to cache new records and data
697 * in memory without allocating space in the actual filesystem to hold
698 * the records and data. In the event that a filesystem becomes full,
699 * any records remaining in memory can be flushed to the memory log
700 * area. This allows the kernel to immediately return success.
702 * The buffer offset is a physical offset of zone-2 offset. The lower
703 * 52 bits of the zone-2 offset is added to the buffer offset of each
704 * volume to generate an actual I/O offset within the block device.
706 * NOTE: boot area and memory log are currently not used.
710 * Filesystem type string
712 #define HAMMER_FSTYPE_STRING "DragonFly HAMMER"
715 * These macros are only used by userspace when userspace commands either
716 * initialize or add a new HAMMER volume.
718 #define HAMMER_BOOT_MINBYTES (32*1024)
719 #define HAMMER_BOOT_NOMBYTES (64LL*1024*1024)
720 #define HAMMER_BOOT_MAXBYTES (256LL*1024*1024)
722 #define HAMMER_MEM_MINBYTES (256*1024)
723 #define HAMMER_MEM_NOMBYTES (1LL*1024*1024*1024)
724 #define HAMMER_MEM_MAXBYTES (64LL*1024*1024*1024)
726 typedef struct hammer_volume_ondisk {
727 uint64_t vol_signature; /* HAMMER_FSBUF_VOLUME for a valid header */
730 * These are relative to block device offset, not zone offsets.
732 int64_t vol_bot_beg; /* offset of boot area */
733 int64_t vol_mem_beg; /* offset of memory log */
734 int64_t vol_buf_beg; /* offset of the first buffer in volume */
735 int64_t vol_buf_end; /* offset of volume EOF (on buffer boundary) */
736 int64_t vol_reserved01;
738 uuid_t vol_fsid; /* identify filesystem */
739 uuid_t vol_fstype; /* identify filesystem type */
740 char vol_label[64]; /* filesystem label */
742 int32_t vol_no; /* volume number within filesystem */
743 int32_t vol_count; /* number of volumes making up filesystem */
745 uint32_t vol_version; /* version control information */
746 hammer_crc_t vol_crc; /* header crc */
747 uint32_t vol_flags; /* volume flags */
748 uint32_t vol_rootvol; /* the root volume number (must be 0) */
750 uint32_t vol_reserved[8];
753 * These fields are initialized and space is reserved in every
754 * volume making up a HAMMER filesytem, but only the root volume
755 * contains valid data. Note that vol0_stat_bigblocks does not
756 * include big-blocks for freemap and undomap initially allocated
757 * by newfs_hammer(8).
759 int64_t vol0_stat_bigblocks; /* total big-blocks when fs is empty */
760 int64_t vol0_stat_freebigblocks;/* number of free big-blocks */
761 int64_t vol0_reserved01;
762 int64_t vol0_stat_inodes; /* for statfs only */
763 int64_t vol0_reserved02;
764 hammer_off_t vol0_btree_root; /* B-Tree root offset in zone-8 */
765 hammer_tid_t vol0_next_tid; /* highest partially synchronized TID */
766 hammer_off_t vol0_reserved03;
769 * Blockmaps for zones. Not all zones use a blockmap. Note that
770 * the entire root blockmap is cached in the hammer_mount structure.
772 struct hammer_blockmap vol0_blockmap[HAMMER_MAX_ZONES];
775 * Array of zone-2 addresses for undo FIFO.
777 hammer_off_t vol0_undo_array[HAMMER_MAX_UNDO_BIGBLOCKS];
778 } *hammer_volume_ondisk_t;
780 #define HAMMER_ROOT_VOLNO 0
782 #define HAMMER_VOLF_NEEDFLUSH 0x0004 /* volume needs flush */
784 #define HAMMER_VOL_CRCSIZE1 \
785 offsetof(struct hammer_volume_ondisk, vol_crc)
786 #define HAMMER_VOL_CRCSIZE2 \
787 (sizeof(struct hammer_volume_ondisk) - HAMMER_VOL_CRCSIZE1 - \
788 sizeof(hammer_crc_t))
790 #define HAMMER_VOL_VERSION_MIN 1 /* minimum supported version */
791 #define HAMMER_VOL_VERSION_DEFAULT 6 /* newfs default version */
792 #define HAMMER_VOL_VERSION_WIP 7 /* version >= this is WIP */
793 #define HAMMER_VOL_VERSION_MAX 6 /* maximum supported version */
795 #define HAMMER_VOL_VERSION_ONE 1
796 #define HAMMER_VOL_VERSION_TWO 2 /* new dirent layout (2.3+) */
797 #define HAMMER_VOL_VERSION_THREE 3 /* new snapshot layout (2.5+) */
798 #define HAMMER_VOL_VERSION_FOUR 4 /* new undo/flush (2.5+) */
799 #define HAMMER_VOL_VERSION_FIVE 5 /* dedup (2.9+) */
800 #define HAMMER_VOL_VERSION_SIX 6 /* DIRHASH_ALG1 */
803 * Translate a zone-2 address to physical address
805 #define hammer_xlate_to_phys(volume, zone2_offset) \
806 ((volume)->vol_buf_beg + HAMMER_OFF_SHORT_ENCODE(zone2_offset))
809 * Effective per-volume filesystem capacity including big-blocks for layer1/2
811 #define HAMMER_VOL_BUF_SIZE(volume) \
812 ((volume)->vol_buf_end - (volume)->vol_buf_beg)
815 * Record types are fairly straightforward. The B-Tree includes the record
816 * type in its index sort.
818 #define HAMMER_RECTYPE_UNKNOWN 0x0000
819 #define HAMMER_RECTYPE_INODE 0x0001 /* inode in obj_id space */
820 #define HAMMER_RECTYPE_DATA 0x0010
821 #define HAMMER_RECTYPE_DIRENTRY 0x0011
822 #define HAMMER_RECTYPE_DB 0x0012
823 #define HAMMER_RECTYPE_EXT 0x0013 /* ext attributes */
824 #define HAMMER_RECTYPE_FIX 0x0014 /* fixed attribute */
825 #define HAMMER_RECTYPE_PFS 0x0015 /* PFS management */
826 #define HAMMER_RECTYPE_SNAPSHOT 0x0016 /* Snapshot management */
827 #define HAMMER_RECTYPE_CONFIG 0x0017 /* hammer cleanup config */
828 #define HAMMER_RECTYPE_MAX 0xFFFF
830 #define HAMMER_RECTYPE_ENTRY_START (HAMMER_RECTYPE_INODE + 1)
831 #define HAMMER_RECTYPE_CLEAN_START HAMMER_RECTYPE_EXT
833 #define HAMMER_FIXKEY_SYMLINK 1
835 #define HAMMER_OBJTYPE_UNKNOWN 0 /* never exists on-disk as unknown */
836 #define HAMMER_OBJTYPE_DIRECTORY 1
837 #define HAMMER_OBJTYPE_REGFILE 2
838 #define HAMMER_OBJTYPE_DBFILE 3
839 #define HAMMER_OBJTYPE_FIFO 4
840 #define HAMMER_OBJTYPE_CDEV 5
841 #define HAMMER_OBJTYPE_BDEV 6
842 #define HAMMER_OBJTYPE_SOFTLINK 7
843 #define HAMMER_OBJTYPE_PSEUDOFS 8 /* pseudo filesystem obj */
844 #define HAMMER_OBJTYPE_SOCKET 9
847 * HAMMER inode attribute data
849 * The data reference for a HAMMER inode points to this structure. Any
850 * modifications to the contents of this structure will result in a
851 * replacement operation.
853 * parent_obj_id is only valid for directories (which cannot be hard-linked),
854 * and specifies the parent directory obj_id. This field will also be set
855 * for non-directory inodes as a recovery aid, but can wind up holding
856 * stale information. However, since object id's are not reused, the worse
857 * that happens is that the recovery code is unable to use it.
858 * A parent_obj_id of 0 means it's a root inode of root or non-root PFS.
860 * NOTE: Future note on directory hardlinks. We can implement a record type
861 * which allows us to point to multiple parent directories.
863 typedef struct hammer_inode_data {
864 uint16_t version; /* inode data version */
865 uint16_t mode; /* basic unix permissions */
866 uint32_t uflags; /* chflags */
867 uint32_t rmajor; /* used by device nodes */
868 uint32_t rminor; /* used by device nodes */
870 int64_t parent_obj_id; /* parent directory obj_id */
875 uint8_t cap_flags; /* capability support flags (extension) */
878 uint64_t nlinks; /* hard links */
879 uint64_t size; /* filesystem object size */
881 char symlink[24]; /* HAMMER_INODE_BASESYMLEN */
883 uint64_t mtime; /* mtime must be second-to-last */
884 uint64_t atime; /* atime must be last */
885 } *hammer_inode_data_t;
888 * Neither mtime nor atime upates are CRCd by the B-Tree element.
889 * mtime updates have UNDO, atime updates do not.
891 #define HAMMER_INODE_CRCSIZE \
892 offsetof(struct hammer_inode_data, mtime)
894 #define HAMMER_INODE_DATA_VERSION 1
895 #define HAMMER_OBJID_ROOT 1 /* root inodes # */
896 #define HAMMER_INODE_BASESYMLEN 24 /* see ext.symlink */
899 * Capability & implementation flags.
901 * HAMMER_INODE_CAP_DIR_LOCAL_INO - Use inode B-Tree localization
902 * for directory entries. Also see HAMMER_DIR_INODE_LOCALIZATION().
904 #define HAMMER_INODE_CAP_DIRHASH_MASK 0x03 /* directory: hash algorithm */
905 #define HAMMER_INODE_CAP_DIRHASH_ALG0 0x00
906 #define HAMMER_INODE_CAP_DIRHASH_ALG1 0x01
907 #define HAMMER_INODE_CAP_DIRHASH_ALG2 0x02
908 #define HAMMER_INODE_CAP_DIRHASH_ALG3 0x03
909 #define HAMMER_INODE_CAP_DIR_LOCAL_INO 0x04 /* use inode localization */
911 #define HAMMER_DATA_DOALIGN(offset) \
912 (((offset) + 15) & ~15)
913 #define HAMMER_DATA_DOALIGN_WITH(type, offset) \
914 (((type)(offset) + 15) & (~(type)15))
917 * A HAMMER directory entry associates a HAMMER filesystem object with a
918 * namespace. It is hooked into a pseudo-filesystem (with its own inode
919 * numbering space) in the filesystem by setting the high 16 bits of the
920 * localization field. The low 16 bits must be 0 and are reserved for
923 * Directory entries are indexed with a 128 bit namekey rather then an
924 * offset. A portion of the namekey is an iterator/randomizer to deal
927 * NOTE: leaf.base.obj_type from the related B-Tree leaf entry holds
928 * the filesystem object type of obj_id, e.g. a den_type equivalent.
929 * It is not stored in hammer_direntry_data.
931 * NOTE: name field / the filename data reference is NOT terminated with \0.
933 typedef struct hammer_direntry_data {
934 int64_t obj_id; /* object being referenced */
935 uint32_t localization; /* identify pseudo-filesystem */
937 char name[16]; /* name (extended) */
938 } *hammer_direntry_data_t;
940 #define HAMMER_ENTRY_NAME_OFF offsetof(struct hammer_direntry_data, name[0])
941 #define HAMMER_ENTRY_SIZE(nlen) offsetof(struct hammer_direntry_data, name[nlen])
944 * Symlink data which does not fit in the inode is stored in a separate
947 typedef struct hammer_symlink_data {
948 char name[16]; /* name (extended) */
949 } *hammer_symlink_data_t;
951 #define HAMMER_SYMLINK_NAME_OFF offsetof(struct hammer_symlink_data, name[0])
954 * The root inode for the primary filesystem and root inode for any
955 * pseudo-fs may be tagged with an optional data structure using
956 * HAMMER_RECTYPE_PFS and localization id. This structure allows
957 * the node to be used as a mirroring master or slave.
959 * When operating as a slave CD's into the node automatically become read-only
960 * and as-of sync_end_tid.
962 * When operating as a master the read PFSD info sets sync_end_tid to
963 * the most recently flushed TID.
965 * sync_low_tid is not yet used but will represent the highest pruning
966 * end-point, after which full history is available.
968 * We need to pack this structure making it equally sized on both 32-bit and
969 * 64-bit machines as it is part of struct hammer_ioc_mrecord_pfs which is
970 * send over the wire in hammer mirror operations. Only on 64-bit machines
971 * the size of this struct differ when packed or not. This leads us to the
972 * situation where old 64-bit systems (using the non-packed structure),
973 * which were never able to mirror to/from 32-bit systems, are now no longer
974 * able to mirror to/from newer 64-bit systems (using the packed structure).
976 struct hammer_pseudofs_data {
977 hammer_tid_t sync_low_tid; /* full history beyond this point */
978 hammer_tid_t sync_beg_tid; /* earliest tid w/ full history avail */
979 hammer_tid_t sync_end_tid; /* current synchronizatoin point */
980 uint64_t sync_beg_ts; /* real-time of last completed sync */
981 uint64_t sync_end_ts; /* initiation of current sync cycle */
982 uuid_t shared_uuid; /* shared uuid (match required) */
983 uuid_t unique_uuid; /* unique uuid of this master/slave */
984 int32_t reserved01; /* reserved for future master_id */
985 int32_t mirror_flags; /* misc flags */
986 char label[64]; /* filesystem space label */
987 char snapshots[64]; /* softlink dir for pruning */
988 int32_t reserved02; /* was prune_{time,freq} */
989 int32_t reserved03; /* was reblock_{time,freq} */
990 int32_t reserved04; /* was snapshot_freq */
991 int32_t prune_min; /* do not prune recent history */
992 int32_t prune_max; /* do not retain history beyond here */
993 int32_t reserved[16];
996 typedef struct hammer_pseudofs_data *hammer_pseudofs_data_t;
998 #define HAMMER_PFSD_SLAVE 0x00000001
999 #define HAMMER_PFSD_DELETED 0x80000000
1001 #define hammer_is_pfs_slave(pfsd) \
1002 (((pfsd)->mirror_flags & HAMMER_PFSD_SLAVE) != 0)
1003 #define hammer_is_pfs_master(pfsd) \
1004 (!hammer_is_pfs_slave(pfsd))
1005 #define hammer_is_pfs_deleted(pfsd) \
1006 (((pfsd)->mirror_flags & HAMMER_PFSD_DELETED) != 0)
1008 #define HAMMER_MAX_PFS 65536
1009 #define HAMMER_MAX_PFSID (HAMMER_MAX_PFS - 1)
1010 #define HAMMER_ROOT_PFSID 0
1013 * Snapshot meta-data { Objid = HAMMER_OBJID_ROOT, Key = tid, rectype = SNAPSHOT }.
1015 * Snapshot records replace the old <fs>/snapshots/<softlink> methodology. Snapshot
1016 * records are mirrored but may be independantly managed once they are laid down on
1019 * NOTE: The b-tree key is signed, the tid is not, so callers must still sort the
1022 * NOTE: Reserved fields must be zero (as usual)
1024 typedef struct hammer_snapshot_data {
1025 hammer_tid_t tid; /* the snapshot TID itself (== key) */
1026 uint64_t ts; /* real-time when snapshot was made */
1027 uint64_t reserved01;
1028 uint64_t reserved02;
1029 char label[64]; /* user-supplied description */
1030 uint64_t reserved03[4];
1031 } *hammer_snapshot_data_t;
1034 * Config meta-data { ObjId = HAMMER_OBJID_ROOT, Key = 0, rectype = CONFIG }.
1036 * Used to store the hammer cleanup config. This data is not mirrored.
1038 typedef struct hammer_config_data {
1040 } *hammer_config_data_t;
1043 * Rollup various structures embedded as record data
1045 typedef union hammer_data_ondisk {
1046 struct hammer_direntry_data entry;
1047 struct hammer_inode_data inode;
1048 struct hammer_symlink_data symlink;
1049 struct hammer_pseudofs_data pfsd;
1050 struct hammer_snapshot_data snap;
1051 struct hammer_config_data config;
1052 } *hammer_data_ondisk_t;
1055 * Ondisk layout of B-Tree related structures
1057 #include "hammer_btree.h"
1059 #define HAMMER_DIR_INODE_LOCALIZATION(ino_data) \
1060 (((ino_data)->cap_flags & HAMMER_INODE_CAP_DIR_LOCAL_INO) ? \
1061 HAMMER_LOCALIZE_INODE : \
1062 HAMMER_LOCALIZE_MISC)
1064 #endif /* !VFS_HAMMER_DISK_H_ */