1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2002 Networks Associates Technology, Inc.
5 * All rights reserved.
6 *
7 * This software was developed for the FreeBSD Project by Marshall
8 * Kirk McKusick and Network Associates Laboratories, the Security
9 * Research Division of Network Associates, Inc. under DARPA/SPAWAR
10 * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
11 * research program.
12 *
13 * Copyright (c) 1983, 1989, 1993, 1994
14 * The Regents of the University of California. All rights reserved.
15 *
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 * 3. Neither the name of the University nor the names of its contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * SUCH DAMAGE.
39 */
40
41 #if 0
42 #ifndef lint
43 static const char copyright[] =
44 "@(#) Copyright (c) 1983, 1989, 1993, 1994\n\
45 The Regents of the University of California. All rights reserved.\n";
46 #endif /* not lint */
47
48 #ifndef lint
49 static char sccsid[] = "@(#)newfs.c 8.13 (Berkeley) 5/1/95";
50 #endif /* not lint */
51 #endif
52 #include <sys/cdefs.h>
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 off_t mediasize; /* device size */
98 int sectorsize; /* bytes/sector */
99 int realsectorsize; /* bytes/sector in hardware */
100 int fsize = 0; /* fragment size */
101 int bsize = 0; /* block size */
102 int maxbsize = 0; /* maximum clustering */
103 int maxblkspercg = MAXBLKSPERCG; /* maximum blocks per cylinder group */
104 int minfree = MINFREE; /* free space threshold */
105 int metaspace; /* space held for metadata blocks */
106 int opt = DEFAULTOPT; /* optimization preference (space or time) */
107 int density; /* number of bytes per inode */
108 int maxcontig = 0; /* max contiguous blocks to allocate */
109 int maxbpg; /* maximum blocks per file in a cyl group */
110 int avgfilesize = AVFILESIZ;/* expected average file size */
111 int avgfilesperdir = AFPDIR;/* expected number of files per directory */
112 u_char *volumelabel = NULL; /* volume label for filesystem */
113 struct uufsd disk; /* libufs disk structure */
114
115 static char device[MAXPATHLEN];
116 static u_char bootarea[BBSIZE];
117 static int is_file; /* work on a file, not a device */
118 static char *dkname;
119 static char *disktype;
120
121 static void getfssize(intmax_t *, const char *p, intmax_t, intmax_t);
122 static struct disklabel *getdisklabel(void);
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
main(int argc,char * argv[])129 main(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] == '_' || volumelabel[i] == '-');
155 if (volumelabel[i] != '\0') {
156 errx(1, "bad volume label. Valid characters "
157 "are alphanumerics, dashes, 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 /* FALLTHROUGH */
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 == NULL) {
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, §orsize) == -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();
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 if (pp->p_size == 0)
368 errx(1, "%s: `%c' partition is unavailable",
369 special, *cp);
370 if (pp->p_fstype == FS_BOOT)
371 errx(1, "%s: `%c' partition overlaps boot program",
372 special, *cp);
373 getfssize(&fssize, special, pp->p_size, reserved);
374 if (sectorsize == 0)
375 sectorsize = lp->d_secsize;
376 if (fsize == 0)
377 fsize = pp->p_fsize;
378 if (bsize == 0)
379 bsize = pp->p_frag * pp->p_fsize;
380 if (is_file)
381 part_ofs = pp->p_offset;
382 }
383 if (sectorsize <= 0)
384 errx(1, "%s: no default sector size", special);
385 if (fsize <= 0)
386 fsize = MAX(DFL_FRAGSIZE, sectorsize);
387 if (bsize <= 0)
388 bsize = MIN(DFL_BLKSIZE, 8 * fsize);
389 if (minfree < MINFREE && opt != FS_OPTSPACE) {
390 fprintf(stderr, "Warning: changing optimization to space ");
391 fprintf(stderr, "because minfree is less than %d%%\n", MINFREE);
392 opt = FS_OPTSPACE;
393 }
394 /* Use soft updates by default for UFS2 and above */
395 if (Oflag > 1)
396 Uflag = 1;
397 realsectorsize = sectorsize;
398 if (sectorsize != DEV_BSIZE) { /* XXX */
399 int secperblk = sectorsize / DEV_BSIZE;
400
401 sectorsize = DEV_BSIZE;
402 fssize *= secperblk;
403 if (pp != NULL)
404 pp->p_size *= secperblk;
405 }
406 mkfs(pp, special);
407 ufs_disk_close(&disk);
408 if (!jflag)
409 exit(0);
410 if (execlp("tunefs", "newfs", "-j", "enable", special, NULL) < 0)
411 err(1, "Cannot enable soft updates journaling, tunefs");
412 /* NOT REACHED */
413 }
414
415 void
getfssize(intmax_t * fsz,const char * s,intmax_t disksize,intmax_t reserved)416 getfssize(intmax_t *fsz, const char *s, intmax_t disksize, intmax_t reserved)
417 {
418 intmax_t available;
419
420 available = disksize - reserved;
421 if (available <= 0)
422 errx(1, "%s: reserved not less than device size %jd",
423 s, disksize);
424 if (*fsz == 0)
425 *fsz = available;
426 else if (*fsz > available)
427 errx(1, "%s: maximum file system size is %jd",
428 s, available);
429 }
430
431 struct disklabel *
getdisklabel(void)432 getdisklabel(void)
433 {
434 static struct disklabel lab;
435 struct disklabel *lp;
436
437 if (is_file) {
438 if (read(disk.d_fd, bootarea, BBSIZE) != BBSIZE)
439 err(4, "cannot read bootarea");
440 if (bsd_disklabel_le_dec(
441 bootarea + (0 /* labeloffset */ +
442 1 /* labelsoffset */ * sectorsize),
443 &lab, MAXPARTITIONS))
444 errx(1, "no valid label found");
445
446 lp = &lab;
447 return &lab;
448 }
449
450 if (disktype) {
451 lp = getdiskbyname(disktype);
452 if (lp != NULL)
453 return (lp);
454 }
455 return (NULL);
456 }
457
458 static void
usage(void)459 usage(void)
460 {
461 fprintf(stderr,
462 "usage: %s [ -fsoptions ] special-device%s\n",
463 getprogname(),
464 " [device-type]");
465 fprintf(stderr, "where fsoptions are:\n");
466 fprintf(stderr, "\t-E Erase previous disk content\n");
467 fprintf(stderr, "\t-J Enable journaling via gjournal\n");
468 fprintf(stderr, "\t-L volume label to add to superblock\n");
469 fprintf(stderr,
470 "\t-N do not create file system, just print out parameters\n");
471 fprintf(stderr, "\t-O file system format: 1 => UFS1, 2 => UFS2\n");
472 fprintf(stderr, "\t-R regression test, suppress random factors\n");
473 fprintf(stderr, "\t-S sector size\n");
474 fprintf(stderr, "\t-T disktype\n");
475 fprintf(stderr, "\t-U enable soft updates\n");
476 fprintf(stderr, "\t-a maximum contiguous blocks\n");
477 fprintf(stderr, "\t-b block size\n");
478 fprintf(stderr, "\t-c blocks per cylinders group\n");
479 fprintf(stderr, "\t-d maximum extent size\n");
480 fprintf(stderr, "\t-e maximum blocks per file in a cylinder group\n");
481 fprintf(stderr, "\t-f frag size\n");
482 fprintf(stderr, "\t-g average file size\n");
483 fprintf(stderr, "\t-h average files per directory\n");
484 fprintf(stderr, "\t-i number of bytes per inode\n");
485 fprintf(stderr, "\t-j enable soft updates journaling\n");
486 fprintf(stderr, "\t-k space to hold for metadata blocks\n");
487 fprintf(stderr, "\t-l enable multilabel MAC\n");
488 fprintf(stderr, "\t-n do not create .snap directory\n");
489 fprintf(stderr, "\t-m minimum free space %%\n");
490 fprintf(stderr, "\t-o optimization preference (`space' or `time')\n");
491 fprintf(stderr, "\t-p partition name (a..h)\n");
492 fprintf(stderr, "\t-r reserved sectors at the end of device\n");
493 fprintf(stderr, "\t-s file system size (sectors)\n");
494 fprintf(stderr, "\t-t enable TRIM\n");
495 exit(1);
496 }
497
498 static int
expand_number_int(const char * buf,int * num)499 expand_number_int(const char *buf, int *num)
500 {
501 int64_t num64;
502 int rval;
503
504 rval = expand_number(buf, &num64);
505 if (rval < 0)
506 return (rval);
507 if (num64 > INT_MAX || num64 < INT_MIN) {
508 errno = ERANGE;
509 return (-1);
510 }
511 *num = (int)num64;
512 return (0);
513 }
514