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)
28 # CANON_DEVS - whether or not to canonicalize device symlinks
29 # yes: canonicalize device symlinks
30 # no (default) do not canonicalize device if they are symlinks
32 # - These can be added to $HOST_CONFIG_DIR (witch default to ./config)
33 # below or a separate local configuration file can be used (using
34 # the HOST_OPTIONS variable).
35 # - This script is shared by the stress test system and the auto-qa
37 # - TEST_DEV & TEST_DIR must be assigned.
38 # - this script shouldn't make any assertions about filesystem
39 # validity or mountedness.
44 # all tests should use a common language setting to prevent golden
51 export HOST=`hostname -s`
52 test `uname -s` = "Linux" || _fatal "fstests only supports Linux"
54 export MODULAR=0 # using XFS as a module or not
55 export BOOT="/boot" # install target for kernels
56 export EXTRA=${EXTRA:=xfs-qa}
58 # general parameters (mainly for auto-qa)
59 export SOAK_PROC=3 # -p option to fsstress
60 export SOAK_STRESS=10000 # -n option to fsstress
61 export SOAK_PASSES=-1 # count of repetitions of fsstress (while soaking)
62 export EMAIL=root@localhost # where auto-qa will send its status messages
64 export HOST_OPTIONS=${HOST_OPTIONS:=local.config}
65 export CHECK_OPTIONS=${CHECK_OPTIONS:="-g auto"}
66 export BENCH_PASSES=${BENCH_PASSES:=5}
67 export TIME_FACTOR=${TIME_FACTOR:=1}
68 export LOAD_FACTOR=${LOAD_FACTOR:=1}
69 export SOAK_DURATION=${SOAK_DURATION:=}
70 export DEBUGFS_MNT=${DEBUGFS_MNT:="/sys/kernel/debug"}
72 # some constants for overlayfs setup
73 export OVL_UPPER="ovl-upper"
74 export OVL_LOWER="ovl-lower"
75 export OVL_WORK="ovl-work"
76 # overlay mount point parent must be the base fs root
77 export OVL_MNT="ovl-mnt"
78 # By default unionmount-testsuite is expected under src
79 export UNIONMOUNT_TESTSUITE=${UNIONMOUNT_TESTSUITE:=$here/src/unionmount-testsuite}
81 # From e2fsprogs/e2fsck/e2fsck.h:
82 # Exit code used by fsck-type programs
84 export FSCK_NONDESTRUCT=1
86 export FSCK_UNCORRECTED=4
89 export FSCK_CANCELED=32
90 export FSCK_LIBRARY=128
93 #export DEBUG=${DEBUG:=...} # arbitrary CFLAGS really.
94 export MALLOCLIB=${MALLOCLIB:=/usr/lib/libefence.a}
95 export LOCAL_CONFIGURE_OPTIONS=${LOCAL_CONFIGURE_OPTIONS:=--enable-readline=yes}
97 export RECREATE_TEST_DEV=false
99 # Handle mkfs.$fstyp which does (or does not) require -f to overwrite
100 set_mkfs_prog_path_with_opts()
103 local p=$(type -P mkfs.$fstyp)
105 # Note: mkfs.f2fs doesn't support the --help option yet, but it doesn't
106 # matter since it also prints the help when an invalid option is given.
107 if [ "$p" != "" ] && \
108 $p --help |& grep -q "[[:space:]]-f[[:space:]|,]"; then
122 export MKFS_PROG="$(type -P mkfs)"
123 [ "$MKFS_PROG" = "" ] && _fatal "mkfs not found"
125 export MOUNT_PROG="$(type -P mount)"
126 [ "$MOUNT_PROG" = "" ] && _fatal "mount not found"
128 export UMOUNT_PROG="$(type -P umount)"
129 [ "$UMOUNT_PROG" = "" ] && _fatal "umount not found"
131 export FSSTRESS_PROG="./ltp/fsstress"
132 [ ! -x $FSSTRESS_PROG ] && _fatal "fsstress not found or executable"
134 export PERL_PROG="$(type -P perl)"
135 [ "$PERL_PROG" = "" ] && _fatal "perl not found"
137 export AWK_PROG="$(type -P awk)"
138 [ "$AWK_PROG" = "" ] && _fatal "awk not found"
140 export SED_PROG="$(type -P sed)"
141 [ "$SED_PROG" = "" ] && _fatal "sed not found"
143 export BC_PROG="$(type -P bc)"
144 [ "$BC_PROG" = "" ] && _fatal "bc not found"
146 export PS_ALL_FLAGS="-ef"
148 export DF_PROG="$(type -P df)"
149 [ "$DF_PROG" = "" ] && _fatal "df not found"
150 export DF_PROG="$DF_PROG -T -P" # Linux
152 export XFS_IO_PROG="$(type -P xfs_io)"
153 [ "$XFS_IO_PROG" = "" ] && _fatal "xfs_io not found"
155 export MKSWAP_PROG="$(type -P mkswap)"
156 # mkswap from util-linux v2.17.2 or older needs "-f" option to force to erase
158 MKSWAP_PROG="$MKSWAP_PROG -f"
160 export XFS_LOGPRINT_PROG="$(type -P xfs_logprint)"
161 export XFS_REPAIR_PROG="$(type -P xfs_repair)"
162 export XFS_DB_PROG="$(type -P xfs_db)"
163 export XFS_METADUMP_PROG="$(type -P xfs_metadump)"
164 export XFS_MDRESTORE_PROG="$(type -P xfs_mdrestore)"
165 export XFS_ADMIN_PROG="$(type -P xfs_admin)"
166 export XFS_GROWFS_PROG=$(type -P xfs_growfs)
167 export XFS_SPACEMAN_PROG="$(type -P xfs_spaceman)"
168 export XFS_SCRUB_PROG="$(type -P xfs_scrub)"
169 export XFS_PARALLEL_REPAIR_PROG="$(type -P xfs_prepair)"
170 export XFS_PARALLEL_REPAIR64_PROG="$(type -P xfs_prepair64)"
171 export __XFSDUMP_PROG="$(type -P xfsdump)"
172 if [ -n "$__XFSDUMP_PROG" ]; then
173 export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
175 export XFSDUMP_PROG=""
177 export XFSRESTORE_PROG="$(type -P xfsrestore)"
178 export XFSINVUTIL_PROG="$(type -P xfsinvutil)"
179 export GETFATTR_PROG="$(type -P getfattr)"
180 export SETFATTR_PROG="$(type -P setfattr)"
181 export CHACL_PROG="$(type -P chacl)"
182 export ATTR_PROG="$(type -P attr)"
183 export QUOTA_PROG="$(type -P quota)"
184 export XFS_QUOTA_PROG="$(type -P xfs_quota)"
185 export KILLALL_PROG="$(type -P killall)"
186 export INDENT_PROG="$(type -P indent)"
187 export XFS_COPY_PROG="$(type -P xfs_copy)"
188 export FSTRIM_PROG="$(type -P fstrim)"
189 export DUMPE2FS_PROG="$(type -P dumpe2fs)"
190 export RESIZE2FS_PROG="$(type -P resize2fs)"
191 export F2FS_IO_PROG="$(type -P f2fs_io)"
192 export FIO_PROG="$(type -P fio)"
193 export FILEFRAG_PROG="$(type -P filefrag)"
194 export E4DEFRAG_PROG="$(type -P e4defrag)"
195 export LOGGER_PROG="$(type -P logger)"
196 export DBENCH_PROG="$(type -P dbench)"
197 export DMSETUP_PROG="$(type -P dmsetup)"
198 export WIPEFS_PROG="$(type -P wipefs)"
199 export BLKDISCARD_PROG="$(type -P blkdiscard)"
200 export DUMP_PROG="$(type -P dump)"
201 export RESTORE_PROG="$(type -P restore)"
202 export LVM_PROG="$(type -P lvm)"
203 export LSATTR_PROG="$(type -P lsattr)"
204 export CHATTR_PROG="$(type -P chattr)"
205 export DEBUGFS_PROG="$(type -P debugfs)"
206 export UUIDGEN_PROG="$(type -P uuidgen)"
207 export GETRICHACL_PROG="$(type -P getrichacl)"
208 export SETRICHACL_PROG="$(type -P setrichacl)"
209 export KEYCTL_PROG="$(type -P keyctl)"
210 export XZ_PROG="$(type -P xz)"
211 export LZ4_PROG="$(type -P lz4)"
212 export FLOCK_PROG="$(type -P flock)"
213 export LDD_PROG="$(type -P ldd)"
214 export TIMEOUT_PROG="$(type -P timeout)"
215 export MAN_PROG="$(type -P man)"
216 export NFS4_SETFACL_PROG="$(type -P nfs4_setfacl)"
217 export NFS4_GETFACL_PROG="$(type -P nfs4_getfacl)"
218 export UBIUPDATEVOL_PROG="$(type -P ubiupdatevol)"
219 export THIN_CHECK_PROG="$(type -P thin_check)"
220 export PYTHON3_PROG="$(type -P python3)"
221 export SQLITE3_PROG="$(type -P sqlite3)"
222 export TIMEOUT_PROG="$(type -P timeout)"
223 export SETCAP_PROG="$(type -P setcap)"
224 export GETCAP_PROG="$(type -P getcap)"
225 export CAPSH_PROG="$(type -P capsh)"
226 export CHECKBASHISMS_PROG="$(type -P checkbashisms)"
227 export XFS_INFO_PROG="$(type -P xfs_info)"
228 export DUPEREMOVE_PROG="$(type -P duperemove)"
229 export CC_PROG="$(type -P cc)"
230 export FSVERITY_PROG="$(type -P fsverity)"
231 export OPENSSL_PROG="$(type -P openssl)"
232 export ACCTON_PROG="$(type -P accton)"
233 export E2IMAGE_PROG="$(type -P e2image)"
234 export BLKZONE_PROG="$(type -P blkzone)"
235 export GZIP_PROG="$(type -P gzip)"
236 export BTRFS_IMAGE_PROG="$(type -P btrfs-image)"
237 export BTRFS_MAP_LOGICAL_PROG=$(type -P btrfs-map-logical)
239 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
240 # newer systems have udevadm command but older systems like RHEL5 don't.
241 # But if neither one is available, just set it to "sleep 1" to wait for lv to
243 UDEV_SETTLE_PROG="$(type -P udevadm)"
244 if [ "$UDEV_SETTLE_PROG" == "" ]; then
245 # try udevsettle command
246 UDEV_SETTLE_PROG="$(type -P udevsettle)"
248 # udevadm is available, add 'settle' as subcommand
249 UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
251 # neither command is available, use sleep 1
253 # Udev events are sent via netlink to userspace through
254 # kobject_uevent_net_broadcast(), and udev in userspace is in charge of
255 # handling the events. The command `udevadm settle` just checks if
256 # /run/udev/queue is 0, however, a kernel without CONFIG_NET will have
257 # kobject_uevent_net_broadcast() be a no-op, and so /run/udev/queue may not
258 # exist or always be 0. We check for /proc/net to see CONFIG_NET was enabled.
259 if [[ "$UDEV_SETTLE_PROG" == "" || ! -d /proc/net ]]; then
260 UDEV_SETTLE_PROG="sleep 1"
262 export UDEV_SETTLE_PROG
264 # Set MODPROBE_PATIENT_RM_TIMEOUT_SECONDS to "forever" if you want the patient
265 # modprobe removal to run forever trying to remove a module.
266 MODPROBE_REMOVE_PATIENT=""
267 modprobe --help >& /dev/null && modprobe --help 2>&1 | grep -q -1 "remove-patiently"
268 if [[ $? -ne 0 ]]; then
269 if [[ -z "$MODPROBE_PATIENT_RM_TIMEOUT_SECONDS" ]]; then
270 # We will open code our own implementation of patient module
271 # remover in fstests. Use a 50 second default.
272 export MODPROBE_PATIENT_RM_TIMEOUT_SECONDS="50"
275 MODPROBE_RM_PATIENT_TIMEOUT_ARGS=""
276 if [[ ! -z "$MODPROBE_PATIENT_RM_TIMEOUT_SECONDS" ]]; then
277 if [[ "$MODPROBE_PATIENT_RM_TIMEOUT_SECONDS" != "forever" ]]; then
278 MODPROBE_PATIENT_RM_TIMEOUT_MS="$((MODPROBE_PATIENT_RM_TIMEOUT_SECONDS * 1000))"
279 MODPROBE_RM_PATIENT_TIMEOUT_ARGS="-t $MODPROBE_PATIENT_RM_TIMEOUT_MS"
282 # We export MODPROBE_PATIENT_RM_TIMEOUT_SECONDS here for parity
283 # with environments without support for modprobe -p, but we
284 # only really need it exported right now for environments which
285 # don't have support for modprobe -p to implement our own
286 # patient module removal support within fstests.
287 export MODPROBE_PATIENT_RM_TIMEOUT_SECONDS="50"
288 MODPROBE_PATIENT_RM_TIMEOUT_MS="$((MODPROBE_PATIENT_RM_TIMEOUT_SECONDS * 1000))"
289 MODPROBE_RM_PATIENT_TIMEOUT_ARGS="-t $MODPROBE_PATIENT_RM_TIMEOUT_MS"
291 MODPROBE_REMOVE_PATIENT="modprobe -p $MODPROBE_RM_PATIENT_TIMEOUT_ARGS"
293 export MODPROBE_REMOVE_PATIENT
295 export MKFS_XFS_PROG=$(type -P mkfs.xfs)
296 export MKFS_EXT4_PROG=$(type -P mkfs.ext4)
297 export MKFS_UDF_PROG=$(type -P mkudffs)
298 export MKFS_BTRFS_PROG=$(set_mkfs_prog_path_with_opts btrfs)
299 export MKFS_F2FS_PROG=$(set_mkfs_prog_path_with_opts f2fs)
300 export DUMP_F2FS_PROG=$(type -P dump.f2fs)
301 export F2FS_IO_PROG=$(type -P f2fs_io)
302 export BTRFS_UTIL_PROG=$(type -P btrfs)
303 export BTRFS_SHOW_SUPER_PROG=$(type -P btrfs-show-super)
304 export BTRFS_CONVERT_PROG=$(type -P btrfs-convert)
305 export BTRFS_TUNE_PROG=$(type -P btrfstune)
306 export BTRFS_CORRUPT_BLOCK_PROG=$(type -P btrfs-corrupt-block)
307 export XFS_FSR_PROG=$(type -P xfs_fsr)
308 export MKFS_NFS_PROG="false"
309 export MKFS_AFS_PROG="false"
310 export MKFS_CIFS_PROG="false"
311 export MKFS_OVERLAY_PROG="false"
312 export MKFS_REISER4_PROG=$(type -P mkfs.reiser4)
313 export E2FSCK_PROG=$(type -P e2fsck)
314 export TUNE2FS_PROG=$(type -P tune2fs)
315 export FSCK_OVERLAY_PROG=$(type -P fsck.overlay)
316 export MKFS_BCACHEFS_PROG=$(set_mkfs_prog_path_with_opts bcachefs)
318 # SELinux adds extra xattrs which can mess up our expected output.
319 # So, mount with a context, and they won't be created.
321 # Since the context= option only accepts contexts defined in the SELinux
322 # policy, and different systems may have different policies with
323 # different context names, use the context of an existing directory.
324 # Assume that any valid context is fine, since xfstests should really
325 # only be run from an "unconfined" process, or with SELinux in permissive
326 # mode. But if not, just specify your own SELINUX_MOUNT_OPTIONS.
327 if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
328 : ${SELINUX_MOUNT_OPTIONS:="-o context=$(stat -c %C /)"}
329 export SELINUX_MOUNT_OPTIONS
332 # check if mkfs.xfs supports v5 xfs
333 if [ "$FSTYP" == "xfs" ]; then
334 XFS_MKFS_HAS_NO_META_SUPPORT=""
335 touch /tmp/crc_check.img
336 $MKFS_XFS_PROG -N -d file,name=/tmp/crc_check.img,size=32m -m crc=0 \
338 if [ $? -ne 0 ]; then
339 XFS_MKFS_HAS_NO_META_SUPPORT=true
341 rm -f /tmp/crc_check.img
342 export XFS_MKFS_HAS_NO_META_SUPPORT
349 echo $PLAN9_MOUNT_OPTIONS
352 echo $FUSE_MOUNT_OPTIONS
355 echo $XFS_MOUNT_OPTIONS
358 echo $UDF_MOUNT_OPTIONS
361 echo $NFS_MOUNT_OPTIONS
364 echo $AFS_MOUNT_OPTIONS
367 echo $CIFS_MOUNT_OPTIONS
370 echo $CEPHFS_MOUNT_OPTIONS
373 echo $GLUSTERFS_MOUNT_OPTIONS
376 echo $OVERLAY_MOUNT_OPTIONS
378 ext2|ext3|ext4|ext4dev)
379 # acls & xattrs aren't turned on by default on ext$FOO
380 echo "-o acl,user_xattr $EXT_MOUNT_OPTIONS"
383 echo "-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
386 # acls & xattrs aren't turned on by default on reiserfs
387 echo "-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
390 # acls & xattrs aren't supported by reiser4
391 echo $REISER4_MOUNT_OPTIONS
394 # acls aren't turned on by default on gfs2
395 echo "-o acl $GFS2_MOUNT_OPTIONS"
398 # We need to specify the size at mount, use 1G by default
399 echo "-o size=1G $TMPFS_MOUNT_OPTIONS"
402 echo $UBIFS_MOUNT_OPTIONS
411 export MOUNT_OPTIONS=$(_common_mount_opts)
416 export TEST_FS_MOUNT_OPTS=$(_common_mount_opts)
423 export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
426 [ ! -z "$udf_fsize" ] && \
427 UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
428 export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
431 export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
434 export MKFS_OPTIONS=$AFS_MKFS_OPTIONS
437 export MKFS_OPTIONS=$CIFS_MKFS_OPTIONS
440 export MKFS_OPTIONS=$CEPHFS_MKFS_OPTIONS
443 export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
446 export MKFS_OPTIONS=$REISER4_MKFS_OPTIONS
449 export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
452 export MKFS_OPTIONS="$JFS_MKFS_OPTIONS -q"
455 export MKFS_OPTIONS="$F2FS_MKFS_OPTIONS"
458 export MKFS_OPTIONS="$BTRFS_MKFS_OPTIONS"
461 export MKFS_OPTIONS=$BCACHEFS_MKFS_OPTIONS
471 ext2|ext3|ext4|ext4dev)
472 export FSCK_OPTIONS="-nf"
475 export FSCK_OPTIONS="--yes"
478 export FSCK_OPTIONS=""
481 export FSCK_OPTIONS="-n"
486 # check necessary running dependences then source sepcific fs helpers
487 _source_specific_fs()
497 [ "$XFS_LOGPRINT_PROG" = "" ] && _fatal "xfs_logprint not found"
498 [ "$XFS_REPAIR_PROG" = "" ] && _fatal "xfs_repair not found"
499 [ "$XFS_DB_PROG" = "" ] && _fatal "xfs_db not found"
500 [ "$MKFS_XFS_PROG" = "" ] && _fatal "mkfs_xfs not found"
501 [ "$XFS_INFO_PROG" = "" ] && _fatal "xfs_info not found"
506 [ "$MKFS_UDF_PROG" = "" ] && _fatal "mkfs_udf/mkudffs not found"
509 [ "$MKFS_BTRFS_PROG" = "" ] && _fatal "mkfs.btrfs not found"
514 [ "$MKFS_EXT4_PROG" = "" ] && _fatal "mkfs.ext4 not found"
521 [ "$MKFS_F2FS_PROG" = "" ] && _fatal "mkfs.f2fs not found"
543 [ "$MKFS_REISER4_PROG" = "" ] && _fatal "mkfs.reiser4 not found"
548 [ "$UBIUPDATEVOL_PROG" = "" ] && _fatal "ubiupdatevol not found"
556 [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
558 [ -f /etc/xfsqa.config ] && export HOST_OPTIONS=/etc/xfsqa.config
559 [ -f $HOST_CONFIG_DIR/$HOST ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST
560 [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
563 # Returns a list of sections in config file
564 # Each section starts with the section name in the format
565 # [section_name1]. Only alphanumeric characters and '_' is allowed
566 # in the section name otherwise the section will not be resognised.
567 # Section name must be contained between square brackets.
568 get_config_sections() {
569 sed -n -e "s/^\[\([[:alnum:]_-]*\)\]/\1/p" < $1
572 if [ ! -f "$HOST_OPTIONS" ]; then
576 export HOST_OPTIONS_SECTIONS="-no-sections-"
577 export OPTIONS_HAVE_SECTIONS=false
578 if [ -f "$HOST_OPTIONS" ]; then
579 export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
580 if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
582 export HOST_OPTIONS_SECTIONS="-no-sections-"
584 export OPTIONS_HAVE_SECTIONS=true
594 if [ -z "$dev" ]; then
595 if [ "$dev_needed" == "required" ]; then
596 _fatal "common/config: $name is required but not defined!"
601 if [ -b "$dev" ] || ( echo $dev | grep -qE ":|//" ); then
602 # block device or a network url
607 9p|fuse|tmpfs|virtiofs|afs)
608 # 9p, fuse, virtiofs and afs mount tags are just plain strings,
609 # so anything is allowed tmpfs doesn't use mount source, ignore
612 # ceph has two different possible syntaxes for mount devices. The
613 # network URL check above catches the legacy syntax. Check for the
614 # new-style syntax here.
615 if ( echo $dev | grep -qEv "=/" ); then
616 _fatal "common/config: $name ($dev) is not a valid ceph mount string"
620 if [ ! -d "$dev" ]; then
621 _fatal "common/config: $name ($dev) is not a directory for overlay"
625 if [ ! -c "$dev" ]; then
626 _fatal "common/config: $name ($dev) is not a character device"
632 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
636 # check and return a canonical mount point path
637 _canonicalize_mountpoint()
642 if [ -d "$dir" ]; then
643 # this follows symlinks and removes all trailing "/"s
648 if [ "$FSTYP" != "overlay" ] || [[ "$name" == OVL_BASE_* ]]; then
649 _fatal "common/config: $name ($dir) is not a directory"
652 # base fs may not be mounted yet, so just check that parent dir
653 # exists (where base fs will be mounted) because we are going to
654 # mkdir the overlay mount point dir anyway
655 local base=`basename $dir`
656 local parent=`dirname $dir`
657 parent=`_canonicalize_mountpoint OVL_BASE_$name "$parent"`
659 # prepend the overlay mount point to canonical parent path
663 # Enables usage of /dev/disk/by-id/ symlinks to persist target devices
665 _canonicalize_devices()
667 if [ "$CANON_DEVS" != "yes" ]; then
670 [ -L "$TEST_DEV" ] && TEST_DEV=$(readlink -e "$TEST_DEV")
671 [ -L "$SCRATCH_DEV" ] && SCRATCH_DEV=$(readlink -e "$SCRATCH_DEV")
672 [ -L "$TEST_LOGDEV" ] && TEST_LOGDEV=$(readlink -e "$TEST_LOGDEV")
673 [ -L "$TEST_RTDEV" ] && TEST_RTDEV=$(readlink -e "$TEST_RTDEV")
674 [ -L "$SCRATCH_RTDEV" ] && SCRATCH_RTDEV=$(readlink -e "$SCRATCH_RTDEV")
675 [ -L "$LOGWRITES_DEV" ] && LOGWRITES_DEV=$(readlink -e "$LOGWRITES_DEV")
676 if [ ! -z "$SCRATCH_DEV_POOL" ]; then
677 local NEW_SCRATCH_POOL=""
678 for i in $SCRATCH_DEV_POOL; do
680 NEW_SCRATCH_POOL="$NEW_SCRATCH_POOL $(readlink -e $i)"
682 NEW_SCRATCH_POOL="$NEW_SCRATCH_POOL $i"
685 SCRATCH_DEV_POOL="$NEW_SCRATCH_POOL"
689 # On check -overlay, for the non multi section config case, this
690 # function is called on every test, before init_rc().
691 # When SCRATCH/TEST_* vars are defined in config file, config file
692 # is sourced on every test and this function overrides the vars
694 # When SCRATCH/TEST_* vars are defined in evironment and not
695 # in config file, this function is called after vars have already
696 # been overriden in the previous test.
697 # In that case, TEST_DEV is a directory and not a blockdev/chardev and
698 # the function will return without overriding the SCRATCH/TEST_* vars.
699 _overlay_config_override()
701 # There are 2 options for configuring overlayfs tests:
703 # 1. (legacy) SCRATCH/TEST_DEV point to existing directories
704 # on an already mounted fs. In this case, the new
705 # OVL_BASE_SCRATCH/TEST_* vars are set to use the legacy
706 # vars values (even though they may not be mount points).
708 [ ! -d "$TEST_DEV" ] || export OVL_BASE_TEST_DIR="$TEST_DEV"
709 [ ! -d "$SCRATCH_DEV" ] || export OVL_BASE_SCRATCH_MNT="$SCRATCH_DEV"
711 # Config file may specify base fs type, but we obay -overlay flag
712 [ "$FSTYP" == overlay ] || export OVL_BASE_FSTYP="$FSTYP"
715 # 2. SCRATCH/TEST_DEV point to the base fs partitions. In this case,
716 # the new OVL_BASE_SCRATCH/TEST_DEV/MNT vars are set to the values
717 # of the configured base fs and SCRATCH/TEST_DEV vars are set to the
718 # overlayfs base and mount dirs inside base fs mount.
719 [ -b "$TEST_DEV" ] || [ -c "$TEST_DEV" ] || [ "$OVL_BASE_FSTYP" == tmpfs ] || return 0
721 # Store original base fs vars
722 export OVL_BASE_TEST_DEV="$TEST_DEV"
723 export OVL_BASE_TEST_DIR="$TEST_DIR"
724 # If config does not set MOUNT_OPTIONS, its value may be
725 # leftover from previous _overlay_config_override, so
726 # don't use that value for base fs mount
727 [ "$MOUNT_OPTIONS" != "$OVERLAY_MOUNT_OPTIONS" ] || unset MOUNT_OPTIONS
728 export OVL_BASE_MOUNT_OPTIONS="$MOUNT_OPTIONS"
730 # Set TEST vars to overlay base and mount dirs inside base fs
731 export TEST_DEV="$OVL_BASE_TEST_DIR"
732 export TEST_DIR="$OVL_BASE_TEST_DIR/$OVL_MNT"
733 export MOUNT_OPTIONS="$OVERLAY_MOUNT_OPTIONS"
735 [ -b "$SCRATCH_DEV" ] || [ -c "$SCRATCH_DEV" ] || [ "$OVL_BASE_FSTYP" == tmpfs ] || return 0
737 # Store original base fs vars
738 export OVL_BASE_SCRATCH_DEV="$SCRATCH_DEV"
739 export OVL_BASE_SCRATCH_MNT="$SCRATCH_MNT"
741 # Set SCRATCH vars to overlay base and mount dirs inside base fs
742 export SCRATCH_DEV="$OVL_BASE_SCRATCH_MNT"
743 export SCRATCH_MNT="$OVL_BASE_SCRATCH_MNT/$OVL_MNT"
745 # Set fsck options, use default if user not set directly.
746 export FSCK_OPTIONS="$OVERLAY_FSCK_OPTIONS"
747 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
748 export IDMAPPED_MOUNTS="$IDMAPPED_MOUNTS"
751 _overlay_config_restore()
754 [ -z "$OVL_BASE_FSTYP" ] || export FSTYP=$OVL_BASE_FSTYP
755 [ -z "$OVL_BASE_TEST_DEV" ] || export TEST_DEV=$OVL_BASE_TEST_DEV
756 [ -z "$OVL_BASE_TEST_DIR" ] || export TEST_DIR=$OVL_BASE_TEST_DIR
757 [ -z "$OVL_BASE_SCRATCH_DEV" ] || export SCRATCH_DEV=$OVL_BASE_SCRATCH_DEV
758 [ -z "$OVL_BASE_SCRATCH_MNT" ] || export SCRATCH_MNT=$OVL_BASE_SCRATCH_MNT
759 [ -z "$OVL_BASE_MOUNT_OPTIONS" ] || export MOUNT_OPTIONS=$OVL_BASE_MOUNT_OPTIONS
762 # Parse config section options. This function will parse all the configuration
763 # within a single section which name is passed as an argument. For section
764 # name format see comments in get_config_sections().
765 # Empty lines and everything after '#' will be ignored.
766 # Configuration options should be defined in the format
768 # CONFIG_OPTION=value
770 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
771 parse_config_section() {
773 if ! $OPTIONS_HAVE_SECTIONS; then
776 eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
778 -e 's/[[:space:]]*$//' \
779 -e 's/^[[:space:]]*//' \
780 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
782 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
786 if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
790 # We might have overriden FSTYP and TEST/SCRATCH vars with overlay values
791 # in the previous section, so restore them to original values stored in
793 # We need to do this *before* old FSTYP and MOUNT_OPTIONS are recorded
794 # and *before* SCRATCH_DEV and MOUNT_OPTIONS are unset
795 if [ "$FSTYP" == "overlay" ]; then
796 _overlay_config_restore
799 local OLD_FSTYP=$FSTYP
800 local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
801 local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
802 local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
803 local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
804 local OLD_USE_EXTERNAL=$USE_EXTERNAL
807 unset TEST_FS_MOUNT_OPTS
812 # We might have deduced SCRATCH_DEV from the SCRATCH_DEV_POOL in the previous
813 # run, so we have to unset it now.
814 if [ "$SCRATCH_DEV_NOT_SET" == "true" ]; then
818 parse_config_section $1
819 if [ ! -z "$OLD_FSTYP" ] && [ $OLD_FSTYP != $FSTYP ]; then
820 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
821 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
822 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
823 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
825 # clear the external devices if we are not using them
826 if [ -z "$USE_EXTERNAL" ]; then
833 [ -z "$MOUNT_OPTIONS" ] && export MOUNT_OPTIONS=$OLD_MOUNT_OPTIONS
834 [ -z "$TEST_FS_MOUNT_OPTS" ] && export TEST_FS_MOUNT_OPTS=$OLD_TEST_FS_MOUNT_OPTS
835 [ -z "$MKFS_OPTIONS" ] && export MKFS_OPTIONS=$OLD_MKFS_OPTIONS
836 [ -z "$FSCK_OPTIONS" ] && export FSCK_OPTIONS=$OLD_FSCK_OPTIONS
837 [ -z "$USE_EXTERNAL" ] && export USE_EXTERNAL=$OLD_USE_EXTERNAL
840 # set default RESULT_BASE
841 if [ -z "$RESULT_BASE" ]; then
842 export RESULT_BASE="$here/results/"
845 if [ "$FSTYP" == "tmpfs" ]; then
846 if [ -z "TEST_DEV" ]; then
847 export TEST_DEV=tmpfs_test
849 if [ -z "SCRATCH_DEV" ]; then
850 export TEST_DEV=tmpfs_scratch
854 # Mandatory Config values.
856 [ -z "$EMAIL" ] && MC="$MC EMAIL"
857 [ -z "$TEST_DIR" ] && MC="$MC TEST_DIR"
858 [ -z "$TEST_DEV" ] && MC="$MC TEST_DEV"
860 if [ -n "$MC" ]; then
861 echo "Warning: need to define parameters for host $HOST"
862 echo " or set variables:"
867 _check_device TEST_DEV required $TEST_DEV
868 export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
870 # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
871 # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
872 if [ ! -z "$SCRATCH_DEV_POOL" ]; then
873 if [ ! -z "$SCRATCH_DEV" ]; then
874 echo "common/config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) should be unset when \$SCRATCH_DEV_POOL ($SCRATCH_DEV_POOL) is set"
877 SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
879 export SCRATCH_DEV_NOT_SET=true
882 _check_device SCRATCH_DEV optional $SCRATCH_DEV
883 export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
885 if [ -n "$USE_EXTERNAL" ]; then
886 _check_device TEST_RTDEV optional $TEST_RTDEV
887 _check_device TEST_LOGDEV optional $TEST_LOGDEV
888 _check_device SCRATCH_RTDEV optional $SCRATCH_RTDEV
889 _check_device SCRATCH_LOGDEV optional $SCRATCH_LOGDEV
892 # Override FSTYP from config when running ./check -overlay
893 # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs.
894 # We need to do this *after* default mount options are set by base FSTYP
895 # and *after* SCRATCH_DEV is deduced from SCRATCH_DEV_POOL
896 if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
897 _overlay_config_override
901 if [ -z "$CONFIG_INCLUDED" ]; then
902 get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
903 export CONFIG_INCLUDED=true
905 # Autodetect fs type based on what's on $TEST_DEV unless it's been set
907 if [ -z "$FSTYP" ] && [ ! -z "$TEST_DEV" ]; then
908 FSTYP=`blkid -c /dev/null -s TYPE -o value $TEST_DEV`
912 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
913 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
914 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
915 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
917 # We get here for the non multi section case, on every test that sources
918 # common/rc after re-sourcing the HOST_OPTIONS config file.
919 # Because of this re-sourcing, we need to re-canonicalize the configured
920 # mount points and re-override TEST/SCRATCH_DEV overlay vars.
922 # canonicalize the mount points
923 # this follows symlinks and removes all trailing "/"s
924 export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
925 export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
927 # Override FSTYP from config when running ./check -overlay
928 # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs
929 if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
930 _overlay_config_override
934 _canonicalize_devices
936 # make sure this script returns success