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