2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 * @(#)dump.h 8.2 (Berkeley) 4/28/95
37 * Dump maps used to describe what is to be dumped.
39 int mapsize; /* size of the state maps */
40 char *usedinomap; /* map of allocated inodes */
41 char *dumpdirmap; /* map of directories to be dumped */
42 char *dumpinomap; /* map of files to be dumped */
44 * Map manipulation macros.
46 #define SETINO(ino, map) \
47 map[(u_int)((ino) - 1) / CHAR_BIT] |= \
48 1 << ((u_int)((ino) - 1) % CHAR_BIT)
49 #define CLRINO(ino, map) \
50 map[(u_int)((ino) - 1) / CHAR_BIT] &= \
51 ~(1 << ((u_int)((ino) - 1) % CHAR_BIT))
52 #define TSTINO(ino, map) \
53 (map[(u_int)((ino) - 1) / CHAR_BIT] & \
54 (1 << ((u_int)((ino) - 1) % CHAR_BIT)))
57 * All calculations done in 0.1" units!
59 char *disk; /* name of the disk file */
60 char *tape; /* name of the tape file */
61 char *popenout; /* popen(3) per-"tape" command */
62 char *dumpdates; /* name of the file containing dump date information*/
63 char *temp; /* name of the file for doing rewrite of dumpdates */
64 int lastlevel; /* dump level of previous dump */
65 int level; /* dump level of this dump */
66 int uflag; /* update flag */
67 int diskfd; /* disk file descriptor */
68 int tapefd; /* tape file descriptor */
69 int pipeout; /* true => output to standard output */
70 ino_t curino; /* current inumber; used globally */
71 int newtape; /* new tape flag */
72 int density; /* density in 0.1" units */
73 long tapesize; /* estimated tape size, blocks */
74 long tsize; /* tape size in 0.1" units */
75 long asize; /* number of 0.1" units written on current tape */
76 int etapes; /* estimated number of tapes */
77 int nonodump; /* if set, do not honor UF_NODUMP user flags */
78 int unlimited; /* if set, write to end of medium */
79 int cachesize; /* size of block cache in bytes */
80 int rsync_friendly; /* be friendly with rsync */
82 int notify; /* notify operator flag */
83 int blockswritten; /* number of blocks written on current tape */
84 int tapeno; /* current tape number */
85 time_t tstart_writing; /* when started writing the first tape block */
86 time_t tend_writing; /* after writing the last tape block */
87 int passno; /* current dump pass number */
88 struct fs *sblock; /* the file system super block */
89 char sblock_buf[MAXBSIZE];
90 long dev_bsize; /* block size of underlying disk device */
91 int dev_bshift; /* log2(dev_bsize) */
92 int tp_bshift; /* log2(TP_BSIZE) */
94 /* operator interface functions */
95 void broadcast(const char *message);
97 void lastdump(int arg); /* int should be char */
98 void msg(const char *fmt, ...) __printflike(1, 2);
99 void msgtail(const char *fmt, ...) __printflike(1, 2);
100 int query(const char *question);
101 void quit(const char *fmt, ...) __printflike(1, 2);
103 time_t unctime(char *str);
105 /* mapping rouintes */
107 int mapfiles(ino_t maxino, long *tapesize);
108 int mapdirs(ino_t maxino, long *tapesize);
110 /* file dumping routines */
111 void blkread(ufs2_daddr_t blkno, char *buf, int size);
112 ssize_t cread(int fd, void *buf, size_t nbytes, off_t offset);
113 void dumpino(union dinode *dp, ino_t ino);
114 void dumpmap(char *map, int type, ino_t ino);
115 void writeheader(ino_t ino);
117 /* tape writing routines */
119 void close_rewind(void);
120 void dumpblock(ufs2_daddr_t blkno, int size);
121 void startnewtape(int top);
123 void writerec(char *dp, int isspcl);
125 void Exit(int status) __dead2;
126 void dumpabort(int signo) __dead2;
127 void dump_getfstab(void);
129 char *rawname(char *cp);
130 union dinode *getinode(ino_t inum, int *mode);
135 int rmthost(const char *host);
136 int rmtopen(const char *tape, int mode);
137 int rmtwrite(const char *buf, int count);
140 void interrupt(int signo); /* in case operator bangs on console */
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 */
150 #define OPGRENT "operator" /* group entry to notify */
152 struct fstab *fstabsearch(const char *key); /* search fs_file and fs_spec */
159 * The contents of the file _PATH_DUMPDATES is maintained both on
160 * a linked list, and then (eventually) arrayified.
163 char dd_name[NAME_MAX+3];
167 int nddates; /* number of records (might be zero) */
168 struct dumpdates **ddatev; /* the arrayfied version */
169 void initdumptimes(void);
170 void getdumptime(void);
171 void putdumptime(void);
172 #define ITITERATE(i, ddp) \
173 if (ddatev != NULL) \
174 for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
176 #define DUMPFMTLEN 53 /* max device pathname length */
177 #define DUMPOUTFMT "%-*s %d %s" /* for printf */
178 /* name, level, ctime(date) */
179 #define DUMPINFMT "%s %d %[^\n]\n" /* inverse for scanf */
184 #define _PATH_FSTAB "/etc/fstab"