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.27 2000/11/10 13:22: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"
85 #define SBOFF (SBLOCK * DEV_BSIZE)
88 int notify = 0; /* notify operator flag */
89 int blockswritten = 0; /* number of blocks written on current tape */
90 int tapeno = 0; /* current tape number */
91 int density = 0; /* density in bytes/0.1" " <- this is for hilit19 */
92 int ntrec = NTREC; /* # tape blocks in each tape record */
93 int cartridge = 0; /* Assume non-cartridge tape */
94 int dokerberos = 0; /* Use Kerberos authentication */
95 long dev_bsize = 1; /* recalculated below */
96 long blocksperfile; /* output blocks per file */
97 char *host = NULL; /* remote host (if any) */
98 int sizest = 0; /* return size estimate only */
104 int maxbsize = 64*1024; /* XXX MAXBSIZE from sys/param.h */
105 static long numarg __P((const char *, long, long));
106 static void obsolete __P((int *, char **[]));
107 static void usage __P((void));
109 ino_t iexclude_list[IEXCLUDE_MAXNUM]; /* the inode exclude list */
110 int iexclude_num = 0; /* number of elements in the list */
113 main(int argc, char *argv[])
117 register struct dinode *dp;
118 register struct fstab *dt;
121 int i, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
125 char directory[MAXPATHLEN];
126 char pathname[MAXPATHLEN];
129 char labelstr[LBLSIZE];
134 (void)time4(&spcl.c_date);
136 (void)time((time_t *)&spcl.c_date);
140 __progname = argv[0];
142 initialize_ext2_error_table();
145 tsize = 0; /* Default later, based on 'c' option for cart tapes */
148 if ((tapeprefix = getenv("TAPE")) == NULL)
149 tapeprefix = _PATH_DEFTAPE;
150 dumpdates = _PATH_DUMPDATES;
151 strcpy(labelstr, "none"); /* XXX safe strcpy. */
152 if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
153 quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
159 obsolete(&argc, &argv);
161 #define optstring "0123456789aB:b:cd:e:f:F:h:kL:Mns:ST:uWw"
163 #define optstring "0123456789aB:b:cd:e:f:F:h:L:Mns:ST:uWw"
165 while ((ch = getopt(argc, argv, optstring)) != -1)
169 case '0': case '1': case '2': case '3': case '4':
170 case '5': case '6': case '7': case '8': case '9':
174 case 'a': /* `auto-size', Write to EOM. */
178 case 'B': /* blocks per output file */
180 blocksperfile = numarg("number of blocks per file",
184 case 'b': /* blocks per tape write */
185 ntrec = numarg("number of blocks per write",
187 if (ntrec > maxbsize/1024) {
188 msg("Please choose a blocksize <= %dKB\n",
195 case 'c': /* Tape is cart. not 9-track */
200 case 'd': /* density, in bits per inch */
202 density = numarg("density", 10L, 327670L) / 10;
203 if (density >= 625 && !bflag)
204 ntrec = HIGHDENSITYTREC;
208 case 'e': /* exclude an inode */
209 if (iexclude_num == IEXCLUDE_MAXNUM) {
210 (void)fprintf(stderr, "Too many -e options\n");
213 iexclude_list[iexclude_num++] = numarg("inode to exclude",0L,0L);
214 if (iexclude_list[iexclude_num-1] <= ROOTINO) {
215 (void)fprintf(stderr, "Cannot exclude inode %ld\n", iexclude_list[iexclude_num-1]);
218 msg("Added %d to exclude list\n",
219 iexclude_list[iexclude_num-1]);
222 case 'f': /* output file */
226 case 'F': /* end of tape script */
231 honorlevel = numarg("honor level", 0L, 10L);
242 * Note that although there are LBLSIZE characters,
243 * the last must be '\0', so the limit on strlen()
244 * is really LBLSIZE-1.
246 strncpy(labelstr, optarg, LBLSIZE);
247 labelstr[LBLSIZE-1] = '\0';
248 if (strlen(optarg) > LBLSIZE-1) {
250 "WARNING Label `%s' is larger than limit of %d characters.\n",
252 msg("WARNING: Using truncated label `%s'.\n",
257 case 'M': /* multi-volume flag */
261 case 'n': /* notify operators */
265 case 's': /* tape size, feet */
267 tsize = numarg("tape size", 1L, 0L) * 12 * 10;
271 sizest = 1; /* return size estimate only */
274 case 'T': /* time of last dump */
275 spcl.c_ddate = unctime(optarg);
276 if (spcl.c_ddate < 0) {
277 (void)fprintf(stderr, "bad time \"%s\"\n",
285 case 'u': /* update dumpdates */
289 case 'W': /* what to do */
292 exit(X_FINOK); /* do nothing else */
301 (void)fprintf(stderr, "Must specify disk or filesystem\n");
305 if (strlen(diskparam) >= MAXPATHLEN) {
306 (void)fprintf(stderr, "Disk or filesystem name too long: %s\n", diskparam);
311 (void)fprintf(stderr, "Unknown arguments to dump:");
313 (void)fprintf(stderr, " %s", *argv++);
314 (void)fprintf(stderr, "\n");
317 if (Tflag && uflag) {
318 (void)fprintf(stderr,
319 "You cannot use the T and u flags together.\n");
322 if (strcmp(tapeprefix, "-") == 0) {
324 tapeprefix = "standard output";
328 blocksperfile = blocksperfile / ntrec * ntrec; /* round down */
329 else if (!unlimited) {
331 * Determine how to default tape size and density
334 * 9-track 1600 bpi (160 bytes/.1") 2300 ft.
335 * 9-track 6250 bpi (625 bytes/.1") 2300 ft.
336 * cartridge 8000 bpi (100 bytes/.1") 1700 ft.
338 * hilit19 hits again: "
341 density = cartridge ? 100 : 160;
343 tsize = cartridge ? 1700L*120L : 2300L*120L;
346 if (strchr(tapeprefix, ':')) {
348 tapeprefix = strchr(host, ':');
349 *tapeprefix++ = '\0';
351 if (index(tapeprefix, '\n')) {
352 (void)fprintf(stderr, "invalid characters in tape\n");
355 if (rmthost(host) == 0)
358 (void)fprintf(stderr, "remote dump not enabled\n");
362 (void)setuid(getuid()); /* rmthost() is the only reason to be setuid */
364 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
366 if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
367 signal(SIGTRAP, sig);
368 if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
370 if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
372 if (signal(SIGSEGV, SIG_IGN) != SIG_IGN)
373 signal(SIGSEGV, sig);
374 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
375 signal(SIGTERM, sig);
376 if (signal(SIGINT, interrupt) == SIG_IGN)
377 signal(SIGINT, SIG_IGN);
378 set_operators(); /* /etc/group snarfed */
379 getfstab(); /* /etc/fstab snarfed */
381 disk = get_device_name(diskparam);
382 if (!disk) { /* null means the disk is some form
383 of LABEL= or UID= but it was not
385 msg("Cannot find a disk having %s\n", diskparam);
389 * disk may end in / and this can confuse
392 if (strlen(disk) > 1 && disk[strlen(disk) - 1] == '/')
393 disk[strlen(disk) - 1] = '\0';
395 * disk can be either the full special file name,
396 * the suffix of the special file name,
397 * the special name missing the leading '/',
398 * the file system name with or without the leading '/'.
400 if ((dt = fstabsearch(disk)) != NULL) {
401 disk = rawname(dt->fs_spec);
402 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
403 (void)strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
407 if (realpath(disk, pathname) == NULL)
409 strcpy(pathname, disk);
411 * The argument could be now a mountpoint of
412 * a filesystem specified in fstab. Search for it.
414 if ((dt = fstabsearch(pathname)) != NULL) {
415 disk = rawname(dt->fs_spec);
416 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
417 (void)strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
420 * The argument was not found in the fstab
421 * assume that this is a subtree and search for it
423 dt = fstabsearchdir(pathname, directory);
425 char name[MAXPATHLEN];
426 (void)strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
427 (void)snprintf(name, sizeof(name), "%s (dir %s)",
428 dt->fs_file, directory);
429 (void)strncpy(spcl.c_filesys, name, NAMELEN);
430 disk = rawname(dt->fs_spec);
432 (void)strncpy(spcl.c_dev, disk, NAMELEN);
433 (void)strncpy(spcl.c_filesys, "an unlisted file system",
440 (void)strncpy(spcl.c_dev, disk, NAMELEN);
441 (void)strncpy(spcl.c_filesys, "an unlisted file system",
446 if (directory[0] != 0) {
448 (void)fprintf(stderr, "Only level 0 dumps are allowed on a subdirectory\n");
452 (void)fprintf(stderr, "You can't update the dumpdates file when dumping a subdirectory\n");
456 spcl.c_dev[NAMELEN-1]='\0';
457 spcl.c_filesys[NAMELEN-1]='\0';
458 (void)strncpy(spcl.c_label, labelstr, sizeof(spcl.c_label) - 1);
459 (void)gethostname(spcl.c_host, NAMELEN);
460 spcl.c_level = level - '0';
461 spcl.c_type = TS_TAPE;
463 getdumptime(uflag); /* dumpdates snarfed */
465 if (spcl.c_ddate == 0 && spcl.c_level) {
466 msg("WARNING: There is no inferior level dump on this filesystem\n");
467 msg("WARNING: Assuming a level 0 dump by default\n");
473 snprintf(tape, MAXPATHLEN, "%s%03d", tapeprefix, tapeno + 1);
475 strncpy(tape, tapeprefix, MAXPATHLEN);
476 tape[MAXPATHLEN - 1] = '\0';
480 msg("Date of this level %c dump: %s", level,
482 spcl.c_date == 0 ? "the epoch\n" : ctime4(&spcl.c_date));
484 spcl.c_date == 0 ? "the epoch\n" : ctime(&spcl.c_date));
486 msg("Date of last level %c dump: %s", lastlevel,
488 spcl.c_ddate == 0 ? "the epoch\n" : ctime4(&spcl.c_ddate));
490 spcl.c_ddate == 0 ? "the epoch\n" : ctime(&spcl.c_ddate));
492 msg("Dumping %s (%s) ", disk, spcl.c_filesys);
494 msgtail("to %s on host %s\n", tape, host);
496 msgtail("to %s\n", tape);
497 msg("Label: %s\n", labelstr);
499 } /* end of size estimate */
502 retval = dump_fs_open(disk, &fs);
504 com_err(disk, retval, "while opening filesystem");
505 if (retval == EXT2_ET_REV_TOO_HIGH)
506 printf ("Get a newer version of dump!\n");
509 if (fs->super->s_rev_level > DUMP_CURRENT_REV) {
510 com_err(disk, retval, "while opening filesystem");
511 printf ("Get a newer version of dump!\n");
514 if ((diskfd = open(disk, O_RDONLY)) < 0) {
515 msg("Cannot open %s\n", disk);
519 dev_bsize = DEV_BSIZE;
520 dev_bshift = ffs(dev_bsize) - 1;
521 if (dev_bsize != (1 << dev_bshift))
522 quit("dev_bsize (%d) is not a power of 2", dev_bsize);
523 tp_bshift = ffs(TP_BSIZE) - 1;
524 if (TP_BSIZE != (1 << tp_bshift))
525 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
526 maxino = fs->super->s_inodes_count;
528 spcl.c_flags |= DR_NEWINODEFMT;
530 #else /* __linux __*/
531 if ((diskfd = open(disk, O_RDONLY)) < 0) {
532 msg("Cannot open %s\n", disk);
536 sblock = (struct fs *)sblock_buf;
537 bread(SBOFF, (char *) sblock, SBSIZE);
538 if (sblock->fs_magic != FS_MAGIC)
539 quit("bad sblock magic number\n");
540 dev_bsize = sblock->fs_fsize / fsbtodb(sblock, 1);
541 dev_bshift = ffs(dev_bsize) - 1;
542 if (dev_bsize != (1 << dev_bshift))
543 quit("dev_bsize (%d) is not a power of 2", dev_bsize);
544 tp_bshift = ffs(TP_BSIZE) - 1;
545 if (TP_BSIZE != (1 << tp_bshift))
546 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
548 if (sblock->fs_inodefmt >= FS_44INODEFMT)
549 spcl.c_flags |= DR_NEWINODEFMT;
551 maxino = sblock->fs_ipg * sblock->fs_ncg;
552 #endif /* __linux__ */
553 mapsize = roundup(howmany(maxino, NBBY), TP_BSIZE);
554 usedinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
555 dumpdirmap = (char *)calloc((unsigned) mapsize, sizeof(char));
556 dumpinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
557 tapesize = 2 * (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
559 nonodump = spcl.c_level < honorlevel;
562 (void)signal(SIGINFO, statussig);
566 msg("mapping (Pass I) [regular files]\n");
568 if (directory[0] == 0)
569 anydirskipped = mapfiles(maxino, &tapesize);
571 anydirskipped = mapfilesfromdir(maxino, &tapesize, directory);
573 anydirskipped = mapfiles(maxino, &tapesize);
577 msg("mapping (Pass II) [directories]\n");
578 while (anydirskipped) {
579 anydirskipped = mapdirs(maxino, &tapesize);
583 printf("%.0f\n", ((double)tapesize + 11) * TP_BSIZE);
585 } /* stop here for size estimate */
587 if (pipeout || unlimited) {
588 tapesize += 11; /* 10 trailer blocks + 1 map header */
589 msg("estimated %ld tape blocks.\n", tapesize);
594 fetapes = (double) tapesize / blocksperfile;
595 else if (cartridge) {
596 /* Estimate number of tapes, assuming streaming stops at
597 the end of each block written, and not in mid-block.
598 Assume no erroneous blocks; this can be compensated
599 for with an artificially low tape size. */
601 ( (double) tapesize /* blocks */
602 * TP_BSIZE /* bytes/block */
603 * (1.0/density) /* 0.1" / byte " */
605 (double) tapesize /* blocks */
606 * (1.0/ntrec) /* streaming-stops per block */
607 * 15.48 /* 0.1" / streaming-stop " */
608 ) * (1.0 / tsize ); /* tape / 0.1" " */
610 /* Estimate number of tapes, for old fashioned 9-track
612 int tenthsperirg = (density == 625) ? 3 : 7;
614 ( (double) tapesize /* blocks */
615 * TP_BSIZE /* bytes / block */
616 * (1.0/density) /* 0.1" / byte " */
618 (double) tapesize /* blocks */
619 * (1.0/ntrec) /* IRG's / block */
620 * tenthsperirg /* 0.1" / IRG " */
621 ) * (1.0 / tsize ); /* tape / 0.1" " */
623 etapes = fetapes; /* truncating assignment */
625 /* count the dumped inodes map on each additional tape */
626 tapesize += (etapes - 1) *
627 (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
628 tapesize += etapes + 10; /* headers + 10 trailer blks */
629 msg("estimated %ld tape blocks on %3.2f tape(s).\n",
634 * Allocate tape buffer.
638 "can't allocate tape buffers - try a smaller blocking factor.\n");
642 (void)time4(&(tstart_writing));
644 (void)time((time_t *)&(tstart_writing));
646 dumpmap(usedinomap, TS_CLRI, maxino - 1);
648 msg("dumping (Pass III) [directories]\n");
649 dirty = 0; /* XXX just to get gcc to shut up */
650 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
651 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
655 if ((dirty & 1) == 0)
658 * Skip directory inodes deleted and maybe reallocated
661 if ((dp->di_mode & IFMT) != IFDIR)
665 * Skip directory inodes deleted and not yes reallocated...
667 if (dp->di_nlink == 0 || dp->di_dtime != 0)
669 (void)dumpdirino(dp, ino);
671 (void)dumpino(dp, ino);
675 msg("dumping (Pass IV) [regular files]\n");
676 for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
677 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
681 if ((dirty & 1) == 0)
684 * Skip inodes deleted and reallocated as directories.
687 if ((dp->di_mode & IFMT) == IFDIR)
691 * No need to check here for deleted and not yes reallocated inodes
692 * since this is done in dumpino().
695 (void)dumpino(dp, ino);
699 (void)time4(&(tend_writing));
701 (void)time((time_t *)&(tend_writing));
703 spcl.c_type = TS_END;
704 for (i = 0; i < ntrec; i++)
705 writeheader(maxino - 1);
710 msg("%ld tape blocks (%.2fMB)\n", spcl.c_tapea,
711 ((double)spcl.c_tapea * TP_BSIZE / 1048576));
713 msg("%ld tape blocks (%.2fMB) on %d volume(s)\n",
715 ((double)spcl.c_tapea * TP_BSIZE / 1048576),
718 /* report dump performance, avoid division through zero */
719 if (tend_writing - tstart_writing == 0)
720 msg("finished in less than a second\n");
722 msg("finished in %d seconds, throughput %d KBytes/sec\n",
723 tend_writing - tstart_writing,
724 spcl.c_tapea / (tend_writing - tstart_writing));
728 msg("Date of this level %c dump: %s", level,
729 spcl.c_date == 0 ? "the epoch\n" : ctime4(&spcl.c_date));
731 msg("Date of this level %c dump: %s", level,
732 spcl.c_date == 0 ? "the epoch\n" : ctime(&spcl.c_date));
734 msg("Date this dump completed: %s", ctime(&tnow));
736 msg("Average transfer rate: %ld KB/s\n", xferrate / tapeno);
738 broadcast("DUMP IS DONE!\7\7\n");
739 msg("DUMP IS DONE\n");
742 return 0; /* gcc - shut up */
748 char white[MAXPATHLEN];
751 strncpy(white, __progname, MAXPATHLEN-1);
752 white[MAXPATHLEN-1] = '\0';
753 for (i=0; i<MAXPATHLEN; ++i)
754 if (white[i] != '\0') white[i] = ' ';
757 "%s %s\n", __progname, _DUMP_VERSION);
759 "usage:\t%s [-0123456789ac"
763 "MnSu] [-B records] [-b blocksize] [-d density]\n"
764 "\t%s [-e inode#] [-f file] [-h level] [-s feet] [-T date] filesystem\n"
765 "\t%s [-W | -w]\n", __progname, white, __progname);
770 * Pick up a numeric argument. It must be nonnegative and in the given
771 * range (except that a vmax of 0 means unlimited).
774 numarg(const char *meaning, long vmin, long vmax)
779 val = strtol(optarg, &p, 10);
781 errx(X_STARTUP, "illegal %s -- %s", meaning, optarg);
782 if (val < vmin || (vmax && val > vmax))
783 errx(X_STARTUP, "%s must be between %ld and %ld", meaning, vmin, vmax);
798 quit("Signal on pipe: cannot recover\n");
799 msg("Rewriting attempted as response to unknown signal.\n");
800 (void)fflush(stderr);
801 (void)fflush(stdout);
806 msg("SIGSEGV: ABORTING!\n");
807 (void)signal(SIGSEGV, SIG_DFL);
808 (void)kill(0, SIGSEGV);
818 #else /* __linux__ */
819 static char rawbuf[MAXPATHLEN];
820 char *dp = strrchr(cp, '/');
825 (void)strncpy(rawbuf, cp, MAXPATHLEN - 1);
826 rawbuf[MAXPATHLEN-1] = '\0';
828 (void)strncat(rawbuf, "/r", MAXPATHLEN - 1 - strlen(rawbuf));
829 (void)strncat(rawbuf, dp + 1, MAXPATHLEN - 1 - strlen(rawbuf));
831 #endif /* __linux__ */
836 * Change set of key letters and ordered arguments into something
837 * getopt(3) will like.
840 obsolete(int *argcp, char **argvp[])
843 char *ap, **argv, *flagsp=NULL, **nargv, *p=NULL;
849 /* Return if no arguments or first argument has leading dash. */
851 if (argc == 1 || *ap == '-')
854 /* Allocate space for new arguments. */
855 if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
856 (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
857 err(X_STARTUP, "malloc new args");
862 for (flags = 0; *ap; ++ap) {
875 warnx("option requires an argument -- %c", *ap);
878 if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
879 err(X_STARTUP, "malloc arg");
882 (void)strcpy(&nargv[0][2], *argv);
896 /* Terminate flags. */
902 /* Copy remaining arguments. */
903 while ((*nargv++ = *argv++));
905 /* Update argument count. */
906 *argcp = nargv - *argvp - 1;