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.52 2011/06/10 13:41:41 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. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 #include <config.h>
  41 #include <protocols/dumprestore.h>
  42 #include <compatlfs.h>
  43 #include "transformation.h"
  44
  45 #define MAXINOPB        (MAXBSIZE / sizeof(struct dinode))
  46 #define MAXNINDIR       (MAXBSIZE / sizeof(blk_t))
  47 #define NUM_STR_SIZE    32      /* a generic number buffer size */
  48
  49 /*
  50  * Dump maps used to describe what is to be dumped.
  51  */
  52 extern int      mapsize;        /* size of the state maps */
  53 extern char     *usedinomap;    /* map of allocated inodes */
  54 extern char     *dumpdirmap;    /* map of directories to be dumped */
  55 extern char     *dumpinomap;    /* map of files to be dumped */
  56 extern char     *metainomap;    /* which of the inodes in dumpinomap
  57                                    will get only their metadata dumped */
  58 /*
  59  * Map manipulation macros.
  60  */
  61 #define SETINO(ino, map) \
  62         map[(u_int)((ino) - 1) / NBBY] |=  1 << ((u_int)((ino) - 1) % NBBY)
  63 #define CLRINO(ino, map) \
  64         map[(u_int)((ino) - 1) / NBBY] &=  ~(1 << ((u_int)((ino) - 1) % NBBY))
  65 #define TSTINO(ino, map) \
  66         (map[(u_int)((ino) - 1) / NBBY] &  (1 << ((u_int)((ino) - 1) % NBBY)))
  67
  68 /*
  69  *      All calculations done in 0.1" units!
  70  */
  71 extern char     *host;          /* name of the remote host */
  72 extern const char *disk;        /* name of the disk file */
  73 extern char     tape[MAXPATHLEN];/* name of the tape file */
  74 extern char     *tapeprefix;    /* prefix of the tape file */
  75 extern char     *dumpdates;     /* name of the file containing dump date information*/
  76 extern char     lastlevel[NUM_STR_SIZE];/* dump level of previous dump */
  77 extern char     level[NUM_STR_SIZE];/* dump level of this dump */
  78 extern int      zipflag;        /* which compression method */
  79 extern int      uflag;          /* update flag */
  80 extern int      mflag;          /* dump metadata only if possible flag */
  81 extern int      Mflag;          /* multi-volume flag */
  82 extern int      qflag;          /* quit on errors flag */
  83 extern int      vflag;          /* verbose flag */
  84 extern int      breademax;      /* maximum number of bread errors before we quit */
  85 extern char     *eot_script;    /* end of volume script fiag */
  86 extern int      diskfd;         /* disk file descriptor */
  87 extern int      tapefd;         /* tape file descriptor */
  88 extern int      pipeout;        /* true => output to standard output */
  89 extern int      fifoout;        /* true => output to fifo */
  90 extern dump_ino_t curino;       /* current inumber; used globally */
  91 extern int      newtape;        /* new tape flag */
  92 extern int      density;        /* density in 0.1" units */
  93 extern long long tapesize;      /* estimated tape size, blocks */
  94 extern long     tsize;          /* tape size in 0.1" units */
  95 extern long     asize;          /* number of 0.1" units written on current tape */
  96 extern int      etapes;         /* estimated number of tapes */
  97 extern int      nonodump;       /* if set, do not honor UF_NODUMP user flags */
  98 extern int      unlimited;      /* if set, write to end of medium */
  99 extern int      compressed;     /* if set, dump is to be compressed */
 100 extern long long bytes_written;/* total bytes written to tape */
 101 extern long     uncomprblks;    /* uncompressed blocks written to tape */
 102 extern int      notify;         /* notify operator flag */
 103 extern int      blockswritten;  /* number of blocks written on current tape */
 104 extern int      tapeno;         /* current tape number */
 105 extern time_t   tstart_writing; /* when started writing the first tape block */
 106 extern time_t   tend_writing;   /* after writing the last tape block */
 107 #ifdef __linux__
 108 extern ext2_filsys fs;
 109 #else
 110 extern struct   fs *sblock;     /* the file system super block */
 111 extern char     sblock_buf[MAXBSIZE];
 112 #endif
 113 extern long     xferrate;       /* averaged transfer rate of all volumes */
 114 extern long     dev_bsize;      /* block size of underlying disk device */
 115 extern int      dev_bshift;     /* log2(dev_bsize) */
 116 extern int      tp_bshift;      /* log2(TP_BSIZE) */
 117 extern dump_ino_t volinfo[];    /* which inode on which volume archive info */
 118 extern Transformation *transformation;
 119
 120 #ifndef __P
 121 #include <sys/cdefs.h>
 122 #endif
 123
 124 /* operator interface functions */
 125 void    broadcast __P((const char *message));
 126 time_t  do_stats __P((void));
 127 void    lastdump __P((char arg));
 128 void    msg __P((const char *fmt, ...));
 129 void    msgtail __P((const char *fmt, ...));
 130 int     query __P((const char *question));
 131 void    quit __P((const char *fmt, ...));
 132 void    set_operators __P((void));
 133 #if defined(SIGINFO)
 134 void    statussig __P((int signo));
 135 #endif
 136 void    timeest __P((void));
 137 time_t  unctime __P((const char *str));
 138
 139 /* mapping rouintes */
 140 struct  dinode;
 141 long    blockest __P((struct dinode const *dp));
 142 int     mapfiles __P((dump_ino_t maxino, long long *tapesize));
 143 #ifdef  __linux__
 144 int     mapfilesfromdir __P((dump_ino_t maxino, long long *tapesize, char *directory));
 145 int     maponefile __P((dump_ino_t maxino, long long *tapesize, char *directory));
 146 #endif
 147 int     mapdirs __P((dump_ino_t maxino, long long *tapesize));
 148
 149 /* file dumping routines */
 150 void    blksout __P((blk_t *blkp, int frags, dump_ino_t ino));
 151 void    bread __P((ext2_loff_t blkno, char *buf, int size));
 152 void    dumpino __P((struct dinode *dp, dump_ino_t ino, int metaonly));
 153 #ifdef  __linux__
 154 void    dumpdirino __P((struct dinode *dp, dump_ino_t ino));
 155 #endif
 156 void    dumpmap __P((char *map, int type, dump_ino_t ino));
 157 void    writeheader __P((dump_ino_t ino));
 158 void    mkchecksum __P((union u_spcl *tmpspcl));
 159
 160 /* tape writing routines */
 161 int     alloctape __P((void));
 162 void    close_rewind __P((void));
 163 void    dumpblock __P((blk_t blkno, int size));
 164 void    startnewtape __P((int top));
 165 time_t  trewind __P((void));
 166 void    writerec __P((const void *dp, int isspcl));
 167 char    *mktimeest __P((time_t tnow));
 168
 169 void    Exit __P((int status));
 170 void    dumpabort __P((int signo));
 171 void    getfstab __P((void));
 172
 173 const char *rawname __P((const char *cp));
 174 struct  dinode *getino __P((dump_ino_t inum));
 175
 176 /* rdump routines */
 177 #ifdef RDUMP
 178 int     rmthost __P((const char *host));
 179 int     rmtopen __P((const char *tape, const int mode));
 180 void    rmtclose __P((void));
 181 int     rmtread __P((char *buf, size_t count));
 182 int     rmtwrite __P((const char *buf, size_t count));
 183 OFF_T   rmtseek __P((OFF_T offset, int pos));
 184 struct mtget * rmtstatus __P((void));
 185 int     rmtioctl __P((int cmd, int count));
 186 #endif /* RDUMP */
 187
 188 void    interrupt __P((int signo));     /* in case operator bangs on console */
 189 int     exclude_ino __P((dump_ino_t ino));
 190 void    do_exclude_ino __P((dump_ino_t ino, const char *));
 191
 192 /*
 193  *      Exit status codes
 194  */
 195 #define X_FINOK         0       /* normal exit */
 196 #define X_STARTUP       1       /* startup error */
 197 #define X_REWRITE       2       /* restart writing from the check point */
 198 #define X_ABORT         3       /* abort dump; don't attempt checkpointing */
 199
 200 #define OPGRENT "operator"              /* group entry to notify */
 201 #ifdef  __linux__
 202 #define DIALUP  "ttyS"                  /* prefix for dialups */
 203 #else
 204 #define DIALUP  "ttyd"                  /* prefix for dialups */
 205 #endif
 206
 207 #include <mntent.h>
 208
 209 struct  mntent *fstabsearch __P((const char *key));     /* search fs_file and fs_spec */
 210 #ifdef  __linux__
 211 struct  mntent *fstabsearchdir __P((const char *key, char *dir));       /* search fs_file and fs_spec */
 212 #endif
 213
 214 /*
 215  *      The contents of the file _PATH_DUMPDATES is maintained both on
 216  *      a linked list, and then (eventually) arrayified.
 217  */
 218 struct dumpdates {
 219         char    dd_name[MAXPATHLEN+3];
 220         struct mntent *dd_fstab;
 221         int     dd_level;
 222         time_t  dd_ddate;
 223 };
 224 struct dumptime {
 225         struct  dumpdates dt_value;
 226         struct  dumptime *dt_next;
 227 };
 228 extern struct   dumptime *dthead;       /* head of the list version */
 229 extern int      nddates;                /* number of records (might be zero) */
 230 extern int      ddates_in;              /* we have read the increment file */
 231 extern struct   dumpdates **ddatev;     /* the arrayfied version */
 232 void    initdumptimes __P((int));
 233 void    getdumptime __P((int));
 234 void    putdumptime __P((void));
 235 #define ITITERATE(i, ddp) \
 236         for (ddp = ddatev[i = 0]; i < nddates; ddp = ddatev[++i])
 237
 238 void    sig __P((int signo));
 239
 240 /*
 241  * Compatibility with old systems.
 242  */
 243 #ifdef COMPAT
 244 #include <sys/file.h>
 245 #define strchr(a,b)     index(a,b)
 246 #define strrchr(a,b)    rindex(a,b)
 247 extern char *strdup(), *ctime();
 248 extern int read(), write();
 249 extern int errno;
 250 #endif
 251
 252 #ifdef  __linux__
 253 #define DUMP_CURRENT_REV        1
 254
 255 int dump_fs_open(const char *disk, ext2_filsys *fs);
 256 #endif
 257
 258 #ifndef __linux__
 259 #ifndef _PATH_UTMP
 260 #define _PATH_UTMP      "/etc/utmp"
 261 #endif
 262 #ifndef _PATH_FSTAB
 263 #define _PATH_FSTAB     "/etc/fstab"
 264 #endif
 265 #endif
 266
 267 #ifdef sunos
 268 extern char *calloc();
 269 extern char *malloc();
 270 extern long atol();
 271 extern char *strcpy();
 272 extern char *strncpy();
 273 extern char *strcat();
 274 extern time_t time();
 275 extern void endgrent();
 276 extern void exit();
 277 extern off_t lseek();
 278 extern const char *strerror();
 279
 280 #endif
 281