common.rc

   1 ##/bin/bash
   2 #-----------------------------------------------------------------------
   3 #  Copyright (c) 2000-2006 Silicon Graphics, Inc.  All Rights Reserved.
   4 #  This program is free software; you can redistribute it and/or modify
   5 #  it under the terms of the GNU General Public License as published by
   6 #  the Free Software Foundation; either version 2 of the License, or
   7 #  (at your option) any later version.
   8 #
   9 #  This program is distributed in the hope that it will be useful,
  10 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #  GNU General Public License for more details.
  13 #
  14 #  You should have received a copy of the GNU General Public License
  15 #  along with this program; if not, write to the Free Software
  16 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
  17 #  USA
  18 #
  19 #  Contact information: Silicon Graphics, Inc., 1500 Crittenden Lane,
  20 #  Mountain View, CA 94043, USA, or: http://www.sgi.com
  21 #-----------------------------------------------------------------------
  22
  23 dd()
  24 {
  25    if [ "$HOSTOS" == "Linux" ]
  26    then
  27         command dd --help | grep noxfer > /dev/null 2>&1
  28
  29         if [ "$?" -eq 0 ]
  30             then
  31                 command dd status=noxfer $@
  32             else
  33                 command dd $@
  34         fi
  35    else
  36         command dd $@
  37    fi
  38 }
  39
  40 # ls -l w/ selinux sometimes puts a dot at the end:
  41 # -rwxrw-r--. id1 id2 file1
  42
  43 _ls_l()
  44 {
  45         ls -l $* | sed "s/\(^[-rwxdlbcpsStT]*\)\. /\1 /"
  46 }
  47
  48 _mount_opts()
  49 {
  50     # SELinux adds extra xattrs which can mess up our expected output.
  51     # So, mount with a context, and they won't be created
  52     # nfs_t is a "liberal" context so we can use it.
  53     if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
  54         SELINUX_MOUNT_OPTIONS="-o context=system_u:object_r:nfs_t:s0"
  55     fi
  56
  57     case $FSTYP in
  58     xfs)
  59         export SELINUX_MOUNT_OPTIONS
  60         export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
  61         ;;
  62     udf)
  63         export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
  64         ;;
  65     nfs)
  66         export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
  67         ;;
  68     ext2|ext3|ext4)
  69         # acls & xattrs aren't turned on by default on ext$FOO
  70         export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
  71         ;;
  72     reiserfs)
  73         # acls & xattrs aren't turned on by default on reiserfs
  74         export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
  75         ;;
  76     gfs2)
  77         # acls aren't turned on by default on gfs2
  78         export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
  79         ;;
  80     *)
  81         ;;
  82     esac
  83 }
  84
  85 _mkfs_opts()
  86 {
  87     case $FSTYP in
  88     xfs)
  89         export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
  90         ;;
  91     udf)
  92         [ ! -z "$udf_fsize" ] && \
  93             UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
  94         export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
  95         ;;
  96     nfs)
  97         export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
  98         ;;
  99     reiserfs)
 100         export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
 101         ;;
 102     gfs2)
 103         export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
 104         ;;
 105     *)
 106         ;;
 107     esac
 108 }
 109
 110 _fsck_opts()
 111 {
 112     case $FSTYP in
 113     ext2|ext3|ext4)
 114         export FSCK_OPTIONS="-nf"
 115         ;;
 116     reiserfs)
 117         export FSCK_OPTIONS="--yes"
 118         ;;
 119     *)
 120         export FSCK_OPTIONS="-n"
 121         ;;
 122     esac
 123 }
 124
 125 [ -z "$FSTYP" ] && FSTYP=xfs
 126 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
 127 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
 128 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
 129
 130
 131 # we need common.config
 132 if [ "$iam" != "check" ]
 133 then
 134     if ! . ./common.config
 135         then
 136         echo "$iam: failed to source common.config"
 137         exit 1
 138     fi
 139 fi
 140
 141 # make sure we have a standard umask
 142 umask 022
 143
 144 _mount()
 145 {
 146     $MOUNT_PROG `_mount_ops_filter $*`
 147 }
 148
 149 _scratch_options()
 150 {
 151     type=$1
 152     SCRATCH_OPTIONS=""
 153
 154     if [ "$FSTYP" != "xfs" ]; then
 155         return
 156     fi
 157
 158     case $type in
 159     mkfs)
 160         [ "$HOSTOS" != "IRIX" ] && SCRATCH_OPTIONS="$SCRATCH_OPTIONS -f"
 161         rt_opt="-r"
 162         log_opt="-l"
 163         ;;
 164     mount)
 165         rt_opt="-o"
 166         log_opt="-o"
 167         ;;
 168     esac
 169     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
 170         SCRATCH_OPTIONS="$SCRATCH_OPTIONS ${rt_opt}rtdev=$SCRATCH_RTDEV"
 171     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 172         SCRATCH_OPTIONS="$SCRATCH_OPTIONS ${log_opt}logdev=$SCRATCH_LOGDEV"
 173 }
 174
 175 _test_options()
 176 {
 177     type=$1
 178     TEST_OPTIONS=""
 179
 180     if [ "$FSTYP" != "xfs" ]; then
 181         return
 182     fi
 183
 184     case $type in
 185     mkfs)
 186         rt_opt="-r"
 187         log_opt="-l"
 188         ;;
 189     mount)
 190         rt_opt="-o"
 191         log_opt="-o"
 192         ;;
 193     esac
 194     [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ] && \
 195         TEST_OPTIONS="$TEST_OPTIONS ${rt_opt}rtdev=$TEST_RTDEV"
 196     [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
 197         TEST_OPTIONS="$TEST_OPTIONS ${log_opt}logdev=$TEST_LOGDEV"
 198 }
 199
 200 _mount_ops_filter()
 201 {
 202     params="$*"
 203
 204     #get mount point to handle dmapi mtpt option correctly
 205     let last_index=$#-1
 206     [ $last_index -gt 0 ] && shift $last_index
 207     FS_ESCAPED=$1
 208
 209     # irix is fussy about how it is fed its mount options
 210     # - multiple -o's are not allowed
 211     # - no spaces between comma delimitered options
 212     # the sed script replaces all -o's (except the first) with a comma
 213     # not required for linux, but won't hurt
 214
 215     echo $params | sed -e 's/[[:space:]]*-o[[:space:]]*/UnIqUe/1; s/[[:space:]]*-o[[:space:]]*/,/g; s/UnIqUe/ -o /1' \
 216         | sed -e 's/dmapi/dmi/' \
 217         | $PERL_PROG -ne "s#mtpt=[^,|^\n|^\s]*#mtpt=$FS_ESCAPED\1\2#; print;"
 218
 219 }
 220
 221 _scratch_mount_options()
 222 {
 223     _scratch_options mount
 224
 225     echo $SCRATCH_OPTIONS $MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS $* $SCRATCH_DEV $SCRATCH_MNT
 226 }
 227
 228 _scratch_mount()
 229 {
 230     _mount -t $FSTYP `_scratch_mount_options $*`
 231 }
 232
 233 _scratch_unmount()
 234 {
 235     $UMOUNT_PROG $SCRATCH_DEV
 236 }
 237
 238 _scratch_remount()
 239 {
 240     _scratch_unmount
 241     _scratch_mount
 242 }
 243
 244 _test_mount()
 245 {
 246     _test_options mount
 247     _mount -t $FSTYP $TEST_OPTIONS $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS $* $TEST_DEV $TEST_DIR
 248 }
 249
 250 _scratch_mkfs_options()
 251 {
 252     _scratch_options mkfs
 253     echo $SCRATCH_OPTIONS $MKFS_OPTIONS $* $SCRATCH_DEV
 254 }
 255
 256 _scratch_mkfs_xfs()
 257 {
 258     # extra mkfs options can be added by tests
 259     local extra_mkfs_options=$*
 260
 261     local tmp_dir=/tmp/
 262
 263     _scratch_options mkfs
 264
 265     # save mkfs output in case conflict means we need to run again.
 266     # only the output for the mkfs that applies should be shown
 267     $MKFS_XFS_PROG $SCRATCH_OPTIONS $MKFS_OPTIONS $extra_mkfs_options $SCRATCH_DEV \
 268         2>$tmp_dir.mkfserr 1>$tmp_dir.mkfsstd
 269     local mkfs_status=$?
 270
 271     # a mkfs failure may be caused by conflicts between
 272     # $MKFS_OPTIONS and $extra_mkfs_options
 273
 274     if [ $mkfs_status -ne 0 -a ! -z "$extra_mkfs_options" ]; then
 275         echo "** mkfs failed with extra mkfs options added to \"$MKFS_OPTIONS\" by test $seq **" \
 276             >>$here/$seq.full
 277         echo "** attempting to mkfs using only test $seq options: $extra_mkfs_options **" \
 278             >>$here/$seq.full
 279         # running mkfs again. overwrite previous mkfs output files
 280         $MKFS_XFS_PROG $SCRATCH_OPTIONS $extra_mkfs_options $SCRATCH_DEV \
 281             2>$tmp_dir.mkfserr 1>$tmp_dir.mkfsstd
 282         mkfs_status=$?
 283     fi
 284
 285     # output stored mkfs output
 286     cat $tmp_dir.mkfserr >&2
 287     cat $tmp_dir.mkfsstd
 288     rm -f $tmp_dir.mkfserr $tmp_dir.mkfsstd
 289
 290     if [ "$USE_BIG_LOOPFS" = yes ]; then
 291         [ -z "$RETAIN_AG_BYTES" ] && RETAIN_AG_BYTES=0
 292         ./tools/ag-wipe -q -r $RETAIN_AG_BYTES $SCRATCH_DEV
 293     fi
 294
 295     return $mkfs_status
 296 }
 297
 298 _scratch_mkfs()
 299 {
 300     case $FSTYP in
 301     xfs)
 302         _scratch_mkfs_xfs $*
 303         ;;
 304     nfs*)
 305         # do nothing for nfs
 306         ;;
 307     udf)
 308         $MKFS_UDF_PROG $MKFS_OPTIONS $* $SCRATCH_DEV > /dev/null
 309         ;;
 310     *)
 311         /sbin/mkfs -t $FSTYP -- $MKFS_OPTIONS $* $SCRATCH_DEV
 312         ;;
 313     esac
 314 }
 315
 316 # Create fs of certain size on scratch device
 317 # _scratch_mkfs_sized <size in bytes> [optional blocksize]
 318 _scratch_mkfs_sized()
 319 {
 320     fssize=$1
 321     blocksize=$2
 322     [ -z "$blocksize" ] && blocksize=4096
 323     blocks=`expr $fssize / $blocksize`
 324
 325     case $FSTYP in
 326     xfs)
 327         _scratch_mkfs_xfs -d size=$fssize -b size=$blocksize
 328         ;;
 329     ext2|ext3|ext4)
 330         /sbin/mkfs.$FSTYP $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
 331         ;;
 332      btrfs)
 333         /sbin/mkfs.$FSTYP $MKFS_OPTIONS $SCRATCH_DEV -b $fssize
 334         ;;
 335     *)
 336         _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_sized"
 337         ;;
 338     esac
 339 }
 340
 341 # Emulate an N-data-disk stripe w/ various stripe units
 342 # _scratch_mkfs_geom <sunit bytes> <swidth multiplier> [optional blocksize]
 343 _scratch_mkfs_geom()
 344 {
 345     sunit_bytes=$1
 346     swidth_mult=$2
 347     blocksize=$3
 348     [ -z "$blocksize" ] && blocksize=4096
 349
 350     let sunit_blocks=$sunit_bytes/$blocksize
 351     let swidth_blocks=$sunit_blocks*$swidth_mult
 352
 353     case $FSTYP in
 354     xfs)
 355         MKFS_OPTIONS+=" -b size=$blocksize, -d su=$sunit_bytes,sw=$swidth_mult"
 356         ;;
 357     ext4)
 358         MKFS_OPTIONS+=" -b $blocksize -E stride=$sunit_blocks,stripe_width=$swidth_blocks"
 359         ;;
 360     *)
 361         _notrun "can't mkfs $FSTYP with geometry"
 362         ;;
 363     esac
 364     _scratch_mkfs
 365 }
 366
 367 _scratch_resvblks()
 368 {
 369         case $FSTYP in
 370         xfs)
 371                 xfs_io -x -c "resblks $1" $SCRATCH_MNT
 372                 ;;
 373         *)
 374                 ;;
 375         esac
 376 }
 377
 378 _scratch_xfs_db_options()
 379 {
 380     SCRATCH_OPTIONS=""
 381     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 382         SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
 383     echo $SCRATCH_OPTIONS $* $SCRATCH_DEV
 384 }
 385
 386 _scratch_xfs_logprint()
 387 {
 388     SCRATCH_OPTIONS=""
 389     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 390         SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
 391     $XFS_LOGPRINT_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
 392 }
 393
 394 _scratch_xfs_check()
 395 {
 396     SCRATCH_OPTIONS=""
 397     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 398         SCRATCH_OPTIONS="-l $SCRATCH_LOGDEV"
 399     $XFS_CHECK_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
 400 }
 401
 402 _scratch_xfs_repair()
 403 {
 404     SCRATCH_OPTIONS=""
 405     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 406         SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
 407     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
 408         SCRATCH_OPTIONS=$SCRATCH_OPTIONS" -r$SCRATCH_RTDEV"
 409     [ "$USE_BIG_LOOPFS" = yes ] && SCRATCH_OPTIONS=$SCRATCH_OPTIONS" -t"
 410     $XFS_REPAIR_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
 411 }
 412
 413 _get_pids_by_name()
 414 {
 415     if [ $# -ne 1 ]
 416     then
 417         echo "Usage: _get_pids_by_name process-name" 1>&2
 418         exit 1
 419     fi
 420
 421     # Algorithm ... all ps(1) variants have a time of the form MM:SS or
 422     # HH:MM:SS before the psargs field, use this as the search anchor.
 423     #
 424     # Matches with $1 (process-name) occur if the first psarg is $1
 425     # or ends in /$1 ... the matching uses sed's regular expressions,
 426     # so passing a regex into $1 will work.
 427
 428     ps $PS_ALL_FLAGS \
 429     | sed -n \
 430         -e 's/$/ /' \
 431         -e 's/[         ][      ]*/ /g' \
 432         -e 's/^ //' \
 433         -e 's/^[^ ]* //' \
 434         -e "/[0-9]:[0-9][0-9]  *[^ ]*\/$1 /s/ .*//p" \
 435         -e "/[0-9]:[0-9][0-9]  *$1 /s/ .*//p"
 436 }
 437
 438 # fix malloc libs output
 439 #
 440 _fix_malloc()
 441 {
 442     # filter out the Electric Fence notice
 443     $PERL_PROG -e '
 444         while (<>) {
 445             if (defined $o && /^\s+Electric Fence/) {
 446                 chomp($o);
 447                 print "$o";
 448                 undef $o;
 449                 next;
 450             }
 451             print $o if (defined $o);
 452
 453             $o=$_;
 454         }
 455         print $o if (defined $o);
 456     '
 457 }
 458
 459 # check if run as root
 460 #
 461 _need_to_be_root()
 462 {
 463     id=`id | $SED_PROG -e 's/(.*//' -e 's/.*=//'`
 464     if [ "$id" -ne 0 ]
 465     then
 466         echo "Arrgh ... you need to be root (not uid=$id) to run this test"
 467         exit 1
 468     fi
 469 }
 470
 471
 472 #
 473 # _df_device : get an IRIX style df line for a given device
 474 #
 475 #       - returns "" if not mounted
 476 #       - returns fs type in field two (ala IRIX)
 477 #       - joins line together if split by fancy df formatting
 478 #       - strips header etc
 479 #
 480
 481 _df_device()
 482 {
 483     if [ $# -ne 1 ]
 484     then
 485         echo "Usage: _df_device device" 1>&2
 486         exit 1
 487     fi
 488
 489     $DF_PROG 2>/dev/null | $AWK_PROG -v what=$1 '
 490         match($1,what) && NF==1 {
 491             v=$1
 492             getline
 493             print v, $0
 494             exit
 495         }
 496         match($1,what) {
 497             print
 498             exit
 499         }
 500     '
 501 }
 502
 503 #
 504 # _df_dir : get an IRIX style df line for device where a directory resides
 505 #
 506 #       - returns fs type in field two (ala IRIX)
 507 #       - joins line together if split by fancy df formatting
 508 #       - strips header etc
 509 #
 510
 511 _df_dir()
 512 {
 513     if [ $# -ne 1 ]
 514     then
 515         echo "Usage: _df_dir device" 1>&2
 516         exit 1
 517     fi
 518
 519     $DF_PROG $1 2>/dev/null | $AWK_PROG -v what=$1 '
 520         NR == 2 && NF==1 {
 521             v=$1
 522             getline
 523             print v, $0;
 524             exit 0
 525         }
 526         NR == 2 {
 527             print;
 528             exit 0
 529         }
 530         {}
 531     '
 532     # otherwise, nada
 533 }
 534
 535 # return percentage used disk space for mounted device
 536
 537 _used()
 538 {
 539     if [ $# -ne 1 ]
 540     then
 541         echo "Usage: _used device" 1>&2
 542         exit 1
 543     fi
 544
 545     _df_device $1 | $AWK_PROG '{ sub("%", "") ; print $6 }'
 546 }
 547
 548 # return the FS type of a mounted device
 549 #
 550 _fs_type()
 551 {
 552     if [ $# -ne 1 ]
 553     then
 554         echo "Usage: _fs_type device" 1>&2
 555         exit 1
 556     fi
 557
 558     _df_device $1 | $AWK_PROG '{ print $2 }'
 559 }
 560
 561 # return the FS mount options of a mounted device
 562 #
 563 # should write a version which just parses the output of mount for IRIX
 564 # compatibility, but since this isn't used at all, at the moment I'll leave
 565 # this for now
 566 #
 567 _fs_options()
 568 {
 569     if [ $# -ne 1 ]
 570     then
 571         echo "Usage: _fs_options device" 1>&2
 572         exit 1
 573     fi
 574
 575     $AWK_PROG -v dev=$1 '
 576         match($1,dev) { print $4 }
 577     ' </proc/mounts
 578 }
 579
 580 # returns device number if a file is a block device
 581 #
 582 _is_block_dev()
 583 {
 584     if [ $# -ne 1 ]
 585     then
 586         echo "Usage: _is_block_dev dev" 1>&2
 587         exit 1
 588     fi
 589
 590     [ -b $1 ] && src/lstat64 $1 | $AWK_PROG '/Device type:/ { print $9 }'
 591 }
 592
 593 # Do a command, log it to $seq.full, optionally test return status
 594 # and die if command fails. If called with one argument _do executes the
 595 # command, logs it, and returns its exit status. With two arguments _do
 596 # first prints the message passed in the first argument, and then "done"
 597 # or "fail" depending on the return status of the command passed in the
 598 # second argument. If the command fails and the variable _do_die_on_error
 599 # is set to "always" or the two argument form is used and _do_die_on_error
 600 # is set to "message_only" _do will print an error message to
 601 # $seq.out and exit.
 602
 603 _do()
 604 {
 605     if [ $# -eq 1 ]; then
 606         _cmd=$1
 607     elif [ $# -eq 2 ]; then
 608         _note=$1
 609         _cmd=$2
 610         echo -n "$_note... "
 611     else
 612         echo "Usage: _do [note] cmd" 1>&2
 613         status=1; exit
 614     fi
 615
 616     (eval "echo '---' \"$_cmd\"") >>$here/$seq.full
 617     (eval "$_cmd") >$tmp._out 2>&1; ret=$?
 618     cat $tmp._out | _fix_malloc >>$here/$seq.full
 619     if [ $# -eq 2 ]; then
 620         if [ $ret -eq 0 ]; then
 621             echo "done"
 622         else
 623             echo "fail"
 624         fi
 625     fi
 626     if [ $ret -ne 0  ] \
 627         && [ "$_do_die_on_error" = "always" \
 628             -o \( $# -eq 2 -a "$_do_die_on_error" = "message_only" \) ]
 629     then
 630         [ $# -ne 2 ] && echo
 631         eval "echo \"$_cmd\" failed \(returned $ret\): see $seq.full"
 632         status=1; exit
 633     fi
 634
 635     return $ret
 636 }
 637
 638 # bail out, setting up .notrun file
 639 #
 640 _notrun()
 641 {
 642     echo "$*" >$seq.notrun
 643     echo "$seq not run: $*"
 644     status=0
 645     exit
 646 }
 647
 648 # just plain bail out
 649 #
 650 _fail()
 651 {
 652     echo "$*" | tee -a $here/$seq.full
 653     echo "(see $seq.full for details)"
 654     status=1
 655     exit 1
 656 }
 657
 658 # tests whether $FSTYP is one of the supported filesystems for a test
 659 #
 660 _supported_fs()
 661 {
 662     for f
 663     do
 664         if [ "$f" = "$FSTYP" -o "$f" = "generic" ]
 665         then
 666             return
 667         fi
 668     done
 669
 670     _notrun "not suitable for this filesystem type: $FSTYP"
 671 }
 672
 673 # tests whether $FSTYP is one of the supported OSes for a test
 674 #
 675 _supported_os()
 676 {
 677     for h
 678     do
 679         if [ "$h" = "$HOSTOS" ]
 680         then
 681             return
 682         fi
 683     done
 684
 685     _notrun "not suitable for this OS: $HOSTOS"
 686 }
 687
 688 # this test needs a scratch partition - check we're ok & unmount it
 689 #
 690 _require_scratch()
 691 {
 692     case "$FSTYP" in
 693         nfs*)
 694                  echo $SCRATCH_DEV | grep -q ":" > /dev/null 2>&1
 695                  if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]
 696                  then
 697                      _notrun "this test requires a valid \$SCRATCH_DEV"
 698                  fi
 699                  ;;
 700         *)
 701                  if [ -z "$SCRATCH_DEV" -o "`_is_block_dev $SCRATCH_DEV`" = "" ]
 702                  then
 703                      _notrun "this test requires a valid \$SCRATCH_DEV"
 704                  fi
 705                  if [ "`_is_block_dev $SCRATCH_DEV`" = "`_is_block_dev $TEST_DEV`" ]
 706                  then
 707                      _notrun "this test requires a valid \$SCRATCH_DEV"
 708                  fi
 709                 if [ ! -d "$SCRATCH_MNT" ]
 710                 then
 711                      _notrun "this test requires a valid \$SCRATCH_MNT"
 712                 fi
 713                  ;;
 714     esac
 715
 716     # mounted?
 717     if _mount | grep -q $SCRATCH_DEV
 718     then
 719         # if it's mounted, make sure its on $SCRATCH_MNT
 720         if ! _mount | grep $SCRATCH_DEV | grep -q $SCRATCH_MNT
 721         then
 722             echo "\$SCRATCH_DEV is mounted but not on \$SCRATCH_MNT - aborting"
 723             exit 1
 724         fi
 725         # and then unmount it
 726         if ! $UMOUNT_PROG $SCRATCH_DEV
 727         then
 728             echo "failed to unmount $SCRATCH_DEV"
 729             exit 1
 730         fi
 731     fi
 732 }
 733
 734 # this test needs a logdev
 735 #
 736 _require_logdev()
 737 {
 738     [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && \
 739         _notrun "This test requires a valid \$SCRATCH_LOGDEV"
 740     [ "$USE_EXTERNAL" != yes ] && \
 741         _notrun "This test requires USE_EXTERNAL to be enabled"
 742
 743     # ensure its not mounted
 744     $UMOUNT_PROG $SCRATCH_LOGDEV 2>/dev/null
 745 }
 746
 747 # this test requires loopback device support
 748 #
 749 _require_loop()
 750 {
 751     if [ "$HOSTOS" != "Linux" ]
 752     then
 753         _notrun "This test requires linux for loopback device support"
 754     fi
 755
 756     modprobe loop >/dev/null 2>&1
 757     if grep loop /proc/devices >/dev/null 2>&1
 758     then
 759         :
 760     else
 761         _notrun "This test requires loopback device support"
 762     fi
 763 }
 764
 765 # this test requires that (large) loopback device files are not in use
 766 #
 767 _require_nobigloopfs()
 768 {
 769     [ "$USE_BIG_LOOPFS" = yes ] && \
 770         _notrun "Large filesystem testing in progress, skipped this test"
 771 }
 772
 773 # this test requires that a realtime subvolume is in use, and
 774 # that the kernel supports realtime as well.
 775 #
 776 _require_realtime()
 777 {
 778     [ "$USE_EXTERNAL" = yes ] || \
 779         _notrun "External volumes not in use, skipped this test"
 780     [ "$SCRATCH_RTDEV" = "" ] && \
 781         _notrun "Realtime device required, skipped this test"
 782 }
 783
 784 # this test requires that a specified command (executable) exists
 785 # $1 - command, $2 - name for error message
 786 #
 787 _require_command()
 788 {
 789     [ -n "$1" ] && _cmd="$1" || _cmd="$2"
 790     [ -n "$1" -a -x "$1" ] || _notrun "$_cmd utility required, skipped this test"
 791 }
 792
 793 # this test requires that external log/realtime devices are not in use
 794 #
 795 _require_nonexternal()
 796 {
 797     [ "$USE_EXTERNAL" = yes ] && \
 798         _notrun "External device testing in progress, skipped this test"
 799 }
 800
 801 # indicate whether YP/NIS is active or not
 802 #
 803 _yp_active()
 804 {
 805         local dn
 806         dn=$(domainname 2>/dev/null)
 807         test -n "${dn}" -a "${dn}" != "(none)"
 808         echo $?
 809 }
 810
 811 # cat the password file
 812 #
 813 _cat_passwd()
 814 {
 815         [ $(_yp_active) -eq 0 ] && ypcat passwd
 816         cat /etc/passwd
 817 }
 818
 819 # cat the group file
 820 #
 821 _cat_group()
 822 {
 823         [ $(_yp_active) -eq 0 ] && ypcat group
 824         cat /etc/group
 825 }
 826
 827 # check for the fsgqa user on the machine
 828 #
 829 _require_user()
 830 {
 831     qa_user=fsgqa
 832     _cat_passwd | grep -q $qa_user
 833     [ "$?" == "0" ] || _notrun "$qa_user user not defined."
 834 }
 835
 836 # check that xfs_io, glibc, kernel, and filesystem all (!) support
 837 # fallocate
 838 #
 839 _require_xfs_io_falloc()
 840 {
 841         testfile=$TEST_DIR/$$.falloc
 842         testio=`$XFS_IO_PROG -F -f -c "falloc 0 1m" $testfile 2>&1`
 843         rm -f $testfile 2>&1 > /dev/null
 844         echo $testio | grep -q "not found" && \
 845                 _notrun "xfs_io fallocate support is missing"
 846         echo $testio | grep -q "Operation not supported" && \
 847                 _notrun "xfs_io fallocate command failed (old kernel/wrong fs?)"
 848 }
 849
 850 # check that xfs_io, kernel and filesystem all support fallocate with hole
 851 # punching
 852 _require_xfs_io_falloc_punch()
 853 {
 854         testfile=$TEST_DIR/$$.falloc
 855         testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
 856                 -c "fpunch 4k 8k" $testfile 2>&1`
 857         rm -f $testfile 2>&1 > /dev/null
 858         echo $testio | grep -q "not found" && \
 859                 _notrun "xfs_io fallocate punch support is missing"
 860         echo $testio | grep -q "Operation not supported" && \
 861                 _notrun "xfs_io fallocate punch command failed (no fs support?)"
 862 }
 863
 864 # check that xfs_io, kernel and filesystem support fiemap
 865 _require_xfs_io_fiemap()
 866 {
 867         testfile=$TEST_DIR/$$.fiemap
 868         testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
 869                 -c "fiemap -v" $testfile 2>&1`
 870         rm -f $testfile 2>&1 > /dev/null
 871         echo $testio | grep -q "not found" && \
 872                 _notrun "xfs_io fiemap support is missing"
 873         echo $testio | grep -q "Operation not supported" && \
 874                 _notrun "xfs_io fiemap command failed (no fs support?)"
 875 }
 876
 877 # Check that a fs has enough free space (in 1024b blocks)
 878 #
 879 _require_fs_space()
 880 {
 881         MNT=$1
 882         BLOCKS=$2       # in units of 1024
 883         let GB=$BLOCKS/1024/1024
 884
 885         FREE_BLOCKS=`df -klP $MNT | grep -v Filesystem | awk '{print $4}'`
 886         [ $FREE_BLOCKS -lt $BLOCKS ] && \
 887                 _notrun "This test requires at least ${GB}GB free on $MNT to run"
 888 }
 889
 890 #
 891 # Check if the filesystem supports sparse files.
 892 #
 893 # Unfortunately there is no better way to do this than a manual black list.
 894 #
 895 _require_sparse_files()
 896 {
 897     case $FSTYP in
 898     hfsplus)
 899         _notrun "Sparse files not supported by this filesystem type: $FSTYP"
 900         ;;
 901     *)
 902         ;;
 903     esac
 904 }
 905
 906 # check that a FS on a device is mounted
 907 # if so, return mount point
 908 #
 909 _is_mounted()
 910 {
 911     if [ $# -ne 1 ]
 912     then
 913         echo "Usage: _is_mounted device" 1>&2
 914         exit 1
 915     fi
 916
 917     device=$1
 918
 919     if _mount | grep "$device " | $AWK_PROG -v pattern="type $FSTYP" '
 920         pattern        { print $3 ; exit 0 }
 921         END            { exit 1 }
 922     '
 923     then
 924         echo "_is_mounted: $device is not a mounted $FSTYP FS"
 925         exit 1
 926     fi
 927 }
 928
 929 # remount a FS to a new mode (ro or rw)
 930 #
 931 _remount()
 932 {
 933     if [ $# -ne 2 ]
 934     then
 935         echo "Usage: _remount device ro/rw" 1>&2
 936         exit 1
 937     fi
 938     device=$1
 939     mode=$2
 940
 941     if ! mount -o remount,$mode $device
 942     then
 943         echo "_remount: failed to remount filesystem on $device as $mode"
 944         exit 1
 945     fi
 946 }
 947
 948 # Run the appropriate repair/check on a filesystem
 949 #
 950 # if the filesystem is mounted, it's either remounted ro before being
 951 # checked or it's unmounted and then remounted
 952 #
 953
 954 # If set, we remount ro instead of unmounting for fsck
 955 USE_REMOUNT=0
 956
 957 _umount_or_remount_ro()
 958 {
 959     if [ $# -ne 1 ]
 960     then
 961         echo "Usage: _umount_or_remount_ro <device>" 1>&2
 962         exit 1
 963     fi
 964
 965     device=$1
 966     mountpoint=`_is_mounted $device`
 967
 968     if [ $USE_REMOUNT -eq 0 ]; then
 969         $UMOUNT_PROG $device
 970     else
 971         _remount $device ro
 972     fi
 973     echo "$mountpoint"
 974 }
 975
 976 _mount_or_remount_rw()
 977 {
 978     if [ $# -ne 3 ]
 979     then
 980         echo "Usage: _mount_or_remount_rw <opts> <device> <mountpoint>" 1>&2
 981         exit 1
 982     fi
 983     mount_opts=$1
 984     device=$2
 985     mountpoint=$3
 986
 987     if [ $USE_REMOUNT -eq 0 ]
 988     then
 989         if ! _mount -t $FSTYP $mount_opts $device $mountpoint
 990         then
 991             echo "!!! failed to remount $device on $mountpoint"
 992             return 0 # ok=0
 993         fi
 994     else
 995         _remount $device rw
 996     fi
 997
 998     return 1 # ok=1
 999 }
1000
1001 # Check a generic filesystem in no-op mode; this assumes that the
1002 # underlying fsck program accepts "-n" for a no-op (check-only) run,
1003 # and that it will still return an errno for corruption in this mode.
1004 #
1005 # Filesystems which don't support this will need to define their
1006 # own check routine.
1007 #
1008 _check_generic_filesystem()
1009 {
1010     device=$1
1011
1012     # If type is set, we're mounted
1013     type=`_fs_type $device`
1014     ok=1
1015
1016     if [ "$type" = "$FSTYP" ]
1017     then
1018         # mounted ...
1019         mountpoint=`_umount_or_remount_ro $device`
1020     fi
1021
1022     fsck -t $FSTYP $FSCK_OPTIONS $device >$tmp.fsck 2>&1
1023     if [ $? -ne 0 ]
1024     then
1025         echo "_check_generic_filesystem: filesystem on $device is inconsistent (see $seq.full)"
1026
1027         echo "_check_generic filesystem: filesystem on $device is inconsistent" >>$here/$seq.full
1028         echo "*** fsck.$FSTYP output ***"                     >>$here/$seq.full
1029         cat $tmp.fsck                                         >>$here/$seq.full
1030         echo "*** end fsck.$FSTYP output"                     >>$here/$seq.full
1031
1032         ok=0
1033     fi
1034     rm -f $tmp.fsck
1035
1036     if [ $ok -eq 0 ]
1037     then
1038         echo "*** mount output ***"                             >>$here/$seq.full
1039         _mount                                                  >>$here/$seq.full
1040         echo "*** end mount output"                             >>$here/$seq.full
1041     elif [ "$type" = "$FSTYP" ]
1042     then
1043         # was mounted ...
1044         _mount_or_remount_rw "$MOUNT_OPTIONS" $device $mountpoint
1045         ok=$?
1046     fi
1047
1048     if [ $ok -eq 0 ]; then
1049         status=1
1050         exit 1
1051     fi
1052
1053     return 0
1054 }
1055
1056 # run xfs_check and friends on a FS.
1057
1058 _check_xfs_filesystem()
1059 {
1060     if [ $# -ne 3 ]
1061     then
1062         echo "Usage: _check_xfs_filesystem device <logdev>|none <rtdev>|none" 1>&2
1063         exit 1
1064     fi
1065
1066     extra_mount_options=""
1067     device=$1
1068     if [ "$2" != "none" ]; then
1069         extra_log_options="-l$2"
1070         extra_mount_options="-ologdev=$2"
1071     fi
1072
1073     if [ "$3" != "none" ]; then
1074         extra_rt_options="-r$3"
1075         extra_mount_options=$extra_mount_options" -ortdev=$3"
1076     fi
1077     extra_mount_options=$extra_mount_options" $MOUNT_OPTIONS"
1078
1079     [ "$FSTYP" != xfs ] && return 0
1080     testoption=""
1081     [ "$USE_BIG_LOOPFS" = yes ] && testoption=-t
1082
1083     type=`_fs_type $device`
1084     ok=1
1085
1086     if [ "$type" = "xfs" ]
1087     then
1088         # mounted ...
1089         mountpoint=`_umount_or_remount_ro $device`
1090     fi
1091
1092     $XFS_LOGPRINT_PROG -t $extra_log_options $device 2>&1 \
1093                 | tee $tmp.logprint | grep -q "<CLEAN>"
1094     if [ $? -ne 0 -a "$HOSTOS" = "Linux" ]
1095     then
1096         echo "_check_xfs_filesystem: filesystem on $device has dirty log (see $seq.full)"
1097
1098         echo "_check_xfs_filesystem: filesystem on $device has dirty log"   >>$here/$seq.full
1099         echo "*** xfs_logprint -t output ***"                   >>$here/$seq.full
1100         cat $tmp.logprint                                       >>$here/$seq.full
1101         echo "*** end xfs_logprint output"                      >>$here/$seq.full
1102
1103         ok=0
1104     fi
1105
1106     $XFS_CHECK_PROG $testoption $extra_log_options $device 2>&1 |\
1107          _fix_malloc >$tmp.fs_check
1108     if [ -s $tmp.fs_check ]
1109     then
1110         echo "_check_xfs_filesystem: filesystem on $device is inconsistent (c) (see $seq.full)"
1111
1112         echo "_check_xfs_filesystem: filesystem on $device is inconsistent" >>$here/$seq.full
1113         echo "*** xfs_check output ***"                         >>$here/$seq.full
1114         cat $tmp.fs_check                                       >>$here/$seq.full
1115         echo "*** end xfs_check output"                         >>$here/$seq.full
1116
1117         ok=0
1118     fi
1119     # repair doesn't scale massively at this stage, optionally skip it for now
1120     [ "$USE_BIG_LOOPFS" = yes ] || \
1121     $XFS_REPAIR_PROG -n $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
1122     if [ $? -ne 0 ]
1123     then
1124         echo "_check_xfs_filesystem: filesystem on $device is inconsistent (r) (see $seq.full)"
1125
1126         echo "_check_xfs_filesystem: filesystem on $device is inconsistent" >>$here/$seq.full
1127         echo "*** xfs_repair -n output ***"                     >>$here/$seq.full
1128         cat $tmp.repair | _fix_malloc                           >>$here/$seq.full
1129         echo "*** end xfs_repair output"                        >>$here/$seq.full
1130
1131         ok=0
1132     fi
1133     rm -f $tmp.fs_check $tmp.logprint $tmp.repair
1134
1135     if [ $ok -eq 0 ]
1136     then
1137         echo "*** mount output ***"                             >>$here/$seq.full
1138         _mount                                                  >>$here/$seq.full
1139         echo "*** end mount output"                             >>$here/$seq.full
1140     elif [ "$type" = "xfs" ]
1141     then
1142         _mount_or_remount_rw "$extra_mount_options" $device $mountpoint
1143     fi
1144
1145     if [ $ok -eq 0 ]; then
1146         status=1
1147         exit 1
1148     fi
1149
1150     return 0
1151 }
1152
1153 # Filter the knowen errors the UDF Verifier reports.
1154 _udf_test_known_error_filter()
1155 {
1156         egrep -v "PVD  60  Error: Interchange Level: 1, Maximum Interchange Level: 0|FSD  28  Error: Interchange Level: 1, Maximum Interchange Level: 1,|PVD  72  Warning: Volume Set Identifier: \"\*IRIX UDF\",|Warning: [0-9]+ unused blocks NOT marked as unallocated."
1157
1158 }
1159
1160 _check_udf_filesystem()
1161 {
1162     [ "$DISABLE_UDF_TEST" == "1" ] && return
1163
1164     if [ $# -ne 1 -a $# -ne 2 ]
1165     then
1166         echo "Usage: _check_udf_filesystem device [last_block]" 1>&2
1167         exit 1
1168     fi
1169
1170     if [ ! -x $here/src/udf_test ]
1171     then
1172         echo "udf_test not installed, please download and build the Philips"
1173         echo "UDF Verification Software from http://www.extra.research.philips.com/udf/."
1174         echo "Then copy the udf_test binary to $here/src/."
1175         echo "If you do not wish to run udf_test then set environment variable DISABLE_UDF_TEST"
1176         echo "to 1."
1177         return
1178     fi
1179
1180     device=$1
1181     if [ $# -eq 2 ];
1182     then
1183         LAST_BLOCK=`expr \( $2 - 1 \)`
1184         OPT_ARG="-lastvalidblock $LAST_BLOCK"
1185     fi
1186
1187     rm -f $seq.checkfs
1188     sleep 1 # Due to a problem with time stamps in udf_test
1189     $here/src/udf_test $OPT_ARG $device | tee $here/$seq.checkfs | egrep "Error|Warning" | \
1190         _udf_test_known_error_filter | \
1191         egrep -iv "Error count:.*[0-9]+.*total occurrences:.*[0-9]+|Warning count:.*[0-9]+.*total occurrences:.*[0-9]+" | \
1192         sed "s/^.*$/Warning UDF Verifier reported errors see $seq.checkfs./g"
1193
1194 }
1195
1196 _check_xfs_test_fs()
1197 {
1198     TEST_LOG="none"
1199     TEST_RT="none"
1200     [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
1201         TEST_LOG="$TEST_LOGDEV"
1202
1203     [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ] && \
1204         TEST_RT="$TEST_RTDEV"
1205
1206     _check_xfs_filesystem $TEST_DEV $TEST_LOG $TEST_RT
1207
1208     # check for ipath consistency
1209     if $XFS_GROWFS_PROG -n $TEST_DIR | grep -q 'inode-paths=1'; then
1210         # errors go to stderr
1211         xfs_check_ipaths $TEST_DIR >/dev/null
1212         xfs_repair_ipaths -n $TEST_DIR >/dev/null
1213     fi
1214 }
1215
1216 _check_test_fs()
1217 {
1218     case $FSTYP in
1219     xfs)
1220         _check_xfs_test_fs
1221         ;;
1222     nfs)
1223         # no way to check consistency for nfs
1224         ;;
1225     udf)
1226         # do nothing for now
1227         ;;
1228     *)
1229         _check_generic_filesystem $TEST_DEV
1230         ;;
1231     esac
1232 }
1233
1234 _check_scratch_fs()
1235 {
1236     case $FSTYP in
1237     xfs)
1238         SCRATCH_LOG="none"
1239         SCRATCH_RT="none"
1240         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
1241             SCRATCH_LOG="$SCRATCH_LOGDEV"
1242
1243         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
1244             SCRATCH_RT="$SCRATCH_RTDEV"
1245
1246         _check_xfs_filesystem $SCRATCH_DEV $SCRATCH_LOG $SCRATCH_RT
1247         ;;
1248     udf)
1249         _check_udf_filesystem $SCRATCH_DEV $udf_fsize
1250         ;;
1251     nfs*)
1252         # Don't know how to check an NFS filesystem, yet.
1253         ;;
1254     *)
1255         _check_generic_filesystem $SCRATCH_DEV
1256         ;;
1257     esac
1258 }
1259
1260 _full_fstyp_details()
1261 {
1262      [ -z "$FSTYP" ] && FSTYP=xfs
1263      if [ $FSTYP = xfs ]; then
1264         if [ -d /proc/fs/xfs ]; then
1265             if grep -q 'debug 0' /proc/fs/xfs/stat; then
1266                 FSTYP="$FSTYP (non-debug)"
1267             elif grep -q 'debug 1' /proc/fs/xfs/stat; then
1268                 FSTYP="$FSTYP (debug)"
1269             fi
1270         else
1271             if uname -a | grep -qi 'debug'; then
1272                 FSTYP="$FSTYP (debug)"
1273             else
1274                 FSTYP="$FSTYP (non-debug)"
1275             fi
1276         fi
1277      fi
1278      echo $FSTYP
1279 }
1280
1281 _full_platform_details()
1282 {
1283      os=`uname -s`
1284      host=`hostname -s`
1285      kernel=`uname -r`
1286      platform=`uname -m`
1287      echo "$os/$platform $host $kernel"
1288 }
1289
1290 _setup_udf_scratchdir()
1291 {
1292     [ "$FSTYP" != "udf" ] \
1293         && _fail "setup_udf_testdir: \$FSTYP is not udf"
1294     [ -z "$SCRATCH_DEV" -o ! -b "$SCRATCH_DEV" ] \
1295         && _notrun "this test requires a valid \$SCRATCH_DEV"
1296     [ -z "$SCRATCH_MNT" ] \
1297         && _notrun "this test requires a valid \$SCRATCH_MNT"
1298
1299     # mounted?
1300     if _mount | grep -q $SCRATCH_DEV
1301     then
1302         # if it's mounted, make sure its on $TEST_RW_DIR
1303         if ! _mount | grep $SCRATCH_DEV | grep -q $SCRATCH_MNT
1304         then
1305             _fail "\$SCRATCH_DEV is mounted but not on \$SCRATCH_MNT - aborting"
1306         fi
1307         $UMOUNT_PROG $SCRATCH_DEV
1308     fi
1309
1310     _scratch_mkfs
1311     _scratch_mount
1312
1313     testdir=$SCRATCH_MNT
1314 }
1315
1316 _setup_nfs_scratchdir()
1317 {
1318     [ "$FSTYP" != "nfs" ] \
1319         && _fail "setup_nfs_testdir: \$FSTYP is not nfs"
1320     [ -z "$SCRATCH_DEV" ] \
1321         && _notrun "this test requires a valid host fs for \$SCRATCH_DEV"
1322     [ -z "$SCRATCH_MNT" ] \
1323         && _notrun "this test requires a valid \$SCRATCH_MNT"
1324
1325     # mounted?
1326     if _mount | grep -q $SCRATCH_DEV
1327     then
1328         # if it's mounted, make sure its on $SCRATCH_MNT
1329         if ! _mount | grep $SCRATCH_DEV | grep -q $SCRATCH_MNT
1330         then
1331             _fail "\$SCRATCH_DEV is mounted but not on \$SCRATCH_MNT - aborting"
1332         fi
1333         $UMOUNT_PROG $SCRATCH_DEV
1334     fi
1335
1336     _scratch_mkfs
1337     _scratch_mount
1338
1339     testdir=$SCRATCH_MNT
1340 }
1341
1342 #
1343 # Warning for UDF and NFS:
1344 # this function calls _setup_udf_scratchdir and _setup_udf_scratchdir
1345 # which actually uses the scratch dir for the test dir.
1346 #
1347 # This was done because testdir was intended to be a persistent
1348 # XFS only partition.  This should eventually change, and treat
1349 # at least local filesystems all the same.
1350 #
1351 _setup_testdir()
1352 {
1353     case $FSTYP in
1354     udf)
1355         _setup_udf_scratchdir
1356         ;;
1357     nfs*)
1358         _setup_nfs_scratchdir
1359         ;;
1360     *)
1361         testdir=$TEST_DIR
1362         ;;
1363     esac
1364 }
1365
1366 _cleanup_testdir()
1367 {
1368     case $FSTYP in
1369     udf)
1370         # umount testdir as it is $SCRATCH_MNT which could be used by xfs next
1371         [ -n "$testdir" ] && $UMOUNT_PROG $testdir
1372         ;;
1373     nfs*)
1374         # umount testdir as it is $SCRATCH_MNT which could be used by xfs next
1375         [ -n "$testdir" ] && $UMOUNT_PROG $testdir
1376         ;;
1377     *)
1378         # do nothing, testdir is $TEST_DIR
1379         :
1380         ;;
1381     esac
1382 }
1383
1384 _link_out_file()
1385 {
1386    if [ -z "$1" ]; then
1387       echo Error must pass \$seq.
1388       exit
1389    fi
1390    rm -f $1
1391    if [ "`uname`" == "IRIX64" ] || [ "`uname`" == "IRIX" ]; then
1392       ln -s $1.irix $1
1393    elif [ "`uname`" == "Linux" ]; then
1394       ln -s $1.linux $1
1395    else
1396       echo Error test $seq does not run on the operating system: `uname`
1397       exit
1398    fi
1399 }
1400
1401 _die()
1402 {
1403         echo $@
1404         exit 1
1405 }
1406
1407 _nfiles()
1408 {
1409         f=0
1410         while [ $f -lt $1 ]
1411         do
1412                 file=f$f
1413                 echo > $file
1414                 if [ $size -gt 0 ]; then
1415                     dd if=/dev/zero of=$file bs=1024 count=$size
1416                 fi
1417                 let f=$f+1
1418         done
1419 }
1420
1421 # takes dirname, depth
1422 _descend()
1423 {
1424         dirname=$1; depth=$2
1425         mkdir $dirname  || die "mkdir $dirname failed"
1426         cd $dirname
1427
1428         _nfiles $files           # files for this dir
1429
1430         [ $depth -eq 0 ] && return
1431         let deep=$depth-1 # go 1 down
1432
1433         [ $verbose = true ] && echo "descending, depth from leaves = $deep"
1434
1435         d=0
1436         while [ $d -lt $dirs ]
1437         do
1438                 _descend d$d $deep &
1439                 let d=$d+1
1440                 wait
1441         done
1442 }
1443
1444 # Populate a filesystem with inodes for performance experiments
1445 #
1446 # usage: populate [-v] [-n ndirs] [-f nfiles] [-d depth] [-r root] [-s size]
1447 #
1448 _populate_fs()
1449 {
1450     here=`pwd`
1451     dirs=5          # ndirs in each subdir till leaves
1452     size=0          # sizeof files in K
1453     files=100       # num files in _each_ subdir
1454     depth=2         # depth of tree from root to leaves
1455     verbose=false
1456     root=root       # path of initial root of directory tree
1457
1458     while getopts "d:f:n:r:s:v" c
1459     do
1460         case $c in
1461         d)      depth=$OPTARG;;
1462         n)      dirs=$OPTARG;;
1463         f)      files=$OPTARG;;
1464         s)      size=$OPTARG;;
1465         v)      verbose=true;;
1466         r)      root=$OPTARG;;
1467         esac
1468     done
1469
1470     _descend $root $depth
1471     wait
1472
1473     cd $here
1474
1475     [ $verbose = true ] && echo done
1476 }
1477
1478 # query whether the given file has the given inode flag set
1479 #
1480 _test_inode_flag()
1481 {
1482     flag=$1
1483     file=$2
1484
1485     if which $XFS_IO_PROG >/dev/null; then
1486         if $XFS_IO_PROG -r -c 'lsattr -v' "$file" | grep -q "$flag" ; then
1487             return 0
1488         fi
1489     fi
1490     return 1
1491 }
1492
1493 # query the given files extsize allocator hint in bytes (if any)
1494 #
1495 _test_inode_extsz()
1496 {
1497     file=$1
1498     blocks=""
1499
1500     if which $XFS_IO_PROG >/dev/null; then
1501         blocks=`$XFS_IO_PROG -r -c 'stat' "$file" | \
1502                 awk '/^xattr.extsize =/ { print $3 }'`
1503     fi
1504     [ -z "$blocks" ] && blocks="0"
1505     echo $blocks
1506 }
1507
1508
1509 ################################################################################
1510
1511 if [ "$iam" != new -a "$iam" != bench ]
1512 then
1513     # make some further configuration checks here
1514
1515     if [ "$TEST_DEV" = ""  ]
1516     then
1517         echo "common.rc: Error: \$TEST_DEV is not set"
1518         exit 1
1519     fi
1520
1521     # if $TEST_DEV is not mounted, mount it now as XFS
1522     if [ -z "`_fs_type $TEST_DEV`" ]
1523     then
1524         # $TEST_DEV is not mounted
1525         if ! _test_mount
1526         then
1527             echo "common.rc: retrying test device mount with external set"
1528             [ "$USE_EXTERNAL" != "yes" ] && export USE_EXTERNAL=yes
1529             if ! _test_mount
1530             then
1531                 echo "common.rc: could not mount $TEST_DEV on $TEST_DIR"
1532                 exit 1
1533             fi
1534         fi
1535     fi
1536
1537     if [ "`_fs_type $TEST_DEV`" != "$FSTYP" ]
1538     then
1539         echo "common.rc: Error: \$TEST_DEV ($TEST_DEV) is not a MOUNTED $FSTYP filesystem"
1540         $DF_PROG $TEST_DEV
1541         exit 1
1542     fi
1543 fi
1544
1545 # make sure this script returns success
1546 /bin/true