2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1991, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 static const char copyright[] =
34 "@(#) Copyright (c) 1980, 1991, 1993, 1994\n\
35 The Regents of the University of California. All rights reserved.\n";
40 static char sccsid[] = "@(#)main.c 8.6 (Berkeley) 5/1/95";
42 static const char rcsid[] =
46 #include <sys/param.h>
48 #include <sys/mount.h>
49 #include <sys/disklabel.h>
51 #include <ufs/ufs/dinode.h>
52 #include <ufs/ufs/ufsmount.h>
53 #include <ufs/ffs/fs.h>
55 #include <protocols/dumprestore.h>
74 #include "pathnames.h"
76 int notify = 0; /* notify operator flag */
77 int snapdump = 0; /* dumping live filesystem, so use snapshot */
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 int cachesize = 0; /* block cache size (in bytes), defaults to 0 */
84 long dev_bsize = 1; /* recalculated below */
85 long blocksperfile; /* output blocks per file */
86 char *host = NULL; /* remote host (if any) */
88 static char *getmntpt(char *, int *);
89 static long numarg(const char *, long, long);
90 static void obsolete(int *, char **[]);
91 static void usage(void) __dead2;
94 main(int argc, char *argv[])
102 int ch, mode, mntflags;
103 int i, ret, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
104 int just_estimate = 0;
108 spcl.c_date = _time_to_time64(time(NULL));
110 tsize = 0; /* Default later, based on 'c' option for cart tapes */
111 dumpdates = _PATH_DUMPDATES;
115 if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
116 quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
123 obsolete(&argc, &argv);
124 while ((ch = getopt(argc, argv,
125 "0123456789aB:b:C:cD:d:f:h:LnP:RrSs:T:uWw")) != -1)
128 case '0': case '1': case '2': case '3': case '4':
129 case '5': case '6': case '7': case '8': case '9':
130 level = 10 * level + ch - '0';
133 case 'a': /* `auto-size', Write to EOM. */
137 case 'B': /* blocks per output file */
138 blocksperfile = numarg("number of blocks per file",
142 case 'b': /* blocks per tape write */
143 ntrec = numarg("number of blocks per write",
148 cachesize = numarg("cachesize", 0, 0) * 1024 * 1024;
151 case 'c': /* Tape is cart. not 9-track */
159 case 'd': /* density, in bits per inch */
160 density = numarg("density", 10L, 327670L) / 10;
161 if (density >= 625 && !bflag)
162 ntrec = HIGHDENSITYTREC;
165 case 'f': /* output file */
166 if (popenout != NULL)
167 errx(X_STARTUP, "You cannot use the P and f "
168 "flags together.\n");
173 honorlevel = numarg("honor level", 0L, 10L);
180 case 'n': /* notify operators */
186 errx(X_STARTUP, "You cannot use the P and f "
187 "flags together.\n");
191 case 'r': /* store slightly less data to be friendly to rsync */
192 if (rsync_friendly < 1)
196 case 'R': /* store even less data to be friendlier to rsync */
197 if (rsync_friendly < 2)
201 case 'S': /* exit after estimating # of tapes */
205 case 's': /* tape size, feet */
206 tsize = numarg("tape size", 1L, 0L) * 12 * 10;
209 case 'T': /* time of last dump */
210 spcl.c_ddate = unctime(optarg);
211 if (spcl.c_ddate < 0) {
212 (void)fprintf(stderr, "bad time \"%s\"\n",
220 case 'u': /* update /etc/dumpdates */
224 case 'W': /* what to do */
227 exit(X_FINOK); /* do nothing else */
236 (void)fprintf(stderr, "Must specify disk or file system\n");
242 (void)fprintf(stderr, "Unknown arguments to dump:");
244 (void)fprintf(stderr, " %s", *argv++);
245 (void)fprintf(stderr, "\n");
248 if (rsync_friendly && (level > 0)) {
249 (void)fprintf(stderr, "%s %s\n", "rsync friendly options",
250 "can be used only with level 0 dumps.");
253 if (Tflag && uflag) {
254 (void)fprintf(stderr,
255 "You cannot use the T and u flags together.\n");
259 tape = "child pipeline process";
260 } else if (tape == NULL && (tape = getenv("TAPE")) == NULL)
261 tape = _PATH_DEFTAPE;
262 if (strcmp(tape, "-") == 0) {
264 tape = "standard output";
268 blocksperfile = rounddown(blocksperfile, ntrec);
269 else if (!unlimited) {
271 * Determine how to default tape size and density
274 * 9-track 1600 bpi (160 bytes/.1") 2300 ft.
275 * 9-track 6250 bpi (625 bytes/.1") 2300 ft.
276 * cartridge 8000 bpi (100 bytes/.1") 1700 ft.
278 * hilit19 hits again: "
281 density = cartridge ? 100 : 160;
283 tsize = cartridge ? 1700L*120L : 2300L*120L;
286 if (strchr(tape, ':')) {
288 tape = strchr(host, ':');
291 if (strchr(tape, '\n')) {
292 (void)fprintf(stderr, "invalid characters in tape\n");
295 if (rmthost(host) == 0)
298 (void)fprintf(stderr, "remote dump not enabled\n");
302 (void)setuid(getuid()); /* rmthost() is the only reason to be setuid */
304 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
306 if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
307 signal(SIGTRAP, sig);
308 if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
310 if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
312 if (signal(SIGSEGV, SIG_IGN) != SIG_IGN)
313 signal(SIGSEGV, sig);
314 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
315 signal(SIGTERM, sig);
316 if (signal(SIGINT, interrupt) == SIG_IGN)
317 signal(SIGINT, SIG_IGN);
319 dump_getfstab(); /* /etc/fstab snarfed */
321 * disk can be either the full special file name,
322 * the suffix of the special file name,
323 * the special name missing the leading '/',
324 * the file system name with or without the leading '/'.
326 dt = fstabsearch(disk);
328 disk = rawname(dt->fs_spec);
330 errx(X_STARTUP, "%s: unknown file system", dt->fs_spec);
331 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
332 (void)strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
334 (void)strncpy(spcl.c_dev, disk, NAMELEN);
335 (void)strncpy(spcl.c_filesys, "an unlisted file system",
338 spcl.c_dev[NAMELEN-1]='\0';
339 spcl.c_filesys[NAMELEN-1]='\0';
341 if ((mntpt = getmntpt(disk, &mntflags)) != NULL) {
342 if (mntflags & MNT_RDONLY) {
345 "-L ignored for read-only filesystem.");
348 } else if (snapdump == 0) {
350 "should use -L when dumping live read-write "
353 char snapname[BUFSIZ], snapcmd[BUFSIZ];
355 snprintf(snapname, sizeof snapname, "%s/.snap", mntpt);
356 if ((stat(snapname, &sb) < 0) || !S_ISDIR(sb.st_mode)) {
357 msg("WARNING: %s %s\n",
358 "-L requested but snapshot location",
361 "is not a directory",
362 "dump downgraded, -L ignored");
365 snprintf(snapname, sizeof snapname,
366 "%s/.snap/dump_snapshot", mntpt);
367 snprintf(snapcmd, sizeof snapcmd, "%s %s %s",
368 _PATH_MKSNAP_FFS, mntpt, snapname);
370 if (system(snapcmd) != 0)
371 errx(X_STARTUP, "Cannot create %s: %s\n",
372 snapname, strerror(errno));
373 if ((diskfd = open(snapname, O_RDONLY)) < 0) {
375 errx(X_STARTUP, "Cannot open %s: %s\n",
376 snapname, strerror(errno));
379 if (fstat(diskfd, &sb) != 0)
380 err(X_STARTUP, "%s: stat", snapname);
381 spcl.c_date = _time_to_time64(sb.st_mtime);
384 } else if (snapdump != 0) {
385 msg("WARNING: Cannot use -L on an unmounted filesystem.\n");
389 if ((diskfd = open(disk, O_RDONLY)) < 0)
390 err(X_STARTUP, "Cannot open %s", disk);
391 if (fstat(diskfd, &sb) != 0)
392 err(X_STARTUP, "%s: stat", disk);
393 if (S_ISDIR(sb.st_mode))
394 errx(X_STARTUP, "%s: unknown file system", disk);
397 (void)strcpy(spcl.c_label, "none");
398 (void)gethostname(spcl.c_host, NAMELEN);
399 spcl.c_level = level;
400 spcl.c_type = TS_TAPE;
401 if (rsync_friendly) {
402 /* don't store real dump times */
406 if (spcl.c_date == 0) {
407 tmsg = "the epoch\n";
409 time_t t = _time64_to_time(spcl.c_date);
412 msg("Date of this level %d dump: %s", level, tmsg);
414 if (!Tflag && (!rsync_friendly))
415 getdumptime(); /* /etc/dumpdates snarfed */
416 if (spcl.c_ddate == 0) {
417 tmsg = "the epoch\n";
419 time_t t = _time64_to_time(spcl.c_ddate);
423 msg("Date of last (level unknown) dump: %s", tmsg);
425 msg("Date of last level %d dump: %s", lastlevel, tmsg);
427 msg("Dumping %s%s ", snapdump ? "snapshot of ": "", disk);
429 msgtail("(%s) ", dt->fs_file);
431 msgtail("to %s on host %s\n", tape, host);
433 msgtail("to %s\n", tape);
436 if ((ret = sbget(diskfd, &sblock, -1)) != 0) {
439 warn("Cannot find file system superblock");
442 warn("Unable to read file system superblock");
446 dev_bsize = sblock->fs_fsize / fsbtodb(sblock, 1);
447 dev_bshift = ffs(dev_bsize) - 1;
448 if (dev_bsize != (1 << dev_bshift))
449 quit("dev_bsize (%ld) is not a power of 2", dev_bsize);
450 tp_bshift = ffs(TP_BSIZE) - 1;
451 if (TP_BSIZE != (1 << tp_bshift))
452 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
453 maxino = sblock->fs_ipg * sblock->fs_ncg;
454 mapsize = roundup(howmany(maxino, CHAR_BIT), TP_BSIZE);
455 usedinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
456 dumpdirmap = (char *)calloc((unsigned) mapsize, sizeof(char));
457 dumpinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
458 tapesize = 3 * (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
460 nonodump = spcl.c_level < honorlevel;
463 setproctitle("%s: pass 1: regular files", disk);
464 msg("mapping (Pass I) [regular files]\n");
465 anydirskipped = mapfiles(maxino, &tapesize);
468 setproctitle("%s: pass 2: directories", disk);
469 msg("mapping (Pass II) [directories]\n");
470 while (anydirskipped) {
471 anydirskipped = mapdirs(maxino, &tapesize);
474 if (pipeout || unlimited) {
475 tapesize += 10; /* 10 trailer blocks */
476 msg("estimated %ld tape blocks.\n", tapesize);
481 fetapes = (double) tapesize / blocksperfile;
482 else if (cartridge) {
483 /* Estimate number of tapes, assuming streaming stops at
484 the end of each block written, and not in mid-block.
485 Assume no erroneous blocks; this can be compensated
486 for with an artificially low tape size. */
488 ( (double) tapesize /* blocks */
489 * TP_BSIZE /* bytes/block */
490 * (1.0/density) /* 0.1" / byte " */
492 (double) tapesize /* blocks */
493 * (1.0/ntrec) /* streaming-stops per block */
494 * 15.48 /* 0.1" / streaming-stop " */
495 ) * (1.0 / tsize ); /* tape / 0.1" " */
497 /* Estimate number of tapes, for old fashioned 9-track
499 int tenthsperirg = (density == 625) ? 3 : 7;
501 ( (double) tapesize /* blocks */
502 * TP_BSIZE /* bytes / block */
503 * (1.0/density) /* 0.1" / byte " */
505 (double) tapesize /* blocks */
506 * (1.0/ntrec) /* IRG's / block */
507 * tenthsperirg /* 0.1" / IRG " */
508 ) * (1.0 / tsize ); /* tape / 0.1" " */
510 etapes = fetapes; /* truncating assignment */
512 /* count the dumped inodes map on each additional tape */
513 tapesize += (etapes - 1) *
514 (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
515 tapesize += etapes + 10; /* headers + 10 trailer blks */
516 msg("estimated %ld tape blocks on %3.2f tape(s).\n",
521 * If the user only wants an estimate of the number of
528 * Allocate tape buffer.
532 "can't allocate tape buffers - try a smaller blocking factor.\n");
535 (void)time((time_t *)&(tstart_writing));
536 dumpmap(usedinomap, TS_CLRI, maxino - 1);
539 setproctitle("%s: pass 3: directories", disk);
540 msg("dumping (Pass III) [directories]\n");
541 dirty = 0; /* XXX just to get gcc to shut up */
542 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
543 if (((ino - 1) % CHAR_BIT) == 0) /* map is offset by 1 */
547 if ((dirty & 1) == 0)
550 * Skip directory inodes deleted and maybe reallocated
552 dp = getinode(ino, &mode);
555 (void)dumpino(dp, ino);
559 setproctitle("%s: pass 4: regular files", disk);
560 msg("dumping (Pass IV) [regular files]\n");
561 for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
562 if (((ino - 1) % CHAR_BIT) == 0) /* map is offset by 1 */
566 if ((dirty & 1) == 0)
569 * Skip inodes deleted and reallocated as directories.
571 dp = getinode(ino, &mode);
574 (void)dumpino(dp, ino);
577 (void)time((time_t *)&(tend_writing));
578 spcl.c_type = TS_END;
579 for (i = 0; i < ntrec; i++)
580 writeheader(maxino - 1);
582 msg("DUMP: %jd tape blocks\n", (intmax_t)spcl.c_tapea);
584 msg("DUMP: %jd tape blocks on %d volume%s\n",
585 (intmax_t)spcl.c_tapea, spcl.c_volume,
586 (spcl.c_volume == 1) ? "" : "s");
588 /* report dump performance, avoid division through zero */
589 if (tend_writing - tstart_writing == 0)
590 msg("finished in less than a second\n");
592 msg("finished in %jd seconds, throughput %jd KBytes/sec\n",
593 (intmax_t)tend_writing - tstart_writing,
594 (intmax_t)(spcl.c_tapea /
595 (tend_writing - tstart_writing)));
599 broadcast("DUMP IS DONE!\a\a\n");
600 msg("DUMP IS DONE\n");
609 "usage: dump [-0123456789acLnSu] [-B records] [-b blocksize] [-C cachesize]\n"
610 " [-D dumpdates] [-d density] [-f file | -P pipecommand] [-h level]\n"
611 " [-s feet] [-T date] filesystem\n"
617 * Check to see if a disk is currently mounted.
620 getmntpt(char *name, int *mntflagsp)
623 struct statfs *mntbuf;
625 mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
626 for (i = 0; i < mntsize; i++) {
627 if (!strcmp(mntbuf[i].f_mntfromname, name)) {
628 *mntflagsp = mntbuf[i].f_flags;
629 return (mntbuf[i].f_mntonname);
636 * Pick up a numeric argument. It must be nonnegative and in the given
637 * range (except that a vmax of 0 means unlimited).
640 numarg(const char *meaning, long vmin, long vmax)
645 val = strtol(optarg, &p, 10);
647 errx(1, "illegal %s -- %s", meaning, optarg);
648 if (val < vmin || (vmax && val > vmax))
649 errx(1, "%s must be between %ld and %ld", meaning, vmin, vmax);
664 quit("Signal on pipe: cannot recover\n");
665 msg("Rewriting attempted as response to unknown signal.\n");
666 (void)fflush(stderr);
667 (void)fflush(stdout);
672 msg("SIGSEGV: ABORTING!\n");
673 (void)signal(SIGSEGV, SIG_DFL);
674 (void)kill(0, SIGSEGV);
685 * Ensure that the device passed in is a raw device.
687 if (stat(cp, &sb) == 0 && (sb.st_mode & S_IFMT) == S_IFCHR)
691 * Since there's only one device type now, we can't construct any
692 * better name, so we have to return NULL.
699 * Change set of key letters and ordered arguments into something
700 * getopt(3) will like.
703 obsolete(int *argcp, char **argvp[])
706 char *ap, **argv, *flagsp, **nargv, *p;
713 * Return if no arguments or first argument has leading
717 if (argc == 1 || *ap == '-' || *ap == '/')
720 /* Allocate space for new arguments. */
721 if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
722 (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
728 for (flags = 0; *ap; ++ap) {
740 warnx("option requires an argument -- %c", *ap);
743 if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
747 (void)strcpy(&nargv[0][2], *argv);
761 /* Terminate flags. */
768 /* Copy remaining arguments. */
769 while ((*nargv++ = *argv++));
771 /* Update argument count. */
772 *argcp = nargv - *argvp - 1;