2 * Ported to Linux's Second Extended File System as part of the
3 * dump and restore backup suit
4 * Remy Card <card@Linux.EU.Org>, 1994-1997
5 * Stelian Pop <pop@cybercable.fr>, 1999-2000
9 * Copyright (c) 1980, 1991, 1993, 1994
10 * The Regents of the University of California. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the University of
23 * California, Berkeley and its contributors.
24 * 4. 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.
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
42 static const char rcsid[] =
43 "$Id: main.c,v 1.23 2000/08/19 23:48:10 stelian Exp $";
46 #include <sys/param.h>
49 #include <linux/ext2_fs.h>
51 #include <bsdcompat.h>
54 #include <sys/vnode.h>
56 #include <ufs/inode.h>
59 #include <ufs/ufs/dinode.h>
60 #include <ufs/ffs/fs.h>
64 #include <protocols/dumprestore.h>
67 #include <compaterr.h>
77 #include <ext2fs/ext2fs.h>
81 #include "pathnames.h"
84 #define SBOFF (SBLOCK * DEV_BSIZE)
87 int notify = 0; /* notify operator flag */
88 int blockswritten = 0; /* number of blocks written on current tape */
89 int tapeno = 0; /* current tape number */
90 int density = 0; /* density in bytes/0.1" " <- this is for hilit19 */
91 int ntrec = NTREC; /* # tape blocks in each tape record */
92 int cartridge = 0; /* Assume non-cartridge tape */
93 int dokerberos = 0; /* Use Kerberos authentication */
94 long dev_bsize = 1; /* recalculated below */
95 long blocksperfile; /* output blocks per file */
96 char *host = NULL; /* remote host (if any) */
97 int sizest = 0; /* return size estimate only */
103 int maxbsize = 64*1024; /* XXX MAXBSIZE from sys/param.h */
104 static long numarg __P((const char *, long, long));
105 static void obsolete __P((int *, char **[]));
106 static void usage __P((void));
108 ino_t iexclude_list[IEXCLUDE_MAXNUM]; /* the inode exclude list */
109 int iexclude_num = 0; /* number of elements in the list */
112 main(int argc, char *argv[])
116 register struct dinode *dp;
117 register struct fstab *dt;
120 int i, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
124 char directory[MAXPATHLEN];
125 char pathname[MAXPATHLEN];
128 char labelstr[LBLSIZE];
132 (void)time4(&spcl.c_date);
134 (void)time((time_t *)&spcl.c_date);
138 __progname = argv[0];
140 initialize_ext2_error_table();
143 tsize = 0; /* Default later, based on 'c' option for cart tapes */
145 if ((tapeprefix = getenv("TAPE")) == NULL)
146 tapeprefix = _PATH_DEFTAPE;
147 dumpdates = _PATH_DUMPDATES;
148 strcpy(labelstr, "none"); /* XXX safe strcpy. */
149 if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
150 quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
156 obsolete(&argc, &argv);
158 #define optstring "0123456789aB:b:cd:e:f:F:h:kL:Mns:ST:uWw"
160 #define optstring "0123456789aB:b:cd:e:f:F:h:L:Mns:ST:uWw"
162 while ((ch = getopt(argc, argv, optstring)) != -1)
166 case '0': case '1': case '2': case '3': case '4':
167 case '5': case '6': case '7': case '8': case '9':
171 case 'a': /* `auto-size', Write to EOM. */
175 case 'B': /* blocks per output file */
176 blocksperfile = numarg("number of blocks per file",
180 case 'b': /* blocks per tape write */
181 ntrec = numarg("number of blocks per write",
183 if (ntrec > maxbsize/1024) {
184 msg("Please choose a blocksize <= %dKB\n",
191 case 'c': /* Tape is cart. not 9-track */
195 case 'd': /* density, in bits per inch */
196 density = numarg("density", 10L, 327670L) / 10;
197 if (density >= 625 && !bflag)
198 ntrec = HIGHDENSITYTREC;
202 case 'e': /* exclude an inode */
203 iexclude_list[iexclude_num++] =
204 numarg("inode to exclude",0L,0L);
205 msg("Added %d to exclude list\n",
206 iexclude_list[iexclude_num-1]);
209 case 'f': /* output file */
213 case 'F': /* end of tape script */
218 honorlevel = numarg("honor level", 0L, 10L);
229 * Note that although there are LBLSIZE characters,
230 * the last must be '\0', so the limit on strlen()
231 * is really LBLSIZE-1.
233 strncpy(labelstr, optarg, LBLSIZE);
234 labelstr[LBLSIZE-1] = '\0';
235 if (strlen(optarg) > LBLSIZE-1) {
237 "WARNING Label `%s' is larger than limit of %d characters.\n",
239 msg("WARNING: Using truncated label `%s'.\n",
244 case 'M': /* multi-volume flag */
248 case 'n': /* notify operators */
252 case 's': /* tape size, feet */
253 tsize = numarg("tape size", 1L, 0L) * 12 * 10;
257 sizest = 1; /* return size estimate only */
260 case 'T': /* time of last dump */
261 spcl.c_ddate = unctime(optarg);
262 if (spcl.c_ddate < 0) {
263 (void)fprintf(stderr, "bad time \"%s\"\n",
271 case 'u': /* update dumpdates */
275 case 'W': /* what to do */
278 exit(X_FINOK); /* do nothing else */
287 (void)fprintf(stderr, "Must specify disk or filesystem\n");
291 if (strlen(disk) >= MAXPATHLEN) {
292 (void)fprintf(stderr, "Disk or filesystem name too long: %s\n", disk);
297 (void)fprintf(stderr, "Unknown arguments to dump:");
299 (void)fprintf(stderr, " %s", *argv++);
300 (void)fprintf(stderr, "\n");
303 if (Tflag && uflag) {
304 (void)fprintf(stderr,
305 "You cannot use the T and u flags together.\n");
308 if (strcmp(tapeprefix, "-") == 0) {
310 tapeprefix = "standard output";
314 blocksperfile = blocksperfile / ntrec * ntrec; /* round down */
315 else if (!unlimited) {
317 * Determine how to default tape size and density
320 * 9-track 1600 bpi (160 bytes/.1") 2300 ft.
321 * 9-track 6250 bpi (625 bytes/.1") 2300 ft.
322 * cartridge 8000 bpi (100 bytes/.1") 1700 ft.
324 * hilit19 hits again: "
327 density = cartridge ? 100 : 160;
329 tsize = cartridge ? 1700L*120L : 2300L*120L;
332 if (strchr(tapeprefix, ':')) {
334 tapeprefix = strchr(host, ':');
335 *tapeprefix++ = '\0';
337 if (index(tapeprefix, '\n')) {
338 (void)fprintf(stderr, "invalid characters in tape\n");
341 if (rmthost(host) == 0)
344 (void)fprintf(stderr, "remote dump not enabled\n");
348 (void)setuid(getuid()); /* rmthost() is the only reason to be setuid */
350 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
352 if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
353 signal(SIGTRAP, sig);
354 if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
356 if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
358 if (signal(SIGSEGV, SIG_IGN) != SIG_IGN)
359 signal(SIGSEGV, sig);
360 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
361 signal(SIGTERM, sig);
362 if (signal(SIGINT, interrupt) == SIG_IGN)
363 signal(SIGINT, SIG_IGN);
364 set_operators(); /* /etc/group snarfed */
365 getfstab(); /* /etc/fstab snarfed */
367 * disk may end in / and this can confuse
370 if (strlen(disk) > 1 && disk[strlen(disk) - 1] == '/')
371 disk[strlen(disk) - 1] = '\0';
373 * disk can be either the full special file name,
374 * the suffix of the special file name,
375 * the special name missing the leading '/',
376 * the file system name with or without the leading '/'.
378 if ((dt = fstabsearch(disk)) != NULL) {
379 disk = rawname(dt->fs_spec);
380 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
381 (void)strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
385 * The argument was not found in the fstab
386 * assume that this is a subtree and search for it
389 if (realpath(disk, pathname) == NULL)
391 strcpy(pathname, disk);
392 dt = fstabsearchdir(pathname, directory);
394 char name[MAXPATHLEN];
395 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
396 (void)snprintf(name, sizeof(name), "%s (dir %s)",
397 dt->fs_file, directory);
398 (void)strncpy(spcl.c_filesys, name, NAMELEN);
399 disk = rawname(dt->fs_spec);
401 (void)strncpy(spcl.c_dev, disk, NAMELEN);
402 (void)strncpy(spcl.c_filesys, "an unlisted file system",
408 (void)strncpy(spcl.c_dev, disk, NAMELEN);
409 (void)strncpy(spcl.c_filesys, "an unlisted file system",
414 if (directory[0] != 0) {
416 (void)fprintf(stderr, "Only level 0 dumps are allowed on a subdirectory\n");
420 (void)fprintf(stderr, "You can't update the dumpdates file when dumping a subdirectory\n");
425 spcl.c_dev[NAMELEN-1]='\0';
426 spcl.c_filesys[NAMELEN-1]='\0';
427 (void)strncpy(spcl.c_label, labelstr, sizeof(spcl.c_label) - 1);
428 (void)gethostname(spcl.c_host, NAMELEN);
429 spcl.c_level = level - '0';
430 spcl.c_type = TS_TAPE;
432 getdumptime(uflag); /* dumpdates snarfed */
434 if (spcl.c_ddate == 0 && spcl.c_level) {
435 msg("WARNING: There is no inferior level dump on this filesystem\n");
436 msg("WARNING: Assuming a level 0 dump by default\n");
442 snprintf(tape, MAXPATHLEN, "%s%03d", tapeprefix, tapeno + 1);
444 strncpy(tape, tapeprefix, MAXPATHLEN);
445 tape[MAXPATHLEN - 1] = '\0';
449 msg("Date of this level %c dump: %s", level,
451 spcl.c_date == 0 ? "the epoch\n" : ctime4(&spcl.c_date));
453 spcl.c_date == 0 ? "the epoch\n" : ctime(&spcl.c_date));
455 msg("Date of last level %c dump: %s", lastlevel,
457 spcl.c_ddate == 0 ? "the epoch\n" : ctime4(&spcl.c_ddate));
459 spcl.c_ddate == 0 ? "the epoch\n" : ctime(&spcl.c_ddate));
461 msg("Dumping %s (%s) ", disk, spcl.c_filesys);
463 msgtail("to %s on host %s\n", tape, host);
465 msgtail("to %s\n", tape);
466 msg("Label: %s\n", labelstr);
468 } /* end of size estimate */
471 retval = dump_fs_open(disk, &fs);
473 com_err(disk, retval, "while opening filesystem");
474 if (retval == EXT2_ET_REV_TOO_HIGH)
475 printf ("Get a newer version of dump!\n");
478 if (fs->super->s_rev_level > DUMP_CURRENT_REV) {
479 com_err(disk, retval, "while opening filesystem");
480 printf ("Get a newer version of dump!\n");
483 if ((diskfd = open(disk, O_RDONLY)) < 0) {
484 msg("Cannot open %s\n", disk);
488 dev_bsize = DEV_BSIZE;
489 dev_bshift = ffs(dev_bsize) - 1;
490 if (dev_bsize != (1 << dev_bshift))
491 quit("dev_bsize (%d) is not a power of 2", dev_bsize);
492 tp_bshift = ffs(TP_BSIZE) - 1;
493 if (TP_BSIZE != (1 << tp_bshift))
494 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
495 maxino = fs->super->s_inodes_count;
497 spcl.c_flags |= DR_NEWINODEFMT;
499 #else /* __linux __*/
500 if ((diskfd = open(disk, O_RDONLY)) < 0) {
501 msg("Cannot open %s\n", disk);
505 sblock = (struct fs *)sblock_buf;
506 bread(SBOFF, (char *) sblock, SBSIZE);
507 if (sblock->fs_magic != FS_MAGIC)
508 quit("bad sblock magic number\n");
509 dev_bsize = sblock->fs_fsize / fsbtodb(sblock, 1);
510 dev_bshift = ffs(dev_bsize) - 1;
511 if (dev_bsize != (1 << dev_bshift))
512 quit("dev_bsize (%d) is not a power of 2", dev_bsize);
513 tp_bshift = ffs(TP_BSIZE) - 1;
514 if (TP_BSIZE != (1 << tp_bshift))
515 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
517 if (sblock->fs_inodefmt >= FS_44INODEFMT)
518 spcl.c_flags |= DR_NEWINODEFMT;
520 maxino = sblock->fs_ipg * sblock->fs_ncg;
521 #endif /* __linux__ */
522 mapsize = roundup(howmany(maxino, NBBY), TP_BSIZE);
523 usedinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
524 dumpdirmap = (char *)calloc((unsigned) mapsize, sizeof(char));
525 dumpinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
526 tapesize = 2 * (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
528 nonodump = spcl.c_level < honorlevel;
531 (void)signal(SIGINFO, statussig);
535 msg("mapping (Pass I) [regular files]\n");
537 if (directory[0] == 0)
538 anydirskipped = mapfiles(maxino, &tapesize);
540 anydirskipped = mapfilesfromdir(maxino, &tapesize, directory);
542 anydirskipped = mapfiles(maxino, &tapesize);
546 msg("mapping (Pass II) [directories]\n");
547 while (anydirskipped) {
548 anydirskipped = mapdirs(maxino, &tapesize);
552 printf("%.0f\n", ((double)tapesize + 11) * TP_BSIZE);
554 } /* stop here for size estimate */
556 if (pipeout || unlimited) {
557 tapesize += 11; /* 10 trailer blocks + 1 map header */
558 msg("estimated %ld tape blocks.\n", tapesize);
563 fetapes = (double) tapesize / blocksperfile;
564 else if (cartridge) {
565 /* Estimate number of tapes, assuming streaming stops at
566 the end of each block written, and not in mid-block.
567 Assume no erroneous blocks; this can be compensated
568 for with an artificially low tape size. */
570 ( (double) tapesize /* blocks */
571 * TP_BSIZE /* bytes/block */
572 * (1.0/density) /* 0.1" / byte " */
574 (double) tapesize /* blocks */
575 * (1.0/ntrec) /* streaming-stops per block */
576 * 15.48 /* 0.1" / streaming-stop " */
577 ) * (1.0 / tsize ); /* tape / 0.1" " */
579 /* Estimate number of tapes, for old fashioned 9-track
581 int tenthsperirg = (density == 625) ? 3 : 7;
583 ( (double) tapesize /* blocks */
584 * TP_BSIZE /* bytes / block */
585 * (1.0/density) /* 0.1" / byte " */
587 (double) tapesize /* blocks */
588 * (1.0/ntrec) /* IRG's / block */
589 * tenthsperirg /* 0.1" / IRG " */
590 ) * (1.0 / tsize ); /* tape / 0.1" " */
592 etapes = fetapes; /* truncating assignment */
594 /* count the dumped inodes map on each additional tape */
595 tapesize += (etapes - 1) *
596 (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
597 tapesize += etapes + 10; /* headers + 10 trailer blks */
598 msg("estimated %ld tape blocks on %3.2f tape(s).\n",
603 * Allocate tape buffer.
607 "can't allocate tape buffers - try a smaller blocking factor.\n");
611 (void)time4(&(tstart_writing));
613 (void)time((time_t *)&(tstart_writing));
615 dumpmap(usedinomap, TS_CLRI, maxino - 1);
617 msg("dumping (Pass III) [directories]\n");
618 dirty = 0; /* XXX just to get gcc to shut up */
619 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
620 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
624 if ((dirty & 1) == 0)
627 * Skip directory inodes deleted and maybe reallocated
630 if ((dp->di_mode & IFMT) != IFDIR)
634 * Skip directory inodes deleted and not yes reallocated...
636 if (dp->di_nlink == 0 || dp->di_dtime != 0)
638 (void)dumpdirino(dp, ino);
640 (void)dumpino(dp, ino);
644 msg("dumping (Pass IV) [regular files]\n");
645 for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
646 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
650 if ((dirty & 1) == 0)
653 * Skip inodes deleted and reallocated as directories.
656 if ((dp->di_mode & IFMT) == IFDIR)
660 * No need to check here for deleted and not yes reallocated inodes
661 * since this is done in dumpino().
664 (void)dumpino(dp, ino);
668 (void)time4(&(tend_writing));
670 (void)time((time_t *)&(tend_writing));
672 spcl.c_type = TS_END;
673 for (i = 0; i < ntrec; i++)
674 writeheader(maxino - 1);
679 msg("%ld tape blocks (%.2fMB)\n", spcl.c_tapea,
680 ((double)spcl.c_tapea * TP_BSIZE / 1048576));
682 msg("%ld tape blocks (%.2fMB) on %d volume(s)\n",
684 ((double)spcl.c_tapea * TP_BSIZE / 1048576),
687 /* report dump performance, avoid division through zero */
688 if (tend_writing - tstart_writing == 0)
689 msg("finished in less than a second\n");
691 msg("finished in %d seconds, throughput %d KBytes/sec\n",
692 tend_writing - tstart_writing,
693 spcl.c_tapea / (tend_writing - tstart_writing));
697 msg("Date of this level %c dump: %s", level,
698 spcl.c_date == 0 ? "the epoch\n" : ctime4(&spcl.c_date));
700 msg("Date of this level %c dump: %s", level,
701 spcl.c_date == 0 ? "the epoch\n" : ctime(&spcl.c_date));
703 msg("Date this dump completed: %s", ctime(&tnow));
705 msg("Average transfer rate: %ld KB/s\n", xferrate / tapeno);
707 broadcast("DUMP IS DONE!\7\7\n");
708 msg("DUMP IS DONE\n");
711 return 0; /* gcc - shut up */
717 char white[MAXPATHLEN];
720 strncpy(white, __progname, MAXPATHLEN-1);
721 white[MAXPATHLEN-1] = '\0';
722 for (i=0; i<MAXPATHLEN; ++i)
723 if (white[i] != '\0') white[i] = ' ';
726 "%s %s\n", __progname, _DUMP_VERSION);
728 "usage:\t%s [-0123456789ac"
732 "MnSu] [-B records] [-b blocksize] [-d density]\n"
733 "\t%s [-e inode#] [-f file] [-h level] [-s feet] [-T date] filesystem\n"
734 "\t%s [-W | -w]\n", __progname, white, __progname);
739 * Pick up a numeric argument. It must be nonnegative and in the given
740 * range (except that a vmax of 0 means unlimited).
743 numarg(const char *meaning, long vmin, long vmax)
748 val = strtol(optarg, &p, 10);
750 errx(X_STARTUP, "illegal %s -- %s", meaning, optarg);
751 if (val < vmin || (vmax && val > vmax))
752 errx(X_STARTUP, "%s must be between %ld and %ld", meaning, vmin, vmax);
767 quit("Signal on pipe: cannot recover\n");
768 msg("Rewriting attempted as response to unknown signal.\n");
769 (void)fflush(stderr);
770 (void)fflush(stdout);
775 msg("SIGSEGV: ABORTING!\n");
776 (void)signal(SIGSEGV, SIG_DFL);
777 (void)kill(0, SIGSEGV);
787 #else /* __linux__ */
788 static char rawbuf[MAXPATHLEN];
789 char *dp = strrchr(cp, '/');
794 (void)strncpy(rawbuf, cp, MAXPATHLEN - 1);
795 rawbuf[MAXPATHLEN-1] = '\0';
797 (void)strncat(rawbuf, "/r", MAXPATHLEN - 1 - strlen(rawbuf));
798 (void)strncat(rawbuf, dp + 1, MAXPATHLEN - 1 - strlen(rawbuf));
800 #endif /* __linux__ */
805 * Change set of key letters and ordered arguments into something
806 * getopt(3) will like.
809 obsolete(int *argcp, char **argvp[])
812 char *ap, **argv, *flagsp=NULL, **nargv, *p=NULL;
818 /* Return if no arguments or first argument has leading dash. */
820 if (argc == 1 || *ap == '-')
823 /* Allocate space for new arguments. */
824 if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
825 (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
826 err(X_STARTUP, "malloc new args");
831 for (flags = 0; *ap; ++ap) {
844 warnx("option requires an argument -- %c", *ap);
847 if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
848 err(X_STARTUP, "malloc arg");
851 (void)strcpy(&nargv[0][2], *argv);
865 /* Terminate flags. */
871 /* Copy remaining arguments. */
872 while ((*nargv++ = *argv++));
874 /* Update argument count. */
875 *argcp = nargv - *argvp - 1;