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=-v4
  42   _restore_debug=-v4
  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 -nR $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 #
 414 # Add more files so that there are more than the number
 415 # of streams.
 416 # There are bugs in dump/restore for # non-dir files < # streams
 417 # It can be tested in another configuration.
 418 # It is a pathalogical case.
 419 #
 420 sub/a           1       $nobody $nobody
 421 sub/b           2       $nobody $nobody
 422 sub/c           4       $nobody $nobody
 423 sub/d           8       $nobody $nobody
 424 sub/e           16      $nobody $nobody
 425 sub/f           32      $nobody $nobody
 426 sub/g           64      $nobody $nobody
 427 sub/h           128     $nobody $nobody
 428 sub/i           256     $nobody $nobody
 429 sub/j           512     $nobody $nobody
 430 sub/k           1024    $nobody $nobody
 431 sub/l           2048    $nobody $nobody
 432 sub/m           4096    $nobody $nobody
 433 sub/n           8192    $nobody $nobody
 434 End-of-File
 435 }
 436
 437 #
 438 # extended file attribute flags
 439 #
 440 _mk_fillconfig_xattr()
 441 {
 442     cat <<End-of-File >$tmp.config
 443 # pathname      size    user    group    perm   name
 444 #
 445 xflag_realtime  10      $nobody $nobody  777    XFS_XFLAG_REALTIME
 446 xflag_prealloc  10      $nobody $nobody  777    XFS_XFLAG_PREALLOC
 447 xflag_immutable 10      $nobody $nobody  777    XFS_XFLAG_IMMUTABLE
 448 xflag_append    10      $nobody $nobody  777    XFS_XFLAG_APPEND
 449 xflag_sync      10      $nobody $nobody  777    XFS_XFLAG_SYNC
 450 xflag_noatime   10      $nobody $nobody  777    XFS_XFLAG_NOATIME
 451 xflag_nodump    10      $nobody $nobody  777    XFS_XFLAG_NODUMP
 452 xflag_hasattr   10      $nobody $nobody  777    XFS_XFLAG_HASATTR
 453 End-of-File
 454 }
 455
 456 #
 457 # Create a bunch of directories/files of different sizes
 458 # filled with data.
 459 #
 460 # Pinched from test 001.
 461 #
 462 _do_create_dumpdir_fill()
 463 {
 464     echo "Creating directory system to dump using src/fill."
 465
 466     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
 467     cd $dump_dir
 468
 469     $verbose && echo -n "Setup "
 470     sed -e '/^#/d' $tmp.config \
 471     | while read file nbytes owner group perms ea_name ea_value namespace
 472     do
 473         if [ $nbytes = "d" ]; then
 474             # create a directory
 475             dir=$file
 476             if [ ! -d $dir ]
 477             then
 478                 if mkdir $dir
 479                 then
 480                     :
 481                 else
 482                     $verbose && echo
 483                     echo "Error: cannot mkdir \"$dir\""
 484                     exit 1
 485                 fi
 486             fi
 487         else
 488             # create a directory/file
 489             dir=`dirname $file`
 490             if [ "$dir" != "." ]
 491             then
 492                 if [ ! -d $dir ]
 493                 then
 494                     if mkdir $dir
 495                     then
 496                         :
 497                     else
 498                         $verbose && echo
 499                         echo "Error: cannot mkdir \"$dir\""
 500                         exit 1
 501                     fi
 502                 fi
 503             fi
 504             rm -f $file
 505             if $here/src/fill $file $file $nbytes
 506             then
 507                 :
 508             else
 509                 $verbose && echo
 510                 echo "Error: cannot create \"$file\""
 511                 exit 1
 512             fi
 513         fi
 514         if [ -n "$owner" -a -n "$group" ]; then
 515             chown $owner.$group $file
 516         fi
 517         if [ -n "$perms" ]; then
 518             chmod $perms $file
 519         fi
 520
 521         # extended attributes (EA)
 522         if [ -n "$ea_name" -a -n "$ea_value" ]; then
 523             if [ "X$namespace" = "Xroot" ]; then
 524                 attr -R -s $ea_name -V $ea_value $file
 525             else
 526                 attr -s $ea_name -V $ea_value $file
 527             fi
 528         # extended file attribute flags - no value - NOT EAs
 529         elif [ -n "$ea_name" -a -z "$ea_value" ]; then
 530             # set the flag
 531             # TODO XXX
 532             # use xfs_io to send the ioctl
 533             :
 534         fi
 535         $verbose && echo -n "."
 536     done
 537     $verbose && echo
 538
 539     cd $here
 540 }
 541
 542 _create_dumpdir_largefile()
 543 {
 544     _wipe_fs
 545     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
 546     _largesize=4294967297
 547     _largefile=$dump_dir/largefile
 548     echo "dd a largefile at offset $_largesize"
 549     POSIXLY_CORRECT=yes \
 550     dd if=/dev/zero of=$_largefile bs=1 seek=$_largesize count=10 2>&1
 551     _stable_fs
 552 }
 553
 554 _create_dumpdir_fill()
 555 {
 556     _wipe_fs
 557     _mk_fillconfig1
 558     _do_create_dumpdir_fill
 559     _stable_fs
 560 }
 561
 562 _create_dumpdir_fill2()
 563 {
 564     _wipe_fs
 565     _mk_fillconfig2
 566     _do_create_dumpdir_fill
 567     _stable_fs
 568 }
 569
 570 _create_dumpdir_fill_perm()
 571 {
 572     _wipe_fs
 573     _mk_fillconfig_perm
 574     _do_create_dumpdir_fill
 575     _stable_fs
 576 }
 577
 578 _create_dumpdir_fill_ea()
 579 {
 580     _wipe_fs
 581     _mk_fillconfig_ea
 582     _do_create_dumpdir_fill
 583     _stable_fs
 584 }
 585
 586
 587 #
 588 # Append a subset of the fill'ed files
 589 # So we can see if just these get dumped on an incremental
 590 #
 591 _append_dumpdir_fill()
 592 {
 593     cd $dump_dir
 594     cat <<End-of-File >$tmp.config
 595 # pathname
 596 #
 597 small
 598 sub/big
 599 #
 600 sub/a
 601 sub/c
 602 sub/e
 603 End-of-File
 604     sed -e '/^#/d' $tmp.config \
 605     | while read file
 606     do
 607         echo 'Extra text' >>$file
 608     done
 609
 610     cd $here
 611     _stable_fs
 612 }
 613
 614 _do_create_dump_symlinks()
 615 {
 616     echo "Creating directory system of symlinks to dump."
 617
 618     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
 619     cd $dump_dir
 620
 621     $verbose && echo -n "Setup "
 622     sed -e '/^#/d' $tmp.config \
 623     | while read file nbytes owner group owner2 group2 perms perms2
 624     do
 625         dir=`dirname $file`
 626         if [ "$dir" != "." ]
 627         then
 628             if [ ! -d $dir ]
 629             then
 630                 if mkdir $dir
 631                 then
 632                     :
 633                 else
 634                     $verbose && echo
 635                     echo "Error: cannot mkdir \"$dir\""
 636                     exit 1
 637                 fi
 638             fi
 639         fi
 640         rm -f $file
 641         touch $file
 642
 643         # Do chmod on symlink using umask.
 644         # This won't do the right thing as it subtracts permissions.
 645         # However, I don't care, as long as I get some different perms
 646         # for testing.
 647         if [ -n "$perms2" ]; then
 648             omask=`umask`
 649             umask $perms2
 650         fi
 651         ln -s $file $file-link
 652         if [ -n "$perms2" ]; then
 653             umask $omask
 654         fi
 655
 656         if [ -n "$owner" -a -n "$group" ]; then
 657             chown $owner.$group $file
 658         fi
 659         if [ -n "$owner" -a -n "$group" ]; then
 660             chown -h $owner.$group $file-link
 661         fi
 662         if [ -n "$perms" ]; then
 663             chmod $perms $file
 664         fi
 665         $verbose && echo -n "."
 666     done
 667     $verbose && echo
 668
 669     cd $here
 670 }
 671
 672 _mk_symlink_config()
 673 {
 674     cat <<End-of-File >$tmp.config
 675 # path  size    owner1  group1  owner2  group2  perm1   perm2
 676 #
 677 a       0       $nobody $nobody daemon  sys     124     421
 678 b       0       daemon  sys     bin     bin     347     743
 679 sub/a   0       bin     bin     $nobody sys     777     777
 680 sub/b   0       $nobody sys     $nobody $nobody 367     763
 681 End-of-File
 682 }
 683
 684 _create_dumpdir_symlinks()
 685 {
 686     _wipe_fs
 687     _mk_symlink_config
 688     _do_create_dump_symlinks
 689     _stable_fs
 690 }
 691
 692 #
 693 # create hardlinks of form $_fname, $_fname_h1 $_fname_h2 ...
 694 #
 695 _create_hardlinks()
 696 {
 697     _fname=$1
 698     _numlinks=$2
 699
 700     touch $_fname
 701     _j=1
 702     while [ $_j -le $_numlinks ]; do
 703         _suffix=_h$_j
 704         _hardlink=$_fname$_suffix
 705         echo "creating hardlink $_hardlink to $_fname"
 706         ln $_fname $_hardlink
 707         _j=`expr $_j + 1`
 708     done
 709 }
 710
 711 #
 712 # create a set of hardlinks
 713 # create hardlinks of form file1, file1_h1 file1_h2 ...
 714 # create hardlinks of form file2, file2_h1 file2_h2 ...
 715 # create hardlinks of form file3, file3_h1 file3_h2 ...
 716 #
 717 _create_hardset()
 718 {
 719     _numsets=$1
 720     _i=1
 721     while [ $_i -le $_numsets ]; do
 722         _create_hardlinks file$_i 5
 723         _i=`expr $_i + 1`
 724     done
 725 }
 726
 727
 728 _modify_level()
 729 {
 730     _level=$1
 731     echo "mod level $_level" >$dump_dir/file$_level
 732 }
 733
 734 _create_dumpdir_hardlinks()
 735 {
 736     _numsets=$1
 737     _wipe_fs
 738     echo "Creating directory system of hardlinks to incrementally dump."
 739
 740     mkdir -p $dump_dir || _fail "cannot mkdir \"$dump_dir\""
 741     cd $dump_dir
 742
 743     _create_hardset $_numsets
 744
 745     cd $here
 746     _stable_fs
 747 }
 748
 749 #
 750 # Filter for ls
 751 # Filter out times and dates on symlinks and char devices.
 752 # Filter out size on directories because this can differ
 753 # when transitioning to long inode numbers (ie. 64 bits).
 754 #
 755 _ls_filter()
 756 {
 757   $AWK_PROG '
 758         /^l/ { date = $8; time = $7; sub(date,"DATE"); sub(time,"TIME"); print}
 759         /^c/ { date = $9; time = $7; sub(date,"DATE"); sub(time,"TIME"); print}
 760         /^d/ { size = $5; sub(size,"SIZE"); print}
 761         {print}' \
 762   | sed -e 's/total [0-9][0-9]*/total TOTAL/'
 763 }
 764
 765 #
 766 # Filtering of Irix character hwgraph device names
 767 # e.g.
 768 # chardev: /hw/node/xtalk/15/pci/0/scsi_ctlr/0/target/1/lun/0/disk/partition/4/char
 769 # blkdev:  /dev/dsk/dks0d1s4
 770 #
 771 _filter_devchar()
 772 {
 773     $AWK_PROG '
 774         /\/hw\/node/ {
 775             sub(/\/hw.*scsi_ctlr\//,"/dev/dsk/dks")  # blah blah /dev/dsk/dks0/target/1/....
 776             sub(/\/target\//,"d")                    # blah blah /dev/dsk/dks0d1/lun/0/disk.....
 777             sub(/\/lun.*partition\//,"s")            # blah blah /dev/dsk/dks0d1s4/char
 778             sub(/\/char/,"")                         # blah blah /dev/dsk/dks0d1s4
 779         }
 780         { print }
 781     '
 782 }
 783
 784
 785 #
 786 # Filter out the non-deterministic dump msgs from
 787 # xfsdump and xfsrestore
 788 #
 789 _dump_filter_main()
 790 {
 791   _filter_devchar |\
 792   sed \
 793       -e "s/`hostname`/HOSTNAME/"                       \
 794       -e "s#$SCRATCH_DEV#SCRATCH_DEV#"                  \
 795       -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"               \
 796       -e "s#$dumptape#TAPE_DEV#"                        \
 797       -e "s#$SCRATCH_MNT#SCRATCH_MNT#"                  \
 798       -e "s#$dump_file#DUMP_FILE#"                      \
 799       -e 's#/var/lib/xfsdump#/var/xfsdump#'             \
 800       -e 's/session id:[        ]*[0-9a-f-]*/session id: ID/'  \
 801       -e '/filesystem id:[      ]*[0-9a-f-]*/d'         \
 802       -e 's/time:[      ].*/time: TIME/'                \
 803       -e 's/date:[      ].*/date: DATE/'                \
 804       -e 's/dump begun .*/dump begun DATE/'             \
 805       -e 's/[0-9][0-9]* seconds/SECS seconds/'          \
 806       -e 's/restore.[0-9][0-9]*/restore.PID/'           \
 807       -e 's/ino [0-9][0-9]*/ino INO/'                   \
 808       -e '/: dump size/s/[0-9][0-9]*/NUM/'              \
 809       -e '/dump size:/s/[0-9][0-9]*/NUM/'               \
 810       -e '/dump size per stream:/s/[0-9][0-9]*/NUM/'    \
 811       -e 's/\(media file size[   ]*\)[0-9][0-9]*/\1NUM/' \
 812       -e 's/\(mfile size:[       ]*\)[0-9][0-9]*/\1NUM/' \
 813       -e '/drive[        ]*[0-9][0-9]*:/d'              \
 814       -e '/\/dev\/tty/d'                                \
 815       -e '/inventory session uuid/d'                    \
 816       -e '/ - Running single-threaded/d'                \
 817       -e '/^.*I\/O metrics: .*$/d'                      \
 818       -e 's/1048576/BLOCKSZ/'                           \
 819       -e 's/2097152/BLOCKSZ/'                           \
 820       -e 's/(pid[        ]*[1-9][0-9]*)/\(pid PID\)/'   \
 821       -e '/version 3\.0/d'                              \
 822       -e 's/\/hw\/module.*$/SCRATCH_DEV/'               \
 823       -e 's/id:[[:space:]]*[0-9a-f]\{8\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{4\}-[0-9a-f]\{12\}/ID: ID/'                                              \
 824       -e 's/\[y\/n\][- ]----------------------*/\[y\/n\]/'              \
 825   | perl -ne '
 826       if ($_ =~ /(?:Dump|Restore) Summary/) {
 827         $skip = 1;
 828       } elsif ($_ =~ /(?:Dump|Restore) Status/) {
 829         $skip = 0;
 830       }
 831       print if (! $skip);'
 832 }
 833
 834 _dump_filter()
 835 {
 836    if $do_quota_check
 837    then
 838        _dump_filter_main | _check_quota_dumprestore | _check_quota_entries
 839    else
 840        _dump_filter_main
 841    fi
 842 }
 843
 844 _invutil_filter()
 845 {
 846   _dump_filter_main \
 847   | sed \
 848         -e 's/UUID[     ]*:[    ][0-9a-f-]*/UUID                :       ID/' \
 849         -e 's/TIME OF DUMP[     ]*:.*/TIME OF DUMP      :       TIME/' \
 850         -e 's/HOSTNAME:SCRATCH_MNT.*/HOSTNAME:SCRATCH_MNT/' \
 851         -e 's#inventory/[0-9a-f-]*#inventory/UUID#' \
 852
 853 }
 854
 855
 856 _dir_filter()
 857 {
 858   sed \
 859     -e "s#$dump_file#DUMP_FILE#"      \
 860     -e "s#$SCRATCH_DEV#SCRATCH_DEV#"        \
 861     -e "s#$SCRATCH_RAWDEV#SCRATCH_DEV#"    \
 862     -e "s#$dumptape#TAPE_DEV#"         \
 863     -e "s#$dump_dir#DUMP_DIR#g"       \
 864     -e "s#$restore_dir#RESTORE_DIR#g" \
 865     -e "s#$SCRATCH_MNT#SCRATCH_MNT#g"       \
 866     -e "s#$dump_sdir#DUMP_SUBDIR#g"   \
 867     -e "s#$restore_sdir#RESTORE_SUBDIR#g" \
 868     -e "s#$$#PID#g" \
 869
 870 }
 871
 872 #
 873 # Note: requires a space between option letter and argument
 874 #
 875 _parse_args()
 876 {
 877     OPTIND=0
 878     dump_args=""
 879     while [ $# -gt 0 ]
 880     do
 881         case $1
 882         in
 883         -f)
 884             [ -z "$2" ] && _fail "missing argument for -f"
 885             dumptape=$2
 886             shift
 887             ;;
 888         -L)
 889             [ -z "$2" ] && _fail "missing argument for -L"
 890             session_label=$2
 891             shift
 892             ;;
 893         -o)
 894             dump_args="$dump_args -o"
 895             ;;
 896         -F)
 897             dump_args="$dump_args -F"
 898             ;;
 899         --multi)
 900             multi=$2
 901             shift
 902             ;;
 903         -q)
 904             do_quota_check=true
 905             ;;
 906         -Q)
 907             do_quota_check=false
 908             ;;
 909         -l)
 910             [ -z "$2" ] && _fail "missing argument for -l"
 911             dump_args="$dump_args -l$2"
 912             shift
 913             ;;
 914         *)
 915             _fail "invalid argument to common.dump function: $1"
 916             ;;
 917         esac
 918         shift
 919     done
 920 }
 921
 922
 923 #
 924 # Dump a subdir
 925 #
 926 _do_dump_sub()
 927 {
 928     _parse_args $*
 929
 930     echo "Dumping to tape..."
 931     opts="$_dump_debug$dump_args -s $dump_sdir -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 932     echo "xfsdump $opts" | _dir_filter
 933     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
 934 }
 935
 936 #
 937 # Do dump to tape
 938 #
 939 _do_dump()
 940 {
 941     _parse_args $*
 942
 943     echo "Dumping to tape..."
 944     opts="$_dump_debug$dump_args -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 945     echo "xfsdump $opts" | _dir_filter
 946     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
 947 }
 948
 949
 950 #
 951 # Do full dump with -m
 952 #
 953 _do_dump_min()
 954 {
 955     _parse_args $*
 956
 957     echo "Dumping to tape..."
 958     onemeg=1048576
 959     opts="$_dump_debug$dump_args -m -b $onemeg -l0 -f $dumptape -M $media_label -L $session_label $SCRATCH_MNT"
 960     echo "xfsdump $opts" | _dir_filter
 961     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
 962 }
 963
 964
 965 #
 966 # Do full dump to file
 967 #
 968 _do_dump_file()
 969 {
 970     _parse_args $*
 971
 972     echo "Dumping to file..."
 973     opts="$_dump_debug$dump_args -f $dump_file -M $media_label -L $session_label $SCRATCH_MNT"
 974     echo "xfsdump $opts" | _dir_filter
 975     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
 976 }
 977
 978 #
 979 # Do full dump to multiple files
 980 #
 981 _do_dump_multi_file()
 982 {
 983     _parse_args "$@"
 984
 985     multi_args=""
 986
 987     i=0
 988     while [ $i -lt $multi ]
 989     do
 990         multi_args="$multi_args -f $dump_file.$i -M $media_label.$i"
 991         i=`expr $i + 1`
 992     done
 993
 994     echo "Dumping to files..."
 995     opts="$_dump_debug$dump_args $multi_args -L $session_label $SCRATCH_MNT"
 996     echo "xfsdump $opts" | _dir_filter
 997     xfsdump $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
 998 }
 999
