xref: /freebsd/sbin/dump/main.c (revision 1130b656e5fe4c2d1ba299e024d1b40eaeebd380)
1 /*-
2  * Copyright (c) 1980, 1991, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifndef lint
35 static char copyright[] =
36 "@(#) Copyright (c) 1980, 1991, 1993, 1994\n\
37 	The Regents of the University of California.  All rights reserved.\n";
38 #endif /* not lint */
39 
40 #ifndef lint
41 static char sccsid[] = "@(#)main.c	8.4 (Berkeley) 4/15/94";
42 #endif /* not lint */
43 
44 #include <sys/param.h>
45 #include <sys/time.h>
46 #ifdef sunos
47 #include <sys/vnode.h>
48 
49 #include <ufs/inode.h>
50 #include <ufs/fs.h>
51 #else
52 #include <ufs/ffs/fs.h>
53 #include <ufs/ufs/dinode.h>
54 #endif
55 
56 #include <protocols/dumprestore.h>
57 
58 #include <ctype.h>
59 #include <errno.h>
60 #include <fcntl.h>
61 #include <fstab.h>
62 #include <signal.h>
63 #include <stdio.h>
64 #ifdef __STDC__
65 #include <stdlib.h>
66 #include <string.h>
67 #include <unistd.h>
68 #endif
69 
70 #include "dump.h"
71 #include "pathnames.h"
72 
73 #ifndef SBOFF
74 #define SBOFF (SBLOCK * DEV_BSIZE)
75 #endif
76 
77 int	notify = 0;	/* notify operator flag */
78 int	blockswritten = 0;	/* number of blocks written on current tape */
79 int	tapeno = 0;	/* current tape number */
80 int	density = 0;	/* density in bytes/0.1" " <- this is for hilit19 */
81 int	ntrec = NTREC;	/* # tape blocks in each tape record */
82 int	cartridge = 0;	/* Assume non-cartridge tape */
83 long	dev_bsize = 1;	/* recalculated below */
84 long	blocksperfile;	/* output blocks per file */
85 char	*host = NULL;	/* remote host (if any) */
86 
87 static long numarg __P((int, char *, long, long, int *, char ***));
88 static void missingarg __P((int, char *)) __dead2;
89 
90 int
91 main(argc, argv)
92 	int argc;
93 	char **argv;
94 {
95 	register ino_t ino;
96 	register int dirty;
97 	register struct dinode *dp;
98 	register struct	fstab *dt;
99 	register char *map;
100 	register char *cp;
101 	int i, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
102 	ino_t maxino;
103 
104 	spcl.c_date = 0;
105 	(void)time((time_t *)&spcl.c_date);
106 
107 	tsize = 0;	/* Default later, based on 'c' option for cart tapes */
108 	if ((tape = getenv("TAPE")) == NULL)
109 		tape = _PATH_DEFTAPE;
110 	dumpdates = _PATH_DUMPDATES;
111 	temp = _PATH_DTMP;
112 	if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
113 		quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
114 	level = '0';
115 	if (argc == 1) {
116 		(void) fprintf(stderr, "Must specify a key.\n");
117 		Exit(X_ABORT);
118 	}
119 	argv++;
120 	argc -= 2;
121 	for (cp = *argv++; cp != NULL && *cp != '\0'; cp++) {
122 		switch (*cp) {
123 		case '-':
124 			break;
125 
126 		case 'w':
127 			lastdump('w');	/* tell us only what has to be done */
128 			exit(0);
129 
130 		case 'W':		/* what to do */
131 			lastdump('W');	/* tell us state of what is done */
132 			exit(0);	/* do nothing else */
133 
134 		case 'f':		/* output file */
135 			if (argc < 1)
136 				missingarg('f', "output file");
137 			tape = *argv++;
138 			argc--;
139 			break;
140 
141 		case 'd':		/* density, in bits per inch */
142 			density = numarg('d', "density",
143 			    10L, 327670L, &argc, &argv) / 10;
144 			if (density >= 625 && !bflag)
145 				ntrec = HIGHDENSITYTREC;
146 			break;
147 
148 		case 's':		/* tape size, feet */
149 			tsize = numarg('s', "size",
150 			    1L, 0L, &argc, &argv) * 12 * 10;
151 			break;
152 
153 		case 'T':		/* time of last dump */
154 			if (argc < 1)
155 				missingarg('T', "time of last dump");
156 			spcl.c_ddate = unctime(*argv);
157 			if (spcl.c_ddate < 0) {
158 				(void)fprintf(stderr, "bad time \"%s\"\n",
159 				    *argv);
160 				exit(X_ABORT);
161 			}
162 			Tflag = 1;
163 			lastlevel = '?';
164 			argc--;
165 			argv++;
166 			break;
167 
168 		case 'b':		/* blocks per tape write */
169 			ntrec = numarg('b', "number of blocks per write",
170 			    1L, 1000L, &argc, &argv);
171 			/* XXX restore is unable to restore dumps that
172 			   were created  with a blocksize larger than 32K.
173 			   Possibly a bug in the scsi tape driver. */
174 			if ( ntrec > 32 ) {
175 				msg("please choose a blocksize <= 32\n");
176 				exit(X_ABORT);
177 			}
178 			break;
179 
180 		case 'B':		/* blocks per output file */
181 			blocksperfile = numarg('B', "number of blocks per file",
182 			    1L, 0L, &argc, &argv);
183 			break;
184 
185 		case 'c':		/* Tape is cart. not 9-track */
186 			cartridge = 1;
187 			break;
188 
189 		/* dump level */
190 		case '0': case '1': case '2': case '3': case '4':
191 		case '5': case '6': case '7': case '8': case '9':
192 			level = *cp;
193 			break;
194 
195 		case 'u':		/* update /etc/dumpdates */
196 			uflag = 1;
197 			break;
198 
199 		case 'n':		/* notify operators */
200 			notify = 1;
201 			break;
202 
203 		case 'h':
204 			honorlevel = numarg('h', "honor level",
205 			    0L, 10L, &argc, &argv);
206 			break;
207 
208 		default:
209 			(void)fprintf(stderr, "bad key '%c'\n", *cp);
210 			exit(X_ABORT);
211 		}
212 	}
213 	if (argc < 1) {
214 		(void)fprintf(stderr, "Must specify disk or filesystem\n");
215 		exit(X_ABORT);
216 	}
217 	disk = *argv++;
218 	argc--;
219 	if (argc >= 1) {
220 		(void)fprintf(stderr, "Unknown arguments to dump:");
221 		while (argc--)
222 			(void)fprintf(stderr, " %s", *argv++);
223 		(void)fprintf(stderr, "\n");
224 		exit(X_ABORT);
225 	}
226 	if (Tflag && uflag) {
227 	        (void)fprintf(stderr,
228 		    "You cannot use the T and u flags together.\n");
229 		exit(X_ABORT);
230 	}
231 	if (strcmp(tape, "-") == 0) {
232 		pipeout++;
233 		tape = "standard output";
234 	}
235 
236 	if (blocksperfile)
237 		blocksperfile = blocksperfile / ntrec * ntrec; /* round down */
238 	else {
239 		/*
240 		 * Determine how to default tape size and density
241 		 *
242 		 *         	density				tape size
243 		 * 9-track	1600 bpi (160 bytes/.1")	2300 ft.
244 		 * 9-track	6250 bpi (625 bytes/.1")	2300 ft.
245 		 * cartridge	8000 bpi (100 bytes/.1")	1700 ft.
246 		 *						(450*4 - slop)
247 		 * hilit19 hits again: "
248 		 */
249 		if (density == 0)
250 			density = cartridge ? 100 : 160;
251 		if (tsize == 0)
252 			tsize = cartridge ? 1700L*120L : 2300L*120L;
253 	}
254 
255 	if (index(tape, ':')) {
256 		host = tape;
257 		tape = index(host, ':');
258 		*tape++ = '\0';
259 #ifdef RDUMP
260 		if (index(tape, '\n')) {
261 		    (void)fprintf(stderr, "invalid characters in tape\n");
262 		    exit(X_ABORT);
263 		}
264 		if (rmthost(host) == 0)
265 			exit(X_ABORT);
266 #else
267 		(void)fprintf(stderr, "remote dump not enabled\n");
268 		exit(X_ABORT);
269 #endif
270 	}
271 	(void)setuid(getuid()); /* rmthost() is the only reason to be setuid */
272 
273 	if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
274 		signal(SIGHUP, sig);
275 	if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
276 		signal(SIGTRAP, sig);
277 	if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
278 		signal(SIGFPE, sig);
279 	if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
280 		signal(SIGBUS, sig);
281 	if (signal(SIGSEGV, SIG_IGN) != SIG_IGN)
282 		signal(SIGSEGV, sig);
283 	if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
284 		signal(SIGTERM, sig);
285 	if (signal(SIGINT, interrupt) == SIG_IGN)
286 		signal(SIGINT, SIG_IGN);
287 
288 	set_operators();	/* /etc/group snarfed */
289 	getfstab();		/* /etc/fstab snarfed */
290 	/*
291 	 *	disk can be either the full special file name,
292 	 *	the suffix of the special file name,
293 	 *	the special name missing the leading '/',
294 	 *	the file system name with or without the leading '/'.
295 	 */
296 	dt = fstabsearch(disk);
297 	if (dt != NULL) {
298 		disk = rawname(dt->fs_spec);
299 		(void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
300 		(void)strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
301 	} else {
302 		(void)strncpy(spcl.c_dev, disk, NAMELEN);
303 		(void)strncpy(spcl.c_filesys, "an unlisted file system",
304 		    NAMELEN);
305 	}
306 	spcl.c_dev[NAMELEN-1]='\0';
307 	spcl.c_filesys[NAMELEN-1]='\0';
308 	(void)strcpy(spcl.c_label, "none");
309 	(void)gethostname(spcl.c_host, NAMELEN);
310 	spcl.c_level = level - '0';
311 	spcl.c_type = TS_TAPE;
312 	if (!Tflag)
313 	        getdumptime();		/* /etc/dumpdates snarfed */
314 
315 	msg("Date of this level %c dump: %s", level,
316 		spcl.c_date == 0 ? "the epoch\n" : ctime(&spcl.c_date));
317  	msg("Date of last level %c dump: %s", lastlevel,
318 		spcl.c_ddate == 0 ? "the epoch\n" : ctime(&spcl.c_ddate));
319 	msg("Dumping %s ", disk);
320 	if (dt != NULL)
321 		msgtail("(%s) ", dt->fs_file);
322 	if (host)
323 		msgtail("to %s on host %s\n", tape, host);
324 	else
325 		msgtail("to %s\n", tape);
326 
327 	if ((diskfd = open(disk, O_RDONLY)) < 0) {
328 		msg("Cannot open %s\n", disk);
329 		exit(X_ABORT);
330 	}
331 	sync();
332 	sblock = (struct fs *)sblock_buf;
333 	bread(SBOFF, (char *) sblock, SBSIZE);
334 	if (sblock->fs_magic != FS_MAGIC)
335 		quit("bad sblock magic number\n");
336 	dev_bsize = sblock->fs_fsize / fsbtodb(sblock, 1);
337 	dev_bshift = ffs(dev_bsize) - 1;
338 	if (dev_bsize != (1 << dev_bshift))
339 		quit("dev_bsize (%d) is not a power of 2", dev_bsize);
340 	tp_bshift = ffs(TP_BSIZE) - 1;
341 	if (TP_BSIZE != (1 << tp_bshift))
342 		quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
343 #ifdef FS_44INODEFMT
344 	if (sblock->fs_inodefmt >= FS_44INODEFMT)
345 		spcl.c_flags |= DR_NEWINODEFMT;
346 #endif
347 	maxino = sblock->fs_ipg * sblock->fs_ncg;
348 	mapsize = roundup(howmany(maxino, NBBY), TP_BSIZE);
349 	usedinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
350 	dumpdirmap = (char *)calloc((unsigned) mapsize, sizeof(char));
351 	dumpinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
352 	tapesize = 3 * (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
353 
354 	nonodump = spcl.c_level < honorlevel;
355 
356 	msg("mapping (Pass I) [regular files]\n");
357 	anydirskipped = mapfiles(maxino, &tapesize);
358 
359 	msg("mapping (Pass II) [directories]\n");
360 	while (anydirskipped) {
361 		anydirskipped = mapdirs(maxino, &tapesize);
362 	}
363 
364 	if (pipeout) {
365 		tapesize += 10;	/* 10 trailer blocks */
366 		msg("estimated %ld tape blocks.\n", tapesize);
367 	} else {
368 		double fetapes;
369 
370 		if (blocksperfile)
371 			fetapes = (double) tapesize / blocksperfile;
372 		else if (cartridge) {
373 			/* Estimate number of tapes, assuming streaming stops at
374 			   the end of each block written, and not in mid-block.
375 			   Assume no erroneous blocks; this can be compensated
376 			   for with an artificially low tape size. */
377 			fetapes =
378 			(	  (double) tapesize	/* blocks */
379 				* TP_BSIZE	/* bytes/block */
380 				* (1.0/density)	/* 0.1" / byte " */
381 			  +
382 				  (double) tapesize	/* blocks */
383 				* (1.0/ntrec)	/* streaming-stops per block */
384 				* 15.48		/* 0.1" / streaming-stop " */
385 			) * (1.0 / tsize );	/* tape / 0.1" " */
386 		} else {
387 			/* Estimate number of tapes, for old fashioned 9-track
388 			   tape */
389 			int tenthsperirg = (density == 625) ? 3 : 7;
390 			fetapes =
391 			(	  (double) tapesize	/* blocks */
392 				* TP_BSIZE	/* bytes / block */
393 				* (1.0/density)	/* 0.1" / byte " */
394 			  +
395 				  (double) tapesize	/* blocks */
396 				* (1.0/ntrec)	/* IRG's / block */
397 				* tenthsperirg	/* 0.1" / IRG " */
398 			) * (1.0 / tsize );	/* tape / 0.1" " */
399 		}
400 		etapes = fetapes;		/* truncating assignment */
401 		etapes++;
402 		/* count the dumped inodes map on each additional tape */
403 		tapesize += (etapes - 1) *
404 			(howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
405 		tapesize += etapes + 10;	/* headers + 10 trailer blks */
406 		msg("estimated %ld tape blocks on %3.2f tape(s).\n",
407 		    tapesize, fetapes);
408 	}
409 
410 	/*
411 	 * Allocate tape buffer.
412 	 */
413 	if (!alloctape())
414 		quit("can't allocate tape buffers - try a smaller blocking factor.\n");
415 
416 	startnewtape(1);
417 	(void)time((time_t *)&(tstart_writing));
418 	dumpmap(usedinomap, TS_CLRI, maxino - 1);
419 
420 	msg("dumping (Pass III) [directories]\n");
421 	dirty = 0;		/* XXX just to get gcc to shut up */
422 	for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
423 		if (((ino - 1) % NBBY) == 0)	/* map is offset by 1 */
424 			dirty = *map++;
425 		else
426 			dirty >>= 1;
427 		if ((dirty & 1) == 0)
428 			continue;
429 		/*
430 		 * Skip directory inodes deleted and maybe reallocated
431 		 */
432 		dp = getino(ino);
433 		if ((dp->di_mode & IFMT) != IFDIR)
434 			continue;
435 		(void)dumpino(dp, ino);
436 	}
437 
438 	msg("dumping (Pass IV) [regular files]\n");
439 	for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
440 		int mode;
441 
442 		if (((ino - 1) % NBBY) == 0)	/* map is offset by 1 */
443 			dirty = *map++;
444 		else
445 			dirty >>= 1;
446 		if ((dirty & 1) == 0)
447 			continue;
448 		/*
449 		 * Skip inodes deleted and reallocated as directories.
450 		 */
451 		dp = getino(ino);
452 		mode = dp->di_mode & IFMT;
453 		if (mode == IFDIR)
454 			continue;
455 		(void)dumpino(dp, ino);
456 	}
457 
458 	(void)time((time_t *)&(tend_writing));
459 	spcl.c_type = TS_END;
460 	for (i = 0; i < ntrec; i++)
461 		writeheader(maxino - 1);
462 	if (pipeout)
463 		msg("DUMP: %ld tape blocks\n", spcl.c_tapea);
464 	else
465 		msg("DUMP: %ld tape blocks on %d volumes(s)\n",
466 		    spcl.c_tapea, spcl.c_volume);
467 
468 	/* report dump performance, avoid division through zero */
469 	if (tend_writing - tstart_writing == 0)
470 		msg("finished in less than a second\n");
471 	else
472 		msg("finished in %d seconds, throughput %d KBytes/sec\n",
473 		    tend_writing - tstart_writing,
474 		    spcl.c_tapea / (tend_writing - tstart_writing));
475 
476 	putdumptime();
477 	trewind();
478 	broadcast("DUMP IS DONE!\7\7\n");
479 	msg("DUMP IS DONE\n");
480 	Exit(X_FINOK);
481 	/* NOTREACHED */
482 }
483 
484 /*
485  * Pick up a numeric argument.  It must be nonnegative and in the given
486  * range (except that a vmax of 0 means unlimited).
487  */
488 static long
489 numarg(letter, meaning, vmin, vmax, pargc, pargv)
490 	int letter;
491 	char *meaning;
492 	long vmin, vmax;
493 	int *pargc;
494 	char ***pargv;
495 {
496 	register char *p;
497 	long val;
498 	char *str;
499 
500 	if (--*pargc < 0)
501 		missingarg(letter, meaning);
502 	str = *(*pargv)++;
503 	for (p = str; *p; p++)
504 		if (!isdigit(*p))
505 			goto bad;
506 	val = atol(str);
507 	if (val < vmin || (vmax && val > vmax))
508 		goto bad;
509 	return (val);
510 
511 bad:
512 	(void)fprintf(stderr, "bad '%c' (%s) value \"%s\"\n",
513 	    letter, meaning, str);
514 	exit(X_ABORT);
515 }
516 
517 static void
518 missingarg(letter, meaning)
519 	int letter;
520 	char *meaning;
521 {
522 
523 	(void)fprintf(stderr, "The '%c' flag (%s) requires an argument\n",
524 	    letter, meaning);
525 	exit(X_ABORT);
526 }
527 
528 void
529 sig(signo)
530 	int signo;
531 {
532 	switch(signo) {
533 	case SIGALRM:
534 	case SIGBUS:
535 	case SIGFPE:
536 	case SIGHUP:
537 	case SIGTERM:
538 	case SIGTRAP:
539 		if (pipeout)
540 			quit("Signal on pipe: cannot recover\n");
541 		msg("Rewriting attempted as response to unknown signal.\n");
542 		(void)fflush(stderr);
543 		(void)fflush(stdout);
544 		close_rewind();
545 		exit(X_REWRITE);
546 		/* NOTREACHED */
547 	case SIGSEGV:
548 		msg("SIGSEGV: ABORTING!\n");
549 		(void)signal(SIGSEGV, SIG_DFL);
550 		(void)kill(0, SIGSEGV);
551 		/* NOTREACHED */
552 	}
553 }
554 
555 char *
556 rawname(cp)
557 	char *cp;
558 {
559 	static char rawbuf[MAXPATHLEN];
560 	char *dp = rindex(cp, '/');
561 
562 	if (dp == NULL)
563 		return (NULL);
564 	*dp = '\0';
565 	(void)strncpy(rawbuf, cp, MAXPATHLEN - 1);
566 	rawbuf[MAXPATHLEN-1] = '\0';
567 	*dp = '/';
568 	(void)strncat(rawbuf, "/r", MAXPATHLEN - 1 - strlen(rawbuf));
569 	(void)strncat(rawbuf, dp + 1, MAXPATHLEN - 1 - strlen(rawbuf));
570 	return (rawbuf);
571 }
572 
573 #ifdef sunos
574 const char *
575 strerror(errnum)
576 	int errnum;
577 {
578 	extern int sys_nerr;
579 	extern const char *const sys_errlist[];
580 
581 	if (errnum < sys_nerr)
582 		return (sys_errlist[errnum]);
583 	else
584 		return ("bogus errno in strerror");
585 }
586 #endif
587