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