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 <stelian@popies.net>, 1999-2000
   6  *      Stelian Pop <stelian@popies.net> - Alcôve <www.alcove.com>, 2000-2002
   7  *
   8  *      $Id: dump.h,v 1.43 2003/03/26 10:58:22 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 #include <compatlfs.h>
  47
  48 #define MAXINOPB        (MAXBSIZE / sizeof(struct dinode))
  49 #define MAXNINDIR       (MAXBSIZE / sizeof(daddr_t))
  50
  51 /*
  52  * Dump maps used to describe what is to be dumped.
  53  */
  54 extern int      mapsize;        /* size of the state maps */
  55 extern char     *usedinomap;    /* map of allocated inodes */
  56 extern char     *dumpdirmap;    /* map of directories to be dumped */
  57 extern char     *dumpinomap;    /* map of files to be dumped */
  58 extern char     *metainomap;    /* which of the inodes in dumpinomap
  59                                    will get only their metadata dumped */
  60 /*
  61  * Map manipulation macros.
  62  */
  63 #define SETINO(ino, map) \
  64         map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
  65 #define CLRINO(ino, map) \
  66         map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
  67 #define TSTINO(ino, map) \
  68         (map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
  69
  70 /*
  71  *      All calculations done in 0.1" units!
  72  */
  73 extern char     *host;          /* name of the remote host */
  74 extern const char *disk;        /* name of the disk file */
  75 extern char     tape[MAXPATHLEN];/* name of the tape file */
  76 extern char     *tapeprefix;    /* prefix of the tape file */
  77 extern char     *dumpdates;     /* name of the file containing dump date information*/
  78 extern char     lastlevel;      /* dump level of previous dump */
  79 extern char     level;          /* dump level of this dump */
  80 extern int      Afile;          /* archive file descriptor */
  81 extern int      AfileActive;    /* Afile flag */
  82 extern int      bzipflag;       /* compression is done using bzlib */
  83 extern int      uflag;          /* update flag */
  84 extern int      mflag;          /* dump metadata only if possible flag */
  85 extern int      Mflag;          /* multi-volume flag */
  86 extern int      qflag;          /* quit on errors flag */
  87 extern int      vflag;          /* verbose flag */
  88 extern int      breademax;      /* maximum number of bread errors before we quit */
  89 extern char     *eot_script;    /* end of volume script fiag */
  90 extern int      diskfd;         /* disk file descriptor */
  91 extern int      tapefd;         /* tape file descriptor */
  92 extern int      pipeout;        /* true => output to standard output */
  93 extern int      fifoout;        /* true => output to fifo */
  94 extern dump_ino_t curino;       /* current inumber; used globally */
  95 extern int      newtape;        /* new tape flag */
  96 extern int      density;        /* density in 0.1" units */
  97 extern long     tapesize;       /* estimated tape size, blocks */
  98 extern long     tsize;          /* tape size in 0.1" units */
  99 extern long     asize;          /* number of 0.1" units written on current tape */
 100 extern int      etapes;         /* estimated number of tapes */
 101 extern int      nonodump;       /* if set, do not honor UF_NODUMP user flags */
 102 extern int      unlimited;      /* if set, write to end of medium */
 103 extern int      compressed;     /* if set, dump is to be compressed */
 104 extern long long bytes_written;/* total bytes written to tape */
 105 extern long     uncomprblks;    /* uncompressed blocks written to tape */
 106 extern int      notify;         /* notify operator flag */
 107 extern int      blockswritten;  /* number of blocks written on current tape */
 108 extern int      tapeno;         /* current tape number */
 109 extern time_t   tstart_writing; /* when started writing the first tape block */
 110 extern time_t   tend_writing;   /* after writing the last tape block */
 111 #ifdef __linux__
 112 extern ext2_filsys fs;
 113 #else
 114 extern struct   fs *sblock;     /* the file system super block */
 115 extern char     sblock_buf[MAXBSIZE];
 116 #endif
 117 extern long     xferrate;       /* averaged transfer rate of all volumes */
 118 extern long     dev_bsize;      /* block size of underlying disk device */
 119 extern int      dev_bshift;     /* log2(dev_bsize) */
 120 extern int      tp_bshift;      /* log2(TP_BSIZE) */
 121 extern dump_ino_t volinfo[];    /* which inode on which volume archive info */
 122
 123 #ifdef USE_QFA
 124 #define QFA_MAGIC       "495115637697"
 125 #define QFA_VERSION     "1.0"
 126 extern int      gTapeposfd;
 127 extern char     *gTapeposfile;
 128 extern char     gTps[255];
 129 extern int32_t  gThisDumpDate;
 130 #endif /* USE_QFA */
 131
 132 #ifndef __P
 133 #include <sys/cdefs.h>
 134 #endif
 135
 136 /* operator interface functions */
 137 void    broadcast __P((const char *message));
 138 time_t  do_stats __P((void));
 139 void    lastdump __P((char arg));
 140 void    msg __P((const char *fmt, ...));
 141 void    msgtail __P((const char *fmt, ...));
 142 int     query __P((const char *question));
 143 void    quit __P((const char *fmt, ...));
 144 void    set_operators __P((void));
 145 #if defined(SIGINFO)
 146 void    statussig __P((int signo));
 147 #endif
 148 void    timeest __P((void));
 149 time_t  unctime __P((const char *str));
 150
 151 /* mapping rouintes */
 152 struct  dinode;
 153 long    blockest __P((struct dinode const *dp));
 154 int     mapfiles __P((dump_ino_t maxino, long *tapesize));
 155 #ifdef  __linux__
 156 int     mapfilesfromdir __P((dump_ino_t maxino, long *tapesize, char *directory));
 157 int     maponefile __P((dump_ino_t maxino, long *tapesize, char *directory));
 158 #endif
 159 int     mapdirs __P((dump_ino_t maxino, long *tapesize));
 160
 161 /* file dumping routines */
 162 void    blksout __P((daddr_t *blkp, int frags, dump_ino_t ino));
 163 void    bread __P((daddr_t blkno, char *buf, int size));
 164 void    dumpino __P((struct dinode *dp, dump_ino_t ino, int metaonly));
 165 #ifdef  __linux__
 166 void    dumpdirino __P((struct dinode *dp, dump_ino_t ino));
 167 #endif
 168 void    dumpmap __P((char *map, int type, dump_ino_t ino));
 169 void    writeheader __P((dump_ino_t ino));
 170 void    mkchecksum __P((union u_spcl *tmpspcl));
 171
 172 /* tape writing routines */
 173 int     alloctape __P((void));
 174 void    close_rewind __P((void));
 175 void    dumpblock __P((daddr_t blkno, int size));
 176 void    startnewtape __P((int top));
 177 time_t  trewind __P((void));
 178 void    writerec __P((const void *dp, int isspcl));
 179 char    *mktimeest __P((time_t tnow));
 180
 181 void    Exit __P((int status));
 182 void    dumpabort __P((int signo));
 183 void    getfstab __P((void));
 184
 185 const char *rawname __P((const char *cp));
 186 struct  dinode *getino __P((dump_ino_t inum));
 187
 188 /* rdump routines */
 189 #ifdef RDUMP
 190 int     rmthost __P((const char *host));
 191 int     rmtopen __P((const char *tape, const int mode));
 192 void    rmtclose __P((void));
 193 int     rmtread __P((char *buf, size_t count));
 194 int     rmtwrite __P((const char *buf, size_t count));
 195 OFF_T   rmtseek __P((OFF_T offset, int pos));
 196 struct mtget * rmtstatus __P((void));
 197 int     rmtioctl __P((int cmd, int count));
 198 #endif /* RDUMP */
 199
 200 void    interrupt __P((int signo));     /* in case operator bangs on console */
 201 int     exclude_ino __P((dump_ino_t ino));
 202 void    do_exclude_ino __P((dump_ino_t ino, const char *));
 203
 204 /*
 205  *      Exit status codes
 206  */
 207 #define X_FINOK         0       /* normal exit */
 208 #define X_STARTUP       1       /* startup error */
 209 #define X_REWRITE       2       /* restart writing from the check point */
 210 #define X_ABORT         3       /* abort dump; don't attempt checkpointing */
 211
 212 #define OPGRENT "operator"              /* group entry to notify */
 213 #ifdef  __linux__
 214 #define DIALUP  "ttyS"                  /* prefix for dialups */
 215 #else
 216 #define DIALUP  "ttyd"                  /* prefix for dialups */
 217 #endif
 218
 219 #include <mntent.h>
 220
 221 struct  mntent *fstabsearch __P((const char *key));     /* search fs_file and fs_spec */
 222 #ifdef  __linux__
 223 struct  mntent *fstabsearchdir __P((const char *key, char *dir));       /* search fs_file and fs_spec */
 224 #endif
 225
 226 /*
 227  *      The contents of the file _PATH_DUMPDATES is maintained both on
 228  *      a linked list, and then (eventually) arrayified.
 229  */
 230 struct dumpdates {
 231         char    dd_name[MAXPATHLEN+3];
 232         struct mntent *dd_fstab;
 233         char    dd_level;
 234         time_t  dd_ddate;
 235 };
 236 struct dumptime {
 237         struct  dumpdates dt_value;
 238         struct  dumptime *dt_next;
 239 };
 240 extern struct   dumptime *dthead;       /* head of the list version */
 241 extern int      nddates;                /* number of records (might be zero) */
 242 extern int      ddates_in;              /* we have read the increment file */
 243 extern struct   dumpdates **ddatev;     /* the arrayfied version */
 244 void    initdumptimes __P((int));
 245 void    getdumptime __P((int));
 246 void    putdumptime __P((void));
 247 #define ITITERATE(i, ddp) \
 248         for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
 249
 250 void    sig __P((int signo));
 251
 252 /*
 253  * Compatibility with old systems.
 254  */
 255 #ifdef COMPAT
 256 #include <sys/file.h>
 257 #define strchr(a,b)     index(a,b)
 258 #define strrchr(a,b)    rindex(a,b)
 259 extern char *strdup(), *ctime();
 260 extern int read(), write();
 261 extern int errno;
 262 #endif
 263
 264 #ifdef  __linux__
 265 #define DUMP_CURRENT_REV        1
 266
 267 int dump_fs_open(const char *disk, ext2_filsys *fs);
 268 #endif
 269
 270 #ifdef sunos
 271 extern char *calloc();
 272 extern char *malloc();
 273 extern long atol();
 274 extern char *strcpy();
 275 extern char *strncpy();
 276 extern char *strcat();
 277 extern time_t time();
 278 extern void endgrent();
 279 extern void exit();
 280 extern off_t lseek();
 281 extern const char *strerror();
 282 #endif
 283
 284                                 /* 04-Feb-00 ILC */
 285 #define IEXCLUDE_MAXNUM 256     /* max size of inode exclude list */
 286