shared,generic: move shared/006 to generic/
[xfstests-dev.git] / common / rc
index 9d6665b6c4d789bb75a5ef7b4c16f1dc21d78b0a..dcd591b33b87d03473ffd138c70a0fe9c5472970 100644 (file)
--- a/common/rc
+++ b/common/rc
@@ -1,24 +1,6 @@
 ##/bin/bash
-#-----------------------------------------------------------------------
-#  Copyright (c) 2000-2006 Silicon Graphics, Inc.  All Rights Reserved.
-#  This program is free software; you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation; either version 2 of the License, or
-#  (at your option) any later version.
-#
-#  This program is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  GNU General Public License for more details.
-#
-#  You should have received a copy of the GNU General Public License
-#  along with this program; if not, write to the Free Software
-#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
-#  USA
-#
-#  Contact information: Silicon Graphics, Inc., 1500 Crittenden Lane,
-#  Mountain View, CA 94043, USA, or: http://www.sgi.com
-#-----------------------------------------------------------------------
+# SPDX-License-Identifier: GPL-2.0+
+# Copyright (c) 2000-2006 Silicon Graphics, Inc.  All Rights Reserved.
 
 . common/config
 
@@ -116,7 +98,7 @@ _dump_err_cont()
 _dump_err2()
 {
     _err_msg="$*"
-    >2& echo "$_err_msg"
+    >&2 echo "$_err_msg"
 }
 
 _log_err()
@@ -375,7 +357,7 @@ _scratch_remount()
     local opts="$1"
 
     if test -n "$opts"; then
-       mount -o "remount,$opts" $SCRATCH_MNT
+       _try_scratch_mount "-o remount,$opts"
     fi
 }
 
@@ -411,6 +393,17 @@ _scratch_shutdown()
        fi
 }
 
+# Return a file path that can be used to shut down the scratch filesystem.
+# Caller should _require_scratch_shutdown before using this.
+_scratch_shutdown_handle()
+{
+       if [ $FSTYP = "overlay" ]; then
+               echo $OVL_BASE_SCRATCH_MNT
+       else
+               echo $SCRATCH_MNT
+       fi
+}
+
 _test_mount()
 {
     if [ "$FSTYP" == "overlay" ]; then
@@ -987,7 +980,10 @@ _scratch_mkfs_sized()
        ;;
     btrfs)
        local mixed_opt=
-       (( fssize <= 1024 * 1024 * 1024 )) && mixed_opt='--mixed'
+       # minimum size that's needed without the mixed option.
+       # Ref: btrfs-prog: btrfs_min_dev_size()
+       # Non mixed mode is also the default option.
+       (( fssize < $((256 * 1024 *1024)) )) && mixed_opt='--mixed'
        $MKFS_BTRFS_PROG $MKFS_OPTIONS $mixed_opt -b $fssize $SCRATCH_DEV
        ;;
     jfs)
@@ -1116,11 +1112,20 @@ _repair_scratch_fs()
        return $res
         ;;
     *)
-        # Let's hope fsck -y suffices...
-        fsck -t $FSTYP -y $SCRATCH_DEV 2>&1
+       local dev=$SCRATCH_DEV
+       local fstyp=$FSTYP
+       if [ $FSTYP = "overlay" -a -n "$OVL_BASE_SCRATCH_DEV" ]; then
+               _repair_overlay_scratch_fs
+               # Fall through to repair base fs
+               dev=$OVL_BASE_SCRATCH_DEV
+               fstyp=$OVL_BASE_FSTYP
+               $UMOUNT_PROG $OVL_BASE_SCRATCH_MNT
+       fi
+       # Let's hope fsck -y suffices...
+       fsck -t $fstyp -y $dev 2>&1
        local res=$?
        case $res in
-       0|1|2)
+       $FSCK_OK|$FSCK_NONDESTRUCT|$FSCK_REBOOT)
                res=0
                ;;
        *)
@@ -2006,7 +2011,9 @@ _yp_active()
        local dn
        dn=$(domainname 2>/dev/null)
        local ypcat=$(type -P ypcat)
-       test -n "${dn}" -a "${dn}" != "(none)" -a "${dn}" != "localdomain" -a -n "${ypcat}"
+       local rpcinfo=$(type -P rpcinfo)
+       test -n "${dn}" -a "${dn}" != "(none)" -a "${dn}" != "localdomain" -a -n "${ypcat}" -a -n "${rpcinfo}" && \
+               "${rpcinfo}" -p localhost 2>/dev/null | grep -q ypbind
        echo $?
 }
 
