sbin/hammer: Fix bug in get_buffer_data()
[dragonfly.git] / sbin / hammer / ondisk.c
1 /*
2  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34
35 #include <sys/diskslice.h>
36 #include <sys/diskmbr.h>
37
38 #include "hammer_util.h"
39
40 static void check_volume(struct volume_info *vol);
41 static void get_buffer_readahead(struct buffer_info *base);
42 static __inline int readhammervol(struct volume_info *vol);
43 static __inline int readhammerbuf(struct buffer_info *buf);
44 static __inline int writehammervol(struct volume_info *vol);
45 static __inline int writehammerbuf(struct buffer_info *buf);
46
47 uuid_t Hammer_FSType;
48 uuid_t Hammer_FSId;
49 int UseReadBehind = -4;
50 int UseReadAhead = 4;
51 int DebugOpt;
52
53 TAILQ_HEAD(volume_list, volume_info);
54 static struct volume_list VolList = TAILQ_HEAD_INITIALIZER(VolList);
55 static int valid_hammer_volumes;
56
57 static __inline
58 int
59 buffer_hash(hammer_off_t zone2_offset)
60 {
61         int hi;
62
63         hi = (int)(zone2_offset / HAMMER_BUFSIZE) & HAMMER_BUFLISTMASK;
64         return(hi);
65 }
66
67 static struct buffer_info*
68 find_buffer(hammer_off_t zone2_offset)
69 {
70         struct volume_info *volume;
71         struct buffer_info *buf;
72         int hi;
73
74         volume = get_volume(HAMMER_VOL_DECODE(zone2_offset));
75         assert(volume);
76
77         hi = buffer_hash(zone2_offset);
78         TAILQ_FOREACH(buf, &volume->buffer_lists[hi], entry)
79                 if (buf->zone2_offset == zone2_offset)
80                         return(buf);
81         return(NULL);
82 }
83
84 static
85 struct volume_info *
86 __alloc_volume(const char *volname, int oflags)
87 {
88         struct volume_info *vol;
89         int i;
90
91         vol = calloc(1, sizeof(*vol));
92         vol->vol_no = -1;
93         vol->rdonly = (oflags == O_RDONLY);
94         vol->name = strdup(volname);
95         vol->fd = open(vol->name, oflags);
96         if (vol->fd < 0)
97                 err(1, "alloc_volume: Failed to open %s", vol->name);
98         check_volume(vol);
99
100         vol->ondisk = calloc(1, HAMMER_BUFSIZE);
101
102         for (i = 0; i < HAMMER_BUFLISTS; ++i)
103                 TAILQ_INIT(&vol->buffer_lists[i]);
104
105         return(vol);
106 }
107
108 static void
109 __add_volume(struct volume_info *vol)
110 {
111         struct volume_info *scan;
112         struct stat st1, st2;
113
114         if (fstat(vol->fd, &st1) != 0)
115                 errx(1, "add_volume: %s: Failed to stat", vol->name);
116
117         TAILQ_FOREACH(scan, &VolList, entry) {
118                 if (scan->vol_no == vol->vol_no) {
119                         errx(1, "add_volume: %s: Duplicate volume number %d "
120                                 "against %s",
121                                 vol->name, vol->vol_no, scan->name);
122                 }
123                 if (fstat(scan->fd, &st2) != 0) {
124                         errx(1, "add_volume: %s: Failed to stat %s",
125                                 vol->name, scan->name);
126                 }
127                 if ((st1.st_ino == st2.st_ino) && (st1.st_dev == st2.st_dev)) {
128                         errx(1, "add_volume: %s: Specified more than once",
129                                 vol->name);
130                 }
131         }
132
133         TAILQ_INSERT_TAIL(&VolList, vol, entry);
134 }
135
136 static void
137 __verify_volume(struct volume_info *vol)
138 {
139         hammer_volume_ondisk_t ondisk = vol->ondisk;
140
141         if (ondisk->vol_signature != HAMMER_FSBUF_VOLUME) {
142                 errx(1, "verify_volume: Invalid volume signature %016jx",
143                         ondisk->vol_signature);
144         }
145         if (ondisk->vol_rootvol != HAMMER_ROOT_VOLNO) {
146                 errx(1, "verify_volume: Invalid root volume# %d",
147                         ondisk->vol_rootvol);
148         }
149         if (bcmp(&Hammer_FSType, &ondisk->vol_fstype, sizeof(Hammer_FSType))) {
150                 errx(1, "verify_volume: %s: Header does not indicate "
151                         "that this is a HAMMER volume", vol->name);
152         }
153         if (bcmp(&Hammer_FSId, &ondisk->vol_fsid, sizeof(Hammer_FSId))) {
154                 errx(1, "verify_volume: %s: FSId does not match other volumes!",
155                         vol->name);
156         }
157 }
158
159 /*
160  * Initialize a volume structure and ondisk vol_no field.
161  */
162 struct volume_info *
163 init_volume(const char *filename, int oflags, int32_t vol_no)
164 {
165         struct volume_info *vol;
166
167         vol = __alloc_volume(filename, oflags);
168         vol->vol_no = vol->ondisk->vol_no = vol_no;
169
170         __add_volume(vol);
171
172         return(vol);
173 }
174
175 /*
176  * Initialize a volume structure and read ondisk volume header.
177  */
178 struct volume_info*
179 load_volume(const char *filename, int oflags, int verify)
180 {
181         struct volume_info *vol;
182         int n;
183
184         vol = __alloc_volume(filename, oflags);
185
186         n = readhammervol(vol);
187         if (n == -1) {
188                 err(1, "load_volume: %s: Read failed at offset 0", vol->name);
189         }
190         vol->vol_no = vol->ondisk->vol_no;
191
192         if (valid_hammer_volumes++ == 0)
193                 Hammer_FSId = vol->ondisk->vol_fsid;
194         if (verify)
195                 __verify_volume(vol);
196
197         __add_volume(vol);
198
199         return(vol);
200 }
201
202 /*
203  * Check basic volume characteristics.
204  */
205 static void
206 check_volume(struct volume_info *vol)
207 {
208         struct partinfo pinfo;
209         struct stat st;
210
211         /*
212          * Get basic information about the volume
213          */
214         if (ioctl(vol->fd, DIOCGPART, &pinfo) < 0) {
215                 /*
216                  * Allow the formatting of regular files as HAMMER volumes
217                  */
218                 if (fstat(vol->fd, &st) < 0)
219                         err(1, "Unable to stat %s", vol->name);
220                 vol->size = st.st_size;
221                 vol->type = "REGFILE";
222         } else {
223                 /*
224                  * When formatting a block device as a HAMMER volume the
225                  * sector size must be compatible.  HAMMER uses 16384 byte
226                  * filesystem buffers.
227                  */
228                 if (pinfo.reserved_blocks) {
229                         errx(1, "HAMMER cannot be placed in a partition "
230                                 "which overlaps the disklabel or MBR");
231                 }
232                 if (pinfo.media_blksize > HAMMER_BUFSIZE ||
233                     HAMMER_BUFSIZE % pinfo.media_blksize) {
234                         errx(1, "A media sector size of %d is not supported",
235                              pinfo.media_blksize);
236                 }
237
238                 vol->size = pinfo.media_size;
239                 vol->device_offset = pinfo.media_offset;
240                 vol->type = "DEVICE";
241         }
242 }
243
244 void
245 assert_volume_offset(struct volume_info *vol)
246 {
247         assert(hammer_is_zone_raw_buffer(vol->vol_free_off));
248         assert(hammer_is_zone_raw_buffer(vol->vol_free_end));
249         if (vol->vol_free_off >= vol->vol_free_end)
250                 errx(1, "Ran out of room, filesystem too small");
251 }
252
253 struct volume_info *
254 get_volume(int32_t vol_no)
255 {
256         struct volume_info *vol;
257
258         TAILQ_FOREACH(vol, &VolList, entry) {
259                 if (vol->vol_no == vol_no)
260                         break;
261         }
262
263         return(vol);
264 }
265
266 struct volume_info *
267 get_root_volume(void)
268 {
269         return(get_volume(HAMMER_ROOT_VOLNO));
270 }
271
272 static hammer_off_t
273 __blockmap_xlate_to_zone2(hammer_off_t buf_offset)
274 {
275         hammer_off_t zone2_offset;
276         int error = 0;
277
278         if (hammer_is_zone_raw_buffer(buf_offset))
279                 zone2_offset = buf_offset;
280         else
281                 zone2_offset = blockmap_lookup(buf_offset, &error);
282
283         if (error)
284                 return(HAMMER_OFF_BAD);
285         assert(hammer_is_zone_raw_buffer(zone2_offset));
286
287         return(zone2_offset);
288 }
289
290 static struct buffer_info *
291 __alloc_buffer(hammer_off_t zone2_offset, int isnew)
292 {
293         struct volume_info *volume;
294         struct buffer_info *buf;
295         int hi;
296
297         volume = get_volume(HAMMER_VOL_DECODE(zone2_offset));
298         assert(volume != NULL);
299
300         buf = calloc(1, sizeof(*buf));
301         buf->zone2_offset = zone2_offset;
302         buf->raw_offset = hammer_xlate_to_phys(volume->ondisk, zone2_offset);
303         buf->volume = volume;
304         buf->ondisk = calloc(1, HAMMER_BUFSIZE);
305
306         if (isnew <= 0) {
307                 if (readhammerbuf(buf) == -1) {
308                         err(1, "Failed to read %s:%016jx at %016jx",
309                             volume->name,
310                             (intmax_t)buf->zone2_offset,
311                             (intmax_t)buf->raw_offset);
312                 }
313         }
314
315         hi = buffer_hash(zone2_offset);
316         TAILQ_INSERT_TAIL(&volume->buffer_lists[hi], buf, entry);
317         hammer_cache_add(&buf->cache);
318
319         return(buf);
320 }
321
322 /*
323  * Acquire the 16KB buffer for specified zone offset.
324  */
325 static struct buffer_info *
326 get_buffer(hammer_off_t buf_offset, int isnew)
327 {
328         struct buffer_info *buf;
329         hammer_off_t zone2_offset;
330         int dora = 0;
331
332         zone2_offset = __blockmap_xlate_to_zone2(buf_offset);
333         if (zone2_offset == HAMMER_OFF_BAD)
334                 return(NULL);
335
336         zone2_offset &= ~HAMMER_BUFMASK64;
337         buf = find_buffer(zone2_offset);
338
339         if (buf == NULL) {
340                 buf = __alloc_buffer(zone2_offset, isnew);
341                 dora = (isnew == 0);
342         } else {
343                 assert(isnew != -1);
344                 hammer_cache_used(&buf->cache);
345         }
346         assert(buf->ondisk != NULL);
347
348         ++buf->cache.refs;
349         hammer_cache_flush();
350
351         if (isnew > 0) {
352                 assert(buf->cache.modified == 0);
353                 bzero(buf->ondisk, HAMMER_BUFSIZE);
354                 buf->cache.modified = 1;
355         }
356         if (dora)
357                 get_buffer_readahead(buf);
358         return(buf);
359 }
360
361 static void
362 get_buffer_readahead(struct buffer_info *base)
363 {
364         struct buffer_info *buf;
365         struct volume_info *vol;
366         hammer_off_t zone2_offset;
367         int64_t raw_offset;
368         int ri = UseReadBehind;
369         int re = UseReadAhead;
370
371         raw_offset = base->raw_offset + ri * HAMMER_BUFSIZE;
372         vol = base->volume;
373
374         while (ri < re) {
375                 if (raw_offset >= vol->ondisk->vol_buf_end)
376                         break;
377                 if (raw_offset < vol->ondisk->vol_buf_beg || ri == 0) {
378                         ++ri;
379                         raw_offset += HAMMER_BUFSIZE;
380                         continue;
381                 }
382                 zone2_offset = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no,
383                         raw_offset - vol->ondisk->vol_buf_beg);
384                 buf = find_buffer(zone2_offset);
385                 if (buf == NULL) {
386                         /* call with -1 to prevent another readahead */
387                         buf = get_buffer(zone2_offset, -1);
388                         rel_buffer(buf);
389                 }
390                 ++ri;
391                 raw_offset += HAMMER_BUFSIZE;
392         }
393 }
394
395 void
396 rel_buffer(struct buffer_info *buffer)
397 {
398         struct volume_info *volume;
399         int hi;
400
401         if (buffer == NULL)
402                 return;
403         assert(buffer->cache.refs > 0);
404         if (--buffer->cache.refs == 0) {
405                 if (buffer->cache.delete) {
406                         hi = buffer_hash(buffer->zone2_offset);
407                         volume = buffer->volume;
408                         if (buffer->cache.modified)
409                                 flush_buffer(buffer);
410                         TAILQ_REMOVE(&volume->buffer_lists[hi], buffer, entry);
411                         hammer_cache_del(&buffer->cache);
412                         free(buffer->ondisk);
413                         free(buffer);
414                 }
415         }
416 }
417
418 /*
419  * Retrieve a pointer to a buffer data given a buffer offset.  The underlying
420  * bufferp is freed if isnew or the offset is out of range of the cached data.
421  * If bufferp is freed a referenced buffer is loaded into it.
422  */
423 void *
424 get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp,
425                 int isnew)
426 {
427         hammer_off_t xor;
428
429         if (*bufferp != NULL) {
430                 if (hammer_is_zone_direct_xlated(buf_offset)) {
431                         xor = HAMMER_OFF_LONG_ENCODE(buf_offset) ^
432                               HAMMER_OFF_LONG_ENCODE((*bufferp)->zone2_offset);
433                         if (isnew > 0 || (xor & ~HAMMER_BUFMASK64)) {
434                                 rel_buffer(*bufferp);
435                                 *bufferp = NULL;
436                         }
437                 }
438         }
439
440         if (*bufferp == NULL) {
441                 *bufferp = get_buffer(buf_offset, isnew);
442                 if (*bufferp == NULL)
443                         return(NULL);
444         }
445
446         return(((char *)(*bufferp)->ondisk) +
447                 ((int32_t)buf_offset & HAMMER_BUFMASK));
448 }
449
450 /*
451  * Allocate HAMMER elements - B-Tree nodes
452  */
453 hammer_node_ondisk_t
454 alloc_btree_node(hammer_off_t *offp, struct buffer_info **data_bufferp)
455 {
456         hammer_node_ondisk_t node;
457
458         node = alloc_blockmap(HAMMER_ZONE_BTREE_INDEX, sizeof(*node),
459                               offp, data_bufferp);
460         bzero(node, sizeof(*node));
461         return(node);
462 }
463
464 /*
465  * Allocate HAMMER elements - meta data (inode, direntry, PFS, etc)
466  */
467 void *
468 alloc_meta_element(hammer_off_t *offp, int32_t data_len,
469                    struct buffer_info **data_bufferp)
470 {
471         void *data;
472
473         data = alloc_blockmap(HAMMER_ZONE_META_INDEX, data_len,
474                               offp, data_bufferp);
475         bzero(data, data_len);
476         return(data);
477 }
478
479 /*
480  * Format a new blockmap.  This is mostly a degenerate case because
481  * all allocations are now actually done from the freemap.
482  */
483 void
484 format_blockmap(struct volume_info *root_vol, int zone, hammer_off_t offset)
485 {
486         hammer_blockmap_t blockmap;
487         hammer_off_t zone_base;
488
489         /* Only root volume needs formatting */
490         assert(root_vol->vol_no == HAMMER_ROOT_VOLNO);
491
492         assert(hammer_is_index_record(zone));
493
494         blockmap = &root_vol->ondisk->vol0_blockmap[zone];
495         zone_base = HAMMER_ZONE_ENCODE(zone, offset);
496
497         bzero(blockmap, sizeof(*blockmap));
498         blockmap->phys_offset = 0;
499         blockmap->first_offset = zone_base;
500         blockmap->next_offset = zone_base;
501         blockmap->alloc_offset = HAMMER_ENCODE(zone, 255, -1);
502         hammer_crc_set_blockmap(blockmap);
503 }
504
505 /*
506  * Format a new freemap.  Set all layer1 entries to UNAVAIL.  The initialize
507  * code will load each volume's freemap.
508  */
509 void
510 format_freemap(struct volume_info *root_vol)
511 {
512         struct buffer_info *buffer = NULL;
513         hammer_off_t layer1_offset;
514         hammer_blockmap_t blockmap;
515         hammer_blockmap_layer1_t layer1;
516         int i, isnew;
517
518         /* Only root volume needs formatting */
519         assert(root_vol->vol_no == HAMMER_ROOT_VOLNO);
520
521         layer1_offset = bootstrap_bigblock(root_vol);
522         for (i = 0; i < HAMMER_BIGBLOCK_SIZE; i += sizeof(*layer1)) {
523                 isnew = ((i % HAMMER_BUFSIZE) == 0);
524                 layer1 = get_buffer_data(layer1_offset + i, &buffer, isnew);
525                 bzero(layer1, sizeof(*layer1));
526                 layer1->phys_offset = HAMMER_BLOCKMAP_UNAVAIL;
527                 layer1->blocks_free = 0;
528                 hammer_crc_set_layer1(layer1);
529         }
530         assert(i == HAMMER_BIGBLOCK_SIZE);
531         rel_buffer(buffer);
532
533         blockmap = &root_vol->ondisk->vol0_blockmap[HAMMER_ZONE_FREEMAP_INDEX];
534         bzero(blockmap, sizeof(*blockmap));
535         blockmap->phys_offset = layer1_offset;
536         blockmap->first_offset = 0;
537         blockmap->next_offset = HAMMER_ENCODE_RAW_BUFFER(0, 0);
538         blockmap->alloc_offset = HAMMER_ENCODE_RAW_BUFFER(255, -1);
539         hammer_crc_set_blockmap(blockmap);
540 }
541
542 /*
543  * Load the volume's remaining free space into the freemap.
544  *
545  * Returns the number of big-blocks available.
546  */
547 int64_t
548 initialize_freemap(struct volume_info *vol)
549 {
550         struct volume_info *root_vol;
551         struct buffer_info *buffer1 = NULL;
552         struct buffer_info *buffer2 = NULL;
553         hammer_blockmap_layer1_t layer1;
554         hammer_blockmap_layer2_t layer2;
555         hammer_off_t layer1_offset;
556         hammer_off_t layer2_offset;
557         hammer_off_t phys_offset;
558         hammer_off_t block_offset;
559         hammer_off_t aligned_vol_free_end;
560         hammer_blockmap_t freemap;
561         int64_t count = 0;
562         int64_t layer1_count = 0;
563
564         root_vol = get_root_volume();
565
566         assert_volume_offset(vol);
567         aligned_vol_free_end = HAMMER_BLOCKMAP_LAYER2_DOALIGN(vol->vol_free_end);
568
569         printf("initialize freemap volume %d\n", vol->vol_no);
570
571         /*
572          * Initialize the freemap.  First preallocate the big-blocks required
573          * to implement layer2.   This preallocation is a bootstrap allocation
574          * using blocks from the target volume.
575          */
576         freemap = &root_vol->ondisk->vol0_blockmap[HAMMER_ZONE_FREEMAP_INDEX];
577
578         for (phys_offset = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no, 0);
579              phys_offset < aligned_vol_free_end;
580              phys_offset += HAMMER_BLOCKMAP_LAYER2) {
581                 layer1_offset = freemap->phys_offset +
582                                 HAMMER_BLOCKMAP_LAYER1_OFFSET(phys_offset);
583                 layer1 = get_buffer_data(layer1_offset, &buffer1, 0);
584                 if (layer1->phys_offset == HAMMER_BLOCKMAP_UNAVAIL) {
585                         layer1->phys_offset = bootstrap_bigblock(vol);
586                         layer1->blocks_free = 0;
587                         buffer1->cache.modified = 1;
588                         hammer_crc_set_layer1(layer1);
589                 }
590         }
591
592         /*
593          * Now fill everything in.
594          */
595         for (phys_offset = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no, 0);
596              phys_offset < aligned_vol_free_end;
597              phys_offset += HAMMER_BLOCKMAP_LAYER2) {
598                 layer1_count = 0;
599                 layer1_offset = freemap->phys_offset +
600                                 HAMMER_BLOCKMAP_LAYER1_OFFSET(phys_offset);
601                 layer1 = get_buffer_data(layer1_offset, &buffer1, 0);
602                 assert(layer1->phys_offset != HAMMER_BLOCKMAP_UNAVAIL);
603
604                 for (block_offset = 0;
605                      block_offset < HAMMER_BLOCKMAP_LAYER2;
606                      block_offset += HAMMER_BIGBLOCK_SIZE) {
607                         layer2_offset = layer1->phys_offset +
608                                         HAMMER_BLOCKMAP_LAYER2_OFFSET(block_offset);
609                         layer2 = get_buffer_data(layer2_offset, &buffer2, 0);
610                         bzero(layer2, sizeof(*layer2));
611
612                         if (phys_offset + block_offset < vol->vol_free_off) {
613                                 /*
614                                  * Big-blocks already allocated as part
615                                  * of the freemap bootstrap.
616                                  */
617                                 layer2->zone = HAMMER_ZONE_FREEMAP_INDEX;
618                                 layer2->append_off = HAMMER_BIGBLOCK_SIZE;
619                                 layer2->bytes_free = 0;
620                         } else if (phys_offset + block_offset < vol->vol_free_end) {
621                                 layer2->zone = 0;
622                                 layer2->append_off = 0;
623                                 layer2->bytes_free = HAMMER_BIGBLOCK_SIZE;
624                                 ++count;
625                                 ++layer1_count;
626                         } else {
627                                 layer2->zone = HAMMER_ZONE_UNAVAIL_INDEX;
628                                 layer2->append_off = HAMMER_BIGBLOCK_SIZE;
629                                 layer2->bytes_free = 0;
630                         }
631                         hammer_crc_set_layer2(layer2);
632                         buffer2->cache.modified = 1;
633                 }
634
635                 layer1->blocks_free += layer1_count;
636                 hammer_crc_set_layer1(layer1);
637                 buffer1->cache.modified = 1;
638         }
639
640         rel_buffer(buffer1);
641         rel_buffer(buffer2);
642         return(count);
643 }
644
645 /*
646  * Returns the number of big-blocks available for filesystem data and undos
647  * without formatting.
648  */
649 int64_t
650 count_freemap(struct volume_info *vol)
651 {
652         hammer_off_t phys_offset;
653         hammer_off_t vol_free_off;
654         hammer_off_t aligned_vol_free_end;
655         int64_t count = 0;
656
657         vol_free_off = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no, 0);
658
659         assert_volume_offset(vol);
660         aligned_vol_free_end = HAMMER_BLOCKMAP_LAYER2_DOALIGN(vol->vol_free_end);
661
662         if (vol->vol_no == HAMMER_ROOT_VOLNO)
663                 vol_free_off += HAMMER_BIGBLOCK_SIZE;
664
665         for (phys_offset = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no, 0);
666              phys_offset < aligned_vol_free_end;
667              phys_offset += HAMMER_BLOCKMAP_LAYER2) {
668                 vol_free_off += HAMMER_BIGBLOCK_SIZE;
669         }
670
671         for (phys_offset = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no, 0);
672              phys_offset < aligned_vol_free_end;
673              phys_offset += HAMMER_BIGBLOCK_SIZE) {
674                 if (phys_offset < vol_free_off) {
675                         ;
676                 } else if (phys_offset < vol->vol_free_end) {
677                         ++count;
678                 }
679         }
680
681         return(count);
682 }
683
684 /*
685  * Format the undomap for the root volume.
686  */
687 void
688 format_undomap(struct volume_info *root_vol, int64_t *undo_buffer_size)
689 {
690         hammer_off_t undo_limit;
691         hammer_blockmap_t blockmap;
692         hammer_volume_ondisk_t ondisk;
693         struct buffer_info *buffer = NULL;
694         hammer_off_t scan;
695         int n;
696         int limit_index;
697         uint32_t seqno;
698
699         /* Only root volume needs formatting */
700         assert(root_vol->vol_no == HAMMER_ROOT_VOLNO);
701         ondisk = root_vol->ondisk;
702
703         /*
704          * Size the undo buffer in multiples of HAMMER_BIGBLOCK_SIZE,
705          * up to HAMMER_MAX_UNDO_BIGBLOCKS big-blocks.
706          * Size to approximately 0.1% of the disk.
707          *
708          * The minimum UNDO fifo size is 512MB, or approximately 1% of
709          * the recommended 50G disk.
710          *
711          * Changing this minimum is rather dangerous as complex filesystem
712          * operations can cause the UNDO FIFO to fill up otherwise.
713          */
714         undo_limit = *undo_buffer_size;
715         if (undo_limit == 0) {
716                 undo_limit = HAMMER_VOL_BUF_SIZE(ondisk) / 1000;
717                 if (undo_limit < HAMMER_BIGBLOCK_SIZE * HAMMER_MIN_UNDO_BIGBLOCKS)
718                         undo_limit = HAMMER_BIGBLOCK_SIZE * HAMMER_MIN_UNDO_BIGBLOCKS;
719         }
720         undo_limit = HAMMER_BIGBLOCK_DOALIGN(undo_limit);
721         if (undo_limit < HAMMER_BIGBLOCK_SIZE)
722                 undo_limit = HAMMER_BIGBLOCK_SIZE;
723         if (undo_limit > HAMMER_BIGBLOCK_SIZE * HAMMER_MAX_UNDO_BIGBLOCKS)
724                 undo_limit = HAMMER_BIGBLOCK_SIZE * HAMMER_MAX_UNDO_BIGBLOCKS;
725         *undo_buffer_size = undo_limit;
726
727         blockmap = &ondisk->vol0_blockmap[HAMMER_ZONE_UNDO_INDEX];
728         bzero(blockmap, sizeof(*blockmap));
729         blockmap->phys_offset = HAMMER_BLOCKMAP_UNAVAIL;
730         blockmap->first_offset = HAMMER_ENCODE_UNDO(0);
731         blockmap->next_offset = blockmap->first_offset;
732         blockmap->alloc_offset = HAMMER_ENCODE_UNDO(undo_limit);
733         hammer_crc_set_blockmap(blockmap);
734
735         limit_index = undo_limit / HAMMER_BIGBLOCK_SIZE;
736         assert(limit_index <= HAMMER_MAX_UNDO_BIGBLOCKS);
737
738         for (n = 0; n < limit_index; ++n) {
739                 ondisk->vol0_undo_array[n] = alloc_undo_bigblock(root_vol);
740         }
741         while (n < HAMMER_MAX_UNDO_BIGBLOCKS) {
742                 ondisk->vol0_undo_array[n++] = HAMMER_BLOCKMAP_UNAVAIL;
743         }
744
745         /*
746          * Pre-initialize the UNDO blocks (HAMMER version 4+)
747          */
748         printf("initializing the undo map (%jd MB)\n",
749                 (intmax_t)HAMMER_OFF_LONG_ENCODE(blockmap->alloc_offset) /
750                 (1024 * 1024));
751
752         scan = blockmap->first_offset;
753         seqno = 0;
754
755         while (scan < blockmap->alloc_offset) {
756                 hammer_fifo_head_t head;
757                 hammer_fifo_tail_t tail;
758                 int isnew;
759                 int bytes = HAMMER_UNDO_ALIGN;
760
761                 isnew = ((scan & HAMMER_BUFMASK64) == 0);
762                 head = get_buffer_data(scan, &buffer, isnew);
763                 buffer->cache.modified = 1;
764                 tail = (void *)((char *)head + bytes - sizeof(*tail));
765
766                 bzero(head, bytes);
767                 head->hdr_signature = HAMMER_HEAD_SIGNATURE;
768                 head->hdr_type = HAMMER_HEAD_TYPE_DUMMY;
769                 head->hdr_size = bytes;
770                 head->hdr_seq = seqno++;
771
772                 tail->tail_signature = HAMMER_TAIL_SIGNATURE;
773                 tail->tail_type = HAMMER_HEAD_TYPE_DUMMY;
774                 tail->tail_size = bytes;
775
776                 hammer_crc_set_fifo_head(head, bytes);
777
778                 scan += bytes;
779         }
780         rel_buffer(buffer);
781 }
782
783 const char *zone_labels[] = {
784         "",             /* 0 */
785         "raw_volume",   /* 1 */
786         "raw_buffer",   /* 2 */
787         "undo",         /* 3 */
788         "freemap",      /* 4 */
789         "",             /* 5 */
790         "",             /* 6 */
791         "",             /* 7 */
792         "btree",        /* 8 */
793         "meta",         /* 9 */
794         "large_data",   /* 10 */
795         "small_data",   /* 11 */
796         "",             /* 12 */
797         "",             /* 13 */
798         "",             /* 14 */
799         "unavail",      /* 15 */
800 };
801
802 void
803 print_blockmap(const struct volume_info *vol)
804 {
805         hammer_blockmap_t blockmap;
806         hammer_volume_ondisk_t ondisk;
807         int64_t size, used;
808         int i;
809 #define INDENT ""
810
811         ondisk = vol->ondisk;
812         printf(INDENT"vol_label\t%s\n", ondisk->vol_label);
813         printf(INDENT"vol_count\t%d\n", ondisk->vol_count);
814         printf(INDENT"vol_bot_beg\t%s\n", sizetostr(ondisk->vol_bot_beg));
815         printf(INDENT"vol_mem_beg\t%s\n", sizetostr(ondisk->vol_mem_beg));
816         printf(INDENT"vol_buf_beg\t%s\n", sizetostr(ondisk->vol_buf_beg));
817         printf(INDENT"vol_buf_end\t%s\n", sizetostr(ondisk->vol_buf_end));
818         printf(INDENT"vol0_next_tid\t%016jx\n",
819                (uintmax_t)ondisk->vol0_next_tid);
820
821         blockmap = &ondisk->vol0_blockmap[HAMMER_ZONE_UNDO_INDEX];
822         size = HAMMER_OFF_LONG_ENCODE(blockmap->alloc_offset);
823         if (blockmap->first_offset <= blockmap->next_offset)
824                 used = blockmap->next_offset - blockmap->first_offset;
825         else
826                 used = blockmap->alloc_offset - blockmap->first_offset +
827                         HAMMER_OFF_LONG_ENCODE(blockmap->next_offset);
828         printf(INDENT"undo_size\t%s\n", sizetostr(size));
829         printf(INDENT"undo_used\t%s\n", sizetostr(used));
830
831         printf(INDENT"zone #             "
832                "phys             first            next             alloc\n");
833         for (i = 0; i < HAMMER_MAX_ZONES; i++) {
834                 blockmap = &ondisk->vol0_blockmap[i];
835                 printf(INDENT"zone %-2d %-10s %016jx %016jx %016jx %016jx\n",
836                         i, zone_labels[i],
837                         (uintmax_t)blockmap->phys_offset,
838                         (uintmax_t)blockmap->first_offset,
839                         (uintmax_t)blockmap->next_offset,
840                         (uintmax_t)blockmap->alloc_offset);
841         }
842 }
843
844 /*
845  * Flush various tracking structures to disk
846  */
847 void
848 flush_all_volumes(void)
849 {
850         struct volume_info *vol;
851
852         TAILQ_FOREACH(vol, &VolList, entry)
853                 flush_volume(vol);
854 }
855
856 void
857 flush_volume(struct volume_info *volume)
858 {
859         struct buffer_info *buffer;
860         int i;
861
862         for (i = 0; i < HAMMER_BUFLISTS; ++i) {
863                 TAILQ_FOREACH(buffer, &volume->buffer_lists[i], entry)
864                         flush_buffer(buffer);
865         }
866         if (writehammervol(volume) == -1)
867                 err(1, "Write volume %d (%s)", volume->vol_no, volume->name);
868 }
869
870 void
871 flush_buffer(struct buffer_info *buffer)
872 {
873         struct volume_info *vol;
874
875         vol = buffer->volume;
876         if (writehammerbuf(buffer) == -1)
877                 err(1, "Write volume %d (%s)", vol->vol_no, vol->name);
878         buffer->cache.modified = 0;
879 }
880
881 /*
882  * Core I/O operations
883  */
884 static int
885 __read(struct volume_info *vol, void *data, int64_t offset, int size)
886 {
887         ssize_t n;
888
889         n = pread(vol->fd, data, size, offset);
890         if (n != size)
891                 return(-1);
892         return(0);
893 }
894
895 static __inline int
896 readhammervol(struct volume_info *vol)
897 {
898         return(__read(vol, vol->ondisk, 0, HAMMER_BUFSIZE));
899 }
900
901 static __inline int
902 readhammerbuf(struct buffer_info *buf)
903 {
904         return(__read(buf->volume, buf->ondisk, buf->raw_offset, HAMMER_BUFSIZE));
905 }
906
907 static int
908 __write(struct volume_info *vol, const void *data, int64_t offset, int size)
909 {
910         ssize_t n;
911
912         if (vol->rdonly)
913                 return(0);
914
915         n = pwrite(vol->fd, data, size, offset);
916         if (n != size)
917                 return(-1);
918         return(0);
919 }
920
921 static __inline int
922 writehammervol(struct volume_info *vol)
923 {
924         return(__write(vol, vol->ondisk, 0, HAMMER_BUFSIZE));
925 }
926
927 static __inline int
928 writehammerbuf(struct buffer_info *buf)
929 {
930         return(__write(buf->volume, buf->ondisk, buf->raw_offset, HAMMER_BUFSIZE));
931 }
932
933 int64_t init_boot_area_size(int64_t value, off_t avg_vol_size)
934 {
935         if (value == 0) {
936                 value = HAMMER_BOOT_NOMBYTES;
937                 while (value > avg_vol_size / HAMMER_MAX_VOLUMES)
938                         value >>= 1;
939         }
940
941         if (value < HAMMER_BOOT_MINBYTES) {
942                 value = HAMMER_BOOT_MINBYTES;
943         } else if (value > HAMMER_BOOT_MAXBYTES) {
944                 value = HAMMER_BOOT_MAXBYTES;
945         }
946
947         return(value);
948 }
949
950 int64_t init_memory_log_size(int64_t value, off_t avg_vol_size)
951 {
952         if (value == 0) {
953                 value = HAMMER_MEM_NOMBYTES;
954                 while (value > avg_vol_size / HAMMER_MAX_VOLUMES)
955                         value >>= 1;
956         }
957
958         if (value < HAMMER_MEM_MINBYTES) {
959                 value = HAMMER_MEM_MINBYTES;
960         } else if (value > HAMMER_MEM_MAXBYTES) {
961                 value = HAMMER_MEM_MAXBYTES;
962         }
963
964         return(value);
965 }