dump/dump.h

   1 /*
   2  *      Ported to Linux's Second Extended File System as part of the
   3  *      dump and restore backup suit
   4  *      Remy Card <card@Linux.EU.Org>, 1994-1997
   5  *      Stelian Pop <pop@cybercable.fr>, 1999-2000
   6  *
   7  *      $Id: dump.h,v 1.10 2000/02/04 20:22:21 stelian Exp $
   8  */
   9
  10 /*-
  11  * Copyright (c) 1980, 1993
  12  *      The Regents of the University of California.  All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  * 3. All advertising materials mentioning features or use of this software
  23  *    must display the following acknowledgement:
  24  *      This product includes software developed by the University of
  25  *      California, Berkeley and its contributors.
  26  * 4. Neither the name of the University nor the names of its contributors
  27  *    may be used to endorse or promote products derived from this software
  28  *    without specific prior written permission.
  29  *
  30  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  34  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  35  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  36  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  39  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  40  * SUCH DAMAGE.
  41  */
  42
  43 #define MAXINOPB        (MAXBSIZE / sizeof(struct dinode))
  44 #define MAXNINDIR       (MAXBSIZE / sizeof(daddr_t))
  45
  46 #ifndef NAME_MAX
  47 #define NAME_MAX 255
  48 #endif
  49
  50 /*
  51  * Dump maps used to describe what is to be dumped.
  52  */
  53 int     mapsize;        /* size of the state maps */
  54 char    *usedinomap;    /* map of allocated inodes */
  55 char    *dumpdirmap;    /* map of directories to be dumped */
  56 char    *dumpinomap;    /* map of files to be dumped */
  57 /*
  58  * Map manipulation macros.
  59  */
  60 #define SETINO(ino, map) \
  61         map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
  62 #define CLRINO(ino, map) \
  63         map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
  64 #define TSTINO(ino, map) \
  65         (map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
  66
  67 /*
  68  *      All calculations done in 0.1" units!
  69  */
  70 char    *disk;          /* name of the disk file */
  71 char    tape[NAME_MAX]; /* name of the tape file */
  72 char    *tapeprefix;    /* prefix of the tape file */
  73 char    *dumpdates;     /* name of the file containing dump date information*/
  74 char    *temp;          /* name of the file for doing rewrite of dumpdates */
  75 char    lastlevel;      /* dump level of previous dump */
  76 char    level;          /* dump level of this dump */
  77 int     uflag;          /* update flag */
  78 int     Mflag;          /* multi-volume flag */
  79 int     diskfd;         /* disk file descriptor */
  80 int     tapefd;         /* tape file descriptor */
  81 int     pipeout;        /* true => output to standard output */
  82 ino_t   curino;         /* current inumber; used globally */
  83 int     newtape;        /* new tape flag */
  84 int     density;        /* density in 0.1" units */
  85 long    tapesize;       /* estimated tape size, blocks */
  86 long    tsize;          /* tape size in 0.1" units */
  87 long    asize;          /* number of 0.1" units written on current tape */
  88 int     etapes;         /* estimated number of tapes */
  89 int     nonodump;       /* if set, do not honor UF_NODUMP user flags */
  90 int     unlimited;      /* if set, write to end of medium */
  91
  92 int     notify;         /* notify operator flag */
  93 int     blockswritten;  /* number of blocks written on current tape */
  94 int     tapeno;         /* current tape number */
  95 time_t  tstart_writing; /* when started writing the first tape block */
  96 time_t  tend_writing;   /* after writing the last tape block */
  97 #ifdef __linux__
  98 ext2_filsys fs;
  99 #else
 100 struct  fs *sblock;     /* the file system super block */
 101 char    sblock_buf[MAXBSIZE];
 102 #endif
 103 long    xferrate;       /* averaged transfer rate of all volumes */
 104 long    dev_bsize;      /* block size of underlying disk device */
 105 int     dev_bshift;     /* log2(dev_bsize) */
 106 int     tp_bshift;      /* log2(TP_BSIZE) */
 107
 108 #ifndef __P
 109 #include <sys/cdefs.h>
 110 #endif
 111
 112 /* operator interface functions */
 113 void    broadcast __P((const char *message));
 114 time_t  do_stats __P((void));
 115 void    lastdump __P((char arg));
 116 void    msg __P((const char *fmt, ...));
 117 void    msgtail __P((const char *fmt, ...));
 118 int     query __P((const char *question));
 119 void    quit __P((const char *fmt, ...));
 120 void    set_operators __P((void));
 121 #if defined(SIGINFO)
 122 void    statussig __P((int signo));
 123 #endif
 124 void    timeest __P((void));
 125 time_t  unctime __P((const char *str));
 126
 127 /* mapping rouintes */
 128 struct  dinode;
 129 long    blockest __P((struct dinode *dp));
 130 int     mapfiles __P((ino_t maxino, long *tapesize));
 131 #ifdef  __linux__
 132 int     mapfilesfromdir __P((ino_t maxino, long *tapesize, char *directory));
 133 #endif
 134 int     mapdirs __P((ino_t maxino, long *tapesize));
 135
 136 /* file dumping routines */
 137 void    blksout __P((daddr_t *blkp, int frags, ino_t ino));
 138 void    bread __P((daddr_t blkno, char *buf, int size));
 139 void    dumpino __P((struct dinode *dp, ino_t ino));
 140 #ifdef  __linux__
 141 void    dumpdirino __P((struct dinode *dp, ino_t ino));
 142 #endif
 143 void    dumpmap __P((char *map, int type, ino_t ino));
 144 void    writeheader __P((ino_t ino));
 145
 146 /* tape writing routines */
 147 int     alloctape __P((void));
 148 void    close_rewind __P((void));
 149 void    dumpblock __P((daddr_t blkno, int size));
 150 void    startnewtape __P((int top));
 151 void    trewind __P((void));
 152 void    writerec __P((const void *dp, int isspcl));
 153
 154 void    Exit __P((int status));
 155 void    dumpabort __P((int signo));
 156 void    getfstab __P((void));
 157
 158 char    *rawname __P((char *cp));
 159 struct  dinode *getino __P((ino_t inum));
 160
 161 /* rdump routines */
 162 #ifdef RDUMP
 163 int     rmthost __P((const char *host));
 164 int     rmtopen __P((const char *tape, int mode));
 165 void    rmtclose __P((void));
 166 int     rmtread __P((char *buf, size_t count));
 167 int     rmtwrite __P((const char *buf, size_t count));
 168 int     rmtseek __P((int offset, int pos));
 169 struct mtget * rmtstatus __P((void));
 170 int     rmtioctl __P((int cmd, int count));
 171 #endif /* RDUMP */
 172
 173 void    interrupt __P((int signo));     /* in case operator bangs on console */
 174
 175 /*
 176  *      Exit status codes
 177  */
 178 #define X_FINOK         0       /* normal exit */
 179 #define X_STARTUP       1       /* startup error */
 180 #define X_REWRITE       2       /* restart writing from the check point */
 181 #define X_ABORT         3       /* abort dump; don't attempt checkpointing */
 182
 183 #define OPGRENT "operator"              /* group entry to notify */
 184 #ifdef  __linux__
 185 #define DIALUP  "ttyS"                  /* prefix for dialups */
 186 #else
 187 #define DIALUP  "ttyd"                  /* prefix for dialups */
 188 #endif
 189
 190 struct  fstab *fstabsearch __P((const char *key));      /* search fs_file and fs_spec */
 191 #ifdef  __linux__
 192 struct  fstab *fstabsearchdir __P((const char *key, char *dir));        /* search fs_file and fs_spec */
 193 #endif
 194
 195 /*
 196  *      The contents of the file _PATH_DUMPDATES is maintained both on
 197  *      a linked list, and then (eventually) arrayified.
 198  */
 199 struct dumpdates {
 200         char    dd_name[NAME_MAX+3];
 201         char    dd_level;
 202         time_t  dd_ddate;
 203 };
 204 struct dumptime {
 205         struct  dumpdates dt_value;
 206         struct  dumptime *dt_next;
 207 };
 208 struct  dumptime *dthead;       /* head of the list version */
 209 int     nddates;                /* number of records (might be zero) */
 210 int     ddates_in;              /* we have read the increment file */
 211 struct  dumpdates **ddatev;     /* the arrayfied version */
 212 void    initdumptimes __P((int));
 213 void    getdumptime __P((int));
 214 void    putdumptime __P((void));
 215 #define ITITERATE(i, ddp) \
 216         for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
 217
 218 void    sig __P((int signo));
 219
 220 /*
 221  * Compatibility with old systems.
 222  */
 223 #ifdef COMPAT
 224 #include <sys/file.h>
 225 #define strchr(a,b)     index(a,b)
 226 #define strrchr(a,b)    rindex(a,b)
 227 extern char *strdup(), *ctime();
 228 extern int read(), write();
 229 extern int errno;
 230 #endif
 231
 232 #ifdef  __linux__
 233 #define DUMP_CURRENT_REV        1
 234
 235 int dump_fs_open(const char *disk, ext2_filsys *fs);
 236 #endif
 237
 238 #ifndef __linux__
 239 #ifndef _PATH_UTMP
 240 #define _PATH_UTMP      "/etc/utmp"
 241 #endif
 242 #ifndef _PATH_FSTAB
 243 #define _PATH_FSTAB     "/etc/fstab"
 244 #endif
 245 #endif
 246
 247 #ifdef sunos
 248 extern char *calloc();
 249 extern char *malloc();
 250 extern long atol();
 251 extern char *strcpy();
 252 extern char *strncpy();
 253 extern char *strcat();
 254 extern time_t time();
 255 extern void endgrent();
 256 extern void exit();
 257 extern off_t lseek();
 258 extern const char *strerror();
 259 #endif
 260
 261                                 /* 04-Feb-00 ILC */
 262 #define IEXCLUDE_MAXNUM 256     /* max size of inode exclude list */
 263