[dump.git] / dump / dump.h

/*
 *	Ported to Linux's Second Extended File System as part of the
 *	dump and restore backup suit
 *	Remy Card <card@Linux.EU.Org>, 1994-1997
 *	Stelian Pop <pop@cybercable.fr>, 1999-2000
 *
 *	$Id: dump.h,v 1.14 2000/11/10 11:48:31 stelian Exp $
 */

/*-
 * Copyright (c) 1980, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#define MAXINOPB	(MAXBSIZE / sizeof(struct dinode))
#define MAXNINDIR	(MAXBSIZE / sizeof(daddr_t))

/*
 * Dump maps used to describe what is to be dumped.
 */
int	mapsize;	/* size of the state maps */
char	*usedinomap;	/* map of allocated inodes */
char	*dumpdirmap;	/* map of directories to be dumped */
char	*dumpinomap;	/* map of files to be dumped */
/*
 * Map manipulation macros.
 */
#define	SETINO(ino, map) \
	map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
#define	CLRINO(ino, map) \
	map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
#define	TSTINO(ino, map) \
	(map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))

/*
 *	All calculations done in 0.1" units!
 */
char	*disk;		/* name of the disk file */
char	tape[MAXPATHLEN];	/* name of the tape file */
char	*tapeprefix;	/* prefix of the tape file */
char	*dumpdates;	/* name of the file containing dump date information*/
char	lastlevel;	/* dump level of previous dump */
char	level;		/* dump level of this dump */
int	uflag;		/* update flag */
int	Mflag;		/* multi-volume flag */
char	*eot_script;	/* end of volume script fiag */
int	diskfd;		/* disk file descriptor */
int	tapefd;		/* tape file descriptor */
int	pipeout;	/* true => output to standard output */
ino_t	curino;		/* current inumber; used globally */
int	newtape;	/* new tape flag */
int	density;	/* density in 0.1" units */
long	tapesize;	/* estimated tape size, blocks */
long	tsize;		/* tape size in 0.1" units */
long	asize;		/* number of 0.1" units written on current tape */
int	etapes;		/* estimated number of tapes */
int	nonodump;	/* if set, do not honor UF_NODUMP user flags */
int	unlimited;	/* if set, write to end of medium */

int	notify;		/* notify operator flag */
int	blockswritten;	/* number of blocks written on current tape */
int	tapeno;		/* current tape number */
time_t	tstart_writing;	/* when started writing the first tape block */
time_t	tend_writing;	/* after writing the last tape block */
#ifdef __linux__
ext2_filsys fs;
#else
struct	fs *sblock;	/* the file system super block */
char	sblock_buf[MAXBSIZE];
#endif
long	xferrate;       /* averaged transfer rate of all volumes */
long	dev_bsize;	/* block size of underlying disk device */
int	dev_bshift;	/* log2(dev_bsize) */
int	tp_bshift;	/* log2(TP_BSIZE) */

#ifndef __P
#include <sys/cdefs.h>
#endif

/* operator interface functions */
void	broadcast __P((const char *message));
time_t	do_stats __P((void));
void	lastdump __P((char arg));
void	msg __P((const char *fmt, ...));
void	msgtail __P((const char *fmt, ...));
int	query __P((const char *question));
void	quit __P((const char *fmt, ...));
void	set_operators __P((void));
#if defined(SIGINFO)
void	statussig __P((int signo));
#endif
void	timeest __P((void));
time_t	unctime __P((const char *str));

/* mapping rouintes */
struct	dinode;
long	blockest __P((struct dinode *dp));
int	mapfiles __P((ino_t maxino, long *tapesize));
#ifdef	__linux__
int	mapfilesfromdir __P((ino_t maxino, long *tapesize, char *directory));
#endif
int	mapdirs __P((ino_t maxino, long *tapesize));

