2 * Copyright (c) 1983, 1989, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#) Copyright (c) 1983, 1989, 1993, 1994 The Regents of the University of California. All rights reserved.
30 * @(#)newfs.c 8.13 (Berkeley) 5/1/95
31 * $FreeBSD: src/sbin/newfs/newfs.c,v 1.30.2.9 2003/05/13 12:03:55 joerg Exp $
35 * newfs: friendly front end to mkfs
37 #include <sys/param.h>
39 #include <sys/diskslice.h>
41 #include <sys/mount.h>
42 #include <sys/sysctl.h>
44 #include <vfs/ufs/dir.h>
45 #include <vfs/ufs/dinode.h>
46 #include <vfs/ufs/fs.h>
47 #include <vfs/ufs/ufsmount.h>
63 #include <sys/types.h>
71 struct mntopt mopts[] = {
77 void fatal(const char *fmt, ...) __printflike(1, 2);
79 #define COMPAT /* allow non-labeled disks */
82 * The following two constants set the default block and fragment sizes.
83 * Both constants must be a power of 2 and meet the following constraints:
84 * MINBSIZE <= DESBLKSIZE <= MAXBSIZE
85 * sectorsize <= DESFRAGSIZE <= DESBLKSIZE
86 * DESBLKSIZE / DESFRAGSIZE <= 8
88 #define DFL_FRAGSIZE 2048
89 #define DFL_BLKSIZE 16384
92 * Cylinder groups may have up to many cylinders. The actual
93 * number used depends upon how much information can be stored
94 * on a single cylinder. The default is to use as many as possible
95 * cylinders per group.
97 #define DESCPG 65536 /* desired fs_cpg ("infinity") */
100 * Once upon a time...
101 * ROTDELAY gives the minimum number of milliseconds to initiate
102 * another disk transfer on the same cylinder. It is used in
103 * determining the rotationally optimal layout for disk blocks
104 * within a file; the default of fs_rotdelay is 4ms.
106 * ...but now we make this 0 to disable the rotdelay delay because
107 * modern drives with read/write-behind achieve higher performance
113 * MAXBLKPG determines the maximum number of data blocks which are
114 * placed in a single cylinder group. The default is one indirect
115 * block worth of data blocks.
117 #define MAXBLKPG(bsize) ((bsize) / sizeof(daddr_t))
120 * Each file system has a number of inodes statically allocated.
121 * We allocate one inode slot per NFPI fragments, expecting this
122 * to be far more than we will ever need.
127 * Once upon a time...
128 * For each cylinder we keep track of the availability of blocks at different
129 * rotational positions, so that we can lay out the data to be picked
130 * up with minimum rotational latency. NRPOS is the default number of
131 * rotational positions that we distinguish. With NRPOS of 8 the resolution
132 * of our summary information is 2ms for a typical 3600 rpm drive.
134 * ...but now we make this 1 (which essentially disables the rotational
135 * position table because modern drives with read-ahead and write-behind do
136 * better without the rotational position table.
138 #define NRPOS 1 /* number distinct rotational positions */
141 * About the same time as the above, we knew what went where on the disks.
142 * no longer so, so kill the code which finds the different platters too...
143 * We do this by saying one head, with a lot of sectors on it.
144 * The number of sectors are used to determine the size of a cyl-group.
145 * Kirk suggested one or two meg per "cylinder" so we say two.
147 #define NTRACKS 1 /* number of heads */
148 #define NSECTORS 4096 /* number of sectors */
150 int mfs; /* run as the memory based filesystem */
151 char *mfs_mtpt; /* mount point for mfs */
152 struct stat mfs_mtstat; /* stat prior to mount */
153 int Lflag; /* add a volume label */
154 int Nflag; /* run without writing file system */
155 int Oflag; /* format as an 4.3BSD file system */
156 int Cflag; /* copy underlying filesystem (mfs only) */
157 int Uflag; /* enable soft updates for file system */
158 int Eflag; /* erase contents using TRIM */
159 uint64_t slice_offset; /* Pysical device slice offset */
160 u_long fssize; /* file system size */
161 int ntracks = NTRACKS; /* # tracks/cylinder */
162 int nsectors = NSECTORS; /* # sectors/track */
163 int nphyssectors; /* # sectors/track including spares */
164 int secpercyl; /* sectors per cylinder */
165 int trackspares = -1; /* spare sectors per track */
166 int cylspares = -1; /* spare sectors per cylinder */
167 int sectorsize; /* bytes/sector */
168 int realsectorsize; /* bytes/sector in hardware */
169 int rpm; /* revolutions/minute of drive */
170 int interleave; /* hardware sector interleave */
171 int trackskew = -1; /* sector 0 skew, per track */
172 int headswitch; /* head switch time, usec */
173 int trackseek; /* track-to-track seek, usec */
174 int fsize = 0; /* fragment size */
175 int bsize = 0; /* block size */
176 int cpg = DESCPG; /* cylinders/cylinder group */
177 int cpgflg; /* cylinders/cylinder group flag was given */
178 int minfree = MINFREE; /* free space threshold */
179 int opt = DEFAULTOPT; /* optimization preference (space or time) */
180 int density; /* number of bytes per inode */
181 int maxcontig = 0; /* max contiguous blocks to allocate */
182 int rotdelay = ROTDELAY; /* rotational delay between blocks */
183 int maxbpg; /* maximum blocks per file in a cyl group */
184 int nrpos = NRPOS; /* # of distinguished rotational positions */
185 int avgfilesize = AVFILESIZ;/* expected average file size */
186 int avgfilesperdir = AFPDIR;/* expected number of files per directory */
187 int bbsize = BBSIZE; /* boot block size */
188 int sbsize = SBSIZE; /* superblock size */
189 int mntflags = MNT_ASYNC; /* flags to be passed to mount */
190 int t_or_u_flag = 0; /* user has specified -t or -u */
191 caddr_t membase; /* start address of memory based filesystem */
193 u_char *volumelabel = NULL; /* volume label for filesystem */
199 char mfsdevname[256];
202 static void usage(void);
203 static void mfsintr(int signo);
206 main(int argc, char **argv)
209 struct disktab geom; /* disk geometry data */
212 int fsi = -1, fso = -1, len, n, vflag;
213 char *s1, *s2, *special;
214 const char *opstring;
220 bzero(&geom, sizeof(geom));
222 if ((progname = strrchr(*argv, '/')))
227 if (strstr(progname, "mfs")) {
233 "L:NCF:T:Ua:b:c:d:e:f:g:h:i:m:o:s:v" :
234 "L:NEOS:T:Ua:b:c:d:e:f:g:h:i:k:l:m:n:o:p:r:s:t:u:vx:";
235 while ((ch = getopt(argc, argv, opstring)) != -1) {
241 volumelabel = optarg;
243 while (isalnum(volumelabel[++i]))
245 if (volumelabel[i] != '\0')
246 errx(1, "bad volume label. Valid characters are alphanumerics.");
247 if (strlen(volumelabel) >= MAXVOLLEN)
248 errx(1, "bad volume label. Length is longer than %d.",
259 Cflag = 1; /* MFS only */
262 if ((sectorsize = atoi(optarg)) <= 0)
263 fatal("%s: bad sector size", optarg);
277 if ((maxcontig = atoi(optarg)) <= 0)
278 fatal("%s: bad maximum contiguous blocks",
282 if ((bsize = atoi(optarg)) < MINBSIZE)
283 fatal("%s: bad block size", optarg);
286 if ((cpg = atoi(optarg)) <= 0)
287 fatal("%s: bad cylinders/group", optarg);
291 if ((rotdelay = atoi(optarg)) < 0)
292 fatal("%s: bad rotational delay", optarg);
295 if ((maxbpg = atoi(optarg)) <= 0)
296 fatal("%s: bad blocks per file in a cylinder group",
300 if ((fsize = atoi(optarg)) <= 0)
301 fatal("%s: bad fragment size", optarg);
304 if ((avgfilesize = atoi(optarg)) <= 0)
305 fatal("%s: bad average file size", optarg);
308 if ((avgfilesperdir = atoi(optarg)) <= 0)
309 fatal("%s: bad average files per dir", optarg);
312 if ((density = atoi(optarg)) <= 0)
313 fatal("%s: bad bytes per inode", optarg);
316 if ((trackskew = atoi(optarg)) < 0)
317 fatal("%s: bad track skew", optarg);
320 if ((interleave = atoi(optarg)) <= 0)
321 fatal("%s: bad interleave", optarg);
324 if ((minfree = atoi(optarg)) < 0 || minfree > 99)
325 fatal("%s: bad free space %%", optarg);
328 if ((nrpos = atoi(optarg)) < 0)
329 fatal("%s: bad rotational layout count",
336 getmntopts(optarg, mopts, &mntflags, 0);
338 if (strcmp(optarg, "space") == 0)
340 else if (strcmp(optarg, "time") == 0)
343 fatal("%s: unknown optimization preference: use `space' or `time'", optarg);
347 if ((trackspares = atoi(optarg)) < 0)
348 fatal("%s: bad spare sectors per track",
352 if ((rpm = atoi(optarg)) <= 0)
353 fatal("%s: bad revolutions/minute", optarg);
357 * Unsigned long but limit to long. On 32 bit a
358 * tad under 2G, on 64 bit the upper bound is more
359 * swap space then operand size.
361 * NOTE: fssize is converted from 512 byte sectors
362 * to filesystem block-sized sectors by mkfs XXX.
364 fssize = strtoul(optarg, NULL, 10);
365 if (fssize == 0 || fssize > LONG_MAX)
366 fatal("%s: bad file system size", optarg);
370 if ((ntracks = atoi(optarg)) < 0)
371 fatal("%s: bad total tracks", optarg);
375 if ((nsectors = atoi(optarg)) < 0)
376 fatal("%s: bad sectors/track", optarg);
382 if ((cylspares = atoi(optarg)) < 0)
383 fatal("%s: bad spare sectors per cylinder",
394 if (argc != 2 && (mfs || argc != 1))
398 /* Copy the NetBSD way of faking up a disk label */
399 if (mfs && !strcmp(special, "swap")) {
401 * it's an MFS, mounted on "swap." fake up a label.
404 fso = -1; /* XXX; normally done below. */
406 geom.d_media_blksize = 512;
408 geom.d_secpertrack = 64;
409 /* geom.d_ncylinders not used */
410 geom.d_secpercyl = 1024;
411 geom.d_media_blocks = 16384;
413 geom.d_interleave = 1;
419 * If we can't stat the device and the path is relative, try
422 if (stat(special, &st) < 0 && special[0] && special[0] != '/')
423 asprintf(&special, "/dev/%s", special);
426 char sysctl_name[64];
427 int trim_enabled = 0;
428 size_t olen = sizeof(trim_enabled);
429 char *dev_name = strdup(special);
431 dev_name = strtok(dev_name + strlen("/dev/da"),"s");
432 sprintf(sysctl_name, "kern.cam.da.%s.trim_enabled",
435 sysctlbyname(sysctl_name, &trim_enabled, &olen, NULL, 0);
437 if(errno == ENOENT) {
438 printf("Device:%s does not support the TRIM command\n",
443 printf("Erase device option selected, but sysctl (%s) "
444 "is not enabled\n",sysctl_name);
452 fso = open(special, O_WRONLY);
454 fatal("%s: %s", special, strerror(errno));
456 /* Bail if target special is mounted */
457 n = getmntinfo(&mp, MNT_NOWAIT);
459 fatal("%s: getmntinfo: %s", special, strerror(errno));
461 len = sizeof(_PATH_DEV) - 1;
463 if (strncmp(_PATH_DEV, s1, len) == 0)
467 s2 = mp->f_mntfromname;
468 if (strncmp(_PATH_DEV, s2, len) == 0) {
472 if (strcmp(s1, s2) == 0 || strcmp(s1, &s2[1]) == 0)
473 fatal("%s is mounted on %s",
474 special, mp->f_mntonname);
478 if (mfs && disktype != NULL) {
481 if ((dt = getdisktabbyname(disktype)) == NULL)
482 fatal("%s: unknown disk type", disktype);
485 struct partinfo pinfo;
488 fatal("null special file name");
489 fsi = open(special, O_RDONLY);
491 fatal("%s: %s", special, strerror(errno));
492 if (fstat(fsi, &st) < 0)
493 fatal("%s: %s", special, strerror(errno));
494 if ((st.st_mode & S_IFMT) != S_IFCHR && !mfs && !vflag)
495 printf("%s: %s: not a character-special device\n",
498 if (!mfs && disktype == NULL)
501 if (ioctl(fsi, DIOCGPART, &pinfo) < 0) {
503 fatal("%s: unable to retrieve geometry "
504 "information", argv[0]);
507 * fake up geometry data
509 geom.d_media_blksize = 512;
511 geom.d_secpertrack = 64;
512 geom.d_secpercyl = 1024;
513 geom.d_media_blocks = st.st_size /
514 geom.d_media_blksize;
515 geom.d_media_size = geom.d_media_blocks *
516 geom.d_media_blksize;
517 /* geom.d_ncylinders not used */
520 * extract geometry from pinfo
522 geom.d_media_blksize = pinfo.media_blksize;
523 geom.d_nheads = pinfo.d_nheads;
524 geom.d_secpertrack = pinfo.d_secpertrack;
525 geom.d_secpercyl = pinfo.d_secpercyl;
526 /* geom.d_ncylinders not used */
527 geom.d_media_blocks = pinfo.media_blocks;
528 geom.d_media_size = pinfo.media_size;
529 slice_offset = pinfo.media_offset;
531 if (geom.d_media_blocks == 0 || geom.d_media_size == 0) {
532 fatal("%s: is unavailable", argv[0]);
534 printf("%s: media size %6.2fMB\n",
535 argv[0], geom.d_media_size / 1024.0 / 1024.0);
536 if (geom.d_media_size / 512 >= 0x80000000ULL)
537 fatal("%s: media size is too large for newfs to handle",
542 fssize = geom.d_media_blocks;
543 if ((u_long)fssize > geom.d_media_blocks && !mfs) {
544 fatal("%s: maximum file system size is %" PRIu64 " blocks",
545 argv[0], geom.d_media_blocks);
553 ntracks = geom.d_nheads;
555 fatal("%s: no default #tracks", argv[0]);
558 nsectors = geom.d_secpertrack;
560 fatal("%s: no default #sectors/track", argv[0]);
562 if (sectorsize == 0) {
563 sectorsize = geom.d_media_blksize;
565 fatal("%s: no default sector size", argv[0]);
567 if (trackskew == -1) {
568 trackskew = geom.d_trackskew;
572 if (interleave == 0) {
573 interleave = geom.d_interleave;
578 fsize = MAX(DFL_FRAGSIZE, geom.d_media_blksize);
580 bsize = MIN(DFL_BLKSIZE, 8 * fsize);
582 * Maxcontig sets the default for the maximum number of blocks
583 * that may be allocated sequentially. With filesystem clustering
584 * it is possible to allocate contiguous blocks up to the maximum
585 * transfer size permitted by the controller or buffering.
588 maxcontig = MAX(1, MAXPHYS / bsize - 1);
590 density = NFPI * fsize;
591 if (minfree < MINFREE && opt != FS_OPTSPACE) {
592 fprintf(stderr, "Warning: changing optimization to space ");
593 fprintf(stderr, "because minfree is less than %d%%\n", MINFREE);
596 if (trackspares == -1)
598 nphyssectors = nsectors + trackspares;
601 secpercyl = nsectors * ntracks - cylspares;
603 * Only complain if -t or -u have been specified; the default
604 * case (4096 sectors per cylinder) is intended to disagree
605 * with the disklabel.
607 if (t_or_u_flag && (uint32_t)secpercyl != geom.d_secpercyl)
608 fprintf(stderr, "%s (%d) %s (%u)\n",
609 "Warning: calculated sectors per cylinder", secpercyl,
610 "disagrees with disk label", geom.d_secpercyl);
612 maxbpg = MAXBLKPG(bsize);
613 headswitch = geom.d_headswitch;
614 trackseek = geom.d_trkseek;
615 realsectorsize = sectorsize;
616 if (sectorsize != DEV_BSIZE) { /* XXX */
617 int secperblk = sectorsize / DEV_BSIZE;
619 sectorsize = DEV_BSIZE;
620 nsectors *= secperblk;
621 nphyssectors *= secperblk;
622 secpercyl *= secperblk;
628 stat(mfs_mtpt, &mfs_mtstat) < 0 ||
629 !S_ISDIR(mfs_mtstat.st_mode)
631 fatal("mount point not dir: %s", mfs_mtpt);
634 mkfs(special, fsi, fso, (Cflag && mfs) ? argv[1] : NULL);
637 * NOTE: Newfs no longer accesses or attempts to update the
638 * filesystem disklabel.
640 * NOTE: fssize is converted from 512 byte sectors
641 * to filesystem block-sized sectors by mkfs XXX.
648 struct mfs_args args;
650 bzero(&args, sizeof(args));
652 snprintf(mfsdevname, sizeof(mfsdevname), "/dev/mfs%d",
654 args.fspec = mfsdevname;
655 args.export.ex_root = -2;
656 if (mntflags & MNT_RDONLY)
657 args.export.ex_flags = MNT_EXRDONLY;
659 args.export.ex_flags = 0;
661 args.size = fssize * fsize;
663 error = getvfsbyname("mfs", &vfc);
664 if (error && vfsisloadable("mfs")) {
666 fatal("vfsload(mfs)");
667 endvfsent(); /* flush cache */
668 error = getvfsbyname("mfs", &vfc);
671 fatal("mfs filesystem not available");
675 udev = (253 << 8) | (getpid() & 255) |
676 ((getpid() & ~0xFF) << 8);
677 if (mknod(mfsdevname, S_IFCHR | 0700, udev) < 0)
678 printf("Warning: unable to create %s\n", mfsdevname);
680 signal(SIGINT, mfsintr);
681 if (mount(vfc.vfc_name, argv[1], mntflags, &args) < 0)
682 fatal("%s: %s", argv[1], strerror(errno));
683 signal(SIGINT, SIG_DFL);
693 mfsintr(__unused int signo)
696 munmap(membase, fssize * fsize);
706 fatal(const char *fmt, ...)
711 if (fcntl(STDERR_FILENO, F_GETFL) < 0) {
712 openlog(progname, LOG_CONS, LOG_DAEMON);
713 vsyslog(LOG_ERR, fmt, ap);
728 "usage: %s [ -fsoptions ] special-device mount-point\n",
732 "usage: %s [ -fsoptions ] special-device%s\n",
739 fprintf(stderr, "where fsoptions are:\n");
740 fprintf(stderr, "\t-C (mfs) Copy the underlying filesystem to the MFS mount\n");
741 fprintf(stderr, "\t-E erase file system contents using TRIM\n");
742 fprintf(stderr, "\t-L volume name\n");
744 "\t-N do not create file system, just print out parameters\n");
745 fprintf(stderr, "\t-O create a 4.3BSD format filesystem\n");
746 fprintf(stderr, "\t-S sector size\n");
748 fprintf(stderr, "\t-T disktype\n");
750 fprintf(stderr, "\t-U enable soft updates\n");
751 fprintf(stderr, "\t-a maximum contiguous blocks\n");
752 fprintf(stderr, "\t-b block size\n");
753 fprintf(stderr, "\t-c cylinders/group\n");
754 fprintf(stderr, "\t-d rotational delay between contiguous blocks\n");
755 fprintf(stderr, "\t-e maximum blocks per file in a cylinder group\n");
756 fprintf(stderr, "\t-f frag size\n");
757 fprintf(stderr, "\t-g average file size\n");
758 fprintf(stderr, "\t-h average files per directory\n");
759 fprintf(stderr, "\t-i number of bytes per inode\n");
760 fprintf(stderr, "\t-k sector 0 skew, per track\n");
761 fprintf(stderr, "\t-l hardware sector interleave\n");
762 fprintf(stderr, "\t-m minimum free space %%\n");
763 fprintf(stderr, "\t-n number of distinguished rotational positions\n");
764 fprintf(stderr, "\t-o optimization preference (`space' or `time')\n");
765 fprintf(stderr, "\t-p spare sectors per track\n");
766 fprintf(stderr, "\t-s file system size (sectors)\n");
767 fprintf(stderr, "\t-r revolutions/minute\n");
768 fprintf(stderr, "\t-t tracks/cylinder\n");
769 fprintf(stderr, "\t-u sectors/track\n");
771 "\t-v do not attempt to determine partition name from device name\n");
772 fprintf(stderr, "\t-x spare sectors per cylinder\n");