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