common/config

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