common/config

   1 ##/bin/bash
   2 # SPDX-License-Identifier: GPL-2.0
   3 # Copyright (c) 2000-2003,2006 Silicon Graphics, Inc.  All Rights Reserved.
   4 #
   5 # setup and check for config parameters, and in particular
   6 #
   7 # EMAIL -           email of the script runner.
   8 # TEST_DIR -        scratch test directory that is in an already
   9 #                   mounted XFS file system, needs to be be world
  10 #                   writeable
  11 # TEST_DEV -        device for file system containing TEST_DIR
  12 #
  13 # and optionally:
  14 # SCRATCH_DEV -     device you can make a scratch file system on
  15 # SCRATCH_MNT -     mount point for scratch file system
  16 # SCRATCH_LOGDEV -  scratch log device for external log testing
  17 # SCRATCH_RTDEV -   scratch rt dev
  18 # TEST_LOGDEV -     test log device for external log testing
  19 # TEST_RTDEV -      test rt dev
  20 # TAPE_DEV -        the tape device for the xfsdump tests
  21 # RMT_TAPE_DEV -    the remote tape device for the xfsdump tests
  22 # RMT_IRIXTAPE_DEV- the IRIX remote tape device for the xfsdump tests
  23 # RMT_TAPE_USER -   remote user for tape device
  24 # SELINUX_MOUNT_OPTIONS - Options to use when SELinux is enabled.
  25 #
  26 # - These can be added to $HOST_CONFIG_DIR (witch default to ./config)
  27 #   below or a separate local configuration file can be used (using
  28 #   the HOST_OPTIONS variable).
  29 # - This script is shared by the stress test system and the auto-qa
  30 #   system
  31 # - TEST_DEV & TEST_DIR must be assigned.
  32 # - this script shouldn't make any assertions about filesystem
  33 #   validity or mountedness.
  34 #
  35
  36 . common/test_names
  37
  38 # all tests should use a common language setting to prevent golden
  39 # output mismatches.
  40 export LANG=C
  41 export LC_ALL=C
  42
  43 PATH=".:$PATH"
  44
  45 export HOST=`hostname -s`
  46 export HOSTOS=`uname -s`
  47
  48 export MODULAR=0               # using XFS as a module or not
  49 export BOOT="/boot"            # install target for kernels
  50 export EXTRA=${EXTRA:=xfs-qa}
  51
  52 # general parameters (mainly for auto-qa)
  53 export SOAK_PROC=3             # -p option to fsstress
  54 export SOAK_STRESS=10000       # -n option to fsstress
  55 export SOAK_PASSES=-1          # count of repetitions of fsstress (while soaking)
  56 export EMAIL=root@localhost    # where auto-qa will send its status messages
  57 export HOST_OPTIONS=${HOST_OPTIONS:=local.config}
  58 export CHECK_OPTIONS=${CHECK_OPTIONS:="-g auto"}
  59 export BENCH_PASSES=${BENCH_PASSES:=5}
  60 export XFS_MKFS_OPTIONS=${XFS_MKFS_OPTIONS:=-bsize=4096}
  61 export TIME_FACTOR=${TIME_FACTOR:=1}
  62 export LOAD_FACTOR=${LOAD_FACTOR:=1}
  63 export DEBUGFS_MNT=${DEBUGFS_MNT:="/sys/kernel/debug"}
  64
  65 # some constants for overlayfs setup
  66 export OVL_UPPER="ovl-upper"
  67 export OVL_LOWER="ovl-lower"
  68 export OVL_WORK="ovl-work"
  69 # overlay mount point parent must be the base fs root
  70 export OVL_MNT="ovl-mnt"
  71
  72 export PWD=`pwd`
  73 #export DEBUG=${DEBUG:=...} # arbitrary CFLAGS really.
  74 export MALLOCLIB=${MALLOCLIB:=/usr/lib/libefence.a}
  75 export LOCAL_CONFIGURE_OPTIONS=${LOCAL_CONFIGURE_OPTIONS:=--enable-readline=yes}
  76
  77 export RECREATE_TEST_DEV=false
  78
  79 # Handle mkfs.$fstyp which does (or does not) require -f to overwrite
  80 set_mkfs_prog_path_with_opts()
  81 {
  82         local fstyp=$1
  83         local p=$(type -P mkfs.$fstyp)
  84
  85         # Note: mkfs.f2fs doesn't support the --help option yet, but it doesn't
  86         # matter since it also prints the help when an invalid option is given.
  87         if [ "$p" != "" ] && \
  88                 $p --help |& grep -q "[[:space:]]-f[[:space:]|]"; then
  89                 echo "$p -f"
  90         else
  91                 echo $p
  92         fi
  93 }
  94
  95 _fatal()
  96 {
  97     echo "$*"
  98     status=1
  99     exit 1
 100 }
 101
 102 export MKFS_PROG="$(type -P mkfs)"
 103 [ "$MKFS_PROG" = "" ] && _fatal "mkfs not found"
 104
 105 export MOUNT_PROG="$(type -P mount)"
 106 [ "$MOUNT_PROG" = "" ] && _fatal "mount not found"
 107
 108 export UMOUNT_PROG="$(type -P umount)"
 109 [ "$UMOUNT_PROG" = "" ] && _fatal "umount not found"
 110
 111 export FSSTRESS_PROG="./ltp/fsstress"
 112 [ ! -x $FSSTRESS_PROG ] && _fatal "fsstress not found or executable"
 113
 114 export PERL_PROG="$(type -P perl)"
 115 [ "$PERL_PROG" = "" ] && _fatal "perl not found"
 116
 117 export AWK_PROG="$(type -P awk)"
 118 [ "$AWK_PROG" = "" ] && _fatal "awk not found"
 119
 120 export SED_PROG="$(type -P sed)"
 121 [ "$SED_PROG" = "" ] && _fatal "sed not found"
 122
 123 export BC_PROG="$(type -P bc)"
 124 [ "$BC_PROG" = "" ] && _fatal "bc not found"
 125
 126 export PS_ALL_FLAGS="-ef"
 127
 128 export DF_PROG="$(type -P df)"
 129 [ "$DF_PROG" = "" ] && _fatal "df not found"
 130 [ "$HOSTOS" = "Linux" ] && export DF_PROG="$DF_PROG -T -P"
 131
 132 export XFS_IO_PROG="$(type -P xfs_io)"
 133 [ "$XFS_IO_PROG" = "" ] && _fatal "xfs_io not found"
 134
 135 export XFS_LOGPRINT_PROG="$(type -P xfs_logprint)"
 136 export XFS_REPAIR_PROG="$(type -P xfs_repair)"
 137 export XFS_DB_PROG="$(type -P xfs_db)"
 138 export XFS_GROWFS_PROG=$(type -P xfs_growfs)
 139 export XFS_SPACEMAN_PROG="$(type -P xfs_spaceman)"
 140 export XFS_SCRUB_PROG="$(type -P xfs_scrub)"
 141 export XFS_PARALLEL_REPAIR_PROG="$(type -P xfs_prepair)"
 142 export XFS_PARALLEL_REPAIR64_PROG="$(type -P xfs_prepair64)"
 143 export __XFSDUMP_PROG="$(type -P xfsdump)"
 144 if [ -n "$__XFSDUMP_PROG" ]; then
 145         export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
 146 else
 147         export XFSDUMP_PROG=""
 148 fi
 149 export XFSRESTORE_PROG="$(type -P xfsrestore)"
 150 export XFSINVUTIL_PROG="$(type -P xfsinvutil)"
 151 export GETFATTR_PROG="$(type -P getfattr)"
 152 export SETFATTR_PROG="$(type -P setfattr)"
 153 export CHACL_PROG="$(type -P chacl)"
 154 export ATTR_PROG="$(type -P attr)"
 155 export QUOTA_PROG="$(type -P quota)"
 156 export XFS_QUOTA_PROG="$(type -P xfs_quota)"
 157 export KILLALL_PROG="$(type -P killall)"
 158 export INDENT_PROG="$(type -P indent)"
 159 export XFS_COPY_PROG="$(type -P xfs_copy)"
 160 export FSTRIM_PROG="$(type -P fstrim)"
 161 export DUMPE2FS_PROG="$(type -P dumpe2fs)"
 162 export RESIZE2FS_PROG="$(type -P resize2fs)"
 163 export FIO_PROG="$(type -P fio)"
 164 export FILEFRAG_PROG="$(type -P filefrag)"
 165 export E4DEFRAG_PROG="$(type -P e4defrag)"
 166 export LOGGER_PROG="$(type -P logger)"
 167 export DBENCH_PROG="$(type -P dbench)"
 168 export DMSETUP_PROG="$(type -P dmsetup)"
 169 export WIPEFS_PROG="$(type -P wipefs)"
 170 export DUMP_PROG="$(type -P dump)"
 171 export RESTORE_PROG="$(type -P restore)"
 172 export LVM_PROG="$(type -P lvm)"
 173 export CHATTR_PROG="$(type -P chattr)"
 174 export DEBUGFS_PROG="$(type -P debugfs)"
 175 export UUIDGEN_PROG="$(type -P uuidgen)"
 176 export GETRICHACL_PROG="$(type -P getrichacl)"
 177 export SETRICHACL_PROG="$(type -P setrichacl)"
 178 export KEYCTL_PROG="$(type -P keyctl)"
 179 export XZ_PROG="$(type -P xz)"
 180 export FLOCK_PROG="$(type -P flock)"
 181 export LDD_PROG="$(type -P ldd)"
 182 export TIMEOUT_PROG="$(type -P timeout)"
 183 export MAN_PROG="$(type -P man)"
 184 export NFS4_SETFACL_PROG="$(type -P nfs4_setfacl)"
 185 export NFS4_GETFACL_PROG="$(type -P nfs4_getfacl)"
 186 export UBIUPDATEVOL_PROG="$(type -P ubiupdatevol)"
 187 export THIN_CHECK_PROG="$(type -P thin_check)"
 188 export PYTHON2_PROG="$(type -P python2)"
 189 export SQLITE3_PROG="$(type -P sqlite3)"
 190 export TIMEOUT_PROG="$(type -P timeout)"
 191 export SETCAP_PROG="$(type -P setcap)"
 192 export GETCAP_PROG="$(type -P getcap)"
 193 export CHECKBASHISMS_PROG="$(type -P checkbashisms)"
 194 export XFS_INFO_PROG="$(type -P xfs_info)"
 195 export DUPEREMOVE_PROG="$(type -P duperemove)"
 196
 197 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
 198 # newer systems have udevadm command but older systems like RHEL5 don't.
 199 # But if neither one is available, just set it to "sleep 1" to wait for lv to
 200 # be settled
 201 UDEV_SETTLE_PROG="$(type -P udevadm)"
 202 if [ "$UDEV_SETTLE_PROG" == "" ]; then
 203         # try udevsettle command
 204         UDEV_SETTLE_PROG="$(type -P udevsettle)"
 205 else
 206         # udevadm is available, add 'settle' as subcommand
 207         UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
 208 fi
 209 # neither command is available, use sleep 1
 210 if [ "$UDEV_SETTLE_PROG" == "" ]; then
 211         UDEV_SETTLE_PROG="sleep 1"
 212 fi
 213 export UDEV_SETTLE_PROG
 214
 215 case "$HOSTOS" in
 216     Linux)
 217         export MKFS_XFS_PROG=$(type -P mkfs.xfs)
 218         export MKFS_EXT4_PROG=$(type -P mkfs.ext4)
 219         export MKFS_UDF_PROG=$(type -P mkudffs)
 220         export MKFS_BTRFS_PROG=$(set_mkfs_prog_path_with_opts btrfs)
 221         export MKFS_F2FS_PROG=$(set_mkfs_prog_path_with_opts f2fs)
 222         export DUMP_F2FS_PROG=$(type -P dump.f2fs)
 223         export BTRFS_UTIL_PROG=$(type -P btrfs)
 224         export BTRFS_SHOW_SUPER_PROG=$(type -P btrfs-show-super)
 225         export BTRFS_CONVERT_PROG=$(type -P btrfs-convert)
 226         export BTRFS_TUNE_PROG=$(type -P btrfstune)
 227         export XFS_FSR_PROG=$(type -P xfs_fsr)
 228         export MKFS_NFS_PROG="false"
 229         export MKFS_CIFS_PROG="false"
 230         export MKFS_OVERLAY_PROG="false"
 231         export MKFS_REISER4_PROG=$(type -P mkfs.reiser4)
 232         export E2FSCK_PROG=$(type -P e2fsck)
 233         export TUNE2FS_PROG=$(type -P tune2fs)
 234         export FSCK_OVERLAY_PROG=$(type -P fsck.overlay)
 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 _mount_opts()
 264 {
 265         case $FSTYP in
 266         9p)
 267                 export MOUNT_OPTIONS=$PLAN9_MOUNT_OPTIONS
 268                 ;;
 269         xfs)
 270                 export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
 271                 ;;
 272         udf)
 273                 export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
 274                 ;;
 275         nfs)
 276                 export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
 277                 ;;
 278         cifs)
 279                 export MOUNT_OPTIONS=$CIFS_MOUNT_OPTIONS
 280                 ;;
 281         ceph)
 282                 export MOUNT_OPTIONS=$CEPHFS_MOUNT_OPTIONS
 283                 ;;
 284         glusterfs)
 285                 export MOUNT_OPTIONS=$GLUSTERFS_MOUNT_OPTIONS
 286                 ;;
 287         overlay)
 288                 export MOUNT_OPTIONS=$OVERLAY_MOUNT_OPTIONS
 289                 ;;
 290         ext2|ext3|ext4|ext4dev)
 291                 # acls & xattrs aren't turned on by default on ext$FOO
 292                 export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
 293                 ;;
 294         f2fs)
 295                 export MOUNT_OPTIONS="-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
 296                 ;;
 297         reiserfs)
 298                 # acls & xattrs aren't turned on by default on reiserfs
 299                 export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
 300                 ;;
 301        reiser4)
 302                # acls & xattrs aren't supported by reiser4
 303                export MOUNT_OPTIONS=$REISER4_MOUNT_OPTIONS
 304                ;;
 305         gfs2)
 306                 # acls aren't turned on by default on gfs2
 307                 export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
 308                 ;;
 309         tmpfs)
 310                 # We need to specify the size at mount, use 1G by default
 311                 export MOUNT_OPTIONS="-o size=1G $TMPFS_MOUNT_OPTIONS"
 312                 ;;
 313         ubifs)
 314                 export MOUNT_OPTIONS=$UBIFS_MOUNT_OPTIONS
 315                 ;;
 316         *)
 317                 ;;
 318         esac
 319 }
 320
 321 _test_mount_opts()
 322 {
 323         case $FSTYP in
 324         9p)
 325                 export TEST_FS_MOUNT_OPTS=$PLAN9_MOUNT_OPTIONS
 326                 ;;
 327         cifs)
 328                 export TEST_FS_MOUNT_OPTS=$CIFS_MOUNT_OPTIONS
 329                 ;;
 330         ceph)
 331                 export TEST_FS_MOUNT_OPTS=$CEPHFS_MOUNT_OPTIONS
 332                 ;;
 333         nfs)
 334                 export TEST_FS_MOUNT_OPTS=$NFS_MOUNT_OPTIONS
 335                 ;;
 336         glusterfs)
 337                 export TEST_FS_MOUNT_OPTS=$GLUSTERFS_MOUNT_OPTIONS
 338                 ;;
 339         ext2|ext3|ext4|ext4dev)
 340                 # acls & xattrs aren't turned on by default on older ext$FOO
 341                 export TEST_FS_MOUNT_OPTS="-o acl,user_xattr $EXT_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         case "$FSTYP" in
 459         9p)
 460                 # 9p mount tags are just plain strings, so anything is allowed
 461                 ;;
 462         overlay)
 463                 if [ ! -d "$dev" ]; then
 464                         _fatal "common/config: $name ($dev) is not a directory for overlay"
 465                 fi
 466                 ;;
 467         ubifs)
 468                 if [ ! -c "$dev" ]; then
 469                         _fatal "common/config: $name ($dev) is not a character device"
 470                 fi
 471                 ;;
 472         *)
 473                 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
 474         esac
 475 }
 476
 477 # check and return a canonical mount point path
 478 _canonicalize_mountpoint()
 479 {
 480         local name=$1
 481         local dir=$2
 482
 483         if [ -d "$dir" ]; then
 484                 # this follows symlinks and removes all trailing "/"s
 485                 readlink -e "$dir"
 486                 return 0
 487         fi
 488
 489         if [ "$FSTYP" != "overlay" ] || [[ "$name" == OVL_BASE_* ]]; then
 490                 _fatal "common/config: $name ($dir) is not a directory"
 491         fi
 492
 493         # base fs may not be mounted yet, so just check that parent dir
 494         # exists (where base fs will be mounted) because we are going to
 495         # mkdir the overlay mount point dir anyway
 496         local base=`basename $dir`
 497         local parent=`dirname $dir`
 498         parent=`_canonicalize_mountpoint OVL_BASE_$name "$parent"`
 499
 500         # prepend the overlay mount point to canonical parent path
 501         echo "$parent/$base"
 502 }
 503
 504 # On check -overlay, for the non multi section config case, this
 505 # function is called on every test, before init_rc().
 506 # When SCRATCH/TEST_* vars are defined in config file, config file
 507 # is sourced on every test and this function overrides the vars
 508 # every time.
 509 # When SCRATCH/TEST_* vars are defined in evironment and not
 510 # in config file, this function is called after vars have already
 511 # been overriden in the previous test.
 512 # In that case, TEST_DEV is a directory and not a blockdev and
 513 # the function will return without overriding the SCRATCH/TEST_* vars.
 514 _overlay_config_override()
 515 {
 516         # There are 2 options for configuring overlayfs tests:
 517         #
 518         # 1. (legacy) SCRATCH/TEST_DEV point to existing directories
 519         #    on an already mounted fs.  In this case, the new
 520         #    OVL_BASE_SCRATCH/TEST_* vars are set to use the legacy
 521         #    vars values (even though they may not be mount points).
 522         #
 523         [ ! -d "$TEST_DEV" ] || export OVL_BASE_TEST_DIR="$TEST_DEV"
 524         [ ! -d "$SCRATCH_DEV" ] || export OVL_BASE_SCRATCH_MNT="$SCRATCH_DEV"
 525
 526         # 2. SCRATCH/TEST_DEV point to the base fs partitions.  In this case,
 527         #    the new OVL_BASE_SCRATCH/TEST_DEV/MNT vars are set to the values
 528         #    of the configured base fs and SCRATCH/TEST_DEV vars are set to the
 529         #    overlayfs base and mount dirs inside base fs mount.
 530         [ -b "$TEST_DEV" ] || return 0
 531
 532         # Config file may specify base fs type, but we obay -overlay flag
 533         export OVL_BASE_FSTYP="$FSTYP"
 534         export FSTYP=overlay
 535
 536         # Store original base fs vars
 537         export OVL_BASE_TEST_DEV="$TEST_DEV"
 538         export OVL_BASE_TEST_DIR="$TEST_DIR"
 539         # If config does not set MOUNT_OPTIONS, its value may be
 540         # leftover from previous _overlay_config_override, so
 541         # don't use that value for base fs mount
 542         [ "$MOUNT_OPTIONS" != "$OVERLAY_MOUNT_OPTIONS" ] || unset MOUNT_OPTIONS
 543         export OVL_BASE_MOUNT_OPTIONS="$MOUNT_OPTIONS"
 544
 545         # Set TEST vars to overlay base and mount dirs inside base fs
 546         export TEST_DEV="$OVL_BASE_TEST_DIR"
 547         export TEST_DIR="$OVL_BASE_TEST_DIR/$OVL_MNT"
 548         export MOUNT_OPTIONS="$OVERLAY_MOUNT_OPTIONS"
 549
 550         [ -b "$SCRATCH_DEV" ] || return 0
 551
 552         # Store original base fs vars
 553         export OVL_BASE_SCRATCH_DEV="$SCRATCH_DEV"
 554         export OVL_BASE_SCRATCH_MNT="$SCRATCH_MNT"
 555
 556         # Set SCRATCH vars to overlay base and mount dirs inside base fs
 557         export SCRATCH_DEV="$OVL_BASE_SCRATCH_MNT"
 558         export SCRATCH_MNT="$OVL_BASE_SCRATCH_MNT/$OVL_MNT"
 559
 560         # Set fsck options, use default if user not set directly.
 561         export FSCK_OPTIONS="$OVERLAY_FSCK_OPTIONS"
 562         [ -z "$FSCK_OPTIONS" ] && _fsck_opts
 563 }
 564
 565 _overlay_config_restore()
 566 {
 567         export OVERLAY=true
 568         [ -z "$OVL_BASE_FSTYP" ] || export FSTYP=$OVL_BASE_FSTYP
 569         [ -z "$OVL_BASE_TEST_DEV" ] || export TEST_DEV=$OVL_BASE_TEST_DEV
 570         [ -z "$OVL_BASE_TEST_DIR" ] || export TEST_DIR=$OVL_BASE_TEST_DIR
 571         [ -z "$OVL_BASE_SCRATCH_DEV" ] || export SCRATCH_DEV=$OVL_BASE_SCRATCH_DEV
 572         [ -z "$OVL_BASE_SCRATCH_MNT" ] || export SCRATCH_MNT=$OVL_BASE_SCRATCH_MNT
 573         [ -z "$OVL_BASE_MOUNT_OPTIONS" ] || export MOUNT_OPTIONS=$OVL_BASE_MOUNT_OPTIONS
 574 }
 575
 576 # Parse config section options. This function will parse all the configuration
 577 # within a single section which name is passed as an argument. For section
 578 # name format see comments in get_config_sections().
 579 # Empty lines and everything after '#' will be ignored.
 580 # Configuration options should be defined in the format
 581 #
 582 # CONFIG_OPTION=value
 583 #
 584 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
 585 parse_config_section() {
 586         SECTION=$1
 587         if ! $OPTIONS_HAVE_SECTIONS; then
 588                 return 0
 589         fi
 590         eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
 591                 -e 's/#.*$//' \
 592                 -e 's/[[:space:]]*$//' \
 593                 -e 's/^[[:space:]]*//' \
 594                 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
 595                 < $HOST_OPTIONS \
 596                 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
 597 }
 598
 599 get_next_config() {
 600         if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
 601                 return 0
 602         fi
 603
 604         # We might have overriden FSTYP and TEST/SCRATCH vars with overlay values
 605         # in the previous section, so restore them to original values stored in
 606         # OVL_BASE_*.
 607         # We need to do this *before* old FSTYP and MOUNT_OPTIONS are recorded
 608         # and *before* SCRATCH_DEV and MOUNT_OPTIONS are unset
 609         if [ "$FSTYP" == "overlay" ]; then
 610                 _overlay_config_restore
 611         fi
 612
 613         local OLD_FSTYP=$FSTYP
 614         local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
 615         local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
 616         local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
 617         local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
 618         local OLD_USE_EXTERNAL=$USE_EXTERNAL
 619
 620         unset MOUNT_OPTIONS
 621         unset TEST_FS_MOUNT_OPTS
 622         unset MKFS_OPTIONS
 623         unset FSCK_OPTIONS
 624         unset USE_EXTERNAL
 625
 626         # We might have deduced SCRATCH_DEV from the SCRATCH_DEV_POOL in the previous
 627         # run, so we have to unset it now.
 628         if [ "$SCRATCH_DEV_NOT_SET" == "true" ]; then
 629                 unset SCRATCH_DEV
 630         fi
 631
 632         parse_config_section $1
 633
 634         if [ ! -z "$OLD_FSTYP" ] && [ $OLD_FSTYP != $FSTYP ]; then
 635                 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
 636                 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
 637                 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
 638                 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
 639
 640                 # clear the external devices if we are not using them
 641                 if [ -z "$USE_EXTERNAL" ]; then
 642                         unset TEST_RTDEV
 643                         unset TEST_LOGDEV
 644                         unset SCRATCH_RTDEV
 645                         unset SCRATCH_LOGDEV
 646                 fi
 647         else
 648                 [ -z "$MOUNT_OPTIONS" ] && export MOUNT_OPTIONS=$OLD_MOUNT_OPTIONS
 649                 [ -z "$TEST_FS_MOUNT_OPTS" ] && export TEST_FS_MOUNT_OPTS=$OLD_TEST_FS_MOUNT_OPTS
 650                 [ -z "$MKFS_OPTIONS" ] && export MKFS_OPTIONS=$OLD_MKFS_OPTIONS
 651                 [ -z "$FSCK_OPTIONS" ] && export FSCK_OPTIONS=$OLD_FSCK_OPTIONS
 652                 [ -z "$USE_EXTERNAL" ] && export USE_EXTERNAL=$OLD_USE_EXTERNAL
 653         fi
 654
 655         # set default RESULT_BASE
 656         if [ -z "$RESULT_BASE" ]; then
 657                 export RESULT_BASE="$here/results/"
 658         fi
 659
 660         #  Mandatory Config values.
 661         MC=""
 662         [ -z "$EMAIL" ]          && MC="$MC EMAIL"
 663         [ -z "$TEST_DIR" ]       && MC="$MC TEST_DIR"
 664         [ -z "$TEST_DEV" ]       && MC="$MC TEST_DEV"
 665
 666         if [ -n "$MC" ]; then
 667                 echo "Warning: need to define parameters for host $HOST"
 668                 echo "       or set variables:"
 669                 echo "       $MC"
 670                 exit 1
 671         fi
 672
 673         _check_device TEST_DEV required $TEST_DEV
 674         export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
 675
 676         # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
 677         # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
 678         if [ ! -z "$SCRATCH_DEV_POOL" ]; then
 679                 if [ ! -z "$SCRATCH_DEV" ]; then
 680                         echo "common/config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) should be unset when \$SCRATCH_DEV_POOL ($SCRATCH_DEV_POOL) is set"
 681                         exit 1
 682                 fi
 683                 SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
 684                 export SCRATCH_DEV
 685                 export SCRATCH_DEV_NOT_SET=true
 686         fi
 687
 688         _check_device SCRATCH_DEV optional $SCRATCH_DEV
 689         export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
 690
 691         if [ -n "$USE_EXTERNAL" ]; then
 692                 _check_device TEST_RTDEV optional $TEST_RTDEV
 693                 _check_device TEST_LOGDEV optional $TEST_LOGDEV
 694                 _check_device SCRATCH_RTDEV optional $SCRATCH_RTDEV
 695                 _check_device SCRATCH_LOGDEV optional $SCRATCH_LOGDEV
 696         fi
 697
 698         # Override FSTYP from config when running ./check -overlay
 699         # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs.
 700         # We need to do this *after* default mount options are set by base FSTYP
 701         # and *after* SCRATCH_DEV is deduced from SCRATCH_DEV_POOL
 702         if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
 703                 _overlay_config_override
 704         fi
 705 }
 706
 707 if [ -z "$CONFIG_INCLUDED" ]; then
 708         get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
 709         export CONFIG_INCLUDED=true
 710
 711         # Autodetect fs type based on what's on $TEST_DEV unless it's been set
 712         # externally
 713         if [ -z "$FSTYP" ] && \
 714            [ "$HOSTOS" == "Linux" -o "$OSTYPE" == "linux-gnu" ] && \
 715            [ ! -z "$TEST_DEV" ]; then
 716                 FSTYP=`blkid -c /dev/null -s TYPE -o value $TEST_DEV`
 717         fi
 718         FSTYP=${FSTYP:=xfs}
 719         export FSTYP
 720         [ -z "$MOUNT_OPTIONS" ] && _mount_opts
 721         [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
 722         [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
 723         [ -z "$FSCK_OPTIONS" ] && _fsck_opts
 724 else
 725         # We get here for the non multi section case, on every test that sources
 726         # common/rc after re-sourcing the HOST_OPTIONS config file.
 727         # Because of this re-sourcing, we need to re-canonicalize the configured
 728         # mount points and re-override TEST/SCRATCH_DEV overlay vars.
 729
 730         # canonicalize the mount points
 731         # this follows symlinks and removes all trailing "/"s
 732         export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
 733         export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
 734
 735         # Override FSTYP from config when running ./check -overlay
 736         # and maybe override base fs TEST/SCRATCH_DEV with overlay base dirs
 737         if [ "$OVERLAY" == "true" -o "$FSTYP" == "overlay" ]; then
 738                 _overlay_config_override
 739         fi
 740 fi
 741
 742 # make sure this script returns success
 743 /bin/true