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