8023273da1158e9f4b041244705c6ff7dc1a71d1
[xfstests-dev.git] / common / config
1 ##/bin/bash
2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2000-2003,2006 Silicon Graphics, Inc.  All Rights Reserved.
4 #
5 # setup and check for config parameters, and in particular
6 #
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
10 #                   writeable
11 # TEST_DEV -        device for file system containing TEST_DIR
12 #
13 # and optionally:
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.
26 #                   yes: keep all dmesg
27 #                   no: only keep dmesg with error/warning (default)
28 #
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
33 #   system
34 # - TEST_DEV & TEST_DIR must be assigned.
35 # - this script shouldn't make any assertions about filesystem
36 #   validity or mountedness.
37 #
38
39 . common/test_names
40
41 # all tests should use a common language setting to prevent golden
42 # output mismatches.
43 export LANG=C
44 export LC_ALL=C
45
46 PATH=".:$PATH"
47
48 export HOST=`hostname -s`
49 export HOSTOS=`uname -s`
50
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}
54
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 XFS_MKFS_OPTIONS=${XFS_MKFS_OPTIONS:=-bsize=4096}
64 export TIME_FACTOR=${TIME_FACTOR:=1}
65 export LOAD_FACTOR=${LOAD_FACTOR:=1}
66 export DEBUGFS_MNT=${DEBUGFS_MNT:="/sys/kernel/debug"}
67
68 # some constants for overlayfs setup
69 export OVL_UPPER="ovl-upper"
70 export OVL_LOWER="ovl-lower"
71 export OVL_WORK="ovl-work"
72 # overlay mount point parent must be the base fs root
73 export OVL_MNT="ovl-mnt"
74
75 # From e2fsprogs/e2fsck/e2fsck.h:
76 # Exit code used by fsck-type programs
77 export FSCK_OK=0
78 export FSCK_NONDESTRUCT=1
79 export FSCK_REBOOT=2
80 export FSCK_UNCORRECTED=4
81 export FSCK_ERROR=8
82 export FSCK_USAGE=16
83 export FSCK_CANCELED=32
84 export FSCK_LIBRARY=128
85
86 export PWD=`pwd`
87 #export DEBUG=${DEBUG:=...} # arbitrary CFLAGS really.
88 export MALLOCLIB=${MALLOCLIB:=/usr/lib/libefence.a}
89 export LOCAL_CONFIGURE_OPTIONS=${LOCAL_CONFIGURE_OPTIONS:=--enable-readline=yes}
90
91 export RECREATE_TEST_DEV=false
92
93 # Handle mkfs.$fstyp which does (or does not) require -f to overwrite
94 set_mkfs_prog_path_with_opts()
95 {
96         local fstyp=$1
97         local p=$(type -P mkfs.$fstyp)
98
99         # Note: mkfs.f2fs doesn't support the --help option yet, but it doesn't
100         # matter since it also prints the help when an invalid option is given.
101         if [ "$p" != "" ] && \
102                 $p --help |& grep -q "[[:space:]]-f[[:space:]|]"; then
103                 echo "$p -f"
104         else
105                 echo $p
106         fi
107 }
108
109 _fatal()
110 {
111     echo "$*"
112     status=1
113     exit 1
114 }
115
116 export MKFS_PROG="$(type -P mkfs)"
117 [ "$MKFS_PROG" = "" ] && _fatal "mkfs not found"
118
119 export MOUNT_PROG="$(type -P mount)"
120 [ "$MOUNT_PROG" = "" ] && _fatal "mount not found"
121
122 export UMOUNT_PROG="$(type -P umount)"
123 [ "$UMOUNT_PROG" = "" ] && _fatal "umount not found"
124
125 export FSSTRESS_PROG="./ltp/fsstress"
126 [ ! -x $FSSTRESS_PROG ] && _fatal "fsstress not found or executable"
127
128 export PERL_PROG="$(type -P perl)"
129 [ "$PERL_PROG" = "" ] && _fatal "perl not found"
130
131 export AWK_PROG="$(type -P awk)"
132 [ "$AWK_PROG" = "" ] && _fatal "awk not found"
133
134 export SED_PROG="$(type -P sed)"
135 [ "$SED_PROG" = "" ] && _fatal "sed not found"
136
137 export BC_PROG="$(type -P bc)"
138 [ "$BC_PROG" = "" ] && _fatal "bc not found"
139
140 export PS_ALL_FLAGS="-ef"
141
142 export DF_PROG="$(type -P df)"
143 [ "$DF_PROG" = "" ] && _fatal "df not found"
144 [ "$HOSTOS" = "Linux" ] && export DF_PROG="$DF_PROG -T -P"
145
146 export XFS_IO_PROG="$(type -P xfs_io)"
147 [ "$XFS_IO_PROG" = "" ] && _fatal "xfs_io not found"
148
149 export MKSWAP_PROG="$(type -P mkswap)"
150 # mkswap from util-linux v2.17.2 or older needs "-f" option to force to erase
151 # bootbits sectors
152 MKSWAP_PROG="$MKSWAP_PROG -f"
153
154 export XFS_LOGPRINT_PROG="$(type -P xfs_logprint)"
155 export XFS_REPAIR_PROG="$(type -P xfs_repair)"
156 export XFS_DB_PROG="$(type -P xfs_db)"
157 export XFS_ADMIN_PROG="$(type -P xfs_admin)"
158 export XFS_GROWFS_PROG=$(type -P xfs_growfs)
159 export XFS_SPACEMAN_PROG="$(type -P xfs_spaceman)"
160 export XFS_SCRUB_PROG="$(type -P xfs_scrub)"
161 export XFS_PARALLEL_REPAIR_PROG="$(type -P xfs_prepair)"
162 export XFS_PARALLEL_REPAIR64_PROG="$(type -P xfs_prepair64)"
163 export __XFSDUMP_PROG="$(type -P xfsdump)"
164 if [ -n "$__XFSDUMP_PROG" ]; then
165         export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
166 else
167         export XFSDUMP_PROG=""
168 fi
169 export XFSRESTORE_PROG="$(type -P xfsrestore)"
170 export XFSINVUTIL_PROG="$(type -P xfsinvutil)"
171 export GETFATTR_PROG="$(type -P getfattr)"
172 export SETFATTR_PROG="$(type -P setfattr)"
173 export CHACL_PROG="$(type -P chacl)"
174 export ATTR_PROG="$(type -P attr)"
175 export QUOTA_PROG="$(type -P quota)"
176 export XFS_QUOTA_PROG="$(type -P xfs_quota)"
177 export KILLALL_PROG="$(type -P killall)"
178 export INDENT_PROG="$(type -P indent)"
179 export XFS_COPY_PROG="$(type -P xfs_copy)"
180 export FSTRIM_PROG="$(type -P fstrim)"
181 export DUMPE2FS_PROG="$(type -P dumpe2fs)"
182 export RESIZE2FS_PROG="$(type -P resize2fs)"
183 export F2FS_IO_PROG="$(type -P f2fs_io)"
184 export FIO_PROG="$(type -P fio)"
185 export FILEFRAG_PROG="$(type -P filefrag)"
186 export E4DEFRAG_PROG="$(type -P e4defrag)"
187 export LOGGER_PROG="$(type -P logger)"
188 export DBENCH_PROG="$(type -P dbench)"
189 export DMSETUP_PROG="$(type -P dmsetup)"
190 export WIPEFS_PROG="$(type -P wipefs)"
191 export BLKDISCARD_PROG="$(type -P blkdiscard)"
192 export DUMP_PROG="$(type -P dump)"
193 export RESTORE_PROG="$(type -P restore)"
194 export LVM_PROG="$(type -P lvm)"
195 export LSATTR_PROG="$(type -P lsattr)"
196 export CHATTR_PROG="$(type -P chattr)"
197 export DEBUGFS_PROG="$(type -P debugfs)"
198 export UUIDGEN_PROG="$(type -P uuidgen)"
199 export GETRICHACL_PROG="$(type -P getrichacl)"
200 export SETRICHACL_PROG="$(type -P setrichacl)"
201 export KEYCTL_PROG="$(type -P keyctl)"
202 export XZ_PROG="$(type -P xz)"
203 export FLOCK_PROG="$(type -P flock)"
204 export LDD_PROG="$(type -P ldd)"
205 export TIMEOUT_PROG="$(type -P timeout)"
206 export MAN_PROG="$(type -P man)"
207 export NFS4_SETFACL_PROG="$(type -P nfs4_setfacl)"
208 export NFS4_GETFACL_PROG="$(type -P nfs4_getfacl)"
209 export UBIUPDATEVOL_PROG="$(type -P ubiupdatevol)"
210 export THIN_CHECK_PROG="$(type -P thin_check)"
211 export PYTHON2_PROG="$(type -P python2)"
212 export SQLITE3_PROG="$(type -P sqlite3)"
213 export TIMEOUT_PROG="$(type -P timeout)"
214 export SETCAP_PROG="$(type -P setcap)"
215 export GETCAP_PROG="$(type -P getcap)"
216 export CAPSH_PROG="$(type -P capsh)"
217 export CHECKBASHISMS_PROG="$(type -P checkbashisms)"
218 export XFS_INFO_PROG="$(type -P xfs_info)"
219 export DUPEREMOVE_PROG="$(type -P duperemove)"
220 export CC_PROG="$(type -P cc)"
221 export FSVERITY_PROG="$(type -P fsverity)"
222 export OPENSSL_PROG="$(type -P openssl)"
223 export ACCTON_PROG="$(type -P accton)"
224
225 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
226 # newer systems have udevadm command but older systems like RHEL5 don't.
227 # But if neither one is available, just set it to "sleep 1" to wait for lv to
228 # be settled
229 UDEV_SETTLE_PROG="$(type -P udevadm)"
230 if [ "$UDEV_SETTLE_PROG" == "" ]; then
231         # try udevsettle command
232         UDEV_SETTLE_PROG="$(type -P udevsettle)"
233 else
234         # udevadm is available, add 'settle' as subcommand
235         UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
236 fi
237 # neither command is available, use sleep 1
238 if [ "$UDEV_SETTLE_PROG" == "" ]; then
239         UDEV_SETTLE_PROG="sleep 1"
240 fi
241 export UDEV_SETTLE_PROG
242
243 case "$HOSTOS" in
244     Linux)
245         export MKFS_XFS_PROG=$(type -P mkfs.xfs)
246         export MKFS_EXT4_PROG=$(type -P mkfs.ext4)
247         export MKFS_UDF_PROG=$(type -P mkudffs)
248         export MKFS_BTRFS_PROG=$(set_mkfs_prog_path_with_opts btrfs)
249         export MKFS_F2FS_PROG=$(set_mkfs_prog_path_with_opts f2fs)
250         export DUMP_F2FS_PROG=$(type -P dump.f2fs)
251         export F2FS_IO_PROG=$(type -P f2fs_io)
252         export BTRFS_UTIL_PROG=$(type -P btrfs)
253         export BTRFS_SHOW_SUPER_PROG=$(type -P btrfs-show-super)
254         export BTRFS_CONVERT_PROG=$(type -P btrfs-convert)
255         export BTRFS_TUNE_PROG=$(type -P btrfstune)
256         export XFS_FSR_PROG=$(type -P xfs_fsr)
257         export MKFS_NFS_PROG="false"
258         export MKFS_CIFS_PROG="false"
259         export MKFS_OVERLAY_PROG="false"
260         export MKFS_REISER4_PROG=$(type -P mkfs.reiser4)
261         export E2FSCK_PROG=$(type -P e2fsck)
262         export TUNE2FS_PROG=$(type -P tune2fs)
263         export FSCK_OVERLAY_PROG=$(type -P fsck.overlay)
264         ;;
265 esac
266
267 # SELinux adds extra xattrs which can mess up our expected output.
268 # So, mount with a context, and they won't be created.
269 #
270 # Since the context= option only accepts contexts defined in the SELinux
271 # policy, and different systems may have different policies with
272 # different context names, use the context of an existing directory.
273 # Assume that any valid context is fine, since xfstests should really
274 # only be run from an "unconfined" process, or with SELinux in permissive
275 # mode.  But if not, just specify your own SELINUX_MOUNT_OPTIONS.
276 if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
277         : ${SELINUX_MOUNT_OPTIONS:="-o context=$(stat -c %C /)"}
278         export SELINUX_MOUNT_OPTIONS
279 fi
280
281 # check if mkfs.xfs supports v5 xfs
282 if [ "$FSTYP" == "xfs" ]; then
283         XFS_MKFS_HAS_NO_META_SUPPORT=""
284         touch /tmp/crc_check.img
285         $MKFS_XFS_PROG -N -d file,name=/tmp/crc_check.img,size=32m -m crc=0 \
286                 >/dev/null 2>&1;
287         if [ $? -ne 0 ]; then
288                 XFS_MKFS_HAS_NO_META_SUPPORT=true
289         fi
290         rm -f /tmp/crc_check.img
291         export XFS_MKFS_HAS_NO_META_SUPPORT
292 fi
293
294 _mount_opts()
295 {
296         case $FSTYP in
297         9p)
298                 export MOUNT_OPTIONS=$PLAN9_MOUNT_OPTIONS
299                 ;;
300         xfs)
301                 export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
302                 ;;
303         udf)
304                 export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
305                 ;;
306         nfs)
307                 export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
308                 ;;
309         cifs)
310                 export MOUNT_OPTIONS=$CIFS_MOUNT_OPTIONS
311                 ;;
312         ceph)
313                 export MOUNT_OPTIONS=$CEPHFS_MOUNT_OPTIONS
314                 ;;
315         glusterfs)
316                 export MOUNT_OPTIONS=$GLUSTERFS_MOUNT_OPTIONS
317                 ;;
318         overlay)
319                 export MOUNT_OPTIONS=$OVERLAY_MOUNT_OPTIONS
320                 ;;
321         ext2|ext3|ext4|ext4dev)
322                 # acls & xattrs aren't turned on by default on ext$FOO
323                 export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
324                 ;;
325         f2fs)
326                 export MOUNT_OPTIONS="-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
327                 ;;
328         reiserfs)
329                 # acls & xattrs aren't turned on by default on reiserfs
330                 export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
331                 ;;
332        reiser4)
333                # acls & xattrs aren't supported by reiser4
334                export MOUNT_OPTIONS=$REISER4_MOUNT_OPTIONS
335                ;;
336         gfs2)
337                 # acls aren't turned on by default on gfs2
338                 export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
339                 ;;
340         tmpfs)
341                 # We need to specify the size at mount, use 1G by default
342                 export MOUNT_OPTIONS="-o size=1G $TMPFS_MOUNT_OPTIONS"
343                 ;;
344         ubifs)
345                 export MOUNT_OPTIONS=$UBIFS_MOUNT_OPTIONS
346                 ;;
347         *)
348                 ;;
349         esac
350 }
351
352 _test_mount_opts()
353 {
354         case $FSTYP in
355         9p)
356                 export TEST_FS_MOUNT_OPTS=$PLAN9_MOUNT_OPTIONS
357                 ;;
358         cifs)
359                 export TEST_FS_MOUNT_OPTS=$CIFS_MOUNT_OPTIONS
360                 ;;
361         ceph)
362                 export TEST_FS_MOUNT_OPTS=$CEPHFS_MOUNT_OPTIONS
363                 ;;
364         nfs)
365                 export TEST_FS_MOUNT_OPTS=$NFS_MOUNT_OPTIONS
366                 ;;
367         glusterfs)
368                 export TEST_FS_MOUNT_OPTS=$GLUSTERFS_MOUNT_OPTIONS
369                 ;;
370         ext2|ext3|ext4|ext4dev)
371                 # acls & xattrs aren't turned on by default on older ext$FOO
372                 export TEST_FS_MOUNT_OPTS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
373                 ;;
374         *)
375                 ;;
376         esac
377 }
378
379 _mkfs_opts()
380 {
381         case $FSTYP in
382         xfs)
383                 export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
384                 ;;
385         udf)
386                 [ ! -z "$udf_fsize" ] && \
387                         UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
388                 export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
389                 ;;
390         nfs)
391                 export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
392                 ;;
393         cifs)
394                 export MKFS_OPTIONS=$CIFS_MKFS_OPTIONS
395                 ;;
396         ceph)
397                 export MKFS_OPTIONS=$CEPHFS_MKFS_OPTIONS
398                 ;;
399         reiserfs)
400                 export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
401                 ;;
402        reiser4)
403                 export MKFS_OPTIONS=$REISER4_MKFS_OPTIONS
404                 ;;
405         gfs2)
406                 export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
407                 ;;
408         jfs)
409                 export MKFS_OPTIONS="$JFS_MKFS_OPTIONS -q"
410                 ;;
411         f2fs)
412                 export MKFS_OPTIONS="$F2FS_MKFS_OPTIONS"
413                 ;;
414         *)
415                 ;;
416         esac
417 }
418
419 _fsck_opts()
420 {
421         case $FSTYP in
422         ext2|ext3|ext4|ext4dev)
423                 export FSCK_OPTIONS="-nf"
424                 ;;
425         reiser*)
426                 export FSCK_OPTIONS="--yes"
427                 ;;
428         f2fs)
429                 export FSCK_OPTIONS=""
430                 ;;
431         *)
432                 export FSCK_OPTIONS="-n"
433                 ;;
434         esac
435 }
436
437 known_hosts()
438 {
439         [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
440
441         [ -f /etc/xfsqa.config ]             && export HOST_OPTIONS=/etc/xfsqa.config
442         [ -f $HOST_CONFIG_DIR/$HOST ]        && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST
443         [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
444 }
445
446 # Returns a list of sections in config file
447 # Each section starts with the section name in the format
448 # [section_name1]. Only alphanumeric characters and '_' is allowed
449 # in the section name otherwise the section will not be resognised.
450 # Section name must be contained between square brackets.
451 get_config_sections() {
452         sed -n -e "s/^\[\([[:alnum:]_]*\)\]/\1/p" < $1
453 }
454
455 if [ ! -f "$HOST_OPTIONS" ]; then
456         known_hosts
457 fi
458
459 export HOST_OPTIONS_SECTIONS="-no-sections-"
460 export OPTIONS_HAVE_SECTIONS=false
461 if [ -f "$HOST_OPTIONS" ]; then
462         export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
463         if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
464                 . $HOST_OPTIONS
465                 export HOST_OPTIONS_SECTIONS="-no-sections-"
466         else
467                 export OPTIONS_HAVE_SECTIONS=true
468         fi
469 fi
470
471 _check_device()
472 {
473         local name=$1
474         local dev_needed=$2
475         local dev=$3
476
477         if [ -z "$dev" ]; then
478                 if [ "$dev_needed" == "required" ]; then
479                         _fatal "common/config: $name is required but not defined!"
480                 fi
481                 return 0
482         fi
483
484         if [ -b "$dev" ] || ( echo $dev | grep -qE ":|//" ); then
485                 # block device or a network url
486                 return 0
487         fi
488
489         case "$FSTYP" in
490         9p|tmpfs|virtiofs)
491                 # 9p and virtiofs mount tags are just plain strings, so anything is allowed
492                 # tmpfs doesn't use mount source, ignore
493                 ;;
494         overlay)
495                 if [ ! -d "$dev" ]; then
496                         _fatal "common/config: $name ($dev) is not a directory for overlay"
497                 fi
498                 ;;
499         ubifs)
500                 if [ ! -c "$dev" ]; then
501                         _fatal "common/config: $name ($dev) is not a character device"
502                 fi
503                 ;;
504         *)
505                 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
506         esac
507 }
508
509 # check and return a canonical mount point path
510 _canonicalize_mountpoint()
511 {
512         local name=$1
513         local dir=$2
514
515         if [ -d "$dir" ]; then
516                 # this follows symlinks and removes all trailing "/"s
517                 readlink -e "$dir"
518                 return 0
519         fi
520
521         if [ "$FSTYP" != "overlay" ] || [[ "$name" == OVL_BASE_* ]]; then
522                 _fatal "common/config: $name ($dir) is not a directory"
523         fi
524
525         # base fs may not be mounted yet, so just check that parent dir
526         # exists (where base fs will be mounted) because we are going to
527         # mkdir the overlay mount point dir anyway
528         local base=`basename $dir`
529         local parent=`dirname $dir`
530         parent=`_canonicalize_mountpoint OVL_BASE_$name "$parent"`
531
532         # prepend the overlay mount point to canonical parent path
533         echo "$parent/$base"
534 }
535
536 # On check -overlay, for the non multi section config case, this
537 # function is called on every test, before init_rc().
538 # When SCRATCH/TEST_* vars are defined in config file, config file
539 # is sourced on every test and this function overrides the vars
540 # every time.
541 # When SCRATCH/TEST_* vars are defined in evironment and not
542 # in config file, this function is called after vars have already
543 # been overriden in the previous test.
544 # In that case, TEST_DEV is a directory and not a blockdev/chardev and
545 # the function will return without overriding the SCRATCH/TEST_* vars.
546 _overlay_config_override()
547 {
548         # There are 2 options for configuring overlayfs tests:
549         #
550         # 1. (legacy) SCRATCH/TEST_DEV point to existing directories
551         #    on an already mounted fs.  In this case, the new
552         #    OVL_BASE_SCRATCH/TEST_* vars are set to use the legacy
553         #    vars values (even though they may not be mount points).
554         #
555         [ ! -d "$TEST_DEV" ] || export OVL_BASE_TEST_DIR="$TEST_DEV"
556         [ ! -d "$SCRATCH_DEV" ] || export OVL_BASE_SCRATCH_MNT="$SCRATCH_DEV"
557
558         # 2. SCRATCH/TEST_DEV point to the base fs partitions.  In this case,
559         #    the new OVL_BASE_SCRATCH/TEST_DEV/MNT vars are set to the values
560         #    of the configured base fs and SCRATCH/TEST_DEV vars are set to the
561         #    overlayfs base and mount dirs inside base fs mount.
562         [ -b "$TEST_DEV" ] || [ -c "$TEST_DEV" ] || return 0
563
564         # Config file may specify base fs type, but we obay -overlay flag
565         [ "$FSTYP" == overlay ] || export OVL_BASE_FSTYP="$FSTYP"
566         export FSTYP=overlay
567
568         # Store original base fs vars
569         export OVL_BASE_TEST_DEV="$TEST_DEV"
570         export OVL_BASE_TEST_DIR="$TEST_DIR"
571         # If config does not set MOUNT_OPTIONS, its value may be
572         # leftover from previous _overlay_config_override, so
573         # don't use that value for base fs mount
574         [ "$MOUNT_OPTIONS" != "$OVERLAY_MOUNT_OPTIONS" ] || unset MOUNT_OPTIONS
575         export OVL_BASE_MOUNT_OPTIONS="$MOUNT_OPTIONS"
576
577         # Set TEST vars to overlay base and mount dirs inside base fs
578         export TEST_DEV="$OVL_BASE_TEST_DIR"
579         export TEST_DIR="$OVL_BASE_TEST_DIR/$OVL_MNT"
580         export MOUNT_OPTIONS="$OVERLAY_MOUNT_OPTIONS"
581
582         [ -b "$SCRATCH_DEV" ] || [ -c "$SCRATCH_DEV" ] || return 0
583
584         # Store original base fs vars
585         export OVL_BASE_SCRATCH_DEV="$SCRATCH_DEV"
586         export OVL_BASE_SCRATCH_MNT="$SCRATCH_MNT"
587
588         # Set SCRATCH vars to overlay base and mount dirs inside base fs
589         export SCRATCH_DEV="$OVL_BASE_SCRATCH_MNT"
590         export SCRATCH_MNT="$OVL_BASE_SCRATCH_MNT/$OVL_MNT"
591
592         # Set fsck options, use default if user not set directly.
593         export FSCK_OPTIONS="$OVERLAY_FSCK_OPTIONS"
594         [ -z "$FSCK_OPTIONS" ] && _fsck_opts
595 }
596
597 _overlay_config_restore()
598 {
599         export OVERLAY=true
600         [ -z "$OVL_BASE_FSTYP" ] || export FSTYP=$OVL_BASE_FSTYP
601         [ -z "$OVL_BASE_TEST_DEV" ] || export TEST_DEV=$OVL_BASE_TEST_DEV
602         [ -z "$OVL_BASE_TEST_DIR" ] || export TEST_DIR=$OVL_BASE_TEST_DIR
603         [ -z "$OVL_BASE_SCRATCH_DEV" ] || export SCRATCH_DEV=$OVL_BASE_SCRATCH_DEV
604         [ -z "$OVL_BASE_SCRATCH_MNT" ] || export SCRATCH_MNT=$OVL_BASE_SCRATCH_MNT
605         [ -z "$OVL_BASE_MOUNT_OPTIONS" ] || export MOUNT_OPTIONS=$OVL_BASE_MOUNT_OPTIONS
606 }
607
608 # Parse config section options. This function will parse all the configuration
609 # within a single section which name is passed as an argument. For section
610 # name format see comments in get_config_sections().
611 # Empty lines and everything after '#' will be ignored.
612 # Configuration options should be defined in the format
613 #
614 # CONFIG_OPTION=value
615 #
616 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
617 parse_config_section() {
618         SECTION=$1
619         if ! $OPTIONS_HAVE_SECTIONS; then
620                 return 0
621         fi
622         eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
623                 -e 's/#.*$//' \
624                 -e 's/[[:space:]]*$//' \
625                 -e 's/^[[:space:]]*//' \
626                 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
627                 < $HOST_OPTIONS \
628                 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
629 }
630
631 get_next_config() {
632         if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
633                 return 0
634         fi
635
636         # We might have overriden FSTYP and TEST/SCRATCH vars with overlay values
637         # in the previous section, so restore them to original values stored in
638         # OVL_BASE_*.
639         # We need to do this *before* old FSTYP and MOUNT_OPTIONS are recorded
640         # and *before* SCRATCH_DEV and MOUNT_OPTIONS are unset
641         if [ "$FSTYP" == "overlay" ]; then
642                 _overlay_config_restore
643         fi
644
645         local OLD_FSTYP=$FSTYP
646         local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
647         local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
648         local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
649         local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
650         local OLD_USE_EXTERNAL=$USE_EXTERNAL
651
652         unset MOUNT_OPTIONS
653         unset TEST_FS_MOUNT_OPTS
654         unset MKFS_OPTIONS
655         unset FSCK_OPTIONS
656         unset USE_EXTERNAL
657
658         # We might have deduced SCRATCH_DEV from the SCRATCH_DEV_POOL in the previous
659         # run, so we have to unset it now.
660         if [ "$SCRATCH_DEV_NOT_SET" == "true" ]; then
661                 unset SCRATCH_DEV
662         fi
663
664         parse_config_section $1
665
666         if [ ! -z "$OLD_FSTYP" ] && [ $OLD_FSTYP != $FSTYP ]; then
667                 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
668                 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
669                 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
670                 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
671
672                 # clear the external devices if we are not using them
673                 if [ -z "$USE_EXTERNAL" ]; then
674                         unset TEST_RTDEV
675                         unset TEST_LOGDEV
676                         unset SCRATCH_RTDEV
677                         unset SCRATCH_LOGDEV
678                 fi
679         else
680                 [ -z "$MOUNT_OPTIONS" ] && export MOUNT_OPTIONS=$OLD_MOUNT_OPTIONS
681                 [ -z "$TEST_FS_MOUNT_OPTS" ] && export TEST_FS_MOUNT_OPTS=$OLD_TEST_FS_MOUNT_OPTS
682                 [ -z "$MKFS_OPTIONS" ] && export MKFS_OPTIONS=$OLD_MKFS_OPTIONS
683                 [ -z "$FSCK_OPTIONS" ] && export FSCK_OPTIONS=$OLD_FSCK_OPTIONS
684                 [ -z "$USE_EXTERNAL" ] && export USE_EXTERNAL=$OLD_USE_EXTERNAL
685         fi
686
687         # set default RESULT_BASE
688         if [ -z "$RESULT_BASE" ]; then
689                 export RESULT_BASE="$here/results/"
690         fi
691
692         if [ "$FSTYP" == "tmpfs" ]; then
693                 if [ -z "TEST_DEV" ]; then
694                         export TEST_DEV=tmpfs_test
695                 fi
696                 if [ -z "SCRATCH_DEV" ]; then
697                         export TEST_DEV=tmpfs_scratch
698                 fi
699         fi
700
701         #  Mandatory Config values.
702         MC=""
703         [ -z "$EMAIL" ]          && MC="$MC EMAIL"
704         [ -z "$TEST_DIR" ]       && MC="$MC TEST_DIR"
705         [ -z "$TEST_DEV" ]       && MC="$MC TEST_DEV"
706
707         if [ -n "$MC" ]; then
708                 echo "Warning: need to define parameters for host $HOST"
709                 echo "       or set variables:"
710                 echo "       $MC"
711                 exit 1
712         fi
713
714         _check_device TEST_DEV required $TEST_DEV
715         export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
716
717         # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
718         # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
719         if [ ! -z "$SCRATCH_DEV_POOL" ]; then
720                 if [ ! -z "$SCRATCH_DEV" ]; then
721                         echo "common/config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) should be unset when \$SCRATCH_DEV_POOL ($SCRATCH_DEV_POOL) is set"
722                         exit 1
723                 fi
724                 SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
725                 export SCRATCH_DEV
726                 export SCRATCH_DEV_NOT_SET=true
727         fi
728
729         _check_device SCRATCH_DEV optional $SCRATCH_DEV
730         export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
731
732         if [ -n "$USE_EXTERNAL" ]; then
733                 _check_device TEST_RTDEV optional $TEST_RTDEV
734                 _check_device TEST_LOGDEV optional $TEST_LOGDEV
735                 _check_device SCRATCH_RTDEV optional $SCRATCH_RTDEV
736                 _check_device SCRATCH_LOGDEV optional $SCRATCH_LOGDEV
737         fi
738
739         # Override FSTYP from config when running ./check -overlay
740         # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs.
741         # We need to do this *after* default mount options are set by base FSTYP
742         # and *after* SCRATCH_DEV is deduced from SCRATCH_DEV_POOL
743         if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
744                 _overlay_config_override
745         fi
746 }
747
748 if [ -z "$CONFIG_INCLUDED" ]; then
749         get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
750         export CONFIG_INCLUDED=true
751
752         # Autodetect fs type based on what's on $TEST_DEV unless it's been set
753         # externally
754         if [ -z "$FSTYP" ] && \
755            [ "$HOSTOS" == "Linux" -o "$OSTYPE" == "linux-gnu" ] && \
756            [ ! -z "$TEST_DEV" ]; then
757                 FSTYP=`blkid -c /dev/null -s TYPE -o value $TEST_DEV`
758         fi
759         FSTYP=${FSTYP:=xfs}
760         export FSTYP
761         [ -z "$MOUNT_OPTIONS" ] && _mount_opts
762         [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
763         [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
764         [ -z "$FSCK_OPTIONS" ] && _fsck_opts
765 else
766         # We get here for the non multi section case, on every test that sources
767         # common/rc after re-sourcing the HOST_OPTIONS config file.
768         # Because of this re-sourcing, we need to re-canonicalize the configured
769         # mount points and re-override TEST/SCRATCH_DEV overlay vars.
770
771         # canonicalize the mount points
772         # this follows symlinks and removes all trailing "/"s
773         export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
774         export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
775
776         # Override FSTYP from config when running ./check -overlay
777         # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs
778         if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
779                 _overlay_config_override
780         fi
781 fi
782
783 # make sure this script returns success
784 /bin/true