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$");
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;
120static int	unlabeled;
121
122static void getfssize(intmax_t *, const char *p, intmax_t, intmax_t);
123static struct disklabel *getdisklabel(char *s);
124static void rewritelabel(char *s, struct disklabel *lp);
125static void usage(void);
126static int expand_number_int(const char *buf, int *num);
127
128ufs2_daddr_t part_ofs; /* partition offset in blocks, used with files */
129
130int
131main(int argc, char *argv[])
132{
133	struct partition *pp;
134	struct disklabel *lp;
135	struct partition oldpartition;
136	struct stat st;
137	char *cp, *special;
138	intmax_t reserved;
139	int ch, i, rval;
140	char part_name;		/* partition name, default to full disk */
141
142	part_name = 'c';
143	reserved = 0;
144	while ((ch = getopt(argc, argv,
145	    "EJL:NO:RS:T:UXa:b:c:d:e:f:g:h:i:jk:lm:no:p:r:s:t")) != -1)
146		switch (ch) {
147		case 'E':
148			Eflag = 1;
149			break;
150		case 'J':
151			Jflag = 1;
152			break;
153		case 'L':
154			volumelabel = optarg;
155			i = -1;
156			while (isalnum(volumelabel[++i]));
157			if (volumelabel[i] != '\0') {
158				errx(1, "bad volume label. Valid characters are alphanumerics.");
159			}
160			if (strlen(volumelabel) >= MAXVOLLEN) {
161				errx(1, "bad volume label. Length is longer than %d.",
162				    MAXVOLLEN);
163			}
164			Lflag = 1;
165			break;
166		case 'N':
167			Nflag = 1;
168			break;
169		case 'O':
170			if ((Oflag = atoi(optarg)) < 1 || Oflag > 2)
171				errx(1, "%s: bad file system format value",
172				    optarg);
173			break;
174		case 'R':
175			Rflag = 1;
176			break;
177		case 'S':
178			rval = expand_number_int(optarg, &sectorsize);
179			if (rval < 0 || sectorsize <= 0)
180				errx(1, "%s: bad sector size", optarg);
181			break;
182		case 'T':
183			disktype = optarg;
184			break;
185		case 'j':
186			jflag = 1;
187			/* fall through to enable soft updates */
188		case 'U':
189			Uflag = 1;
190			break;
191		case 'X':
192			Xflag++;
193			break;
194		case 'a':
195			rval = expand_number_int(optarg, &maxcontig);
196			if (rval < 0 || maxcontig <= 0)
197				errx(1, "%s: bad maximum contiguous blocks",
198				    optarg);
199			break;
200		case 'b':
201			rval = expand_number_int(optarg, &bsize);
202			if (rval < 0)
203				 errx(1, "%s: bad block size",
204                                    optarg);
205			if (bsize < MINBSIZE)
206				errx(1, "%s: block size too small, min is %d",
207				    optarg, MINBSIZE);
208			if (bsize > MAXBSIZE)
209				errx(1, "%s: block size too large, max is %d",
210				    optarg, MAXBSIZE);
211			break;
212		case 'c':
213			rval = expand_number_int(optarg, &maxblkspercg);
214			if (rval < 0 || maxblkspercg <= 0)
215				errx(1, "%s: bad blocks per cylinder group",
216				    optarg);
217			break;
218		case 'd':
219			rval = expand_number_int(optarg, &maxbsize);
220			if (rval < 0 || maxbsize < MINBSIZE)
221				errx(1, "%s: bad extent block size", optarg);
222			break;
223		case 'e':
224			rval = expand_number_int(optarg, &maxbpg);
225			if (rval < 0 || maxbpg <= 0)
226			  errx(1, "%s: bad blocks per file in a cylinder group",
227				    optarg);
228			break;
229		case 'f':
230			rval = expand_number_int(optarg, &fsize);
231			if (rval < 0 || fsize <= 0)
232				errx(1, "%s: bad fragment size", optarg);
233			break;
234		case 'g':
235			rval = expand_number_int(optarg, &avgfilesize);
236			if (rval < 0 || avgfilesize <= 0)
237				errx(1, "%s: bad average file size", optarg);
238			break;
239		case 'h':
240			rval = expand_number_int(optarg, &avgfilesperdir);
241			if (rval < 0 || avgfilesperdir <= 0)
242			       errx(1, "%s: bad average files per dir", optarg);
243			break;
244		case 'i':
245			rval = expand_number_int(optarg, &density);
246			if (rval < 0 || density <= 0)
247				errx(1, "%s: bad bytes per inode", optarg);
248			break;
249		case 'l':
250			lflag = 1;
251			break;
252		case 'k':
253			if ((metaspace = atoi(optarg)) < 0)
254				errx(1, "%s: bad metadata space %%", optarg);
255			if (metaspace == 0)
256				/* force to stay zero in mkfs */
257				metaspace = -1;
258			break;
259		case 'm':
260			if ((minfree = atoi(optarg)) < 0 || minfree > 99)
261				errx(1, "%s: bad free space %%", optarg);
262			break;
263		case 'n':
264			nflag = 1;
265			break;
266		case 'o':
267			if (strcmp(optarg, "space") == 0)
268				opt = FS_OPTSPACE;
269			else if (strcmp(optarg, "time") == 0)
270				opt = FS_OPTTIME;
271			else
272				errx(1,
273		"%s: unknown optimization preference: use `space' or `time'",
274				    optarg);
275			break;
276		case 'r':
277			errno = 0;
278			reserved = strtoimax(optarg, &cp, 0);
279			if (errno != 0 || cp == optarg ||
280			    *cp != '\0' || reserved < 0)
281				errx(1, "%s: bad reserved size", optarg);
282			break;
283		case 'p':
284			is_file = 1;
285			part_name = optarg[0];
286			break;
287
288		case 's':
289			errno = 0;
290			fssize = strtoimax(optarg, &cp, 0);
291			if (errno != 0 || cp == optarg ||
292			    *cp != '\0' || fssize < 0)
293				errx(1, "%s: bad file system size", optarg);
294			break;
295		case 't':
296			tflag = 1;
297			break;
298		case '?':
299		default:
300			usage();
301		}
302	argc -= optind;
303	argv += optind;
304
305	if (argc != 1)
306		usage();
307
308	special = argv[0];
309	if (!special[0])
310		err(1, "empty file/special name");
311	cp = strrchr(special, '/');
312	if (cp == 0) {
313		/*
314		 * No path prefix; try prefixing _PATH_DEV.
315		 */
316		snprintf(device, sizeof(device), "%s%s", _PATH_DEV, special);
317		special = device;
318	}
319
320	if (is_file) {
321		/* bypass ufs_disk_fillout_blank */
322		bzero( &disk, sizeof(disk));
323		disk.d_bsize = 1;
324		disk.d_name = special;
325		disk.d_fd = open(special, O_RDONLY);
326		if (disk.d_fd < 0 ||
327		    (!Nflag && ufs_disk_write(&disk) == -1))
328			errx(1, "%s: ", special);
329	} else if (ufs_disk_fillout_blank(&disk, special) == -1 ||
330	    (!Nflag && ufs_disk_write(&disk) == -1)) {
331		if (disk.d_error != NULL)
332			errx(1, "%s: %s", special, disk.d_error);
333		else
334			err(1, "%s", special);
335	}
336	if (fstat(disk.d_fd, &st) < 0)
337		err(1, "%s", special);
338	if ((st.st_mode & S_IFMT) != S_IFCHR) {
339		warn("%s: not a character-special device", special);
340		is_file = 1;	/* assume it is a file */
341		dkname = special;
342		if (sectorsize == 0)
343			sectorsize = 512;
344		mediasize = st.st_size;
345		/* set fssize from the partition */
346	} else {
347	    if (sectorsize == 0)
348		if (ioctl(disk.d_fd, DIOCGSECTORSIZE, &sectorsize) == -1)
349		    sectorsize = 0;	/* back out on error for safety */
350	    if (sectorsize && ioctl(disk.d_fd, DIOCGMEDIASIZE, &mediasize) != -1)
351		getfssize(&fssize, special, mediasize / sectorsize, reserved);
352	}
353	pp = NULL;
354	lp = getdisklabel(special);
355	if (lp != NULL) {
356		if (!is_file) /* already set for files */
357			part_name = special[strlen(special) - 1];
358		if ((part_name < 'a' || part_name - 'a' >= MAXPARTITIONS) &&
359				!isdigit(part_name))
360			errx(1, "%s: can't figure out file system partition",
361					special);
362		cp = &part_name;
363		if (isdigit(*cp))
364			pp = &lp->d_partitions[RAW_PART];
365		else
366			pp = &lp->d_partitions[*cp - 'a'];
367		oldpartition = *pp;
368		if (pp->p_size == 0)
369			errx(1, "%s: `%c' partition is unavailable",
370			    special, *cp);
371		if (pp->p_fstype == FS_BOOT)
372			errx(1, "%s: `%c' partition overlaps boot program",
373			    special, *cp);
374		getfssize(&fssize, special, pp->p_size, reserved);
375		if (sectorsize == 0)
376			sectorsize = lp->d_secsize;
377		if (fsize == 0)
378			fsize = pp->p_fsize;
379		if (bsize == 0)
380			bsize = pp->p_frag * pp->p_fsize;
381		if (is_file)
382			part_ofs = pp->p_offset;
383	}
384	if (sectorsize <= 0)
385		errx(1, "%s: no default sector size", special);
386	if (fsize <= 0)
387		fsize = MAX(DFL_FRAGSIZE, sectorsize);
388	if (bsize <= 0)
389		bsize = MIN(DFL_BLKSIZE, 8 * fsize);
390	if (minfree < MINFREE && opt != FS_OPTSPACE) {
391		fprintf(stderr, "Warning: changing optimization to space ");
392		fprintf(stderr, "because minfree is less than %d%%\n", MINFREE);
393		opt = FS_OPTSPACE;
394	}
395	realsectorsize = sectorsize;
396	if (sectorsize != DEV_BSIZE) {		/* XXX */
397		int secperblk = sectorsize / DEV_BSIZE;
398
399		sectorsize = DEV_BSIZE;
400		fssize *= secperblk;
401		if (pp != NULL)
402			pp->p_size *= secperblk;
403	}
404	mkfs(pp, special);
405	if (!unlabeled) {
406		if (realsectorsize != DEV_BSIZE)
407			pp->p_size /= realsectorsize / DEV_BSIZE;
408		if (!Nflag && bcmp(pp, &oldpartition, sizeof(oldpartition)))
409			rewritelabel(special, lp);
410	}
411	ufs_disk_close(&disk);
412	if (!jflag)
413		exit(0);
414	if (execlp("tunefs", "newfs", "-j", "enable", special, NULL) < 0)
415		err(1, "Cannot enable soft updates journaling, tunefs");
416	/* NOT REACHED */
417}
418
419void
420getfssize(intmax_t *fsz, const char *s, intmax_t disksize, intmax_t reserved)
421{
422	intmax_t available;
423
424	available = disksize - reserved;
425	if (available <= 0)
426		errx(1, "%s: reserved not less than device size %jd",
427		    s, disksize);
428	if (*fsz == 0)
429		*fsz = available;
430	else if (*fsz > available)
431		errx(1, "%s: maximum file system size is %jd",
432		    s, available);
433}
434
435struct disklabel *
436getdisklabel(char *s)
437{
438	static struct disklabel lab;
439	struct disklabel *lp;
440
441	if (is_file) {
442		if (read(disk.d_fd, bootarea, BBSIZE) != BBSIZE)
443			err(4, "cannot read bootarea");
444		if (bsd_disklabel_le_dec(
445		    bootarea + (0 /* labeloffset */ +
446				1 /* labelsoffset */ * sectorsize),
447		    &lab, MAXPARTITIONS))
448			errx(1, "no valid label found");
449
450		lp = &lab;
451		return &lab;
452	}
453
454	if (ioctl(disk.d_fd, DIOCGDINFO, (char *)&lab) != -1)
455		return (&lab);
456	unlabeled++;
457	if (disktype) {
458		lp = getdiskbyname(disktype);
459		if (lp != NULL)
460			return (lp);
461	}
462	return (NULL);
463}
464
465void
466rewritelabel(char *s, struct disklabel *lp)
467{
468	if (unlabeled)
469		return;
470	lp->d_checksum = 0;
471	lp->d_checksum = dkcksum(lp);
472	if (is_file) {
473		bsd_disklabel_le_enc(bootarea + 0 /* labeloffset */ +
474			1 /* labelsoffset */ * sectorsize, lp);
475		lseek(disk.d_fd, 0, SEEK_SET);
476		if (write(disk.d_fd, bootarea, BBSIZE) != BBSIZE)
477			errx(1, "cannot write label");
478		return;
479	}
480	if (ioctl(disk.d_fd, DIOCWDINFO, (char *)lp) == -1)
481		warn("ioctl (WDINFO): %s: can't rewrite disk label", s);
482}
483
484static void
485usage()
486{
487	fprintf(stderr,
488	    "usage: %s [ -fsoptions ] special-device%s\n",
489	    getprogname(),
490	    " [device-type]");
491	fprintf(stderr, "where fsoptions are:\n");
492	fprintf(stderr, "\t-E Erase previous disk content\n");
493	fprintf(stderr, "\t-J Enable journaling via gjournal\n");
494	fprintf(stderr, "\t-L volume label to add to superblock\n");
495	fprintf(stderr,
496	    "\t-N do not create file system, just print out parameters\n");
497	fprintf(stderr, "\t-O file system format: 1 => UFS1, 2 => UFS2\n");
498	fprintf(stderr, "\t-R regression test, suppress random factors\n");
499	fprintf(stderr, "\t-S sector size\n");
500	fprintf(stderr, "\t-T disktype\n");
501	fprintf(stderr, "\t-U enable soft updates\n");
502	fprintf(stderr, "\t-a maximum contiguous blocks\n");
503	fprintf(stderr, "\t-b block size\n");
504	fprintf(stderr, "\t-c blocks per cylinders group\n");
505	fprintf(stderr, "\t-d maximum extent size\n");
506	fprintf(stderr, "\t-e maximum blocks per file in a cylinder group\n");
507	fprintf(stderr, "\t-f frag size\n");
508	fprintf(stderr, "\t-g average file size\n");
509	fprintf(stderr, "\t-h average files per directory\n");
510	fprintf(stderr, "\t-i number of bytes per inode\n");
511	fprintf(stderr, "\t-j enable soft updates journaling\n");
512	fprintf(stderr, "\t-k space to hold for metadata blocks\n");
513	fprintf(stderr, "\t-l enable multilabel MAC\n");
514	fprintf(stderr, "\t-n do not create .snap directory\n");
515	fprintf(stderr, "\t-m minimum free space %%\n");
516	fprintf(stderr, "\t-o optimization preference (`space' or `time')\n");
517	fprintf(stderr, "\t-p partition name (a..h)\n");
518	fprintf(stderr, "\t-r reserved sectors at the end of device\n");
519	fprintf(stderr, "\t-s file system size (sectors)\n");
520	fprintf(stderr, "\t-t enable TRIM\n");
521	exit(1);
522}
523
524static int
525expand_number_int(const char *buf, int *num)
526{
527	int64_t num64;
528	int rval;
529
530	rval = expand_number(buf, &num64);
531	if (rval < 0)
532		return (rval);
533	if (num64 > INT_MAX || num64 < INT_MIN) {
534		errno = ERANGE;
535		return (-1);
536	}
537	*num = (int)num64;
538	return (0);
539}
540