newfs.c revision 343538
1/* 2 * Copyright (c) 2002 Networks Associates Technology, Inc. 3 * All rights reserved. 4 * 5 * This software was developed for the FreeBSD Project by Marshall 6 * Kirk McKusick and Network Associates Laboratories, the Security 7 * Research Division of Network Associates, Inc. under DARPA/SPAWAR 8 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS 9 * research program. 10 * 11 * Copyright (c) 1983, 1989, 1993, 1994 12 * The Regents of the University of California. All rights reserved. 13 * 14 * Redistribution and use in source and binary forms, with or without 15 * modification, are permitted provided that the following conditions 16 * are met: 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 2. Redistributions in binary form must reproduce the above copyright 20 * notice, this list of conditions and the following disclaimer in the 21 * documentation and/or other materials provided with the distribution. 22 * 4. Neither the name of the University nor the names of its contributors 23 * may be used to endorse or promote products derived from this software 24 * without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 */ 38 39#if 0 40#ifndef lint 41static const char copyright[] = 42"@(#) Copyright (c) 1983, 1989, 1993, 1994\n\ 43 The Regents of the University of California. All rights reserved.\n"; 44#endif /* not lint */ 45 46#ifndef lint 47static char sccsid[] = "@(#)newfs.c 8.13 (Berkeley) 5/1/95"; 48#endif /* not lint */ 49#endif 50#include <sys/cdefs.h> 51__FBSDID("$FreeBSD: stable/11/sbin/newfs/newfs.c 343538 2019-01-28 21:48:04Z mckusick $"); 52 53/* 54 * newfs: friendly front end to mkfs 55 */ 56#include <sys/param.h> 57#include <sys/stat.h> 58#include <sys/disk.h> 59#include <sys/disklabel.h> 60#include <sys/file.h> 61#include <sys/mount.h> 62 63#include <ufs/ufs/dir.h> 64#include <ufs/ufs/dinode.h> 65#include <ufs/ffs/fs.h> 66#include <ufs/ufs/ufsmount.h> 67 68#include <ctype.h> 69#include <err.h> 70#include <errno.h> 71#include <inttypes.h> 72#include <paths.h> 73#include <stdarg.h> 74#include <stdio.h> 75#include <stdlib.h> 76#include <string.h> 77#include <syslog.h> 78#include <unistd.h> 79 80#include <libutil.h> 81 82#include "newfs.h" 83 84int Eflag; /* Erase previous disk contents */ 85int Lflag; /* add a volume label */ 86int Nflag; /* run without writing file system */ 87int Oflag = 2; /* file system format (1 => UFS1, 2 => UFS2) */ 88int Rflag; /* regression test */ 89int Uflag; /* enable soft updates for file system */ 90int jflag; /* enable soft updates journaling for filesys */ 91int Xflag = 0; /* exit in middle of newfs for testing */ 92int Jflag; /* enable gjournal for file system */ 93int lflag; /* enable multilabel for file system */ 94int nflag; /* do not create .snap directory */ 95int tflag; /* enable TRIM */ 96intmax_t fssize; /* file system size */ 97off_t mediasize; /* device size */ 98int sectorsize; /* bytes/sector */ 99int realsectorsize; /* bytes/sector in hardware */ 100int fsize = 0; /* fragment size */ 101int bsize = 0; /* block size */ 102int maxbsize = 0; /* maximum clustering */ 103int maxblkspercg = MAXBLKSPERCG; /* maximum blocks per cylinder group */ 104int minfree = MINFREE; /* free space threshold */ 105int metaspace; /* space held for metadata blocks */ 106int opt = DEFAULTOPT; /* optimization preference (space or time) */ 107int density; /* number of bytes per inode */ 108int maxcontig = 0; /* max contiguous blocks to allocate */ 109int maxbpg; /* maximum blocks per file in a cyl group */ 110int avgfilesize = AVFILESIZ;/* expected average file size */ 111int avgfilesperdir = AFPDIR;/* expected number of files per directory */ 112u_char *volumelabel = NULL; /* volume label for filesystem */ 113struct uufsd disk; /* libufs disk structure */ 114 115static char device[MAXPATHLEN]; 116static u_char bootarea[BBSIZE]; 117static int is_file; /* work on a file, not a device */ 118static char *dkname; 119static char *disktype; 120 121static void getfssize(intmax_t *, const char *p, intmax_t, intmax_t); 122static struct disklabel *getdisklabel(char *s); 123static void usage(void); 124static int expand_number_int(const char *buf, int *num); 125 126ufs2_daddr_t part_ofs; /* partition offset in blocks, used with files */ 127 128int 129main(int argc, char *argv[]) 130{ 131 struct partition *pp; 132 struct disklabel *lp; 133 struct stat st; 134 char *cp, *special; 135 intmax_t reserved; 136 int ch, i, rval; 137 char part_name; /* partition name, default to full disk */ 138 139 part_name = 'c'; 140 reserved = 0; 141 while ((ch = getopt(argc, argv, 142 "EJL:NO:RS:T:UXa:b:c:d:e:f:g:h:i:jk:lm:no:p:r:s:t")) != -1) 143 switch (ch) { 144 case 'E': 145 Eflag = 1; 146 break; 147 case 'J': 148 Jflag = 1; 149 break; 150 case 'L': 151 volumelabel = optarg; 152 i = -1; 153 while (isalnum(volumelabel[++i]) || 154 volumelabel[i] == '_'); 155 if (volumelabel[i] != '\0') { 156 errx(1, "bad volume label. Valid characters " 157 "are alphanumerics and underscores."); 158 } 159 if (strlen(volumelabel) >= MAXVOLLEN) { 160 errx(1, "bad volume label. Length is longer than %d.", 161 MAXVOLLEN); 162 } 163 Lflag = 1; 164 break; 165 case 'N': 166 Nflag = 1; 167 break; 168 case 'O': 169 if ((Oflag = atoi(optarg)) < 1 || Oflag > 2) 170 errx(1, "%s: bad file system format value", 171 optarg); 172 break; 173 case 'R': 174 Rflag = 1; 175 break; 176 case 'S': 177 rval = expand_number_int(optarg, §orsize); 178 if (rval < 0 || sectorsize <= 0) 179 errx(1, "%s: bad sector size", optarg); 180 break; 181 case 'T': 182 disktype = optarg; 183 break; 184 case 'j': 185 jflag = 1; 186 /* fall through to enable soft updates */ 187 case 'U': 188 Uflag = 1; 189 break; 190 case 'X': 191 Xflag++; 192 break; 193 case 'a': 194 rval = expand_number_int(optarg, &maxcontig); 195 if (rval < 0 || maxcontig <= 0) 196 errx(1, "%s: bad maximum contiguous blocks", 197 optarg); 198 break; 199 case 'b': 200 rval = expand_number_int(optarg, &bsize); 201 if (rval < 0) 202 errx(1, "%s: bad block size", 203 optarg); 204 if (bsize < MINBSIZE) 205 errx(1, "%s: block size too small, min is %d", 206 optarg, MINBSIZE); 207 if (bsize > MAXBSIZE) 208 errx(1, "%s: block size too large, max is %d", 209 optarg, MAXBSIZE); 210 break; 211 case 'c': 212 rval = expand_number_int(optarg, &maxblkspercg); 213 if (rval < 0 || maxblkspercg <= 0) 214 errx(1, "%s: bad blocks per cylinder group", 215 optarg); 216 break; 217 case 'd': 218 rval = expand_number_int(optarg, &maxbsize); 219 if (rval < 0 || maxbsize < MINBSIZE) 220 errx(1, "%s: bad extent block size", optarg); 221 break; 222 case 'e': 223 rval = expand_number_int(optarg, &maxbpg); 224 if (rval < 0 || maxbpg <= 0) 225 errx(1, "%s: bad blocks per file in a cylinder group", 226 optarg); 227 break; 228 case 'f': 229 rval = expand_number_int(optarg, &fsize); 230 if (rval < 0 || fsize <= 0) 231 errx(1, "%s: bad fragment size", optarg); 232 break; 233 case 'g': 234 rval = expand_number_int(optarg, &avgfilesize); 235 if (rval < 0 || avgfilesize <= 0) 236 errx(1, "%s: bad average file size", optarg); 237 break; 238 case 'h': 239 rval = expand_number_int(optarg, &avgfilesperdir); 240 if (rval < 0 || avgfilesperdir <= 0) 241 errx(1, "%s: bad average files per dir", optarg); 242 break; 243 case 'i': 244 rval = expand_number_int(optarg, &density); 245 if (rval < 0 || density <= 0) 246 errx(1, "%s: bad bytes per inode", optarg); 247 break; 248 case 'l': 249 lflag = 1; 250 break; 251 case 'k': 252 if ((metaspace = atoi(optarg)) < 0) 253 errx(1, "%s: bad metadata space %%", optarg); 254 if (metaspace == 0) 255 /* force to stay zero in mkfs */ 256 metaspace = -1; 257 break; 258 case 'm': 259 if ((minfree = atoi(optarg)) < 0 || minfree > 99) 260 errx(1, "%s: bad free space %%", optarg); 261 break; 262 case 'n': 263 nflag = 1; 264 break; 265 case 'o': 266 if (strcmp(optarg, "space") == 0) 267 opt = FS_OPTSPACE; 268 else if (strcmp(optarg, "time") == 0) 269 opt = FS_OPTTIME; 270 else 271 errx(1, 272 "%s: unknown optimization preference: use `space' or `time'", 273 optarg); 274 break; 275 case 'r': 276 errno = 0; 277 reserved = strtoimax(optarg, &cp, 0); 278 if (errno != 0 || cp == optarg || 279 *cp != '\0' || reserved < 0) 280 errx(1, "%s: bad reserved size", optarg); 281 break; 282 case 'p': 283 is_file = 1; 284 part_name = optarg[0]; 285 break; 286 287 case 's': 288 errno = 0; 289 fssize = strtoimax(optarg, &cp, 0); 290 if (errno != 0 || cp == optarg || 291 *cp != '\0' || fssize < 0) 292 errx(1, "%s: bad file system size", optarg); 293 break; 294 case 't': 295 tflag = 1; 296 break; 297 case '?': 298 default: 299 usage(); 300 } 301 argc -= optind; 302 argv += optind; 303 304 if (argc != 1) 305 usage(); 306 307 special = argv[0]; 308 if (!special[0]) 309 err(1, "empty file/special name"); 310 cp = strrchr(special, '/'); 311 if (cp == NULL) { 312 /* 313 * No path prefix; try prefixing _PATH_DEV. 314 */ 315 snprintf(device, sizeof(device), "%s%s", _PATH_DEV, special); 316 special = device; 317 } 318 319 if (is_file) { 320 /* bypass ufs_disk_fillout_blank */ 321 bzero( &disk, sizeof(disk)); 322 disk.d_bsize = 1; 323 disk.d_name = special; 324 disk.d_fd = open(special, O_RDONLY); 325 if (disk.d_fd < 0 || 326 (!Nflag && ufs_disk_write(&disk) == -1)) 327 errx(1, "%s: ", special); 328 } else if (ufs_disk_fillout_blank(&disk, special) == -1 || 329 (!Nflag && ufs_disk_write(&disk) == -1)) { 330 if (disk.d_error != NULL) 331 errx(1, "%s: %s", special, disk.d_error); 332 else 333 err(1, "%s", special); 334 } 335 if (fstat(disk.d_fd, &st) < 0) 336 err(1, "%s", special); 337 if ((st.st_mode & S_IFMT) != S_IFCHR) { 338 warn("%s: not a character-special device", special); 339 is_file = 1; /* assume it is a file */ 340 dkname = special; 341 if (sectorsize == 0) 342 sectorsize = 512; 343 mediasize = st.st_size; 344 /* set fssize from the partition */ 345 } else { 346 if (sectorsize == 0) 347 if (ioctl(disk.d_fd, DIOCGSECTORSIZE, §orsize) == -1) 348 sectorsize = 0; /* back out on error for safety */ 349 if (sectorsize && ioctl(disk.d_fd, DIOCGMEDIASIZE, &mediasize) != -1) 350 getfssize(&fssize, special, mediasize / sectorsize, reserved); 351 } 352 pp = NULL; 353 lp = getdisklabel(special); 354 if (lp != NULL) { 355 if (!is_file) /* already set for files */ 356 part_name = special[strlen(special) - 1]; 357 if ((part_name < 'a' || part_name - 'a' >= MAXPARTITIONS) && 358 !isdigit(part_name)) 359 errx(1, "%s: can't figure out file system partition", 360 special); 361 cp = &part_name; 362 if (isdigit(*cp)) 363 pp = &lp->d_partitions[RAW_PART]; 364 else 365 pp = &lp->d_partitions[*cp - 'a']; 366 if (pp->p_size == 0) 367 errx(1, "%s: `%c' partition is unavailable", 368 special, *cp); 369 if (pp->p_fstype == FS_BOOT) 370 errx(1, "%s: `%c' partition overlaps boot program", 371 special, *cp); 372 getfssize(&fssize, special, pp->p_size, reserved); 373 if (sectorsize == 0) 374 sectorsize = lp->d_secsize; 375 if (fsize == 0) 376 fsize = pp->p_fsize; 377 if (bsize == 0) 378 bsize = pp->p_frag * pp->p_fsize; 379 if (is_file) 380 part_ofs = pp->p_offset; 381 } 382 if (sectorsize <= 0) 383 errx(1, "%s: no default sector size", special); 384 if (fsize <= 0) 385 fsize = MAX(DFL_FRAGSIZE, sectorsize); 386 if (bsize <= 0) 387 bsize = MIN(DFL_BLKSIZE, 8 * fsize); 388 if (minfree < MINFREE && opt != FS_OPTSPACE) { 389 fprintf(stderr, "Warning: changing optimization to space "); 390 fprintf(stderr, "because minfree is less than %d%%\n", MINFREE); 391 opt = FS_OPTSPACE; 392 } 393 realsectorsize = sectorsize; 394 if (sectorsize != DEV_BSIZE) { /* XXX */ 395 int secperblk = sectorsize / DEV_BSIZE; 396 397 sectorsize = DEV_BSIZE; 398 fssize *= secperblk; 399 if (pp != NULL) 400 pp->p_size *= secperblk; 401 } 402 mkfs(pp, special); 403 ufs_disk_close(&disk); 404 if (!jflag) 405 exit(0); 406 if (execlp("tunefs", "newfs", "-j", "enable", special, NULL) < 0) 407 err(1, "Cannot enable soft updates journaling, tunefs"); 408 /* NOT REACHED */ 409} 410 411void 412getfssize(intmax_t *fsz, const char *s, intmax_t disksize, intmax_t reserved) 413{ 414 intmax_t available; 415 416 available = disksize - reserved; 417 if (available <= 0) 418 errx(1, "%s: reserved not less than device size %jd", 419 s, disksize); 420 if (*fsz == 0) 421 *fsz = available; 422 else if (*fsz > available) 423 errx(1, "%s: maximum file system size is %jd", 424 s, available); 425} 426 427struct disklabel * 428getdisklabel(char *s) 429{ 430 static struct disklabel lab; 431 struct disklabel *lp; 432 433 if (is_file) { 434 if (read(disk.d_fd, bootarea, BBSIZE) != BBSIZE) 435 err(4, "cannot read bootarea"); 436 if (bsd_disklabel_le_dec( 437 bootarea + (0 /* labeloffset */ + 438 1 /* labelsoffset */ * sectorsize), 439 &lab, MAXPARTITIONS)) 440 errx(1, "no valid label found"); 441 442 lp = &lab; 443 return &lab; 444 } 445 446 if (disktype) { 447 lp = getdiskbyname(disktype); 448 if (lp != NULL) 449 return (lp); 450 } 451 return (NULL); 452} 453 454static void 455usage() 456{ 457 fprintf(stderr, 458 "usage: %s [ -fsoptions ] special-device%s\n", 459 getprogname(), 460 " [device-type]"); 461 fprintf(stderr, "where fsoptions are:\n"); 462 fprintf(stderr, "\t-E Erase previous disk content\n"); 463 fprintf(stderr, "\t-J Enable journaling via gjournal\n"); 464 fprintf(stderr, "\t-L volume label to add to superblock\n"); 465 fprintf(stderr, 466 "\t-N do not create file system, just print out parameters\n"); 467 fprintf(stderr, "\t-O file system format: 1 => UFS1, 2 => UFS2\n"); 468 fprintf(stderr, "\t-R regression test, suppress random factors\n"); 469 fprintf(stderr, "\t-S sector size\n"); 470 fprintf(stderr, "\t-T disktype\n"); 471 fprintf(stderr, "\t-U enable soft updates\n"); 472 fprintf(stderr, "\t-a maximum contiguous blocks\n"); 473 fprintf(stderr, "\t-b block size\n"); 474 fprintf(stderr, "\t-c blocks per cylinders group\n"); 475 fprintf(stderr, "\t-d maximum extent size\n"); 476 fprintf(stderr, "\t-e maximum blocks per file in a cylinder group\n"); 477 fprintf(stderr, "\t-f frag size\n"); 478 fprintf(stderr, "\t-g average file size\n"); 479 fprintf(stderr, "\t-h average files per directory\n"); 480 fprintf(stderr, "\t-i number of bytes per inode\n"); 481 fprintf(stderr, "\t-j enable soft updates journaling\n"); 482 fprintf(stderr, "\t-k space to hold for metadata blocks\n"); 483 fprintf(stderr, "\t-l enable multilabel MAC\n"); 484 fprintf(stderr, "\t-n do not create .snap directory\n"); 485 fprintf(stderr, "\t-m minimum free space %%\n"); 486 fprintf(stderr, "\t-o optimization preference (`space' or `time')\n"); 487 fprintf(stderr, "\t-p partition name (a..h)\n"); 488 fprintf(stderr, "\t-r reserved sectors at the end of device\n"); 489 fprintf(stderr, "\t-s file system size (sectors)\n"); 490 fprintf(stderr, "\t-t enable TRIM\n"); 491 exit(1); 492} 493 494static int 495expand_number_int(const char *buf, int *num) 496{ 497 int64_t num64; 498 int rval; 499 500 rval = expand_number(buf, &num64); 501 if (rval < 0) 502 return (rval); 503 if (num64 > INT_MAX || num64 < INT_MIN) { 504 errno = ERANGE; 505 return (-1); 506 } 507 *num = (int)num64; 508 return (0); 509} 510