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