new lint library

[unix-history] / usr / src / sbin / restore / tape.c

/* Copyright (c) 1983 Regents of the University of California */

#ifndef lint
static char sccsid[] = "@(#)tape.c      3.11    (Berkeley)      83/04/17";
#endif

#include "restore.h"
#include <dumprestor.h>
#include <sys/ioctl.h>
#include <sys/mtio.h>
#include <sys/file.h>
#include <setjmp.h>
#include <stat.h>

static long     fssize;
static int      mt = -1;
static int      pipein = 0;
static char     *magtape;
static int      bct = NTREC+1;
static char     tbf[NTREC*TP_BSIZE];
static union    u_spcl endoftapemark;
static long     blksread;
static jmp_buf  restart;
static int      gettingfile = 0;        /* restart has a valid frame */

static int      ofile;
static char     *map;
static char     lnkbuf[MAXPATHLEN + 1];
static int      pathlen;

/*
* Set up an input source
*/
setinput(source)
       char *source;
{
#ifdef RRESTOR
       char *host;
       char *index();

       host = source;
       magtape = index(host, ':');
       if (magtape == 0) {
nohost:
               msg("need keyletter ``f'' and device ``host:tape''\n");
               done(1);
       }
       *magtape++ = '\0';
       if (rmthost(host) == 0)
               done(1);
       setuid(getuid());       /* no longer need or want root privileges */
#else
       if (strcmp(source, "-") == 0) {
               pipein++;
               yflag++;
       }
       magtape = source;
#endif RRESTOR
}

/*
* Verify that the tape drive can be accessed and
* that it actually is a dump tape.
*/
setup()
{
       int i, j, *ip;
       struct stat stbuf;
       extern char *ctime();
       extern int xtrmap(), xtrmapskip();

       vprintf(stdout, "Verify tape and initialize maps\n");
#ifdef RRESTOR
       if ((mt = rmtopen(magtape, 0)) < 0)
#else
       if (pipein)
               mt = 0;
       else if ((mt = open(magtape, 0)) < 0)
#endif
       {
               fprintf(stderr, "%s: cannot open tape\n", magtape);
               done(1);
       }
       volno = 1;
       setdumpnum();
       flsht();
       if (gethead(&spcl) == FAIL) {
               bct--; /* push back this block */
               cvtflag++;
               if (gethead(&spcl) == FAIL) {
                       fprintf(stderr, "Tape is not a dump tape\n");
                       done(1);
               }
               fprintf(stderr, "Converting to new file system format.\n");
       }
       if (pipein) {
               endoftapemark.s_spcl.c_magic = cvtflag ? OFS_MAGIC : NFS_MAGIC;
               endoftapemark.s_spcl.c_type = TS_END;
               ip = (int *)&endoftapemark;
               j = sizeof(union u_spcl) / sizeof(int);
               i = 0;
               do
                       i += *ip++;
               while (--j);
               endoftapemark.s_spcl.c_checksum = CHECKSUM - i;
       }
       vprintf(stdout, "Dump   date: %s", ctime(&spcl.c_date));
       vprintf(stdout, "Dumped from: %s", ctime(&spcl.c_ddate));
       dumptime = spcl.c_ddate;
       dumpdate = spcl.c_date;
       if (stat(".", &stbuf) < 0) {
               fprintf(stderr, "cannot stat .\n");
               done(1);
       }
       fssize = stbuf.st_blksize;
       if (fssize <= 0 || ((fssize - 1) & fssize) != 0) {
               fprintf(stderr, "bad block size %d\n", fssize);
               done(1);
       }
       if (checkvol(&spcl, (long)1) == FAIL) {
               fprintf(stderr, "Tape is not volume 1 of the dump\n");
               done(1);
       }
       if (readhdr(&spcl) == FAIL)
               panic("no header after volume mark!\n");
       findinode(&spcl, 1);
       if (checktype(&spcl, TS_CLRI) == FAIL) {
               fprintf(stderr, "Cannot find file removal list\n");
               done(1);
       }
       maxino = (spcl.c_count * TP_BSIZE * NBBY) + 1;
       dprintf(stdout, "maxino = %d\n", maxino);
       map = calloc((unsigned)1, (unsigned)howmany(maxino, NBBY));
       if (map == (char *)NIL)
               panic("no memory for file removal list\n");
       clrimap = map;
       curfile.action = USING;
       getfile(xtrmap, xtrmapskip);
       if (checktype(&spcl, TS_BITS) == FAIL) {
               fprintf(stderr, "Cannot find file dump list\n");
               done(1);
       }
       map = calloc((unsigned)1, (unsigned)howmany(maxino, NBBY));
       if (map == (char *)NULL)
               panic("no memory for file dump list\n");
       dumpmap = map;
       curfile.action = USING;
       getfile(xtrmap, xtrmapskip);
}

