2 * Copyright (c) 1980, 1991, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
33 * @(#) Copyright (c) 1980, 1991, 1993, 1994 The Regents of the University of California. All rights reserved.
34 * @(#)main.c 8.6 (Berkeley) 5/1/95
35 * $FreeBSD: src/sbin/dump/main.c,v 1.20.2.9 2003/01/25 18:54:59 dillon Exp $
36 * $DragonFly: src/sbin/dump/main.c,v 1.9 2004/12/27 22:36:37 liamfoy Exp $
39 #include <sys/param.h>
43 #include <sys/vnode.h>
45 #include <ufs/inode.h>
48 #include <vfs/ufs/dinode.h>
49 #include <vfs/ufs/fs.h>
52 #include <protocols/dumprestore.h>
65 #include "pathnames.h"
68 #define SBOFF (SBLOCK * DEV_BSIZE)
71 int notify = 0; /* notify operator flag */
72 int blockswritten = 0; /* number of blocks written on current tape */
73 int tapeno = 0; /* current tape number */
74 int density = 0; /* density in bytes/0.1" " <- this is for hilit19 */
75 int ntrec = NTREC; /* # tape blocks in each tape record */
76 int cartridge = 0; /* Assume non-cartridge tape */
77 int dokerberos = 0; /* Use Kerberos authentication */
78 int cachesize = 0; /* block cache size (in bytes) */
79 long dev_bsize = 1; /* recalculated below */
80 long blocksperfile; /* output blocks per file */
81 char *host = NULL; /* remote host (if any) */
83 static long numarg(char *, long, long);
84 static void obsolete(int *, char **[]);
85 static void usage(void);
88 main(int argc, char **argv)
97 int i, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
98 int just_estimate = 0;
102 time((time_t *)&spcl.c_date);
104 tsize = 0; /* Default later, based on 'c' option for cart tapes */
105 if ((tape = getenv("TAPE")) == NULL)
106 tape = _PATH_DEFTAPE;
107 dumpdates = _PATH_DUMPDATES;
109 if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
110 quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
116 obsolete(&argc, &argv);
118 #define optstring "0123456789aB:b:cd:f:h:kns:ST:uWwD:C:"
120 #define optstring "0123456789aB:b:cd:f:h:ns:ST:uWwD:C:"
122 while ((ch = getopt(argc, argv, optstring)) != -1)
126 case '0': case '1': case '2': case '3': case '4':
127 case '5': case '6': case '7': case '8': case '9':
131 case 'a': /* `auto-size', Write to EOM. */
135 case 'B': /* blocks per output file */
136 blocksperfile = numarg("number of blocks per file",
140 case 'b': /* blocks per tape write */
141 ntrec = numarg("number of blocks per write",
145 case 'c': /* Tape is cart. not 9-track */
149 case 'd': /* density, in bits per inch */
150 density = numarg("density", 10L, 327670L) / 10;
151 if (density >= 625 && !bflag)
152 ntrec = HIGHDENSITYTREC;
155 case 'f': /* output file */
164 cachesize = numarg("cachesize", 0, 0) * 1024 * 1024;
168 honorlevel = numarg("honor level", 0L, 10L);
177 case 'n': /* notify operators */
181 case 's': /* tape size, feet */
182 tsize = numarg("tape size", 1L, 0L) * 12 * 10;
185 case 'S': /* exit after estimating # of tapes */
189 case 'T': /* time of last dump */
190 spcl.c_ddate = unctime(optarg);
191 if (spcl.c_ddate < 0) {
192 fprintf(stderr, "bad time \"%s\"\n", optarg);
199 case 'u': /* update /etc/dumpdates */
203 case 'W': /* what to do */
206 exit(X_FINOK); /* do nothing else */
215 fprintf(stderr, "Must specify disk or filesystem\n");
221 fprintf(stderr, "Unknown arguments to dump:");
223 fprintf(stderr, " %s", *argv++);
224 fprintf(stderr, "\n");
227 if (Tflag && uflag) {
228 fprintf(stderr, "You cannot use the T and u flags together.\n");
231 if (strcmp(tape, "-") == 0) {
233 tape = "standard output";
237 blocksperfile = blocksperfile / ntrec * ntrec; /* round down */
238 else if (!unlimited) {
240 * Determine how to default tape size and density
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.
247 * hilit19 hits again: "
250 density = cartridge ? 100 : 160;
252 tsize = cartridge ? 1700L*120L : 2300L*120L;
255 if (strchr(tape, ':')) {
257 tape = strchr(host, ':');
260 if (strchr(tape, '\n')) {
261 fprintf(stderr, "invalid characters in tape\n");
264 if (rmthost(host) == 0)
267 fprintf(stderr, "remote dump not enabled\n");
271 setuid(getuid()); /* rmthost() is the only reason to be setuid */
273 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
275 if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
276 signal(SIGTRAP, sig);
277 if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
279 if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
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);
288 getfstab(); /* /etc/fstab snarfed */
290 * disk can be either the full special file name,
291 * the suffix of the special file name,
292 * the special name missing the leading '/',
293 * the file system name with or without the leading '/'.
295 dt = fstabsearch(disk);
297 disk = rawname(dt->fs_spec);
298 strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
299 strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
301 strncpy(spcl.c_dev, disk, NAMELEN);
302 strncpy(spcl.c_filesys, "an unlisted file system", NAMELEN);
304 spcl.c_dev[NAMELEN-1]='\0';
305 spcl.c_filesys[NAMELEN-1]='\0';
306 strcpy(spcl.c_label, "none");
307 gethostname(spcl.c_host, NAMELEN);
308 spcl.c_level = level - '0';
309 spcl.c_type = TS_TAPE;
311 getdumptime(); /* /etc/dumpdates snarfed */
313 msg("Date of this level %c dump: %s", level,
314 spcl.c_date == 0 ? "the epoch\n" : ctime(&spcl.c_date));
315 msg("Date of last level %c dump: %s", lastlevel,
316 spcl.c_ddate == 0 ? "the epoch\n" : ctime(&spcl.c_ddate));
317 msg("Dumping %s ", disk);
319 msgtail("(%s) ", dt->fs_file);
321 msgtail("to %s on host %s\n", tape, host);
323 msgtail("to %s\n", tape);
325 if ((diskfd = open(disk, O_RDONLY)) < 0)
326 err(X_STARTUP, "Cannot open %s", disk);
327 if (fstat(diskfd, &sb) != 0)
328 err(X_STARTUP, "%s: stat", disk);
329 if (S_ISDIR(sb.st_mode))
330 errx(X_STARTUP, "%s: unknown file system", disk);
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 (%ld) 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);
344 if (sblock->fs_inodefmt >= FS_44INODEFMT)
345 spcl.c_flags |= DR_NEWINODEFMT;
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);
354 nonodump = spcl.c_level < honorlevel;
357 setproctitle("%s: pass 1: regular files", disk);
358 msg("mapping (Pass I) [regular files]\n");
359 anydirskipped = mapfiles(maxino, &tapesize);
362 setproctitle("%s: pass 2: directories", disk);
363 msg("mapping (Pass II) [directories]\n");
364 while (anydirskipped) {
365 anydirskipped = mapdirs(maxino, &tapesize);
368 if (pipeout || unlimited) {
369 tapesize += 10; /* 10 trailer blocks */
370 msg("estimated %ld tape blocks.\n", tapesize);
375 fetapes = (double) tapesize / blocksperfile;
376 else if (cartridge) {
377 /* Estimate number of tapes, assuming streaming stops at
378 the end of each block written, and not in mid-block.
379 Assume no erroneous blocks; this can be compensated
380 for with an artificially low tape size. */
382 ( (double) tapesize /* blocks */
383 * TP_BSIZE /* bytes/block */
384 * (1.0/density) /* 0.1" / byte " */
386 (double) tapesize /* blocks */
387 * (1.0/ntrec) /* streaming-stops per block */
388 * 15.48 /* 0.1" / streaming-stop " */
389 ) * (1.0 / tsize ); /* tape / 0.1" " */
391 /* Estimate number of tapes, for old fashioned 9-track
393 int tenthsperirg = (density == 625) ? 3 : 7;
395 ( (double) tapesize /* blocks */
396 * TP_BSIZE /* bytes / block */
397 * (1.0/density) /* 0.1" / byte " */
399 (double) tapesize /* blocks */
400 * (1.0/ntrec) /* IRG's / block */
401 * tenthsperirg /* 0.1" / IRG " */
402 ) * (1.0 / tsize ); /* tape / 0.1" " */
404 etapes = fetapes; /* truncating assignment */
406 /* count the dumped inodes map on each additional tape */
407 tapesize += (etapes - 1) *
408 (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
409 tapesize += etapes + 10; /* headers + 10 trailer blks */
410 msg("estimated %ld tape blocks on %3.2f tape(s).\n",
415 * If the user only wants an estimate of the number of
422 * Allocate tape buffer.
426 "can't allocate tape buffers - try a smaller blocking factor.\n");
429 time((time_t *)&(tstart_writing));
430 dumpmap(usedinomap, TS_CLRI, maxino - 1);
433 setproctitle("%s: pass 3: directories", disk);
434 msg("dumping (Pass III) [directories]\n");
435 dirty = 0; /* XXX just to get gcc to shut up */
436 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
437 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
441 if ((dirty & 1) == 0)
444 * Skip directory inodes deleted and maybe reallocated
447 if ((dp->di_mode & IFMT) != IFDIR)
453 setproctitle("%s: pass 4: regular files", disk);
454 msg("dumping (Pass IV) [regular files]\n");
455 for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
458 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
462 if ((dirty & 1) == 0)
465 * Skip inodes deleted and reallocated as directories.
468 mode = dp->di_mode & IFMT;
475 spcl.c_type = TS_END;
476 for (i = 0; i < ntrec; i++)
477 writeheader(maxino - 1);
479 msg("DUMP: %ld tape blocks\n", (long)spcl.c_tapea);
481 msg("DUMP: %ld tape blocks on %d volume%s\n",
482 (long)spcl.c_tapea, spcl.c_volume,
483 (spcl.c_volume == 1) ? "" : "s");
485 /* report dump performance, avoid division through zero */
486 if (tend_writing - tstart_writing == 0)
487 msg("finished in less than a second\n");
489 msg("finished in %ld seconds, throughput %ld KBytes/sec\n",
490 (long)(tend_writing - tstart_writing),
491 spcl.c_tapea / (tend_writing - tstart_writing));
495 broadcast("DUMP IS DONE!\a\a\n");
496 msg("DUMP IS DONE\n");
505 "usage: dump [-0123456789ac"
509 "nSu] [-B records] [-b blocksize] [-D dumpdates]\n"
510 " [-d density] [-f file ] [-h level] [-s feet]\n"
511 " [-T date] [-C cachesizeMB] filesystem\n"
512 " dump [-W | -w]\n");
517 * Pick up a numeric argument. It must be nonnegative and in the given
518 * range (except that a vmax of 0 means unlimited).
521 numarg(char *meaning, long vmin, long vmax)
526 val = strtol(optarg, &p, 10);
528 errx(1, "illegal %s -- %s", meaning, optarg);
529 if (val < vmin || (vmax && val > vmax))
530 errx(1, "%s must be between %ld and %ld", meaning, vmin, vmax);
545 quit("Signal on pipe: cannot recover\n");
546 msg("Rewriting attempted as response to unknown signal.\n");
553 msg("SIGSEGV: ABORTING!\n");
554 signal(SIGSEGV, SIG_DFL);
563 static char rawbuf[MAXPATHLEN];
567 if (stat(cp, &sb) == 0) {
569 * If the name already refers to a raw device, return
570 * it immediately without tampering.
572 if ((sb.st_mode & S_IFMT) == S_IFCHR)
576 dp = strrchr(cp, '/');
581 strncpy(rawbuf, cp, MAXPATHLEN - 1);
582 rawbuf[MAXPATHLEN-1] = '\0';
584 strncat(rawbuf, "/r", MAXPATHLEN - 1 - strlen(rawbuf));
585 strncat(rawbuf, dp + 1, MAXPATHLEN - 1 - strlen(rawbuf));
591 * Change set of key letters and ordered arguments into something
592 * getopt(3) will like.
595 obsolete(int *argcp, char ***argvp)
598 char *ap, **argv, *flagsp, **nargv, *p;
604 /* Return if no arguments or first argument has leading dash. */
606 if (argc == 1 || *ap == '-')
609 /* Allocate space for new arguments. */
610 if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
611 (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
617 for (flags = 0; *ap; ++ap) {
629 warnx("option requires an argument -- %c", *ap);
632 if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
636 strcpy(&nargv[0][2], *argv);
650 /* Terminate flags. */
656 /* Copy remaining arguments. */
657 while ((*nargv++ = *argv++));
659 /* Update argument count. */
660 *argcp = nargv - *argvp - 1;