2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2000-2003,2006 Silicon Graphics, Inc. All Rights Reserved.
5 # setup and check for config parameters, and in particular
7 # EMAIL - email of the script runner.
8 # TEST_DIR - scratch test directory that is in an already
9 # mounted XFS file system, needs to be be world
11 # TEST_DEV - device for file system containing TEST_DIR
14 # SCRATCH_DEV - device you can make a scratch file system on
15 # SCRATCH_MNT - mount point for scratch file system
16 # SCRATCH_LOGDEV - scratch log device for external log testing
17 # SCRATCH_RTDEV - scratch rt dev
18 # TEST_LOGDEV - test log device for external log testing
19 # TEST_RTDEV - test rt dev
20 # TAPE_DEV - the tape device for the xfsdump tests
21 # RMT_TAPE_DEV - the remote tape device for the xfsdump tests
22 # RMT_IRIXTAPE_DEV- the IRIX remote tape device for the xfsdump tests
23 # RMT_TAPE_USER - remote user for tape device
24 # SELINUX_MOUNT_OPTIONS - Options to use when SELinux is enabled.
25 # KEEP_DMESG - whether to keep all dmesg for each test case.
27 # no: only keep dmesg with error/warning (default)
29 # - These can be added to $HOST_CONFIG_DIR (witch default to ./config)
30 # below or a separate local configuration file can be used (using
31 # the HOST_OPTIONS variable).
32 # - This script is shared by the stress test system and the auto-qa
34 # - TEST_DEV & TEST_DIR must be assigned.
35 # - this script shouldn't make any assertions about filesystem
36 # validity or mountedness.
41 # all tests should use a common language setting to prevent golden
48 export HOST=`hostname -s`
49 test `uname -s` = "Linux" || _fatal "fstests only supports Linux"
51 export MODULAR=0 # using XFS as a module or not
52 export BOOT="/boot" # install target for kernels
53 export EXTRA=${EXTRA:=xfs-qa}
55 # general parameters (mainly for auto-qa)
56 export SOAK_PROC=3 # -p option to fsstress
57 export SOAK_STRESS=10000 # -n option to fsstress
58 export SOAK_PASSES=-1 # count of repetitions of fsstress (while soaking)
59 export EMAIL=root@localhost # where auto-qa will send its status messages
60 export HOST_OPTIONS=${HOST_OPTIONS:=local.config}
61 export CHECK_OPTIONS=${CHECK_OPTIONS:="-g auto"}
62 export BENCH_PASSES=${BENCH_PASSES:=5}
63 export TIME_FACTOR=${TIME_FACTOR:=1}
64 export LOAD_FACTOR=${LOAD_FACTOR:=1}
65 export DEBUGFS_MNT=${DEBUGFS_MNT:="/sys/kernel/debug"}
67 # some constants for overlayfs setup
68 export OVL_UPPER="ovl-upper"
69 export OVL_LOWER="ovl-lower"
70 export OVL_WORK="ovl-work"
71 # overlay mount point parent must be the base fs root
72 export OVL_MNT="ovl-mnt"
73 # By default unionmount-testsuite is expected under src
74 export UNIONMOUNT_TESTSUITE=${UNIONMOUNT_TESTSUITE:=$here/src/unionmount-testsuite}
76 # From e2fsprogs/e2fsck/e2fsck.h:
77 # Exit code used by fsck-type programs
79 export FSCK_NONDESTRUCT=1
81 export FSCK_UNCORRECTED=4
84 export FSCK_CANCELED=32
85 export FSCK_LIBRARY=128
88 #export DEBUG=${DEBUG:=...} # arbitrary CFLAGS really.
89 export MALLOCLIB=${MALLOCLIB:=/usr/lib/libefence.a}
90 export LOCAL_CONFIGURE_OPTIONS=${LOCAL_CONFIGURE_OPTIONS:=--enable-readline=yes}
92 export RECREATE_TEST_DEV=false
94 # Handle mkfs.$fstyp which does (or does not) require -f to overwrite
95 set_mkfs_prog_path_with_opts()
98 local p=$(type -P mkfs.$fstyp)
100 # Note: mkfs.f2fs doesn't support the --help option yet, but it doesn't
101 # matter since it also prints the help when an invalid option is given.
102 if [ "$p" != "" ] && \
103 $p --help |& grep -q "[[:space:]]-f[[:space:]|]"; then
117 export MKFS_PROG="$(type -P mkfs)"
118 [ "$MKFS_PROG" = "" ] && _fatal "mkfs not found"
120 export MOUNT_PROG="$(type -P mount)"
121 [ "$MOUNT_PROG" = "" ] && _fatal "mount not found"
123 export UMOUNT_PROG="$(type -P umount)"
124 [ "$UMOUNT_PROG" = "" ] && _fatal "umount not found"
126 export FSSTRESS_PROG="./ltp/fsstress"
127 [ ! -x $FSSTRESS_PROG ] && _fatal "fsstress not found or executable"
129 export PERL_PROG="$(type -P perl)"
130 [ "$PERL_PROG" = "" ] && _fatal "perl not found"
132 export AWK_PROG="$(type -P awk)"
133 [ "$AWK_PROG" = "" ] && _fatal "awk not found"
135 export SED_PROG="$(type -P sed)"
136 [ "$SED_PROG" = "" ] && _fatal "sed not found"
138 export BC_PROG="$(type -P bc)"
139 [ "$BC_PROG" = "" ] && _fatal "bc not found"
141 export PS_ALL_FLAGS="-ef"
143 export DF_PROG="$(type -P df)"
144 [ "$DF_PROG" = "" ] && _fatal "df not found"
145 export DF_PROG="$DF_PROG -T -P" # Linux
147 export XFS_IO_PROG="$(type -P xfs_io)"
148 [ "$XFS_IO_PROG" = "" ] && _fatal "xfs_io not found"
150 export MKSWAP_PROG="$(type -P mkswap)"
151 # mkswap from util-linux v2.17.2 or older needs "-f" option to force to erase
153 MKSWAP_PROG="$MKSWAP_PROG -f"
155 export XFS_LOGPRINT_PROG="$(type -P xfs_logprint)"
156 export XFS_REPAIR_PROG="$(type -P xfs_repair)"
157 export XFS_DB_PROG="$(type -P xfs_db)"
158 export XFS_METADUMP_PROG="$(type -P xfs_metadump)"
159 export XFS_ADMIN_PROG="$(type -P xfs_admin)"
160 export XFS_GROWFS_PROG=$(type -P xfs_growfs)
161 export XFS_SPACEMAN_PROG="$(type -P xfs_spaceman)"
162 export XFS_SCRUB_PROG="$(type -P xfs_scrub)"
163 export XFS_PARALLEL_REPAIR_PROG="$(type -P xfs_prepair)"
164 export XFS_PARALLEL_REPAIR64_PROG="$(type -P xfs_prepair64)"
165 export __XFSDUMP_PROG="$(type -P xfsdump)"
166 if [ -n "$__XFSDUMP_PROG" ]; then
167 export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
169 export XFSDUMP_PROG=""
171 export XFSRESTORE_PROG="$(type -P xfsrestore)"
172 export XFSINVUTIL_PROG="$(type -P xfsinvutil)"
173 export GETFATTR_PROG="$(type -P getfattr)"
174 export SETFATTR_PROG="$(type -P setfattr)"
175 export CHACL_PROG="$(type -P chacl)"
176 export ATTR_PROG="$(type -P attr)"
177 export QUOTA_PROG="$(type -P quota)"
178 export XFS_QUOTA_PROG="$(type -P xfs_quota)"
179 export KILLALL_PROG="$(type -P killall)"
180 export INDENT_PROG="$(type -P indent)"
181 export XFS_COPY_PROG="$(type -P xfs_copy)"
182 export FSTRIM_PROG="$(type -P fstrim)"
183 export DUMPE2FS_PROG="$(type -P dumpe2fs)"
184 export RESIZE2FS_PROG="$(type -P resize2fs)"
185 export F2FS_IO_PROG="$(type -P f2fs_io)"
186 export FIO_PROG="$(type -P fio)"
187 export FILEFRAG_PROG="$(type -P filefrag)"
188 export E4DEFRAG_PROG="$(type -P e4defrag)"
189 export LOGGER_PROG="$(type -P logger)"
190 export DBENCH_PROG="$(type -P dbench)"
191 export DMSETUP_PROG="$(type -P dmsetup)"
192 export WIPEFS_PROG="$(type -P wipefs)"
193 export BLKDISCARD_PROG="$(type -P blkdiscard)"
194 export DUMP_PROG="$(type -P dump)"
195 export RESTORE_PROG="$(type -P restore)"
196 export LVM_PROG="$(type -P lvm)"
197 export LSATTR_PROG="$(type -P lsattr)"
198 export CHATTR_PROG="$(type -P chattr)"
199 export DEBUGFS_PROG="$(type -P debugfs)"
200 export UUIDGEN_PROG="$(type -P uuidgen)"
201 export GETRICHACL_PROG="$(type -P getrichacl)"
202 export SETRICHACL_PROG="$(type -P setrichacl)"
203 export KEYCTL_PROG="$(type -P keyctl)"
204 export XZ_PROG="$(type -P xz)"
205 export LZ4_PROG="$(type -P lz4)"
206 export FLOCK_PROG="$(type -P flock)"
207 export LDD_PROG="$(type -P ldd)"
208 export TIMEOUT_PROG="$(type -P timeout)"
209 export MAN_PROG="$(type -P man)"
210 export NFS4_SETFACL_PROG="$(type -P nfs4_setfacl)"
211 export NFS4_GETFACL_PROG="$(type -P nfs4_getfacl)"
212 export UBIUPDATEVOL_PROG="$(type -P ubiupdatevol)"
213 export THIN_CHECK_PROG="$(type -P thin_check)"
214 export PYTHON2_PROG="$(type -P python2)"
215 export SQLITE3_PROG="$(type -P sqlite3)"
216 export TIMEOUT_PROG="$(type -P timeout)"
217 export SETCAP_PROG="$(type -P setcap)"
218 export GETCAP_PROG="$(type -P getcap)"
219 export CAPSH_PROG="$(type -P capsh)"
220 export CHECKBASHISMS_PROG="$(type -P checkbashisms)"
221 export XFS_INFO_PROG="$(type -P xfs_info)"
222 export DUPEREMOVE_PROG="$(type -P duperemove)"
223 export CC_PROG="$(type -P cc)"
224 export FSVERITY_PROG="$(type -P fsverity)"
225 export OPENSSL_PROG="$(type -P openssl)"
226 export ACCTON_PROG="$(type -P accton)"
227 export E2IMAGE_PROG="$(type -P e2image)"
228 export BLKZONE_PROG="$(type -P blkzone)"
229 export GZIP_PROG="$(type -P gzip)"
230 export BTRFS_IMAGE_PROG="$(type -P btrfs-image)"
232 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
233 # newer systems have udevadm command but older systems like RHEL5 don't.
234 # But if neither one is available, just set it to "sleep 1" to wait for lv to
236 UDEV_SETTLE_PROG="$(type -P udevadm)"
237 if [ "$UDEV_SETTLE_PROG" == "" ]; then
238 # try udevsettle command
239 UDEV_SETTLE_PROG="$(type -P udevsettle)"
241 # udevadm is available, add 'settle' as subcommand
242 UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
244 # neither command is available, use sleep 1
246 # Udev events are sent via netlink to userspace through
247 # kobject_uevent_net_broadcast(), and udev in userspace is in charge of
248 # handling the events. The command `udevadm settle` just checks if
249 # /run/udev/queue is 0, however, a kernel without CONFIG_NET will have
250 # kobject_uevent_net_broadcast() be a no-op, and so /run/udev/queue may not
251 # exist or always be 0. We check for /proc/net to see CONFIG_NET was enabled.
252 if [[ "$UDEV_SETTLE_PROG" == "" || ! -d /proc/net ]]; then
253 UDEV_SETTLE_PROG="sleep 1"
255 export UDEV_SETTLE_PROG
257 # Set MODPROBE_PATIENT_RM_TIMEOUT_SECONDS to "forever" if you want the patient
258 # modprobe removal to run forever trying to remove a module.
259 MODPROBE_REMOVE_PATIENT=""
260 modprobe --help >& /dev/null && modprobe --help | grep -q -1 "remove-patiently"
261 if [[ $? -ne 0 ]]; then
262 if [[ -z "$MODPROBE_PATIENT_RM_TIMEOUT_SECONDS" ]]; then
263 # We will open code our own implementation of patient module
264 # remover in fstests. Use a 50 second default.
265 export MODPROBE_PATIENT_RM_TIMEOUT_SECONDS="50"
268 MODPROBE_RM_PATIENT_TIMEOUT_ARGS=""
269 if [[ ! -z "$MODPROBE_PATIENT_RM_TIMEOUT_SECONDS" ]]; then
270 if [[ "$MODPROBE_PATIENT_RM_TIMEOUT_SECONDS" != "forever" ]]; then
271 MODPROBE_PATIENT_RM_TIMEOUT_MS="$((MODPROBE_PATIENT_RM_TIMEOUT_SECONDS * 1000))"
272 MODPROBE_RM_PATIENT_TIMEOUT_ARGS="-t $MODPROBE_PATIENT_RM_TIMEOUT_MS"
275 # We export MODPROBE_PATIENT_RM_TIMEOUT_SECONDS here for parity
276 # with environments without support for modprobe -p, but we
277 # only really need it exported right now for environments which
278 # don't have support for modprobe -p to implement our own
279 # patient module removal support within fstests.
280 export MODPROBE_PATIENT_RM_TIMEOUT_SECONDS="50"
281 MODPROBE_PATIENT_RM_TIMEOUT_MS="$((MODPROBE_PATIENT_RM_TIMEOUT_SECONDS * 1000))"
282 MODPROBE_RM_PATIENT_TIMEOUT_ARGS="-t $MODPROBE_PATIENT_RM_TIMEOUT_MS"
284 MODPROBE_REMOVE_PATIENT="modprobe -p $MODPROBE_RM_PATIENT_TIMEOUT_ARGS"
286 export MODPROBE_REMOVE_PATIENT
288 export MKFS_XFS_PROG=$(type -P mkfs.xfs)
289 export MKFS_EXT4_PROG=$(type -P mkfs.ext4)
290 export MKFS_UDF_PROG=$(type -P mkudffs)
291 export MKFS_BTRFS_PROG=$(set_mkfs_prog_path_with_opts btrfs)
292 export MKFS_F2FS_PROG=$(set_mkfs_prog_path_with_opts f2fs)
293 export DUMP_F2FS_PROG=$(type -P dump.f2fs)
294 export F2FS_IO_PROG=$(type -P f2fs_io)
295 export BTRFS_UTIL_PROG=$(type -P btrfs)
296 export BTRFS_SHOW_SUPER_PROG=$(type -P btrfs-show-super)
297 export BTRFS_CONVERT_PROG=$(type -P btrfs-convert)
298 export BTRFS_TUNE_PROG=$(type -P btrfstune)
299 export XFS_FSR_PROG=$(type -P xfs_fsr)
300 export MKFS_NFS_PROG="false"
301 export MKFS_CIFS_PROG="false"
302 export MKFS_OVERLAY_PROG="false"
303 export MKFS_REISER4_PROG=$(type -P mkfs.reiser4)
304 export E2FSCK_PROG=$(type -P e2fsck)
305 export TUNE2FS_PROG=$(type -P tune2fs)
306 export FSCK_OVERLAY_PROG=$(type -P fsck.overlay)
308 # SELinux adds extra xattrs which can mess up our expected output.
309 # So, mount with a context, and they won't be created.
311 # Since the context= option only accepts contexts defined in the SELinux
312 # policy, and different systems may have different policies with
313 # different context names, use the context of an existing directory.
314 # Assume that any valid context is fine, since xfstests should really
315 # only be run from an "unconfined" process, or with SELinux in permissive
316 # mode. But if not, just specify your own SELINUX_MOUNT_OPTIONS.
317 if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
318 : ${SELINUX_MOUNT_OPTIONS:="-o context=$(stat -c %C /)"}
319 export SELINUX_MOUNT_OPTIONS
322 # check if mkfs.xfs supports v5 xfs
323 if [ "$FSTYP" == "xfs" ]; then
324 XFS_MKFS_HAS_NO_META_SUPPORT=""
325 touch /tmp/crc_check.img
326 $MKFS_XFS_PROG -N -d file,name=/tmp/crc_check.img,size=32m -m crc=0 \
328 if [ $? -ne 0 ]; then
329 XFS_MKFS_HAS_NO_META_SUPPORT=true
331 rm -f /tmp/crc_check.img
332 export XFS_MKFS_HAS_NO_META_SUPPORT
339 export MOUNT_OPTIONS=$PLAN9_MOUNT_OPTIONS
342 export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
345 export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
348 export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
351 export MOUNT_OPTIONS=$CIFS_MOUNT_OPTIONS
354 export MOUNT_OPTIONS=$CEPHFS_MOUNT_OPTIONS
357 export MOUNT_OPTIONS=$GLUSTERFS_MOUNT_OPTIONS
360 export MOUNT_OPTIONS=$OVERLAY_MOUNT_OPTIONS
362 ext2|ext3|ext4|ext4dev)
363 # acls & xattrs aren't turned on by default on ext$FOO
364 export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
367 export MOUNT_OPTIONS="-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
370 # acls & xattrs aren't turned on by default on reiserfs
371 export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
374 # acls & xattrs aren't supported by reiser4
375 export MOUNT_OPTIONS=$REISER4_MOUNT_OPTIONS
378 # acls aren't turned on by default on gfs2
379 export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
382 # We need to specify the size at mount, use 1G by default
383 export MOUNT_OPTIONS="-o size=1G $TMPFS_MOUNT_OPTIONS"
386 export MOUNT_OPTIONS=$UBIFS_MOUNT_OPTIONS
397 export TEST_FS_MOUNT_OPTS=$PLAN9_MOUNT_OPTIONS
400 export TEST_FS_MOUNT_OPTS=$CIFS_MOUNT_OPTIONS
403 export TEST_FS_MOUNT_OPTS=$CEPHFS_MOUNT_OPTIONS
406 export TEST_FS_MOUNT_OPTS=$NFS_MOUNT_OPTIONS
409 export TEST_FS_MOUNT_OPTS=$GLUSTERFS_MOUNT_OPTIONS
411 ext2|ext3|ext4|ext4dev)
412 # acls & xattrs aren't turned on by default on older ext$FOO
413 export TEST_FS_MOUNT_OPTS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
424 export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
427 [ ! -z "$udf_fsize" ] && \
428 UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
429 export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
432 export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
435 export MKFS_OPTIONS=$CIFS_MKFS_OPTIONS
438 export MKFS_OPTIONS=$CEPHFS_MKFS_OPTIONS
441 export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
444 export MKFS_OPTIONS=$REISER4_MKFS_OPTIONS
447 export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
450 export MKFS_OPTIONS="$JFS_MKFS_OPTIONS -q"
453 export MKFS_OPTIONS="$F2FS_MKFS_OPTIONS"
456 export MKFS_OPTIONS="$BTRFS_MKFS_OPTIONS"
459 export MKFS_OPTIONS=$BCACHEFS_MKFS_OPTIONS
469 ext2|ext3|ext4|ext4dev)
470 export FSCK_OPTIONS="-nf"
473 export FSCK_OPTIONS="--yes"
476 export FSCK_OPTIONS=""
479 export FSCK_OPTIONS="-n"
486 [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
488 [ -f /etc/xfsqa.config ] && export HOST_OPTIONS=/etc/xfsqa.config
489 [ -f $HOST_CONFIG_DIR/$HOST ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST
490 [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
493 # Returns a list of sections in config file
494 # Each section starts with the section name in the format
495 # [section_name1]. Only alphanumeric characters and '_' is allowed
496 # in the section name otherwise the section will not be resognised.
497 # Section name must be contained between square brackets.
498 get_config_sections() {
499 sed -n -e "s/^\[\([[:alnum:]_-]*\)\]/\1/p" < $1
502 if [ ! -f "$HOST_OPTIONS" ]; then
506 export HOST_OPTIONS_SECTIONS="-no-sections-"
507 export OPTIONS_HAVE_SECTIONS=false
508 if [ -f "$HOST_OPTIONS" ]; then
509 export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
510 if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
512 export HOST_OPTIONS_SECTIONS="-no-sections-"
514 export OPTIONS_HAVE_SECTIONS=true
524 if [ -z "$dev" ]; then
525 if [ "$dev_needed" == "required" ]; then
526 _fatal "common/config: $name is required but not defined!"
531 if [ -b "$dev" ] || ( echo $dev | grep -qE ":|//" ); then
532 # block device or a network url
538 # 9p and virtiofs mount tags are just plain strings, so anything is allowed
539 # tmpfs doesn't use mount source, ignore
542 # ceph has two different possible syntaxes for mount devices. The
543 # network URL check above catches the legacy syntax. Check for the
544 # new-style syntax here.
545 if ( echo $dev | grep -qEv "=/" ); then
546 _fatal "common/config: $name ($dev) is not a valid ceph mount string"
550 if [ ! -d "$dev" ]; then
551 _fatal "common/config: $name ($dev) is not a directory for overlay"
555 if [ ! -c "$dev" ]; then
556 _fatal "common/config: $name ($dev) is not a character device"
562 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
566 # check and return a canonical mount point path
567 _canonicalize_mountpoint()
572 if [ -d "$dir" ]; then
573 # this follows symlinks and removes all trailing "/"s
578 if [ "$FSTYP" != "overlay" ] || [[ "$name" == OVL_BASE_* ]]; then
579 _fatal "common/config: $name ($dir) is not a directory"
582 # base fs may not be mounted yet, so just check that parent dir
583 # exists (where base fs will be mounted) because we are going to
584 # mkdir the overlay mount point dir anyway
585 local base=`basename $dir`
586 local parent=`dirname $dir`
587 parent=`_canonicalize_mountpoint OVL_BASE_$name "$parent"`
589 # prepend the overlay mount point to canonical parent path
593 # On check -overlay, for the non multi section config case, this
594 # function is called on every test, before init_rc().
595 # When SCRATCH/TEST_* vars are defined in config file, config file
596 # is sourced on every test and this function overrides the vars
598 # When SCRATCH/TEST_* vars are defined in evironment and not
599 # in config file, this function is called after vars have already
600 # been overriden in the previous test.
601 # In that case, TEST_DEV is a directory and not a blockdev/chardev and
602 # the function will return without overriding the SCRATCH/TEST_* vars.
603 _overlay_config_override()
605 # There are 2 options for configuring overlayfs tests:
607 # 1. (legacy) SCRATCH/TEST_DEV point to existing directories
608 # on an already mounted fs. In this case, the new
609 # OVL_BASE_SCRATCH/TEST_* vars are set to use the legacy
610 # vars values (even though they may not be mount points).
612 [ ! -d "$TEST_DEV" ] || export OVL_BASE_TEST_DIR="$TEST_DEV"
613 [ ! -d "$SCRATCH_DEV" ] || export OVL_BASE_SCRATCH_MNT="$SCRATCH_DEV"
615 # Config file may specify base fs type, but we obay -overlay flag
616 [ "$FSTYP" == overlay ] || export OVL_BASE_FSTYP="$FSTYP"
619 # 2. SCRATCH/TEST_DEV point to the base fs partitions. In this case,
620 # the new OVL_BASE_SCRATCH/TEST_DEV/MNT vars are set to the values
621 # of the configured base fs and SCRATCH/TEST_DEV vars are set to the
622 # overlayfs base and mount dirs inside base fs mount.
623 [ -b "$TEST_DEV" ] || [ -c "$TEST_DEV" ] || [ "$OVL_BASE_FSTYP" == tmpfs ] || return 0
625 # Store original base fs vars
626 export OVL_BASE_TEST_DEV="$TEST_DEV"
627 export OVL_BASE_TEST_DIR="$TEST_DIR"
628 # If config does not set MOUNT_OPTIONS, its value may be
629 # leftover from previous _overlay_config_override, so
630 # don't use that value for base fs mount
631 [ "$MOUNT_OPTIONS" != "$OVERLAY_MOUNT_OPTIONS" ] || unset MOUNT_OPTIONS
632 export OVL_BASE_MOUNT_OPTIONS="$MOUNT_OPTIONS"
634 # Set TEST vars to overlay base and mount dirs inside base fs
635 export TEST_DEV="$OVL_BASE_TEST_DIR"
636 export TEST_DIR="$OVL_BASE_TEST_DIR/$OVL_MNT"
637 export MOUNT_OPTIONS="$OVERLAY_MOUNT_OPTIONS"
639 [ -b "$SCRATCH_DEV" ] || [ -c "$SCRATCH_DEV" ] || [ "$OVL_BASE_FSTYP" == tmpfs ] || return 0
641 # Store original base fs vars
642 export OVL_BASE_SCRATCH_DEV="$SCRATCH_DEV"
643 export OVL_BASE_SCRATCH_MNT="$SCRATCH_MNT"
645 # Set SCRATCH vars to overlay base and mount dirs inside base fs
646 export SCRATCH_DEV="$OVL_BASE_SCRATCH_MNT"
647 export SCRATCH_MNT="$OVL_BASE_SCRATCH_MNT/$OVL_MNT"
649 # Set fsck options, use default if user not set directly.
650 export FSCK_OPTIONS="$OVERLAY_FSCK_OPTIONS"
651 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
652 export IDMAPPED_MOUNTS="$IDMAPPED_MOUNTS"
655 _overlay_config_restore()
658 [ -z "$OVL_BASE_FSTYP" ] || export FSTYP=$OVL_BASE_FSTYP
659 [ -z "$OVL_BASE_TEST_DEV" ] || export TEST_DEV=$OVL_BASE_TEST_DEV
660 [ -z "$OVL_BASE_TEST_DIR" ] || export TEST_DIR=$OVL_BASE_TEST_DIR
661 [ -z "$OVL_BASE_SCRATCH_DEV" ] || export SCRATCH_DEV=$OVL_BASE_SCRATCH_DEV
662 [ -z "$OVL_BASE_SCRATCH_MNT" ] || export SCRATCH_MNT=$OVL_BASE_SCRATCH_MNT
663 [ -z "$OVL_BASE_MOUNT_OPTIONS" ] || export MOUNT_OPTIONS=$OVL_BASE_MOUNT_OPTIONS
666 # Parse config section options. This function will parse all the configuration
667 # within a single section which name is passed as an argument. For section
668 # name format see comments in get_config_sections().
669 # Empty lines and everything after '#' will be ignored.
670 # Configuration options should be defined in the format
672 # CONFIG_OPTION=value
674 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
675 parse_config_section() {
677 if ! $OPTIONS_HAVE_SECTIONS; then
680 eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
682 -e 's/[[:space:]]*$//' \
683 -e 's/^[[:space:]]*//' \
684 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
686 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
690 if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
694 # We might have overriden FSTYP and TEST/SCRATCH vars with overlay values
695 # in the previous section, so restore them to original values stored in
697 # We need to do this *before* old FSTYP and MOUNT_OPTIONS are recorded
698 # and *before* SCRATCH_DEV and MOUNT_OPTIONS are unset
699 if [ "$FSTYP" == "overlay" ]; then
700 _overlay_config_restore
703 local OLD_FSTYP=$FSTYP
704 local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
705 local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
706 local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
707 local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
708 local OLD_USE_EXTERNAL=$USE_EXTERNAL
711 unset TEST_FS_MOUNT_OPTS
716 # We might have deduced SCRATCH_DEV from the SCRATCH_DEV_POOL in the previous
717 # run, so we have to unset it now.
718 if [ "$SCRATCH_DEV_NOT_SET" == "true" ]; then
722 parse_config_section $1
724 if [ ! -z "$OLD_FSTYP" ] && [ $OLD_FSTYP != $FSTYP ]; then
725 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
726 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
727 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
728 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
730 # clear the external devices if we are not using them
731 if [ -z "$USE_EXTERNAL" ]; then
738 [ -z "$MOUNT_OPTIONS" ] && export MOUNT_OPTIONS=$OLD_MOUNT_OPTIONS
739 [ -z "$TEST_FS_MOUNT_OPTS" ] && export TEST_FS_MOUNT_OPTS=$OLD_TEST_FS_MOUNT_OPTS
740 [ -z "$MKFS_OPTIONS" ] && export MKFS_OPTIONS=$OLD_MKFS_OPTIONS
741 [ -z "$FSCK_OPTIONS" ] && export FSCK_OPTIONS=$OLD_FSCK_OPTIONS
742 [ -z "$USE_EXTERNAL" ] && export USE_EXTERNAL=$OLD_USE_EXTERNAL
745 # set default RESULT_BASE
746 if [ -z "$RESULT_BASE" ]; then
747 export RESULT_BASE="$here/results/"
750 if [ "$FSTYP" == "tmpfs" ]; then
751 if [ -z "TEST_DEV" ]; then
752 export TEST_DEV=tmpfs_test
754 if [ -z "SCRATCH_DEV" ]; then
755 export TEST_DEV=tmpfs_scratch
759 # Mandatory Config values.
761 [ -z "$EMAIL" ] && MC="$MC EMAIL"
762 [ -z "$TEST_DIR" ] && MC="$MC TEST_DIR"
763 [ -z "$TEST_DEV" ] && MC="$MC TEST_DEV"
765 if [ -n "$MC" ]; then
766 echo "Warning: need to define parameters for host $HOST"
767 echo " or set variables:"
772 _check_device TEST_DEV required $TEST_DEV
773 export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
775 # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
776 # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
777 if [ ! -z "$SCRATCH_DEV_POOL" ]; then
778 if [ ! -z "$SCRATCH_DEV" ]; then
779 echo "common/config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) should be unset when \$SCRATCH_DEV_POOL ($SCRATCH_DEV_POOL) is set"
782 SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
784 export SCRATCH_DEV_NOT_SET=true
787 _check_device SCRATCH_DEV optional $SCRATCH_DEV
788 export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
790 if [ -n "$USE_EXTERNAL" ]; then
791 _check_device TEST_RTDEV optional $TEST_RTDEV
792 _check_device TEST_LOGDEV optional $TEST_LOGDEV
793 _check_device SCRATCH_RTDEV optional $SCRATCH_RTDEV
794 _check_device SCRATCH_LOGDEV optional $SCRATCH_LOGDEV
797 # Override FSTYP from config when running ./check -overlay
798 # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs.
799 # We need to do this *after* default mount options are set by base FSTYP
800 # and *after* SCRATCH_DEV is deduced from SCRATCH_DEV_POOL
801 if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
802 _overlay_config_override
806 if [ -z "$CONFIG_INCLUDED" ]; then
807 get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
808 export CONFIG_INCLUDED=true
810 # Autodetect fs type based on what's on $TEST_DEV unless it's been set
812 if [ -z "$FSTYP" ] && [ ! -z "$TEST_DEV" ]; then
813 FSTYP=`blkid -c /dev/null -s TYPE -o value $TEST_DEV`
817 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
818 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
819 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
820 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
822 # We get here for the non multi section case, on every test that sources
823 # common/rc after re-sourcing the HOST_OPTIONS config file.
824 # Because of this re-sourcing, we need to re-canonicalize the configured
825 # mount points and re-override TEST/SCRATCH_DEV overlay vars.
827 # canonicalize the mount points
828 # this follows symlinks and removes all trailing "/"s
829 export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
830 export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
832 # Override FSTYP from config when running ./check -overlay
833 # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs
834 if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
835 _overlay_config_override
839 # make sure this script returns success