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