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