sbin/dump/dump.h

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