common/rc

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