1000
1001 _prepare_restore_dir()
1002 {
1003     rm -rf $restore_dir
1004     mkdir $restore_dir || _fail "failed to mkdir $restore_dir"
1005 }
1006
1007
1008 #
1009 # Get tape ready and restore dir
1010 #
1011 _prepare_restore()
1012 {
1013     _prepare_restore_dir
1014
1015     echo "Rewinding tape"
1016     _rewind
1017 }
1018
1019 #
1020 # Restore the tape into $restore_dir
1021 #
1022 _do_restore()
1023 {
1024     _parse_args $*
1025     _prepare_restore
1026
1027
1028     echo "Restoring from tape..."
1029     opts="$_restore_debug -f $dumptape  -L $session_label $restore_dir"
1030     echo "xfsrestore $opts" | _dir_filter
1031     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1032 }
1033
1034 #
1035 # Restore the tape into $restore_dir using -m
1036 #
1037 _do_restore_min()
1038 {
1039     _parse_args $*
1040     _prepare_restore
1041
1042     echo "Restoring from tape..."
1043     onemeg=1048576
1044     opts="$_restore_debug -m -b $onemeg -f $dumptape  -L $session_label $restore_dir"
1045     echo "xfsrestore $opts" | _dir_filter
1046     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1047 }
1048
1049 #
1050 # Restore the tape from a dump file
1051 #
1052 _do_restore_file()
1053 {
1054     _parse_args $*
1055     _prepare_restore_dir
1056
1057     echo "Restoring from file..."
1058     opts="$_restore_debug -f $dump_file  -L $session_label $restore_dir"
1059     echo "xfsrestore $opts" | _dir_filter
1060     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1061 }
1062
1063 #
1064 # Cumulative restore from a file
1065 # Need to specify the dump level e.g. "-l 0"
1066 #
1067 _do_restore_file_cum()
1068 {
1069     _parse_args $*
1070     if echo $dump_args | grep '\-l0' >/dev/null; then
1071         _prepare_restore_dir
1072     fi
1073
1074     echo "Restoring cumumlative from file..."
1075     opts="$_restore_debug -f $dump_file -r $restore_dir"
1076     echo "xfsrestore $opts" | _dir_filter
1077     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1078 }
1079
1080 _do_restore_toc()
1081 {
1082     echo "Contents of dump ..."
1083     opts="$_restore_debug -f $dump_file -t"
1084     echo "xfsrestore $opts" | _dir_filter
1085     cd $SCRATCH_MNT # for IRIX which needs xfs cwd
1086     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter_main |\
1087     _check_quota_file |\
1088     _check_quota_entries |\
1089     $AWK_PROG 'NF != 1 { print; next }
1090                {files = sprintf("%s\n%s", files, $1)}
1091                 END { print files | "sort" } '
1092     # the above awk code is to alpha sort only the output
1093     # of files (and not the verbose restore msgs)
1094     cd $here # put back
1095 }
1096
1097 #
1098 # Restore the tape from multiple dump files
1099 #
1100 _do_restore_multi_file()
1101 {
1102     _parse_args "$@"
1103     _prepare_restore_dir
1104
1105     multi_args=""
1106
1107     i=0
1108     while [ $i -lt $multi ]
1109     do
1110         multi_args="$multi_args -f $dump_file.$i"
1111         i=`expr $i + 1`
1112     done
1113
1114     echo "Restoring from file..."
1115     opts="$_restore_debug $multi_args -L $session_label $restore_dir"
1116     echo "xfsrestore $opts" | _dir_filter
1117     xfsrestore $opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1118 }
1119
1120 #
1121 # Do xfsdump piped into xfsrestore - xfsdump | xfsrestore
1122 #
1123 # Use -s as we want to dump and restore to the same xfs partition
1124 #
1125 _do_dump_restore()
1126 {
1127     _parse_args $*
1128     _prepare_restore_dir
1129     echo "xfsdump|xfsrestore ..."
1130     restore_opts="$_restore_debug - $restore_dir"
1131     dump_opts="$_dump_debug$dump_args -s $dump_sdir - $SCRATCH_MNT"
1132     echo "xfsdump $dump_opts | xfsrestore $restore_opts" | _dir_filter
1133     xfsdump $dump_opts 2>$tmp.dump.mlog | xfsrestore $restore_opts 2>&1 | tee -a $here/$seq.full | _dump_filter
1134     _dump_filter <$tmp.dump.mlog
1135 }
1136
1137 #
1138 # Compare dumped subdirectory with restored dir
1139 # using ls -nR.
1140 # Thus no contents are compared but permissions, sizes,
1141 # owners, etc... are.
1142 #
1143 _ls_compare_sub()
1144 {
1145     #
1146     # verify we got back what we dumped
1147     #
1148     echo "Comparing listing of dump directory with restore directory"
1149     ls -nR $dump_dir | tee -a $here/$seq.full | _ls_filter >$tmp.dump_dir
1150     ls -nR $restore_dir/$dump_sdir | tee -a $here/$seq.full | _ls_filter \
1151     | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1152
1153     diff -bcs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1154
1155 }
1156
1157 #
1158 # filter out the date fields
1159 #
1160 _ls_nodate_filter()
1161 {
1162     $AWK_PROG 'NF == 9 { print $1, $2, $3, $4, $9 }'
1163 }
1164
1165 #
1166 # _ls_compare_sub but don't compare dates
1167 _ls_nodate_compare_sub()
1168 {
1169     #
1170     # verify we got back what we dumped
1171     #
1172     echo "Comparing listing of dump directory with restore directory"
1173     ls -nR $dump_dir | tee -a $here/$seq.full | _ls_filter | _ls_nodate_filter >$tmp.dump_dir
1174     ls -nR $restore_dir/$dump_sdir | tee -a $here/$seq.full | _ls_filter \
1175     | _ls_nodate_filter | sed -e "s#$restore_sdir\/##" >$tmp.restore_dir
1176
1177     diff -bcs $tmp.dump_dir $tmp.restore_dir | sed -e "s#$tmp#TMP#g"
1178 }
1179
1180 #
1181 # Compare using recursive diff the files of the dumped
1182 # subdirectory.
1183 # This one will compare the contents.
1184 #
1185 _diff_compare_sub()
1186 {
1187     echo "Comparing dump directory with restore directory"
1188     diff -rs $dump_dir $restore_dir/$dump_sdir | _dir_filter
1189 }
1190
1191 _get_eas_on_path()
1192 {
1193     _path=$1
1194
1195 # Tim - this is the IRIX way...
1196     # find $_path -exec attr -l {} \; |\
1197     # awk '{print $9, $2}' |\
1198     # sed 's/["]//g' |\
1199     # sort |\
1200 # and this is now the Linux way...
1201     echo "User names"
1202     getfattr --absolute-names -Rh -m user $_path |\
1203     perl -wn -e '
1204         if (m/^# file: (\S+)/) { $file = $1 }
1205         elsif (m/^user\.(\w+)/) { print $file, " ",$1,"\n" }' |\
1206     sort |\
1207     while read file ea_name; do
1208         attr -g $ea_name $file
1209     done
1210
1211     if [ "$USE_ATTR_SECURE" = yes ]; then
1212         echo "Security names"
1213         getfattr --absolute-names -Rh -m security $_path |\
1214         perl -wn -e '
1215             if (m/^# file: (\S+)/) { $file = $1 }
1216             elsif (m/^security\.(\w+)/) { print $file, " ",$1,"\n" }' |\
1217         sort |\
1218         while read file ea_name; do
1219             attr -g $ea_name $file
1220         done
1221     fi
1222
1223     echo "Root names"
1224     getfattr --absolute-names -Rh -m trusted $_path |\
1225     perl -wn -e '
1226         if (m/^# file: (\S+)/) { $file = $1 }
1227         elsif (m/^trusted\.(\w+)/) { print $file, " ",$1,"\n" }' |\
1228     sort |\
1229     while read file ea_name; do
1230         attr -R -g $ea_name $file
1231     done
1232 }
1233
1234 #
1235 # Compare the extended attributes of the files/dirs
1236 # b/w the dumped and restore dirs.
1237 #
1238 #
1239 # Attribute "attr5" had a 8 byte value for /spare1/dump.5460/dir:
1240 # Attribute "attr5" had a 8 byte value for /spare1/restore.5460/dump.5460/dir:
1241 #
1242 _diff_compare_eas()
1243 {
1244     echo "Comparing dump directory with restore directory"
1245     echo "Looking at the extended attributes (EAs)"
1246     echo "EAs on dump"
1247     _get_eas_on_path $dump_dir | tee $seq.ea1 | _dir_filter
1248     echo "EAs on restore"
1249     _get_eas_on_path $restore_dir/$dump_sdir \
1250     | sed -e "s#$restore_sdir\/##" \
1251     | tee $seq.ea2 \
1252     | _dir_filter
1253     diff -s $seq.ea1 $seq.ea2
1254 }
1255
1256
1257 #
1258 # Compare using recursive diff the files of the dumped
1259 # filesystem
1260 #
1261 _diff_compare()
1262 {
1263     echo "Comparing dump directory with restore directory"
1264     diff -rs $SCRATCH_MNT $restore_dir | _dir_filter | _check_quota_diff
1265 }
1266
1267 #
1268 # Check out the dump inventory
1269 #
1270 _dump_inventory()
1271 {
1272     xfsdump $_dump_debug -I | tee -a $here/$seq.full | _dump_filter_main
1273 }
1274
1275 #
1276 # Do the xfsinvutil cmd with debug and filters
1277 # Need to set variable: "$middate" to the invutil date
1278 #
1279 _do_invutil()
1280 {
1281     host=`hostname`
1282     echo "xfsinvutil $_invutil_debug -M $host:$SCRATCH_MNT \"$middate\" $*" >$here/$seq.full
1283     xfsinvutil $_invutil_debug $* -M $host:$SCRATCH_MNT "$middate" \
1284     | tee -a $here/$seq.full | _invutil_filter
1285 }
1286
1287 #
1288 # ensure we can find the user quota msg if user quotas are on
1289 # ensure we can find the group quota msg if group quotas are on
1290 #
1291 _check_quota()
1292 {
1293     usermsg=$1
1294     groupmsg=$2
1295     uquota=0
1296     gquota=0
1297     $here/src/feature -U $SCRATCH_DEV && uquota=1
1298     $here/src/feature -G $SCRATCH_DEV && gquota=1
1299
1300     $AWK_PROG -v uquota=$uquota -v gquota=$gquota -v full=$here/$seq.full \
1301               -v usermsg="$usermsg" -v groupmsg="$groupmsg" '
1302         $0 ~ groupmsg {
1303                         print "Found group quota:", $0 >>full
1304                         found_gquota = 1
1305                         if (!gquota) {
1306                             print "Found extra:", $0
1307                         }
1308                         next
1309         }
1310         $0 ~ usermsg {
1311                         print "Found user quota:", $0 >>full
1312                         found_uquota = 1
1313                         if (!uquota) {
1314                             print "Found extra:", $0
1315                         }
1316                         next
1317         }
1318                         { print }
1319         END {
1320                 if (uquota && !found_uquota) {
1321                     print "Missing: ", usermsg
1322                 }
1323                 if (gquota && !found_gquota) {
1324                     print "Missing: ", groupmsg
1325                 }
1326         }
1327     '
1328 }
1329
1330 #
1331 # xfsrestore: 3 directories and 40 entries processed
1332 #   $5 = 40
1333 #   num entries needs to be reduced by num quota file(s)
1334 #
1335 _check_quota_entries()
1336 {
1337     uquota=0
1338     gquota=0
1339     $here/src/feature -U $SCRATCH_DEV && uquota=1
1340     $here/src/feature -G $SCRATCH_DEV && gquota=1
1341     $AWK_PROG -v uquota=$uquota -v gquota=$gquota '
1342         /entries processed/ {
1343                 if (uquota) $5--
1344                 if (gquota) $5--
1345         }
1346         {print}'
1347 }
1348
1349 #
1350 # Look for:
1351 # xfsdump: saving user quota information for: SCRATCH_MNT
1352 # xfsdump: saving group quota information for: SCRATCH_MNT
1353 # xfsrestore: user quota information written to ...'
1354 # xfsrestore: group quota information written to ...'
1355 #
1356 _check_quota_dumprestore()
1357 {
1358    _check_quota 'user quota information' \
1359                 'group quota information'
1360 }
1361
1362 #
1363 # Look for:
1364 # Only in RESTORE_DIR: xfsdump_quotas
1365 # Only in RESTORE_DIR: xfsdump_quotas_group
1366 #
1367 _check_quota_diff()
1368 {
1369    _check_quota 'Only in RESTORE_DIR: xfsdump_quotas' \
1370        'Only in RESTORE_DIR: xfsdump_quotas_group'
1371 }
1372
1373 #
1374 # Look for the quota file in the output
1375 # Ensure that it is there if it should be
1376 # Filter it out so that the output is always the same
1377 # even with no quotas
1378 #
1379 _check_quota_file()
1380 {
1381    _check_quota 'xfsdump_quotas' 'xfsdump_quotas_group'
1382 }
1383
1384
1385 # make sure this script returns success
1386 /bin/true