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 extern int mapsize; /* size of the state maps */
40 extern char *usedinomap; /* map of allocated inodes */
41 extern char *dumpdirmap; /* map of directories to be dumped */
42 extern 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 extern char *disk; /* name of the disk file */
60 extern char *tape; /* name of the tape file */
61 extern char *popenout; /* popen(3) per-"tape" command */
62 extern char *dumpdates; /* name of the file containing dump date info */
63 extern int lastlevel; /* dump level of previous dump */
64 extern int level; /* dump level of this dump */
65 extern int uflag; /* update flag */
66 extern int diskfd; /* disk file descriptor */
67 extern int pipeout; /* true => output to standard output */
68 extern ino_t curino; /* current inumber; used globally */
69 extern int newtape; /* new tape flag */
70 extern int density; /* density in 0.1" units */
71 extern long tapesize; /* estimated tape size, blocks */
72 extern long tsize; /* tape size in 0.1" units */
73 extern int etapes; /* estimated number of tapes */
74 extern int nonodump; /* if set, do not honor UF_NODUMP user flags */
75 extern int unlimited; /* if set, write to end of medium */
76 extern int cachesize; /* size of block cache in bytes */
77 extern int rsync_friendly; /* be friendly with rsync */
78 extern int notify; /* notify operator flag */
79 extern int blockswritten; /* number of blocks written on current tape */
80 extern int tapeno; /* current tape number */
81 extern int ntrec; /* blocking factor on tape */
82 extern long blocksperfile; /* number of blocks per output file */
83 extern int cartridge; /* assume non-cartridge tape */
84 extern char *host; /* remote host (if any) */
85 extern time_t tstart_writing; /* when started writing the first tape block */
86 extern time_t tend_writing; /* after writing the last tape block */
87 extern int passno; /* current dump pass number */
88 extern struct fs *sblock; /* the file system super block */
89 extern long dev_bsize; /* block size of underlying disk device */
90 extern int dev_bshift; /* log2(dev_bsize) */
91 extern int tp_bshift; /* log2(TP_BSIZE) */
93 /* operator interface functions */
94 void broadcast(const char *message);
96 void lastdump(int arg); /* int should be char */
97 void msg(const char *fmt, ...) __printflike(1, 2);
98 void msgtail(const char *fmt, ...) __printflike(1, 2);
99 int query(const char *question);
100 void quit(const char *fmt, ...) __printflike(1, 2);
102 time_t unctime(char *str);
104 /* mapping rouintes */
106 int mapfiles(ino_t maxino, long *tapesize);
107 int mapdirs(ino_t maxino, long *tapesize);
109 /* file dumping routines */
110 void blkread(ufs2_daddr_t blkno, char *buf, int size);
111 ssize_t cread(int fd, void *buf, size_t nbytes, off_t offset);
112 void dumpino(union dinode *dp, ino_t ino);
113 void dumpmap(char *map, int type, ino_t ino);
114 void writeheader(ino_t ino);
116 /* tape writing routines */
118 void close_rewind(void);
119 void dumpblock(ufs2_daddr_t blkno, int size);
120 void startnewtape(int top);
122 void writerec(char *dp, int isspcl);
124 void Exit(int status) __dead2;
125 void dumpabort(int signo) __dead2;
126 void dump_getfstab(void);
128 char *rawname(char *cp);
129 union dinode *getino(ino_t inum, int *mode);
134 int rmthost(const char *host);
135 int rmtopen(const char *tape, int mode);
136 int rmtwrite(const char *buf, int count);
139 void interrupt(int signo); /* in case operator bangs on console */
144 #define X_FINOK 0 /* normal exit */
145 #define X_STARTUP 1 /* startup error */
146 #define X_REWRITE 2 /* restart writing from the check point */
147 #define X_ABORT 3 /* abort dump; don't attempt checkpointing */
149 #define OPGRENT "operator" /* group entry to notify */
151 struct fstab *fstabsearch(const char *key); /* search fs_file and fs_spec */
158 * The contents of the file _PATH_DUMPDATES is maintained both on
159 * a linked list, and then (eventually) arrayified.
162 char dd_name[NAME_MAX+3];
166 extern int nddates; /* number of records (might be zero) */
167 extern struct dumpdates **ddatev; /* the arrayfied version */
168 void initdumptimes(void);
169 void getdumptime(void);
170 void putdumptime(void);
171 #define ITITERATE(i, ddp) \
172 if (ddatev != NULL) \
173 for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
175 #define DUMPFMTLEN 53 /* max device pathname length */
176 #define DUMPOUTFMT "%-*s %d %s" /* for printf */
177 /* name, level, ctime(date) */
178 #define DUMPINFMT "%s %d %[^\n]\n" /* inverse for scanf */
183 #define _PATH_FSTAB "/etc/fstab"