/* file dumping routines */
void	blksout __P((daddr_t *blkp, int frags, ino_t ino));
void	bread __P((daddr_t blkno, char *buf, int size));
void	dumpino __P((struct dinode *dp, ino_t ino));
#ifdef	__linux__
void	dumpdirino __P((struct dinode *dp, ino_t ino));
#endif
void	dumpmap __P((char *map, int type, ino_t ino));
void	writeheader __P((ino_t ino));

/* tape writing routines */
int	alloctape __P((void));
void	close_rewind __P((void));
void	dumpblock __P((daddr_t blkno, int size));
void	startnewtape __P((int top));
time_t	trewind __P((void));
void	writerec __P((const void *dp, int isspcl));

void 	Exit __P((int status));
void	dumpabort __P((int signo));
void	getfstab __P((void));

char	*rawname __P((char *cp));
struct	dinode *getino __P((ino_t inum));

/* rdump routines */
#ifdef RDUMP
int	rmthost __P((const char *host));
int	rmtopen __P((const char *tape, int mode));
void	rmtclose __P((void));
int	rmtread __P((char *buf, size_t count));
int	rmtwrite __P((const char *buf, size_t count));
int	rmtseek __P((int offset, int pos));
struct mtget * rmtstatus __P((void));
int	rmtioctl __P((int cmd, int count));
#endif /* RDUMP */

void	interrupt __P((int signo));	/* in case operator bangs on console */

/*
 *	Exit status codes
 */
#define	X_FINOK		0	/* normal exit */
#define	X_STARTUP	1	/* startup error */
#define	X_REWRITE	2	/* restart writing from the check point */
#define	X_ABORT		3	/* abort dump; don't attempt checkpointing */

#define	OPGRENT	"operator"		/* group entry to notify */
#ifdef	__linux__
#define DIALUP	"ttyS"			/* prefix for dialups */
#else
#define DIALUP	"ttyd"			/* prefix for dialups */
#endif

struct	fstab *fstabsearch __P((const char *key));	/* search fs_file and fs_spec */
#ifdef	__linux__
struct	fstab *fstabsearchdir __P((const char *key, char *dir));	/* search fs_file and fs_spec */
#endif

/*
 *	The contents of the file _PATH_DUMPDATES is maintained both on
 *	a linked list, and then (eventually) arrayified.
 */
struct dumpdates {
	char	dd_name[MAXPATHLEN+3];
	struct fstab *dd_fstab;
	char	dd_level;
	time_t	dd_ddate;
};
struct dumptime {
	struct	dumpdates dt_value;
	struct	dumptime *dt_next;
};
struct	dumptime *dthead;	/* head of the list version */
int	nddates;		/* number of records (might be zero) */
int	ddates_in;		/* we have read the increment file */
struct	dumpdates **ddatev;	/* the arrayfied version */
void	initdumptimes __P((int));
void	getdumptime __P((int));
void	putdumptime __P((void));
#define	ITITERATE(i, ddp) \
	for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])

void	sig __P((int signo));

/*
 * Compatibility with old systems.
 */
#ifdef COMPAT
#include <sys/file.h>
#define	strchr(a,b)	index(a,b)
#define	strrchr(a,b)	rindex(a,b)
extern char *strdup(), *ctime();
extern int read(), write();
extern int errno;
#endif

#ifdef	__linux__
#define	DUMP_CURRENT_REV	1

int dump_fs_open(const char *disk, ext2_filsys *fs);
#endif

#ifndef	__linux__
#ifndef	_PATH_UTMP
#define	_PATH_UTMP	"/etc/utmp"
#endif
#ifndef	_PATH_FSTAB
#define	_PATH_FSTAB	"/etc/fstab"
#endif
#endif

#ifdef sunos
extern char *calloc();
extern char *malloc();
extern long atol();
extern char *strcpy();
extern char *strncpy();
extern char *strcat();
extern time_t time();
extern void endgrent();
extern void exit();
extern off_t lseek();
extern const char *strerror();
#endif

				/* 04-Feb-00 ILC */
