e5a65f25091b52e333fd28ffff7e952da969a385
[xfstests-dev.git] / common / rc
1 ##/bin/bash
2 # SPDX-License-Identifier: GPL-2.0+
3 # Copyright (c) 2000-2006 Silicon Graphics, Inc.  All Rights Reserved.
4
5 . common/config
6
7 BC=$(which bc 2> /dev/null) || BC=
8
9 _require_math()
10 {
11         if [ -z "$BC" ]; then
12                 _notrun "this test requires 'bc' tool for doing math operations"
13         fi
14 }
15
16 _math()
17 {
18         [ $# -le 0 ] && return
19         LANG=C echo "scale=0; $@" | "$BC" -q 2> /dev/null
20 }
21
22 dd()
23 {
24         command dd --help 2>&1 | grep noxfer >/dev/null
25         if [ "$?" -eq 0 ]
26             then
27                 command dd status=noxfer $@
28             else
29                 command dd $@
30         fi
31 }
32
33 # Prints the md5 checksum of a given file
34 _md5_checksum()
35 {
36         md5sum $1 | cut -d ' ' -f1
37 }
38
39 # Write a byte into a range of a file
40 _pwrite_byte() {
41         local pattern="$1"
42         local offset="$2"
43         local len="$3"
44         local file="$4"
45         local xfs_io_args="$5"
46
47         $XFS_IO_PROG $xfs_io_args -f -c "pwrite -S $pattern $offset $len" "$file"
48 }
49
50 # mmap-write a byte into a range of a file
51 _mwrite_byte() {
52         local pattern="$1"
53         local offset="$2"
54         local len="$3"
55         local mmap_len="$4"
56         local file="$5"
57
58         $XFS_IO_PROG -f -c "mmap -rw 0 $mmap_len" -c "mwrite -S $pattern $offset $len" "$file"
59 }
60
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
64
65 _ls_l()
66 {
67         ls -l $* | sed "s/\(^[-rwxdlbcpsStT]*\)\. /\1 /" | grep -v 'lost+found'
68 }
69
70 _dump_err()
71 {
72     _err_msg="$*"
73     echo "$_err_msg"
74 }
75
76 _dump_err_cont()
77 {
78     _err_msg="$*"
79     echo -n "$_err_msg"
80 }
81
82 _dump_err2()
83 {
84     _err_msg="$*"
85     >&2 echo "$_err_msg"
86 }
87
88 _log_err()
89 {
90     _err_msg="$*"
91     echo "$_err_msg" | tee -a $seqres.full
92     echo "(see $seqres.full for details)"
93 }
94
95 # make sure we have a standard umask
96 umask 022
97
98 # check for correct setup and source the $FSTYP specific functions now
99 case "$FSTYP" in
100     xfs)
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"
106
107          . ./common/xfs
108          ;;
109     udf)
110          [ "$MKFS_UDF_PROG" = "" ] && _fatal "mkfs_udf/mkudffs not found"
111          ;;
112     btrfs)
113          [ "$MKFS_BTRFS_PROG" = "" ] && _fatal "mkfs.btrfs not found"
114
115          . ./common/btrfs
116          ;;
117     ext4)
118          [ "$MKFS_EXT4_PROG" = "" ] && _fatal "mkfs.ext4 not found"
119          ;;
120     f2fs)
121          [ "$MKFS_F2FS_PROG" = "" ] && _fatal "mkfs.f2fs not found"
122          ;;
123     nfs)
124          . ./common/nfs
125          ;;
126     cifs)
127          ;;
128     9p)
129          ;;
130     ceph)
131          . ./common/ceph
132          ;;
133     glusterfs)
134          ;;
135     overlay)
136          . ./common/overlay
137          ;;
138     reiser4)
139          [ "$MKFS_REISER4_PROG" = "" ] && _fatal "mkfs.reiser4 not found"
140          ;;
141     pvfs2)
142         ;;
143     ubifs)
144         [ "$UBIUPDATEVOL_PROG" = "" ] && _fatal "ubiupdatevol not found"
145         ;;
146 esac
147
148 if [ ! -z "$REPORT_LIST" ]; then
149         . ./common/report
150         _assert_report_list
151 fi
152
153 _get_filesize()
154 {
155     stat -c %s "$1"
156 }
157
158 # Get hugepagesize in bytes
159 _get_hugepagesize()
160 {
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))
166 }
167
168 _mount()
169 {
170     $MOUNT_PROG `_mount_ops_filter $*`
171 }
172
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
175 _get_mount()
176 {
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"
183         fi
184
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 | \
191                                                 cut -d\  -f2-`
192                 fi
193                 MOUNTED_POINT_STACK="$mnt_point $MOUNTED_POINT_STACK"
194         else
195                 return 1
196         fi
197 }
198
199 # Unmount the last mounted mountpoint in MOUNTED_POINT_STACK
200 # and return it to caller
201 _put_mount()
202 {
203         local last_mnt=`echo $MOUNTED_POINT_STACK | awk '{print $1}'`
204
205         if [ -n "$last_mnt" ]; then
206                 $UMOUNT_PROG $last_mnt
207         fi
208         MOUNTED_POINT_STACK=`echo $MOUNTED_POINT_STACK | cut -d\  -f2-`
209 }
210
211 # Unmount all mountpoints in MOUNTED_POINT_STACK and clear the stack
212 _clear_mount_stack()
213 {
214         if [ -n "$MOUNTED_POINT_STACK" ]; then
215                 $UMOUNT_PROG $MOUNTED_POINT_STACK
216         fi
217         MOUNTED_POINT_STACK=""
218 }
219
220 _scratch_options()
221 {
222     local type=$1
223     local rt_opt=""
224     local log_opt=""
225     SCRATCH_OPTIONS=""
226
227     if [ "$FSTYP" != "xfs" ]; then
228         return
229     fi
230
231     case $type in
232     mkfs)
233         SCRATCH_OPTIONS="$SCRATCH_OPTIONS -f"
234         rt_opt="-r"
235         log_opt="-l"
236         ;;
237     mount)
238         rt_opt="-o"
239         log_opt="-o"
240         ;;
241     esac
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"
246 }
247
248 _test_options()
249 {
250     local type=$1
251     local rt_opt=""
252     local log_opt=""
253     TEST_OPTIONS=""
254
255     if [ "$FSTYP" != "xfs" ]; then
256         return
257     fi
258
259     case $type in
260     mkfs)
261         rt_opt="-r"
262         log_opt="-l"
263         ;;
264     mount)
265         rt_opt="-o"
266         log_opt="-o"
267         ;;
268     esac
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"
273 }
274
275 _mount_ops_filter()
276 {
277     local params="$*"
278     local last_index=$(( $# - 1 ))
279
280     [ $last_index -gt 0 ] && shift $last_index
281     local fs_escaped=$1
282
283     echo $params | \
284         $PERL_PROG -ne "s#mtpt=[^,|^\n|^\s]*#mtpt=$fs_escaped\1\2#; print;"
285
286 }
287
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()
292 {
293         echo $MOUNT_OPTIONS $SELINUX_MOUNT_OPTIONS $*
294 }
295
296 _scratch_mount_options()
297 {
298         _scratch_options mount
299
300         echo `_common_dev_mount_options $*` $SCRATCH_OPTIONS \
301                                         $SCRATCH_DEV $SCRATCH_MNT
302 }
303
304 _supports_filetype()
305 {
306         local dir=$1
307
308         local fstyp=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $2}'`
309         case "$fstyp" in
310         xfs)
311                 $XFS_INFO_PROG $dir | grep -q "ftype=1"
312                 ;;
313         ext2|ext3|ext4)
314                 local dev=`$DF_PROG $dir | tail -1 | $AWK_PROG '{print $1}'`
315                 tune2fs -l $dev | grep -q filetype
316                 ;;
317         *)
318                 local testfile=$dir/$$.ftype
319                 touch $testfile
320                 # look for DT_UNKNOWN files
321                 local unknowns=$($here/src/t_dir_type $dir u | wc -l)
322                 rm $testfile
323                 # 0 unknowns is success
324                 return $unknowns
325                 ;;
326         esac
327 }
328
329 # mount scratch device with given options but don't check mount status
330 _try_scratch_mount()
331 {
332         if [ "$FSTYP" == "overlay" ]; then
333                 _overlay_scratch_mount $*
334                 return $?
335         fi
336         _mount -t $FSTYP `_scratch_mount_options $*`
337 }
338
339 # mount scratch device with given options and _fail if mount fails
340 _scratch_mount()
341 {
342         _try_scratch_mount $* || _fail "mount failed"
343 }
344
345 _scratch_mount_idmapped()
346 {
347         local type="$1"
348         local id="$2"
349
350         if [ "$type" = "u" ]; then
351                 # This means root will be able to create files as uid %id in
352                 # the underlying filesystem by going through the idmapped mount.
353                 $here/src/idmapped-mounts/mount-idmapped --map-mount u:0:$id:1 \
354                                                          --map-mount u:$id:0:1 \
355                                                          --map-mount g:0:0:1 \
356                                                          "$SCRATCH_MNT" "$SCRATCH_MNT" || _fail "mount-idmapped failed"
357         elif [ "$type" = "g" ]; then
358                 # This means root will be able to create files as gid %id in
359                 # the underlying filesystem by going through the idmapped mount.
360                 $here/src/idmapped-mounts/mount-idmapped --map-mount g:0:$id:1 \
361                                                          --map-mount g:$id:0:1 \
362                                                          --map-mount u:0:0:1 \
363                                                          "$SCRATCH_MNT" "$SCRATCH_MNT" || _fail "mount-idmapped failed"
364         elif [ "$type" = "b" ]; then
365                 # This means root will be able to create files as uid and gid
366                 # %id in the underlying filesystem by going through the idmapped mount.
367                 $here/src/idmapped-mounts/mount-idmapped --map-mount b:0:$id:1 \
368                                                          --map-mount b:$id:0:1 \
369                                                          "$SCRATCH_MNT" "$SCRATCH_MNT" || _fail "mount-idmapped failed"
370         else
371                 _fail "usage: either \"u\" (uid), \"g\" (gid), or \"b\" (uid and gid) must be specified "
372         fi
373 }
374
375 _scratch_unmount()
376 {
377         case "$FSTYP" in
378         overlay)
379                 _overlay_scratch_unmount
380                 ;;
381         btrfs)
382                 $UMOUNT_PROG $SCRATCH_MNT
383                 ;;
384         *)
385                 $UMOUNT_PROG $SCRATCH_DEV
386                 ;;
387         esac
388 }
389
390 _scratch_umount_idmapped()
391 {
392         $UMOUNT_PROG $SCRATCH_MNT
393 }
394
395 _scratch_remount()
396 {
397     local opts="$1"
398
399     if test -n "$opts"; then
400         _try_scratch_mount "-o remount,$opts"
401     fi
402 }
403
404 _scratch_cycle_mount()
405 {
406     local opts="$1"
407
408     if [ "$FSTYP" = tmpfs ]; then
409         _scratch_remount "$opts"
410         return
411     fi
412     if test -n "$opts"; then
413         opts="-o $opts"
414     fi
415     _scratch_unmount
416     _try_scratch_mount "$opts" || _fail "cycle mount failed"
417 }
418
419 _scratch_shutdown()
420 {
421         if [ $FSTYP = "overlay" ]; then
422                 # In lagacy overlay usage, it may specify directory as
423                 # SCRATCH_DEV, in this case OVL_BASE_SCRATCH_DEV
424                 # will be null, so check OVL_BASE_SCRATCH_DEV before
425                 # running shutdown to avoid shutting down base fs accidently.
426                 if [ -z $OVL_BASE_SCRATCH_DEV ]; then
427                         _fail "_scratch_shutdown: call _require_scratch_shutdown first in test"
428                 else
429                         $here/src/godown $* $OVL_BASE_SCRATCH_MNT
430                 fi
431         else
432                 $here/src/godown $* $SCRATCH_MNT
433         fi
434 }
435
436 # Return a file path that can be used to shut down the scratch filesystem.
437 # Caller should _require_scratch_shutdown before using this.
438 _scratch_shutdown_handle()
439 {
440         if [ $FSTYP = "overlay" ]; then
441                 echo $OVL_BASE_SCRATCH_MNT
442         else
443                 echo $SCRATCH_MNT
444         fi
445 }
446
447 _test_mount()
448 {
449     if [ "$FSTYP" == "overlay" ]; then
450         _overlay_test_mount $*
451         return $?
452     fi
453     _test_options mount
454     _mount -t $FSTYP $TEST_OPTIONS $TEST_FS_MOUNT_OPTS $SELINUX_MOUNT_OPTIONS $* $TEST_DEV $TEST_DIR
455 }
456
457 _test_unmount()
458 {
459         if [ "$FSTYP" == "overlay" ]; then
460                 _overlay_test_unmount
461         else
462                 $UMOUNT_PROG $TEST_DEV
463         fi
464 }
465
466 _test_cycle_mount()
467 {
468     if [ "$FSTYP" = tmpfs ]; then
469         return
470     fi
471     _test_unmount
472     _test_mount
473 }
474
475 _scratch_mkfs_options()
476 {
477     _scratch_options mkfs
478     echo $SCRATCH_OPTIONS $MKFS_OPTIONS $* $SCRATCH_DEV
479 }
480
481 # Do the actual mkfs work on SCRATCH_DEV. Firstly mkfs with both MKFS_OPTIONS
482 # and user specified mkfs options, if that fails (due to conflicts between mkfs
483 # options), do a second mkfs with only user provided mkfs options.
484 #
485 # First param is the mkfs command without any mkfs options and device.
486 # Second param is the filter to remove unnecessary messages from mkfs stderr.
487 # Other extra mkfs options are followed.
488 _scratch_do_mkfs()
489 {
490         local mkfs_cmd=$1
491         local mkfs_filter=$2
492         shift 2
493         local extra_mkfs_options=$*
494         local mkfs_status
495         local tmp=`mktemp -u`
496
497         # save mkfs output in case conflict means we need to run again.
498         # only the output for the mkfs that applies should be shown
499         eval "$mkfs_cmd $MKFS_OPTIONS $extra_mkfs_options $SCRATCH_DEV" \
500                 2>$tmp.mkfserr 1>$tmp.mkfsstd
501         mkfs_status=$?
502
503         # a mkfs failure may be caused by conflicts between $MKFS_OPTIONS and
504         # $extra_mkfs_options
505         if [ $mkfs_status -ne 0 -a -n "$extra_mkfs_options" ]; then
506                 (
507                 echo -n "** mkfs failed with extra mkfs options "
508                 echo "added to \"$MKFS_OPTIONS\" by test $seq **"
509                 echo -n "** attempting to mkfs using only test $seq "
510                 echo "options: $extra_mkfs_options **"
511                 ) >> $seqres.full
512
513                 # running mkfs again. overwrite previous mkfs output files
514                 eval "$mkfs_cmd $extra_mkfs_options $SCRATCH_DEV" \
515                         2>$tmp.mkfserr 1>$tmp.mkfsstd
516                 mkfs_status=$?
517         fi
518
519         # output stored mkfs output, filtering unnecessary output from stderr
520         cat $tmp.mkfsstd
521         eval "cat $tmp.mkfserr | $mkfs_filter" >&2
522
523         rm -f $tmp.mkfserr $tmp.mkfsstd
524         return $mkfs_status
525 }
526
527 _setup_large_ext4_fs()
528 {
529         local fs_size=$1
530         local tmp_dir=/tmp/
531
532         [ "$LARGE_SCRATCH_DEV" != yes ] && return 0
533         [ -z "$SCRATCH_DEV_EMPTY_SPACE" ] && SCRATCH_DEV_EMPTY_SPACE=0
534         [ $SCRATCH_DEV_EMPTY_SPACE -ge $fs_size ] && return 0
535
536         # Default free space in the FS is 50GB, but you can specify more via
537         # SCRATCH_DEV_EMPTY_SPACE
538         local space_to_consume=$(($fs_size - 50*1024*1024*1024 - $SCRATCH_DEV_EMPTY_SPACE))
539
540         # mount the filesystem and create 16TB - 4KB files until we consume
541         # all the necessary space.
542         _try_scratch_mount 2>&1 >$tmp_dir/mnt.err
543         local status=$?
544         if [ $status -ne 0 ]; then
545                 echo "mount failed"
546                 cat $tmp_dir/mnt.err >&2
547                 rm -f $tmp_dir/mnt.err
548                 return $status
549         fi
550         rm -f $tmp_dir/mnt.err
551
552         local file_size=$((16*1024*1024*1024*1024 - 4096))
553         local nfiles=0
554         while [ $space_to_consume -gt $file_size ]; do
555
556                 xfs_io -F -f \
557                         -c "truncate $file_size" \
558                         -c "falloc -k 0 $file_size" \
559                         $SCRATCH_MNT/.use_space.$nfiles 2>&1
560                 status=$?
561                 if [ $status -ne 0 ]; then
562                         break;
563                 fi
564
565                 space_to_consume=$(( $space_to_consume - $file_size ))
566                 nfiles=$(($nfiles + 1))
567         done
568
569         # consume the remaining space.
570         if [ $space_to_consume -gt 0 ]; then
571                 xfs_io -F -f \
572                         -c "truncate $space_to_consume" \
573                         -c "falloc -k 0 $space_to_consume" \
574                         $SCRATCH_MNT/.use_space.$nfiles 2>&1
575                 status=$?
576         fi
577         export NUM_SPACE_FILES=$nfiles
578
579         _scratch_unmount
580         if [ $status -ne 0 ]; then
581                 echo "large file prealloc failed"
582                 cat $tmp_dir/mnt.err >&2
583                 return $status
584         fi
585         return 0
586 }
587
588 _scratch_mkfs_ext4()
589 {
590         local mkfs_cmd="$MKFS_EXT4_PROG -F"
591         local mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \" | grep -v \"^$\""
592         local tmp=`mktemp -u`
593         local mkfs_status
594
595         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
596             $mkfs_cmd -O journal_dev $MKFS_OPTIONS $SCRATCH_LOGDEV && \
597             mkfs_cmd="$mkfs_cmd -J device=$SCRATCH_LOGDEV"
598
599         _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
600         mkfs_status=$?
601
602         if [ $mkfs_status -eq 0 -a "$LARGE_SCRATCH_DEV" = yes ]; then
603                 # manually parse the mkfs output to get the fs size in bytes
604                 local fs_size=`cat $tmp.mkfsstd | awk ' \
605                         /^Block size/ { split($2, a, "="); bs = a[2] ; } \
606                         / inodes, / { blks = $3 } \
607                         /reserved for the super user/ { resv = $1 } \
608                         END { fssize = bs * blks - resv; print fssize }'`
609
610                 _setup_large_ext4_fs $fs_size
611                 mkfs_status=$?
612         fi
613
614         # output mkfs stdout and stderr
615         cat $tmp.mkfsstd
616         cat $tmp.mkfserr >&2
617         rm -f $tmp.mkfserr $tmp.mkfsstd
618
619         return $mkfs_status
620 }
621
622 _ext4_metadump()
623 {
624         local device="$1"
625         local dumpfile="$2"
626         local compressopt="$3"
627
628         test -n "$E2IMAGE_PROG" || _fail "e2image not installed"
629         $E2IMAGE_PROG -Q "$device" "$dumpfile"
630         [ "$compressopt" = "compress" ] && [ -n "$DUMP_COMPRESSOR" ] &&
631                 $DUMP_COMPRESSOR "$dumpfile" &>> "$seqres.full"
632 }
633
634 _test_mkfs()
635 {
636     case $FSTYP in
637     nfs*)
638         # do nothing for nfs
639         ;;
640     cifs)
641         # do nothing for cifs
642         ;;
643     9p)
644         # do nothing for 9p
645         ;;
646     virtiofs)
647         # do nothing for virtiofs
648         ;;
649     ceph)
650         # do nothing for ceph
651         ;;
652     glusterfs)
653         # do nothing for glusterfs
654         ;;
655     overlay)
656         # do nothing for overlay
657         ;;
658     pvfs2)
659         # do nothing for pvfs2
660         ;;
661     udf)
662         $MKFS_UDF_PROG $MKFS_OPTIONS $* $TEST_DEV > /dev/null
663         ;;
664     btrfs)
665         $MKFS_BTRFS_PROG $MKFS_OPTIONS $* $TEST_DEV > /dev/null
666         ;;
667     ext2|ext3|ext4)
668         $MKFS_PROG -t $FSTYP -- -F $MKFS_OPTIONS $* $TEST_DEV
669         ;;
670     *)
671         yes | $MKFS_PROG -t $FSTYP -- $MKFS_OPTIONS $* $TEST_DEV
672         ;;
673     esac
674 }
675
676 _mkfs_dev()
677 {
678     local tmp=`mktemp -u`
679     case $FSTYP in
680     nfs*)
681         # do nothing for nfs
682         ;;
683     9p)
684         # do nothing for 9p
685         ;;
686     virtiofs)
687         # do nothing for virtiofs
688         ;;
689     overlay)
690         # do nothing for overlay
691         ;;
692     pvfs2)
693         # do nothing for pvfs2
694         ;;
695     udf)
696         $MKFS_UDF_PROG $MKFS_OPTIONS $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
697         ;;
698     btrfs)
699         $MKFS_BTRFS_PROG $MKFS_OPTIONS $* 2>$tmp.mkfserr 1>$tmp.mkfsstd
700         ;;
701     ext2|ext3|ext4)
702         $MKFS_PROG -t $FSTYP -- -F $MKFS_OPTIONS $* \
703                 2>$tmp.mkfserr 1>$tmp.mkfsstd
704         ;;
705     xfs)
706         $MKFS_PROG -t $FSTYP -- -f $MKFS_OPTIONS $* \
707                 2>$tmp.mkfserr 1>$tmp.mkfsstd
708         ;;
709     *)
710         yes | $MKFS_PROG -t $FSTYP -- $MKFS_OPTIONS $* \
711                 2>$tmp.mkfserr 1>$tmp.mkfsstd
712         ;;
713     esac
714
715     if [ $? -ne 0 ]; then
716         # output stored mkfs output
717         cat $tmp.mkfserr >&2
718         cat $tmp.mkfsstd
719         status=1
720         exit 1
721     fi
722     rm -f $tmp.mkfserr $tmp.mkfsstd
723 }
724
725 # remove all files in $SCRATCH_MNT, useful when testing on NFS/CIFS
726 _scratch_cleanup_files()
727 {
728         case $FSTYP in
729         overlay)
730                 # Avoid rm -rf /* if we messed up
731                 [ -n "$OVL_BASE_SCRATCH_MNT" ] || return 1
732                 _overlay_base_scratch_mount || return 1
733                 rm -rf $OVL_BASE_SCRATCH_MNT/* || return 1
734                 _overlay_mkdirs $OVL_BASE_SCRATCH_MNT
735                 # leave base fs mouted so tests can setup lower/upper dir files
736                 ;;
737         *)
738                 [ -n "$SCRATCH_MNT" ] || return 1
739                 _scratch_mount
740                 rm -rf $SCRATCH_MNT/*
741                 _scratch_unmount
742                 ;;
743         esac
744 }
745
746 _scratch_mkfs()
747 {
748         local mkfs_cmd=""
749         local mkfs_filter=""
750         local mkfs_status
751
752         case $FSTYP in
753         nfs*|cifs|ceph|overlay|glusterfs|pvfs2|9p|virtiofs)
754                 # unable to re-create this fstyp, just remove all files in
755                 # $SCRATCH_MNT to avoid EEXIST caused by the leftover files
756                 # created in previous runs
757                 _scratch_cleanup_files
758                 return $?
759                 ;;
760         tmpfs)
761                 # do nothing for tmpfs
762                 return 0
763                 ;;
764         ubifs)
765                 # erase the UBI volume; reformated automatically on next mount
766                 $UBIUPDATEVOL_PROG ${SCRATCH_DEV} -t
767                 return 0
768                 ;;
769         ext4)
770                 _scratch_mkfs_ext4 $*
771                 return $?
772                 ;;
773         xfs)
774                 _scratch_mkfs_xfs $*
775                 return $?
776                 ;;
777         udf)
778                 mkfs_cmd="$MKFS_UDF_PROG"
779                 mkfs_filter="cat"
780                 ;;
781         btrfs)
782                 mkfs_cmd="$MKFS_BTRFS_PROG"
783                 mkfs_filter="cat"
784                 ;;
785         ext3)
786                 mkfs_cmd="$MKFS_PROG -t $FSTYP -- -F"
787                 mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
788
789                 # put journal on separate device?
790                 [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
791                 $mkfs_cmd -O journal_dev $MKFS_OPTIONS $SCRATCH_LOGDEV && \
792                 mkfs_cmd="$mkfs_cmd -J device=$SCRATCH_LOGDEV"
793                 ;;
794         ext2)
795                 mkfs_cmd="$MKFS_PROG -t $FSTYP -- -F"
796                 mkfs_filter="grep -v -e ^Warning: -e \"^mke2fs \""
797                 ;;
798         f2fs)
799                 mkfs_cmd="$MKFS_F2FS_PROG"
800                 mkfs_filter="cat"
801                 ;;
802         ocfs2)
803                 mkfs_cmd="yes | $MKFS_PROG -t $FSTYP --"
804                 mkfs_filter="grep -v -e ^mkfs\.ocfs2"
805                 ;;
806         *)
807                 mkfs_cmd="yes | $MKFS_PROG -t $FSTYP --"
808                 mkfs_filter="cat"
809                 ;;
810         esac
811
812         _scratch_do_mkfs "$mkfs_cmd" "$mkfs_filter" $*
813         return $?
814 }
815
816 # Helper function to get a spare or replace-target device from
817 # configured SCRATCH_DEV_POLL, must call _scratch_dev_pool_get()
818 # before _spare_dev_get(). Replace-target-device/Spare-device will
819 # be assigned to SPARE_DEV.
820 # As of now only one replace-target-device/spare-device can be
821 # assigned.
822 #
823 # Usage:
824 #  _scratch_dev_pool_get() <ndevs>
825 #     _spare_dev_get()
826 #     :: do stuff
827 #     _spare_dev_put()
828 #  _scratch_dev_pool_put()
829 #
830 _spare_dev_get()
831 {
832         typeset -p SCRATCH_DEV_POOL_SAVED >/dev/null 2>&1
833         if [ $? -ne 0 ]; then
834                 _fail "Bug: unset val, must call _scratch_dev_pool_get before _spare_dev_get"
835         fi
836
837         if [ -z "$SCRATCH_DEV_POOL_SAVED" ]; then
838                 _fail "Bug: str empty, must call _scratch_dev_pool_get before _spare_dev_get"
839         fi
840
841         # Check if the spare is already assigned
842         typeset -p SPARE_DEV >/dev/null 2>&1
843         if [ $? -eq 0 ]; then
844                 if [ ! -z "$SPARE_DEV" ]; then
845                         _fail "Bug: SPARE_DEV = $SPARE_DEV already assigned"
846                 fi
847         fi
848
849         local ndevs=`echo $SCRATCH_DEV_POOL| wc -w`
850         local config_ndevs=`echo $SCRATCH_DEV_POOL_SAVED| wc -w`
851
852         if [ $ndevs -eq $config_ndevs ]; then
853                 _notrun "All devs used no spare"
854         fi
855         # Get a dev that is not used
856         local -a devs="( $SCRATCH_DEV_POOL_SAVED )"
857         SPARE_DEV=${devs[@]:$ndevs:1}
858         export SPARE_DEV
859 }
860
861 _spare_dev_put()
862 {
863         typeset -p SPARE_DEV >/dev/null 2>&1
864         if [ $? -ne 0 ]; then
865                 _fail "Bug: unset val, must call _spare_dev_get before its put"
866         fi
867
868         if [ -z "$SPARE_DEV" ]; then
869                 _fail "Bug: str empty, must call _spare_dev_get before its put"
870         fi
871
872         export SPARE_DEV=""
873 }
874
875 #
876 # Generally test cases will have..
877 #   _require_scratch_dev_pool X
878 # to make sure it has the enough scratch devices including
879 # replace-target and spare device. Now arg1 here is the
880 # required number of scratch devices by a-test-case excluding
881 # the replace-target and spare device. So this function will
882 # set SCRATCH_DEV_POOL to the specified number of devices.
883 #
884 # Usage:
885 #  _scratch_dev_pool_get() <ndevs>
886 #     :: do stuff
887 #
888 #  _scratch_dev_pool_put()
889 #
890 _scratch_dev_pool_get()
891 {
892         if [ $# -ne 1 ]; then
893                 _fail "Usage: _scratch_dev_pool_get ndevs"
894         fi
895
896         local test_ndevs=$1
897         local config_ndevs=`echo $SCRATCH_DEV_POOL| wc -w`
898         local -a devs="( $SCRATCH_DEV_POOL )"
899
900         typeset -p config_ndevs >/dev/null 2>&1
901         if [ $? -ne 0 ]; then
902                 _fail "Bug: cant find SCRATCH_DEV_POOL ndevs"
903         fi
904
905         if [ $config_ndevs -lt $test_ndevs ]; then
906                 _notrun "Need at least test requested number of ndevs $test_ndevs"
907         fi
908
909         SCRATCH_DEV_POOL_SAVED=${SCRATCH_DEV_POOL}
910         export SCRATCH_DEV_POOL_SAVED
911         SCRATCH_DEV_POOL=${devs[@]:0:$test_ndevs}
912         export SCRATCH_DEV_POOL
913 }
914
915 _scratch_dev_pool_put()
916 {
917         typeset -p SCRATCH_DEV_POOL_SAVED >/dev/null 2>&1
918         if [ $? -ne 0 ]; then
919                 _fail "Bug: unset val, must call _scratch_dev_pool_get before _scratch_dev_pool_put"
920         fi
921
922         if [ -z "$SCRATCH_DEV_POOL_SAVED" ]; then
923                 _fail "Bug: str empty, must call _scratch_dev_pool_get before _scratch_dev_pool_put"
924         fi
925
926         export SCRATCH_DEV_POOL=$SCRATCH_DEV_POOL_SAVED
927         export SCRATCH_DEV_POOL_SAVED=""
928 }
929
930 _scratch_pool_mkfs()
931 {
932     case $FSTYP in
933     btrfs)
934         $MKFS_BTRFS_PROG $MKFS_OPTIONS $* $SCRATCH_DEV_POOL > /dev/null
935         ;;
936     *)
937         echo "_scratch_pool_mkfs is not implemented for $FSTYP" 1>&2
938         ;;
939     esac
940 }
941
942 # Return the amount of free memory available on the system
943 _free_memory_bytes()
944 {
945     free -b | grep ^Mem | awk '{print $4}'
946 }
947
948 _available_memory_bytes()
949 {
950         nf=`free -b | grep ^Mem | awk '{print NF}'`
951         if [[ nf -lt 7 ]]; then
952                 # Doesn't have available field. Fallback.
953                 _free_memory_bytes
954         else
955                 free -b | grep ^Mem | awk '{print $7}'
956         fi
957 }
958
959 # Create fs of certain size on scratch device
960 # _scratch_mkfs_sized <size in bytes> [optional blocksize]
961 _scratch_mkfs_sized()
962 {
963         local fssize=$1
964         local blocksize=$2
965         local def_blksz
966
967         case $FSTYP in
968         xfs)
969                 def_blksz=`echo $MKFS_OPTIONS | sed -rn 's/.*-b ?size= ?+([0-9]+).*/\1/p'`
970                 ;;
971         ext2|ext3|ext4|ext4dev|udf|btrfs|reiser4|ocfs2|reiserfs)
972                 def_blksz=`echo $MKFS_OPTIONS | sed -rn 's/.*-b ?+([0-9]+).*/\1/p'`
973                 ;;
974         jfs)
975                 def_blksz=4096
976                 ;;
977         esac
978
979         [ -n "$def_blksz" ] && blocksize=$def_blksz
980         [ -z "$blocksize" ] && blocksize=4096
981
982         local re='^[0-9]+$'
983         if ! [[ $fssize =~ $re ]] ; then
984                 _notrun "error: _scratch_mkfs_sized: fs size \"$fssize\" not an integer."
985         fi
986         if ! [[ $blocksize =~ $re ]] ; then
987                 _notrun "error: _scratch_mkfs_sized: block size \"$blocksize\" not an integer."
988         fi
989
990         local blocks=`expr $fssize / $blocksize`
991
992         if [ -b "$SCRATCH_DEV" ]; then
993                 local devsize=`blockdev --getsize64 $SCRATCH_DEV`
994                 [ "$fssize" -gt "$devsize" ] && _notrun "Scratch device too small"
995         fi
996
997         if [ "$FSTYP" = "xfs" ] && [ -b "$SCRATCH_RTDEV" ]; then
998                 local rtdevsize=`blockdev --getsize64 $SCRATCH_RTDEV`
999                 [ "$fssize" -gt "$rtdevsize" ] && _notrun "Scratch rt device too small"
1000                 rt_ops="-r size=$fssize"
1001         fi
1002
1003         case $FSTYP in
1004         xfs)
1005                 # don't override MKFS_OPTIONS that set a block size.
1006                 echo $MKFS_OPTIONS |egrep -q "b?size="
1007                 if [ $? -eq 0 ]; then
1008                         _scratch_mkfs_xfs -d size=$fssize $rt_ops
1009                 else
1010                         _scratch_mkfs_xfs -d size=$fssize $rt_ops -b size=$blocksize
1011                 fi
1012                 ;;
1013         ext2|ext3|ext4|ext4dev)
1014                 ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1015                 ;;
1016         gfs2)
1017                 # mkfs.gfs2 doesn't automatically shrink journal files on small
1018                 # filesystems, so the journal files may end up being bigger than the
1019                 # filesystem, which will cause mkfs.gfs2 to fail.  Until that's fixed,
1020                 # shrink the journal size to at most one eigth of the filesystem and at
1021                 # least 8 MiB, the minimum size allowed.
1022                 local min_journal_size=8
1023                 local default_journal_size=128
1024                 if (( fssize/8 / (1024*1024) < default_journal_size )); then
1025                         local journal_size=$(( fssize/8 / (1024*1024) ))
1026                         (( journal_size >= min_journal_size )) || journal_size=$min_journal_size
1027                         MKFS_OPTIONS="-J $journal_size $MKFS_OPTIONS"
1028                 fi
1029                 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS -O -b $blocksize $SCRATCH_DEV $blocks
1030                 ;;
1031         ocfs2)
1032                 yes | ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1033                 ;;
1034         udf)
1035                 $MKFS_UDF_PROG $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1036                 ;;
1037         btrfs)
1038                 local mixed_opt=
1039                 # minimum size that's needed without the mixed option.
1040                 # Ref: btrfs-prog: btrfs_min_dev_size()
1041                 # Non mixed mode is also the default option.
1042                 (( fssize < $((256 * 1024 *1024)) )) && mixed_opt='--mixed'
1043                 $MKFS_BTRFS_PROG $MKFS_OPTIONS $mixed_opt -b $fssize $SCRATCH_DEV
1044                 ;;
1045         jfs)
1046                 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS $SCRATCH_DEV $blocks
1047                 ;;
1048         reiserfs)
1049                 ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV $blocks
1050                 ;;
1051         reiser4)
1052                 # mkfs.resier4 requires size in KB as input for creating filesystem
1053                 $MKFS_REISER4_PROG $MKFS_OPTIONS -y -b $blocksize $SCRATCH_DEV \
1054                                    `expr $fssize / 1024`
1055                 ;;
1056         f2fs)
1057                 # mkfs.f2fs requires # of sectors as an input for the size
1058                 local sector_size=`blockdev --getss $SCRATCH_DEV`
1059                 $MKFS_F2FS_PROG $MKFS_OPTIONS $SCRATCH_DEV `expr $fssize / $sector_size`
1060                 ;;
1061         tmpfs)
1062                 local free_mem=`_free_memory_bytes`
1063                 if [ "$free_mem" -lt "$fssize" ] ; then
1064                    _notrun "Not enough memory ($free_mem) for tmpfs with $fssize bytes"
1065                 fi
1066                 export MOUNT_OPTIONS="-o size=$fssize $TMPFS_MOUNT_OPTIONS"
1067                 ;;
1068         *)
1069                 _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_sized"
1070                 ;;
1071         esac
1072 }
1073
1074 # Emulate an N-data-disk stripe w/ various stripe units
1075 # _scratch_mkfs_geom <sunit bytes> <swidth multiplier> [optional blocksize]
1076 _scratch_mkfs_geom()
1077 {
1078     local sunit_bytes=$1
1079     local swidth_mult=$2
1080     local blocksize=$3
1081     [ -z "$blocksize" ] && blocksize=4096
1082
1083     local sunit_blocks=$(( sunit_bytes / blocksize ))
1084     local swidth_blocks=$(( sunit_blocks * swidth_mult ))
1085
1086     case $FSTYP in
1087     xfs)
1088         if echo "$MKFS_OPTIONS" | egrep -q "b?size="; then
1089                 MKFS_OPTIONS=$(echo "$MKFS_OPTIONS" | sed -r "s/(b?size=)[0-9]+k?/\1$blocksize/")
1090         else
1091                 MKFS_OPTIONS+=" -b size=$blocksize"
1092         fi
1093
1094         if echo "$MKFS_OPTIONS" | egrep -q "(su|sunit|sw|swidth)="; then
1095                 MKFS_OPTIONS=$(echo "$MKFS_OPTIONS" | sed -r \
1096                         -e "s/(su|sunit)=[0-9kmg]+/su=$sunit_bytes/" \
1097                         -e "s/(sw|swidth)=[0-9kmg]+/sw=$swidth_mult/")
1098         else
1099                 MKFS_OPTIONS+=" -d su=$sunit_bytes,sw=$swidth_mult"
1100         fi
1101         ;;
1102     ext4|ext4dev)
1103         MKFS_OPTIONS+=" -b $blocksize -E stride=$sunit_blocks,stripe_width=$swidth_blocks"
1104         ;;
1105     *)
1106         _notrun "can't mkfs $FSTYP with geometry"
1107         ;;
1108     esac
1109     _scratch_mkfs
1110 }
1111
1112 # Create fs of certain blocksize on scratch device
1113 # _scratch_mkfs_blocksized blocksize
1114 _scratch_mkfs_blocksized()
1115 {
1116     local blocksize=$1
1117
1118     local re='^[0-9]+$'
1119     if ! [[ $blocksize =~ $re ]] ; then
1120         _notrun "error: _scratch_mkfs_sized: block size \"$blocksize\" not an integer."
1121     fi
1122
1123     case $FSTYP in
1124     xfs)
1125         _scratch_mkfs_xfs $MKFS_OPTIONS -b size=$blocksize
1126         ;;
1127     ext2|ext3|ext4)
1128         ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize $SCRATCH_DEV
1129         ;;
1130     gfs2)
1131         ${MKFS_PROG} -t $FSTYP $MKFS_OPTIONS -O -b $blocksize $SCRATCH_DEV
1132         ;;
1133     ocfs2)
1134         yes | ${MKFS_PROG} -t $FSTYP -F $MKFS_OPTIONS -b $blocksize -C $blocksize $SCRATCH_DEV
1135         ;;
1136     *)
1137         _notrun "Filesystem $FSTYP not supported in _scratch_mkfs_blocksized"
1138         ;;
1139     esac
1140 }
1141
1142 _scratch_resvblks()
1143 {
1144         case $FSTYP in
1145         xfs)
1146                 xfs_io -x -c "resblks $1" $SCRATCH_MNT
1147                 ;;
1148         *)
1149                 ;;
1150         esac
1151 }
1152
1153
1154 # Repair scratch filesystem.  Returns 0 if the FS is good to go (either no
1155 # errors found or errors were fixed) and nonzero otherwise; also spits out
1156 # a complaint on stderr if fsck didn't tell us that the FS is good to go.
1157 _repair_scratch_fs()
1158 {
1159     case $FSTYP in
1160     xfs)
1161         _scratch_xfs_repair "$@" 2>&1
1162         local res=$?
1163         if [ "$res" -ne 0 ]; then
1164                 echo "xfs_repair returns $res; replay log?"
1165                 _try_scratch_mount
1166                 res=$?
1167                 if [ "$res" -gt 0 ]; then
1168                         echo "mount returns $res; zap log?"
1169                         _scratch_xfs_repair -L 2>&1
1170                         echo "log zap returns $?"
1171                 else
1172                         umount "$SCRATCH_MNT"
1173                 fi
1174                 _scratch_xfs_repair "$@" 2>&1
1175                 res=$?
1176         fi
1177         if [ $res -ne 0 ]; then
1178                 _dump_err2 "xfs_repair failed, err=$res"
1179         fi
1180         return $res
1181         ;;
1182     *)
1183         local dev=$SCRATCH_DEV
1184         local fstyp=$FSTYP
1185         if [ $FSTYP = "overlay" -a -n "$OVL_BASE_SCRATCH_DEV" ]; then
1186                 _repair_overlay_scratch_fs
1187                 # Fall through to repair base fs
1188                 dev=$OVL_BASE_SCRATCH_DEV
1189                 fstyp=$OVL_BASE_FSTYP
1190                 $UMOUNT_PROG $OVL_BASE_SCRATCH_MNT
1191         fi
1192         # Let's hope fsck -y suffices...
1193         fsck -t $fstyp -y $dev 2>&1
1194         local res=$?
1195         case $res in
1196         $FSCK_OK|$FSCK_NONDESTRUCT|$FSCK_REBOOT)
1197                 res=0
1198                 ;;
1199         *)
1200                 _dump_err2 "fsck.$FSTYP failed, err=$res"
1201                 ;;
1202         esac
1203         return $res
1204         ;;
1205     esac
1206 }
1207
1208 _get_pids_by_name()
1209 {
1210     if [ $# -ne 1 ]
1211     then
1212         echo "Usage: _get_pids_by_name process-name" 1>&2
1213         exit 1
1214     fi
1215
1216     # Algorithm ... all ps(1) variants have a time of the form MM:SS or
1217     # HH:MM:SS before the psargs field, use this as the search anchor.
1218     #
1219     # Matches with $1 (process-name) occur if the first psarg is $1
1220     # or ends in /$1 ... the matching uses sed's regular expressions,
1221     # so passing a regex into $1 will work.
1222
1223     ps $PS_ALL_FLAGS \
1224     | sed -n \
1225         -e 's/$/ /' \
1226         -e 's/[         ][      ]*/ /g' \
1227         -e 's/^ //' \
1228         -e 's/^[^ ]* //' \
1229         -e "/[0-9]:[0-9][0-9]  *[^ ]*\/$1 /s/ .*//p" \
1230         -e "/[0-9]:[0-9][0-9]  *$1 /s/ .*//p"
1231 }
1232
1233 #
1234 # _df_device : get an IRIX style df line for a given device
1235 #
1236 #       - returns "" if not mounted
1237 #       - returns fs type in field two (ala IRIX)
1238 #       - joins line together if split by fancy df formatting
1239 #       - strips header etc
1240 #
1241
1242 _df_device()
1243 {
1244     if [ $# -ne 1 ]
1245     then
1246         echo "Usage: _df_device device" 1>&2
1247         exit 1
1248     fi
1249
1250     # Note that we use "==" here so awk doesn't try to interpret an NFS over
1251     # IPv6 server as a regular expression.
1252     $DF_PROG 2>/dev/null | $AWK_PROG -v what=$1 '
1253         ($1==what) && (NF==1) {
1254             v=$1
1255             getline
1256             print v, $0
1257             exit
1258         }
1259         ($1==what) {
1260             print
1261             exit
1262         }
1263     '
1264 }
1265
1266 #
1267 # _df_dir : get an IRIX style df line for device where a directory resides
1268 #
1269 #       - returns fs type in field two (ala IRIX)
1270 #       - joins line together if split by fancy df formatting
1271 #       - strips header etc
1272 #
1273
1274 _df_dir()
1275 {
1276     if [ $# -ne 1 ]
1277     then
1278         echo "Usage: _df_dir device" 1>&2
1279         exit 1
1280     fi
1281
1282     $DF_PROG $1 2>/dev/null | $AWK_PROG -v what=$1 '
1283         NR == 2 && NF==1 {
1284             v=$1
1285             getline
1286             print v, $0;
1287             exit 0
1288         }
1289         NR == 2 {
1290             print;
1291             exit 0
1292         }
1293         {}
1294     '
1295     # otherwise, nada
1296 }
1297
1298 # return percentage used disk space for mounted device
1299
1300 _used()
1301 {
1302     if [ $# -ne 1 ]
1303     then
1304         echo "Usage: _used device" 1>&2
1305         exit 1
1306     fi
1307
1308     _df_device $1 | $AWK_PROG '{ sub("%", "") ; print $6 }'
1309 }
1310
1311 # return the FS type of a mounted device
1312 #
1313 _fs_type()
1314 {
1315     if [ $# -ne 1 ]
1316     then
1317         echo "Usage: _fs_type device" 1>&2
1318         exit 1
1319     fi
1320
1321     #
1322     # The Linux kernel shows NFSv4 filesystems in df output as
1323     # filesystem type nfs4, although we mounted it as nfs earlier.
1324     # Fix the filesystem type up here so that the callers don't
1325     # have to bother with this quirk.
1326     #
1327     _df_device $1 | $AWK_PROG '{ print $2 }' | \
1328         sed -e 's/nfs4/nfs/' -e 's/fuse.glusterfs/glusterfs/'
1329 }
1330
1331 # return the FS mount options of a mounted device
1332 #
1333 # should write a version which just parses the output of mount for IRIX
1334 # compatibility, but since this isn't used at all, at the moment I'll leave
1335 # this for now
1336 #
1337 _fs_options()
1338 {
1339     if [ $# -ne 1 ]
1340     then
1341         echo "Usage: _fs_options device" 1>&2
1342         exit 1
1343     fi
1344
1345     $AWK_PROG -v dev=$1 '
1346         match($1,dev) { print $4 }
1347     ' </proc/mounts
1348 }
1349
1350 # returns device number if a file is a block device
1351 #
1352 _is_block_dev()
1353 {
1354     if [ $# -ne 1 ]
1355     then
1356         echo "Usage: _is_block_dev dev" 1>&2
1357         exit 1
1358     fi
1359
1360     local dev=$1
1361     if [ -L "$dev" ]; then
1362         dev=`readlink -f "$dev"`
1363     fi
1364
1365     if [ -b "$dev" ]; then
1366         $here/src/lstat64 "$dev" | $AWK_PROG '/Device type:/ { print $9 }'
1367     fi
1368 }
1369
1370 # returns device number if a file is a character device
1371 #
1372 _is_char_dev()
1373 {
1374         if [ $# -ne 1 ]; then
1375                 echo "Usage: _is_char_dev dev" 1>&2
1376                 exit 1
1377         fi
1378
1379         local dev=$1
1380         if [ -L "$dev" ]; then
1381                 dev=`readlink -f "$dev"`
1382         fi
1383
1384         if [ -c "$dev" ]; then
1385                 $here/src/lstat64 "$dev" | $AWK_PROG '/Device type:/ { print $9 }'
1386         fi
1387 }
1388
1389 # Do a command, log it to $seqres.full, optionally test return status
1390 # and die if command fails. If called with one argument _do executes the
1391 # command, logs it, and returns its exit status. With two arguments _do
1392 # first prints the message passed in the first argument, and then "done"
1393 # or "fail" depending on the return status of the command passed in the
1394 # second argument. If the command fails and the variable _do_die_on_error
1395 # is set to "always" or the two argument form is used and _do_die_on_error
1396 # is set to "message_only" _do will print an error message to
1397 # $seqres.out and exit.
1398
1399 _do()
1400 {
1401     if [ $# -eq 1 ]; then
1402         local cmd=$1
1403     elif [ $# -eq 2 ]; then
1404         local note=$1
1405         local cmd=$2
1406         echo -n "$note... "
1407     else
1408         echo "Usage: _do [note] cmd" 1>&2
1409         status=1; exit
1410     fi
1411
1412     (eval "echo '---' \"$cmd\"") >>$seqres.full
1413     (eval "$cmd") >$tmp._out 2>&1
1414     local ret=$?
1415     cat $tmp._out >>$seqres.full
1416     rm -f $tmp._out
1417     if [ $# -eq 2 ]; then
1418         if [ $ret -eq 0 ]; then
1419             echo "done"
1420         else
1421             echo "fail"
1422         fi
1423     fi
1424     if [ $ret -ne 0  ] \
1425         && [ "$_do_die_on_error" = "always" \
1426             -o \( $# -eq 2 -a "$_do_die_on_error" = "message_only" \) ]
1427     then
1428         [ $# -ne 2 ] && echo
1429         eval "echo \"$cmd\" failed \(returned $ret\): see $seqres.full"
1430         status=1; exit
1431     fi
1432
1433     return $ret
1434 }
1435
1436 # bail out, setting up .notrun file. Need to kill the filesystem check files
1437 # here, otherwise they are set incorrectly for the next test.
1438 #
1439 _notrun()
1440 {
1441     echo "$*" > $seqres.notrun
1442     echo "$seq not run: $*"
1443     rm -f ${RESULT_DIR}/require_test*
1444     rm -f ${RESULT_DIR}/require_scratch*
1445
1446     status=0
1447     exit
1448 }
1449
1450 # just plain bail out
1451 #
1452 _fail()
1453 {
1454     echo "$*" | tee -a $seqres.full
1455     echo "(see $seqres.full for details)"
1456     status=1
1457     exit 1
1458 }
1459
1460 # tests whether $FSTYP is one of the supported filesystems for a test
1461 #
1462 _supported_fs()
1463 {
1464     local f
1465
1466     for f
1467     do
1468         if [ "$f" = "$FSTYP" -o "$f" = "generic" ]
1469         then
1470             return
1471         fi
1472     done
1473
1474     _notrun "not suitable for this filesystem type: $FSTYP"
1475 }
1476
1477 # check if a FS on a device is mounted
1478 # if so, verify that it is mounted on mount point
1479 # if fstype is given as argument, verify that it is also
1480 # mounted with correct fs type
1481 #
1482 _check_mounted_on()
1483 {
1484         local devname=$1
1485         local dev=$2
1486         local mntname=$3
1487         local mnt=$4
1488         local type=$5
1489
1490         # find $dev as the source, and print result in "$dev $mnt" format
1491         local mount_rec=`findmnt -rncv -S $dev -o SOURCE,TARGET`
1492         [ -n "$mount_rec" ] || return 1 # 1 = not mounted
1493
1494         # if it's mounted, make sure its on $mnt
1495         if [ "$mount_rec" != "$dev $mnt" ]; then
1496                 echo "$devname=$dev is mounted but not on $mntname=$mnt - aborting"
1497                 echo "Already mounted result:"
1498                 echo $mount_rec
1499                 return 2 # 2 = mounted on wrong mnt
1500         fi
1501
1502         if [ -n "$type" -a "`_fs_type $dev`" != "$type" ]; then
1503                 echo "$devname=$dev is mounted but not a type $type filesystem"
1504                 # raw $DF_PROG cannot handle NFS/CIFS/overlay correctly
1505                 _df_device $dev
1506                 return 3 # 3 = mounted as wrong type
1507         fi
1508         return 0 # 0 = mounted as expected
1509 }
1510
1511 # this test needs a scratch partition - check we're ok & unmount it
1512 # No post-test check of the device is required. e.g. the test intentionally
1513 # finishes the test with the filesystem in a corrupt state
1514 _require_scratch_nocheck()
1515 {
1516     case "$FSTYP" in
1517         glusterfs)
1518                 echo $SCRATCH_DEV | egrep -q ":/?" > /dev/null 2>&1
1519                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1520                         _notrun "this test requires a valid \$SCRATCH_DEV"
1521                 fi
1522                 if [ ! -d "$SCRATCH_MNT" ]; then
1523                         _notrun "this test requires a valid \$SCRATCH_MNT"
1524                 fi
1525                 ;;
1526         9p|virtiofs)
1527                 if [ -z "$SCRATCH_DEV" ]; then
1528                         _notrun "this test requires a valid \$SCRATCH_DEV"
1529                 fi
1530                 if [ ! -d "$SCRATCH_MNT" ]; then
1531                         _notrun "this test requires a valid \$SCRATCH_MNT"
1532                 fi
1533                 ;;
1534         nfs*|ceph)
1535                 echo $SCRATCH_DEV | grep -q ":/" > /dev/null 2>&1
1536                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1537                         _notrun "this test requires a valid \$SCRATCH_DEV"
1538                 fi
1539                 if [ ! -d "$SCRATCH_MNT" ]; then
1540                         _notrun "this test requires a valid \$SCRATCH_MNT"
1541                 fi
1542                 ;;
1543         pvfs2)
1544                 echo $SCRATCH_DEV | grep -q "://" > /dev/null 2>&1
1545                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1546                         _notrun "this test requires a valid \$SCRATCH_DEV"
1547                 fi
1548                 if [ ! -d "$SCRATCH_MNT" ]; then
1549                         _notrun "this test requires a valid \$SCRATCH_MNT"
1550                 fi
1551                 ;;
1552         cifs)
1553                 echo $SCRATCH_DEV | grep -q "//" > /dev/null 2>&1
1554                 if [ -z "$SCRATCH_DEV" -o "$?" != "0" ]; then
1555                         _notrun "this test requires a valid \$SCRATCH_DEV"
1556                 fi
1557                 if [ ! -d "$SCRATCH_MNT" ]; then
1558                      _notrun "this test requires a valid \$SCRATCH_MNT"
1559                 fi
1560                 ;;
1561         overlay)
1562                 if [ -z "$OVL_BASE_SCRATCH_MNT" -o ! -d "$OVL_BASE_SCRATCH_MNT" ]; then
1563                         _notrun "this test requires a valid \$OVL_BASE_SCRATCH_MNT as ovl base dir"
1564                 fi
1565                 # if $SCRATCH_MNT is derived from $OVL_BASE_SCRATCH_MNT then
1566                 # don't check $SCRATCH_MNT dir here because base fs may not be mounted
1567                 # and we will create the mount point anyway on _overlay_mount
1568                 if [ "$SCRATCH_MNT" != "$OVL_BASE_SCRATCH_MNT/$OVL_MNT" -a ! -d "$SCRATCH_MNT" ]; then
1569                         _notrun "this test requires a valid \$SCRATCH_MNT"
1570                 fi
1571                 ;;
1572         tmpfs)
1573                 if [ -z "$SCRATCH_DEV" -o ! -d "$SCRATCH_MNT" ];
1574                 then
1575                     _notrun "this test requires a valid \$SCRATCH_MNT and unique \$SCRATCH_DEV"
1576                 fi
1577                 ;;
1578         ubifs)
1579                 # ubifs needs an UBI volume. This will be a char device, not a block device.
1580                 if [ ! -c "$SCRATCH_DEV" ]; then
1581                         _notrun "this test requires a valid UBI volume for \$SCRATCH_DEV"
1582                 fi
1583                 if [ ! -d "$SCRATCH_MNT" ]; then
1584                         _notrun "this test requires a valid \$SCRATCH_MNT"
1585                 fi
1586                 ;;
1587         *)
1588                  if [ -z "$SCRATCH_DEV" -o "`_is_block_dev "$SCRATCH_DEV"`" = "" ]
1589                  then
1590                      _notrun "this test requires a valid \$SCRATCH_DEV"
1591                  fi
1592                  if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1593                  then
1594                      _notrun "this test requires a valid \$SCRATCH_DEV"
1595                  fi
1596                 if [ ! -d "$SCRATCH_MNT" ]
1597                 then
1598                      _notrun "this test requires a valid \$SCRATCH_MNT"
1599                 fi
1600                  ;;
1601     esac
1602
1603     _check_mounted_on SCRATCH_DEV $SCRATCH_DEV SCRATCH_MNT $SCRATCH_MNT
1604     local err=$?
1605     [ $err -le 1 ] || exit 1
1606     if [ $err -eq 0 ]
1607     then
1608         # if it's mounted, unmount it
1609         if ! _scratch_unmount
1610         then
1611             echo "failed to unmount $SCRATCH_DEV"
1612             exit 1
1613         fi
1614     fi
1615     rm -f ${RESULT_DIR}/require_scratch
1616 }
1617
1618 # we need the scratch device and it should be checked post test.
1619 _require_scratch()
1620 {
1621         _require_scratch_nocheck
1622         touch ${RESULT_DIR}/require_scratch
1623 }
1624
1625 # require a scratch dev of a minimum size (in kb)
1626 _require_scratch_size()
1627 {
1628         [ $# -eq 1 ] || _fail "_require_scratch_size: expected size param"
1629
1630         _require_scratch
1631         local devsize=`_get_device_size $SCRATCH_DEV`
1632         [ $devsize -lt $1 ] && _notrun "scratch dev too small"
1633 }
1634
1635 # require a scratch dev of a minimum size (in kb) and should not be checked
1636 # post test
1637 _require_scratch_size_nocheck()
1638 {
1639         [ $# -eq 1 ] || _fail "_require_scratch_size: expected size param"
1640
1641         _require_scratch_nocheck
1642         local devsize=`_get_device_size $SCRATCH_DEV`
1643         [ $devsize -lt $1 ] && _notrun "scratch dev too small"
1644 }
1645
1646 # Require scratch fs which supports >16T of filesystem size.
1647 # _require_scratch must be called before this function is called.
1648 _require_scratch_16T_support()
1649 {
1650         case $FSTYP in
1651         ext2|ext3|f2fs)
1652                 _notrun "$FSTYP doesn't support >16T filesystem"
1653                 ;;
1654         ext4)
1655                 _scratch_mkfs >> $seqres.full 2>&1
1656                 _scratch_mount
1657                 local blocksize=$(_get_block_size $SCRATCH_MNT)
1658                 if [ $blocksize -lt 4096 ]; then
1659                         _notrun "This test requires >16T fs support"
1660                 fi
1661                 _scratch_unmount
1662                 ;;
1663         *)
1664                 ;;
1665         esac
1666 }
1667
1668 # this test needs a test partition - check we're ok & mount it
1669 #
1670 _require_test()
1671 {
1672     case "$FSTYP" in
1673         glusterfs)
1674                 echo $TEST_DEV | egrep -q ":/?" > /dev/null 2>&1
1675                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1676                         _notrun "this test requires a valid \$TEST_DEV"
1677                 fi
1678                 if [ ! -d "$TEST_DIR" ]; then
1679                         _notrun "this test requires a valid \$TEST_DIR"
1680                 fi
1681                 ;;
1682         9p|virtiofs)
1683                 if [ -z "$TEST_DEV" ]; then
1684                         _notrun "this test requires a valid \$TEST_DEV"
1685                 fi
1686                 if [ ! -d "$TEST_DIR" ]; then
1687                         _notrun "this test requires a valid \$TEST_DIR"
1688                 fi
1689                 ;;
1690         nfs*|ceph)
1691                 echo $TEST_DEV | grep -q ":/" > /dev/null 2>&1
1692                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1693                         _notrun "this test requires a valid \$TEST_DEV"
1694                 fi
1695                 if [ ! -d "$TEST_DIR" ]; then
1696                         _notrun "this test requires a valid \$TEST_DIR"
1697                 fi
1698                 ;;
1699         cifs)
1700                 echo $TEST_DEV | grep -q "//" > /dev/null 2>&1
1701                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1702                         _notrun "this test requires a valid \$TEST_DEV"
1703                 fi
1704                 if [ ! -d "$TEST_DIR" ]; then
1705                      _notrun "this test requires a valid \$TEST_DIR"
1706                 fi
1707                 ;;
1708         pvfs2)
1709                 echo $TEST_DEV | grep -q "://" > /dev/null 2>&1
1710                 if [ -z "$TEST_DEV" -o "$?" != "0" ]; then
1711                         _notrun "this test requires a valid \$TEST_DIR"
1712                 fi
1713                 if [ ! -d "$TEST_DIR" ]; then
1714                         _notrun "this test requires a valid \$TEST_DIR"
1715                 fi
1716                 ;;
1717         overlay)
1718                 if [ -z "$OVL_BASE_TEST_DIR" -o ! -d "$OVL_BASE_TEST_DIR" ]; then
1719                         _notrun "this test requires a valid \$TEST_DIR as ovl base dir"
1720                 fi
1721                 if [ ! -d "$TEST_DIR" ]; then
1722                         _notrun "this test requires a valid \$TEST_DIR"
1723                 fi
1724                 ;;
1725         tmpfs)
1726                 if [ -z "$TEST_DEV" -o ! -d "$TEST_DIR" ];
1727                 then
1728                     _notrun "this test requires a valid \$TEST_DIR and unique $TEST_DEV"
1729                 fi
1730                 ;;
1731         ubifs)
1732                 # ubifs needs an UBI volume. This will be a char device, not a block device.
1733                 if [ ! -c "$TEST_DEV" ]; then
1734                         _notrun "this test requires a valid UBI volume for \$TEST_DEV"
1735                 fi
1736                 if [ ! -d "$TEST_DIR" ]; then
1737                         _notrun "this test requires a valid \$TEST_DIR"
1738                 fi
1739                 ;;
1740         *)
1741                  if [ -z "$TEST_DEV" ] || [ "`_is_block_dev "$TEST_DEV"`" = "" ]
1742                  then
1743                      _notrun "this test requires a valid \$TEST_DEV"
1744                  fi
1745                  if [ "`_is_block_dev "$SCRATCH_DEV"`" = "`_is_block_dev "$TEST_DEV"`" ]
1746                  then
1747                      _notrun "this test requires a valid \$TEST_DEV"
1748                  fi
1749                 if [ ! -d "$TEST_DIR" ]
1750                 then
1751                      _notrun "this test requires a valid \$TEST_DIR"
1752                 fi
1753                  ;;
1754     esac
1755
1756     _check_mounted_on TEST_DEV $TEST_DEV TEST_DIR $TEST_DIR
1757     local err=$?
1758     [ $err -le 1 ] || exit 1
1759     if [ $err -ne 0 ]
1760     then
1761         if ! _test_mount
1762         then
1763                 echo "!!! failed to mount $TEST_DEV on $TEST_DIR"
1764                 exit 1
1765         fi
1766     fi
1767     touch ${RESULT_DIR}/require_test
1768 }
1769
1770 _has_logdev()
1771 {
1772         local ret=0
1773         [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && ret=1
1774         [ "$USE_EXTERNAL" != yes ] && ret=1
1775
1776         return $ret
1777 }
1778
1779 # this test needs a logdev
1780 #
1781 _require_logdev()
1782 {
1783     [ -z "$SCRATCH_LOGDEV" -o ! -b "$SCRATCH_LOGDEV" ] && \
1784         _notrun "This test requires a valid \$SCRATCH_LOGDEV"
1785     [ "$USE_EXTERNAL" != yes ] && \
1786         _notrun "This test requires USE_EXTERNAL to be enabled"
1787
1788     # ensure its not mounted
1789     $UMOUNT_PROG $SCRATCH_LOGDEV 2>/dev/null
1790 }
1791
1792 # this test requires loopback device support
1793 #
1794 _require_loop()
1795 {
1796     modprobe loop >/dev/null 2>&1
1797     if grep loop /proc/devices >/dev/null 2>&1
1798     then
1799         :
1800     else
1801         _notrun "This test requires loopback device support"
1802     fi
1803 }
1804
1805 # this test requires kernel support for a secondary filesystem
1806 #
1807 _require_extra_fs()
1808 {
1809         modprobe "$1" >/dev/null 2>&1
1810         grep -q -w "$1" /proc/filesystems ||
1811                 _notrun "this test requires $1 support"
1812 }
1813
1814 # this test requires that (large) loopback device files are not in use
1815 #
1816 _require_no_large_scratch_dev()
1817 {
1818     [ "$LARGE_SCRATCH_DEV" = yes ] && \
1819         _notrun "Large filesystem testing in progress, skipped this test"
1820 }
1821
1822 # this test requires that a realtime subvolume is in use, and
1823 # that the kernel supports realtime as well.
1824 #
1825 _require_realtime()
1826 {
1827     [ "$USE_EXTERNAL" = yes ] || \
1828         _notrun "External volumes not in use, skipped this test"
1829     [ "$SCRATCH_RTDEV" = "" ] && \
1830         _notrun "Realtime device required, skipped this test"
1831 }
1832
1833 # This test requires that a realtime subvolume is not in use
1834 #
1835 _require_no_realtime()
1836 {
1837         [ "$USE_EXTERNAL" = "yes" ] && [ -n "$SCRATCH_RTDEV" ] && \
1838                 _notrun "Test not compatible with realtime subvolumes, skipped this test"
1839 }
1840
1841 # this test requires that a specified command (executable) exists
1842 # $1 - command, $2 - name for error message
1843 #
1844 # Note: the command string might have parameters, so strip them before checking
1845 # whether it is executable.
1846 _require_command()
1847 {
1848         if [ $# -eq 2 ]; then
1849                 local name="$2"
1850         elif [ $# -eq 1 ]; then
1851                 local name="$1"
1852         else
1853                 _fail "usage: _require_command <command> [<name>]"
1854         fi
1855
1856         local command=`echo "$1" | awk '{ print $1 }'`
1857         if [ ! -x "$command" ]; then
1858                 _notrun "$name utility required, skipped this test"
1859         fi
1860 }
1861
1862 # this test requires the device to be valid block device
1863 # $1 - device
1864 _require_block_device()
1865 {
1866         if [ -z "$1" ]; then
1867                 echo "Usage: _require_block_device <dev>" 1>&2
1868                 exit 1
1869         fi
1870         if [ "`_is_block_dev "$1"`" == "" ]; then
1871                 _notrun "require $1 to be valid block disk"
1872         fi
1873 }
1874
1875 # this test requires a path to refere to a local block or character device
1876 # $1 - device
1877 _require_local_device()
1878 {
1879         if [ -z "$1" ]; then
1880                 echo "Usage: _require_local_device <dev>" 1>&2
1881                 exit 1
1882         fi
1883         if [ "`_is_block_dev "$1"`" != "" ]; then
1884                 return 0
1885         fi
1886         if [ "`_is_char_dev "$1"`" != "" ]; then
1887                 return 0
1888         fi
1889         _notrun "require $1 to be local device"
1890 }
1891
1892 # brd based ram disks erase the device when they receive a flush command when no
1893 # active references are present. This causes problems for DM devices sitting on
1894 # top of brd devices as DM doesn't hold active references to the brd device.
1895 _require_sane_bdev_flush()
1896 {
1897         echo $1 | grep -q "^/dev/ram[0-9]\+$"
1898         if [ $? -eq 0 ]; then
1899                 _notrun "This test requires a sane block device flush"
1900         fi
1901 }
1902
1903 # this test requires a specific device mapper target
1904 _require_dm_target()
1905 {
1906         local target=$1
1907
1908         # require SCRATCH_DEV to be a valid block device with sane BLKFLSBUF
1909         # behaviour
1910         _require_block_device $SCRATCH_DEV
1911         _require_sane_bdev_flush $SCRATCH_DEV
1912         _require_command "$DMSETUP_PROG" dmsetup
1913
1914         _normalize_mount_options | egrep -q "dax(=always| |$)" || \
1915                         test -e "/sys/block/$(_short_dev $SCRATCH_DEV)/dax"
1916         if [ $? -eq 0 ]; then
1917                 case $target in
1918                 stripe|linear|log-writes)
1919                         ;;
1920                 *)
1921                         _notrun "Cannot run tests with DAX on $target devices."
1922                         ;;
1923                 esac
1924         fi
1925
1926         modprobe dm-$target >/dev/null 2>&1
1927
1928         $DMSETUP_PROG targets 2>&1 | grep -q ^$target
1929         if [ $? -ne 0 ]; then
1930                 _notrun "This test requires dm $target support"
1931         fi
1932 }
1933
1934 # this test requires the ext4 kernel support crc feature on scratch device
1935 #
1936 _require_scratch_ext4_crc()
1937 {
1938         _scratch_mkfs_ext4 >/dev/null 2>&1
1939         dumpe2fs -h $SCRATCH_DEV 2> /dev/null | grep -q metadata_csum || _notrun "metadata_csum not supported by this filesystem"
1940         _try_scratch_mount >/dev/null 2>&1 \
1941            || _notrun "Kernel doesn't support metadata_csum feature"
1942         _scratch_unmount
1943 }
1944
1945 # Check whether the specified feature whether it is supported by
1946 # mkfs.ext4 and the kernel.
1947 _require_scratch_ext4_feature()
1948 {
1949     if [ -z "$1" ]; then
1950         echo "Usage: _require_scratch_ext4_feature feature"
1951         exit 1
1952     fi
1953     $MKFS_EXT4_PROG -F $MKFS_OPTIONS -O "$1" \
1954                     $SCRATCH_DEV 512m >/dev/null 2>&1 \
1955         || _notrun "mkfs.ext4 doesn't support $1 feature"
1956     _try_scratch_mount >/dev/null 2>&1 \
1957         || _notrun "Kernel doesn't support the ext4 feature(s): $1"
1958     _scratch_unmount
1959 }
1960
1961 # this test requires that external log/realtime devices are not in use
1962 #
1963 _require_nonexternal()
1964 {
1965     [ "$USE_EXTERNAL" = yes ] && \
1966         _notrun "External device testing in progress, skipped this test"
1967 }
1968
1969 # this test requires that the kernel supports asynchronous I/O
1970 _require_aio()
1971 {
1972         $here/src/feature -A
1973         case $? in
1974         0)
1975                 ;;
1976         1)
1977                 _notrun "kernel does not support asynchronous I/O"
1978                 ;;
1979         *)
1980                 _fail "unexpected error testing for asynchronous I/O support"
1981                 ;;
1982         esac
1983 }
1984
1985 # this test requires that a (specified) aio-dio executable exists
1986 # and that the kernel supports asynchronous I/O.
1987 # $1 - command (optional)
1988 #
1989 _require_aiodio()
1990 {
1991     if [ -z "$1" ]
1992     then
1993         AIO_TEST=$here/src/aio-dio-regress/aiodio_sparse2
1994         [ -x $AIO_TEST ] || _notrun "aio-dio utilities required"
1995     else
1996         AIO_TEST=$here/src/aio-dio-regress/$1
1997         [ -x $AIO_TEST ] || _notrun "$AIO_TEST not built"
1998     fi
1999     _require_aio
2000     _require_odirect
2001 }
2002
2003 # this test requires that the kernel supports IO_URING
2004 _require_io_uring()
2005 {
2006         $here/src/feature -R
2007         case $? in
2008         0)
2009                 ;;
2010         1)
2011                 _notrun "kernel does not support IO_URING"
2012                 ;;
2013         *)
2014                 _fail "unexpected error testing for IO_URING support"
2015                 ;;
2016         esac
2017 }
2018
2019 # test whether the mount_setattr syscall is available
2020 _require_mount_setattr()
2021 {
2022         $here/src/feature -r
2023         case $? in
2024         0)
2025                 ;;
2026         1)
2027                 _notrun "kernel does not support mount_setattr syscall"
2028                 ;;
2029         *)
2030                 _fail "unexpected error testing for mount_setattr support"
2031                 ;;
2032         esac
2033 }
2034
2035 # test whether idmapped mounts are supported
2036 _require_idmapped_mounts()
2037 {
2038         IDMAPPED_MOUNTS_TEST=$here/src/idmapped-mounts/idmapped-mounts
2039         [ -x $IDMAPPED_MOUNTS_TEST ] || _notrun "idmapped-mounts utilities required"
2040
2041         _require_mount_setattr
2042
2043         $here/src/idmapped-mounts/idmapped-mounts --supported \
2044                 --device "$TEST_DEV" \
2045                 --mount "$TEST_DIR" \
2046                 --fstype "$FSTYP"
2047
2048         if [ $? -ne 0 ]; then
2049                 _notrun "idmapped-mounts not support by $FSTYP"
2050         fi
2051 }
2052
2053 # this test requires that a test program exists under src/
2054 # $1 - command (require)
2055 #
2056 _require_test_program()
2057 {
2058     local prog=$here/src/$1
2059     [ -x $prog ] || _notrun "$prog not built"
2060 }
2061
2062 # run an aio-dio program
2063 # $1 - command
2064 _run_aiodio()
2065 {
2066     if [ -z "$1" ]
2067     then
2068         echo "usage: _run_aiodio command_name" 2>&1
2069         status=1; exit 1
2070     fi
2071
2072     _require_aiodio $1
2073
2074     local testtemp=$TEST_DIR/aio-testfile
2075     rm -f $testtemp
2076     $AIO_TEST $testtemp 2>&1
2077     status=$?
2078     rm -f $testtemp
2079
2080     return $status
2081 }
2082
2083 _require_timestamp_range()
2084 {
2085         local device=${1:-$TEST_DEV}
2086
2087         local tsmin tsmax
2088         read tsmin tsmax <<<$(_filesystem_timestamp_range $device)
2089         if [ $tsmin -eq -1 -a $tsmax -eq -1 ]; then
2090                 _notrun "filesystem $FSTYP timestamp bounds are unknown"
2091         fi
2092
2093         # expect console warning from rw scratch mount if fs limit is near
2094         if [ $tsmax -le $((1<<31)) ] && \
2095                 ! _check_dmesg_for "filesystem being mounted at .* supports timestamps until"
2096         then
2097                 _notrun "Kernel does not support timestamp limits"
2098         fi
2099 }
2100
2101 _filesystem_timestamp_range()
2102 {
2103         local device=${1:-$TEST_DEV}
2104         local fstyp=${2:-$FSTYP}
2105         u32max=$(((1<<32)-1))
2106         s32min=-$((1<<31))
2107         s32max=$(((1<<31)-1))
2108         s64max=$(((1<<63)-1))
2109         s64min=$((1<<63))
2110
2111         case $fstyp in
2112         ext2)
2113                 echo "$s32min $s32max"
2114                 ;;
2115         ext3|ext4)
2116                 if [ $(dumpe2fs -h $device 2>/dev/null | grep "Inode size:" | cut -d: -f2) -gt 128 ]; then
2117                         printf "%d %d\n" $s32min 0x37fffffff
2118                 else
2119                         echo "$s32min $s32max"
2120                 fi
2121                 ;;
2122
2123         jfs)
2124                 echo "0 $u32max"
2125                 ;;
2126         xfs)
2127                 echo "$s32min $s32max"
2128                 ;;
2129         btrfs)
2130                 echo "$s64min $s64max"
2131                 ;;
2132         overlay)
2133                 if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
2134                         _filesystem_timestamp_range $OVL_BASE_TEST_DEV $OVL_BASE_FSTYP
2135                 else
2136                         echo "-1 -1"
2137                 fi
2138                 ;;
2139         *)
2140                 echo "-1 -1"
2141                 ;;
2142         esac
2143 }
2144
2145 # indicate whether YP/NIS is active or not
2146 #
2147 _yp_active()
2148 {
2149         local dn
2150         dn=$(domainname 2>/dev/null)
2151         local ypcat=$(type -P ypcat)
2152         local rpcinfo=$(type -P rpcinfo)
2153         test -n "${dn}" -a "${dn}" != "(none)" -a "${dn}" != "localdomain" -a -n "${ypcat}" -a -n "${rpcinfo}" && \
2154                 "${rpcinfo}" -p localhost 2>/dev/null | grep -q ypbind
2155         echo $?
2156 }
2157
2158 # cat the password file
2159 #
2160 _cat_passwd()
2161 {
2162         [ $(_yp_active) -eq 0 ] && ypcat passwd
2163         cat /etc/passwd
2164 }
2165
2166 # cat the group file
2167 #
2168 _cat_group()
2169 {
2170         [ $(_yp_active) -eq 0 ] && ypcat group
2171         cat /etc/group
2172 }
2173
2174 # check for a user on the machine, fsgqa as default
2175 #
2176 _require_user()
2177 {
2178     qa_user=fsgqa
2179     if [ -n "$1" ];then
2180         qa_user=$1
2181     fi
2182     _cat_passwd | grep -q $qa_user
2183     [ "$?" == "0" ] || _notrun "$qa_user user not defined."
2184     echo /bin/true | su $qa_user
2185     [ "$?" == "0" ] || _notrun "$qa_user cannot execute commands."
2186 }
2187
2188 # check for a group on the machine, fsgqa as default
2189 #
2190 _require_group()
2191 {
2192     qa_group=fsgqa
2193     if [ -n "$1" ];then
2194         qa_group=$1
2195     fi
2196     _cat_group | grep -q $qa_group
2197     [ "$?" == "0" ] || _notrun "$qa_group group not defined."
2198 }
2199
2200 _filter_user_do()
2201 {
2202         perl -ne "
2203 s,.*Permission\sdenied.*,Permission denied,;
2204 s,.*no\saccess\sto\stty.*,,;
2205 s,.*no\sjob\scontrol\sin\sthis\sshell.*,,;
2206 s,^\s*$,,;
2207         print;"
2208 }
2209
2210 _user_do()
2211 {
2212         echo $1 | su -s /bin/bash $qa_user 2>&1 | _filter_user_do
2213 }
2214
2215 _require_xfs_io_command()
2216 {
2217         if [ -z "$1" ]
2218         then
2219                 echo "Usage: _require_xfs_io_command command [switch]" 1>&2
2220                 exit 1
2221         fi
2222         local command=$1
2223         shift
2224         local param="$*"
2225         local param_checked=""
2226         local opts=""
2227         local attr_info=""
2228
2229         local testfile=$TEST_DIR/$$.xfs_io
2230         local testio
2231         case $command in
2232         "lsattr")
2233                 # Test xfs_io lsattr support and filesystem FS_IOC_FSSETXATTR
2234                 # support.
2235                 testio=`$XFS_IO_PROG -F -f -c "lsattr $param" $testfile 2>&1`
2236                 param_checked="$param"
2237                 ;;
2238         "chattr")
2239                 local testdir=$TEST_DIR/$$.attr_dir
2240                 mkdir $TEST_DIR/$$.attr_dir
2241                 if [ -z "$param" ]; then
2242                         param=s
2243                 fi
2244                 # Test xfs_io chattr support AND
2245                 # filesystem FS_IOC_FSSETXATTR support
2246                 # 'tPnE' flags are only valid for a directory so check them on a directory.
2247                 if echo "$param" | egrep -q 't|P|n|E'; then
2248                         testio=`$XFS_IO_PROG -F -c "chattr +$param" $testdir 2>&1`
2249                         attr_info=`$XFS_IO_PROG -F -r -c "lsattr" $testdir | awk '{print $1}'`
2250                         $XFS_IO_PROG -F -r -c "chattr -$param" $testdir 2>&1
2251                 else
2252                         testio=`$XFS_IO_PROG -F -f -c "chattr +$param" $testfile 2>&1`
2253                         attr_info=`$XFS_IO_PROG -F -r -c "lsattr" $testfile | awk '{print $1}'`
2254                         $XFS_IO_PROG -F -r -c "chattr -$param" $testfile 2>&1
2255                 fi
2256                 param_checked="+$param"
2257                 rm -rf $testdir 2>&1 > /dev/null
2258                 ;;
2259         "chproj")
2260                 testio=`$XFS_IO_PROG -F -f -c "chproj 0" $testfile 2>&1`
2261                 ;;
2262         "copy_range")
2263                 local testcopy=$TEST_DIR/$$.copy.xfs_io
2264                 local copy_opts=$testfile
2265                 if [ "$param" == "-f" ]; then
2266                         # source file is the open destination file
2267                         testcopy=$testfile
2268                         copy_opts="0 -d 4k -l 4k"
2269                 fi
2270                 $XFS_IO_PROG -F -f -c "pwrite 0 4k" $testfile > /dev/null 2>&1
2271                 testio=`$XFS_IO_PROG -F -f -c "copy_range $param $copy_opts" $testcopy 2>&1`
2272                 rm -f $testcopy > /dev/null 2>&1
2273                 param_checked="$param"
2274                 ;;
2275         "falloc" )
2276                 testio=`$XFS_IO_PROG -F -f -c "falloc $param 0 1m" $testfile 2>&1`
2277                 param_checked="$param"
2278                 ;;
2279         "fpunch" | "fcollapse" | "zero" | "fzero" | "finsert" | "funshare")
2280                 local blocksize=$(_get_block_size $TEST_DIR)
2281                 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 $((5 * $blocksize))" \
2282                         -c "fsync" -c "$command $blocksize $((2 * $blocksize))" \
2283                         $testfile 2>&1`
2284                 ;;
2285         "fiemap")
2286                 # If 'ranged' is passed as argument then we check to see if fiemap supports
2287                 # ranged query params
2288                 if echo "$param" | grep -q "ranged"; then
2289                         param=$(echo "$param" | sed "s/ranged//")
2290                         $XFS_IO_PROG -c "help fiemap" | grep -q "\[offset \[len\]\]"
2291                         [ $? -eq 0 ] || _notrun "xfs_io $command ranged support is missing"
2292                 fi
2293                 testio=`$XFS_IO_PROG -F -f -c "pwrite 0 20k" -c "fsync" \
2294                         -c "fiemap -v $param" $testfile 2>&1`
2295                 param_checked="$param"
2296                 ;;
2297         "flink")
2298                 local testlink=$TEST_DIR/$$.link.xfs_io
2299                 testio=`$XFS_IO_PROG -F -f -c "flink $testlink" $testfile 2>&1`
2300                 rm -f $testlink > /dev/null 2>&1
2301                 ;;
2302         "-T")
2303                 # Check O_TMPFILE support in xfs_io, kernel and fs
2304                 testio=`$XFS_IO_PROG -T -c quit $TEST_DIR 2>&1`
2305                 echo $testio | egrep -q "invalid option|Is a directory" && \
2306                         _notrun "xfs_io $command support is missing"
2307                 echo $testio | grep -q "Operation not supported" && \
2308                         _notrun "O_TMPFILE is not supported"
2309                 ;;
2310         "fsmap")
2311                 testio=`$XFS_IO_PROG -f -c "fsmap" $testfile 2>&1`
2312                 echo $testio | grep -q "Inappropriate ioctl" && \
2313                         _notrun "xfs_io $command support is missing"
2314                 ;;
2315         "label")
2316                 testio=`$XFS_IO_PROG -c "label" $TEST_DIR 2>&1`
2317                 ;;
2318         "open")
2319                 # -c "open $f" is broken in xfs_io <= 4.8. Along with the fix,
2320                 # a new -C flag was introduced to execute one shot commands.
2321                 # Check for -C flag support as an indication for the bug fix.
2322                 testio=`$XFS_IO_PROG -F -f -C "open $testfile" $testfile 2>&1`
2323                 echo $testio | grep -q "invalid option" && \
2324                         _notrun "xfs_io $command support is missing"
2325                 ;;
2326         "pwrite")
2327                 # -N (RWF_NOWAIT) only works with direct vectored I/O writes
2328                 local pwrite_opts=" "
2329                 if [ "$param" == "-N" ]; then
2330                         opts+=" -d"
2331                         pwrite_opts+="-V 1 -b 4k"
2332                 fi
2333                 testio=`$XFS_IO_PROG -f $opts -c \
2334                         "pwrite $pwrite_opts $param 0 4k" $testfile 2>&1`
2335                 param_checked="$pwrite_opts $param"
2336                 ;;
2337         "scrub"|"repair")
2338                 testio=`$XFS_IO_PROG -x -c "$command probe" $TEST_DIR 2>&1`
2339                 echo $testio | grep -q "Inappropriate ioctl" && \
2340                         _notrun "xfs_io $command support is missing"
2341                 ;;
2342         "utimes" )
2343                 testio=`$XFS_IO_PROG -f -c "utimes 0 0 0 0" $testfile 2>&1`
2344                 ;;
2345         "syncfs")
2346                 touch $testfile
2347                 testio=`$XFS_IO_PROG -c "syncfs" $testfile 2>&1`
2348                 ;;
2349         *)
2350                 testio=`$XFS_IO_PROG -c "help $command" 2>&1`
2351         esac
2352
2353         rm -f $testfile 2>&1 > /dev/null
2354         echo $testio | grep -q "not found" && \
2355                 _notrun "xfs_io $command $param_checked support is missing"
2356         echo $testio | grep -q "Operation not supported\|Inappropriate ioctl" && \
2357                 _notrun "xfs_io $command $param_checked failed (old kernel/wrong fs?)"
2358         echo $testio | grep -q "Invalid" && \
2359                 _notrun "xfs_io $command $param_checked failed (old kernel/wrong fs/bad args?)"
2360         echo $testio | grep -q "foreign file active" && \
2361                 _notrun "xfs_io $command $param_checked not supported on $FSTYP"
2362         echo $testio | grep -q "Function not implemented" && \
2363                 _notrun "xfs_io $command $param_checked support is missing (missing syscall?)"
2364         echo $testio | grep -q "unknown flag" && \
2365                 _notrun "xfs_io $command $param_checked support is missing (unknown flag)"
2366
2367         [ -n "$param" ] || return
2368
2369         if [ -z "$param_checked" ]; then
2370                 $XFS_IO_PROG -c "help $command" | grep -E -q "^ $param ([a-zA-Z_]+ )?--" || \
2371                         _notrun "xfs_io $command doesn't support $param"
2372         else
2373                 # xfs_io could result in "command %c not supported" if it was
2374                 # built on kernels not supporting pwritev2() calls
2375                 echo $testio | grep -q "\(invalid option\|not supported\)" && \
2376                         _notrun "xfs_io $command doesn't support $param"
2377         fi
2378
2379         # On XFS, ioctl(FSSETXATTR)(called by xfs_io -c "chattr") maskes off unsupported
2380         # or invalid flags silently so need to check these flags by extra ioctl(FSGETXATTR)
2381         # (called by xfs_io -c "lsattr").
2382         # The following URL explains why we don't change the behavior of XFS.
2383         # https://www.spinics.net/lists/linux-xfs/msg44725.html
2384         if [ -n "$attr_info" -a "$FSTYP" = "xfs" ]; then
2385                 local num=${#param}
2386                 for i in $(seq 0 $((num-1))); do
2387                         echo $attr_info | grep -q "${param:$i:1}" || \
2388                                 _notrun "xfs_io $command +${param:$i:1} support is missing (unknown flag in kernel)"
2389                 done
2390         fi
2391 }
2392
2393 # check that kernel and filesystem support direct I/O
2394 _require_odirect()
2395 {
2396         if [ $FSTYP = "ext4" ] || [ $FSTYP = "f2fs" ] ; then
2397                 if echo "$MOUNT_OPTIONS" | grep -q "test_dummy_encryption"; then
2398                         _notrun "$FSTYP encryption doesn't support O_DIRECT"
2399                 fi
2400         fi
2401         if [ $FSTYP = "ext4" ] ; then
2402                 if echo "$MOUNT_OPTIONS" | grep -q "data=journal"; then
2403                         _notrun "ext4 data journaling doesn't support O_DIRECT"
2404                 fi
2405         fi
2406         local testfile=$TEST_DIR/$$.direct
2407         $XFS_IO_PROG -F -f -d -c "pwrite 0 20k" $testfile > /dev/null 2>&1
2408         if [ $? -ne 0 ]; then
2409                 _notrun "O_DIRECT is not supported"
2410         fi
2411         rm -f $testfile 2>&1 > /dev/null
2412 }
2413
2414 _format_swapfile() {
2415         local fname="$1"
2416         local sz="$2"
2417
2418         rm -f "$fname"
2419         touch "$fname"
2420         chmod 0600 "$fname"
2421         # Swap files must be nocow on Btrfs.
2422         $CHATTR_PROG +C "$fname" > /dev/null 2>&1
2423         _pwrite_byte 0x61 0 "$sz" "$fname" >> $seqres.full
2424         # Ignore permission complaints on filesystems that don't support perms
2425         $MKSWAP_PROG "$fname" 2> >(grep -v 'insecure permission' >&2) >> $seqres.full
2426 }
2427
2428 # Check that the filesystem supports swapfiles
2429 _require_scratch_swapfile()
2430 {
2431         _require_scratch
2432         _require_command "$MKSWAP_PROG" "mkswap"
2433
2434         _scratch_mkfs >/dev/null 2>&1
2435
2436         # With mounting SELinux context(e.g. system_u:object_r:root_t:s0),
2437         # standard mkswap tried to reset the type of default context to
2438         # swapfile_t if it's not swapfile_t, and then it failed and returned
2439         # ENOTSUP expectedly as we don't want to create any SELinux attr on
2440         # purpose.  standard mkswap ignored this relabel error by commit
2441         # d97dc0e of util-linux, but it still reported the error before
2442         # commit d97dc0e.  We mount swapfile context directly to skip the
2443         # reset step.
2444         [ -n "$SELINUX_MOUNT_OPTIONS" ] && export \
2445                 SELINUX_MOUNT_OPTIONS="-o context=system_u:object_r:swapfile_t:s0"
2446
2447         _scratch_mount
2448
2449         # Minimum size for mkswap is 10 pages
2450         _format_swapfile "$SCRATCH_MNT/swap" $(($(get_page_size) * 10))
2451
2452         # ext* and xfs have supported all variants of swap files since their
2453         # introduction, so swapon should not fail.
2454         case "$FSTYP" in
2455         ext2|ext3|ext4|xfs)
2456                 if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
2457                         _scratch_unmount
2458                         _fail "swapon failed for $FSTYP"
2459                 fi
2460                 ;;
2461         *)
2462                 if ! swapon "$SCRATCH_MNT/swap" >/dev/null 2>&1; then
2463                         _scratch_unmount
2464                         _notrun "swapfiles are not supported"
2465                 fi
2466                 ;;
2467         esac
2468
2469         swapoff "$SCRATCH_MNT/swap" >/dev/null 2>&1
2470         _scratch_unmount
2471 }
2472
2473 # Check that a fs has enough free space (in 1024b blocks)
2474 #
2475 _require_fs_space()
2476 {
2477         local mnt=$1
2478         local blocks=$2 # in units of 1024
2479         local gb=$(( blocks / 1024 / 1024 ))
2480
2481         local free_blocks=`df -kP $mnt | grep -v Filesystem | awk '{print $4}'`
2482         [ $free_blocks -lt $blocks ] && \
2483                 _notrun "This test requires at least ${gb}GB free on $mnt to run"
2484 }
2485
2486 #
2487 # Check if the filesystem supports sparse files.
2488 #
2489 # Unfortunately there is no better way to do this than a manual black list.
2490 #
2491 _require_sparse_files()
2492 {
2493     case $FSTYP in
2494     hfsplus|exfat)
2495         _notrun "Sparse files not supported by this filesystem type: $FSTYP"
2496         ;;
2497     *)
2498         ;;
2499     esac
2500 }
2501
2502 _require_debugfs()
2503 {
2504     #boot_params always present in debugfs
2505     [ -d "$DEBUGFS_MNT/boot_params" ] || _notrun "Debugfs not mounted"
2506 }
2507
2508 _require_fail_make_request()
2509 {
2510     [ -f "$DEBUGFS_MNT/fail_make_request/probability" ] \
2511         || _notrun "$DEBUGFS_MNT/fail_make_request \
2512  not found. Seems that CONFIG_FAULT_INJECTION_DEBUG_FS kernel config option not enabled"
2513 }
2514
2515 # Disable extent zeroing for ext4 on the given device
2516 _ext4_disable_extent_zeroout()
2517 {
2518         local dev=${1:-$TEST_DEV}
2519         local sdev=`_short_dev $dev`
2520
2521         [ -f /sys/fs/ext4/$sdev/extent_max_zeroout_kb ] && \
2522                 echo 0 >/sys/fs/ext4/$sdev/extent_max_zeroout_kb
2523 }
2524
2525 # The default behavior of SEEK_HOLE is to always return EOF.
2526 # Filesystems that implement non-default behavior return the offset
2527 # of holes with SEEK_HOLE. There is no way to query the filesystem
2528 # of which behavior it is implementing.
2529 # We use this whitelist FSTYP, to set expectation and avoid silent
2530 # regression of filesystem seek hole behavior.
2531 #
2532 # Return 0 for true
2533 _fstyp_has_non_default_seek_data_hole()
2534 {
2535         if [ -z $1 ]; then
2536                 local fstyp=$FSTYP
2537         else
2538                 local fstyp=$1
2539         fi
2540
2541         case "$fstyp" in
2542         btrfs|ext4|xfs|cifs|f2fs|gfs2|ocfs2|tmpfs)
2543                 return 0
2544                 ;;
2545         nfs*)
2546                 # NFSv2 and NFSv3 only support default behavior of SEEK_HOLE,
2547                 # while NFSv4 supports non-default behavior
2548                 local nfsvers=`_df_device $TEST_DEV | $AWK_PROG '{ print $2 }'`
2549                 [ "$nfsvers" = "nfs4" ]
2550                 return $?
2551                 ;;
2552         overlay)
2553                 if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
2554                         _fstyp_has_non_default_seek_data_hole $OVL_BASE_FSTYP
2555                         return $?
2556                 else
2557                         # Assume that base fs has default behavior
2558                         return 1
2559                 fi
2560                 ;;
2561         *)
2562                 # by default fstyp has default SEEK_HOLE behavior;
2563                 # if your fs has non-default behavior, add it to whitelist above!
2564                 return 1
2565                 ;;
2566         esac
2567 }
2568
2569 # Run seek sanity test with predefined expectation for SEEK_DATA/HOLE behavior
2570 _run_seek_sanity_test()
2571 {
2572         local testseekargs
2573         if _fstyp_has_non_default_seek_data_hole; then
2574                 testseekargs+="-f"
2575         fi
2576         $here/src/seek_sanity_test $testseekargs $*
2577 }
2578
2579 # Check if the file system supports seek_data/hole
2580 _require_seek_data_hole()
2581 {
2582         local dev=${1:-$TEST_DEV}
2583         local testfile=$TEST_DIR/$$.seek
2584         local testseek=`$here/src/seek_sanity_test -t $testfile 2>&1`
2585
2586         rm -f $testfile &>/dev/null
2587         echo $testseek | grep -q "Kernel does not support" && \
2588                 _notrun "File system does not support llseek(2) SEEK_DATA/HOLE"
2589         # Disable extent zeroing for ext4 as that change where holes are
2590         # created
2591         if [ "$FSTYP" = "ext4" ]; then
2592                 _ext4_disable_extent_zeroout $dev
2593         fi
2594 }
2595
2596 _require_runas()
2597 {
2598         _require_test_program "runas"
2599 }
2600
2601 _runas()
2602 {
2603         "$here/src/runas" "$@"
2604 }
2605
2606 _require_richacl_prog()
2607 {
2608         _require_command "$GETRICHACL_PROG" getrichacl
2609         _require_command "$SETRICHACL_PROG" setrichacl
2610 }
2611
2612 _require_scratch_richacl_xfs()
2613 {
2614         _scratch_mkfs_xfs_supported -m richacl=1 >/dev/null 2>&1 \
2615                 || _notrun "mkfs.xfs doesn't have richacl feature"
2616         _scratch_mkfs_xfs -m richacl=1 >/dev/null 2>&1
2617         _try_scratch_mount >/dev/null 2>&1 \
2618                 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2619         _scratch_unmount
2620 }
2621
2622 _require_scratch_richacl_ext4()
2623 {
2624         _scratch_mkfs -O richacl >/dev/null 2>&1 \
2625                 || _notrun "can't mkfs $FSTYP with option -O richacl"
2626         _try_scratch_mount >/dev/null 2>&1 \
2627                 || _notrun "kernel doesn't support richacl feature on $FSTYP"
2628         _scratch_unmount
2629 }
2630
2631 _require_scratch_richacl_support()
2632 {
2633         _scratch_mount
2634         $GETFATTR_PROG -n system.richacl >/dev/null 2>&1 \
2635                 || _notrun "this test requires richacl support on \$SCRATCH_DEV"
2636         _scratch_unmount
2637 }
2638
2639 _require_scratch_richacl()
2640 {
2641         case "$FSTYP" in
2642         xfs)    _require_scratch_richacl_xfs
2643                 ;;
2644         ext4)   _require_scratch_richacl_ext4
2645                 ;;
2646         nfs*|cifs|overlay)
2647                 _require_scratch_richacl_support
2648                 ;;
2649         *)      _notrun "this test requires richacl support on \$SCRATCH_DEV"
2650                 ;;
2651         esac
2652 }
2653
2654 _scratch_mkfs_richacl()
2655 {
2656         case "$FSTYP" in
2657         xfs)    _scratch_mkfs_xfs -m richacl=1
2658                 ;;
2659         ext4)   _scratch_mkfs -O richacl
2660                 ;;
2661         nfs*|cifs|overlay)
2662                 _scratch_mkfs
2663                 ;;
2664         esac
2665 }
2666
2667 # check if the given device is mounted, if so, return mount point
2668 _is_dev_mounted()
2669 {
2670         local dev=$1
2671         local fstype=${2:-$FSTYP}
2672
2673         if [ $# -lt 1 ]; then
2674                 echo "Usage: _is_dev_mounted <device> [fstype]" 1>&2
2675                 exit 1
2676         fi
2677
2678         findmnt -rncv -S $dev -t $fstype -o TARGET | head -1
2679 }
2680
2681 # check if the given dir is a mount point, if so, return mount point
2682 _is_dir_mountpoint()
2683 {
2684         local dir=$1
2685         local fstype=${2:-$FSTYP}
2686
2687         if [ $# -lt 1 ]; then
2688                 echo "Uasge: _is_dir_mountpoint <dir> [fstype]" 1>&2
2689                 exit 1
2690         fi
2691
2692         findmnt -rncv -t $fstype -o TARGET $dir | head -1
2693 }
2694
2695 # remount a FS to a new mode (ro or rw)
2696 #
2697 _remount()
2698 {
2699     if [ $# -ne 2 ]
2700     then
2701         echo "Usage: _remount device ro/rw" 1>&2
2702         exit 1
2703     fi
2704     local device=$1
2705     local mode=$2
2706
2707     if ! mount -o remount,$mode $device
2708     then
2709         echo "_remount: failed to remount filesystem on $device as $mode"
2710         exit 1
2711     fi
2712 }
2713
2714 # Run the appropriate repair/check on a filesystem
2715 #
2716 # if the filesystem is mounted, it's either remounted ro before being
2717 # checked or it's unmounted and then remounted
2718 #
2719
2720 # If set, we remount ro instead of unmounting for fsck
2721 USE_REMOUNT=0
2722
2723 _umount_or_remount_ro()
2724 {
2725     if [ $# -ne 1 ]
2726     then
2727         echo "Usage: _umount_or_remount_ro <device>" 1>&2
2728         exit 1
2729     fi
2730
2731     local device=$1
2732     local mountpoint=`_is_dev_mounted $device`
2733
2734     if [ $USE_REMOUNT -eq 0 ]; then
2735         $UMOUNT_PROG $device
2736     else
2737         _remount $device ro
2738     fi
2739     echo "$mountpoint"
2740 }
2741
2742 _mount_or_remount_rw()
2743 {
2744         if [ $# -ne 3 ]; then
2745                 echo "Usage: _mount_or_remount_rw <opts> <dev> <mnt>" 1>&2
2746                 exit 1
2747         fi
2748         local mount_opts=$1
2749         local device=$2
2750         local mountpoint=$3
2751
2752         if [ $USE_REMOUNT -eq 0 ]; then
2753                 if [ "$FSTYP" != "overlay" ]; then
2754                         _mount -t $FSTYP $mount_opts $device $mountpoint
2755                 else
2756                         _overlay_mount $device $mountpoint
2757                 fi
2758                 if [ $? -ne 0 ]; then
2759                         _dump_err "!!! failed to remount $device on $mountpoint"
2760                         return 0 # ok=0
2761                 fi
2762         else
2763                 _remount $device rw
2764         fi
2765
2766         return 1 # ok=1
2767 }
2768
2769 # Check a generic filesystem in no-op mode; this assumes that the
2770 # underlying fsck program accepts "-n" for a no-op (check-only) run,
2771 # and that it will still return an errno for corruption in this mode.
2772 #
2773 # Filesystems which don't support this will need to define their
2774 # own check routine.
2775 #
2776 _check_generic_filesystem()
2777 {
2778     local device=$1
2779
2780     # If type is set, we're mounted
2781     local type=`_fs_type $device`
2782     local ok=1
2783
2784     if [ "$type" = "$FSTYP" ]
2785     then
2786         # mounted ...
2787         local mountpoint=`_umount_or_remount_ro $device`
2788     fi
2789
2790     fsck -t $FSTYP $FSCK_OPTIONS $device >$tmp.fsck 2>&1
2791     if [ $? -ne 0 ]
2792     then
2793         _log_err "_check_generic_filesystem: filesystem on $device is inconsistent"
2794         echo "*** fsck.$FSTYP output ***"       >>$seqres.full
2795         cat $tmp.fsck                           >>$seqres.full
2796         echo "*** end fsck.$FSTYP output"       >>$seqres.full
2797
2798         ok=0
2799     fi
2800     rm -f $tmp.fsck
2801
2802     if [ $ok -eq 0 ] && [ -n "$DUMP_CORRUPT_FS" ]; then
2803         case "$FSTYP" in
2804         ext*)
2805             local flatdev="$(basename "$device")"
2806             _ext4_metadump "$seqres.$flatdev.check.qcow2" "$device" compress
2807             ;;
2808         esac
2809     fi
2810
2811     if [ $ok -eq 0 ]
2812     then
2813         echo "*** mount output ***"             >>$seqres.full
2814         _mount                                  >>$seqres.full
2815         echo "*** end mount output"             >>$seqres.full
2816     elif [ "$type" = "$FSTYP" ]
2817     then
2818         # was mounted ...
2819         _mount_or_remount_rw "$MOUNT_OPTIONS" $device $mountpoint
2820         ok=$?
2821     fi
2822
2823     if [ $ok -eq 0 ]; then
2824         status=1
2825         if [ "$iam" != "check" ]; then
2826                 exit 1
2827         fi
2828         return 1
2829     fi
2830
2831     return 0
2832 }
2833
2834 # Filter the knowen errors the UDF Verifier reports.
2835 _udf_test_known_error_filter()
2836 {
2837         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."
2838
2839 }
2840
2841 _check_udf_filesystem()
2842 {
2843     [ "$DISABLE_UDF_TEST" == "1" ] && return
2844
2845     if [ $# -ne 1 -a $# -ne 2 ]
2846     then
2847         echo "Usage: _check_udf_filesystem device [last_block]" 1>&2
2848         exit 1
2849     fi
2850
2851     if [ ! -x $here/src/udf_test ]
2852     then
2853         echo "udf_test not installed, please download and build the Philips"
2854         echo "UDF Verification Software from http://www.extra.research.philips.com/udf/."
2855         echo "Then copy the udf_test binary to $here/src/."
2856         echo "If you do not wish to run udf_test then set environment variable DISABLE_UDF_TEST"
2857         echo "to 1."
2858         return
2859     fi
2860
2861     local device=$1
2862     local opt_arg=""
2863     if [ $# -eq 2 ]; then
2864         opt_arg="-lastvalidblock $(( $2 - 1 ))"
2865     fi
2866
2867     rm -f $seqres.checkfs
2868     sleep 1 # Due to a problem with time stamps in udf_test
2869     $here/src/udf_test $opt_arg $device | tee $seqres.checkfs | egrep "Error|Warning" | \
2870         _udf_test_known_error_filter | \
2871         egrep -iv "Error count:.*[0-9]+.*total occurrences:.*[0-9]+|Warning count:.*[0-9]+.*total occurrences:.*[0-9]+" && \
2872         echo "Warning UDF Verifier reported errors see $seqres.checkfs." && return 1
2873     return 0
2874 }
2875
2876 _check_test_fs()
2877 {
2878     case $FSTYP in
2879     xfs)
2880         _check_xfs_test_fs
2881         ;;
2882     nfs)
2883         # no way to check consistency for nfs
2884         ;;
2885     cifs)
2886         # no way to check consistency for cifs
2887         ;;
2888     9p)
2889         # no way to check consistency for 9p
2890         ;;
2891     virtiofs)
2892         # no way to check consistency for virtiofs
2893         ;;
2894     ceph)
2895         # no way to check consistency for CephFS
2896         ;;
2897     glusterfs)
2898         # no way to check consistency for GlusterFS
2899         ;;
2900     overlay)
2901         _check_overlay_test_fs
2902         ;;
2903     pvfs2)
2904         ;;
2905     udf)
2906         # do nothing for now
2907         ;;
2908     btrfs)
2909         _check_btrfs_filesystem $TEST_DEV
2910         ;;
2911     tmpfs)
2912         # no way to check consistency for tmpfs
2913         ;;
2914     ubifs)
2915         # there is no fsck program for ubifs yet
2916         ;;
2917     *)
2918         _check_generic_filesystem $TEST_DEV
2919         ;;
2920     esac
2921 }
2922
2923 _check_scratch_fs()
2924 {
2925     local device=$SCRATCH_DEV
2926     [ $# -eq 1 ] && device=$1
2927
2928     case $FSTYP in
2929     xfs)
2930         local scratch_log="none"
2931         local scratch_rt="none"
2932         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_LOGDEV" ] && \
2933             scratch_log="$SCRATCH_LOGDEV"
2934
2935         [ "$USE_EXTERNAL" = yes -a ! -z "$SCRATCH_RTDEV" ] && \
2936             scratch_rt="$SCRATCH_RTDEV"
2937
2938         _check_xfs_filesystem $device $scratch_log $scratch_rt
2939         ;;
2940     udf)
2941         _check_udf_filesystem $device $udf_fsize
2942         ;;
2943     nfs*)
2944         # Don't know how to check an NFS filesystem, yet.
2945         ;;
2946     cifs)
2947         # Don't know how to check a CIFS filesystem, yet.
2948         ;;
2949     9p)
2950         # no way to check consistency for 9p
2951         ;;
2952     virtiofs)
2953         # no way to check consistency for virtiofs
2954         ;;
2955     ceph)
2956         # no way to check consistency for CephFS
2957         ;;
2958     glusterfs)
2959         # no way to check consistency for GlusterFS
2960         ;;
2961     overlay)
2962         _check_overlay_scratch_fs
2963         ;;
2964     pvfs2)
2965         ;;
2966     btrfs)
2967         _check_btrfs_filesystem $device
2968         ;;
2969     tmpfs)
2970         # no way to check consistency for tmpfs
2971         ;;
2972     ubifs)
2973         # there is no fsck program for ubifs yet
2974         ;;
2975     *)
2976         _check_generic_filesystem $device
2977         ;;
2978     esac
2979 }
2980
2981 _full_fstyp_details()
2982 {
2983      [ -z "$FSTYP" ] && FSTYP=xfs
2984      if [ $FSTYP = xfs ]; then
2985         if [ -d /proc/fs/xfs ]; then
2986             if grep -q 'debug 0' /proc/fs/xfs/stat; then
2987                 FSTYP="$FSTYP (non-debug)"
2988             elif grep -q 'debug 1' /proc/fs/xfs/stat; then
2989                 FSTYP="$FSTYP (debug)"
2990             fi
2991         else
2992             if uname -a | grep -qi 'debug'; then
2993                 FSTYP="$FSTYP (debug)"
2994             else
2995                 FSTYP="$FSTYP (non-debug)"
2996             fi
2997         fi
2998      fi
2999      echo $FSTYP
3000 }
3001
3002 _full_platform_details()
3003 {
3004      local os=`uname -s`
3005      local host=`hostname -s`
3006      local kernel=`uname -rv`
3007      local platform=`uname -m`
3008      echo "$os/$platform $host $kernel"
3009 }
3010
3011 _get_os_name()
3012 {
3013         if [ "`uname`" == "Linux" ]; then
3014                 echo 'linux'
3015         else
3016                 echo Unknown operating system: `uname`
3017                 exit
3018         fi
3019 }
3020
3021 _link_out_file_named()
3022 {
3023         local features=$2
3024         local suffix=$(FEATURES="$features" perl -e '
3025                 my %feathash;
3026                 my $feature, $result, $suffix, $opts;
3027
3028                 foreach $feature (split(/,/, $ENV{"FEATURES"})) {
3029                         $feathash{$feature} = 1;
3030                 }
3031                 $result = "default";
3032                 while (<>) {
3033                         my $found = 1;
3034
3035                         chomp;
3036                         ($opts, $suffix) = split(/ *: */);
3037                         foreach my $opt (split(/,/, $opts)) {
3038                                 if (!exists($feathash{$opt})) {
3039                                         $found = 0;
3040                                         last;
3041                                 }
3042                         }
3043                         if ($found == 1) {
3044                                 $result = $suffix;
3045                                 last;
3046                         }
3047                 }
3048                 print $result
3049                 ' <$seqfull.cfg)
3050         rm -f $1
3051         ln -fs $(basename $1).$suffix $1
3052 }
3053
3054 _link_out_file()
3055 {
3056         local features
3057
3058         if [ $# -eq 0 ]; then
3059                 features="$(_get_os_name),$FSTYP"
3060                 if [ -n "$MOUNT_OPTIONS" ]; then
3061                         features=$features,${MOUNT_OPTIONS##"-o "}
3062                 fi
3063         else
3064                 features=$1
3065         fi
3066
3067         _link_out_file_named $seqfull.out "$features"
3068 }
3069
3070 _die()
3071 {
3072         echo $@
3073         exit 1
3074 }
3075
3076 # convert urandom incompressible data to compressible text data
3077 _ddt()
3078 {
3079         od /dev/urandom | dd iflag=fullblock ${*}
3080 }
3081
3082 #takes files, randomdata
3083 _nfiles()
3084 {
3085         local f=0
3086         while [ $f -lt $1 ]
3087         do
3088                 local file=f$f
3089                 echo > $file
3090                 if [ $size -gt 0 ]; then
3091                     if [ "$2" == "false" ]; then
3092                         dd if=/dev/zero of=$file bs=1024 count=$size 2>&1 | _filter_dd
3093                     elif [ "$2" == "comp" ]; then
3094                         _ddt of=$file bs=1024 count=$size 2>&1 | _filter_dd
3095                     else
3096                         dd if=/dev/urandom of=$file bs=1024 count=$size 2>&1 | _filter_dd
3097                     fi
3098                 fi
3099                 let f=$f+1
3100         done
3101 }
3102
3103 # takes dirname, depth, randomdata
3104 _descend()
3105 {
3106         local dirname=$1 depth=$2 randomdata=$3
3107         mkdir $dirname  || die "mkdir $dirname failed"
3108         cd $dirname
3109
3110         _nfiles $files $randomdata          # files for this dir and data type
3111
3112         [ $depth -eq 0 ] && return
3113         local deep=$(( depth - 1 )) # go 1 down
3114
3115         [ $verbose = true ] && echo "descending, depth from leaves = $deep"
3116
3117         local d=0
3118         while [ $d -lt $dirs ]
3119         do
3120                 _descend d$d $deep &
3121                 let d=$d+1
3122                 wait
3123         done
3124 }
3125
3126 # Populate a filesystem with inodes for performance experiments
3127 #
3128 # usage: populate [-v] [-n ndirs] [-f nfiles] [-d depth] [-r root] [-s size] [-x]
3129 #
3130 _populate_fs()
3131 {
3132     local here=`pwd`
3133     local dirs=5          # ndirs in each subdir till leaves
3134     local size=0          # sizeof files in K
3135     local files=100       # num files in _each_ subdir
3136     local depth=2         # depth of tree from root to leaves
3137     local verbose=false
3138     local root=root       # path of initial root of directory tree
3139     local randomdata=false # -x data type urandom, zero or compressible
3140     local c
3141
3142     OPTIND=1
3143     while getopts "d:f:n:r:s:v:x:c" c
3144     do
3145         case $c in
3146         d)      depth=$OPTARG;;
3147         n)      dirs=$OPTARG;;
3148         f)      files=$OPTARG;;
3149         s)      size=$OPTARG;;
3150         v)      verbose=true;;
3151         r)      root=$OPTARG;;
3152         x)      randomdata=true;;
3153         c)      randomdata=comp;;
3154         esac
3155     done
3156
3157     _descend $root $depth $randomdata
3158     wait
3159
3160     cd $here
3161
3162     [ $verbose = true ] && echo done
3163 }
3164
3165 # query whether the given file has the given inode flag set
3166 #
3167 _test_inode_flag()
3168 {
3169         local flag=$1
3170         local file=$2
3171
3172         if $XFS_IO_PROG -r -c 'lsattr -v' "$file" | grep -q "$flag" ; then
3173                 return 0
3174         fi
3175         return 1
3176 }
3177
3178 # query the given files extsize allocator hint in bytes (if any)
3179 #
3180 _test_inode_extsz()
3181 {
3182         local file=$1
3183         local blocks=""
3184
3185         blocks=`$XFS_IO_PROG -r -c 'stat' "$file" | \
3186                 awk '/^xattr.extsize =/ { print $3 }'`
3187         [ -z "$blocks" ] && blocks="0"
3188         echo $blocks
3189 }
3190
3191 # scratch_dev_pool should contain the disks pool for the btrfs raid
3192 _require_scratch_dev_pool()
3193 {
3194         local i
3195         local ndevs
3196
3197         if [ -z "$SCRATCH_DEV_POOL" ]; then
3198                 _notrun "this test requires a valid \$SCRATCH_DEV_POOL"
3199         fi
3200
3201         if [ -z "$1" ]; then
3202                 ndevs=2
3203         else
3204                 ndevs=$1
3205         fi
3206
3207         # btrfs test case needs ndevs or more scratch_dev_pool; other FS not sure
3208         # so fail it
3209         case $FSTYP in
3210         btrfs)
3211                 if [ "`echo $SCRATCH_DEV_POOL|wc -w`" -lt $ndevs ]; then
3212                         _notrun "btrfs and this test needs $ndevs or more disks in SCRATCH_DEV_POOL"
3213                 fi
3214         ;;
3215         *)
3216                 _notrun "dev_pool is not supported by fstype \"$FSTYP\""
3217         ;;
3218         esac
3219
3220         for i in $SCRATCH_DEV_POOL; do
3221                 if [ "`_is_block_dev "$i"`" = "" ]; then
3222                         _notrun "this test requires valid block disk $i"
3223                 fi
3224                 if [ "`_is_block_dev "$i"`" = "`_is_block_dev "$TEST_DEV"`" ]; then
3225                         _notrun "$i is part of TEST_DEV, this test requires unique disks"
3226                 fi
3227                 if _mount | grep -q $i; then
3228                         if ! $UMOUNT_PROG $i; then
3229                             echo "failed to unmount $i - aborting"
3230                             exit 1
3231                         fi
3232                 fi
3233                 # to help better debug when something fails, we remove
3234                 # traces of previous btrfs FS on the dev.
3235                 dd if=/dev/zero of=$i bs=4096 count=100 > /dev/null 2>&1
3236         done
3237 }
3238
3239 # ensure devices in SCRATCH_DEV_POOL are of the same size
3240 # must be called after _require_scratch_dev_pool
3241 _require_scratch_dev_pool_equal_size()
3242 {
3243         local size
3244         local newsize
3245         local dev
3246
3247         # SCRATCH_DEV has been set to the first device in SCRATCH_DEV_POOL
3248         size=`_get_device_size $SCRATCH_DEV`
3249         for dev in $SCRATCH_DEV_POOL; do
3250                 newsize=`_get_device_size $dev`
3251                 if [ $size -ne $newsize ]; then
3252                         _notrun "This test requires devices in SCRATCH_DEV_POOL have the same size"
3253                 fi
3254         done
3255 }
3256
3257
3258 # Check that fio is present, and it is able to execute given jobfile
3259 _require_fio()
3260 {
3261         local job=$1
3262
3263         _require_command "$FIO_PROG" fio
3264         if [ -z "$1" ]; then
3265                 return 1;
3266         fi
3267
3268         $FIO_PROG --warnings-fatal --showcmd $job >> $seqres.full 2>&1
3269         [ $? -eq 0 ] || _notrun "$FIO_PROG too old, see $seqres.full"
3270 }
3271
3272 # Does freeze work on this fs?
3273 _require_freeze()
3274 {
3275         xfs_freeze -f "$TEST_DIR" >/dev/null 2>&1
3276         local result=$?
3277         xfs_freeze -u "$TEST_DIR" >/dev/null 2>&1
3278         [ $result -eq 0 ] || _notrun "$FSTYP does not support freezing"
3279 }
3280
3281 # Does NFS export work on this fs?
3282 _require_exportfs()
3283 {
3284         _require_test_program "open_by_handle"
3285         mkdir -p "$TEST_DIR"/exportfs_test
3286         $here/src/open_by_handle -c "$TEST_DIR"/exportfs_test 2>&1 \
3287                 || _notrun "$FSTYP does not support NFS export"
3288 }
3289
3290
3291 # Does shutdown work on this fs?
3292 _require_scratch_shutdown()
3293 {
3294         [ -x $here/src/godown ] || _notrun "src/godown executable not found"
3295
3296         _scratch_mkfs > /dev/null 2>&1 || _notrun "_scratch_mkfs failed on $SCRATCH_DEV"
3297         _scratch_mount
3298
3299         if [ $FSTYP = "overlay" ]; then
3300                 if [ -z $OVL_BASE_SCRATCH_DEV ]; then
3301                         # In lagacy overlay usage, it may specify directory as
3302                         # SCRATCH_DEV, in this case OVL_BASE_SCRATCH_DEV
3303                         # will be null, so check OVL_BASE_SCRATCH_DEV before
3304                         # running shutdown to avoid shutting down base fs accidently.
3305                         _notrun "This test requires a valid $OVL_BASE_SCRATCH_DEV as ovl base fs"
3306                 else
3307                         $here/src/godown -f $OVL_BASE_SCRATCH_MNT 2>&1 \
3308                         || _notrun "Underlying filesystem does not support shutdown"
3309                 fi
3310         else
3311                 $here/src/godown -f $SCRATCH_MNT 2>&1 \
3312                         || _notrun "$FSTYP does not support shutdown"
3313         fi
3314
3315         _scratch_unmount
3316 }
3317
3318 _check_s_dax()
3319 {
3320         local target=$1
3321         local exp_s_dax=$2
3322
3323         local attributes=$($XFS_IO_PROG -c 'statx -r' $target | awk '/stat.attributes / { print $3 }')
3324
3325         # The original attribute bit value, STATX_ATTR_DAX (0x2000), conflicted
3326         # with STATX_ATTR_MOUNT_ROOT.  Therefore, STATX_ATTR_DAX was changed to
3327         # 0x00200000.
3328         #
3329         # Because DAX tests do not run on root mounts, STATX_ATTR_MOUNT_ROOT
3330         # should always be 0.  Check for the old flag and fail the test if that
3331         # occurs.
3332
3333         if [ $(( attributes & 0x2000 )) -ne 0 ]; then
3334                 echo "$target has an unexpected STATX_ATTR_MOUNT_ROOT flag set"
3335                 echo "which used to be STATX_ATTR_DAX"
3336                 echo "     This test should not be running on the root inode..."
3337                 echo "     Does the kernel have the following patch?"
3338                 echo "     72d1249e2ffd uapi: fix statx attribute value overlap for DAX & MOUNT_ROOT"
3339         fi
3340
3341         if [ $exp_s_dax -eq 0 ]; then
3342                 (( attributes & 0x00200000 )) && echo "$target has unexpected S_DAX flag"
3343         else
3344                 (( attributes & 0x00200000 )) || echo "$target doesn't have expected S_DAX flag"
3345         fi
3346 }
3347
3348 _check_xflag()
3349 {
3350         local target=$1
3351         local exp_xflag=$2
3352
3353         if [ $exp_xflag -eq 0 ]; then
3354                 _test_inode_flag dax $target && echo "$target has unexpected FS_XFLAG_DAX flag"
3355         else
3356                 _test_inode_flag dax $target || echo "$target doesn't have expected FS_XFLAG_DAX flag"
3357         fi
3358 }
3359
3360 # Check if dax mount options are supported
3361 #
3362 # $1 can be either 'dax=always' or 'dax'
3363 #
3364 # dax=always
3365 #      Check for the new dax options (dax=inode, dax=always or dax=never)
3366 #      by passing "dax=always".
3367 # dax
3368 #      Check for the old dax or new dax=always by passing "dax".
3369 #
3370 # This only accepts 'dax=always' because dax=always, dax=inode and
3371 # dax=never are always supported together.  So if the other options are
3372 # required checking for 'dax=always' indicates support for the other 2.
3373 #
3374 # Return 0 if filesystem/device supports the specified dax option.
3375 # Return 1 if mount fails with the specified dax option.
3376 # Return 2 if /proc/mounts shows wrong dax option.
3377 _check_scratch_dax_mountopt()
3378 {
3379         local option=$1
3380
3381         _require_scratch
3382         _scratch_mkfs > /dev/null 2>&1
3383
3384         _try_scratch_mount "-o $option" > /dev/null 2>&1 || return 1
3385
3386         if _fs_options $SCRATCH_DEV | egrep -q "dax(=always|,|$)"; then
3387                 _scratch_unmount
3388                 return 0
3389         else
3390                 _scratch_unmount
3391                 return 2
3392         fi
3393 }
3394
3395 # Throw notrun if _check_scratch_dax_mountopt() returns a non-zero value.
3396 _require_scratch_dax_mountopt()
3397 {
3398         local mountopt=$1
3399
3400         _check_scratch_dax_mountopt "$mountopt"
3401         local res=$?
3402
3403         [ $res -eq 1 ] && _notrun "mount $SCRATCH_DEV with $mountopt failed"
3404         [ $res -eq 2 ] && _notrun "$SCRATCH_DEV $FSTYP does not support -o $mountopt"
3405 }
3406
3407 _require_dax_iflag()
3408 {
3409         _require_xfs_io_command "chattr" "x"
3410 }
3411
3412 # Does norecovery support by this fs?
3413 _require_norecovery()
3414 {
3415         _try_scratch_mount -o ro,norecovery || \
3416                 _notrun "$FSTYP does not support norecovery"
3417         _scratch_unmount
3418 }
3419
3420 # Does this filesystem support metadata journaling?
3421 # We exclude ones here that don't; otherwise we assume that it does, so the
3422 # test will run, fail, and motivate someone to update this test for a new
3423 # filesystem.
3424 #
3425 # It's possible that TEST_DEV and SCRATCH_DEV have different features (it'd be
3426 # odd, but possible) so check $TEST_DEV by default, but we can optionall pass
3427 # any dev we want.
3428 _has_metadata_journaling()
3429 {
3430         if [ -z $1 ]; then
3431                 local dev=$TEST_DEV
3432         else
3433                 local dev=$1
3434         fi
3435
3436         case "$FSTYP" in
3437         ext2|vfat|msdos|udf|exfat)
3438                 echo "$FSTYP does not support metadata journaling"
3439                 return 1
3440                 ;;
3441         ext4)
3442                 # ext4 could be mkfs'd without a journal...
3443                 _require_dumpe2fs
3444                 $DUMPE2FS_PROG -h $dev 2>&1 | grep -q has_journal || {
3445                         echo "$FSTYP on $dev not configured with metadata journaling"
3446                         return 1
3447                 }
3448                 # ext4 might not load a journal
3449                 if _normalize_mount_options | grep -qw "noload"; then
3450                         echo "mount option \"noload\" not allowed in this test"
3451                         return 1
3452                 fi
3453                 ;;
3454         overlay)
3455                 # metadata journaling check is based on base filesystem configurations
3456                 # and  because -overlay option saves those configurations to OVL_BASE_*,
3457                 # adding restore/override the configurations before/after the check.
3458                 if [ ! -z $OVL_BASE_FSTYP -a $OVL_BASE_FSTYP != "overlay" ]; then
3459                         local ret
3460
3461                         _overlay_config_restore
3462                         _has_metadata_journaling
3463                         ret=$?
3464                         _overlay_config_override
3465                         return $ret
3466                 else
3467                         echo "No metadata journaling support for legacy overlay setup"
3468                         return 1
3469                 fi
3470                 ;;
3471         *)
3472                 # by default we pass; if you need to, add your fs above!
3473                 ;;
3474         esac
3475         return 0
3476 }
3477
3478 _require_metadata_journaling()
3479 {
3480         local msg=$(_has_metadata_journaling $@)
3481         if [ -n "$msg" ]; then
3482                 _notrun "$msg"
3483         fi
3484 }
3485
3486 _count_extents()
3487 {
3488         $XFS_IO_PROG -r -c "fiemap" $1 | tail -n +2 | grep -v hole | wc -l
3489 }
3490
3491 # Similar to _count_extents() but if any extent is shared multiples times in
3492 # the file (reflinked to different file offsets), it is accounted as 1 extent
3493 # instead of N extents.
3494 _count_exclusive_extents()
3495 {
3496         $XFS_IO_PROG -r -c "fiemap" $1 | tail -n +2 | grep -v hole | \
3497                 cut -d ' ' -f 3 | sort | uniq | wc -l
3498 }
3499
3500 _count_holes()
3501 {
3502         $XFS_IO_PROG -r -c "fiemap" $1 | tail -n +2 | grep hole | wc -l
3503 }
3504
3505 _count_attr_extents()
3506 {
3507         $XFS_IO_PROG -c "fiemap -a" $1 | tail -n +2 | grep -v hole | wc -l
3508 }
3509
3510 # arg 1 is dev to remove and is output of the below eg.
3511 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
3512 _devmgt_remove()
3513 {
3514         local lun=$1
3515         local disk=$2
3516
3517         echo 1 > /sys/class/scsi_device/${lun}/device/delete || _fail "Remove disk failed"
3518
3519         stat $disk > /dev/null 2>&1
3520         while [ $? -eq 0 ]; do
3521                 sleep 1
3522                 stat $disk > /dev/null 2>&1
3523         done
3524 }
3525
3526 # arg 1 is dev to add and is output of the below eg.
3527 # ls -l /sys/class/block/sdd | rev | cut -d "/" -f 3 | rev
3528 _devmgt_add()
3529 {
3530         local h
3531         local tdl
3532         # arg 1 will be in h:t:d:l format now in the h and "t d l" format
3533         h=`echo ${1} | cut -d":" -f 1`
3534         tdl=`echo ${1} | cut -d":" -f 2-|sed 's/:/ /g'`
3535
3536         echo ${tdl} >  /sys/class/scsi_host/host${h}/scan || _fail "Add disk failed"
3537
3538         # ensure the device comes online
3539         local dev_back_oneline=0
3540         local i
3541         for i in `seq 1 10`; do
3542                 if [ -d /sys/class/scsi_device/${1}/device/block ]; then
3543                         local dev=`ls /sys/class/scsi_device/${1}/device/block`
3544                         local j
3545                         for j in `seq 1 10`;
3546                         do
3547                                 stat /dev/$dev > /dev/null 2>&1
3548                                 if [ $? -eq 0 ]; then
3549                                         dev_back_oneline=1
3550                                         break
3551                                 fi
3552                                 sleep 1
3553                         done
3554                         break
3555                 else
3556                         sleep 1
3557                 fi
3558         done
3559         if [ $dev_back_oneline -eq 0 ]; then
3560                 echo "/dev/$dev online failed" >> $seqres.full
3561         else
3562                 echo "/dev/$dev is back online" >> $seqres.full
3563         fi
3564 }
3565
3566 _require_fstrim()
3567 {
3568         if [ -z "$FSTRIM_PROG" ]; then
3569                 _notrun "This test requires fstrim utility."
3570         fi
3571 }
3572
3573 _require_batched_discard()
3574 {
3575         if [ $# -ne 1 ]; then
3576                 echo "Usage: _require_batched_discard mnt_point" 1>&2
3577                 exit 1
3578         fi
3579         _require_fstrim
3580         $FSTRIM_PROG $1 > /dev/null 2>&1 || _notrun "FITRIM not supported on $1"
3581 }
3582
3583 _require_dumpe2fs()
3584 {
3585         if [ -z "$DUMPE2FS_PROG" ]; then
3586                 _notrun "This test requires dumpe2fs utility."
3587         fi
3588 }
3589
3590 _require_ugid_map()
3591 {
3592         if [ ! -e /proc/self/uid_map ]; then
3593                 _notrun "This test requires procfs uid_map support."
3594         fi
3595         if [ ! -e /proc/self/gid_map ]; then
3596                 _notrun "This test requires procfs gid_map support."
3597         fi
3598 }
3599
3600 _require_fssum()
3601 {
3602         FSSUM_PROG=$here/src/fssum
3603         [ -x $FSSUM_PROG ] || _notrun "fssum not built"
3604 }
3605
3606 _require_cloner()
3607 {
3608         CLONER_PROG=$here/src/cloner
3609         [ -x $CLONER_PROG ] || \
3610                 _notrun "cloner binary not present at $CLONER_PROG"
3611 }
3612
3613 # Normalize mount options from global $MOUNT_OPTIONS
3614 # Convert options like "-o opt1,opt2 -oopt3" to
3615 # "opt1 opt2 opt3"
3616 _normalize_mount_options()
3617 {
3618         echo $MOUNT_OPTIONS | sed -n 's/-o\s*\(\S*\)/\1/gp'| sed 's/,/ /g'
3619 }
3620
3621 # skip test if MOUNT_OPTIONS contains the given strings
3622 # Both dax and dax=always are excluded if dax or dax=always is passed
3623 _exclude_scratch_mount_option()
3624 {
3625         local mnt_opts=$(_normalize_mount_options)
3626
3627         while [ $# -gt 0 ]; do
3628                 local pattern=$1
3629                 echo "$pattern" | egrep -q "dax(=always|$)" && \
3630                         pattern="dax(=always| |$)"
3631                 if echo $mnt_opts | egrep -q "$pattern"; then
3632                         _notrun "mount option \"$1\" not allowed in this test"
3633                 fi
3634                 shift
3635         done
3636 }
3637
3638 _require_atime()
3639 {
3640         _exclude_scratch_mount_option "noatime"
3641         case $FSTYP in
3642         nfs|cifs|virtiofs)
3643                 _notrun "atime related mount options have no effect on $FSTYP"
3644                 ;;
3645         esac
3646
3647 }
3648
3649 _require_relatime()
3650 {
3651         _scratch_mkfs > /dev/null 2>&1
3652         _try_scratch_mount -o relatime || \
3653                 _notrun "relatime not supported by the current kernel"
3654         _scratch_unmount
3655 }
3656
3657 _require_userns()
3658 {
3659         [ -x $here/src/nsexec ] || _notrun "src/nsexec executable not found"
3660         $here/src/nsexec -U true 2>/dev/null || _notrun "userns not supported by this kernel"
3661 }
3662
3663 _create_loop_device()
3664 {
3665         local file=$1 dev
3666         dev=`losetup -f --show $file` || _fail "Cannot assign $file to a loop device"
3667         echo $dev
3668 }
3669
3670 _destroy_loop_device()
3671 {
3672         local dev=$1
3673         losetup -d $dev || _fail "Cannot destroy loop device $dev"
3674 }
3675
3676 _scale_fsstress_args()
3677 {
3678     local args=""
3679     while [ $# -gt 0 ]; do
3680         case "$1" in
3681             -n) args="$args $1 $(($2 * $TIME_FACTOR))"; shift ;;
3682             -p) args="$args $1 $(($2 * $LOAD_FACTOR))"; shift ;;
3683             *) args="$args $1" ;;
3684         esac
3685         shift
3686     done
3687     printf '%s\n' "$args"
3688 }
3689
3690 #
3691 # Return the logical block size if running on a block device,
3692 # else substitute the page size.
3693 #
3694 _min_dio_alignment()
3695 {
3696     local dev=$1
3697
3698     if [ -b "$dev" ]; then
3699         blockdev --getss $dev
3700     else
3701         $here/src/feature -s
3702     fi
3703 }
3704
3705 run_check()
3706 {
3707         echo "# $@" >> $seqres.full 2>&1
3708         "$@" >> $seqres.full 2>&1 || _fail "failed: '$@'"
3709 }
3710
3711 _require_symlinks()
3712 {
3713         local target=`mktemp -p $TEST_DIR`
3714         local link=`mktemp -p $TEST_DIR -u`
3715         ln -s `basename $target` $link
3716         if [ "$?" -ne 0 ]; then
3717                 rm -f $target
3718                 _notrun "Require symlinks support"
3719         fi
3720         rm -f $target $link
3721 }
3722
3723 _require_hardlinks()
3724 {
3725         local target=`mktemp -p $TEST_DIR`
3726         local link=`mktemp -p $TEST_DIR -u`
3727         ln $target $link
3728         if [ "$?" -ne 0 ]; then
3729                 rm -f $target
3730                 _notrun "No hardlink support"
3731         fi
3732         rm -f $target $link
3733 }
3734
3735 _require_test_fcntl_advisory_locks()
3736 {
3737         [ "$FSTYP" != "cifs" ] && return 0
3738         cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -q "nobrl" && return 0
3739         cat /proc/mounts | grep $TEST_DEV | grep cifs | grep -qE "nounix|forcemand" && \
3740                 _notrun "Require fcntl advisory locks support"
3741 }
3742
3743 _require_test_fcntl_setlease()
3744 {
3745         _require_test_program "locktest"
3746         touch $TEST_DIR/setlease_testfile
3747         $here/src/locktest -t $TEST_DIR/setlease_testfile >/dev/null 2>&1
3748         [ $? -eq 22 ] && _notrun "Require fcntl setlease support"
3749 }
3750
3751 _require_ofd_locks()
3752 {
3753         # Give a test run by getlk wrlck on testfile.
3754         # If the running kernel does not support OFD locks,
3755         # EINVAL will be returned.
3756         _require_test_program "t_ofd_locks"
3757         touch $TEST_DIR/ofd_testfile
3758         $here/src/t_ofd_locks -t $TEST_DIR/ofd_testfile > /dev/null 2>&1
3759         [ $? -eq 22 ] && _notrun "Require OFD locks support"
3760 }
3761
3762 _require_test_lsattr()
3763 {
3764         local testio=$(lsattr -d $TEST_DIR 2>&1)
3765         echo $testio | grep -q "Operation not supported" && \
3766                 _notrun "lsattr not supported by test filesystem type: $FSTYP"
3767         echo $testio | grep -q "Inappropriate ioctl for device" && \
3768                 _notrun "lsattr not supported by test filesystem type: $FSTYP"
3769 }
3770
3771 _require_chattr()
3772 {
3773         if [ -z "$1" ]; then
3774                 echo "Usage: _require_chattr <attr>"
3775                 exit 1
3776         fi
3777         local attribute=$1
3778
3779         touch $TEST_DIR/syscalltest
3780         chattr "+$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
3781         local ret=$?
3782         chattr "-$attribute" $TEST_DIR/syscalltest > $TEST_DIR/syscalltest.out 2>&1
3783         if [ "$ret" -ne 0 ]; then
3784                 _notrun "file system doesn't support chattr +$attribute"
3785         fi
3786         cat $TEST_DIR/syscalltest.out >> $seqres.full
3787         rm -f $TEST_DIR/syscalltest.out
3788 }
3789
3790 _get_total_inode()
3791 {
3792         if [ -z "$1" ]; then
3793                 echo "Usage: _get_total_inode <mnt>"
3794                 exit 1
3795         fi
3796         local nr_inode;
3797         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $3}'`
3798         echo $nr_inode
3799 }
3800
3801 _get_used_inode()
3802 {
3803         if [ -z "$1" ]; then
3804                 echo "Usage: _get_used_inode <mnt>"
3805                 exit 1
3806         fi
3807         local nr_inode;
3808         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $4}'`
3809         echo $nr_inode
3810 }
3811
3812 _get_used_inode_percent()
3813 {
3814         if [ -z "$1" ]; then
3815                 echo "Usage: _get_used_inode_percent <mnt>"
3816                 exit 1
3817         fi
3818         local pct_inode;
3819         pct_inode=`$DF_PROG -i $1 | tail -1 | awk '{ print $6 }' | \
3820                    sed -e 's/%//'`
3821         echo $pct_inode
3822 }
3823
3824 _get_free_inode()
3825 {
3826         if [ -z "$1" ]; then
3827                 echo "Usage: _get_free_inode <mnt>"
3828                 exit 1
3829         fi
3830         local nr_inode;
3831         nr_inode=`$DF_PROG -i $1 | tail -1 | awk '{print $5}'`
3832         echo $nr_inode
3833 }
3834
3835 # get the available space in bytes
3836 #
3837 _get_available_space()
3838 {
3839         if [ -z "$1" ]; then
3840                 echo "Usage: _get_available_space <mnt>"
3841                 exit 1
3842         fi
3843         local avail_kb;
3844         avail_kb=`$DF_PROG $1 | tail -n1 | awk '{ print $5 }'`
3845         echo $((avail_kb * 1024))
3846 }
3847
3848 # return device size in kb
3849 _get_device_size()
3850 {
3851         echo $(($(blockdev --getsz $1) >> 1))
3852 }
3853
3854 # Make sure we actually have dmesg checking set up.
3855 _require_check_dmesg()
3856 {
3857         test -w /dev/kmsg || \
3858                 _notrun "Test requires writable /dev/kmsg."
3859 }
3860
3861 # Return the dmesg log since the start of this test.  Caller must ensure that
3862 # /dev/kmsg was writable when the test was started so that we can find the
3863 # beginning of this test's log messages; _require_check_dmesg does this.
3864 _dmesg_since_test_start()
3865 {
3866         # search the dmesg log of last run of $seqnum for possible failures
3867         # use sed \cregexpc address type, since $seqnum contains "/"
3868         dmesg | tac | sed -ne "0,\#run fstests $seqnum at $date_time#p" | \
3869                 tac
3870 }
3871
3872 # check dmesg log for a specific string, subject to the same requirements as
3873 # _dmesg_since_test_start.
3874 _check_dmesg_for()
3875 {
3876         _dmesg_since_test_start | egrep -q "$1"
3877 }
3878
3879 # Default filter for dmesg scanning.
3880 # Ignore lockdep complaining about its own bugginess when scanning dmesg
3881 # output, because we shouldn't be failing filesystem tests on account of
3882 # lockdep.
3883 _check_dmesg_filter()
3884 {
3885         egrep -v -e "BUG: MAX_LOCKDEP_CHAIN_HLOCKS too low" \
3886                 -e "BUG: MAX_STACK_TRACE_ENTRIES too low"
3887 }
3888
3889 # check dmesg log for WARNING/Oops/etc.
3890 _check_dmesg()
3891 {
3892         if [ ! -f ${RESULT_DIR}/check_dmesg ]; then
3893                 return 0
3894         fi
3895         rm -f ${RESULT_DIR}/check_dmesg
3896
3897         # default filter is a simple cat command, caller could provide a
3898         # customized filter and pass the name through the first argument, to
3899         # filter out intentional WARNINGs or Oopses
3900         local filter=${1:-_check_dmesg_filter}
3901
3902         _dmesg_since_test_start | $filter >$seqres.dmesg
3903         egrep -q -e "kernel BUG at" \
3904              -e "WARNING:" \
3905              -e "\bBUG:" \
3906              -e "Oops:" \
3907              -e "possible recursive locking detected" \
3908              -e "Internal error" \
3909              -e "(INFO|ERR): suspicious RCU usage" \
3910              -e "INFO: possible circular locking dependency detected" \
3911              -e "general protection fault:" \
3912              -e "BUG .* remaining" \
3913              -e "UBSAN:" \
3914              $seqres.dmesg
3915         if [ $? -eq 0 ]; then
3916                 _dump_err "_check_dmesg: something found in dmesg (see $seqres.dmesg)"
3917                 return 1
3918         else
3919                 if [ "$KEEP_DMESG" != "yes" ]; then
3920                         rm -f $seqres.dmesg
3921                 fi
3922                 return 0
3923         fi
3924 }
3925
3926 # capture the kmemleak report
3927 _capture_kmemleak()
3928 {
3929         local kern_knob="$DEBUGFS_MNT/kmemleak"
3930         local leak_file="$1"
3931
3932         # Tell the kernel to scan for memory leaks.  Apparently the write
3933         # returns before the scan is complete, so do it twice in the hopes
3934         # that twice is enough to capture all the leaks.
3935         echo "scan" > "$kern_knob"
3936         cat "$kern_knob" > /dev/null
3937         echo "scan" > "$kern_knob"
3938         cat "$kern_knob" > "$leak_file.tmp"
3939         if [ -s "$leak_file.tmp" ]; then
3940                 cat > "$leak_file" << ENDL
3941 EXPERIMENTAL kmemleak reported some memory leaks!  Due to the way kmemleak
3942 works, the leak might be from an earlier test, or something totally unrelated.
3943 ENDL
3944                 cat "$leak_file.tmp" >> "$leak_file"
3945         fi
3946         rm -rf "$leak_file.tmp"
3947         echo "clear" > "$kern_knob"
3948 }
3949
3950 # Figure out if the running kernel supports kmemleak; if it does, clear out
3951 # anything that leaked before we even started testing.  The leak checker only
3952 # needs to be primed like this once per ./check invocation.
3953 _detect_kmemleak()
3954 {
3955         local kern_knob="$DEBUGFS_MNT/kmemleak"
3956         KMEMLEAK_CHECK_FILE="/tmp/check_kmemleak"
3957
3958         # Since kernel v4.19-rc3, the kmemleak knob exists even if kmemleak is
3959         # disabled, but returns EBUSY on write. So instead of relying on
3960         # existance of writable knob file, we use a test file to indicate that
3961         # _check_kmemleak() is enabled only if we actually managed to write to
3962         # the knob file.
3963         rm -f "$KMEMLEAK_CHECK_FILE"
3964
3965         if [ ! -w "$kern_knob" ]; then
3966                 return 0
3967         fi
3968
3969         # Disable the automatic scan so that we can control it completely,
3970         # then dump all the leaks recorded so far.
3971         if echo "scan=off" > "$kern_knob" 2>/dev/null; then
3972                 _capture_kmemleak /dev/null
3973                 touch "$KMEMLEAK_CHECK_FILE"
3974         fi
3975 }
3976
3977 # Kick the kmemleak checker to scan for leaks.  Background leak scan mode is
3978 # not enabled, so we must call the kernel to ask for a scan and deal with the
3979 # results appropriately.  This we do after every test completes, whether or not
3980 # it was successful.
3981 _check_kmemleak()
3982 {
3983         local kern_knob="$DEBUGFS_MNT/kmemleak"
3984         local leak_file="$seqres.kmemleak"
3985
3986         if [ ! -f "$KMEMLEAK_CHECK_FILE" ]; then
3987                 return 0
3988         fi
3989
3990         # Not enabled, so discard any report of leaks found.
3991         if [ "$USE_KMEMLEAK" != "yes" ]; then
3992                 _capture_kmemleak /dev/null
3993                 return 0
3994         fi
3995
3996         # Capture and report any leaks
3997         _capture_kmemleak "$leak_file"
3998         if [ -s "$leak_file" ]; then
3999                 _dump_err "_check_kmemleak: something found in kmemleak (see $leak_file)"
4000                 return 1
4001         else
4002                 rm -f "$leak_file"
4003                 return 0
4004         fi
4005 }
4006
4007 # don't check dmesg log after test
4008 _disable_dmesg_check()
4009 {
4010         rm -f ${RESULT_DIR}/check_dmesg
4011 }
4012
4013 init_rc()
4014 {
4015         # make some further configuration checks here
4016         if [ "$TEST_DEV" = ""  ]
4017         then
4018                 echo "common/rc: Error: \$TEST_DEV is not set"
4019                 exit 1
4020         fi
4021
4022         # if $TEST_DEV is not mounted, mount it now as XFS
4023         if [ -z "`_fs_type $TEST_DEV`" ]
4024         then
4025                 # $TEST_DEV is not mounted
4026                 if ! _test_mount
4027                 then
4028                         echo "common/rc: retrying test device mount with external set"
4029                         [ "$USE_EXTERNAL" != "yes" ] && export USE_EXTERNAL=yes
4030                         if ! _test_mount
4031                         then
4032                                 echo "common/rc: could not mount $TEST_DEV on $TEST_DIR"
4033                                 exit 1
4034                         fi
4035                 fi
4036         fi
4037
4038         # Sanity check that TEST partition is not mounted at another mount point
4039         # or as another fs type
4040         _check_mounted_on TEST_DEV $TEST_DEV TEST_DIR $TEST_DIR $FSTYP || exit 1
4041         if [ -n "$SCRATCH_DEV" ]; then
4042                 # Sanity check that SCRATCH partition is not mounted at another
4043                 # mount point, because it is about to be unmounted and formatted.
4044                 # Another fs type for scratch is fine (bye bye old fs type).
4045                 _check_mounted_on SCRATCH_DEV $SCRATCH_DEV SCRATCH_MNT $SCRATCH_MNT
4046                 [ $? -le 1 ] || exit 1
4047         fi
4048
4049         # Figure out if we need to add -F ("foreign", deprecated) option to xfs_io
4050         $XFS_IO_PROG -c stat $TEST_DIR 2>&1 | grep -q "is not on an XFS filesystem" && \
4051                 export XFS_IO_PROG="$XFS_IO_PROG -F"
4052
4053         # xfs_io -i option starts an idle thread for xfs_io.
4054         # With single threaded process, the file table is not shared
4055         # and file structs are not reference counted.
4056         # Spawning an idle thread can help detecting file struct
4057         # reference leaks, so we want to enable the option whenever
4058         # it is supported.
4059         $XFS_IO_PROG -i -c quit 2>/dev/null && \
4060                 export XFS_IO_PROG="$XFS_IO_PROG -i"
4061
4062         # xfs_copy on v5 filesystems do not require the "-d" option if xfs_db
4063         # can change the UUID on v5 filesystems
4064         if [ "$FSTYP" == "xfs" ]; then
4065                 touch /tmp/$$.img
4066                 $MKFS_XFS_PROG -d file,name=/tmp/$$.img,size=512m >/dev/null 2>&1
4067                 # xfs_db will return 0 even if it can't generate a new uuid, so
4068                 # check the output to make sure if it can change UUID of V5 xfs
4069                 $XFS_DB_PROG -x -c "uuid generate" /tmp/$$.img \
4070                         | grep -q "invalid UUID\|supported on V5 fs" \
4071                         && export XFS_COPY_PROG="$XFS_COPY_PROG -d"
4072                 rm -f /tmp/$$.img
4073         fi
4074 }
4075
4076 # get real device path name by following link
4077 _real_dev()
4078 {
4079         local dev=$1
4080         if [ -b "$dev" ] && [ -L "$dev" ]; then
4081                 dev=`readlink -f "$dev"`
4082         fi
4083         echo $dev
4084 }
4085
4086 # basename of a device
4087 _short_dev()
4088 {
4089         echo `basename $(_real_dev $1)`
4090 }
4091
4092 _sysfs_dev()
4093 {
4094         local dev=`_real_dev $1`
4095         local maj=$(stat -c%t $dev | tr [:lower:] [:upper:])
4096         local min=$(stat -c%T $dev | tr [:lower:] [:upper:])
4097         maj=$(echo "ibase=16; $maj" | bc)
4098         min=$(echo "ibase=16; $min" | bc)
4099         echo /sys/dev/block/$maj:$min
4100 }
4101
4102 # Get the minimum block size of a file.  Usually this is the
4103 # minimum fs block size, but some filesystems (ocfs2) do block
4104 # mappings in larger units.
4105 _get_file_block_size()
4106 {
4107         if [ -z $1 ] || [ ! -d $1 ]; then
4108                 echo "Missing mount point argument for _get_file_block_size"
4109                 exit 1
4110         fi
4111
4112         case "$FSTYP" in
4113         "ocfs2")
4114                 stat -c '%o' $1
4115                 ;;
4116         "xfs")
4117                 _xfs_get_file_block_size $1
4118                 ;;
4119         *)
4120                 _get_block_size $1
4121                 ;;
4122         esac
4123 }
4124
4125 # Get the minimum block size of an fs.
4126 _get_block_size()
4127 {
4128         if [ -z $1 ] || [ ! -d $1 ]; then
4129                 echo "Missing mount point argument for _get_block_size"
4130                 exit 1
4131         fi
4132         stat -f -c %S $1
4133 }
4134
4135 # Require that the fundamental allocation unit of a file is the same as the
4136 # filesystem block size.
4137 _require_file_block_size_equals_fs_block_size()
4138 {
4139         local file_alloc_unit="$(_get_file_block_size $1)"
4140         local fs_block_size="$(_get_block_size $1)"
4141         test "$file_alloc_unit" != "$fs_block_size" && \
4142                 _notrun "File allocation unit is larger than a filesystem block"
4143 }
4144
4145 get_page_size()
4146 {
4147         echo $(getconf PAGE_SIZE)
4148 }
4149
4150
4151 run_fsx()
4152 {
4153         echo fsx $@
4154         local args=`echo $@ | sed -e "s/ BSIZE / $bsize /g" -e "s/ PSIZE / $psize /g"`
4155         set -- $here/ltp/fsx $args $FSX_AVOID $TEST_DIR/junk
4156         echo "$@" >>$seqres.full
4157         rm -f $TEST_DIR/junk
4158         "$@" 2>&1 | tee -a $seqres.full >$tmp.fsx
4159         if [ ${PIPESTATUS[0]} -ne 0 ]; then
4160                 cat $tmp.fsx
4161                 rm -f $tmp.fsx
4162                 exit 1
4163         fi
4164         rm -f $tmp.fsx
4165 }
4166
4167 # Test for the existence of a sysfs entry at /sys/fs/$FSTYP/DEV/$ATTR
4168 #
4169 # Only one argument is needed:
4170 #  - attr: path name under /sys/fs/$FSTYP/DEV
4171 #
4172 # Usage example:
4173 #   _require_fs_sysfs error/fail_at_unmount
4174 _require_fs_sysfs()
4175 {
4176         local attr=$1
4177         local dname=$(_short_dev $TEST_DEV)
4178
4179         if [ -z "$attr" -o -z "$dname" ];then
4180                 _fail "Usage: _require_fs_sysfs <sysfs_attr_path>"
4181         fi
4182
4183         if [ ! -e /sys/fs/${FSTYP}/${dname}/${attr} ];then
4184                 _notrun "This test requires /sys/fs/${FSTYP}/${dname}/${attr}"
4185         fi
4186 }
4187
4188 _require_statx()
4189 {
4190         $here/src/stat_test --check-statx ||
4191         _notrun "This test requires the statx system call"
4192 }
4193
4194 # Write "content" into /sys/fs/$FSTYP/$DEV/$ATTR
4195 #
4196 # All arguments are necessary, and in this order:
4197 #  - dev: device name, e.g. $SCRATCH_DEV
4198 #  - attr: path name under /sys/fs/$FSTYP/$dev
4199 #  - content: the content of $attr
4200 #
4201 # Usage example:
4202 #   _set_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount 0
4203 _set_fs_sysfs_attr()
4204 {
4205         local dev=$1
4206         shift
4207         local attr=$1
4208         shift
4209         local content="$*"
4210
4211         if [ ! -b "$dev" -o -z "$attr" -o -z "$content" ];then
4212                 _fail "Usage: _set_fs_sysfs_attr <mounted_device> <attr> <content>"
4213         fi
4214
4215         local dname=$(_short_dev $dev)
4216         echo "$content" > /sys/fs/${FSTYP}/${dname}/${attr}
4217 }
4218
4219 # Print the content of /sys/fs/$FSTYP/$DEV/$ATTR
4220 #
4221 # All arguments are necessary, and in this order:
4222 #  - dev: device name, e.g. $SCRATCH_DEV
4223 #  - attr: path name under /sys/fs/$FSTYP/$dev
4224 #
4225 # Usage example:
4226 #   _get_fs_sysfs_attr /dev/mapper/scratch-dev error/fail_at_unmount
4227 _get_fs_sysfs_attr()
4228 {
4229         local dev=$1
4230         local attr=$2
4231
4232         if [ ! -b "$dev" -o -z "$attr" ];then
4233                 _fail "Usage: _get_fs_sysfs_attr <mounted_device> <attr>"
4234         fi
4235
4236         local dname=$(_short_dev $dev)
4237         cat /sys/fs/${FSTYP}/${dname}/${attr}
4238 }
4239
4240 # Generic test for specific filesystem feature.
4241 # Currently only implemented to test overlayfs features.
4242 _require_scratch_feature()
4243 {
4244         local feature=$1
4245
4246         case "$FSTYP" in
4247         overlay)
4248                 _require_scratch_overlay_features ${feature}
4249                 ;;
4250         *)
4251                 _fail "Test for feature '${feature}' of ${FSTYP} is not implemented"
4252                 ;;
4253         esac
4254 }
4255
4256 # Get the maximum size of a file in $TEST_DIR (s_maxbytes).  On ext4 this will
4257 # be UINT32_MAX * block_size, but other filesystems may allow up to LLONG_MAX.
4258 _get_max_file_size()
4259 {
4260         local testfile=$TEST_DIR/maxfilesize.$seq
4261         local l=0
4262         local r=9223372036854775807 # LLONG_MAX
4263
4264         rm -f $testfile
4265         while (( l < r )); do
4266                 # Use _math() to avoid signed integer overflow.
4267                 local m=$(_math "($l + $r + 1) / 2")
4268                 if $XFS_IO_PROG -f -c "truncate $m" $testfile \
4269                         |& grep -q 'File too large'
4270                 then
4271                         r=$(( m - 1 ))
4272                 else
4273                         l=$m
4274                 fi
4275         done
4276         echo $l
4277 }
4278
4279 # get MAX_LFS_FILESIZE
4280 _get_max_lfs_filesize()
4281 {
4282         case "$(getconf LONG_BIT)" in
4283         "32")
4284                 local ulong_max=$(getconf ULONG_MAX)
4285                 local page_size=$(getconf PAGE_SIZE)
4286                 echo $(( ulong_max * page_size ))
4287                 ;;
4288         "64")
4289                 echo 9223372036854775807
4290                 ;;
4291         *)
4292                 _fail "sizeof(long) == $(getconf LONG_BIT)?"
4293                 ;;
4294         esac
4295 }
4296
4297 # The maximum filesystem label length, /not/ including terminating NULL
4298 _label_get_max()
4299 {
4300         case $FSTYP in
4301         xfs)
4302                 echo 12
4303                 ;;
4304         btrfs)
4305                 echo 255
4306                 ;;
4307         f2fs)
4308                 echo 255
4309                 ;;
4310         *)
4311                 _notrun "$FSTYP does not define maximum label length"
4312                 ;;
4313         esac
4314 }
4315
4316 # Helper to check above early in a script
4317 _require_label_get_max()
4318 {
4319         # Just call _label_get_max which will notrun if appropriate
4320         dummy=$(_label_get_max)
4321 }
4322
4323 _dmsetup_remove()
4324 {
4325         $UDEV_SETTLE_PROG >/dev/null 2>&1
4326         $DMSETUP_PROG remove "$@" >>$seqres.full 2>&1
4327         $DMSETUP_PROG mknodes >/dev/null 2>&1
4328 }
4329
4330 _dmsetup_create()
4331 {
4332         $DMSETUP_PROG create "$@" >>$seqres.full 2>&1 || return 1
4333         $DMSETUP_PROG mknodes >/dev/null 2>&1
4334         $UDEV_SETTLE_PROG >/dev/null 2>&1
4335 }
4336
4337 _require_btime()
4338 {
4339         # Note: filesystems are not required to report btime (creation time)
4340         # if the caller doesn't ask for it, so we define STATX_BTIME here and
4341         # pass it in to the statx command.
4342         export STATX_BTIME=0x800
4343         $XFS_IO_PROG -f $TEST_DIR/test_creation_time -c "statx -m $STATX_BTIME -v" \
4344                 | grep btime >>$seqres.full 2>&1 || \
4345                 _notrun "inode creation time not supported by this filesystem"
4346         rm -f $TEST_DIR/test_creation_time
4347 }
4348
4349 _require_scratch_btime()
4350 {
4351         _require_scratch
4352         _scratch_mkfs > /dev/null 2>&1
4353         _scratch_mount
4354
4355         # Note: filesystems are not required to report btime (creation time)
4356         # if the caller doesn't ask for it, so we define STATX_BTIME here and
4357         # pass it in to the statx command.
4358         export STATX_BTIME=0x800
4359         $XFS_IO_PROG -f $SCRATCH_MNT/test_creation_time -c "statx -m $STATX_BTIME -v" \
4360                 | grep btime >>$seqres.full 2>&1 || \
4361                 _notrun "inode creation time not supported by this filesystem"
4362