xref: /freebsd/sbin/dump/dump.h (revision 6780ab54325a71e7e70112b11657973edde8655e)
1 /*-
2  * Copyright (c) 1980, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)dump.h	8.2 (Berkeley) 4/28/95
34  *
35  * $FreeBSD$
36  */
37 
38 /*
39  * Dump maps used to describe what is to be dumped.
40  */
41 int	mapsize;	/* size of the state maps */
42 char	*usedinomap;	/* map of allocated inodes */
43 char	*dumpdirmap;	/* map of directories to be dumped */
44 char	*dumpinomap;	/* map of files to be dumped */
45 /*
46  * Map manipulation macros.
47  */
48 #define	SETINO(ino, map) \
49 	map[(u_int)((ino) - 1) / CHAR_BIT] |= \
50 	    1 << ((u_int)((ino) - 1) % CHAR_BIT)
51 #define	CLRINO(ino, map) \
52 	map[(u_int)((ino) - 1) / CHAR_BIT] &= \
53 	    ~(1 << ((u_int)((ino) - 1) % CHAR_BIT))
54 #define	TSTINO(ino, map) \
55 	(map[(u_int)((ino) - 1) / CHAR_BIT] & \
56 	    (1 << ((u_int)((ino) - 1) % CHAR_BIT)))
57 
58 /*
59  *	All calculations done in 0.1" units!
60  */
61 char	*disk;		/* name of the disk file */
62 char	*tape;		/* name of the tape file */
63 char	*dumpdates;	/* name of the file containing dump date information*/
64 char	*temp;		/* name of the file for doing rewrite of dumpdates */
65 char	lastlevel;	/* dump level of previous dump */
66 char	level;		/* dump level of this dump */
67 int	uflag;		/* update flag */
68 int	diskfd;		/* disk file descriptor */
69 int	tapefd;		/* tape file descriptor */
70 int	pipeout;	/* true => output to standard output */
71 ino_t	curino;		/* current inumber; used globally */
72 int	newtape;	/* new tape flag */
73 int	density;	/* density in 0.1" units */
74 long	tapesize;	/* estimated tape size, blocks */
75 long	tsize;		/* tape size in 0.1" units */
76 long	asize;		/* number of 0.1" units written on current tape */
77 int	etapes;		/* estimated number of tapes */
78 int	nonodump;	/* if set, do not honor UF_NODUMP user flags */
79 int	unlimited;	/* if set, write to end of medium */
80 int	cachesize;	/* size of block cache in bytes */
81 
82 int	notify;		/* notify operator flag */
83 int	blockswritten;	/* number of blocks written on current tape */
84 int	tapeno;		/* current tape number */
85 time_t	tstart_writing;	/* when started writing the first tape block */
86 time_t	tend_writing;	/* after writing the last tape block */
87 int	passno;		/* current dump pass number */
88 struct	fs *sblock;	/* the file system super block */
89 char	sblock_buf[MAXBSIZE];
90 long	dev_bsize;	/* block size of underlying disk device */
91 int	dev_bshift;	/* log2(dev_bsize) */
92 int	tp_bshift;	/* log2(TP_BSIZE) */
93 
94 /* operator interface functions */
95 void	broadcast(const char *message);
96 void	infosch(int);
97 void	lastdump(int arg);	/* int should be char */
98 void	msg(const char *fmt, ...) __printflike(1, 2);
99 void	msgtail(const char *fmt, ...) __printflike(1, 2);
100 int	query(const char *question);
101 void	quit(const char *fmt, ...) __printflike(1, 2);
102 void	timeest(void);
103 time_t	unctime(char *str);
104 
105 /* mapping rouintes */
106 union	dinode;
107 int	mapfiles(ino_t maxino, long *tapesize);
108 int	mapdirs(ino_t maxino, long *tapesize);
109 
110 /* file dumping routines */
111 void	ufs1_blksout(ufs1_daddr_t *blkp, int frags, ino_t ino);
112 void	ufs2_blksout(ufs2_daddr_t *blkp, int frags, ino_t ino);
113 void	bread(ufs2_daddr_t blkno, char *buf, int size);
114 void	dumpino(union dinode *dp, ino_t ino);
115 void	dumpmap(char *map, int type, ino_t ino);
116 void	writeheader(ino_t ino);
117 
118 /* tape writing routines */
119 int	alloctape(void);
120 void	close_rewind(void);
121 void	dumpblock(ufs2_daddr_t blkno, int size);
122 void	startnewtape(int top);
123 void	trewind(void);
124 void	writerec(char *dp, int isspcl);
125 
126 void	Exit(int status) __dead2;
127 void	dumpabort(int signo);
128 void	getfstab(void);
129 
130 char	*rawname(char *cp);
131 union	dinode *getino(ino_t inum, int *mode);
132 
133 /* rdump routines */
134 #ifdef RDUMP
135 void	rmtclose(void);
136 int	rmthost(const char *host);
137 int	rmtopen(const char *tape, int mode);
138 int	rmtwrite(const char *buf, int count);
139 #endif /* RDUMP */
140 
141 void	interrupt(int signo);	/* in case operator bangs on console */
142 
143 /*
144  *	Exit status codes
145  */
146 #define	X_FINOK		0	/* normal exit */
147 #define	X_STARTUP	1	/* startup error */
148 #define	X_REWRITE	2	/* restart writing from the check point */
149 #define	X_ABORT		3	/* abort dump; don't attempt checkpointing */
150 
151 #define	OPGRENT	"operator"		/* group entry to notify */
152 
153 struct	fstab *fstabsearch(const char *key); /* search fs_file and fs_spec */
154 
155 #ifndef NAME_MAX
156 #define NAME_MAX 255
157 #endif
158 
159 /*
160  *	The contents of the file _PATH_DUMPDATES is maintained both on
161  *	a linked list, and then (eventually) arrayified.
162  */
163 struct dumpdates {
164 	char	dd_name[NAME_MAX+3];
165 	char	dd_level;
166 	time_t	dd_ddate;
167 };
168 int	nddates;		/* number of records (might be zero) */
169 int	ddates_in;		/* we have read the increment file */
170 struct	dumpdates **ddatev;	/* the arrayfied version */
171 void	initdumptimes(void);
172 void	getdumptime(void);
173 void	putdumptime(void);
174 #define	ITITERATE(i, ddp) \
175 	for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
176 
177 void	sig(int signo);
178 
179 #ifndef	_PATH_FSTAB
180 #define	_PATH_FSTAB	"/etc/fstab"
181 #endif
182