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=.script-config
11 if [ -f "${basedir}/../${SCRIPT_CONFIG}" ]; then
12 . "${basedir}/../${SCRIPT_CONFIG}"
14 MODULES=(zlib_deflate spl splat zavl znvpair zunicode zcommon zfs)
29 TESTS_RUN=${TESTS_RUN:-'*'}
30 TESTS_SKIP=${TESTS_SKIP:-}
33 exec_prefix=@exec_prefix@
34 libexecdir=@libexecdir@
35 pkglibexecdir=${libexecdir}/@PACKAGE@
39 ETCDIR=${ETCDIR:-/etc}
40 DEVDIR=${DEVDIR:-/dev/disk/zpool}
41 ZPOOLDIR=${ZPOOLDIR:-${pkglibexecdir}/zpool-config}
43 ZDB=${ZDB:-${sbindir}/zdb}
44 ZFS=${ZFS:-${sbindir}/zfs}
45 ZINJECT=${ZINJECT:-${sbindir}/zinject}
46 ZPOOL=${ZPOOL:-${sbindir}/zpool}
47 ZPOOL_ID=${ZPOOL_ID:-${bindir}/zpool_id}
48 ZTEST=${ZTEST:-${sbindir}/ztest}
50 COMMON_SH=${COMMON_SH:-${pkglibexecdir}/common.sh}
51 ZFS_SH=${ZFS_SH:-${pkglibexecdir}/zfs.sh}
52 ZPOOL_CREATE_SH=${ZPOOL_CREATE_SH:-${pkglibexecdir}/zpool-create.sh}
54 LDMOD=${LDMOD:-/sbin/modprobe}
55 LSMOD=${LSMOD:-/sbin/lsmod}
56 RMMOD=${RMMOD:-/sbin/rmmod}
57 INFOMOD=${INFOMOD:-/sbin/modinfo}
58 LOSETUP=${LOSETUP:-/sbin/losetup}
59 SYSCTL=${SYSCTL:-/sbin/sysctl}
60 UDEVADM=${UDEVADM:-/sbin/udevadm}
61 AWK=${AWK:-/usr/bin/awk}
63 COLOR_BLACK="\033[0;30m"
64 COLOR_DK_GRAY="\033[1;30m"
65 COLOR_BLUE="\033[0;34m"
66 COLOR_LT_BLUE="\033[1;34m"
67 COLOR_GREEN="\033[0;32m"
68 COLOR_LT_GREEN="\033[1;32m"
69 COLOR_CYAN="\033[0;36m"
70 COLOR_LT_CYAN="\033[1;36m"
71 COLOR_RED="\033[0;31m"
72 COLOR_LT_RED="\033[1;31m"
73 COLOR_PURPLE="\033[0;35m"
74 COLOR_LT_PURPLE="\033[1;35m"
75 COLOR_BROWN="\033[0;33m"
76 COLOR_YELLOW="\033[1;33m"
77 COLOR_LT_GRAY="\033[0;37m"
78 COLOR_WHITE="\033[1;37m"
82 echo -e "${PROG}: $1" >&2
87 if [ ${VERBOSE} ]; then
93 echo -e "${COLOR_GREEN}Pass${COLOR_RESET}"
97 echo -e "${COLOR_RED}Fail${COLOR_RESET} ($1)"
102 echo -e "${COLOR_BROWN}Skip${COLOR_RESET}"
106 ${SYSCTL} -w kernel.spl.debug.dump=1 &>/dev/null
107 local NAME=`dmesg | tail -n 1 | cut -f5 -d' '`
108 ${SPLBUILD}/cmd/spl ${NAME} >${NAME}.log
110 echo "Dumped debug log: ${NAME}.log"
117 local LOADED_MODULES=()
118 local MISSING_MODULES=()
120 for MOD in ${MODULES[*]}; do
121 local NAME=`basename $MOD .ko`
123 if ${LSMOD} | egrep -q "^${NAME}"; then
124 LOADED_MODULES=(${NAME} ${LOADED_MODULES[*]})
127 if [ ${INFOMOD} ${MOD} 2>/dev/null ]; then
128 MISSING_MODULES=("\t${MOD}\n" ${MISSING_MODULES[*]})
132 if [ ${#LOADED_MODULES[*]} -gt 0 ]; then
133 ERROR="Unload these modules with '${PROG} -u':\n"
134 ERROR="${ERROR}${LOADED_MODULES[*]}"
138 if [ ${#MISSING_MODULES[*]} -gt 0 ]; then
139 ERROR="The following modules can not be found,"
140 ERROR="${ERROR} ensure your source trees are built:\n"
141 ERROR="${ERROR}${MISSING_MODULES[*]}"
149 local NAME=`basename $1 .ko`
151 if [ ${VERBOSE} ]; then
152 echo "Loading ${NAME} ($@)"
155 ${LDMOD} $* || ERROR="Failed to load $1" return 1
163 for MOD in ${MODULES[*]}; do
164 local NAME=`basename ${MOD} .ko`
168 OPT_NAME=`echo ${OPT} | cut -f1 -d'='`
170 if [ ${NAME} = "${OPT_NAME}" ]; then
171 VALUE=`echo ${OPT} | cut -f2- -d'='`
175 load_module ${MOD} ${VALUE} || return 1
178 if [ ${VERBOSE} ]; then
179 echo "Successfully loaded ZFS module stack"
186 local NAME=`basename $1 .ko`
188 if [ ${VERBOSE} ]; then
189 echo "Unloading ${NAME} ($@)"
192 ${RMMOD} ${NAME} || ERROR="Failed to unload ${NAME}" return 1
198 local MODULES_REVERSE=( $(echo ${MODULES[@]} |
199 ${AWK} '{for (i=NF;i>=1;i--) printf $i" "} END{print ""}') )
201 for MOD in ${MODULES_REVERSE[*]}; do
202 local NAME=`basename ${MOD} .ko`
203 local USE_COUNT=`${LSMOD} |
204 egrep "^${NAME} "| ${AWK} '{print $3}'`
206 if [ "${USE_COUNT}" = 0 ] ; then
208 if [ "${DUMP_LOG}" -a ${NAME} = "spl" ]; then
212 unload_module ${MOD} || return 1
216 if [ ${VERBOSE} ]; then
217 echo "Successfully unloaded ZFS module stack"
223 unused_loop_device() {
224 for DEVICE in `ls -1 /dev/loop*`; do
225 ${LOSETUP} ${DEVICE} &>/dev/null
226 if [ $? -ne 0 ]; then
232 die "Error: Unable to find unused loopback device"
236 # This can be slightly dangerous because the loop devices we are
237 # cleanup up may not be ours. However, if the devices are currently
238 # in use we will not be able to remove them, and we only remove
239 # devices which include 'zpool' in the name. So any damage we might
240 # do should be limited to other zfs related testing.
242 cleanup_loop_devices() {
243 local TMP_FILE=`mktemp`
245 ${LOSETUP} -a | tr -d '()' >${TMP_FILE}
246 ${AWK} -F":" -v losetup="$LOSETUP" \
247 '/zpool/ { system("losetup -d "$1) }' ${TMP_FILE}
248 ${AWK} -F" " '/zpool/ { system("rm -f "$3) }' ${TMP_FILE}
254 # The following udev helper functions assume that the provided
255 # udev rules file will create a /dev/disk/zpool/<CHANNEL><RANK>
256 # disk mapping. In this mapping each CHANNEL is represented by
257 # the letters a-z, and the RANK is represented by the numbers
258 # 1-n. A CHANNEL should identify a group of RANKS which are all
259 # attached to a single controller, each RANK represents a disk.
260 # This provides a simply mechanism to locate a specific drive
261 # given a known hardware configuration.
266 # When running in tree manually contruct symlinks in tree to
267 # the proper devices. Symlinks are installed for all entires
268 # in the config file regardless of if that device actually
269 # exists. When installed as a package udev can be relied on for
270 # this and it will only create links for devices which exist.
271 if [ ${INTREE} ]; then
275 ${AWK} '!/^#/ && /./ { system( \
276 "ln -f -s /dev/disk/by-path/"$2" "$1";" \
277 "ln -f -s /dev/disk/by-path/"$2"-part1 "$1"p1;" \
278 "ln -f -s /dev/disk/by-path/"$2"-part9 "$1"p9;" \
282 DST_FILE=`basename ${SRC_PATH} | cut -f1-2 -d'.'`
283 DST_PATH=/etc/zfs/${DST_FILE}
285 if [ -e ${DST_PATH} ]; then
286 die "Error: Config ${DST_PATH} already exists"
289 cp ${SRC_PATH} ${DST_PATH}
291 if [ -f ${UDEVADM} ]; then
306 if [ ${INTREE} ]; then
309 ${AWK} '!/^#/ && /./ { system( \
310 "rm -f "$1" "$1"p1 "$1"p9") }' $SRC_PATH
318 local CHANNEL=`echo "obase=16; $1+96" | bc`
321 printf "\x${CHANNEL}${RANK}"
330 for RANK in `seq 1 ${RANKS}`; do
331 for CHANNEL in `seq 1 ${CHANNELS}`; do
332 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
333 RAID0S[${IDX}]="${DEVDIR}/${DISK}"
341 udev_raid10_setup() {
347 for RANK in `seq 1 ${RANKS}`; do
348 for CHANNEL1 in `seq 1 2 ${CHANNELS}`; do
349 let CHANNEL2=CHANNEL1+1
350 DISK1=`udev_cr2d ${CHANNEL1} ${RANK}`
351 DISK2=`udev_cr2d ${CHANNEL2} ${RANK}`
352 GROUP="${DEVDIR}/${DISK1} ${DEVDIR}/${DISK2}"
353 RAID10S[${IDX}]="mirror ${GROUP}"
366 for RANK in `seq 1 ${RANKS}`; do
369 for CHANNEL in `seq 1 ${CHANNELS}`; do
370 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
371 RAIDZ[${CHANNEL}]="${DEVDIR}/${DISK}"
374 RAIDZS[${RANK}]="${RAIDZ[*]}"
380 udev_raidz2_setup() {
385 for RANK in `seq 1 ${RANKS}`; do
388 for CHANNEL in `seq 1 ${CHANNELS}`; do
389 DISK=`udev_cr2d ${CHANNEL} ${RANK}`
390 RAIDZ2[${CHANNEL}]="${DEVDIR}/${DISK}"
393 RAIDZ2S[${RANK}]="${RAIDZ2[*]}"
403 printf "%-4d %-36s " ${TEST_NUM} "${TEST_NAME}"
411 printf "%-4d %-36s " ${TEST_NUM} "${TEST_NAME}"
419 for i in ${TESTS_SKIP[@]}; do
420 if [[ $i == ${TEST_NUM} ]] ; then
421 skip_one_test ${TEST_NUM} "${TEST_NAME}"
426 if [ "${TESTS_RUN[0]}" = "*" ]; then
427 run_one_test ${TEST_NUM} "${TEST_NAME}"
429 for i in ${TESTS_RUN[@]}; do
430 if [[ $i == ${TEST_NUM} ]] ; then
431 run_one_test ${TEST_NUM} "${TEST_NAME}"
436 skip_one_test ${TEST_NUM} "${TEST_NAME}"