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 -t 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
 534 _create_dumpdir_fill()
 535 {
 536     _wipe_fs
 537     _mk_fillconfig1
 538     _do_create_dumpdir_fill
 539     _stable_fs
 540 }
 541
 542 _create_dumpdir_fill2()
 543 {
 544     _wipe_fs
 545     _mk_fillconfig2
 546     _do_create_dumpdir_fill
 547     _stable_fs
 548 }
 549
 550 _create_dumpdir_fill_perm()
 551 {
 552     _wipe_fs
 553     _mk_fillconfig_perm
 554     _do_create_dumpdir_fill
 555     _stable_fs
 556 }
 557
 558 _create_dumpdir_fill_ea()
 559 {
 560     _wipe_fs
 561     _mk_fillconfig_ea
 562     _do_create_dumpdir_fill
 563     _stable_fs
 564 }
 565
 566
 567 #
 568 # Append a subset of the fill'ed files
 569 # So we can see if just these get dumped on an incremental
 570 #
 571 _append_dumpdir_fill()
 572 {
 573     cd $dump_dir
 574     cat <<End-of-File >$tmp.config
 575 # pathname
 576 #
 577 small
 578 sub/big
 579 #
 580 sub/a
 581 sub/c
 582 sub/e
 583 End-of-File
 584     sed -e '/^#/d' $tmp.config \
 585     | while read file
 586     do
 587         echo 'Extra text' >>$file
 588     done
 589
 590     cd $here
 591     _stable_fs
 592 }
 593
 594 _do_create_dump_symlinks()
 595 {
 596     echo "Creating directory system of symlinks to dump."
 597
 598     mkdir -p $dump_dir ||\
 599         _error "cannot mkdir \"$dump_dir\""
 600     cd $dump_dir
 601
 602     $verbose && echo -n "Setup "
 603     sed -e '/^#/d' $tmp.config \
 604     | while read file nbytes owner group owner2 group2 perms perms2
 605     do
 606         dir=`dirname $file`
 607         if [ "$dir" != "." ]
 608         then
 609             if [ ! -d $dir ]
 610             then
 611                 if mkdir $dir
 612                 then
 613                     :
 614                 else
 615                     $verbose && echo
 616                     echo "Error: cannot mkdir \"$dir\""
 617                     exit 1
 618                 fi
 619             fi
 620         fi
 621         rm -f $file
 622         touch $file
 623
 624         # Do chmod on symlink using umask.
 625         # This won't do the right thing as it subtracts permissions.
 626         # However, I don't care, as long as I get some different perms
 627         # for testing.
 628         if [ -n "$perms2" ]; then
 629             omask=`umask`
 630             umask $perms2
 631         fi
 632         ln -s $file $file-link
 633         if [ -n "$perms2" ]; then
 634             umask $omask
 635         fi
 636
 637         if [ -n "$owner" -a -n "$group" ]; then
 638             chown $owner.$group $file
 639         fi
 640         if [ -n "$owner" -a -n "$group" ]; then
 641             chown -h $owner.$group $file-link
 642         fi
 643         if [ -n "$perms" ]; then
 644             chmod $perms $file
 645         fi
 646         $verbose && echo -n "."
 647     done
 648     $verbose && echo
 649
 650     cd $here
 651 }
 652
 653 _mk_symlink_config()
 654 {
 655     cat <<End-of-File >$tmp.config
 656 # path  size    owner1  group1  owner2  group2  perm1   perm2
 657 #
 658 a       0       $nobody $nobody daemon  sys     124     421
 659 b       0       daemon  sys     bin     bin     347     743
 660 sub/a   0       bin     bin     $nobody sys     777     777
 661 sub/b   0       $nobody sys     $nobody $nobody 367     763
 662 End-of-File
 663 }
 664
 665 _create_dumpdir_symlinks()
 666 {
 667     _wipe_fs
 668     _mk_symlink_config
 669     _do_create_dump_symlinks
 670     _stable_fs
 671 }
 672
 673 #
 674 # create hardlinks of form $_fname, $_fname_h1 $_fname_h2 ...
 675 #
 676 _create_hardlinks()
 677 {
 678     _fname=$1
 679     _numlinks=$2
 680
 681     touch $_fname
 682     _j=1
 683     while [ $_j -le $_numlinks ]; do
 684         _suffix=_h$_j
 685         _hardlink=$_fname$_suffix
 686         echo "creating hardlink $_hardlink to $_fname"
 687         ln $_fname $_hardlink
 688         _j=`expr $_j + 1`
 689     done
 690 }
 691
 692 #
 693 # create a set of hardlinks
 694 # create hardlinks of form file1, file1_h1 file1_h2 ...
 695 # create hardlinks of form file2, file2_h1 file2_h2 ...
 696 # create hardlinks of form file3, file3_h1 file3_h2 ...
 697 #
 698 _create_hardset()
 699 {
 700     _numsets=$1
 701     _i=1
 702     while [ $_i -le $_numsets ]; do
 703         _create_hardlinks file$_i 5
 704         _i=`expr $_i + 1`
 705     done
 706 }
 707
 708
 709 _modify_level()
 710 {
 711     _level=$1
 712     echo "mod level $_level" >$dump_dir/file$_level
 713 }
 714
 715 _create_dumpdir_hardlinks()
 716 {
 717     _numsets=$1
 718     _wipe_fs
 719     echo "Creating directory system of hardlinks to incrementally dump."
 720
 721     mkdir -p $dump_dir ||\
 722         _error "cannot mkdir \"$dump_dir\""
 723     cd $dump_dir
 724
 725     _create_hardset $_numsets
 726
 727     cd $here
 728     _stable_fs
 729 }
 730
 731 #
 732 # Filter for ls
 733 # Filter out dates on symlinks and char devices
 734 #
 735 _ls_filter()
 736 {
 737   $AWK_PROG '
 738         /^l/ { date = $8; sub(date,"DATE"); print}
 739         /^c/ { date = $9; sub(date,"DATE"); print}
 740         {print}' \
 741   | sed -e 's/total [0-9][0-9]*/total TOTAL/'
 742 }
 743
 744
 745 #
 746 # Filter out the non-deterministic dump msgs from
 747 # xfsdump and xfsrestore
 748 #
 749 _dump_filter_main()
 750 {
 751   sed \
 752       -e "s/`hostname`/HOSTNAME/"   \
 753       -e "s#$SCRATCH_DEV#SCRATCH_DEV#"    \
 754       -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
 755       -e "s#$dumptape#TAPE_DEV#"    \
 756       -e "s#$SCRATCH_MNT#SCRATCH_MNT#"    \
 757       -e "s#$dump_file#DUMP_FILE#"  \
 758       -e 's#/var/lib/xfsdump#/var/xfsdump#' \
 759       -e 's/id:[        ]*[0-9a-f-]*/id: ID/'  \
 760       -e 's/time:[      ].*/time: TIME/'       \
 761       -e 's/date:[      ].*/date: DATE/'       \
 762       -e 's/dump begun .*/dump begun DATE/'    \
 763       -e 's/[0-9][0-9]* seconds/SECS seconds/' \
 764       -e 's/restore.[0-9][0-9]*/restore.PID/' \
 765       -e 's/ino [0-9][0-9]*/ino INO/' \
 766       -e '/: dump size/s/[0-9][0-9]*/NUM/'     \
 767       -e '/dump size:/s/[0-9][0-9]*/NUM/'      \
 768       -e '/dump size per stream:/s/[0-9][0-9]*/NUM/' \
 769       -e 's/\(media file size[   ]*\)[0-9][0-9]*/\1NUM/' \
 770       -e 's/\(mfile size:[       ]*\)[0-9][0-9]*/\1NUM/' \
 771       -e '/drive[        ]*[0-9][0-9]*:/d' \
 772       -e '/\/dev\/tty/d' \
 773       -e '/inventory session uuid/d' \
 774       -e '/ - Running single-threaded/d' \
 775       -e '/^.*I\/O metrics: .*$/d' \
 776       -e 's/1048576/BLOCKSZ/' \
 777       -e 's/2097152/BLOCKSZ/' \
 778       -e 's/(pid[        ]*[1-9][0-9]*)/\(pid PID\)/' \
 779   | perl -ne '
 780       if ($_ =~ /(?:Dump|Restore) Summary/) {
 781         $skip = 1;
 782       } elsif ($_ =~ /(?:Dump|Restore) Status/) {
 783         $skip = 0;
 784       }
 785       print if (! $skip);'
 786 }
 787
 788 _dump_filter()
 789 {
 790    if $do_quota_check
 791    then
 792        _dump_filter_main | _check_quota_dumprestore | _check_quota_entries
 793    else
 794        _dump_filter_main
 795    fi
 796 }
 797
 798 _invutil_filter()
 799 {
 800   _dump_filter_main \
 801   | sed \
 802         -e 's/UUID[     ]*:[    ][0-9a-f-]*/UUID                :       ID/' \
 803         -e 's/TIME OF DUMP[     ]*:.*/TIME OF DUMP      :       TIME/' \
 804         -e 's/HOSTNAME:SCRATCH_MNT.*/HOSTNAME:SCRATCH_MNT/' \
 805         -e 's#inventory/[0-9a-f-]*#inventory/UUID#' \
 806
 807 }
 808
 809
 810 _dir_filter()
 811 {
 812   sed \
 813     -e "s#$dump_file#DUMP_FILE#"      \
 814     -e "s#$SCRATCH_DEV#SCRATCH_DEV#"        \
 815     -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
 816     -e "s#$dumptape#TAPE_DEV#"         \
 817     -e "s#$dump_dir#DUMP_DIR#g"       \
 818     -e "s#$restore_dir#RESTORE_DIR#g" \
 819     -e "s#$SCRATCH_MNT#SCRATCH_MNT#g"       \
 820     -e "s#$dump_sdir#DUMP_SUBDIR#g"   \
 821     -e "s#$restore_sdir#RESTORE_SUBDIR#g" \
 822     -e "s#$$#PID#g" \
 823
 824 }
 825
 826 #
 827 # Note: requires a space between option letter and argument
 828 #
 829 _parse_args()
 830 {
 831     OPTIND=0
 832     dump_args=""
 833     while [ $# -gt 0 ]
 834     do
 835         case $1
 836         in
 837         -f)
 838             [ -z "$2" ] && _error "missing argument for -f"
 839             dumptape=$2
 840             shift
 841             ;;
 842         -L)
 843             [ -z "$2" ] && _error "missing argument for -L"
 844             session_label=$2
 845             shift
 846             ;;
 847         -o)
 848             dump_args="$dump_args -o"
 849             ;;
 850         -F)
 851             dump_args="$dump_args -F"
 852             ;;
 853         --multi)
 854             multi=$2
 855             shift
 856             ;;
 857         -q)
 858             do_quota_check=true
 859             ;;
 860         -Q)
 861             do_quota_check=false
 862             ;;
 863         -l)
 864             [ -z "$2" ] && _error "missing argument for -l"
 865             dump_args="$dump_args -l$2"
 866             shift
 867             ;;
 868         *)
 869             _error "invalid argument to common.dump function: $1"
 870             ;;
 871         esac
 872         shift
 873     done
 874 }
 875
 876
 877 #
 878 # Dump a subdir
 879 #
 880 _do_dump_sub()
 881 {
 882     _parse_args $*
 883
 884     echo "Dumping to tape..."
 885     opts="$_dump_debug$dump_args -s $dump_sdir -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 886     echo "xfsdump $opts" | _dir_filter
 887     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 888 }
 889
 890 #
 891 # Do dump to tape
 892 #
 893 _do_dump()
 894 {
 895     _parse_args $*
 896
 897     echo "Dumping to tape..."
 898     opts="$_dump_debug$dump_args -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 899     echo "xfsdump $opts" | _dir_filter
 900     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 901 }
 902
 903
 904 #
 905 # Do full dump with -m
 906 #
 907 _do_dump_min()
 908 {
 909     _parse_args $*
 910
 911     echo "Dumping to tape..."
 912     onemeg=1048576
 913     opts="$_dump_debug$dump_args -m -b $onemeg -l0 -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 914     echo "xfsdump $opts" | _dir_filter
 915     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 916 }
 917
 918
 919 #
 920 # Do full dump to file
 921 #
 922 _do_dump_file()
 923 {
 924     _parse_args $*
 925
 926     echo "Dumping to file..."
 927     opts="$_dump_debug$dump_args -f $dump_file -M $media_label -L $session_label $SCRATCH_MNT"
 928     echo "xfsdump $opts" | _dir_filter
 929     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 930 }
 931
 932 #
 933 # Do full dump to multiple files
 934 #
 935 _do_dump_multi_file()
 936 {
 937     _parse_args "$@"
 938
 939     multi_args=""
 940
 941     i=0
 942     while [ $i -lt $multi ]
 943     do
 944         multi_args="$multi_args -f $dump_file.$i -M $media_label.$i"
 945         i=`expr $i + 1`
 946     done
 947
 948     echo "Dumping to files..."
 949     opts="$_dump_debug$dump_args $multi_args -L $session_label $SCRATCH_MNT"
 950     echo "xfsdump $opts" | _dir_filter
 951     xfsdump $opts 2>&1 | tee -a $seq.full | _dump_filter
 952 }
 953
 954
 955 _prepare_restore_dir()
 956 {
 957     rm -rf $restore_dir
 958     mkdir $restore_dir ||\
 959         _error "failed to mkdir $restore_dir"
 960 }
 961
 962
 963 #
 964 # Get tape ready and restore dir
 965 #
 966 _prepare_restore()
 967 {
 968     _prepare_restore_dir
 969
 970     echo "Rewinding tape"
 971     _rewind
 972 }
 973
 974 #
 975 # Restore the tape into $restore_dir
 976 #
 977 _do_restore()
 978 {
 979     _parse_args $*
 980     _prepare_restore
 981
 982
 983     echo "Restoring from tape..."
 984     opts="$_restore_debug -f $dumptape  -L $session_label $restore_dir"
 985     echo "xfsrestore $opts" | _dir_filter
 986     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
 987 }
 988
 989 #
 990 # Restore the tape into $restore_dir using -m
 991 #
 992 _do_restore_min()
 993 {
 994     _parse_args $*
 995     _prepare_restore
 996
 997     echo "Restoring from tape..."
 998     onemeg=1048576
 999     opts="$_restore_debug -m -b $onemeg -f $dumptape  -L $session_label $restore_dir"
1000     echo "xfsrestore $opts" | _dir_filter
1001     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1002 }
1003
1004 #
1005 # Restore the tape from a dump file
1006 #
1007 _do_restore_file()
1008 {
1009     _parse_args $*
1010     _prepare_restore_dir
1011
1012     echo "Restoring from file..."
1013     opts="$_restore_debug -f $dump_file  -L $session_label $restore_dir"
1014     echo "xfsrestore $opts" | _dir_filter
1015     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1016 }
1017
1018 #
1019 # Cumulative restore from a file
1020 # Need to specify the dump level e.g. "-l 0"
1021 #
1022 _do_restore_file_cum()
1023 {
1024     _parse_args $*
1025     if echo $dump_args | grep '\-l0' >/dev/null; then
1026         _prepare_restore_dir
1027     fi
1028
1029     echo "Restoring cumumlative from file..."
1030     opts="$_restore_debug -f $dump_file -r $restore_dir"
1031     echo "xfsrestore $opts" | _dir_filter
1032     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1033 }
1034
1035 _do_restore_toc()
1036 {
1037     echo "Contents of dump ..."
1038     opts="$_restore_debug -f $dump_file -t"
1039     echo "xfsrestore $opts" | _dir_filter
1040     cd $SCRATCH_MNT # for IRIX which needs xfs cwd
1041     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter_main |\
1042     _check_quota_file |\
1043     _check_quota_entries |\
1044     $AWK_PROG 'NF != 1 { print; next }
1045                {files = sprintf("%s\n%s", files, $1)}
1046                 END { print files | "sort" } '
1047     # the above awk code is to alpha sort only the output
1048     # of files (and not the verbose restore msgs)
1049     cd $here # put back
1050 }
1051
1052 #
1053 # Restore the tape from multiple dump files
1054 #
1055 _do_restore_multi_file()
1056 {
1057     _parse_args "$@"
1058     _prepare_restore_dir
1059
1060     multi_args=""
1061
1062     i=0
1063     while [ $i -lt $multi ]
1064     do
1065         multi_args="$multi_args -f $dump_file.$i"
1066         i=`expr $i + 1`
1067     done
1068
1069     echo "Restoring from file..."
1070     opts="$_restore_debug $multi_args -L $session_label $restore_dir"
1071     echo "xfsrestore $opts" | _dir_filter
1072     xfsrestore $opts 2>&1 | tee -a $seq.full | _dump_filter
1073 }
1074
1075 #
1076 # Do xfsdump piped into xfsrestore - xfsdump | xfsrestore
1077 #
1078 # Use -s as we want to dump and restore to the same xfs partition
1079 #
1080 _do_dump_restore()
1081 {
1082     _parse_args $*
1083     _prepare_restore_dir
1084     echo "xfsdump|xfsrestore ..."
1085     restore_opts="$_restore_debug - $restore_dir"
1086     dump_opts="$_dump_debug$dump_args -s $dump_sdir - $SCRATCH_MNT"
1087     echo "xfsdump $dump_opts | xfsrestore $restore_opts" | _dir_filter
1088     xfsdump $dump_opts 2>$tmp.dump.mlog | xfsrestore $restore_opts 2>&1 | tee -a $seq.full | _dump_filter
1089     _dump_filter <$tmp.dump.mlog
1090 }
1091
1092 #
1093 # Compare dumped subdirectory with restored dir
1094 # using ls -lR.
1095 # Thus no contents are compared but permissions, sizes,
1096 # owners, etc... are.
1097 #
1098 _ls_compare_sub()
1099 {
1100     #
1101     # verify we got back what we dumped
1102     #
1103     echo "Comparing listing of dump directory with restore directory"
1104     ls -lR $dump_dir | tee -a $seq.full | _ls_filter >$tmp.dump_dir
1105     ls -lR $restore_dir/$dump_sdir | tee -a $seq.full | _ls_filter \
1106     | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1107
1108     diff -cs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1109 }
1110
1111 #
1112 # filter out the date fields
1113 #
1114 _ls_nodate_filter()
1115 {
1116     $AWK_PROG 'NF == 9 { print $1, $2, $3, $4, $9 }'
1117 }
1118
1119 #
1120 # _ls_compare_sub but don't compare dates
1121 _ls_nodate_compare_sub()
1122 {
1123     #
1124     # verify we got back what we dumped
1125     #
1126     echo "Comparing listing of dump directory with restore directory"
1127     ls -lR $dump_dir | tee -a $seq.full | _ls_filter | _ls_nodate_filter >$tmp.dump_dir
1128     ls -lR $restore_dir/$dump_sdir | tee -a $seq.full | _ls_filter \
1129     | _ls_nodate_filter | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1130
1131     diff -cs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1132 }
1133
1134 #
1135 # Compare using recursive diff the files of the dumped
1136 # subdirectory.
1137 # This one will compare the contents.
1138 #
1139 _diff_compare_sub()
1140 {
1141     echo "Comparing dump directory with restore directory"
1142     diff -rs $dump_dir $restore_dir/$dump_sdir | _dir_filter
1143 }
1144
1145 _get_eas_on_path()
1146 {
1147     _path=$1
1148
1149     find $_path -exec attr -l {} \; |\
1150     awk '{print $9, $2}' |\
1151     sed 's/["]//g' |\
1152     sort |\
1153     while read file ea_name; do
1154         attr -g $ea_name $file
1155     done
1156 }
1157
1158 #
1159 # Compare the extended attributes of the files/dirs
1160 # b/w the dumped and restore dirs.
1161 #
1162 #
1163 # Attribute "attr5" had a 8 byte value for /spare1/dump.5460/dir:
1164 # Attribute "attr5" had a 8 byte value for /spare1/restore.5460/dump.5460/dir:
1165 #
1166 _diff_compare_eas()
1167 {
1168     echo "Comparing dump directory with restore directory"
1169     echo "Looking at the extended attributes (EAs)"
1170     echo "EAs on dump"
1171     _get_eas_on_path $dump_dir | tee $seq.ea1 | _dir_filter
1172     echo "EAs on restore"
1173     _get_eas_on_path $restore_dir/$dump_sdir \
1174     | sed -e "s#$restore_sdir\/##" \
1175     | tee $seq.ea2 \
1176     | _dir_filter
1177     diff -s $seq.ea1 $seq.ea2
1178 }
1179
1180
1181 #
1182 # Compare using recursive diff the files of the dumped
1183 # filesystem
1184 #
1185 _diff_compare()
1186 {
1187     echo "Comparing dump directory with restore directory"
1188     diff -rs $SCRATCH_MNT $restore_dir | _dir_filter | _check_quota_diff
1189 }
1190
1191 #
1192 # Check out the dump inventory
1193 #
1194 _dump_inventory()
1195 {
1196     xfsdump $_dump_debug -I | tee -a $seq.full | _dump_filter_main
1197 }
1198
1199 #
1200 # Do the xfsinvutil cmd with debug and filters
1201 # Need to set variable: "$middate" to the invutil date
1202 #
1203 _do_invutil()
1204 {
1205     host=`hostname`
1206     echo "xfsinvutil $_invutil_debug -M $host:$SCRATCH_MNT \"$middate\" $*" >$seq.full
1207     xfsinvutil $_invutil_debug $* -M $host:$SCRATCH_MNT "$middate" \
1208     | tee -a $seq.full | _invutil_filter
1209 }
1210
1211 #
1212 # ensure we can find the user quota msg if user quotas are on
1213 # ensure we can find the group quota msg if group quotas are on
1214 #
1215 _check_quota()
1216 {
1217     usermsg=$1
1218     groupmsg=$2
1219     uquota=0
1220     gquota=0
1221     $here/src/feature -U $SCRATCH_DEV && uquota=1
1222     $here/src/feature -G $SCRATCH_DEV && gquota=1
1223
1224     $AWK_PROG -v uquota=$uquota -v gquota=$gquota -v full=$seq.full \
1225               -v usermsg="$usermsg" -v groupmsg="$groupmsg" '
1226         $0 ~ groupmsg {
1227                         print "Found group quota:", $0 >>full
1228                         found_gquota = 1
1229                         if (!gquota) {
1230                             print "Found extra:", $0
1231                         }
1232                         next
1233         }
1234         $0 ~ usermsg {
1235                         print "Found user quota:", $0 >>full
1236                         found_uquota = 1
1237                         if (!uquota) {
1238                             print "Found extra:", $0
1239                         }
1240                         next
1241         }
1242                         { print }
1243         END {
1244                 if (uquota && !found_uquota) {
1245                     print "Missing: ", usermsg
1246                 }
1247                 if (gquota && !found_gquota) {
1248                     print "Missing: ", groupmsg
1249                 }
1250         }
1251     '
1252 }
1253
1254 #
1255 # xfsrestore: 3 directories and 40 entries processed
1256 #   $5 = 40
1257 #   num entries needs to be reduced by num quota file(s)
1258 #
1259 _check_quota_entries()
1260 {
1261     uquota=0
1262     gquota=0
1263     $here/src/feature -U $SCRATCH_DEV && uquota=1
1264     $here/src/feature -G $SCRATCH_DEV && gquota=1
1265     $AWK_PROG -v uquota=$uquota -v gquota=$gquota '
1266         /entries processed/ {
1267                 if (uquota) $5--
1268                 if (gquota) $5--
1269         }
1270         {print}'
1271 }
1272
1273 #
1274 # Look for:
1275 # xfsdump: saving user quota information for: SCRATCH_MNT
1276 # xfsdump: saving group quota information for: SCRATCH_MNT
1277 # xfsrestore: user quota information written to ...'
1278 # xfsrestore: group quota information written to ...'
1279 #
1280 _check_quota_dumprestore()
1281 {
1282    _check_quota 'user quota information' \
1283                 'group quota information'
1284 }
1285
1286 #
1287 # Look for:
1288 # Only in RESTORE_DIR: xfsdump_quotas
1289 # Only in RESTORE_DIR: xfsdump_quotas_group
1290 #
1291 _check_quota_diff()
1292 {
1293    _check_quota 'Only in RESTORE_DIR: xfsdump_quotas' \
1294        'Only in RESTORE_DIR: xfsdump_quotas_group'
1295 }
1296
1297 #
1298 # Look for the quota file in the output
1299 # Ensure that it is there if it should be
1300 # Filter it out so that the output is always the same
1301 # even with no quotas
1302 #
1303 _check_quota_file()
1304 {
1305    _check_quota 'xfsdump_quotas' 'xfsdump_quotas_group'
1306 }
1307
1308 # make sure this script returns success
1309 /bin/true