1116cb9955d3f90a8309a6d34b98d55e65da6961
[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
224 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
225 # newer systems have udevadm command but older systems like RHEL5 don't.
226 # But if neither one is available, just set it to "sleep 1" to wait for lv to
227 # be settled
228 UDEV_SETTLE_PROG="$(type -P udevadm)"
229 if [ "$UDEV_SETTLE_PROG" == "" ]; then
230         # try udevsettle command
231         UDEV_SETTLE_PROG="$(type -P udevsettle)"
232 else
233         # udevadm is available, add 'settle' as subcommand
234         UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
235 fi
236 # neither command is available, use sleep 1
237 if [ "$UDEV_SETTLE_PROG" == "" ]; then
238         UDEV_SETTLE_PROG="sleep 1"
239 fi
240 export UDEV_SETTLE_PROG
241
242 case "$HOSTOS" in
243     Linux)
244         export MKFS_XFS_PROG=$(type -P mkfs.xfs)
245         export MKFS_EXT4_PROG=$(type -P mkfs.ext4)
246         export MKFS_UDF_PROG=$(type -P mkudffs)
247         export MKFS_BTRFS_PROG=$(set_mkfs_prog_path_with_opts btrfs)
248         export MKFS_F2FS_PROG=$(set_mkfs_prog_path_with_opts f2fs)
249         export DUMP_F2FS_PROG=$(type -P dump.f2fs)
250         export F2FS_IO_PROG=$(type -P f2fs_io)
251         export BTRFS_UTIL_PROG=$(type -P btrfs)
252         export BTRFS_SHOW_SUPER_PROG=$(type -P btrfs-show-super)
253         export BTRFS_CONVERT_PROG=$(type -P btrfs-convert)
254         export BTRFS_TUNE_PROG=$(type -P btrfstune)
255         export XFS_FSR_PROG=$(type -P xfs_fsr)
256         export MKFS_NFS_PROG="false"
257         export MKFS_CIFS_PROG="false"
258         export MKFS_OVERLAY_PROG="false"
259         export MKFS_REISER4_PROG=$(type -P mkfs.reiser4)
260         export E2FSCK_PROG=$(type -P e2fsck)
261         export TUNE2FS_PROG=$(type -P tune2fs)
262         export FSCK_OVERLAY_PROG=$(type -P fsck.overlay)
263         ;;
264 esac
265
266 # SELinux adds extra xattrs which can mess up our expected output.
267 # So, mount with a context, and they won't be created.
268 #
269 # Since the context= option only accepts contexts defined in the SELinux
270 # policy, and different systems may have different policies with
271 # different context names, use the context of an existing directory.
272 # Assume that any valid context is fine, since xfstests should really
273 # only be run from an "unconfined" process, or with SELinux in permissive
274 # mode.  But if not, just specify your own SELINUX_MOUNT_OPTIONS.
275 if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
276         : ${SELINUX_MOUNT_OPTIONS:="-o context=$(stat -c %C /)"}
277         export SELINUX_MOUNT_OPTIONS
278 fi
279
280 # check if mkfs.xfs supports v5 xfs
281 if [ "$FSTYP" == "xfs" ]; then
282         XFS_MKFS_HAS_NO_META_SUPPORT=""
283         touch /tmp/crc_check.img
284         $MKFS_XFS_PROG -N -d file,name=/tmp/crc_check.img,size=32m -m crc=0 \
285                 >/dev/null 2>&1;
286         if [ $? -ne 0 ]; then
287                 XFS_MKFS_HAS_NO_META_SUPPORT=true
288         fi
289         rm -f /tmp/crc_check.img
290         export XFS_MKFS_HAS_NO_META_SUPPORT
291 fi
292
293 _mount_opts()
294 {
295         case $FSTYP in
296         9p)
297                 export MOUNT_OPTIONS=$PLAN9_MOUNT_OPTIONS
298                 ;;
299         xfs)
300                 export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
301                 ;;
302         udf)
303                 export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
304                 ;;
305         nfs)
306                 export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
307                 ;;
308         cifs)
309                 export MOUNT_OPTIONS=$CIFS_MOUNT_OPTIONS
310                 ;;
311         ceph)
312                 export MOUNT_OPTIONS=$CEPHFS_MOUNT_OPTIONS
313                 ;;
314         glusterfs)
315                 export MOUNT_OPTIONS=$GLUSTERFS_MOUNT_OPTIONS
316                 ;;
317         overlay)
318                 export MOUNT_OPTIONS=$OVERLAY_MOUNT_OPTIONS
319                 ;;
320         ext2|ext3|ext4|ext4dev)
321                 # acls & xattrs aren't turned on by default on ext$FOO
322                 export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
323                 ;;
324         f2fs)
325                 export MOUNT_OPTIONS="-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
326                 ;;
327         reiserfs)
328                 # acls & xattrs aren't turned on by default on reiserfs
329                 export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
330                 ;;
331        reiser4)
332                # acls & xattrs aren't supported by reiser4
333                export MOUNT_OPTIONS=$REISER4_MOUNT_OPTIONS
334                ;;
335         gfs2)
336                 # acls aren't turned on by default on gfs2
337                 export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
338                 ;;
339         tmpfs)
340                 # We need to specify the size at mount, use 1G by default
341                 export MOUNT_OPTIONS="-o size=1G $TMPFS_MOUNT_OPTIONS"
342                 ;;
343         ubifs)
344                 export MOUNT_OPTIONS=$UBIFS_MOUNT_OPTIONS
345                 ;;
346         *)
347                 ;;
348         esac
349 }
350
351 _test_mount_opts()
352 {
353         case $FSTYP in
354         9p)
355                 export TEST_FS_MOUNT_OPTS=$PLAN9_MOUNT_OPTIONS
356                 ;;
357         cifs)
358                 export TEST_FS_MOUNT_OPTS=$CIFS_MOUNT_OPTIONS
359                 ;;
360         ceph)
361                 export TEST_FS_MOUNT_OPTS=$CEPHFS_MOUNT_OPTIONS
362                 ;;
363         nfs)
364                 export TEST_FS_MOUNT_OPTS=$NFS_MOUNT_OPTIONS
365                 ;;
366         glusterfs)
367                 export TEST_FS_MOUNT_OPTS=$GLUSTERFS_MOUNT_OPTIONS
368                 ;;
369         ext2|ext3|ext4|ext4dev)
370                 # acls & xattrs aren't turned on by default on older ext$FOO
371                 export TEST_FS_MOUNT_OPTS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
372                 ;;
373         *)
374                 ;;
375         esac
376 }
377
378 _mkfs_opts()
379 {
380         case $FSTYP in
381         xfs)
382                 export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
383                 ;;
384         udf)
385                 [ ! -z "$udf_fsize" ] && \
386                         UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
387                 export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
388                 ;;
389         nfs)
390                 export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
391                 ;;
392         cifs)
393                 export MKFS_OPTIONS=$CIFS_MKFS_OPTIONS
394                 ;;
395         ceph)
396                 export MKFS_OPTIONS=$CEPHFS_MKFS_OPTIONS
397                 ;;
398         reiserfs)
399                 export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
400                 ;;
401        reiser4)
402                 export MKFS_OPTIONS=$REISER4_MKFS_OPTIONS
403                 ;;
404         gfs2)
405                 export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
406                 ;;
407         jfs)
408                 export MKFS_OPTIONS="$JFS_MKFS_OPTIONS -q"
409                 ;;
410         f2fs)
411                 export MKFS_OPTIONS="$F2FS_MKFS_OPTIONS"
412                 ;;
413         *)
414                 ;;
415         esac
416 }
417
418 _fsck_opts()
419 {
420         case $FSTYP in
421         ext2|ext3|ext4|ext4dev)
422                 export FSCK_OPTIONS="-nf"
423                 ;;
424         reiser*)
425                 export FSCK_OPTIONS="--yes"
426                 ;;
427         f2fs)
428                 export FSCK_OPTIONS=""
429                 ;;
430         *)
431                 export FSCK_OPTIONS="-n"
432                 ;;
433         esac
434 }
435
436 known_hosts()
437 {
438         [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
439
440         [ -f /etc/xfsqa.config ]             && export HOST_OPTIONS=/etc/xfsqa.config
441         [ -f $HOST_CONFIG_DIR/$HOST ]        && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST
442         [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
443 }
444
445 # Returns a list of sections in config file
446 # Each section starts with the section name in the format
447 # [section_name1]. Only alphanumeric characters and '_' is allowed
448 # in the section name otherwise the section will not be resognised.
449 # Section name must be contained between square brackets.
450 get_config_sections() {
451         sed -n -e "s/^\[\([[:alnum:]_]*\)\]/\1/p" < $1
452 }
453
454 if [ ! -f "$HOST_OPTIONS" ]; then
455         known_hosts
456 fi
457
458 export HOST_OPTIONS_SECTIONS="-no-sections-"
459 export OPTIONS_HAVE_SECTIONS=false
460 if [ -f "$HOST_OPTIONS" ]; then
461         export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
462         if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
463                 . $HOST_OPTIONS
464                 export HOST_OPTIONS_SECTIONS="-no-sections-"
465         else
466                 export OPTIONS_HAVE_SECTIONS=true
467         fi
468 fi
469
470 _check_device()
471 {
472         local name=$1
473         local dev_needed=$2
474         local dev=$3
475
476         if [ -z "$dev" ]; then
477                 if [ "$dev_needed" == "required" ]; then
478                         _fatal "common/config: $name is required but not defined!"
479                 fi
480                 return 0
481         fi
482
483         if [ -b "$dev" ] || ( echo $dev | grep -qE ":|//" ); then
484                 # block device or a network url
485                 return 0
486         fi
487
488         case "$FSTYP" in
489         9p|tmpfs|virtiofs)
490                 # 9p and virtiofs mount tags are just plain strings, so anything is allowed
491                 # tmpfs doesn't use mount source, ignore
492                 ;;
493         overlay)
494                 if [ ! -d "$dev" ]; then
495                         _fatal "common/config: $name ($dev) is not a directory for overlay"
496                 fi
497                 ;;
498         ubifs)
499                 if [ ! -c "$dev" ]; then
500                         _fatal "common/config: $name ($dev) is not a character device"
501                 fi
502                 ;;
503         *)
504                 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
505         esac
506 }
507
508 # check and return a canonical mount point path
509 _canonicalize_mountpoint()
510 {
511         local name=$1
512         local dir=$2
513
514         if [ -d "$dir" ]; then
515                 # this follows symlinks and removes all trailing "/"s
516                 readlink -e "$dir"
517                 return 0
518         fi
519
520         if [ "$FSTYP" != "overlay" ] || [[ "$name" == OVL_BASE_* ]]; then
521                 _fatal "common/config: $name ($dir) is not a directory"
522         fi
523
524         # base fs may not be mounted yet, so just check that parent dir
525         # exists (where base fs will be mounted) because we are going to
526         # mkdir the overlay mount point dir anyway
527         local base=`basename $dir`
528         local parent=`dirname $dir`
529         parent=`_canonicalize_mountpoint OVL_BASE_$name "$parent"`
530
531         # prepend the overlay mount point to canonical parent path
532         echo "$parent/$base"
533 }
534
535 # On check -overlay, for the non multi section config case, this
536 # function is called on every test, before init_rc().
537 # When SCRATCH/TEST_* vars are defined in config file, config file
538 # is sourced on every test and this function overrides the vars
539 # every time.
540 # When SCRATCH/TEST_* vars are defined in evironment and not
541 # in config file, this function is called after vars have already
542 # been overriden in the previous test.
543 # In that case, TEST_DEV is a directory and not a blockdev/chardev and
544 # the function will return without overriding the SCRATCH/TEST_* vars.
545 _overlay_config_override()
546 {
547         # There are 2 options for configuring overlayfs tests:
548         #
549         # 1. (legacy) SCRATCH/TEST_DEV point to existing directories
550         #    on an already mounted fs.  In this case, the new
551         #    OVL_BASE_SCRATCH/TEST_* vars are set to use the legacy
552         #    vars values (even though they may not be mount points).
553         #
554         [ ! -d "$TEST_DEV" ] || export OVL_BASE_TEST_DIR="$TEST_DEV"
555         [ ! -d "$SCRATCH_DEV" ] || export OVL_BASE_SCRATCH_MNT="$SCRATCH_DEV"
556
557         # 2. SCRATCH/TEST_DEV point to the base fs partitions.  In this case,
558         #    the new OVL_BASE_SCRATCH/TEST_DEV/MNT vars are set to the values
559         #    of the configured base fs and SCRATCH/TEST_DEV vars are set to the
560         #    overlayfs base and mount dirs inside base fs mount.
561         [ -b "$TEST_DEV" ] || [ -c "$TEST_DEV" ] || return 0
562
563         # Config file may specify base fs type, but we obay -overlay flag
564         [ "$FSTYP" == overlay ] || export OVL_BASE_FSTYP="$FSTYP"
565         export FSTYP=overlay
566
567         # Store original base fs vars
568         export OVL_BASE_TEST_DEV="$TEST_DEV"
569         export OVL_BASE_TEST_DIR="$TEST_DIR"
570         # If config does not set MOUNT_OPTIONS, its value may be
571         # leftover from previous _overlay_config_override, so
572         # don't use that value for base fs mount
573         [ "$MOUNT_OPTIONS" != "$OVERLAY_MOUNT_OPTIONS" ] || unset MOUNT_OPTIONS
574         export OVL_BASE_MOUNT_OPTIONS="$MOUNT_OPTIONS"
575
576         # Set TEST vars to overlay base and mount dirs inside base fs
577         export TEST_DEV="$OVL_BASE_TEST_DIR"
578         export TEST_DIR="$OVL_BASE_TEST_DIR/$OVL_MNT"
579         export MOUNT_OPTIONS="$OVERLAY_MOUNT_OPTIONS"
580
581         [ -b "$SCRATCH_DEV" ] || [ -c "$SCRATCH_DEV" ] || return 0
582
583         # Store original base fs vars
584         export OVL_BASE_SCRATCH_DEV="$SCRATCH_DEV"
585         export OVL_BASE_SCRATCH_MNT="$SCRATCH_MNT"
586
587         # Set SCRATCH vars to overlay base and mount dirs inside base fs
588         export SCRATCH_DEV="$OVL_BASE_SCRATCH_MNT"
589         export SCRATCH_MNT="$OVL_BASE_SCRATCH_MNT/$OVL_MNT"
590
591         # Set fsck options, use default if user not set directly.
592         export FSCK_OPTIONS="$OVERLAY_FSCK_OPTIONS"
593         [ -z "$FSCK_OPTIONS" ] && _fsck_opts
594 }
595
596 _overlay_config_restore()
597 {
598         export OVERLAY=true
599         [ -z "$OVL_BASE_FSTYP" ] || export FSTYP=$OVL_BASE_FSTYP
600         [ -z "$OVL_BASE_TEST_DEV" ] || export TEST_DEV=$OVL_BASE_TEST_DEV
601         [ -z "$OVL_BASE_TEST_DIR" ] || export TEST_DIR=$OVL_BASE_TEST_DIR
602         [ -z "$OVL_BASE_SCRATCH_DEV" ] || export SCRATCH_DEV=$OVL_BASE_SCRATCH_DEV
603         [ -z "$OVL_BASE_SCRATCH_MNT" ] || export SCRATCH_MNT=$OVL_BASE_SCRATCH_MNT
604         [ -z "$OVL_BASE_MOUNT_OPTIONS" ] || export MOUNT_OPTIONS=$OVL_BASE_MOUNT_OPTIONS
605 }
606
607 # Parse config section options. This function will parse all the configuration
608 # within a single section which name is passed as an argument. For section
609 # name format see comments in get_config_sections().
610 # Empty lines and everything after '#' will be ignored.
611 # Configuration options should be defined in the format
612 #
613 # CONFIG_OPTION=value
614 #
615 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
616 parse_config_section() {
617         SECTION=$1
618         if ! $OPTIONS_HAVE_SECTIONS; then
619                 return 0
620         fi
621         eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
622                 -e 's/#.*$//' \
623                 -e 's/[[:space:]]*$//' \
624                 -e 's/^[[:space:]]*//' \
625                 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
626                 < $HOST_OPTIONS \
627                 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
628 }
629
630 get_next_config() {
631         if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
632                 return 0
633         fi
634
635         # We might have overriden FSTYP and TEST/SCRATCH vars with overlay values
636         # in the previous section, so restore them to original values stored in
637         # OVL_BASE_*.
638         # We need to do this *before* old FSTYP and MOUNT_OPTIONS are recorded
639         # and *before* SCRATCH_DEV and MOUNT_OPTIONS are unset
640         if [ "$FSTYP" == "overlay" ]; then
641                 _overlay_config_restore
642         fi
643
644         local OLD_FSTYP=$FSTYP
645         local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
646         local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
647         local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
648         local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
649         local OLD_USE_EXTERNAL=$USE_EXTERNAL
650
651         unset MOUNT_OPTIONS
652         unset TEST_FS_MOUNT_OPTS
653         unset MKFS_OPTIONS
654         unset FSCK_OPTIONS
655         unset USE_EXTERNAL
656
657         # We might have deduced SCRATCH_DEV from the SCRATCH_DEV_POOL in the previous
658         # run, so we have to unset it now.
659         if [ "$SCRATCH_DEV_NOT_SET" == "true" ]; then
660                 unset SCRATCH_DEV
661         fi
662
663         parse_config_section $1
664
665         if [ ! -z "$OLD_FSTYP" ] && [ $OLD_FSTYP != $FSTYP ]; then
666                 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
667                 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
668                 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
669                 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
670
671                 # clear the external devices if we are not using them
672                 if [ -z "$USE_EXTERNAL" ]; then
673                         unset TEST_RTDEV
674                         unset TEST_LOGDEV
675                         unset SCRATCH_RTDEV
676                         unset SCRATCH_LOGDEV
677                 fi
678         else
679                 [ -z "$MOUNT_OPTIONS" ] && export MOUNT_OPTIONS=$OLD_MOUNT_OPTIONS
680                 [ -z "$TEST_FS_MOUNT_OPTS" ] && export TEST_FS_MOUNT_OPTS=$OLD_TEST_FS_MOUNT_OPTS
681                 [ -z "$MKFS_OPTIONS" ] && export MKFS_OPTIONS=$OLD_MKFS_OPTIONS
682                 [ -z "$FSCK_OPTIONS" ] && export FSCK_OPTIONS=$OLD_FSCK_OPTIONS
683                 [ -z "$USE_EXTERNAL" ] && export USE_EXTERNAL=$OLD_USE_EXTERNAL
684         fi
685
686         # set default RESULT_BASE
687         if [ -z "$RESULT_BASE" ]; then
688                 export RESULT_BASE="$here/results/"
689         fi
690
691         if [ "$FSTYP" == "tmpfs" ]; then
692                 if [ -z "TEST_DEV" ]; then
693                         export TEST_DEV=tmpfs_test
694                 fi
695                 if [ -z "SCRATCH_DEV" ]; then
696                         export TEST_DEV=tmpfs_scratch
697                 fi
698         fi
699
700         #  Mandatory Config values.
701         MC=""
702         [ -z "$EMAIL" ]          && MC="$MC EMAIL"
703         [ -z "$TEST_DIR" ]       && MC="$MC TEST_DIR"
704         [ -z "$TEST_DEV" ]       && MC="$MC TEST_DEV"
705
706         if [ -n "$MC" ]; then
707                 echo "Warning: need to define parameters for host $HOST"
708                 echo "       or set variables:"
709                 echo "       $MC"
710                 exit 1
711         fi
712
713         _check_device TEST_DEV required $TEST_DEV
714         export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
715
716         # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
717         # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
718         if [ ! -z "$SCRATCH_DEV_POOL" ]; then
719                 if [ ! -z "$SCRATCH_DEV" ]; then
720                         echo "common/config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) should be unset when \$SCRATCH_DEV_POOL ($SCRATCH_DEV_POOL) is set"
721                         exit 1
722                 fi
723                 SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
724                 export SCRATCH_DEV
725                 export SCRATCH_DEV_NOT_SET=true
726         fi
727
728         _check_device SCRATCH_DEV optional $SCRATCH_DEV
729         export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
730
731         if [ -n "$USE_EXTERNAL" ]; then
732                 _check_device TEST_RTDEV optional $TEST_RTDEV
733                 _check_device TEST_LOGDEV optional $TEST_LOGDEV
734                 _check_device SCRATCH_RTDEV optional $SCRATCH_RTDEV
735                 _check_device SCRATCH_LOGDEV optional $SCRATCH_LOGDEV
736         fi
737
738         # Override FSTYP from config when running ./check -overlay
739         # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs.
740         # We need to do this *after* default mount options are set by base FSTYP
741         # and *after* SCRATCH_DEV is deduced from SCRATCH_DEV_POOL
742         if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
743                 _overlay_config_override
744         fi
745 }
746
747 if [ -z "$CONFIG_INCLUDED" ]; then
748         get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
749         export CONFIG_INCLUDED=true
750
751         # Autodetect fs type based on what's on $TEST_DEV unless it's been set
752         # externally
753         if [ -z "$FSTYP" ] && \
754            [ "$HOSTOS" == "Linux" -o "$OSTYPE" == "linux-gnu" ] && \
755            [ ! -z "$TEST_DEV" ]; then
756                 FSTYP=`blkid -c /dev/null -s TYPE -o value $TEST_DEV`
757         fi
758         FSTYP=${FSTYP:=xfs}
759         export FSTYP
760         [ -z "$MOUNT_OPTIONS" ] && _mount_opts
761         [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
762         [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
763         [ -z "$FSCK_OPTIONS" ] && _fsck_opts
764 else
765         # We get here for the non multi section case, on every test that sources
766         # common/rc after re-sourcing the HOST_OPTIONS config file.
767         # Because of this re-sourcing, we need to re-canonicalize the configured
768         # mount points and re-override TEST/SCRATCH_DEV overlay vars.
769
770         # canonicalize the mount points
771         # this follows symlinks and removes all trailing "/"s
772         export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
773         export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
774
775         # Override FSTYP from config when running ./check -overlay
776         # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs
777         if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
778                 _overlay_config_override
779         fi
780 fi
781
782 # make sure this script returns success
783 /bin/true