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 BC=$(which bc 2> /dev/null) || BC=
  24
  25 # Valid test names start with 3 digits "NNN":
  26 #  "[0-9]\{3\}"
  27 # followed by an optional "-":
  28 #  "-\?"
  29 # followed by an optional combination of alphanumeric and "-" chars:
  30 #  "[[:alnum:]-]*"
  31 # e.g. 999-the-mark-of-fstests
  32 #
  33 VALID_TEST_ID="[0-9]\{3\}"
  34 VALID_TEST_NAME="$VALID_TEST_ID-\?[[:alnum:]-]*"
  35
  36 _require_math()
  37 {
  38         if [ -z "$BC" ]; then
  39                 _notrun "this test requires 'bc' tool for doing math operations"
  40         fi
  41 }
  42
  43 _math()
  44 {
  45         [ $# -le 0 ] && return
  46         if [ "$BC" ]; then
  47                 result=$(LANG=C echo "scale=0; $@" | "$BC" -q 2> /dev/null)
  48         else
  49                 _notrun "this test requires 'bc' tool for doing math operations"
  50         fi
  51         echo "$result"
  52 }
  53
  54 dd()
  55 {
  56    if [ "$HOSTOS" == "Linux" ]
  57    then
  58         command dd --help 2>&1 | grep noxfer >/dev/null
  59
  60         if [ "$?" -eq 0 ]
  61             then
  62                 command dd status=noxfer $@
  63             else
  64                 command dd $@
  65         fi
  66    else
  67         command dd $@
  68    fi
  69 }
  70
  71 # Prints the md5 checksum of a given file
  72 _md5_checksum()
  73 {
  74         md5sum $1 | cut -d ' ' -f1
  75 }
  76
  77 # Write a byte into a range of a file
  78 _pwrite_byte() {
  79         pattern="$1"
  80         offset="$2"
  81         len="$3"
  82         file="$4"
  83         xfs_io_args="$5"
  84
  85         $XFS_IO_PROG $xfs_io_args -f -c "pwrite -S $pattern $offset $len" "$file"
  86 }
  87
  88 # mmap-write a byte into a range of a file
  89 _mwrite_byte() {
  90         pattern="$1"
  91         offset="$2"
  92         len="$3"
  93         mmap_len="$4"
  94         file="$5"
  95
  96         $XFS_IO_PROG -f -c "mmap -rw 0 $mmap_len" -c "mwrite -S $pattern $offset $len" "$file"
  97 }
  98
  99 # ls -l w/ selinux sometimes puts a dot at the end:
 100 # -rwxrw-r--. id1 id2 file1
 101 # Also filter out lost+found directory on extN file system if present
 102
 103 _ls_l()
 104 {
 105         ls -l $* | sed "s/\(^[-rwxdlbcpsStT]*\)\. /\1 /" | grep -v 'lost+found'
 106 }
 107
 108 # we need common/config
 109 if [ "$iam" != "check" ]
 110 then
 111     if ! . ./common/config
 112         then
 113         echo "$iam: failed to source common/config"
 114         exit 1
 115     fi
 116 fi
 117
 118 _dump_err()
 119 {
 120     err_msg="$*"
 121     echo "$err_msg"
 122 }
 123
 124 _dump_err2()
 125 {
 126     err_msg="$*"
 127     >2& echo "$err_msg"
 128 }
 129
 130 _log_err()
 131 {
 132     err_msg="$*"
 133     echo "$err_msg" | tee -a $seqres.full
 134     echo "(see $seqres.full for details)"
 135 }
 136
 137 # make sure we have a standard umask
 138 umask 022
 139
 140 # check for correct setup and source the $FSTYP specific functions now
 141 case "$FSTYP" in
 142     xfs)
 143          [ "$XFS_LOGPRINT_PROG" = "" ] && _fatal "xfs_logprint not found"
 144          [ "$XFS_REPAIR_PROG" = "" ] && _fatal "xfs_repair not found"
 145          [ "$XFS_DB_PROG" = "" ] && _fatal "xfs_db not found"
 146          [ "$MKFS_XFS_PROG" = "" ] && _fatal "mkfs_xfs not found"
 147
 148          . ./common/xfs
 149          ;;
 150     udf)
 151          [ "$MKFS_UDF_PROG" = "" ] && _fatal "mkfs_udf/mkudffs not found"
 152          ;;
 153     btrfs)
 154          [ "$MKFS_BTRFS_PROG" = "" ] && _fatal "mkfs.btrfs not found"
 155
 156          . ./common/btrfs
 157          ;;
 158     ext4)
 159          [ "$MKFS_EXT4_PROG" = "" ] && _fatal "mkfs.ext4 not found"
 160          ;;
 161     f2fs)
 162          [ "$MKFS_F2FS_PROG" = "" ] && _fatal "mkfs.f2fs not found"
 163          ;;
 164     nfs)
 165          . ./common/nfs
 166          ;;
 167     cifs)
 168          ;;
 169     ceph)
 170          ;;
 171     glusterfs)
 172          ;;
 173     overlay)
 174          ;;
 175     reiser4)
 176          [ "$MKFS_REISER4_PROG" = "" ] && _fatal "mkfs.reiser4 not found"
 177          ;;
 178     pvfs2)
 179         ;;
 180     ubifs)
 181         [ "$UBIUPDATEVOL_PROG" = "" ] && _fatal "ubiupdatevol not found"
 182         ;;
 183 esac
 184
 185 if [ ! -z "$REPORT_LIST" ]; then
 186         . ./common/report
 187         _assert_report_list
 188 fi
 189
 190 _mount()
 191 {
 192     $MOUNT_PROG `_mount_ops_filter $*`
 193 }
 194
 195 # Call _mount to do mount operation but also save mountpoint to
 196 # MOUNTED_POINT_STACK. Note that the mount point must be the last parameter
 197 _get_mount()
 198 {
 199         local mnt_point=${!#}
 200
 201         _mount $*
 202         if [ $? -eq 0 ]; then
 203                 MOUNTED_POINT_STACK="$mnt_point $MOUNTED_POINT_STACK"
 204         else
 205                 return 1
 206         fi
 207 }
 208
 209 # Unmount the last mounted mountpoint in MOUNTED_POINT_STACK
 210 # and return it to caller
 211 _put_mount()
 212 {
 213         local last_mnt=`echo $MOUNTED_POINT_STACK | awk '{print $1}'`
 214
 215         if [ -n "$last_mnt" ]; then
 216                 $UMOUNT_PROG $last_mnt
 217         fi
 218         MOUNTED_POINT_STACK=`echo $MOUNTED_POINT_STACK | cut -d\  -f2-`
 219 }
 220
 221 # Unmount all mountpoints in MOUNTED_POINT_STACK and clear the stack
 222 _clear_mount_stack()
 223 {
 224         if [ -n "$MOUNTED_POINT_STACK" ]; then
 225                 $UMOUNT_PROG $MOUNTED_POINT_STACK
 226         fi
 227         MOUNTED_POINT_STACK=""
 228 }
 229
 230 _scratch_options()
 231 {
 232     type=$1
 233     SCRATCH_OPTIONS=""
 234
 235     if [ "$FSTYP" != "xfs" ]; then
 236         return
 237     fi
 238
 239     case $type in
 240     mkfs)
 241         SCRATCH_OPTIONS="$SCRATCH_OPTIONS -f"
 242         rt_opt="-r"
 243         log_opt="-l"
 244         ;;
 245     mount)
 246         rt_opt="-o"
 247         log_opt="-o"
 248         ;;
 249     esac
 250     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
 251         SCRATCH_OPTIONS="$SCRATCH_OPTIONS ${rt_opt}rtdev=$SCRATCH_RTDEV"
 252     [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 253         SCRATCH_OPTIONS="$SCRATCH_OPTIONS ${log_opt}logdev=$SCRATCH_LOGDEV"
 254 }
 255
 256 _test_options()
 257 {
 258     type=$1
 259     TEST_OPTIONS=""
 260
 261     if [ "$FSTYP" != "xfs" ]; then
 262         return
 263     fi
 264
 265     case $type in
 266     mkfs)
 267         rt_opt="-r"
 268         log_opt="-l"
 269         ;;
 270     mount)
 271         rt_opt="-o"
 272         log_opt="-o"
 273         ;;
 274     esac
 275     [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ] && \
 276         TEST_OPTIONS="$TEST_OPTIONS ${rt_opt}rtdev=$TEST_RTDEV"
 277     [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
 278         TEST_OPTIONS="$TEST_OPTIONS ${log_opt}logdev=$TEST_LOGDEV"
 279 }
 280
 281 _mount_ops_filter()
 282 {
 283     params="$*"
 284
 285     #get mount point to handle dmapi mtpt option correctly
 286     let last_index=$#-1
 287     [ $last_index -gt 0 ] && shift $last_index
 288     FS_ESCAPED=$1
 289
 290     echo $params | sed -e 's/dmapi/dmi/' \
 291         | $PERL_PROG -ne "s#mtpt=[^,|^\n|^\s]*#mtpt=$FS_ESCAPED\1\2#; print;"
 292
 293 }
 294
 295 # Used for mounting non-scratch devices (e.g. loop, dm constructs)
 296 # with the safe set of scratch mount options (e.g. loop image may be
 297 # hosted on $SCRATCH_DEV, so can't use external scratch devices).
 298 _common_dev_mount_options()
 299 {
 300         echo $MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS $*
 301 }
 302
 303 _overlay_basic_mount_options()
 304 {
 305         echo "-o lowerdir=$1/$OVL_LOWER,upperdir=$1/$OVL_UPPER,workdir=$1/$OVL_WORK"
 306 }
 307
 308 _overlay_mount_options()
 309 {
 310         echo `_common_dev_mount_options` \
 311              `_overlay_basic_mount_options $1` \
 312              $OVERLAY_MOUNT_OPTIONS
 313 }
 314
 315 _scratch_mount_options()
 316 {
 317         _scratch_options mount
 318
 319         if [ "$FSTYP" == "overlay" ]; then
 320                 echo `_overlay_mount_options $OVL_BASE_SCRATCH_MNT`
 321                 return 0
 322         fi
 323         echo `_common_dev_mount_options $*` $SCRATCH_OPTIONS \
 324                                         $SCRATCH_DEV $SCRATCH_MNT
 325 }
 326
 327 _supports_filetype()
 328 {
 329         local dir=$1
 330
 331         local fstyp=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $2}'`
 332         case "$fstyp" in
 333         xfs)
 334                 xfs_info $dir | grep -q "ftype=1"
 335                 ;;
 336         ext2|ext3|ext4)
 337                 local dev=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $1}'`
 338                 tune2fs -l $dev | grep -q filetype
 339                 ;;
 340         *)
 341                 local testfile=$dir/$$.ftype
 342                 touch $testfile
 343                 # look for DT_UNKNOWN files
 344                 local unknowns=$(src/t_dir_type $dir u | wc -l)
 345                 rm $testfile
 346                 # 0 unknowns is success
 347                 return $unknowns
 348                 ;;
 349         esac
 350 }
 351
 352 # helper function to do the actual overlayfs mount operation
 353 _overlay_mount_dirs()
 354 {
 355         local lowerdir=$1
 356         local upperdir=$2
 357         local workdir=$3
 358         shift 3
 359
 360         $MOUNT_PROG -t overlay -o lowerdir=$lowerdir -o upperdir=$upperdir \
 361                     -o workdir=$workdir $*
 362 }
 363
 364 _overlay_mkdirs()
 365 {
 366         local dir=$1
 367
 368         mkdir -p $dir/$OVL_UPPER
 369         mkdir -p $dir/$OVL_LOWER
 370         mkdir -p $dir/$OVL_WORK
 371         mkdir -p $dir/$OVL_MNT
 372 }
 373
 374 # Given a base fs dir, set up overlay directories and mount on the given mnt.
 375 # The dir is used as the mount device so it can be seen from df or mount
 376 _overlay_mount()
 377 {
 378         local dir=$1
 379         local mnt=$2
 380         shift 2
 381
 382         _supports_filetype $dir || _notrun "upper fs needs to support d_type"
 383
 384         _overlay_mkdirs $dir
 385
 386         _overlay_mount_dirs $dir/$OVL_LOWER $dir/$OVL_UPPER \
 387                             $dir/$OVL_WORK $OVERLAY_MOUNT_OPTIONS \
 388                             $SELINUX_MOUNT_OPTIONS $* $dir $mnt
 389 }
 390
 391 _overlay_base_test_mount()
 392 {
 393         if [ -z "$OVL_BASE_TEST_DEV" -o -z "$OVL_BASE_TEST_DIR" ] || \
 394                 _check_mounted_on OVL_BASE_TEST_DEV $OVL_BASE_TEST_DEV \
 395                                 OVL_BASE_TEST_DIR $OVL_BASE_TEST_DIR
 396         then
 397                 # no base fs or already mounted
 398                 return 0
 399         elif [ $? -ne 1 ]
 400         then
 401                 # base fs mounted but not on mount point
 402                 return 1
 403         fi
 404
 405         _mount $TEST_FS_MOUNT_OPTS \
 406                 $SELINUX_MOUNT_OPTIONS \
 407                 $OVL_BASE_TEST_DEV $OVL_BASE_TEST_DIR
 408 }
 409
 410 _overlay_test_mount()
 411 {
 412         _overlay_base_test_mount && \
 413                 _overlay_mount $OVL_BASE_TEST_DIR $TEST_DIR $*
 414 }
 415
 416 _overlay_base_scratch_mount()
 417 {
 418         if [ -z "$OVL_BASE_SCRATCH_DEV" -o -z "$OVL_BASE_SCRATCH_MNT" ] || \
 419                 _check_mounted_on OVL_BASE_SCRATCH_DEV $OVL_BASE_SCRATCH_DEV \
 420                                 OVL_BASE_SCRATCH_MNT $OVL_BASE_SCRATCH_MNT
 421         then
 422                 # no base fs or already mounted
 423                 return 0
 424         elif [ $? -ne 1 ]
 425         then
 426                 # base fs mounted but not on mount point
 427                 return 1
 428         fi
 429
 430         _mount $OVL_BASE_MOUNT_OPTIONS \
 431                 $SELINUX_MOUNT_OPTIONS \
 432                 $OVL_BASE_SCRATCH_DEV $OVL_BASE_SCRATCH_MNT
 433 }
 434
 435 _overlay_base_scratch_unmount()
 436 {
 437         [ -n "$OVL_BASE_SCRATCH_DEV" -a -n "$OVL_BASE_SCRATCH_MNT" ] || return 0
 438
 439         $UMOUNT_PROG $OVL_BASE_SCRATCH_MNT
 440 }
 441
 442 _overlay_scratch_mount()
 443 {
 444         _overlay_base_scratch_mount && \
 445                 _overlay_mount $OVL_BASE_SCRATCH_MNT $SCRATCH_MNT $*
 446 }
 447
 448 _overlay_base_test_unmount()
 449 {
 450         [ -n "$OVL_BASE_TEST_DEV" -a -n "$OVL_BASE_TEST_DIR" ] || return 0
 451
 452         $UMOUNT_PROG $OVL_BASE_TEST_DIR
 453 }
 454
 455 _overlay_test_unmount()
 456 {
 457         $UMOUNT_PROG $TEST_DIR
 458         _overlay_base_test_unmount
 459 }
 460
 461 _overlay_scratch_unmount()
 462 {
 463         $UMOUNT_PROG $SCRATCH_MNT
 464         _overlay_base_scratch_unmount
 465 }
 466
 467 _scratch_mount()
 468 {
 469     if [ "$FSTYP" == "overlay" ]; then
 470         _overlay_scratch_mount $*
 471         return $?
 472     fi
 473     _mount -t $FSTYP `_scratch_mount_options $*`
 474 }
 475
 476 _scratch_unmount()
 477 {
 478         case "$FSTYP" in
 479         overlay)
 480                 _overlay_scratch_unmount
 481                 ;;
 482         btrfs)
 483                 $UMOUNT_PROG $SCRATCH_MNT
 484                 ;;
 485         *)
 486                 $UMOUNT_PROG $SCRATCH_DEV
 487                 ;;
 488         esac
 489 }
 490
 491 _scratch_remount()
 492 {
 493     local opts="$1"
 494
 495     if test -n "$opts"; then
 496         mount -o "remount,$opts" $SCRATCH_MNT
 497     fi
 498 }
 499
 500 _scratch_cycle_mount()
 501 {
 502     local opts="$1"
 503
 504     if [ "$FSTYP" = tmpfs ]; then
 505         _scratch_remount "$opts"
 506         return
 507     fi
 508     if test -n "$opts"; then
 509         opts="-o $opts"
 510     fi
 511     _scratch_unmount
 512     _scratch_mount "$opts"
 513 }
 514
 515 _test_mount()
 516 {
 517     if [ "$FSTYP" == "overlay" ]; then
 518         _overlay_test_mount $*
 519         return $?
 520     fi
 521     _test_options mount
 522     _mount -t $FSTYP $TEST_OPTIONS $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS $* $TEST_DEV $TEST_DIR
 523 }
 524
 525 _test_unmount()
 526 {
 527         if [ "$FSTYP" == "overlay" ]; then
 528                 _overlay_test_unmount
 529         else
 530                 $UMOUNT_PROG $TEST_DEV
 531         fi
 532 }
 533
 534 _test_cycle_mount()
 535 {
 536     if [ "$FSTYP" = tmpfs ]; then
 537         return
 538     fi
 539     _test_unmount
 540     _test_mount
 541 }
 542
 543 _scratch_mkfs_options()
 544 {
 545     _scratch_options mkfs
 546     echo $SCRATCH_OPTIONS $MKFS_OPTIONS $* $SCRATCH_DEV
 547 }
 548
 549 # Do the actual mkfs work on SCRATCH_DEV. Firstly mkfs with both MKFS_OPTIONS
 550 # and user specified mkfs options, if that fails (due to conflicts between mkfs
 551 # options), do a second mkfs with only user provided mkfs options.
 552 #
 553 # First param is the mkfs command without any mkfs options and device.
 554 # Second param is the filter to remove unnecessary messages from mkfs stderr.
 555 # Other extra mkfs options are followed.
 556 _scratch_do_mkfs()
 557 {
 558         local mkfs_cmd=$1
 559         local mkfs_filter=$2
 560         shift 2
 561         local extra_mkfs_options=$*
 562         local mkfs_status
 563         local tmp=`mktemp -u`
 564
 565         # save mkfs output in case conflict means we need to run again.
 566         # only the output for the mkfs that applies should be shown
 567         eval "$mkfs_cmd $MKFS_OPTIONS $extra_mkfs_options $SCRATCH_DEV" \
 568                 2>$tmp.mkfserr 1>$tmp.mkfsstd
 569         mkfs_status=$?
 570
 571         # a mkfs failure may be caused by conflicts between $MKFS_OPTIONS and
 572         # $extra_mkfs_options
 573         if [ $mkfs_status -ne 0 -a -n "$extra_mkfs_options" ]; then
 574                 (
 575                 echo -n "** mkfs failed with extra mkfs options "
 576                 echo "added to \"$MKFS_OPTIONS\" by test $seq **"
 577                 echo -n "** attempting to mkfs using only test $seq "
 578                 echo "options: $extra_mkfs_options **"
 579                 ) >> $seqres.full
 580
 581                 # running mkfs again. overwrite previous mkfs output files
 582                 eval "$mkfs_cmd $extra_mkfs_options $SCRATCH_DEV" \
 583                         2>$tmp.mkfserr 1>$tmp.mkfsstd
 584                 mkfs_status=$?
 585         fi
 586
 587         # output stored mkfs output, filtering unnecessary output from stderr
 588         cat $tmp.mkfsstd
 589         eval "cat $tmp.mkfserr | $mkfs_filter" >&2
 590
 591         rm -f $tmp.mkfserr $tmp.mkfsstd
 592         return $mkfs_status
 593 }
 594
 595 _scratch_metadump()
 596 {
 597         dumpfile=$1
 598         shift
 599         options=
 600
 601         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 602                 options="-l $SCRATCH_LOGDEV"
 603
 604         xfs_metadump $options "$@" $SCRATCH_DEV $dumpfile
 605 }
 606
 607 _setup_large_ext4_fs()
 608 {
 609         fs_size=$1
 610         local tmp_dir=/tmp/
 611
 612         [ "$LARGE_SCRATCH_DEV" != yes ] && return 0
 613         [ -z "$SCRATCH_DEV_EMPTY_SPACE" ] && SCRATCH_DEV_EMPTY_SPACE=0
 614         [ $SCRATCH_DEV_EMPTY_SPACE -ge $fs_size ] && return 0
 615
 616         # Default free space in the FS is 50GB, but you can specify more via
 617         # SCRATCH_DEV_EMPTY_SPACE
 618         space_to_consume=$(($fs_size - 50*1024*1024*1024 - $SCRATCH_DEV_EMPTY_SPACE))
 619
 620         # mount the filesystem and create 16TB - 4KB files until we consume
 621         # all the necessary space.
 622         _scratch_mount 2>&1 >$tmp_dir/mnt.err
 623         local status=$?
 624         if [ $status -ne 0 ]; then
 625                 echo "mount failed"
 626                 cat $tmp_dir/mnt.err >&2
 627                 rm -f $tmp_dir/mnt.err
 628                 return $status
 629         fi
 630         rm -f $tmp_dir/mnt.err
 631
 632         file_size=$((16*1024*1024*1024*1024 - 4096))
 633         nfiles=0
 634         while [ $space_to_consume -gt $file_size ]; do
 635
 636                 xfs_io -F -f \
 637                         -c "truncate $file_size" \
 638                         -c "falloc -k 0 $file_size" \
 639                         $SCRATCH_MNT/.use_space.$nfiles 2>&1
 640                 status=$?
 641                 if [ $status -ne 0 ]; then
 642                         break;
 643                 fi
 644
 645                 space_to_consume=$(( $space_to_consume - $file_size ))
 646                 nfiles=$(($nfiles + 1))
 647         done
 648
 649         # consume the remaining space.
 650         if [ $space_to_consume -gt 0 ]; then
 651                 xfs_io -F -f \
 652                         -c "truncate $space_to_consume" \
 653                         -c "falloc -k 0 $space_to_consume" \
 654                         $SCRATCH_MNT/.use_space.$nfiles 2>&1
 655                 status=$?
 656         fi
 657         export NUM_SPACE_FILES=$nfiles
 658
 659         _scratch_unmount
 660         if [ $status -ne 0 ]; then
 661                 echo "large file prealloc failed"
 662                 cat $tmp_dir/mnt.err >&2
 663                 return $status
 664         fi
 665         return 0
 666 }
 667
 668 _scratch_mkfs_ext4()
 669 {
 670         local mkfs_cmd="$MKFS_EXT4_PROG -F"
 671         local mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
 672         local tmp=`mktemp -u`
 673         local mkfs_status
 674
 675         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 676             $mkfs_cmd -O journal_dev $MKFS_OPTIONS $SCRATCH_LOGDEV && \
 677             mkfs_cmd="$mkfs_cmd -J device=$SCRATCH_LOGDEV"
 678
 679         _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
 680         mkfs_status=$?
 681
 682         if [ $mkfs_status -eq 0 -a "$LARGE_SCRATCH_DEV" = yes ]; then
 683                 # manually parse the mkfs output to get the fs size in bytes
 684                 fs_size=`cat $tmp.mkfsstd | awk ' \
 685                         /^Block size/ { split($2, a, "="); bs = a[2] ; } \
 686                         / inodes, / { blks = $3 } \
 687                         /reserved for the super user/ { resv = $1 } \
 688                         END { fssize = bs * blks - resv; print fssize }'`
 689
 690                 _setup_large_ext4_fs $fs_size
 691                 mkfs_status=$?
 692         fi
 693
 694         # output mkfs stdout and stderr
 695         cat $tmp.mkfsstd
 696         cat $tmp.mkfserr >&2
 697         rm -f $tmp.mkfserr $tmp.mkfsstd
 698
 699         return $mkfs_status
 700 }
 701
 702 _test_mkfs()
 703 {
 704     case $FSTYP in
 705     nfs*)
 706         # do nothing for nfs
 707         ;;
 708     cifs)
 709         # do nothing for cifs
 710         ;;
 711     ceph)
 712         # do nothing for ceph
 713         ;;
 714     glusterfs)
 715         # do nothing for glusterfs
 716         ;;
 717     overlay)
 718         # do nothing for overlay
 719         ;;
 720     pvfs2)
 721         # do nothing for pvfs2
 722         ;;
 723     udf)
 724         $MKFS_UDF_PROG $MKFS_OPTIONS $* $TEST_DEV > /dev/null
 725         ;;
 726     btrfs)
 727         $MKFS_BTRFS_PROG $MKFS_OPTIONS $* $TEST_DEV > /dev/null
 728         ;;
 729     ext2|ext3|ext4)
 730         $MKFS_PROG -t $FSTYP -- -F $MKFS_OPTIONS $* $TEST_DEV
 731         ;;
 732     *)
 733         yes | $MKFS_PROG -t $FSTYP -- $MKFS_OPTIONS $* $TEST_DEV
 734         ;;
 735     esac
 736 }
 737
 738 _mkfs_dev()
 739 {
 740     local tmp=`mktemp -u`
 741     case $FSTYP in
 742     nfs*)
 743         # do nothing for nfs
 744         ;;
 745     overlay)
 746         # do nothing for overlay
 747         ;;
 748     pvfs2)
 749         # do nothing for pvfs2
 750         ;;
 751     udf)
 752         $MKFS_UDF_PROG $MKFS_OPTIONS $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
 753         ;;
 754     btrfs)
 755         $MKFS_BTRFS_PROG $MKFS_OPTIONS $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
 756         ;;
 757     ext2|ext3|ext4)
 758         $MKFS_PROG -t $FSTYP -- -F $MKFS_OPTIONS $* \
 759                 2>$tmp.mkfserr 1>$tmp.mkfsstd
 760         ;;
 761
 762     *)
 763         yes | $MKFS_PROG -t $FSTYP -- $MKFS_OPTIONS $* \
 764                 2>$tmp.mkfserr 1>$tmp.mkfsstd
 765         ;;
 766     esac
 767
 768     if [ $? -ne 0 ]; then
 769         # output stored mkfs output
 770         cat $tmp.mkfserr >&2
 771         cat $tmp.mkfsstd
 772         status=1
 773         exit 1
 774     fi
 775     rm -f $tmp.mkfserr $tmp.mkfsstd
 776 }
 777
 778 # remove all files in $SCRATCH_MNT, useful when testing on NFS/CIFS
 779 _scratch_cleanup_files()
 780 {
 781         case $FSTYP in
 782         overlay)
 783                 # Avoid rm -rf /* if we messed up
 784                 [ -n "$OVL_BASE_SCRATCH_MNT" ] || return 1
 785                 _overlay_base_scratch_mount || return 1
 786                 rm -rf $OVL_BASE_SCRATCH_MNT/* || return 1
 787                 _overlay_mkdirs $OVL_BASE_SCRATCH_MNT
 788                 # leave base fs mouted so tests can setup lower/upper dir files
 789                 ;;
 790         *)
 791                 [ -n "$SCRATCH_MNT" ] || return 1
 792                 _scratch_mount
 793                 rm -rf $SCRATCH_MNT/*
 794                 _scratch_unmount
 795                 ;;
 796         esac
 797 }
 798
 799 _scratch_mkfs()
 800 {
 801         local mkfs_cmd=""
 802         local mkfs_filter=""
 803         local mkfs_status
 804
 805         case $FSTYP in
 806         nfs*|cifs|ceph|overlay|glusterfs|pvfs2)
 807                 # unable to re-create this fstyp, just remove all files in
 808                 # $SCRATCH_MNT to avoid EEXIST caused by the leftover files
 809                 # created in previous runs
 810                 _scratch_cleanup_files
 811                 return $?
 812                 ;;
 813         tmpfs)
 814                 # do nothing for tmpfs
 815                 return 0
 816                 ;;
 817         ubifs)
 818                 # erase the UBI volume; reformated automatically on next mount
 819                 $UBIUPDATEVOL_PROG ${SCRATCH_DEV} -t
 820                 return 0
 821                 ;;
 822         ext4)
 823                 _scratch_mkfs_ext4 $*
 824                 return $?
 825                 ;;
 826         xfs)
 827                 _scratch_mkfs_xfs $*
 828                 return $?
 829                 ;;
 830         udf)
 831                 mkfs_cmd="$MKFS_UDF_PROG"
 832                 mkfs_filter="cat"
 833                 ;;
 834         btrfs)
 835                 mkfs_cmd="$MKFS_BTRFS_PROG"
 836                 mkfs_filter="cat"
 837                 ;;
 838         ext3)
 839                 mkfs_cmd="$MKFS_PROG -t $FSTYP -- -F"
 840                 mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
 841
 842                 # put journal on separate device?
 843                 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
 844                 $mkfs_cmd -O journal_dev $MKFS_OPTIONS $SCRATCH_LOGDEV && \
 845                 mkfs_cmd="$mkfs_cmd -J device=$SCRATCH_LOGDEV"
 846                 ;;
 847         ext2)
 848                 mkfs_cmd="$MKFS_PROG -t $FSTYP -- -F"
 849                 mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
 850                 ;;
 851         f2fs)
 852                 mkfs_cmd="$MKFS_F2FS_PROG"
 853                 mkfs_filter="cat"
 854                 ;;
 855         ocfs2)
 856                 mkfs_cmd="yes | $MKFS_PROG -t $FSTYP --"
 857                 mkfs_filter="grep -v -e ^mkfs\.ocfs2"
 858                 ;;
 859         *)
 860                 mkfs_cmd="yes | $MKFS_PROG -t $FSTYP --"
 861                 mkfs_filter="cat"
 862                 ;;
 863         esac
 864
 865         _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $*
 866         return $?
 867 }
 868
 869 # Helper function to get a spare or replace-target device from
 870 # configured SCRATCH_DEV_POLL, must call _scratch_dev_pool_get()
 871 # before _spare_dev_get(). Replace-target-device/Spare-device will
 872 # be assigned to SPARE_DEV.
 873 # As of now only one replace-target-device/spare-device can be
 874 # assigned.
 875 #
 876 # Usage:
 877 #  _scratch_dev_pool_get() <ndevs>
 878 #     _spare_dev_get()
 879 #     :: do stuff
 880 #     _spare_dev_put()
 881 #  _scratch_dev_pool_put()
 882 #
 883 _spare_dev_get()
 884 {
 885         typeset -p SCRATCH_DEV_POOL_SAVED >/dev/null 2>&1
 886         if [ $? -ne 0 ]; then
 887                 _fail "Bug: unset val, must call _scratch_dev_pool_get before _spare_dev_get"
 888         fi
 889
 890         if [ -z "$SCRATCH_DEV_POOL_SAVED" ]; then
 891                 _fail "Bug: str empty, must call _scratch_dev_pool_get before _spare_dev_get"
 892         fi
 893
 894         # Check if the spare is already assigned
 895         typeset -p SPARE_DEV >/dev/null 2>&1
 896         if [ $? -eq 0 ]; then
 897                 if [ ! -z "$SPARE_DEV" ]; then
 898                         _fail "Bug: SPARE_DEV = $SPARE_DEV already assigned"
 899                 fi
 900         fi
 901
 902         local ndevs=`echo $SCRATCH_DEV_POOL| wc -w`
 903         local config_ndevs=`echo $SCRATCH_DEV_POOL_SAVED| wc -w`
 904
 905         if [ $ndevs -eq $config_ndevs ]; then
 906                 _notrun "All devs used no spare"
 907         fi
 908         # Get a dev that is not used
 909         local -a devs="( $SCRATCH_DEV_POOL_SAVED )"
 910         SPARE_DEV=${devs[@]:$ndevs:1}
 911         export SPARE_DEV
 912 }
 913
 914 _spare_dev_put()
 915 {
 916         typeset -p SPARE_DEV >/dev/null 2>&1
 917         if [ $? -ne 0 ]; then
 918                 _fail "Bug: unset val, must call _spare_dev_get before its put"
 919         fi
 920
 921         if [ -z "$SPARE_DEV" ]; then
 922                 _fail "Bug: str empty, must call _spare_dev_get before its put"
 923         fi
 924
 925         export SPARE_DEV=""
 926 }
 927
 928 #
 929 # Generally test cases will have..
 930 #   _require_scratch_dev_pool X
 931 # to make sure it has the enough scratch devices including
 932 # replace-target and spare device. Now arg1 here is the
 933 # required number of scratch devices by a-test-case excluding
 934 # the replace-target and spare device. So this function will
 935 # set SCRATCH_DEV_POOL to the specified number of devices.
 936 #
 937 # Usage:
 938 #  _scratch_dev_pool_get() <ndevs>
 939 #     :: do stuff
 940 #
 941 #  _scratch_dev_pool_put()
 942 #
 943 _scratch_dev_pool_get()
 944 {
 945         if [ $# -ne 1 ]; then
 946                 _fail "Usage: _scratch_dev_pool_get ndevs"
 947         fi
 948
 949         local test_ndevs=$1
 950         local config_ndevs=`echo $SCRATCH_DEV_POOL| wc -w`
 951         local -a devs="( $SCRATCH_DEV_POOL )"
 952
 953         typeset -p config_ndevs >/dev/null 2>&1
 954         if [ $? -ne 0 ]; then
 955                 _fail "Bug: cant find SCRATCH_DEV_POOL ndevs"
 956         fi
 957
 958         if [ $config_ndevs -lt $test_ndevs ]; then
 959                 _notrun "Need at least test requested number of ndevs $test_ndevs"
 960         fi
 961
 962         SCRATCH_DEV_POOL_SAVED=${SCRATCH_DEV_POOL}
 963         export SCRATCH_DEV_POOL_SAVED
 964         SCRATCH_DEV_POOL=${devs[@]:0:$test_ndevs}
 965         export SCRATCH_DEV_POOL
 966 }
 967
 968 _scratch_dev_pool_put()
 969 {
 970         typeset -p SCRATCH_DEV_POOL_SAVED >/dev/null 2>&1
 971         if [ $? -ne 0 ]; then
 972                 _fail "Bug: unset val, must call _scratch_dev_pool_get before _scratch_dev_pool_put"
 973         fi
 974
 975         if [ -z "$SCRATCH_DEV_POOL_SAVED" ]; then
 976                 _fail "Bug: str empty, must call _scratch_dev_pool_get before _scratch_dev_pool_put"
 977         fi
 978
 979         export SCRATCH_DEV_POOL=$SCRATCH_DEV_POOL_SAVED
 980         export SCRATCH_DEV_POOL_SAVED=""
 981 }
 982
 983 _scratch_pool_mkfs()
 984 {
 985     case $FSTYP in
 986     btrfs)
 987         # if dup profile is in mkfs options call _scratch_mkfs instead
 988         # because dup profile only works with single device
 989         if [[ "$*" =~ dup ]]; then
 990             _scratch_mkfs $*
 991         else
 992             $MKFS_BTRFS_PROG $MKFS_OPTIONS $* $SCRATCH_DEV_POOL > /dev/null
 993         fi
 994         ;;
 995     *)
 996         echo "_scratch_pool_mkfs is not implemented for $FSTYP" 1>&2
 997         ;;
 998     esac
 999 }
1000
1001 # Return the amount of free memory available on the system
1002 _free_memory_bytes()
1003 {
1004     free -b | grep ^Mem | awk '{print $4}'
1005 }
1006
1007 # Create fs of certain size on scratch device
1008 # _scratch_mkfs_sized <size in bytes> [optional blocksize]
1009 _scratch_mkfs_sized()
1010 {
1011     fssize=$1
1012     blocksize=$2
1013
1014     case $FSTYP in
1015     xfs)
1016         def_blksz=`echo $MKFS_OPTIONS|sed -rn 's/.*-b ?size= ?+([0-9]+).*/\1/p'`
1017         ;;
1018     ext2|ext3|ext4|ext4dev|udf|btrfs|reiser4|ocfs2|reiserfs)
1019         def_blksz=`echo $MKFS_OPTIONS| sed -rn 's/.*-b ?+([0-9]+).*/\1/p'`
1020         ;;
1021     jfs)
1022         def_blksz=4096
1023         ;;
1024     esac
1025
1026     [ -n "$def_blksz" ] && blocksize=$def_blksz
1027     [ -z "$blocksize" ] && blocksize=4096
1028
1029
1030     re='^[0-9]+$'
1031     if ! [[ $fssize =~ $re ]] ; then
1032         _notrun "error: _scratch_mkfs_sized: fs size \"$fssize\" not an integer."
1033     fi
1034     if ! [[ $blocksize =~ $re ]] ; then
1035         _notrun "error: _scratch_mkfs_sized: block size \"$blocksize\" not an integer."
1036     fi
1037
1038     blocks=`expr $fssize / $blocksize`
1039
1040     if [ "$HOSTOS" == "Linux" -a -b "$SCRATCH_DEV" ]; then
1041         devsize=`blockdev --getsize64 $SCRATCH_DEV`
1042         [ "$fssize" -gt "$devsize" ] && _notrun "Scratch device too small"
1043     fi
1044
1045     case $FSTYP in
1046     xfs)
1047         # don't override MKFS_OPTIONS that set a block size.
1048         echo $MKFS_OPTIONS |egrep -q "b?size="
1049         if [ $? -eq 0 ]; then
1050                 _scratch_mkfs_xfs -d size=$fssize
1051         else
1052                 _scratch_mkfs_xfs -d size=$fssize -b size=$blocksize
1053         fi
1054         ;;
1055     ext2|ext3|ext4|ext4dev)
1056         ${MKFS_PROG}.$FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1057         ;;
1058     ocfs2)
1059         yes | ${MKFS_PROG}.$FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1060         ;;
1061     udf)
1062         $MKFS_UDF_PROG $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1063         ;;
1064     btrfs)
1065         local mixed_opt=
1066         (( fssize <= 100 * 1024 * 1024 )) && mixed_opt='--mixed'
1067         $MKFS_BTRFS_PROG $MKFS_OPTIONS $mixed_opt -b $fssize $SCRATCH_DEV
1068         ;;
1069     jfs)
1070         ${MKFS_PROG}.$FSTYP $MKFS_OPTIONS $SCRATCH_DEV $blocks
1071         ;;
1072     reiserfs)
1073         ${MKFS_PROG}.$FSTYP $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1074         ;;
1075     reiser4)
1076         # mkfs.resier4 requires size in KB as input for creating filesystem
1077         $MKFS_REISER4_PROG $MKFS_OPTIONS -y -b $blocksize $SCRATCH_DEV \
1078                            `expr $fssize / 1024`
1079         ;;
1080     f2fs)
1081         # mkfs.f2fs requires # of sectors as an input for the size
1082         sector_size=`blockdev --getss $SCRATCH_DEV`
1083         $MKFS_F2FS_PROG $MKFS_OPTIONS $SCRATCH_DEV `expr $fssize / $sector_size`
1084         ;;
1085     tmpfs)
1086         free_mem=`_free_memory_bytes`
1087         if [ "$free_mem" -lt "$fssize" ] ; then
1088            _notrun "Not enough memory ($free_mem) for tmpfs with $fssize bytes"
1089         fi
1090         export MOUNT_OPTIONS="-o size=$fssize $TMPFS_MOUNT_OPTIONS"
1091         ;;
1092     *)
1093         _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_sized"
1094         ;;
1095     esac
1096 }
1097
1098 # Emulate an N-data-disk stripe w/ various stripe units
1099 # _scratch_mkfs_geom <sunit bytes> <swidth multiplier> [optional blocksize]
1100 _scratch_mkfs_geom()
1101 {
1102     sunit_bytes=$1
1103     swidth_mult=$2
1104     blocksize=$3
1105     [ -z "$blocksize" ] && blocksize=4096
1106
1107     let sunit_blocks=$sunit_bytes/$blocksize
1108     let swidth_blocks=$sunit_blocks*$swidth_mult
1109
1110     case $FSTYP in
1111     xfs)
1112         MKFS_OPTIONS+=" -b size=$blocksize, -d su=$sunit_bytes,sw=$swidth_mult"
1113         ;;
1114     ext4|ext4dev)
1115         MKFS_OPTIONS+=" -b $blocksize -E stride=$sunit_blocks,stripe_width=$swidth_blocks"
1116         ;;
1117     *)
1118         _notrun "can't mkfs $FSTYP with geometry"
1119         ;;
1120     esac
1121     _scratch_mkfs
1122 }
1123
1124 # Create fs of certain blocksize on scratch device
1125 # _scratch_mkfs_blocksized blocksize
1126 _scratch_mkfs_blocksized()
1127 {
1128     blocksize=$1
1129
1130     re='^[0-9]+$'
1131     if ! [[ $blocksize =~ $re ]] ; then
1132         _notrun "error: _scratch_mkfs_sized: block size \"$blocksize\" not an integer."
1133     fi
1134
1135     case $FSTYP in
1136     xfs)
1137         _scratch_mkfs_xfs $MKFS_OPTIONS -b size=$blocksize
1138         ;;
1139     ext2|ext3|ext4)
1140         ${MKFS_PROG}.$FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV
1141         ;;
1142     ocfs2)
1143         yes | ${MKFS_PROG}.$FSTYP -F $MKFS_OPTIONS -b $blocksize -C $blocksize $SCRATCH_DEV
1144         ;;
1145     *)
1146         _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_blocksized"
1147         ;;
1148     esac
1149 }
1150
1151 _scratch_resvblks()
1152 {
1153         case $FSTYP in
1154         xfs)
1155                 xfs_io -x -c "resblks $1" $SCRATCH_MNT
1156                 ;;
1157         *)
1158                 ;;
1159         esac
1160 }
1161
1162
1163 # Repair scratch filesystem.  Returns 0 if the FS is good to go (either no
1164 # errors found or errors were fixed) and nonzero otherwise; also spits out
1165 # a complaint on stderr if fsck didn't tell us that the FS is good to go.
1166 _repair_scratch_fs()
1167 {
1168     case $FSTYP in
1169     xfs)
1170         _scratch_xfs_repair "$@" 2>&1
1171         res=$?
1172         if [ "$res" -ne 0 ]; then
1173                 echo "xfs_repair returns $res; replay log?"
1174                 _scratch_mount
1175                 res=$?
1176                 if [ "$res" -gt 0 ]; then
1177                         echo "mount returns $res; zap log?"
1178                         _scratch_xfs_repair -L 2>&1
1179                         echo "log zap returns $?"
1180                 else
1181                         umount "$SCRATCH_MNT"
1182                 fi
1183                 _scratch_xfs_repair "$@" 2>&1
1184                 res=$?
1185         fi
1186         if [ $res -ne 0 ]; then
1187                 _dump_err2 "xfs_repair failed, err=$res"
1188         fi
1189         return $res
1190         ;;
1191     *)
1192         # Let's hope fsck -y suffices...
1193         fsck -t $FSTYP -y $SCRATCH_DEV 2>&1
1194         res=$?
1195         case $res in
1196         0|1|2)
1197                 res=0
1198                 ;;
1199         *)
1200                 _dump_err2 "fsck.$FSTYP failed, err=$res"
1201                 ;;
1202         esac
1203         return $res
1204         ;;
1205     esac
1206 }
1207
1208 _get_pids_by_name()
1209 {
1210     if [ $# -ne 1 ]
1211     then
1212         echo "Usage: _get_pids_by_name process-name" 1>&2
1213         exit 1
1214     fi
1215
1216     # Algorithm ... all ps(1) variants have a time of the form MM:SS or
1217     # HH:MM:SS before the psargs field, use this as the search anchor.
1218     #
1219     # Matches with $1 (process-name) occur if the first psarg is $1
1220     # or ends in /$1 ... the matching uses sed's regular expressions,
1221     # so passing a regex into $1 will work.
1222
1223     ps $PS_ALL_FLAGS \
1224     | sed -n \
1225         -e 's/$/ /' \
1226         -e 's/[         ][      ]*/ /g' \
1227         -e 's/^ //' \
1228         -e 's/^[^ ]* //' \
1229         -e "/[0-9]:[0-9][0-9]  *[^ ]*\/$1 /s/ .*//p" \
1230         -e "/[0-9]:[0-9][0-9]  *$1 /s/ .*//p"
1231 }
1232
1233 # fix malloc libs output
1234 #
1235 _fix_malloc()
1236 {
1237     # filter out the Electric Fence notice
1238     $PERL_PROG -e '
1239         while (<>) {
1240             if (defined $o && /^\s+Electric Fence/) {
1241                 chomp($o);
1242                 print "$o";
1243                 undef $o;
1244                 next;
1245             }
1246             print $o if (defined $o);
1247
1248             $o=$_;
1249         }
1250         print $o if (defined $o);
1251     '
1252 }
1253
1254 #
1255 # _df_device : get an IRIX style df line for a given device
1256 #
1257 #       - returns "" if not mounted
1258 #       - returns fs type in field two (ala IRIX)
1259 #       - joins line together if split by fancy df formatting
1260 #       - strips header etc
1261 #
1262
1263 _df_device()
1264 {
1265     if [ $# -ne 1 ]
1266     then
1267         echo "Usage: _df_device device" 1>&2
1268         exit 1
1269     fi
1270
1271     # Note that we use "==" here so awk doesn't try to interpret an NFS over
1272     # IPv6 server as a regular expression.
1273     $DF_PROG 2>/dev/null | $AWK_PROG -v what=$1 '
1274         ($1==what) && (NF==1) {
1275             v=$1
1276             getline
1277             print v, $0
1278             exit
1279         }
1280         ($1==what) {
1281             print
1282             exit
1283         }
1284     '
1285 }
1286
1287 #
1288 # _df_dir : get an IRIX style df line for device where a directory resides
1289 #
1290 #       - returns fs type in field two (ala IRIX)
1291 #       - joins line together if split by fancy df formatting
1292 #       - strips header etc
1293 #
1294
1295 _df_dir()
1296 {
1297     if [ $# -ne 1 ]
1298     then
1299         echo "Usage: _df_dir device" 1>&2
1300         exit 1
1301     fi
1302
1303     $DF_PROG $1 2>/dev/null | $AWK_PROG -v what=$1 '
1304         NR == 2 && NF==1 {
1305             v=$1
1306             getline
1307             print v, $0;
1308             exit 0
1309         }
1310         NR == 2 {
1311             print;
1312             exit 0
1313         }
1314         {}
1315     '
1316     # otherwise, nada
1317 }
1318
1319 # return percentage used disk space for mounted device
1320
1321 _used()
1322 {
1323     if [ $# -ne 1 ]
1324     then
1325         echo "Usage: _used device" 1>&2
1326         exit 1
1327     fi
1328
1329     _df_device $1 | $AWK_PROG '{ sub("%", "") ; print $6 }'
1330 }
1331
1332 # return the FS type of a mounted device
1333 #
1334 _fs_type()
1335 {
1336     if [ $# -ne 1 ]
1337     then
1338         echo "Usage: _fs_type device" 1>&2
1339         exit 1
1340     fi
1341
1342     #
1343     # The Linux kernel shows NFSv4 filesystems in df output as
1344     # filesystem type nfs4, although we mounted it as nfs earlier.
1345     # Fix the filesystem type up here so that the callers don't
1346     # have to bother with this quirk.
1347     #
1348     _df_device $1 | $AWK_PROG '{ print $2 }' | \
1349         sed -e 's/nfs4/nfs/' -e 's/fuse.glusterfs/glusterfs/'
1350 }
1351
1352 # return the FS mount options of a mounted device
1353 #
1354 # should write a version which just parses the output of mount for IRIX
1355 # compatibility, but since this isn't used at all, at the moment I'll leave
1356 # this for now
1357 #
1358 _fs_options()
1359 {
1360     if [ $# -ne 1 ]
1361     then
1362         echo "Usage: _fs_options device" 1>&2
1363         exit 1
1364     fi
1365
1366     $AWK_PROG -v dev=$1 '
1367         match($1,dev) { print $4 }
1368     ' </proc/mounts
1369 }
1370
1371 # returns device number if a file is a block device
1372 #
1373 _is_block_dev()
1374 {
1375     if [ $# -ne 1 ]
1376     then
1377         echo "Usage: _is_block_dev dev" 1>&2
1378         exit 1
1379     fi
1380
1381     _dev=$1
1382     if [ -L "${_dev}" ]; then
1383         _dev=`readlink -f "${_dev}"`
1384     fi
1385
1386     if [ -b "${_dev}" ]; then
1387         src/lstat64 "${_dev}" | $AWK_PROG '/Device type:/ { print $9 }'
1388     fi
1389 }
1390
1391 # returns device number if a file is a character device
1392 #
1393 _is_char_dev()
1394 {
1395         if [ $# -ne 1 ]; then
1396                 echo "Usage: _is_char_dev dev" 1>&2
1397                 exit 1
1398         fi
1399
1400         _dev=$1
1401         if [ -L "${_dev}" ]; then
1402                 _dev=`readlink -f "${_dev}"`
1403         fi
1404
1405         if [ -c "${_dev}" ]; then
1406                 src/lstat64 "${_dev}" | $AWK_PROG '/Device type:/ { print $9 }'
1407         fi
1408 }
1409
1410 # Do a command, log it to $seqres.full, optionally test return status
1411 # and die if command fails. If called with one argument _do executes the
1412 # command, logs it, and returns its exit status. With two arguments _do
1413 # first prints the message passed in the first argument, and then "done"
1414 # or "fail" depending on the return status of the command passed in the
1415 # second argument. If the command fails and the variable _do_die_on_error
1416 # is set to "always" or the two argument form is used and _do_die_on_error
1417 # is set to "message_only" _do will print an error message to
1418 # $seqres.out and exit.
1419
1420 _do()
1421 {
1422     if [ $# -eq 1 ]; then
1423         _cmd=$1
1424     elif [ $# -eq 2 ]; then
1425         _note=$1
1426         _cmd=$2
1427         echo -n "$_note... "
1428     else
1429         echo "Usage: _do [note] cmd" 1>&2
1430         status=1; exit
1431     fi
1432
1433     (eval "echo '---' \"$_cmd\"") >>$seqres.full
1434     (eval "$_cmd") >$tmp._out 2>&1; ret=$?
1435     cat $tmp._out | _fix_malloc >>$seqres.full
1436     rm -f $tmp._out
1437     if [ $# -eq 2 ]; then
1438         if [ $ret -eq 0 ]; then
1439             echo "done"
1440         else
1441             echo "fail"
1442         fi
1443     fi
1444     if [ $ret -ne 0  ] \
1445         && [ "$_do_die_on_error" = "always" \
1446             -o \( $# -eq 2 -a "$_do_die_on_error" = "message_only" \) ]
1447     then
1448         [ $# -ne 2 ] && echo
1449         eval "echo \"$_cmd\" failed \(returned $ret\): see $seqres.full"
1450         status=1; exit
1451     fi
1452
1453     return $ret
1454 }
1455
1456 # bail out, setting up .notrun file. Need to kill the filesystem check files
1457 # here, otherwise they are set incorrectly for the next test.
1458 #
1459 _notrun()
1460 {
1461     echo "$*" > $seqres.notrun
1462     echo "$seq not run: $*"
1463     rm -f ${RESULT_DIR}/require_test*
1464     rm -f ${RESULT_DIR}/require_scratch*
1465
1466     status=0
1467     exit
1468 }
1469
1470 # just plain bail out
1471 #
1472 _fail()
1473 {
1474     echo "$*" | tee -a $seqres.full
1475     echo "(see $seqres.full for details)"
1476     status=1
1477     exit 1
1478 }
1479
1480 # tests whether $FSTYP is one of the supported filesystems for a test
1481 #
1482 _supported_fs()
1483 {
1484     for f
1485     do
1486         if [ "$f" = "$FSTYP" -o "$f" = "generic" ]
1487         then
1488             return
1489         fi
1490     done
1491
1492     _notrun "not suitable for this filesystem type: $FSTYP"
1493 }
1494
1495
1496 # tests whether $FSTYP is one of the supported OSes for a test
1497 #
1498 _supported_os()
1499 {
1500     for h
1501     do
1502         if [ "$h" = "$HOSTOS" ]
1503         then
1504             return
1505         fi
1506     done
1507
1508     _notrun "not suitable for this OS: $HOSTOS"
1509 }
1510
1511 # check if a FS on a device is mounted
1512 # if so, verify that it is mounted on mount point
1513 # if fstype is given as argument, verify that it is also
1514 # mounted with correct fs type
1515 #
1516 _check_mounted_on()
1517 {
1518         local devname=$1
1519         local dev=$2
1520         local mntname=$3
1521         local mnt=$4
1522         local type=$5
1523
1524         # find $dev as the source, and print result in "$dev $mnt" format
1525         local mount_rec=`findmnt -rncv -S $dev -o SOURCE,TARGET`
1526         [ -n "$mount_rec" ] || return 1 # 1 = not mounted
1527
1528         # if it's mounted, make sure its on $mnt
1529         if [ "$mount_rec" != "$dev $mnt" ]; then
1530                 echo "$devname=$dev is mounted but not on $mntname=$mnt - aborting"
1531                 echo "Already mounted result:"
1532                 echo $mount_rec
1533                 return 2 # 2 = mounted on wrong mnt
1534         fi
1535
1536         if [ -n "$type" -a "`_fs_type $dev`" != "$type" ]; then
1537                 echo "$devname=$dev is mounted but not a type $type filesystem"
1538                 # raw $DF_PROG cannot handle NFS/CIFS/overlay correctly
1539                 _df_device $dev
1540                 return 3 # 3 = mounted as wrong type
1541         fi
1542         return 0 # 0 = mounted as expected
1543 }
1544
1545 # this test needs a scratch partition - check we're ok & unmount it
1546 # No post-test check of the device is required. e.g. the test intentionally
1547 # finishes the test with the filesystem in a corrupt state
1548 _require_scratch_nocheck()
1549 {
1550     case "$FSTYP" in
1551         glusterfs)
1552                 echo $SCRATCH_DEV | egrep -q ":/?" > /dev/null 2>&1
1553                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1554                         _notrun "this test requires a valid \$SCRATCH_DEV"
1555                 fi
1556                 if [ ! -d "$SCRATCH_MNT" ]; then
1557                         _notrun "this test requires a valid \$SCRATCH_MNT"
1558                 fi
1559                 ;;
1560         nfs*|ceph)
1561                 echo $SCRATCH_DEV | grep -q ":/" > /dev/null 2>&1
1562                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1563                         _notrun "this test requires a valid \$SCRATCH_DEV"
1564                 fi
1565                 if [ ! -d "$SCRATCH_MNT" ]; then
1566                         _notrun "this test requires a valid \$SCRATCH_MNT"
1567                 fi
1568                 ;;
1569         pvfs2)
1570                 echo $SCRATCH_DEV | grep -q "://" > /dev/null 2>&1
1571                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1572                         _notrun "this test requires a valid \$SCRATCH_DEV"
1573                 fi
1574                 if [ ! -d "$SCRATCH_MNT" ]; then
1575                         _notrun "this test requires a valid \$SCRATCH_MNT"
1576                 fi
1577                 ;;
1578         cifs)
1579                 echo $SCRATCH_DEV | grep -q "//" > /dev/null 2>&1
1580                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1581                         _notrun "this test requires a valid \$SCRATCH_DEV"
1582                 fi
1583                 if [ ! -d "$SCRATCH_MNT" ]; then
1584                      _notrun "this test requires a valid \$SCRATCH_MNT"
1585                 fi
1586                 ;;
1587         overlay)
1588                 if [ -z "$OVL_BASE_SCRATCH_MNT" -o ! -d "$OVL_BASE_SCRATCH_MNT" ]; then
1589                         _notrun "this test requires a valid \$OVL_BASE_SCRATCH_MNT as ovl base dir"
1590                 fi
1591                 # if $SCRATCH_MNT is derived from $OVL_BASE_SCRATCH_MNT then
1592                 # don't check $SCRATCH_MNT dir here because base fs may not be mounted
1593                 # and we will create the mount point anyway on _overlay_mount
1594                 if [ "$SCRATCH_MNT" != "$OVL_BASE_SCRATCH_MNT/$OVL_MNT" -a ! -d "$SCRATCH_MNT" ]; then
1595                         _notrun "this test requires a valid \$SCRATCH_MNT"
1596                 fi
1597                 ;;
1598         tmpfs)
1599                 if [ -z "$SCRATCH_DEV" -o ! -d "$SCRATCH_MNT" ];
1600                 then
1601                     _notrun "this test requires a valid \$SCRATCH_MNT and unique $SCRATCH_DEV"
1602                 fi
1603                 ;;
1604         ubifs)
1605                 # ubifs needs an UBI volume. This will be a char device, not a block device.
1606                 if [ ! -c "$SCRATCH_DEV" ]; then
1607                         _notrun "this test requires a valid UBI volume for \$SCRATCH_DEV"
1608                 fi
1609                 if [ ! -d "$SCRATCH_MNT" ]; then
1610                         _notrun "this test requires a valid \$SCRATCH_MNT"
1611                 fi
1612                 ;;
1613         *)
1614                  if [ -z "$SCRATCH_DEV" -o "`_is_block_dev "$SCRATCH_DEV"`" = "" ]
1615                  then
1616                      _notrun "this test requires a valid \$SCRATCH_DEV"
1617                  fi
1618                  if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1619                  then
1620                      _notrun "this test requires a valid \$SCRATCH_DEV"
1621                  fi
1622                 if [ ! -d "$SCRATCH_MNT" ]
1623                 then
1624                      _notrun "this test requires a valid \$SCRATCH_MNT"
1625                 fi
1626                  ;;
1627     esac
1628
1629     _check_mounted_on SCRATCH_DEV $SCRATCH_DEV SCRATCH_MNT $SCRATCH_MNT
1630     local err=$?
1631     [ $err -le 1 ] || exit 1
1632     if [ $err -eq 0 ]
1633     then
1634         # if it's mounted, unmount it
1635         if ! _scratch_unmount
1636         then
1637             echo "failed to unmount $SCRATCH_DEV"
1638             exit 1
1639         fi
1640     fi
1641     rm -f ${RESULT_DIR}/require_scratch
1642 }
1643
1644 # we need the scratch device and it should be checked post test.
1645 _require_scratch()
1646 {
1647         _require_scratch_nocheck
1648         touch ${RESULT_DIR}/require_scratch
1649 }
1650
1651
1652 # this test needs a test partition - check we're ok & mount it
1653 #
1654 _require_test()
1655 {
1656     case "$FSTYP" in
1657         glusterfs)
1658                 echo $TEST_DEV | egrep -q ":/?" > /dev/null 2>&1
1659                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1660                         _notrun "this test requires a valid \$TEST_DEV"
1661                 fi
1662                 if [ ! -d "$TEST_DIR" ]; then
1663                         _notrun "this test requires a valid \$TEST_DIR"
1664                 fi
1665                 ;;
1666         nfs*|ceph)
1667                 echo $TEST_DEV | grep -q ":/" > /dev/null 2>&1
1668                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1669                         _notrun "this test requires a valid \$TEST_DEV"
1670                 fi
1671                 if [ ! -d "$TEST_DIR" ]; then
1672                         _notrun "this test requires a valid \$TEST_DIR"
1673                 fi
1674                 ;;
1675         cifs)
1676                 echo $TEST_DEV | grep -q "//" > /dev/null 2>&1
1677                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1678                         _notrun "this test requires a valid \$TEST_DEV"
1679                 fi
1680                 if [ ! -d "$TEST_DIR" ]; then
1681                      _notrun "this test requires a valid \$TEST_DIR"
1682                 fi
1683                 ;;
1684         pvfs2)
1685                 echo $TEST_DEV | grep -q "://" > /dev/null 2>&1
1686                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1687                         _notrun "this test requires a valid \$TEST_DIR"
1688                 fi
1689                 if [ ! -d "$TEST_DIR" ]; then
1690                         _notrun "this test requires a valid \$TEST_DIR"
1691                 fi
1692                 ;;
1693         overlay)
1694                 if [ -z "$OVL_BASE_TEST_DIR" -o ! -d "$OVL_BASE_TEST_DIR" ]; then
1695                         _notrun "this test requires a valid \$TEST_DIR as ovl base dir"
1696                 fi
1697                 if [ ! -d "$TEST_DIR" ]; then
1698                         _notrun "this test requires a valid \$TEST_DIR"
1699                 fi
1700                 ;;
1701         tmpfs)
1702                 if [ -z "$TEST_DEV" -o ! -d "$TEST_DIR" ];
1703                 then
1704                     _notrun "this test requires a valid \$TEST_DIR and unique $TEST_DEV"
1705                 fi
1706                 ;;
1707         ubifs)
1708                 # ubifs needs an UBI volume. This will be a char device, not a block device.
1709                 if [ ! -c "$TEST_DEV" ]; then
1710                         _notrun "this test requires a valid UBI volume for \$TEST_DEV"
1711                 fi
1712                 if [ ! -d "$TEST_DIR" ]; then
1713                         _notrun "this test requires a valid \$TEST_DIR"
1714                 fi
1715                 ;;
1716         *)
1717                  if [ -z "$TEST_DEV" ] || [ "`_is_block_dev "$TEST_DEV"`" = "" ]
1718                  then
1719                      _notrun "this test requires a valid \$TEST_DEV"
1720                  fi
1721                  if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1722                  then
1723                      _notrun "this test requires a valid \$TEST_DEV"
1724                  fi
1725                 if [ ! -d "$TEST_DIR" ]
1726                 then
1727                      _notrun "this test requires a valid \$TEST_DIR"
1728                 fi
1729                  ;;
1730     esac
1731
1732     _check_mounted_on TEST_DEV $TEST_DEV TEST_DIR $TEST_DIR
1733     local err=$?
1734     [ $err -le 1 ] || exit 1
1735     if [ $err -ne 0 ]
1736     then
1737         if ! _test_mount
1738         then
1739                 echo "!!! failed to mount $TEST_DEV on $TEST_DIR"
1740                 exit 1
1741         fi
1742     fi
1743     touch ${RESULT_DIR}/require_test
1744 }
1745
1746 _has_logdev()
1747 {
1748         local ret=0
1749         [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && ret=1
1750         [ "$USE_EXTERNAL" != yes ] && ret=1
1751
1752         return $ret
1753 }
1754
1755 # this test needs a logdev
1756 #
1757 _require_logdev()
1758 {
1759     [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && \
1760         _notrun "This test requires a valid \$SCRATCH_LOGDEV"
1761     [ "$USE_EXTERNAL" != yes ] && \
1762         _notrun "This test requires USE_EXTERNAL to be enabled"
1763
1764     # ensure its not mounted
1765     $UMOUNT_PROG $SCRATCH_LOGDEV 2>/dev/null
1766 }
1767
1768 # this test requires loopback device support
1769 #
1770 _require_loop()
1771 {
1772     if [ "$HOSTOS" != "Linux" ]
1773     then
1774         _notrun "This test requires linux for loopback device support"
1775     fi
1776
1777     modprobe loop >/dev/null 2>&1
1778     if grep loop /proc/devices >/dev/null 2>&1
1779     then
1780         :
1781     else
1782         _notrun "This test requires loopback device support"
1783     fi
1784 }
1785
1786 # this test requires ext2 filesystem support
1787 #
1788 _require_ext2()
1789 {
1790     if [ "$HOSTOS" != "Linux" ]
1791     then
1792         _notrun "This test requires linux for ext2 filesystem support"
1793     fi
1794
1795     modprobe ext2 >/dev/null 2>&1
1796     if grep ext2 /proc/filesystems >/dev/null 2>&1
1797     then
1798         :
1799     else
1800         _notrun "This test requires ext2 filesystem support"
1801     fi
1802 }
1803
1804 # this test requires tmpfs filesystem support
1805 #
1806 _require_tmpfs()
1807 {
1808         modprobe tmpfs >/dev/null 2>&1
1809         grep -q tmpfs /proc/filesystems ||
1810                 _notrun "this test requires tmpfs support"
1811 }
1812
1813 # this test requires that (large) loopback device files are not in use
1814 #
1815 _require_no_large_scratch_dev()
1816 {
1817     [ "$LARGE_SCRATCH_DEV" = yes ] && \
1818         _notrun "Large filesystem testing in progress, skipped this test"
1819 }
1820
1821 # this test requires that a realtime subvolume is in use, and
1822 # that the kernel supports realtime as well.
1823 #
1824 _require_realtime()
1825 {
1826     [ "$USE_EXTERNAL" = yes ] || \
1827         _notrun "External volumes not in use, skipped this test"
1828     [ "$SCRATCH_RTDEV" = "" ] && \
1829         _notrun "Realtime device required, skipped this test"
1830 }
1831
1832 # this test requires that a specified command (executable) exists
1833 # $1 - command, $2 - name for error message
1834 #
1835 # Note: the command string might have parameters, so strip them before checking
1836 # whether it is executable.
1837 _require_command()
1838 {
1839         if [ $# -eq 2 ]; then
1840                 _name="$2"
1841         elif [ $# -eq 1 ]; then
1842                 _name="$1"
1843         else
1844                 _fail "usage: _require_command <command> [<name>]"
1845         fi
1846
1847         _command=`echo "$1" | awk '{ print $1 }'`
1848         if [ ! -x "$_command" ]; then
1849                 _notrun "$_name utility required, skipped this test"
1850         fi
1851 }
1852
1853 # this test requires the device to be valid block device
1854 # $1 - device
1855 _require_block_device()
1856 {
1857         if [ -z "$1" ]; then
1858                 echo "Usage: _require_block_device <dev>" 1>&2
1859                 exit 1
1860         fi
1861         if [ "`_is_block_dev "$1"`" == "" ]; then
1862                 _notrun "require $1 to be valid block disk"
1863         fi
1864 }
1865
1866 # this test requires a path to refere to a local block or character device
1867 # $1 - device
1868 _require_local_device()
1869 {
1870         if [ -z "$1" ]; then
1871                 echo "Usage: _require_local_device <dev>" 1>&2
1872                 exit 1
1873         fi
1874         if [ "`_is_block_dev "$1"`" != "" ]; then
1875                 return 0
1876         fi
1877         if [ "`_is_char_dev "$1"`" != "" ]; then
1878                 return 0
1879         fi
1880         _notrun "require $1 to be local device"
1881 }
1882
1883 # brd based ram disks erase the device when they receive a flush command when no
1884 # active references are present. This causes problems for DM devices sitting on
1885 # top of brd devices as DM doesn't hold active references to the brd device.
1886 _require_sane_bdev_flush()
1887 {
1888         echo $1 | grep -q "^/dev/ram[0-9]\+$"
1889         if [ $? -eq 0 ]; then
1890                 _notrun "This test requires a sane block device flush"
1891         fi
1892 }
1893
1894 # this test requires a specific device mapper target
1895 _require_dm_target()
1896 {
1897         _target=$1
1898
1899         # require SCRATCH_DEV to be a valid block device with sane BLKFLSBUF
1900         # behaviour
1901         _require_block_device $SCRATCH_DEV
1902         _require_sane_bdev_flush $SCRATCH_DEV
1903         _require_command "$DMSETUP_PROG" dmsetup
1904
1905         modprobe dm-$_target >/dev/null 2>&1
1906
1907         $DMSETUP_PROG targets 2>&1 | grep -q ^$_target
1908         if [ $? -ne 0 ]; then
1909                 _notrun "This test requires dm $_target support"
1910         fi
1911 }
1912
1913 # this test requires the ext4 kernel support crc feature on scratch device
1914 #
1915 _require_scratch_ext4_crc()
1916 {
1917         _scratch_mkfs_ext4 >/dev/null 2>&1
1918         dumpe2fs -h $SCRATCH_DEV 2> /dev/null | grep -q metadata_csum || _notrun "metadata_csum not supported by this filesystem"
1919         _scratch_mount >/dev/null 2>&1 \
1920            || _notrun "Kernel doesn't support metadata_csum feature"
1921         _scratch_unmount
1922 }
1923
1924 # Check the specified feature whether it is available in mkfs.ext4 or not.
1925 _require_ext4_mkfs_feature()
1926 {
1927         local feature=$1
1928         local testfile=/tmp/$$.ext4_mkfs
1929
1930         if [ -z "$feature" ]; then
1931                 echo "Usage: _require_ext4_mkfs_feature feature"
1932                 exit 1
1933         fi
1934
1935         touch $testfile
1936         local result=$($MKFS_EXT4_PROG -F -O $feature -n $testfile 512m 2>&1)
1937         rm -f $testfile
1938         echo $result | grep -q "Invalid filesystem option" && \
1939                 _notrun "mkfs.ext4 doesn't support $feature feature"
1940 }
1941
1942 # this test requires the ext4 kernel support bigalloc feature
1943 #
1944 _require_ext4_bigalloc()
1945 {
1946         $MKFS_EXT4_PROG -F -O bigalloc $SCRATCH_DEV 512m >/dev/null 2>&1
1947         _scratch_mount >/dev/null 2>&1 \
1948            || _notrun "Ext4 kernel doesn't support bigalloc feature"
1949         _scratch_unmount
1950 }
1951
1952 # this test requires that external log/realtime devices are not in use
1953 #
1954 _require_nonexternal()
1955 {
1956     [ "$USE_EXTERNAL" = yes ] && \
1957         _notrun "External device testing in progress, skipped this test"
1958 }
1959
1960 # this test requires that the kernel supports asynchronous I/O
1961 _require_aio()
1962 {
1963         $here/src/feature -A
1964         case $? in
1965         0)
1966                 ;;
1967         1)
1968                 _notrun "kernel does not support asynchronous I/O"
1969                 ;;
1970         *)
1971                 _fail "unexpected error testing for asynchronous I/O support"
1972                 ;;
1973         esac
1974 }
1975
1976 # this test requires that a (specified) aio-dio executable exists
1977 # and that the kernel supports asynchronous I/O.
1978 # $1 - command (optional)
1979 #
1980 _require_aiodio()
1981 {
1982     if [ -z "$1" ]
1983     then
1984         AIO_TEST=src/aio-dio-regress/aiodio_sparse2
1985         [ -x $AIO_TEST ] || _notrun "aio-dio utilities required"
1986     else
1987         AIO_TEST=src/aio-dio-regress/$1
1988         [ -x $AIO_TEST ] || _notrun "$AIO_TEST not built"
1989     fi
1990     _require_aio
1991     _require_odirect
1992 }
1993
1994 # this test requires that a test program exists under src/
1995 # $1 - command (require)
1996 #
1997 _require_test_program()
1998 {
1999     SRC_TEST=src/$1
2000     [ -x $SRC_TEST ] || _notrun "$SRC_TEST not built"
2001 }
2002
2003 # run an aio-dio program
2004 # $1 - command
2005 _run_aiodio()
2006 {
2007     if [ -z "$1" ]
2008     then
2009         echo "usage: _run_aiodio command_name" 2>&1
2010         status=1; exit 1
2011     fi
2012
2013     _require_aiodio $1
2014
2015     local testtemp=$TEST_DIR/aio-testfile
2016     rm -f $testtemp
2017     $AIO_TEST $testtemp 2>&1
2018     status=$?
2019     rm -f $testtemp
2020
2021     return $status
2022 }
2023
2024 # this test requires y2038 sysfs switch and filesystem
2025 # timestamp ranges support.
2026 _require_y2038()
2027 {
2028         local device=${1:-$TEST_DEV}
2029         local sysfsdir=/proc/sys/fs/fs-timestamp-check-on
2030
2031         if [ ! -e $sysfsdir ]; then
2032                 _notrun "no kernel support for y2038 sysfs switch"
2033         fi
2034
2035         local tsmin tsmax
2036         read tsmin tsmax <<<$(_filesystem_timestamp_range $device)
2037         if [ $tsmin -eq -1 -a $tsmax -eq -1 ]; then
2038                 _notrun "filesystem $FSTYP timestamp bounds are unknown"
2039         fi
2040 }
2041
2042 _filesystem_timestamp_range()
2043 {
2044         device=${1:-$TEST_DEV}
2045         case $FSTYP in
2046         ext4)
2047                 if [ $(dumpe2fs -h $device 2>/dev/null | grep "Inode size:" | cut -d: -f2) -gt 128 ]; then
2048                         echo "-2147483648 15032385535"
2049                 else
2050                         echo "-2147483648 2147483647"
2051                 fi
2052                 ;;
2053
2054         xfs)
2055                 echo "-2147483648 2147483647"
2056                 ;;
2057         jfs)
2058                 echo "0 4294967295"
2059                 ;;
2060         f2fs)
2061                 echo "-2147483648 2147483647"
2062                 ;;
2063         *)
2064                 echo "-1 -1"
2065                 ;;
2066         esac
2067 }
2068
2069 # indicate whether YP/NIS is active or not
2070 #
2071 _yp_active()
2072 {
2073         local dn
2074         dn=$(domainname 2>/dev/null)
2075         test -n "${dn}" -a "${dn}" != "(none)" -a "${dn}" != "localdomain"
2076         echo $?
2077 }
2078
2079 # cat the password file
2080 #
2081 _cat_passwd()
2082 {
2083         [ $(_yp_active) -eq 0 ] && ypcat passwd
2084         cat /etc/passwd
2085 }
2086
2087 # cat the group file
2088 #
2089 _cat_group()
2090 {
2091         [ $(_yp_active) -eq 0 ] && ypcat group
2092         cat /etc/group
2093 }
2094
2095 # check for a user on the machine, fsgqa as default
2096 #
2097 _require_user()
2098 {
2099     qa_user=fsgqa
2100     if [ -n "$1" ];then
2101         qa_user=$1
2102     fi
2103     _cat_passwd | grep -q $qa_user
2104     [ "$?" == "0" ] || _notrun "$qa_user user not defined."
2105     echo /bin/true | su $qa_user
2106     [ "$?" == "0" ] || _notrun "$qa_user cannot execute commands."
2107 }
2108
2109 # check for a group on the machine, fsgqa as default
2110 #
2111 _require_group()
2112 {
2113     qa_group=fsgqa
2114     if [ -n "$1" ];then
2115         qa_group=$1
2116     fi
2117     _cat_group | grep -q $qa_group
2118     [ "$?" == "0" ] || _notrun "$qa_group group not defined."
2119 }
2120
2121 _filter_user_do()
2122 {
2123         perl -ne "
2124 s,.*Permission\sdenied.*,Permission denied,;
2125 s,.*no\saccess\sto\stty.*,,;
2126 s,.*no\sjob\scontrol\sin\sthis\sshell.*,,;
2127 s,^\s*$,,;
2128         print;"
2129 }
2130
2131 _user_do()
2132 {
2133         echo $1 | su -s /bin/bash $qa_user 2>&1 | _filter_user_do
2134 }
2135
2136 _require_xfs_io_command()
2137 {
2138         if [ -z "$1" ]
2139         then
2140                 echo "Usage: _require_xfs_io_command command [switch]" 1>&2
2141                 exit 1
2142         fi
2143         local command=$1
2144         shift
2145         local param="$*"
2146         local param_checked=0
2147
2148         testfile=$TEST_DIR/$$.xfs_io
2149         case $command in
2150         "chproj")
2151                 testio=`$XFS_IO_PROG -F -f -c "chproj 0" $testfile 2>&1`
2152                 ;;
2153         "copy_range")
2154                 testcopy=$TEST_DIR/$$.copy.xfs_io
2155                 $XFS_IO_PROG -F -f -c "pwrite 0 4k" $testfile > /dev/null 2>&1
2156                 testio=`$XFS_IO_PROG -F -f -c "copy_range $testfile" $testcopy 2>&1`
2157                 rm -f $testcopy > /dev/null 2>&1
2158                 ;;
2159         "falloc" )
2160                 testio=`$XFS_IO_PROG -F -f -c "falloc $param 0 1m" $testfile 2>&1`
2161                 param_checked=1
2162                 ;;
2163         "fpunch" | "fcollapse" | "zero" | "fzero" | "finsert" | "funshare")
2164                 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
2165                         -c "$command 4k 8k" $testfile 2>&1`
2166                 ;;
2167         "fiemap")
2168                 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
2169                         -c "fiemap -v $param" $testfile 2>&1`
2170                 param_checked=1
2171                 ;;
2172         "flink" )
2173                 testio=`$XFS_IO_PROG -T -F -c "flink $testfile" \
2174                         $TEST_DIR 2>&1`
2175                 echo $testio | egrep -q "invalid option|Is a directory" && \
2176                         _notrun "xfs_io $command support is missing"
2177                 ;;
2178         "fsmap" )
2179                 testio=`$XFS_IO_PROG -f -c "fsmap" $testfile 2>&1`
2180                 echo $testio | grep -q "Inappropriate ioctl" && \
2181                         _notrun "xfs_io $command support is missing"
2182                 ;;
2183         "open")
2184                 # -c "open $f" is broken in xfs_io <= 4.8. Along with the fix,
2185                 # a new -C flag was introduced to execute one shot commands.
2186                 # Check for -C flag support as an indication for the bug fix.
2187                 testio=`$XFS_IO_PROG -F -f -C "open $testfile" $testfile 2>&1`
2188                 echo $testio | grep -q "invalid option" && \
2189                         _notrun "xfs_io $command support is missing"
2190                 ;;
2191         "scrub"|"repair")
2192                 testio=`$XFS_IO_PROG -x -c "$command dummy 0" $TEST_DIR 2>&1`
2193                 echo $testio | grep -q "Inappropriate ioctl" && \
2194                         _notrun "xfs_io $command support is missing"
2195                 ;;
2196         "utimes" )
2197                 testio=`$XFS_IO_PROG -f -c "utimes" 0 0 0 0 $testfile 2>&1`
2198                 ;;
2199         *)
2200                 testio=`$XFS_IO_PROG -c "help $command" 2>&1`
2201         esac
2202
2203         rm -f $testfile 2>&1 > /dev/null
2204         echo $testio | grep -q "not found" && \
2205                 _notrun "xfs_io $command support is missing"
2206         echo $testio | grep -q "Operation not supported" && \
2207                 _notrun "xfs_io $command failed (old kernel/wrong fs?)"
2208         echo $testio | grep -q "Invalid" && \
2209                 _notrun "xfs_io $command failed (old kernel/wrong fs/bad args?)"
2210         echo $testio | grep -q "foreign file active" && \
2211                 _notrun "xfs_io $command not supported on $FSTYP"
2212         echo $testio | grep -q "Function not implemented" && \
2213                 _notrun "xfs_io $command support is missing (missing syscall?)"
2214
2215         if [ -n "$param" -a $param_checked -eq 0 ]; then
2216                 $XFS_IO_PROG -c "help $command" | grep -q "^ $param --" || \
2217                         _notrun "xfs_io $command doesn't support $param"
2218         fi
2219 }
2220
2221 # check that kernel and filesystem support direct I/O
2222 _require_odirect()
2223 {
2224         if [ $FSTYP = "ext4" ] ; then
2225                 if echo "$MOUNT_OPTIONS" | grep -q "test_dummy_encryption"; then
2226                         _notrun "ext4 encryption doesn't support O_DIRECT"
2227                 fi
2228         fi
2229         testfile=$TEST_DIR/$$.direct
2230         $XFS_IO_PROG -F -f -d -c "pwrite 0 20k" $testfile > /dev/null 2>&1
2231         if [ $? -ne 0 ]; then
2232                 _notrun "O_DIRECT is not supported"
2233         fi
2234         rm -f $testfile 2>&1 > /dev/null
2235 }
2236
2237 # Check that the filesystem supports swapfiles
2238 _require_scratch_swapfile()
2239 {
2240         _require_scratch
2241
2242         _scratch_mkfs >/dev/null
2243         _scratch_mount
2244
2245         # Minimum size for mkswap is 10 pages
2246         local size=$(($(get_page_size) * 10))
2247
2248         _pwrite_byte 0x61 0 "$size" "$SCRATCH_MNT/swap" >/dev/null 2>&1
2249         mkswap "$SCRATCH_MNT/swap" >/dev/null 2>&1
2250         if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
2251                 _scratch_unmount
2252                 _notrun "swapfiles are not supported"
2253         fi
2254
2255         swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
2256         _scratch_unmount
2257 }
2258
2259 # Check that a fs has enough free space (in 1024b blocks)
2260 #
2261 _require_fs_space()
2262 {
2263         MNT=$1
2264         BLOCKS=$2       # in units of 1024
2265         let GB=$BLOCKS/1024/1024
2266
2267         FREE_BLOCKS=`df -kP $MNT | grep -v Filesystem | awk '{print $4}'`
2268         [ $FREE_BLOCKS -lt $BLOCKS ] && \
2269                 _notrun "This test requires at least ${GB}GB free on $MNT to run"
2270 }
2271
2272 #
2273 # Check if the filesystem supports sparse files.
2274 #
2275 # Unfortunately there is no better way to do this than a manual black list.
2276 #
2277 _require_sparse_files()
2278 {
2279     case $FSTYP in
2280     hfsplus)
2281         _notrun "Sparse files not supported by this filesystem type: $FSTYP"
2282         ;;
2283     *)
2284         ;;
2285     esac
2286 }
2287
2288 _require_debugfs()
2289 {
2290     #boot_params always present in debugfs
2291     [ -d "$DEBUGFS_MNT/boot_params" ] || _notrun "Debugfs not mounted"
2292 }
2293
2294 _require_fail_make_request()
2295 {
2296     [ -f "$DEBUGFS_MNT/fail_make_request/probability" ] \
2297         || _notrun "$DEBUGFS_MNT/fail_make_request \
2298  not found. Seems that CONFIG_FAIL_MAKE_REQUEST kernel config option not enabled"
2299 }
2300
2301 # Disable extent zeroing for ext4 on the given device
2302 _ext4_disable_extent_zeroout()
2303 {
2304         local dev=${1:-$TEST_DEV}
2305         local sdev=`_short_dev $dev`
2306
2307         [ -f /sys/fs/ext4/$sdev/extent_max_zeroout_kb ] && \
2308                 echo 0 >/sys/fs/ext4/$sdev/extent_max_zeroout_kb
2309 }
2310
2311 # Check if the file system supports seek_data/hole
2312 _require_seek_data_hole()
2313 {
2314         local dev=${1:-$TEST_DEV}
2315         local testfile=$TEST_DIR/$$.seek
2316         local testseek=`$here/src/seek_sanity_test -t $testfile 2>&1`
2317
2318         rm -f $testfile &>/dev/null
2319         echo $testseek | grep -q "Kernel does not support" && \
2320                 _notrun "File system does not support llseek(2) SEEK_DATA/HOLE"
2321         # Disable extent zeroing for ext4 as that change where holes are
2322         # created
2323         if [ "$FSTYP" = "ext4" ]; then
2324                 _ext4_disable_extent_zeroout $dev
2325         fi
2326 }
2327
2328 _require_runas()
2329 {
2330         _require_test_program "runas"
2331 }
2332
2333 _runas()
2334 {
2335         "$here/src/runas" "$@"
2336 }
2337
2338 _require_richacl_prog()
2339 {
2340         _require_command "$GETRICHACL_PROG" getrichacl
2341         _require_command "$SETRICHACL_PROG" setrichacl
2342 }
2343
2344 _require_scratch_richacl_xfs()
2345 {
2346         _scratch_mkfs_xfs_supported -m richacl=1 >/dev/null 2>&1 \
2347                 || _notrun "mkfs.xfs doesn't have richacl feature"
2348         _scratch_mkfs_xfs -m richacl=1 >/dev/null 2>&1
2349         _scratch_mount >/dev/null 2>&1 \
2350                 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2351         _scratch_unmount
2352 }
2353
2354 _require_scratch_richacl_ext4()
2355 {
2356         _scratch_mkfs -O richacl >/dev/null 2>&1 \
2357                 || _notrun "can't mkfs $FSTYP with option -O richacl"
2358         _scratch_mount >/dev/null 2>&1 \
2359                 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2360         _scratch_unmount
2361 }
2362
2363 _require_scratch_richacl_support()
2364 {
2365         _scratch_mount
2366         $GETFATTR_PROG -n system.richacl >/dev/null 2>&1 \
2367                 || _notrun "this test requires richacl support on \$SCRATCH_DEV"
2368         _scratch_unmount
2369 }
2370
2371 _require_scratch_richacl()
2372 {
2373         case "$FSTYP" in
2374         xfs)    _require_scratch_richacl_xfs
2375                 ;;
2376         ext4)   _require_scratch_richacl_ext4
2377                 ;;
2378         nfs*|cifs|overlay)
2379                 _require_scratch_richacl_support
2380                 ;;
2381         *)      _notrun "this test requires richacl support on \$SCRATCH_DEV"
2382                 ;;
2383         esac
2384 }
2385
2386 _scratch_mkfs_richacl()
2387 {
2388         case "$FSTYP" in
2389         xfs)    _scratch_mkfs_xfs -m richacl=1
2390                 ;;
2391         ext4)   _scratch_mkfs -O richacl
2392                 ;;
2393         nfs*|cifs|overlay)
2394                 _scratch_mkfs
2395                 ;;
2396         esac
2397 }
2398
2399 # check that a FS on a device is mounted
2400 # if so, return mount point
2401 #
2402 _is_mounted()
2403 {
2404     if [ $# -ne 1 ]
2405     then
2406         echo "Usage: _is_mounted device" 1>&2
2407         exit 1
2408     fi
2409
2410     device=$1
2411
2412     if _mount | grep "$device " | $AWK_PROG -v pattern="type $FSTYP" '
2413         pattern        { print $3 ; exit 0 }
2414         END            { exit 1 }
2415     '
2416     then
2417         echo "_is_mounted: $device is not a mounted $FSTYP FS"
2418         exit 1
2419     fi
2420 }
2421
2422 # remount a FS to a new mode (ro or rw)
2423 #
2424 _remount()
2425 {
2426     if [ $# -ne 2 ]
2427     then
2428         echo "Usage: _remount device ro/rw" 1>&2
2429         exit 1
2430     fi
2431     device=$1
2432     mode=$2
2433
2434     if ! mount -o remount,$mode $device
2435     then
2436         echo "_remount: failed to remount filesystem on $device as $mode"
2437         exit 1
2438     fi
2439 }
2440
2441 # Run the appropriate repair/check on a filesystem
2442 #
2443 # if the filesystem is mounted, it's either remounted ro before being
2444 # checked or it's unmounted and then remounted
2445 #
2446
2447 # If set, we remount ro instead of unmounting for fsck
2448 USE_REMOUNT=0
2449
2450 _umount_or_remount_ro()
2451 {
2452     if [ $# -ne 1 ]
2453     then
2454         echo "Usage: _umount_or_remount_ro <device>" 1>&2
2455         exit 1
2456     fi
2457
2458     device=$1
2459     mountpoint=`_is_mounted $device`
2460
2461     if [ $USE_REMOUNT -eq 0 ]; then
2462         $UMOUNT_PROG $device
2463     else
2464         _remount $device ro
2465     fi
2466     echo "$mountpoint"
2467 }
2468
2469 _mount_or_remount_rw()
2470 {
2471         if [ $# -ne 3 ]; then
2472                 echo "Usage: _mount_or_remount_rw <opts> <dev> <mnt>" 1>&2
2473                 exit 1
2474         fi
2475         mount_opts=$1
2476         device=$2
2477         mountpoint=$3
2478
2479         if [ $USE_REMOUNT -eq 0 ]; then
2480                 if [ "$FSTYP" != "overlay" ]; then
2481                         _mount -t $FSTYP $mount_opts $device $mountpoint
2482                 else
2483                         _overlay_mount $device $mountpoint
2484                 fi
2485                 if [ $? -ne 0 ]; then
2486                         _dump_err "!!! failed to remount $device on $mountpoint"
2487                         return 0 # ok=0
2488                 fi
2489         else
2490                 _remount $device rw
2491         fi
2492
2493         return 1 # ok=1
2494 }
2495
2496 # Check a generic filesystem in no-op mode; this assumes that the
2497 # underlying fsck program accepts "-n" for a no-op (check-only) run,
2498 # and that it will still return an errno for corruption in this mode.
2499 #
2500 # Filesystems which don't support this will need to define their
2501 # own check routine.
2502 #
2503 _check_generic_filesystem()
2504 {
2505     device=$1
2506
2507     # If type is set, we're mounted
2508     type=`_fs_type $device`
2509     ok=1
2510
2511     if [ "$type" = "$FSTYP" ]
2512     then
2513         # mounted ...
2514         mountpoint=`_umount_or_remount_ro $device`
2515     fi
2516
2517     fsck -t $FSTYP $FSCK_OPTIONS $device >$tmp.fsck 2>&1
2518     if [ $? -ne 0 ]
2519     then
2520         _log_err "_check_generic_filesystem: filesystem on $device is inconsistent"
2521         echo "*** fsck.$FSTYP output ***"       >>$seqres.full
2522         cat $tmp.fsck                           >>$seqres.full
2523         echo "*** end fsck.$FSTYP output"       >>$seqres.full
2524
2525         ok=0
2526     fi
2527     rm -f $tmp.fsck
2528
2529     if [ $ok -eq 0 ]
2530     then
2531         echo "*** mount output ***"             >>$seqres.full
2532         _mount                                  >>$seqres.full
2533         echo "*** end mount output"             >>$seqres.full
2534     elif [ "$type" = "$FSTYP" ]
2535     then
2536         # was mounted ...
2537         _mount_or_remount_rw "$MOUNT_OPTIONS" $device $mountpoint
2538         ok=$?
2539     fi
2540
2541     if [ $ok -eq 0 ]; then
2542         status=1
2543         if [ "$iam" != "check" ]; then
2544                 exit 1
2545         fi
2546         return 1
2547     fi
2548
2549     return 0
2550 }
2551
2552 # Filter the knowen errors the UDF Verifier reports.
2553 _udf_test_known_error_filter()
2554 {
2555         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."
2556
2557 }
2558
2559 _check_udf_filesystem()
2560 {
2561     [ "$DISABLE_UDF_TEST" == "1" ] && return
2562
2563     if [ $# -ne 1 -a $# -ne 2 ]
2564     then
2565         echo "Usage: _check_udf_filesystem device [last_block]" 1>&2
2566         exit 1
2567     fi
2568
2569     if [ ! -x $here/src/udf_test ]
2570     then
2571         echo "udf_test not installed, please download and build the Philips"
2572         echo "UDF Verification Software from http://www.extra.research.philips.com/udf/."
2573         echo "Then copy the udf_test binary to $here/src/."
2574         echo "If you do not wish to run udf_test then set environment variable DISABLE_UDF_TEST"
2575         echo "to 1."
2576         return
2577     fi
2578
2579     device=$1
2580     if [ $# -eq 2 ];
2581     then
2582         LAST_BLOCK=`expr \( $2 - 1 \)`
2583         OPT_ARG="-lastvalidblock $LAST_BLOCK"
2584     fi
2585
2586     rm -f $seqres.checkfs
2587     sleep 1 # Due to a problem with time stamps in udf_test
2588     $here/src/udf_test $OPT_ARG $device | tee $seqres.checkfs | egrep "Error|Warning" | \
2589         _udf_test_known_error_filter | \
2590         egrep -iv "Error count:.*[0-9]+.*total occurrences:.*[0-9]+|Warning count:.*[0-9]+.*total occurrences:.*[0-9]+" && \
2591         echo "Warning UDF Verifier reported errors see $seqres.checkfs." && return 1
2592     return 0
2593 }
2594
2595 _check_test_fs()
2596 {
2597     case $FSTYP in
2598     xfs)
2599         _check_xfs_test_fs
2600         ;;
2601     nfs)
2602         # no way to check consistency for nfs
2603         ;;
2604     cifs)
2605         # no way to check consistency for cifs
2606         ;;
2607     ceph)
2608         # no way to check consistency for CephFS
2609         ;;
2610     glusterfs)
2611         # no way to check consistency for GlusterFS
2612         ;;
2613     overlay)
2614         # no way to check consistency for overlay
2615         ;;
2616     pvfs2)
2617         ;;
2618     udf)
2619         # do nothing for now
2620         ;;
2621     btrfs)
2622         _check_btrfs_filesystem $TEST_DEV
2623         ;;
2624     tmpfs)
2625         # no way to check consistency for tmpfs
2626         ;;
2627     ubifs)
2628         # there is no fsck program for ubifs yet
2629         ;;
2630     *)
2631         _check_generic_filesystem $TEST_DEV
2632         ;;
2633     esac
2634 }
2635
2636 _check_scratch_fs()
2637 {
2638     device=$SCRATCH_DEV
2639     [ $# -eq 1 ] && device=$1
2640
2641     case $FSTYP in
2642     xfs)
2643         SCRATCH_LOG="none"
2644         SCRATCH_RT="none"
2645         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
2646             SCRATCH_LOG="$SCRATCH_LOGDEV"
2647
2648         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
2649             SCRATCH_RT="$SCRATCH_RTDEV"
2650
2651         _check_xfs_filesystem $device $SCRATCH_LOG $SCRATCH_RT
2652         ;;
2653     udf)
2654         _check_udf_filesystem $device $udf_fsize
2655         ;;
2656     nfs*)
2657         # Don't know how to check an NFS filesystem, yet.
2658         ;;
2659     cifs)
2660         # Don't know how to check a CIFS filesystem, yet.
2661         ;;
2662     ceph)
2663         # no way to check consistency for CephFS
2664         ;;
2665     glusterfs)
2666         # no way to check consistency for GlusterFS
2667         ;;
2668     overlay)
2669         # no way to check consistency for overlay
2670         ;;
2671     pvfs2)
2672         ;;
2673     btrfs)
2674         _check_btrfs_filesystem $device
2675         ;;
2676     tmpfs)
2677         # no way to check consistency for tmpfs
2678         ;;
2679     ubifs)
2680         # there is no fsck program for ubifs yet
2681         ;;
2682     *)
2683         _check_generic_filesystem $device
2684         ;;
2685     esac
2686 }
2687
2688 _full_fstyp_details()
2689 {
2690      [ -z "$FSTYP" ] && FSTYP=xfs
2691      if [ $FSTYP = xfs ]; then
2692         if [ -d /proc/fs/xfs ]; then
2693             if grep -q 'debug 0' /proc/fs/xfs/stat; then
2694                 FSTYP="$FSTYP (non-debug)"
2695             elif grep -q 'debug 1' /proc/fs/xfs/stat; then
2696                 FSTYP="$FSTYP (debug)"
2697             fi
2698         else
2699             if uname -a | grep -qi 'debug'; then
2700                 FSTYP="$FSTYP (debug)"
2701             else
2702                 FSTYP="$FSTYP (non-debug)"
2703             fi
2704         fi
2705      fi
2706      echo $FSTYP
2707 }
2708
2709 _full_platform_details()
2710 {
2711      os=`uname -s`
2712      host=`hostname -s`
2713      kernel=`uname -r`
2714      platform=`uname -m`
2715      echo "$os/$platform $host $kernel"
2716 }
2717
2718 _get_os_name()
2719 {
2720         if [ "`uname`" == "Linux" ]; then
2721                 echo 'linux'
2722         else
2723                 echo Unknown operating system: `uname`
2724                 exit
2725         fi
2726 }
2727
2728 _link_out_file_named()
2729 {
2730         export FEATURES=$2
2731         SUFFIX=$(perl -e '
2732                 my %feathash;
2733                 my $feature, $result, $suffix, $opts;
2734
2735                 foreach $feature (split(/,/, $ENV{"FEATURES"})) {
2736                         $feathash{$feature} = 1;
2737                 }
2738                 $result = "default";
2739                 while (<>) {
2740                         my $found = 1;
2741
2742                         chomp;
2743                         ($opts, $suffix) = split(/ *: */);
2744                         foreach my $opt (split(/,/, $opts)) {
2745                                 if (!exists($feathash{$opt})) {
2746                                         $found = 0;
2747                                         last;
2748                                 }
2749                         }
2750                         if ($found == 1) {
2751                                 $result = $suffix;
2752                                 last;
2753                         }
2754                 }
2755                 print $result
2756                 ' <$seqfull.cfg)
2757         rm -f $1
2758         SRC=$(basename $1)
2759         ln -fs $SRC.$SUFFIX $1
2760 }
2761
2762 _link_out_file()
2763 {
2764         if [ $# -eq 0 ]; then
2765                 FEATURES="$(_get_os_name)"
2766                 if [ -n "$MOUNT_OPTIONS" ]; then
2767                         FEATURES=$FEATURES,${MOUNT_OPTIONS##"-o "}
2768                 fi
2769         else
2770                 FEATURES=$1
2771         fi
2772
2773         _link_out_file_named $seqfull.out "$FEATURES"
2774 }
2775
2776 _die()
2777 {
2778         echo $@
2779         exit 1
2780 }
2781
2782 # convert urandom incompressible data to compressible text data
2783 _ddt()
2784 {
2785         od /dev/urandom | dd iflag=fullblock ${*}
2786 }
2787
2788 #takes files, randomdata
2789 _nfiles()
2790 {
2791         f=0
2792         while [ $f -lt $1 ]
2793         do
2794                 file=f$f
2795                 echo > $file
2796                 if [ $size -gt 0 ]; then
2797                     if [ "$2" == "false" ]; then
2798                         dd if=/dev/zero of=$file bs=1024 count=$size 2>&1 | _filter_dd
2799                     elif [ "$2" == "comp" ]; then
2800                         _ddt of=$file bs=1024 count=$size 2>&1 | _filter_dd
2801                     else
2802                         dd if=/dev/urandom of=$file bs=1024 count=$size 2>&1 | _filter_dd
2803                     fi
2804                 fi
2805                 let f=$f+1
2806         done
2807 }
2808
2809 # takes dirname, depth, randomdata
2810 _descend()
2811 {
2812         dirname=$1; depth=$2; randomdata=$3
2813         mkdir $dirname  || die "mkdir $dirname failed"
2814         cd $dirname
2815
2816         _nfiles $files $randomdata          # files for this dir and data type
2817
2818         [ $depth -eq 0 ] && return
2819         let deep=$depth-1 # go 1 down
2820
2821         [ $verbose = true ] && echo "descending, depth from leaves = $deep"
2822
2823         d=0
2824         while [ $d -lt $dirs ]
2825         do
2826                 _descend d$d $deep &
2827                 let d=$d+1
2828                 wait
2829         done
2830 }
2831
2832 # Populate a filesystem with inodes for performance experiments
2833 #
2834 # usage: populate [-v] [-n ndirs] [-f nfiles] [-d depth] [-r root] [-s size] [-x]
2835 #
2836 _populate_fs()
2837 {
2838     here=`pwd`
2839     dirs=5          # ndirs in each subdir till leaves
2840     size=0          # sizeof files in K
2841     files=100       # num files in _each_ subdir
2842     depth=2         # depth of tree from root to leaves
2843     verbose=false
2844     root=root       # path of initial root of directory tree
2845     randomdata=false # -x data type urandom, zero or compressible
2846
2847     OPTIND=1
2848     while getopts "d:f:n:r:s:v:x:c" c
2849     do
2850         case $c in
2851         d)      depth=$OPTARG;;
2852         n)      dirs=$OPTARG;;
2853         f)      files=$OPTARG;;
2854         s)      size=$OPTARG;;
2855         v)      verbose=true;;
2856         r)      root=$OPTARG;;
2857         x)      randomdata=true;;
2858         c)      randomdata=comp;;
2859         esac
2860     done
2861
2862     _descend $root $depth $randomdata
2863     wait
2864
2865     cd $here
2866
2867     [ $verbose = true ] && echo done
2868 }
2869
2870 # query whether the given file has the given inode flag set
2871 #
2872 _test_inode_flag()
2873 {
2874         flag=$1
2875         file=$2
2876
2877         if $XFS_IO_PROG -r -c 'lsattr -v' "$file" | grep -q "$flag" ; then
2878                 return 0
2879         fi
2880         return 1
2881 }
2882
2883 # query the given files extsize allocator hint in bytes (if any)
2884 #
2885 _test_inode_extsz()
2886 {
2887         file=$1
2888         blocks=""
2889
2890         blocks=`$XFS_IO_PROG -r -c 'stat' "$file" | \
2891                 awk '/^xattr.extsize =/ { print $3 }'`
2892         [ -z "$blocks" ] && blocks="0"
2893         echo $blocks
2894 }
2895
2896 # scratch_dev_pool should contain the disks pool for the btrfs raid
2897 _require_scratch_dev_pool()
2898 {
2899         local i
2900         local ndevs
2901
2902         if [ -z "$SCRATCH_DEV_POOL" ]; then
2903                 _notrun "this test requires a valid \$SCRATCH_DEV_POOL"
2904         fi
2905
2906         if [ -z "$1" ]; then
2907                 ndevs=2
2908         else
2909                 ndevs=$1
2910         fi
2911
2912         # btrfs test case needs ndevs or more scratch_dev_pool; other FS not sure
2913         # so fail it
2914         case $FSTYP in
2915         btrfs)
2916                 if [ "`echo $SCRATCH_DEV_POOL|wc -w`" -lt $ndevs ]; then
2917                         _notrun "btrfs and this test needs $ndevs or more disks in SCRATCH_DEV_POOL"
2918                 fi
2919         ;;
2920         *)
2921                 _notrun "dev_pool is not supported by fstype \"$FSTYP\""
2922         ;;
2923         esac
2924
2925         for i in $SCRATCH_DEV_POOL; do
2926                 if [ "`_is_block_dev "$i"`" = "" ]; then
2927                         _notrun "this test requires valid block disk $i"
2928                 fi
2929                 if [ "`_is_block_dev "$i"`" = "`_is_block_dev "$TEST_DEV"`" ]; then
2930                         _notrun "$i is part of TEST_DEV, this test requires unique disks"
2931                 fi
2932                 if _mount | grep -q $i; then
2933                         if ! $UMOUNT_PROG $i; then
2934                             echo "failed to unmount $i - aborting"
2935                             exit 1
2936                         fi
2937                 fi
2938                 # to help better debug when something fails, we remove
2939                 # traces of previous btrfs FS on the dev.
2940                 dd if=/dev/zero of=$i bs=4096 count=100 > /dev/null 2>&1
2941         done
2942 }
2943
2944 # ensure devices in SCRATCH_DEV_POOL are of the same size
2945 # must be called after _require_scratch_dev_pool
2946 _require_scratch_dev_pool_equal_size()
2947 {
2948         local _size
2949         local _newsize
2950         local _dev
2951
2952         # SCRATCH_DEV has been set to the first device in SCRATCH_DEV_POOL
2953         _size=`_get_device_size $SCRATCH_DEV`
2954         for _dev in $SCRATCH_DEV_POOL; do
2955                 _newsize=`_get_device_size $_dev`
2956                 if [ $_size -ne $_newsize ]; then
2957                         _notrun "This test requires devices in SCRATCH_DEV_POOL have the same size"
2958                 fi
2959         done
2960 }
2961
2962 # We will check if the device is deletable
2963 _require_deletable_scratch_dev_pool()
2964 {
2965         local i
2966         local x
2967         for i in $SCRATCH_DEV_POOL; do
2968                 x=`echo $i | cut -d"/" -f 3`
2969                 if [ ! -f /sys/class/block/${x}/device/delete ]; then
2970                         _notrun "$i is a device which is not deletable"
2971                 fi
2972         done
2973 }
2974
2975 # Check that fio is present, and it is able to execute given jobfile
2976 _require_fio()
2977 {
2978         job=$1
2979
2980         _require_command "$FIO_PROG" fio
2981         if [ -z "$1" ]; then
2982                 return 1;
2983         fi
2984
2985         $FIO_PROG --warnings-fatal --showcmd $job >> $seqres.full 2>&1
2986         [ $? -eq 0 ] || _notrun "$FIO_PROG too old, see $seqres.full"
2987 }
2988
2989 # Does freeze work on this fs?
2990 _require_freeze()
2991 {
2992         xfs_freeze -f "$TEST_DIR" >/dev/null 2>&1
2993         result=$?
2994         xfs_freeze -u "$TEST_DIR" >/dev/null 2>&1
2995         [ $result -eq 0 ] || _notrun "$FSTYP does not support freezing"
2996 }
2997
2998 # Does NFS export work on this fs?
2999 _require_exportfs()
3000 {
3001         _require_test_program "open_by_handle"
3002         mkdir -p "$TEST_DIR"/exportfs_test
3003         $here/src/open_by_handle -c "$TEST_DIR"/exportfs_test 2>&1 \
3004                 || _notrun "$FSTYP does not support NFS export"
3005 }
3006
3007
3008 # Does shutdown work on this fs?
3009 _require_scratch_shutdown()
3010 {
3011         [ -x src/godown ] || _notrun "src/godown executable not found"
3012
3013         _scratch_mkfs > /dev/null 2>&1
3014         _scratch_mount
3015         src/godown -f $SCRATCH_MNT 2>&1 \
3016                 || _notrun "$FSTYP does not support shutdown"
3017         _scratch_unmount
3018 }
3019
3020 # Does dax mount option work on this dev/fs?
3021 _require_scratch_dax()
3022 {
3023         _require_scratch
3024         _scratch_mkfs > /dev/null 2>&1
3025         _scratch_mount -o dax
3026         # Check options to be sure. XFS ignores dax option
3027         # and goes on if dev underneath does not support dax.
3028         _fs_options $SCRATCH_DEV | grep -qw "dax" || \
3029                 _notrun "$SCRATCH_DEV $FSTYP does not support -o dax"
3030         _scratch_unmount
3031 }
3032
3033 # Does norecovery support by this fs?
3034 _require_norecovery()
3035 {
3036         _scratch_mount -o ro,norecovery || \
3037                 _notrun "$FSTYP does not support norecovery"
3038         _scratch_unmount
3039 }
3040
3041 # Does this filesystem support metadata journaling?
3042 # We exclude ones here that don't; otherwise we assume that it does, so the
3043 # test will run, fail, and motivate someone to update this test for a new
3044 # filesystem.
3045 #
3046 # It's possible that TEST_DEV and SCRATCH_DEV have different features (it'd be
3047 # odd, but possible) so check $TEST_DEV by default, but we can optionall pass
3048 # any dev we want.
3049 _require_metadata_journaling()
3050 {
3051         if [ -z $1 ]; then
3052                 DEV=$TEST_DEV
3053         else
3054                 DEV=$1
3055         fi
3056
3057         case "$FSTYP" in
3058         ext2|vfat|msdos|udf)
3059                 _notrun "$FSTYP does not support metadata journaling"
3060                 ;;
3061         ext4)
3062                 # ext4 could be mkfs'd without a journal...
3063                 _require_dumpe2fs
3064                 $DUMPE2FS_PROG -h $DEV 2>&1 | grep -q has_journal || \
3065                         _notrun "$FSTYP on $DEV not configured with metadata journaling"
3066                 # ext4 might not load a journal
3067                 _exclude_scratch_mount_option "noload"
3068                 ;;
3069         *)
3070                 # by default we pass; if you need to, add your fs above!
3071                 ;;
3072         esac
3073 }
3074
3075 _count_extents()
3076 {
3077         $XFS_IO_PROG -c "fiemap" $1 | tail -n +2 | grep -v hole | wc -l
3078 }
3079
3080 _count_holes()
3081 {
3082         $XFS_IO_PROG -c "fiemap" $1 | tail -n +2 | grep hole | wc -l
3083 }
3084
3085 _count_attr_extents()
3086 {
3087         $XFS_IO_PROG -c "fiemap -a" $1 | tail -n +2 | grep -v hole | wc -l
3088 }
3089
3090 # arg 1 is dev to remove and is output of the below eg.
3091 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
3092 _devmgt_remove()
3093 {
3094         local lun=$1
3095         local disk=$2
3096
3097         echo 1 > /sys/class/scsi_device/${lun}/device/delete || _fail "Remove disk failed"
3098
3099         stat $disk > /dev/null 2>&1
3100         while [ $? -eq 0 ]; do
3101                 sleep 1
3102                 stat $disk > /dev/null 2>&1
3103         done
3104 }
3105
3106 # arg 1 is dev to add and is output of the below eg.
3107 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
3108 _devmgt_add()
3109 {
3110         local h
3111         local tdl
3112         # arg 1 will be in h:t:d:l format now in the h and "t d l" format
3113         h=`echo ${1} | cut -d":" -f 1`
3114         tdl=`echo ${1} | cut -d":" -f 2-|sed 's/:/ /g'`
3115
3116         echo ${tdl} >  /sys/class/scsi_host/host${h}/scan || _fail "Add disk failed"
3117
3118         # ensure the device comes online
3119         dev_back_oneline=0
3120         for i in `seq 1 10`; do
3121                 if [ -d /sys/class/scsi_device/${1}/device/block ]; then
3122                         dev=`ls /sys/class/scsi_device/${1}/device/block`
3123                         for j in `seq 1 10`;
3124                         do
3125                                 stat /dev/$dev > /dev/null 2>&1
3126                                 if [ $? -eq 0 ]; then
3127                                         dev_back_oneline=1
3128                                         break
3129                                 fi
3130                                 sleep 1
3131                         done
3132                         break
3133                 else
3134                         sleep 1
3135                 fi
3136         done
3137         if [ $dev_back_oneline -eq 0 ]; then
3138                 echo "/dev/$dev online failed" >> $seqres.full
3139         else
3140                 echo "/dev/$dev is back online" >> $seqres.full
3141         fi
3142 }
3143
3144 _require_fstrim()
3145 {
3146         if [ -z "$FSTRIM_PROG" ]; then
3147                 _notrun "This test requires fstrim utility."
3148         fi
3149 }
3150
3151 _require_batched_discard()
3152 {
3153         if [ $# -ne 1 ]; then
3154                 echo "Usage: _require_batched_discard mnt_point" 1>&2
3155                 exit 1
3156         fi
3157         _require_fstrim
3158         $FSTRIM_PROG $1 > /dev/null 2>&1 || _notrun "FITRIM not supported on $1"
3159 }
3160
3161 _require_dumpe2fs()
3162 {
3163         if [ -z "$DUMPE2FS_PROG" ]; then
3164                 _notrun "This test requires dumpe2fs utility."
3165         fi
3166 }
3167
3168 _require_ugid_map()
3169 {
3170         if [ ! -e /proc/self/uid_map ]; then
3171                 _notrun "This test requires procfs uid_map support."
3172         fi
3173         if [ ! -e /proc/self/gid_map ]; then
3174                 _notrun "This test requires procfs gid_map support."
3175         fi
3176 }
3177
3178 _require_fssum()
3179 {
3180         FSSUM_PROG=$here/src/fssum
3181         [ -x $FSSUM_PROG ] || _notrun "fssum not built"
3182 }
3183
3184 _require_cloner()
3185 {
3186         CLONER_PROG=$here/src/cloner
3187         [ -x $CLONER_PROG ] || \
3188                 _notrun "cloner binary not present at $CLONER_PROG"
3189 }
3190
3191 # Normalize mount options from global $MOUNT_OPTIONS
3192 # Convert options like "-o opt1,opt2 -oopt3" to
3193 # "opt1 opt2 opt3"
3194 _normalize_mount_options()
3195 {
3196         echo $MOUNT_OPTIONS | sed -n 's/-o\s*\(\S*\)/\1/gp'| sed 's/,/ /g'
3197 }
3198
3199 # skip test if MOUNT_OPTIONS contains the given strings
3200 _exclude_scratch_mount_option()
3201 {
3202         local mnt_opts=$(_normalize_mount_options)
3203
3204         while [ $# -gt 0 ]; do
3205                 if echo $mnt_opts | grep -qw "$1"; then
3206                         _notrun "mount option \"$1\" not allowed in this test"
3207                 fi
3208                 shift
3209         done
3210 }
3211
3212 _require_atime()
3213 {
3214         _exclude_scratch_mount_option "noatime"
3215         if [ "$FSTYP" == "nfs" ]; then
3216                 _notrun "atime related mount options have no effect on NFS"
3217         fi
3218 }
3219
3220 _require_relatime()
3221 {
3222         _scratch_mkfs > /dev/null 2>&1
3223         _scratch_mount -o relatime || \
3224                 _notrun "relatime not supported by the current kernel"
3225         _scratch_unmount
3226 }
3227
3228 _require_userns()
3229 {
3230         [ -x src/nsexec ] || _notrun "src/nsexec executable not found"
3231         src/nsexec -U true 2>/dev/null || _notrun "userns not supported by this kernel"
3232 }
3233
3234 _create_loop_device()
3235 {
3236         file=$1
3237         dev=`losetup -f --show $file` || _fail "Cannot assign $file to a loop device"
3238         echo $dev
3239 }
3240
3241 _destroy_loop_device()
3242 {
3243         dev=$1
3244         losetup -d $dev || _fail "Cannot destroy loop device $dev"
3245 }
3246
3247 _scale_fsstress_args()
3248 {
3249     args=""
3250     while [ $# -gt 0 ]; do
3251         case "$1" in
3252             -n) args="$args $1 $(($2 * $TIME_FACTOR))"; shift ;;
3253             -p) args="$args $1 $(($2 * $LOAD_FACTOR))"; shift ;;
3254             *) args="$args $1" ;;
3255         esac
3256         shift
3257     done
3258     echo $args
3259 }
3260
3261 #
3262 # Return the logical block size if running on a block device,
3263 # else substitute the page size.
3264 #
3265 _min_dio_alignment()
3266 {
3267     dev=$1
3268
3269     if [ -b "$dev" ]; then
3270         blockdev --getss $dev
3271     else
3272         $here/src/feature -s
3273     fi
3274 }
3275
3276 run_check()
3277 {
3278         echo "# $@" >> $seqres.full 2>&1
3279         "$@" >> $seqres.full 2>&1 || _fail "failed: '$@'"
3280 }
3281
3282 _require_test_symlinks()
3283 {
3284         target=`mktemp -p $TEST_DIR`
3285         link=`mktemp -p $TEST_DIR -u`
3286         ln -s `basename $target` $link
3287         if [ "$?" -ne 0 ]; then
3288                 rm -f $target
3289                 _notrun "Require symlinks support"
3290         fi
3291         rm -f $target $link
3292 }
3293
3294 _require_test_fcntl_advisory_locks()
3295 {
3296         [ "$FSTYP" != "cifs" ] && return 0
3297         cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -q "nobrl" && return 0
3298         cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -qE "nounix|forcemand" && \
3299                 _notrun "Require fcntl advisory locks support"
3300 }
3301
3302 _require_test_lsattr()
3303 {
3304         testio=$(lsattr -d $TEST_DIR 2>&1)
3305         echo $testio | grep -q "Operation not supported" && \
3306                 _notrun "lsattr not supported by test filesystem type: $FSTYP"
3307         echo $testio | grep -q "Inappropriate ioctl for device" && \
3308                 _notrun "lsattr not supported by test filesystem type: $FSTYP"
3309 }
3310
3311 _require_chattr()
3312 {
3313         if [ -z "$1" ]; then
3314                 echo "Usage: _require_chattr <attr>"
3315                 exit 1
3316         fi
3317         local attribute=$1
3318
3319         touch $TEST_DIR/syscalltest
3320         chattr "+$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
3321         status=$?
3322         chattr "-$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
3323         if [ "$status" -ne 0 ]; then
3324                 _notrun "file system doesn't support chattr +$attribute"
3325         fi
3326         cat $TEST_DIR/syscalltest.out >> $seqres.full
3327         rm -f $TEST_DIR/syscalltest.out
3328 }
3329
3330 _get_total_inode()
3331 {
3332         if [ -z "$1" ]; then
3333                 echo "Usage: _get_total_inode <mnt>"
3334                 exit 1
3335         fi
3336         local nr_inode;
3337         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $3}'`
3338         echo $nr_inode
3339 }
3340
3341 _get_used_inode()
3342 {
3343         if [ -z "$1" ]; then
3344                 echo "Usage: _get_used_inode <mnt>"
3345                 exit 1
3346         fi
3347         local nr_inode;
3348         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $4}'`
3349         echo $nr_inode
3350 }
3351
3352 _get_used_inode_percent()
3353 {
3354         if [ -z "$1" ]; then
3355                 echo "Usage: _get_used_inode_percent <mnt>"
3356                 exit 1
3357         fi
3358         local pct_inode;
3359         pct_inode=`$DF_PROG -i $1 | tail -1 | awk '{ print $6 }' | \
3360                    sed -e 's/%//'`
3361         echo $pct_inode
3362 }
3363
3364 _get_free_inode()
3365 {
3366         if [ -z "$1" ]; then
3367                 echo "Usage: _get_free_inode <mnt>"
3368                 exit 1
3369         fi
3370         local nr_inode;
3371         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $5}'`
3372         echo $nr_inode
3373 }
3374
3375 # get the available space in bytes
3376 #
3377 _get_available_space()
3378 {
3379         if [ -z "$1" ]; then
3380                 echo "Usage: _get_available_space <mnt>"
3381                 exit 1
3382         fi
3383         local avail_kb;
3384         avail_kb=`$DF_PROG $1 | tail -n1 | awk '{ print $5 }'`
3385         echo $((avail_kb * 1024))
3386 }
3387
3388 # return device size in kb
3389 _get_device_size()
3390 {
3391         grep `_short_dev $1` /proc/partitions | awk '{print $3}'
3392 }
3393
3394 # check dmesg log for WARNING/Oops/etc.
3395 _check_dmesg()
3396 {
3397         if [ ! -f ${RESULT_DIR}/check_dmesg ]; then
3398                 return 0
3399         fi
3400         rm -f ${RESULT_DIR}/check_dmesg
3401
3402         # default filter is a simple cat command, caller could provide a
3403         # customized filter and pass the name through the first argument, to
3404         # filter out intentional WARNINGs or Oopses
3405         filter=${1:-cat}
3406
3407         # search the dmesg log of last run of $seqnum for possible failures
3408         # use sed \cregexpc address type, since $seqnum contains "/"
3409         dmesg | tac | sed -ne "0,\#run fstests $seqnum at $date_time#p" | \
3410                 tac | $filter >$seqres.dmesg
3411         egrep -q -e "kernel BUG at" \
3412              -e "WARNING:" \
3413              -e "BUG:" \
3414              -e "Oops:" \
3415              -e "possible recursive locking detected" \
3416              -e "Internal error" \
3417              -e "(INFO|ERR): suspicious RCU usage" \
3418              -e "INFO: possible circular locking dependency detected" \
3419              -e "general protection fault:" \
3420              $seqres.dmesg
3421         if [ $? -eq 0 ]; then
3422                 _dump_err "_check_dmesg: something found in dmesg (see $seqres.dmesg)"
3423                 return 1
3424         else
3425                 rm -f $seqres.dmesg
3426                 return 0
3427         fi
3428 }
3429
3430 # don't check dmesg log after test
3431 _disable_dmesg_check()
3432 {
3433         rm -f ${RESULT_DIR}/check_dmesg
3434 }
3435
3436 init_rc()
3437 {
3438         if [ "$iam" == new ]
3439         then
3440                 return
3441         fi
3442         # make some further configuration checks here
3443         if [ "$TEST_DEV" = ""  ]
3444         then
3445                 echo "common/rc: Error: \$TEST_DEV is not set"
3446                 exit 1
3447         fi
3448
3449         # if $TEST_DEV is not mounted, mount it now as XFS
3450         if [ -z "`_fs_type $TEST_DEV`" ]
3451         then
3452                 # $TEST_DEV is not mounted
3453                 if ! _test_mount
3454                 then
3455                         echo "common/rc: retrying test device mount with external set"
3456                         [ "$USE_EXTERNAL" != "yes" ] && export USE_EXTERNAL=yes
3457                         if ! _test_mount
3458                         then
3459                                 echo "common/rc: could not mount $TEST_DEV on $TEST_DIR"
3460                                 exit 1
3461                         fi
3462                 fi
3463         fi
3464
3465         # Sanity check that TEST partition is not mounted at another mount point
3466         # or as another fs type
3467         _check_mounted_on TEST_DEV $TEST_DEV TEST_DIR $TEST_DIR $FSTYP || exit 1
3468         if [ -n "$SCRATCH_DEV" ]; then
3469                 # Sanity check that SCRATCH partition is not mounted at another
3470                 # mount point, because it is about to be unmounted and formatted.
3471                 # Another fs type for scratch is fine (bye bye old fs type).
3472                 _check_mounted_on SCRATCH_DEV $SCRATCH_DEV SCRATCH_MNT $SCRATCH_MNT
3473                 [ $? -le 1 ] || exit 1
3474         fi
3475
3476         # Figure out if we need to add -F ("foreign", deprecated) option to xfs_io
3477         $XFS_IO_PROG -c stat $TEST_DIR 2>&1 | grep -q "is not on an XFS filesystem" && \
3478                 export XFS_IO_PROG="$XFS_IO_PROG -F"
3479
3480         # xfs_io -i option starts an idle thread for xfs_io.
3481         # With single threaded process, the file table is not shared
3482         # and file structs are not reference counted.
3483         # Spawning an idle thread can help detecting file struct
3484         # reference leaks, so we want to enable the option whenever
3485         # it is supported.
3486         $XFS_IO_PROG -i -c quit 2>/dev/null && \
3487                 export XFS_IO_PROG="$XFS_IO_PROG -i"
3488
3489         # xfs_copy on v5 filesystems do not require the "-d" option if xfs_db
3490         # can change the UUID on v5 filesystems
3491         if [ "$FSTYP" == "xfs" ]; then
3492                 touch /tmp/$$.img
3493                 $MKFS_XFS_PROG -d file,name=/tmp/$$.img,size=512m >/dev/null 2>&1
3494                 # xfs_db will return 0 even if it can't generate a new uuid, so
3495                 # check the output to make sure if it can change UUID of V5 xfs
3496                 $XFS_DB_PROG -x -c "uuid generate" /tmp/$$.img \
3497                         | grep -q "invalid UUID\|supported on V5 fs" \
3498                         && export XFS_COPY_PROG="$XFS_COPY_PROG -d"
3499                 rm -f /tmp/$$.img
3500         fi
3501 }
3502
3503 # get real device path name by following link
3504 _real_dev()
3505 {
3506         local _dev=$1
3507         if [ -b "$_dev" ] && [ -L "$_dev" ]; then
3508                 _dev=`readlink -f "$_dev"`
3509         fi
3510         echo $_dev
3511 }
3512
3513 # basename of a device
3514 _short_dev()
3515 {
3516         echo `basename $(_real_dev $1)`
3517 }
3518
3519 _sysfs_dev()
3520 {
3521         local _dev=`_real_dev $1`
3522         local _maj=$(stat -c%t $_dev | tr [:lower:] [:upper:])
3523         local _min=$(stat -c%T $_dev | tr [:lower:] [:upper:])
3524         _maj=$(echo "ibase=16; $_maj" | bc)
3525         _min=$(echo "ibase=16; $_min" | bc)
3526         echo /sys/dev/block/$_maj:$_min
3527 }
3528
3529 # Get the minimum block size of a file.  Usually this is the
3530 # minimum fs block size, but some filesystems (ocfs2) do block
3531 # mappings in larger units.
3532 _get_file_block_size()
3533 {
3534         if [ -z $1 ] || [ ! -d $1 ]; then
3535                 echo "Missing mount point argument for _get_file_block_size"
3536                 exit 1
3537         fi
3538         if [ "$FSTYP" = "ocfs2" ]; then
3539                 stat -c '%o' $1
3540         else
3541                 _get_block_size $1
3542         fi
3543 }
3544
3545 # Get the minimum block size of an fs.
3546 _get_block_size()
3547 {
3548         if [ -z $1 ] || [ ! -d $1 ]; then
3549                 echo "Missing mount point argument for _get_block_size"
3550                 exit 1
3551         fi
3552         stat -f -c %S $1
3553 }
3554
3555 get_page_size()
3556 {
3557         echo $(getconf PAGE_SIZE)
3558 }
3559
3560
3561 run_fsx()
3562 {
3563         echo fsx $@
3564         args=`echo $@ | sed -e "s/ BSIZE / $bsize /g" -e "s/ PSIZE / $psize /g"`
3565         set -- $here/ltp/fsx $args $FSX_AVOID $TEST_DIR/junk
3566         echo "$@" >>$seqres.full
3567         rm -f $TEST_DIR/junk
3568         "$@" 2>&1 | tee -a $seqres.full >$tmp.fsx
3569         if [ ${PIPESTATUS[0]} -ne 0 ]; then
3570                 cat $tmp.fsx
3571                 rm -f $tmp.fsx
3572                 exit 1
3573         fi
3574         rm -f $tmp.fsx
3575 }
3576
3577 # Test for the existence of a sysfs entry at /sys/fs/$FSTYP/DEV/$ATTR
3578 #
3579 # Only one argument is needed:
3580 #  - attr: path name under /sys/fs/$FSTYP/DEV
3581 #
3582 # Usage example:
3583 #   _require_fs_sysfs error/fail_at_unmount
3584 _require_fs_sysfs()
3585 {
3586         local attr=$1
3587         local dname=$(_short_dev $TEST_DEV)
3588
3589         if [ -z "$attr" -o -z "$dname" ];then
3590                 _fail "Usage: _require_fs_sysfs <sysfs_attr_path>"
3591         fi
3592
3593         if [ ! -e /sys/fs/${FSTYP}/${dname}/${attr} ];then
3594                 _notrun "This test requires /sys/fs/${FSTYP}/${dname}/${attr}"
3595         fi
3596 }
3597
3598 _require_statx()
3599 {
3600         $here/src/stat_test --check-statx ||
3601         _notrun "This test requires the statx system call"
3602 }
3603
3604 # Write "content" into /sys/fs/$FSTYP/$DEV/$ATTR
3605 #
3606 # All arguments are necessary, and in this order:
3607 #  - dev: device name, e.g. $SCRATCH_DEV
3608 #  - attr: path name under /sys/fs/$FSTYP/$dev
3609 #  - content: the content of $attr
3610 #
3611 # Usage example:
3612 #   _set_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount 0
3613 _set_fs_sysfs_attr()
3614 {
3615         local dev=$1
3616         shift
3617         local attr=$1
3618         shift
3619         local content="$*"
3620
3621         if [ ! -b "$dev" -o -z "$attr" -o -z "$content" ];then
3622                 _fail "Usage: _set_fs_sysfs_attr <mounted_device> <attr> <content>"
3623         fi
3624
3625         local dname=$(_short_dev $dev)
3626         echo "$content" > /sys/fs/${FSTYP}/${dname}/${attr}
3627 }
3628
3629 # Print the content of /sys/fs/$FSTYP/$DEV/$ATTR
3630 #
3631 # All arguments are necessary, and in this order:
3632 #  - dev: device name, e.g. $SCRATCH_DEV
3633 #  - attr: path name under /sys/fs/$FSTYP/$dev
3634 #
3635 # Usage example:
3636 #   _get_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount
3637 _get_fs_sysfs_attr()
3638 {
3639         local dev=$1
3640         local attr=$2
3641
3642         if [ ! -b "$dev" -o -z "$attr" ];then
3643                 _fail "Usage: _get_fs_sysfs_attr <mounted_device> <attr>"
3644         fi
3645
3646         local dname=$(_short_dev $dev)
3647         cat /sys/fs/${FSTYP}/${dname}/${attr}
3648 }
3649
3650 # Print the value of a filesystem module parameter
3651 # at /sys/module/$FSTYP/parameters/$PARAM
3652 #
3653 # Usage example (FSTYP=overlay):
3654 #   _get_fs_module_param index
3655 _get_fs_module_param()
3656 {
3657         cat /sys/module/${FSTYP}/parameters/${1} 2>/dev/null
3658 }
3659
3660 # Generic test for specific filesystem feature.
3661 # Currently only implemented to test overlayfs features.
3662 _require_scratch_feature()
3663 {
3664         local feature=$1
3665
3666         case "$FSTYP" in
3667         overlay)
3668                 # overalyfs features (e.g. redirect_dir, index) are
3669                 # configurable from Kconfig (the build default), by module
3670                 # parameter (the system default) and per mount by mount
3671                 # option ${feature}=[on|off].
3672                 #
3673                 # If the module parameter does not exist then there is no
3674                 # point in checking the mount option.
3675                 local default=`_get_fs_module_param ${feature}`
3676                 [ "$default" = Y ] || [ "$default" = N ] || \
3677                         _notrun "feature '${feature}' not supported by ${FSTYP}"
3678
3679                 _scratch_mkfs > /dev/null 2>&1
3680                 _scratch_mount -o ${feature}=on || \
3681                         _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
3682                 # Check options to be sure. For example, Overlayfs will fallback to
3683                 # index=off if underlying fs does not support file handles.
3684                 # Overlayfs only displays mount option if it differs from the default.
3685                 # Overlayfs may enable the feature, but fallback to read-only mount.
3686                 ((( [ "$default" = N ] && _fs_options $SCRATCH_DEV | grep -q "${feature}=on" ) || \
3687                   ( [ "$default" = Y ] && ! _fs_options $SCRATCH_DEV | grep -q "${feature}=off" )) && \
3688                     touch $SCRATCH_MNT/foo 2>/dev/null ) || \
3689                         _notrun "${FSTYP} feature '${feature}' cannot be enabled on ${SCRATCH_DEV}"
3690                 _scratch_unmount
3691                 ;;
3692         *)
3693                 _fail "Test for feature '${feature}' of ${FSTYP} is not implemented"
3694                 ;;
3695         esac
3696 }
3697
3698
3699 init_rc
3700
3701 ################################################################################
3702 # make sure this script returns success
3703 /bin/true