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