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