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 /*
42 * newfs: friendly front end to mkfs
43 */
44 #include <sys/param.h>
45 #include <sys/stat.h>
46 #include <sys/disk.h>
47 #include <sys/disklabel.h>
48 #include <sys/file.h>
49 #include <sys/mount.h>
50
51 #include <ufs/ufs/dir.h>
52 #include <ufs/ufs/dinode.h>
53 #include <ufs/ffs/fs.h>
54 #include <ufs/ufs/extattr.h>
55 #include <ufs/ufs/quota.h>
56 #include <ufs/ufs/ufsmount.h>
57
58 #include <ctype.h>
59 #include <err.h>
60 #include <errno.h>
61 #include <inttypes.h>
62 #include <paths.h>
63 #include <stdarg.h>
64 #include <stdio.h>
65 #include <stdlib.h>
66 #include <string.h>
67 #include <syslog.h>
68 #include <unistd.h>
69
70 #include <libutil.h>
71
72 #include "newfs.h"
73
74 int Eflag; /* Erase previous disk contents */
75 int Lflag; /* add a volume label */
76 int Nflag; /* run without writing file system */
77 int Oflag = 2; /* file system format (1 => UFS1, 2 => UFS2) */
78 int Rflag; /* regression test */
79 int Uflag; /* enable soft updates for file system */
80 int jflag; /* enable soft updates journaling for filesys */
81 int Xflag = 0; /* exit in middle of newfs for testing */
82 int Jflag; /* enable gjournal for file system */
83 int lflag; /* enable multilabel for file system */
84 int nflag; /* do not create .snap directory */
85 int tflag; /* enable TRIM */
86 intmax_t fssize; /* file system size */
87 off_t mediasize; /* device size */
88 int sectorsize; /* bytes/sector */
89 int realsectorsize; /* bytes/sector in hardware */
90 int fsize = 0; /* fragment size */
91 int bsize = 0; /* block size */
92 int maxbsize = 0; /* maximum clustering */
93 int maxblkspercg = MAXBLKSPERCG; /* maximum blocks per cylinder group */
94 int minfree = MINFREE; /* free space threshold */
95 int metaspace; /* space held for metadata blocks */
96 int opt = DEFAULTOPT; /* optimization preference (space or time) */
97 int density; /* number of bytes per inode */
98 int maxcontig = 0; /* max contiguous blocks to allocate */
99 int maxbpg; /* maximum blocks per file in a cyl group */
100 int avgfilesize = AVFILESIZ;/* expected average file size */
101 int avgfilesperdir = AFPDIR;/* expected number of files per directory */
102 u_char *volumelabel = NULL; /* volume label for filesystem */
103 struct uufsd disk; /* libufs disk structure */
104
105 static char device[MAXPATHLEN];
106 static u_char bootarea[BBSIZE];
107 static int is_file; /* work on a file, not a device */
108 static char *disktype;
109
110 static void getfssize(intmax_t *, const char *p, intmax_t, intmax_t);
111 static struct disklabel *getdisklabel(void);
112 static void usage(void) __dead2;
113 static int expand_number_int(const char *buf, int *num);
114
115 ufs2_daddr_t part_ofs; /* partition offset in blocks, used with files */
116
117 int
main(int argc,char * argv[])118 main(int argc, char *argv[])
119 {
120 struct partition *pp;
121 struct disklabel *lp;
122 struct stat st;
123 char *cp, *special;
124 intmax_t reserved;
125 int ch, rval;
126 size_t i;
127 char part_name; /* partition name, default to full disk */
128
129 part_name = 'c';
130 reserved = 0;
131 while ((ch = getopt(argc, argv,
132 "EJL:NO:RS:T:UXa:b:c:d:e:f:g:h:i:jk:lm:no:p:r:s:t")) != -1)
133 switch (ch) {
134 case 'E':
135 Eflag = 1;
136 break;
137 case 'J':
138 Jflag = 1;
139 break;
140 case 'L':
141 volumelabel = optarg;
142 for (i = 0; isalnum(volumelabel[i]) ||
143 volumelabel[i] == '_' || volumelabel[i] == '-';
144 i++)
145 continue;
146 if (volumelabel[i] != '\0') {
147 errx(1, "bad volume label. Valid characters "
148 "are alphanumerics, dashes, and underscores.");
149 }
150 if (strlen(volumelabel) >= MAXVOLLEN) {
151 errx(1, "bad volume label. Length is longer than %d.",
152 MAXVOLLEN);
153 }
154 Lflag = 1;
155 break;
156 case 'N':
157 Nflag = 1;
158 break;
159 case 'O':
160 if ((Oflag = atoi(optarg)) < 1 || Oflag > 2)
161 errx(1, "%s: bad file system format value",
162 optarg);
163 break;
164 case 'R':
165 Rflag = 1;
166 break;
167 case 'S':
168 rval = expand_number_int(optarg, §orsize);
169 if (rval < 0 || sectorsize <= 0)
170 errx(1, "%s: bad sector size", optarg);
171 break;
172 case 'T':
173 disktype = optarg;
174 break;
175 case 'j':
176 jflag = 1;
177 /* fall through to enable soft updates */
178 /* FALLTHROUGH */
179 case 'U':
180 Uflag = 1;
181 break;
182 case 'X':
183 Xflag++;
184 break;
185 case 'a':
186 rval = expand_number_int(optarg, &maxcontig);
187 if (rval < 0 || maxcontig <= 0)
188 errx(1, "%s: bad maximum contiguous blocks",
189 optarg);
190 break;
191 case 'b':
192 rval = expand_number_int(optarg, &bsize);
193 if (rval < 0)
194 errx(1, "%s: bad block size",
195 optarg);
196 if (bsize < MINBSIZE)
197 errx(1, "%s: block size too small, min is %d",
198 optarg, MINBSIZE);
199 if (bsize > MAXBSIZE)
200 errx(1, "%s: block size too large, max is %d",
201 optarg, MAXBSIZE);
202 break;
203 case 'c':
204 rval = expand_number_int(optarg, &maxblkspercg);
205 if (rval < 0 || maxblkspercg <= 0)
206 errx(1, "%s: bad blocks per cylinder group",
207 optarg);
208 break;
209 case 'd':
210 rval = expand_number_int(optarg, &maxbsize);
211 if (rval < 0 || maxbsize < MINBSIZE)
212 errx(1, "%s: bad extent block size", optarg);
213 break;
214 case 'e':
215 rval = expand_number_int(optarg, &maxbpg);
216 if (rval < 0 || maxbpg <= 0)
217 errx(1, "%s: bad blocks per file in a cylinder group",
218 optarg);
219 break;
220 case 'f':
221 rval = expand_number_int(optarg, &fsize);
222 if (rval < 0 || fsize <= 0)
223 errx(1, "%s: bad fragment size", optarg);
224 break;
225 case 'g':
226 rval = expand_number_int(optarg, &avgfilesize);
227 if (rval < 0 || avgfilesize <= 0)
228 errx(1, "%s: bad average file size", optarg);
229 break;
230 case 'h':
231 rval = expand_number_int(optarg, &avgfilesperdir);
232 if (rval < 0 || avgfilesperdir <= 0)
233 errx(1, "%s: bad average files per dir", optarg);
234 break;
235 case 'i':
236 rval = expand_number_int(optarg, &density);
237 if (rval < 0 || density <= 0)
238 errx(1, "%s: bad bytes per inode", optarg);
239 break;
240 case 'l':
241 lflag = 1;
242 break;
243 case 'k':
244 if ((metaspace = atoi(optarg)) < 0)
245 errx(1, "%s: bad metadata space %%", optarg);
246 if (metaspace == 0)
247 /* force to stay zero in mkfs */
248 metaspace = -1;
249 break;
250 case 'm':
251 if ((minfree = atoi(optarg)) < 0 || minfree > 99)
252 errx(1, "%s: bad free space %%", optarg);
253 break;
254 case 'n':
255 nflag = 1;
256 break;
257 case 'o':
258 if (strcmp(optarg, "space") == 0)
259 opt = FS_OPTSPACE;
260 else if (strcmp(optarg, "time") == 0)
261 opt = FS_OPTTIME;
262 else
263 errx(1,
264 "%s: unknown optimization preference: use `space' or `time'",
265 optarg);
266 break;
267 case 'r':
268 errno = 0;
269 reserved = strtoimax(optarg, &cp, 0);
270 if (errno != 0 || cp == optarg ||
271 *cp != '\0' || reserved < 0)
272 errx(1, "%s: bad reserved size", optarg);
273 break;
274 case 'p':
275 is_file = 1;
276 part_name = optarg[0];
277 break;
278
279 case 's':
280 errno = 0;
281 fssize = strtoimax(optarg, &cp, 0);
282 if (errno != 0 || cp == optarg ||
283 *cp != '\0' || fssize < 0)
284 errx(1, "%s: bad file system size", optarg);
285 break;
286 case 't':
287 tflag = 1;
288 break;
289 case '?':
290 default:
291 usage();
292 }
293 argc -= optind;
294 argv += optind;
295
296 if (argc != 1)
297 usage();
298
299 special = argv[0];
300 if (!special[0])
301 err(1, "empty file/special name");
302 cp = strrchr(special, '/');
303 if (cp == NULL) {
304 /*
305 * No path prefix; try prefixing _PATH_DEV.
306 */
307 snprintf(device, sizeof(device), "%s%s", _PATH_DEV, special);
308 special = device;
309 }
310
311 if (is_file) {
312 /* bypass ufs_disk_fillout_blank */
313 bzero( &disk, sizeof(disk));
314 disk.d_bsize = 1;
315 disk.d_name = special;
316 disk.d_fd = open(special, O_RDONLY);
317 if (disk.d_fd < 0 ||
318 (!Nflag && ufs_disk_write(&disk) == -1))
319 errx(1, "%s: ", special);
320 } else if (ufs_disk_fillout_blank(&disk, special) == -1 ||
321 (!Nflag && ufs_disk_write(&disk) == -1)) {
322 if (disk.d_error != NULL)
323 errx(1, "%s: %s", special, disk.d_error);
324 else
325 err(1, "%s", special);
326 }
327 if (fstat(disk.d_fd, &st) < 0)
328 err(1, "%s", special);
329 if ((st.st_mode & S_IFMT) != S_IFCHR) {
330 is_file = 1; /* assume it is a file */
331 if (sectorsize == 0)
332 sectorsize = 512;
333 mediasize = st.st_size;
334 /* set fssize from the partition */
335 } else {
336 if (sectorsize == 0)
337 if (ioctl(disk.d_fd, DIOCGSECTORSIZE, §orsize) == -1)
338 sectorsize = 0; /* back out on error for safety */
339 if (sectorsize && ioctl(disk.d_fd, DIOCGMEDIASIZE, &mediasize) != -1)
340 getfssize(&fssize, special, mediasize / sectorsize, reserved);
341 }
342 pp = NULL;
343 lp = getdisklabel();
344 /*
345 * set filesystem size from file size when a bsdlabel isn't present
346 */
347 if (lp == NULL && is_file)
348 fssize = mediasize / sectorsize;
349 if (lp != NULL) {
350 if (!is_file) /* already set for files */
351 part_name = special[strlen(special) - 1];
352 if ((part_name < 'a' || part_name - 'a' >= MAXPARTITIONS) &&
353 !isdigit(part_name))
354 errx(1, "%s: can't figure out file system partition",
355 special);
356 cp = &part_name;
357 if (isdigit(*cp))
358 pp = &lp->d_partitions[RAW_PART];
359 else
360 pp = &lp->d_partitions[*cp - 'a'];
361 if (pp->p_size == 0)
362 errx(1, "%s: `%c' partition is unavailable",
363 special, *cp);
364 if (pp->p_fstype == FS_BOOT)
365 errx(1, "%s: `%c' partition overlaps boot program",
366 special, *cp);
367 getfssize(&fssize, special, pp->p_size, reserved);
368 if (sectorsize == 0)
369 sectorsize = lp->d_secsize;
370 if (fsize == 0)
371 fsize = pp->p_fsize;
372 if (bsize == 0)
373 bsize = pp->p_frag * pp->p_fsize;
374 if (is_file)
375 part_ofs = pp->p_offset;
376 }
377 if (sectorsize <= 0)
378 errx(1, "%s: no default sector size", special);
379 if (fsize <= 0)
380 fsize = MAX(DFL_FRAGSIZE, sectorsize);
381 if (bsize <= 0)
382 bsize = MIN(DFL_BLKSIZE, 8 * fsize);
383 if (minfree < MINFREE && opt != FS_OPTSPACE) {
384 fprintf(stderr, "Warning: changing optimization to space ");
385 fprintf(stderr, "because minfree is less than %d%%\n", MINFREE);
386 opt = FS_OPTSPACE;
387 }
388 /* Use soft updates by default for UFS2 and above */
389 if (Oflag > 1)
390 Uflag = 1;
391 realsectorsize = sectorsize;
392 if (sectorsize != DEV_BSIZE) { /* XXX */
393 int secperblk = sectorsize / DEV_BSIZE;
394
395 sectorsize = DEV_BSIZE;
396 fssize *= secperblk;
397 if (pp != NULL)
398 pp->p_size *= secperblk;
399 }
400 mkfs(pp, special);
401 ufs_disk_close(&disk);
402 if (!jflag)
403 exit(0);
404 if (execlp("tunefs", "newfs", "-j", "enable", special, NULL) < 0)
405 err(1, "Cannot enable soft updates journaling, tunefs");
406 /* NOT REACHED */
407 }
408
409 void
getfssize(intmax_t * fsz,const char * s,intmax_t disksize,intmax_t reserved)410 getfssize(intmax_t *fsz, const char *s, intmax_t disksize, intmax_t reserved)
411 {
412 intmax_t available;
413
414 available = disksize - reserved;
415 if (available <= 0)
416 errx(1, "%s: reserved not less than device size %jd",
417 s, disksize);
418 if (*fsz == 0)
419 *fsz = available;
420 else if (*fsz > available)
421 errx(1, "%s: maximum file system size is %jd",
422 s, available);
423 }
424
425 struct disklabel *
getdisklabel(void)426 getdisklabel(void)
427 {
428 static struct disklabel lab;
429 struct disklabel *lp;
430
431 if (is_file) {
432 if (read(disk.d_fd, bootarea, BBSIZE) != BBSIZE)
433 err(4, "cannot read bootarea");
434 if (bsd_disklabel_le_dec(
435 bootarea + (0 /* labeloffset */ +
436 1 /* labelsoffset */ * sectorsize),
437 &lab, MAXPARTITIONS))
438 return (NULL);
439
440 lp = &lab;
441 return &lab;
442 }
443
444 if (disktype) {
445 lp = getdiskbyname(disktype);
446 if (lp != NULL)
447 return (lp);
448 }
449 return (NULL);
450 }
451
452 static void
usage(void)453 usage(void)
454 {
455 fprintf(stderr,
456 "usage: %s [ -fsoptions ] special-device%s\n",
457 getprogname(),
458 " [device-type]");
459 fprintf(stderr, "where fsoptions are:\n");
460 fprintf(stderr, "\t-E Erase previous disk content\n");
461 fprintf(stderr, "\t-J Enable journaling via gjournal\n");
462 fprintf(stderr, "\t-L volume label to add to superblock\n");
463 fprintf(stderr,
464 "\t-N do not create file system, just print out parameters\n");
465 fprintf(stderr, "\t-O file system format: 1 => UFS1, 2 => UFS2\n");
466 fprintf(stderr, "\t-R regression test, suppress random factors\n");
467 fprintf(stderr, "\t-S sector size\n");
468 fprintf(stderr, "\t-T disktype\n");
469 fprintf(stderr, "\t-U enable soft updates\n");
470 fprintf(stderr, "\t-a maximum contiguous blocks\n");
471 fprintf(stderr, "\t-b block size\n");
472 fprintf(stderr, "\t-c blocks per cylinders group\n");
473 fprintf(stderr, "\t-d maximum extent size\n");
474 fprintf(stderr, "\t-e maximum blocks per file in a cylinder group\n");
475 fprintf(stderr, "\t-f frag size\n");
476 fprintf(stderr, "\t-g average file size\n");
477 fprintf(stderr, "\t-h average files per directory\n");
478 fprintf(stderr, "\t-i number of bytes per inode\n");
479 fprintf(stderr, "\t-j enable soft updates journaling\n");
480 fprintf(stderr, "\t-k space to hold for metadata blocks\n");
481 fprintf(stderr, "\t-l enable multilabel MAC\n");
482 fprintf(stderr, "\t-n do not create .snap directory\n");
483 fprintf(stderr, "\t-m minimum free space %%\n");
484 fprintf(stderr, "\t-o optimization preference (`space' or `time')\n");
485 fprintf(stderr, "\t-p partition name (a..h)\n");
486 fprintf(stderr, "\t-r reserved sectors at the end of device\n");
487 fprintf(stderr, "\t-s file system size (sectors)\n");
488 fprintf(stderr, "\t-t enable TRIM\n");
489 exit(1);
490 }
491
492 static int
expand_number_int(const char * buf,int * num)493 expand_number_int(const char *buf, int *num)
494 {
495 int64_t num64;
496 int rval;
497
498 rval = expand_number(buf, &num64);
499 if (rval < 0)
500 return (rval);
501 if (num64 > INT_MAX || num64 < INT_MIN) {
502 errno = ERANGE;
503 return (-1);
504 }
505 *num = (int)num64;
506 return (0);
507 }
508