common.dump

   1 #/bin/sh
   2
   3 #
   4 # Functions useful for xfsdump/xfsrestore tests
   5 #
   6 # Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
   7 #
   8 # This program is free software; you can redistribute it and/or modify it
   9 # under the terms of version 2 of the GNU General Public License as
  10 # published by the Free Software Foundation.
  11 #
  12 # This program is distributed in the hope that it would be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  15 #
  16 # Further, this software is distributed without any warranty that it is
  17 # free of the rightful claim of any third person regarding infringement
  18 # or the like.  Any license provided herein, whether implied or
  19 # otherwise, applies only to this software file.  Patent licenses, if
  20 # any, provided herein do not apply to combinations of this program with
  21 # other software, or any other product whatsoever.
  22 #
  23 # You should have received a copy of the GNU General Public License along
  24 # with this program; if not, write the Free Software Foundation, Inc., 59
  25 # Temple Place - Suite 330, Boston MA 02111-1307, USA.
  26 #
  27 # Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  28 # Mountain View, CA  94043, or:
  29 #
  30 # http://www.sgi.com
  31 #
  32 # For further information regarding this notice, see:
  33 #
  34 # http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  35 #
  36
  37 # --- initializations ---
  38 rm -f $seq.full
  39
  40 if [ -n "$DEBUGDUMP" ]; then
  41   _dump_debug=-v5
  42   _restore_debug=-v5
  43   _invutil_debug=-d
  44 fi
  45
  46 # Use dump/restore in qa directory for debugging
  47 PATH="$here:$PATH"
  48 export PATH
  49 #which xfsdump
  50 #which xfsrestore
  51 #which xfsinvutil
  52
  53 # status returned for not run tests
  54 NOTRUNSTS=2
  55
  56 # name those directories
  57 dump_file=$tmp.dumpfile
  58 # dump_file=$here/dumpfile #TEMP OVERRIDE DUMP FILE
  59 dump_sdir=dumpdir
  60 dump_dir=$SCRATCH_MNT/$dump_sdir
  61 restore_sdir=restoredir
  62 restore_dir=$SCRATCH_MNT/$restore_sdir
  63 multi=3
  64 dumptape=$TAPE_DEV
  65 media_label="stress_tape_media"
  66 session_label="stress_$seq"
  67
  68 nobody=4 # define this uid/gid as a number
  69 do_quota_check=true # do quota check if quotas enabled
  70
  71 _need_to_be_root
  72
  73 # install our cleaner
  74 trap "_cleanup; exit \$status" 0 1 2 3 15
  75
  76 # start inventory from a known base - move it aside for test
  77 for dir in /var/xfsdump/inventory /var/lib/xfsdump/inventory; do
  78     if [ -d $dir ]; then
  79         [ -d $dir.$seq ] && rm -rf $dir.$seq
  80         mv $dir $dir.$seq
  81     fi
  82 done
  83
  84 # remove this when xfstests irix/linux port done
  85 if [ "X$XFS_HOST_OS" = "Xirix" ]
  86 then # IRIX
  87     have_mtvariable=false
  88     MKFS_OPTS=""
  89 else # Linux
  90     have_mtvariable=true
  91     MKFS_OPTS="-f"
  92 fi
  93
  94
  95 #
  96 # do a remote/local mt
  97 #
  98 _mt()
  99 {
 100     op=$1
 101     if _isrmt; then
 102         # REMOTE
 103         _rmtdev=`echo $dumptape | $AWK_PROG -F: '{print $2}'`
 104
 105         if echo $dumptape | grep '@' >/dev/null; then
 106             _spec=`echo $dumptape | $AWK_PROG -F: '{print $1}'`
 107             _rmtuser=`echo $_spec | $AWK_PROG -F@ '{print $1}'`
 108             _rmthost=`echo $_spec | $AWK_PROG -F@ '{print $2}'`
 109             rsh -n -l $_rmtuser $_rmthost "mt -t $_rmtdev $op"
 110         else
 111             _rmthost=`echo $dumptape | $AWK_PROG -F: '{print $1}'`
 112             rsh -n $_rmthost "mt -t $_rmtdev $op"
 113         fi
 114     else
 115         #LOCAL
 116         mt -t $dumptape $op
 117     fi
 118 }
 119
 120 _check_onl()
 121 {
 122     _limit=10
 123     i=0
 124     while [ $i -lt $_limit ]; do
 125         echo "Checking online..." >>$seq.full
 126         if _mt status >$tmp.status 2>&1; then
 127             break;
 128         else
 129             sleep 2
 130         fi
 131         i=`expr $i + 1`
 132     done
 133
 134
 135     if [ $i -eq $_limit ]; then
 136         echo "ERROR: mt -f $dumptape failed"
 137         cat $tmp.status
 138
 139         echo "mt -f $dumptape failed" >$seq.notrun
 140         status=$NOTRUNSTS
 141         exit
 142     fi
 143
 144
 145     if egrep -i 'onl|ready' $tmp.status | grep -iv 'not ready' >/dev/null; then
 146         :
 147     else
 148         echo "ERROR: $dumptape is not online"
 149         cat $tmp.status
 150
 151         echo "dumptape, $dumptape, is not online" >$seq.notrun
 152         status=$NOTRUNSTS
 153         exit
 154     fi
 155 }
 156
 157 _wait_tape()
 158 {
 159     echo "Wait for tape, $dumptape, ..." >>$seq.full
 160
 161     i=0
 162     while [ $i -lt 20 ]; do
 163         echo "Checking status..." >>$seq.full
 164         if _mt status 2>&1 | tee -a $seq.full | egrep -i "onl|ready" >/dev/null; then
 165             break;
 166         else
 167             sleep 2
 168         fi
 169         i=`expr $i + 1`
 170     done
 171 }
 172
 173 #
 174 # Keep trying so we know we really have rewound
 175 #
 176 _rewind()
 177 {
 178     echo "Initiate rewind..." >>$seq.full
 179     _wait_tape
 180     _mt rewind >/dev/null
 181     _wait_tape
 182 }
 183
 184 #
 185 # Do a custom erase because:
 186 # (i) some machines don't support it
 187 # (ii) some machines take forever to do it
 188 #
 189 _erase_soft()
 190 {
 191     echo "Erasing tape" | tee -a $seq.full
 192     _rewind
 193     _mt weof 3
 194     _rewind
 195 }
 196
 197 _erase_hard()
 198 {
 199     echo "Erasing tape" | tee -a $seq.full
 200     _mt erase
 201 }
 202
 203 _isrmt()
 204 {
 205     echo $dumptape | grep ':' >/dev/null
 206 }
 207
 208 #
 209 # Get tape ready
 210 #
 211 _set_variable()
 212 {
 213     $have_mtvariable || return
 214
 215     if _isrmt; then
 216         :
 217     else
 218         # LOCAL
 219         echo "Put scsi tape driver into variable block size mode"
 220         mt -f $dumptape setblk 0
 221     fi
 222 }
 223
 224 _require_tape()
 225 {
 226     dumptape=$1
 227
 228     if [ -z "$dumptape" ]; then
 229         echo "This test requires a dump tape - none was specified"
 230         echo "No dump tape specified" >$seq.notrun
 231         status=$NOTRUNSTS
 232         exit
 233     fi
 234
 235     _check_onl
 236     _set_variable
 237 }
 238
 239 _error()
 240 {
 241     echo "Error: $*" | tee -a $seq.full
 242     echo "(see $seq.full for details)"
 243     status=1
 244     exit
 245 }
 246
 247 _wipe_fs()
 248 {
 249     _require_scratch
 250
 251     mkfs_xfs $MKFS_OPTS $SCRATCH_DEV>>$seq.full  ||\
 252         _error "mkfs failed"
 253
 254     mount -t xfs $SCRATCH_DEV $SCRATCH_MNT >>$seq.full ||\
 255         _error "mount failed"
 256 }
 257
 258 #
 259 # Cleanup created dirs and files
 260 # Called by trap
 261 #
 262 _cleanup()
 263 {
 264     cd $here
 265     rm -f $tmp.*
 266
 267     if [ -n "$DEBUGDUMP" ]; then
 268         # save it for inspection
 269         for dir in /var/xfsdump/inventory /var/lib/xfsdump/inventory; do
 270             [ -d $dir ] || continue
 271             tar -cvf $seq.inventory.tar $dir
 272             ls -lR $dir >$seq.inventory.ls
 273         done
 274     fi
 275
 276     # put inventory dir back
 277     for dir in /var/xfsdump/inventory /var/lib/xfsdump/inventory; do
 278         [ -d $dir.$seq ] || continue
 279         rm -rf $dir             # get rid of new one
 280         mv $dir.$seq $dir
 281     done
 282
 283     if [ $status -ne $NOTRUNSTS ]; then
 284         # Sleep added to stop _check_fs from complaining that the
 285         # scratch_dev is still busy
 286         sleep 10
 287
 288         _check_fs $SCRATCH_DEV
 289     fi
 290 }
 291
 292 #
 293 # ensure that bulkstat data will
 294 # match with incore data
 295 # by forcing disk data to be written out
 296 #
 297 _stable_fs()
 298 {
 299     _saveddir=`pwd`; cd /
 300     umount $SCRATCH_MNT >>$seq.full ||\
 301         _error "unmount failed"
 302     mount -t xfs $SCRATCH_DEV $SCRATCH_MNT >>$seq.full ||\
 303         _error "mount failed"
 304     cd $_saveddir
 305 }
 306
 307 #
 308 # Run src/fsstress to create a mixture of
 309 # files,dirs,links,symlinks
 310 #
 311 # Pinched from test 013.
 312 #
 313 _create_dumpdir_stress()
 314 {
 315     echo "Creating directory system to dump using src/fsstress."
 316
 317     _wipe_fs
 318
 319     _param="-f link=10 -f creat=10 -f mkdir=10 -f truncate=5 -f symlink=10"
 320     _count=200
 321     rm -rf $dump_dir
 322     if ! mkdir $dump_dir; then
 323         echo "    failed to mkdir $dump_dir"
 324         status=1
 325         exit
 326     fi
 327     echo ""
 328     echo "-----------------------------------------------"
 329     echo "fsstress : $_param"
 330     echo "-----------------------------------------------"
 331     if ! $here/src/fsstress $_param -s 1 $FSSTRESS_AVOID -n $_count -d $dump_dir >$tmp.out 2>&1
 332     then
 333         echo "    fsstress (count=$_count) returned $? - see $seq.full"
 334
 335         echo "--------------------------------------"       >>$here/$seq.full
 336         echo "output from fsstress:"                        >>$here/$seq.full
 337         echo "--------------------------------------"       >>$here/$seq.full
 338         cat $tmp.out                                        >>$here/$seq.full
 339         status=1
 340     fi
 341
 342     _stable_fs
 343 }
 344
 345 _mk_fillconfig1()
 346 {
 347     cat <<End-of-File >$tmp.config
 348 # pathname      size in bytes   owner   group
 349 #
 350 small           10      $nobody $nobody
 351 big             102400  daemon  sys
 352 sub/small       10      bin     bin
 353 sub/big         102400  $nobody sys
 354 #
 355 sub/a           1       $nobody $nobody
 356 sub/b           2       $nobody $nobody
 357 sub/c           4       $nobody $nobody
 358 sub/d           8       $nobody $nobody
 359 sub/e           16      $nobody $nobody
 360 sub/f           32      $nobody $nobody
 361 sub/g           64      $nobody $nobody
 362 sub/h           128     $nobody $nobody
 363 sub/i           256     $nobody $nobody
 364 sub/j           512     $nobody $nobody
 365 sub/k           1024    $nobody $nobody
 366 sub/l           2048    $nobody $nobody
 367 sub/m           4096    $nobody $nobody
 368 sub/n           8192    $nobody $nobody
 369 #
 370 sub/a00         100     $nobody $nobody
 371 sub/b00         200     $nobody $nobody
 372 sub/c00         400     $nobody $nobody
 373 sub/d00         800     $nobody $nobody
 374 sub/e00         1600    $nobody $nobody
 375 sub/f00         3200    $nobody $nobody
 376 sub/g00         6400    $nobody $nobody
 377 sub/h00         12800   $nobody $nobody
 378 sub/i00         25600   $nobody $nobody
 379 sub/j00         51200   $nobody $nobody
 380 sub/k00         102400  $nobody $nobody
 381 sub/l00         204800  $nobody $nobody
 382 sub/m00         409600  $nobody $nobody
 383 sub/n00         819200  $nobody $nobody
 384 #
 385 sub/a000        1000    $nobody $nobody
 386 sub/e000        16000   $nobody $nobody
 387 sub/h000        128000  $nobody $nobody
 388 sub/k000        1024000 $nobody $nobody
 389 End-of-File
 390 }
 391
 392 _mk_fillconfig2()
 393 {
 394     cat <<End-of-File >$tmp.config
 395 # pathname      size in bytes
 396 #
 397 smalll          10      $nobody $nobody
 398 biggg           102400  $nobody $nobody
 399 sub/smalll      10      $nobody $nobody
 400 sub/biggg       102400  $nobody $nobody
 401 End-of-File
 402 }
 403
 404 _mk_fillconfig_perm()
 405 {
 406     # dir_guid: ugo=rwx,g+s on dir is for IRIX chmod(1)
 407
 408     cat <<End-of-File >$tmp.config
 409 # pathname      size/dir  user group mode
 410 #
 411 file_suid       10      $nobody $nobody 04777
 412 file_guid       10      $nobody $nobody 02777
 413 file_sticky     10      $nobody $nobody 01777
 414 file_mix1       10      $nobody $nobody 761
 415 file_mix2       10      $nobody $nobody 642
 416 dir_suid        d       $nobody $nobody 04777
 417 dir_guid        d       $nobody $nobody ugo=rwx,g+s
 418 dir_sticky      d       $nobody $nobody 01777
 419 dir_mix1        d       $nobody $nobody 761
 420 dir_mix2        d       $nobody $nobody 642
 421 End-of-File
 422 }
 423
 424 _mk_fillconfig_ea()
 425 {
 426     cat <<End-of-File >$tmp.config
 427 # pathname      size    user    group    perm   name value
 428 #
 429 smalll          10      $nobody $nobody  777    attr1 some_text
 430 biggg           102400  $nobody $nobody  777    attr2 some_text2
 431 sub/smalll      10      $nobody $nobody  777    attr3 some_text3
 432 sub/biggg       102400  $nobody $nobody  777    attr4 some_text4
 433 dir             d       $nobody $nobody  777    attr5 dir_text
 434 #
 435 # Add more files so that there are more than the number
 436 # of streams.
 437 # There are bugs in dump/restore for # non-dir files < # streams
 438 # It can be tested in another configuration.
 439 # It is a pathalogical case.
 440 #
 441 sub/a           1       $nobody $nobody
 442 sub/b           2       $nobody $nobody
 443 sub/c           4       $nobody $nobody
 444 sub/d           8       $nobody $nobody
 445 sub/e           16      $nobody $nobody
 446 sub/f           32      $nobody $nobody
 447 sub/g           64      $nobody $nobody
 448 sub/h           128     $nobody $nobody
 449 sub/i           256     $nobody $nobody
 450 sub/j           512     $nobody $nobody
 451 sub/k           1024    $nobody $nobody
 452 sub/l           2048    $nobody $nobody
 453 sub/m           4096    $nobody $nobody
 454 sub/n           8192    $nobody $nobody
 455 End-of-File
 456 }
 457
 458 #
 459 # Create a bunch of directories/files of different sizes
 460 # filled with data.
 461 #
 462 # Pinched from test 001.
 463 #
 464 _do_create_dumpdir_fill()
 465 {
 466     echo "Creating directory system to dump using src/fill."
 467
 468     mkdir -p $dump_dir ||\
 469         _error "cannot mkdir \"$dump_dir\""
 470     cd $dump_dir
 471
 472     $verbose && echo -n "Setup "
 473     sed -e '/^#/d' $tmp.config \
 474     | while read file nbytes owner group perms ea_name ea_value
 475     do
 476         if [ $nbytes = "d" ]; then
 477             # create a directory
 478             dir=$file
 479             if [ ! -d $dir ]
 480             then
 481                 if mkdir $dir
 482                 then
 483                     :
 484                 else
 485                     $verbose && echo
 486                     echo "Error: cannot mkdir \"$dir\""
 487                     exit 1
 488                 fi
 489             fi
 490         else
 491             # create a directory/file
 492             dir=`dirname $file`
 493             if [ "$dir" != "." ]
 494             then
 495                 if [ ! -d $dir ]
 496                 then
 497                     if mkdir $dir
 498                     then
 499                         :
 500                     else
 501                         $verbose && echo
 502                         echo "Error: cannot mkdir \"$dir\""
 503                         exit 1
 504                     fi
 505                 fi
 506             fi
 507             rm -f $file
 508             if $here/src/fill $file $file $nbytes
 509             then
 510                 :
 511             else
 512                 $verbose && echo
 513                 echo "Error: cannot create \"$file\""
 514                 exit 1
 515             fi
 516         fi
 517         if [ -n "$owner" -a -n "$group" ]; then
 518             chown $owner.$group $file
 519         fi
 520         if [ -n "$perms" ]; then
 521             chmod $perms $file
 522         fi
 523         if [ -n "$ea_name" -a -n "$ea_value" ]; then
 524             attr -s $ea_name -V $ea_value $file
 525         fi
 526         $verbose && echo -n "."
 527     done
 528     $verbose && echo
 529
 530     cd $here
 531 }
 532
 533 _create_dumpdir_largefile()
 534 {
 535     _wipe_fs
 536     mkdir -p $dump_dir ||\
 537         _error "cannot mkdir \"$dump_dir\""
 538     _largesize=4294967297
 539     _largefile=$dump_dir/largefile
 540     echo "dd a largefile at offset $_largesize"
 541     dd if=/dev/zero of=$_largefile bs=1 seek=$_largesize count=10 2>&1
 542     _stable_fs
 543 }
 544
 545 _create_dumpdir_fill()
 546 {
 547     _wipe_fs
 548     _mk_fillconfig1
 549     _do_create_dumpdir_fill
 550     _stable_fs
 551 }
 552
 553 _create_dumpdir_fill2()
 554 {
 555     _wipe_fs
 556     _mk_fillconfig2
 557     _do_create_dumpdir_fill
 558     _stable_fs
 559 }
 560
 561 _create_dumpdir_fill_perm()
 562 {
 563     _wipe_fs
 564     _mk_fillconfig_perm
 565     _do_create_dumpdir_fill
 566     _stable_fs
 567 }
 568
 569 _create_dumpdir_fill_ea()
 570 {
 571     _wipe_fs
 572     _mk_fillconfig_ea
 573     _do_create_dumpdir_fill
 574     _stable_fs
 575 }
 576
 577
 578 #
 579 # Append a subset of the fill'ed files
 580 # So we can see if just these get dumped on an incremental
 581 #
 582 _append_dumpdir_fill()
 583 {
 584     cd $dump_dir
 585     cat <<End-of-File >$tmp.config
 586 # pathname
 587 #
 588 small
 589 sub/big
 590 #
 591 sub/a
 592 sub/c
 593 sub/e
 594 End-of-File
 595     sed -e '/^#/d' $tmp.config \
 596     | while read file
 597     do
 598         echo 'Extra text' >>$file
 599     done
 600
 601     cd $here
 602     _stable_fs
 603 }
 604
 605 _do_create_dump_symlinks()
 606 {
 607     echo "Creating directory system of symlinks to dump."
 608
 609     mkdir -p $dump_dir ||\
 610         _error "cannot mkdir \"$dump_dir\""
 611     cd $dump_dir
 612
 613     $verbose && echo -n "Setup "
 614     sed -e '/^#/d' $tmp.config \
 615     | while read file nbytes owner group owner2 group2 perms perms2
 616     do
 617         dir=`dirname $file`
 618         if [ "$dir" != "." ]
 619         then
 620             if [ ! -d $dir ]
 621             then
 622                 if mkdir $dir
 623                 then
 624                     :
 625                 else
 626                     $verbose && echo
 627                     echo "Error: cannot mkdir \"$dir\""
 628                     exit 1
 629                 fi
 630             fi
 631         fi
 632         rm -f $file
 633         touch $file
 634
 635         # Do chmod on symlink using umask.
 636         # This won't do the right thing as it subtracts permissions.
 637         # However, I don't care, as long as I get some different perms
 638         # for testing.
 639         if [ -n "$perms2" ]; then
 640             omask=`umask`
 641             umask $perms2
 642         fi
 643         ln -s $file $file-link
 644         if [ -n "$perms2" ]; then
 645             umask $omask
 646         fi
 647
 648         if [ -n "$owner" -a -n "$group" ]; then
 649             chown $owner.$group $file
 650         fi
 651         if [ -n "$owner" -a -n "$group" ]; then
 652             chown -h $owner.$group $file-link
 653         fi
 654         if [ -n "$perms" ]; then
 655             chmod $perms $file
 656         fi
 657         $verbose && echo -n "."
 658     done
 659     $verbose && echo
 660
 661     cd $here
 662 }
 663
 664 _mk_symlink_config()
 665 {
 666     cat <<End-of-File >$tmp.config
 667 # path  size    owner1  group1  owner2  group2  perm1   perm2
 668 #
 669 a       0       $nobody $nobody daemon  sys     124     421
 670 b       0       daemon  sys     bin     bin     347     743
 671 sub/a   0       bin     bin     $nobody sys     777     777
 672 sub/b   0       $nobody sys     $nobody $nobody 367     763
 673 End-of-File
 674 }
 675
 676 _create_dumpdir_symlinks()
 677 {
 678     _wipe_fs
 679     _mk_symlink_config
 680     _do_create_dump_symlinks
 681     _stable_fs
 682 }
 683
 684 #
 685 # create hardlinks of form $_fname, $_fname_h1 $_fname_h2 ...
 686 #
 687 _create_hardlinks()
 688 {
 689     _fname=$1
 690     _numlinks=$2
 691
 692     touch $_fname
 693     _j=1
 694     while [ $_j -le $_numlinks ]; do
 695         _suffix=_h$_j
 696         _hardlink=$_fname$_suffix
 697         echo "creating hardlink $_hardlink to $_fname"
 698         ln $_fname $_hardlink
 699         _j=`expr $_j + 1`
 700     done
 701 }
 702
 703 #
 704 # create a set of hardlinks
 705 # create hardlinks of form file1, file1_h1 file1_h2 ...
 706 # create hardlinks of form file2, file2_h1 file2_h2 ...
 707 # create hardlinks of form file3, file3_h1 file3_h2 ...
 708 #
 709 _create_hardset()
 710 {
 711     _numsets=$1
 712     _i=1
 713     while [ $_i -le $_numsets ]; do
 714         _create_hardlinks file$_i 5
 715         _i=`expr $_i + 1`
 716     done
 717 }
 718
 719
 720 _modify_level()
 721 {
 722     _level=$1
 723     echo "mod level $_level" >$dump_dir/file$_level
 724 }
 725
 726 _create_dumpdir_hardlinks()
 727 {
 728     _numsets=$1
 729     _wipe_fs
 730     echo "Creating directory system of hardlinks to incrementally dump."
 731
 732     mkdir -p $dump_dir ||\
 733         _error "cannot mkdir \"$dump_dir\""
 734     cd $dump_dir
 735
 736     _create_hardset $_numsets
 737
 738     cd $here
 739     _stable_fs
 740 }
 741
 742 #
 743 # Filter for ls
 744 # Filter out dates on symlinks and char devices
 745 #
 746 _ls_filter()
 747 {
 748   $AWK_PROG '
 749         /^l/ { date = $8; sub(date,"DATE"); print}
 750         /^c/ { date = $9; sub(date,"DATE"); print}
 751         {print}' \
 752   | sed -e 's/total [0-9][0-9]*/total TOTAL/'
 753 }
 754
 755
 756 #
 757 # Filter out the non-deterministic dump msgs from
 758 # xfsdump and xfsrestore
 759 #
 760 _dump_filter_main()
 761 {
 762   sed \
 763       -e "s/`hostname`/HOSTNAME/"   \
 764       -e "s#$SCRATCH_DEV#SCRATCH_DEV#"    \
 765       -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
 766       -e "s#$dumptape#TAPE_DEV#"    \
 767       -e "s#$SCRATCH_MNT#SCRATCH_MNT#"    \
 768       -e "s#$dump_file#DUMP_FILE#"  \
 769       -e 's#/var/lib/xfsdump#/var/xfsdump#' \
 770       -e 's/id:[        ]*[0-9a-f-]*/id: ID/'  \
 771       -e 's/time:[      ].*/time: TIME/'       \
 772       -e 's/date:[      ].*/date: DATE/'       \
 773       -e 's/dump begun .*/dump begun DATE/'    \
 774       -e 's/[0-9][0-9]* seconds/SECS seconds/' \
 775       -e 's/restore.[0-9][0-9]*/restore.PID/' \
 776       -e 's/ino [0-9][0-9]*/ino INO/' \
 777       -e '/: dump size/s/[0-9][0-9]*/NUM/'     \
 778       -e '/dump size:/s/[0-9][0-9]*/NUM/'      \
 779       -e '/dump size per stream:/s/[0-9][0-9]*/NUM/' \
 780       -e 's/\(media file size[   ]*\)[0-9][0-9]*/\1NUM/' \
 781       -e 's/\(mfile size:[       ]*\)[0-9][0-9]*/\1NUM/' \
 782       -e '/drive[        ]*[0-9][0-9]*:/d' \
 783       -e '/\/dev\/tty/d' \
 784       -e '/inventory session uuid/d' \
 785       -e '/ - Running single-threaded/d' \
 786       -e '/^.*I\/O metrics: .*$/d' \
 787       -e 's/1048576/BLOCKSZ/' \
 788       -e 's/2097152/BLOCKSZ/' \
 789       -e 's/(pid[        ]*[1-9][0-9]*)/\(pid PID\)/' \
 790   | perl -ne '
 791       if ($_ =~ /(?:Dump|Restore) Summary/) {
 792         $skip = 1;
 793       } elsif ($_ =~ /(?:Dump|Restore) Status/) {
 794         $skip = 0;
 795       }
 796       print if (! $skip);'
 797 }
 798
 799 _dump_filter()
 800 {
 801    if $do_quota_check
 802    then
 803        _dump_filter_main | _check_quota_dumprestore | _check_quota_entries
 804    else
 805        _dump_filter_main
 806    fi
 807 }
 808
 809 _invutil_filter()
 810 {
 811   _dump_filter_main \
 812   | sed \
 813         -e 's/UUID[     ]*:[    ][0-9a-f-]*/UUID                :       ID/' \
 814         -e 's/TIME OF DUMP[     ]*:.*/TIME OF DUMP      :       TIME/' \
 815         -e 's/HOSTNAME:SCRATCH_MNT.*/HOSTNAME:SCRATCH_MNT/' \
 816         -e 's#inventory/[0-9a-f-]*#inventory/UUID#' \
 817
 818 }
 819
 820
 821 _dir_filter()
 822 {
 823   sed \
 824     -e "s#$dump_file#DUMP_FILE#"      \
 825     -e "s#$SCRATCH_DEV#SCRATCH_DEV#"        \
 826     -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
 827     -e "s#$dumptape#TAPE_DEV#"         \
 828     -e "s#$dump_dir#DUMP_DIR#g"       \
 829     -e "s#$restore_dir#RESTORE_DIR#g" \
 830     -e "s#$SCRATCH_MNT#SCRATCH_MNT#g"       \
 831     -e "s#$dump_sdir#DUMP_SUBDIR#g"   \
 832     -e "s#$restore_sdir#RESTORE_SUBDIR#g" \
 833     -e "s#$$#PID#g" \
 834
 835 }
 836
 837 #
 838 # Note: requires a space between option letter and argument
 839 #
 840 _parse_args()
 841 {
 842     OPTIND=0
 843     dump_args=""
 844     while [ $# -gt 0 ]
 845     do
 846         case $1
 847         in
 848         -f)
 849             [ -z "$2" ] && _error "missing argument for -f"
 850             dumptape=$2
 851             shift
 852             ;;
 853         -L)
 854             [ -z "$2" ] && _error "missing argument for -L"
 855             session_label=$2
 856             shift
 857             ;;
 858         -o)
 859             dump_args="$dump_args -o"
 860             ;;
 861         -F)
 862             dump_args="$dump_args -F"
 863             ;;
 864         --multi)
 865             multi=$2
 866             shift
 867             ;;
 868         -q)
 869             do_quota_check=true
 870             ;;
 871         -Q)
 872             do_quota_check=false
 873             ;;
 874         -l)
 875             [ -z "$2" ] && _error "missing argument for -l"
 876             dump_args="$dump_args -l$2"
 877             shift
 878             ;;
 879         *)
 880             _error "invalid argument to common.dump function: $1"
 881             ;;
 882         esac
 883         shift
 884     done
 885 }
 886
 887
 888 #
 889 # Dump a subdir
 890 #
 891 _do_dump_sub()
 892 {
 893     _parse_args $*
 894
 895     echo "Dumping to tape..."
 896     opts="$_dump_debug$dump_args -s $dump_sdir -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 897     echo "xfsdump $opts" | _dir_filter
 898     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 899 }
 900
 901 #
 902 # Do dump to tape
 903 #
 904 _do_dump()
 905 {
 906     _parse_args $*
 907
 908     echo "Dumping to tape..."
 909     opts="$_dump_debug$dump_args -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 910     echo "xfsdump $opts" | _dir_filter
 911     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 912 }
 913
 914
 915 #
 916 # Do full dump with -m
 917 #
 918 _do_dump_min()
 919 {
 920     _parse_args $*
 921
 922     echo "Dumping to tape..."
 923     onemeg=1048576
 924     opts="$_dump_debug$dump_args -m -b $onemeg -l0 -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 925     echo "xfsdump $opts" | _dir_filter
 926     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 927 }
 928
 929
 930 #
 931 # Do full dump to file
 932 #
 933 _do_dump_file()
 934 {
 935     _parse_args $*
 936
 937     echo "Dumping to file..."
 938     opts="$_dump_debug$dump_args -f $dump_file -M $media_label -L $session_label $SCRATCH_MNT"
 939     echo "xfsdump $opts" | _dir_filter
 940     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 941 }
 942
 943 #
 944 # Do full dump to multiple files
 945 #
 946 _do_dump_multi_file()
 947 {
 948     _parse_args "$@"
 949
 950     multi_args=""
 951
 952     i=0
 953     while [ $i -lt $multi ]
 954     do
 955         multi_args="$multi_args -f $dump_file.$i -M $media_label.$i"
 956         i=`expr $i + 1`
 957     done
 958
 959     echo "Dumping to files..."
 960     opts="$_dump_debug$dump_args $multi_args -L $session_label $SCRATCH_MNT"
 961     echo "xfsdump $opts" | _dir_filter
 962     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 963 }
 964
 965
 966 _prepare_restore_dir()
 967 {
 968     rm -rf $restore_dir
 969     mkdir $restore_dir ||\
 970         _error "failed to mkdir $restore_dir"
 971 }
 972
 973
 974 #
 975 # Get tape ready and restore dir
 976 #
 977 _prepare_restore()
 978 {
 979     _prepare_restore_dir
 980
 981     echo "Rewinding tape"
 982     _rewind
 983 }
 984
 985 #
 986 # Restore the tape into $restore_dir
 987 #
 988 _do_restore()
 989 {
 990     _parse_args $*
 991     _prepare_restore
 992
 993
 994     echo "Restoring from tape..."
 995     opts="$_restore_debug -f $dumptape  -L $session_label $restore_dir"
 996     echo "xfsrestore $opts" | _dir_filter
 997     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
 998 }
 999
