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:-}
34 exec_prefix
=@exec_prefix@
35 pkgdatadir
=@datarootdir@
/@PACKAGE@
39 udevruledir
=@udevruledir@
40 sysconfdir
=@sysconfdir@
42 ETCDIR
=${ETCDIR:-/etc}
43 DEVDIR
=${DEVDIR:-/dev/disk/by-vdev}
44 ZPOOLDIR
=${ZPOOLDIR:-${pkgdatadir}/zpool-config}
45 ZPIOSDIR
=${ZPIOSDIR:-${pkgdatadir}/zpios-test}
46 ZPIOSPROFILEDIR
=${ZPIOSPROFILEDIR:-${pkgdatadir}/zpios-profile}
48 ZDB
=${ZDB:-${sbindir}/zdb}
49 ZFS
=${ZFS:-${sbindir}/zfs}
50 ZINJECT
=${ZINJECT:-${sbindir}/zinject}
51 ZPOOL
=${ZPOOL:-${sbindir}/zpool}
52 ZTEST
=${ZTEST:-${sbindir}/ztest}
53 ZPIOS
=${ZPIOS:-${sbindir}/zpios}
55 COMMON_SH
=${COMMON_SH:-${pkgdatadir}/common.sh}
56 ZFS_SH
=${ZFS_SH:-${pkgdatadir}/zfs.sh}
57 ZPOOL_CREATE_SH
=${ZPOOL_CREATE_SH:-${pkgdatadir}/zpool-create.sh}
58 ZPIOS_SH
=${ZPIOS_SH:-${pkgdatadir}/zpios.sh}
59 ZPIOS_SURVEY_SH
=${ZPIOS_SURVEY_SH:-${pkgdatadir}/zpios-survey.sh}
61 LDMOD
=${LDMOD:-/sbin/modprobe}
62 LSMOD
=${LSMOD:-/sbin/lsmod}
63 RMMOD
=${RMMOD:-/sbin/rmmod}
64 INFOMOD
=${INFOMOD:-/sbin/modinfo}
65 LOSETUP
=${LOSETUP:-/sbin/losetup}
66 MDADM
=${MDADM:-/sbin/mdadm}
67 PARTED
=${PARTED:-/sbin/parted}
68 BLOCKDEV
=${BLOCKDEV:-/sbin/blockdev}
69 LSSCSI
=${LSSCSI:-/usr/bin/lsscsi}
70 SCSIRESCAN
=${SCSIRESCAN:-/usr/bin/scsi-rescan}
71 SYSCTL
=${SYSCTL:-/sbin/sysctl}
72 UDEVADM
=${UDEVADM:-/sbin/udevadm}
73 AWK
=${AWK:-/usr/bin/awk}
75 COLOR_BLACK
="\033[0;30m"
76 COLOR_DK_GRAY
="\033[1;30m"
77 COLOR_BLUE
="\033[0;34m"
78 COLOR_LT_BLUE
="\033[1;34m"
79 COLOR_GREEN
="\033[0;32m"
80 COLOR_LT_GREEN
="\033[1;32m"
81 COLOR_CYAN
="\033[0;36m"
82 COLOR_LT_CYAN
="\033[1;36m"
83 COLOR_RED
="\033[0;31m"
84 COLOR_LT_RED
="\033[1;31m"
85 COLOR_PURPLE
="\033[0;35m"
86 COLOR_LT_PURPLE
="\033[1;35m"
87 COLOR_BROWN
="\033[0;33m"
88 COLOR_YELLOW
="\033[1;33m"
89 COLOR_LT_GRAY
="\033[0;37m"
90 COLOR_WHITE
="\033[1;37m"
94 echo -e "${PROG}: $1" >&2
99 if [ ${VERBOSE} ]; then
105 echo -e "${COLOR_GREEN}Pass${COLOR_RESET}"
109 echo -e "${COLOR_RED}Fail${COLOR_RESET} ($1)"
114 echo -e "${COLOR_BROWN}Skip${COLOR_RESET}"
119 local MAX_DIR_SIZE
=$2
120 local MAX_FILE_SIZE
=$3
122 mkdir
-p $ROOT/{a
,b
,c
,d
,e
,f
,g
}/{h
,i
}
126 COUNT
=$
(($RANDOM % $MAX_DIR_SIZE))
128 for i
in `seq $COUNT`; do
129 FILE
=`mktemp -p ${DIR}`
130 SIZE
=$
(($RANDOM % $MAX_FILE_SIZE))
131 dd if=/dev
/urandom of
=$FILE bs
=1k count
=$SIZE &>/dev
/null
139 # Disable the udev rule 90-zfs.rules to prevent the zfs module
140 # stack from being loaded due to the detection of a zfs device.
141 # This is important because the test scripts require full control
142 # over when and how the modules are loaded/unloaded. A trap is
143 # set to ensure the udev rule is correctly replaced on exit.
144 local RULE
=${udevruledir}/90-zfs.rules
145 if test -e ${RULE}; then
146 trap "mv ${RULE}.disabled ${RULE}" INT TERM EXIT
147 mv ${RULE} ${RULE}.disabled
150 # Create a random directory tree of files and sub-directories to
151 # to act as a copy source for the various regression tests.
152 SRC_DIR
=`mktemp -d -p /var/tmp/ zfs.src.XXXXXXXX`
153 trap "rm -Rf $SRC_DIR" INT TERM EXIT
154 populate
$SRC_DIR 10 100
158 ${SYSCTL} -w kernel.spl.debug.dump
=1 &>/dev
/null
159 local NAME
=`dmesg | tail -n 1 | cut -f5 -d' '`
160 ${SPLBUILD}/cmd/spl ${NAME} >${NAME}.log
162 echo "Dumped debug log: ${NAME}.log"
169 local LOADED_MODULES
=()
170 local MISSING_MODULES
=()
172 for MOD
in ${MODULES[*]}; do
173 local NAME
=`basename $MOD .ko`
175 if ${LSMOD} |
egrep -q "^${NAME}"; then
176 LOADED_MODULES
=(${NAME} ${LOADED_MODULES[*]})
179 if [ ${INFOMOD} ${MOD} 2>/dev
/null
]; then
180 MISSING_MODULES
=("\t${MOD}\n" ${MISSING_MODULES[*]})
184 if [ ${#LOADED_MODULES[*]} -gt 0 ]; then
185 ERROR
="Unload these modules with '${PROG} -u':\n"
186 ERROR
="${ERROR}${LOADED_MODULES[*]}"
190 if [ ${#MISSING_MODULES[*]} -gt 0 ]; then
191 ERROR
="The following modules can not be found,"
192 ERROR
="${ERROR} ensure your source trees are built:\n"
193 ERROR
="${ERROR}${MISSING_MODULES[*]}"
201 local NAME
=`basename $1 .ko`
203 if [ ${VERBOSE} ]; then
204 echo "Loading ${NAME} ($@)"
207 ${LDMOD} $
* &>/dev
/null || ERROR
="Failed to load $1" return 1
215 for MOD
in ${KERNEL_MODULES[*]}; do
219 for MOD
in ${MODULES[*]}; do
220 local NAME
=`basename ${MOD} .ko`
224 OPT_NAME
=`echo ${OPT} | cut -f1 -d'='`
226 if [ ${NAME} = "${OPT_NAME}" ]; then
227 VALUE
=`echo ${OPT} | cut -f2- -d'='`
231 load_module
${MOD} ${VALUE} ||
return 1
234 if [ ${VERBOSE} ]; then
235 echo "Successfully loaded ZFS module stack"
242 local NAME
=`basename $1 .ko`
244 if [ ${VERBOSE} ]; then
245 echo "Unloading ${NAME} ($@)"
248 ${RMMOD} ${NAME} || ERROR="Failed to unload ${NAME}" return 1
254 local MODULES_REVERSE=( $(echo ${MODULES[@]} |
255 ${AWK} '{for (i=NF;i>=1;i--) printf $i" "} END{print ""}') )
257 for MOD in ${MODULES_REVERSE[*]}; do
258 local NAME=`basename ${MOD} .ko`
259 local USE_COUNT=`${LSMOD} |
260 egrep "^
${NAME} "| ${AWK} '{print $3}'`
262 if [ "${USE_COUNT}" = 0 ] ; then
264 if [ "${DUMP_LOG}" -a ${NAME} = "spl" ]; then
268 unload_module ${MOD} || return 1
272 if [ ${VERBOSE} ]; then
273 echo "Successfully unloaded ZFS module stack"
280 # Check that the mdadm utilities are installed.
283 test -f ${LOSETUP} || die "${LOSETUP} utility must be installed"
288 # Find and return an unused loopback device.
290 unused_loop_device() {
291 for DEVICE in `ls -1 /dev/loop[0-9]* 2>/dev/null`; do
292 ${LOSETUP} ${DEVICE} &>/dev/null
293 if [ $? -ne 0 ]; then
299 die "Error: Unable to find unused loopback device"
303 # This can be slightly dangerous because the loop devices we are
304 # cleaning up may not be ours. However, if the devices are currently
305 # in use we will not be able to remove them, and we only remove
306 # devices which include 'zpool
' in the name. So any damage we might
307 # do should be limited to other zfs related testing.
309 cleanup_loop_devices() {
310 local TMP_FILE=`mktemp`
312 ${LOSETUP} -a | tr -d '()' >${TMP_FILE}
313 ${AWK} -F":" -v losetup="$LOSETUP" \
314 '/zpool
/ { system
("losetup -d "$1) }' ${TMP_FILE}
315 ${AWK} -F" " '/zpool
/ { system
("rm -f "$3) }' ${TMP_FILE}
321 # Destroy the passed loopback devices, this is used when you know
322 # the names of the loopback devices.
324 destroy_loop_devices() {
327 msg "Destroying ${LODEVICES}"
328 ${LOSETUP} -d ${LODEVICES} || \
329 die "Error $? destroying ${FILE} -> ${DEVICE} loopback"
336 # Create a device label.
342 ${PARTED} ${DEVICE} --script -- mklabel ${LABEL} || return 1
348 # Create a primary partition on a block device.
356 ${PARTED} --align optimal ${DEVICE} --script -- \
357 mkpart ${TYPE} ${START} ${END} || return 1
364 # Create a filesystem on the block device
370 # Force 4K blocksize, else mkfs.ext2 tries to use 8K, which
372 /sbin
/mkfs.
${FSTYPE} -b 4096 -F -q ${DEVICE} >/dev
/null ||
return 1
378 # Check that the mdadm utilities are installed.
381 test -f ${MDADM} || die
"${MDADM} utility must be installed"
382 test -f ${PARTED} || die
"${PARTED} utility must be installed"
385 check_md_partitionable
() {
386 local LOFILE
=`mktemp -p /tmp zpool-lo.XXXXXXXX`
387 local LODEVICE
=`unused_loop_device`
388 local MDDEVICE
=`unused_md_device`
394 dd if=/dev
/zero of
=${LOFILE} bs
=1M count
=0 seek
=16 \
395 &>/dev
/null ||
return ${RESULT}
397 msg
"Creating ${LODEVICE} using ${LOFILE}"
398 ${LOSETUP} ${LODEVICE} ${LOFILE}
399 if [ $?
-ne 0 ]; then
404 msg
"Creating ${MDDEVICE} using ${LODEVICE}"
405 ${MDADM} --build ${MDDEVICE} --level=faulty \
406 --raid-devices=1 ${LODEVICE} &>/dev
/null
407 if [ $?
-ne 0 ]; then
408 destroy_loop_devices
${LODEVICE}
412 wait_udev
${MDDEVICE} 30
414 ${BLOCKDEV} --rereadpt ${MDDEVICE} 2>/dev
/null
417 destroy_md_devices
${MDDEVICE}
418 destroy_loop_devices
${LODEVICE}
425 # Find and return an unused md device.
428 for (( i
=0; i
<32; i
++ )); do
431 # Skip active devicesudo in /proc/mdstat.
432 grep -q "${MDDEVICE} " /proc
/mdstat
&& continue
434 # Device doesn't exist, use it.
435 if [ ! -e $
/dev
/{MDDEVICE
} ]; then
436 echo /dev
/${MDDEVICE}
440 # Device exists but may not be in use.
441 if [ -b /dev
/${MDDEVICE} ]; then
442 ${MDADM} --detail /dev
/${MDDEVICE} &>/dev
/null
443 if [ $?
-eq 1 ]; then
444 echo /dev
/${MDDEVICE}
450 die
"Error: Unable to find unused md device"
454 # This can be slightly dangerous because it is possible the md devices
455 # we are cleaning up may not be ours. However, if the devices are
456 # currently in use we will not be able to remove them, and even if
457 # we remove devices which were not out we do not zero the super block
458 # so you should be able to reconstruct them.
460 cleanup_md_devices
() {
461 destroy_md_devices
"`ls /dev/md* 2>/dev/null | grep -v p`"
466 # Destroy the passed md devices, this is used when you know
467 # the names of the md devices.
469 destroy_md_devices
() {
472 msg
"Destroying ${MDDEVICES}"
473 for MDDEVICE
in ${MDDEVICES}; do
474 ${MDADM} --stop ${MDDEVICE} &>/dev
/null
475 ${MDADM} --remove ${MDDEVICE} &>/dev
/null
476 ${MDADM} --detail ${MDDEVICE} &>/dev
/null
483 # Check that the scsi utilities are installed.
486 ${INFOMOD} scsi_debug
&>/dev
/null || die
"scsi_debug module required"
487 test -f ${LSSCSI} || die
"${LSSCSI} utility must be installed"
491 # Rescan the scsi bus for scsi_debug devices. It is preferable to use the
492 # scsi-rescan tool if it is installed, but if it's not we can fall back to
493 # removing and readding the device manually. This rescan will only effect
494 # the first scsi_debug device if scsi-rescan is missing.
497 local AWK_SCRIPT
="/scsi_debug/ { print \$1; exit }"
499 if [ -f ${SCSIRESCAN} ]; then
500 ${SCSIRESCAN} --forcerescan --remove &>/dev
/null
502 local SCSIID
=`${LSSCSI} | ${AWK} "${AWK_SCRIPT}" | tr -d '[]'`
503 local SCSIHOST
=`echo ${SCSIID} | cut -f1 -d':'`
504 echo 1 >"/sys/class/scsi_device/${SCSIID}/device/delete"
506 echo "- - -" >/sys
/class
/scsi_host
/host${SCSIHOST}/scan
512 # Trigger udev and wait for it to settle.
515 if [ -f ${UDEVADM} ]; then
516 ${UDEVADM} trigger
--action=change
--subsystem-match=block
525 # The following udev helper functions assume that the provided
526 # udev rules file will create a /dev/disk/by-vdev/<CHANNEL><RANK>
527 # disk mapping. In this mapping each CHANNEL is represented by
528 # the letters a-z, and the RANK is represented by the numbers
529 # 1-n. A CHANNEL should identify a group of RANKS which are all
530 # attached to a single controller, each RANK represents a disk.
531 # This provides a simply mechanism to locate a specific drive
532 # given a known hardware configuration.
537 # When running in tree manually contruct symlinks in tree to
538 # the proper devices. Symlinks are installed for all entires
539 # in the config file regardless of if that device actually
540 # exists. When installed as a package udev can be relied on for
541 # this and it will only create links for devices which exist.
542 if [ ${INTREE} ]; then
546 ${AWK} '!/^#/ && /./ { system( \
547 "ln -f -s /dev/disk/by-path/"$2" "$1";" \
548 "ln -f -s /dev/disk/by-path/"$2"-part1 "$1"p1;" \
549 "ln -f -s /dev/disk/by-path/"$2"-part9 "$1"p9;" \
553 DST_FILE
=`basename ${SRC_PATH} | cut -f1-2 -d'.'`
554 DST_PATH
=/etc
/zfs
/${DST_FILE}
556 if [ -e ${DST_PATH} ]; then
557 die
"Error: Config ${DST_PATH} already exists"
560 cp ${SRC_PATH} ${DST_PATH}
570 if [ ${INTREE} ]; then
573 ${AWK} '!/^#/ && /./ { system( \
574 "rm -f "$1" "$1"p1 "$1"p9") }' $SRC_PATH
582 local CHANNEL
=`echo "obase=16; $1+96" | bc`
585 printf "\x${CHANNEL}${RANK}"
594 for RANK
in `seq 1 ${RANKS}`; do
595 for CHANNEL
in `seq 1 ${CHANNELS}`; do
596 DISK
=`udev_cr2d ${CHANNEL} ${RANK}`
597 RAID0S
[${IDX}]="${DEVDIR}/${DISK}"
605 udev_raid10_setup() {
611 for RANK in `seq 1 ${RANKS}`; do
612 for CHANNEL1 in `seq 1 2 ${CHANNELS}`; do
613 let CHANNEL2=CHANNEL1+1
614 DISK1=`udev_cr2d ${CHANNEL1} ${RANK}`
615 DISK2=`udev_cr2d ${CHANNEL2} ${RANK}`
616 GROUP="${DEVDIR}/${DISK1} ${DEVDIR}/${DISK2}"
617 RAID10S[${IDX}]="mirror
${GROUP}"
630 for RANK in `seq 1 ${RANKS}`; do
633 for CHANNEL in `seq 1 ${CHANNELS}`; do
634 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
635 RAIDZ[${CHANNEL}]="${DEVDIR}/${DISK}"
638 RAIDZS
[${RANK}]="${RAIDZ[*]}"
644 udev_raidz2_setup
() {
649 for RANK
in `seq 1 ${RANKS}`; do
652 for CHANNEL
in `seq 1 ${CHANNELS}`; do
653 DISK
=`udev_cr2d ${CHANNEL} ${RANK}`
654 RAIDZ2
[${CHANNEL}]="${DEVDIR}/${DISK}"
657 RAIDZ2S[${RANK}]="${RAIDZ2[*]}"
667 printf "%-4d %-34s " ${TEST_NUM} "${TEST_NAME}"
675 printf "%-4d %-34s " ${TEST_NUM} "${TEST_NAME}"
683 for i in ${TESTS_SKIP[@]}; do
684 if [[ $i == ${TEST_NUM} ]] ; then
685 skip_one_test ${TEST_NUM} "${TEST_NAME}"
690 if [ "${TESTS_RUN[0]}" = "*" ]; then
691 run_one_test ${TEST_NUM} "${TEST_NAME}"
693 for i in ${TESTS_RUN[@]}; do
694 if [[ $i == ${TEST_NUM} ]] ; then
695 run_one_test ${TEST_NUM} "${TEST_NAME}"
700 skip_one_test ${TEST_NUM} "${TEST_NAME}"
710 while [ ! -e ${DEVICE} ]; do
711 if [ ${COUNT} -gt ${DELAY} ]; then
723 local STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size
724 local STACK_TRACER_ENABLED=/proc/sys/kernel/stack_tracer_enabled
726 if [ -e $STACK_MAX_SIZE ]; then
727 echo 1 >$STACK_TRACER_ENABLED
728 echo 0 >$STACK_MAX_SIZE
733 local STACK_MAX_SIZE=/sys/kernel/debug/tracing/stack_max_size
734 local STACK_TRACE=/sys/kernel/debug/tracing/stack_trace
735 local STACK_LIMIT=7000
737 if [ -e $STACK_MAX_SIZE ]; then
738 STACK_SIZE=`cat $STACK_MAX_SIZE`
740 if [ $STACK_SIZE -ge $STACK_LIMIT ]; then
742 echo "Warning
: max stack size
$STACK_SIZE bytes
"