getvol(nextvol)
       long nextvol;
{
       long newvol;
       long savecnt;
       union u_spcl tmpspcl;
#       define tmpbuf tmpspcl.s_spcl

       if (pipein) {
               if (nextvol != 1)
                       panic("Changing volumes on pipe input?\n");
               if (volno == 1)
                       return;
               goto gethdr;
       }
       savecnt = blksread;
again:
       if (pipein)
               done(1); /* pipes do not get a second chance */
       if (command == 'R' || command == 'r' || curfile.action != SKIP)
               newvol = nextvol;
       else 
               newvol = 0;
       while (newvol <= 0) {
               fprintf(stderr, "Specify next volume #: ");
               if (gets(tbf) == NULL)
                       continue;
               newvol = atoi(tbf);
               if (newvol <= 0) {
                       fprintf(stderr,
                           "Volume numbers are positive numerics\n");
               }
       }
       if (newvol == volno)
               return;
       closemt();
       fprintf(stderr, "Mount tape volume %d then type return ", newvol);
       while (getchar() != '\n')
               ;
#ifdef RRESTOR
       if ((mt = rmtopen(magtape, 0)) == -1)
#else
       if ((mt = open(magtape, 0)) == -1)
#endif
       {
               fprintf(stderr, "Cannot open tape!\n");
               goto again;
       }
gethdr:
       volno = newvol;
       setdumpnum();
       flsht();
       if (readhdr(&tmpbuf) == FAIL) {
               fprintf(stderr, "tape is not dump tape\n");
               volno = 0;
               goto again;
       }
       if (checkvol(&tmpbuf, volno) == FAIL) {
               fprintf(stderr, "Wrong volume (%d)\n", tmpbuf.c_volume);
               volno = 0;
               goto again;
       }
       if (tmpbuf.c_date != dumpdate || tmpbuf.c_ddate != dumptime) {
               fprintf(stderr, "Wrong dump date (%s)\n",
                       ctime(&tmpbuf.c_date));
               volno = 0;
               goto again;
       }
       blksread = savecnt;
       if (curfile.action == USING) {
               if (volno == 1)
                       panic("active file into volume 1\n");
               return;
       }
       (void) gethead(&spcl);
       findinode(&spcl, curfile.action == UNKNOWN ? 1 : 0);
       if (gettingfile) {
               gettingfile = 0;
               longjmp(restart, 1);
       }
}

/*
* handle multiple dumps per tape by skipping forward to the
* appropriate one.
*/
setdumpnum()
{
       struct mtop tcom;

       if (dumpnum == 1 || volno != 1)
               return;
       if (pipein) {
               fprintf(stderr, "Cannot have multiple dumps on pipe input\n");
               done(1);
       }
       tcom.mt_op = MTFSF;
       tcom.mt_count = dumpnum - 1;
#ifdef RRESTOR
       rmtioctl(MTFSF, dumpnum - 1);
#else
       if (ioctl(mt, MTIOCTOP, &tcom) < 0)
               perror("ioctl MTFSF");
#endif
}

