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