2 # SPDX-License-Identifier: GPL-2.0+
3 # Copyright (c) 2000-2006 Silicon Graphics, Inc. All Rights Reserved.
7 BC=$(which bc 2> /dev/null) || BC=
12 _notrun "this test requires 'bc' tool for doing math operations"
18 [ $# -le 0 ] && return
19 LANG=C echo "scale=0; $@" | "$BC" -q 2> /dev/null
24 command dd --help 2>&1 | grep noxfer >/dev/null
27 command dd status=noxfer $@
33 # Prints the md5 checksum of a given file
36 md5sum $1 | cut -d ' ' -f1
39 # Write a byte into a range of a file
45 local xfs_io_args="$5"
47 $XFS_IO_PROG $xfs_io_args -f -c "pwrite -S $pattern $offset $len" "$file"
50 # mmap-write a byte into a range of a file
58 $XFS_IO_PROG -f -c "mmap -rw 0 $mmap_len" -c "mwrite -S $pattern $offset $len" "$file"
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
67 ls -l $* | sed "s/\(^[-rwxdlbcpsStT]*\)\. /\1 /" | grep -v 'lost+found'
91 echo "$_err_msg" | tee -a $seqres.full
92 echo "(see $seqres.full for details)"
95 # make sure we have a standard umask
98 # check for correct setup and source the $FSTYP specific functions now
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"
110 [ "$MKFS_UDF_PROG" = "" ] && _fatal "mkfs_udf/mkudffs not found"
113 [ "$MKFS_BTRFS_PROG" = "" ] && _fatal "mkfs.btrfs not found"
118 [ "$MKFS_EXT4_PROG" = "" ] && _fatal "mkfs.ext4 not found"
121 [ "$MKFS_F2FS_PROG" = "" ] && _fatal "mkfs.f2fs not found"
139 [ "$MKFS_REISER4_PROG" = "" ] && _fatal "mkfs.reiser4 not found"
144 [ "$UBIUPDATEVOL_PROG" = "" ] && _fatal "ubiupdatevol not found"
148 if [ ! -z "$REPORT_LIST" ]; then
158 # Get hugepagesize in bytes
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))
170 $MOUNT_PROG `_mount_ops_filter $*`
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
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"
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 | \
193 MOUNTED_POINT_STACK="$mnt_point $MOUNTED_POINT_STACK"
199 # Unmount the last mounted mountpoint in MOUNTED_POINT_STACK
200 # and return it to caller
203 local last_mnt=`echo $MOUNTED_POINT_STACK | awk '{print $1}'`
205 if [ -n "$last_mnt" ]; then
206 $UMOUNT_PROG $last_mnt
208 MOUNTED_POINT_STACK=`echo $MOUNTED_POINT_STACK | cut -d\ -f2-`
211 # Unmount all mountpoints in MOUNTED_POINT_STACK and clear the stack
214 if [ -n "$MOUNTED_POINT_STACK" ]; then
215 $UMOUNT_PROG $MOUNTED_POINT_STACK
217 MOUNTED_POINT_STACK=""
227 if [ "$FSTYP" != "xfs" ]; then
233 SCRATCH_OPTIONS="$SCRATCH_OPTIONS -f"
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"
255 if [ "$FSTYP" != "xfs" ]; then
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"
278 local last_index=$(( $# - 1 ))
280 [ $last_index -gt 0 ] && shift $last_index
284 $PERL_PROG -ne "s#mtpt=[^,|^\n|^\s]*#mtpt=$fs_escaped\1\2#; print;"
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()
293 echo $MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS $*
296 _scratch_mount_options()
298 _scratch_options mount
300 echo `_common_dev_mount_options $*` $SCRATCH_OPTIONS \
301 $SCRATCH_DEV $SCRATCH_MNT
308 local fstyp=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $2}'`
311 $XFS_INFO_PROG $dir | grep -q "ftype=1"
314 local dev=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $1}'`
315 tune2fs -l $dev | grep -q filetype
318 local testfile=$dir/$$.ftype
320 # look for DT_UNKNOWN files
321 local unknowns=$($here/src/t_dir_type $dir u | wc -l)
323 # 0 unknowns is success
329 # mount scratch device with given options but don't check mount status
332 if [ "$FSTYP" == "overlay" ]; then
333 _overlay_scratch_mount $*
336 _mount -t $FSTYP `_scratch_mount_options $*`
339 # mount scratch device with given options and _fail if mount fails
342 _try_scratch_mount $* || _fail "mount failed"
349 _overlay_scratch_unmount
352 $UMOUNT_PROG $SCRATCH_MNT
355 $UMOUNT_PROG $SCRATCH_DEV
364 if test -n "$opts"; then
365 _try_scratch_mount "-o remount,$opts"
369 _scratch_cycle_mount()
373 if [ "$FSTYP" = tmpfs ]; then
374 _scratch_remount "$opts"
377 if test -n "$opts"; then
381 _try_scratch_mount "$opts" || _fail "cycle mount failed"
386 if [ $FSTYP = "overlay" ]; then
387 # In lagacy overlay usage, it may specify directory as
388 # SCRATCH_DEV, in this case OVL_BASE_SCRATCH_DEV
389 # will be null, so check OVL_BASE_SCRATCH_DEV before
390 # running shutdown to avoid shutting down base fs accidently.
391 if [ -z $OVL_BASE_SCRATCH_DEV ]; then
392 _fail "_scratch_shutdown: call _require_scratch_shutdown first in test"
394 $here/src/godown $* $OVL_BASE_SCRATCH_MNT
397 $here/src/godown $* $SCRATCH_MNT
401 # Return a file path that can be used to shut down the scratch filesystem.
402 # Caller should _require_scratch_shutdown before using this.
403 _scratch_shutdown_handle()
405 if [ $FSTYP = "overlay" ]; then
406 echo $OVL_BASE_SCRATCH_MNT
414 if [ "$FSTYP" == "overlay" ]; then
415 _overlay_test_mount $*
419 _mount -t $FSTYP $TEST_OPTIONS $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS $* $TEST_DEV $TEST_DIR
424 if [ "$FSTYP" == "overlay" ]; then
425 _overlay_test_unmount
427 $UMOUNT_PROG $TEST_DEV
433 if [ "$FSTYP" = tmpfs ]; then
440 _scratch_mkfs_options()
442 _scratch_options mkfs
443 echo $SCRATCH_OPTIONS $MKFS_OPTIONS $* $SCRATCH_DEV
446 # Do the actual mkfs work on SCRATCH_DEV. Firstly mkfs with both MKFS_OPTIONS
447 # and user specified mkfs options, if that fails (due to conflicts between mkfs
448 # options), do a second mkfs with only user provided mkfs options.
450 # First param is the mkfs command without any mkfs options and device.
451 # Second param is the filter to remove unnecessary messages from mkfs stderr.
452 # Other extra mkfs options are followed.
458 local extra_mkfs_options=$*
460 local tmp=`mktemp -u`
462 # save mkfs output in case conflict means we need to run again.
463 # only the output for the mkfs that applies should be shown
464 eval "$mkfs_cmd $MKFS_OPTIONS $extra_mkfs_options $SCRATCH_DEV" \
465 2>$tmp.mkfserr 1>$tmp.mkfsstd
468 # a mkfs failure may be caused by conflicts between $MKFS_OPTIONS and
469 # $extra_mkfs_options
470 if [ $mkfs_status -ne 0 -a -n "$extra_mkfs_options" ]; then
472 echo -n "** mkfs failed with extra mkfs options "
473 echo "added to \"$MKFS_OPTIONS\" by test $seq **"
474 echo -n "** attempting to mkfs using only test $seq "
475 echo "options: $extra_mkfs_options **"
478 # running mkfs again. overwrite previous mkfs output files
479 eval "$mkfs_cmd $extra_mkfs_options $SCRATCH_DEV" \
480 2>$tmp.mkfserr 1>$tmp.mkfsstd
484 # output stored mkfs output, filtering unnecessary output from stderr
486 eval "cat $tmp.mkfserr | $mkfs_filter" >&2
488 rm -f $tmp.mkfserr $tmp.mkfsstd
492 _setup_large_ext4_fs()
497 [ "$LARGE_SCRATCH_DEV" != yes ] && return 0
498 [ -z "$SCRATCH_DEV_EMPTY_SPACE" ] && SCRATCH_DEV_EMPTY_SPACE=0
499 [ $SCRATCH_DEV_EMPTY_SPACE -ge $fs_size ] && return 0
501 # Default free space in the FS is 50GB, but you can specify more via
502 # SCRATCH_DEV_EMPTY_SPACE
503 local space_to_consume=$(($fs_size - 50*1024*1024*1024 - $SCRATCH_DEV_EMPTY_SPACE))
505 # mount the filesystem and create 16TB - 4KB files until we consume
506 # all the necessary space.
507 _try_scratch_mount 2>&1 >$tmp_dir/mnt.err
509 if [ $status -ne 0 ]; then
511 cat $tmp_dir/mnt.err >&2
512 rm -f $tmp_dir/mnt.err
515 rm -f $tmp_dir/mnt.err
517 local file_size=$((16*1024*1024*1024*1024 - 4096))
519 while [ $space_to_consume -gt $file_size ]; do
522 -c "truncate $file_size" \
523 -c "falloc -k 0 $file_size" \
524 $SCRATCH_MNT/.use_space.$nfiles 2>&1
526 if [ $status -ne 0 ]; then
530 space_to_consume=$(( $space_to_consume - $file_size ))
531 nfiles=$(($nfiles + 1))
534 # consume the remaining space.
535 if [ $space_to_consume -gt 0 ]; then
537 -c "truncate $space_to_consume" \
538 -c "falloc -k 0 $space_to_consume" \
539 $SCRATCH_MNT/.use_space.$nfiles 2>&1
542 export NUM_SPACE_FILES=$nfiles
545 if [ $status -ne 0 ]; then
546 echo "large file prealloc failed"
547 cat $tmp_dir/mnt.err >&2
555 local mkfs_cmd="$MKFS_EXT4_PROG -F"
556 local mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \" | grep -v \"^$\""
557 local tmp=`mktemp -u`
560 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
561 $mkfs_cmd -O journal_dev $MKFS_OPTIONS $SCRATCH_LOGDEV && \
562 mkfs_cmd="$mkfs_cmd -J device=$SCRATCH_LOGDEV"
564 _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
567 if [ $mkfs_status -eq 0 -a "$LARGE_SCRATCH_DEV" = yes ]; then
568 # manually parse the mkfs output to get the fs size in bytes
569 local fs_size=`cat $tmp.mkfsstd | awk ' \
570 /^Block size/ { split($2, a, "="); bs = a[2] ; } \
571 / inodes, / { blks = $3 } \
572 /reserved for the super user/ { resv = $1 } \
573 END { fssize = bs * blks - resv; print fssize }'`
575 _setup_large_ext4_fs $fs_size
579 # output mkfs stdout and stderr
582 rm -f $tmp.mkfserr $tmp.mkfsstd
591 local compressopt="$3"
593 test -n "$E2IMAGE_PROG" || _fail "e2image not installed"
594 $E2IMAGE_PROG -Q "$device" "$dumpfile"
595 [ "$compressopt" = "compress" ] && [ -n "$DUMP_COMPRESSOR" ] &&
596 $DUMP_COMPRESSOR "$dumpfile" &>> "$seqres.full"
606 # do nothing for cifs
612 # do nothing for virtiofs
615 # do nothing for ceph
618 # do nothing for glusterfs
621 # do nothing for overlay
624 # do nothing for pvfs2
627 $MKFS_UDF_PROG $MKFS_OPTIONS $* $TEST_DEV > /dev/null
630 $MKFS_BTRFS_PROG $MKFS_OPTIONS $* $TEST_DEV > /dev/null
633 $MKFS_PROG -t $FSTYP -- -F $MKFS_OPTIONS $* $TEST_DEV
636 yes | $MKFS_PROG -t $FSTYP -- $MKFS_OPTIONS $* $TEST_DEV
643 local tmp=`mktemp -u`
652 # do nothing for virtiofs
655 # do nothing for overlay
658 # do nothing for pvfs2
661 $MKFS_UDF_PROG $MKFS_OPTIONS $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
664 $MKFS_BTRFS_PROG $MKFS_OPTIONS $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
667 $MKFS_PROG -t $FSTYP -- -F $MKFS_OPTIONS $* \
668 2>$tmp.mkfserr 1>$tmp.mkfsstd
671 $MKFS_PROG -t $FSTYP -- -f $MKFS_OPTIONS $* \
672 2>$tmp.mkfserr 1>$tmp.mkfsstd
675 yes | $MKFS_PROG -t $FSTYP -- $MKFS_OPTIONS $* \
676 2>$tmp.mkfserr 1>$tmp.mkfsstd
680 if [ $? -ne 0 ]; then
681 # output stored mkfs output
687 rm -f $tmp.mkfserr $tmp.mkfsstd
690 # remove all files in $SCRATCH_MNT, useful when testing on NFS/CIFS
691 _scratch_cleanup_files()
695 # Avoid rm -rf /* if we messed up
696 [ -n "$OVL_BASE_SCRATCH_MNT" ] || return 1
697 _overlay_base_scratch_mount || return 1
698 rm -rf $OVL_BASE_SCRATCH_MNT/* || return 1
699 _overlay_mkdirs $OVL_BASE_SCRATCH_MNT
700 # leave base fs mouted so tests can setup lower/upper dir files
703 [ -n "$SCRATCH_MNT" ] || return 1
705 rm -rf $SCRATCH_MNT/*
718 nfs*|cifs|ceph|overlay|glusterfs|pvfs2|9p|virtiofs)
719 # unable to re-create this fstyp, just remove all files in
720 # $SCRATCH_MNT to avoid EEXIST caused by the leftover files
721 # created in previous runs
722 _scratch_cleanup_files
726 # do nothing for tmpfs
730 # erase the UBI volume; reformated automatically on next mount
731 $UBIUPDATEVOL_PROG ${SCRATCH_DEV} -t
735 _scratch_mkfs_ext4 $*
743 mkfs_cmd="$MKFS_UDF_PROG"
747 mkfs_cmd="$MKFS_BTRFS_PROG"
751 mkfs_cmd="$MKFS_PROG -t $FSTYP -- -F"
752 mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
754 # put journal on separate device?
755 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
756 $mkfs_cmd -O journal_dev $MKFS_OPTIONS $SCRATCH_LOGDEV && \
757 mkfs_cmd="$mkfs_cmd -J device=$SCRATCH_LOGDEV"
760 mkfs_cmd="$MKFS_PROG -t $FSTYP -- -F"
761 mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
764 mkfs_cmd="$MKFS_F2FS_PROG"
768 mkfs_cmd="yes | $MKFS_PROG -t $FSTYP --"
769 mkfs_filter="grep -v -e ^mkfs\.ocfs2"
772 mkfs_cmd="yes | $MKFS_PROG -t $FSTYP --"
777 _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $*
781 # Helper function to get a spare or replace-target device from
782 # configured SCRATCH_DEV_POLL, must call _scratch_dev_pool_get()
783 # before _spare_dev_get(). Replace-target-device/Spare-device will
784 # be assigned to SPARE_DEV.
785 # As of now only one replace-target-device/spare-device can be
789 # _scratch_dev_pool_get() <ndevs>
793 # _scratch_dev_pool_put()
797 typeset -p SCRATCH_DEV_POOL_SAVED >/dev/null 2>&1
798 if [ $? -ne 0 ]; then
799 _fail "Bug: unset val, must call _scratch_dev_pool_get before _spare_dev_get"
802 if [ -z "$SCRATCH_DEV_POOL_SAVED" ]; then
803 _fail "Bug: str empty, must call _scratch_dev_pool_get before _spare_dev_get"
806 # Check if the spare is already assigned
807 typeset -p SPARE_DEV >/dev/null 2>&1
808 if [ $? -eq 0 ]; then
809 if [ ! -z "$SPARE_DEV" ]; then
810 _fail "Bug: SPARE_DEV = $SPARE_DEV already assigned"
814 local ndevs=`echo $SCRATCH_DEV_POOL| wc -w`
815 local config_ndevs=`echo $SCRATCH_DEV_POOL_SAVED| wc -w`
817 if [ $ndevs -eq $config_ndevs ]; then
818 _notrun "All devs used no spare"
820 # Get a dev that is not used
821 local -a devs="( $SCRATCH_DEV_POOL_SAVED )"
822 SPARE_DEV=${devs[@]:$ndevs:1}
828 typeset -p SPARE_DEV >/dev/null 2>&1
829 if [ $? -ne 0 ]; then
830 _fail "Bug: unset val, must call _spare_dev_get before its put"
833 if [ -z "$SPARE_DEV" ]; then
834 _fail "Bug: str empty, must call _spare_dev_get before its put"
841 # Generally test cases will have..
842 # _require_scratch_dev_pool X
843 # to make sure it has the enough scratch devices including
844 # replace-target and spare device. Now arg1 here is the
845 # required number of scratch devices by a-test-case excluding
846 # the replace-target and spare device. So this function will
847 # set SCRATCH_DEV_POOL to the specified number of devices.
850 # _scratch_dev_pool_get() <ndevs>
853 # _scratch_dev_pool_put()
855 _scratch_dev_pool_get()
857 if [ $# -ne 1 ]; then
858 _fail "Usage: _scratch_dev_pool_get ndevs"
862 local config_ndevs=`echo $SCRATCH_DEV_POOL| wc -w`
863 local -a devs="( $SCRATCH_DEV_POOL )"
865 typeset -p config_ndevs >/dev/null 2>&1
866 if [ $? -ne 0 ]; then
867 _fail "Bug: cant find SCRATCH_DEV_POOL ndevs"
870 if [ $config_ndevs -lt $test_ndevs ]; then
871 _notrun "Need at least test requested number of ndevs $test_ndevs"
874 SCRATCH_DEV_POOL_SAVED=${SCRATCH_DEV_POOL}
875 export SCRATCH_DEV_POOL_SAVED
876 SCRATCH_DEV_POOL=${devs[@]:0:$test_ndevs}
877 export SCRATCH_DEV_POOL
880 _scratch_dev_pool_put()
882 typeset -p SCRATCH_DEV_POOL_SAVED >/dev/null 2>&1
883 if [ $? -ne 0 ]; then
884 _fail "Bug: unset val, must call _scratch_dev_pool_get before _scratch_dev_pool_put"
887 if [ -z "$SCRATCH_DEV_POOL_SAVED" ]; then
888 _fail "Bug: str empty, must call _scratch_dev_pool_get before _scratch_dev_pool_put"
891 export SCRATCH_DEV_POOL=$SCRATCH_DEV_POOL_SAVED
892 export SCRATCH_DEV_POOL_SAVED=""
899 $MKFS_BTRFS_PROG $MKFS_OPTIONS $* $SCRATCH_DEV_POOL > /dev/null
902 echo "_scratch_pool_mkfs is not implemented for $FSTYP" 1>&2
907 # Return the amount of free memory available on the system
910 free -b | grep ^Mem | awk '{print $4}'
913 _available_memory_bytes()
915 nf=`free -b | grep ^Mem | awk '{print NF}'`
916 if [[ nf -lt 7 ]]; then
917 # Doesn't have available field. Fallback.
920 free -b | grep ^Mem | awk '{print $7}'
924 # Create fs of certain size on scratch device
925 # _scratch_mkfs_sized <size in bytes> [optional blocksize]
926 _scratch_mkfs_sized()
934 def_blksz=`echo $MKFS_OPTIONS | sed -rn 's/.*-b ?size= ?+([0-9]+).*/\1/p'`
936 ext2|ext3|ext4|ext4dev|udf|btrfs|reiser4|ocfs2|reiserfs)
937 def_blksz=`echo $MKFS_OPTIONS | sed -rn 's/.*-b ?+([0-9]+).*/\1/p'`
944 [ -n "$def_blksz" ] && blocksize=$def_blksz
945 [ -z "$blocksize" ] && blocksize=4096
948 if ! [[ $fssize =~ $re ]] ; then
949 _notrun "error: _scratch_mkfs_sized: fs size \"$fssize\" not an integer."
951 if ! [[ $blocksize =~ $re ]] ; then
952 _notrun "error: _scratch_mkfs_sized: block size \"$blocksize\" not an integer."
955 local blocks=`expr $fssize / $blocksize`
957 if [ -b "$SCRATCH_DEV" ]; then
958 local devsize=`blockdev --getsize64 $SCRATCH_DEV`
959 [ "$fssize" -gt "$devsize" ] && _notrun "Scratch device too small"
962 if [ "$FSTYP" = "xfs" ] && [ -b "$SCRATCH_RTDEV" ]; then
963 local rtdevsize=`blockdev --getsize64 $SCRATCH_RTDEV`
964 [ "$fssize" -gt "$rtdevsize" ] && _notrun "Scratch rt device too small"
965 rt_ops="-r size=$fssize"
970 # don't override MKFS_OPTIONS that set a block size.
971 echo $MKFS_OPTIONS |egrep -q "b?size="
972 if [ $? -eq 0 ]; then
973 _scratch_mkfs_xfs -d size=$fssize $rt_ops
975 _scratch_mkfs_xfs -d size=$fssize $rt_ops -b size=$blocksize
978 ext2|ext3|ext4|ext4dev)
979 ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
982 # mkfs.gfs2 doesn't automatically shrink journal files on small
983 # filesystems, so the journal files may end up being bigger than the
984 # filesystem, which will cause mkfs.gfs2 to fail. Until that's fixed,
985 # shrink the journal size to at most one eigth of the filesystem and at
986 # least 8 MiB, the minimum size allowed.
987 local min_journal_size=8
988 local default_journal_size=128
989 if (( fssize/8 / (1024*1024) < default_journal_size )); then
990 local journal_size=$(( fssize/8 / (1024*1024) ))
991 (( journal_size >= min_journal_size )) || journal_size=$min_journal_size
992 MKFS_OPTIONS="-J $journal_size $MKFS_OPTIONS"
994 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS -O -b $blocksize $SCRATCH_DEV $blocks
997 yes | ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1000 $MKFS_UDF_PROG $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1004 # minimum size that's needed without the mixed option.
1005 # Ref: btrfs-prog: btrfs_min_dev_size()
1006 # Non mixed mode is also the default option.
1007 (( fssize < $((256 * 1024 *1024)) )) && mixed_opt='--mixed'
1008 $MKFS_BTRFS_PROG $MKFS_OPTIONS $mixed_opt -b $fssize $SCRATCH_DEV
1011 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS $SCRATCH_DEV $blocks
1014 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1017 # mkfs.resier4 requires size in KB as input for creating filesystem
1018 $MKFS_REISER4_PROG $MKFS_OPTIONS -y -b $blocksize $SCRATCH_DEV \
1019 `expr $fssize / 1024`
1022 # mkfs.f2fs requires # of sectors as an input for the size
1023 local sector_size=`blockdev --getss $SCRATCH_DEV`
1024 $MKFS_F2FS_PROG $MKFS_OPTIONS $SCRATCH_DEV `expr $fssize / $sector_size`
1027 local free_mem=`_free_memory_bytes`
1028 if [ "$free_mem" -lt "$fssize" ] ; then
1029 _notrun "Not enough memory ($free_mem) for tmpfs with $fssize bytes"
1031 export MOUNT_OPTIONS="-o size=$fssize $TMPFS_MOUNT_OPTIONS"
1034 _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_sized"
1039 # Emulate an N-data-disk stripe w/ various stripe units
1040 # _scratch_mkfs_geom <sunit bytes> <swidth multiplier> [optional blocksize]
1041 _scratch_mkfs_geom()
1043 local sunit_bytes=$1
1044 local swidth_mult=$2
1046 [ -z "$blocksize" ] && blocksize=4096
1048 local sunit_blocks=$(( sunit_bytes / blocksize ))
1049 local swidth_blocks=$(( sunit_blocks * swidth_mult ))
1053 if echo "$MKFS_OPTIONS" | egrep -q "b?size="; then
1054 MKFS_OPTIONS=$(echo "$MKFS_OPTIONS" | sed -r "s/(b?size=)[0-9]+k?/\1$blocksize/")
1056 MKFS_OPTIONS+=" -b size=$blocksize"
1059 if echo "$MKFS_OPTIONS" | egrep -q "(su|sunit|sw|swidth)="; then
1060 MKFS_OPTIONS=$(echo "$MKFS_OPTIONS" | sed -r \
1061 -e "s/(su|sunit)=[0-9kmg]+/su=$sunit_bytes/" \
1062 -e "s/(sw|swidth)=[0-9kmg]+/sw=$swidth_mult/")
1064 MKFS_OPTIONS+=" -d su=$sunit_bytes,sw=$swidth_mult"
1068 MKFS_OPTIONS+=" -b $blocksize -E stride=$sunit_blocks,stripe_width=$swidth_blocks"
1071 _notrun "can't mkfs $FSTYP with geometry"
1077 # Create fs of certain blocksize on scratch device
1078 # _scratch_mkfs_blocksized blocksize
1079 _scratch_mkfs_blocksized()
1084 if ! [[ $blocksize =~ $re ]] ; then
1085 _notrun "error: _scratch_mkfs_sized: block size \"$blocksize\" not an integer."
1090 _scratch_mkfs_xfs $MKFS_OPTIONS -b size=$blocksize
1093 ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV
1096 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS -O -b $blocksize $SCRATCH_DEV
1099 yes | ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize -C $blocksize $SCRATCH_DEV
1102 _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_blocksized"
1111 xfs_io -x -c "resblks $1" $SCRATCH_MNT
1119 # Repair scratch filesystem. Returns 0 if the FS is good to go (either no
1120 # errors found or errors were fixed) and nonzero otherwise; also spits out
1121 # a complaint on stderr if fsck didn't tell us that the FS is good to go.
1122 _repair_scratch_fs()
1126 _scratch_xfs_repair "$@" 2>&1
1128 if [ "$res" -ne 0 ]; then
1129 echo "xfs_repair returns $res; replay log?"
1132 if [ "$res" -gt 0 ]; then
1133 echo "mount returns $res; zap log?"
1134 _scratch_xfs_repair -L 2>&1
1135 echo "log zap returns $?"
1137 umount "$SCRATCH_MNT"
1139 _scratch_xfs_repair "$@" 2>&1
1142 if [ $res -ne 0 ]; then
1143 _dump_err2 "xfs_repair failed, err=$res"
1148 local dev=$SCRATCH_DEV
1150 if [ $FSTYP = "overlay" -a -n "$OVL_BASE_SCRATCH_DEV" ]; then
1151 _repair_overlay_scratch_fs
1152 # Fall through to repair base fs
1153 dev=$OVL_BASE_SCRATCH_DEV
1154 fstyp=$OVL_BASE_FSTYP
1155 $UMOUNT_PROG $OVL_BASE_SCRATCH_MNT
1157 # Let's hope fsck -y suffices...
1158 fsck -t $fstyp -y $dev 2>&1
1161 $FSCK_OK|$FSCK_NONDESTRUCT|$FSCK_REBOOT)
1165 _dump_err2 "fsck.$FSTYP failed, err=$res"
1177 echo "Usage: _get_pids_by_name process-name" 1>&2
1181 # Algorithm ... all ps(1) variants have a time of the form MM:SS or
1182 # HH:MM:SS before the psargs field, use this as the search anchor.
1184 # Matches with $1 (process-name) occur if the first psarg is $1
1185 # or ends in /$1 ... the matching uses sed's regular expressions,
1186 # so passing a regex into $1 will work.
1191 -e 's/[ ][ ]*/ /g' \
1194 -e "/[0-9]:[0-9][0-9] *[^ ]*\/$1 /s/ .*//p" \
1195 -e "/[0-9]:[0-9][0-9] *$1 /s/ .*//p"
1199 # _df_device : get an IRIX style df line for a given device
1201 # - returns "" if not mounted
1202 # - returns fs type in field two (ala IRIX)
1203 # - joins line together if split by fancy df formatting
1204 # - strips header etc
1211 echo "Usage: _df_device device" 1>&2
1215 # Note that we use "==" here so awk doesn't try to interpret an NFS over
1216 # IPv6 server as a regular expression.
1217 $DF_PROG 2>/dev/null | $AWK_PROG -v what=$1 '
1218 ($1==what) && (NF==1) {
1232 # _df_dir : get an IRIX style df line for device where a directory resides
1234 # - returns fs type in field two (ala IRIX)
1235 # - joins line together if split by fancy df formatting
1236 # - strips header etc
1243 echo "Usage: _df_dir device" 1>&2
1247 $DF_PROG $1 2>/dev/null | $AWK_PROG -v what=$1 '
1263 # return percentage used disk space for mounted device
1269 echo "Usage: _used device" 1>&2
1273 _df_device $1 | $AWK_PROG '{ sub("%", "") ; print $6 }'
1276 # return the FS type of a mounted device
1282 echo "Usage: _fs_type device" 1>&2
1287 # The Linux kernel shows NFSv4 filesystems in df output as
1288 # filesystem type nfs4, although we mounted it as nfs earlier.
1289 # Fix the filesystem type up here so that the callers don't
1290 # have to bother with this quirk.
1292 _df_device $1 | $AWK_PROG '{ print $2 }' | \
1293 sed -e 's/nfs4/nfs/' -e 's/fuse.glusterfs/glusterfs/'
1296 # return the FS mount options of a mounted device
1298 # should write a version which just parses the output of mount for IRIX
1299 # compatibility, but since this isn't used at all, at the moment I'll leave
1306 echo "Usage: _fs_options device" 1>&2
1310 $AWK_PROG -v dev=$1 '
1311 match($1,dev) { print $4 }
1315 # returns device number if a file is a block device
1321 echo "Usage: _is_block_dev dev" 1>&2
1326 if [ -L "$dev" ]; then
1327 dev=`readlink -f "$dev"`
1330 if [ -b "$dev" ]; then
1331 $here/src/lstat64 "$dev" | $AWK_PROG '/Device type:/ { print $9 }'
1335 # returns device number if a file is a character device
1339 if [ $# -ne 1 ]; then
1340 echo "Usage: _is_char_dev dev" 1>&2
1345 if [ -L "$dev" ]; then
1346 dev=`readlink -f "$dev"`
1349 if [ -c "$dev" ]; then
1350 $here/src/lstat64 "$dev" | $AWK_PROG '/Device type:/ { print $9 }'
1354 # Do a command, log it to $seqres.full, optionally test return status
1355 # and die if command fails. If called with one argument _do executes the
1356 # command, logs it, and returns its exit status. With two arguments _do
1357 # first prints the message passed in the first argument, and then "done"
1358 # or "fail" depending on the return status of the command passed in the
1359 # second argument. If the command fails and the variable _do_die_on_error
1360 # is set to "always" or the two argument form is used and _do_die_on_error
1361 # is set to "message_only" _do will print an error message to
1362 # $seqres.out and exit.
1366 if [ $# -eq 1 ]; then
1368 elif [ $# -eq 2 ]; then
1373 echo "Usage: _do [note] cmd" 1>&2
1377 (eval "echo '---' \"$cmd\"") >>$seqres.full
1378 (eval "$cmd") >$tmp._out 2>&1
1380 cat $tmp._out >>$seqres.full
1382 if [ $# -eq 2 ]; then
1383 if [ $ret -eq 0 ]; then
1390 && [ "$_do_die_on_error" = "always" \
1391 -o \( $# -eq 2 -a "$_do_die_on_error" = "message_only" \) ]
1393 [ $# -ne 2 ] && echo
1394 eval "echo \"$cmd\" failed \(returned $ret\): see $seqres.full"
1401 # bail out, setting up .notrun file. Need to kill the filesystem check files
1402 # here, otherwise they are set incorrectly for the next test.
1406 echo "$*" > $seqres.notrun
1407 echo "$seq not run: $*"
1408 rm -f ${RESULT_DIR}/require_test*
1409 rm -f ${RESULT_DIR}/require_scratch*
1415 # just plain bail out
1419 echo "$*" | tee -a $seqres.full
1420 echo "(see $seqres.full for details)"
1425 # tests whether $FSTYP is one of the supported filesystems for a test
1433 if [ "$f" = "$FSTYP" -o "$f" = "generic" ]
1439 _notrun "not suitable for this filesystem type: $FSTYP"
1442 # check if a FS on a device is mounted
1443 # if so, verify that it is mounted on mount point
1444 # if fstype is given as argument, verify that it is also
1445 # mounted with correct fs type
1455 # find $dev as the source, and print result in "$dev $mnt" format
1456 local mount_rec=`findmnt -rncv -S $dev -o SOURCE,TARGET`
1457 [ -n "$mount_rec" ] || return 1 # 1 = not mounted
1459 # if it's mounted, make sure its on $mnt
1460 if [ "$mount_rec" != "$dev $mnt" ]; then
1461 echo "$devname=$dev is mounted but not on $mntname=$mnt - aborting"
1462 echo "Already mounted result:"
1464 return 2 # 2 = mounted on wrong mnt
1467 if [ -n "$type" -a "`_fs_type $dev`" != "$type" ]; then
1468 echo "$devname=$dev is mounted but not a type $type filesystem"
1469 # raw $DF_PROG cannot handle NFS/CIFS/overlay correctly
1471 return 3 # 3 = mounted as wrong type
1473 return 0 # 0 = mounted as expected
1476 # this test needs a scratch partition - check we're ok & unmount it
1477 # No post-test check of the device is required. e.g. the test intentionally
1478 # finishes the test with the filesystem in a corrupt state
1479 _require_scratch_nocheck()
1483 echo $SCRATCH_DEV | egrep -q ":/?" > /dev/null 2>&1
1484 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1485 _notrun "this test requires a valid \$SCRATCH_DEV"
1487 if [ ! -d "$SCRATCH_MNT" ]; then
1488 _notrun "this test requires a valid \$SCRATCH_MNT"
1492 if [ -z "$SCRATCH_DEV" ]; then
1493 _notrun "this test requires a valid \$SCRATCH_DEV"
1495 if [ ! -d "$SCRATCH_MNT" ]; then
1496 _notrun "this test requires a valid \$SCRATCH_MNT"
1500 echo $SCRATCH_DEV | grep -q ":/" > /dev/null 2>&1
1501 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1502 _notrun "this test requires a valid \$SCRATCH_DEV"
1504 if [ ! -d "$SCRATCH_MNT" ]; then
1505 _notrun "this test requires a valid \$SCRATCH_MNT"
1509 echo $SCRATCH_DEV | grep -q "://" > /dev/null 2>&1
1510 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1511 _notrun "this test requires a valid \$SCRATCH_DEV"
1513 if [ ! -d "$SCRATCH_MNT" ]; then
1514 _notrun "this test requires a valid \$SCRATCH_MNT"
1518 echo $SCRATCH_DEV | grep -q "//" > /dev/null 2>&1
1519 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1520 _notrun "this test requires a valid \$SCRATCH_DEV"
1522 if [ ! -d "$SCRATCH_MNT" ]; then
1523 _notrun "this test requires a valid \$SCRATCH_MNT"
1527 if [ -z "$OVL_BASE_SCRATCH_MNT" -o ! -d "$OVL_BASE_SCRATCH_MNT" ]; then
1528 _notrun "this test requires a valid \$OVL_BASE_SCRATCH_MNT as ovl base dir"
1530 # if $SCRATCH_MNT is derived from $OVL_BASE_SCRATCH_MNT then
1531 # don't check $SCRATCH_MNT dir here because base fs may not be mounted
1532 # and we will create the mount point anyway on _overlay_mount
1533 if [ "$SCRATCH_MNT" != "$OVL_BASE_SCRATCH_MNT/$OVL_MNT" -a ! -d "$SCRATCH_MNT" ]; then
1534 _notrun "this test requires a valid \$SCRATCH_MNT"
1538 if [ -z "$SCRATCH_DEV" -o ! -d "$SCRATCH_MNT" ];
1540 _notrun "this test requires a valid \$SCRATCH_MNT and unique \$SCRATCH_DEV"
1544 # ubifs needs an UBI volume. This will be a char device, not a block device.
1545 if [ ! -c "$SCRATCH_DEV" ]; then
1546 _notrun "this test requires a valid UBI volume for \$SCRATCH_DEV"
1548 if [ ! -d "$SCRATCH_MNT" ]; then
1549 _notrun "this test requires a valid \$SCRATCH_MNT"
1553 if [ -z "$SCRATCH_DEV" -o "`_is_block_dev "$SCRATCH_DEV"`" = "" ]
1555 _notrun "this test requires a valid \$SCRATCH_DEV"
1557 if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1559 _notrun "this test requires a valid \$SCRATCH_DEV"
1561 if [ ! -d "$SCRATCH_MNT" ]
1563 _notrun "this test requires a valid \$SCRATCH_MNT"
1568 _check_mounted_on SCRATCH_DEV $SCRATCH_DEV SCRATCH_MNT $SCRATCH_MNT
1570 [ $err -le 1 ] || exit 1
1573 # if it's mounted, unmount it
1574 if ! _scratch_unmount
1576 echo "failed to unmount $SCRATCH_DEV"
1580 rm -f ${RESULT_DIR}/require_scratch
1583 # we need the scratch device and it should be checked post test.
1586 _require_scratch_nocheck
1587 touch ${RESULT_DIR}/require_scratch
1590 # require a scratch dev of a minimum size (in kb)
1591 _require_scratch_size()
1593 [ $# -eq 1 ] || _fail "_require_scratch_size: expected size param"
1596 local devsize=`_get_device_size $SCRATCH_DEV`
1597 [ $devsize -lt $1 ] && _notrun "scratch dev too small"
1600 # require a scratch dev of a minimum size (in kb) and should not be checked
1602 _require_scratch_size_nocheck()
1604 [ $# -eq 1 ] || _fail "_require_scratch_size: expected size param"
1606 _require_scratch_nocheck
1607 local devsize=`_get_device_size $SCRATCH_DEV`
1608 [ $devsize -lt $1 ] && _notrun "scratch dev too small"
1611 # require scratch fs which supports >16T of filesystem size.
1612 _require_scratch_16T_support()
1616 _notrun "$FSTYP doesn't support >16T filesystem"
1619 _scratch_mkfs >> $seqres.full 2>&1
1621 local blocksize=$(_get_block_size $SCRATCH_MNT)
1622 if [ $blocksize -lt 4096 ]; then
1623 _notrun "This test requires >16T fs support"
1632 # this test needs a test partition - check we're ok & mount it
1638 echo $TEST_DEV | egrep -q ":/?" > /dev/null 2>&1
1639 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1640 _notrun "this test requires a valid \$TEST_DEV"
1642 if [ ! -d "$TEST_DIR" ]; then
1643 _notrun "this test requires a valid \$TEST_DIR"
1647 if [ -z "$TEST_DEV" ]; then
1648 _notrun "this test requires a valid \$TEST_DEV"
1650 if [ ! -d "$TEST_DIR" ]; then
1651 _notrun "this test requires a valid \$TEST_DIR"
1655 echo $TEST_DEV | grep -q ":/" > /dev/null 2>&1
1656 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1657 _notrun "this test requires a valid \$TEST_DEV"
1659 if [ ! -d "$TEST_DIR" ]; then
1660 _notrun "this test requires a valid \$TEST_DIR"
1664 echo $TEST_DEV | grep -q "//" > /dev/null 2>&1
1665 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1666 _notrun "this test requires a valid \$TEST_DEV"
1668 if [ ! -d "$TEST_DIR" ]; then
1669 _notrun "this test requires a valid \$TEST_DIR"
1673 echo $TEST_DEV | grep -q "://" > /dev/null 2>&1
1674 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1675 _notrun "this test requires a valid \$TEST_DIR"
1677 if [ ! -d "$TEST_DIR" ]; then
1678 _notrun "this test requires a valid \$TEST_DIR"
1682 if [ -z "$OVL_BASE_TEST_DIR" -o ! -d "$OVL_BASE_TEST_DIR" ]; then
1683 _notrun "this test requires a valid \$TEST_DIR as ovl base dir"
1685 if [ ! -d "$TEST_DIR" ]; then
1686 _notrun "this test requires a valid \$TEST_DIR"
1690 if [ -z "$TEST_DEV" -o ! -d "$TEST_DIR" ];
1692 _notrun "this test requires a valid \$TEST_DIR and unique $TEST_DEV"
1696 # ubifs needs an UBI volume. This will be a char device, not a block device.
1697 if [ ! -c "$TEST_DEV" ]; then
1698 _notrun "this test requires a valid UBI volume for \$TEST_DEV"
1700 if [ ! -d "$TEST_DIR" ]; then
1701 _notrun "this test requires a valid \$TEST_DIR"
1705 if [ -z "$TEST_DEV" ] || [ "`_is_block_dev "$TEST_DEV"`" = "" ]
1707 _notrun "this test requires a valid \$TEST_DEV"
1709 if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1711 _notrun "this test requires a valid \$TEST_DEV"
1713 if [ ! -d "$TEST_DIR" ]
1715 _notrun "this test requires a valid \$TEST_DIR"
1720 _check_mounted_on TEST_DEV $TEST_DEV TEST_DIR $TEST_DIR
1722 [ $err -le 1 ] || exit 1
1727 echo "!!! failed to mount $TEST_DEV on $TEST_DIR"
1731 touch ${RESULT_DIR}/require_test
1737 [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && ret=1
1738 [ "$USE_EXTERNAL" != yes ] && ret=1
1743 # this test needs a logdev
1747 [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && \
1748 _notrun "This test requires a valid \$SCRATCH_LOGDEV"
1749 [ "$USE_EXTERNAL" != yes ] && \
1750 _notrun "This test requires USE_EXTERNAL to be enabled"
1752 # ensure its not mounted
1753 $UMOUNT_PROG $SCRATCH_LOGDEV 2>/dev/null
1756 # this test requires loopback device support
1760 modprobe loop >/dev/null 2>&1
1761 if grep loop /proc/devices >/dev/null 2>&1
1765 _notrun "This test requires loopback device support"
1769 # this test requires ext2 filesystem support
1773 modprobe ext2 >/dev/null 2>&1
1774 if grep ext2 /proc/filesystems >/dev/null 2>&1
1778 _notrun "This test requires ext2 filesystem support"
1782 # this test requires tmpfs filesystem support
1786 modprobe tmpfs >/dev/null 2>&1
1787 grep -q tmpfs /proc/filesystems ||
1788 _notrun "this test requires tmpfs support"
1791 # this test requires that (large) loopback device files are not in use
1793 _require_no_large_scratch_dev()
1795 [ "$LARGE_SCRATCH_DEV" = yes ] && \
1796 _notrun "Large filesystem testing in progress, skipped this test"
1799 # this test requires that a realtime subvolume is in use, and
1800 # that the kernel supports realtime as well.
1804 [ "$USE_EXTERNAL" = yes ] || \
1805 _notrun "External volumes not in use, skipped this test"
1806 [ "$SCRATCH_RTDEV" = "" ] && \
1807 _notrun "Realtime device required, skipped this test"
1810 # This test requires that a realtime subvolume is not in use
1812 _require_no_realtime()
1814 [ "$USE_EXTERNAL" = "yes" ] && [ -n "$SCRATCH_RTDEV" ] && \
1815 _notrun "Test not compatible with realtime subvolumes, skipped this test"
1818 # this test requires that a specified command (executable) exists
1819 # $1 - command, $2 - name for error message
1821 # Note: the command string might have parameters, so strip them before checking
1822 # whether it is executable.
1825 if [ $# -eq 2 ]; then
1827 elif [ $# -eq 1 ]; then
1830 _fail "usage: _require_command <command> [<name>]"
1833 local command=`echo "$1" | awk '{ print $1 }'`
1834 if [ ! -x "$command" ]; then
1835 _notrun "$name utility required, skipped this test"
1839 # this test requires the device to be valid block device
1841 _require_block_device()
1843 if [ -z "$1" ]; then
1844 echo "Usage: _require_block_device <dev>" 1>&2
1847 if [ "`_is_block_dev "$1"`" == "" ]; then
1848 _notrun "require $1 to be valid block disk"
1852 # this test requires a path to refere to a local block or character device
1854 _require_local_device()
1856 if [ -z "$1" ]; then
1857 echo "Usage: _require_local_device <dev>" 1>&2
1860 if [ "`_is_block_dev "$1"`" != "" ]; then
1863 if [ "`_is_char_dev "$1"`" != "" ]; then
1866 _notrun "require $1 to be local device"
1869 # brd based ram disks erase the device when they receive a flush command when no
1870 # active references are present. This causes problems for DM devices sitting on
1871 # top of brd devices as DM doesn't hold active references to the brd device.
1872 _require_sane_bdev_flush()
1874 echo $1 | grep -q "^/dev/ram[0-9]\+$"
1875 if [ $? -eq 0 ]; then
1876 _notrun "This test requires a sane block device flush"
1880 # this test requires a specific device mapper target
1881 _require_dm_target()
1885 # require SCRATCH_DEV to be a valid block device with sane BLKFLSBUF
1887 _require_block_device $SCRATCH_DEV
1888 _require_sane_bdev_flush $SCRATCH_DEV
1889 _require_command "$DMSETUP_PROG" dmsetup
1891 _normalize_mount_options | egrep -q "dax(=always| |$)" || \
1892 test -e "/sys/block/$(_short_dev $SCRATCH_DEV)/dax"
1893 if [ $? -eq 0 ]; then
1895 stripe|linear|log-writes)
1898 _notrun "Cannot run tests with DAX on $target devices."
1903 modprobe dm-$target >/dev/null 2>&1
1905 $DMSETUP_PROG targets 2>&1 | grep -q ^$target
1906 if [ $? -ne 0 ]; then
1907 _notrun "This test requires dm $target support"
1911 # this test requires the ext4 kernel support crc feature on scratch device
1913 _require_scratch_ext4_crc()
1915 _scratch_mkfs_ext4 >/dev/null 2>&1
1916 dumpe2fs -h $SCRATCH_DEV 2> /dev/null | grep -q metadata_csum || _notrun "metadata_csum not supported by this filesystem"
1917 _try_scratch_mount >/dev/null 2>&1 \
1918 || _notrun "Kernel doesn't support metadata_csum feature"
1922 # Check whether the specified feature whether it is supported by
1923 # mkfs.ext4 and the kernel.
1924 _require_scratch_ext4_feature()
1926 if [ -z "$1" ]; then
1927 echo "Usage: _require_scratch_ext4_feature feature"
1930 $MKFS_EXT4_PROG -F $MKFS_OPTIONS -O "$1" \
1931 $SCRATCH_DEV 512m >/dev/null 2>&1 \
1932 || _notrun "mkfs.ext4 doesn't support $1 feature"
1933 _try_scratch_mount >/dev/null 2>&1 \
1934 || _notrun "Kernel doesn't support the ext4 feature(s): $1"
1938 # this test requires that external log/realtime devices are not in use
1940 _require_nonexternal()
1942 [ "$USE_EXTERNAL" = yes ] && \
1943 _notrun "External device testing in progress, skipped this test"
1946 # this test requires that the kernel supports asynchronous I/O
1949 $here/src/feature -A
1954 _notrun "kernel does not support asynchronous I/O"
1957 _fail "unexpected error testing for asynchronous I/O support"
1962 # this test requires that a (specified) aio-dio executable exists
1963 # and that the kernel supports asynchronous I/O.
1964 # $1 - command (optional)
1970 AIO_TEST=$here/src/aio-dio-regress/aiodio_sparse2
1971 [ -x $AIO_TEST ] || _notrun "aio-dio utilities required"
1973 AIO_TEST=$here/src/aio-dio-regress/$1
1974 [ -x $AIO_TEST ] || _notrun "$AIO_TEST not built"
1980 # this test requires that the kernel supports IO_URING
1983 $here/src/feature -R
1988 _notrun "kernel does not support IO_URING"
1991 _fail "unexpected error testing for IO_URING support"
1996 # this test requires that a test program exists under src/
1997 # $1 - command (require)
1999 _require_test_program()
2001 local prog=$here/src/$1
2002 [ -x $prog ] || _notrun "$prog not built"
2005 # run an aio-dio program
2011 echo "usage: _run_aiodio command_name" 2>&1
2017 local testtemp=$TEST_DIR/aio-testfile
2019 $AIO_TEST $testtemp 2>&1
2026 _require_timestamp_range()
2028 local device=${1:-$TEST_DEV}
2031 read tsmin tsmax <<<$(_filesystem_timestamp_range $device)
2032 if [ $tsmin -eq -1 -a $tsmax -eq -1 ]; then
2033 _notrun "filesystem $FSTYP timestamp bounds are unknown"
2036 # expect console warning from rw scratch mount if fs limit is near
2037 if [ $tsmax -le $((1<<31)) ] && \
2038 ! _check_dmesg_for "filesystem being mounted at .* supports timestamps until"
2040 _notrun "Kernel does not support timestamp limits"
2044 _filesystem_timestamp_range()
2046 local device=${1:-$TEST_DEV}
2047 local fstyp=${2:-$FSTYP}
2048 u32max=$(((1<<32)-1))
2050 s32max=$(((1<<31)-1))
2051 s64max=$(((1<<63)-1))
2056 echo "$s32min $s32max"
2059 if [ $(dumpe2fs -h $device 2>/dev/null | grep "Inode size:" | cut -d: -f2) -gt 128 ]; then
2060 printf "%d %d\n" $s32min 0x37fffffff
2062 echo "$s32min $s32max"
2070 echo "$s32min $s32max"
2073 echo "$s64min $s64max"
2076 if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
2077 _filesystem_timestamp_range $OVL_BASE_TEST_DEV $OVL_BASE_FSTYP
2088 # indicate whether YP/NIS is active or not
2093 dn=$(domainname 2>/dev/null)
2094 local ypcat=$(type -P ypcat)
2095 local rpcinfo=$(type -P rpcinfo)
2096 test -n "${dn}" -a "${dn}" != "(none)" -a "${dn}" != "localdomain" -a -n "${ypcat}" -a -n "${rpcinfo}" && \
2097 "${rpcinfo}" -p localhost 2>/dev/null | grep -q ypbind
2101 # cat the password file
2105 [ $(_yp_active) -eq 0 ] && ypcat passwd
2109 # cat the group file
2113 [ $(_yp_active) -eq 0 ] && ypcat group
2117 # check for a user on the machine, fsgqa as default
2125 _cat_passwd | grep -q $qa_user
2126 [ "$?" == "0" ] || _notrun "$qa_user user not defined."
2127 echo /bin/true | su $qa_user
2128 [ "$?" == "0" ] || _notrun "$qa_user cannot execute commands."
2131 # check for a group on the machine, fsgqa as default
2139 _cat_group | grep -q $qa_group
2140 [ "$?" == "0" ] || _notrun "$qa_group group not defined."
2146 s,.*Permission\sdenied.*,Permission denied,;
2147 s,.*no\saccess\sto\stty.*,,;
2148 s,.*no\sjob\scontrol\sin\sthis\sshell.*,,;
2155 echo $1 | su -s /bin/bash $qa_user 2>&1 | _filter_user_do
2158 _require_xfs_io_command()
2162 echo "Usage: _require_xfs_io_command command [switch]" 1>&2
2168 local param_checked=""
2172 local testfile=$TEST_DIR/$$.xfs_io
2176 # Test xfs_io lsattr support and filesystem FS_IOC_FSSETXATTR
2178 testio=`$XFS_IO_PROG -F -f -c "lsattr $param" $testfile 2>&1`
2179 param_checked="$param"
2182 local testdir=$TEST_DIR/$$.attr_dir
2183 mkdir $TEST_DIR/$$.attr_dir
2184 if [ -z "$param" ]; then
2187 # Test xfs_io chattr support AND
2188 # filesystem FS_IOC_FSSETXATTR support
2189 # 'tPnE' flags are only valid for a directory so check them on a directory.
2190 if echo "$param" | egrep -q 't|P|n|E'; then
2191 testio=`$XFS_IO_PROG -F -c "chattr +$param" $testdir 2>&1`
2192 attr_info=`$XFS_IO_PROG -F -r -c "lsattr" $testdir | awk '{print $1}'`
2193 $XFS_IO_PROG -F -r -c "chattr -$param" $testdir 2>&1
2195 testio=`$XFS_IO_PROG -F -f -c "chattr +$param" $testfile 2>&1`
2196 attr_info=`$XFS_IO_PROG -F -r -c "lsattr" $testfile | awk '{print $1}'`
2197 $XFS_IO_PROG -F -r -c "chattr -$param" $testfile 2>&1
2199 param_checked="+$param"
2200 rm -rf $testdir 2>&1 > /dev/null
2203 testio=`$XFS_IO_PROG -F -f -c "chproj 0" $testfile 2>&1`
2206 local testcopy=$TEST_DIR/$$.copy.xfs_io
2207 local copy_opts=$testfile
2208 if [ "$param" == "-f" ]; then
2209 # source file is the open destination file
2211 copy_opts="0 -d 4k -l 4k"
2213 $XFS_IO_PROG -F -f -c "pwrite 0 4k" $testfile > /dev/null 2>&1
2214 testio=`$XFS_IO_PROG -F -f -c "copy_range $param $copy_opts" $testcopy 2>&1`
2215 rm -f $testcopy > /dev/null 2>&1
2216 param_checked="$param"
2219 testio=`$XFS_IO_PROG -F -f -c "falloc $param 0 1m" $testfile 2>&1`
2220 param_checked="$param"
2222 "fpunch" | "fcollapse" | "zero" | "fzero" | "finsert" | "funshare")
2223 local blocksize=$(_get_block_size $TEST_DIR)
2224 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 $((5 * $blocksize))" \
2225 -c "fsync" -c "$command $blocksize $((2 * $blocksize))" \
2229 # If 'ranged' is passed as argument then we check to see if fiemap supports
2230 # ranged query params
2231 if echo "$param" | grep -q "ranged"; then
2232 param=$(echo "$param" | sed "s/ranged//")
2233 $XFS_IO_PROG -c "help fiemap" | grep -q "\[offset \[len\]\]"
2234 [ $? -eq 0 ] || _notrun "xfs_io $command ranged support is missing"
2236 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
2237 -c "fiemap -v $param" $testfile 2>&1`
2238 param_checked="$param"
2241 local testlink=$TEST_DIR/$$.link.xfs_io
2242 testio=`$XFS_IO_PROG -F -f -c "flink $testlink" $testfile 2>&1`
2243 rm -f $testlink > /dev/null 2>&1
2246 # Check O_TMPFILE support in xfs_io, kernel and fs
2247 testio=`$XFS_IO_PROG -T -c quit $TEST_DIR 2>&1`
2248 echo $testio | egrep -q "invalid option|Is a directory" && \
2249 _notrun "xfs_io $command support is missing"
2250 echo $testio | grep -q "Operation not supported" && \
2251 _notrun "O_TMPFILE is not supported"
2254 testio=`$XFS_IO_PROG -f -c "fsmap" $testfile 2>&1`
2255 echo $testio | grep -q "Inappropriate ioctl" && \
2256 _notrun "xfs_io $command support is missing"
2259 testio=`$XFS_IO_PROG -c "label" $TEST_DIR 2>&1`
2262 # -c "open $f" is broken in xfs_io <= 4.8. Along with the fix,
2263 # a new -C flag was introduced to execute one shot commands.
2264 # Check for -C flag support as an indication for the bug fix.
2265 testio=`$XFS_IO_PROG -F -f -C "open $testfile" $testfile 2>&1`
2266 echo $testio | grep -q "invalid option" && \
2267 _notrun "xfs_io $command support is missing"
2270 # -N (RWF_NOWAIT) only works with direct vectored I/O writes
2271 local pwrite_opts=" "
2272 if [ "$param" == "-N" ]; then
2274 pwrite_opts+="-V 1 -b 4k"
2276 testio=`$XFS_IO_PROG -f $opts -c \
2277 "pwrite $pwrite_opts $param 0 4k" $testfile 2>&1`
2278 param_checked="$pwrite_opts $param"
2281 testio=`$XFS_IO_PROG -x -c "$command probe" $TEST_DIR 2>&1`
2282 echo $testio | grep -q "Inappropriate ioctl" && \
2283 _notrun "xfs_io $command support is missing"
2286 testio=`$XFS_IO_PROG -f -c "utimes 0 0 0 0" $testfile 2>&1`
2290 testio=`$XFS_IO_PROG -c "syncfs" $testfile 2>&1`
2293 testio=`$XFS_IO_PROG -c "help $command" 2>&1`
2296 rm -f $testfile 2>&1 > /dev/null
2297 echo $testio | grep -q "not found" && \
2298 _notrun "xfs_io $command $param_checked support is missing"
2299 echo $testio | grep -q "Operation not supported\|Inappropriate ioctl" && \
2300 _notrun "xfs_io $command $param_checked failed (old kernel/wrong fs?)"
2301 echo $testio | grep -q "Invalid" && \
2302 _notrun "xfs_io $command $param_checked failed (old kernel/wrong fs/bad args?)"
2303 echo $testio | grep -q "foreign file active" && \
2304 _notrun "xfs_io $command $param_checked not supported on $FSTYP"
2305 echo $testio | grep -q "Function not implemented" && \
2306 _notrun "xfs_io $command $param_checked support is missing (missing syscall?)"
2307 echo $testio | grep -q "unknown flag" && \
2308 _notrun "xfs_io $command $param_checked support is missing (unknown flag)"
2310 [ -n "$param" ] || return
2312 if [ -z "$param_checked" ]; then
2313 $XFS_IO_PROG -c "help $command" | grep -E -q "^ $param ([a-zA-Z_]+ )?--" || \
2314 _notrun "xfs_io $command doesn't support $param"
2316 # xfs_io could result in "command %c not supported" if it was
2317 # built on kernels not supporting pwritev2() calls
2318 echo $testio | grep -q "\(invalid option\|not supported\)" && \
2319 _notrun "xfs_io $command doesn't support $param"
2322 # On XFS, ioctl(FSSETXATTR)(called by xfs_io -c "chattr") maskes off unsupported
2323 # or invalid flags silently so need to check these flags by extra ioctl(FSGETXATTR)
2324 # (called by xfs_io -c "lsattr").
2325 # The following URL explains why we don't change the behavior of XFS.
2326 # https://www.spinics.net/lists/linux-xfs/msg44725.html
2327 if [ -n "$attr_info" -a "$FSTYP" = "xfs" ]; then
2329 for i in $(seq 0 $((num-1))); do
2330 echo $attr_info | grep -q "${param:$i:1}" || \
2331 _notrun "xfs_io $command +${param:$i:1} support is missing (unknown flag in kernel)"
2336 # check that kernel and filesystem support direct I/O
2339 if [ $FSTYP = "ext4" ] || [ $FSTYP = "f2fs" ] ; then
2340 if echo "$MOUNT_OPTIONS" | grep -q "test_dummy_encryption"; then
2341 _notrun "$FSTYP encryption doesn't support O_DIRECT"
2344 if [ $FSTYP = "ext4" ] ; then
2345 if echo "$MOUNT_OPTIONS" | grep -q "data=journal"; then
2346 _notrun "ext4 data journaling doesn't support O_DIRECT"
2349 local testfile=$TEST_DIR/$$.direct
2350 $XFS_IO_PROG -F -f -d -c "pwrite 0 20k" $testfile > /dev/null 2>&1
2351 if [ $? -ne 0 ]; then
2352 _notrun "O_DIRECT is not supported"
2354 rm -f $testfile 2>&1 > /dev/null
2357 _format_swapfile() {
2364 # Swap files must be nocow on Btrfs.
2365 $CHATTR_PROG +C "$fname" > /dev/null 2>&1
2366 _pwrite_byte 0x61 0 "$sz" "$fname" >> $seqres.full
2367 $MKSWAP_PROG "$fname" >> $seqres.full
2370 # Check that the filesystem supports swapfiles
2371 _require_scratch_swapfile()
2374 _require_command "$MKSWAP_PROG" "mkswap"
2376 _scratch_mkfs >/dev/null 2>&1
2378 # With mounting SELinux context(e.g. system_u:object_r:root_t:s0),
2379 # standard mkswap tried to reset the type of default context to
2380 # swapfile_t if it's not swapfile_t, and then it failed and returned
2381 # ENOTSUP expectedly as we don't want to create any SELinux attr on
2382 # purpose. standard mkswap ignored this relabel error by commit
2383 # d97dc0e of util-linux, but it still reported the error before
2384 # commit d97dc0e. We mount swapfile context directly to skip the
2386 [ -n "$SELINUX_MOUNT_OPTIONS" ] && export \
2387 SELINUX_MOUNT_OPTIONS="-o context=system_u:object_r:swapfile_t:s0"
2391 # Minimum size for mkswap is 10 pages
2392 _format_swapfile "$SCRATCH_MNT/swap" $(($(get_page_size) * 10))
2394 # ext* and xfs have supported all variants of swap files since their
2395 # introduction, so swapon should not fail.
2398 if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
2400 _fail "swapon failed for $FSTYP"
2404 if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
2406 _notrun "swapfiles are not supported"
2411 swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
2415 # Check that a fs has enough free space (in 1024b blocks)
2420 local blocks=$2 # in units of 1024
2421 local gb=$(( blocks / 1024 / 1024 ))
2423 local free_blocks=`df -kP $mnt | grep -v Filesystem | awk '{print $4}'`
2424 [ $free_blocks -lt $blocks ] && \
2425 _notrun "This test requires at least ${gb}GB free on $mnt to run"
2429 # Check if the filesystem supports sparse files.
2431 # Unfortunately there is no better way to do this than a manual black list.
2433 _require_sparse_files()
2437 _notrun "Sparse files not supported by this filesystem type: $FSTYP"
2446 #boot_params always present in debugfs
2447 [ -d "$DEBUGFS_MNT/boot_params" ] || _notrun "Debugfs not mounted"
2450 _require_fail_make_request()
2452 [ -f "$DEBUGFS_MNT/fail_make_request/probability" ] \
2453 || _notrun "$DEBUGFS_MNT/fail_make_request \
2454 not found. Seems that CONFIG_FAULT_INJECTION_DEBUG_FS kernel config option not enabled"
2457 # Disable extent zeroing for ext4 on the given device
2458 _ext4_disable_extent_zeroout()
2460 local dev=${1:-$TEST_DEV}
2461 local sdev=`_short_dev $dev`
2463 [ -f /sys/fs/ext4/$sdev/extent_max_zeroout_kb ] && \
2464 echo 0 >/sys/fs/ext4/$sdev/extent_max_zeroout_kb
2467 # The default behavior of SEEK_HOLE is to always return EOF.
2468 # Filesystems that implement non-default behavior return the offset
2469 # of holes with SEEK_HOLE. There is no way to query the filesystem
2470 # of which behavior it is implementing.
2471 # We use this whitelist FSTYP, to set expectation and avoid silent
2472 # regression of filesystem seek hole behavior.
2475 _fstyp_has_non_default_seek_data_hole()
2484 btrfs|ext4|xfs|cifs|f2fs|gfs2|ocfs2|tmpfs)
2488 # NFSv2 and NFSv3 only support default behavior of SEEK_HOLE,
2489 # while NFSv4 supports non-default behavior
2490 local nfsvers=`_df_device $TEST_DEV | $AWK_PROG '{ print $2 }'`
2491 [ "$nfsvers" = "nfs4" ]
2495 if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
2496 _fstyp_has_non_default_seek_data_hole $OVL_BASE_FSTYP
2499 # Assume that base fs has default behavior
2504 # by default fstyp has default SEEK_HOLE behavior;
2505 # if your fs has non-default behavior, add it to whitelist above!
2511 # Run seek sanity test with predefined expectation for SEEK_DATA/HOLE behavior
2512 _run_seek_sanity_test()
2515 if _fstyp_has_non_default_seek_data_hole; then
2518 $here/src/seek_sanity_test $testseekargs $*
2521 # Check if the file system supports seek_data/hole
2522 _require_seek_data_hole()
2524 local dev=${1:-$TEST_DEV}
2525 local testfile=$TEST_DIR/$$.seek
2526 local testseek=`$here/src/seek_sanity_test -t $testfile 2>&1`
2528 rm -f $testfile &>/dev/null
2529 echo $testseek | grep -q "Kernel does not support" && \
2530 _notrun "File system does not support llseek(2) SEEK_DATA/HOLE"
2531 # Disable extent zeroing for ext4 as that change where holes are
2533 if [ "$FSTYP" = "ext4" ]; then
2534 _ext4_disable_extent_zeroout $dev
2540 _require_test_program "runas"
2545 "$here/src/runas" "$@"
2548 _require_richacl_prog()
2550 _require_command "$GETRICHACL_PROG" getrichacl
2551 _require_command "$SETRICHACL_PROG" setrichacl
2554 _require_scratch_richacl_xfs()
2556 _scratch_mkfs_xfs_supported -m richacl=1 >/dev/null 2>&1 \
2557 || _notrun "mkfs.xfs doesn't have richacl feature"
2558 _scratch_mkfs_xfs -m richacl=1 >/dev/null 2>&1
2559 _try_scratch_mount >/dev/null 2>&1 \
2560 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2564 _require_scratch_richacl_ext4()
2566 _scratch_mkfs -O richacl >/dev/null 2>&1 \
2567 || _notrun "can't mkfs $FSTYP with option -O richacl"
2568 _try_scratch_mount >/dev/null 2>&1 \
2569 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2573 _require_scratch_richacl_support()
2576 $GETFATTR_PROG -n system.richacl >/dev/null 2>&1 \
2577 || _notrun "this test requires richacl support on \$SCRATCH_DEV"
2581 _require_scratch_richacl()
2584 xfs) _require_scratch_richacl_xfs
2586 ext4) _require_scratch_richacl_ext4
2589 _require_scratch_richacl_support
2591 *) _notrun "this test requires richacl support on \$SCRATCH_DEV"
2596 _scratch_mkfs_richacl()
2599 xfs) _scratch_mkfs_xfs -m richacl=1
2601 ext4) _scratch_mkfs -O richacl
2609 # check if the given device is mounted, if so, return mount point
2613 local fstype=${2:-$FSTYP}
2615 if [ $# -lt 1 ]; then
2616 echo "Usage: _is_dev_mounted <device> [fstype]" 1>&2
2620 findmnt -rncv -S $dev -t $fstype -o TARGET | head -1
2623 # check if the given dir is a mount point, if so, return mount point
2624 _is_dir_mountpoint()
2627 local fstype=${2:-$FSTYP}
2629 if [ $# -lt 1 ]; then
2630 echo "Uasge: _is_dir_mountpoint <dir> [fstype]" 1>&2
2634 findmnt -rncv -t $fstype -o TARGET $dir | head -1
2637 # remount a FS to a new mode (ro or rw)
2643 echo "Usage: _remount device ro/rw" 1>&2
2649 if ! mount -o remount,$mode $device
2651 echo "_remount: failed to remount filesystem on $device as $mode"
2656 # Run the appropriate repair/check on a filesystem
2658 # if the filesystem is mounted, it's either remounted ro before being
2659 # checked or it's unmounted and then remounted
2662 # If set, we remount ro instead of unmounting for fsck
2665 _umount_or_remount_ro()
2669 echo "Usage: _umount_or_remount_ro <device>" 1>&2
2674 local mountpoint=`_is_dev_mounted $device`
2676 if [ $USE_REMOUNT -eq 0 ]; then
2677 $UMOUNT_PROG $device
2684 _mount_or_remount_rw()
2686 if [ $# -ne 3 ]; then
2687 echo "Usage: _mount_or_remount_rw <opts> <dev> <mnt>" 1>&2
2694 if [ $USE_REMOUNT -eq 0 ]; then
2695 if [ "$FSTYP" != "overlay" ]; then
2696 _mount -t $FSTYP $mount_opts $device $mountpoint
2698 _overlay_mount $device $mountpoint
2700 if [ $? -ne 0 ]; then
2701 _dump_err "!!! failed to remount $device on $mountpoint"
2711 # Check a generic filesystem in no-op mode; this assumes that the
2712 # underlying fsck program accepts "-n" for a no-op (check-only) run,
2713 # and that it will still return an errno for corruption in this mode.
2715 # Filesystems which don't support this will need to define their
2716 # own check routine.
2718 _check_generic_filesystem()
2722 # If type is set, we're mounted
2723 local type=`_fs_type $device`
2726 if [ "$type" = "$FSTYP" ]
2729 local mountpoint=`_umount_or_remount_ro $device`
2732 fsck -t $FSTYP $FSCK_OPTIONS $device >$tmp.fsck 2>&1
2735 _log_err "_check_generic_filesystem: filesystem on $device is inconsistent"
2736 echo "*** fsck.$FSTYP output ***" >>$seqres.full
2737 cat $tmp.fsck >>$seqres.full
2738 echo "*** end fsck.$FSTYP output" >>$seqres.full
2744 if [ $ok -eq 0 ] && [ -n "$DUMP_CORRUPT_FS" ]; then
2747 local flatdev="$(basename "$device")"
2748 _ext4_metadump "$seqres.$flatdev.check.qcow2" "$device" compress
2755 echo "*** mount output ***" >>$seqres.full
2756 _mount >>$seqres.full
2757 echo "*** end mount output" >>$seqres.full
2758 elif [ "$type" = "$FSTYP" ]
2761 _mount_or_remount_rw "$MOUNT_OPTIONS" $device $mountpoint
2765 if [ $ok -eq 0 ]; then
2767 if [ "$iam" != "check" ]; then
2776 # Filter the knowen errors the UDF Verifier reports.
2777 _udf_test_known_error_filter()
2779 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."
2783 _check_udf_filesystem()
2785 [ "$DISABLE_UDF_TEST" == "1" ] && return
2787 if [ $# -ne 1 -a $# -ne 2 ]
2789 echo "Usage: _check_udf_filesystem device [last_block]" 1>&2
2793 if [ ! -x $here/src/udf_test ]
2795 echo "udf_test not installed, please download and build the Philips"
2796 echo "UDF Verification Software from http://www.extra.research.philips.com/udf/."
2797 echo "Then copy the udf_test binary to $here/src/."
2798 echo "If you do not wish to run udf_test then set environment variable DISABLE_UDF_TEST"
2805 if [ $# -eq 2 ]; then
2806 opt_arg="-lastvalidblock $(( $2 - 1 ))"
2809 rm -f $seqres.checkfs
2810 sleep 1 # Due to a problem with time stamps in udf_test
2811 $here/src/udf_test $opt_arg $device | tee $seqres.checkfs | egrep "Error|Warning" | \
2812 _udf_test_known_error_filter | \
2813 egrep -iv "Error count:.*[0-9]+.*total occurrences:.*[0-9]+|Warning count:.*[0-9]+.*total occurrences:.*[0-9]+" && \
2814 echo "Warning UDF Verifier reported errors see $seqres.checkfs." && return 1
2825 # no way to check consistency for nfs
2828 # no way to check consistency for cifs
2831 # no way to check consistency for 9p
2834 # no way to check consistency for virtiofs
2837 # no way to check consistency for CephFS
2840 # no way to check consistency for GlusterFS
2843 _check_overlay_test_fs
2848 # do nothing for now
2851 _check_btrfs_filesystem $TEST_DEV
2854 # no way to check consistency for tmpfs
2857 # there is no fsck program for ubifs yet
2860 _check_generic_filesystem $TEST_DEV
2867 local device=$SCRATCH_DEV
2868 [ $# -eq 1 ] && device=$1
2872 local scratch_log="none"
2873 local scratch_rt="none"
2874 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
2875 scratch_log="$SCRATCH_LOGDEV"
2877 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
2878 scratch_rt="$SCRATCH_RTDEV"
2880 _check_xfs_filesystem $device $scratch_log $scratch_rt
2883 _check_udf_filesystem $device $udf_fsize
2886 # Don't know how to check an NFS filesystem, yet.
2889 # Don't know how to check a CIFS filesystem, yet.
2892 # no way to check consistency for 9p
2895 # no way to check consistency for virtiofs
2898 # no way to check consistency for CephFS
2901 # no way to check consistency for GlusterFS
2904 _check_overlay_scratch_fs
2909 _check_btrfs_filesystem $device
2912 # no way to check consistency for tmpfs
2915 # there is no fsck program for ubifs yet
2918 _check_generic_filesystem $device
2923 _full_fstyp_details()
2925 [ -z "$FSTYP" ] && FSTYP=xfs
2926 if [ $FSTYP = xfs ]; then
2927 if [ -d /proc/fs/xfs ]; then
2928 if grep -q 'debug 0' /proc/fs/xfs/stat; then
2929 FSTYP="$FSTYP (non-debug)"
2930 elif grep -q 'debug 1' /proc/fs/xfs/stat; then
2931 FSTYP="$FSTYP (debug)"
2934 if uname -a | grep -qi 'debug'; then
2935 FSTYP="$FSTYP (debug)"
2937 FSTYP="$FSTYP (non-debug)"
2944 _full_platform_details()
2947 local host=`hostname -s`
2948 local kernel=`uname -rv`
2949 local platform=`uname -m`
2950 echo "$os/$platform $host $kernel"
2955 if [ "`uname`" == "Linux" ]; then
2958 echo Unknown operating system: `uname`
2963 _link_out_file_named()
2966 local suffix=$(FEATURES="$features" perl -e '
2968 my $feature, $result, $suffix, $opts;
2970 foreach $feature (split(/,/, $ENV{"FEATURES"})) {
2971 $feathash{$feature} = 1;
2973 $result = "default";
2978 ($opts, $suffix) = split(/ *: */);
2979 foreach my $opt (split(/,/, $opts)) {
2980 if (!exists($feathash{$opt})) {
2993 ln -fs $(basename $1).$suffix $1
3000 if [ $# -eq 0 ]; then
3001 features="$(_get_os_name),$FSTYP"
3002 if [ -n "$MOUNT_OPTIONS" ]; then
3003 features=$features,${MOUNT_OPTIONS##"-o "}
3009 _link_out_file_named $seqfull.out "$features"
3018 # convert urandom incompressible data to compressible text data
3021 od /dev/urandom | dd iflag=fullblock ${*}
3024 #takes files, randomdata
3032 if [ $size -gt 0 ]; then
3033 if [ "$2" == "false" ]; then
3034 dd if=/dev/zero of=$file bs=1024 count=$size 2>&1 | _filter_dd
3035 elif [ "$2" == "comp" ]; then
3036 _ddt of=$file bs=1024 count=$size 2>&1 | _filter_dd
3038 dd if=/dev/urandom of=$file bs=1024 count=$size 2>&1 | _filter_dd
3045 # takes dirname, depth, randomdata
3048 local dirname=$1 depth=$2 randomdata=$3
3049 mkdir $dirname || die "mkdir $dirname failed"
3052 _nfiles $files $randomdata # files for this dir and data type
3054 [ $depth -eq 0 ] && return
3055 local deep=$(( depth - 1 )) # go 1 down
3057 [ $verbose = true ] && echo "descending, depth from leaves = $deep"
3060 while [ $d -lt $dirs ]
3062 _descend d$d $deep &
3068 # Populate a filesystem with inodes for performance experiments
3070 # usage: populate [-v] [-n ndirs] [-f nfiles] [-d depth] [-r root] [-s size] [-x]
3075 local dirs=5 # ndirs in each subdir till leaves
3076 local size=0 # sizeof files in K
3077 local files=100 # num files in _each_ subdir
3078 local depth=2 # depth of tree from root to leaves
3080 local root=root # path of initial root of directory tree
3081 local randomdata=false # -x data type urandom, zero or compressible
3085 while getopts "d:f:n:r:s:v:x:c" c
3094 x) randomdata=true;;
3095 c) randomdata=comp;;
3099 _descend $root $depth $randomdata
3104 [ $verbose = true ] && echo done
3107 # query whether the given file has the given inode flag set
3114 if $XFS_IO_PROG -r -c 'lsattr -v' "$file" | grep -q "$flag" ; then
3120 # query the given files extsize allocator hint in bytes (if any)
3127 blocks=`$XFS_IO_PROG -r -c 'stat' "$file" | \
3128 awk '/^xattr.extsize =/ { print $3 }'`
3129 [ -z "$blocks" ] && blocks="0"
3133 # scratch_dev_pool should contain the disks pool for the btrfs raid
3134 _require_scratch_dev_pool()
3139 if [ -z "$SCRATCH_DEV_POOL" ]; then
3140 _notrun "this test requires a valid \$SCRATCH_DEV_POOL"
3143 if [ -z "$1" ]; then
3149 # btrfs test case needs ndevs or more scratch_dev_pool; other FS not sure
3153 if [ "`echo $SCRATCH_DEV_POOL|wc -w`" -lt $ndevs ]; then
3154 _notrun "btrfs and this test needs $ndevs or more disks in SCRATCH_DEV_POOL"
3158 _notrun "dev_pool is not supported by fstype \"$FSTYP\""
3162 for i in $SCRATCH_DEV_POOL; do
3163 if [ "`_is_block_dev "$i"`" = "" ]; then
3164 _notrun "this test requires valid block disk $i"
3166 if [ "`_is_block_dev "$i"`" = "`_is_block_dev "$TEST_DEV"`" ]; then
3167 _notrun "$i is part of TEST_DEV, this test requires unique disks"
3169 if _mount | grep -q $i; then
3170 if ! $UMOUNT_PROG $i; then
3171 echo "failed to unmount $i - aborting"
3175 # to help better debug when something fails, we remove
3176 # traces of previous btrfs FS on the dev.
3177 dd if=/dev/zero of=$i bs=4096 count=100 > /dev/null 2>&1
3181 # ensure devices in SCRATCH_DEV_POOL are of the same size
3182 # must be called after _require_scratch_dev_pool
3183 _require_scratch_dev_pool_equal_size()
3189 # SCRATCH_DEV has been set to the first device in SCRATCH_DEV_POOL
3190 size=`_get_device_size $SCRATCH_DEV`
3191 for dev in $SCRATCH_DEV_POOL; do
3192 newsize=`_get_device_size $dev`
3193 if [ $size -ne $newsize ]; then
3194 _notrun "This test requires devices in SCRATCH_DEV_POOL have the same size"
3200 # Check that fio is present, and it is able to execute given jobfile
3205 _require_command "$FIO_PROG" fio
3206 if [ -z "$1" ]; then
3210 $FIO_PROG --warnings-fatal --showcmd $job >> $seqres.full 2>&1
3211 [ $? -eq 0 ] || _notrun "$FIO_PROG too old, see $seqres.full"
3214 # Does freeze work on this fs?
3217 xfs_freeze -f "$TEST_DIR" >/dev/null 2>&1
3219 xfs_freeze -u "$TEST_DIR" >/dev/null 2>&1
3220 [ $result -eq 0 ] || _notrun "$FSTYP does not support freezing"
3223 # Does NFS export work on this fs?
3226 _require_test_program "open_by_handle"
3227 mkdir -p "$TEST_DIR"/exportfs_test
3228 $here/src/open_by_handle -c "$TEST_DIR"/exportfs_test 2>&1 \
3229 || _notrun "$FSTYP does not support NFS export"
3233 # Does shutdown work on this fs?
3234 _require_scratch_shutdown()
3236 [ -x $here/src/godown ] || _notrun "src/godown executable not found"
3238 _scratch_mkfs > /dev/null 2>&1 || _notrun "_scratch_mkfs failed on $SCRATCH_DEV"
3241 if [ $FSTYP = "overlay" ]; then
3242 if [ -z $OVL_BASE_SCRATCH_DEV ]; then
3243 # In lagacy overlay usage, it may specify directory as
3244 # SCRATCH_DEV, in this case OVL_BASE_SCRATCH_DEV
3245 # will be null, so check OVL_BASE_SCRATCH_DEV before
3246 # running shutdown to avoid shutting down base fs accidently.
3247 _notrun "This test requires a valid $OVL_BASE_SCRATCH_DEV as ovl base fs"
3249 $here/src/godown -f $OVL_BASE_SCRATCH_MNT 2>&1 \
3250 || _notrun "Underlying filesystem does not support shutdown"
3253 $here/src/godown -f $SCRATCH_MNT 2>&1 \
3254 || _notrun "$FSTYP does not support shutdown"
3265 local attributes=$($XFS_IO_PROG -c 'statx -r' $target | awk '/stat.attributes / { print $3 }')
3267 # The original attribute bit value, STATX_ATTR_DAX (0x2000), conflicted
3268 # with STATX_ATTR_MOUNT_ROOT. Therefore, STATX_ATTR_DAX was changed to
3271 # Because DAX tests do not run on root mounts, STATX_ATTR_MOUNT_ROOT
3272 # should always be 0. Check for the old flag and fail the test if that
3275 if [ $(( attributes & 0x2000 )) -ne 0 ]; then
3276 echo "$target has an unexpected STATX_ATTR_MOUNT_ROOT flag set"
3277 echo "which used to be STATX_ATTR_DAX"
3278 echo " This test should not be running on the root inode..."
3279 echo " Does the kernel have the following patch?"
3280 echo " 72d1249e2ffd uapi: fix statx attribute value overlap for DAX & MOUNT_ROOT"
3283 if [ $exp_s_dax -eq 0 ]; then
3284 (( attributes & 0x00200000 )) && echo "$target has unexpected S_DAX flag"
3286 (( attributes & 0x00200000 )) || echo "$target doesn't have expected S_DAX flag"
3295 if [ $exp_xflag -eq 0 ]; then
3296 _test_inode_flag dax $target && echo "$target has unexpected FS_XFLAG_DAX flag"
3298 _test_inode_flag dax $target || echo "$target doesn't have expected FS_XFLAG_DAX flag"
3302 # Check if dax mount options are supported
3304 # $1 can be either 'dax=always' or 'dax'
3307 # Check for the new dax options (dax=inode, dax=always or dax=never)
3308 # by passing "dax=always".
3310 # Check for the old dax or new dax=always by passing "dax".
3312 # This only accepts 'dax=always' because dax=always, dax=inode and
3313 # dax=never are always supported together. So if the other options are
3314 # required checking for 'dax=always' indicates support for the other 2.
3316 # Return 0 if filesystem/device supports the specified dax option.
3317 # Return 1 if mount fails with the specified dax option.
3318 # Return 2 if /proc/mounts shows wrong dax option.
3319 _check_scratch_dax_mountopt()
3324 _scratch_mkfs > /dev/null 2>&1
3326 _try_scratch_mount "-o $option" > /dev/null 2>&1 || return 1
3328 if _fs_options $SCRATCH_DEV | egrep -q "dax(=always|,|$)"; then
3337 # Throw notrun if _check_scratch_dax_mountopt() returns a non-zero value.
3338 _require_scratch_dax_mountopt()
3342 _check_scratch_dax_mountopt "$mountopt"
3345 [ $res -eq 1 ] && _notrun "mount $SCRATCH_DEV with $mountopt failed"
3346 [ $res -eq 2 ] && _notrun "$SCRATCH_DEV $FSTYP does not support -o $mountopt"
3349 _require_dax_iflag()
3351 _require_xfs_io_command "chattr" "x"
3354 # Does norecovery support by this fs?
3355 _require_norecovery()
3357 _try_scratch_mount -o ro,norecovery || \
3358 _notrun "$FSTYP does not support norecovery"
3362 # Does this filesystem support metadata journaling?
3363 # We exclude ones here that don't; otherwise we assume that it does, so the
3364 # test will run, fail, and motivate someone to update this test for a new
3367 # It's possible that TEST_DEV and SCRATCH_DEV have different features (it'd be
3368 # odd, but possible) so check $TEST_DEV by default, but we can optionall pass
3370 _has_metadata_journaling()
3379 ext2|vfat|msdos|udf|exfat)
3380 echo "$FSTYP does not support metadata journaling"
3384 # ext4 could be mkfs'd without a journal...
3386 $DUMPE2FS_PROG -h $dev 2>&1 | grep -q has_journal || {
3387 echo "$FSTYP on $dev not configured with metadata journaling"
3390 # ext4 might not load a journal
3391 if _normalize_mount_options | grep -qw "noload"; then
3392 echo "mount option \"noload\" not allowed in this test"
3397 # metadata journaling check is based on base filesystem configurations
3398 # and because -overlay option saves those configurations to OVL_BASE_*,
3399 # adding restore/override the configurations before/after the check.
3400 if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
3403 _overlay_config_restore
3404 _has_metadata_journaling
3406 _overlay_config_override
3409 echo "No metadata journaling support for legacy overlay setup"
3414 # by default we pass; if you need to, add your fs above!
3420 _require_metadata_journaling()
3422 local msg=$(_has_metadata_journaling $@)
3423 if [ -n "$msg" ]; then
3430 $XFS_IO_PROG -r -c "fiemap" $1 | tail -n +2 | grep -v hole | wc -l
3433 # Similar to _count_extents() but if any extent is shared multiples times in
3434 # the file (reflinked to different file offsets), it is accounted as 1 extent
3435 # instead of N extents.
3436 _count_exclusive_extents()
3438 $XFS_IO_PROG -r -c "fiemap" $1 | tail -n +2 | grep -v hole | \
3439 cut -d ' ' -f 3 | sort | uniq | wc -l
3444 $XFS_IO_PROG -r -c "fiemap" $1 | tail -n +2 | grep hole | wc -l
3447 _count_attr_extents()
3449 $XFS_IO_PROG -c "fiemap -a" $1 | tail -n +2 | grep -v hole | wc -l
3452 # arg 1 is dev to remove and is output of the below eg.
3453 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
3459 echo 1 > /sys/class/scsi_device/${lun}/device/delete || _fail "Remove disk failed"
3461 stat $disk > /dev/null 2>&1
3462 while [ $? -eq 0 ]; do
3464 stat $disk > /dev/null 2>&1
3468 # arg 1 is dev to add and is output of the below eg.
3469 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
3474 # arg 1 will be in h:t:d:l format now in the h and "t d l" format
3475 h=`echo ${1} | cut -d":" -f 1`
3476 tdl=`echo ${1} | cut -d":" -f 2-|sed 's/:/ /g'`
3478 echo ${tdl} > /sys/class/scsi_host/host${h}/scan || _fail "Add disk failed"
3480 # ensure the device comes online
3481 local dev_back_oneline=0
3483 for i in `seq 1 10`; do
3484 if [ -d /sys/class/scsi_device/${1}/device/block ]; then
3485 local dev=`ls /sys/class/scsi_device/${1}/device/block`
3487 for j in `seq 1 10`;
3489 stat /dev/$dev > /dev/null 2>&1
3490 if [ $? -eq 0 ]; then
3501 if [ $dev_back_oneline -eq 0 ]; then
3502 echo "/dev/$dev online failed" >> $seqres.full
3504 echo "/dev/$dev is back online" >> $seqres.full
3510 if [ -z "$FSTRIM_PROG" ]; then
3511 _notrun "This test requires fstrim utility."
3515 _require_batched_discard()
3517 if [ $# -ne 1 ]; then
3518 echo "Usage: _require_batched_discard mnt_point" 1>&2
3522 $FSTRIM_PROG $1 > /dev/null 2>&1 || _notrun "FITRIM not supported on $1"
3527 if [ -z "$DUMPE2FS_PROG" ]; then
3528 _notrun "This test requires dumpe2fs utility."
3534 if [ ! -e /proc/self/uid_map ]; then
3535 _notrun "This test requires procfs uid_map support."
3537 if [ ! -e /proc/self/gid_map ]; then
3538 _notrun "This test requires procfs gid_map support."
3544 FSSUM_PROG=$here/src/fssum
3545 [ -x $FSSUM_PROG ] || _notrun "fssum not built"
3550 CLONER_PROG=$here/src/cloner
3551 [ -x $CLONER_PROG ] || \
3552 _notrun "cloner binary not present at $CLONER_PROG"
3555 # Normalize mount options from global $MOUNT_OPTIONS
3556 # Convert options like "-o opt1,opt2 -oopt3" to
3558 _normalize_mount_options()
3560 echo $MOUNT_OPTIONS | sed -n 's/-o\s*\(\S*\)/\1/gp'| sed 's/,/ /g'
3563 # skip test if MOUNT_OPTIONS contains the given strings
3564 # Both dax and dax=always are excluded if dax or dax=always is passed
3565 _exclude_scratch_mount_option()
3567 local mnt_opts=$(_normalize_mount_options)
3569 while [ $# -gt 0 ]; do
3571 echo "$pattern" | egrep -q "dax(=always|$)" && \
3572 pattern="dax(=always| |$)"
3573 if echo $mnt_opts | egrep -q "$pattern"; then
3574 _notrun "mount option \"$1\" not allowed in this test"
3582 _exclude_scratch_mount_option "noatime"
3585 _notrun "atime related mount options have no effect on $FSTYP"
3593 _scratch_mkfs > /dev/null 2>&1
3594 _try_scratch_mount -o relatime || \
3595 _notrun "relatime not supported by the current kernel"
3601 [ -x $here/src/nsexec ] || _notrun "src/nsexec executable not found"
3602 $here/src/nsexec -U true 2>/dev/null || _notrun "userns not supported by this kernel"
3605 _create_loop_device()
3608 dev=`losetup -f --show $file` || _fail "Cannot assign $file to a loop device"
3612 _destroy_loop_device()
3615 losetup -d $dev || _fail "Cannot destroy loop device $dev"
3618 _scale_fsstress_args()
3621 while [ $# -gt 0 ]; do
3623 -n) args="$args $1 $(($2 * $TIME_FACTOR))"; shift ;;
3624 -p) args="$args $1 $(($2 * $LOAD_FACTOR))"; shift ;;
3625 *) args="$args $1" ;;
3629 printf '%s\n' "$args"
3633 # Return the logical block size if running on a block device,
3634 # else substitute the page size.
3636 _min_dio_alignment()
3640 if [ -b "$dev" ]; then
3641 blockdev --getss $dev
3643 $here/src/feature -s
3649 echo "# $@" >> $seqres.full 2>&1
3650 "$@" >> $seqres.full 2>&1 || _fail "failed: '$@'"
3655 local target=`mktemp -p $TEST_DIR`
3656 local link=`mktemp -p $TEST_DIR -u`
3657 ln -s `basename $target` $link
3658 if [ "$?" -ne 0 ]; then
3660 _notrun "Require symlinks support"
3665 _require_hardlinks()
3667 local target=`mktemp -p $TEST_DIR`
3668 local link=`mktemp -p $TEST_DIR -u`
3670 if [ "$?" -ne 0 ]; then
3672 _notrun "No hardlink support"
3677 _require_test_fcntl_advisory_locks()
3679 [ "$FSTYP" != "cifs" ] && return 0
3680 cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -q "nobrl" && return 0
3681 cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -qE "nounix|forcemand" && \
3682 _notrun "Require fcntl advisory locks support"
3685 _require_test_fcntl_setlease()
3687 _require_test_program "locktest"
3688 touch $TEST_DIR/setlease_testfile
3689 $here/src/locktest -t $TEST_DIR/setlease_testfile >/dev/null 2>&1
3690 [ $? -eq 22 ] && _notrun "Require fcntl setlease support"
3693 _require_ofd_locks()
3695 # Give a test run by getlk wrlck on testfile.
3696 # If the running kernel does not support OFD locks,
3697 # EINVAL will be returned.
3698 _require_test_program "t_ofd_locks"
3699 touch $TEST_DIR/ofd_testfile
3700 $here/src/t_ofd_locks -t $TEST_DIR/ofd_testfile > /dev/null 2>&1
3701 [ $? -eq 22 ] && _notrun "Require OFD locks support"
3704 _require_test_lsattr()
3706 local testio=$(lsattr -d $TEST_DIR 2>&1)
3707 echo $testio | grep -q "Operation not supported" && \
3708 _notrun "lsattr not supported by test filesystem type: $FSTYP"
3709 echo $testio | grep -q "Inappropriate ioctl for device" && \
3710 _notrun "lsattr not supported by test filesystem type: $FSTYP"
3715 if [ -z "$1" ]; then
3716 echo "Usage: _require_chattr <attr>"
3721 touch $TEST_DIR/syscalltest
3722 chattr "+$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
3724 chattr "-$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
3725 if [ "$ret" -ne 0 ]; then
3726 _notrun "file system doesn't support chattr +$attribute"
3728 cat $TEST_DIR/syscalltest.out >> $seqres.full
3729 rm -f $TEST_DIR/syscalltest.out
3734 if [ -z "$1" ]; then
3735 echo "Usage: _get_total_inode <mnt>"
3739 nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $3}'`
3745 if [ -z "$1" ]; then
3746 echo "Usage: _get_used_inode <mnt>"
3750 nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $4}'`
3754 _get_used_inode_percent()
3756 if [ -z "$1" ]; then
3757 echo "Usage: _get_used_inode_percent <mnt>"
3761 pct_inode=`$DF_PROG -i $1 | tail -1 | awk '{ print $6 }' | \
3768 if [ -z "$1" ]; then
3769 echo "Usage: _get_free_inode <mnt>"
3773 nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $5}'`
3777 # get the available space in bytes
3779 _get_available_space()
3781 if [ -z "$1" ]; then
3782 echo "Usage: _get_available_space <mnt>"
3786 avail_kb=`$DF_PROG $1 | tail -n1 | awk '{ print $5 }'`
3787 echo $((avail_kb * 1024))
3790 # return device size in kb
3793 grep -w `_short_dev $1` /proc/partitions | awk '{print $3}'
3796 # Make sure we actually have dmesg checking set up.
3797 _require_check_dmesg()
3799 test -w /dev/kmsg || \
3800 _notrun "Test requires writable /dev/kmsg."
3803 # Return the dmesg log since the start of this test. Caller must ensure that
3804 # /dev/kmsg was writable when the test was started so that we can find the
3805 # beginning of this test's log messages; _require_check_dmesg does this.
3806 _dmesg_since_test_start()
3808 # search the dmesg log of last run of $seqnum for possible failures
3809 # use sed \cregexpc address type, since $seqnum contains "/"
3810 dmesg | tac | sed -ne "0,\#run fstests $seqnum at $date_time#p" | \
3814 # check dmesg log for a specific string, subject to the same requirements as
3815 # _dmesg_since_test_start.
3818 _dmesg_since_test_start | egrep -q "$1"
3821 # Default filter for dmesg scanning.
3822 # Ignore lockdep complaining about its own bugginess when scanning dmesg
3823 # output, because we shouldn't be failing filesystem tests on account of
3825 _check_dmesg_filter()
3827 egrep -v -e "BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low" \
3828 -e "BUG: MAX_STACK_TRACE_ENTRIES too low"
3831 # check dmesg log for WARNING/Oops/etc.
3834 if [ ! -f ${RESULT_DIR}/check_dmesg ]; then
3837 rm -f ${RESULT_DIR}/check_dmesg
3839 # default filter is a simple cat command, caller could provide a
3840 # customized filter and pass the name through the first argument, to
3841 # filter out intentional WARNINGs or Oopses
3842 local filter=${1:-_check_dmesg_filter}
3844 _dmesg_since_test_start | $filter >$seqres.dmesg
3845 egrep -q -e "kernel BUG at" \
3849 -e "possible recursive locking detected" \
3850 -e "Internal error" \
3851 -e "(INFO|ERR): suspicious RCU usage" \
3852 -e "INFO: possible circular locking dependency detected" \
3853 -e "general protection fault:" \
3854 -e "BUG .* remaining" \
3857 if [ $? -eq 0 ]; then
3858 _dump_err "_check_dmesg: something found in dmesg (see $seqres.dmesg)"
3861 if [ "$KEEP_DMESG" != "yes" ]; then
3868 # capture the kmemleak report
3871 local kern_knob="$DEBUGFS_MNT/kmemleak"
3872 local leak_file="$1"
3874 # Tell the kernel to scan for memory leaks. Apparently the write
3875 # returns before the scan is complete, so do it twice in the hopes
3876 # that twice is enough to capture all the leaks.
3877 echo "scan" > "$kern_knob"
3878 cat "$kern_knob" > /dev/null
3879 echo "scan" > "$kern_knob"
3880 cat "$kern_knob" > "$leak_file.tmp"
3881 if [ -s "$leak_file.tmp" ]; then
3882 cat > "$leak_file" << ENDL
3883 EXPERIMENTAL kmemleak reported some memory leaks! Due to the way kmemleak
3884 works, the leak might be from an earlier test, or something totally unrelated.
3886 cat "$leak_file.tmp" >> "$leak_file"
3888 rm -rf "$leak_file.tmp"
3889 echo "clear" > "$kern_knob"
3892 # Figure out if the running kernel supports kmemleak; if it does, clear out
3893 # anything that leaked before we even started testing. The leak checker only
3894 # needs to be primed like this once per ./check invocation.
3897 local kern_knob="$DEBUGFS_MNT/kmemleak"
3898 KMEMLEAK_CHECK_FILE="/tmp/check_kmemleak"
3900 # Since kernel v4.19-rc3, the kmemleak knob exists even if kmemleak is
3901 # disabled, but returns EBUSY on write. So instead of relying on
3902 # existance of writable knob file, we use a test file to indicate that
3903 # _check_kmemleak() is enabled only if we actually managed to write to
3905 rm -f "$KMEMLEAK_CHECK_FILE"
3907 if [ ! -w "$kern_knob" ]; then
3911 # Disable the automatic scan so that we can control it completely,
3912 # then dump all the leaks recorded so far.
3913 if echo "scan=off" > "$kern_knob" 2>/dev/null; then
3914 _capture_kmemleak /dev/null
3915 touch "$KMEMLEAK_CHECK_FILE"
3919 # Kick the kmemleak checker to scan for leaks. Background leak scan mode is
3920 # not enabled, so we must call the kernel to ask for a scan and deal with the
3921 # results appropriately. This we do after every test completes, whether or not
3922 # it was successful.
3925 local kern_knob="$DEBUGFS_MNT/kmemleak"
3926 local leak_file="$seqres.kmemleak"
3928 if [ ! -f "$KMEMLEAK_CHECK_FILE" ]; then
3932 # Not enabled, so discard any report of leaks found.
3933 if [ "$USE_KMEMLEAK" != "yes" ]; then
3934 _capture_kmemleak /dev/null
3938 # Capture and report any leaks
3939 _capture_kmemleak "$leak_file"
3940 if [ -s "$leak_file" ]; then
3941 _dump_err "_check_kmemleak: something found in kmemleak (see $leak_file)"
3949 # don't check dmesg log after test
3950 _disable_dmesg_check()
3952 rm -f ${RESULT_DIR}/check_dmesg
3957 # make some further configuration checks here
3958 if [ "$TEST_DEV" = "" ]
3960 echo "common/rc: Error: \$TEST_DEV is not set"
3964 # if $TEST_DEV is not mounted, mount it now as XFS
3965 if [ -z "`_fs_type $TEST_DEV`" ]
3967 # $TEST_DEV is not mounted
3970 echo "common/rc: retrying test device mount with external set"
3971 [ "$USE_EXTERNAL" != "yes" ] && export USE_EXTERNAL=yes
3974 echo "common/rc: could not mount $TEST_DEV on $TEST_DIR"
3980 # Sanity check that TEST partition is not mounted at another mount point
3981 # or as another fs type
3982 _check_mounted_on TEST_DEV $TEST_DEV TEST_DIR $TEST_DIR $FSTYP || exit 1
3983 if [ -n "$SCRATCH_DEV" ]; then
3984 # Sanity check that SCRATCH partition is not mounted at another
3985 # mount point, because it is about to be unmounted and formatted.
3986 # Another fs type for scratch is fine (bye bye old fs type).
3987 _check_mounted_on SCRATCH_DEV $SCRATCH_DEV SCRATCH_MNT $SCRATCH_MNT
3988 [ $? -le 1 ] || exit 1
3991 # Figure out if we need to add -F ("foreign", deprecated) option to xfs_io
3992 $XFS_IO_PROG -c stat $TEST_DIR 2>&1 | grep -q "is not on an XFS filesystem" && \
3993 export XFS_IO_PROG="$XFS_IO_PROG -F"
3995 # xfs_io -i option starts an idle thread for xfs_io.
3996 # With single threaded process, the file table is not shared
3997 # and file structs are not reference counted.
3998 # Spawning an idle thread can help detecting file struct
3999 # reference leaks, so we want to enable the option whenever
4001 $XFS_IO_PROG -i -c quit 2>/dev/null && \
4002 export XFS_IO_PROG="$XFS_IO_PROG -i"
4004 # xfs_copy on v5 filesystems do not require the "-d" option if xfs_db
4005 # can change the UUID on v5 filesystems
4006 if [ "$FSTYP" == "xfs" ]; then
4008 $MKFS_XFS_PROG -d file,name=/tmp/$$.img,size=512m >/dev/null 2>&1
4009 # xfs_db will return 0 even if it can't generate a new uuid, so
4010 # check the output to make sure if it can change UUID of V5 xfs
4011 $XFS_DB_PROG -x -c "uuid generate" /tmp/$$.img \
4012 | grep -q "invalid UUID\|supported on V5 fs" \
4013 && export XFS_COPY_PROG="$XFS_COPY_PROG -d"
4018 # get real device path name by following link
4022 if [ -b "$dev" ] && [ -L "$dev" ]; then
4023 dev=`readlink -f "$dev"`
4028 # basename of a device
4031 echo `basename $(_real_dev $1)`
4036 local dev=`_real_dev $1`
4037 local maj=$(stat -c%t $dev | tr [:lower:] [:upper:])
4038 local min=$(stat -c%T $dev | tr [:lower:] [:upper:])
4039 maj=$(echo "ibase=16; $maj" | bc)
4040 min=$(echo "ibase=16; $min" | bc)
4041 echo /sys/dev/block/$maj:$min
4044 # Get the minimum block size of a file. Usually this is the
4045 # minimum fs block size, but some filesystems (ocfs2) do block
4046 # mappings in larger units.
4047 _get_file_block_size()
4049 if [ -z $1 ] || [ ! -d $1 ]; then
4050 echo "Missing mount point argument for _get_file_block_size"
4059 _xfs_get_file_block_size $1
4067 # Get the minimum block size of an fs.
4070 if [ -z $1 ] || [ ! -d $1 ]; then
4071 echo "Missing mount point argument for _get_block_size"
4079 echo $(getconf PAGE_SIZE)
4086 local args=`echo $@ | sed -e "s/ BSIZE / $bsize /g" -e "s/ PSIZE / $psize /g"`
4087 set -- $here/ltp/fsx $args $FSX_AVOID $TEST_DIR/junk
4088 echo "$@" >>$seqres.full
4089 rm -f $TEST_DIR/junk
4090 "$@" 2>&1 | tee -a $seqres.full >$tmp.fsx
4091 if [ ${PIPESTATUS[0]} -ne 0 ]; then
4099 # Test for the existence of a sysfs entry at /sys/fs/$FSTYP/DEV/$ATTR
4101 # Only one argument is needed:
4102 # - attr: path name under /sys/fs/$FSTYP/DEV
4105 # _require_fs_sysfs error/fail_at_unmount
4109 local dname=$(_short_dev $TEST_DEV)
4111 if [ -z "$attr" -o -z "$dname" ];then
4112 _fail "Usage: _require_fs_sysfs <sysfs_attr_path>"
4115 if [ ! -e /sys/fs/${FSTYP}/${dname}/${attr} ];then
4116 _notrun "This test requires /sys/fs/${FSTYP}/${dname}/${attr}"
4122 $here/src/stat_test --check-statx ||
4123 _notrun "This test requires the statx system call"
4126 # Write "content" into /sys/fs/$FSTYP/$DEV/$ATTR
4128 # All arguments are necessary, and in this order:
4129 # - dev: device name, e.g. $SCRATCH_DEV
4130 # - attr: path name under /sys/fs/$FSTYP/$dev
4131 # - content: the content of $attr
4134 # _set_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount 0
4135 _set_fs_sysfs_attr()
4143 if [ ! -b "$dev" -o -z "$attr" -o -z "$content" ];then
4144 _fail "Usage: _set_fs_sysfs_attr <mounted_device> <attr> <content>"
4147 local dname=$(_short_dev $dev)
4148 echo "$content" > /sys/fs/${FSTYP}/${dname}/${attr}
4151 # Print the content of /sys/fs/$FSTYP/$DEV/$ATTR
4153 # All arguments are necessary, and in this order:
4154 # - dev: device name, e.g. $SCRATCH_DEV
4155 # - attr: path name under /sys/fs/$FSTYP/$dev
4158 # _get_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount
4159 _get_fs_sysfs_attr()
4164 if [ ! -b "$dev" -o -z "$attr" ];then
4165 _fail "Usage: _get_fs_sysfs_attr <mounted_device> <attr>"
4168 local dname=$(_short_dev $dev)
4169 cat /sys/fs/${FSTYP}/${dname}/${attr}
4172 # Generic test for specific filesystem feature.
4173 # Currently only implemented to test overlayfs features.
4174 _require_scratch_feature()
4180 _require_scratch_overlay_features ${feature}
4183 _fail "Test for feature '${feature}' of ${FSTYP} is not implemented"
4188 # Get the maximum size of a file in $TEST_DIR (s_maxbytes). On ext4 this will
4189 # be UINT32_MAX * block_size, but other filesystems may allow up to LLONG_MAX.
4190 _get_max_file_size()
4192 local testfile=$TEST_DIR/maxfilesize.$seq
4194 local r=9223372036854775807 # LLONG_MAX
4197 while (( l < r )); do
4198 # Use _math() to avoid signed integer overflow.
4199 local m=$(_math "($l + $r + 1) / 2")
4200 if $XFS_IO_PROG -f -c "truncate $m" $testfile \
4201 |& grep -q 'File too large'
4211 # get MAX_LFS_FILESIZE
4212 _get_max_lfs_filesize()
4214 case "$(getconf LONG_BIT)" in
4216 local ulong_max=$(getconf ULONG_MAX)
4217 local page_size=$(getconf PAGE_SIZE)
4218 echo $(( ulong_max * page_size ))
4221 echo 9223372036854775807
4224 _fail "sizeof(long) == $(getconf LONG_BIT)?"
4229 # The maximum filesystem label length, /not/ including terminating NULL
4243 _notrun "$FSTYP does not define maximum label length"
4248 # Helper to check above early in a script
4249 _require_label_get_max()
4251 # Just call _label_get_max which will notrun if appropriate
4252 dummy=$(_label_get_max)
4257 $UDEV_SETTLE_PROG >/dev/null 2>&1
4258 $DMSETUP_PROG remove "$@" >>$seqres.full 2>&1
4259 $DMSETUP_PROG mknodes >/dev/null 2>&1
4264 $DMSETUP_PROG create "$@" >>$seqres.full 2>&1 || return 1
4265 $DMSETUP_PROG mknodes >/dev/null 2>&1
4266 $UDEV_SETTLE_PROG >/dev/null 2>&1
4271 # Note: filesystems are not required to report btime (creation time)
4272 # if the caller doesn't ask for it, so we define STATX_BTIME here and
4273 # pass it in to the statx command.
4274 export STATX_BTIME=0x800
4275 $XFS_IO_PROG -f $TEST_DIR/test_creation_time -c "statx -m $STATX_BTIME -v" \
4276 | grep btime >>$seqres.full 2>&1 || \
4277 _notrun "inode creation time not supported by this filesystem"
4278 rm -f $TEST_DIR/test_creation_time
4281 _require_scratch_btime()
4284 _scratch_mkfs > /dev/null 2>&1
4287 # Note: filesystems are not required to report btime (creation time)
4288 # if the caller doesn't ask for it, so we define STATX_BTIME here and
4289 # pass it in to the statx command.
4290 export STATX_BTIME=0x800
4291 $XFS_IO_PROG -f $SCRATCH_MNT/test_creation_time -c "statx -m $STATX_BTIME -v" \
4292 | grep btime >>$seqres.full 2>&1 || \
4293 _notrun "inode creation time not supported by this filesystem"
4298 _require_inode_limits()
4300 if [ $(_get_free_inode $TEST_DIR) -eq 0 ]; then
4301 _notrun "$FSTYP does not have a fixed number of inodes available"
4305 _require_filefrag_options()
4307 _require_command "$FILEFRAG_PROG" filefrag
4310 local file="$TEST_DIR/options_testfile"
4313 ${FILEFRAG_PROG} -$options $file 2>&1 | grep -q "invalid option" && \
4314 _notrun "filefrag doesn't support $options option"
4320 _require_filefrag_options "B"
4322 local file="$TEST_DIR/fibmap_testfile"
4325 ${FILEFRAG_PROG} -B $file 2>&1 | grep -q "FIBMAP[[:space:]]*unsupported"
4326 if [ $? -eq 0 ]; then
4327 _notrun "FIBMAP not supported by this filesystem"
4332 _try_wipe_scratch_devs()
4334 test -x "$WIPEFS_PROG" || return 0
4336 # Do specified filesystem wipe at first
4339 _try_wipe_scratch_xfs
4343 # Then do wipefs on all scratch devices
4344 for dev in $SCRATCH_DEV_POOL $SCRATCH_DEV $SCRATCH_LOGDEV $SCRATCH_RTDEV; do
4345 test -b $dev && $WIPEFS_PROG -a $dev
4349 # Only run this on xfs if xfs_scrub is available and has the unicode checker
4350 _check_xfs_scrub_does_unicode() {
4351 [ "${FSTYP}" == "xfs" ] || return 1
4356 _supports_xfs_scrub "${mount}" "${dev}" || return 1
4358 # We only care if xfs_scrub has unicode string support...
4359 if ! type ldd > /dev/null 2>&1 || \
4360 ! ldd "${XFS_SCRUB_PROG}" | grep -q libicui18n; then
4367 # exfat timestamps start at 1980 and cannot be prior to epoch
4368 _require_negative_timestamps() {
4371 _notrun "$FSTYP does not support negative timestamps"
4376 # Require the 'accton' userspace tool and CONFIG_BSD_PROCESS_ACCT=y.
4377 _require_bsd_process_accounting()
4379 _require_command "$ACCTON_PROG" accton
4380 $ACCTON_PROG on &> $tmp.test_accton
4381 cat $tmp.test_accton >> $seqres.full
4382 if grep 'Function not implemented' $tmp.test_accton; then
4383 _notrun "BSD process accounting support unavailable"
4385 $ACCTON_PROG off >> $seqres.full
4388 _require_sysctl_variable()
4391 sysctl $name &>/dev/null || _notrun "$name sysctl unavailable"
4396 mknod $TEST_DIR/$seq.null c 1 3 \
4397 || _notrun "$FSTYP does not support mknod/mkfifo"
4398 rm -f $TEST_DIR/$seq.null
4403 $GETCAP_PROG "$@" | _filter_getcap
4404 return ${PIPESTATUS[0]}
4409 ################################################################################
4410 # make sure this script returns success