2 # XFS specific common functions.
10 [ "$LARGE_SCRATCH_DEV" != yes ] && return 0
11 [ -z "$SCRATCH_DEV_EMPTY_SPACE" ] && SCRATCH_DEV_EMPTY_SPACE=0
12 [ $SCRATCH_DEV_EMPTY_SPACE -ge $fs_size ] && return 0
14 # calculate the size of the file we need to allocate.
15 # Default free space in the FS is 50GB, but you can specify more via
16 # SCRATCH_DEV_EMPTY_SPACE
17 file_size=$(($fs_size - 50*1024*1024*1024))
18 file_size=$(($file_size - $SCRATCH_DEV_EMPTY_SPACE))
20 # mount the filesystem, create the file, unmount it
21 _try_scratch_mount 2>&1 >$tmp_dir/mnt.err
23 if [ $status -ne 0 ]; then
25 cat $tmp_dir/mnt.err >&2
26 rm -f $tmp_dir/mnt.err
29 rm -f $tmp_dir/mnt.err
32 -c "truncate $file_size" \
33 -c "falloc -k 0 $file_size" \
35 $SCRATCH_MNT/.use_space 2>&1 > /dev/null
36 export NUM_SPACE_FILES=1
39 if [ $status -ne 0 ]; then
40 echo "large file prealloc failed"
41 cat $tmp_dir/mnt.err >&2
47 _scratch_mkfs_xfs_opts()
51 # remove metadata related mkfs options if mkfs.xfs doesn't them
52 if [ -n "$XFS_MKFS_HAS_NO_META_SUPPORT" ]; then
53 mkfs_opts=`echo $mkfs_opts | sed "s/-m\s\+\S\+//g"`
58 echo "$MKFS_XFS_PROG $SCRATCH_OPTIONS $mkfs_opts"
62 _scratch_mkfs_xfs_supported()
68 $MKFS_XFS_PROG -N $MKFS_OPTIONS $SCRATCH_OPTIONS $mkfs_opts $SCRATCH_DEV
71 # a mkfs failure may be caused by conflicts between $MKFS_OPTIONS and
72 # $mkfs_opts, try again without $MKFS_OPTIONS
73 if [ $mkfs_status -ne 0 -a -n "$mkfs_opts" ]; then
74 $MKFS_XFS_PROG -N $SCRATCH_OPTIONS $mkfs_opts $SCRATCH_DEV
80 # Returns the minimum XFS log size, in units of log blocks.
81 _scratch_find_xfs_min_logblocks()
83 local mkfs_cmd="`_scratch_mkfs_xfs_opts`"
85 # The smallest log size we can specify is 2M (XFS_MIN_LOG_BYTES) so
86 # pass that in and see if mkfs succeeds or tells us what is the
88 local XFS_MIN_LOG_BYTES=2097152
90 # Try formatting the filesystem with all the options given and the
91 # minimum log size. We hope either that this succeeds or that mkfs
92 # tells us the required minimum log size for the feature set.
94 # We cannot use _scratch_do_mkfs because it will retry /any/ failed
95 # mkfs with MKFS_OPTIONS removed even if the only "failure" was that
96 # the log was too small.
97 local extra_mkfs_options="$* -N -l size=$XFS_MIN_LOG_BYTES"
98 eval "$mkfs_cmd $MKFS_OPTIONS $extra_mkfs_options $SCRATCH_DEV" \
99 2>$tmp.mkfserr 1>$tmp.mkfsstd
102 # If the format fails for a reason other than the log being too small,
103 # try again without MKFS_OPTIONS because that's what _scratch_do_mkfs
104 # will do if we pass in the log size option.
105 if [ $mkfs_status -ne 0 ] &&
106 ! egrep -q '(log size.*too small, minimum|external log device.*too small, must be)' $tmp.mkfserr; then
107 eval "$mkfs_cmd $extra_mkfs_options $SCRATCH_DEV" \
108 2>$tmp.mkfserr 1>$tmp.mkfsstd
112 # mkfs suceeded, so we must pick out the log block size to do the
114 if [ $mkfs_status -eq 0 ]; then
115 blksz="$(grep '^log.*bsize' $tmp.mkfsstd | \
116 sed -e 's/log.*bsize=\([0-9]*\).*$/\1/g')"
117 echo $((XFS_MIN_LOG_BYTES / blksz))
118 rm -f $tmp.mkfsstd $tmp.mkfserr
122 # Usually mkfs will tell us the minimum log size...
123 if grep -q 'minimum size is' $tmp.mkfserr; then
124 grep 'minimum size is' $tmp.mkfserr | \
125 sed -e 's/^.*minimum size is \([0-9]*\) blocks/\1/g'
126 rm -f $tmp.mkfsstd $tmp.mkfserr
129 if grep -q 'external log device.*too small, must be' $tmp.mkfserr; then
130 grep 'external log device.*too small, must be' $tmp.mkfserr | \
131 sed -e 's/^.*must be at least \([0-9]*\) blocks/\1/g'
132 rm -f $tmp.mkfsstd $tmp.mkfserr
136 # Don't know what to do, so fail
137 echo "Cannot determine minimum log size" >&2
138 cat $tmp.mkfsstd >> $seqres.full
139 cat $tmp.mkfserr >> $seqres.full
140 rm -f $tmp.mkfsstd $tmp.mkfserr
145 local mkfs_cmd="`_scratch_mkfs_xfs_opts`"
146 local mkfs_filter="sed -e '/less than device physical sector/d' \
147 -e '/switching to logical sector/d' \
148 -e '/Default configuration/d'"
149 local tmp=`mktemp -u`
152 _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
155 grep -q crc=0 $tmp.mkfsstd && _force_xfsv4_mount_options
157 if [ $mkfs_status -eq 0 -a "$LARGE_SCRATCH_DEV" = yes ]; then
158 # manually parse the mkfs output to get the fs size in bytes
160 fs_size=`cat $tmp.mkfsstd | perl -ne '
161 if (/^data\s+=\s+bsize=(\d+)\s+blocks=(\d+)/) {
163 print STDOUT "$size\n";
165 _setup_large_xfs_fs $fs_size
169 # output mkfs stdout and stderr
172 rm -f $tmp.mkfserr $tmp.mkfsstd
177 # Get the size of an allocation unit of a file. Normally this is just the
178 # block size of the file, but for realtime files, this is the realtime extent
180 _xfs_get_file_block_size()
184 if ! ($XFS_IO_PROG -c "stat -v" "$path" 2>&1 | egrep -q '(rt-inherit|realtime)'); then
185 _get_block_size "$path"
189 # Otherwise, call xfs_info until we find a mount point or the root.
190 path="$(readlink -m "$path")"
191 while ! $XFS_INFO_PROG "$path" &>/dev/null && [ "$path" != "/" ]; do
192 path="$(dirname "$path")"
194 $XFS_INFO_PROG "$path" | grep realtime | sed -e 's/^.*extsz=\([0-9]*\).*$/\1/g'
197 # Set or clear the realtime status of every supplied path. The first argument
198 # is either 'data' or 'realtime'. All other arguments should be paths to
199 # existing directories or empty regular files.
201 # For each directory, each file subsequently created will target the given
202 # device for file data allocations. For each empty regular file, each
203 # subsequent file data allocation will be on the given device.
211 "data") chattr_arg="-t";;
212 "realtime") chattr_arg="+t";;
214 echo "${device}: Don't know what device this is?"
219 $XFS_IO_PROG -c "chattr $chattr_arg" "$@"
227 local value=$($XFS_IO_PROG -c "stat" "$path" | grep -w "$field")
228 echo ${value##fsxattr.${field} = }
231 # xfs_check script is planned to be deprecated. But, we want to
232 # be able to invoke "xfs_check" behavior in xfstests in order to
233 # maintain the current verification levels.
238 USAGE="Usage: xfs_check [-fsvV] [-l logdev] [-i ino]... [-b bno]... special"
241 while getopts "b:fi:l:stvV" c; do
246 i) OPTS=$OPTS"-i "$OPTARG" ";;
247 b) OPTS=$OPTS"-b "$OPTARG" ";;
248 f) DBOPTS=$DBOPTS" -f";;
249 l) DBOPTS=$DBOPTS" -l "$OPTARG" ";;
250 V) $XFS_DB_PROG -p xfs_check -V
258 1) ${XFS_DB_PROG}${DBOPTS} -F -i -p xfs_check -c "check$OPTS" $1
268 _scratch_xfs_db_options()
271 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
272 SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
273 echo $SCRATCH_OPTIONS $* $SCRATCH_DEV
278 $XFS_DB_PROG "$@" $(_scratch_xfs_db_options)
281 _test_xfs_db_options()
284 [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
285 TEST_OPTIONS="-l$TEST_LOGDEV"
286 echo $TEST_OPTIONS $* $TEST_DEV
291 $XFS_DB_PROG "$@" $(_test_xfs_db_options)
296 local options=("$SCRATCH_DEV")
298 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
299 options+=("$SCRATCH_LOGDEV")
300 if [ "$USE_EXTERNAL" = yes ] && [ -n "$SCRATCH_RTDEV" ]; then
301 $XFS_ADMIN_PROG --help 2>&1 | grep -q 'rtdev' || \
302 _notrun 'xfs_admin does not support rt devices'
303 rt_opts+=(-r "$SCRATCH_RTDEV")
306 # xfs_admin in xfsprogs 5.11 has a bug where an external log device
307 # forces xfs_db to be invoked, potentially with zero command arguments.
308 # When this happens, xfs_db will wait for input on stdin, which causes
309 # fstests to hang. Since xfs_admin is not an interactive tool, we
310 # can redirect stdin from /dev/null to prevent this issue.
311 $XFS_ADMIN_PROG "${rt_opts[@]}" "$@" "${options[@]}" < /dev/null
314 _scratch_xfs_logprint()
317 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
318 SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
319 $XFS_LOGPRINT_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
325 [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
326 TEST_OPTIONS="-l$TEST_LOGDEV"
327 $XFS_LOGPRINT_PROG $TEST_OPTIONS $* $TEST_DEV
333 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
334 SCRATCH_OPTIONS="-l $SCRATCH_LOGDEV"
335 [ "$LARGE_SCRATCH_DEV" = yes ] && \
336 SCRATCH_OPTIONS=$SCRATCH_OPTIONS" -t"
337 _xfs_check $SCRATCH_OPTIONS $* $SCRATCH_DEV
340 # Check for secret debugging hooks in xfs_repair
341 _require_libxfs_debug_flag() {
344 grep -q "$hook" "$(type -P xfs_repair)" || \
345 _notrun "libxfs debug hook $hook not detected?"
348 _scratch_xfs_repair()
351 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
352 SCRATCH_OPTIONS="-l$SCRATCH_LOGDEV"
353 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
354 SCRATCH_OPTIONS=$SCRATCH_OPTIONS" -r$SCRATCH_RTDEV"
355 $XFS_REPAIR_PROG $SCRATCH_OPTIONS $* $SCRATCH_DEV
358 # this test requires the projid32bit feature to be available in mkfs.xfs.
360 _require_projid32bit()
362 _scratch_mkfs_xfs_supported -i projid32bit=1 >/dev/null 2>&1 \
363 || _notrun "mkfs.xfs doesn't have projid32bit feature"
366 _require_projid16bit()
368 _scratch_mkfs_xfs_supported -i projid32bit=0 >/dev/null 2>&1 \
369 || _notrun "16 bit project IDs not supported on $SCRATCH_DEV"
372 # this test requires the crc feature to be available in mkfs.xfs
374 _require_xfs_mkfs_crc()
376 _scratch_mkfs_xfs_supported -m crc=1 >/dev/null 2>&1 \
377 || _notrun "mkfs.xfs doesn't have crc feature"
380 # this test requires the xfs kernel support crc feature
384 _scratch_mkfs_xfs -m crc=1 >/dev/null 2>&1
385 _try_scratch_mount >/dev/null 2>&1 \
386 || _notrun "Kernel doesn't support crc feature"
390 # this test requires the xfs kernel support crc feature on scratch device
392 _require_scratch_xfs_crc()
394 _scratch_mkfs_xfs >/dev/null 2>&1
395 _try_scratch_mount >/dev/null 2>&1 \
396 || _notrun "Kernel doesn't support crc feature"
397 $XFS_INFO_PROG $SCRATCH_MNT | grep -q 'crc=1' || _notrun "crc feature not supported by this filesystem"
401 # this test requires the finobt feature to be available in mkfs.xfs
403 _require_xfs_mkfs_finobt()
405 _scratch_mkfs_xfs_supported -m crc=1,finobt=1 >/dev/null 2>&1 \
406 || _notrun "mkfs.xfs doesn't have finobt feature"
409 # this test requires the xfs kernel support finobt feature
411 _require_xfs_finobt()
413 _scratch_mkfs_xfs -m crc=1,finobt=1 >/dev/null 2>&1
414 _try_scratch_mount >/dev/null 2>&1 \
415 || _notrun "Kernel doesn't support finobt feature"
419 # this test requires xfs sysfs attribute support
426 if [ ! -e $sysfsdir ]; then
427 _notrun "no kernel support for XFS sysfs attributes"
430 if [ ! -z $1 ] && [ ! -e $sysfsdir/$attr ]; then
431 _notrun "sysfs attribute '$attr' is not supported"
435 # this test requires the xfs sparse inode feature
437 _require_xfs_sparse_inodes()
439 _scratch_mkfs_xfs_supported -m crc=1 -i sparse > /dev/null 2>&1 \
440 || _notrun "mkfs.xfs does not support sparse inodes"
441 _scratch_mkfs_xfs -m crc=1 -i sparse > /dev/null 2>&1
442 _try_scratch_mount >/dev/null 2>&1 \
443 || _notrun "kernel does not support sparse inodes"
447 # check that xfs_db supports a specific command
448 _require_xfs_db_command()
450 if [ $# -ne 1 ]; then
451 echo "Usage: _require_xfs_db_command command" 1>&2
456 _scratch_mkfs_xfs >/dev/null 2>&1
457 _scratch_xfs_db -x -c "help" | grep $command > /dev/null || \
458 _notrun "xfs_db $command support is missing"
461 # Does the filesystem mounted from a particular device support scrub?
462 _supports_xfs_scrub()
464 local mountpoint="$1"
467 if [ -z "$device" ] || [ -z "$mountpoint" ]; then
468 echo "Usage: _supports_xfs_scrub mountpoint device"
472 if [ ! -b "$device" ] || [ ! -e "$mountpoint" ]; then
476 test "$FSTYP" = "xfs" || return 1
477 test -x "$XFS_SCRUB_PROG" || return 1
479 # Probe for kernel support...
480 $XFS_IO_PROG -c 'help scrub' 2>&1 | grep -q 'types are:.*probe' || return 1
481 $XFS_IO_PROG -c "scrub probe" "$mountpoint" 2>&1 | grep -q "Inappropriate ioctl" && return 1
483 # Scrub can't run on norecovery mounts
484 _fs_options "$device" | grep -q "norecovery" && return 1
489 # Save a snapshot of a corrupt xfs filesystem for later debugging.
494 local compressopt="$4"
495 shift; shift; shift; shift
497 test -z "$options" && options="-a -o"
499 if [ "$logdev" != "none" ]; then
500 options="$options -l $logdev"
503 $XFS_METADUMP_PROG $options "$device" "$metadump"
505 [ "$compressopt" = "compress" ] && [ -n "$DUMP_COMPRESSOR" ] &&
506 $DUMP_COMPRESSOR -f "$metadump" &> /dev/null
510 # Snapshot the metadata on the scratch device
511 _scratch_xfs_metadump()
517 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
518 logdev=$SCRATCH_LOGDEV
520 _xfs_metadump "$metadump" "$SCRATCH_DEV" "$logdev" nocompress "$@"
523 # run xfs_check and friends on a FS.
524 _check_xfs_filesystem()
526 if [ $# -ne 3 ]; then
527 echo "Usage: _check_xfs_filesystem device <logdev>|none <rtdev>|none" 1>&2
531 extra_mount_options=""
535 if [ -f $device ]; then
540 if [ "$logdev" != "none" ]; then
541 extra_log_options="-l$logdev"
542 extra_mount_options="-ologdev=$logdev"
546 if [ "$rtdev" != "none" ]; then
547 extra_rt_options="-r$rtdev"
548 extra_mount_options=$extra_mount_options" -ortdev=$rtdev"
550 extra_mount_options=$extra_mount_options" $MOUNT_OPTIONS"
552 [ "$FSTYP" != xfs ] && return 0
554 type=`_fs_type $device`
557 # Run online scrub if we can.
558 mntpt="$(_is_dev_mounted $device)"
559 if [ -n "$mntpt" ] && _supports_xfs_scrub "$mntpt" "$device"; then
560 # Tests can create a scenario in which a call to syncfs() issued
561 # at the end of the execution of the test script would return an
562 # error code. xfs_scrub internally calls syncfs() before
563 # starting the actual online consistency check operation. Since
564 # such a call to syncfs() fails, xfs_scrub ends up returning
565 # without performing consistency checks on the test
566 # filesystem. This can mask a possible on-disk data structure
567 # corruption. Hence consume such a possible syncfs() failure
568 # before executing a scrub operation.
569 $XFS_IO_PROG -c syncfs $mntpt >> $seqres.full 2>&1
571 "$XFS_SCRUB_PROG" $scrubflag -v -d -n $mntpt > $tmp.scrub 2>&1
572 if [ $? -ne 0 ]; then
573 _log_err "_check_xfs_filesystem: filesystem on $device failed scrub"
574 echo "*** xfs_scrub $scrubflag -v -d -n output ***" >> $seqres.full
575 cat $tmp.scrub >> $seqres.full
576 echo "*** end xfs_scrub output" >> $serqres.full
582 if [ "$type" = "xfs" ]; then
584 mountpoint=`_umount_or_remount_ro $device`
587 $XFS_LOGPRINT_PROG -t $extra_log_options $device 2>&1 \
588 | tee $tmp.logprint | grep -q "<CLEAN>"
589 if [ $? -ne 0 ]; then
590 _log_err "_check_xfs_filesystem: filesystem on $device has dirty log"
591 echo "*** xfs_logprint -t output ***" >>$seqres.full
592 cat $tmp.logprint >>$seqres.full
593 echo "*** end xfs_logprint output" >>$seqres.full
598 # xfs_check runs out of memory on large files, so even providing the
599 # test option (-t) to avoid indexing the free space trees doesn't make
600 # it pass on large filesystems. Avoid it.
602 # As of August 2021, xfs_repair completely supersedes xfs_check's
603 # ability to find corruptions, so we no longer run xfs_check unless
605 if [ "$LARGE_SCRATCH_DEV" != yes ] && [ "$FORCE_XFS_CHECK_PROG" = "yes" ]; then
606 _xfs_check $extra_log_options $device 2>&1 > $tmp.fs_check
608 if [ -s $tmp.fs_check ]; then
609 _log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (c)"
610 echo "*** xfs_check output ***" >>$seqres.full
611 cat $tmp.fs_check >>$seqres.full
612 echo "*** end xfs_check output" >>$seqres.full
617 $XFS_REPAIR_PROG -n $extra_options $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
618 if [ $? -ne 0 ]; then
619 _log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (r)"
620 echo "*** xfs_repair -n output ***" >>$seqres.full
621 cat $tmp.repair >>$seqres.full
622 echo "*** end xfs_repair output" >>$seqres.full
626 rm -f $tmp.fs_check $tmp.logprint $tmp.repair
628 if [ "$ok" -ne 1 ] && [ "$DUMP_CORRUPT_FS" = "1" ]; then
629 local flatdev="$(basename "$device")"
630 _xfs_metadump "$seqres.$flatdev.check.md" "$device" "$logdev" \
631 compress >> $seqres.full
634 # Optionally test the index rebuilding behavior.
635 if [ -n "$TEST_XFS_REPAIR_REBUILD" ]; then
637 $XFS_REPAIR_PROG $extra_options $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
638 if [ $? -ne 0 ]; then
639 _log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (rebuild)"
640 echo "*** xfs_repair output ***" >>$seqres.full
641 cat $tmp.repair >>$seqres.full
642 echo "*** end xfs_repair output" >>$seqres.full
649 $XFS_REPAIR_PROG -n $extra_options $extra_log_options $extra_rt_options $device >$tmp.repair 2>&1
650 if [ $? -ne 0 ]; then
651 _log_err "_check_xfs_filesystem: filesystem on $device is inconsistent (rebuild-reverify)"
652 echo "*** xfs_repair -n output ***" >>$seqres.full
653 cat $tmp.repair >>$seqres.full
654 echo "*** end xfs_repair output" >>$seqres.full
661 if [ "$rebuild_ok" -ne 1 ] && [ "$DUMP_CORRUPT_FS" = "1" ]; then
662 local flatdev="$(basename "$device")"
663 _xfs_metadump "$seqres.$flatdev.rebuild.md" "$device" \
664 "$logdev" compress >> $seqres.full
668 if [ $ok -eq 0 ]; then
669 echo "*** mount output ***" >>$seqres.full
670 _mount >>$seqres.full
671 echo "*** end mount output" >>$seqres.full
672 elif [ "$type" = "xfs" ]; then
673 _mount_or_remount_rw "$extra_mount_options" $device $mountpoint
676 if [ $ok -eq 0 ]; then
678 if [ "$iam" != "check" ]; then
691 [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_LOGDEV" ] && \
692 TEST_LOG="$TEST_LOGDEV"
694 [ "$USE_EXTERNAL" = yes -a ! -z "$TEST_RTDEV" ] && \
695 TEST_RT="$TEST_RTDEV"
697 _check_xfs_filesystem $TEST_DEV $TEST_LOG $TEST_RT
701 _require_xfs_test_rmapbt()
705 if [ "$($XFS_INFO_PROG "$TEST_DIR" | grep -c "rmapbt=1")" -ne 1 ]; then
706 _notrun "rmapbt not supported by test filesystem type: $FSTYP"
710 _require_xfs_scratch_rmapbt()
714 _scratch_mkfs > /dev/null
716 if [ "$($XFS_INFO_PROG "$SCRATCH_MNT" | grep -c "rmapbt=1")" -ne 1 ]; then
718 _notrun "rmapbt not supported by scratch filesystem type: $FSTYP"
740 $XFS_IO_PROG -c "bmap -${param}lpv" "$file" | grep -c "$@"
743 # Reset all xfs error handling attributes, set them to original
746 # Only one argument, and it's mandatory:
747 # - dev: device name, e.g. $SCRATCH_DEV
749 # Note: this function only works for XFS
750 _reset_xfs_sysfs_error_handling()
754 if [ ! -b "$dev" -o "$FSTYP" != "xfs" ]; then
755 _fail "Usage: reset_xfs_sysfs_error_handling <device>"
758 _set_fs_sysfs_attr $dev error/fail_at_unmount 1
759 echo -n "error/fail_at_unmount="
760 _get_fs_sysfs_attr $dev error/fail_at_unmount
762 # Make sure all will be configured to retry forever by default, except
763 # for ENODEV, which is an unrecoverable error, so it will be configured
764 # to not retry on error by default.
765 for e in default EIO ENOSPC; do
766 _set_fs_sysfs_attr $dev \
767 error/metadata/${e}/max_retries -1
768 echo -n "error/metadata/${e}/max_retries="
769 _get_fs_sysfs_attr $dev error/metadata/${e}/max_retries
771 _set_fs_sysfs_attr $dev \
772 error/metadata/${e}/retry_timeout_seconds 0
773 echo -n "error/metadata/${e}/retry_timeout_seconds="
774 _get_fs_sysfs_attr $dev \
775 error/metadata/${e}/retry_timeout_seconds
779 # Skip if we are running an older binary without the stricter input checks.
780 # Make multiple checks to be sure that there is no regression on the one
781 # selected feature check, which would skew the result.
783 # At first, make a common function that runs the tests and returns
784 # number of failed cases.
785 _xfs_mkfs_validation_check()
787 local tmpfile=`mktemp`
788 local cmd="$MKFS_XFS_PROG -f -N -d file,name=$tmpfile,size=1g"
790 $cmd -s size=8s >/dev/null 2>&1
793 $cmd -l version=2,su=260k >/dev/null 2>&1
800 # Skip the test if all calls passed - mkfs accepts invalid input
801 _require_xfs_mkfs_validation()
803 _xfs_mkfs_validation_check
804 if [ "$?" -eq 0 ]; then
805 _notrun "Requires newer mkfs with stricter input checks: the oldest supported version of xfsprogs is 4.7."
809 # The opposite of _require_xfs_mkfs_validation.
810 _require_xfs_mkfs_without_validation()
812 _xfs_mkfs_validation_check
813 if [ "$?" -ne 0 ]; then
814 _notrun "Requires older mkfs without strict input checks: the last supported version of xfsprogs is 4.5."
818 _require_scratch_xfs_shrink()
821 _require_command "$XFS_GROWFS_PROG" xfs_growfs
823 _scratch_mkfs_xfs | _filter_mkfs 2>$tmp.mkfs >/dev/null
826 # here just to check if kernel supports, no need do more extra work
828 errmsg=$($XFS_GROWFS_PROG -D$((dblocks-1)) "$SCRATCH_MNT" 2>&1)
829 if [ "$?" -ne 0 ]; then
830 echo "$errmsg" | grep 'XFS_IOC_FSGROWFSDATA xfsctl failed: Invalid argument' > /dev/null && \
831 _notrun "kernel does not support shrinking"
832 echo "$errmsg" | grep 'data size .* too small, old size is ' > /dev/null && \
833 _notrun "xfsprogs does not support shrinking"
834 _fail "$XFS_GROWFS_PROG failed unexpectedly: $errmsg"
839 # XFS ability to change UUIDs on V5/CRC filesystems
843 # This will create a crc fs on $SCRATCH_DEV
846 _scratch_xfs_db -x -c "uuid restore" 2>&1 \
847 | grep -q "invalid UUID\|supported on V5 fs" \
848 && _notrun "Userspace doesn't support meta_uuid feature"
850 _scratch_xfs_db -x -c "uuid generate" >/dev/null 2>&1
852 _try_scratch_mount >/dev/null 2>&1 \
853 || _notrun "Kernel doesn't support meta_uuid feature"
857 # this test requires mkfs.xfs have case-insensitive naming support
858 _require_xfs_mkfs_ciname()
860 _scratch_mkfs_xfs_supported -n version=ci >/dev/null 2>&1 \
861 || _notrun "need case-insensitive naming support in mkfs.xfs"
864 # this test requires mkfs.xfs have configuration file support
865 _require_xfs_mkfs_cfgfile()
868 _scratch_mkfs_xfs_supported -c options=/tmp/a >/dev/null 2>&1
871 test $res -eq 0 || _notrun "need configuration file support in mkfs.xfs"
874 # XFS_DEBUG requirements
877 if grep -q "debug 0" /proc/fs/xfs/stat; then
878 _notrun "Require XFS built with CONFIG_XFS_DEBUG"
881 _require_no_xfs_debug()
883 if grep -q "debug 1" /proc/fs/xfs/stat; then
884 _notrun "Require XFS built without CONFIG_XFS_DEBUG"
888 # Require that assertions will not crash the system.
890 # Assertions would always crash the system if XFS assert fatal was enabled
891 # (CONFIG_XFS_ASSERT_FATAL=y). If a test is designed to trigger an assertion,
892 # skip the test on a CONFIG_XFS_ASSERT_FATAL built XFS by default. Note:
893 # CONFIG_XFS_ASSERT_FATAL can be disabled by setting bug_on_assert to zero if
894 # we want test to run.
895 _require_no_xfs_bug_on_assert()
897 if [ -f /sys/fs/xfs/debug/bug_on_assert ]; then
898 grep -q "1" /sys/fs/xfs/debug/bug_on_assert && \
899 _notrun "test requires XFS bug_on_assert to be off, turn it off to run the test"
901 # Note: Prior to the creation of CONFIG_XFS_ASSERT_FATAL (and
902 # the sysfs knob bug_on_assert), assertions would always crash
903 # the system if XFS debug was enabled (CONFIG_XFS_DEBUG=y). If
904 # a test is designed to trigger an assertion and the test
905 # designer does not want to hang fstests, skip the test.
906 _require_no_xfs_debug
910 # Get a metadata field
911 # The first arg is the field name
912 # The rest of the arguments are xfs_db commands to find the metadata.
913 _scratch_xfs_get_metadata_field()
918 local grep_key="$(echo "${key}" | tr '[]()' '....')"
922 cmds+=("-c" "${arg}")
924 _scratch_xfs_db "${cmds[@]}" -c "print ${key}" | grep "^${grep_key}" | \
928 # Set a metadata field
929 # The first arg is the field name
930 # The second arg is the new value
931 # The rest of the arguments are xfs_db commands to find the metadata.
932 _scratch_xfs_set_metadata_field()
941 cmds+=("-c" "${arg}")
945 _scratch_xfs_db -x -c "help write" | egrep -q "(-c|-d)" && value="-- ${value}"
946 _scratch_xfs_db -x -c "help write" | egrep -q "(-d)" && wr_cmd="${wr_cmd} -d"
947 _scratch_xfs_db -x "${cmds[@]}" -c "${wr_cmd} ${key} ${value}"
950 _scratch_xfs_get_sb_field()
952 _scratch_xfs_get_metadata_field "$1" "sb 0"
955 _scratch_xfs_set_sb_field()
957 _scratch_xfs_set_metadata_field "$1" "$2" "sb 0"
960 # Before xfsprogs commit 4222d000ed("db: write via array indexing doesn't
961 # work"), xfs_db command to write a specific AGFL index doesn't work. It's a
962 # bug in a diagnostic tool that is only used by XFS developers as a test
963 # infrastructure, so it's fine to treat it as a infrastructure dependency as
964 # all other _require rules.
965 _require_xfs_db_write_array()
970 touch $TEST_DIR/$seq.img
971 $MKFS_XFS_PROG -d file,name=$TEST_DIR/$seq.img,size=512m >/dev/null 2>&1
972 $XFS_DB_PROG -x -c "agfl 0" -c "write bno[32] 78" $TEST_DIR/$seq.img \
974 $XFS_DB_PROG -x -c "agfl 0" -c "print bno[32]" $TEST_DIR/$seq.img \
975 | grep -q "bno\[32\] = 78" && supported=1
976 rm -f $TEST_DIR/$seq.img
977 [ $supported -eq 0 ] && _notrun "xfs_db write can't support array"
980 _require_xfs_spaceman_command()
983 echo "Usage: _require_xfs_spaceman_command command [switch]" 1>&2
989 local param_checked=0
992 _require_command "$XFS_SPACEMAN_PROG" "xfs_spaceman"
994 testfile=$TEST_DIR/$$.xfs_spaceman
998 testio=`$XFS_SPACEMAN_PROG -c "health $param" $TEST_DIR 2>&1`
1002 testio=`$XFS_SPACEMAN_PROG -c "help $command" $TEST_DIR 2>&1`
1005 rm -f $testfile 2>&1 > /dev/null
1006 echo $testio | grep -q "not found" && \
1007 _notrun "xfs_spaceman $command support is missing"
1008 echo $testio | grep -q "Operation not supported" && \
1009 _notrun "xfs_spaceman $command failed (old kernel/wrong fs?)"
1010 echo $testio | grep -q "Invalid" && \
1011 _notrun "xfs_spaceman $command failed (old kernel/wrong fs/bad args?)"
1012 echo $testio | grep -q "foreign file active" && \
1013 _notrun "xfs_spaceman $command not supported on $FSTYP"
1014 echo $testio | grep -q "Inappropriate ioctl for device" && \
1015 _notrun "xfs_spaceman $command support is missing (missing ioctl?)"
1016 echo $testio | grep -q "Function not implemented" && \
1017 _notrun "xfs_spaceman $command support is missing (missing syscall?)"
1019 [ -n "$param" ] || return
1021 if [ $param_checked -eq 0 ]; then
1022 $XFS_SPACEMAN_PROG -c "help $command" | grep -q "^ $param --" || \
1023 _notrun "xfs_spaceman $command doesn't support $param"
1027 _scratch_get_sfdir_prefix() {
1030 for prefix in "u.sfdir3" "u.sfdir2" "u3.sfdir3"; do
1031 if [ -n "$(_scratch_xfs_get_metadata_field \
1032 "${prefix}.hdr.parent.i4" \
1033 "inode ${dir_ino}")" ]; then
1038 _scratch_xfs_db -c "inode ${dir_ino}" -c 'p' >> $seqres.full
1042 _scratch_get_bmx_prefix() {
1045 for prefix in "u3.bmx" "u.bmx"; do
1046 if [ -n "$(_scratch_xfs_get_metadata_field \
1047 "${prefix}[0].startblock" \
1048 "inode ${ino}")" ]; then
1053 _scratch_xfs_db -c "inode ${ino}" -c 'p' >> $seqres.full
1057 _scratch_get_iext_count()
1065 field=core.naextents
1074 _scratch_xfs_get_metadata_field $field "inode $ino"
1078 # Ensures that we don't pass any mount options incompatible with XFS v4
1080 _force_xfsv4_mount_options()
1085 # Can't have group and project quotas in XFS v4
1086 echo "$MOUNT_OPTIONS" | egrep -q "(gquota|grpquota|grpjquota=|gqnoenforce)" && gquota=1
1087 echo "$MOUNT_OPTIONS" | egrep -q "(\bpquota|prjquota|pqnoenforce)" && pquota=1
1089 if [ $gquota -gt 0 ] && [ $pquota -gt 0 ]; then
1090 export MOUNT_OPTIONS=$(echo $MOUNT_OPTIONS \
1091 | sed -e 's/gquota/QUOTA/g' \
1092 -e 's/grpquota/QUOTA/g' \
1093 -e 's/grpjquota=[^, ]/QUOTA/g' \
1094 -e 's/gqnoenforce/QUOTA/g' \
1095 -e "s/QUOTA/defaults/g")
1097 echo "MOUNT_OPTIONS = $MOUNT_OPTIONS" >>$seqres.full
1100 # Find AG count of mounted filesystem
1101 _xfs_mount_agcount()
1103 $XFS_INFO_PROG "$1" | grep agcount= | sed -e 's/^.*agcount=\([0-9]*\),.*$/\1/g'
1106 # Wipe the superblock of each XFS AGs
1107 _try_wipe_scratch_xfs()
1109 local num='^[0-9]+$'
1114 # Try to wipe each SB if there's an existed XFS
1115 agcount=`_scratch_xfs_get_sb_field agcount 2>/dev/null`
1116 agsize=`_scratch_xfs_get_sb_field agblocks 2>/dev/null`
1117 dbsize=`_scratch_xfs_get_sb_field blocksize 2>/dev/null`
1118 if [[ $agcount =~ $num && $agsize =~ $num && $dbsize =~ $num ]];then
1119 for ((i = 0; i < agcount; i++)); do
1120 $XFS_IO_PROG -c "pwrite $((i * dbsize * agsize)) $dbsize" \
1121 $SCRATCH_DEV >/dev/null;
1125 # Try to wipe each SB by default mkfs.xfs geometry
1126 local tmp=`mktemp -u`
1127 unset agcount agsize dbsize
1128 _scratch_mkfs_xfs -N 2>/dev/null | perl -ne '
1129 if (/^meta-data=.*\s+agcount=(\d+), agsize=(\d+) blks/) {
1130 print STDOUT "agcount=$1\nagsize=$2\n";
1132 if (/^data\s+=\s+bsize=(\d+)\s/) {
1133 print STDOUT "dbsize=$1\n";
1137 if [[ $agcount =~ $num && $agsize =~ $num && $dbsize =~ $num ]];then
1138 for ((i = 0; i < agcount; i++)); do
1139 $XFS_IO_PROG -c "pwrite $((i * dbsize * agsize)) $dbsize" \
1140 $SCRATCH_DEV >/dev/null;
1148 [ -n "$XFS_COPY_PROG" ] || _notrun "xfs_copy binary not yet installed"
1149 [ "$USE_EXTERNAL" = yes ] && \
1150 _notrun "Cannot xfs_copy with external devices"
1153 __xfs_cowgc_interval_knob1="/proc/sys/fs/xfs/speculative_cow_prealloc_lifetime"
1154 __xfs_cowgc_interval_knob2="/proc/sys/fs/xfs/speculative_prealloc_lifetime"
1156 _xfs_set_cowgc_interval() {
1157 if [ -w $__xfs_cowgc_interval_knob1 ]; then
1158 echo "$@" > $__xfs_cowgc_interval_knob1
1159 elif [ -w $__xfs_cowgc_interval_knob2 ]; then
1160 echo "$@" > $__xfs_cowgc_interval_knob2
1162 _fail "Can't find cowgc interval procfs knob?"
1166 _xfs_get_cowgc_interval() {
1167 if [ -w $__xfs_cowgc_interval_knob1 ]; then
1168 cat $__xfs_cowgc_interval_knob1
1169 elif [ -w $__xfs_cowgc_interval_knob2 ]; then
1170 cat $__xfs_cowgc_interval_knob2
1172 _fail "Can't find cowgc interval procfs knob?"
1176 # Print the status of the given features on the scratch filesystem.
1177 # Returns 0 if all features are found, 1 otherwise.
1178 _check_scratch_xfs_features()
1180 local features="$(_scratch_xfs_db -c 'version')"
1181 local output=("FEATURES:")
1184 for feature in "$@"; do
1186 if echo "${features}" | grep -q -w "${feature}"; then
1188 found=$((found + 1))
1190 output+=("${feature}:${status}")
1194 test "${found}" -eq "$#"
1197 # Skip a test if any of the given fs features aren't present on the scratch
1198 # filesystem. The scratch fs must have been formatted already.
1199 _require_scratch_xfs_features()
1201 local features="$(_scratch_xfs_db -c 'version' 2>/dev/null)"
1203 for feature in "$@"; do
1204 echo "${features}" | grep -q -w "${feature}" ||
1205 _notrun "Missing scratch feature: ${feature}"
1209 # Decide if xfs_repair knows how to set (or clear) a filesystem feature.
1210 _require_xfs_repair_upgrade()
1214 $XFS_REPAIR_PROG -c "$type=garbagevalue" 2>&1 | \
1215 grep -q 'unknown option' && \
1216 _notrun "xfs_repair does not support upgrading fs with $type"
1219 # Require that the scratch device exists, that mkfs can format with inobtcount
1220 # enabled, and that the kernel can mount such a filesystem.
1221 _require_scratch_xfs_inobtcount()
1225 _scratch_mkfs -m inobtcount=1 &> /dev/null || \
1226 _notrun "mkfs.xfs doesn't support inobtcount feature"
1227 _try_scratch_mount || \
1228 _notrun "kernel doesn't support xfs inobtcount feature"
1232 _xfs_timestamp_range()
1236 local dbprog="$XFS_DB_PROG $device"
1237 test "$device" = "$SCRATCH_DEV" && dbprog=_scratch_xfs_db
1239 $dbprog -f -c 'help timelimit' | grep -v -q 'not found' && use_db=1
1240 if [ $use_db -eq 0 ]; then
1241 # The "timelimit" command was added to xfs_db at the same time
1242 # that bigtime was added to xfsprogs. Therefore, we can assume
1243 # the old timestamp range if the command isn't present.
1244 echo "-$((1<<31)) $(((1<<31)-1))"
1246 $dbprog -f -c 'timelimit --compact' | \
1247 awk '{printf("%s %s", $1, $2);}'
1251 # Require that the scratch device exists, that mkfs can format with bigtime
1252 # enabled, that the kernel can mount such a filesystem, and that xfs_info
1253 # advertises the presence of that feature.
1254 _require_scratch_xfs_bigtime()
1258 _scratch_mkfs -m bigtime=1 &>/dev/null || \
1259 _notrun "mkfs.xfs doesn't support bigtime feature"
1260 _try_scratch_mount || \
1261 _notrun "kernel doesn't support xfs bigtime feature"
1262 $XFS_INFO_PROG "$SCRATCH_MNT" | grep -q -w "bigtime=1" || \
1263 _notrun "bigtime feature not advertised on mount?"