@@ -2077,12 +2084,22 @@ _require_xfs_io_command()
        local command=$1
        shift
        local param="$*"
-       local param_checked=0
+       local param_checked=""
        local opts=""
 
        local testfile=$TEST_DIR/$$.xfs_io
        local testio
        case $command in
+       "chattr")
+               if [ -z "$param" ]; then
+                       param=s
+               fi
+               # Test xfs_io chattr support AND
+               # filesystem FS_IOC_FSSETXATTR support
+               testio=`$XFS_IO_PROG -F -f -c "chattr +$param" $testfile 2>&1`
+               $XFS_IO_PROG -F -f -r -c "chattr -$param" $testfile 2>&1
+               param_checked="+$param"
+               ;;
        "chproj")
                testio=`$XFS_IO_PROG -F -f -c "chproj 0" $testfile 2>&1`
                ;;
@@ -2094,7 +2111,7 @@ _require_xfs_io_command()
                ;;
        "falloc" )
                testio=`$XFS_IO_PROG -F -f -c "falloc $param 0 1m" $testfile 2>&1`
-               param_checked=1
+               param_checked="$param"
                ;;
        "fpunch" | "fcollapse" | "zero" | "fzero" | "finsert" | "funshare")
                local blocksize=$(_get_block_size $TEST_DIR)
