3 # Copyright (c) 2000-2003,2006 Silicon Graphics, Inc. All Rights Reserved.
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.
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.
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
19 # setup and check for config parameters, and in particular
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
25 # TEST_DEV - device for file system containing TEST_DIR
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
39 # - These can be added to $HOST_CONFIG_DIR (witch default to ./config)
40 # below or a separate local configuration file can be used (using
41 # the HOST_OPTIONS variable).
42 # - This script is shared by the stress test system and the auto-qa
44 # - TEST_DEV & TEST_DIR must be assigned.
45 # - this script shouldn't make any assertions about filesystem
46 # validity or mountedness.
49 # all tests should use a common language setting to prevent golden
54 # Warning: don't put freeware before /usr/bsd on IRIX coz you'll
55 # get the wrong hostname and set your system name to -s :)
56 [ -d /usr/bsd ] && PATH=$PATH:/usr/bsd
57 [ -d /usr/freeware/bin ] && PATH=$PATH:/usr/freeware/bin
60 export HOST=`hostname -s`
61 export HOSTOS=`uname -s`
62 [ "$HOSTOS" = "IRIX64" ] && export HOSTOS="IRIX"
64 export MODULAR=0 # using XFS as a module or not
65 export BOOT="/boot" # install target for kernels
66 export EXTRA=${EXTRA:=xfs-qa}
68 # general parameters (mainly for auto-qa)
69 export SOAK_PROC=3 # -p option to fsstress
70 export SOAK_STRESS=10000 # -n option to fsstress
71 export SOAK_PASSES=-1 # count of repetitions of fsstress (while soaking)
72 export EMAIL=root@localhost # where auto-qa will send its status messages
73 export HOST_OPTIONS=${HOST_OPTIONS:=local.config}
74 export CHECK_OPTIONS=${CHECK_OPTIONS:="-g auto"}
75 export BENCH_PASSES=${BENCH_PASSES:=5}
76 export XFS_MKFS_OPTIONS=${XFS_MKFS_OPTIONS:=-bsize=4096}
77 export TIME_FACTOR=${TIME_FACTOR:=1}
78 export LOAD_FACTOR=${LOAD_FACTOR:=1}
79 export DEBUGFS_MNT=${DEBUGFS_MNT:="/sys/kernel/debug"}
80 export OVERLAY_UPPER_DIR=${OVERLAY_UPPER_DIR:="upper"}
81 export OVERLAY_LOWER_DIR=${OVERLAY_LOWER_DIR:="lower"}
82 export OVERLAY_WORK_DIR=${OVERLAY_WORK_DIR:="work"}
85 #export DEBUG=${DEBUG:=...} # arbitrary CFLAGS really.
86 export MALLOCLIB=${MALLOCLIB:=/usr/lib/libefence.a}
87 export LOCAL_CONFIGURE_OPTIONS=${LOCAL_CONFIGURE_OPTIONS:=--enable-readline=yes}
89 export RECREATE_TEST_DEV=false
91 # $1 = prog to look for, $2* = default pathnames if not found in $PATH
94 p=`which $1 2> /dev/null`
95 if [ -n "$p" -a -x "$p" ]; then
113 # Handle mkfs.btrfs which does (or does not) require -f to overwrite
114 set_btrfs_mkfs_prog_path_with_opts()
116 p=`set_prog_path mkfs.btrfs`
117 if [ "$p" != "" ] && grep -q 'force overwrite' $p; then
131 export MKFS_PROG="`set_prog_path mkfs`"
132 [ "$MKFS_PROG" = "" ] && _fatal "mkfs not found"
134 export MOUNT_PROG="`set_prog_path mount`"
135 [ "$MOUNT_PROG" = "" ] && _fatal "mount not found"
137 export UMOUNT_PROG="`set_prog_path umount`"
138 [ "$UMOUNT_PROG" = "" ] && _fatal "umount not found"
140 export FSSTRESS_PROG="./ltp/fsstress"
141 [ ! -x $FSSTRESS_PROG ] && _fatal "fsstress not found or executable"
143 export PERL_PROG="`set_prog_path perl`"
144 [ "$PERL_PROG" = "" ] && _fatal "perl not found"
146 export AWK_PROG="`set_prog_path awk`"
147 [ "$AWK_PROG" = "" ] && _fatal "awk not found"
149 export SED_PROG="`set_prog_path sed`"
150 [ "$SED_PROG" = "" ] && _fatal "sed not found"
152 export BC_PROG="`set_prog_path bc`"
153 [ "$BC_PROG" = "" ] && _fatal "bc not found"
155 export PS_ALL_FLAGS="-ef"
157 export DF_PROG="`set_prog_path df`"
158 [ "$DF_PROG" = "" ] && _fatal "df not found"
159 [ "$HOSTOS" = "Linux" ] && export DF_PROG="$DF_PROG -T -P"
161 export XFS_IO_PROG="`set_prog_path xfs_io`"
162 [ "$XFS_IO_PROG" = "" ] && _fatal "xfs_io not found"
164 export XFS_LOGPRINT_PROG="`set_prog_path xfs_logprint`"
165 export XFS_REPAIR_PROG="`set_prog_path xfs_repair`"
166 export XFS_DB_PROG="`set_prog_path xfs_db`"
167 export XFS_GROWFS_PROG=`set_prog_path xfs_growfs`
168 export XFS_SCRUB_PROG="`set_prog_path xfs_scrub`"
169 export XFS_PARALLEL_REPAIR_PROG="`set_prog_path xfs_prepair`"
170 export XFS_PARALLEL_REPAIR64_PROG="`set_prog_path xfs_prepair64`"
171 export __XFSDUMP_PROG="`set_prog_path xfsdump`"
172 if [ -n "$__XFSDUMP_PROG" ]; then
173 export XFSDUMP_PROG="$__XFSDUMP_PROG -e"
175 export XFSDUMP_PROG=""
177 export XFSRESTORE_PROG="`set_prog_path xfsrestore`"
178 export XFSINVUTIL_PROG="`set_prog_path xfsinvutil`"
179 export GETFATTR_PROG="`set_prog_path getfattr`"
180 export SETFATTR_PROG="`set_prog_path setfattr`"
181 export CHACL_PROG="`set_prog_path chacl`"
182 export ATTR_PROG="`set_prog_path attr`"
183 export QUOTA_PROG="`set_prog_path quota`"
184 export XFS_QUOTA_PROG="`set_prog_path xfs_quota`"
185 export KILLALL_PROG="`set_prog_path killall`"
186 export INDENT_PROG="`set_prog_path indent`"
187 export XFS_COPY_PROG="`set_prog_path xfs_copy`"
188 export FSTRIM_PROG="`set_prog_path fstrim`"
189 export DUMPE2FS_PROG="`set_prog_path dumpe2fs`"
190 export FIO_PROG="`set_prog_path fio`"
191 export FILEFRAG_PROG="`set_prog_path filefrag`"
192 export E4DEFRAG_PROG="`set_prog_path e4defrag`"
193 export LOGGER_PROG="`set_prog_path logger`"
194 export DBENCH_PROG="`set_prog_path dbench`"
195 export DMSETUP_PROG="`set_prog_path dmsetup`"
196 export WIPEFS_PROG="`set_prog_path wipefs`"
197 export DUMP_PROG="`set_prog_path dump`"
198 export RESTORE_PROG="`set_prog_path restore`"
199 export LVM_PROG="`set_prog_path lvm`"
200 export CHATTR_PROG="`set_prog_path chattr`"
201 export DEBUGFS_PROG="`set_prog_path debugfs`"
202 export UUIDGEN_PROG="`set_prog_path uuidgen`"
203 export GETRICHACL_PROG="`set_prog_path getrichacl`"
204 export SETRICHACL_PROG="`set_prog_path setrichacl`"
205 export KEYCTL_PROG="`set_prog_path keyctl`"
206 export XZ_PROG="`set_prog_path xz`"
207 export FLOCK_PROG="`set_prog_path flock`"
208 export LDD_PROG="`set_prog_path ldd`"
209 export TIMEOUT_PROG="`set_prog_path timeout`"
211 # use 'udevadm settle' or 'udevsettle' to wait for lv to be settled.
212 # newer systems have udevadm command but older systems like RHEL5 don't.
213 # But if neither one is available, just set it to "sleep 1" to wait for lv to
215 UDEV_SETTLE_PROG="`set_prog_path udevadm`"
216 if [ "$UDEV_SETTLE_PROG" == "" ]; then
217 # try udevsettle command
218 UDEV_SETTLE_PROG="`set_prog_path udevsettle`"
220 # udevadm is available, add 'settle' as subcommand
221 UDEV_SETTLE_PROG="$UDEV_SETTLE_PROG settle"
223 # neither command is available, use sleep 1
224 if [ "$UDEV_SETTLE_PROG" == "" ]; then
225 UDEV_SETTLE_PROG="sleep 1"
227 export UDEV_SETTLE_PROG
231 export MKFS_XFS_PROG="`set_prog_path mkfs_xfs`"
232 export MKFS_UDF_PROG="`set_prog_path mkfs_udf`"
233 export XFS_FSR_PROG="`set_prog_path /usr/etc/fsr_xfs`"
234 export MKFS_NFS_PROG="false"
235 export MKFS_CIFS_PROG="false"
238 export MKFS_XFS_PROG="`set_prog_path mkfs.xfs`"
239 export MKFS_EXT4_PROG="`set_prog_path mkfs.ext4`"
240 export MKFS_UDF_PROG="`set_prog_path mkudffs`"
241 export MKFS_BTRFS_PROG="`set_btrfs_mkfs_prog_path_with_opts`"
242 export MKFS_F2FS_PROG="`set_prog_path mkfs.f2fs`"
243 export DUMP_F2FS_PROG="`set_prog_path dump.f2fs`"
244 export BTRFS_UTIL_PROG="`set_prog_path btrfs`"
245 export BTRFS_SHOW_SUPER_PROG="`set_prog_path btrfs-show-super`"
246 export BTRFS_CONVERT_PROG="`set_prog_path btrfs-convert`"
247 export XFS_FSR_PROG="`set_prog_path xfs_fsr`"
248 export MKFS_NFS_PROG="false"
249 export MKFS_CIFS_PROG="false"
250 export MKFS_OVERLAY_PROG="false"
251 export MKFS_REISER4_PROG="`set_prog_path mkfs.reiser4`"
252 export E2FSCK_PROG="`set_prog_path e2fsck`"
253 export TUNE2FS_PROG="`set_prog_path tune2fs`"
257 # SELinux adds extra xattrs which can mess up our expected output.
258 # So, mount with a context, and they won't be created
259 # # nfs_t is a "liberal" context so we can use it.
260 if [ -x /usr/sbin/selinuxenabled ] && /usr/sbin/selinuxenabled; then
261 SELINUX_MOUNT_OPTIONS="-o context=system_u:object_r:nfs_t:s0"
262 export SELINUX_MOUNT_OPTIONS
265 # check if mkfs.xfs supports v5 xfs
266 XFS_MKFS_HAS_NO_META_SUPPORT=""
267 touch /tmp/crc_check.img
268 $MKFS_XFS_PROG -N -d file,name=/tmp/crc_check.img,size=32m -m crc=0 \
270 if [ $? -ne 0 ]; then
271 XFS_MKFS_HAS_NO_META_SUPPORT=true
273 rm -f /tmp/crc_check.img
274 export XFS_MKFS_HAS_NO_META_SUPPORT
276 # new doesn't need config file parsed, we can stop here
277 if [ "$iam" == "new" ]; then
285 export MOUNT_OPTIONS=$XFS_MOUNT_OPTIONS
288 export MOUNT_OPTIONS=$UDF_MOUNT_OPTIONS
291 export MOUNT_OPTIONS=$NFS_MOUNT_OPTIONS
294 export MOUNT_OPTIONS=$CIFS_MOUNT_OPTIONS
297 export MOUNT_OPTIONS=$CEPHFS_MOUNT_OPTIONS
300 export MOUNT_OPTIONS=$OVERLAY_MOUNT_OPTIONS
302 ext2|ext3|ext4|ext4dev)
303 # acls & xattrs aren't turned on by default on ext$FOO
304 export MOUNT_OPTIONS="-o acl,user_xattr $EXT_MOUNT_OPTIONS"
307 export MOUNT_OPTIONS="-o acl,user_xattr $F2FS_MOUNT_OPTIONS"
310 # acls & xattrs aren't turned on by default on reiserfs
311 export MOUNT_OPTIONS="-o acl,user_xattr $REISERFS_MOUNT_OPTIONS"
314 # acls & xattrs aren't supported by reiser4
315 export MOUNT_OPTIONS=$REISER4_MOUNT_OPTIONS
318 # acls aren't turned on by default on gfs2
319 export MOUNT_OPTIONS="-o acl $GFS2_MOUNT_OPTIONS"
322 # We need to specify the size at mount, use 1G by default
323 export MOUNT_OPTIONS="-o size=1G $TMPFS_MOUNT_OPTIONS"
334 export TEST_FS_MOUNT_OPTS=$CIFS_MOUNT_OPTIONS
337 export TEST_FS_MOUNT_OPTS=$CEPHFS_MOUNT_OPTIONS
348 export MKFS_OPTIONS=$XFS_MKFS_OPTIONS
351 [ ! -z "$udf_fsize" ] && \
352 UDF_MKFS_OPTIONS="$UDF_MKFS_OPTIONS -s $udf_fsize"
353 export MKFS_OPTIONS=$UDF_MKFS_OPTIONS
356 export MKFS_OPTIONS=$NFS_MKFS_OPTIONS
359 export MKFS_OPTIONS=$CIFS_MKFS_OPTIONS
362 export MKFS_OPTIONS=$CEPHFS_MKFS_OPTIONS
365 export MKFS_OPTIONS="$REISERFS_MKFS_OPTIONS -q"
368 export MKFS_OPTIONS=$REISER4_MKFS_OPTIONS
371 export MKFS_OPTIONS="$GFS2_MKFS_OPTIONS -O -p lock_nolock"
374 export MKFS_OPTIONS="$JFS_MKFS_OPTIONS -q"
377 export MKFS_OPTIONS="$F2FS_MKFS_OPTIONS"
387 ext2|ext3|ext4|ext4dev)
388 export FSCK_OPTIONS="-nf"
391 export FSCK_OPTIONS="--yes"
394 export FSCK_OPTIONS=""
397 export FSCK_OPTIONS="-n"
404 [ "$HOST_CONFIG_DIR" ] || HOST_CONFIG_DIR=`pwd`/configs
406 [ -f /etc/xfsqa.config ] && export HOST_OPTIONS=/etc/xfsqa.config
407 [ -f $HOST_CONFIG_DIR/$HOST ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST
408 [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
411 # Returns a list of sections in config file
412 # Each section starts with the section name in the format
413 # [section_name1]. Only alphanumeric characters and '_' is allowed
414 # in the section name otherwise the section will not be resognised.
415 # Section name must be contained between square brackets.
416 get_config_sections() {
417 sed -n -e "s/^\[\([[:alnum:]_]*\)\]/\1/p" < $1
420 if [ ! -f "$HOST_OPTIONS" ]; then
424 export HOST_OPTIONS_SECTIONS="-no-sections-"
425 export OPTIONS_HAVE_SECTIONS=false
426 if [ -f "$HOST_OPTIONS" ]; then
427 export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
428 if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
430 export HOST_OPTIONS_SECTIONS="-no-sections-"
432 export OPTIONS_HAVE_SECTIONS=true
442 if [ -z "$dev" ]; then
443 if [ "$dev_needed" == "required" ]; then
444 _fatal "common/config: $name is required but not defined!"
449 echo $dev | grep -qE ":|//" > /dev/null 2>&1
451 if [ "$FSTYP" == "overlay" ]; then
452 if [ ! -d "$dev" ]; then
453 _fatal "common/config: $name ($dev) is not a directory for overlay"
455 elif [ ! -b "$dev" -a "$network_dev" != "0" ]; then
456 _fatal "common/config: $name ($dev) is not a block device or a network filesystem"
460 # check and return a canonical mount point path
461 _canonicalize_mountpoint()
466 if [ ! -d "$dir" ]; then
467 _fatal "common/config: $name ($dir) is not a directory"
470 # this follows symlinks and removes all trailing "/"s
474 # Parse config section options. This function will parse all the configuration
475 # within a single section which name is passed as an argument. For section
476 # name format see comments in get_config_sections().
477 # Empty lines and everything after '#' will be ignored.
478 # Configuration options should be defined in the format
480 # CONFIG_OPTION=value
482 # This 'CONFIG_OPTION' variable and will be exported as an environment variable.
483 parse_config_section() {
485 if ! $OPTIONS_HAVE_SECTIONS; then
488 eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
490 -e 's/[[:space:]]*$//' \
491 -e 's/^[[:space:]]*//' \
492 -e "s/^\([^=]*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
494 | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
498 if [ ! -z "$CONFIG_INCLUDED" ] && ! $OPTIONS_HAVE_SECTIONS; then
502 local OLD_FSTYP=$FSTYP
503 local OLD_MOUNT_OPTIONS=$MOUNT_OPTIONS
504 local OLD_TEST_FS_MOUNT_OPTS=$TEST_FS_MOUNT_OPTS
505 local OLD_MKFS_OPTIONS=$MKFS_OPTIONS
506 local OLD_FSCK_OPTIONS=$FSCK_OPTIONS
507 local OLD_USE_EXTERNAL=$USE_EXTERNAL
514 # We might have deduced SCRATCH_DEV from the SCRATCH_DEV_POOL in the previous
515 # run, so we have to unset it now.
516 if [ "$SCRATCH_DEV_NOT_SET" == "true" ]; then
520 parse_config_section $1
522 if [ ! -z "$OLD_FSTYP" ] && [ $OLD_FSTYP != $FSTYP ]; then
523 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
524 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
525 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
526 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
528 # clear the external devices if we are not using them
529 if [ -z "$USE_EXTERNAL" ]; then
536 [ -z "$MOUNT_OPTIONS" ] && export MOUNT_OPTIONS=$OLD_MOUNT_OPTIONS
537 [ -z "$TEST_FS_MOUNT_OPTS" ] && export TEST_FS_MOUNT_OPTS=$OLD_TEST_FS_MOUNT_OPTS
538 [ -z "$MKFS_OPTIONS" ] && export MKFS_OPTIONS=$OLD_MKFS_OPTIONS
539 [ -z "$FSCK_OPTIONS" ] && export FSCK_OPTIONS=$OLD_FSCK_OPTIONS
540 [ -z "$USE_EXTERNAL" ] && export USE_EXTERNAL=$OLD_USE_EXTERNAL
543 # set default RESULT_BASE
544 if [ -z "$RESULT_BASE" ]; then
545 export RESULT_BASE="$here/results/"
548 # Mandatory Config values.
550 [ -z "$EMAIL" ] && MC="$MC EMAIL"
551 [ -z "$TEST_DIR" ] && MC="$MC TEST_DIR"
552 [ -z "$TEST_DEV" ] && MC="$MC TEST_DEV"
554 if [ -n "$MC" ]; then
555 echo "Warning: need to define parameters for host $HOST"
556 echo " or set variables:"
561 _check_device TEST_DEV required $TEST_DEV
562 export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
564 # a btrfs tester will set only SCRATCH_DEV_POOL, we will put first of its dev
565 # to SCRATCH_DEV and rest to SCRATCH_DEV_POOL to maintain the backward compatibility
566 if [ ! -z "$SCRATCH_DEV_POOL" ]; then
567 if [ ! -z "$SCRATCH_DEV" ]; then
568 echo "common/config: Error: \$SCRATCH_DEV ($SCRATCH_DEV) should be unset when \$SCRATCH_DEV_POOL ($SCRATCH_DEV_POOL) is set"
571 SCRATCH_DEV=`echo $SCRATCH_DEV_POOL | awk '{print $1}'`
573 export SCRATCH_DEV_NOT_SET=true
576 _check_device SCRATCH_DEV optional $SCRATCH_DEV
577 export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
579 if [ -n "$USE_EXTERNAL" ]; then
580 _check_device TEST_RTDEV optional $TEST_RTDEV
581 _check_device TEST_LOGDEV optional $TEST_LOGDEV
582 _check_device SCRATCH_RTDEV optional $SCRATCH_RTDEV
583 _check_device SCRATCH_LOGDEV optional $SCRATCH_LOGDEV
587 if [ -z "$CONFIG_INCLUDED" ]; then
588 get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
589 export CONFIG_INCLUDED=true
591 # Autodetect fs type based on what's on $TEST_DEV unless it's been set
593 if [ -z "$FSTYP" ] && \
594 [ "$HOSTOS" == "Linux" -o "$OSTYPE" == "linux-gnu" ] && \
595 [ ! -z "$TEST_DEV" ]; then
596 FSTYP=`blkid -c /dev/null -s TYPE -o value $TEST_DEV`
600 [ -z "$MOUNT_OPTIONS" ] && _mount_opts
601 [ -z "$TEST_FS_MOUNT_OPTS" ] && _test_mount_opts
602 [ -z "$MKFS_OPTIONS" ] && _mkfs_opts
603 [ -z "$FSCK_OPTIONS" ] && _fsck_opts
605 # canonicalize the mount points
606 # this follows symlinks and removes all trailing "/"s
607 export TEST_DIR=`_canonicalize_mountpoint TEST_DIR $TEST_DIR`
608 export SCRATCH_MNT=`_canonicalize_mountpoint SCRATCH_MNT $SCRATCH_MNT`
611 # make sure this script returns success