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