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. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#) Copyright (c) 1980, 1991, 1993, 1994 The Regents of the University of California. All rights reserved.
30 * @(#)main.c 8.6 (Berkeley) 5/1/95
31 * $FreeBSD: src/sbin/dump/main.c,v 1.20.2.9 2003/01/25 18:54:59 dillon Exp $
34 #include <sys/param.h>
37 #include <vfs/ufs/dinode.h>
38 #include <vfs/ufs/fs.h>
40 #include <protocols/dumprestore.h>
53 #include "pathnames.h"
56 #define SBOFF (SBLOCK * DEV_BSIZE)
59 int notify = 0; /* notify operator flag */
60 int blockswritten = 0; /* number of blocks written on current tape */
61 int tapeno = 0; /* current tape number */
62 int density = 0; /* density in bytes/0.1" " <- this is for hilit19 */
63 int ntrec = NTREC; /* # tape blocks in each tape record */
64 int cartridge = 0; /* Assume non-cartridge tape */
65 int dokerberos = 0; /* Use Kerberos authentication */
66 int cachesize = 0; /* block cache size (in bytes) */
67 long dev_bsize = 1; /* recalculated below */
68 long blocksperfile; /* output blocks per file */
69 const char *host; /* remote host (if any) */
70 const char *dumpdates; /* name of the file containing dump date information*/
71 const char *temp; /* name of the file for doing rewrite of dumpdates */
73 static long numarg(const char *, long, long);
74 static void obsolete(int *, char **[]);
75 static void usage(void);
78 main(int argc, char **argv)
83 struct ufs1_dinode *dp;
87 int i, anydirskipped, bflag = 0, Tflag = 0, honorlevel = 1;
88 int just_estimate = 0;
92 time((time_t *)&spcl.c_date);
94 tsize = 0; /* Default later, based on 'c' option for cart tapes */
95 if ((tape = getenv("TAPE")) == NULL)
97 dumpdates = _PATH_DUMPDATES;
99 if (TP_BSIZE / DEV_BSIZE == 0 || TP_BSIZE % DEV_BSIZE != 0)
100 quit("TP_BSIZE must be a multiple of DEV_BSIZE\n");
106 obsolete(&argc, &argv);
108 #define optstring "0123456789aB:b:cd:f:h:kns:ST:uWwD:C:"
110 #define optstring "0123456789aB:b:cd:f:h:ns:ST:uWwD:C:"
112 while ((ch = getopt(argc, argv, optstring)) != -1)
116 case '0': case '1': case '2': case '3': case '4':
117 case '5': case '6': case '7': case '8': case '9':
121 case 'a': /* `auto-size', Write to EOM. */
125 case 'B': /* blocks per output file */
126 blocksperfile = numarg("number of blocks per file",
130 case 'b': /* blocks per tape write */
131 ntrec = numarg("number of blocks per write",
135 case 'c': /* Tape is cart. not 9-track */
139 case 'd': /* density, in bits per inch */
140 density = numarg("density", 10L, 327670L) / 10;
141 if (density >= 625 && !bflag)
142 ntrec = HIGHDENSITYTREC;
145 case 'f': /* output file */
154 cachesize = numarg("cachesize", 0, 0) * 1024 * 1024;
158 honorlevel = numarg("honor level", 0L, 10L);
167 case 'n': /* notify operators */
171 case 's': /* tape size, feet */
172 tsize = numarg("tape size", 1L, 0L) * 12 * 10;
175 case 'S': /* exit after estimating # of tapes */
179 case 'T': /* time of last dump */
180 spcl.c_ddate = unctime(optarg);
181 if (spcl.c_ddate < 0) {
182 fprintf(stderr, "bad time \"%s\"\n", optarg);
189 case 'u': /* update /etc/dumpdates */
193 case 'W': /* what to do */
196 exit(X_FINOK); /* do nothing else */
205 fprintf(stderr, "Must specify disk or filesystem\n");
211 fprintf(stderr, "Unknown arguments to dump:");
213 fprintf(stderr, " %s", *argv++);
214 fprintf(stderr, "\n");
217 if (Tflag && uflag) {
218 fprintf(stderr, "You cannot use the T and u flags together.\n");
221 if (strcmp(tape, "-") == 0) {
223 tape = "standard output";
227 blocksperfile = blocksperfile / ntrec * ntrec; /* round down */
228 else if (!unlimited) {
230 * Determine how to default tape size and density
233 * 9-track 1600 bpi (160 bytes/.1") 2300 ft.
234 * 9-track 6250 bpi (625 bytes/.1") 2300 ft.
235 * cartridge 8000 bpi (100 bytes/.1") 1700 ft.
237 * hilit19 hits again: "
240 density = cartridge ? 100 : 160;
242 tsize = cartridge ? 1700L*120L : 2300L*120L;
245 if (strchr(tape, ':')) {
247 if ((host = strdup(tape)) == NULL)
248 err(1, "strdup failed");
249 ehost = strchr(host, ':');
253 if (strchr(tape, '\n')) {
254 fprintf(stderr, "invalid characters in tape\n");
257 if (rmthost(host) == 0)
260 fprintf(stderr, "remote dump not enabled\n");
264 setuid(getuid()); /* rmthost() is the only reason to be setuid */
266 if (signal(SIGHUP, SIG_IGN) != SIG_IGN)
268 if (signal(SIGTRAP, SIG_IGN) != SIG_IGN)
269 signal(SIGTRAP, sig);
270 if (signal(SIGFPE, SIG_IGN) != SIG_IGN)
272 if (signal(SIGBUS, SIG_IGN) != SIG_IGN)
274 if (signal(SIGSEGV, SIG_IGN) != SIG_IGN)
275 signal(SIGSEGV, sig);
276 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
277 signal(SIGTERM, sig);
278 if (signal(SIGINT, interrupt) == SIG_IGN)
279 signal(SIGINT, SIG_IGN);
281 dump_getfstab(); /* /etc/fstab snarfed */
283 * disk can be either the full special file name,
284 * the suffix of the special file name,
285 * the special name missing the leading '/',
286 * the file system name with or without the leading '/'.
288 dt = fstabsearch(disk);
290 disk = rawname(dt->fs_spec);
291 strncpy(spcl.c_dev, dt->fs_spec, NAMELEN);
292 strncpy(spcl.c_filesys, dt->fs_file, NAMELEN);
294 strncpy(spcl.c_dev, disk, NAMELEN);
295 strncpy(spcl.c_filesys, "an unlisted file system", NAMELEN);
297 spcl.c_dev[NAMELEN-1]='\0';
298 spcl.c_filesys[NAMELEN-1]='\0';
299 strcpy(spcl.c_label, "none");
300 gethostname(spcl.c_host, NAMELEN);
301 spcl.c_level = level - '0';
302 spcl.c_type = TS_TAPE;
304 getdumptime(); /* /etc/dumpdates snarfed */
306 msg("Date of this level %c dump: %s", level,
307 spcl.c_date == 0 ? "the epoch\n" : ctime((const time_t *)&spcl.c_date));
308 msg("Date of last level %c dump: %s", lastlevel,
309 spcl.c_ddate == 0 ? "the epoch\n" : ctime((const time_t *)&spcl.c_ddate));
310 msg("Dumping %s ", disk);
312 msgtail("(%s) ", dt->fs_file);
314 msgtail("to %s on host %s\n", tape, host);
316 msgtail("to %s\n", tape);
318 if ((diskfd = open(disk, O_RDONLY)) < 0)
319 err(X_STARTUP, "Cannot open %s", disk);
320 if (fstat(diskfd, &sb) != 0)
321 err(X_STARTUP, "%s: stat", disk);
322 if (S_ISDIR(sb.st_mode))
323 errx(X_STARTUP, "%s: unknown file system", disk);
325 sblock = (struct fs *)sblock_buf;
326 bread(SBOFF, (char *) sblock, SBSIZE);
327 if (sblock->fs_magic != FS_MAGIC)
328 quit("bad sblock magic number\n");
329 dev_bsize = sblock->fs_fsize / fsbtodb(sblock, 1);
330 dev_bshift = ffs(dev_bsize) - 1;
331 if (dev_bsize != (1 << dev_bshift))
332 quit("dev_bsize (%ld) is not a power of 2", dev_bsize);
333 tp_bshift = ffs(TP_BSIZE) - 1;
334 if (TP_BSIZE != (1 << tp_bshift))
335 quit("TP_BSIZE (%d) is not a power of 2", TP_BSIZE);
337 if (sblock->fs_inodefmt >= FS_44INODEFMT)
338 spcl.c_flags |= DR_NEWINODEFMT;
340 maxino = sblock->fs_ipg * sblock->fs_ncg;
341 mapsize = roundup(howmany(maxino, NBBY), TP_BSIZE);
342 usedinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
343 dumpdirmap = (char *)calloc((unsigned) mapsize, sizeof(char));
344 dumpinomap = (char *)calloc((unsigned) mapsize, sizeof(char));
345 tapesize = 3 * (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
347 nonodump = spcl.c_level < honorlevel;
350 setproctitle("%s: pass 1: regular files", disk);
351 msg("mapping (Pass I) [regular files]\n");
352 anydirskipped = mapfiles(maxino, &tapesize);
355 setproctitle("%s: pass 2: directories", disk);
356 msg("mapping (Pass II) [directories]\n");
357 while (anydirskipped) {
358 anydirskipped = mapdirs(maxino, &tapesize);
361 if (pipeout || unlimited) {
362 tapesize += 10; /* 10 trailer blocks */
363 msg("estimated %ld tape blocks.\n", tapesize);
368 fetapes = (double) tapesize / blocksperfile;
369 else if (cartridge) {
370 /* Estimate number of tapes, assuming streaming stops at
371 the end of each block written, and not in mid-block.
372 Assume no erroneous blocks; this can be compensated
373 for with an artificially low tape size. */
375 ( (double) tapesize /* blocks */
376 * TP_BSIZE /* bytes/block */
377 * (1.0/density) /* 0.1" / byte " */
379 (double) tapesize /* blocks */
380 * (1.0/ntrec) /* streaming-stops per block */
381 * 15.48 /* 0.1" / streaming-stop " */
382 ) * (1.0 / tsize ); /* tape / 0.1" " */
384 /* Estimate number of tapes, for old fashioned 9-track
386 int tenthsperirg = (density == 625) ? 3 : 7;
388 ( (double) tapesize /* blocks */
389 * TP_BSIZE /* bytes / block */
390 * (1.0/density) /* 0.1" / byte " */
392 (double) tapesize /* blocks */
393 * (1.0/ntrec) /* IRG's / block */
394 * tenthsperirg /* 0.1" / IRG " */
395 ) * (1.0 / tsize ); /* tape / 0.1" " */
397 etapes = fetapes; /* truncating assignment */
399 /* count the dumped inodes map on each additional tape */
400 tapesize += (etapes - 1) *
401 (howmany(mapsize * sizeof(char), TP_BSIZE) + 1);
402 tapesize += etapes + 10; /* headers + 10 trailer blks */
403 msg("estimated %ld tape blocks on %3.2f tape(s).\n",
408 * If the user only wants an estimate of the number of
415 * Allocate tape buffer.
419 "can't allocate tape buffers - try a smaller blocking factor.\n");
422 time((time_t *)&(tstart_writing));
423 dumpmap(usedinomap, TS_CLRI, maxino - 1);
426 setproctitle("%s: pass 3: directories", disk);
427 msg("dumping (Pass III) [directories]\n");
428 dirty = 0; /* XXX just to get gcc to shut up */
429 for (map = dumpdirmap, ino = 1; ino < maxino; ino++) {
430 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
434 if ((dirty & 1) == 0)
437 * Skip directory inodes deleted and maybe reallocated
440 if ((dp->di_mode & IFMT) != IFDIR)
446 setproctitle("%s: pass 4: regular files", disk);
447 msg("dumping (Pass IV) [regular files]\n");
448 for (map = dumpinomap, ino = 1; ino < maxino; ino++) {
451 if (((ino - 1) % NBBY) == 0) /* map is offset by 1 */
455 if ((dirty & 1) == 0)
458 * Skip inodes deleted and reallocated as directories.
461 mode = dp->di_mode & IFMT;
468 spcl.c_type = TS_END;
469 for (i = 0; i < ntrec; i++)
470 writeheader(maxino - 1);
472 msg("DUMP: %ld tape blocks\n", (long)spcl.c_tapea);
474 msg("DUMP: %ld tape blocks on %d volume%s\n",
475 (long)spcl.c_tapea, spcl.c_volume,
476 (spcl.c_volume == 1) ? "" : "s");
478 /* report dump performance, avoid division through zero */
479 if (tend_writing - tstart_writing == 0)
480 msg("finished in less than a second\n");
482 msg("finished in %ld seconds, throughput %ld KBytes/sec\n",
483 (long)(tend_writing - tstart_writing),
484 spcl.c_tapea / (tend_writing - tstart_writing));
488 broadcast("DUMP IS DONE!\a\a\n");
489 msg("DUMP IS DONE\n");
498 "usage: dump [-0123456789ac"
502 "nSu] [-B records] [-b blocksize] [-D dumpdates]\n"
503 " [-d density] [-f file ] [-h level] [-s feet]\n"
504 " [-T date] [-C cachesizeMB] filesystem\n"
505 " dump [-W | -w]\n");
510 * Pick up a numeric argument. It must be nonnegative and in the given
511 * range (except that a vmax of 0 means unlimited).
514 numarg(const char *meaning, long vmin, long vmax)
519 val = strtol(optarg, &p, 10);
521 errx(1, "illegal %s -- %s", meaning, optarg);
522 if (val < vmin || (vmax && val > vmax))
523 errx(1, "%s must be between %ld and %ld", meaning, vmin, vmax);
538 quit("Signal on pipe: cannot recover\n");
539 msg("Rewriting attempted as response to unknown signal.\n");
546 msg("SIGSEGV: ABORTING!\n");
547 signal(SIGSEGV, SIG_DFL);
556 static char rawbuf[MAXPATHLEN];
560 if (stat(cp, &sb) == 0) {
562 * If the name already refers to a raw device, return
563 * it immediately without tampering.
565 if ((sb.st_mode & S_IFMT) == S_IFCHR)
569 dp = strrchr(cp, '/');
574 strncpy(rawbuf, cp, MAXPATHLEN - 1);
575 rawbuf[MAXPATHLEN-1] = '\0';
577 strncat(rawbuf, "/r", MAXPATHLEN - 1 - strlen(rawbuf));
578 strncat(rawbuf, dp + 1, MAXPATHLEN - 1 - strlen(rawbuf));
584 * Change set of key letters and ordered arguments into something
585 * getopt(3) will like.
588 obsolete(int *argcp, char ***argvp)
591 char *ap, **argv, *flagsp, **nargv, *p;
597 /* Return if no arguments or first argument has leading dash. */
599 if (argc == 1 || *ap == '-')
602 /* Allocate space for new arguments. */
603 if ((*argvp = nargv = malloc((argc + 1) * sizeof(char *))) == NULL ||
604 (p = flagsp = malloc(strlen(ap) + 2)) == NULL)
610 for (flags = 0; *ap; ++ap) {
622 warnx("option requires an argument -- %c", *ap);
625 if ((nargv[0] = malloc(strlen(*argv) + 2 + 1)) == NULL)
629 strcpy(&nargv[0][2], *argv);
643 /* Terminate flags. */
649 /* Copy remaining arguments. */
650 while ((*nargv++ = *argv++));
652 /* Update argument count. */
653 *argcp = nargv - *argvp - 1;