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