xref: /freebsd/sbin/dump/dump.h (revision b52b9d56d4e96089873a75f9e29062eec19fabba)
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) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
50 #define	CLRINO(ino, map) \
51 	map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
52 #define	TSTINO(ino, map) \
53 	(map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
54 
55 /*
56  *	All calculations done in 0.1" units!
57  */
58 char	*disk;		/* name of the disk file */
59 char	*tape;		/* name of the tape file */
60 char	*dumpdates;	/* name of the file containing dump date information*/
61 char	*temp;		/* name of the file for doing rewrite of dumpdates */
62 char	lastlevel;	/* dump level of previous dump */
63 char	level;		/* dump level of this dump */
64 int	uflag;		/* update flag */
65 int	diskfd;		/* disk file descriptor */
66 int	tapefd;		/* tape file descriptor */
67 int	pipeout;	/* true => output to standard output */
68 ino_t	curino;		/* current inumber; used globally */
69 int	newtape;	/* new tape flag */
70 int	density;	/* density in 0.1" units */
71 long	tapesize;	/* estimated tape size, blocks */
72 long	tsize;		/* tape size in 0.1" units */
73 long	asize;		/* number of 0.1" units written on current tape */
74 int	etapes;		/* estimated number of tapes */
75 int	nonodump;	/* if set, do not honor UF_NODUMP user flags */
76 int	unlimited;	/* if set, write to end of medium */
77 
78 int	notify;		/* notify operator flag */
79 int	blockswritten;	/* number of blocks written on current tape */
80 int	tapeno;		/* current tape number */
81 time_t	tstart_writing;	/* when started writing the first tape block */
82 time_t	tend_writing;	/* after writing the last tape block */
83 int	passno;		/* current dump pass number */
84 struct	fs *sblock;	/* the filesystem super block */
85 char	sblock_buf[MAXBSIZE];
86 long	dev_bsize;	/* block size of underlying disk device */
87 int	dev_bshift;	/* log2(dev_bsize) */
88 int	tp_bshift;	/* log2(TP_BSIZE) */
89 
90 /* operator interface functions */
91 void	broadcast(const char *message);
92 void	infosch(int);
93 void	lastdump(int arg);	/* int should be char */
94 void	msg(const char *fmt, ...) __printflike(1, 2);
95 void	msgtail(const char *fmt, ...) __printflike(1, 2);
96 int	query(const char *question);
97 void	quit(const char *fmt, ...) __printflike(1, 2);
98 void	timeest(void);
99 time_t	unctime(char *str);
100 
101 /* mapping rouintes */
102 union	dinode;
103 long	blockest(union dinode *dp);
104 int	mapfiles(ino_t maxino, long *tapesize);
105 int	mapdirs(ino_t maxino, long *tapesize);
106 
107 /* file dumping routines */
108 void	ufs1_blksout(ufs1_daddr_t *blkp, int frags, ino_t ino);
109 void	ufs2_blksout(ufs2_daddr_t *blkp, int frags, ino_t ino);
110 void	bread(ufs2_daddr_t blkno, char *buf, int size);
111 void	dumpino(union dinode *dp, ino_t ino);
112 void	dumpmap(char *map, int type, ino_t ino);
113 void	writeheader(ino_t ino);
114 
115 /* tape writing routines */
116 int	alloctape(void);
117 void	close_rewind(void);
118 void	dumpblock(ufs2_daddr_t blkno, int size);
119 void	startnewtape(int top);
120 void	trewind(void);
121 void	writerec(char *dp, int isspcl);
122 
123 void	Exit(int status) __dead2;
124 void	dumpabort(int signo);
125 void	getfstab(void);
126 
127 char	*rawname(char *cp);
128 union	dinode *getino(ino_t inum, int *mode);
129 
130 /* rdump routines */
131 #ifdef RDUMP
132 void	rmtclose(void);
133 int	rmthost(const char *host);
134 int	rmtopen(const char *tape, int mode);
135 int	rmtwrite(const char *buf, int count);
136 #endif /* RDUMP */
137 
138 void	interrupt(int signo);	/* in case operator bangs on console */
139 
140 /*
141  *	Exit status codes
142  */
143 #define	X_FINOK		0	/* normal exit */
144 #define	X_STARTUP	1	/* startup error */
145 #define	X_REWRITE	2	/* restart writing from the check point */
146 #define	X_ABORT		3	/* abort dump; don't attempt checkpointing */
147 
148 #define	OPGRENT	"operator"		/* group entry to notify */
149 
150 struct	fstab *fstabsearch(const char *key); /* search fs_file and fs_spec */
151 
152 #ifndef NAME_MAX
153 #define NAME_MAX 255
154 #endif
155 
156 /*
157  *	The contents of the file _PATH_DUMPDATES is maintained both on
158  *	a linked list, and then (eventually) arrayified.
159  */
160 struct dumpdates {
161 	char	dd_name[NAME_MAX+3];
162 	char	dd_level;
163 	time_t	dd_ddate;
164 };
165 int	nddates;		/* number of records (might be zero) */
166 int	ddates_in;		/* we have read the increment file */
167 struct	dumpdates **ddatev;	/* the arrayfied version */
168 void	initdumptimes(void);
169 void	getdumptime(void);
170 void	putdumptime(void);
171 #define	ITITERATE(i, ddp) \
172 	for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
173 
174 void	sig(int signo);
175 
176 #ifndef	_PATH_FSTAB
177 #define	_PATH_FSTAB	"/etc/fstab"
178 #endif
179