2 * Copyright (c) 2007 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sbin/newfs_hammer/newfs_hammer.c,v 1.44 2008/08/21 23:32:27 thomas Exp $
37 #include "newfs_hammer.h"
39 static int64_t getsize(const char *str
, int64_t minval
, int64_t maxval
, int pw
);
40 static const char *sizetostr(off_t size
);
41 static void check_volume(struct volume_info
*vol
);
42 static void format_volume(struct volume_info
*vol
, int nvols
,const char *label
,
44 static hammer_off_t
format_root(const char *label
);
45 static u_int64_t
nowtime(void);
46 static void usage(void);
48 static int ForceOpt
= 0;
49 static int HammerVersion
= -1;
51 #define GIG (1024LL*1024*1024)
54 main(int ac
, char **av
)
60 const char *label
= NULL
;
61 struct volume_info
*vol
;
65 * Sanity check basic filesystem structures. No cookies for us
68 assert(sizeof(struct hammer_volume_ondisk
) <= HAMMER_BUFSIZE
);
69 assert(sizeof(struct hammer_blockmap_layer1
) == 32);
70 assert(sizeof(struct hammer_blockmap_layer2
) == 16);
73 * Generate a filesystem id and lookup the filesystem type
75 uuidgen(&Hammer_FSId
, 1);
76 uuid_name_lookup(&Hammer_FSType
, "DragonFly HAMMER", &status
);
77 if (status
!= uuid_s_ok
) {
78 errx(1, "uuids file does not have the DragonFly "
79 "HAMMER filesystem type");
85 while ((ch
= getopt(ac
, av
, "fL:b:m:u:V:")) != -1) {
94 BootAreaSize
= getsize(optarg
,
96 HAMMER_BOOT_MAXBYTES
, 2);
99 MemAreaSize
= getsize(optarg
,
101 HAMMER_MEM_MAXBYTES
, 2);
104 UndoBufferSize
= getsize(optarg
,
105 HAMMER_LARGEBLOCK_SIZE
,
106 HAMMER_LARGEBLOCK_SIZE
*
107 HAMMER_UNDO_LAYER2
, 2);
108 if (UndoBufferSize
< 100*1024*1024 && ForceOpt
== 0)
109 errx(1, "The minimum UNDO fifo size is 100MB\n");
110 if (UndoBufferSize
< 100*1024*1024) {
112 "WARNING: you have specified an UNDO "
113 "FIFO size less than 100MB, which may\n"
114 "lead to VFS panics.\n");
118 HammerVersion
= strtol(optarg
, NULL
, 0);
119 if (HammerVersion
< HAMMER_VOL_VERSION_MIN
||
120 HammerVersion
>= HAMMER_VOL_VERSION_WIP
) {
122 "I don't understand how to format "
123 "HAMMER version %d\n",
135 "newfs_hammer: A filesystem label must be specified\n");
139 if (HammerVersion
< 0) {
140 size_t olen
= sizeof(HammerVersion
);
141 HammerVersion
= HAMMER_VOL_VERSION_DEFAULT
;
142 if (sysctlbyname("vfs.hammer.supported_version",
143 &HammerVersion
, &olen
, NULL
, 0) == 0) {
144 if (HammerVersion
>= HAMMER_VOL_VERSION_WIP
) {
145 HammerVersion
= HAMMER_VOL_VERSION_WIP
- 1;
147 "newfs_hammer: WARNING: HAMMER VFS "
148 "supports higher version than I "
150 "using version %d\n",
155 "newfs_hammer: WARNING: HAMMER VFS not "
156 "loaded, cannot get version info.\n"
157 "Using version %d\n",
158 HAMMER_VOL_VERSION_DEFAULT
);
163 * Collect volume information
170 if (NumVolumes
== 0) {
172 "newfs_hammer: You must specify at least one special file (volume)\n");
176 if (NumVolumes
> HAMMER_MAX_VOLUMES
) {
178 "newfs_hammer: The maximum number of volumes is %d\n", HAMMER_MAX_VOLUMES
);
183 for (i
= 0; i
< NumVolumes
; ++i
) {
184 vol
= setup_volume(i
, av
[i
], 1, O_RDWR
);
187 * Load up information on the volume and initialize
188 * its remaining fields.
195 * Calculate defaults for the boot and memory area sizes.
197 if (BootAreaSize
== 0) {
198 BootAreaSize
= HAMMER_BOOT_NOMBYTES
;
199 while (BootAreaSize
> total
/ NumVolumes
/ HAMMER_MAX_VOLUMES
)
201 if (BootAreaSize
< HAMMER_BOOT_MINBYTES
)
203 } else if (BootAreaSize
< HAMMER_BOOT_MINBYTES
) {
204 BootAreaSize
= HAMMER_BOOT_MINBYTES
;
206 if (MemAreaSize
== 0) {
207 MemAreaSize
= HAMMER_MEM_NOMBYTES
;
208 while (MemAreaSize
> total
/ NumVolumes
/ HAMMER_MAX_VOLUMES
)
210 if (MemAreaSize
< HAMMER_MEM_MINBYTES
)
212 } else if (MemAreaSize
< HAMMER_MEM_MINBYTES
) {
213 MemAreaSize
= HAMMER_MEM_MINBYTES
;
217 * Format the volumes. Format the root volume first so we can
218 * bootstrap the freemap.
220 format_volume(get_volume(RootVolNo
), NumVolumes
, label
, total
);
221 for (i
= 0; i
< NumVolumes
; ++i
) {
223 format_volume(get_volume(i
), NumVolumes
, label
, total
);
227 * Pre-size the blockmap layer1/layer2 infrastructure to the zone
228 * limit. If we do this the filesystem does not have to allocate
229 * new layer2 blocks which reduces the chances of the reblocker
230 * having to fallback to an extremely inefficient algorithm.
232 vol
= get_volume(RootVolNo
);
233 vol
->ondisk
->vol0_stat_bigblocks
= vol
->ondisk
->vol0_stat_freebigblocks
;
234 vol
->cache
.modified
= 1;
235 uuid_to_string(&Hammer_FSId
, &fsidstr
, &status
);
237 printf("---------------------------------------------\n");
238 printf("%d volume%s total size %s version %d\n",
239 NumVolumes
, (NumVolumes
== 1 ? "" : "s"),
240 sizetostr(total
), HammerVersion
);
241 printf("boot-area-size: %s\n", sizetostr(BootAreaSize
));
242 printf("memory-log-size: %s\n", sizetostr(MemAreaSize
));
243 printf("undo-buffer-size: %s\n", sizetostr(UndoBufferSize
));
244 printf("total-pre-allocated: %s\n",
245 sizetostr(vol
->vol_free_off
& HAMMER_OFF_SHORT_MASK
));
246 printf("fsid: %s\n", fsidstr
);
248 printf("NOTE: Please remember that you may have to manually set up a\n"
249 "cron(8) job to prune and reblock the filesystem regularly.\n"
250 "By default, the system automatically runs 'hammer cleanup'\n"
251 "on a nightly basis. The periodic.conf(5) variable\n"
252 "'daily_clean_hammer_enable' can be unset to disable this.\n"
253 "Also see 'man hammer' and 'man HAMMER' for more information.\n");
254 if (total
< 50*GIG
) {
255 printf("\nWARNING: HAMMER filesystems less than 50GB are "
257 "You may have to run 'hammer prune-everything' and "
259 "quite often, even if using a nohistory mount.\n");
270 "usage: newfs_hammer -L label [-f] [-b bootsize] [-m savesize] [-u undosize]\n"
271 " [-V version] special ...\n"
277 * Convert the size in bytes to a human readable string.
281 sizetostr(off_t size
)
285 if (size
< 1024 / 2) {
286 snprintf(buf
, sizeof(buf
), "%6.2f", (double)size
);
287 } else if (size
< 1024 * 1024 / 2) {
288 snprintf(buf
, sizeof(buf
), "%6.2fKB",
289 (double)size
/ 1024);
290 } else if (size
< 1024 * 1024 * 1024LL / 2) {
291 snprintf(buf
, sizeof(buf
), "%6.2fMB",
292 (double)size
/ (1024 * 1024));
293 } else if (size
< 1024 * 1024 * 1024LL * 1024LL / 2) {
294 snprintf(buf
, sizeof(buf
), "%6.2fGB",
295 (double)size
/ (1024 * 1024 * 1024LL));
297 snprintf(buf
, sizeof(buf
), "%6.2fTB",
298 (double)size
/ (1024 * 1024 * 1024LL * 1024LL));
304 * Convert a string to a 64 bit signed integer with various requirements.
307 getsize(const char *str
, int64_t minval
, int64_t maxval
, int powerof2
)
312 val
= strtoll(str
, &ptr
, 0);
331 errx(1, "Unknown suffix in number '%s'\n", str
);
335 errx(1, "Unknown suffix in number '%s'\n", str
);
339 errx(1, "Value too small: %s, min is %s\n",
340 str
, sizetostr(minval
));
344 errx(1, "Value too large: %s, max is %s\n",
345 str
, sizetostr(maxval
));
348 if ((powerof2
& 1) && (val
^ (val
- 1)) != ((val
<< 1) - 1)) {
349 errx(1, "Value not power of 2: %s\n", str
);
352 if ((powerof2
& 2) && (val
& HAMMER_BUFMASK
)) {
353 errx(1, "Value not an integral multiple of %dK: %s",
354 HAMMER_BUFSIZE
/ 1024, str
);
361 * Generate a transaction id. Transaction ids are no longer time-based.
362 * Put the nail in the coffin by not making the first one time-based.
364 * We could start at 1 here but start at 2^32 to reserve a small domain for
365 * possible future use.
370 static hammer_tid_t lasttid
;
373 lasttid
= 0x0000000100000000ULL
;
383 gettimeofday(&tv
, NULL
);
384 xtime
= tv
.tv_sec
* 1000000LL + tv
.tv_usec
;
389 * Check basic volume characteristics. HAMMER filesystems use a minimum
390 * of a 16KB filesystem buffer size.
394 check_volume(struct volume_info
*vol
)
396 struct partinfo pinfo
;
400 * Get basic information about the volume
402 vol
->fd
= open(vol
->name
, O_RDWR
);
404 err(1, "Unable to open %s R+W", vol
->name
);
405 if (ioctl(vol
->fd
, DIOCGPART
, &pinfo
) < 0) {
407 * Allow the formatting of regular files as HAMMER volumes
409 if (fstat(vol
->fd
, &st
) < 0)
410 err(1, "Unable to stat %s", vol
->name
);
411 vol
->size
= st
.st_size
;
412 vol
->type
= "REGFILE";
415 * When formatting a block device as a HAMMER volume the
416 * sector size must be compatible. HAMMER uses 16384 byte
417 * filesystem buffers.
419 if (pinfo
.reserved_blocks
) {
420 errx(1, "HAMMER cannot be placed in a partition "
421 "which overlaps the disklabel or MBR");
423 if (pinfo
.media_blksize
> 16384 ||
424 16384 % pinfo
.media_blksize
) {
425 errx(1, "A media sector size of %d is not supported",
426 pinfo
.media_blksize
);
429 vol
->size
= pinfo
.media_size
;
430 vol
->type
= "DEVICE";
432 printf("Volume %d %s %-15s size %s\n",
433 vol
->vol_no
, vol
->type
, vol
->name
,
434 sizetostr(vol
->size
));
437 * Reserve space for (future) header junk, setup our poor-man's
438 * bigblock allocator.
440 vol
->vol_alloc
= HAMMER_BUFSIZE
* 16;
444 * Format a HAMMER volume. Cluster 0 will be initially placed in volume 0.
448 format_volume(struct volume_info
*vol
, int nvols
, const char *label
,
449 off_t total_size __unused
)
451 struct volume_info
*root_vol
;
452 struct hammer_volume_ondisk
*ondisk
;
458 * Initialize basic information in the on-disk volume structure.
460 ondisk
= vol
->ondisk
;
462 ondisk
->vol_fsid
= Hammer_FSId
;
463 ondisk
->vol_fstype
= Hammer_FSType
;
464 snprintf(ondisk
->vol_name
, sizeof(ondisk
->vol_name
), "%s", label
);
465 ondisk
->vol_no
= vol
->vol_no
;
466 ondisk
->vol_count
= nvols
;
467 ondisk
->vol_version
= HammerVersion
;
469 ondisk
->vol_bot_beg
= vol
->vol_alloc
;
470 vol
->vol_alloc
+= BootAreaSize
;
471 ondisk
->vol_mem_beg
= vol
->vol_alloc
;
472 vol
->vol_alloc
+= MemAreaSize
;
475 * The remaining area is the zone 2 buffer allocation area. These
478 ondisk
->vol_buf_beg
= vol
->vol_alloc
;
479 ondisk
->vol_buf_end
= vol
->size
& ~(int64_t)HAMMER_BUFMASK
;
481 if (ondisk
->vol_buf_end
< ondisk
->vol_buf_beg
) {
482 errx(1, "volume %d %s is too small to hold the volume header",
483 vol
->vol_no
, vol
->name
);
486 ondisk
->vol_nblocks
= (ondisk
->vol_buf_end
- ondisk
->vol_buf_beg
) /
488 ondisk
->vol_blocksize
= HAMMER_BUFSIZE
;
490 ondisk
->vol_rootvol
= RootVolNo
;
491 ondisk
->vol_signature
= HAMMER_FSBUF_VOLUME
;
493 vol
->vol_free_off
= HAMMER_ENCODE_RAW_BUFFER(vol
->vol_no
, 0);
494 vol
->vol_free_end
= HAMMER_ENCODE_RAW_BUFFER(vol
->vol_no
, (ondisk
->vol_buf_end
- ondisk
->vol_buf_beg
) & ~HAMMER_LARGEBLOCK_MASK64
);
497 * Format the root volume.
499 if (vol
->vol_no
== RootVolNo
) {
503 ondisk
->vol0_next_tid
= createtid();
506 &ondisk
->vol0_blockmap
[HAMMER_ZONE_FREEMAP_INDEX
]);
508 freeblks
= initialize_freemap(vol
);
509 ondisk
->vol0_stat_freebigblocks
= freeblks
;
511 freebytes
= freeblks
* HAMMER_LARGEBLOCK_SIZE64
;
512 if (freebytes
< 1*GIG
&& ForceOpt
== 0) {
513 errx(1, "Cannot create a HAMMER filesystem less than "
514 "1GB unless you use -f. HAMMER filesystems\n"
515 "less than 50GB are not recommended\n");
518 for (i
= 8; i
< HAMMER_MAX_ZONES
; ++i
) {
519 format_blockmap(&ondisk
->vol0_blockmap
[i
],
520 HAMMER_ZONE_ENCODE(i
, 0));
522 format_undomap(ondisk
);
524 ondisk
->vol0_btree_root
= format_root(label
);
525 ++ondisk
->vol0_stat_inodes
; /* root inode */
527 freeblks
= initialize_freemap(vol
);
528 root_vol
= get_volume(RootVolNo
);
529 root_vol
->cache
.modified
= 1;
530 root_vol
->ondisk
->vol0_stat_freebigblocks
+= freeblks
;
531 root_vol
->ondisk
->vol0_stat_bigblocks
+= freeblks
;
532 rel_volume(root_vol
);
537 * Format the root directory.
541 format_root(const char *label
)
543 hammer_off_t btree_off
;
544 hammer_off_t pfsd_off
;
545 hammer_off_t data_off
;
546 hammer_tid_t create_tid
;
547 hammer_node_ondisk_t bnode
;
548 struct hammer_inode_data
*idata
;
549 hammer_pseudofs_data_t pfsd
;
550 struct buffer_info
*data_buffer1
= NULL
;
551 struct buffer_info
*data_buffer2
= NULL
;
552 hammer_btree_elm_t elm
;
555 bnode
= alloc_btree_element(&btree_off
);
556 idata
= alloc_data_element(&data_off
, sizeof(*idata
), &data_buffer1
);
557 pfsd
= alloc_data_element(&pfsd_off
, sizeof(*pfsd
), &data_buffer2
);
558 create_tid
= createtid();
562 * Populate the inode data and inode record for the root directory.
564 idata
->version
= HAMMER_INODE_DATA_VERSION
;
566 idata
->ctime
= xtime
;
567 idata
->mtime
= xtime
;
568 idata
->atime
= xtime
;
569 idata
->obj_type
= HAMMER_OBJTYPE_DIRECTORY
;
572 if (HammerVersion
>= HAMMER_VOL_VERSION_TWO
)
573 idata
->cap_flags
|= HAMMER_INODE_CAP_DIR_LOCAL_INO
;
575 pfsd
->sync_low_tid
= 1;
576 pfsd
->sync_beg_tid
= 0;
577 pfsd
->sync_end_tid
= 0; /* overriden by vol0_next_tid on pfs0 */
578 pfsd
->shared_uuid
= Hammer_FSId
;
579 pfsd
->unique_uuid
= Hammer_FSId
;
580 pfsd
->reserved01
= 0;
581 pfsd
->mirror_flags
= 0;
582 snprintf(pfsd
->label
, sizeof(pfsd
->label
), "%s", label
);
585 * Create the root of the B-Tree. The root is a leaf node so we
586 * do not have to worry about boundary elements.
588 bnode
->signature
= HAMMER_BTREE_SIGNATURE_GOOD
;
590 bnode
->type
= HAMMER_BTREE_TYPE_LEAF
;
592 elm
= &bnode
->elms
[0];
593 elm
->leaf
.base
.btype
= HAMMER_BTREE_TYPE_RECORD
;
594 elm
->leaf
.base
.localization
= HAMMER_LOCALIZE_INODE
;
595 elm
->leaf
.base
.obj_id
= HAMMER_OBJID_ROOT
;
596 elm
->leaf
.base
.key
= 0;
597 elm
->leaf
.base
.create_tid
= create_tid
;
598 elm
->leaf
.base
.delete_tid
= 0;
599 elm
->leaf
.base
.rec_type
= HAMMER_RECTYPE_INODE
;
600 elm
->leaf
.base
.obj_type
= HAMMER_OBJTYPE_DIRECTORY
;
601 elm
->leaf
.create_ts
= (u_int32_t
)time(NULL
);
603 elm
->leaf
.data_offset
= data_off
;
604 elm
->leaf
.data_len
= sizeof(*idata
);
605 elm
->leaf
.data_crc
= crc32(idata
, HAMMER_INODE_CRCSIZE
);
607 elm
= &bnode
->elms
[1];
608 elm
->leaf
.base
.btype
= HAMMER_BTREE_TYPE_RECORD
;
609 elm
->leaf
.base
.localization
= HAMMER_LOCALIZE_MISC
;
610 elm
->leaf
.base
.obj_id
= HAMMER_OBJID_ROOT
;
611 elm
->leaf
.base
.key
= 0;
612 elm
->leaf
.base
.create_tid
= create_tid
;
613 elm
->leaf
.base
.delete_tid
= 0;
614 elm
->leaf
.base
.rec_type
= HAMMER_RECTYPE_PFS
;
615 elm
->leaf
.base
.obj_type
= 0;
616 elm
->leaf
.create_ts
= (u_int32_t
)time(NULL
);
618 elm
->leaf
.data_offset
= pfsd_off
;
619 elm
->leaf
.data_len
= sizeof(*pfsd
);
620 elm
->leaf
.data_crc
= crc32(pfsd
, sizeof(*pfsd
));
622 bnode
->crc
= crc32(&bnode
->crc
+ 1, HAMMER_BTREE_CRCSIZE
);