extractfile(name)
       char *name;
{
       int mode;
       time_t timep[2];
       struct entry *ep;
       extern int xtrlnkfile(), xtrlnkskip();
       extern int xtrfile(), xtrskip();

       curfile.name = name;
       curfile.action = USING;
       timep[0] = curfile.dip->di_atime;
       timep[1] = curfile.dip->di_mtime;
       mode = curfile.dip->di_mode;
       switch (mode & IFMT) {

       default:
               fprintf(stderr, "%s: unknown file mode 0%o\n", name, mode);
               skipfile();
               return (FAIL);

       case IFDIR:
               if (mflag) {
                       ep = lookupname(name);
                       if (ep == NIL || ep->e_flags & EXTRACT)
                               panic("unextracted directory %s\n", name);
                       skipfile();
                       return (GOOD);
               }
               vprintf(stdout, "extract file %s\n", name);
               return (genliteraldir(name, curfile.ino));

       case IFLNK:
               lnkbuf[0] = '\0';
               pathlen = 0;
               getfile(xtrlnkfile, xtrlnkskip);
               if (pathlen == 0) {
                       vprintf(stdout,
                           "%s: zero length symbolic link (ignored)\n", name);
               } else if (symlink(lnkbuf, name) < 0) {
                       fprintf(stderr, "%s: cannot create symbolic link\n",
                           name);
                       return (FAIL);
               } else
                       vprintf(stdout, "extract symbolic link %s\n", name);
               return (GOOD);

       case IFCHR:
       case IFBLK:
               vprintf(stdout, "extract special file %s\n", name);
               if (mknod(name, mode, (int)curfile.dip->di_rdev) < 0) {
                       fprintf(stderr, "%s: cannot create special file\n",
                           name);
                       skipfile();
                       return (FAIL);
               }
               (void) chown(name, curfile.dip->di_uid, curfile.dip->di_gid);
               (void) chmod(name, mode);
               skipfile();
               utime(name, timep);
               return (GOOD);

       case IFREG:
               vprintf(stdout, "extract file %s\n", name);
               if ((ofile = open(name, FWRONLY|FCREATE, 0666)) < 0) {
                       fprintf(stderr, "%s: cannot create file\n", name);
                       skipfile();
                       return (FAIL);
               }
               (void) fchown(ofile, curfile.dip->di_uid, curfile.dip->di_gid);
               (void) fchmod(ofile, mode);
               getfile(xtrfile, xtrskip);
               (void) close(ofile);
               utime(name, timep);
               return (GOOD);
       }
       /* NOTREACHED */
}

/*
* skip over bit maps on the tape
*/
skipmaps()
{

       while (checktype(&spcl, TS_CLRI) == GOOD ||
              checktype(&spcl, TS_BITS) == GOOD)
               skipfile();
}

/*
* skip over a file on the tape
*/
skipfile()
{
       extern int null();

       curfile.action = SKIP;
       getfile(null, null);
}

/*
* Do the file extraction, calling the supplied functions
* with the blocks
*/
getfile(f1, f2)
       int     (*f2)(), (*f1)();
{
       register int i;
       int curblk = 0;
       off_t size = spcl.c_dinode.di_size;
       static char clearedbuf[MAXBSIZE];
       char buf[MAXBSIZE / TP_BSIZE][TP_BSIZE];

       if (checktype(&spcl, TS_END) == GOOD)
               panic("ran off end of tape\n");
       if (ishead(&spcl) == FAIL)
               panic("not at beginning of a file\n");
       if (!gettingfile && setjmp(restart) != 0)
               return;
       gettingfile++;
loop:
       for (i = 0; i < spcl.c_count; i++) {
               if (spcl.c_addr[i]) {
                       readtape(&buf[curblk++][0]);
                       if (curblk == fssize / TP_BSIZE) {
                               (*f1)(buf, size > TP_BSIZE ?
                                    (long) (fssize) :
                                    (curblk - 1) * TP_BSIZE + size);
                               curblk = 0;
                       }
               } else {
                       if (curblk > 0) {
                               (*f1)(buf, size > TP_BSIZE ?
                                    (long) (curblk * TP_BSIZE) :
                                    (curblk - 1) * TP_BSIZE + size);
                               curblk = 0;
                       }
                       (*f2)(clearedbuf, size > TP_BSIZE ?
                               (long) TP_BSIZE : size);
               }
               if ((size -= TP_BSIZE) <= 0)
                       break;
       }
       if (readhdr(&spcl) == GOOD && size > 0) {
               if (checktype(&spcl, TS_ADDR) == GOOD)
                       goto loop;
               dprintf(stdout, "Missing address (header) block for %s\n",
                       curfile.name);
       }
       if (curblk > 0)
               (*f1)(buf, (curblk * TP_BSIZE) + size);
       findinode(&spcl, 1);
       gettingfile = 0;
}

