xref: /freebsd/sbin/newfs/newfs.c (revision 9a14aa017b21c292740c00ee098195cd46642730)
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
41 static 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
47 static char sccsid[] = "@(#)newfs.c	8.13 (Berkeley) 5/1/95";
48 #endif /* not lint */
49 #endif
50 #include <sys/cdefs.h>
51 __FBSDID("$FreeBSD$");
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 
84 int	Eflag;			/* Erase previous disk contents */
85 int	Lflag;			/* add a volume label */
86 int	Nflag;			/* run without writing file system */
87 int	Oflag = 2;		/* file system format (1 => UFS1, 2 => UFS2) */
88 int	Rflag;			/* regression test */
89 int	Uflag;			/* enable soft updates for file system */
90 int	jflag;			/* enable soft updates journaling for filesys */
91 int	Xflag = 0;		/* exit in middle of newfs for testing */
92 int	Jflag;			/* enable gjournal for file system */
93 int	lflag;			/* enable multilabel for file system */
94 int	nflag;			/* do not create .snap directory */
95 int	tflag;			/* enable TRIM */
96 intmax_t fssize;		/* file system size */
97 int	sectorsize;		/* bytes/sector */
98 int	realsectorsize;		/* bytes/sector in hardware */
99 int	fsize = 0;		/* fragment size */
100 int	bsize = 0;		/* block size */
101 int	maxbsize = 0;		/* maximum clustering */
102 int	maxblkspercg = MAXBLKSPERCG; /* maximum blocks per cylinder group */
103 int	minfree = MINFREE;	/* free space threshold */
104 int	opt = DEFAULTOPT;	/* optimization preference (space or time) */
105 int	density;		/* number of bytes per inode */
106 int	maxcontig = 0;		/* max contiguous blocks to allocate */
107 int	maxbpg;			/* maximum blocks per file in a cyl group */
108 int	avgfilesize = AVFILESIZ;/* expected average file size */
109 int	avgfilesperdir = AFPDIR;/* expected number of files per directory */
110 u_char	*volumelabel = NULL;	/* volume label for filesystem */
111 struct uufsd disk;		/* libufs disk structure */
112 
113 static char	device[MAXPATHLEN];
114 static u_char   bootarea[BBSIZE];
115 static int	is_file;		/* work on a file, not a device */
116 static char	*dkname;
117 static char	*disktype;
118 static int	unlabeled;
119 
120 static void getfssize(intmax_t *, const char *p, intmax_t, intmax_t);
121 static struct disklabel *getdisklabel(char *s);
122 static void rewritelabel(char *s, struct disklabel *lp);
123 static void usage(void);
124 static int expand_number_int(const char *buf, int *num);
125 
126 ufs2_daddr_t part_ofs; /* partition offset in blocks, used with files */
127 
128 int
129 main(int argc, char *argv[])
130 {
131 	struct partition *pp;
132 	struct disklabel *lp;
133 	struct partition oldpartition;
134 	struct stat st;
135 	char *cp, *special;
136 	intmax_t reserved;
137 	int ch, i, rval;
138 	off_t mediasize;
139 	char part_name;		/* partition name, default to full disk */
140 
141 	part_name = 'c';
142 	reserved = 0;
143 	while ((ch = getopt(argc, argv,
144 	    "EJL:NO:RS:T:UXa:b:c:d:e:f:g:h:i:jlm:no:p:r:s:t")) != -1)
145 		switch (ch) {
146 		case 'E':
147 			Eflag = 1;
148 			break;
149 		case 'J':
150 			Jflag = 1;
151 			break;
152 		case 'L':
153 			volumelabel = optarg;
154 			i = -1;
155 			while (isalnum(volumelabel[++i]));
156 			if (volumelabel[i] != '\0') {
157 				errx(1, "bad volume label. Valid characters are alphanumerics.");
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, &sectorsize);
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 'm':
252 			if ((minfree = atoi(optarg)) < 0 || minfree > 99)
253 				errx(1, "%s: bad free space %%", optarg);
254 			break;
255 		case 'n':
256 			nflag = 1;
257 			break;
258 		case 'o':
259 			if (strcmp(optarg, "space") == 0)
260 				opt = FS_OPTSPACE;
261 			else if (strcmp(optarg, "time") == 0)
262 				opt = FS_OPTTIME;
263 			else
264 				errx(1,
265 		"%s: unknown optimization preference: use `space' or `time'",
266 				    optarg);
267 			break;
268 		case 'r':
269 			errno = 0;
270 			reserved = strtoimax(optarg, &cp, 0);
271 			if (errno != 0 || cp == optarg ||
272 			    *cp != '\0' || reserved < 0)
273 				errx(1, "%s: bad reserved size", optarg);
274 			break;
275 		case 'p':
276 			is_file = 1;
277 			part_name = optarg[0];
278 			break;
279 
280 		case 's':
281 			errno = 0;
282 			fssize = strtoimax(optarg, &cp, 0);
283 			if (errno != 0 || cp == optarg ||
284 			    *cp != '\0' || fssize < 0)
285 				errx(1, "%s: bad file system size", optarg);
286 			break;
287 		case 't':
288 			tflag = 1;
289 			break;
290 		case '?':
291 		default:
292 			usage();
293 		}
294 	argc -= optind;
295 	argv += optind;
296 
297 	if (argc != 1)
298 		usage();
299 
300 	special = argv[0];
301 	if (!special[0])
302 		err(1, "empty file/special name");
303 	cp = strrchr(special, '/');
304 	if (cp == 0) {
305 		/*
306 		 * No path prefix; try prefixing _PATH_DEV.
307 		 */
308 		snprintf(device, sizeof(device), "%s%s", _PATH_DEV, special);
309 		special = device;
310 	}
311 
312 	if (is_file) {
313 		/* bypass ufs_disk_fillout_blank */
314 		bzero( &disk, sizeof(disk));
315 		disk.d_bsize = 1;
316 		disk.d_name = special;
317 		disk.d_fd = open(special, O_RDONLY);
318 		if (disk.d_fd < 0 ||
319 		    (!Nflag && ufs_disk_write(&disk) == -1))
320 			errx(1, "%s: ", special);
321 	} else if (ufs_disk_fillout_blank(&disk, special) == -1 ||
322 	    (!Nflag && ufs_disk_write(&disk) == -1)) {
323 		if (disk.d_error != NULL)
324 			errx(1, "%s: %s", special, disk.d_error);
325 		else
326 			err(1, "%s", special);
327 	}
328 	if (fstat(disk.d_fd, &st) < 0)
329 		err(1, "%s", special);
330 	if ((st.st_mode & S_IFMT) != S_IFCHR) {
331 		warn("%s: not a character-special device", special);
332 		is_file = 1;	/* assume it is a file */
333 		dkname = special;
334 		if (sectorsize == 0)
335 			sectorsize = 512;
336 		mediasize = st.st_size;
337 		/* set fssize from the partition */
338 	} else {
339 	    if (sectorsize == 0)
340 		if (ioctl(disk.d_fd, DIOCGSECTORSIZE, &sectorsize) == -1)
341 		    sectorsize = 0;	/* back out on error for safety */
342 	    if (sectorsize && ioctl(disk.d_fd, DIOCGMEDIASIZE, &mediasize) != -1)
343 		getfssize(&fssize, special, mediasize / sectorsize, reserved);
344 	}
345 	pp = NULL;
346 	lp = getdisklabel(special);
347 	if (lp != NULL) {
348 		if (!is_file) /* already set for files */
349 			part_name = special[strlen(special) - 1];
350 		if ((part_name < 'a' || part_name - 'a' >= MAXPARTITIONS) &&
351 				!isdigit(part_name))
352 			errx(1, "%s: can't figure out file system partition",
353 					special);
354 		cp = &part_name;
355 		if (isdigit(*cp))
356 			pp = &lp->d_partitions[RAW_PART];
357 		else
358 			pp = &lp->d_partitions[*cp - 'a'];
359 		oldpartition = *pp;
360 		if (pp->p_size == 0)
361 			errx(1, "%s: `%c' partition is unavailable",
362 			    special, *cp);
363 		if (pp->p_fstype == FS_BOOT)
364 			errx(1, "%s: `%c' partition overlaps boot program",
365 			    special, *cp);
366 		getfssize(&fssize, special, pp->p_size, reserved);
367 		if (sectorsize == 0)
368 			sectorsize = lp->d_secsize;
369 		if (fsize == 0)
370 			fsize = pp->p_fsize;
371 		if (bsize == 0)
372 			bsize = pp->p_frag * pp->p_fsize;
373 		if (is_file)
374 			part_ofs = pp->p_offset;
375 	}
376 	if (sectorsize <= 0)
377 		errx(1, "%s: no default sector size", special);
378 	if (fsize <= 0)
379 		fsize = MAX(DFL_FRAGSIZE, sectorsize);
380 	if (bsize <= 0)
381 		bsize = MIN(DFL_BLKSIZE, 8 * fsize);
382 	if (minfree < MINFREE && opt != FS_OPTSPACE) {
383 		fprintf(stderr, "Warning: changing optimization to space ");
384 		fprintf(stderr, "because minfree is less than %d%%\n", MINFREE);
385 		opt = FS_OPTSPACE;
386 	}
387 	realsectorsize = sectorsize;
388 	if (sectorsize != DEV_BSIZE) {		/* XXX */
389 		int secperblk = sectorsize / DEV_BSIZE;
390 
391 		sectorsize = DEV_BSIZE;
392 		fssize *= secperblk;
393 		if (pp != NULL)
394 			pp->p_size *= secperblk;
395 	}
396 	mkfs(pp, special);
397 	if (!unlabeled) {
398 		if (realsectorsize != DEV_BSIZE)
399 			pp->p_size /= realsectorsize / DEV_BSIZE;
400 		if (!Nflag && bcmp(pp, &oldpartition, sizeof(oldpartition)))
401 			rewritelabel(special, lp);
402 	}
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 
411 void
412 getfssize(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 
427 struct disklabel *
428 getdisklabel(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 (ioctl(disk.d_fd, DIOCGDINFO, (char *)&lab) != -1)
447 		return (&lab);
448 	unlabeled++;
449 	if (disktype) {
450 		lp = getdiskbyname(disktype);
451 		if (lp != NULL)
452 			return (lp);
453 	}
454 	return (NULL);
455 }
456 
457 void
458 rewritelabel(char *s, struct disklabel *lp)
459 {
460 	if (unlabeled)
461 		return;
462 	lp->d_checksum = 0;
463 	lp->d_checksum = dkcksum(lp);
464 	if (is_file) {
465 		bsd_disklabel_le_enc(bootarea + 0 /* labeloffset */ +
466 			1 /* labelsoffset */ * sectorsize, lp);
467 		lseek(disk.d_fd, 0, SEEK_SET);
468 		if (write(disk.d_fd, bootarea, BBSIZE) != BBSIZE)
469 			errx(1, "cannot write label");
470 		return;
471 	}
472 	if (ioctl(disk.d_fd, DIOCWDINFO, (char *)lp) == -1)
473 		warn("ioctl (WDINFO): %s: can't rewrite disk label", s);
474 }
475 
476 static void
477 usage()
478 {
479 	fprintf(stderr,
480 	    "usage: %s [ -fsoptions ] special-device%s\n",
481 	    getprogname(),
482 	    " [device-type]");
483 	fprintf(stderr, "where fsoptions are:\n");
484 	fprintf(stderr, "\t-E Erase previous disk content\n");
485 	fprintf(stderr, "\t-J Enable journaling via gjournal\n");
486 	fprintf(stderr, "\t-L volume label to add to superblock\n");
487 	fprintf(stderr,
488 	    "\t-N do not create file system, just print out parameters\n");
489 	fprintf(stderr, "\t-O file system format: 1 => UFS1, 2 => UFS2\n");
490 	fprintf(stderr, "\t-R regression test, suppress random factors\n");
491 	fprintf(stderr, "\t-S sector size\n");
492 	fprintf(stderr, "\t-T disktype\n");
493 	fprintf(stderr, "\t-U enable soft updates\n");
494 	fprintf(stderr, "\t-a maximum contiguous blocks\n");
495 	fprintf(stderr, "\t-b block size\n");
496 	fprintf(stderr, "\t-c blocks per cylinders group\n");
497 	fprintf(stderr, "\t-d maximum extent size\n");
498 	fprintf(stderr, "\t-e maximum blocks per file in a cylinder group\n");
499 	fprintf(stderr, "\t-f frag size\n");
500 	fprintf(stderr, "\t-g average file size\n");
501 	fprintf(stderr, "\t-h average files per directory\n");
502 	fprintf(stderr, "\t-i number of bytes per inode\n");
503 	fprintf(stderr, "\t-j enable soft updates journaling\n");
504 	fprintf(stderr, "\t-l enable multilabel MAC\n");
505 	fprintf(stderr, "\t-n do not create .snap directory\n");
506 	fprintf(stderr, "\t-m minimum free space %%\n");
507 	fprintf(stderr, "\t-o optimization preference (`space' or `time')\n");
508 	fprintf(stderr, "\t-p partition name (a..h)\n");
509 	fprintf(stderr, "\t-r reserved sectors at the end of device\n");
510 	fprintf(stderr, "\t-s file system size (sectors)\n");
511 	fprintf(stderr, "\t-t enable TRIM\n");
512 	exit(1);
513 }
514 
515 static int
516 expand_number_int(const char *buf, int *num)
517 {
518 	int64_t num64;
519 	int rval;
520 
521 	rval = expand_number(buf, &num64);
522 	if (rval < 0)
523 		return (rval);
524 	if (num64 > INT_MAX || num64 < INT_MIN) {
525 		errno = ERANGE;
526 		return (-1);
527 	}
528 	*num = (int)num64;
529 	return (0);
530 }
531