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 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)dump.h	8.2 (Berkeley) 4/28/95
30 *
31 * $FreeBSD$
32 */
33
34/*
35 * Dump maps used to describe what is to be dumped.
36 */
37int	mapsize;	/* size of the state maps */
38char	*usedinomap;	/* map of allocated inodes */
39char	*dumpdirmap;	/* map of directories to be dumped */
40char	*dumpinomap;	/* map of files to be dumped */
41/*
42 * Map manipulation macros.
43 */
44#define	SETINO(ino, map) \
45	map[(u_int)((ino) - 1) / CHAR_BIT] |= \
46	    1 << ((u_int)((ino) - 1) % CHAR_BIT)
47#define	CLRINO(ino, map) \
48	map[(u_int)((ino) - 1) / CHAR_BIT] &= \
49	    ~(1 << ((u_int)((ino) - 1) % CHAR_BIT))
50#define	TSTINO(ino, map) \
51	(map[(u_int)((ino) - 1) / CHAR_BIT] & \
52	    (1 << ((u_int)((ino) - 1) % CHAR_BIT)))
53
54/*
55 *	All calculations done in 0.1" units!
56 */
57char	*disk;		/* name of the disk file */
58char	*tape;		/* name of the tape file */
59char	*popenout;	/* popen(3) per-"tape" command */
60char	*dumpdates;	/* name of the file containing dump date information*/
61char	*temp;		/* name of the file for doing rewrite of dumpdates */
62int	lastlevel;	/* dump level of previous dump */
63int	level;		/* dump level of this dump */
64int	uflag;		/* update flag */
65int	diskfd;		/* disk file descriptor */
66int	tapefd;		/* tape file descriptor */
67int	pipeout;	/* true => output to standard output */
68ino_t	curino;		/* current inumber; used globally */
69int	newtape;	/* new tape flag */
70int	density;	/* density in 0.1" units */
71long	tapesize;	/* estimated tape size, blocks */
72long	tsize;		/* tape size in 0.1" units */
73long	asize;		/* number of 0.1" units written on current tape */
74int	etapes;		/* estimated number of tapes */
75int	nonodump;	/* if set, do not honor UF_NODUMP user flags */
76int	unlimited;	/* if set, write to end of medium */
77int	cachesize;	/* size of block cache in bytes */
78int	rsync_friendly;	/* be friendly with rsync */
79
80int	notify;		/* notify operator flag */
81int	blockswritten;	/* number of blocks written on current tape */
82int	tapeno;		/* current tape number */
83time_t	tstart_writing;	/* when started writing the first tape block */
84time_t	tend_writing;	/* after writing the last tape block */
85int	passno;		/* current dump pass number */
86struct	fs *sblock;	/* the file system super block */
87char	sblock_buf[MAXBSIZE];
88long	dev_bsize;	/* block size of underlying disk device */
89int	dev_bshift;	/* log2(dev_bsize) */
90int	tp_bshift;	/* log2(TP_BSIZE) */
91
92/* operator interface functions */
93void	broadcast(const char *message);
94void	infosch(int);
95void	lastdump(int arg);	/* int should be char */
96void	msg(const char *fmt, ...) __printflike(1, 2);
97void	msgtail(const char *fmt, ...) __printflike(1, 2);
98int	query(const char *question);
99void	quit(const char *fmt, ...) __printflike(1, 2);
100void	timeest(void);
101time_t	unctime(char *str);
102
103/* mapping rouintes */
104union	dinode;
105int	mapfiles(ino_t maxino, long *tapesize);
106int	mapdirs(ino_t maxino, long *tapesize);
107
108/* file dumping routines */
109void	bread(ufs2_daddr_t blkno, char *buf, int size);
110ssize_t cread(int fd, void *buf, size_t nbytes, off_t offset);
111void	dumpino(union dinode *dp, ino_t ino);
112void	dumpmap(char *map, int type, ino_t ino);
113void	writeheader(ino_t ino);
114
115/* tape writing routines */
116int	alloctape(void);
117void	close_rewind(void);
118void	dumpblock(ufs2_daddr_t blkno, int size);
119void	startnewtape(int top);
120void	trewind(void);
121void	writerec(char *dp, int isspcl);
122
123void	Exit(int status) __dead2;
124void	dumpabort(int signo) __dead2;
125void	dump_getfstab(void);
126
127char	*rawname(char *cp);
128union	dinode *getino(ino_t inum, int *mode);
129
130/* rdump routines */
131#ifdef RDUMP
132void	rmtclose(void);
133int	rmthost(const char *host);
134int	rmtopen(const char *tape, int mode);
135int	rmtwrite(const char *buf, int count);
136#endif /* RDUMP */
137
138void	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
150struct	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 */
160struct dumpdates {
161	char	dd_name[NAME_MAX+3];
162	int	dd_level;
163	time_t	dd_ddate;
164};
165int	nddates;		/* number of records (might be zero) */
166struct	dumpdates **ddatev;	/* the arrayfied version */
167void	initdumptimes(void);
168void	getdumptime(void);
169void	putdumptime(void);
170#define	ITITERATE(i, ddp) \
171    	if (ddatev != NULL) \
172		for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
173
174#define	DUMPFMTLEN	53			/* max device pathname length */
175#define	DUMPOUTFMT	"%-*s %d %s"		/* for printf */
176						/* name, level, ctime(date) */
177#define	DUMPINFMT	"%s %d %[^\n]\n"	/* inverse for scanf */
178
179void	sig(int signo);
180
181#ifndef	_PATH_FSTAB
182#define	_PATH_FSTAB	"/etc/fstab"
183#endif
184