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