common.dump

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