1/* $NetBSD: dump.h,v 1.45 2008/02/16 17:58:01 matt Exp $ */ 2 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#include <machine/bswap.h> 35 36union dinode { 37 struct ufs1_dinode dp1; 38 struct ufs2_dinode dp2; 39}; 40#define DIP(dp, field) \ 41 (is_ufs2 ? (dp)->dp2.di_##field : (dp)->dp1.di_##field) 42 43#define DIP_SET(dp, field, val) do { \ 44 if (is_ufs2) \ 45 (dp)->dp2.di_##field = (val); \ 46 else \ 47 (dp)->dp1.di_##field = (val); \ 48} while (0) 49 50/* 51 * Filestore-independent UFS data, so code can be more easily shared 52 * between ffs, lfs, and maybe ext2fs and others as well. 53 */ 54struct ufsi { 55 int64_t ufs_dsize; /* file system size, in sectors */ 56 int32_t ufs_bsize; /* block size */ 57 int32_t ufs_bshift; /* log2(ufs_bsize) */ 58 int32_t ufs_fsize; /* fragment size */ 59 int32_t ufs_frag; /* block size / frag size */ 60 int32_t ufs_fsatoda; /* disk address conversion constant */ 61 int32_t ufs_nindir; /* disk addresses per indirect block */ 62 int32_t ufs_inopb; /* inodes per block */ 63 int32_t ufs_maxsymlinklen; /* max symlink length */ 64 int32_t ufs_bmask; /* block mask */ 65 int32_t ufs_fmask; /* frag mask */ 66 int64_t ufs_qbmask; /* ~ufs_bmask */ 67 int64_t ufs_qfmask; /* ~ufs_fmask */ 68}; 69#define fsatoda(u,a) ((a) << (u)->ufs_fsatoda) 70#define ufs_fragroundup(u,size) /* calculates roundup(size, ufs_fsize) */ \ 71 (((size) + (u)->ufs_qfmask) & (u)->ufs_fmask) 72#define ufs_blkoff(u,loc) /* calculates (loc % u->ufs_bsize) */ \ 73 ((loc) & (u)->ufs_qbmask) 74#define ufs_dblksize(u,d,b) \ 75 ((((b) >= NDADDR || DIP((d), size) >= ((b)+1) << (u)->ufs_bshift \ 76 ? (u)->ufs_bsize \ 77 : (ufs_fragroundup((u), ufs_blkoff(u, DIP((d), size))))))) 78struct ufsi *ufsib; 79 80/* 81 * Dump maps used to describe what is to be dumped. 82 */ 83int mapsize; /* size of the state maps */ 84char *usedinomap; /* map of allocated inodes */ 85char *dumpdirmap; /* map of directories to be dumped */ 86char *dumpinomap; /* map of files to be dumped */ 87/* 88 * Map manipulation macros. 89 */ 90#define SETINO(ino, map) \ 91 map[(u_int)((ino) - 1) / NBBY] |= 1 << ((u_int)((ino) - 1) % NBBY) 92#define CLRINO(ino, map) \ 93 map[(u_int)((ino) - 1) / NBBY] &= ~(1 << ((u_int)((ino) - 1) % NBBY)) 94#define TSTINO(ino, map) \ 95 (map[(u_int)((ino) - 1) / NBBY] & (1 << ((u_int)((ino) - 1) % NBBY))) 96 97/* 98 * All calculations done in 0.1" units! 99 */ 100char *disk; /* name of the disk file */ 101char *disk_dev; /* name of the raw device we are dumping */ 102const char *tape; /* name of the tape file */ 103const char *dumpdates; /* name of the file containing dump date information*/ 104const char *temp; /* name of the file for doing rewrite of dumpdates */ 105char lastlevel; /* dump level of previous dump */ 106char level; /* dump level of this dump */ 107int uflag; /* update flag */ 108int eflag; /* eject flag */ 109int lflag; /* autoload flag */ 110int diskfd; /* disk file descriptor */ 111int tapefd; /* tape file descriptor */ 112int pipeout; /* true => output to standard output */ 113int trueinc; /* true => "true incremental", i.e use last 9 as ref */ 114ino_t curino; /* current inumber; used globally */ 115int newtape; /* new tape flag */ 116u_int64_t tapesize; /* estimated tape size, blocks */ 117long tsize; /* tape size in 0.1" units */ 118long asize; /* number of 0.1" units written on current tape */ 119int etapes; /* estimated number of tapes */ 120int nonodump; /* if set, do not honor UF_NODUMP user flags */ 121int unlimited; /* if set, write to end of medium */ 122 123extern int density; /* density in 0.1" units */ 124extern int notify; /* notify operator flag */ 125extern int timestamp; /* timestamp messages */ 126extern int blockswritten; /* number of blocks written on current tape */ 127extern int tapeno; /* current tape number */ 128extern int is_ufs2; 129 130time_t tstart_writing; /* when started writing the first tape block */ 131time_t tstart_volume; /* when started writing the current volume */ 132int xferrate; /* averaged transfer rate of all volumes */ 133char sblock_buf[MAXBSIZE]; /* buffer to hold the superblock */ 134extern long dev_bsize; /* block size of underlying disk device */ 135int dev_bshift; /* log2(dev_bsize) */ 136int tp_bshift; /* log2(TP_BSIZE) */ 137int needswap; /* file system in swapped byte order */ 138 139 140/* some inline functions to help the byte-swapping mess */ 141static inline u_int16_t iswap16(u_int16_t); 142static inline u_int32_t iswap32(u_int32_t); 143static inline u_int64_t iswap64(u_int64_t); 144 145static inline u_int16_t iswap16(u_int16_t x) 146{ 147 if (needswap) 148 return bswap16(x); 149 else 150 return x; 151} 152 153static inline u_int32_t iswap32(u_int32_t x) 154{ 155 if (needswap) 156 return bswap32(x); 157 else 158 return x; 159} 160 161static inline u_int64_t iswap64(u_int64_t x) 162{ 163 if (needswap) 164 return bswap64(x); 165 else 166 return x; 167} 168 169/* filestore-specific hooks */ 170int fs_read_sblock(char *); 171struct ufsi *fs_parametrize(void); 172ino_t fs_maxino(void); 173void fs_mapinodes(ino_t, u_int64_t *, int *); 174 175/* operator interface functions */ 176void broadcast(const char *); 177void lastdump(char); 178void msg(const char *fmt, ...) __attribute__((__format__(__printf__,1,2))); 179void msgtail(const char *fmt, ...) __attribute__((__format__(__printf__,1,2))); 180int query(const char *); 181void quit(const char *fmt, ...) __attribute__((__format__(__printf__,1,2))); 182time_t do_stats(void); 183void statussig(int); 184void timeest(void); 185time_t unctime(char *); 186 187/* mapping routines */ 188union dinode; 189int64_t blockest(union dinode *); 190void mapfileino(ino_t, u_int64_t *, int *); 191int mapfiles(ino_t, u_int64_t *, char *, char * const *); 192int mapdirs(ino_t, u_int64_t *); 193 194/* file dumping routines */ 195void blksout32(int32_t *, int, ino_t); 196void blksout64(int64_t *, int, ino_t); 197void dumpino(union dinode *, ino_t); 198#ifndef RRESTORE 199void dumpmap(char *, int, ino_t); 200#endif 201void writeheader(ino_t); 202 203/* data block caching */ 204void bread(daddr_t, char *, int); 205void rawread(daddr_t, char *, int); 206void initcache(int, int); 207void printcachestats(void); 208 209/* tape writing routines */ 210int alloctape(void); 211void close_rewind(void); 212void dumpblock(daddr_t, int); 213void startnewtape(int); 214void trewind(int); 215void writerec(char *, int); 216 217void Exit(int); 218void dumpabort(int); 219void getfstab(void); 220 221char *rawname(char *); 222union dinode *getino(ino_t); 223 224void *xcalloc(size_t, size_t); 225void *xmalloc(size_t); 226char *xstrdup(const char *); 227 228/* LFS snapshot hooks */ 229#ifdef DUMP_LFS 230int lfs_wrap_stop(char *); 231void lfs_wrap_go(void); 232#endif 233 234/* rdump routines */ 235#if defined(RDUMP) || defined(RRESTORE) 236void rmtclose(void); 237int rmthost(const char *); 238int rmtopen(const char *, int, int); 239int rmtwrite(const char *, int); 240int rmtioctl(int, int); 241#endif /* RDUMP || RRESTORE */ 242 243void interrupt(int); /* in case operator bangs on console */ 244 245/* 246 * Exit status codes 247 */ 248#define X_FINOK 0 /* normal exit */ 249#define X_STARTUP 1 /* startup error */ 250#define X_REWRITE 2 /* restart writing from the check point */ 251#define X_ABORT 3 /* abort dump; don't attempt checkpointing */ 252 253#define OPGRENT "operator" /* group entry to notify */ 254#define DIALUP "ttyd" /* prefix for dialups */ 255 256struct fstab *fstabsearch(const char *); /* search fs_file and fs_spec */ 257struct statvfs *mntinfosearch(const char *key); 258 259#ifndef NAME_MAX 260#define NAME_MAX 255 261#endif 262 263/* 264 * The contents of the file _PATH_DUMPDATES is maintained both on 265 * a linked list, and then (eventually) arrayified. 266 */ 267struct dumpdates { 268 char dd_name[NAME_MAX+3]; 269 char dd_level; 270 time_t dd_ddate; 271}; 272 273extern int nddates; /* number of records (might be zero) */ 274extern struct dumpdates **ddatev; /* the arrayfied version */ 275 276void initdumptimes(void); 277void getdumptime(void); 278void putdumptime(void); 279#define ITITERATE(i, ddp) \ 280 if (ddatev != NULL) \ 281 for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i]) 282 283void sig(int signo); 284 285/* 286 * Compatibility with old systems. 287 */ 288#ifdef COMPAT 289#include <sys/file.h> 290#define strchr(a,b) index(a,b) 291#define strrchr(a,b) rindex(a,b) 292extern char *strdup(), *ctime(); 293extern int read(), write(); 294extern int errno; 295#endif 296 297#ifndef _PATH_FSTAB 298#define _PATH_FSTAB "/etc/fstab" 299#endif 300