1 /* $NetBSD: dump.h,v 1.33 2001/12/30 04:03:16 lukem 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. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by the University of 18 * California, Berkeley and its contributors. 19 * 4. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * @(#)dump.h 8.2 (Berkeley) 4/28/95 36 */ 37 38 #include <machine/bswap.h> 39 40 #define MAXINOPB (MAXBSIZE / sizeof(struct dinode)) 41 #define MAXNINDIR (MAXBSIZE / sizeof(daddr_t)) 42 43 /* 44 * Filestore-independent UFS data, so code can be more easily shared 45 * between ffs, lfs, and maybe ext2fs and others as well. 46 */ 47 struct ufsi { 48 int64_t ufs_dsize; /* file system size, in sectors */ 49 int32_t ufs_bsize; /* block size */ 50 int32_t ufs_bshift; /* log2(ufs_bsize) */ 51 int32_t ufs_fsize; /* fragment size */ 52 int32_t ufs_frag; /* block size / frag size */ 53 int32_t ufs_fsatoda; /* disk address conversion constant */ 54 int32_t ufs_nindir; /* disk addresses per indirect block */ 55 int32_t ufs_inopb; /* inodes per block */ 56 int32_t ufs_maxsymlinklen; /* max symlink length */ 57 int32_t ufs_bmask; /* block mask */ 58 int32_t ufs_fmask; /* frag mask */ 59 int64_t ufs_qbmask; /* ~ufs_bmask */ 60 int64_t ufs_qfmask; /* ~ufs_fmask */ 61 }; 62 #define fsatoda(u,a) ((a) << (u)->ufs_fsatoda) 63 #define ufs_fragroundup(u,size) /* calculates roundup(size, ufs_fsize) */ \ 64 (((size) + (u)->ufs_qfmask) & (u)->ufs_fmask) 65 #define ufs_blkoff(u,loc) /* calculates (loc % u->ufs_bsize) */ \ 66 ((loc) & (u)->ufs_qbmask) 67 #define ufs_dblksize(u,d,b) \ 68 ((((b) >= NDADDR || (d)->di_size >= ((b)+1) << (u)->ufs_bshift \ 69 ? (u)->ufs_bsize \ 70 : (ufs_fragroundup((u), ufs_blkoff(u, (d)->di_size)))))) 71 struct ufsi *ufsib; 72 73 /* 74 * Dump maps used to describe what is to be dumped. 75 */ 76 int mapsize; /* size of the state maps */ 77 char *usedinomap; /* map of allocated inodes */ 78 char *dumpdirmap; /* map of directories to be dumped */ 79 char *dumpinomap; /* map of files to be dumped */ 80 /* 81 * Map manipulation macros. 82 */ 83 #define SETINO(ino, map) \ 84 map[(u_int)((ino) - 1) / NBBY] |= 1 << ((u_int)((ino) - 1) % NBBY) 85 #define CLRINO(ino, map) \ 86 map[(u_int)((ino) - 1) / NBBY] &= ~(1 << ((u_int)((ino) - 1) % NBBY)) 87 #define TSTINO(ino, map) \ 88 (map[(u_int)((ino) - 1) / NBBY] & (1 << ((u_int)((ino) - 1) % NBBY))) 89 90 /* 91 * All calculations done in 0.1" units! 92 */ 93 char *disk; /* name of the disk file */ 94 char *tape; /* name of the tape file */ 95 char *dumpdates; /* name of the file containing dump date information*/ 96 char *temp; /* name of the file for doing rewrite of dumpdates */ 97 char lastlevel; /* dump level of previous dump */ 98 char level; /* dump level of this dump */ 99 int uflag; /* update flag */ 100 int eflag; /* eject flag */ 101 int lflag; /* autoload flag */ 102 int diskfd; /* disk file descriptor */ 103 int tapefd; /* tape file descriptor */ 104 int pipeout; /* true => output to standard output */ 105 ino_t curino; /* current inumber; used globally */ 106 int newtape; /* new tape flag */ 107 long tapesize; /* estimated tape size, blocks */ 108 long tsize; /* tape size in 0.1" units */ 109 long asize; /* number of 0.1" units written on current tape */ 110 int etapes; /* estimated number of tapes */ 111 int nonodump; /* if set, do not honor UF_NODUMP user flags */ 112 int unlimited; /* if set, write to end of medium */ 113 114 extern int density; /* density in 0.1" units */ 115 extern int notify; /* notify operator flag */ 116 extern int timestamp; /* timestamp messages */ 117 extern int blockswritten; /* number of blocks written on current tape */ 118 extern int tapeno; /* current tape number */ 119 120 time_t tstart_writing; /* when started writing the first tape block */ 121 int xferrate; /* averaged transfer rate of all volumes */ 122 char sblock_buf[MAXBSIZE]; /* buffer to hold the superblock */ 123 extern long dev_bsize; /* block size of underlying disk device */ 124 int dev_bshift; /* log2(dev_bsize) */ 125 int tp_bshift; /* log2(TP_BSIZE) */ 126 int needswap; /* file system in swapped byte order */ 127 /* some inline functs to help the byte-swapping mess */ 128 static __inline u_int16_t iswap16(u_int16_t); 129 static __inline u_int32_t iswap32(u_int32_t); 130 static __inline u_int64_t iswap64(u_int64_t); 131 132 static __inline u_int16_t iswap16(u_int16_t x) 133 { 134 if (needswap) 135 return bswap16(x); 136 else 137 return x; 138 } 139 140 static __inline u_int32_t iswap32(u_int32_t x) 141 { 142 if (needswap) 143 return bswap32(x); 144 else 145 return x; 146 } 147 148 static __inline u_int64_t iswap64(u_int64_t x) 149 { 150 if (needswap) 151 return bswap64(x); 152 else 153 return x; 154 } 155 156 /* filestore-specific hooks */ 157 int fs_read_sblock(char *); 158 struct ufsi *fs_parametrize(void); 159 ino_t fs_maxino(void); 160 161 /* operator interface functions */ 162 void broadcast(char *); 163 void lastdump(char); 164 void msg(const char *fmt, ...) __attribute__((__format__(__printf__,1,2))); 165 void msgtail(const char *fmt, ...) __attribute__((__format__(__printf__,1,2))); 166 int query(char *); 167 void quit(const char *fmt, ...) __attribute__((__format__(__printf__,1,2))); 168 void set_operators(void); 169 time_t do_stats(void); 170 void statussig(int); 171 void timeest(void); 172 time_t unctime(char *); 173 174 /* mapping routines */ 175 struct dinode; 176 long blockest(struct dinode *); 177 void mapfileino(ino_t, long *, int *); 178 int mapfiles(ino_t, long *, char *, char * const *); 179 int mapdirs(ino_t, long *); 180 181 /* file dumping routines */ 182 void blksout(daddr_t *, int, ino_t); 183 void dumpino(struct dinode *, ino_t); 184 void dumpmap(char *, int, ino_t); 185 void writeheader(ino_t); 186 187 /* data block caching */ 188 void bread(daddr_t, char *, int); 189 void rawread(daddr_t, char *, int); 190 void initcache(int, int); 191 void printcachestats(void); 192 193 /* tape writing routines */ 194 int alloctape(void); 195 void close_rewind(void); 196 void dumpblock(daddr_t, int); 197 void startnewtape(int); 198 void trewind(int); 199 void writerec(char *, int); 200 201 void Exit(int); 202 void dumpabort(int); 203 void getfstab(void); 204 205 char *rawname(char *); 206 struct dinode *getino(ino_t); 207 208 void *xcalloc(size_t, size_t); 209 void *xmalloc(size_t); 210 char *xstrdup(const char *); 211 212 /* rdump routines */ 213 #if defined(RDUMP) || defined(RRESTORE) 214 void rmtclose(void); 215 int rmthost(char *); 216 int rmtopen(char *, int, int); 217 int rmtwrite(char *, int); 218 int rmtioctl(int, int); 219 #endif /* RDUMP || RRESTORE */ 220 221 void interrupt(int); /* in case operator bangs on console */ 222 223 /* 224 * Exit status codes 225 */ 226 #define X_FINOK 0 /* normal exit */ 227 #define X_STARTUP 1 /* startup error */ 228 #define X_REWRITE 2 /* restart writing from the check point */ 229 #define X_ABORT 3 /* abort dump; don't attempt checkpointing */ 230 231 #define OPGRENT "operator" /* group entry to notify */ 232 #define DIALUP "ttyd" /* prefix for dialups */ 233 234 struct fstab *fstabsearch(const char *); /* search fs_file and fs_spec */ 235 struct statfs *mntinfosearch(const char *key); 236 237 #ifndef NAME_MAX 238 #define NAME_MAX 255 239 #endif 240 241 /* 242 * The contents of the file _PATH_DUMPDATES is maintained both on 243 * a linked list, and then (eventually) arrayified. 244 */ 245 struct dumpdates { 246 char dd_name[NAME_MAX+3]; 247 char dd_level; 248 time_t dd_ddate; 249 }; 250 251 extern int nddates; /* number of records (might be zero) */ 252 extern struct dumpdates **ddatev; /* the arrayfied version */ 253 254 void initdumptimes(void); 255 void getdumptime(void); 256 void putdumptime(void); 257 #define ITITERATE(i, ddp) \ 258 if (ddatev != NULL) \ 259 for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i]) 260 261 void sig(int signo); 262 263 /* 264 * Compatibility with old systems. 265 */ 266 #ifdef COMPAT 267 #include <sys/file.h> 268 #define strchr(a,b) index(a,b) 269 #define strrchr(a,b) rindex(a,b) 270 extern char *strdup(), *ctime(); 271 extern int read(), write(); 272 extern int errno; 273 #endif 274 275 #ifndef _PATH_UTMP 276 #define _PATH_UTMP "/etc/utmp" 277 #endif 278 #ifndef _PATH_FSTAB 279 #define _PATH_FSTAB "/etc/fstab" 280 #endif 281