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