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/extattr.h>
52 #include <ufs/ufs/quota.h>
53 #include <ufs/ufs/dinode.h>
54 #include <ufs/ufs/ufsmount.h>
55 #include <ufs/ffs/fs.h>
57 #include <protocols/dumprestore.h>
76 #include "pathnames.h"
78 int mapsize; /* size of the state maps */
79 char *usedinomap; /* map of allocated inodes */
80 char *dumpdirmap; /* map of directories to be dumped */
81 char *dumpinomap; /* map of files to be dumped */
82 char *disk; /* name of the disk file */
83 char *tape; /* name of the tape file */
84 char *popenout; /* popen(3) per-"tape" command */
85 int level; /* dump level of this dump */
86 int uflag; /* update flag */
87 int diskfd; /* disk file descriptor */
88 int pipeout; /* true => output to standard output */
89 int density = 0; /* density in bytes/0.1" " <- this is for hilit19 */
90 long tapesize; /* estimated tape size, blocks */
91 long tsize; /* tape size in 0.1" units */
92 int etapes; /* estimated number of tapes */
93 int nonodump; /* if set, do not honor UF_NODUMP user flags */
94 int unlimited; /* if set, write to end of medium */
95 int cachesize = 0; /* block cache size (in bytes), defaults to 0 */
96 int rsync_friendly; /* be friendly with rsync */
97 int notify = 0; /* notify operator flag */
98 int blockswritten = 0; /* number of blocks written on current tape */
99 int tapeno = 0; /* current tape number */
100 int ntrec = NTREC; /* # tape blocks in each tape record */
101 long blocksperfile; /* number of blocks per output file */
102 int cartridge = 0; /* Assume non-cartridge tape */
103 char *host = NULL; /* remote host (if any) */
104 time_t tstart_writing; /* when started writing the first tape block */
105 time_t tend_writing; /* after writing the last tape block */
106 int passno; /* current dump pass number */
107 struct fs *sblock; /* the file system super block */
108 long dev_bsize = 1; /* recalculated below */
109 int dev_bshift; /* log2(dev_bsize) */
110 int tp_bshift; /* log2(TP_BSIZE) */
111 int snapdump = 0; /* dumping live filesystem, so use snapshot */
113 static char *getmntpt(char *, int *);
114 static long numarg(const char *, long, long);
115 static void obsolete(int *, char **[]);
116 static void usage(void) __dead2;
119 main(int argc, char *argv[])
127 int ch, mode, mntflags;
128 int i, ret, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
129 int just_estimate = 0;
133 spcl.c_date = _time_to_time64(time(NULL));
135 tsize = 0; /* Default later, based on 'c' option for cart tapes */
136 dumpdates = _PATH_DUMPDATES;
139 if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
140 quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
147 obsolete(&argc, &argv);
148 while ((ch = getopt(argc, argv,
149 "0123456789aB:b:C:cD:d:f:h:LnP:RrSs:T:uWw")) != -1)
152 case '0': case '1': case '2': case '3': case '4':
153 case '5': case '6': case '7': case '8': case '9':
154 level = 10 * level + ch - '0';
157 case 'a': /* `auto-size', Write to EOM. */
161 case 'B': /* blocks per output file */
162 blocksperfile = numarg("number of blocks per file",
166 case 'b': /* blocks per tape write */
167 ntrec = numarg("number of blocks per write",
172 cachesize = numarg("cachesize", 0, 0) * 1024 * 1024;
175 case 'c': /* Tape is cart. not 9-track */
183 case 'd': /* density, in bits per inch */
184 density = numarg("density", 10L, 327670L) / 10;
185 if (density >= 625 && !bflag)
186 ntrec = HIGHDENSITYTREC;
189 case 'f': /* output file */
190 if (popenout != NULL)
191 errx(X_STARTUP, "You cannot use the P and f "
192 "flags together.\n");
197 honorlevel = numarg("honor level", 0L, 10L);
204 case 'n': /* notify operators */
210 errx(X_STARTUP, "You cannot use the P and f "
211 "flags together.\n");
215 case 'r': /* store slightly less data to be friendly to rsync */
216 if (rsync_friendly < 1)
220 case 'R': /* store even less data to be friendlier to rsync */
221 if (rsync_friendly < 2)
225 case 'S': /* exit after estimating # of tapes */
229 case 's': /* tape size, feet */
230 tsize = numarg("tape size", 1L, 0L) * 12 * 10;
233 case 'T': /* time of last dump */
234 spcl.c_ddate = unctime(optarg);
235 if (spcl.c_ddate < 0) {
236 (void)fprintf(stderr, "bad time \"%s\"\n",
244 case 'u': /* update /etc/dumpdates */
248 case 'W': /* what to do */
251 exit(X_FINOK); /* do nothing else */
260 (void)fprintf(stderr, "Must specify disk or file system\n");
266 (void)fprintf(stderr, "Unknown arguments to dump:");
268 (void)fprintf(stderr, " %s", *argv++);
269 (void)fprintf(stderr, "\n");
272 if (rsync_friendly && (level > 0)) {
273 (void)fprintf(stderr, "%s %s\n", "rsync friendly options",
274 "can be used only with level 0 dumps.");
277 if (Tflag && uflag) {
278 (void)fprintf(stderr,
279 "You cannot use the T and u flags together.\n");
283 tape = "child pipeline process";
284 } else if (tape == NULL && (tape = getenv("TAPE")) == NULL)
285 tape = _PATH_DEFTAPE;
286 if (strcmp(tape, "-") == 0) {
288 tape = "standard output";
292 blocksperfile = rounddown(blocksperfile, ntrec);
293 else if (!unlimited) {
295 * Determine how to default tape size and density
298 * 9-track 1600 bpi (160 bytes/.1") 2300 ft.
299 * 9-track 6250 bpi (625 bytes/.1") 2300 ft.
300 * cartridge 8000 bpi (100 bytes/.1") 1700 ft.
302 * hilit19 hits again: "
305 density = cartridge ? 100 : 160;
307 tsize = cartridge ? 1700L*120L : 2300L*120L;
310 if (strchr(tape, ':')) {
312 tape = strchr(host, ':');
315 if (strchr(tape, '\n')) {
316 (void)fprintf(stderr, "invalid characters in tape\n");
319 if (rmthost(host) == 0)
322 (void)fprintf(stderr, "remote dump not enabled\n");
326 (void)setuid(getuid()); /* rmthost() is the only reason to be setuid */
328 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
330 if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
331 signal(SIGTRAP, sig);
332 if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
334 if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
336 if (signal(SIGSEGV, SIG_IGN) != SIG_IGN)
337 signal(SIGSEGV, sig);
338 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
339 signal(SIGTERM, sig);
340 if (signal(SIGINT, interrupt) == SIG_IGN)
341 signal(SIGINT, SIG_IGN);
343 dump_getfstab(); /* /etc/fstab snarfed */
345 * disk can be either the full special file name,
346 * the suffix of the special file name,
347 * the special name missing the leading '/',
348 * the file system name with or without the leading '/'.
350 dt = fstabsearch(disk);
352 disk = rawname(dt->fs_spec);
354 errx(X_STARTUP, "%s: unknown file system", dt->fs_spec);
355 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
356 (void)strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
358 (void)strncpy(spcl.c_dev, disk, NAMELEN);
359 (void)strncpy(spcl.c_filesys, "an unlisted file system",
362 spcl.c_dev[NAMELEN-1]='\0';
363 spcl.c_filesys[NAMELEN-1]='\0';
365 if ((mntpt = getmntpt(disk, &mntflags)) != NULL) {
366 if (mntflags & MNT_RDONLY) {
369 "-L ignored for read-only filesystem.");
372 } else if (snapdump == 0) {
374 "should use -L when dumping live read-write "
377 char snapname[BUFSIZ], snapcmd[BUFSIZ];
379 snprintf(snapname, sizeof snapname, "%s/.snap", mntpt);
380 if ((stat(snapname, &sb) < 0) || !S_ISDIR(sb.st_mode)) {
381 msg("WARNING: %s %s\n",
382 "-L requested but snapshot location",
385 "is not a directory",
386 "dump downgraded, -L ignored");
389 snprintf(snapname, sizeof snapname,
390 "%s/.snap/dump_snapshot", mntpt);
391 snprintf(snapcmd, sizeof snapcmd, "%s %s %s",
392 _PATH_MKSNAP_FFS, mntpt, snapname);
394 if (system(snapcmd) != 0)
395 errx(X_STARTUP, "Cannot create %s: %s\n",
396 snapname, strerror(errno));
397 if ((diskfd = open(snapname, O_RDONLY)) < 0) {
399 errx(X_STARTUP, "Cannot open %s: %s\n",
400 snapname, strerror(errno));
403 if (fstat(diskfd, &sb) != 0)
404 err(X_STARTUP, "%s: stat", snapname);
405 spcl.c_date = _time_to_time64(sb.st_mtime);
408 } else if (snapdump != 0) {
409 msg("WARNING: Cannot use -L on an unmounted filesystem.\n");
413 if ((diskfd = open(disk, O_RDONLY)) < 0)
414 err(X_STARTUP, "Cannot open %s", disk);
415 if (fstat(diskfd, &sb) != 0)
416 err(X_STARTUP, "%s: stat", disk);
417 if (S_ISDIR(sb.st_mode))
418 errx(X_STARTUP, "%s: unknown file system", disk);
421 (void)strcpy(spcl.c_label, "none");
422 (void)gethostname(spcl.c_host, NAMELEN);
423 spcl.c_level = level;
424 spcl.c_type = TS_TAPE;
425 if (rsync_friendly) {
426 /* don't store real dump times */
430 if (spcl.c_date == 0) {
431 tmsg = "the epoch\n";
433 time_t t = _time64_to_time(spcl.c_date);
436 msg("Date of this level %d dump: %s", level, tmsg);
438 if (!Tflag && (!rsync_friendly))
439 getdumptime(); /* /etc/dumpdates snarfed */
440 if (spcl.c_ddate == 0) {
441 tmsg = "the epoch\n";
443 time_t t = _time64_to_time(spcl.c_ddate);
447 msg("Date of last (level unknown) dump: %s", tmsg);
449 msg("Date of last level %d dump: %s", lastlevel, tmsg);
451 msg("Dumping %s%s ", snapdump ? "snapshot of ": "", disk);
453 msgtail("(%s) ", dt->fs_file);
455 msgtail("to %s on host %s\n", tape, host);
457 msgtail("to %s\n", tape);
460 if ((ret = sbget(diskfd, &sblock, UFS_STDSB, UFS_NOCSUM)) != 0) {
463 warn("Cannot find file system superblock");
466 warn("Unable to read file system superblock");
470 dev_bsize = sblock->fs_fsize / fsbtodb(sblock, 1);
471 dev_bshift = ffs(dev_bsize) - 1;
472 if (dev_bsize != (1 << dev_bshift))
473 quit("dev_bsize (%ld) is not a power of 2", dev_bsize);
474 tp_bshift = ffs(TP_BSIZE) - 1;
475 if (TP_BSIZE != (1 << tp_bshift))
476 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
477 maxino = sblock->fs_ipg * sblock->fs_ncg;
478 mapsize = roundup(howmany(maxino, CHAR_BIT), TP_BSIZE);
479 usedinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
480 dumpdirmap = (char *)calloc((unsigned) mapsize, sizeof(char));
481 dumpinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
482 tapesize = 3 * (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
484 nonodump = spcl.c_level < honorlevel;
487 setproctitle("%s: pass 1: regular files", disk);
488 msg("mapping (Pass I) [regular files]\n");
489 anydirskipped = mapfiles(maxino, &tapesize);
492 setproctitle("%s: pass 2: directories", disk);
493 msg("mapping (Pass II) [directories]\n");
494 while (anydirskipped) {
495 anydirskipped = mapdirs(maxino, &tapesize);
498 if (pipeout || unlimited) {
499 tapesize += 10; /* 10 trailer blocks */
500 msg("estimated %ld tape blocks.\n", tapesize);
505 fetapes = (double) tapesize / blocksperfile;
506 else if (cartridge) {
507 /* Estimate number of tapes, assuming streaming stops at
508 the end of each block written, and not in mid-block.
509 Assume no erroneous blocks; this can be compensated
510 for with an artificially low tape size. */
512 ( (double) tapesize /* blocks */
513 * TP_BSIZE /* bytes/block */
514 * (1.0/density) /* 0.1" / byte " */
516 (double) tapesize /* blocks */
517 * (1.0/ntrec) /* streaming-stops per block */
518 * 15.48 /* 0.1" / streaming-stop " */
519 ) * (1.0 / tsize ); /* tape / 0.1" " */
521 /* Estimate number of tapes, for old fashioned 9-track
523 int tenthsperirg = (density == 625) ? 3 : 7;
525 ( (double) tapesize /* blocks */
526 * TP_BSIZE /* bytes / block */
527 * (1.0/density) /* 0.1" / byte " */
529 (double) tapesize /* blocks */
530 * (1.0/ntrec) /* IRG's / block */
531 * tenthsperirg /* 0.1" / IRG " */
532 ) * (1.0 / tsize ); /* tape / 0.1" " */
534 etapes = fetapes; /* truncating assignment */
536 /* count the dumped inodes map on each additional tape */
537 tapesize += (etapes - 1) *
538 (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
539 tapesize += etapes + 10; /* headers + 10 trailer blks */
540 msg("estimated %ld tape blocks on %3.2f tape(s).\n",
545 * If the user only wants an estimate of the number of
552 * Allocate tape buffer.
556 "can't allocate tape buffers - try a smaller blocking factor.\n");
559 (void)time((time_t *)&(tstart_writing));
560 dumpmap(usedinomap, TS_CLRI, maxino - 1);
563 setproctitle("%s: pass 3: directories", disk);
564 msg("dumping (Pass III) [directories]\n");
565 dirty = 0; /* XXX just to get gcc to shut up */
566 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
567 if (((ino - 1) % CHAR_BIT) == 0) /* map is offset by 1 */
571 if ((dirty & 1) == 0)
574 * Skip directory inodes deleted and maybe reallocated
576 dp = getino(ino, &mode);
579 (void)dumpino(dp, ino);
583 setproctitle("%s: pass 4: regular files", disk);
584 msg("dumping (Pass IV) [regular files]\n");
585 for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
586 if (((ino - 1) % CHAR_BIT) == 0) /* map is offset by 1 */
590 if ((dirty & 1) == 0)
593 * Skip inodes deleted and reallocated as directories.
595 dp = getino(ino, &mode);
598 (void)dumpino(dp, ino);
601 (void)time((time_t *)&(tend_writing));
602 spcl.c_type = TS_END;
603 for (i = 0; i < ntrec; i++)
604 writeheader(maxino - 1);
606 msg("DUMP: %jd tape blocks\n", (intmax_t)spcl.c_tapea);
608 msg("DUMP: %jd tape blocks on %d volume%s\n",
609 (intmax_t)spcl.c_tapea, spcl.c_volume,
610 (spcl.c_volume == 1) ? "" : "s");
612 /* report dump performance, avoid division through zero */
613 if (tend_writing - tstart_writing == 0)
614 msg("finished in less than a second\n");
616 msg("finished in %jd seconds, throughput %jd KBytes/sec\n",
617 (intmax_t)tend_writing - tstart_writing,
618 (intmax_t)(spcl.c_tapea /
619 (tend_writing - tstart_writing)));
623 broadcast("DUMP IS DONE!\a\a\n");
624 msg("DUMP IS DONE\n");
633 "usage: dump [-0123456789acLnSu] [-B records] [-b blocksize] [-C cachesize]\n"
634 " [-D dumpdates] [-d density] [-f file | -P pipecommand] [-h level]\n"
635 " [-s feet] [-T date] filesystem\n"
641 * Check to see if a disk is currently mounted.
644 getmntpt(char *name, int *mntflagsp)
647 struct statfs *mntbuf;
649 mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
650 for (i = 0; i < mntsize; i++) {
651 if (!strcmp(mntbuf[i].f_mntfromname, name)) {
652 *mntflagsp = mntbuf[i].f_flags;
653 return (mntbuf[i].f_mntonname);
660 * Pick up a numeric argument. It must be nonnegative and in the given
661 * range (except that a vmax of 0 means unlimited).
664 numarg(const char *meaning, long vmin, long vmax)
669 val = strtol(optarg, &p, 10);
671 errx(1, "illegal %s -- %s", meaning, optarg);
672 if (val < vmin || (vmax && val > vmax))
673 errx(1, "%s must be between %ld and %ld", meaning, vmin, vmax);
688 quit("Signal on pipe: cannot recover\n");
689 msg("Rewriting attempted as response to unknown signal.\n");
690 (void)fflush(stderr);
691 (void)fflush(stdout);
696 msg("SIGSEGV: ABORTING!\n");
697 (void)signal(SIGSEGV, SIG_DFL);
698 (void)kill(0, SIGSEGV);
709 * Ensure that the device passed in is a raw device.
711 if (stat(cp, &sb) == 0 && (sb.st_mode & S_IFMT) == S_IFCHR)
715 * Since there's only one device type now, we can't construct any
716 * better name, so we have to return NULL.
723 * Change set of key letters and ordered arguments into something
724 * getopt(3) will like.
727 obsolete(int *argcp, char **argvp[])
730 char *ap, **argv, *flagsp, **nargv, *p;
737 * Return if no arguments or first argument has leading
741 if (argc == 1 || *ap == '-' || *ap == '/')
744 /* Allocate space for new arguments. */
745 if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
746 (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
752 for (flags = 0; *ap; ++ap) {
764 warnx("option requires an argument -- %c", *ap);
767 if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
771 (void)strcpy(&nargv[0][2], *argv);
785 /* Terminate flags. */
792 /* Copy remaining arguments. */
793 while ((*nargv++ = *argv++));
795 /* Update argument count. */
796 *argcp = nargv - *argvp - 1;