sbin/restore/restore.h

   1 /*-
   2  * Copyright (c) 1983, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 4. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)restore.h   8.3 (Berkeley) 9/13/94
  35  * $FreeBSD$
  36  */
  37
  38 /*
  39  * Flags
  40  */
  41 extern int      bflag;          /* set input block size */
  42 extern int      dflag;          /* print out debugging info */
  43 extern int      Dflag;          /* degraded mode - try hard to get stuff back */
  44 extern int      hflag;          /* restore heirarchies */
  45 extern int      mflag;          /* restore by name instead of inode number */
  46 extern int      Nflag;          /* do not write the disk */
  47 extern int      uflag;          /* unlink symlink targets */
  48 extern int      vflag;          /* print out actions taken */
  49 extern int      yflag;          /* always try to recover from tape errors */
  50 /*
  51  * Global variables
  52  */
  53 extern char     *dumpmap;       /* map of inodes on this dump tape */
  54 extern char     *usedinomap;    /* map of inodes that are in use on this fs */
  55 extern ino_t    maxino;         /* highest numbered inode in this file system */
  56 extern long     dumpnum;        /* location of the dump on this tape */
  57 extern long     volno;          /* current volume being read */
  58 extern long     ntrec;          /* number of TP_BSIZE records per tape block */
  59 extern time_t   dumptime;       /* time that this dump begins */
  60 extern time_t   dumpdate;       /* time that this dump was made */
  61 extern char     command;        /* opration being performed */
  62 extern FILE     *terminal;      /* file descriptor for the terminal input */
  63 extern int      Bcvt;           /* need byte swapping on inodes and dirs */
  64 extern int      oldinofmt;      /* reading tape with FreeBSD 1 format inodes */
  65
  66 /*
  67  * Each file in the file system is described by one of these entries
  68  */
  69 struct entry {
  70         char    *e_name;                /* the current name of this entry */
  71         u_char  e_namlen;               /* length of this name */
  72         char    e_type;                 /* type of this entry, see below */
  73         short   e_flags;                /* status flags, see below */
  74         ino_t   e_ino;                  /* inode number in previous file sys */
  75         long    e_index;                /* unique index (for dumpped table) */
  76         struct  entry *e_parent;        /* pointer to parent directory (..) */
  77         struct  entry *e_sibling;       /* next element in this directory (.) */
  78         struct  entry *e_links;         /* hard links to this inode */
  79         struct  entry *e_entries;       /* for directories, their entries */
  80         struct  entry *e_next;          /* hash chain list */
  81 };
  82 /* types */
  83 #define LEAF 1                  /* non-directory entry */
  84 #define NODE 2                  /* directory entry */
  85 #define LINK 4                  /* synthesized type, stripped by addentry */
  86 /* flags */
  87 #define EXTRACT         0x0001  /* entry is to be replaced from the tape */
  88 #define NEW             0x0002  /* a new entry to be extracted */
  89 #define KEEP            0x0004  /* entry is not to change */
  90 #define REMOVED         0x0010  /* entry has been removed */
  91 #define TMPNAME         0x0020  /* entry has been given a temporary name */
  92 #define EXISTED         0x0040  /* directory already existed during extract */
  93
  94 /*
  95  * Constants associated with entry structs
  96  */
  97 #define HARDLINK        1
  98 #define SYMLINK         2
  99 #define TMPHDR          "RSTTMP"
 100
 101 /*
 102  * The entry describes the next file available on the tape
 103  */
 104 struct context {
 105         short   action;         /* action being taken on this file */
 106         mode_t  mode;           /* mode of file */
 107         ino_t   ino;            /* inumber of file */
 108         uid_t   uid;            /* file owner */
 109         gid_t   gid;            /* file group */
 110         int     file_flags;     /* status flags (chflags) */
 111         int     rdev;           /* device number of file */
 112         time_t  atime_sec;      /* access time seconds */
 113         time_t  mtime_sec;      /* modified time seconds */
 114         time_t  birthtime_sec;  /* creation time seconds */
 115         int     atime_nsec;     /* access time nanoseconds */
 116         int     mtime_nsec;     /* modified time nanoseconds */
 117         int     birthtime_nsec; /* creation time nanoseconds */
 118         int     extsize;        /* size of extended attribute data */
 119         off_t   size;           /* size of file */
 120         char    *name;          /* name of file */
 121 } curfile;
 122 /* actions */
 123 #define USING   1       /* extracting from the tape */
 124 #define SKIP    2       /* skipping */
 125 #define UNKNOWN 3       /* disposition or starting point is unknown */
 126
 127 /*
 128  * Definitions for library routines operating on directories.
 129  */
 130 typedef struct rstdirdesc RST_DIR;
 131
 132 /*
 133  * Flags to setdirmodes.
 134  */
 135 #define FORCE   0x0001
 136
 137 /*
 138  * Useful macros
 139  */
 140 #define TSTINO(ino, map) \
 141         (map[(u_int)((ino) - 1) / CHAR_BIT] & \
 142             (1 << ((u_int)((ino) - 1) % CHAR_BIT)))
 143 #define SETINO(ino, map) \
 144         map[(u_int)((ino) - 1) / CHAR_BIT] |= \
 145             1 << ((u_int)((ino) - 1) % CHAR_BIT)
 146
 147 #define dprintf         if (dflag) fprintf
 148 #define vprintf         if (vflag) fprintf
 149
 150 #define GOOD 1
 151 #define FAIL 0
 152
 153 #define NFS_DR_NEWINODEFMT      0x2     /* Tape uses 4.4 BSD inode format */