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_SCRUB_PROG="`set_prog_path xfs_scrub`"
 153 export XFS_PARALLEL_REPAIR_PROG="`set_prog_path xfs_prepair`"
 154 export XFS_PARALLEL_REPAIR64_PROG="`set_prog_path xfs_prepair64`"
 155 export __XFSDUMP_PROG="`set_prog_path xfsdump`"
 156 if [ -n "$__XFSDUMP_PROG" ]; then
 157         export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
 158 else
 159         export XFSDUMP_PROG=""
 160 fi
 161 export XFSRESTORE_PROG="`set_prog_path xfsrestore`"
 162 export XFSINVUTIL_PROG="`set_prog_path xfsinvutil`"
 163 export GETFATTR_PROG="`set_prog_path getfattr`"
 164 export SETFATTR_PROG="`set_prog_path setfattr`"
 165 export CHACL_PROG="`set_prog_path chacl`"
 166 export ATTR_PROG="`set_prog_path attr`"
 167 export QUOTA_PROG="`set_prog_path quota`"
 168 export XFS_QUOTA_PROG="`set_prog_path xfs_quota`"
 169 export KILLALL_PROG="`set_prog_path killall`"
 170 export INDENT_PROG="`set_prog_path indent`"
 171 export XFS_COPY_PROG="`set_prog_path xfs_copy`"
 172 export FSTRIM_PROG="`set_prog_path fstrim`"
 173 export DUMPE2FS_PROG="`set_prog_path dumpe2fs`"
 174 export FIO_PROG="`set_prog_path fio`"
 175 export FILEFRAG_PROG="`set_prog_path filefrag`"
 176 export E4DEFRAG_PROG="`set_prog_path e4defrag`"
 177 export LOGGER_PROG="`set_prog_path logger`"
 178 export DBENCH_PROG="`set_prog_path dbench`"
 179 export DMSETUP_PROG="`set_prog_path dmsetup`"
 180 export WIPEFS_PROG="`set_prog_path wipefs`"
 181 export DUMP_PROG="`set_prog_path dump`"
 182 export RESTORE_PROG="`set_prog_path restore`"
 183 export LVM_PROG="`set_prog_path lvm`"
 184 export CHATTR_PROG="`set_prog_path chattr`"
 185 export DEBUGFS_PROG="`set_prog_path debugfs`"
 186 export UUIDGEN_PROG="`set_prog_path uuidgen`"
 187 export GETRICHACL_PROG="`set_prog_path getrichacl`"
 188 export SETRICHACL_PROG="`set_prog_path setrichacl`"
 189 export KEYCTL_PROG="`set_prog_path keyctl`"
 190 export XZ_PROG="`set_prog_path xz`"
 191 export FLOCK_PROG="`set_prog_path flock`"
 192 export LDD_PROG="`set_prog_path ldd`"
 193 export TIMEOUT_PROG="`set_prog_path timeout`"
 194 export MAN_PROG="`set_prog_path man`"
 195 export NFS4_SETFACL_PROG="`set_prog_path nfs4_setfacl`"
 196 export NFS4_GETFACL_PROG="`set_prog_path nfs4_getfacl`"
 197 export UBIUPDATEVOL_PROG="`set_prog_path ubiupdatevol`"
 198
 199 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
 200 # newer systems have udevadm command but older systems like RHEL5 don't.
 201 # But if neither one is available, just set it to "sleep 1" to wait for lv to
 202 # be settled
 203 UDEV_SETTLE_PROG="`set_prog_path udevadm`"
 204 if [ "$UDEV_SETTLE_PROG" == "" ]; then
 205         # try udevsettle command
 206         UDEV_SETTLE_PROG="`set_prog_path udevsettle`"
 207 else
 208         # udevadm is available, add 'settle' as subcommand
 209         UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
 210 fi
 211 # neither command is available, use sleep 1
 212 if [ "$UDEV_SETTLE_PROG" == "" ]; then
 213         UDEV_SETTLE_PROG="sleep 1"
 214 fi
 215 export UDEV_SETTLE_PROG
 216
 217 case "$HOSTOS" in
 218     Linux)
 219         export MKFS_XFS_PROG="`set_prog_path mkfs.xfs`"
 220         export MKFS_EXT4_PROG="`set_prog_path mkfs.ext4`"
 221         export MKFS_UDF_PROG="`set_prog_path mkudffs`"
 222         export MKFS_BTRFS_PROG="`set_btrfs_mkfs_prog_path_with_opts`"
 223         export MKFS_F2FS_PROG="`set_prog_path mkfs.f2fs`"
 224         export DUMP_F2FS_PROG="`set_prog_path dump.f2fs`"
 225         export BTRFS_UTIL_PROG="`set_prog_path btrfs`"
 226         export BTRFS_SHOW_SUPER_PROG="`set_prog_path btrfs-show-super`"
 227         export BTRFS_CONVERT_PROG="`set_prog_path btrfs-convert`"
 228         export XFS_FSR_PROG="`set_prog_path xfs_fsr`"
 229         export MKFS_NFS_PROG="false"
 230         export MKFS_CIFS_PROG="false"
 231         export MKFS_OVERLAY_PROG="false"
 232         export MKFS_REISER4_PROG="`set_prog_path mkfs.reiser4`"
 233         export E2FSCK_PROG="`set_prog_path e2fsck`"
 234         export TUNE2FS_PROG="`set_prog_path tune2fs`"
 235         ;;
 236 esac
 237
 238 # SELinux adds extra xattrs which can mess up our expected output.
 239 # So, mount with a context, and they won't be created.
 240 #
 241 # Since the context= option only accepts contexts defined in the SELinux
 242 # policy, and different systems may have different policies with
 243 # different context names, use the context of an existing directory.
 244 # Assume that any valid context is fine, since xfstests should really
 245 # only be run from an "unconfined" process, or with SELinux in permissive
 246 # mode.  But if not, just specify your own SELINUX_MOUNT_OPTIONS.
 247 if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
 248         : ${SELINUX_MOUNT_OPTIONS:="-o context=$(stat -c %C /)"}
 249         export SELINUX_MOUNT_OPTIONS
 250 fi
 251
 252 # check if mkfs.xfs supports v5 xfs
 253 XFS_MKFS_HAS_NO_META_SUPPORT=""
 254 touch /tmp/crc_check.img
 255 $MKFS_XFS_PROG -N -d file,name=/tmp/crc_check.img,size=32m -m crc=0 \
 256         >/dev/null 2>&1;
 257 if [ $? -ne 0 ]; then
 258         XFS_MKFS_HAS_NO_META_SUPPORT=true
 259 fi
 260 rm -f /tmp/crc_check.img
 261 export XFS_MKFS_HAS_NO_META_SUPPORT
 262
 263 # new doesn't need config file parsed, we can stop here
 264 if [ "$iam" == "new" ]; then
 265         return 0
 266 fi
 267
 268 _mount_opts()
 269 {
 270         case $FSTYP in
 271         xfs)
 272                 export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
 273                 ;;
 274         udf)
 275                 export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
 276                 ;;
 277         nfs)
 278                 export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
 279                 ;;
 280         cifs)
 281                 export MOUNT_OPTIONS=$CIFS_MOUNT_OPTIONS
 282                 ;;
 283         ceph)
 284                 export MOUNT_OPTIONS=$CEPHFS_MOUNT_OPTIONS
 285                 ;;
 286         glusterfs)
 287                 export MOUNT_OPTIONS=$GLUSTERFS_MOUNT_OPTIONS
 288                 ;;
 289         overlay)
 290                 export MOUNT_OPTIONS=$OVERLAY_MOUNT_OPTIONS
 291                 ;;
 292         ext2|ext3|ext4|ext4dev)
 293                 # acls & xattrs aren't turned on by default on ext$FOO
 294                 export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
 295                 ;;
 296         f2fs)
 297                 export MOUNT_OPTIONS="-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
 298                 ;;
 299         reiserfs)
 300                 # acls & xattrs aren't turned on by default on reiserfs
 301                 export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
 302                 ;;
 303        reiser4)
 304                # acls & xattrs aren't supported by reiser4
 305                export MOUNT_OPTIONS=$REISER4_MOUNT_OPTIONS
 306                ;;
 307         gfs2)
 308                 # acls aren't turned on by default on gfs2
 309                 export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
 310                 ;;
 311         tmpfs)
 312                 # We need to specify the size at mount, use 1G by default
 313                 export MOUNT_OPTIONS="-o size=1G $TMPFS_MOUNT_OPTIONS"
 314                 ;;
 315         ubifs)
 316                 export MOUNT_OPTIONS=$UBIFS_MOUNT_OPTIONS
 317                 ;;
 318         *)
 319                 ;;
 320         esac
 321 }
 322
 323 _test_mount_opts()
 324 {
 325         case $FSTYP in
 326         cifs)
 327                 export TEST_FS_MOUNT_OPTS=$CIFS_MOUNT_OPTIONS
 328                 ;;
 329         ceph)
 330                 export TEST_FS_MOUNT_OPTS=$CEPHFS_MOUNT_OPTIONS
 331                 ;;
 332         nfs)
 333                 export TEST_FS_MOUNT_OPTS=$NFS_MOUNT_OPTIONS
 334                 ;;
 335         glusterfs)
 336                 export TEST_FS_MOUNT_OPTS=$GLUSTERFS_MOUNT_OPTIONS
 337                 ;;
 338         ext2|ext3|ext4|ext4dev)
 339                 # acls & xattrs aren't turned on by default on older ext$FOO
 340                 export TEST_FS_MOUNT_OPTS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
 341                 ;;
 342         *)
 343                 ;;
 344         esac
 345 }
 346
 347 _mkfs_opts()
 348 {
 349         case $FSTYP in
 350         xfs)
 351                 export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
 352                 ;;
 353         udf)
 354                 [ ! -z "$udf_fsize" ] && \
 355                         UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
 356                 export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
 357                 ;;
 358         nfs)
 359                 export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
 360                 ;;
 361         cifs)
 362                 export MKFS_OPTIONS=$CIFS_MKFS_OPTIONS
 363                 ;;
 364         ceph)
 365                 export MKFS_OPTIONS=$CEPHFS_MKFS_OPTIONS
 366                 ;;
 367         reiserfs)
 368                 export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
 369                 ;;
 370        reiser4)
 371                 export MKFS_OPTIONS=$REISER4_MKFS_OPTIONS
 372                 ;;
 373         gfs2)
 374                 export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
 375                 ;;
 376         jfs)
 377                 export MKFS_OPTIONS="$JFS_MKFS_OPTIONS -q"
 378                 ;;
 379         f2fs)
 380                 export MKFS_OPTIONS="$F2FS_MKFS_OPTIONS"
 381                 ;;
 382         *)
 383                 ;;
 384         esac
 385 }
 386
 387 _fsck_opts()
 388 {
 389         case $FSTYP in
 390         ext2|ext3|ext4|ext4dev)
 391                 export FSCK_OPTIONS="-nf"
 392                 ;;
 393         reiser*)
 394                 export FSCK_OPTIONS="--yes"
 395                 ;;
 396         f2fs)
 397                 export FSCK_OPTIONS=""
 398                 ;;
 399         *)
 400                 export FSCK_OPTIONS="-n"
 401                 ;;
 402         esac
 403 }
 404
 405 known_hosts()
 406 {
 407         [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
 408
 409         [ -f /etc/xfsqa.config ]             && export HOST_OPTIONS=/etc/xfsqa.config
 410         [ -f $HOST_CONFIG_DIR/$HOST ]        && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST
 411         [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
 412 }
 413
 414 # Returns a list of sections in config file
 415 # Each section starts with the section name in the format
 416 # [section_name1]. Only alphanumeric characters and '_' is allowed
 417 # in the section name otherwise the section will not be resognised.
 418 # Section name must be contained between square brackets.
 419 get_config_sections() {
 420         sed -n -e "s/^\[\([[:alnum:]_]*\)\]/\1/p" < $1
 421 }
 422
 423 if [ ! -f "$HOST_OPTIONS" ]; then
 424         known_hosts
 425 fi
 426
 427 export HOST_OPTIONS_SECTIONS="-no-sections-"
 428 export OPTIONS_HAVE_SECTIONS=false
 429 if [ -f "$HOST_OPTIONS" ]; then
 430         export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
 431         if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
 432                 . $HOST_OPTIONS
 433                 export HOST_OPTIONS_SECTIONS="-no-sections-"
 434         else
 435                 export OPTIONS_HAVE_SECTIONS=true
 436         fi
 437 fi
 438
 439 _check_device()
 440 {
 441         local name=$1
 442         local dev_needed=$2
 443         local dev=$3
 444
 445         if [ -z "$dev" ]; then
 446                 if [ "$dev_needed" == "required" ]; then
 447                         _fatal "common/config: $name is required but not defined!"
 448                 fi
 449                 return 0
 450         fi
 451
 452         if [ -b "$dev" ] || ( echo $dev | grep -qE ":|//" ); then
 453                 # block device or a network url
 454                 return 0
 455         fi
 456
 457         case "$FSTYP" in
 458         overlay)
 459                 if [ ! -d "$dev" ]; then
 460                         _fatal "common/config: $name ($dev) is not a directory for overlay"
 461                 fi
 462                 ;;
 463         ubifs)
 464                 if [ ! -c "$dev" ]; then
 465                         _fatal "common/config: $name ($dev) is not a character device"
 466                 fi
 467                 ;;
 468         *)
 469                 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
 470         esac
 471 }
 472
 473 # check and return a canonical mount point path
 474 _canonicalize_mountpoint()
 475 {
 476         local name=$1
 477         local dir=$2
 478
 479         if [ -d "$dir" ]; then
 480                 # this follows symlinks and removes all trailing "/"s
 481                 readlink -e "$dir"
 482                 return 0
 483         fi
 484
 485         if [ "$FSTYP" != "overlay" ] || [[ "$name" == OVL_BASE_* ]]; then
 486                 _fatal "common/config: $name ($dir) is not a directory"
 487         fi
 488
 489         # base fs may not be mounted yet, so just check that parent dir
 490         # exists (where base fs will be mounted) because we are going to
 491         # mkdir the overlay mount point dir anyway
 492         local base=`basename $dir`
 493         local parent=`dirname $dir`
 494         parent=`_canonicalize_mountpoint OVL_BASE_$name "$parent"`
 495
 496         # prepend the overlay mount point to canonical parent path
 497         echo "$parent/$base"
 498 }
 499
 500 # On check -overlay, for the non multi section config case, this
 501 # function is called on every test, before init_rc().
 502 # When SCRATCH/TEST_* vars are defined in config file, config file
 503 # is sourced on every test and this function overrides the vars
 504 # every time.
 505 # When SCRATCH/TEST_* vars are defined in evironment and not
 506 # in config file, this function is called after vars have already
 507 # been overriden in the previous test.
 508 # In that case, TEST_DEV is a directory and not a blockdev and
 509 # the function will return without overriding the SCRATCH/TEST_* vars.
 510 _overlay_config_override()
 511 {
 512         # There are 2 options for configuring overlayfs tests:
 513         #
 514         # 1. (legacy) SCRATCH/TEST_DEV point to existing directories
 515         #    on an already mounted fs.  In this case, the new
 516         #    OVL_BASE_SCRATCH/TEST_* vars are set to use the legacy
 517         #    vars values (even though they may not be mount points).
 518         #
 519         [ ! -d "$TEST_DEV" ] || export OVL_BASE_TEST_DIR="$TEST_DEV"
 520         [ ! -d "$SCRATCH_DEV" ] || export OVL_BASE_SCRATCH_MNT="$SCRATCH_DEV"
 521
 522         # 2. SCRATCH/TEST_DEV point to the base fs partitions.  In this case,
 523         #    the new OVL_BASE_SCRATCH/TEST_DEV/MNT vars are set to the values
 524         #    of the configured base fs and SCRATCH/TEST_DEV vars are set to the
 525         #    overlayfs base and mount dirs inside base fs mount.
 526         [ -b "$TEST_DEV" ] || return 0
 527
 528         # Config file may specify base fs type, but we obay -overlay flag
 529         export OVL_BASE_FSTYP="$FSTYP"
 530         export FSTYP=overlay
 531
 532         # Store original base fs vars
 533         export OVL_BASE_TEST_DEV="$TEST_DEV"
 534         export OVL_BASE_TEST_DIR="$TEST_DIR"
 535         export OVL_BASE_MOUNT_OPTIONS="$MOUNT_OPTIONS"
 536
 537         # Set TEST vars to overlay base and mount dirs inside base fs
 538         export TEST_DEV="$OVL_BASE_TEST_DIR"
 539         export TEST_DIR="$OVL_BASE_TEST_DIR/$OVL_MNT"
 540         export MOUNT_OPTIONS="$OVERLAY_MOUNT_OPTIONS"
 541
 542         [ -b "$SCRATCH_DEV" ] || return 0
 543
 544         # Store original base fs vars
 545         export OVL_BASE_SCRATCH_DEV="$SCRATCH_DEV"
 546         export OVL_BASE_SCRATCH_MNT="$SCRATCH_MNT"
 547
 548         # Set SCRATCH vars to overlay base and mount dirs inside base fs
 549         export SCRATCH_DEV="$OVL_BASE_SCRATCH_MNT"
 550         export SCRATCH_MNT="$OVL_BASE_SCRATCH_MNT/$OVL_MNT"
 551 }
 552
 553 _overlay_config_restore()
 554 {
 555         export OVERLAY=true
 556         [ -z "$OVL_BASE_FSTYP" ] || export FSTYP=$OVL_BASE_FSTYP
 557         [ -z "$OVL_BASE_TEST_DEV" ] || export TEST_DEV=$OVL_BASE_TEST_DEV
 558         [ -z "$OVL_BASE_TEST_DIR" ] || export TEST_DIR=$OVL_BASE_TEST_DIR
 559         [ -z "$OVL_BASE_SCRATCH_DEV" ] || export SCRATCH_DEV=$OVL_BASE_SCRATCH_DEV
 560         [ -z "$OVL_BASE_SCRATCH_MNT" ] || export SCRATCH_MNT=$OVL_BASE_SCRATCH_MNT
 561         [ -z "$OVL_BASE_MOUNT_OPTIONS" ] || export MOUNT_OPTIONS=$OVL_BASE_MOUNT_OPTIONS
 562 }
 563
 564 # Parse config section options. This function will parse all the configuration
 565 # within a single section which name is passed as an argument. For section
 566 # name format see comments in get_config_sections().
 567 # Empty lines and everything after '#' will be ignored.
 568 # Configuration options should be defined in the format
 569 #
 570 # CONFIG_OPTION=value
 571 #
 572 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
 573 parse_config_section() {
 574         SECTION=$1
 575         if ! $OPTIONS_HAVE_SECTIONS; then
 576                 return 0
 577         fi
 578         eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
 579                 -e 's/#.*$//' \
 580                 -e 's/[[:space:]]*$//' \
 581                 -e 's/^[[:space:]]*//' \
 582                 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
 583                 < $HOST_OPTIONS \
 584                 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
 585 }
 586
 587 get_next_config() {
 588         if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
 589                 return 0
 590         fi
 591
 592         # We might have overriden FSTYP and TEST/SCRATCH vars with overlay values
 593         # in the previous section, so restore them to original values stored in
 594         # OVL_BASE_*.
 595         # We need to do this *before* old FSTYP and MOUNT_OPTIONS are recorded
 596         # and *before* SCRATCH_DEV and MOUNT_OPTIONS are unset
 597         if [ "$FSTYP" == "overlay" ]; then
 598                 _overlay_config_restore
 599         fi
 600
 601         local OLD_FSTYP=$FSTYP
 602         local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
 603         local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
 604         local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
 605         local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
 606         local OLD_USE_EXTERNAL=$USE_EXTERNAL
 607
 608         unset MOUNT_OPTIONS
 609         unset TEST_FS_MOUNT_OPTS
 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