xref: /freebsd/sbin/dump/dump.h (revision c11e094d96120a2e0e726ed9705ae0ec08db49b6)
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 #define MAXINOPB	(MAXBSIZE / sizeof(struct dinode))
39 #define MAXNINDIR	(MAXBSIZE / sizeof(daddr_t))
40 
41 /*
42  * Dump maps used to describe what is to be dumped.
43  */
44 int	mapsize;	/* size of the state maps */
45 char	*usedinomap;	/* map of allocated inodes */
46 char	*dumpdirmap;	/* map of directories to be dumped */
47 char	*dumpinomap;	/* map of files to be dumped */
48 /*
49  * Map manipulation macros.
50  */
51 #define	SETINO(ino, map) \
52 	map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
53 #define	CLRINO(ino, map) \
54 	map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
55 #define	TSTINO(ino, map) \
56 	(map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
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 
81 int	notify;		/* notify operator flag */
82 int	blockswritten;	/* number of blocks written on current tape */
83 int	tapeno;		/* current tape number */
84 time_t	tstart_writing;	/* when started writing the first tape block */
85 time_t	tend_writing;	/* after writing the last tape block */
86 int	passno;		/* current dump pass number */
87 struct	fs *sblock;	/* the filesystem super block */
88 char	sblock_buf[MAXBSIZE];
89 long	dev_bsize;	/* block size of underlying disk device */
90 int	dev_bshift;	/* log2(dev_bsize) */
91 int	tp_bshift;	/* log2(TP_BSIZE) */
92 
93 /* operator interface functions */
94 void	broadcast(const char *message);
95 void	infosch(int);
96 void	lastdump(int arg);	/* int should be char */
97 void	msg(const char *fmt, ...) __printflike(1, 2);
98 void	msgtail(const char *fmt, ...) __printflike(1, 2);
99 int	query(const char *question);
100 void	quit(const char *fmt, ...) __printflike(1, 2);
101 void	timeest(void);
102 time_t	unctime(char *str);
103 
104 /* mapping rouintes */
105 struct	dinode;
106 long	blockest(struct dinode *dp);
107 int	mapfiles(ino_t maxino, long *tapesize);
108 int	mapdirs(ino_t maxino, long *tapesize);
109 
110 /* file dumping routines */
111 void	blksout(daddr_t *blkp, int frags, ino_t ino);
112 void	bread(daddr_t blkno, char *buf, int size);
113 void	dumpino(struct dinode *dp, ino_t ino);
114 void	dumpmap(char *map, int type, ino_t ino);
115 void	writeheader(ino_t ino);
116 
117 /* tape writing routines */
118 int	alloctape(void);
119 void	close_rewind(void);
120 void	dumpblock(daddr_t blkno, int size);
121 void	startnewtape(int top);
122 void	trewind(void);
123 void	writerec(char *dp, int isspcl);
124 
125 void	Exit(int status) __dead2;
126 void	dumpabort(int signo);
127 void	getfstab(void);
128 
129 char	*rawname(char *cp);
130 struct	dinode *getino(ino_t inum);
131 
132 /* rdump routines */
133 #ifdef RDUMP
134 void	rmtclose(void);
135 int	rmthost(const char *host);
136 int	rmtopen(const char *tape, int mode);
137 int	rmtwrite(const char *buf, int count);
138 #endif /* RDUMP */
139 
140 void	interrupt(int signo);	/* in case operator bangs on console */
141 
142 /*
143  *	Exit status codes
144  */
145 #define	X_FINOK		0	/* normal exit */
146 #define	X_STARTUP	1	/* startup error */
147 #define	X_REWRITE	2	/* restart writing from the check point */
148 #define	X_ABORT		3	/* abort dump; don't attempt checkpointing */
149 
150 #define	OPGRENT	"operator"		/* group entry to notify */
151 
152 struct	fstab *fstabsearch(const char *key); /* search fs_file and fs_spec */
153 
154 #ifndef NAME_MAX
155 #define NAME_MAX 255
156 #endif
157 
158 /*
159  *	The contents of the file _PATH_DUMPDATES is maintained both on
160  *	a linked list, and then (eventually) arrayified.
161  */
162 struct dumpdates {
163 	char	dd_name[NAME_MAX+3];
164 	char	dd_level;
165 	time_t	dd_ddate;
166 };
167 int	nddates;		/* number of records (might be zero) */
168 int	ddates_in;		/* we have read the increment file */
169 struct	dumpdates **ddatev;	/* the arrayfied version */
170 void	initdumptimes(void);
171 void	getdumptime(void);
172 void	putdumptime(void);
173 #define	ITITERATE(i, ddp) \
174 	for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
175 
176 void	sig(int signo);
177 
178 #ifndef	_PATH_UTMP
179 #define	_PATH_UTMP	"/etc/utmp"
180 #endif
181 #ifndef	_PATH_FSTAB
182 #define	_PATH_FSTAB	"/etc/fstab"
183 #endif
184