@@ -2112,7 +2129,7 @@ _require_xfs_io_command()
                fi
                testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
                        -c "fiemap -v $param" $testfile 2>&1`
-               param_checked=1
+               param_checked="$param"
                ;;
        "flink")
                local testlink=$TEST_DIR/$$.link.xfs_io
@@ -2152,7 +2169,7 @@ _require_xfs_io_command()
                fi
                testio=`$XFS_IO_PROG -f $opts -c \
                        "pwrite $pwrite_opts $param 0 4k" $testfile 2>&1`
-               param_checked=1
+               param_checked="$pwrite_opts $param"
                ;;
        "scrub"|"repair")
                testio=`$XFS_IO_PROG -x -c "$command probe" $TEST_DIR 2>&1`
@@ -2172,19 +2189,19 @@ _require_xfs_io_command()
 
        rm -f $testfile 2>&1 > /dev/null
        echo $testio | grep -q "not found" && \
-               _notrun "xfs_io $command support is missing"
+               _notrun "xfs_io $command $param_checked support is missing"
        echo $testio | grep -q "Operation not supported\|Inappropriate ioctl" && \
-               _notrun "xfs_io $command failed (old kernel/wrong fs?)"
+               _notrun "xfs_io $command $param_checked failed (old kernel/wrong fs?)"
        echo $testio | grep -q "Invalid" && \
-               _notrun "xfs_io $command failed (old kernel/wrong fs/bad args?)"
+               _notrun "xfs_io $command $param_checked failed (old kernel/wrong fs/bad args?)"
        echo $testio | grep -q "foreign file active" && \
-               _notrun "xfs_io $command not supported on $FSTYP"
+               _notrun "xfs_io $command $param_checked not supported on $FSTYP"
        echo $testio | grep -q "Function not implemented" && \
-               _notrun "xfs_io $command support is missing (missing syscall?)"
+               _notrun "xfs_io $command $param_checked support is missing (missing syscall?)"
 
        [ -n "$param" ] || return
 
-       if [ $param_checked -eq 0 ]; then
+       if [ -z "$param_checked" ]; then
                $XFS_IO_PROG -c "help $command" | grep -q "^ $param --" || \
                        _notrun "xfs_io $command doesn't support $param"
        else
@@ -2223,15 +2240,28 @@ _format_swapfile() {
        # Swap files must be nocow on Btrfs.
        $CHATTR_PROG +C "$fname" > /dev/null 2>&1
        _pwrite_byte 0x61 0 "$sz" "$fname" >> $seqres.full
-       mkswap "$fname" >> $seqres.full
+       $MKSWAP_PROG "$fname" >> $seqres.full
 }
 
 # Check that the filesystem supports swapfiles
 _require_scratch_swapfile()
 {
        _require_scratch
+       _require_command "$MKSWAP_PROG" "mkswap"
 
        _scratch_mkfs >/dev/null
+
+       # With mounting SELinux context(e.g. system_u:object_r:root_t:s0),
+       # standard mkswap tried to reset the type of default context to
+       # swapfile_t if it's not swapfile_t, and then it failed and returned
+       # ENOTSUP expectedly as we don't want to create any SELinux attr on
+       # purpose.  standard mkswap ignored this relabel error by commit
+       # d97dc0e of util-linux, but it still reported the error before
+       # commit d97dc0e.  We mount swapfile context directly to skip the
+       # reset step.
+       [ -n "$SELINUX_MOUNT_OPTIONS" ] && export \
+               SELINUX_MOUNT_OPTIONS="-o context=system_u:object_r:swapfile_t:s0"
+
        _scratch_mount
 
        # Minimum size for mkswap is 10 pages
@@ -2298,6 +2328,60 @@ _ext4_disable_extent_zeroout()
                echo 0 >/sys/fs/ext4/$sdev/extent_max_zeroout_kb
 }
 
+# The default behavior of SEEK_HOLE is to always return EOF.
+# Filesystems that implement non-default behavior return the offset
+# of holes with SEEK_HOLE. There is no way to query the filesystem
+# of which behavior it is implementing.
+# We use this whitelist FSTYP, to set expectation and avoid silent
+# regression of filesystem seek hole behavior.
+#
+# Return 0 for true
+_fstyp_has_non_default_seek_data_hole()
+{
+       if [ -z $1 ]; then
+               local fstyp=$FSTYP
+       else
+               local fstyp=$1
+       fi
+
+       case "$fstyp" in
+       btrfs|ext4|xfs|ceph|cifs|f2fs|gfs2|ocfs2|tmpfs)
+               return 0
+               ;;
+       nfs*)
+               # NFSv2 and NFSv3 only support default behavior of SEEK_HOLE,
+               # while NFSv4 supports non-default behavior
+               local nfsvers=`_df_device $TEST_DEV | $AWK_PROG '{ print $2 }'`
+               [ "$nfsvers" = "nfs4" ]
+               return $?
+               ;;
+       overlay)
+               if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
+                       _fstyp_has_non_default_seek_data_hole $OVL_BASE_FSTYP
+                       return $?
+               else
+                       # Assume that base fs has default behavior
+                       return 1
+               fi
+               ;;
+       *)
+               # by default fstyp has default SEEK_HOLE behavior;
+               # if your fs has non-default behavior, add it to whitelist above!
+               return 1
+               ;;
+       esac
+}
+
+# Run seek sanity test with predefined expectation for SEEK_DATA/HOLE behavior
+_run_seek_sanity_test()
+{
+       local testseekargs
+       if _fstyp_has_non_default_seek_data_hole; then
+               testseekargs+="-f"
+       fi
+       $here/src/seek_sanity_test $testseekargs $*
+}
+
 # Check if the file system supports seek_data/hole
 _require_seek_data_hole()
 {
@@ -2961,18 +3045,6 @@ _require_scratch_dev_pool_equal_size()
        done
 }
 
-# We will check if the device is deletable
-_require_deletable_scratch_dev_pool()
-{
-       local i
-       local x
-       for i in $SCRATCH_DEV_POOL; do
-               x=`echo $i | cut -d"/" -f 3`
-               if [ ! -f /sys/class/block/${x}/device/delete ]; then
-                       _notrun "$i is a device which is not deletable"
-               fi
-       done
-}
 
 # Check that fio is present, and it is able to execute given jobfile
 _require_fio()
@@ -3462,6 +3534,16 @@ _check_dmesg_for()
        _dmesg_since_test_start | egrep -q "$1"
 }
 
+# Default filter for dmesg scanning.
+# Ignore lockdep complaining about its own bugginess when scanning dmesg
+# output, because we shouldn't be failing filesystem tests on account of
+# lockdep.
+_check_dmesg_filter()
+{
+       egrep -v -e "BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low" \
+               -e "BUG: MAX_STACK_TRACE_ENTRIES too low"
+}
+
 # check dmesg log for WARNING/Oops/etc.
 _check_dmesg()
 {
@@ -3473,12 +3555,12 @@ _check_dmesg()
        # default filter is a simple cat command, caller could provide a
        # customized filter and pass the name through the first argument, to
        # filter out intentional WARNINGs or Oopses
-       local filter=${1:-cat}
+       local filter=${1:-_check_dmesg_filter}
 
        _dmesg_since_test_start | $filter >$seqres.dmesg
        egrep -q -e "kernel BUG at" \
             -e "WARNING:" \
-            -e "BUG:" \
+            -e "\bBUG:" \
             -e "Oops:" \
             -e "possible recursive locking detected" \
             -e "Internal error" \
@@ -3500,7 +3582,7 @@ _check_dmesg()
 # capture the kmemleak report
 _capture_kmemleak()
 {
-       local kern_knob="${DEBUGFS_MNT}/kmemleak"
+       local kern_knob="$DEBUGFS_MNT/kmemleak"
        local leak_file="$1"
 
        # Tell the kernel to scan for memory leaks.  Apparently the write
@@ -3521,10 +3603,20 @@ ENDL
        echo "clear" > "$kern_knob"
 }
 
-# set up kmemleak
-_init_kmemleak()
+# Figure out if the running kernel supports kmemleak; if it does, clear out
+# anything that leaked before we even started testing.  The leak checker only
+# needs to be primed like this once per ./check invocation.
+_detect_kmemleak()
 {
-       local kern_knob="${DEBUGFS_MNT}/kmemleak"
+       local kern_knob="$DEBUGFS_MNT/kmemleak"
+       KMEMLEAK_CHECK_FILE="/tmp/check_kmemleak"
+
+       # Since kernel v4.19-rc3, the kmemleak knob exists even if kmemleak is
+       # disabled, but returns EBUSY on write. So instead of relying on
+       # existance of writable knob file, we use a test file to indicate that
+       # _check_kmemleak() is enabled only if we actually managed to write to
+       # the knob file.
+       rm -f "$KMEMLEAK_CHECK_FILE"
 
        if [ ! -w "$kern_knob" ]; then
                return 0
@@ -3532,17 +3624,28 @@ _init_kmemleak()
 
        # Disable the automatic scan so that we can control it completely,
        # then dump all the leaks recorded so far.
-       echo "scan=off" > "$kern_knob"
-       _capture_kmemleak /dev/null
+       if echo "scan=off" > "$kern_knob" 2>/dev/null; then
+               _capture_kmemleak /dev/null
+               touch "$KMEMLEAK_CHECK_FILE"
+       fi
 }
 
-# check kmemleak log
+# Kick the kmemleak checker to scan for leaks.  Background leak scan mode is
+# not enabled, so we must call the kernel to ask for a scan and deal with the
+# results appropriately.  This we do after every test completes, whether or not
+# it was successful.
 _check_kmemleak()
 {
-       local kern_knob="${DEBUGFS_MNT}/kmemleak"
-       local leak_file="${seqres}.kmemleak"
+       local kern_knob="$DEBUGFS_MNT/kmemleak"
+       local leak_file="$seqres.kmemleak"
 
-       if [ ! -w "$kern_knob" ]; then
+       if [ ! -f "$KMEMLEAK_CHECK_FILE" ]; then
+               return 0
+       fi
+
+       # Not enabled, so discard any report of leaks found.
+       if [ "$USE_KMEMLEAK" != "yes" ]; then
+               _capture_kmemleak /dev/null
                return 0
        fi
 
@@ -3789,6 +3892,45 @@ _require_scratch_feature()
        esac
 }
 
+# Get the maximum size of a file in $TEST_DIR (s_maxbytes).  On ext4 this will
+# be UINT32_MAX * block_size, but other filesystems may allow up to LLONG_MAX.
+_get_max_file_size()
+{
+       local testfile=$TEST_DIR/maxfilesize.$seq
+       local l=0
+       local r=9223372036854775807 # LLONG_MAX
+
+       rm -f $testfile
+       while (( l < r )); do
+               # Use _math() to avoid signed integer overflow.
+               local m=$(_math "($l + $r + 1) / 2")
+               if $XFS_IO_PROG -f -c "truncate $m" $testfile \
+                       |& grep -q 'File too large'
+               then
+                       r=$(( m - 1 ))
+               else
+                       l=$m
+               fi
+       done
+       echo $l
+}
+
+# get MAX_LFS_FILESIZE
+_get_max_lfs_filesize()
+{
+       case "$(getconf LONG_BIT)" in
+       "32")
+               echo $(( ($(getconf PAGE_SIZE) << ($(getconf LONG_BIT) - 1) ) - 1))
+               ;;
+       "64")
+               echo 9223372036854775807
+               ;;
+       *)
+               _fail "sizeof(long) == $(getconf LONG_BIT)?"
+               ;;
+       esac
+}
+
 # The maximum filesystem label length, /not/ including terminating NULL
 _label_get_max()
 {
@@ -3812,6 +3954,110 @@ _require_label_get_max()
        dummy=$(_label_get_max)
 }
 
+_dmsetup_remove()
+{
+       $UDEV_SETTLE_PROG >/dev/null 2>&1
+       $DMSETUP_PROG remove "$@" >>$seqres.full 2>&1
+       $DMSETUP_PROG mknodes >/dev/null 2>&1
+}
+
+_dmsetup_create()
+{
+       $DMSETUP_PROG create "$@" >>$seqres.full 2>&1 || return 1
+       $DMSETUP_PROG mknodes >/dev/null 2>&1
+       $UDEV_SETTLE_PROG >/dev/null 2>&1
+}
+
+_require_btime()
+{
+       # Note: filesystems are not required to report btime (creation time)
+       # if the caller doesn't ask for it, so we define STATX_BTIME here and
+       # pass it in to the statx command.
+       export STATX_BTIME=0x800
+       $XFS_IO_PROG -f $TEST_DIR/test_creation_time -c "statx -m $STATX_BTIME -v" \
+               | grep btime >>$seqres.full 2>&1 || \
+               _notrun "inode creation time not supported by this filesystem"
+       rm -f $TEST_DIR/test_creation_time
+}
+
+_require_scratch_btime()
+{
+       _require_scratch
+       _scratch_mkfs > /dev/null 2>&1
+       _scratch_mount
+
+       # Note: filesystems are not required to report btime (creation time)
+       # if the caller doesn't ask for it, so we define STATX_BTIME here and
+       # pass it in to the statx command.
+       export STATX_BTIME=0x800
+       $XFS_IO_PROG -f $SCRATCH_MNT/test_creation_time -c "statx -m $STATX_BTIME -v" \
+               | grep btime >>$seqres.full 2>&1 || \
+               _notrun "inode creation time not supported by this filesystem"
+
+       _scratch_unmount
+}
+
+_require_inode_limits()
+{
+       if [ $(_get_free_inode $TEST_DIR) -eq 0 ]; then
+               _notrun "$FSTYP does not have a fixed number of inodes available"
+       fi
+}
+
+_require_filefrag_options()
+{
+       _require_command "$FILEFRAG_PROG" filefrag
+
+       local options=$1
+       local file="$TEST_DIR/options_testfile"
+
+       echo "XX" > $file
+       ${FILEFRAG_PROG} -$options $file 2>&1 | grep -q "invalid option" && \
+               _notrun "filefrag doesn't support $options option"
+       rm -f $file
+}
+
+_require_fibmap()
+{
+       _require_filefrag_options "B"
+
+       local file="$TEST_DIR/fibmap_testfile"
+
+       echo "XX" > $file
+       ${FILEFRAG_PROG} -B $file 2>&1 | grep -q "FIBMAP[[:space:]]*unsupported"
+       if [ $? -eq 0 ]; then
+               _notrun "FIBMAP not supported by this filesystem"
+       fi
+       rm -f $file
+}
+
+_try_wipe_scratch_devs()
+{
+       test -x "$WIPEFS_PROG" || return 0
+
+       for dev in $SCRATCH_DEV_POOL $SCRATCH_DEV $SCRATCH_LOGDEV $SCRATCH_RTDEV; do
+               test -b $dev && $WIPEFS_PROG -a $dev
+       done
+}
+
+# Only run this on xfs if xfs_scrub is available and has the unicode checker
+_check_xfs_scrub_does_unicode() {
+       [ "${FSTYP}" == "xfs" ] || return 1
+
+       local mount="$1"
+       local dev="$2"
+
+       _supports_xfs_scrub "${mount}" "${dev}" || return 1
+
+       # We only care if xfs_scrub has unicode string support...
+       if ! type ldd > /dev/null 2>&1 || \
+          ! ldd "${XFS_SCRUB_PROG}" | grep -q libicui18n; then
+               return 1
+       fi
+
+       return 0
+}
+
 init_rc
 
 ################################################################################