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 # this test needs a scratch partition - check we're ok & unmount it
1358 # No post-test check of the device is required. e.g. the test intentionally
1359 # finishes the test with the filesystem in a corrupt state
1360 _require_scratch_nocheck()
1361 {
1362     case "$FSTYP" in
1363         nfs*|ceph)
1364                 echo $SCRATCH_DEV | grep -q ":/" > /dev/null 2>&1
1365                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1366                         _notrun "this test requires a valid \$SCRATCH_DEV"
1367                 fi
1368                 if [ ! -d "$SCRATCH_MNT" ]; then
1369                         _notrun "this test requires a valid \$SCRATCH_MNT"
1370                 fi
1371                 ;;
1372         cifs)
1373                 echo $SCRATCH_DEV | grep -q "//" > /dev/null 2>&1
1374                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1375                         _notrun "this test requires a valid \$SCRATCH_DEV"
1376                 fi
1377                 if [ ! -d "$SCRATCH_MNT" ]; then
1378                      _notrun "this test requires a valid \$SCRATCH_MNT"
1379                 fi
1380                 ;;
1381         overlay)
1382                 if [ -z "$SCRATCH_DEV" -o ! -d "$SCRATCH_DEV" ]; then
1383                         _notrun "this test requires a valid \$SCRATCH_DEV as ovl base dir"
1384                 fi
1385                 if [ ! -d "$SCRATCH_MNT" ]; then
1386                         _notrun "this test requires a valid \$SCRATCH_MNT"
1387                 fi
1388                 ;;
1389         tmpfs)
1390                 if [ -z "$SCRATCH_DEV" -o ! -d "$SCRATCH_MNT" ];
1391                 then
1392                     _notrun "this test requires a valid \$SCRATCH_MNT and unique $SCRATCH_DEV"
1393                 fi
1394                 ;;
1395         *)
1396                  if [ -z "$SCRATCH_DEV" -o "`_is_block_dev "$SCRATCH_DEV"`" = "" ]
1397                  then
1398                      _notrun "this test requires a valid \$SCRATCH_DEV"
1399                  fi
1400                  if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1401                  then
1402                      _notrun "this test requires a valid \$SCRATCH_DEV"
1403                  fi
1404                 if [ ! -d "$SCRATCH_MNT" ]
1405                 then
1406                      _notrun "this test requires a valid \$SCRATCH_MNT"
1407                 fi
1408                  ;;
1409     esac
1410
1411     # mounted?
1412     # Note that we use -F here so grep doesn't try to interpret an NFS over
1413     # IPv6 server as a regular expression.
1414     mount_rec=`_mount | grep -F $SCRATCH_DEV`
1415     if [ "$mount_rec" ]
1416     then
1417         # if it's mounted, make sure its on $SCRATCH_MNT
1418         if ! echo $mount_rec | grep -q $SCRATCH_MNT
1419         then
1420             echo "\$SCRATCH_DEV=$SCRATCH_DEV is mounted but not on \$SCRATCH_MNT=$SCRATCH_MNT - aborting"
1421             echo "Already mounted result:"
1422             echo $mount_rec
1423             exit 1
1424         fi
1425         # and then unmount it
1426         if ! _scratch_unmount
1427         then
1428             echo "failed to unmount $SCRATCH_DEV"
1429             exit 1
1430         fi
1431     fi
1432     rm -f ${RESULT_DIR}/require_scratch
1433 }
1434
1435 # we need the scratch device and it should be checked post test.
1436 _require_scratch()
1437 {
1438         _require_scratch_nocheck
1439         touch ${RESULT_DIR}/require_scratch
1440 }
1441
1442
1443 # this test needs a test partition - check we're ok & mount it
1444 #
1445 _require_test()
1446 {
1447     case "$FSTYP" in
1448         nfs*|ceph)
1449                 echo $TEST_DEV | grep -q ":/" > /dev/null 2>&1
1450                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1451                         _notrun "this test requires a valid \$TEST_DEV"
1452                 fi
1453                 if [ ! -d "$TEST_DIR" ]; then
1454                         _notrun "this test requires a valid \$TEST_DIR"
1455                 fi
1456                 ;;
1457         cifs)
1458                 echo $TEST_DEV | grep -q "//" > /dev/null 2>&1
1459                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1460                         _notrun "this test requires a valid \$TEST_DEV"
1461                 fi
1462                 if [ ! -d "$TEST_DIR" ]; then
1463                      _notrun "this test requires a valid \$TEST_DIR"
1464                 fi
1465                 ;;
1466         overlay)
1467                 if [ -z "$TEST_DEV" -o ! -d "$TEST_DEV" ]; then
1468                         _notrun "this test requires a valid \$TEST_DEV as ovl base dir"
1469                 fi
1470                 if [ ! -d "$TEST_DIR" ]; then
1471                         _notrun "this test requires a valid \$TEST_DIR"
1472                 fi
1473                 ;;
1474         tmpfs)
1475                 if [ -z "$TEST_DEV" -o ! -d "$TEST_DIR" ];
1476                 then
1477                     _notrun "this test requires a valid \$TEST_DIR and unique $TEST_DEV"
1478                 fi
1479                 ;;
1480         *)
1481                  if [ -z "$TEST_DEV" ] || [ "`_is_block_dev "$TEST_DEV"`" = "" ]
1482                  then
1483                      _notrun "this test requires a valid \$TEST_DEV"
1484                  fi
1485                  if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1486                  then
1487                      _notrun "this test requires a valid \$TEST_DEV"
1488                  fi
1489                 if [ ! -d "$TEST_DIR" ]
1490                 then
1491                      _notrun "this test requires a valid \$TEST_DIR"
1492                 fi
1493                  ;;
1494     esac
1495
1496     # mounted?
1497     # Note that we use -F here so grep doesn't try to interpret an NFS over
1498     # IPv6 server as a regular expression.
1499     mount_rec=`_mount | grep -F $TEST_DEV`
1500     if [ "$mount_rec" ]
1501     then
1502         # if it's mounted, make sure its on $TEST_DIR
1503         if ! echo $mount_rec | grep -q $TEST_DIR
1504         then
1505             echo "\$TEST_DEV=$TEST_DEV is mounted but not on \$TEST_DIR=$TEST_DIR - aborting"
1506             echo "Already mounted result:"
1507             echo $mount_rec
1508             exit 1
1509         fi
1510     else
1511         out=`_mount_or_remount_rw "$MOUNT_OPTIONS" $TEST_DEV $TEST_DIR`
1512         if [ $? -ne 1 ]; then
1513                 echo $out
1514                 exit 1
1515         fi
1516     fi
1517     touch ${RESULT_DIR}/require_test
1518 }
1519
1520 # this test needs a logdev
1521 #
1522 _require_logdev()
1523 {
1524     [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && \
1525         _notrun "This test requires a valid \$SCRATCH_LOGDEV"
1526     [ "$USE_EXTERNAL" != yes ] && \
1527         _notrun "This test requires USE_EXTERNAL to be enabled"
1528
1529     # ensure its not mounted
1530     $UMOUNT_PROG $SCRATCH_LOGDEV 2>/dev/null
1531 }
1532
1533 # this test requires loopback device support
1534 #
1535 _require_loop()
1536 {
1537     if [ "$HOSTOS" != "Linux" ]
1538     then
1539         _notrun "This test requires linux for loopback device support"
1540     fi
1541
1542     modprobe loop >/dev/null 2>&1
1543     if grep loop /proc/devices >/dev/null 2>&1
1544     then
1545         :
1546     else
1547         _notrun "This test requires loopback device support"
1548     fi
1549 }
1550
1551 # this test requires ext2 filesystem support
1552 #
1553 _require_ext2()
1554 {
1555     if [ "$HOSTOS" != "Linux" ]
1556     then
1557         _notrun "This test requires linux for ext2 filesystem support"
1558     fi
1559
1560     modprobe ext2 >/dev/null 2>&1
1561     if grep ext2 /proc/filesystems >/dev/null 2>&1
1562     then
1563         :
1564     else
1565         _notrun "This test requires ext2 filesystem support"
1566     fi
1567 }
1568
1569 # this test requires tmpfs filesystem support
1570 #
1571 _require_tmpfs()
1572 {
1573         modprobe tmpfs >/dev/null 2>&1
1574         grep -q tmpfs /proc/filesystems ||
1575                 _notrun "this test requires tmpfs support"
1576 }
1577
1578 # this test requires that (large) loopback device files are not in use
1579 #
1580 _require_no_large_scratch_dev()
1581 {
1582     [ "$LARGE_SCRATCH_DEV" = yes ] && \
1583         _notrun "Large filesystem testing in progress, skipped this test"
1584 }
1585
1586 # this test requires that a realtime subvolume is in use, and
1587 # that the kernel supports realtime as well.
1588 #
1589 _require_realtime()
1590 {
1591     [ "$USE_EXTERNAL" = yes ] || \
1592         _notrun "External volumes not in use, skipped this test"
1593     [ "$SCRATCH_RTDEV" = "" ] && \
1594         _notrun "Realtime device required, skipped this test"
1595 }
1596
1597 # this test requires that a specified command (executable) exists
1598 # $1 - command, $2 - name for error message
1599 #
1600 # Note: the command string might have parameters, so strip them before checking
1601 # whether it is executable.
1602 _require_command()
1603 {
1604         if [ $# -eq 2 ]; then
1605                 _name="$2"
1606         elif [ $# -eq 1 ]; then
1607                 _name="$1"
1608         else
1609                 _fail "usage: _require_command <command> [<name>]"
1610         fi
1611
1612         _command=`echo "$1" | awk '{ print $1 }'`
1613         if [ ! -x "$_command" ]; then
1614                 _notrun "$_name utility required, skipped this test"
1615         fi
1616 }
1617
1618 # this test requires the device to be valid block device
1619 # $1 - device
1620 _require_block_device()
1621 {
1622         if [ -z "$1" ]; then
1623                 echo "Usage: _require_block_device <dev>" 1>&2
1624                 exit 1
1625         fi
1626         if [ "`_is_block_dev "$1"`" == "" ]; then
1627                 _notrun "require $1 to be valid block disk"
1628         fi
1629 }
1630
1631 # brd based ram disks erase the device when they receive a flush command when no
1632 # active references are present. This causes problems for DM devices sitting on
1633 # top of brd devices as DM doesn't hold active references to the brd device.
1634 _require_sane_bdev_flush()
1635 {
1636         echo $1 | grep -q "^/dev/ram[0-9]\+$"
1637         if [ $? -eq 0 ]; then
1638                 _notrun "This test requires a sane block device flush"
1639         fi
1640 }
1641
1642 # this test requires a specific device mapper target
1643 _require_dm_target()
1644 {
1645         _target=$1
1646
1647         # require SCRATCH_DEV to be a valid block device with sane BLKFLSBUF
1648         # behaviour
1649         _require_block_device $SCRATCH_DEV
1650         _require_sane_bdev_flush $SCRATCH_DEV
1651         _require_command "$DMSETUP_PROG" dmsetup
1652
1653         modprobe dm-$_target >/dev/null 2>&1
1654
1655         $DMSETUP_PROG targets 2>&1 | grep -q ^$_target
1656         if [ $? -ne 0 ]; then
1657                 _notrun "This test requires dm $_target support"
1658         fi
1659 }
1660
1661 # this test requires the ext4 kernel support crc feature on scratch device
1662 #
1663 _require_scratch_ext4_crc()
1664 {
1665         _scratch_mkfs_ext4 >/dev/null 2>&1
1666         dumpe2fs -h $SCRATCH_DEV 2> /dev/null | grep -q metadata_csum || _notrun "metadata_csum not supported by this filesystem"
1667         _scratch_mount >/dev/null 2>&1 \
1668            || _notrun "Kernel doesn't support metadata_csum feature"
1669         _scratch_unmount
1670 }
1671
1672 # this test requires the bigalloc feature to be available in mkfs.ext4
1673 #
1674 _require_ext4_mkfs_bigalloc()
1675 {
1676         $MKFS_EXT4_PROG -F -O bigalloc -n $SCRATCH_DEV 512m >/dev/null 2>&1 \
1677            || _notrun "mkfs.ext4 doesn't have bigalloc feature"
1678 }
1679
1680 # this test requires the ext4 kernel support bigalloc feature
1681 #
1682 _require_ext4_bigalloc()
1683 {
1684         $MKFS_EXT4_PROG -F -O bigalloc $SCRATCH_DEV 512m >/dev/null 2>&1
1685         _scratch_mount >/dev/null 2>&1 \
1686            || _notrun "Ext4 kernel doesn't support bigalloc feature"
1687         _scratch_unmount
1688 }
1689
1690 # this test requires that external log/realtime devices are not in use
1691 #
1692 _require_nonexternal()
1693 {
1694     [ "$USE_EXTERNAL" = yes ] && \
1695         _notrun "External device testing in progress, skipped this test"
1696 }
1697
1698 # this test requires that a (specified) aio-dio executable exists
1699 # $1 - command (optional)
1700 #
1701 _require_aiodio()
1702 {
1703     if [ -z "$1" ]
1704     then
1705         AIO_TEST=src/aio-dio-regress/aiodio_sparse2
1706         [ -x $AIO_TEST ] || _notrun "aio-dio utilities required"
1707     else
1708         AIO_TEST=src/aio-dio-regress/$1
1709         [ -x $AIO_TEST ] || _notrun "$AIO_TEST not built"
1710     fi
1711     _require_odirect
1712 }
1713
1714 # this test requires that a test program exists under src/
1715 # $1 - command (require)
1716 #
1717 _require_test_program()
1718 {
1719     SRC_TEST=src/$1
1720     [ -x $SRC_TEST ] || _notrun "$SRC_TEST not built"
1721 }
1722
1723 # run an aio-dio program
1724 # $1 - command
1725 _run_aiodio()
1726 {
1727     if [ -z "$1" ]
1728     then
1729         echo "usage: _run_aiodio command_name" 2>&1
1730         status=1; exit 1
1731     fi
1732
1733     _require_aiodio $1
1734
1735     local testtemp=$TEST_DIR/aio-testfile
1736     rm -f $testtemp
1737     $AIO_TEST $testtemp 2>&1
1738     status=$?
1739     rm -f $testtemp
1740
1741     return $status
1742 }
1743
1744 # this test requires y2038 sysfs switch and filesystem
1745 # timestamp ranges support.
1746 _require_y2038()
1747 {
1748         local device=${1:-$TEST_DEV}
1749         local sysfsdir=/proc/sys/fs/fs-timestamp-check-on
1750
1751         if [ ! -e $sysfsdir ]; then
1752                 _notrun "no kernel support for y2038 sysfs switch"
1753         fi
1754
1755         local tsmin tsmax
1756         read tsmin tsmax <<<$(_filesystem_timestamp_range $device)
1757         if [ $tsmin -eq -1 -a $tsmax -eq -1 ]; then
1758                 _notrun "filesystem $FSTYP timestamp bounds are unknown"
1759         fi
1760 }
1761
1762 _filesystem_timestamp_range()
1763 {
1764         device=${1:-$TEST_DEV}
1765         case $FSTYP in
1766         ext4)
1767                 if [ $(dumpe2fs -h $device 2>/dev/null | grep "Inode size:" | cut -d: -f2) -gt 128 ]; then
1768                         echo "-2147483648 15032385535"
1769                 else
1770                         echo "-2147483648 2147483647"
1771                 fi
1772                 ;;
1773
1774         xfs)
1775                 echo "-2147483648 2147483647"
1776                 ;;
1777         jfs)
1778                 echo "0 4294967295"
1779                 ;;
1780         f2fs)
1781                 echo "-2147483648 2147483647"
1782                 ;;
1783         *)
1784                 echo "-1 -1"
1785                 ;;
1786         esac
1787 }
1788
1789 # indicate whether YP/NIS is active or not
1790 #
1791 _yp_active()
1792 {
1793         local dn
1794         dn=$(domainname 2>/dev/null)
1795         test -n "${dn}" -a "${dn}" != "(none)" -a "${dn}" != "localdomain"
1796         echo $?
1797 }
1798
1799 # cat the password file
1800 #
1801 _cat_passwd()
1802 {
1803         [ $(_yp_active) -eq 0 ] && ypcat passwd
1804         cat /etc/passwd
1805 }
1806
1807 # cat the group file
1808 #
1809 _cat_group()
1810 {
1811         [ $(_yp_active) -eq 0 ] && ypcat group
1812         cat /etc/group
1813 }
1814
1815 # check for a user on the machine, fsgqa as default
1816 #
1817 _require_user()
1818 {
1819     qa_user=fsgqa
1820     if [ -n "$1" ];then
1821         qa_user=$1
1822     fi
1823     _cat_passwd | grep -q $qa_user
1824     [ "$?" == "0" ] || _notrun "$qa_user user not defined."
1825     echo /bin/true | su $qa_user
1826     [ "$?" == "0" ] || _notrun "$qa_user cannot execute commands."
1827 }
1828
1829 # check for a group on the machine, fsgqa as default
1830 #
1831 _require_group()
1832 {
1833     qa_group=fsgqa
1834     if [ -n "$1" ];then
1835         qa_group=$1
1836     fi
1837     _cat_group | grep -q $qa_group
1838     [ "$?" == "0" ] || _notrun "$qa_group user not defined."
1839 }
1840
1841 _filter_user_do()
1842 {
1843         perl -ne "
1844 s,.*Permission\sdenied.*,Permission denied,;
1845 s,.*no\saccess\sto\stty.*,,;
1846 s,.*no\sjob\scontrol\sin\sthis\sshell.*,,;
1847 s,^\s*$,,;
1848         print;"
1849 }
1850
1851 _user_do()
1852 {
1853     if [ "$HOSTOS" == "IRIX" ]
1854         then
1855         echo $1 | /bin/bash "su $qa_user 2>&1" | _filter_user_do
1856     else
1857         echo $1 | su -s /bin/bash $qa_user 2>&1 | _filter_user_do
1858     fi
1859 }
1860
1861 _require_xfs_io_command()
1862 {
1863         if [ -z "$1" ]
1864         then
1865                 echo "Usage: _require_xfs_io_command command [switch]" 1>&2
1866                 exit 1
1867         fi
1868         command=$1
1869         shift
1870         param="$*"
1871
1872         testfile=$TEST_DIR/$$.xfs_io
1873         case $command in
1874         "chproj")
1875                 testio=`$XFS_IO_PROG -F -f -c "chproj 0" $testfile 2>&1`
1876                 ;;
1877         "falloc" )
1878                 testio=`$XFS_IO_PROG -F -f -c "falloc 0 1m" $testfile 2>&1`
1879                 ;;
1880         "fpunch" | "fcollapse" | "zero" | "fzero" | "finsert" | "funshare")
1881                 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
1882                         -c "$command 4k 8k" $testfile 2>&1`
1883                 ;;
1884         "fiemap")
1885                 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
1886                         -c "fiemap -v" $testfile 2>&1`
1887                 ;;
1888         "flink" )
1889                 testio=`$XFS_IO_PROG -T -F -c "flink $testfile" \
1890                         $TEST_DIR 2>&1`
1891                 echo $testio | egrep -q "invalid option|Is a directory" && \
1892                         _notrun "xfs_io $command support is missing"
1893                 ;;
1894         "fsmap" )
1895                 testio=`$XFS_IO_PROG -f -c "fsmap" $testfile 2>&1`
1896                 echo $testio | egrep -q "Inappropriate ioctl" && \
1897                         _notrun "xfs_io $command support is missing"
1898                 ;;
1899         "open")
1900                 # -c "open $f" is broken in xfs_io <= 4.8. Along with the fix,
1901                 # a new -C flag was introduced to execute one shot commands.
1902                 # Check for -C flag support as an indication for the bug fix.
1903                 testio=`$XFS_IO_PROG -F -f -C "open $testfile" $testfile 2>&1`
1904                 echo $testio | egrep -q "invalid option" && \
1905                         _notrun "xfs_io $command support is missing"
1906                 ;;
1907         "utimes" )
1908                 testio=`$XFS_IO_PROG -f -c "utimes" 0 0 0 0 $testfile 2>&1`
1909                 ;;
1910         *)
1911                 testio=`$XFS_IO_PROG -c "$command help" 2>&1`
1912         esac
1913
1914         rm -f $testfile 2>&1 > /dev/null
1915         echo $testio | grep -q "not found" && \
1916                 _notrun "xfs_io $command support is missing"
1917         echo $testio | grep -q "Operation not supported" && \
1918                 _notrun "xfs_io $command failed (old kernel/wrong fs?)"
1919         echo $testio | grep -q "foreign file active" && \
1920                 _notrun "xfs_io $command not supported on $FSTYP"
1921
1922         test -z "$param" && return
1923         $XFS_IO_PROG -c "help $command" | grep -q "^ $param --" || \
1924                 _notrun "xfs_io $command doesn't support $param"
1925 }
1926
1927 # check that kernel and filesystem support direct I/O
1928 _require_odirect()
1929 {
1930         if [ $FSTYP = "ext4" ] ; then
1931                 if echo "$MOUNT_OPTIONS" | grep -q "test_dummy_encryption"; then
1932                         _notrun "ext4 encryption doesn't support O_DIRECT"
1933                 fi
1934         fi
1935         testfile=$TEST_DIR/$$.direct
1936         $XFS_IO_PROG -F -f -d -c "pwrite 0 20k" $testfile > /dev/null 2>&1
1937         if [ $? -ne 0 ]; then
1938                 _notrun "O_DIRECT is not supported"
1939         fi
1940         rm -f $testfile 2>&1 > /dev/null
1941 }
1942
1943 # Check that the filesystem supports swapfiles
1944 _require_scratch_swapfile()
1945 {
1946         _require_scratch
1947
1948         _scratch_mkfs >/dev/null
1949         _scratch_mount
1950
1951         # Minimum size for mkswap is 10 pages
1952         local size=$(($(get_page_size) * 10))
1953
1954         _pwrite_byte 0x61 0 "$size" "$SCRATCH_MNT/swap" >/dev/null 2>&1
1955         mkswap "$SCRATCH_MNT/swap" >/dev/null 2>&1
1956         if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
1957                 _scratch_unmount
1958                 _notrun "swapfiles are not supported"
1959         fi
1960
1961         swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
1962         _scratch_unmount
1963 }
1964
1965 # Check that a fs has enough free space (in 1024b blocks)
1966 #
1967 _require_fs_space()
1968 {
1969         MNT=$1
1970         BLOCKS=$2       # in units of 1024
1971         let GB=$BLOCKS/1024/1024
1972
1973         FREE_BLOCKS=`df -kP $MNT | grep -v Filesystem | awk '{print $4}'`
1974         [ $FREE_BLOCKS -lt $BLOCKS ] && \
1975                 _notrun "This test requires at least ${GB}GB free on $MNT to run"
1976 }
1977
1978 #
1979 # Check if the filesystem supports sparse files.
1980 #
1981 # Unfortunately there is no better way to do this than a manual black list.
1982 #
1983 _require_sparse_files()
1984 {
1985     case $FSTYP in
1986     hfsplus)
1987         _notrun "Sparse files not supported by this filesystem type: $FSTYP"
1988         ;;
1989     *)
1990         ;;
1991     esac
1992 }
1993
1994 _require_debugfs()
1995 {
1996     #boot_params always present in debugfs
1997     [ -d "$DEBUGFS_MNT/boot_params" ] || _notrun "Debugfs not mounted"
1998 }
1999
2000 _require_fail_make_request()
2001 {
2002     [ -f "$DEBUGFS_MNT/fail_make_request/probability" ] \
2003         || _notrun "$DEBUGFS_MNT/fail_make_request \
2004  not found. Seems that CONFIG_FAIL_MAKE_REQUEST kernel config option not enabled"
2005 }
2006
2007 #
2008 # Check if the file system supports seek_data/hole
2009 #
2010 _require_seek_data_hole()
2011 {
2012     testfile=$TEST_DIR/$$.seek
2013     testseek=`$here/src/seek_sanity_test -t $testfile 2>&1`
2014     rm -f $testfile &>/dev/null
2015     echo $testseek | grep -q "Kernel does not support" && \
2016         _notrun "File system does not support llseek(2) SEEK_DATA/HOLE"
2017 }
2018
2019 _require_runas()
2020 {
2021         _require_test_program "runas"
2022 }
2023
2024 _runas()
2025 {
2026         "$here/src/runas" "$@"
2027 }
2028
2029 _require_richacl_prog()
2030 {
2031         _require_command "$GETRICHACL_PROG" getrichacl
2032         _require_command "$SETRICHACL_PROG" setrichacl
2033 }
2034
2035 _require_scratch_richacl_xfs()
2036 {
2037         _scratch_mkfs_xfs_supported -m richacl=1 >/dev/null 2>&1 \
2038                 || _notrun "mkfs.xfs doesn't have richacl feature"
2039         _scratch_mkfs_xfs -m richacl=1 >/dev/null 2>&1
2040         _scratch_mount >/dev/null 2>&1 \
2041                 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2042         _scratch_unmount
2043 }
2044
2045 _require_scratch_richacl_ext4()
2046 {
2047         _scratch_mkfs -O richacl >/dev/null 2>&1 \
2048                 || _notrun "can't mkfs $FSTYP with option -O richacl"
2049         _scratch_mount >/dev/null 2>&1 \
2050                 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2051         _scratch_unmount
2052 }
2053
2054 _require_scratch_richacl_support()
2055 {
2056         _scratch_mount
2057         $GETFATTR_PROG -n system.richacl >/dev/null 2>&1 \
2058                 || _notrun "this test requires richacl support on \$SCRATCH_DEV"
2059         _scratch_unmount
2060 }
2061
2062 _require_scratch_richacl()
2063 {
2064         case "$FSTYP" in
2065         xfs)    _require_scratch_richacl_xfs
2066                 ;;
2067         ext4)   _require_scratch_richacl_ext4
2068                 ;;
2069         nfs*|cifs|overlay)
2070                 _require_scratch_richacl_support
2071                 ;;
2072         *)      _notrun "this test requires richacl support on \$SCRATCH_DEV"
2073                 ;;
2074         esac
2075 }
2076
2077 _scratch_mkfs_richacl()
2078 {
2079         case "$FSTYP" in
2080         xfs)    _scratch_mkfs_xfs -m richacl=1
2081                 ;;
2082         ext4)   _scratch_mkfs -O richacl
2083                 ;;
2084         nfs*|cifs|overlay)
2085                 _scratch_mkfs
2086                 ;;
2087         esac
2088 }
2089
2090 # check that a FS on a device is mounted
2091 # if so, return mount point
2092 #
2093 _is_mounted()
2094 {
2095     if [ $# -ne 1 ]
2096     then
2097         echo "Usage: _is_mounted device" 1>&2
2098         exit 1
2099     fi
2100
2101     device=$1
2102
2103     if _mount | grep "$device " | $AWK_PROG -v pattern="type $FSTYP" '
2104         pattern        { print $3 ; exit 0 }
2105         END            { exit 1 }
2106     '
2107     then
2108         echo "_is_mounted: $device is not a mounted $FSTYP FS"
2109         exit 1
2110     fi
2111 }
2112
2113 # remount a FS to a new mode (ro or rw)
2114 #
2115 _remount()
2116 {
2117     if [ $# -ne 2 ]
2118     then
2119         echo "Usage: _remount device ro/rw" 1>&2
2120         exit 1
2121     fi
2122     device=$1
2123     mode=$2
2124
2125     if ! mount -o remount,$mode $device
2126     then
2127         echo "_remount: failed to remount filesystem on $device as $mode"
2128         exit 1
2129     fi
2130 }
2131
2132 # Run the appropriate repair/check on a filesystem
2133 #
2134 # if the filesystem is mounted, it's either remounted ro before being
2135 # checked or it's unmounted and then remounted
2136 #
2137
2138 # If set, we remount ro instead of unmounting for fsck
2139 USE_REMOUNT=0
2140
2141 _umount_or_remount_ro()
2142 {
2143     if [ $# -ne 1 ]
2144     then
2145         echo "Usage: _umount_or_remount_ro <device>" 1>&2
2146         exit 1
2147     fi
2148
2149     device=$1
2150     mountpoint=`_is_mounted $device`
2151
2152     if [ $USE_REMOUNT -eq 0 ]; then
2153         $UMOUNT_PROG $device
2154     else
2155         _remount $device ro
2156     fi
2157     echo "$mountpoint"
2158 }
2159
2160 _mount_or_remount_rw()
2161 {
2162         if [ $# -ne 3 ]; then
2163                 echo "Usage: _mount_or_remount_rw <opts> <dev> <mnt>" 1>&2
2164                 exit 1
2165         fi
2166         mount_opts=$1
2167         device=$2
2168         mountpoint=$3
2169
2170         if [ $USE_REMOUNT -eq 0 ]; then
2171                 if [ "$FSTYP" != "overlay" ]; then
2172                         _mount -t $FSTYP $mount_opts $device $mountpoint
2173                 else
2174                         _overlay_mount $device $mountpoint
2175                 fi
2176                 if [ $? -ne 0 ]; then
2177                         echo "!!! failed to remount $device on $mountpoint"
2178                         return 0 # ok=0
2179                 fi
2180         else
2181                 _remount $device rw
2182         fi
2183
2184         return 1 # ok=1
2185 }
2186
2187 # Check a generic filesystem in no-op mode; this assumes that the
2188 # underlying fsck program accepts "-n" for a no-op (check-only) run,
2189 # and that it will still return an errno for corruption in this mode.
2190 #
2191 # Filesystems which don't support this will need to define their
2192 # own check routine.
2193 #
2194 _check_generic_filesystem()
2195 {
2196     device=$1
2197
2198     # If type is set, we're mounted
2199     type=`_fs_type $device`
2200     ok=1
2201
2202     if [ "$type" = "$FSTYP" ]
2203     then
2204         # mounted ...
2205         mountpoint=`_umount_or_remount_ro $device`
2206     fi
2207
2208     fsck -t $FSTYP $FSCK_OPTIONS $device >$tmp.fsck 2>&1
2209     if [ $? -ne 0 ]
2210     then
2211         echo "_check_generic_filesystem: filesystem on $device is inconsistent (see $seqres.full)"
2212
2213         echo "_check_generic filesystem: filesystem on $device is inconsistent" >>$seqres.full
2214         echo "*** fsck.$FSTYP output ***"       >>$seqres.full
2215         cat $tmp.fsck                           >>$seqres.full
2216         echo "*** end fsck.$FSTYP output"       >>$seqres.full
2217
2218         ok=0
2219     fi
2220     rm -f $tmp.fsck
2221
2222     if [ $ok -eq 0 ]
2223     then
2224         echo "*** mount output ***"             >>$seqres.full
2225         _mount                                  >>$seqres.full
2226         echo "*** end mount output"             >>$seqres.full
2227     elif [ "$type" = "$FSTYP" ]
2228     then
2229         # was mounted ...
2230         _mount_or_remount_rw "$MOUNT_OPTIONS" $device $mountpoint
2231         ok=$?
2232     fi
2233
2234     if [ $ok -eq 0 ]; then
2235         status=1
2236         if [ "$iam" != "check" ]; then
2237                 exit 1
2238         fi
2239         return 1
2240     fi
2241
2242     return 0
2243 }
2244
2245 # Filter the knowen errors the UDF Verifier reports.
2246 _udf_test_known_error_filter()
2247 {
2248         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."
2249
2250 }
2251
2252 _check_udf_filesystem()
2253 {
2254     [ "$DISABLE_UDF_TEST" == "1" ] && return
2255
2256     if [ $# -ne 1 -a $# -ne 2 ]
2257     then
2258         echo "Usage: _check_udf_filesystem device [last_block]" 1>&2
2259         exit 1
2260     fi
2261
2262     if [ ! -x $here/src/udf_test ]
2263     then
2264         echo "udf_test not installed, please download and build the Philips"
2265         echo "UDF Verification Software from http://www.extra.research.philips.com/udf/."
2266         echo "Then copy the udf_test binary to $here/src/."
2267         echo "If you do not wish to run udf_test then set environment variable DISABLE_UDF_TEST"
2268         echo "to 1."
2269         return
2270     fi
2271
2272     device=$1
2273     if [ $# -eq 2 ];
2274     then
2275         LAST_BLOCK=`expr \( $2 - 1 \)`
2276         OPT_ARG="-lastvalidblock $LAST_BLOCK"
2277     fi
2278
2279     rm -f $seqres.checkfs
2280     sleep 1 # Due to a problem with time stamps in udf_test
2281     $here/src/udf_test $OPT_ARG $device | tee $seqres.checkfs | egrep "Error|Warning" | \
2282         _udf_test_known_error_filter | \
2283         egrep -iv "Error count:.*[0-9]+.*total occurrences:.*[0-9]+|Warning count:.*[0-9]+.*total occurrences:.*[0-9]+" && \
2284         echo "Warning UDF Verifier reported errors see $seqres.checkfs." && return 1
2285     return 0
2286 }
2287
2288 _check_test_fs()
2289 {
2290     case $FSTYP in
2291     xfs)
2292         _check_xfs_test_fs
2293         ;;
2294     nfs)
2295         # no way to check consistency for nfs
2296         ;;
2297     cifs)
2298         # no way to check consistency for cifs
2299         ;;
2300     ceph)
2301         # no way to check consistency for CephFS
2302         ;;
2303     overlay)
2304         # no way to check consistency for overlay
2305         ;;
2306     udf)
2307         # do nothing for now
2308         ;;
2309     btrfs)
2310         _check_btrfs_filesystem $TEST_DEV
2311         ;;
2312     tmpfs)
2313         # no way to check consistency for tmpfs
2314         ;;
2315     *)
2316         _check_generic_filesystem $TEST_DEV
2317         ;;
2318     esac
2319 }
2320
2321 _check_scratch_fs()
2322 {
2323     device=$SCRATCH_DEV
2324     [ $# -eq 1 ] && device=$1
2325
2326     case $FSTYP in
2327     xfs)
2328         SCRATCH_LOG="none"
2329         SCRATCH_RT="none"
2330         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
2331             SCRATCH_LOG="$SCRATCH_LOGDEV"
2332
2333         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
2334             SCRATCH_RT="$SCRATCH_RTDEV"
2335
2336         _check_xfs_filesystem $device $SCRATCH_LOG $SCRATCH_RT
2337         ;;
2338     udf)
2339         _check_udf_filesystem $device $udf_fsize
2340         ;;
2341     nfs*)
2342         # Don't know how to check an NFS filesystem, yet.
2343         ;;
2344     cifs)
2345         # Don't know how to check a CIFS filesystem, yet.
2346         ;;
2347     ceph)
2348         # no way to check consistency for CephFS
2349         ;;
2350     overlay)
2351         # no way to check consistency for overlay
2352         ;;
2353     btrfs)
2354         _check_btrfs_filesystem $device
2355         ;;
2356     tmpfs)
2357         # no way to check consistency for tmpfs
2358         ;;
2359     *)
2360         _check_generic_filesystem $device
2361         ;;
2362     esac
2363 }
2364
2365 _full_fstyp_details()
2366 {
2367      [ -z "$FSTYP" ] && FSTYP=xfs
2368      if [ $FSTYP = xfs ]; then
2369         if [ -d /proc/fs/xfs ]; then
2370             if grep -q 'debug 0' /proc/fs/xfs/stat; then
2371                 FSTYP="$FSTYP (non-debug)"
2372             elif grep -q 'debug 1' /proc/fs/xfs/stat; then
2373                 FSTYP="$FSTYP (debug)"
2374             fi
2375         else
2376             if uname -a | grep -qi 'debug'; then
2377                 FSTYP="$FSTYP (debug)"
2378             else
2379                 FSTYP="$FSTYP (non-debug)"
2380             fi
2381         fi
2382      fi
2383      echo $FSTYP
2384 }
2385
2386 _full_platform_details()
2387 {
2388      os=`uname -s`
2389      host=`hostname -s`
2390      kernel=`uname -r`
2391      platform=`uname -m`
2392      echo "$os/$platform $host $kernel"
2393 }
2394
2395 _get_os_name()
2396 {
2397         if [ "`uname`" == "IRIX64" ] || [ "`uname`" == "IRIX" ]; then
2398                 echo 'irix'
2399         elif [ "`uname`" == "Linux" ]; then
2400                 echo 'linux'
2401         else
2402                 echo Unknown operating system: `uname`
2403                 exit
2404         fi
2405 }
2406
2407 _link_out_file_named()
2408 {
2409         export FEATURES=$2
2410         SUFFIX=$(perl -e '
2411                 my %feathash;
2412                 my $feature, $result, $suffix, $opts;
2413
2414                 foreach $feature (split(/,/, $ENV{"FEATURES"})) {
2415                         $feathash{$feature} = 1;
2416                 }
2417                 $result = "default";
2418                 while (<>) {
2419                         my $found = 1;
2420
2421                         chomp;
2422                         ($opts, $suffix) = split(/ *: */);
2423                         foreach my $opt (split(/,/, $opts)) {
2424                                 if (!exists($feathash{$opt})) {
2425                                         $found = 0;
2426                                         last;
2427                                 }
2428                         }
2429                         if ($found == 1) {
2430                                 $result = $suffix;
2431                                 last;
2432                         }
2433                 }
2434                 print $result
2435                 ' <$seqfull.cfg)
2436         rm -f $1
2437         SRC=$(basename $1)
2438         ln -fs $SRC.$SUFFIX $1
2439 }
2440
2441 _link_out_file()
2442 {
2443         if [ $# -eq 0 ]; then
2444                 FEATURES="$(_get_os_name)"
2445                 if [ -n "$MOUNT_OPTIONS" ]; then
2446                         FEATURES=$FEATURES,${MOUNT_OPTIONS##"-o "}
2447                 fi
2448         else
2449                 FEATURES=$1
2450         fi
2451
2452         _link_out_file_named $seqfull.out "$FEATURES"
2453 }
2454
2455 _die()
2456 {
2457         echo $@
2458         exit 1
2459 }
2460
2461 # convert urandom incompressible data to compressible text data
2462 _ddt()
2463 {
2464         od /dev/urandom | dd iflag=fullblock ${*}
2465 }
2466
2467 #takes files, randomdata
2468 _nfiles()
2469 {
2470         f=0
2471         while [ $f -lt $1 ]
2472         do
2473                 file=f$f
2474                 echo > $file
2475                 if [ $size -gt 0 ]; then
2476                     if [ "$2" == "false" ]; then
2477                         dd if=/dev/zero of=$file bs=1024 count=$size 2>&1 | _filter_dd
2478                     elif [ "$2" == "comp" ]; then
2479                         _ddt of=$file bs=1024 count=$size 2>&1 | _filter_dd
2480                     else
2481                         dd if=/dev/urandom of=$file bs=1024 count=$size 2>&1 | _filter_dd
2482                     fi
2483                 fi
2484                 let f=$f+1
2485         done
2486 }
2487
2488 # takes dirname, depth, randomdata
2489 _descend()
2490 {
2491         dirname=$1; depth=$2; randomdata=$3
2492         mkdir $dirname  || die "mkdir $dirname failed"
2493         cd $dirname
2494
2495         _nfiles $files $randomdata          # files for this dir and data type
2496
2497         [ $depth -eq 0 ] && return
2498         let deep=$depth-1 # go 1 down
2499
2500         [ $verbose = true ] && echo "descending, depth from leaves = $deep"
2501
2502         d=0
2503         while [ $d -lt $dirs ]
2504         do
2505                 _descend d$d $deep &
2506                 let d=$d+1
2507                 wait
2508         done
2509 }
2510
2511 # Populate a filesystem with inodes for performance experiments
2512 #
2513 # usage: populate [-v] [-n ndirs] [-f nfiles] [-d depth] [-r root] [-s size] [-x]
2514 #
2515 _populate_fs()
2516 {
2517     here=`pwd`
2518     dirs=5          # ndirs in each subdir till leaves
2519     size=0          # sizeof files in K
2520     files=100       # num files in _each_ subdir
2521     depth=2         # depth of tree from root to leaves
2522     verbose=false
2523     root=root       # path of initial root of directory tree
2524     randomdata=false # -x data type urandom, zero or compressible
2525
2526     OPTIND=1
2527     while getopts "d:f:n:r:s:v:x:c" c
2528     do
2529         case $c in
2530         d)      depth=$OPTARG;;
2531         n)      dirs=$OPTARG;;
2532         f)      files=$OPTARG;;
2533         s)      size=$OPTARG;;
2534         v)      verbose=true;;
2535         r)      root=$OPTARG;;
2536         x)      randomdata=true;;
2537         c)      randomdata=comp;;
2538         esac
2539     done
2540
2541     _descend $root $depth $randomdata
2542     wait
2543
2544     cd $here
2545
2546     [ $verbose = true ] && echo done
2547 }
2548
2549 # query whether the given file has the given inode flag set
2550 #
2551 _test_inode_flag()
2552 {
2553         flag=$1
2554         file=$2
2555
2556         if $XFS_IO_PROG -r -c 'lsattr -v' "$file" | grep -q "$flag" ; then
2557                 return 0
2558         fi
2559         return 1
2560 }
2561
2562 # query the given files extsize allocator hint in bytes (if any)
2563 #
2564 _test_inode_extsz()
2565 {
2566         file=$1
2567         blocks=""
2568
2569         blocks=`$XFS_IO_PROG -r -c 'stat' "$file" | \
2570                 awk '/^xattr.extsize =/ { print $3 }'`
2571         [ -z "$blocks" ] && blocks="0"
2572         echo $blocks
2573 }
2574
2575 # scratch_dev_pool should contain the disks pool for the btrfs raid
2576 _require_scratch_dev_pool()
2577 {
2578         local i
2579         local ndevs
2580
2581         if [ -z "$SCRATCH_DEV_POOL" ]; then
2582                 _notrun "this test requires a valid \$SCRATCH_DEV_POOL"
2583         fi
2584
2585         if [ -z "$1" ]; then
2586                 ndevs=2
2587         else
2588                 ndevs=$1
2589         fi
2590
2591         # btrfs test case needs ndevs or more scratch_dev_pool; other FS not sure
2592         # so fail it
2593         case $FSTYP in
2594         btrfs)
2595                 if [ "`echo $SCRATCH_DEV_POOL|wc -w`" -lt $ndevs ]; then
2596                         _notrun "btrfs and this test needs $ndevs or more disks in SCRATCH_DEV_POOL"
2597                 fi
2598         ;;
2599         *)
2600                 _notrun "dev_pool is not supported by fstype \"$FSTYP\""
2601         ;;
2602         esac
2603
2604         for i in $SCRATCH_DEV_POOL; do
2605                 if [ "`_is_block_dev "$i"`" = "" ]; then
2606                         _notrun "this test requires valid block disk $i"
2607                 fi
2608                 if [ "`_is_block_dev "$i"`" = "`_is_block_dev "$TEST_DEV"`" ]; then
2609                         _notrun "$i is part of TEST_DEV, this test requires unique disks"
2610                 fi
2611                 if _mount | grep -q $i; then
2612                         if ! $UMOUNT_PROG $i; then
2613                             echo "failed to unmount $i - aborting"
2614                             exit 1
2615                         fi
2616                 fi
2617                 # to help better debug when something fails, we remove
2618                 # traces of previous btrfs FS on the dev.
2619                 dd if=/dev/zero of=$i bs=4096 count=100 > /dev/null 2>&1
2620         done
2621 }
2622
2623 # ensure devices in SCRATCH_DEV_POOL are of the same size
2624 # must be called after _require_scratch_dev_pool
2625 _require_scratch_dev_pool_equal_size()
2626 {
2627         local _size
2628         local _newsize
2629         local _dev
2630
2631         # SCRATCH_DEV has been set to the first device in SCRATCH_DEV_POOL
2632         _size=`_get_device_size $SCRATCH_DEV`
2633         for _dev in $SCRATCH_DEV_POOL; do
2634                 _newsize=`_get_device_size $_dev`
2635                 if [ $_size -ne $_newsize ]; then
2636                         _notrun "This test requires devices in SCRATCH_DEV_POOL have the same size"
2637                 fi
2638         done
2639 }
2640
2641 # We will check if the device is deletable
2642 _require_deletable_scratch_dev_pool()
2643 {
2644         local i
2645         local x
2646         for i in $SCRATCH_DEV_POOL; do
2647                 x=`echo $i | cut -d"/" -f 3`
2648                 if [ ! -f /sys/class/block/${x}/device/delete ]; then
2649                         _notrun "$i is a device which is not deletable"
2650                 fi
2651         done
2652 }
2653
2654 # Check that fio is present, and it is able to execute given jobfile
2655 _require_fio()
2656 {
2657         job=$1
2658
2659         _require_command "$FIO_PROG" fio
2660         if [ -z "$1" ]; then
2661                 return 1;
2662         fi
2663
2664         $FIO_PROG --warnings-fatal --showcmd $job >> $seqres.full 2>&1
2665         [ $? -eq 0 ] || _notrun "$FIO_PROG too old, see $seqres.full"
2666 }
2667
2668 # Does freeze work on this fs?
2669 _require_freeze()
2670 {
2671         xfs_freeze -f "$TEST_DIR" >/dev/null 2>&1
2672         result=$?
2673         xfs_freeze -u "$TEST_DIR" >/dev/null 2>&1
2674         [ $result -eq 0 ] || _notrun "$FSTYP does not support freezing"
2675 }
2676
2677 # Does shutdown work on this fs?
2678 _require_scratch_shutdown()
2679 {
2680         [ -x src/godown ] || _notrun "src/godown executable not found"
2681
2682         _scratch_mkfs > /dev/null 2>&1
2683         _scratch_mount
2684         src/godown -f $SCRATCH_MNT 2>&1 \
2685                 || _notrun "$FSTYP does not support shutdown"
2686         _scratch_unmount
2687 }
2688
2689 # Does dax mount option work on this dev/fs?
2690 _require_scratch_dax()
2691 {
2692         _require_scratch
2693         _scratch_mkfs > /dev/null 2>&1
2694         _scratch_mount -o dax
2695         # Check options to be sure. XFS ignores dax option
2696         # and goes on if dev underneath does not support dax.
2697         _fs_options $SCRATCH_DEV | grep -qw "dax" || \
2698                 _notrun "$SCRATCH_DEV $FSTYP does not support -o dax"
2699         _scratch_unmount
2700 }
2701
2702 # Does norecovery support by this fs?
2703 _require_norecovery()
2704 {
2705         _scratch_mount -o ro,norecovery || \
2706                 _notrun "$FSTYP does not support norecovery"
2707         _scratch_unmount
2708 }
2709
2710 # Does this filesystem support metadata journaling?
2711 # We exclude ones here that don't; otherwise we assume that it does, so the
2712 # test will run, fail, and motivate someone to update this test for a new
2713 # filesystem.
2714 #
2715 # It's possible that TEST_DEV and SCRATCH_DEV have different features (it'd be
2716 # odd, but possible) so check $TEST_DEV by default, but we can optionall pass
2717 # any dev we want.
2718 _require_metadata_journaling()
2719 {
2720         if [ -z $1 ]; then
2721                 DEV=$TEST_DEV
2722         else
2723                 DEV=$1
2724         fi
2725
2726         case "$FSTYP" in
2727         ext2|vfat|msdos)
2728                 _notrun "$FSTYP does not support metadata journaling"
2729                 ;;
2730         ext4)
2731                 # ext4 could be mkfs'd without a journal...
2732                 _require_dumpe2fs
2733                 $DUMPE2FS_PROG -h $DEV 2>&1 | grep -q has_journal || \
2734                         _notrun "$FSTYP on $DEV not configured with metadata journaling"
2735                 # ext4 might not load a journal
2736                 _exclude_scratch_mount_option "noload"
2737                 ;;
2738         *)
2739                 # by default we pass; if you need to, add your fs above!
2740                 ;;
2741         esac
2742 }
2743
2744 # Does fiemap support?
2745 _require_fiemap()
2746 {
2747         _require_xfs_io_command "fiemap"
2748 }
2749
2750 _count_extents()
2751 {
2752         $XFS_IO_PROG -c "fiemap" $1 | tail -n +2 | grep -v hole | wc -l
2753 }
2754
2755 _count_holes()
2756 {
2757         $XFS_IO_PROG -c "fiemap" $1 | tail -n +2 | grep hole | wc -l
2758 }
2759
2760 # arg 1 is dev to remove and is output of the below eg.
2761 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
2762 _devmgt_remove()
2763 {
2764         local lun=$1
2765         local disk=$2
2766
2767         echo 1 > /sys/class/scsi_device/${lun}/device/delete || _fail "Remove disk failed"
2768
2769         stat $disk > /dev/null 2>&1
2770         while [ $? -eq 0 ]; do
2771                 sleep 1
2772                 stat $disk > /dev/null 2>&1
2773         done
2774 }
2775
2776 # arg 1 is dev to add and is output of the below eg.
2777 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
2778 _devmgt_add()
2779 {
2780         local h
2781         local tdl
2782         # arg 1 will be in h:t:d:l format now in the h and "t d l" format
2783         h=`echo ${1} | cut -d":" -f 1`
2784         tdl=`echo ${1} | cut -d":" -f 2-|sed 's/:/ /g'`
2785
2786         echo ${tdl} >  /sys/class/scsi_host/host${h}/scan || _fail "Add disk failed"
2787
2788         # ensure the device comes online
2789         dev_back_oneline=0
2790         for i in `seq 1 10`; do
2791                 if [ -d /sys/class/scsi_device/${1}/device/block ]; then
2792                         dev=`ls /sys/class/scsi_device/${1}/device/block`
2793                         for j in `seq 1 10`;
2794                         do
2795                                 stat /dev/$dev > /dev/null 2>&1
2796                                 if [ $? -eq 0 ]; then
2797                                         dev_back_oneline=1
2798                                         break
2799                                 fi
2800                                 sleep 1
2801                         done
2802                         break
2803                 else
2804                         sleep 1
2805                 fi
2806         done
2807         if [ $dev_back_oneline -eq 0 ]; then
2808                 echo "/dev/$dev online failed" >> $seqres.full
2809         else
2810                 echo "/dev/$dev is back online" >> $seqres.full
2811         fi
2812 }
2813
2814 _require_fstrim()
2815 {
2816         if [ -z "$FSTRIM_PROG" ]; then
2817                 _notrun "This test requires fstrim utility."
2818         fi
2819 }
2820
2821 _require_batched_discard()
2822 {
2823         if [ $# -ne 1 ]; then
2824                 echo "Usage: _require_batched_discard mnt_point" 1>&2
2825                 exit 1
2826         fi
2827         _require_fstrim
2828         $FSTRIM_PROG $1 > /dev/null 2>&1 || _notrun "FITRIM not supported on $1"
2829 }
2830
2831 _require_dumpe2fs()
2832 {
2833         if [ -z "$DUMPE2FS_PROG" ]; then
2834                 _notrun "This test requires dumpe2fs utility."
2835         fi
2836 }
2837
2838 _require_ugid_map()
2839 {
2840         if [ ! -e /proc/self/uid_map ]; then
2841                 _notrun "This test requires procfs uid_map support."
2842         fi
2843         if [ ! -e /proc/self/gid_map ]; then
2844                 _notrun "This test requires procfs gid_map support."
2845         fi
2846 }
2847
2848 _require_fssum()
2849 {
2850         FSSUM_PROG=$here/src/fssum
2851         [ -x $FSSUM_PROG ] || _notrun "fssum not built"
2852 }
2853
2854 _require_cloner()
2855 {
2856         CLONER_PROG=$here/src/cloner
2857         [ -x $CLONER_PROG ] || \
2858                 _notrun "cloner binary not present at $CLONER_PROG"
2859 }
2860
2861 # Normalize mount options from global $MOUNT_OPTIONS
2862 # Convert options like "-o opt1,opt2 -oopt3" to
2863 # "opt1 opt2 opt3"
2864 _normalize_mount_options()
2865 {
2866         echo $MOUNT_OPTIONS | sed -n 's/-o\s*\(\S*\)/\1/gp'| sed 's/,/ /g'
2867 }
2868
2869 # skip test if MOUNT_OPTIONS contains the given strings
2870 _exclude_scratch_mount_option()
2871 {
2872         local mnt_opts=$(_normalize_mount_options)
2873
2874         while [ $# -gt 0 ]; do
2875                 if echo $mnt_opts | grep -qw "$1"; then
2876                         _notrun "mount option \"$1\" not allowed in this test"
2877                 fi
2878                 shift
2879         done
2880 }
2881
2882 _require_atime()
2883 {
2884         _exclude_scratch_mount_option "noatime"
2885         if [ "$FSTYP" == "nfs" ]; then
2886                 _notrun "atime related mount options have no effect on NFS"
2887         fi
2888 }
2889
2890 _require_relatime()
2891 {
2892         _scratch_mkfs > /dev/null 2>&1
2893         _scratch_mount -o relatime || \
2894                 _notrun "relatime not supported by the current kernel"
2895         _scratch_unmount
2896 }
2897
2898 _require_userns()
2899 {
2900         [ -x src/nsexec ] || _notrun "src/nsexec executable not found"
2901         src/nsexec -U true 2>/dev/null || _notrun "userns not supported by this kernel"
2902 }
2903
2904 _create_loop_device()
2905 {
2906         file=$1
2907         dev=`losetup -f --show $file` || _fail "Cannot assign $file to a loop device"
2908         echo $dev
2909 }
2910
2911 _destroy_loop_device()
2912 {
2913         dev=$1
2914         losetup -d $dev || _fail "Cannot destroy loop device $dev"
2915 }
2916
2917 _scale_fsstress_args()
2918 {
2919     args=""
2920     while [ $# -gt 0 ]; do
2921         case "$1" in
2922             -n) args="$args $1 $(($2 * $TIME_FACTOR))"; shift ;;
2923             -p) args="$args $1 $(($2 * $LOAD_FACTOR))"; shift ;;
2924             *) args="$args $1" ;;
2925         esac
2926         shift
2927     done
2928     echo $args
2929 }
2930
2931 #
2932 # Return the logical block size if running on a block device,
2933 # else substitute the page size.
2934 #
2935 _min_dio_alignment()
2936 {
2937     dev=$1
2938
2939     if [ -b "$dev" ]; then
2940         blockdev --getss $dev
2941     else
2942         $here/src/feature -s
2943     fi
2944 }
2945
2946 run_check()
2947 {
2948         echo "# $@" >> $seqres.full 2>&1
2949         "$@" >> $seqres.full 2>&1 || _fail "failed: '$@'"
2950 }
2951
2952 _require_test_symlinks()
2953 {
2954         # IRIX UDF does not support symlinks
2955         [ "$HOSTOS" = "IRIX" -a "$FSTYP" = 'udf' ] && \
2956                 _notrun "Require symlinks support"
2957         target=`mktemp -p $TEST_DIR`
2958         link=`mktemp -p $TEST_DIR -u`
2959         ln -s `basename $target` $link
2960         if [ "$?" -ne 0 ]; then
2961                 rm -f $target
2962                 _notrun "Require symlinks support"
2963         fi
2964         rm -f $target $link
2965 }
2966
2967 _require_test_fcntl_advisory_locks()
2968 {
2969         [ "$FSTYP" != "cifs" ] && return 0
2970         cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -q "nobrl" && return 0
2971         cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -qE "nounix|forcemand" && \
2972                 _notrun "Require fcntl advisory locks support"
2973 }
2974
2975 _require_test_lsattr()
2976 {
2977         testio=$(lsattr -d $TEST_DIR 2>&1)
2978         echo $testio | grep -q "Operation not supported" && \
2979                 _notrun "lsattr not supported by test filesystem type: $FSTYP"
2980         echo $testio | grep -q "Inappropriate ioctl for device" && \
2981                 _notrun "lsattr not supported by test filesystem type: $FSTYP"
2982 }
2983
2984 _require_chattr()
2985 {
2986     attribute=$1
2987
2988     touch $TEST_DIR/syscalltest
2989     chattr "+$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
2990     status=$?
2991     chattr "-$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
2992     if [ "$status" -ne 0 ]; then
2993       _notrun "file system doesn't support chattr +$attribute"
2994     fi
2995     cat $TEST_DIR/syscalltest.out >> $seqres.full
2996
2997     rm -f $TEST_DIR/syscalltest.out
2998 }
2999
3000 _get_total_inode()
3001 {
3002         if [ -z "$1" ]; then
3003                 echo "Usage: _get_total_inode <mnt>"
3004                 exit 1
3005         fi
3006         local nr_inode;
3007         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $3}'`
3008         echo $nr_inode
3009 }
3010
3011 _get_used_inode()
3012 {
3013         if [ -z "$1" ]; then
3014                 echo "Usage: _get_used_inode <mnt>"
3015                 exit 1
3016         fi
3017         local nr_inode;
3018         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $4}'`
3019         echo $nr_inode
3020 }
3021
3022 _get_used_inode_percent()
3023 {
3024         if [ -z "$1" ]; then
3025                 echo "Usage: _get_used_inode_percent <mnt>"
3026                 exit 1
3027         fi
3028         local pct_inode;
3029         pct_inode=`$DF_PROG -i $1 | tail -1 | awk '{ print $6 }' | \
3030                    sed -e 's/%//'`
3031         echo $pct_inode
3032 }
3033
3034 _get_free_inode()
3035 {
3036         if [ -z "$1" ]; then
3037                 echo "Usage: _get_free_inode <mnt>"
3038                 exit 1
3039         fi
3040         local nr_inode;
3041         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $5}'`
3042         echo $nr_inode
3043 }
3044
3045 # get the available space in bytes
3046 #
3047 _get_available_space()
3048 {
3049         if [ -z "$1" ]; then
3050                 echo "Usage: _get_available_space <mnt>"
3051                 exit 1
3052         fi
3053         local avail_kb;
3054         avail_kb=`$DF_PROG $1 | tail -n1 | awk '{ print $5 }'`
3055         echo $((avail_kb * 1024))
3056 }
3057
3058 # return device size in kb
3059 _get_device_size()
3060 {
3061         grep `_short_dev $1` /proc/partitions | awk '{print $3}'
3062 }
3063
3064 # check dmesg log for WARNING/Oops/etc.
3065 _check_dmesg()
3066 {
3067         if [ ! -f ${RESULT_DIR}/check_dmesg ]; then
3068                 return 0
3069         fi
3070         rm -f ${RESULT_DIR}/check_dmesg
3071
3072         # default filter is a simple cat command, caller could provide a
3073         # customized filter and pass the name through the first argument, to
3074         # filter out intentional WARNINGs or Oopses
3075         filter=${1:-cat}
3076
3077         # search the dmesg log of last run of $seqnum for possible failures
3078         # use sed \cregexpc address type, since $seqnum contains "/"
3079         dmesg | tac | sed -ne "0,\#run fstests $seqnum at $date_time#p" | \
3080                 tac | $filter >$seqres.dmesg
3081         grep -q -e "kernel BUG at" \
3082              -e "WARNING:" \
3083              -e "BUG:" \
3084              -e "Oops:" \
3085              -e "possible recursive locking detected" \
3086              -e "Internal error" \
3087              -e "INFO: suspicious RCU usage" \
3088              -e "INFO: possible circular locking dependency detected" \
3089              -e "general protection fault:" \
3090              $seqres.dmesg
3091         if [ $? -eq 0 ]; then
3092                 echo "_check_dmesg: something found in dmesg (see $seqres.dmesg)"
3093                 return 1
3094         else
3095                 rm -f $seqres.dmesg
3096                 return 0
3097         fi
3098 }
3099
3100 # don't check dmesg log after test
3101 _disable_dmesg_check()
3102 {
3103         rm -f ${RESULT_DIR}/check_dmesg
3104 }
3105
3106 init_rc()
3107 {
3108         if [ "$iam" == new ]
3109         then
3110                 return
3111         fi
3112         # make some further configuration checks here
3113         if [ "$TEST_DEV" = ""  ]
3114         then
3115                 echo "common/rc: Error: \$TEST_DEV is not set"
3116                 exit 1
3117         fi
3118
3119         # if $TEST_DEV is not mounted, mount it now as XFS
3120         if [ -z "`_fs_type $TEST_DEV`" ]
3121         then
3122                 # $TEST_DEV is not mounted
3123                 if ! _test_mount
3124                 then
3125                         echo "common/rc: retrying test device mount with external set"
3126                         [ "$USE_EXTERNAL" != "yes" ] && export USE_EXTERNAL=yes
3127                         if ! _test_mount
3128                         then
3129                                 echo "common/rc: could not mount $TEST_DEV on $TEST_DIR"
3130                                 exit 1
3131                         fi
3132                 fi
3133         fi
3134
3135         if [ "`_fs_type $TEST_DEV`" != "$FSTYP" ]
3136         then
3137                 echo "common/rc: Error: \$TEST_DEV ($TEST_DEV) is not a MOUNTED $FSTYP filesystem"
3138                 # raw $DF_PROG cannot handle NFS/CIFS/overlay correctly
3139                 _df_device $TEST_DEV
3140                 exit 1
3141         fi
3142         # Figure out if we need to add -F ("foreign", deprecated) option to xfs_io
3143         $XFS_IO_PROG -c stat $TEST_DIR 2>&1 | grep -q "is not on an XFS filesystem" && \
3144                 export XFS_IO_PROG="$XFS_IO_PROG -F"
3145
3146         # xfs_io -i option starts an idle thread for xfs_io.
3147         # With single threaded process, the file table is not shared
3148         # and file structs are not reference counted.
3149         # Spawning an idle thread can help detecting file struct
3150         # reference leaks, so we want to enable the option whenever
3151         # it is supported.
3152         $XFS_IO_PROG -i -c quit 2>/dev/null && \
3153                 export XFS_IO_PROG="$XFS_IO_PROG -i"
3154
3155         # xfs_copy on v5 filesystems do not require the "-d" option if xfs_db
3156         # can change the UUID on v5 filesystems
3157         if [ "$FSTYP" == "xfs" ]; then
3158                 touch /tmp/$$.img
3159                 $MKFS_XFS_PROG -d file,name=/tmp/$$.img,size=512m >/dev/null 2>&1
3160                 # xfs_db will return 0 even if it can't generate a new uuid, so
3161                 # check the output to make sure if it can change UUID of V5 xfs
3162                 $XFS_DB_PROG -x -c "uuid generate" /tmp/$$.img \
3163                         | grep -q "invalid UUID\|supported on V5 fs" \
3164                         && export XFS_COPY_PROG="$XFS_COPY_PROG -d"
3165                 rm -f /tmp/$$.img
3166         fi
3167 }
3168
3169 # get real device path name by following link
3170 _real_dev()
3171 {
3172         local _dev=$1
3173         if [ -b "$_dev" ] && [ -L "$_dev" ]; then
3174                 _dev=`readlink -f "$_dev"`
3175         fi
3176         echo $_dev
3177 }
3178
3179 # basename of a device
3180 _short_dev()
3181 {
3182         echo `basename $(_real_dev $1)`
3183 }
3184
3185 _sysfs_dev()
3186 {
3187         local _dev=`_real_dev $1`
3188         local _maj=$(stat -c%t $_dev | tr [:lower:] [:upper:])
3189         local _min=$(stat -c%T $_dev | tr [:lower:] [:upper:])
3190         _maj=$(echo "ibase=16; $_maj" | bc)
3191         _min=$(echo "ibase=16; $_min" | bc)
3192         echo /sys/dev/block/$_maj:$_min
3193 }
3194
3195 # Get the minimum block size of a file.  Usually this is the
3196 # minimum fs block size, but some filesystems (ocfs2) do block
3197 # mappings in larger units.
3198 _get_file_block_size()
3199 {
3200         if [ -z $1 ] || [ ! -d $1 ]; then
3201                 echo "Missing mount point argument for _get_file_block_size"
3202                 exit 1
3203         fi
3204         if [ "$FSTYP" = "ocfs2" ]; then
3205                 stat -c '%o' $1
3206         else
3207                 _get_block_size $1
3208         fi
3209 }
3210
3211 # Get the minimum block size of an fs.
3212 _get_block_size()
3213 {
3214         if [ -z $1 ] || [ ! -d $1 ]; then
3215                 echo "Missing mount point argument for _get_block_size"
3216                 exit 1
3217         fi
3218         stat -f -c %S $1
3219 }
3220
3221 get_page_size()
3222 {
3223         echo $(getconf PAGE_SIZE)
3224 }
3225
3226
3227 run_fsx()
3228 {
3229         echo fsx $@
3230         args=`echo $@ | sed -e "s/ BSIZE / $bsize /g" -e "s/ PSIZE / $psize /g"`
3231         set -- $here/ltp/fsx $args $FSX_AVOID $TEST_DIR/junk
3232         echo "$@" >>$seqres.full
3233         rm -f $TEST_DIR/junk
3234         "$@" 2>&1 | tee -a $seqres.full >$tmp.fsx
3235         if [ ${PIPESTATUS[0]} -ne 0 ]; then
3236                 cat $tmp.fsx
3237                 exit 1
3238         fi
3239 }
3240
3241 # Test for the existence of a sysfs entry at /sys/fs/$FSTYP/DEV/$ATTR
3242 #
3243 # Only one argument is needed:
3244 #  - attr: path name under /sys/fs/$FSTYP/DEV
3245 #
3246 # Usage example:
3247 #   _require_fs_sysfs error/fail_at_unmount
3248 _require_fs_sysfs()
3249 {
3250         local attr=$1
3251         local dname=$(_short_dev $TEST_DEV)
3252
3253         if [ -z "$attr" -o -z "$dname" ];then
3254                 _fail "Usage: _require_fs_sysfs <sysfs_attr_path>"
3255         fi
3256
3257         if [ ! -e /sys/fs/${FSTYP}/${dname}/${attr} ];then
3258                 _notrun "This test requires /sys/fs/${FSTYP}/${dname}/${attr}"
3259         fi
3260 }
3261
3262 # Write "content" into /sys/fs/$FSTYP/$DEV/$ATTR
3263 #
3264 # All arguments are necessary, and in this order:
3265 #  - dev: device name, e.g. $SCRATCH_DEV
3266 #  - attr: path name under /sys/fs/$FSTYP/$dev
3267 #  - content: the content of $attr
3268 #
3269 # Usage example:
3270 #   _set_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount 0
3271 _set_fs_sysfs_attr()
3272 {
3273         local dev=$1
3274         shift
3275         local attr=$1
3276         shift
3277         local content="$*"
3278
3279         if [ ! -b "$dev" -o -z "$attr" -o -z "$content" ];then
3280                 _fail "Usage: _set_fs_sysfs_attr <mounted_device> <attr> <content>"
3281         fi
3282
3283         local dname=$(_short_dev $dev)
3284         echo "$content" > /sys/fs/${FSTYP}/${dname}/${attr}
3285 }
3286
3287 # Print the content of /sys/fs/$FSTYP/$DEV/$ATTR
3288 #
3289 # All arguments are necessary, and in this order:
3290 #  - dev: device name, e.g. $SCRATCH_DEV
3291 #  - attr: path name under /sys/fs/$FSTYP/$dev
3292 #
3293 # Usage example:
3294 #   _get_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount
3295 _get_fs_sysfs_attr()
3296 {
3297         local dev=$1
3298         local attr=$2
3299
3300         if [ ! -b "$dev" -o -z "$attr" ];then
3301                 _fail "Usage: _get_fs_sysfs_attr <mounted_device> <attr>"
3302         fi
3303
3304         local dname=$(_short_dev $dev)
3305         cat /sys/fs/${FSTYP}/${dname}/${attr}
3306 }
3307
3308
3309
3310 init_rc
3311
3312 ################################################################################
3313 # make sure this script returns success
3314 /bin/true