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