test/nvmf: Add unittest script for Nvme mDNS discovery service

Adding script mdns_discovery.sh to test the mDNS discovery service at the host.
The script tests the RPC commands bdev_nvme_start_mdns_discovery, bdev_nvme_stop_mdns_discovery
and bdev_nvme_get_mdns_discovery_info.

avahi-publish tool is used to simulate the advertisement of the discovery service of the target subsystem.

Signed-off-by: Parameswaran Krishnamurthy <parameswaran.krishna@dell.com>
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Ieace458f87b5d9bd51aeb651d9419d07b6fee6d0
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16140
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Boris Glimcher <Boris.Glimcher@emc.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
Parameswaran Krishnamurthy 2023-01-05 13:03:53 +00:00 committed by Tomasz Zawadzki
parent 10f90ccd7b
commit 6d4d5c62e7
5 changed files with 220 additions and 0 deletions

View File

@ -177,6 +177,8 @@ export SPDK_TEST_XNVME
# Comma-separated list of fuzzer targets matching test/fuzz/llvm/$target
: ${SPDK_TEST_FUZZER_TARGET:=}
export SPDK_TEST_FUZZER_TARGET
: ${SPDK_TEST_NVMF_MDNS=0}
export SPDK_TEST_NVMF_MDNS
# always test with SPDK shared objects.
export SPDK_LIB_DIR="$rootdir/build/lib"
@ -512,6 +514,10 @@ function get_config_params() {
config_params+=" $(get_fuzzer_target_config)"
fi
if [[ $SPDK_TEST_NVMF_MDNS -eq 1 ]]; then
config_params+=' --with-avahi'
fi
echo "$config_params"
xtrace_restore
}

View File

