xref: /dragonfly/sbin/dump/dump.h (revision 1de703da)
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: src/sbin/dump/dump.h,v 1.7.6.4 2003/01/25 18:54:59 dillon Exp $
36  * $DragonFly: src/sbin/dump/dump.h,v 1.2 2003/06/17 04:27:32 dillon Exp $
37  */
38 
39 #define MAXINOPB	(MAXBSIZE / sizeof(struct dinode))
40 #define MAXNINDIR	(MAXBSIZE / sizeof(daddr_t))
41 
42 /*
43  * Dump maps used to describe what is to be dumped.
44  */
45 int	mapsize;	/* size of the state maps */
46 char	*usedinomap;	/* map of allocated inodes */
47 char	*dumpdirmap;	/* map of directories to be dumped */
48 char	*dumpinomap;	/* map of files to be dumped */
49 /*
50  * Map manipulation macros.
51  */
52 #define	SETINO(ino, map) \
53 	map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
54 #define	CLRINO(ino, map) \
55 	map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
56 #define	TSTINO(ino, map) \
57 	(map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
58 
59 /*
60  *	All calculations done in 0.1" units!
61  */
62 char	*disk;		/* name of the disk file */
63 char	*tape;		/* name of the tape file */
64 char	*dumpdates;	/* name of the file containing dump date information*/
65 char	*temp;		/* name of the file for doing rewrite of dumpdates */
66 char	lastlevel;	/* dump level of previous dump */
67 char	level;		/* dump level of this dump */
68 int	uflag;		/* update flag */
69 int	diskfd;		/* disk file descriptor */
70 int	tapefd;		/* tape file descriptor */
71 int	pipeout;	/* true => output to standard output */
72 ino_t	curino;		/* current inumber; used globally */
73 int	newtape;	/* new tape flag */
74 int	density;	/* density in 0.1" units */
75 long	tapesize;	/* estimated tape size, blocks */
76 long	tsize;		/* tape size in 0.1" units */
77 long	asize;		/* number of 0.1" units written on current tape */
78 int	etapes;		/* estimated number of tapes */
79 int	nonodump;	/* if set, do not honor UF_NODUMP user flags */
80 int	unlimited;	/* if set, write to end of medium */
81 int	cachesize;	/* size of block cache */
82 
83 int	notify;		/* notify operator flag */
84 int	blockswritten;	/* number of blocks written on current tape */
85 int	tapeno;		/* current tape number */
86 time_t	tstart_writing;	/* when started writing the first tape block */
87 time_t	tend_writing;	/* after writing the last tape block */
88 int	passno;		/* current dump pass number */
89 struct	fs *sblock;	/* the file system super block */
90 char	sblock_buf[MAXBSIZE];
91 long	dev_bsize;	/* block size of underlying disk device */
92 int	dev_bshift;	/* log2(dev_bsize) */
93 int	tp_bshift;	/* log2(TP_BSIZE) */
94 
95 #ifndef __P
96 #include <sys/cdefs.h>
97 #endif
98 
99 /* operator interface functions */
100 void	broadcast __P((char *message));
101 void	infosch __P((int));
102 void	lastdump __P((int arg));	/* int should be char */
103 void	msg __P((const char *fmt, ...)) __printflike(1, 2);
104 void	msgtail __P((const char *fmt, ...)) __printflike(1, 2);
105 int	query __P((char *question));
106 void	quit __P((const char *fmt, ...)) __printflike(1, 2);
107 void	timeest __P((void));
108 time_t	unctime __P((char *str));
109 
110 /* mapping rouintes */
111 struct	dinode;
112 long	blockest __P((struct dinode *dp));
113 int	mapfiles __P((ino_t maxino, long *tapesize));
114 int	mapdirs __P((ino_t maxino, long *tapesize));
115 
116 /* file dumping routines */
117 void	blksout __P((daddr_t *blkp, int frags, ino_t ino));
118 void	bread __P((daddr_t blkno, char *buf, int size));
119 void	dumpino __P((struct dinode *dp, ino_t ino));
120 void	dumpmap __P((char *map, int type, ino_t ino));
121 void	writeheader __P((ino_t ino));
122 
123 /* tape writing routines */
124 int	alloctape __P((void));
125 void	close_rewind __P((void));
126 void	dumpblock __P((daddr_t blkno, int size));
127 void	startnewtape __P((int top));
128 void	trewind __P((void));
129 void	writerec __P((char *dp, int isspcl));
130 
131 void	Exit __P((int status)) __dead2;
132 void	dumpabort __P((int signo));
133 void	getfstab __P((void));
134 
135 char	*rawname __P((char *cp));
136 struct	dinode *getino __P((ino_t inum));
137 
138 /* rdump routines */
139 #ifdef RDUMP
140 void	rmtclose __P((void));
141 int	rmthost __P((char *host));
142 int	rmtopen __P((char *tape, int mode));
143 int	rmtwrite __P((char *buf, int count));
144 #endif /* RDUMP */
145 
146 void	interrupt __P((int signo));	/* in case operator bangs on console */
147 
148 /*
149  *	Exit status codes
150  */
151 #define	X_FINOK		0	/* normal exit */
152 #define	X_STARTUP	1	/* startup error */
153 #define	X_REWRITE	2	/* restart writing from the check point */
154 #define	X_ABORT		3	/* abort dump; don't attempt checkpointing */
155 
156 #define	OPGRENT	"operator"		/* group entry to notify */
157 
158 struct	fstab *fstabsearch __P((char *key));	/* search fs_file and fs_spec */
159 
160 #ifndef NAME_MAX
161 #define NAME_MAX 255
162 #endif
163 
164 /*
165  *	The contents of the file _PATH_DUMPDATES is maintained both on
166  *	a linked list, and then (eventually) arrayified.
167  */
168 struct dumpdates {
169 	char	dd_name[NAME_MAX+3];
170 	char	dd_level;
171 	time_t	dd_ddate;
172 };
173 int	nddates;		/* number of records (might be zero) */
174 int	ddates_in;		/* we have read the increment file */
175 struct	dumpdates **ddatev;	/* the arrayfied version */
176 void	initdumptimes __P((void));
177 void	getdumptime __P((void));
178 void	putdumptime __P((void));
179 #define	ITITERATE(i, ddp) \
180 	for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
181 
182 void	sig __P((int signo));
183 
184 /*
185  * Compatibility with old systems.
186  */
187 #ifdef COMPAT
188 #include <sys/file.h>
189 #define	strchr(a,b)	index(a,b)
190 #define	strrchr(a,b)	rindex(a,b)
191 extern char *strdup(), *ctime();
192 extern int read(), write();
193 extern int errno;
194 #endif
195 
196 #ifndef	_PATH_UTMP
197 #define	_PATH_UTMP	"/etc/utmp"
198 #endif
199 #ifndef	_PATH_FSTAB
200 #define	_PATH_FSTAB	"/etc/fstab"
201 #endif
202 
203 #ifdef sunos
204 extern char *calloc();
205 extern char *malloc();
206 extern long atol();
207 extern char *strcpy();
208 extern char *strncpy();
209 extern char *strcat();
210 extern time_t time();
211 extern void endgrent();
212 extern void exit();
213 extern off_t lseek();
214 extern const char *strerror();
215 #endif
216