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