#define IEXCLUDE_MAXNUM 256	/* max size of inode exclude list */
Commit	Line	Data
1227625a SP	1	/*
	2	* Ported to Linux's Second Extended File System as part of the
	3	* dump and restore backup suit
b45f51d6	4	* Remy Card <card@Linux.EU.Org>, 1994-1997
ebcbe7f6	5	* Stelian Pop <pop@cybercable.fr>, 1999-2000
1227625a	6	*
51b01afe	7	* $Id: dump.h,v 1.14 2000/11/10 11:48:31 stelian Exp $
1227625a SP	8	*/
	9
	10	/*-
	11	* Copyright (c) 1980, 1993
	12	* The Regents of the University of California. All rights reserved.
	13	*
	14	* Redistribution and use in source and binary forms, with or without
	15	* modification, are permitted provided that the following conditions
	16	* are met:
	17	* 1. Redistributions of source code must retain the above copyright
	18	* notice, this list of conditions and the following disclaimer.
	19	* 2. Redistributions in binary form must reproduce the above copyright
	20	* notice, this list of conditions and the following disclaimer in the
	21	* documentation and/or other materials provided with the distribution.
	22	* 3. All advertising materials mentioning features or use of this software
	23	* must display the following acknowledgement:
	24	* This product includes software developed by the University of
	25	* California, Berkeley and its contributors.
	26	* 4. Neither the name of the University nor the names of its contributors
	27	* may be used to endorse or promote products derived from this software
	28	* without specific prior written permission.
	29	*
	30	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	31	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	32	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	33	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	34	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	35	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	36	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	37	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	38	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	39	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	40	* SUCH DAMAGE.
1227625a SP	41	*/
	42
	43	#define MAXINOPB (MAXBSIZE / sizeof(struct dinode))
	44	#define MAXNINDIR (MAXBSIZE / sizeof(daddr_t))
	45
	46	/*
	47	* Dump maps used to describe what is to be dumped.
	48	*/
	49	int mapsize; /* size of the state maps */
	50	char usedinomap; / map of allocated inodes */
	51	char dumpdirmap; / map of directories to be dumped */
	52	char dumpinomap; / map of files to be dumped */
	53	/*
	54	* Map manipulation macros.
	55	*/
	56	#define SETINO(ino, map) \
	57	map[(u_int)((ino) - 1) / NBBY] \|= 1 << ((u_int)((ino) - 1) % NBBY)
	58	#define CLRINO(ino, map) \
	59	map[(u_int)((ino) - 1) / NBBY] &= ~(1 << ((u_int)((ino) - 1) % NBBY))
	60	#define TSTINO(ino, map) \
	61	(map[(u_int)((ino) - 1) / NBBY] & (1 << ((u_int)((ino) - 1) % NBBY)))
	62
	63	/*
	64	* All calculations done in 0.1" units!
	65	*/
	66	char disk; / name of the disk file */
92a9bf12	67	char tape[MAXPATHLEN]; /* name of the tape file */
d1c73b9a	68	char tapeprefix; / prefix of the tape file */
1227625a	69	char dumpdates; / name of the file containing dump date information*/
1227625a SP	70	char lastlevel; /* dump level of previous dump */
	71	char level; /* dump level of this dump */
	72	int uflag; /* update flag */
d1c73b9a	73	int Mflag; /* multi-volume flag */
0d7af9c5	74	char eot_script; / end of volume script fiag */
1227625a SP	75	int diskfd; /* disk file descriptor */
	76	int tapefd; /* tape file descriptor */
	77	int pipeout; /* true => output to standard output */
	78	ino_t curino; /* current inumber; used globally */
	79	int newtape; /* new tape flag */
	80	int density; /* density in 0.1" units */
	81	long tapesize; /* estimated tape size, blocks */
	82	long tsize; /* tape size in 0.1" units */
	83	long asize; /* number of 0.1" units written on current tape */
	84	int etapes; /* estimated number of tapes */
	85	int nonodump; /* if set, do not honor UF_NODUMP user flags */
