xref: /freebsd-13-stable/usr.sbin/makefs/makefs.c (revision 3d497e17ebd33fe0f58d773e35ab994d750258d6)
1 /*	$NetBSD: makefs.c,v 1.26 2006/10/22 21:11:56 christos Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-4-Clause
5  *
6  * Copyright (c) 2001-2003 Wasabi Systems, Inc.
7  * All rights reserved.
8  *
9  * Written by Luke Mewburn for Wasabi Systems, Inc.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed for the NetBSD Project by
22  *      Wasabi Systems, Inc.
23  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
24  *    or promote products derived from this software without specific prior
25  *    written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #include <sys/cdefs.h>
41 #include <sys/types.h>
42 #include <sys/stat.h>
43 #include <assert.h>
44 #include <ctype.h>
45 #include <errno.h>
46 #include <limits.h>
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <time.h>
51 #include <unistd.h>
52 #include <stdbool.h>
53 #include <util.h>
54 
55 #include "makefs.h"
56 #include "mtree.h"
57 
58 /*
59  * list of supported file systems and dispatch functions
60  */
61 typedef struct {
62 	const char	*type;
63 	void		(*prepare_options)(fsinfo_t *);
64 	int		(*parse_options)(const char *, fsinfo_t *);
65 	void		(*cleanup_options)(fsinfo_t *);
66 	void		(*make_fs)(const char *, const char *, fsnode *,
67 				fsinfo_t *);
68 } fstype_t;
69 
70 static fstype_t fstypes[] = {
71 #define ENTRY(name) { \
72 	# name, name ## _prep_opts, name ## _parse_opts, \
73 	name ## _cleanup_opts, name ## _makefs  \
74 }
75 	ENTRY(cd9660),
76 	ENTRY(ffs),
77 	ENTRY(msdos),
78 	{ .type = NULL	},
79 };
80 
81 u_int		debug;
82 int		dupsok;
83 struct timespec	start_time;
84 struct stat stampst;
85 
86 static	fstype_t *get_fstype(const char *);
87 static int get_tstamp(const char *, struct stat *);
88 static	void	usage(fstype_t *, fsinfo_t *);
89 
90 int
main(int argc,char * argv[])91 main(int argc, char *argv[])
92 {
93 	struct stat	 sb;
94 	struct timeval	 start;
95 	fstype_t	*fstype;
96 	fsinfo_t	 fsoptions;
97 	fsnode		*root;
98 	int		 ch, i, len;
99 	const char	*subtree;
100 	const char	*specfile;
101 
102 	setprogname(argv[0]);
103 
104 	debug = 0;
105 	if ((fstype = get_fstype(DEFAULT_FSTYPE)) == NULL)
106 		errx(1, "Unknown default fs type `%s'.", DEFAULT_FSTYPE);
107 
108 		/* set default fsoptions */
109 	(void)memset(&fsoptions, 0, sizeof(fsoptions));
110 	fsoptions.fd = -1;
111 	fsoptions.sectorsize = -1;
112 
113 	if (fstype->prepare_options)
114 		fstype->prepare_options(&fsoptions);
115 
116 	specfile = NULL;
117 #ifdef CLOCK_REALTIME
118 	ch = clock_gettime(CLOCK_REALTIME, &start_time);
119 #else
120 	ch = gettimeofday(&start, NULL);
121 	start_time.tv_sec = start.tv_sec;
122 	start_time.tv_nsec = start.tv_usec * 1000;
123 #endif
124 	if (ch == -1)
125 		err(1, "Unable to get system time");
126 
127 
128 	while ((ch = getopt(argc, argv, "B:b:Dd:f:F:M:m:N:O:o:pR:s:S:t:T:xZ")) != -1) {
129 		switch (ch) {
130 
131 		case 'B':
132 			if (strcmp(optarg, "be") == 0 ||
133 			    strcmp(optarg, "4321") == 0 ||
134 			    strcmp(optarg, "big") == 0) {
135 #if BYTE_ORDER == LITTLE_ENDIAN
136 				fsoptions.needswap = 1;
137 #endif
138 			} else if (strcmp(optarg, "le") == 0 ||
139 			    strcmp(optarg, "1234") == 0 ||
140 			    strcmp(optarg, "little") == 0) {
141 #if BYTE_ORDER == BIG_ENDIAN
142 				fsoptions.needswap = 1;
143 #endif
144 			} else {
145 				warnx("Invalid endian `%s'.", optarg);
146 				usage(fstype, &fsoptions);
147 			}
148 			break;
149 
150 		case 'b':
151 			len = strlen(optarg) - 1;
152 			if (optarg[len] == '%') {
153 				optarg[len] = '\0';
154 				fsoptions.freeblockpc =
155 				    strsuftoll("free block percentage",
156 					optarg, 0, 99);
157 			} else {
158 				fsoptions.freeblocks =
159 				    strsuftoll("free blocks",
160 					optarg, 0, LLONG_MAX);
161 			}
162 			break;
163 
164 		case 'D':
165 			dupsok = 1;
166 			break;
167 
168 		case 'd':
169 			debug = strtoll(optarg, NULL, 0);
170 			break;
171 
172 		case 'f':
173 			len = strlen(optarg) - 1;
174 			if (optarg[len] == '%') {
175 				optarg[len] = '\0';
176 				fsoptions.freefilepc =
177 				    strsuftoll("free file percentage",
178 					optarg, 0, 99);
179 			} else {
180 				fsoptions.freefiles =
181 				    strsuftoll("free files",
182 					optarg, 0, LLONG_MAX);
183 			}
184 			break;
185 
186 		case 'F':
187 			specfile = optarg;
188 			break;
189 
190 		case 'M':
191 			fsoptions.minsize =
192 			    strsuftoll("minimum size", optarg, 1LL, LLONG_MAX);
193 			break;
194 
195 		case 'N':
196 			if (! setup_getid(optarg))
197 				errx(1,
198 			    "Unable to use user and group databases in `%s'",
199 				    optarg);
200 			break;
201 
202 		case 'm':
203 			fsoptions.maxsize =
204 			    strsuftoll("maximum size", optarg, 1LL, LLONG_MAX);
205 			break;
206 
207 		case 'O':
208 			fsoptions.offset =
209 			    strsuftoll("offset", optarg, 0LL, LLONG_MAX);
210 			break;
211 
212 		case 'o':
213 		{
214 			char *p;
215 
216 			while ((p = strsep(&optarg, ",")) != NULL) {
217 				if (*p == '\0')
218 					errx(1, "Empty option");
219 				if (! fstype->parse_options(p, &fsoptions))
220 					usage(fstype, &fsoptions);
221 			}
222 			break;
223 		}
224 		case 'p':
225 			/* Deprecated in favor of 'Z' */
226 			fsoptions.sparse = 1;
227 			break;
228 
229 		case 'R':
230 			/* Round image size up to specified block size */
231 			fsoptions.roundup =
232 			    strsuftoll("roundup-size", optarg, 0, LLONG_MAX);
233 			break;
234 
235 		case 's':
236 			fsoptions.minsize = fsoptions.maxsize =
237 			    strsuftoll("size", optarg, 1LL, LLONG_MAX);
238 			break;
239 
240 		case 'S':
241 			fsoptions.sectorsize =
242 			    (int)strsuftoll("sector size", optarg,
243 				1LL, INT_MAX);
244 			break;
245 
246 		case 't':
247 			/* Check current one and cleanup if necessary. */
248 			if (fstype->cleanup_options)
249 				fstype->cleanup_options(&fsoptions);
250 			fsoptions.fs_specific = NULL;
251 			if ((fstype = get_fstype(optarg)) == NULL)
252 				errx(1, "Unknown fs type `%s'.", optarg);
253 			fstype->prepare_options(&fsoptions);
254 			break;
255 
256 		case 'T':
257 			if (get_tstamp(optarg, &stampst) == -1)
258 				errx(1, "Cannot get timestamp from `%s'",
259 				    optarg);
260 			break;
261 
262 		case 'x':
263 			fsoptions.onlyspec = 1;
264 			break;
265 
266 		case 'Z':
267 			/* Superscedes 'p' for compatibility with NetBSD makefs(8) */
268 			fsoptions.sparse = 1;
269 			break;
270 
271 		default:
272 			usage(fstype, &fsoptions);
273 			/* NOTREACHED */
274 
275 		}
276 	}
277 	if (debug) {
278 		printf("debug mask: 0x%08x\n", debug);
279 		printf("start time: %ld.%ld, %s",
280 		    (long)start_time.tv_sec, (long)start_time.tv_nsec,
281 		    ctime(&start_time.tv_sec));
282 	}
283 	argc -= optind;
284 	argv += optind;
285 
286 	if (argc < 2)
287 		usage(fstype, &fsoptions);
288 
289 	/* -x must be accompanied by -F */
290 	if (fsoptions.onlyspec != 0 && specfile == NULL)
291 		errx(1, "-x requires -F mtree-specfile.");
292 
293 	/* Accept '-' as meaning "read from standard input". */
294 	if (strcmp(argv[1], "-") == 0)
295 		sb.st_mode = S_IFREG;
296 	else {
297 		if (stat(argv[1], &sb) == -1)
298 			err(1, "Can't stat `%s'", argv[1]);
299 	}
300 
301 	switch (sb.st_mode & S_IFMT) {
302 	case S_IFDIR:		/* walk the tree */
303 		subtree = argv[1];
304 		TIMER_START(start);
305 		root = walk_dir(subtree, ".", NULL, NULL);
306 		TIMER_RESULTS(start, "walk_dir");
307 		break;
308 	case S_IFREG:		/* read the manifest file */
309 		subtree = ".";
310 		TIMER_START(start);
311 		root = read_mtree(argv[1], NULL);
312 		TIMER_RESULTS(start, "manifest");
313 		break;
314 	default:
315 		errx(1, "%s: not a file or directory", argv[1]);
316 		/* NOTREACHED */
317 	}
318 
319 	/* append extra directory */
320 	for (i = 2; i < argc; i++) {
321 		if (stat(argv[i], &sb) == -1)
322 			err(1, "Can't stat `%s'", argv[i]);
323 		if (!S_ISDIR(sb.st_mode))
324 			errx(1, "%s: not a directory", argv[i]);
325 		TIMER_START(start);
326 		root = walk_dir(argv[i], ".", NULL, root);
327 		TIMER_RESULTS(start, "walk_dir2");
328 	}
329 
330 	if (specfile) {		/* apply a specfile */
331 		TIMER_START(start);
332 		apply_specfile(specfile, subtree, root, fsoptions.onlyspec);
333 		TIMER_RESULTS(start, "apply_specfile");
334 	}
335 
336 	if (debug & DEBUG_DUMP_FSNODES) {
337 		printf("\nparent: %s\n", subtree);
338 		dump_fsnodes(root);
339 		putchar('\n');
340 	}
341 
342 				/* build the file system */
343 	TIMER_START(start);
344 	fstype->make_fs(argv[0], subtree, root, &fsoptions);
345 	TIMER_RESULTS(start, "make_fs");
346 
347 	free_fsnodes(root);
348 
349 	exit(0);
350 	/* NOTREACHED */
351 }
352 
353 int
set_option(const option_t * options,const char * option,char * buf,size_t len)354 set_option(const option_t *options, const char *option, char *buf, size_t len)
355 {
356 	char *var, *val;
357 	int retval;
358 
359 	assert(option != NULL);
360 
361 	var = estrdup(option);
362 	for (val = var; *val; val++)
363 		if (*val == '=') {
364 			*val++ = '\0';
365 			break;
366 		}
367 	retval = set_option_var(options, var, val, buf, len);
368 	free(var);
369 	return retval;
370 }
371 
372 int
set_option_var(const option_t * options,const char * var,const char * val,char * buf,size_t len)373 set_option_var(const option_t *options, const char *var, const char *val,
374     char *buf, size_t len)
375 {
376 	char *s;
377 	size_t i;
378 
379 #define NUM(type) \
380 	if (!*val) { \
381 		*(type *)options[i].value = 1; \
382 		break; \
383 	} \
384 	*(type *)options[i].value = (type)strsuftoll(options[i].desc, val, \
385 	    options[i].minimum, options[i].maximum); break
386 
387 	for (i = 0; options[i].name != NULL; i++) {
388 		if (var[1] == '\0') {
389 			if (options[i].letter != var[0])
390 				continue;
391 		} else if (strcmp(options[i].name, var) != 0)
392 			continue;
393 		switch (options[i].type) {
394 		case OPT_BOOL:
395 			*(bool *)options[i].value = 1;
396 			break;
397 		case OPT_STRARRAY:
398 			strlcpy((void *)options[i].value, val, (size_t)
399 			    options[i].maximum);
400 			break;
401 		case OPT_STRPTR:
402 			s = estrdup(val);
403 			*(char **)options[i].value = s;
404 			break;
405 		case OPT_STRBUF:
406 			if (buf == NULL)
407 				abort();
408 			strlcpy(buf, val, len);
409 			break;
410 		case OPT_INT64:
411 			NUM(uint64_t);
412 		case OPT_INT32:
413 			NUM(uint32_t);
414 		case OPT_INT16:
415 			NUM(uint16_t);
416 		case OPT_INT8:
417 			NUM(uint8_t);
418 		default:
419 			warnx("Unknown type %d in option %s", options[i].type,
420 			    val);
421 			return 0;
422 		}
423 		return i;
424 	}
425 	warnx("Unknown option `%s'", var);
426 	return -1;
427 }
428 
429 
430 static fstype_t *
get_fstype(const char * type)431 get_fstype(const char *type)
432 {
433 	int i;
434 
435 	for (i = 0; fstypes[i].type != NULL; i++)
436 		if (strcmp(fstypes[i].type, type) == 0)
437 			return (&fstypes[i]);
438 	return (NULL);
439 }
440 
441 option_t *
copy_opts(const option_t * o)442 copy_opts(const option_t *o)
443 {
444 	size_t i;
445 
446 	for (i = 0; o[i].name; i++)
447 		continue;
448 	i++;
449 	return memcpy(ecalloc(i, sizeof(*o)), o, i * sizeof(*o));
450 }
451 
452 static int
get_tstamp(const char * b,struct stat * st)453 get_tstamp(const char *b, struct stat *st)
454 {
455 	time_t when;
456 	char *eb;
457 	long long l;
458 
459 	if (stat(b, st) != -1)
460 		return 0;
461 
462 	{
463 		errno = 0;
464 		l = strtoll(b, &eb, 0);
465 		if (b == eb || *eb || errno)
466 			return -1;
467 		when = (time_t)l;
468 	}
469 
470 	st->st_ino = 1;
471 #ifdef HAVE_STRUCT_STAT_BIRTHTIME
472 	st->st_birthtime =
473 #endif
474 	st->st_mtime = st->st_ctime = st->st_atime = when;
475 	return 0;
476 }
477 
478 static void
usage(fstype_t * fstype,fsinfo_t * fsoptions)479 usage(fstype_t *fstype, fsinfo_t *fsoptions)
480 {
481 	const char *prog;
482 
483 	prog = getprogname();
484 	fprintf(stderr,
485 "Usage: %s [-xZ] [-B endian] [-b free-blocks] [-d debug-mask]\n"
486 "\t[-F mtree-specfile] [-f free-files] [-M minimum-size] [-m maximum-size]\n"
487 "\t[-N userdb-dir] [-O offset] [-o fs-options] [-R roundup-size]\n"
488 "\t[-S sector-size] [-s image-size] [-T <timestamp/file>] [-t fs-type]\n"
489 "\timage-file directory | manifest [extra-directory ...]\n",
490 	    prog);
491 
492 	if (fstype) {
493 		size_t i;
494 		option_t *o = fsoptions->fs_options;
495 
496 		fprintf(stderr, "\n%s specific options:\n", fstype->type);
497 		for (i = 0; o[i].name != NULL; i++)
498 			fprintf(stderr, "\t%c%c%20.20s\t%s\n",
499 			    o[i].letter ? o[i].letter : ' ',
500 			    o[i].letter ? ',' : ' ',
501 			    o[i].name, o[i].desc);
502 	}
503 	exit(1);
504 }
505