2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2000-2001 Silicon Graphics, Inc. All Rights Reserved.
7 # Checks that given_value is in range of correct_value +/- tolerance.
8 # Tolerance can be an absolute value or a percentage of the correct value
9 # (see examples with tolerances below).
10 # Outputs suitable message to stdout if it's not in range.
12 # A verbose option, -v, may be used as the LAST argument
15 # foo: 0.0298 = 0.03 +/- 5%
16 # _within_tolerance "foo" 0.0298 0.03 5%
18 # foo: 0.0298 = 0.03 +/- 0.01
19 # _within_tolerance "foo" 0.0298 0.03 0.01
21 # foo: 0.0298 = 0.03 -0.01 +0.002
22 # _within_tolerance "foo" 0.0298 0.03 0.01 0.002
24 # foo: verbose output of 0.0298 = 0.03 +/- 5%
25 # _within_tolerance "foo" 0.0298 0.03 5% -v
36 # maxtol arg is optional
37 # verbose arg is optional
49 [ "$6" = "-v" ] && _verbose=1
52 # find min with or without %
53 _mintolerance=`echo $_mintol | sed -e 's/%//'`
54 if [ $_mintol = $_mintolerance ]
56 _min=`echo "scale=5; $_correct_val-$_mintolerance" | bc`
58 _min=`echo "scale=5; $_correct_val-$_mintolerance*0.01*$_correct_val" | bc`
61 # find max with or without %
62 _maxtolerance=`echo $_maxtol | sed -e 's/%//'`
63 if [ $_maxtol = $_maxtolerance ]
65 _max=`echo "scale=5; $_correct_val+$_maxtolerance" | bc`
67 _max=`echo "scale=5; $_correct_val+$_maxtolerance*0.01*$_correct_val" | bc`
70 $_debug && echo "min = $_min"
71 $_debug && echo "max = $_max"
75 if ($_min <= $_given_val) 1;
76 if ($_min > $_given_val) 0;
81 if ($_given_val <= $_max) 1;
82 if ($_given_val > $_max) 0;
85 _above_min=`bc <$tmp.bc.1`
86 _below_max=`bc <$tmp.bc.2`
90 _in_range=`expr $_above_min \& $_below_max`
92 # fix up min, max precision for output
93 # can vary for 5.3, 6.2
95 # remove any trailing zeroes from min, max if they have fractional parts
96 _min=`echo $_min | sed -e '/\./s/0*$//' -e 's/\.$//'`
97 _max=`echo $_max | sed -e '/\./s/0*$//' -e 's/\.$//'`
99 if [ $_in_range -eq 1 ]
101 [ $_verbose -eq 1 ] && echo $_name is in range
104 [ $_verbose -eq 1 ] && echo $_name has value of $_given_val
105 [ $_verbose -eq 1 ] && echo $_name is NOT in range $_min .. $_max
115 -e 's/[A-Z][a-z][a-z] [A-z][a-z][a-z] *[0-9][0-9]* [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9][0-9][0-9][0-9]$/DATE/'
118 # prints filtered output on stdout, values (use eval) on stderr
119 # Non XFS filesystems always return a 4k block size and a 256 byte inode.
127 perl -e 'print STDERR "dbsize=4096\nisize=256\n"'
131 echo "_fs_has_crcs=0" >&2
134 if (/^meta-data=([\w,|\/.-]+)\s+isize=(\d+)\s+agcount=(\d+), agsize=(\d+) blks/) {
135 print STDERR "ddev=$1\nisize=$2\nagcount=$3\nagsize=$4\n";
136 print STDOUT "meta-data=DDEV isize=XXX agcount=N, agsize=XXX blks\n";
138 if (/^\s+=\s+sectsz=(\d+)\s+attr=(\d+)/) {
139 print STDERR "sectsz=$1\nattr=$2\n";
141 if (/^\s+=\s+crc=(\d)/) {
142 print STDERR "_fs_has_crcs=$1\n";
144 if (/^data\s+=\s+bsize=(\d+)\s+blocks=(\d+), imaxpct=(\d+)/) {
145 print STDERR "dbsize=$1\ndblocks=$2\nimaxpct=$3\n";
146 print STDOUT "data = bsize=XXX blocks=XXX, imaxpct=PCT\n";
148 if (/^\s+=\s+sunit=(\d+)\s+swidth=(\d+) blks/) {
149 print STDERR "sunit=$1\nswidth=$2\nunwritten=1\n";
150 print STDOUT " = sunit=XXX swidth=XXX, unwritten=X\n";
152 if (/^naming\s+=version\s+(\d+)\s+bsize=(\d+)/) {
153 print STDERR "dirversion=$1\ndirbsize=$2\n";
154 print STDOUT "naming =VERN bsize=XXX\n";
156 if (/^log\s+=(internal log|[\w|\/.-]+)\s+bsize=(\d+)\s+blocks=(\d+),\s+version=(\d+)/ ||
157 /^log\s+=(internal log|[\w|\/.-]+)\s+bsize=(\d+)\s+blocks=(\d+)/) {
158 print STDERR "ldev=\"$1\"\nlbsize=$2\nlblocks=$3\nlversion=$4\n";
159 print STDOUT "log =LDEV bsize=XXX blocks=XXX\n";
161 if (/^\s+=\s+sectsz=(\d+)\s+sunit=(\d+) blks/) {
162 print STDERR "logsectsz=$1\nlogsunit=$2\n\n";
164 if (/^realtime\s+=([\w|\/.-]+)\s+extsz=(\d+)\s+blocks=(\d+), rtextents=(\d+)/) {
165 print STDERR "rtdev=$1\nrtextsz=$2\nrtblocks=$3\nrtextents=$4\n";
166 print STDOUT "realtime =RDEV extsz=XXX blocks=XXX, rtextents=XXX\n";
171 # prints the bits we care about in growfs
176 if (/^data\s+=\s+bsize=(\d+)\s+blocks=(\d+), imaxpct=(\d+)/) {
177 print "xfs_growfs --BlockSize=$1 --Blocks=$2\n";
187 /records in/ { next }
188 /records out/ { next }
189 /No space left on device/ { print " !!! disk full (expected)"
197 perl -ne 'if (/.*:(.*)/) {
198 if ( "$last_line" ne "$1" ) { print "$_"; $first_match=1; }
199 elsif ( $first_match==1 ) { print "*\n"; $first_match=0; }
203 print $_; $last_line=$_;
209 # Apart from standard numeric values, we also filter out 'inf' and 'nan'
210 # which can result from division in some cases
211 sed -e "s/[0-9/.]* [GMKiBbytes]*, [0-9]* ops\; [0-9/:. sec]* ([infa0-9/.]* [EPGMKiBbytes]*\/sec and [infa0-9/.]* ops\/sec)/XXX Bytes, X ops\; XX:XX:XX.X (XXX YYY\/sec and XXX ops\/sec)/"
214 # Also filter out the offset part of xfs_io output
215 # Some test cases may be affected by underlaying extent/chunk layout change,
216 # so wipe out this part to avoid golden output difference
217 _filter_xfs_io_offset()
219 # filter out " at offset XXX" and offset of "pread -v"
220 _filter_xfs_io | sed -e "s/ at offset [0-9]*$//" -e "s/^[0-9a-f]\+:/XXXXXXXX:/"
223 # stderr filter for xfs_io to handle change of error output format (e.g.
224 # pwrite64 -> pwrite).
225 _filter_xfs_io_error()
227 sed -e "s/^\(.*\)64\(: .*$\)/\1\2/"
230 _filter_xfs_io_unique()
232 common_line_filter | _filter_xfs_io
235 _filter_xfs_io_units_modified()
240 $AWK_PROG -v unit="$UNIT" -v unit_size=$UNIT_SIZE '
242 split($2, bytes, "/")
244 bytes_written = strtonum(bytes[1])
246 offset = strtonum($NF)
248 unit_start = offset / unit_size
249 unit_start = int(unit_start)
250 unit_end = (offset + bytes_written - 1) / unit_size
251 unit_end = int(unit_end)
253 printf("%ss modified: [%d - %d]\n", unit, unit_start, unit_end)
260 _filter_xfs_io_blocks_modified()
262 BLOCK_SIZE=$(_get_block_size $SCRATCH_MNT)
264 _filter_xfs_io_units_modified "Block" $BLOCK_SIZE
267 _filter_xfs_io_pages_modified()
269 PAGE_SIZE=$(get_page_size)
271 _filter_xfs_io_units_modified "Page" $PAGE_SIZE
274 _filter_xfs_io_numbers()
276 _filter_xfs_io | sed -E 's/[0-9]+/XXXX/g'
281 # TEST_DEV may be a prefix of TEST_DIR (e.g. /mnt, /mnt/ovl-mnt)
282 # so substitute TEST_DIR first
283 sed -e "s,\B$TEST_DIR,TEST_DIR,g" \
284 -e "s,\B$TEST_DEV,TEST_DEV,g"
289 # SCRATCH_DEV may be a prefix of SCRATCH_MNT (e.g. /mnt, /mnt/ovl-mnt)
290 # so substitute SCRATCH_MNT first
291 sed -e "s,\B$SCRATCH_MNT,SCRATCH_MNT,g" \
292 -e "s,\B$SCRATCH_DEV,SCRATCH_DEV,g" \
296 _filter_testdir_and_scratch()
298 # filter both $TEST_DIR and $SCRATCH_MNT, but always filter the longer
299 # string first if the other string is a substring of the first one
300 if echo "$TEST_DIR" | grep -q "$SCRATCH_MNT"; then
301 _filter_test_dir | _filter_scratch
303 _filter_scratch | _filter_test_dir
307 # Turn any device in the scratch pool into SCRATCH_DEV
308 _filter_scratch_pool()
310 FILTER_STRINGS=`echo $SCRATCH_DEV_POOL | sed -e 's/\s\+/\\\|/g'`
311 sed -e "s,$FILTER_STRINGS,SCRATCH_DEV,g"
321 # Long dev name might be split onto its own line; last
322 # seds remove that newline if present
323 _filter_testdir_and_scratch | _filter_spaces | \
324 sed -e 'N;s/SCRATCH_DEV\n/SCRATCH_DEV/g' | \
325 sed -e 'N;s/TEST_DEV\n/TEST_DEV/g'
328 _filter_project_quota()
330 # Project ID 0 is always present on disk but was not reported
331 # until the GETNEXTQUOTA ioctl came into use. Filter it out.
332 # But if you specify a name for ID 0, that means you want to
333 # deal with it by yourself, this function won't filter it out.
334 _filter_quota | grep -v "^\#0 \|^(null) "
337 # Account for different "ln" failure messages
340 sed -e "s,\(creating symbolic link .*\) to .*: ,\1: ," \
341 -e "s,failed to create,creating,"
344 # If given an arg, filter *that* UUID string
345 # Otherwise look for something that looks like a generic UUID
350 sed -e "s/\(uuid[ :=]\+\) $UUID/\1 <EXACTUUID>/i"
352 sed -e "s/\(uuid[ :=]\+\) [0-9a-f-][0-9a-f-]*/\1 <UUID>/ig"
356 # In mixed group the added disks may have zero used size
359 sed -e "s/0\.00/<SIZE>/g"
362 # Filter out sizes like 6.14MB etc
365 sed -e "s/[0-9\.]\+\s\?[b|k|m|g|t][i]\?[b]\?/<SIZE>/ig"
368 # Convert string read from stdin like 128K to bytes and print it to stdout
369 _filter_size_to_bytes()
372 suffix=${size:${#size}-1}
376 m|M) mul=$((1024*1024)) ;;
377 g|G) mul=$((1024*1024*1024)) ;;
378 t|T) mul=$((1024*1024*1024*1024)) ;;
380 echo $((${size:0:${#size}-1}*$mul))
383 # Print trimmed bytes of fstrim
384 # Starting from util-linux v2.23 fstrim usees human readable sizes in
388 egrep -o "[0-9]+ bytes" | $AWK_PROG '{print $1}'
391 # Remove the ending dot appended to mount error message, util-linux 2.30
398 # Older mount output referred to "block device" when mounting RO devices. It's
399 # gone in newer versions. v2.30 changed the output again. This filter is to
400 # unify all read-only mount messages across all util-linux versions.
402 # for a successful ro mount:
403 # ancient: mount: block device <device> is write-protected, mounting read-only
404 # prior to v2.30: mount: <device> is write-protected, mounting read-only
405 # v2.30 and later: mount: <mountpoint>: WARNING: device write-protected, mounted read-only.
408 # ancient (two-line message):
409 # mount: block device <device> is write-protected, mounting read-only
410 # mount: cannot mount block device <device> read-only
411 # prior to v2.30 (two-line message):
412 # mount: <device> is write-protected, mounting read-only
413 # mount: cannot mount <device> read-only
414 # v2.30 and later (single-line message):
415 # mount: <mountpoint>: cannot mount <device> read-only.
417 # a failed rw remount:
418 # ancient: mount: cannot remount block device <device> read-write, is write-protected
419 # prior to v2.30: mount: cannot remount <device> read-write, is write-protected
420 # v2.30 and later: mount: <mountpoint>: cannot remount <device> read-write, is write-protected.
422 # Now use _filter_ro_mount to unify all these differences across old & new
423 # util-linux versions. So the filtered format would be:
425 # successful ro mount:
426 # mount: device write-protected, mounting read-only
429 # mount: device write-protected, mounting read-only
430 # mount: cannot mount device read-only
433 # mount: cannot remount device read-write, is write-protected
436 if (/write-protected, mount.*read-only/) {
437 # filter successful ro mount, and first line of prior to v2.30
438 # format failed ro mount
439 print "mount: device write-protected, mounting read-only\n";
440 } elsif (/mount: .*: cannot mount.*read-only/) {
441 # filter v2.30 format failed ro mount, convert single-line
442 # message to two-line message
443 print "mount: device write-protected, mounting read-only\n";
444 print "mount: cannot mount device read-only\n";
445 } elsif (/^mount: cannot mount .* read-only$/) {
446 # filter prior to v2.30 format failed ro mount
447 print "mount: cannot mount device read-only\n";
448 } elsif (/mount:.* cannot remount .* read-write.*/) {
449 # filter failed rw remount
450 print "mount: cannot remount device read-write, is write-protected\n";
453 }' | _filter_ending_dot
456 # Filter a failed mount output due to EUCLEAN and USTALE, util-linux changed
457 # the message several times.
460 # mount: Structure needs cleaning
462 # mount: mount <device> on <mountpoint> failed: Structure needs cleaning
464 # mount: <mountpoint>: mount(2) system call failed: Structure needs cleaning.
466 # This is also true for ESTALE error. So let's remove all the changing parts
467 # and keep the 'prior to v2.21' format:
468 # mount: Structure needs cleaning
469 # mount: Stale file handle
470 _filter_error_mount()
472 sed -e "s/mount:\(.*failed:\)/mount:/" | _filter_ending_dot
475 # Similar to _filter_error_mount, filter a busy mount output.
476 # Turn both old (prior to util-linux v2.30) and new (v2.30 and later) format to
478 # old: mount: <device> is already mounted or <mountpoint> busy
479 # new: mount: <mountpoint>: <device> already mounted or mount point busy.
480 # filtered: mount: device already mounted or mount point busy
483 sed -e "s/.*: .* already mounted or .* busy/mount: device already mounted or mount point busy/" | \
489 BLOCK_SIZE=$(_get_block_size $SCRATCH_MNT)
490 $AWK_PROG -v block_size=$BLOCK_SIZE '
492 offset = strtonum("0"$1);
493 $1 = sprintf("%o", offset / block_size);
500 # Remove quotes from failed mknod calls. Starting with Coreutils v8.25,
501 # mknod errors print unquoted filenames
504 sed -e "s/mknod: [\`']\(.*\)': File exists/mknod: \1: File exists/"
507 # Remove leading "rename" in "mv -v" output
510 sed -e "s/^renamed //"
515 sed -e '/^lost+found$/d'
520 sed -e "s,$OVL_LOWER,OVL_LOWER,g" \
521 -e "s,$OVL_UPPER,OVL_UPPER,g" \
522 -e "s,$OVL_WORK,OVL_WORK,g"
525 # interpret filefrag output,
526 # eg. "physical 1234, length 10, logical 5678" -> "1234#10#5678"
530 if (/blocks? of (\d+) bytes/) {
534 ($ext, $logical, $physical, $length) =
535 (/^\s*(\d+):\s+(\d+)..\s+\d+:\s+(\d+)..\s+\d+:\s+(\d+):/)
537 ($flags) = /.*:\s*(\S*)$/;
538 print $physical * $blocksize, "#",
539 $length * $blocksize, "#",
540 $logical * $blocksize, "#",
544 # Clean up the extents list output of 'xfs_io -c fiemap', e.g.
547 # 0: [0..79]: 628365312..628365391
549 # 2: [160..319]: 628365472..628365631
551 # 0 79 628365312 628365391
552 # 160 319 628365472 628365631
556 # first_logical_block last_logical_block first_physical_block last_physical_block
558 # Blocks are 512 bytes, and holes are omitted.
560 _filter_xfs_io_fiemap()
562 grep -E '^[[:space:]]+[0-9]+:' \
563 | grep -v '\<hole\>' \
564 | sed -E 's/^[[:space:]]+[0-9]+://' \
568 # We generate WARNINGs on purpose when applications mix buffered/mmap IO with
569 # direct IO on the same file. This is a helper for _check_dmesg() to filter out
571 _filter_aiodio_dmesg()
573 local warn1="WARNING:.*fs/xfs/xfs_file\.c:.*xfs_file_dio_aio_write.*"
574 local warn2="WARNING:.*fs/xfs/xfs_file\.c:.*xfs_file_dio_aio_read.*"
575 local warn3="WARNING:.*fs/xfs/xfs_file\.c:.*xfs_file_read_iter.*"
576 local warn4="WARNING:.*fs/xfs/xfs_file\.c:.*xfs_file_aio_read.*"
577 local warn5="WARNING:.*fs/iomap\.c:.*iomap_dio_rw.*"
578 local warn6="WARNING:.*fs/xfs/xfs_aops\.c:.*__xfs_get_blocks.*"
579 local warn7="WARNING:.*fs/iomap\.c:.*iomap_dio_actor.*"
580 local warn8="WARNING:.*fs/iomap\.c:.*iomap_dio_complete.*"
581 local warn9="WARNING:.*fs/direct-io\.c:.*dio_complete.*"
582 local warn10="WARNING:.*fs/iomap/direct-io\.c:.*iomap_dio_actor.*"
583 sed -e "s#$warn1#Intentional warnings in xfs_file_dio_aio_write#" \
584 -e "s#$warn2#Intentional warnings in xfs_file_dio_aio_read#" \
585 -e "s#$warn3#Intentional warnings in xfs_file_read_iter#" \
586 -e "s#$warn4#Intentional warnings in xfs_file_aio_read#" \
587 -e "s#$warn5#Intentional warnings in iomap_dio_rw#" \
588 -e "s#$warn6#Intentional warnings in __xfs_get_blocks#" \
589 -e "s#$warn7#Intentional warnings in iomap_dio_actor#" \
590 -e "s#$warn8#Intentional warnings in iomap_dio_complete#" \
591 -e "s#$warn9#Intentional warnings in dio_complete#" \
592 -e "s#$warn10#Intentional warnings in iomap_dio_actor#"
595 # We generate assert related WARNINGs on purpose and make sure test doesn't fail
596 # because of these warnings. This is a helper for _check_dmesg() to filter out
598 _filter_assert_dmesg()
600 local warn1="WARNING:.*fs/xfs/xfs_message\.c:.*asswarn.*"
601 local warn2="WARNING:.*fs/xfs/xfs_message\.c:.*assfail.*"
602 sed -e "s#$warn1#Intentional warnings in asswarn#" \
603 -e "s#$warn2#Intentional warnings in assfail#"
606 # make sure this script returns success