b45f51d6	86	int unlimited; /* if set, write to end of medium */
1227625a SP	87
	88	int notify; /* notify operator flag */
	89	int blockswritten; /* number of blocks written on current tape */
	90	int tapeno; /* current tape number */
	91	time_t tstart_writing; /* when started writing the first tape block */
b45f51d6	92	time_t tend_writing; /* after writing the last tape block */
1227625a	93	#ifdef __linux__
1227625a SP	94	ext2_filsys fs;
	95	#else
	96	struct fs sblock; / the file system super block */
	97	char sblock_buf[MAXBSIZE];
	98	#endif
ddd2ef55	99	long xferrate; /* averaged transfer rate of all volumes */
1227625a SP	100	long dev_bsize; /* block size of underlying disk device */
	101	int dev_bshift; /* log2(dev_bsize) */
	102	int tp_bshift; /* log2(TP_BSIZE) */
	103
	104	#ifndef __P
	105	#include <sys/cdefs.h>
	106	#endif
	107
	108	/* operator interface functions */
ddd2ef55 SP	109	void broadcast __P((const char *message));
	110	time_t do_stats __P((void));
	111	void lastdump __P((char arg));
1227625a SP	112	void msg __P((const char *fmt, ...));
1227625a SP	113	void msgtail __P((const char *fmt, ...));
ddd2ef55	114	int query __P((const char *question));
1227625a SP	115	void quit __P((const char *fmt, ...));
1227625a SP	116	void set_operators __P((void));
ddd2ef55 SP	117	#if defined(SIGINFO)
	118	void statussig __P((int signo));
	119	#endif
1227625a	120	void timeest __P((void));
ddd2ef55	121	time_t unctime __P((const char *str));
1227625a SP	122
	123	/* mapping rouintes */
	124	struct dinode;
	125	long blockest __P((struct dinode *dp));
	126	int mapfiles __P((ino_t maxino, long *tapesize));
	127	#ifdef __linux__
	128	int mapfilesfromdir __P((ino_t maxino, long tapesize, char directory));
	129	#endif
	130	int mapdirs __P((ino_t maxino, long *tapesize));
	131
	132	/* file dumping routines */
	133	void blksout __P((daddr_t *blkp, int frags, ino_t ino));
b45f51d6	134	void bread __P((daddr_t blkno, char *buf, int size));
1227625a SP	135	void dumpino __P((struct dinode *dp, ino_t ino));
	136	#ifdef __linux__
	137	void dumpdirino __P((struct dinode *dp, ino_t ino));
	138	#endif
	139	void dumpmap __P((char *map, int type, ino_t ino));
	140	void writeheader __P((ino_t ino));
	141
	142	/* tape writing routines */
	143	int alloctape __P((void));
	144	void close_rewind __P((void));
	145	void dumpblock __P((daddr_t blkno, int size));
	146	void startnewtape __P((int top));
0d7af9c5	147	time_t trewind __P((void));
ddd2ef55	148	void writerec __P((const void *dp, int isspcl));
1227625a	149
ddd2ef55	150	void Exit __P((int status));
1227625a SP	151	void dumpabort __P((int signo));
	152	void getfstab __P((void));
	153
	154	char rawname __P((char cp));
	155	struct dinode *getino __P((ino_t inum));
	156
	157	/* rdump routines */
	158	#ifdef RDUMP
ddd2ef55 SP	159	int rmthost __P((const char *host));
ddd2ef55 SP	160	int rmtopen __P((const char *tape, int mode));
1227625a	161	void rmtclose __P((void));
ddd2ef55 SP	162	int rmtread __P((char *buf, size_t count));
	163	int rmtwrite __P((const char *buf, size_t count));
	164	int rmtseek __P((int offset, int pos));
	165	struct mtget * rmtstatus __P((void));
	166	int rmtioctl __P((int cmd, int count));