@ -122,6 +122,7 @@ function install_refspdk() {
SPDK_TEST_URING=1
SPDK_TEST_VFIOUSER=1
SPDK_TEST_XNVME=1
SPDK_TEST_NVMF_MDNS=1
EOF
mkdir -p $HOME/output

View File

@ -186,6 +186,7 @@ SPDK_TEST_NVME_SCC=1
SPDK_TEST_NVME_BP=1
SPDK_TEST_NVME_CLI=1
SPDK_TEST_NVMF=1
SPDK_TEST_NVMF_MDNS=1
SPDK_TEST_VFIOUSER=1
SPDK_TEST_RBD=1
SPDK_TEST_BLOCKDEV=1

208
test/nvmf/host/mdns_discovery.sh Executable file
View File

@ -0,0 +1,208 @@
#!/usr/bin/env bash
# SPDX-License-Identifier: BSD-3-Clause
# Copyright (C) 2021 Intel Corporation
# All rights reserved.
# Copyright (c) 2022 Dell Inc, or its subsidiaries. All rights reserved.
#
testdir=$(readlink -f $(dirname $0))
rootdir=$(readlink -f $testdir/../../..)
source $rootdir/test/common/autotest_common.sh
source $rootdir/test/nvmf/common.sh
if [ "$TEST_TRANSPORT" == "rdma" ]; then
echo "Skipping tests on RDMA because the rdma stack fails to configure the same IP for host and target."
exit 0
fi
DISCOVERY_FILTER="address"
DISCOVERY_PORT=8009
DISCOVERY_NQN=nqn.2014-08.org.nvmexpress.discovery
# NQN prefix to use for subsystem NQNs
NQN=nqn.2016-06.io.spdk:cnode
NQN2=nqn.2016-06.io.spdk:cnode2
HOST_NQN=nqn.2021-12.io.spdk:test
HOST_SOCK=/tmp/host.sock
nvmftestinit
# We will start the target as normal, emulating a storage cluster. We will simulate new paths
# to the cluster via multiple listeners with different TCP ports.
nvmfappstart -m 0x2 --wait-for-rpc
$rpc_py nvmf_set_config --discovery-filter=$DISCOVERY_FILTER
$rpc_py framework_start_init
$rpc_py nvmf_create_transport $NVMF_TRANSPORT_OPTS -u 8192
$rpc_py nvmf_subsystem_add_listener $DISCOVERY_NQN -t $TEST_TRANSPORT -a $NVMF_FIRST_TARGET_IP \
-s $DISCOVERY_PORT
$rpc_py bdev_null_create null0 1000 512
$rpc_py bdev_null_create null1 1000 512
$rpc_py bdev_null_create null2 1000 512
$rpc_py bdev_null_create null3 1000 512
$rpc_py bdev_wait_for_examine
# Now start the host where the discovery service will run. For our tests, we will send RPCs to
# the "cluster" to create subsystems, add namespaces, add and remove listeners and add hosts,
# and then check if the discovery service has detected the changes and constructed the correct
# subsystem, ctrlr and bdev objects.
$SPDK_BIN_DIR/nvmf_tgt -m 0x1 -r $HOST_SOCK &
hostpid=$!
waitforlisten $hostpid $HOST_SOCK
trap 'process_shm --id $NVMF_APP_SHM_ID;exit 1' SIGINT SIGTERM
trap 'process_shm --id $NVMF_APP_SHM_ID;nvmftestfini;kill $hostpid;kill $avahi_clientpid;kill $avahipid;' EXIT
# Make sure any existing avahi-daemon is killed before we start it with the specified
# configuration file limiting it to the NVMF_TARGET_INTERFACE.
avahi-daemon --kill || :
"${NVMF_TARGET_NS_CMD[@]}" avahi-daemon -f <(echo -e "[server]\nallow-interfaces=$NVMF_TARGET_INTERFACE,$NVMF_TARGET_INTERFACE2\nuse-ipv4=yes\nuse-ipv6=no") &
avahipid=$!
sleep 1
$rpc_py -s $HOST_SOCK log_set_flag bdev_nvme
$rpc_py -s $HOST_SOCK bdev_nvme_start_mdns_discovery -b mdns -s _nvme-disc._tcp -q $HOST_NQN
function get_bdev_list() {
$rpc_py -s $HOST_SOCK bdev_get_bdevs | jq -r '.[].name' | sort | xargs
}
function get_subsystem_names() {
$rpc_py -s $HOST_SOCK bdev_nvme_get_controllers | jq -r '.[].name' | sort | xargs
}
function get_subsystem_paths() {
$rpc_py -s $HOST_SOCK bdev_nvme_get_controllers -n $1 | jq -r '.[].ctrlrs[].trid.trsvcid' | sort -n | xargs
}
function get_discovery_ctrlrs() {
$rpc_py -s $HOST_SOCK bdev_nvme_get_discovery_info | jq -r '.[].name' | sort | xargs
}
function get_mdns_discovery_svcs() {
$rpc_py -s $HOST_SOCK bdev_nvme_get_mdns_discovery_info | jq -r '.[].name' | sort | xargs
}
# Note that tests need to call get_notification_count and then check $notification_count,
# because if we use $(get_notification_count), the notify_id gets updated in the subshell.
notify_id=0
function get_notification_count() {
notification_count=$($rpc_py -s $HOST_SOCK notify_get_notifications -i $notify_id | jq '. | length')
notify_id=$((notify_id + notification_count))
}
[[ "$(get_subsystem_names)" == "" ]]
[[ "$(get_bdev_list)" == "" ]]
$rpc_py nvmf_create_subsystem ${NQN}0
[[ "$(get_subsystem_names)" == "" ]]
[[ "$(get_bdev_list)" == "" ]]
$rpc_py nvmf_subsystem_add_ns ${NQN}0 null0
[[ "$(get_subsystem_names)" == "" ]]
[[ "$(get_bdev_list)" == "" ]]
# Add listener for the subsystem. But since the the subsystem was not created with -a option, the
# discovery host will not be able to see the subsystem until its hostnqn is added.
$rpc_py nvmf_subsystem_add_listener ${NQN}0 -t $TEST_TRANSPORT -a $NVMF_FIRST_TARGET_IP -s $NVMF_PORT
# Discovery hostnqn is added, so now the host should see the subsystem, with a single path for the
# port of the single listener on the target.
$rpc_py nvmf_subsystem_add_host ${NQN}0 $HOST_NQN
# Adding the second discovery controller and target
$rpc_py nvmf_create_subsystem ${NQN2}0
$rpc_py nvmf_subsystem_add_ns ${NQN2}0 null2
# Discovery hostnqn is added, so now the host should see the subsystem, with a single path for the
# port of the single listener on the target.
$rpc_py nvmf_subsystem_add_host ${NQN2}0 $HOST_NQN
$rpc_py nvmf_subsystem_add_listener $DISCOVERY_NQN -t $TEST_TRANSPORT -a $NVMF_SECOND_TARGET_IP \
-s $DISCOVERY_PORT
$rpc_py nvmf_subsystem_add_listener ${NQN2}0 -t $TEST_TRANSPORT -a $NVMF_SECOND_TARGET_IP -s $NVMF_PORT
#Simulate discovery service publishing by the target
"${NVMF_TARGET_NS_CMD[@]}" /usr/bin/avahi-publish --domain=local --service CDC _nvme-disc._tcp $DISCOVERY_PORT "NQN=$DISCOVERY_NQN" "p=tcp" &
avahi_clientpid=$!
sleep 5 # Wait a bit to make sure the discovery service has a chance to detect the changes
[[ "$(get_mdns_discovery_svcs)" == "mdns" ]]
[[ $(get_discovery_ctrlrs) == "mdns0_nvme mdns1_nvme" ]]
[[ "$(get_subsystem_names)" == "mdns0_nvme0 mdns1_nvme0" ]]
[[ "$(get_bdev_list)" == "mdns0_nvme0n1 mdns1_nvme0n1" ]]
[[ "$(get_subsystem_paths mdns0_nvme0)" == "$NVMF_PORT" ]]
[[ "$(get_subsystem_paths mdns1_nvme0)" == "$NVMF_PORT" ]]
get_notification_count
[[ $notification_count == 2 ]]
# Adding a namespace isn't a discovery function, but do it here anyways just to confirm we see a new bdev.
$rpc_py nvmf_subsystem_add_ns ${NQN}0 null1
$rpc_py nvmf_subsystem_add_ns ${NQN2}0 null3
sleep 1 # Wait a bit to make sure the discovery service has a chance to detect the changes
[[ "$(get_bdev_list)" == "mdns0_nvme0n1 mdns0_nvme0n2 mdns1_nvme0n1 mdns1_nvme0n2" ]]
get_notification_count
[[ $notification_count == 2 ]]
# Add a second path to the same subsystems. This shouldn't change the list of subsystems or bdevs, but
# we should see a second path on the mdns0_nvme0 and mdns1_nvme0 subsystems now.
$rpc_py nvmf_subsystem_add_listener ${NQN}0 -t $TEST_TRANSPORT -a $NVMF_FIRST_TARGET_IP -s $NVMF_SECOND_PORT
$rpc_py nvmf_subsystem_add_listener ${NQN2}0 -t $TEST_TRANSPORT -a $NVMF_SECOND_TARGET_IP -s $NVMF_SECOND_PORT
sleep 1 # Wait a bit to make sure the discovery service has a chance to detect the changes
[[ "$(get_subsystem_names)" == "mdns0_nvme0 mdns1_nvme0" ]]
[[ "$(get_bdev_list)" == "mdns0_nvme0n1 mdns0_nvme0n2 mdns1_nvme0n1 mdns1_nvme0n2" ]]
[[ "$(get_subsystem_paths mdns0_nvme0)" == "$NVMF_PORT $NVMF_SECOND_PORT" ]]
[[ "$(get_subsystem_paths mdns1_nvme0)" == "$NVMF_PORT $NVMF_SECOND_PORT" ]]
get_notification_count
[[ $notification_count == 0 ]]
# Remove the listener for the first port. The subsystem and bdevs should stay, but we should see
# the path to that first port disappear.
$rpc_py nvmf_subsystem_remove_listener ${NQN}0 -t $TEST_TRANSPORT -a $NVMF_FIRST_TARGET_IP -s $NVMF_PORT
$rpc_py nvmf_subsystem_remove_listener ${NQN2}0 -t $TEST_TRANSPORT -a $NVMF_SECOND_TARGET_IP -s $NVMF_PORT
sleep 1 # Wait a bit to make sure the discovery service has a chance to detect the changes
[[ "$(get_subsystem_names)" == "mdns0_nvme0 mdns1_nvme0" ]]
[[ "$(get_bdev_list)" == "mdns0_nvme0n1 mdns0_nvme0n2 mdns1_nvme0n1 mdns1_nvme0n2" ]]
[[ "$(get_subsystem_paths mdns0_nvme0)" == "$NVMF_SECOND_PORT" ]]
[[ "$(get_subsystem_paths mdns1_nvme0)" == "$NVMF_SECOND_PORT" ]]
get_notification_count
[[ $notification_count == 0 ]]
$rpc_py -s $HOST_SOCK bdev_nvme_stop_mdns_discovery -b mdns
sleep 1 # Wait a bit to make sure the discovery service has a chance to detect the changes
[[ "$(get_mdns_discovery_svcs)" == "" ]]
[[ "$(get_subsystem_names)" == "" ]]
[[ "$(get_bdev_list)" == "" ]]
get_notification_count
[[ $notification_count == 4 ]]
# Make sure that it's impossible to start the discovery using the same bdev name
$rpc_py -s $HOST_SOCK bdev_nvme_start_mdns_discovery -b mdns -s _nvme-disc._tcp -q $HOST_NQN
NOT $rpc_py -s $HOST_SOCK bdev_nvme_start_mdns_discovery -b mdns -s _nvme-disc._http -q $HOST_NQN
sleep 5
[[ "$(get_mdns_discovery_svcs)" == "mdns" ]]
[[ $(get_discovery_ctrlrs) == "mdns0_nvme mdns1_nvme" ]]
[[ $(get_bdev_list) == "mdns0_nvme0n1 mdns0_nvme0n2 mdns1_nvme0n1 mdns1_nvme0n2" ]]
# Make sure that it's also impossible to start the discovery using the same service name
NOT $rpc_py -s $HOST_SOCK bdev_nvme_start_mdns_discovery -b cdc -s _nvme-disc._tcp -q $HOST_NQN
[[ $(get_discovery_ctrlrs) == "mdns0_nvme mdns1_nvme" ]]
[[ $(get_bdev_list) == "mdns0_nvme0n1 mdns0_nvme0n2 mdns1_nvme0n1 mdns1_nvme0n2" ]]
$rpc_py -s $HOST_SOCK bdev_nvme_stop_mdns_discovery -b mdns
trap - SIGINT SIGTERM EXIT
kill $hostpid
# Now wait for $hostpid to exit, otherwise if it's still running when we try to kill $avahipid, avahi
# will auto-restart.
wait $hostpid
kill $avahi_clientpid
kill $avahipid
nvmftestfini

View File

@ -92,6 +92,10 @@ run_test "nvmf_discovery" test/nvmf/host/discovery.sh "${TEST_ARGS[@]}"
# TODO: disabled due to intermittent failures (RDMA_CM_EVENT_UNREACHABLE/ETIMEDOUT)
#run_test test/nvmf/host/identify_kernel_nvmf.sh $TEST_ARGS
if [[ $SPDK_TEST_NVMF_MDNS -eq 1 ]]; then
run_test "nvmf_mdns_discovery" test/nvmf/host/mdns_discovery.sh "${TEST_ARGS[@]}"
fi
if [[ $SPDK_TEST_USDT -eq 1 ]]; then
run_test "nvmf_multipath" test/nvmf/host/multipath.sh "${TEST_ARGS[@]}"
run_test "nvmf_timeout" test/nvmf/host/timeout.sh "${TEST_ARGS[@]}"