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