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