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