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