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 libexecdir=@libexecdir@
36 pkglibexecdir=${libexecdir}/@PACKAGE@
40 ETCDIR=${ETCDIR:-/etc}
41 DEVDIR=${DEVDIR:-/dev/disk/zpool}
42 ZPOOLDIR=${ZPOOLDIR:-${pkglibexecdir}/zpool-config}
43 ZPIOSDIR=${ZPIOSDIR:-${pkglibexecdir}/zpios-test}
44 ZPIOSPROFILEDIR=${ZPIOSPROFILEDIR:-${pkglibexecdir}/zpios-profile}
46 ZDB=${ZDB:-${sbindir}/zdb}
47 ZFS=${ZFS:-${sbindir}/zfs}
48 ZINJECT=${ZINJECT:-${sbindir}/zinject}
49 ZPOOL=${ZPOOL:-${sbindir}/zpool}
50 ZPOOL_ID=${ZPOOL_ID:-${bindir}/zpool_id}
51 ZTEST=${ZTEST:-${sbindir}/ztest}
52 ZPIOS=${ZPIOS:-${sbindir}/zpios}
54 COMMON_SH=${COMMON_SH:-${pkglibexecdir}/common.sh}
55 ZFS_SH=${ZFS_SH:-${pkglibexecdir}/zfs.sh}
56 ZPOOL_CREATE_SH=${ZPOOL_CREATE_SH:-${pkglibexecdir}/zpool-create.sh}
57 ZPIOS_SH=${ZPIOS_SH:-${pkglibexecdir}/zpios.sh}
58 ZPIOS_SURVEY_SH=${ZPIOS_SURVEY_SH:-${pkglibexecdir}/zpios-survey.sh}
60 LDMOD=${LDMOD:-/sbin/modprobe}
61 LSMOD=${LSMOD:-/sbin/lsmod}
62 RMMOD=${RMMOD:-/sbin/rmmod}
63 INFOMOD=${INFOMOD:-/sbin/modinfo}
64 LOSETUP=${LOSETUP:-/sbin/losetup}
65 MDADM=${MDADM:-/sbin/mdadm}
66 PARTED=${PARTED:-/sbin/parted}
67 BLOCKDEV=${BLOCKDEV:-/sbin/blockdev}
68 LSSCSI=${LSSCSI:-/usr/bin/lsscsi}
69 SCSIRESCAN=${SCSIRESCAN:-/usr/bin/scsi-rescan}
70 SYSCTL=${SYSCTL:-/sbin/sysctl}
71 UDEVADM=${UDEVADM:-/sbin/udevadm}
72 AWK=${AWK:-/usr/bin/awk}
74 COLOR_BLACK="\033[0;30m"
75 COLOR_DK_GRAY="\033[1;30m"
76 COLOR_BLUE="\033[0;34m"
77 COLOR_LT_BLUE="\033[1;34m"
78 COLOR_GREEN="\033[0;32m"
79 COLOR_LT_GREEN="\033[1;32m"
80 COLOR_CYAN="\033[0;36m"
81 COLOR_LT_CYAN="\033[1;36m"
82 COLOR_RED="\033[0;31m"
83 COLOR_LT_RED="\033[1;31m"
84 COLOR_PURPLE="\033[0;35m"
85 COLOR_LT_PURPLE="\033[1;35m"
86 COLOR_BROWN="\033[0;33m"
87 COLOR_YELLOW="\033[1;33m"
88 COLOR_LT_GRAY="\033[0;37m"
89 COLOR_WHITE="\033[1;37m"
93 echo -e "${PROG}: $1" >&2
98 if [ ${VERBOSE} ]; then
104 echo -e "${COLOR_GREEN}Pass${COLOR_RESET}"
108 echo -e "${COLOR_RED}Fail${COLOR_RESET} ($1)"
113 echo -e "${COLOR_BROWN}Skip${COLOR_RESET}"
117 ${SYSCTL} -w kernel.spl.debug.dump=1 &>/dev/null
118 local NAME=`dmesg | tail -n 1 | cut -f5 -d' '`
119 ${SPLBUILD}/cmd/spl ${NAME} >${NAME}.log
121 echo "Dumped debug log: ${NAME}.log"
128 local LOADED_MODULES=()
129 local MISSING_MODULES=()
131 for MOD in ${MODULES[*]}; do
132 local NAME=`basename $MOD .ko`
134 if ${LSMOD} | egrep -q "^${NAME}"; then
135 LOADED_MODULES=(${NAME} ${LOADED_MODULES[*]})
138 if [ ${INFOMOD} ${MOD} 2>/dev/null ]; then
139 MISSING_MODULES=("\t${MOD}\n" ${MISSING_MODULES[*]})
143 if [ ${#LOADED_MODULES[*]} -gt 0 ]; then
144 ERROR="Unload these modules with '${PROG} -u':\n"
145 ERROR="${ERROR}${LOADED_MODULES[*]}"
149 if [ ${#MISSING_MODULES[*]} -gt 0 ]; then
150 ERROR="The following modules can not be found,"
151 ERROR="${ERROR} ensure your source trees are built:\n"
152 ERROR="${ERROR}${MISSING_MODULES[*]}"
160 local NAME=`basename $1 .ko`
162 if [ ${VERBOSE} ]; then
163 echo "Loading ${NAME} ($@)"
166 ${LDMOD} $* &>/dev/null || ERROR="Failed to load $1" return 1
174 for MOD in ${KERNEL_MODULES[*]}; do
178 for MOD in ${MODULES[*]}; do
179 local NAME=`basename ${MOD} .ko`
183 OPT_NAME=`echo ${OPT} | cut -f1 -d'='`
185 if [ ${NAME} = "${OPT_NAME}" ]; then
186 VALUE=`echo ${OPT} | cut -f2- -d'='`
190 load_module ${MOD} ${VALUE} || return 1
193 if [ ${VERBOSE} ]; then
194 echo "Successfully loaded ZFS module stack"
201 local NAME=`basename $1 .ko`
203 if [ ${VERBOSE} ]; then
204 echo "Unloading ${NAME} ($@)"
207 ${RMMOD} ${NAME} || ERROR="Failed to unload ${NAME}" return 1
213 local MODULES_REVERSE=( $(echo ${MODULES[@]} |
214 ${AWK} '{for (i=NF;i>=1;i--) printf $i" "} END{print ""}') )
216 for MOD in ${MODULES_REVERSE[*]}; do
217 local NAME=`basename ${MOD} .ko`
218 local USE_COUNT=`${LSMOD} |
219 egrep "^${NAME} "| ${AWK} '{print $3}'`
221 if [ "${USE_COUNT}" = 0 ] ; then
223 if [ "${DUMP_LOG}" -a ${NAME} = "spl" ]; then
227 unload_module ${MOD} || return 1
231 if [ ${VERBOSE} ]; then
232 echo "Successfully unloaded ZFS module stack"
239 # Check that the mdadm utilities are installed.
242 test -f ${LOSETUP} || die "${LOSETUP} utility must be installed"
247 # Find and return an unused loopback device.
249 unused_loop_device() {
250 for DEVICE in `ls -1 /dev/loop* 2>/dev/null`; do
251 ${LOSETUP} ${DEVICE} &>/dev/null
252 if [ $? -ne 0 ]; then
258 die "Error: Unable to find unused loopback device"
262 # This can be slightly dangerous because the loop devices we are
263 # cleaning up may not be ours. However, if the devices are currently
264 # in use we will not be able to remove them, and we only remove
265 # devices which include 'zpool' in the name. So any damage we might
266 # do should be limited to other zfs related testing.
268 cleanup_loop_devices() {
269 local TMP_FILE=`mktemp`
271 ${LOSETUP} -a | tr -d '()' >${TMP_FILE}
272 ${AWK} -F":" -v losetup="$LOSETUP" \
273 '/zpool/ { system("losetup -d "$1) }' ${TMP_FILE}
274 ${AWK} -F" " '/zpool/ { system("rm -f "$3) }' ${TMP_FILE}
280 # Destroy the passed loopback devices, this is used when you know
281 # the names of the loopback devices.
283 destroy_loop_devices() {
286 msg "Destroying ${LODEVICES}"
287 ${LOSETUP} -d ${LODEVICES} || \
288 die "Error $? destroying ${FILE} -> ${DEVICE} loopback"
295 # Check that the mdadm utilities are installed.
298 test -f ${MDADM} || die "${MDADM} utility must be installed"
299 test -f ${PARTED} || die "${PARTED} utility must be installed"
302 check_md_partitionable() {
303 local LOFILE=`mktemp -p /tmp zpool-lo.XXXXXXXX`
304 local LODEVICE=`unused_loop_device`
305 local MDDEVICE=`unused_md_device`
311 dd if=/dev/zero of=${LOFILE} bs=1M count=0 seek=16 \
312 &>/dev/null || return ${RESULT}
314 msg "Creating ${LODEVICE} using ${LOFILE}"
315 ${LOSETUP} ${LODEVICE} ${LOFILE}
316 if [ $? -ne 0 ]; then
321 msg "Creating ${MDDEVICE} using ${LODEVICE}"
322 ${MDADM} --build ${MDDEVICE} --level=faulty \
323 --raid-devices=1 ${LODEVICE} &>/dev/null
324 if [ $? -ne 0 ]; then
325 destroy_loop_devices ${LODEVICE}
329 wait_udev ${MDDEVICE} 30
331 ${BLOCKDEV} --rereadpt ${MDDEVICE} 2>/dev/null
334 destroy_md_devices ${MDDEVICE}
335 destroy_loop_devices ${LODEVICE}
342 # Find and return an unused md device.
345 for (( i=0; i<32; i++ )); do
348 # Skip active devicesudo in /proc/mdstat.
349 grep -q "${MDDEVICE} " /proc/mdstat && continue
351 # Device doesn't exist, use it.
352 if [ ! -e $/dev/{MDDEVICE} ]; then
353 echo /dev/${MDDEVICE}
357 # Device exists but may not be in use.
358 if [ -b /dev/${MDDEVICE} ]; then
359 ${MDADM} --detail /dev/${MDDEVICE} &>/dev/null
360 if [ $? -eq 1 ]; then
361 echo /dev/${MDDEVICE}
367 die "Error: Unable to find unused md device"
371 # This can be slightly dangerous because it is possible the md devices
372 # we are cleaning up may not be ours. However, if the devices are
373 # currently in use we will not be able to remove them, and even if
374 # we remove devices which were not out we do not zero the super block
375 # so you should be able to reconstruct them.
377 cleanup_md_devices() {
378 destroy_md_devices "`ls /dev/md* 2>/dev/null | grep -v p`"
383 # Destroy the passed md devices, this is used when you know
384 # the names of the md devices.
386 destroy_md_devices() {
389 msg "Destroying ${MDDEVICES}"
390 for MDDEVICE in ${MDDEVICES}; do
391 ${MDADM} --stop ${MDDEVICE} &>/dev/null
392 ${MDADM} --remove ${MDDEVICE} &>/dev/null
393 ${MDADM} --detail ${MDDEVICE} &>/dev/null
400 # Check that the scsi utilities are installed.
403 ${INFOMOD} scsi_debug &>/dev/null || die "scsi_debug module required"
404 test -f ${LSSCSI} || die "${LSSCSI} utility must be installed"
408 # Rescan the scsi bus for scsi_debug devices. It is preferable to use the
409 # scsi-rescan tool if it is installed, but if it's not we can fall back to
410 # removing and readding the device manually. This rescan will only effect
411 # the first scsi_debug device if scsi-rescan is missing.
414 local AWK_SCRIPT="/scsi_debug/ { print \$1; exit }"
416 if [ -f ${SCSIRESCAN} ]; then
417 ${SCSIRESCAN} --forcerescan --remove &>/dev/null
419 local SCSIID=`${LSSCSI} | ${AWK} "${AWK_SCRIPT}" | tr -d '[]'`
420 local SCSIHOST=`echo ${SCSIID} | cut -f1 -d':'`
421 echo 1 >"/sys/class/scsi_device/${SCSIID}/device/delete"
423 echo "- - -" >/sys/class/scsi_host/host${SCSIHOST}/scan
429 # Trigger udev and wait for it to settle.
432 if [ -f ${UDEVADM} ]; then
442 # The following udev helper functions assume that the provided
443 # udev rules file will create a /dev/disk/zpool/<CHANNEL><RANK>
444 # disk mapping. In this mapping each CHANNEL is represented by
445 # the letters a-z, and the RANK is represented by the numbers
446 # 1-n. A CHANNEL should identify a group of RANKS which are all
447 # attached to a single controller, each RANK represents a disk.
448 # This provides a simply mechanism to locate a specific drive
449 # given a known hardware configuration.
454 # When running in tree manually contruct symlinks in tree to
455 # the proper devices. Symlinks are installed for all entires
456 # in the config file regardless of if that device actually
457 # exists. When installed as a package udev can be relied on for
458 # this and it will only create links for devices which exist.
459 if [ ${INTREE} ]; then
463 ${AWK} '!/^#/ && /./ { system( \
464 "ln -f -s /dev/disk/by-path/"$2" "$1";" \
465 "ln -f -s /dev/disk/by-path/"$2"-part1 "$1"p1;" \
466 "ln -f -s /dev/disk/by-path/"$2"-part9 "$1"p9;" \
470 DST_FILE=`basename ${SRC_PATH} | cut -f1-2 -d'.'`
471 DST_PATH=/etc/zfs/${DST_FILE}
473 if [ -e ${DST_PATH} ]; then
474 die "Error: Config ${DST_PATH} already exists"
477 cp ${SRC_PATH} ${DST_PATH}
487 if [ ${INTREE} ]; then
490 ${AWK} '!/^#/ && /./ { system( \
491 "rm -f "$1" "$1"p1 "$1"p9") }' $SRC_PATH
499 local CHANNEL=`echo "obase=16; $1+96" | bc`
502 printf "\x${CHANNEL}${RANK}"
511 for RANK in `seq 1 ${RANKS}`; do
512 for CHANNEL in `seq 1 ${CHANNELS}`; do
513 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
514 RAID0S[${IDX}]="${DEVDIR}/${DISK}"
522 udev_raid10_setup() {
528 for RANK in `seq 1 ${RANKS}`; do
529 for CHANNEL1 in `seq 1 2 ${CHANNELS}`; do
530 let CHANNEL2=CHANNEL1+1
531 DISK1=`udev_cr2d ${CHANNEL1} ${RANK}`
532 DISK2=`udev_cr2d ${CHANNEL2} ${RANK}`
533 GROUP="${DEVDIR}/${DISK1} ${DEVDIR}/${DISK2}"
534 RAID10S[${IDX}]="mirror ${GROUP}"
547 for RANK in `seq 1 ${RANKS}`; do
550 for CHANNEL in `seq 1 ${CHANNELS}`; do
551 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
552 RAIDZ[${CHANNEL}]="${DEVDIR}/${DISK}"
555 RAIDZS[${RANK}]="${RAIDZ[*]}"
561 udev_raidz2_setup() {
566 for RANK in `seq 1 ${RANKS}`; do
569 for CHANNEL in `seq 1 ${CHANNELS}`; do
570 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
571 RAIDZ2[${CHANNEL}]="${DEVDIR}/${DISK}"
574 RAIDZ2S[${RANK}]="${RAIDZ2[*]}"
584 printf "%-4d %-34s " ${TEST_NUM} "${TEST_NAME}"
592 printf "%-4d %-34s " ${TEST_NUM} "${TEST_NAME}"
600 for i in ${TESTS_SKIP[@]}; do
601 if [[ $i == ${TEST_NUM} ]] ; then
602 skip_one_test ${TEST_NUM} "${TEST_NAME}"
607 if [ "${TESTS_RUN[0]}" = "*" ]; then
608 run_one_test ${TEST_NUM} "${TEST_NAME}"
610 for i in ${TESTS_RUN[@]}; do
611 if [[ $i == ${TEST_NUM} ]] ; then
612 run_one_test ${TEST_NUM} "${TEST_NAME}"
617 skip_one_test ${TEST_NUM} "${TEST_NAME}"
627 while [ ! -e ${DEVICE} ]; do
628 if [ ${COUNT} -gt ${DELAY} ]; then