check: filter lockdep bugs when scanning dmesg
[xfstests-dev.git] / common / rc
index ab5dba25b09bbcc8a36fdf09fafaac1d8a8c1fa0..cbd3c59a39e53231806c4e01616015dec91f6b99 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
 
@@ -136,6 +118,7 @@ case "$FSTYP" in
         [ "$XFS_REPAIR_PROG" = "" ] && _fatal "xfs_repair not found"
         [ "$XFS_DB_PROG" = "" ] && _fatal "xfs_db not found"
         [ "$MKFS_XFS_PROG" = "" ] && _fatal "mkfs_xfs not found"
+        [ "$XFS_INFO_PROG" = "" ] && _fatal "xfs_info not found"
 
         . ./common/xfs
         ;;
@@ -320,7 +303,7 @@ _supports_filetype()
        local fstyp=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $2}'`
        case "$fstyp" in
        xfs)
-               xfs_info $dir | grep -q "ftype=1"
+               $XFS_INFO_PROG $dir | grep -q "ftype=1"
                ;;
        ext2|ext3|ext4)
                local dev=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $1}'`
@@ -374,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
 }
 
@@ -986,7 +969,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)
@@ -2005,7 +1991,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 $?
 }
 
@@ -2154,7 +2142,7 @@ _require_xfs_io_command()
                param_checked=1
                ;;
        "scrub"|"repair")
-               testio=`$XFS_IO_PROG -x -c "$command probe 0" $TEST_DIR 2>&1`
+               testio=`$XFS_IO_PROG -x -c "$command probe" $TEST_DIR 2>&1`
                echo $testio | grep -q "Inappropriate ioctl" && \
                        _notrun "xfs_io $command support is missing"
                ;;
@@ -2222,15 +2210,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
@@ -2297,6 +2298,53 @@ _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|nfs*|ocfs2|tmpfs)
+               return 0
+               ;;
+       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()
 {
@@ -2960,18 +3008,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()
@@ -3243,9 +3279,12 @@ _exclude_scratch_mount_option()
 _require_atime()
 {
        _exclude_scratch_mount_option "noatime"
-       if [ "$FSTYP" == "nfs" ]; then
-               _notrun "atime related mount options have no effect on NFS"
-       fi
+       case $FSTYP in
+       nfs|cifs)
+               _notrun "atime related mount options have no effect on $FSTYP"
+               ;;
+       esac
+
 }
 
 _require_relatime()
@@ -3458,6 +3497,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()
 {
@@ -3469,12 +3518,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" \
@@ -3496,7 +3545,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
@@ -3517,10 +3566,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
@@ -3528,17 +3587,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
 
@@ -3785,6 +3855,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()
 {
@@ -3808,6 +3917,85 @@ _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_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
+}
+
 init_rc
 
 ################################################################################