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
35 #include <sys/sysctl.h>
36 #include <sys/ioctl_compat.h>
38 #include "hammer_util.h"
40 static int64_t getsize(const char *str, int64_t minval, int64_t maxval, int pw);
41 static const char *sizetostr(off_t size);
42 static void trim_volume(struct volume_info *vol);
43 static void format_volume(struct volume_info *vol, int nvols,const char *label);
44 static hammer_off_t format_root_directory(const char *label);
45 static uint64_t nowtime(void);
46 static void usage(void);
49 static int64_t BootAreaSize;
50 static int64_t MemAreaSize;
51 static int64_t UndoBufferSize;
52 static int HammerVersion = -1;
54 #define GIG (1024LL*1024*1024)
57 main(int ac, char **av)
66 const char *label = NULL;
67 struct volume_info *vol;
71 * Sanity check basic filesystem structures. No cookies for us
74 assert(sizeof(struct hammer_volume_ondisk) <= HAMMER_BUFSIZE);
75 assert(sizeof(struct hammer_blockmap_layer1) == 32);
76 assert(sizeof(struct hammer_blockmap_layer2) == 16);
79 * Generate a filesystem id and lookup the filesystem type
81 uuidgen(&Hammer_FSId, 1);
82 uuid_name_lookup(&Hammer_FSType, "DragonFly HAMMER", &status);
83 if (status != uuid_s_ok) {
84 errx(1, "uuids file does not have the DragonFly "
85 "HAMMER filesystem type");
91 while ((ch = getopt(ac, av, "fEL:b:m:u:V:")) != -1) {
103 BootAreaSize = getsize(optarg,
105 HAMMER_BOOT_MAXBYTES, 2);
108 MemAreaSize = getsize(optarg,
110 HAMMER_MEM_MAXBYTES, 2);
113 UndoBufferSize = getsize(optarg,
114 HAMMER_BIGBLOCK_SIZE,
115 HAMMER_BIGBLOCK_SIZE *
116 HAMMER_UNDO_LAYER2, 2);
117 if (UndoBufferSize < 500*1024*1024 && ForceOpt == 0)
118 errx(1, "The minimum UNDO/REDO FIFO size is "
120 if (UndoBufferSize < 500*1024*1024) {
122 "WARNING: you have specified an "
123 "UNDO/REDO FIFO size less than 500MB,\n"
124 "which may lead to VFS panics.\n");
128 HammerVersion = strtol(optarg, NULL, 0);
129 if (HammerVersion < HAMMER_VOL_VERSION_MIN ||
130 HammerVersion >= HAMMER_VOL_VERSION_WIP) {
132 "I don't understand how to format "
133 "HAMMER version %d\n",
145 "newfs_hammer: A filesystem label must be specified\n");
149 if (HammerVersion < 0) {
150 size_t olen = sizeof(HammerVersion);
151 HammerVersion = HAMMER_VOL_VERSION_DEFAULT;
152 if (sysctlbyname("vfs.hammer.supported_version",
153 &HammerVersion, &olen, NULL, 0) == 0) {
154 if (HammerVersion >= HAMMER_VOL_VERSION_WIP) {
155 HammerVersion = HAMMER_VOL_VERSION_WIP - 1;
157 "newfs_hammer: WARNING: HAMMER VFS "
158 "supports higher version than I "
160 "using version %d\n",
165 "newfs_hammer: WARNING: HAMMER VFS not "
166 "loaded, cannot get version info.\n"
167 "Using version %d\n",
168 HAMMER_VOL_VERSION_DEFAULT);
173 * Collect volume information
181 "newfs_hammer: You must specify at least one "
182 "special file (volume)\n");
186 if (nvols > HAMMER_MAX_VOLUMES) {
188 "newfs_hammer: The maximum number of volumes is %d\n",
194 for (i = 0; i < nvols; ++i) {
195 vol = init_volume(i, av[i], O_RDWR);
198 * Load up information on the volume and initialize
199 * its remaining fields.
202 printf("Volume %d %s %-15s size %s\n",
203 vol->vol_no, vol->type, vol->name,
204 sizetostr(vol->size));
207 if (strcmp(vol->type, "REGFILE") == 0) {
208 fprintf(stderr, "Cannot TRIM regular file %s\n",
213 char sysctl_name[64];
214 int trim_enabled = 0;
215 size_t olen = sizeof(trim_enabled);
216 char *dev_name = strdup(vol->name);
217 dev_name = strtok(dev_name + strlen("/dev/da"),"s");
219 sprintf(sysctl_name, "kern.cam.da.%s.trim_enabled",
222 sysctlbyname(sysctl_name, &trim_enabled, &olen, NULL, 0);
223 if(errno == ENOENT) {
224 printf("%s %s (%s) does not support the TRIM "
226 vol->type, vol->name, sysctl_name);
230 printf("Erase device option selected, but "
231 "sysctl (%s) is not enabled\n", sysctl_name);
241 * Calculate defaults for the boot and memory area sizes.
243 avg_vol_size = total / nvols;
244 BootAreaSize = init_boot_area_size(BootAreaSize, avg_vol_size);
245 MemAreaSize = init_mem_area_size(MemAreaSize, avg_vol_size);
248 * Format the volumes. Format the root volume first so we can
249 * bootstrap the freemap.
251 format_volume(get_root_volume(), nvols, label);
252 for (i = 0; i < nvols; ++i) {
253 if (i != HAMMER_ROOT_VOLNO)
254 format_volume(get_volume(i), nvols, label);
258 * Print information stored in the root volume header.
260 vol = get_root_volume();
261 uuid_to_string(&Hammer_FSId, &fsidstr, &status);
263 printf("---------------------------------------------\n");
264 printf("%d volume%s total size %s version %d\n",
265 nvols, (nvols == 1 ? "" : "s"),
266 sizetostr(total), HammerVersion);
267 printf("root-volume: %s\n", vol->name);
268 printf("boot-area-size: %s\n", sizetostr(BootAreaSize));
269 printf("memory-log-size: %s\n", sizetostr(MemAreaSize));
270 printf("undo-buffer-size: %s\n", sizetostr(UndoBufferSize));
271 printf("total-pre-allocated: %s\n",
272 sizetostr(vol->vol_free_off & HAMMER_OFF_SHORT_MASK));
273 printf("fsid: %s\n", fsidstr);
275 printf("NOTE: Please remember that you may have to manually set up a\n"
276 "cron(8) job to prune and reblock the filesystem regularly.\n"
277 "By default, the system automatically runs 'hammer cleanup'\n"
278 "on a nightly basis. The periodic.conf(5) variable\n"
279 "'daily_clean_hammer_enable' can be unset to disable this.\n"
280 "Also see 'man hammer' and 'man HAMMER' for more information.\n");
281 if (total < 10*GIG) {
282 printf("\nWARNING: The minimum UNDO/REDO FIFO is 500MB, you "
283 "really should not\n"
284 "try to format a HAMMER filesystem this small.\n");
286 if (total < 50*GIG) {
287 printf("\nWARNING: HAMMER filesystems less than 50GB are "
289 "You may have to run 'hammer prune-everything' and "
291 "quite often, even if using a nohistory mount.\n");
302 "usage: newfs_hammer -L label [-Ef] [-b bootsize] [-m savesize] [-u undosize]\n"
303 " [-V version] special ...\n"
309 * Convert the size in bytes to a human readable string.
313 sizetostr(off_t size)
317 if (size < 1024 / 2) {
318 snprintf(buf, sizeof(buf), "%6.2f", (double)size);
319 } else if (size < 1024 * 1024 / 2) {
320 snprintf(buf, sizeof(buf), "%6.2fKB",
321 (double)size / 1024);
322 } else if (size < 1024 * 1024 * 1024LL / 2) {
323 snprintf(buf, sizeof(buf), "%6.2fMB",
324 (double)size / (1024 * 1024));
325 } else if (size < 1024 * 1024 * 1024LL * 1024LL / 2) {
326 snprintf(buf, sizeof(buf), "%6.2fGB",
327 (double)size / (1024 * 1024 * 1024LL));
329 snprintf(buf, sizeof(buf), "%6.2fTB",
330 (double)size / (1024 * 1024 * 1024LL * 1024LL));
336 * Convert a string to a 64 bit signed integer with various requirements.
339 getsize(const char *str, int64_t minval, int64_t maxval, int powerof2)
344 val = strtoll(str, &ptr, 0);
363 errx(1, "Unknown suffix in number '%s'\n", str);
367 errx(1, "Unknown suffix in number '%s'\n", str);
371 errx(1, "Value too small: %s, min is %s\n",
372 str, sizetostr(minval));
376 errx(1, "Value too large: %s, max is %s\n",
377 str, sizetostr(maxval));
380 if ((powerof2 & 1) && (val ^ (val - 1)) != ((val << 1) - 1)) {
381 errx(1, "Value not power of 2: %s\n", str);
384 if ((powerof2 & 2) && (val & HAMMER_BUFMASK)) {
385 errx(1, "Value not an integral multiple of %dK: %s",
386 HAMMER_BUFSIZE / 1024, str);
393 * Generate a transaction id. Transaction ids are no longer time-based.
394 * Put the nail in the coffin by not making the first one time-based.
396 * We could start at 1 here but start at 2^32 to reserve a small domain for
397 * possible future use.
402 static hammer_tid_t lasttid;
405 lasttid = 0x0000000100000000ULL;
415 gettimeofday(&tv, NULL);
416 xtime = tv.tv_sec * 1000000LL + tv.tv_usec;
421 * TRIM the volume, but only if the backing store is a DEVICE
425 trim_volume(struct volume_info *vol)
427 if (strncmp(vol->type, "DEVICE", sizeof("DEVICE")) == 0) {
430 /* 1MB offset to prevent destroying disk-reserved area */
431 ioarg[0] = vol->device_offset;
432 ioarg[1] = vol->size;
434 printf("Trimming %s %s, sectors (%llu -%llu)\n",
435 vol->type, vol->name,
436 (unsigned long long)ioarg[0]/512,
437 (unsigned long long)ioarg[1]/512);
439 if (ioctl(vol->fd, IOCTLTRIM, ioarg) < 0) {
440 printf("Device trim failed\n");
447 * Format a HAMMER volume.
451 format_volume(struct volume_info *vol, int nvols, const char *label)
453 struct volume_info *root_vol;
454 struct hammer_volume_ondisk *ondisk;
457 int64_t vol_buf_size;
458 hammer_off_t vol_alloc;
462 * Initialize basic information in the on-disk volume structure.
464 ondisk = vol->ondisk;
466 ondisk->vol_fsid = Hammer_FSId;
467 ondisk->vol_fstype = Hammer_FSType;
468 snprintf(ondisk->vol_name, sizeof(ondisk->vol_name), "%s", label);
469 ondisk->vol_no = vol->vol_no;
470 ondisk->vol_count = nvols;
471 ondisk->vol_version = HammerVersion;
474 * Reserve space for (future) header junk, setup our poor-man's
475 * big-block allocator.
477 vol_alloc = HAMMER_BUFSIZE * 16; /* 262144 */
479 ondisk->vol_bot_beg = vol_alloc;
480 vol_alloc += BootAreaSize;
481 ondisk->vol_mem_beg = vol_alloc;
482 vol_alloc += MemAreaSize;
485 * The remaining area is the zone 2 buffer allocation area.
487 ondisk->vol_buf_beg = vol_alloc;
488 ondisk->vol_buf_end = vol->size & ~(int64_t)HAMMER_BUFMASK;
489 vol_buf_size = ondisk->vol_buf_end - ondisk->vol_buf_beg;
491 if (vol_buf_size < 0) {
492 errx(1, "volume %d %s is too small to hold the volume header",
493 vol->vol_no, vol->name);
496 ondisk->vol_nblocks = vol_buf_size / HAMMER_BUFSIZE;
497 ondisk->vol_blocksize = HAMMER_BUFSIZE;
499 ondisk->vol_rootvol = HAMMER_ROOT_VOLNO;
500 ondisk->vol_signature = HAMMER_FSBUF_VOLUME;
502 vol->vol_free_off = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no, 0);
503 vol->vol_free_end = HAMMER_ENCODE_RAW_BUFFER(vol->vol_no,
504 vol_buf_size & ~HAMMER_BIGBLOCK_MASK64);
507 * Format the root volume.
509 if (vol->vol_no == HAMMER_ROOT_VOLNO) {
511 * Check freemap counts before formatting
513 freeblks = count_freemap(vol);
514 freebytes = freeblks * HAMMER_BIGBLOCK_SIZE64;
515 if (freebytes < 10*GIG && ForceOpt == 0) {
516 errx(1, "Cannot create a HAMMER filesystem less than 10GB "
517 "unless you use -f\n(for the size of Volume %d). "
518 "HAMMER filesystems less than 50GB are not "
519 "recommended.\n", HAMMER_ROOT_VOLNO);
525 ondisk->vol0_next_tid = createtid();
528 * Format freemap. vol0_stat_freebigblocks is
529 * the number of big-blocks available for anything
530 * other than freemap zone at this point.
533 assert(ondisk->vol0_stat_freebigblocks == 0);
534 ondisk->vol0_stat_freebigblocks = initialize_freemap(vol);
537 * Format zones that are mapped to zone-2.
539 for (i = 0; i < HAMMER_MAX_ZONES; ++i) {
540 if (hammer_is_zone2_mapped_index(i))
541 format_blockmap(vol, i, 0);
545 * Format undo zone. Formatting decrements
546 * vol0_stat_freebigblocks whenever a new big-block
547 * is allocated for undo zone.
549 format_undomap(vol, &UndoBufferSize);
550 assert(ondisk->vol0_stat_bigblocks == 0);
551 ondisk->vol0_stat_bigblocks = ondisk->vol0_stat_freebigblocks;
554 * Format the root directory. Formatting decrements
555 * vol0_stat_freebigblocks whenever a new big-block
556 * is allocated for required zones.
558 ondisk->vol0_btree_root = format_root_directory(label);
559 ++ondisk->vol0_stat_inodes; /* root inode */
563 freeblks = initialize_freemap(vol);
564 root_vol = get_root_volume();
565 root_vol->ondisk->vol0_stat_freebigblocks += freeblks;
566 root_vol->ondisk->vol0_stat_bigblocks += freeblks;
567 rel_volume(root_vol);
572 * Format the root directory.
576 format_root_directory(const char *label)
578 hammer_off_t btree_off;
579 hammer_off_t pfsd_off;
580 hammer_off_t data_off;
581 hammer_tid_t create_tid;
582 hammer_node_ondisk_t bnode;
583 struct hammer_inode_data *idata;
584 hammer_pseudofs_data_t pfsd;
585 struct buffer_info *data_buffer0 = NULL;
586 struct buffer_info *data_buffer1 = NULL;
587 struct buffer_info *data_buffer2 = NULL;
588 hammer_btree_elm_t elm;
592 * Allocate zero-filled root btree node, inode and pfs
594 bnode = alloc_btree_element(&btree_off, &data_buffer0);
595 idata = alloc_meta_element(&data_off, sizeof(*idata), &data_buffer1);
596 pfsd = alloc_meta_element(&pfsd_off, sizeof(*pfsd), &data_buffer2);
597 create_tid = createtid();
601 * Populate the inode data and inode record for the root directory.
603 idata->version = HAMMER_INODE_DATA_VERSION;
605 idata->ctime = xtime;
606 idata->mtime = xtime;
607 idata->atime = xtime;
608 idata->obj_type = HAMMER_OBJTYPE_DIRECTORY;
611 if (HammerVersion >= HAMMER_VOL_VERSION_TWO)
612 idata->cap_flags |= HAMMER_INODE_CAP_DIR_LOCAL_INO;
613 if (HammerVersion >= HAMMER_VOL_VERSION_SIX)
614 idata->cap_flags |= HAMMER_INODE_CAP_DIRHASH_ALG1;
617 * Populate the PFS data for the root PFS.
619 pfsd->sync_low_tid = 1;
620 pfsd->sync_beg_tid = 0;
621 pfsd->sync_end_tid = 0; /* overriden by vol0_next_tid on pfs0 */
622 pfsd->shared_uuid = Hammer_FSId;
623 pfsd->unique_uuid = Hammer_FSId;
624 pfsd->reserved01 = 0;
625 pfsd->mirror_flags = 0;
626 snprintf(pfsd->label, sizeof(pfsd->label), "%s", label);
629 * Create the root of the B-Tree. The root is a leaf node so we
630 * do not have to worry about boundary elements.
633 bnode->type = HAMMER_BTREE_TYPE_LEAF;
636 * Create the first node element for the inode.
638 elm = &bnode->elms[0];
639 elm->leaf.base.btype = HAMMER_BTREE_TYPE_RECORD;
640 elm->leaf.base.localization = HAMMER_DEF_LOCALIZATION |
641 HAMMER_LOCALIZE_INODE;
642 elm->leaf.base.obj_id = HAMMER_OBJID_ROOT;
643 elm->leaf.base.key = 0;
644 elm->leaf.base.create_tid = create_tid;
645 elm->leaf.base.delete_tid = 0;
646 elm->leaf.base.rec_type = HAMMER_RECTYPE_INODE;
647 elm->leaf.base.obj_type = HAMMER_OBJTYPE_DIRECTORY;
648 elm->leaf.create_ts = (uint32_t)time(NULL);
650 elm->leaf.data_offset = data_off;
651 elm->leaf.data_len = sizeof(*idata);
652 elm->leaf.data_crc = crc32(idata, HAMMER_INODE_CRCSIZE);
655 * Create the second node element for the PFS data.
657 elm = &bnode->elms[1];
658 elm->leaf.base.btype = HAMMER_BTREE_TYPE_RECORD;
659 elm->leaf.base.localization = HAMMER_DEF_LOCALIZATION |
660 HAMMER_LOCALIZE_MISC;
661 elm->leaf.base.obj_id = HAMMER_OBJID_ROOT;
662 elm->leaf.base.key = 0;
663 elm->leaf.base.create_tid = create_tid;
664 elm->leaf.base.delete_tid = 0;
665 elm->leaf.base.rec_type = HAMMER_RECTYPE_PFS;
666 elm->leaf.base.obj_type = 0;
667 elm->leaf.create_ts = (uint32_t)time(NULL);
669 elm->leaf.data_offset = pfsd_off;
670 elm->leaf.data_len = sizeof(*pfsd);
671 elm->leaf.data_crc = crc32(pfsd, sizeof(*pfsd));
673 bnode->crc = crc32(&bnode->crc + 1, HAMMER_BTREE_CRCSIZE);