backup/full

   1 #!/usr/bin/perl
   2 # full
   3 # Main backup script - does a full dump or execs increm.  Do NOT run directly!
   4 #
   5 # This file is part of chiark backup, a system for backing up GNU/Linux and
   6 # other UN*X-compatible machines, as used on chiark.greenend.org.uk.
   7 #
   8 # chiark backup is:
   9 #  Copyright (C) 1997-1998,2000-2001 Ian Jackson <ian@chiark.greenend.org.uk>
  10 #  Copyright (C) 1999 Peter Maydell <pmaydell@chiark.greenend.org.uk>
  11 #
  12 # This is free software; you can redistribute it and/or modify it under the
  13 # terms of the GNU General Public License as published by the Free Software
  14 # Foundation; either version 2, or (at your option) any later version.
  15 #
  16 # This is distributed in the hope that it will be useful, but WITHOUT ANY
  17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  19 # details.
  20 #
  21 # You should have received a copy of the GNU General Public License along
  22 # with this program; if not, write to the Free Software Foundation, Inc.,
  23 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24
  25 BEGIN {
  26     $etc= '/etc/chiark-backup';
  27     require "$etc/settings.pl";
  28     require 'backuplib.pl';
  29 }
  30
  31 $|=1;
  32
  33 while (@ARGV) {
  34     $_= shift @ARGV;
  35     if (m/^\-\-no\-reten$/) {
  36         $noreten=1;
  37     } elsif (m/^\-\-no\-config\-check$/) {
  38         $nocheck=1;
  39     } else {
  40         die "unknown option/argument \`$_'\n";
  41     }
  42 }
  43
  44 # Check to see whether the tape.nn and fsys.nn files are sane.
  45 # checkallused checks that all the filesystems mounted are in fact
  46 # dumped in both full and incremental dumps.
  47
  48 openlog();
  49
  50 if (!$nocheck) {
  51     setstatus "FAILED configuration check";
  52     print "Configuration check ...\n" or die $!;
  53     system 'backup-checkallused'; $? and die $?;
  54 } else {
  55     setstatus "FAILED rewinding";
  56     rewind_raw();
  57 }
  58
  59 printdate();
  60
  61 setstatus "FAILED reading TAPEID";
  62 # Try to read the tape ID from the tape into the file TAPEID
  63
  64 readtapeid_raw();
  65
  66 setstatus "FAILED during startup";
  67
  68 # We need some ID; if the tape has one already that takes precedence;
  69 # otherwise the user might have set a tape ID that this should be
  70 # by creating really-TAPEID.
  71 if (open T, "TAPEID") {
  72     unlink 'really-TAPEID';
  73 } elsif (open T, "really-TAPEID") {
  74 } else {
  75     die "No TAPEID.\n";
  76 }
  77
  78 # read the ID; it had better be a non-empty string of alphanumeric chars.
  79 chomp($tapeid= <T>);
  80 $tapeid =~ m/[^0-9a-zA-Z]/ and die "Bad TAPEID ($&).\n";
  81 $tapeid =~ m/[0-9a-zA-Z]/ or die "Empty TAPEID.\n";
  82 close T;
  83
  84 setstatus "FAILED at tape identity check";
  85
  86 # We don't let the user overwrite the tape used for the last backup.
  87 if (open L, "last-tape") {
  88     chomp($lasttape= <L>);
  89     close L;
  90 } else {
  91     undef $lasttape;
  92 }
  93
  94 die "Tape $tapeid same as last time.\n" if $tapeid eq $lasttape;
  95
  96 # $tapeid identifies the individual tape; $tapedesc is its current
  97 # identity and function, for printing in messages.  You can make these
  98 # namespaces the same if you like, or you can make the tape.<tapeid>
  99 # files be links to tape.<tapedesc> files.
 100 if (defined($tapedesc= readlink "$etc/tape.$tapeid")) {
 101     $tapedesc =~ s/^.*\.//;
 102     $tapedesc .= "($tapeid)";
 103 } else {
 104     $tapedesc = $tapeid;
 105 }
 106
 107 # Parse the appropriate tape.nn file.
 108 # Format is: empty lines and lines starting '#' are ignored. Trailing
 109 # whitespace is ignored. File must end with 'end' on a line by itself.
 110 # Either there should be a line 'incremental' to indicate that this is
 111 # a tape for incremental backups, or a pair of lines 'filesystems fsg'
 112 # and 'next tapeid', indicating that this tape is part of a full
 113 # backup, containing the filesystem group fsg.
 114 undef $fsys;
 115 open D, "$etc/tape.$tapeid" or die "Unknown tape $tapeid ($!).\n";
 116 for (;;) {
 117     $_= <D> or die; chomp; s/\s+$//;
 118     last if m/^end$/;
 119     next unless m/\S/;
 120     next if m/^\#/;
 121     if (m/^filesystems (\w+)$/) {
 122         $fsys= $1;
 123     } elsif (m/^next (\w+)$/) {
 124         $next= $1;
 125     } elsif (m/^incremental$/) {
 126         $incremental= 1;
 127     } else {
 128         die "unknown entry in tape $tapeid at line $.: $_\n";
 129     }
 130 }
 131 close D or die $!;
 132
 133 # Incremental backups are handled by increm, not us.
 134 if ($incremental) {
 135     die "incremental tape $tapeid has next or filesystems\n"
 136         if defined($next) || defined($fsys);
 137     print STDERR "Incremental tape $tapeid.\n\n";
 138     setstatus "FAILED during incremental startup";
 139     exec "increm",$tapeid,$tapedesc;
 140     die $!;
 141 }
 142
 143 # Read the filesystem group definition (file fsys.nnn)
 144 readfsys("$fsys");
 145
 146 $doing= "dump of $fsys to tape $tapedesc in drive $tape";
 147 print LOG "$doing:\n" or die $!;
 148
 149 if (!$noreten) {
 150     setstatus "FAILED retensioning";
 151     runsystem("mt -f $tape reten");
 152 }
 153
 154 setstatus "FAILED writing tape ID";
 155 # First write the tape ID to this tape.
 156
 157 writetapeid($tapeid,$tapedesc);
 158
 159 unlink 'this-md5sums';
 160
 161 print "Doing $doing ...\n" or die $!;
 162
 163 unlink 'p';
 164 system 'mknod p p'; $? and die $?;
 165
 166 setstatus "FAILED during dump";
 167
 168 sub closepipes () {
 169     close(DUMPOR); close(TEEOR); close(BUFOR); close(FINDOR);
 170     close(DUMPOW); close(TEEOW); close(BUFOW); close(FINDOW);
 171     close(GZOR); close(GZOW);
 172     close(DDERRR); close(DDERRW);
 173 }
 174
 175 # work out a find option string that will exclude the required files
 176 # Note that dump pays no attention to exclude options.
 177 $exclopt = '';
 178 foreach $exc (@excldir) {
 179     $exclopt .= "-regex $exc -prune -o ";
 180 }
 181 foreach $exc (@excl) {
 182     $exclopt .= "-regex $exc -o ";
 183 }
 184
 185 # For each filesystem to be put on this tape:
 186 for $tf (@fsys) {
 187     printdate();
 188     parsefsys();
 189
 190     pipe(FINDOR,FINDOW) or die $!;
 191     pipe(DUMPOR,DUMPOW) or die $!;
 192     pipe(TEEOR,TEEOW) or die $!;
 193     pipe(TEEOR,TEEOW) or die $!;
 194     pipe(BUFOR,BUFOW) or die $!;
 195     pipe(DDERRR,DDERRW) or die $!;
 196
 197     $bufir='TEEOR';
 198     $ddcmd= "dd ibs=$softblocksizebytes obs=$blocksizebytes of=$ntape 2>&1";
 199
 200     if ($gz) {
 201         $bufir='GZOR';
 202         pipe(GZOR,GZOW) or die $!;
 203         $ddcmd .= " conv=sync";
 204     }
 205
 206     nexttapefile("full $prefix:$atf");
 207
 208     # We can back up via dump or cpio or zafio
 209     $dumpin= '</dev/null';
 210     if ($tm eq 'dump') {
 211         $dumpcmd= "dump 0bfu $softblocksizekb - $atf";
 212     } elsif ($tm eq 'cpio') {
 213         startprocess '</dev/null','>&FINDOW',$rstr."find $atf -xdev -noleaf -print0";
 214         $dumpcmd= "cpio -Hustar -o0C$softblocksizebytes";
 215         $dumpin= '<&FINDOR';
 216     } elsif ($tm eq 'zafio') {
 217         # compress-each-file-then-archive using afio
 218         startprocess '</dev/null','>&FINDOW',$rstr."find $atf -xdev -noleaf $exclopt -print";
 219         # don't use verbose flag as this generates 2MB report emails :->
 220         $dumpcmd = "afio -b $softblocksizebytes -Zo -";
 221         $dumpin = '<&FINDOR';
 222     } elsif ($tm eq 'ntfsimage') {
 223         $dumpcmd= "ntfsimage -svvf --dirty $dev";
 224     } else {
 225         die "unknown method $tm for $prefix:$atf\n";
 226     }
 227     # This is a funky way of doing a pipeline which pays attention
 228     # to the exit status of all the commands in the pipeline.
 229     # It is roughly equivalent to:
 230     #    md5sum <p >>this-md5sums
 231     #    dump <$dumpin | tee p [| gzip] | writebuffer | dd >/dev/null
 232
 233     startprocess '<p','>>this-md5sums',"$nice md5sum";
 234     startprocess $dumpin,'>&DUMPOW',"$nice ".$rstr.$dumpcmd;
 235     startprocess '<&DUMPOR','>&TEEOW',"$nice tee p";
 236     if ($gz) {
 237         startprocess '<&TEEOR','>&GZOW',"$nice gzip -v$gz";
 238     }
 239     startprocess "<&$bufir",'>&BUFOW',"$nasty writebuffer";
 240     startprocess '<&DDERRR','>/dev/null',"$nice tee dderr >&2";
 241     startprocess '<&BUFOR','>&DDERRW',"$nasty $ddcmd";
 242     closepipes();
 243     endprocesses();
 244
 245     open DDERR, "dderr" or die $!;
 246     defined(read DDERR,$_,1023) or die $!;
 247     close DDERR;
 248     m/\n(\d+)\+0 records out\n/ or die ">$dderr< ?";
 249     push @tapefilesizes, [ $1, $currenttapefilename ];
 250     $totalrecords += $1;
 251     pboth("total blocks written so far: $totalrecords\n");
 252 }
 253
 254 # The backup should now be complete; verify it
 255
 256 setstatus "FAILED during check";
 257
 258 # Rewind the tape and skip the TAPEID record
 259 runsystem("mt -f $tape rewind");
 260 runsystem("mt -f $ntape fsf 1");
 261
 262 # Check the md5sums match for each filesystem on the tape
 263 open S,"this-md5sums" or die $!;
 264 for $tf (@fsys) {
 265     printdate();
 266     parsefsys();
 267     chomp($orgsum= <S>); $orgsum =~ s/\ +\-?$//;
 268     $orgsum =~ m/^[0-9a-fA-F]{32}$/i or die "orgsum \`$orgsum' ?";
 269     $cmd= "$nasty dd if=$ntape ibs=$blocksizebytes";
 270     $cmd .= " | $nasty readbuffer";
 271     $cmd .= " | $nice gzip -vd" if $gz;
 272     $cmd .= " | $nice md5sum";
 273     pboth("  $cmd\n");
 274     chomp($csum= `$cmd`);
 275     $csum =~ s/\ +\-?$//;
 276     $orgsum eq $csum or die "MISMATCH $tf $csum $orgsum\n";
 277     print "checksum ok $csum\t$tf\n" or die $!;
 278     print LOG "checksum ok $csum\t$tf\n" or die $!;
 279 }
 280 printdate();
 281 runsystem("mt -f $tape rewind");
 282
 283 setstatus "FAILED during cleanup";
 284
 285 $summary= '';
 286 foreach $tfs (@tapefilesizes) {
 287     $summary .= sprintf "    %10d blocks for %s\n", $tfs->[0], $tfs->[1]
 288 }
 289 $summary .=
 290     sprintf "    %10d blocks total (of %d bytes) plus TAPEID and headers\n",
 291     $totalrecords, $blocksizebytes;
 292
 293 pboth("size-summary:\n");
 294 pboth($summary);
 295
 296 open SS, ">size-summary..new" or die $!;
 297 print SS $summary or die $!;
 298 close SS or die $!;
 299 rename 'size-summary..new',"size-summary.$fsys" or die $!;
 300
 301 # Write to some status files to indicate what the backup system
 302 # ought to do when next invoked.
 303 # reset incremental backup count to 1.
 304 open IAN,">increm-advance.new" or die $!;
 305 print IAN "1\n" or die $!;
 306 close IAN or die $!;
 307
 308 # Next full backup is whatever the next link in the tape description
 309 # file says it ought to be.
 310 open TN,">next-full.new" or die $!;
 311 print TN "$next\n" or die $!;
 312 close TN or die $!;
 313
 314 unlink 'last-tape','next-full';
 315 # We are the last tape to have been backed up
 316 rename 'TAPEID','last-tape' or die $!;
 317 rename 'this-md5sums',"md5sums.$fsys" or die $!;
 318 rename 'log',"log.$fsys" or die $!;
 319 rename 'next-full.new',"next-full" or die $!;
 320 rename 'increm-advance.new',"increm-advance" or die $!;
 321
 322 print "$doing completed.\nNext dump tape is $next.\n" or die $!;
 323
 324 setstatus "Successful: $tapedesc $fsys, next $next";
 325 exit 0;