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