/*
* The next routines are called during file extraction to
* put the data into the right form and place.
*/
xtrfile(buf, size)
       char    *buf;
       long    size;
{

       if (write(ofile, buf, (int) size) == -1) {
               fprintf(stderr, "write error extracting inode %d, name %s\n",
                       curfile.ino, curfile.name);
               perror("write");
               done(1);
       }
}

xtrskip(buf, size)
       char *buf;
       long size;
{

#ifdef lint
       buf = buf;
#endif
       if (lseek(ofile, size, 1) == (long)-1) {
               fprintf(stderr, "seek error extracting inode %d, name %s\n",
                       curfile.ino, curfile.name);
               perror("lseek");
               done(1);
       }
}

xtrlnkfile(buf, size)
       char    *buf;
       long    size;
{

       pathlen += size;
       if (pathlen > MAXPATHLEN) {
               fprintf(stderr, "symbolic link name: %s->%s%s; too long %d\n",
                   curfile.name, lnkbuf, buf, pathlen);
               done(1);
       }
       strcat(lnkbuf, buf);
}

xtrlnkskip(buf, size)
       char *buf;
       long size;
{

#ifdef lint
       buf = buf, size = size;
#endif
       fprintf(stderr, "unallocated block in symbolic link %s\n",
               curfile.name);
       done(1);
}

xtrmap(buf, size)
       char    *buf;
       long    size;
{

       bcopy(buf, map, size);
       map += size;
}

xtrmapskip(buf, size)
       char *buf;
       long size;
{

#ifdef lint
       buf = buf;
#endif
       panic("hole in map\n");
       map += size;
}

null() {;}

/*
* Do the tape i/o, dealing with volume changes
* etc..
*/
readtape(b)
       char *b;
{
       register long i;
       long rd, newvol;
       int cnt;

       if (bct >= NTREC) {
               for (i = 0; i < NTREC; i++)
                       ((struct s_spcl *)&tbf[i*TP_BSIZE])->c_magic = 0;
               bct = 0;
               cnt = NTREC*TP_BSIZE;
               rd = 0;
       getmore:
#ifdef RRESTOR
               i = rmtread(&tbf[rd], cnt);
#else
               i = read(mt, &tbf[rd], cnt);
#endif
               if (i > 0 && i != NTREC*TP_BSIZE) {
                       if (!pipein)
                               panic("partial block read: %d should be %d\n",
                                       i, NTREC*TP_BSIZE);
                       rd += i;
                       cnt -= i;
                       if (cnt > 0)
                               goto getmore;
                       i = rd;
               }
               if (i < 0) {
                       fprintf(stderr, "Tape read error while ");
                       switch (curfile.action) {
                       default:
                               fprintf(stderr, "trying to set up tape\n");
                               break;
                       case UNKNOWN:
                               fprintf(stderr, "trying to resyncronize\n");
                               break;
                       case USING:
                               fprintf(stderr, "restoring %s\n", curfile.name);
                               break;
                       case SKIP:
                               fprintf(stderr, "skipping over inode %d\n",
                                       curfile.ino);
                               break;
                       }
                       if (!yflag && !reply("continue"))
                               done(1);
                       i = NTREC*TP_BSIZE;
                       bzero(tbf, i);
#ifdef RRESTOR
                       if (rmtseek(i, 1) < 0)
#else
                       if (lseek(mt, i, 1) == (long)-1)
#endif
                       {
                               fprintf(stderr, "continuation failed\n");
                               done(1);
                       }
               }
               if (i == 0) {
                       if (pipein) {
                               bcopy((char *)&endoftapemark, b,
                                       (long)TP_BSIZE);
                               flsht();
                               return;
                       }
                       newvol = volno + 1;
                       volno = 0;
                       getvol(newvol);
                       readtape(b);
                       return;
               }
       }
       bcopy(&tbf[(bct++*TP_BSIZE)], b, (long)TP_BSIZE);
       blksread++;
}

flsht()
{

       bct = NTREC+1;
}

closemt()
{
       if (mt < 0)
               return;
#ifdef RRESTOR
       rmtclose();
#else
       (void) close(mt);
#endif
}

checkvol(b, t)
       struct s_spcl *b;
       long t;
{

       if (b->c_volume != t)
               return(FAIL);
       return(GOOD);
}