1227625a SP	167	#endif /* RDUMP */
	168
	169	void interrupt __P((int signo)); /* in case operator bangs on console */
	170
	171	/*
	172	* Exit status codes
	173	*/
	174	#define X_FINOK 0 /* normal exit */
ddd2ef55	175	#define X_STARTUP 1 /* startup error */
1227625a SP	176	#define X_REWRITE 2 /* restart writing from the check point */
	177	#define X_ABORT 3 /* abort dump; don't attempt checkpointing */
	178
	179	#define OPGRENT "operator" /* group entry to notify */
	180	#ifdef __linux__
	181	#define DIALUP "ttyS" /* prefix for dialups */
	182	#else
	183	#define DIALUP "ttyd" /* prefix for dialups */
	184	#endif
	185
ddd2ef55	186	struct fstab fstabsearch __P((const char key)); /* search fs_file and fs_spec */
1227625a	187	#ifdef __linux__
ddd2ef55	188	struct fstab fstabsearchdir __P((const char key, char dir)); / search fs_file and fs_spec */
1227625a SP	189	#endif
1227625a SP	190
1227625a SP	191	/*
	192	* The contents of the file _PATH_DUMPDATES is maintained both on
	193	* a linked list, and then (eventually) arrayified.
	194	*/
	195	struct dumpdates {
92a9bf12	196	char dd_name[MAXPATHLEN+3];
51b01afe	197	struct fstab *dd_fstab;
1227625a SP	198	char dd_level;
	199	time_t dd_ddate;
	200	};
	201	struct dumptime {
	202	struct dumpdates dt_value;
	203	struct dumptime *dt_next;
	204	};
	205	struct dumptime dthead; / head of the list version */
	206	int nddates; /* number of records (might be zero) */
	207	int ddates_in; /* we have read the increment file */
	208	struct dumpdates *ddatev; / the arrayfied version */
8d4197bb SP	209	void initdumptimes __P((int));
8d4197bb SP	210	void getdumptime __P((int));
1227625a SP	211	void putdumptime __P((void));
	212	#define ITITERATE(i, ddp) \
	213	for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
	214
	215	void sig __P((int signo));
	216
	217	/*
	218	* Compatibility with old systems.
	219	*/
	220	#ifdef COMPAT
	221	#include <sys/file.h>
	222	#define strchr(a,b) index(a,b)
	223	#define strrchr(a,b) rindex(a,b)
	224	extern char strdup(), ctime();
	225	extern int read(), write();
	226	extern int errno;
	227	#endif
	228
	229	#ifdef __linux__
8d4197bb	230	#define DUMP_CURRENT_REV 1
c930abff SP	231
c930abff SP	232	int dump_fs_open(const char disk, ext2_filsys fs);
1227625a SP	233	#endif
	234
	235	#ifndef __linux__
	236	#ifndef _PATH_UTMP
	237	#define _PATH_UTMP "/etc/utmp"
	238	#endif
	239	#ifndef _PATH_FSTAB
	240	#define _PATH_FSTAB "/etc/fstab"
	241	#endif
	242	#endif
	243
	244	#ifdef sunos
	245	extern char *calloc();
	246	extern char *malloc();
	247	extern long atol();
	248	extern char *strcpy();
	249	extern char *strncpy();
	250	extern char *strcat();
	251	extern time_t time();
	252	extern void endgrent();
b45f51d6	253	extern void exit();
1227625a SP	254	extern off_t lseek();
	255	extern const char *strerror();
	256	#endif
20c345aa SP	257
	258	/* 04-Feb-00 ILC */
	259	#define IEXCLUDE_MAXNUM 256 /* max size of inode exclude list */
	260