Imported Upstream version 0.4b41
[debian/dump] / restore / restore.h
1 /*
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 <stelian@popies.net>, 1999-2000
6  *      Stelian Pop <stelian@popies.net> - AlcĂ´ve <www.alcove.com>, 2000-2002
7  *
8  *      $Id: restore.h,v 1.33 2005/07/07 09:16:08 stelian Exp $
9  */
10
11 /*
12  * Copyright (c) 1983, 1993
13  *      The Regents of the University of California.  All rights reserved.
14  * (c) UNIX System Laboratories, Inc.
15  * All or some portions of this file are derived from material licensed
16  * to the University of California by American Telephone and Telegraph
17  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
18  * the permission of UNIX System Laboratories, Inc.
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  * 1. Redistributions of source code must retain the above copyright
24  *    notice, this list of conditions and the following disclaimer.
25  * 2. Redistributions in binary form must reproduce the above copyright
26  *    notice, this list of conditions and the following disclaimer in the
27  *    documentation and/or other materials provided with the distribution.
28  * 3. Neither the name of the University nor the names of its contributors
29  *    may be used to endorse or promote products derived from this software
30  *    without specific prior written permission.
31  *
32  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42  * SUCH DAMAGE.
43  */
44
45 #include <config.h>
46 #include <protocols/dumprestore.h>
47 /*
48  * Flags
49  */
50 extern int      aflag;          /* automatic volume increment */
51 extern char     *Afile;         /* archive file */
52 extern int      cvtflag;        /* convert from old to new tape format */
53 extern int      bflag;          /* set input block size */
54 extern int      dflag;          /* print out debugging info */
55 extern int      hflag;          /* restore heirarchies */
56 extern int      lflag;          /* assume remote filename is a regular file */
57 extern int      Lflag;          /* compare errors limit */
58 extern int      mflag;          /* restore by name instead of inode number */
59 extern int      Mflag;          /* multi-volume restore */
60 extern int      oflag;          /* do restore permissions without asking */
61 extern int      Vflag;          /* multi-volume on a single device like CDROM */
62 extern int      Nflag;          /* do not write the disk */
63 extern int      uflag;          /* unlink symlink targets */
64 extern int      vflag;          /* print out actions taken */
65 extern int      yflag;          /* always try to recover from tape errors */
66 extern int      zflag;          /* tape is in compressed format */
67 extern int      ufs2flag;       /* tape is a FreeBSD UFS2 dump */
68 extern char*    bot_script;     /* beginning of tape script */
69 /*
70  * Global variables
71  */
72 extern char     *host;          /* name of the remote host */
73 extern char     *dumpmap;       /* map of inodes on this dump tape */
74 extern char     *usedinomap;    /* map of inodes that are in use on this fs */
75 extern dump_ino_t maxino;       /* highest numbered inode in this file system */
76 extern long     dumpnum;        /* location of the dump on this tape */
77 extern long     volno;          /* current volume being read */
78 extern long     ntrec;          /* number of TP_BSIZE records per tape block */
79 extern time_t   dumptime;       /* time that this dump begins */
80 extern time_t   dumpdate;       /* time that this dump was made */
81 extern char     command;        /* opration being performed */
82 extern FILE     *terminal;      /* file descriptor for the terminal input */
83 extern int      pipein;         /* input is from a pipe */
84 extern char     *tmpdir;        /* name of temp directory */
85 extern int      oldinofmt;      /* reading tape with old format inodes */
86 extern int      Bcvt;           /* need byte swapping on inodes and dirs */
87 extern int      compare_ignore_not_found;
88                                 /* used to compare incremental dumps, */
89                                 /* so messages about "not found" files */
90                                 /* isn't seen. */
91 extern int      compare_errors; /* did we encounter any compare errors? */
92 extern char     filesys[NAMELEN];/* name of dumped filesystem */
93 extern dump_ino_t volinfo[];    /* which inode on which volume archive info */
94 extern int      wdfd;           /* original working directory */
95 extern int      dirhash_size;   /* size of the directory hash table */
96
97 /*
98  * Each file in the file system is described by one of these entries
99  */
100 struct entry {
101         char    *e_name;                /* the current name of this entry */
102         u_char  e_namlen;               /* length of this name */
103         char    e_type;                 /* type of this entry, see below */
104         short   e_flags;                /* status flags, see below */
105         dump_ino_t e_ino;               /* inode number in previous file sys */
106         long    e_index;                /* unique index (for dumpped table) */
107         struct  entry *e_parent;        /* pointer to parent directory (..) */
108         struct  entry *e_sibling;       /* next element in this directory (.) */
109         struct  entry *e_links;         /* hard links to this inode */
110         struct  entry **e_entries;      /* for directories, their entries */
111         struct  entry *e_next;          /* hash chain list */
112 };
113 /* types */
114 #define LEAF 1                  /* non-directory entry */
115 #define NODE 2                  /* directory entry */
116 #define LINK 4                  /* synthesized type, stripped by addentry */
117 /* flags */
118 #define EXTRACT         0x0001  /* entry is to be replaced from the tape */
119 #define NEW             0x0002  /* a new entry to be extracted */
120 #define KEEP            0x0004  /* entry is not to change */
121 #define REMOVED         0x0010  /* entry has been removed */
122 #define TMPNAME         0x0020  /* entry has been given a temporary name */
123 #define EXISTED         0x0040  /* directory already existed during extract */
124
125 /*
126  * Constants associated with entry structs
127  */
128 #define HARDLINK        1
129 #define SYMLINK         2
130 #define TMPHDR          "RSTTMP"
131
132 /*
133  * The entry describes the next file available on the tape
134  */
135 struct context {
136         char    *name;          /* name of file */
137         dump_ino_t ino;         /* inumber of file */
138 #if defined(__linux__) || defined(sunos)
139         struct  new_bsd_inode *dip;     /* pointer to inode */
140 #else
141         struct  dinode *dip;    /* pointer to inode */
142 #endif
143         char    action;         /* action being taken on this file */
144 } curfile;
145 /* actions */
146 #define USING   1       /* extracting from the tape */
147 #define SKIP    2       /* skipping */
148 #define UNKNOWN 3       /* disposition or starting point is unknown */
149
150 /*
151  * Definitions for library routines operating on directories.
152  */
153 typedef struct rstdirdesc RST_DIR;
154
155 /*
156  * Flags to setdirmodes.
157  */
158 #define FORCE   0x0001
159
160 /*
161  * Useful macros
162  */
163 #define TSTINO(ino, map) \
164         (map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
165 #define SETINO(ino, map) \
166         map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
167
168 #define Dprintf         if (dflag) fprintf
169 #define Vprintf         if (vflag) fprintf
170
171 #define GOOD 1
172 #define FAIL 0
173
174 #ifdef USE_QFA
175 #define QFA_MAGIC       "495115637697"
176 #define QFA_VERSION     "1.0"
177 extern FILE     *gTapeposfp;
178 extern char     *gTapeposfile;
179 extern char     gTps[255];
180 extern long     gSeekstart;
181 extern int      tapeposflag;
182 extern int      gTapeposfd;
183 extern int      createtapeposflag;
184 extern unsigned long qfadumpdate;
185 extern long long curtapepos;
186 #ifdef sunos
187 int             fdsmtc;
188 long    scsiid;
189 char    smtcpath[2048];
190 #endif
191 #endif /* USE_QFA */
192
193 #define do_compare_error \
194         if (++compare_errors >= Lflag && Lflag) { \
195                 printf("Compare errors limit reached, exiting...\n"); \
196                 exit(2); \
197         }
198
199 #define XATTR_MAXSIZE   4096