readhdr(b)
       struct s_spcl *b;
{

       if (gethead(b) == FAIL) {
               dprintf(stdout, "readhdr fails at %d blocks\n", blksread);
               return(FAIL);
       }
       return(GOOD);
}

/*
* read the tape into buf, then return whether or
* or not it is a header block.
*/
gethead(buf)
       struct s_spcl *buf;
{
       long i;
       union u_ospcl {
               char dummy[TP_BSIZE];
               struct  s_ospcl {
                       long    c_type;
                       long    c_date;
                       long    c_ddate;
                       long    c_volume;
                       long    c_tapea;
                       u_short c_inumber;
                       long    c_magic;
                       long    c_checksum;
                       struct odinode {
                               unsigned short odi_mode;
                               u_short odi_nlink;
                               u_short odi_uid;
                               u_short odi_gid;
                               long    odi_size;
                               long    odi_rdev;
                               char    odi_addr[36];
                               long    odi_atime;
                               long    odi_mtime;
                               long    odi_ctime;
                       } c_dinode;
                       long    c_count;
                       char    c_addr[256];
               } s_ospcl;
       } u_ospcl;

       if (!cvtflag) {
               readtape((char *)buf);
               if (buf->c_magic != NFS_MAGIC || checksum((int *)buf) == FAIL)
                       return(FAIL);
               goto good;
       }
       readtape((char *)(&u_ospcl.s_ospcl));
       bzero((char *)buf, (long)TP_BSIZE);
       buf->c_type = u_ospcl.s_ospcl.c_type;
       buf->c_date = u_ospcl.s_ospcl.c_date;
       buf->c_ddate = u_ospcl.s_ospcl.c_ddate;
       buf->c_volume = u_ospcl.s_ospcl.c_volume;
       buf->c_tapea = u_ospcl.s_ospcl.c_tapea;
       buf->c_inumber = u_ospcl.s_ospcl.c_inumber;
       buf->c_checksum = u_ospcl.s_ospcl.c_checksum;
       buf->c_magic = u_ospcl.s_ospcl.c_magic;
       buf->c_dinode.di_mode = u_ospcl.s_ospcl.c_dinode.odi_mode;
       buf->c_dinode.di_nlink = u_ospcl.s_ospcl.c_dinode.odi_nlink;
       buf->c_dinode.di_uid = u_ospcl.s_ospcl.c_dinode.odi_uid;
       buf->c_dinode.di_gid = u_ospcl.s_ospcl.c_dinode.odi_gid;
       buf->c_dinode.di_size = u_ospcl.s_ospcl.c_dinode.odi_size;
       buf->c_dinode.di_rdev = u_ospcl.s_ospcl.c_dinode.odi_rdev;
       buf->c_dinode.di_atime = u_ospcl.s_ospcl.c_dinode.odi_atime;
       buf->c_dinode.di_mtime = u_ospcl.s_ospcl.c_dinode.odi_mtime;
       buf->c_dinode.di_ctime = u_ospcl.s_ospcl.c_dinode.odi_ctime;
       buf->c_count = u_ospcl.s_ospcl.c_count;
       bcopy(u_ospcl.s_ospcl.c_addr, buf->c_addr, (long)256);
       if (u_ospcl.s_ospcl.c_magic != OFS_MAGIC ||
           checksum((int *)(&u_ospcl.s_ospcl)) == FAIL)
               return(FAIL);
       buf->c_magic = NFS_MAGIC;

good:
       switch (buf->c_type) {

       case TS_CLRI:
       case TS_BITS:
               /*
                * Have to patch up missing information in bit map headers
                */
               buf->c_inumber = 0;
               buf->c_dinode.di_size = buf->c_count * TP_BSIZE;
               for (i = 0; i < buf->c_count; i++)
                       buf->c_addr[i]++;
               break;

       case TS_TAPE:
       case TS_END:
               buf->c_inumber = 0;
               break;

       case TS_INODE:
       case TS_ADDR:
               break;

       default:
               panic("gethead: unknown inode type %d\n", buf->c_type);
               break;
       }
       if (dflag)
               accthdr(buf);
       return(GOOD);
}

