3 # Common support functions for testing scripts. If a script-config
4 # files is available it will be sourced so in-tree kernel modules and
5 # utilities will be used. If no script-config can be found then the
6 # installed kernel modules and utilities will be used.
8 basedir
="$(dirname $0)"
10 SCRIPT_CONFIG
=zfs-script-config.sh
11 if [ -f "${basedir}/../${SCRIPT_CONFIG}" ]; then
12 .
"${basedir}/../${SCRIPT_CONFIG}"
14 KERNEL_MODULES
=(zlib_deflate zlib_inflate
)
15 MODULES
=(spl splat zavl znvpair zunicode zcommon zfs
)
30 TESTS_RUN
=${TESTS_RUN:-'*'}
31 TESTS_SKIP
=${TESTS_SKIP:-}
35 pkgdatadir
=${prefix}/share
/zfs
36 bindir
=${exec_prefix}/bin
37 sbindir
=${exec_prefix}/sbin
40 sysconfdir
=${prefix}/etc
41 localstatedir
=${prefix}/var
43 ETCDIR
=${ETCDIR:-/etc}
44 DEVDIR
=${DEVDIR:-/dev/disk/by-vdev}
45 ZPOOLDIR
=${ZPOOLDIR:-${pkgdatadir}/zpool-config}
46 ZPIOSDIR
=${ZPIOSDIR:-${pkgdatadir}/zpios-test}
47 ZPIOSPROFILEDIR
=${ZPIOSPROFILEDIR:-${pkgdatadir}/zpios-profile}
49 ZDB
=${ZDB:-${sbindir}/zdb}
50 ZFS
=${ZFS:-${sbindir}/zfs}
51 ZINJECT
=${ZINJECT:-${sbindir}/zinject}
52 ZPOOL
=${ZPOOL:-${sbindir}/zpool}
53 ZTEST
=${ZTEST:-${sbindir}/ztest}
54 ZPIOS
=${ZPIOS:-${sbindir}/zpios}
56 COMMON_SH
=${COMMON_SH:-${pkgdatadir}/common.sh}
57 ZFS_SH
=${ZFS_SH:-${pkgdatadir}/zfs.sh}
58 ZPOOL_CREATE_SH
=${ZPOOL_CREATE_SH:-${pkgdatadir}/zpool-create.sh}
59 ZPIOS_SH
=${ZPIOS_SH:-${pkgdatadir}/zpios.sh}
60 ZPIOS_SURVEY_SH
=${ZPIOS_SURVEY_SH:-${pkgdatadir}/zpios-survey.sh}
62 LDMOD
=${LDMOD:-/sbin/modprobe}
63 LSMOD
=${LSMOD:-/sbin/lsmod}
64 RMMOD
=${RMMOD:-/sbin/rmmod}
65 INFOMOD
=${INFOMOD:-/sbin/modinfo}
66 LOSETUP
=${LOSETUP:-/sbin/losetup}
67 MDADM
=${MDADM:-/sbin/mdadm}
68 PARTED
=${PARTED:-/sbin/parted}
69 BLOCKDEV
=${BLOCKDEV:-/sbin/blockdev}
70 LSSCSI
=${LSSCSI:-/usr/bin/lsscsi}
71 SCSIRESCAN
=${SCSIRESCAN:-/usr/bin/scsi-rescan}
72 SYSCTL
=${SYSCTL:-/sbin/sysctl}
73 UDEVADM
=${UDEVADM:-/sbin/udevadm}
74 AWK
=${AWK:-/usr/bin/awk}
76 ZED_PIDFILE
=${ZED_PIDFILE:-${localstatedir}/run/zed.pid}
78 COLOR_BLACK
="\033[0;30m"
79 COLOR_DK_GRAY
="\033[1;30m"
80 COLOR_BLUE
="\033[0;34m"
81 COLOR_LT_BLUE
="\033[1;34m"
82 COLOR_GREEN
="\033[0;32m"
83 COLOR_LT_GREEN
="\033[1;32m"
84 COLOR_CYAN
="\033[0;36m"
85 COLOR_LT_CYAN
="\033[1;36m"
86 COLOR_RED
="\033[0;31m"
87 COLOR_LT_RED
="\033[1;31m"
88 COLOR_PURPLE
="\033[0;35m"
89 COLOR_LT_PURPLE
="\033[1;35m"
90 COLOR_BROWN
="\033[0;33m"
91 COLOR_YELLOW
="\033[1;33m"
92 COLOR_LT_GRAY
="\033[0;37m"
93 COLOR_WHITE
="\033[1;37m"
97 echo -e "${PROG}: $1" >&2
102 if [ ${VERBOSE} ]; then
108 echo -e "${COLOR_GREEN}Pass${COLOR_RESET}"
112 echo -e "${COLOR_RED}Fail${COLOR_RESET} ($1)"
117 echo -e "${COLOR_BROWN}Skip${COLOR_RESET}"
122 local MAX_DIR_SIZE
=$2
123 local MAX_FILE_SIZE
=$3
125 mkdir
-p $ROOT/{a
,b
,c
,d
,e
,f
,g
}/{h
,i
}
129 COUNT
=$
(($RANDOM % $MAX_DIR_SIZE))
131 for i
in `seq $COUNT`; do
132 FILE
=`mktemp -p ${DIR}`
133 SIZE
=$
(($RANDOM % $MAX_FILE_SIZE))
134 dd if=/dev
/urandom of
=$FILE bs
=1k count
=$SIZE &>/dev
/null
142 # Disable the udev rule 90-zfs.rules to prevent the zfs module
143 # stack from being loaded due to the detection of a zfs device.
144 # This is important because the test scripts require full control
145 # over when and how the modules are loaded/unloaded. A trap is
146 # set to ensure the udev rule is correctly replaced on exit.
147 local RULE
=${udevruledir}/90-zfs.rules
148 if test -e ${RULE}; then
149 trap "mv ${RULE}.disabled ${RULE}" INT TERM EXIT
150 mv ${RULE} ${RULE}.disabled
153 # Create a random directory tree of files and sub-directories to
154 # to act as a copy source for the various regression tests.
155 SRC_DIR
=`mktemp -d -p /var/tmp/ zfs.src.XXXXXXXX`
156 trap "rm -Rf $SRC_DIR" INT TERM EXIT
157 populate
$SRC_DIR 10 100
161 ${SYSCTL} -w kernel.spl.debug.dump
=1 &>/dev
/null
162 local NAME
=`dmesg | tail -n 1 | cut -f5 -d' '`
163 ${SPLBUILD}/cmd/spl ${NAME} >${NAME}.log
165 echo "Dumped debug log: ${NAME}.log"
172 local LOADED_MODULES
=()
173 local MISSING_MODULES
=()
175 for MOD
in ${MODULES[*]}; do
176 local NAME
=`basename $MOD .ko`
178 if ${LSMOD} |
egrep -q "^${NAME}"; then
179 LOADED_MODULES
=(${NAME} ${LOADED_MODULES[*]})
182 if [ ${INFOMOD} ${MOD} 2>/dev
/null
]; then
183 MISSING_MODULES
=("\t${MOD}\n" ${MISSING_MODULES[*]})
187 if [ ${#LOADED_MODULES[*]} -gt 0 ]; then
188 ERROR
="Unload these modules with '${PROG} -u':\n"
189 ERROR
="${ERROR}${LOADED_MODULES[*]}"
193 if [ ${#MISSING_MODULES[*]} -gt 0 ]; then
194 ERROR
="The following modules can not be found,"
195 ERROR
="${ERROR} ensure your source trees are built:\n"
196 ERROR
="${ERROR}${MISSING_MODULES[*]}"
204 local NAME
=`basename $1 .ko`
206 if [ ${VERBOSE} ]; then
207 echo "Loading ${NAME} ($@)"
210 ${LDMOD} $
* &>/dev
/null
211 if [ $?
-ne 0 ]; then
212 echo "Failed to load ${NAME} ($@)"
222 for MOD
in ${KERNEL_MODULES[*]}; do
223 load_module
${MOD} >/dev
/null
226 for MOD
in ${MODULES[*]}; do
227 local NAME
=`basename ${MOD} .ko`
231 OPT_NAME
=`echo ${OPT} | cut -f1 -d'='`
233 if [ ${NAME} = "${OPT_NAME}" ]; then
234 VALUE
=`echo ${OPT} | cut -f2- -d'='`
238 load_module
${MOD} ${VALUE} ||
return 1
241 if [ ${VERBOSE} ]; then
242 echo "Successfully loaded ZFS module stack"
249 local NAME
=`basename $1 .ko`
251 if [ ${VERBOSE} ]; then
252 echo "Unloading ${NAME} ($@)"
255 ${RMMOD} ${NAME} || ERROR="Failed to unload ${NAME}" return 1
261 local MODULES_REVERSE=( $(echo ${MODULES[@]} |
262 ${AWK} '{for (i=NF;i>=1;i--) printf $i" "} END{print ""}') )
264 for MOD in ${MODULES_REVERSE[*]}; do
265 local NAME=`basename ${MOD} .ko`
266 local USE_COUNT=`${LSMOD} |
267 egrep "^
${NAME} "| ${AWK} '{print $3}'`
269 if [ "${USE_COUNT}" = 0 ] ; then
271 if [ "${DUMP_LOG}" -a ${NAME} = "spl" ]; then
275 unload_module ${MOD} || return 1
279 if [ ${VERBOSE} ]; then
280 echo "Successfully unloaded ZFS module stack"
287 # Check that the mdadm utilities are installed.
290 test -f ${LOSETUP} || die "${LOSETUP} utility must be installed"
295 # Find and return an unused loop device. A new /dev/loopN node will be
296 # created if required. The kernel loop driver will automatically register
297 # the minor as long as it's
less than
/sys
/module
/loop
/parameters
/max_loop.
299 unused_loop_device
() {
300 local DEVICE
=`${LOSETUP} -f`
301 local MAX_LOOP_PATH
="/sys/module/loop/parameters/max_loop"
304 # An existing /dev/loopN device was available.
305 if [ -n "${DEVICE}" ]; then
310 # Create a new /dev/loopN provided we are not at MAX_LOOP.
311 if [ -f "${MAX_LOOP_PATH}" ]; then
312 MAX_LOOP
=`cat /sys/module/loop/parameters/max_loop`
313 if [ ${MAX_LOOP} -eq 0 ]; then
317 for (( i
=0; i
<=${MAX_LOOP}; i
++ )); do
320 if [ -b "${DEVICE}" ]; then
323 mknod
-m660 "${DEVICE}" b
7 $i
324 chown root.disk
"${DEVICE}"
325 chmod 666 "${DEVICE}"
333 die
"Error: Unable to create new loopback device"
337 # This can be slightly dangerous because the loop devices we are
338 # cleaning up may not be ours. However, if the devices are currently
339 # in use we will not be able to remove them, and we only remove
340 # devices which include 'zpool' or 'deleted' in the name. So any
341 # damage we might do should be limited to other zfs related testing.
343 cleanup_loop_devices
() {
344 local TMP_FILE
=`mktemp`
346 ${LOSETUP} -a |
tr -d '()' >${TMP_FILE}
347 ${AWK} -F":" -v losetup
="$LOSETUP" \
348 '/zpool/ || /deleted/ { system("losetup -d "$1) }' ${TMP_FILE}
349 ${AWK} -F" " '/zpool/ || /deleted/ { system("rm -f "$3) }' ${TMP_FILE}
355 # Destroy the passed loopback devices, this is used when you know
356 # the names of the loopback devices.
358 destroy_loop_devices
() {
361 msg
"Destroying ${LODEVICES}"
362 ${LOSETUP} -d ${LODEVICES} || \
363 die
"Error $? destroying ${FILE} -> ${DEVICE} loopback"
370 # Create a device label taking care to briefly wait if udev needs to settle.
376 wait_udev
${DEVICE} 30 ||
return 1
377 ${PARTED} ${DEVICE} --script -- mklabel ${LABEL} ||
return 2
383 # Create a primary partition on a block device.
391 ${PARTED} --align optimal
${DEVICE} --script -- \
392 mkpart
${TYPE} ${START} ${END} ||
return 1
399 # Create a filesystem on the block device
405 # Force 4K blocksize, else mkfs.ext2 tries to use 8K, which
407 /sbin
/mkfs.
${FSTYPE} -b 4096 -F -q ${DEVICE} >/dev
/null ||
return 1
413 # Check that the mdadm utilities are installed.
416 test -f ${MDADM} || die
"${MDADM} utility must be installed"
417 test -f ${PARTED} || die
"${PARTED} utility must be installed"
420 check_md_partitionable
() {
421 local LOFILE
=`mktemp -p /tmp zpool-lo.XXXXXXXX`
422 local LODEVICE
=`unused_loop_device`
423 local MDDEVICE
=`unused_md_device`
429 dd if=/dev
/zero of
=${LOFILE} bs
=1M count
=0 seek
=16 \
430 &>/dev
/null ||
return ${RESULT}
432 msg
"Creating ${LODEVICE} using ${LOFILE}"
433 ${LOSETUP} ${LODEVICE} ${LOFILE}
434 if [ $?
-ne 0 ]; then
439 msg
"Creating ${MDDEVICE} using ${LODEVICE}"
440 ${MDADM} --build ${MDDEVICE} --level=faulty \
441 --raid-devices=1 ${LODEVICE} &>/dev
/null
442 if [ $?
-ne 0 ]; then
443 destroy_loop_devices
${LODEVICE}
447 wait_udev
${MDDEVICE} 30
449 ${BLOCKDEV} --rereadpt ${MDDEVICE} 2>/dev
/null
452 destroy_md_devices
${MDDEVICE}
453 destroy_loop_devices
${LODEVICE}
460 # Find and return an unused md device.
463 for (( i
=0; i
<32; i
++ )); do
466 # Skip active devicesudo in /proc/mdstat.
467 grep -q "${MDDEVICE} " /proc
/mdstat
&& continue
469 # Device doesn't exist, use it.
470 if [ ! -e $
/dev
/{MDDEVICE
} ]; then
471 echo /dev
/${MDDEVICE}
475 # Device exists but may not be in use.
476 if [ -b /dev
/${MDDEVICE} ]; then
477 ${MDADM} --detail /dev
/${MDDEVICE} &>/dev
/null
478 if [ $?
-eq 1 ]; then
479 echo /dev
/${MDDEVICE}
485 die
"Error: Unable to find unused md device"
489 # This can be slightly dangerous because it is possible the md devices
490 # we are cleaning up may not be ours. However, if the devices are
491 # currently in use we will not be able to remove them, and even if
492 # we remove devices which were not out we do not zero the super block
493 # so you should be able to reconstruct them.
495 cleanup_md_devices
() {
496 destroy_md_devices
"`ls /dev/md* 2>/dev/null | grep -v p`"
501 # Destroy the passed md devices, this is used when you know
502 # the names of the md devices.
504 destroy_md_devices
() {
507 msg
"Destroying ${MDDEVICES}"
508 for MDDEVICE
in ${MDDEVICES}; do
509 ${MDADM} --stop ${MDDEVICE} &>/dev
/null
510 ${MDADM} --remove ${MDDEVICE} &>/dev
/null
511 ${MDADM} --detail ${MDDEVICE} &>/dev
/null
518 # Check that the scsi utilities are installed.
521 ${INFOMOD} scsi_debug
&>/dev
/null || die
"scsi_debug module required"
522 test -f ${LSSCSI} || die
"${LSSCSI} utility must be installed"
526 # Rescan the scsi bus for scsi_debug devices. It is preferable to use the
527 # scsi-rescan tool if it is installed, but if it's not we can fall back to
528 # removing and readding the device manually. This rescan will only effect
529 # the first scsi_debug device if scsi-rescan is missing.
532 local AWK_SCRIPT
="/scsi_debug/ { print \$1; exit }"
534 if [ -f ${SCSIRESCAN} ]; then
535 ${SCSIRESCAN} --forcerescan --remove &>/dev
/null
537 local SCSIID
=`${LSSCSI} | ${AWK} "${AWK_SCRIPT}" | tr -d '[]'`
538 local SCSIHOST
=`echo ${SCSIID} | cut -f1 -d':'`
539 echo 1 >"/sys/class/scsi_device/${SCSIID}/device/delete"
541 echo "- - -" >/sys
/class
/scsi_host
/host${SCSIHOST}/scan
547 # Trigger udev and wait for it to settle.
550 if [ -f ${UDEVADM} ]; then
551 ${UDEVADM} trigger
--action=change
--subsystem-match=block
560 # The following udev helper functions assume that the provided
561 # udev rules file will create a /dev/disk/by-vdev/<CHANNEL><RANK>
562 # disk mapping. In this mapping each CHANNEL is represented by
563 # the letters a-z, and the RANK is represented by the numbers
564 # 1-n. A CHANNEL should identify a group of RANKS which are all
565 # attached to a single controller, each RANK represents a disk.
566 # This provides a simply mechanism to locate a specific drive
567 # given a known hardware configuration.
572 # When running in tree manually contruct symlinks in tree to
573 # the proper devices. Symlinks are installed for all entires
574 # in the config file regardless of if that device actually
575 # exists. When installed as a package udev can be relied on for
576 # this and it will only create links for devices which exist.
577 if [ ${INTREE} ]; then
581 ${AWK} '!/^#/ && /./ { system( \
582 "ln -f -s /dev/disk/by-path/"$2" "$1";" \
583 "ln -f -s /dev/disk/by-path/"$2"-part1 "$1"p1;" \
584 "ln -f -s /dev/disk/by-path/"$2"-part9 "$1"p9;" \
588 DST_FILE
=`basename ${SRC_PATH} | cut -f1-2 -d'.'`
589 DST_PATH
=/etc
/zfs
/${DST_FILE}
591 if [ -e ${DST_PATH} ]; then
592 die
"Error: Config ${DST_PATH} already exists"
595 cp ${SRC_PATH} ${DST_PATH}
605 if [ ${INTREE} ]; then
608 ${AWK} '!/^#/ && /./ { system( \
609 "rm -f "$1" "$1"p1 "$1"p9") }' $SRC_PATH
617 local CHANNEL
=`echo "obase=16; $1+96" | bc`
620 printf "\x${CHANNEL}${RANK}"
629 for RANK
in `seq 1 ${RANKS}`; do
630 for CHANNEL
in `seq 1 ${CHANNELS}`; do
631 DISK
=`udev_cr2d ${CHANNEL} ${RANK}`
632 RAID0S
[${IDX}]="${DEVDIR}/${DISK}"
640 udev_raid10_setup() {
646 for RANK in `seq 1 ${RANKS}`; do
647 for CHANNEL1 in `seq 1 2 ${CHANNELS}`; do
648 let CHANNEL2=CHANNEL1+1
649 DISK1=`udev_cr2d ${CHANNEL1} ${RANK}`
650 DISK2=`udev_cr2d ${CHANNEL2} ${RANK}`
651 GROUP="${DEVDIR}/${DISK1} ${DEVDIR}/${DISK2}"
652 RAID10S[${IDX}]="mirror
${GROUP}"
665 for RANK in `seq 1 ${RANKS}`; do
668 for CHANNEL in `seq 1 ${CHANNELS}`; do
669 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
670 RAIDZ[${CHANNEL}]="${DEVDIR}/${DISK}"
673 RAIDZS
[${RANK}]="${RAIDZ[*]}"
679 udev_raidz2_setup
() {
684 for RANK
in `seq 1 ${RANKS}`; do
687 for CHANNEL
in `seq 1 ${CHANNELS}`; do
688 DISK
=`udev_cr2d ${CHANNEL} ${RANK}`
689 RAIDZ2
[${CHANNEL}]="${DEVDIR}/${DISK}"
692 RAIDZ2S[${RANK}]="${RAIDZ2[*]}"
702 printf "%-4d %-34s " ${TEST_NUM} "${TEST_NAME}"
710 printf "%-4d %-34s " ${TEST_NUM} "${TEST_NAME}"
718 for i in ${TESTS_SKIP[@]}; do
719 if [[ $i == ${TEST_NUM} ]] ; then
720 skip_one_test ${TEST_NUM} "${TEST_NAME}"
725 if [ "${TESTS_RUN[0]}" = "*" ]; then
726 run_one_test ${TEST_NUM} "${TEST_NAME}"
728 for i in ${TESTS_RUN[@]}; do
729 if [[ $i == ${TEST_NUM} ]] ; then
730 run_one_test ${TEST_NUM} "${TEST_NAME}"
735 skip_one_test ${TEST_NUM} "${TEST_NAME}"
745 while [ ! -e ${DEVICE} ]; do
746 if [ ${COUNT} -gt ${DELAY} ]; then
758 local STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size
759 local STACK_TRACER_ENABLED=/proc/sys/kernel/stack_tracer_enabled
761 if [ -e $STACK_MAX_SIZE ]; then
762 echo 1 >$STACK_TRACER_ENABLED
763 echo 0 >$STACK_MAX_SIZE
768 local STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size
769 local STACK_TRACE=/sys/kernel/debug/tracing/stack_trace
770 local STACK_LIMIT=7000
772 if [ -e $STACK_MAX_SIZE ]; then
773 STACK_SIZE=`cat $STACK_MAX_SIZE`
775 if [ $STACK_SIZE -ge $STACK_LIMIT ]; then
777 echo "Warning
: max stack size
$STACK_SIZE bytes
"
784 if [ -f $ZED_PIDFILE ]; then
785 kill $(cat $ZED_PIDFILE)