Kernel - Clean up conditionals to make them more readable (no real code chg)
[dragonfly.git] / sbin / restore / restore.h
blob957589fe0af245720ba8c09c8f4430f29a96ce91
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.
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 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
38 * @(#)restore.h 8.3 (Berkeley) 9/13/94
39 * $DragonFly: src/sbin/restore/restore.h,v 1.3 2006/04/03 01:58:49 dillon Exp $
43 * Flags
45 extern int cvtflag; /* convert from old to new tape format */
46 extern int bflag; /* set input block size */
47 extern int dflag; /* print out debugging info */
48 extern int hflag; /* restore heirarchies */
49 extern int mflag; /* restore by name instead of inode number */
50 extern int Nflag; /* do not write the disk */
51 extern int uflag; /* unlink symlink targets */
52 extern int vflag; /* print out actions taken */
53 extern int yflag; /* always try to recover from tape errors */
55 * Global variables
57 extern char *dumpmap; /* map of inodes on this dump tape */
58 extern char *usedinomap; /* map of inodes that are in use on this fs */
59 extern ufs1_ino_t maxino; /* highest numbered inode in this file system */
60 extern long dumpnum; /* location of the dump on this tape */
61 extern long volno; /* current volume being read */
62 extern long ntrec; /* number of TP_BSIZE records per tape block */
63 extern time_t dumptime; /* time that this dump begins */
64 extern time_t dumpdate; /* time that this dump was made */
65 extern char command; /* opration being performed */
66 extern FILE *terminal; /* file descriptor for the terminal input */
67 extern int oldinofmt; /* reading tape with old format inodes */
68 extern int Bcvt; /* need byte swapping on inodes and dirs */
71 * Each file in the file system is described by one of these entries
73 struct entry {
74 char *e_name; /* the current name of this entry */
75 u_char e_namlen; /* length of this name */
76 char e_type; /* type of this entry, see below */
77 short e_flags; /* status flags, see below */
78 ufs1_ino_t e_ino; /* inode number in previous file sys */
79 long e_index; /* unique index (for dumpped table) */
80 struct entry *e_parent; /* pointer to parent directory (..) */
81 struct entry *e_sibling; /* next element in this directory (.) */
82 struct entry *e_links; /* hard links to this inode */
83 struct entry *e_entries; /* for directories, their entries */
84 struct entry *e_next; /* hash chain list */
86 /* types */
87 #define LEAF 1 /* non-directory entry */
88 #define NODE 2 /* directory entry */
89 #define LINK 4 /* synthesized type, stripped by addentry */
90 /* flags */
91 #define EXTRACT 0x0001 /* entry is to be replaced from the tape */
92 #define NEW 0x0002 /* a new entry to be extracted */
93 #define KEEP 0x0004 /* entry is not to change */
94 #define REMOVED 0x0010 /* entry has been removed */
95 #define TMPNAME 0x0020 /* entry has been given a temporary name */
96 #define EXISTED 0x0040 /* directory already existed during extract */
99 * Constants associated with entry structs
101 #define HARDLINK 1
102 #define SYMLINK 2
103 #define TMPHDR "RSTTMP"
106 * The entry describes the next file available on the tape
108 struct context {
109 char *name; /* name of file */
110 ufs1_ino_t ino; /* inumber of file */
111 struct ufs1_dinode *dip; /* pointer to inode */
112 char action; /* action being taken on this file */
113 } curfile;
114 /* actions */
115 #define USING 1 /* extracting from the tape */
116 #define SKIP 2 /* skipping */
117 #define UNKNOWN 3 /* disposition or starting point is unknown */
120 * Definitions for library routines operating on directories.
122 typedef struct rstdirdesc RST_DIR;
125 * Flags to setdirmodes.
127 #define FORCE 0x0001
130 * Useful macros
132 #define TSTINO(ino, map) \
133 (map[(u_int)((ino) - 1) / NBBY] & (1 << ((u_int)((ino) - 1) % NBBY)))
134 #define SETINO(ino, map) \
135 map[(u_int)((ino) - 1) / NBBY] |= 1 << ((u_int)((ino) - 1) % NBBY)
137 #define dprintf if (dflag) fprintf
138 #define vprintf if (vflag) fprintf
140 #define GOOD 1
141 #define FAIL 0