Commit | Line | Data |
---|---|---|
8750964d MD |
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 | * | |
44a83111 | 34 | * $DragonFly: src/sys/vfs/hammer/hammer_disk.h,v 1.55 2008/11/13 02:18:43 dillon Exp $ |
8750964d MD |
35 | */ |
36 | ||
7dc57964 MD |
37 | #ifndef VFS_HAMMER_DISK_H_ |
38 | #define VFS_HAMMER_DISK_H_ | |
39 | ||
8750964d MD |
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 | * | |
00e31441 | 56 | * A HAMMER filesystem may span multiple volumes. |
8750964d MD |
57 | * |
58 | * A HAMMER filesystem uses a 16K filesystem buffer size. All filesystem | |
c60bb2c5 MD |
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. | |
40043e7f | 62 | * |
4a2796f3 MD |
63 | * 64K X-bufs are used for blocks >= a file's 1MB mark. |
64 | * | |
40043e7f MD |
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 | |
8750964d | 68 | */ |
40043e7f | 69 | #define HAMMER_BUFSIZE 16384 |
4a2796f3 MD |
70 | #define HAMMER_XBUFSIZE 65536 |
71 | #define HAMMER_XDEMARC (1024 * 1024) | |
40043e7f | 72 | #define HAMMER_BUFMASK (HAMMER_BUFSIZE - 1) |
4a2796f3 | 73 | #define HAMMER_XBUFMASK (HAMMER_XBUFSIZE - 1) |
40043e7f MD |
74 | #define HAMMER_BUFFER_BITS 14 |
75 | ||
76 | #if (1 << HAMMER_BUFFER_BITS) != HAMMER_BUFSIZE | |
77 | #error "HAMMER_BUFFER_BITS BROKEN" | |
78 | #endif | |
8750964d | 79 | |
47197d71 MD |
80 | #define HAMMER_BUFSIZE64 ((u_int64_t)HAMMER_BUFSIZE) |
81 | #define HAMMER_BUFMASK64 ((u_int64_t)HAMMER_BUFMASK) | |
82 | ||
4a2796f3 MD |
83 | #define HAMMER_XBUFSIZE64 ((u_int64_t)HAMMER_XBUFSIZE) |
84 | #define HAMMER_XBUFMASK64 ((u_int64_t)HAMMER_XBUFMASK) | |
85 | ||
47197d71 MD |
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 | ||
6b3804c9 MD |
94 | #define HAMMER_OFF_BAD ((hammer_off_t)-1) |
95 | ||
94509284 MD |
96 | /* |
97 | * The current limit of volumes that can make up a HAMMER FS | |
98 | */ | |
99 | #define HAMMER_MAX_VOLUMES 256 | |
100 | ||
8750964d MD |
101 | /* |
102 | * Hammer transction ids are 64 bit unsigned integers and are usually | |
103 | * synchronized with the time of day in nanoseconds. | |
47197d71 MD |
104 | * |
105 | * Hammer offsets are used for FIFO indexing and embed a cycle counter | |
106 | * and volume number in addition to the offset. Most offsets are required | |
107 | * to be 64-byte aligned. | |
8750964d MD |
108 | */ |
109 | typedef u_int64_t hammer_tid_t; | |
47197d71 | 110 | typedef u_int64_t hammer_off_t; |
059819e3 MD |
111 | typedef u_int32_t hammer_seq_t; |
112 | typedef u_int32_t hammer_crc_t; | |
47197d71 MD |
113 | |
114 | #define HAMMER_MIN_TID 0ULL /* unsigned */ | |
115 | #define HAMMER_MAX_TID 0xFFFFFFFFFFFFFFFFULL /* unsigned */ | |
116 | #define HAMMER_MIN_KEY -0x8000000000000000LL /* signed */ | |
117 | #define HAMMER_MAX_KEY 0x7FFFFFFFFFFFFFFFLL /* signed */ | |
118 | #define HAMMER_MIN_OBJID HAMMER_MIN_KEY /* signed */ | |
119 | #define HAMMER_MAX_OBJID HAMMER_MAX_KEY /* signed */ | |
120 | #define HAMMER_MIN_RECTYPE 0x0U /* unsigned */ | |
121 | #define HAMMER_MAX_RECTYPE 0xFFFFU /* unsigned */ | |
122 | #define HAMMER_MIN_OFFSET 0ULL /* unsigned */ | |
123 | #define HAMMER_MAX_OFFSET 0xFFFFFFFFFFFFFFFFULL /* unsigned */ | |
124 | ||
125 | /* | |
126 | * hammer_off_t has several different encodings. Note that not all zones | |
127 | * encode a vol_no. | |
128 | * | |
cb51be26 | 129 | * zone 0: reserved for sanity |
47197d71 MD |
130 | * zone 1 (z,v,o): raw volume relative (offset 0 is the volume header) |
131 | * zone 2 (z,v,o): raw buffer relative (offset 0 is the first buffer) | |
cb51be26 MD |
132 | * zone 3 (z,o): undo fifo - actually fixed phys array in vol hdr |
133 | * zone 4 (z,v,o): freemap - only real blockmap | |
134 | * zone 8 (z,v,o): B-Tree - actually zone-2 address | |
135 | * zone 9 (z,v,o): Record - actually zone-2 address | |
136 | * zone 10 (z,v,o): Large-data - actually zone-2 address | |
137 | * zone 15: reserved for sanity | |
d40bfeca MD |
138 | * |
139 | * layer1/layer2 direct map: | |
140 | * zzzzvvvvvvvvoooo oooooooooooooooo oooooooooooooooo oooooooooooooooo | |
141 | * ----111111111111 1111112222222222 222222222ooooooo oooooooooooooooo | |
47197d71 MD |
142 | */ |
143 | ||
144 | #define HAMMER_ZONE_RAW_VOLUME 0x1000000000000000ULL | |
145 | #define HAMMER_ZONE_RAW_BUFFER 0x2000000000000000ULL | |
40043e7f | 146 | #define HAMMER_ZONE_UNDO 0x3000000000000000ULL |
c3be93f2 | 147 | #define HAMMER_ZONE_FREEMAP 0x4000000000000000ULL |
40043e7f MD |
148 | #define HAMMER_ZONE_RESERVED05 0x5000000000000000ULL |
149 | #define HAMMER_ZONE_RESERVED06 0x6000000000000000ULL | |
150 | #define HAMMER_ZONE_RESERVED07 0x7000000000000000ULL | |
151 | #define HAMMER_ZONE_BTREE 0x8000000000000000ULL | |
bf3b416b | 152 | #define HAMMER_ZONE_META 0x9000000000000000ULL |
40043e7f MD |
153 | #define HAMMER_ZONE_LARGE_DATA 0xA000000000000000ULL |
154 | #define HAMMER_ZONE_SMALL_DATA 0xB000000000000000ULL | |
155 | #define HAMMER_ZONE_RESERVED0C 0xC000000000000000ULL | |
156 | #define HAMMER_ZONE_RESERVED0D 0xD000000000000000ULL | |
157 | #define HAMMER_ZONE_RESERVED0E 0xE000000000000000ULL | |
cb51be26 | 158 | #define HAMMER_ZONE_UNAVAIL 0xF000000000000000ULL |
40043e7f MD |
159 | |
160 | #define HAMMER_ZONE_RAW_VOLUME_INDEX 1 | |
161 | #define HAMMER_ZONE_RAW_BUFFER_INDEX 2 | |
162 | #define HAMMER_ZONE_UNDO_INDEX 3 | |
c3be93f2 | 163 | #define HAMMER_ZONE_FREEMAP_INDEX 4 |
40043e7f | 164 | #define HAMMER_ZONE_BTREE_INDEX 8 |
bf3b416b | 165 | #define HAMMER_ZONE_META_INDEX 9 |
40043e7f MD |
166 | #define HAMMER_ZONE_LARGE_DATA_INDEX 10 |
167 | #define HAMMER_ZONE_SMALL_DATA_INDEX 11 | |
cb51be26 | 168 | #define HAMMER_ZONE_UNAVAIL_INDEX 15 /* unavailable */ |
f03c9cf4 | 169 | |
40043e7f | 170 | #define HAMMER_MAX_ZONES 16 |
47197d71 MD |
171 | |
172 | #define HAMMER_VOL_ENCODE(vol_no) \ | |
173 | ((hammer_off_t)((vol_no) & 255) << 52) | |
174 | #define HAMMER_VOL_DECODE(ham_off) \ | |
175 | (int32_t)(((hammer_off_t)(ham_off) >> 52) & 255) | |
40043e7f MD |
176 | #define HAMMER_ZONE_DECODE(ham_off) \ |
177 | (int32_t)(((hammer_off_t)(ham_off) >> 60)) | |
f03c9cf4 MD |
178 | #define HAMMER_ZONE_ENCODE(zone, ham_off) \ |
179 | (((hammer_off_t)(zone) << 60) | (ham_off)) | |
47197d71 MD |
180 | #define HAMMER_SHORT_OFF_ENCODE(offset) \ |
181 | ((hammer_off_t)(offset) & HAMMER_OFF_SHORT_MASK) | |
182 | #define HAMMER_LONG_OFF_ENCODE(offset) \ | |
183 | ((hammer_off_t)(offset) & HAMMER_OFF_LONG_MASK) | |
184 | ||
185 | #define HAMMER_ENCODE_RAW_VOLUME(vol_no, offset) \ | |
186 | (HAMMER_ZONE_RAW_VOLUME | \ | |
187 | HAMMER_VOL_ENCODE(vol_no) | \ | |
188 | HAMMER_SHORT_OFF_ENCODE(offset)) | |
189 | ||
190 | #define HAMMER_ENCODE_RAW_BUFFER(vol_no, offset) \ | |
191 | (HAMMER_ZONE_RAW_BUFFER | \ | |
192 | HAMMER_VOL_ENCODE(vol_no) | \ | |
193 | HAMMER_SHORT_OFF_ENCODE(offset)) | |
8750964d | 194 | |
c3be93f2 MD |
195 | #define HAMMER_ENCODE_FREEMAP(vol_no, offset) \ |
196 | (HAMMER_ZONE_FREEMAP | \ | |
197 | HAMMER_VOL_ENCODE(vol_no) | \ | |
198 | HAMMER_SHORT_OFF_ENCODE(offset)) | |
199 | ||
40043e7f MD |
200 | /* |
201 | * Large-Block backing store | |
202 | * | |
203 | * A blockmap is a two-level map which translates a blockmap-backed zone | |
204 | * offset into a raw zone 2 offset. Each layer handles 18 bits. The 8M | |
205 | * large-block size is 23 bits so two layers gives us 23+18+18 = 59 bits | |
206 | * of address space. | |
df2ccbac MD |
207 | * |
208 | * When using hinting for a blockmap lookup, the hint is lost when the | |
209 | * scan leaves the HINTBLOCK, which is typically several LARGEBLOCK's. | |
210 | * HINTBLOCK is a heuristic. | |
40043e7f | 211 | */ |
df2ccbac MD |
212 | #define HAMMER_HINTBLOCK_SIZE (HAMMER_LARGEBLOCK_SIZE * 4) |
213 | #define HAMMER_HINTBLOCK_MASK64 ((u_int64_t)HAMMER_HINTBLOCK_SIZE - 1) | |
40043e7f | 214 | #define HAMMER_LARGEBLOCK_SIZE (8192 * 1024) |
df2ccbac | 215 | #define HAMMER_LARGEBLOCK_OVERFILL (6144 * 1024) |
c3be93f2 | 216 | #define HAMMER_LARGEBLOCK_SIZE64 ((u_int64_t)HAMMER_LARGEBLOCK_SIZE) |
40043e7f MD |
217 | #define HAMMER_LARGEBLOCK_MASK (HAMMER_LARGEBLOCK_SIZE - 1) |
218 | #define HAMMER_LARGEBLOCK_MASK64 ((u_int64_t)HAMMER_LARGEBLOCK_SIZE - 1) | |
219 | #define HAMMER_LARGEBLOCK_BITS 23 | |
220 | #if (1 << HAMMER_LARGEBLOCK_BITS) != HAMMER_LARGEBLOCK_SIZE | |
221 | #error "HAMMER_LARGEBLOCK_BITS BROKEN" | |
222 | #endif | |
223 | ||
224 | #define HAMMER_BUFFERS_PER_LARGEBLOCK \ | |
225 | (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE) | |
226 | #define HAMMER_BUFFERS_PER_LARGEBLOCK_MASK \ | |
227 | (HAMMER_BUFFERS_PER_LARGEBLOCK - 1) | |
228 | #define HAMMER_BUFFERS_PER_LARGEBLOCK_MASK64 \ | |
229 | ((hammer_off_t)HAMMER_BUFFERS_PER_LARGEBLOCK_MASK) | |
230 | ||
5de0c0e5 MD |
231 | /* |
232 | * Maximum number of mirrors operating in master mode (multi-master | |
233 | * clustering and mirroring). | |
234 | */ | |
235 | #define HAMMER_MAX_MASTERS 16 | |
236 | ||
c3be93f2 | 237 | /* |
cb51be26 MD |
238 | * The blockmap is somewhat of a degenerate structure. HAMMER only actually |
239 | * uses it in its original incarnation to implement the free-map. | |
bf686dbe | 240 | * |
cb51be26 MD |
241 | * zone:1 raw volume (no blockmap) |
242 | * zone:2 raw buffer (no blockmap) | |
243 | * zone:3 undo-map (direct layer2 array in volume header) | |
244 | * zone:4 free-map (the only real blockmap) | |
245 | * zone:8-15 zone id used to classify big-block only, address is actually | |
246 | * a zone-2 address. | |
c3be93f2 MD |
247 | */ |
248 | struct hammer_blockmap { | |
249 | hammer_off_t phys_offset; /* zone-2 physical offset */ | |
bf686dbe | 250 | hammer_off_t first_offset; /* zone-X logical offset (zone 3) */ |
c3be93f2 MD |
251 | hammer_off_t next_offset; /* zone-X logical offset */ |
252 | hammer_off_t alloc_offset; /* zone-X logical offset */ | |
c3be93f2 | 253 | u_int32_t reserved01; |
19619882 | 254 | hammer_crc_t entry_crc; |
c3be93f2 | 255 | }; |
40043e7f | 256 | |
c3be93f2 | 257 | typedef struct hammer_blockmap *hammer_blockmap_t; |
40043e7f | 258 | |
19619882 MD |
259 | #define HAMMER_BLOCKMAP_CRCSIZE \ |
260 | offsetof(struct hammer_blockmap, entry_crc) | |
261 | ||
c3be93f2 MD |
262 | /* |
263 | * The blockmap is a 2-layer entity made up of big-blocks. The first layer | |
264 | * contains 262144 32-byte entries (18 bits), the second layer contains | |
265 | * 524288 16-byte entries (19 bits), representing 8MB (23 bit) blockmaps. | |
266 | * 18+19+23 = 60 bits. The top four bits are the zone id. | |
267 | * | |
cb51be26 MD |
268 | * Currently only the freemap utilizes both layers in all their glory. |
269 | * All primary data/meta-data zones actually encode a zone-2 address | |
270 | * requiring no real blockmap translation. | |
c3be93f2 | 271 | * |
cb51be26 MD |
272 | * The freemap uses the upper 8 bits of layer-1 to identify the volume, |
273 | * thus any space allocated via the freemap can be directly translated | |
274 | * to a zone:2 (or zone:8-15) address. | |
c3be93f2 | 275 | * |
cb51be26 | 276 | * zone-X blockmap offset: [z:4][layer1:18][layer2:19][bigblock:23] |
c3be93f2 MD |
277 | */ |
278 | struct hammer_blockmap_layer1 { | |
279 | hammer_off_t blocks_free; /* big-blocks free */ | |
280 | hammer_off_t phys_offset; /* UNAVAIL or zone-2 */ | |
c3be93f2 | 281 | hammer_off_t reserved01; |
19619882 MD |
282 | hammer_crc_t layer2_crc; /* xor'd crc's of HAMMER_BLOCKSIZE */ |
283 | /* (not yet used) */ | |
284 | hammer_crc_t layer1_crc; /* MUST BE LAST FIELD OF STRUCTURE*/ | |
c3be93f2 | 285 | }; |
40043e7f | 286 | |
47637bff MD |
287 | typedef struct hammer_blockmap_layer1 *hammer_blockmap_layer1_t; |
288 | ||
19619882 MD |
289 | #define HAMMER_LAYER1_CRCSIZE \ |
290 | offsetof(struct hammer_blockmap_layer1, layer1_crc) | |
291 | ||
320a5c59 MD |
292 | /* |
293 | * layer2 entry for 8MB bigblock. | |
294 | * | |
295 | * NOTE: bytes_free is signed and can legally go negative if/when data | |
296 | * de-dup occurs. This field will never go higher than | |
297 | * HAMMER_LARGEBLOCK_SIZE. If exactly HAMMER_LARGEBLOCK_SIZE | |
298 | * the big-block is completely free. | |
299 | */ | |
c3be93f2 | 300 | struct hammer_blockmap_layer2 { |
cb51be26 MD |
301 | u_int8_t zone; /* typed allocation zone */ |
302 | u_int8_t unused01; | |
303 | u_int16_t unused02; | |
304 | u_int32_t append_off; /* allocatable space index */ | |
320a5c59 | 305 | int32_t bytes_free; /* bytes free within this bigblock */ |
19619882 | 306 | hammer_crc_t entry_crc; |
40043e7f MD |
307 | }; |
308 | ||
47637bff MD |
309 | typedef struct hammer_blockmap_layer2 *hammer_blockmap_layer2_t; |
310 | ||
19619882 MD |
311 | #define HAMMER_LAYER2_CRCSIZE \ |
312 | offsetof(struct hammer_blockmap_layer2, entry_crc) | |
313 | ||
c3be93f2 MD |
314 | #define HAMMER_BLOCKMAP_FREE 0ULL |
315 | #define HAMMER_BLOCKMAP_UNAVAIL ((hammer_off_t)-1LL) | |
316 | ||
317 | #define HAMMER_BLOCKMAP_RADIX1 /* 262144 (18) */ \ | |
318 | (HAMMER_LARGEBLOCK_SIZE / sizeof(struct hammer_blockmap_layer1)) | |
319 | #define HAMMER_BLOCKMAP_RADIX2 /* 524288 (19) */ \ | |
320 | (HAMMER_LARGEBLOCK_SIZE / sizeof(struct hammer_blockmap_layer2)) | |
321 | ||
322 | #define HAMMER_BLOCKMAP_RADIX1_PERBUFFER \ | |
323 | (HAMMER_BLOCKMAP_RADIX1 / (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE)) | |
324 | #define HAMMER_BLOCKMAP_RADIX2_PERBUFFER \ | |
325 | (HAMMER_BLOCKMAP_RADIX2 / (HAMMER_LARGEBLOCK_SIZE / HAMMER_BUFSIZE)) | |
326 | ||
327 | #define HAMMER_BLOCKMAP_LAYER1 /* 18+19+23 */ \ | |
328 | (HAMMER_BLOCKMAP_RADIX1 * HAMMER_BLOCKMAP_LAYER2) | |
6f97fce3 | 329 | #define HAMMER_BLOCKMAP_LAYER2 /* 19+23 - 4TB */ \ |
c3be93f2 MD |
330 | (HAMMER_BLOCKMAP_RADIX2 * HAMMER_LARGEBLOCK_SIZE64) |
331 | ||
332 | #define HAMMER_BLOCKMAP_LAYER1_MASK (HAMMER_BLOCKMAP_LAYER1 - 1) | |
333 | #define HAMMER_BLOCKMAP_LAYER2_MASK (HAMMER_BLOCKMAP_LAYER2 - 1) | |
334 | ||
335 | /* | |
336 | * byte offset within layer1 or layer2 big-block for the entry representing | |
337 | * a zone-2 physical offset. | |
338 | */ | |
339 | #define HAMMER_BLOCKMAP_LAYER1_OFFSET(zone2_offset) \ | |
340 | (((zone2_offset) & HAMMER_BLOCKMAP_LAYER1_MASK) / \ | |
341 | HAMMER_BLOCKMAP_LAYER2 * sizeof(struct hammer_blockmap_layer1)) | |
342 | ||
343 | #define HAMMER_BLOCKMAP_LAYER2_OFFSET(zone2_offset) \ | |
344 | (((zone2_offset) & HAMMER_BLOCKMAP_LAYER2_MASK) / \ | |
345 | HAMMER_LARGEBLOCK_SIZE64 * sizeof(struct hammer_blockmap_layer2)) | |
66325755 | 346 | |
bf686dbe MD |
347 | /* |
348 | * HAMMER UNDO parameters. The UNDO fifo is mapped directly in the volume | |
cb51be26 | 349 | * header with an array of layer2 structures. A maximum of (128x8MB) = 1GB |
bf686dbe MD |
350 | * may be reserved. The size of the undo fifo is usually set a newfs time |
351 | * but can be adjusted if the filesystem is taken offline. | |
352 | */ | |
cb51be26 | 353 | #define HAMMER_UNDO_LAYER2 128 /* max layer2 undo mapping entries */ |
bf686dbe | 354 | |
9380c752 | 355 | /* |
36f82b23 MD |
356 | * All on-disk HAMMER structures which make up elements of the UNDO FIFO |
357 | * contain a hammer_fifo_head and hammer_fifo_tail structure. This structure | |
40043e7f MD |
358 | * contains all the information required to validate the fifo element |
359 | * and to scan the fifo in either direction. The head is typically embedded | |
360 | * in higher level hammer on-disk structures while the tail is typically | |
361 | * out-of-band. hdr_size is the size of the whole mess, including the tail. | |
47197d71 | 362 | * |
36f82b23 MD |
363 | * All undo structures are guaranteed to not cross a 16K filesystem |
364 | * buffer boundary. Most undo structures are fairly small. Data spaces | |
365 | * are not immediately reused by HAMMER so file data is not usually recorded | |
366 | * as part of an UNDO. | |
40043e7f MD |
367 | * |
368 | * PAD elements are allowed to take up only 8 bytes of space as a special | |
369 | * case, containing only hdr_signature, hdr_type, and hdr_size fields, | |
370 | * and with the tail overloaded onto the head structure for 8 bytes total. | |
36f82b23 MD |
371 | * |
372 | * Every undo record has a sequence number. This number is unrelated to | |
373 | * transaction ids and instead collects the undo transactions associated | |
374 | * with a single atomic operation. A larger transactional operation, such | |
375 | * as a remove(), may consist of several smaller atomic operations | |
376 | * representing raw meta-data operations. | |
02428fb6 MD |
377 | * |
378 | * HAMMER VERSION 4 CHANGES | |
379 | * | |
380 | * In HAMMER version 4 the undo structure alignment is reduced from 16384 | |
381 | * to 512 bytes in order to ensure that each 512 byte sector begins with | |
382 | * a header. The reserved01 field in the header is now a 32 bit sequence | |
383 | * number. This allows the recovery code to detect missing sectors | |
384 | * without relying on the 32-bit crc and to definitively identify the current | |
385 | * undo sequence space without having to rely on information from the volume | |
386 | * header. In addition, new REDO entries in the undo space are used to | |
387 | * record write, write/extend, and transaction id updates. | |
388 | * | |
389 | * The grand result is: | |
390 | * | |
391 | * (1) The volume header no longer needs to be synchronized for most | |
392 | * flush and fsync operations. | |
393 | * | |
394 | * (2) Most fsync operations need only lay down REDO records | |
395 | * | |
396 | * (3) Data overwrite for nohistory operations covered by REDO records | |
397 | * can be supported (instead of rolling a new block allocation), | |
398 | * by rolling UNDO for the prior contents of the data. | |
3045a179 MD |
399 | * |
400 | * HAMMER VERSION 5 CHANGES | |
401 | * | |
402 | * Hammer version 5 contains a minor adjustment making layer2's bytes_free | |
403 | * field signed, allowing dedup to push it into the negative domain. | |
9380c752 | 404 | */ |
36f82b23 | 405 | #define HAMMER_HEAD_ONDISK_SIZE 32 |
40043e7f | 406 | #define HAMMER_HEAD_ALIGN 8 |
47197d71 | 407 | #define HAMMER_HEAD_ALIGN_MASK (HAMMER_HEAD_ALIGN - 1) |
40043e7f | 408 | #define HAMMER_TAIL_ONDISK_SIZE 8 |
4c038e17 MD |
409 | #define HAMMER_HEAD_DOALIGN(bytes) \ |
410 | (((bytes) + HAMMER_HEAD_ALIGN_MASK) & ~HAMMER_HEAD_ALIGN_MASK) | |
47197d71 | 411 | |
02428fb6 MD |
412 | #define HAMMER_UNDO_ALIGN 512 |
413 | #define HAMMER_UNDO_ALIGN64 ((u_int64_t)512) | |
414 | #define HAMMER_UNDO_MASK (HAMMER_UNDO_ALIGN - 1) | |
415 | #define HAMMER_UNDO_MASK64 (HAMMER_UNDO_ALIGN64 - 1) | |
416 | ||
47197d71 MD |
417 | struct hammer_fifo_head { |
418 | u_int16_t hdr_signature; | |
419 | u_int16_t hdr_type; | |
02428fb6 MD |
420 | u_int32_t hdr_size; /* Aligned size of the whole mess */ |
421 | u_int32_t hdr_seq; /* Sequence number */ | |
19619882 | 422 | hammer_crc_t hdr_crc; /* XOR crc up to field w/ crc after field */ |
40043e7f MD |
423 | }; |
424 | ||
19619882 MD |
425 | #define HAMMER_FIFO_HEAD_CRCOFF offsetof(struct hammer_fifo_head, hdr_crc) |
426 | ||
40043e7f MD |
427 | struct hammer_fifo_tail { |
428 | u_int16_t tail_signature; | |
429 | u_int16_t tail_type; | |
430 | u_int32_t tail_size; /* aligned size of the whole mess */ | |
47197d71 MD |
431 | }; |
432 | ||
433 | typedef struct hammer_fifo_head *hammer_fifo_head_t; | |
40043e7f | 434 | typedef struct hammer_fifo_tail *hammer_fifo_tail_t; |
9380c752 | 435 | |
8750964d | 436 | /* |
47197d71 | 437 | * Fifo header types. |
8750964d | 438 | */ |
40043e7f | 439 | #define HAMMER_HEAD_TYPE_PAD (0x0040U|HAMMER_HEAD_FLAG_FREE) |
02428fb6 MD |
440 | #define HAMMER_HEAD_TYPE_DUMMY 0x0041U /* dummy entry w/seqno */ |
441 | #define HAMMER_HEAD_TYPE_42 0x0042U | |
40043e7f | 442 | #define HAMMER_HEAD_TYPE_UNDO 0x0043U /* random UNDO information */ |
02428fb6 MD |
443 | #define HAMMER_HEAD_TYPE_REDO 0x0044U /* data REDO / fast fsync */ |
444 | #define HAMMER_HEAD_TYPE_45 0x0045U | |
47197d71 | 445 | |
40043e7f | 446 | #define HAMMER_HEAD_FLAG_FREE 0x8000U /* Indicates object freed */ |
8750964d | 447 | |
47197d71 | 448 | #define HAMMER_HEAD_SIGNATURE 0xC84EU |
40043e7f | 449 | #define HAMMER_TAIL_SIGNATURE 0xC74FU |
47197d71 | 450 | |
36f82b23 MD |
451 | #define HAMMER_HEAD_SEQ_BEG 0x80000000U |
452 | #define HAMMER_HEAD_SEQ_END 0x40000000U | |
453 | #define HAMMER_HEAD_SEQ_MASK 0x3FFFFFFFU | |
454 | ||
47197d71 | 455 | /* |
bf686dbe | 456 | * Misc FIFO structures. |
02428fb6 | 457 | * |
47f363f1 | 458 | * UNDO - Raw meta-data media updates. |
47197d71 MD |
459 | */ |
460 | struct hammer_fifo_undo { | |
461 | struct hammer_fifo_head head; | |
bf686dbe MD |
462 | hammer_off_t undo_offset; /* zone-1 offset */ |
463 | int32_t undo_data_bytes; | |
464 | int32_t undo_reserved01; | |
47197d71 | 465 | /* followed by data */ |
8750964d MD |
466 | }; |
467 | ||
47f363f1 MD |
468 | /* |
469 | * REDO (HAMMER version 4+) - Logical file writes/truncates. | |
470 | * | |
471 | * REDOs contain information which will be duplicated in a later meta-data | |
472 | * update, allowing fast write()+fsync() operations. REDOs can be ignored | |
473 | * without harming filesystem integrity but must be processed if fsync() | |
474 | * semantics are desired. | |
475 | * | |
476 | * Unlike UNDOs which are processed backwards within the recovery span, | |
477 | * REDOs must be processed forwards starting further back (starting outside | |
478 | * the recovery span). | |
479 | * | |
480 | * WRITE - Write logical file (with payload). Executed both | |
481 | * out-of-span and in-span. Out-of-span WRITEs may be | |
482 | * filtered out by TERMs. | |
483 | * | |
484 | * TRUNC - Truncate logical file (no payload). Executed both | |
485 | * out-of-span and in-span. Out-of-span WRITEs may be | |
486 | * filtered out by TERMs. | |
487 | * | |
488 | * TERM_* - Indicates meta-data was committed (if out-of-span) or | |
489 | * will be rolled-back (in-span). Any out-of-span TERMs | |
490 | * matching earlier WRITEs remove those WRITEs from | |
491 | * consideration as they might conflict with a later data | |
492 | * commit (which is not being rolled-back). | |
493 | * | |
494 | * SYNC - The earliest in-span SYNC (the last one when scanning | |
495 | * backwards) tells the recovery code how far out-of-span | |
496 | * it must go to run REDOs. | |
497 | * | |
498 | * NOTE: WRITEs do not always have matching TERMs even under | |
499 | * perfect conditions because truncations might remove the | |
500 | * buffers from consideration. I/O problems can also remove | |
501 | * buffers from consideration. | |
502 | * | |
503 | * TRUNCSs do not always have matching TERMs because several | |
504 | * truncations may be aggregated together into a single TERM. | |
505 | */ | |
02428fb6 MD |
506 | struct hammer_fifo_redo { |
507 | struct hammer_fifo_head head; | |
508 | int64_t redo_objid; /* file being written */ | |
509 | hammer_off_t redo_offset; /* logical offset in file */ | |
510 | int32_t redo_data_bytes; | |
47f363f1 | 511 | u_int32_t redo_flags; |
c58123da MD |
512 | u_int32_t redo_localization; |
513 | u_int32_t redo_reserved; | |
6048b411 | 514 | u_int64_t redo_mtime; /* set mtime */ |
02428fb6 | 515 | }; |
8750964d | 516 | |
47f363f1 MD |
517 | #define HAMMER_REDO_WRITE 0x00000001 |
518 | #define HAMMER_REDO_TRUNC 0x00000002 | |
519 | #define HAMMER_REDO_TERM_WRITE 0x00000004 | |
520 | #define HAMMER_REDO_TERM_TRUNC 0x00000008 | |
521 | #define HAMMER_REDO_SYNC 0x00000010 | |
522 | ||
02428fb6 MD |
523 | union hammer_fifo_any { |
524 | struct hammer_fifo_head head; | |
525 | struct hammer_fifo_undo undo; | |
526 | struct hammer_fifo_redo redo; | |
bf686dbe MD |
527 | }; |
528 | ||
02428fb6 MD |
529 | typedef struct hammer_fifo_redo *hammer_fifo_redo_t; |
530 | typedef struct hammer_fifo_undo *hammer_fifo_undo_t; | |
531 | typedef union hammer_fifo_any *hammer_fifo_any_t; | |
532 | ||
c60bb2c5 | 533 | /* |
47197d71 | 534 | * Volume header types |
c60bb2c5 | 535 | */ |
8750964d | 536 | #define HAMMER_FSBUF_VOLUME 0xC8414D4DC5523031ULL /* HAMMER01 */ |
8750964d MD |
537 | #define HAMMER_FSBUF_VOLUME_REV 0x313052C54D4D41C8ULL /* (reverse endian) */ |
538 | ||
539 | /* | |
540 | * The B-Tree structures need hammer_fsbuf_head. | |
541 | */ | |
542 | #include "hammer_btree.h" | |
543 | ||
544 | /* | |
545 | * HAMMER Volume header | |
546 | * | |
547 | * A HAMMER filesystem is built from any number of block devices, Each block | |
47197d71 MD |
548 | * device contains a volume header followed by however many buffers fit |
549 | * into the volume. | |
8750964d | 550 | * |
47197d71 MD |
551 | * One of the volumes making up a HAMMER filesystem is the master, the |
552 | * rest are slaves. It does not have to be volume #0. | |
c60bb2c5 | 553 | * |
47197d71 MD |
554 | * The volume header takes up an entire 16K filesystem buffer and may |
555 | * represent up to 64KTB (65536 TB) of space. | |
a89aec1b MD |
556 | * |
557 | * Special field notes: | |
558 | * | |
559 | * vol_bot_beg - offset of boot area (mem_beg - bot_beg bytes) | |
560 | * vol_mem_beg - offset of memory log (clu_beg - mem_beg bytes) | |
47197d71 | 561 | * vol_buf_beg - offset of the first buffer. |
a89aec1b MD |
562 | * |
563 | * The memory log area allows a kernel to cache new records and data | |
564 | * in memory without allocating space in the actual filesystem to hold | |
565 | * the records and data. In the event that a filesystem becomes full, | |
566 | * any records remaining in memory can be flushed to the memory log | |
567 | * area. This allows the kernel to immediately return success. | |
8750964d | 568 | */ |
8750964d | 569 | |
a89aec1b MD |
570 | #define HAMMER_BOOT_MINBYTES (32*1024) |
571 | #define HAMMER_BOOT_NOMBYTES (64LL*1024*1024) | |
572 | #define HAMMER_BOOT_MAXBYTES (256LL*1024*1024) | |
573 | ||
574 | #define HAMMER_MEM_MINBYTES (256*1024) | |
575 | #define HAMMER_MEM_NOMBYTES (1LL*1024*1024*1024) | |
576 | #define HAMMER_MEM_MAXBYTES (64LL*1024*1024*1024) | |
577 | ||
8750964d | 578 | struct hammer_volume_ondisk { |
40043e7f MD |
579 | u_int64_t vol_signature;/* Signature */ |
580 | ||
a89aec1b MD |
581 | int64_t vol_bot_beg; /* byte offset of boot area or 0 */ |
582 | int64_t vol_mem_beg; /* byte offset of memory log or 0 */ | |
47197d71 MD |
583 | int64_t vol_buf_beg; /* byte offset of first buffer in volume */ |
584 | int64_t vol_buf_end; /* byte offset of volume EOF (on buf bndry) */ | |
8750964d MD |
585 | int64_t vol_locked; /* reserved clusters are >= this offset */ |
586 | ||
587 | uuid_t vol_fsid; /* identify filesystem */ | |
588 | uuid_t vol_fstype; /* identify filesystem type */ | |
589 | char vol_name[64]; /* Name of volume */ | |
590 | ||
591 | int32_t vol_no; /* volume number within filesystem */ | |
592 | int32_t vol_count; /* number of volumes making up FS */ | |
593 | ||
594 | u_int32_t vol_version; /* version control information */ | |
19619882 | 595 | hammer_crc_t vol_crc; /* header crc */ |
8750964d MD |
596 | u_int32_t vol_flags; /* volume flags */ |
597 | u_int32_t vol_rootvol; /* which volume is the root volume? */ | |
598 | ||
40043e7f | 599 | int32_t vol_reserved04; |
47197d71 | 600 | int32_t vol_reserved05; |
8750964d MD |
601 | u_int32_t vol_reserved06; |
602 | u_int32_t vol_reserved07; | |
603 | ||
fbc6e32a | 604 | int32_t vol_blocksize; /* for statfs only */ |
47197d71 | 605 | int32_t vol_reserved08; |
fbc6e32a MD |
606 | int64_t vol_nblocks; /* total allocatable hammer bufs */ |
607 | ||
8750964d MD |
608 | /* |
609 | * These fields are initialized and space is reserved in every | |
610 | * volume making up a HAMMER filesytem, but only the master volume | |
611 | * contains valid data. | |
612 | */ | |
c3be93f2 MD |
613 | int64_t vol0_stat_bigblocks; /* total bigblocks when fs is empty */ |
614 | int64_t vol0_stat_freebigblocks;/* number of free bigblocks */ | |
fbc6e32a MD |
615 | int64_t vol0_stat_bytes; /* for statfs only */ |
616 | int64_t vol0_stat_inodes; /* for statfs only */ | |
b33e2cc0 | 617 | int64_t vol0_stat_records; /* total records in filesystem */ |
47197d71 | 618 | hammer_off_t vol0_btree_root; /* B-Tree root */ |
4889cbd4 | 619 | hammer_tid_t vol0_next_tid; /* highest partially synchronized TID */ |
5fa5c92f | 620 | hammer_off_t vol0_unused03; |
40043e7f MD |
621 | |
622 | /* | |
0729c8c8 MD |
623 | * Blockmaps for zones. Not all zones use a blockmap. Note that |
624 | * the entire root blockmap is cached in the hammer_mount structure. | |
40043e7f | 625 | */ |
c3be93f2 | 626 | struct hammer_blockmap vol0_blockmap[HAMMER_MAX_ZONES]; |
40043e7f | 627 | |
bf686dbe | 628 | /* |
cb51be26 | 629 | * Array of zone-2 addresses for undo FIFO. |
bf686dbe | 630 | */ |
cb51be26 | 631 | hammer_off_t vol0_undo_array[HAMMER_UNDO_LAYER2]; |
bf686dbe | 632 | |
8750964d MD |
633 | }; |
634 | ||
8cd0a023 MD |
635 | typedef struct hammer_volume_ondisk *hammer_volume_ondisk_t; |
636 | ||
c60bb2c5 MD |
637 | #define HAMMER_VOLF_VALID 0x0001 /* valid entry */ |
638 | #define HAMMER_VOLF_OPEN 0x0002 /* volume is open */ | |
748efb59 | 639 | #define HAMMER_VOLF_NEEDFLUSH 0x0004 /* volume needs flush */ |
8cd0a023 | 640 | |
19619882 MD |
641 | #define HAMMER_VOL_CRCSIZE1 \ |
642 | offsetof(struct hammer_volume_ondisk, vol_crc) | |
643 | #define HAMMER_VOL_CRCSIZE2 \ | |
644 | (sizeof(struct hammer_volume_ondisk) - HAMMER_VOL_CRCSIZE1 - \ | |
645 | sizeof(hammer_crc_t)) | |
646 | ||
44a83111 | 647 | #define HAMMER_VOL_VERSION_MIN 1 /* minimum supported version */ |
e523b881 MD |
648 | #define HAMMER_VOL_VERSION_DEFAULT 6 /* newfs default version */ |
649 | #define HAMMER_VOL_VERSION_WIP 7 /* version >= this is WIP */ | |
89cba4df | 650 | #define HAMMER_VOL_VERSION_MAX 6 /* maximum supported version */ |
44a83111 | 651 | |
5e435c92 | 652 | #define HAMMER_VOL_VERSION_ONE 1 |
beec5dc4 | 653 | #define HAMMER_VOL_VERSION_TWO 2 /* new dirent layout (2.3+) */ |
83f2a3aa | 654 | #define HAMMER_VOL_VERSION_THREE 3 /* new snapshot layout (2.5+) */ |
fd74884e | 655 | #define HAMMER_VOL_VERSION_FOUR 4 /* new undo/flush (2.5+) */ |
3045a179 | 656 | #define HAMMER_VOL_VERSION_FIVE 5 /* dedup (2.9+) */ |
89cba4df | 657 | #define HAMMER_VOL_VERSION_SIX 6 /* DIRHASH_ALG1 */ |
83f2a3aa | 658 | |
c60bb2c5 MD |
659 | /* |
660 | * Record types are fairly straightforward. The B-Tree includes the record | |
661 | * type in its index sort. | |
c60bb2c5 | 662 | */ |
8750964d | 663 | #define HAMMER_RECTYPE_UNKNOWN 0 |
66325755 | 664 | #define HAMMER_RECTYPE_LOWEST 1 /* lowest record type avail */ |
8750964d | 665 | #define HAMMER_RECTYPE_INODE 1 /* inode in obj_id space */ |
ddfdf542 MD |
666 | #define HAMMER_RECTYPE_UNUSED02 2 |
667 | #define HAMMER_RECTYPE_UNUSED03 3 | |
bf686dbe MD |
668 | #define HAMMER_RECTYPE_DATA 0x0010 |
669 | #define HAMMER_RECTYPE_DIRENTRY 0x0011 | |
670 | #define HAMMER_RECTYPE_DB 0x0012 | |
671 | #define HAMMER_RECTYPE_EXT 0x0013 /* ext attributes */ | |
672 | #define HAMMER_RECTYPE_FIX 0x0014 /* fixed attribute */ | |
ea434b6f | 673 | #define HAMMER_RECTYPE_PFS 0x0015 /* PFS management */ |
83f2a3aa MD |
674 | #define HAMMER_RECTYPE_SNAPSHOT 0x0016 /* Snapshot management */ |
675 | #define HAMMER_RECTYPE_CONFIG 0x0017 /* hammer cleanup config */ | |
bf686dbe | 676 | #define HAMMER_RECTYPE_MOVED 0x8000 /* special recovery flag */ |
a9d52b76 MD |
677 | #define HAMMER_RECTYPE_MAX 0xFFFF |
678 | ||
679 | #define HAMMER_RECTYPE_CLEAN_START HAMMER_RECTYPE_EXT | |
7a04d74f MD |
680 | |
681 | #define HAMMER_FIXKEY_SYMLINK 1 | |
8750964d | 682 | |
66325755 | 683 | #define HAMMER_OBJTYPE_UNKNOWN 0 /* (never exists on-disk) */ |
8750964d MD |
684 | #define HAMMER_OBJTYPE_DIRECTORY 1 |
685 | #define HAMMER_OBJTYPE_REGFILE 2 | |
686 | #define HAMMER_OBJTYPE_DBFILE 3 | |
687 | #define HAMMER_OBJTYPE_FIFO 4 | |
c60bb2c5 MD |
688 | #define HAMMER_OBJTYPE_CDEV 5 |
689 | #define HAMMER_OBJTYPE_BDEV 6 | |
690 | #define HAMMER_OBJTYPE_SOFTLINK 7 | |
691 | #define HAMMER_OBJTYPE_PSEUDOFS 8 /* pseudo filesystem obj */ | |
b3bad96f | 692 | #define HAMMER_OBJTYPE_SOCKET 9 |
c60bb2c5 | 693 | |
8750964d | 694 | /* |
11ad5ade | 695 | * HAMMER inode attribute data |
8750964d | 696 | * |
11ad5ade MD |
697 | * The data reference for a HAMMER inode points to this structure. Any |
698 | * modifications to the contents of this structure will result in a | |
699 | * replacement operation. | |
8750964d | 700 | * |
5a930e66 MD |
701 | * parent_obj_id is only valid for directories (which cannot be hard-linked), |
702 | * and specifies the parent directory obj_id. This field will also be set | |
703 | * for non-directory inodes as a recovery aid, but can wind up holding | |
704 | * stale information. However, since object id's are not reused, the worse | |
705 | * that happens is that the recovery code is unable to use it. | |
ddfdf542 MD |
706 | * |
707 | * NOTE: Future note on directory hardlinks. We can implement a record type | |
708 | * which allows us to point to multiple parent directories. | |
8750964d | 709 | * |
11ad5ade MD |
710 | * NOTE: atime is stored in the inode's B-Tree element and not in the inode |
711 | * data. This allows the atime to be updated without having to lay down a | |
712 | * new record. | |
8750964d | 713 | */ |
11ad5ade MD |
714 | struct hammer_inode_data { |
715 | u_int16_t version; /* inode data version */ | |
716 | u_int16_t mode; /* basic unix permissions */ | |
717 | u_int32_t uflags; /* chflags */ | |
718 | u_int32_t rmajor; /* used by device nodes */ | |
719 | u_int32_t rminor; /* used by device nodes */ | |
720 | u_int64_t ctime; | |
adf01747 | 721 | int64_t parent_obj_id; /* parent directory obj_id */ |
11ad5ade MD |
722 | uuid_t uid; |
723 | uuid_t gid; | |
724 | ||
725 | u_int8_t obj_type; | |
5a930e66 MD |
726 | u_int8_t cap_flags; /* capability support flags (extension) */ |
727 | u_int16_t reserved02; | |
ddfdf542 | 728 | u_int32_t reserved03; /* RESERVED FOR POSSIBLE FUTURE BIRTHTIME */ |
11ad5ade | 729 | u_int64_t nlinks; /* hard links */ |
bcac4bbb | 730 | u_int64_t size; /* filesystem object size */ |
2f85fa4d | 731 | union { |
5a930e66 MD |
732 | struct { |
733 | char reserved06[16]; | |
734 | u_int32_t parent_obj_localization; | |
735 | u_int32_t integrity_crc; | |
736 | } obj; | |
2f85fa4d MD |
737 | char symlink[24]; /* HAMMER_INODE_BASESYMLEN */ |
738 | } ext; | |
ddfdf542 MD |
739 | u_int64_t mtime; /* mtime must be second-to-last */ |
740 | u_int64_t atime; /* atime must be last */ | |
8750964d MD |
741 | }; |
742 | ||
ddfdf542 MD |
743 | /* |
744 | * Neither mtime nor atime upates are CRCd by the B-Tree element. | |
745 | * mtime updates have UNDO, atime updates do not. | |
746 | */ | |
bcac4bbb MD |
747 | #define HAMMER_ITIMES_BASE(ino_data) (&(ino_data)->mtime) |
748 | #define HAMMER_ITIMES_BYTES (sizeof(u_int64_t) * 2) | |
749 | ||
ddfdf542 MD |
750 | #define HAMMER_INODE_CRCSIZE \ |
751 | offsetof(struct hammer_inode_data, mtime) | |
752 | ||
11ad5ade MD |
753 | #define HAMMER_INODE_DATA_VERSION 1 |
754 | #define HAMMER_OBJID_ROOT 1 | |
ddfdf542 | 755 | #define HAMMER_INODE_BASESYMLEN 24 /* see ext.symlink */ |
8750964d | 756 | |
5e435c92 MD |
757 | /* |
758 | * Capability & implementation flags. | |
beec5dc4 MD |
759 | * |
760 | * DIR_LOCAL_INO - Use inode B-Tree localization for directory entries. | |
5e435c92 MD |
761 | */ |
762 | #define HAMMER_INODE_CAP_DIRHASH_MASK 0x03 /* directory: hash algorithm */ | |
763 | #define HAMMER_INODE_CAP_DIRHASH_ALG0 0x00 | |
764 | #define HAMMER_INODE_CAP_DIRHASH_ALG1 0x01 | |
765 | #define HAMMER_INODE_CAP_DIRHASH_ALG2 0x02 | |
766 | #define HAMMER_INODE_CAP_DIRHASH_ALG3 0x03 | |
beec5dc4 | 767 | #define HAMMER_INODE_CAP_DIR_LOCAL_INO 0x04 /* use inode localization */ |
5e435c92 | 768 | |
8750964d | 769 | /* |
ddfdf542 MD |
770 | * A HAMMER directory entry associates a HAMMER filesystem object with a |
771 | * namespace. It is possible to hook into a pseudo-filesystem (with its | |
772 | * own inode numbering space) in the filesystem by setting the high | |
773 | * 16 bits of the localization field. The low 16 bits must be 0 and | |
774 | * are reserved for future use. | |
8750964d MD |
775 | * |
776 | * Directory entries are indexed with a 128 bit namekey rather then an | |
ddfdf542 | 777 | * offset. A portion of the namekey is an iterator/randomizer to deal |
8750964d | 778 | * with collisions. |
66325755 | 779 | * |
ddfdf542 MD |
780 | * NOTE: base.base.obj_type from the related B-Tree leaf entry holds |
781 | * the filesystem object type of obj_id, e.g. a den_type equivalent. | |
782 | * It is not stored in hammer_entry_data. | |
6b4f890b MD |
783 | * |
784 | * NOTE: den_name / the filename data reference is NOT terminated with \0. | |
8750964d | 785 | */ |
11ad5ade | 786 | struct hammer_entry_data { |
adf01747 | 787 | int64_t obj_id; /* object being referenced */ |
ddfdf542 MD |
788 | u_int32_t localization; /* identify pseudo-filesystem */ |
789 | u_int32_t reserved02; | |
11ad5ade | 790 | char name[16]; /* name (extended) */ |
8750964d MD |
791 | }; |
792 | ||
11ad5ade MD |
793 | #define HAMMER_ENTRY_NAME_OFF offsetof(struct hammer_entry_data, name[0]) |
794 | #define HAMMER_ENTRY_SIZE(nlen) offsetof(struct hammer_entry_data, name[nlen]) | |
19619882 | 795 | |
ddfdf542 MD |
796 | /* |
797 | * Symlink data which does not fit in the inode is stored in a separte | |
798 | * FIX type record. | |
799 | */ | |
11ad5ade MD |
800 | struct hammer_symlink_data { |
801 | char name[16]; | |
8750964d MD |
802 | }; |
803 | ||
11ad5ade | 804 | #define HAMMER_SYMLINK_NAME_OFF offsetof(struct hammer_symlink_data, name[0]) |
7a04d74f | 805 | |
5fa5c92f MD |
806 | /* |
807 | * The root inode for the primary filesystem and root inode for any | |
808 | * pseudo-fs may be tagged with an optional data structure using | |
809 | * HAMMER_RECTYPE_FIX/HAMMER_FIXKEY_PSEUDOFS. This structure allows | |
810 | * the node to be used as a mirroring master or slave. | |
811 | * | |
812 | * When operating as a slave CD's into the node automatically become read-only | |
a56cb012 | 813 | * and as-of sync_end_tid. |
5fa5c92f | 814 | * |
a56cb012 | 815 | * When operating as a master the read PFSD info sets sync_end_tid to |
5fa5c92f MD |
816 | * the most recently flushed TID. |
817 | * | |
818 | * sync_low_tid is not yet used but will represent the highest pruning | |
819 | * end-point, after which full history is available. | |
c7380858 MN |
820 | * |
821 | * We need to pack this structure making it equally sized on both 32-bit and | |
822 | * 64-bit machines as it is part of struct hammer_ioc_mrecord_pfs which is | |
823 | * send over the wire in hammer mirror operations. Only on 64-bit machines | |
824 | * the size of this struct differ when packed or not. This leads us to the | |
825 | * situation where old 64-bit systems (using the non-packed structure), | |
826 | * which were never able to mirror to/from 32-bit systems, are now no longer | |
827 | * able to mirror to/from newer 64-bit systems (using the packed structure). | |
5fa5c92f MD |
828 | */ |
829 | struct hammer_pseudofs_data { | |
830 | hammer_tid_t sync_low_tid; /* full history beyond this point */ | |
a56cb012 MD |
831 | hammer_tid_t sync_beg_tid; /* earliest tid w/ full history avail */ |
832 | hammer_tid_t sync_end_tid; /* current synchronizatoin point */ | |
5fa5c92f MD |
833 | u_int64_t sync_beg_ts; /* real-time of last completed sync */ |
834 | u_int64_t sync_end_ts; /* initiation of current sync cycle */ | |
835 | uuid_t shared_uuid; /* shared uuid (match required) */ | |
836 | uuid_t unique_uuid; /* unique uuid of this master/slave */ | |
732a1697 | 837 | int32_t reserved01; /* reserved for future master_id */ |
4c038e17 | 838 | int32_t mirror_flags; /* misc flags */ |
5fa5c92f | 839 | char label[64]; /* filesystem space label */ |
260b4b9e | 840 | char snapshots[64]; /* softlink dir for pruning */ |
4c038e17 MD |
841 | int16_t prune_time; /* how long to spend pruning */ |
842 | int16_t prune_freq; /* how often we prune */ | |
843 | int16_t reblock_time; /* how long to spend reblocking */ | |
844 | int16_t reblock_freq; /* how often we reblock */ | |
845 | int32_t snapshot_freq; /* how often we create a snapshot */ | |
846 | int32_t prune_min; /* do not prune recent history */ | |
847 | int32_t prune_max; /* do not retain history beyond here */ | |
848 | int32_t reserved[16]; | |
c7380858 | 849 | } __packed; |
5fa5c92f MD |
850 | |
851 | typedef struct hammer_pseudofs_data *hammer_pseudofs_data_t; | |
852 | ||
853 | #define HAMMER_PFSD_SLAVE 0x00000001 | |
842e7a70 | 854 | #define HAMMER_PFSD_DELETED 0x80000000 |
5fa5c92f | 855 | |
83f2a3aa MD |
856 | /* |
857 | * Snapshot meta-data { Objid = HAMMER_OBJID_ROOT, Key = tid, rectype = SNAPSHOT }. | |
858 | * | |
859 | * Snapshot records replace the old <fs>/snapshots/<softlink> methodology. Snapshot | |
860 | * records are mirrored but may be independantly managed once they are laid down on | |
861 | * a slave. | |
862 | * | |
863 | * NOTE: The b-tree key is signed, the tid is not, so callers must still sort the | |
864 | * results. | |
865 | * | |
866 | * NOTE: Reserved fields must be zero (as usual) | |
867 | */ | |
868 | struct hammer_snapshot_data { | |
869 | hammer_tid_t tid; /* the snapshot TID itself (== key) */ | |
870 | u_int64_t ts; /* real-time when snapshot was made */ | |
871 | u_int64_t reserved01; | |
872 | u_int64_t reserved02; | |
873 | char label[64]; /* user-supplied description */ | |
874 | u_int64_t reserved03[4]; | |
875 | }; | |
876 | ||
877 | /* | |
878 | * Config meta-data { ObjId = HAMMER_OBJID_ROOT, Key = 0, rectype = CONFIG }. | |
879 | * | |
880 | * Used to store the hammer cleanup config. This data is not mirrored. | |
881 | */ | |
882 | struct hammer_config_data { | |
883 | char text[1024]; | |
884 | }; | |
885 | ||
c60bb2c5 MD |
886 | /* |
887 | * Rollup various structures embedded as record data | |
888 | */ | |
427e5fc6 | 889 | union hammer_data_ondisk { |
11ad5ade | 890 | struct hammer_entry_data entry; |
c60bb2c5 | 891 | struct hammer_inode_data inode; |
11ad5ade | 892 | struct hammer_symlink_data symlink; |
842e7a70 | 893 | struct hammer_pseudofs_data pfsd; |
83f2a3aa MD |
894 | struct hammer_snapshot_data snap; |
895 | struct hammer_config_data config; | |
c60bb2c5 MD |
896 | }; |
897 | ||
11ad5ade MD |
898 | typedef union hammer_data_ondisk *hammer_data_ondisk_t; |
899 | ||
7dc57964 | 900 | #endif |