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 * $FreeBSD$ 34 */ 35 36/* 37 * Dump maps used to describe what is to be dumped. 38 */ 39extern int mapsize; /* size of the state maps */ 40extern char *usedinomap; /* map of allocated inodes */ 41extern char *dumpdirmap; /* map of directories to be dumped */ 42extern char *dumpinomap; /* map of files to be dumped */ 43/* 44 * Map manipulation macros. 45 */ 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))) 55 56/* 57 * All calculations done in 0.1" units! 58 */ 59extern char *disk; /* name of the disk file */ 60extern char *tape; /* name of the tape file */ 61extern char *popenout; /* popen(3) per-"tape" command */ 62extern char *dumpdates; /* name of the file containing dump date info */ 63extern int lastlevel; /* dump level of previous dump */ 64extern int level; /* dump level of this dump */ 65extern int uflag; /* update flag */ 66extern int diskfd; /* disk file descriptor */ 67extern int pipeout; /* true => output to standard output */ 68extern ino_t curino; /* current inumber; used globally */ 69extern int newtape; /* new tape flag */ 70extern int density; /* density in 0.1" units */ 71extern long tapesize; /* estimated tape size, blocks */ 72extern long tsize; /* tape size in 0.1" units */ 73extern int etapes; /* estimated number of tapes */ 74extern int nonodump; /* if set, do not honor UF_NODUMP user flags */ 75extern int unlimited; /* if set, write to end of medium */ 76extern int cachesize; /* size of block cache in bytes */ 77extern int rsync_friendly; /* be friendly with rsync */ 78extern int notify; /* notify operator flag */ 79extern int blockswritten; /* number of blocks written on current tape */ 80extern int tapeno; /* current tape number */ 81extern int ntrec; /* blocking factor on tape */ 82extern long blocksperfile; /* number of blocks per output file */ 83extern int cartridge; /* assume non-cartridge tape */ 84extern char *host; /* remote host (if any) */ 85extern time_t tstart_writing; /* when started writing the first tape block */ 86extern time_t tend_writing; /* after writing the last tape block */ 87extern int passno; /* current dump pass number */ 88extern struct fs *sblock; /* the file system super block */ 89extern long dev_bsize; /* block size of underlying disk device */ 90extern int dev_bshift; /* log2(dev_bsize) */ 91extern int tp_bshift; /* log2(TP_BSIZE) */ 92 93/* operator interface functions */ 94void broadcast(const char *message); 95void infosch(int); 96void lastdump(int arg); /* int should be char */ 97void msg(const char *fmt, ...) __printflike(1, 2); 98void msgtail(const char *fmt, ...) __printflike(1, 2); 99int query(const char *question); 100void quit(const char *fmt, ...) __printflike(1, 2); 101void timeest(void); 102time_t unctime(char *str); 103 104/* mapping rouintes */ 105union dinode; 106int mapfiles(ino_t maxino, long *tapesize); 107int mapdirs(ino_t maxino, long *tapesize); 108 109/* file dumping routines */ 110void blkread(ufs2_daddr_t blkno, char *buf, int size); 111ssize_t cread(int fd, void *buf, size_t nbytes, off_t offset); 112void dumpino(union dinode *dp, ino_t ino); 113void dumpmap(char *map, int type, ino_t ino); 114void writeheader(ino_t ino); 115 116/* tape writing routines */ 117int alloctape(void); 118void close_rewind(void); 119void dumpblock(ufs2_daddr_t blkno, int size); 120void startnewtape(int top); 121void trewind(void); 122void writerec(char *dp, int isspcl); 123 124void Exit(int status) __dead2; 125void dumpabort(int signo) __dead2; 126void dump_getfstab(void); 127 128char *rawname(char *cp); 129union dinode *getino(ino_t inum, int *mode); 130 131/* rdump routines */ 132#ifdef RDUMP 133void rmtclose(void); 134int rmthost(const char *host); 135int rmtopen(const char *tape, int mode); 136int rmtwrite(const char *buf, int count); 137#endif /* RDUMP */ 138 139void interrupt(int signo); /* in case operator bangs on console */ 140 141/* 142 * Exit status codes 143 */ 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 */ 148 149#define OPGRENT "operator" /* group entry to notify */ 150 151struct fstab *fstabsearch(const char *key); /* search fs_file and fs_spec */ 152 153#ifndef NAME_MAX 154#define NAME_MAX 255 155#endif 156 157/* 158 * The contents of the file _PATH_DUMPDATES is maintained both on 159 * a linked list, and then (eventually) arrayified. 160 */ 161struct dumpdates { 162 char dd_name[NAME_MAX+3]; 163 int dd_level; 164 time_t dd_ddate; 165}; 166extern int nddates; /* number of records (might be zero) */ 167extern struct dumpdates **ddatev; /* the arrayfied version */ 168void initdumptimes(void); 169void getdumptime(void); 170void putdumptime(void); 171#define ITITERATE(i, ddp) \ 172 if (ddatev != NULL) \ 173 for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i]) 174 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 */ 179 180void sig(int signo); 181 182#ifndef _PATH_FSTAB 183#define _PATH_FSTAB "/etc/fstab" 184#endif 185