/*
* Check that a header is where it belongs and predict the next header
*/
accthdr(header)
       struct s_spcl *header;
{
       static ino_t previno = 0x7fffffff;
       static int prevtype;
       static long predict;
       long blks, i;

       if (header->c_type == TS_TAPE) {
               fprintf(stderr, "Volume header\n");
               return;
       }
       if (previno == 0x7fffffff)
               goto newcalc;
       switch (prevtype) {
       case TS_BITS:
               fprintf(stderr, "Dump mask header");
               break;
       case TS_CLRI:
               fprintf(stderr, "Remove mask header");
               break;
       case TS_INODE:
               fprintf(stderr, "File header, ino %d", previno);
               break;
       case TS_ADDR:
               fprintf(stderr, "File continuation header, ino %d", previno);
               break;
       case TS_END:
               fprintf(stderr, "End of tape header");
               break;
       }
       if (predict != blksread - 1)
               fprintf(stderr, "; predicted %d blocks, got %d blocks",
                       predict, blksread - 1);
       fprintf(stderr, "\n");
newcalc:
       blks = 0;
       if (header->c_type != TS_END)
               for (i = 0; i < header->c_count; i++)
                       if (header->c_addr[i] != 0)
                               blks++;
       predict = blks;
       blksread = 0;
       prevtype = header->c_type;
       previno = header->c_inumber;
}

/*
* Find an inode header.
* Complain if had to skip, and complain is set.
*/
findinode(header, complain)
       struct s_spcl *header;
       int complain;
{
       static long skipcnt = 0;

       curfile.name = "<name unknown>";
       curfile.action = UNKNOWN;
       curfile.dip = (struct dinode *)NIL;
       curfile.ino = 0;
       if (ishead(header) == FAIL) {
               skipcnt++;
               while (gethead(header) == FAIL)
                       skipcnt++;
       }
       for (;;) {
               if (checktype(header, TS_INODE) == GOOD) {
                       curfile.dip = &header->c_dinode;
                       curfile.ino = header->c_inumber;
                       break;
               }
               if (checktype(header, TS_END) == GOOD) {
                       curfile.ino = maxino;
                       break;
               }
               if (checktype(header, TS_CLRI) == GOOD) {
                       curfile.name = "<file removal list>";
                       break;
               }
               if (checktype(header, TS_BITS) == GOOD) {
                       curfile.name = "<file dump list>";
                       break;
               }
               while (gethead(header) == FAIL)
                       skipcnt++;
       }
       if (skipcnt > 0 && complain)
               fprintf(stderr, "resync restor, skipped %d blocks\n", skipcnt);
       skipcnt = 0;
}

/*
* return whether or not the buffer contains a header block
*/
ishead(buf)
       struct s_spcl *buf;
{

       if (buf->c_magic != NFS_MAGIC)
               return(FAIL);
       return(GOOD);
}

checktype(b, t)
       struct s_spcl *b;
       int     t;
{

       if (b->c_type != t)
               return(FAIL);
       return(GOOD);
}

checksum(b)
       register int *b;
{
       register int i, j;

       j = sizeof(union u_spcl) / sizeof(int);
       i = 0;
       do
               i += *b++;
       while (--j);
       if (i != CHECKSUM) {
               fprintf(stderr, "Checksum error %o, inode %d file %s\n", i,
                       curfile.ino, curfile.name);
               return(FAIL);
       }
       return(GOOD);
}

/*
* respond to interrupts
*/
onintr()
{
       if (pipein || reply("restore interrupted, continue") == FAIL)
               done(1);
       if (signal(SIGINT, onintr) == SIG_IGN)
               (void) signal(SIGINT, SIG_IGN);
       if (signal(SIGTERM, onintr) == SIG_IGN)
               (void) signal(SIGTERM, SIG_IGN);
}

/*
* handle unexpected inconsistencies
*/
/* VARARGS1 */
panic(msg, d1, d2)
       char *msg;
       long d1, d2;
{

       fprintf(stderr, msg, d1, d2);
       if (pipein || reply("abort") == GOOD)
               abort();
}

#ifdef RRESTOR
/* VARARGS1 */
msg(cp, a1, a2, a3)
       char *cp;
{

       fprintf(stderr, cp, a1, a2, a3);
}
#endif RRESTOR