1000 #
1001 # Restore the tape into $restore_dir using -m
1002 #
1003 _do_restore_min()
1004 {
1005     _parse_args $*
1006     _prepare_restore
1007
1008     echo "Restoring from tape..."
1009     onemeg=1048576
1010     opts="$_restore_debug -m -b $onemeg -f $dumptape  -L $session_label $restore_dir"
1011     echo "xfsrestore $opts" | _dir_filter
1012     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1013 }
1014
1015 #
1016 # Restore the tape from a dump file
1017 #
1018 _do_restore_file()
1019 {
1020     _parse_args $*
1021     _prepare_restore_dir
1022
1023     echo "Restoring from file..."
1024     opts="$_restore_debug -f $dump_file  -L $session_label $restore_dir"
1025     echo "xfsrestore $opts" | _dir_filter
1026     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1027 }
1028
1029 #
1030 # Cumulative restore from a file
1031 # Need to specify the dump level e.g. "-l 0"
1032 #
1033 _do_restore_file_cum()
1034 {
1035     _parse_args $*
1036     if echo $dump_args | grep '\-l0' >/dev/null; then
1037         _prepare_restore_dir
1038     fi
1039
1040     echo "Restoring cumumlative from file..."
1041     opts="$_restore_debug -f $dump_file -r $restore_dir"
1042     echo "xfsrestore $opts" | _dir_filter
1043     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1044 }
1045
1046 _do_restore_toc()
1047 {
1048     echo "Contents of dump ..."
1049     opts="$_restore_debug -f $dump_file -t"
1050     echo "xfsrestore $opts" | _dir_filter
1051     cd $SCRATCH_MNT # for IRIX which needs xfs cwd
1052     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter_main |\
1053     _check_quota_file |\
1054     _check_quota_entries |\
1055     $AWK_PROG 'NF != 1 { print; next }
1056                {files = sprintf("%s\n%s", files, $1)}
1057                 END { print files | "sort" } '
1058     # the above awk code is to alpha sort only the output
1059     # of files (and not the verbose restore msgs)
1060     cd $here # put back
1061 }
1062
1063 #
1064 # Restore the tape from multiple dump files
1065 #
1066 _do_restore_multi_file()
1067 {
1068     _parse_args "$@"
1069     _prepare_restore_dir
1070
1071     multi_args=""
1072
1073     i=0
1074     while [ $i -lt $multi ]
1075     do
1076         multi_args="$multi_args -f $dump_file.$i"
1077         i=`expr $i + 1`
1078     done
1079
1080     echo "Restoring from file..."
1081     opts="$_restore_debug $multi_args -L $session_label $restore_dir"
1082     echo "xfsrestore $opts" | _dir_filter
1083     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1084 }
1085
1086 #
1087 # Do xfsdump piped into xfsrestore - xfsdump | xfsrestore
1088 #
1089 # Use -s as we want to dump and restore to the same xfs partition
1090 #
1091 _do_dump_restore()
1092 {
1093     _parse_args $*
1094     _prepare_restore_dir
1095     echo "xfsdump|xfsrestore ..."
1096     restore_opts="$_restore_debug - $restore_dir"
1097     dump_opts="$_dump_debug$dump_args -s $dump_sdir - $SCRATCH_MNT"
1098     echo "xfsdump $dump_opts | xfsrestore $restore_opts" | _dir_filter
1099     xfsdump $dump_opts 2>$tmp.dump.mlog | xfsrestore $restore_opts 2>&1 | tee -a $seq.full | _dump_filter
1100     _dump_filter <$tmp.dump.mlog
1101 }
1102
1103 #
1104 # Compare dumped subdirectory with restored dir
1105 # using ls -lR.
1106 # Thus no contents are compared but permissions, sizes,
1107 # owners, etc... are.
1108 #
1109 _ls_compare_sub()
1110 {
1111     #
1112     # verify we got back what we dumped
1113     #
1114     echo "Comparing listing of dump directory with restore directory"
1115     ls -lR $dump_dir | tee -a $seq.full | _ls_filter >$tmp.dump_dir
1116     ls -lR $restore_dir/$dump_sdir | tee -a $seq.full | _ls_filter \
1117     | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1118
1119     diff -cs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1120 }
1121
1122 #
1123 # filter out the date fields
1124 #
1125 _ls_nodate_filter()
1126 {
1127     $AWK_PROG 'NF == 9 { print $1, $2, $3, $4, $9 }'
1128 }
1129
1130 #
1131 # _ls_compare_sub but don't compare dates
1132 _ls_nodate_compare_sub()
1133 {
1134     #
1135     # verify we got back what we dumped
1136     #
1137     echo "Comparing listing of dump directory with restore directory"
1138     ls -lR $dump_dir | tee -a $seq.full | _ls_filter | _ls_nodate_filter >$tmp.dump_dir
1139     ls -lR $restore_dir/$dump_sdir | tee -a $seq.full | _ls_filter \
1140     | _ls_nodate_filter | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1141
1142     diff -cs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1143 }
1144
1145 #
1146 # Compare using recursive diff the files of the dumped
1147 # subdirectory.
1148 # This one will compare the contents.
1149 #
1150 _diff_compare_sub()
1151 {
1152     echo "Comparing dump directory with restore directory"
1153     diff -rs $dump_dir $restore_dir/$dump_sdir | _dir_filter
1154 }
1155
1156 _get_eas_on_path()
1157 {
1158     _path=$1
1159
1160 # Tim - this is the IRIX way...
1161     # find $_path -exec attr -l {} \; |\
1162     # awk '{print $9, $2}' |\
1163     # sed 's/["]//g' |\
1164     # sort |\
1165 # and this is now the Linux way...
1166     getfattr --absolute-names -Rh $_path |\
1167     perl -wn -e '
1168         if (m/^# file: (\S+)/) { $file = $1 }
1169         elsif (m/^user\.(\w+)/) { print $file, " ",$1,"\n" }' |\
1170     sort |\
1171     while read file ea_name; do
1172         attr -g $ea_name $file
1173     done
1174 }
1175
1176 #
1177 # Compare the extended attributes of the files/dirs
1178 # b/w the dumped and restore dirs.
1179 #
1180 #
1181 # Attribute "attr5" had a 8 byte value for /spare1/dump.5460/dir:
1182 # Attribute "attr5" had a 8 byte value for /spare1/restore.5460/dump.5460/dir:
1183 #
1184 _diff_compare_eas()
1185 {
1186     echo "Comparing dump directory with restore directory"
1187     echo "Looking at the extended attributes (EAs)"
1188     echo "EAs on dump"
1189     _get_eas_on_path $dump_dir | tee $seq.ea1 | _dir_filter
1190     echo "EAs on restore"
1191     _get_eas_on_path $restore_dir/$dump_sdir \
1192     | sed -e "s#$restore_sdir\/##" \
1193     | tee $seq.ea2 \
1194     | _dir_filter
1195     diff -s $seq.ea1 $seq.ea2
1196 }
1197
1198
1199 #
1200 # Compare using recursive diff the files of the dumped
1201 # filesystem
1202 #
1203 _diff_compare()
1204 {
1205     echo "Comparing dump directory with restore directory"
1206     diff -rs $SCRATCH_MNT $restore_dir | _dir_filter | _check_quota_diff
1207 }
1208
1209 #
1210 # Check out the dump inventory
1211 #
1212 _dump_inventory()
1213 {
1214     xfsdump $_dump_debug -I | tee -a $seq.full | _dump_filter_main
1215 }
1216
1217 #
1218 # Do the xfsinvutil cmd with debug and filters
1219 # Need to set variable: "$middate" to the invutil date
1220 #
1221 _do_invutil()
1222 {
1223     host=`hostname`
1224     echo "xfsinvutil $_invutil_debug -M $host:$SCRATCH_MNT \"$middate\" $*" >$seq.full
1225     xfsinvutil $_invutil_debug $* -M $host:$SCRATCH_MNT "$middate" \
1226     | tee -a $seq.full | _invutil_filter
1227 }
1228
1229 #
1230 # ensure we can find the user quota msg if user quotas are on
1231 # ensure we can find the group quota msg if group quotas are on
1232 #
1233 _check_quota()
1234 {
1235     usermsg=$1
1236     groupmsg=$2
1237     uquota=0
1238     gquota=0
1239     $here/src/feature -U $SCRATCH_DEV && uquota=1
1240     $here/src/feature -G $SCRATCH_DEV && gquota=1
1241
1242     $AWK_PROG -v uquota=$uquota -v gquota=$gquota -v full=$seq.full \
1243               -v usermsg="$usermsg" -v groupmsg="$groupmsg" '
1244         $0 ~ groupmsg {
1245                         print "Found group quota:", $0 >>full
1246                         found_gquota = 1
1247                         if (!gquota) {
1248                             print "Found extra:", $0
1249                         }
1250                         next
1251         }
1252         $0 ~ usermsg {
1253                         print "Found user quota:", $0 >>full
1254                         found_uquota = 1
1255                         if (!uquota) {
1256                             print "Found extra:", $0
1257                         }
1258                         next
1259         }
1260                         { print }
1261         END {
1262                 if (uquota && !found_uquota) {
1263                     print "Missing: ", usermsg
1264                 }
1265                 if (gquota && !found_gquota) {
1266                     print "Missing: ", groupmsg
1267                 }
1268         }
1269     '
1270 }
1271
1272 #
1273 # xfsrestore: 3 directories and 40 entries processed
1274 #   $5 = 40
1275 #   num entries needs to be reduced by num quota file(s)
1276 #
1277 _check_quota_entries()
1278 {
1279     uquota=0
1280     gquota=0
1281     $here/src/feature -U $SCRATCH_DEV && uquota=1
1282     $here/src/feature -G $SCRATCH_DEV && gquota=1
1283     $AWK_PROG -v uquota=$uquota -v gquota=$gquota '
1284         /entries processed/ {
1285                 if (uquota) $5--
1286                 if (gquota) $5--
1287         }
1288         {print}'
1289 }
1290
1291 #
1292 # Look for:
1293 # xfsdump: saving user quota information for: SCRATCH_MNT
1294 # xfsdump: saving group quota information for: SCRATCH_MNT
1295 # xfsrestore: user quota information written to ...'
1296 # xfsrestore: group quota information written to ...'
1297 #
1298 _check_quota_dumprestore()
1299 {
1300    _check_quota 'user quota information' \
1301                 'group quota information'
1302 }
1303
1304 #
1305 # Look for:
1306 # Only in RESTORE_DIR: xfsdump_quotas
1307 # Only in RESTORE_DIR: xfsdump_quotas_group
1308 #
1309 _check_quota_diff()
1310 {
1311    _check_quota 'Only in RESTORE_DIR: xfsdump_quotas' \
1312        'Only in RESTORE_DIR: xfsdump_quotas_group'
1313 }
1314
1315 #
1316 # Look for the quota file in the output
1317 # Ensure that it is there if it should be
1318 # Filter it out so that the output is always the same
1319 # even with no quotas
1320 #
1321 _check_quota_file()
1322 {
1323    _check_quota 'xfsdump_quotas' 'xfsdump_quotas_group'
1324 }
1325
1326 # make sure this script returns success
1327 /bin/true