ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

scripts: replace PCI_WHITELIST with PCI_ALLOWED

Browse Source 
Similarly replace PCI_BLACKLIST with PCI_BLOCKED.

Use of ALLOWED/BLOCKED matches similar changes made
in DPDK.

While here, replace use of term "blacklist" with "blocked"
in one of the nvme perf scripts.  The usage there was
associated with how devices are blocked by using the
environment variables that are changed by this patch.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I720d99118ba5e050f436612c9fd415db44294a63
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5275
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
This commit is contained in:
Jim Harris 2020-11-25 20:31:42 +00:00 committed by Tomasz Zawadzki
parent 895ad89214
commit a1280c9878
11 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
autotest.sh
View File

@ -90,7 +90,7 @@ rm -f /var/tmp/spdk*.sock
if [ $(uname -s) = Linux ]; then if [ $(uname -s) = Linux ]; then
# OCSSD devices drivers don't support IO issues by kernel so # OCSSD devices drivers don't support IO issues by kernel so
# detect OCSSD devices and blacklist them (unbind from any driver). # detect OCSSD devices and block them (unbind from any driver).
# If test scripts want to use this device it needs to do this explicitly. # If test scripts want to use this device it needs to do this explicitly.
# #
# If some OCSSD device is bound to other driver than nvme we won't be able to # If some OCSSD device is bound to other driver than nvme we won't be able to
@ -100,26 +100,26 @@ if [ $(uname -s) = Linux ]; then
# Send Open Channel 2.0 Geometry opcode "0xe2" - not supported by NVMe device. # Send Open Channel 2.0 Geometry opcode "0xe2" - not supported by NVMe device.
if nvme admin-passthru $dev --namespace-id=1 --data-len=4096 --opcode=0xe2 --read > /dev/null; then if nvme admin-passthru $dev --namespace-id=1 --data-len=4096 --opcode=0xe2 --read > /dev/null; then
bdf="$(basename $(readlink -e /sys/class/nvme/${dev#/dev/}/device))" bdf="$(basename $(readlink -e /sys/class/nvme/${dev#/dev/}/device))"
echo "INFO: blacklisting OCSSD device: $dev ($bdf)" echo "INFO: blocking OCSSD device: $dev ($bdf)"
PCI_BLACKLIST+=" $bdf" PCI_BLOCKED+=" $bdf"
OCSSD_PCI_DEVICES+=" $bdf" OCSSD_PCI_DEVICES+=" $bdf"
fi fi
done < <(find /dev -maxdepth 1 -regex '/dev/nvme[0-9]+' -print0) done < <(find /dev -maxdepth 1 -regex '/dev/nvme[0-9]+' -print0)
export OCSSD_PCI_DEVICES export OCSSD_PCI_DEVICES
# Now, bind blacklisted devices to pci-stub module. This will prevent # Now, bind blocked devices to pci-stub module. This will prevent
# automatic grabbing these devices when we add device/vendor ID to # automatic grabbing these devices when we add device/vendor ID to
# proper driver. # proper driver.
if [[ -n "$PCI_BLACKLIST" ]]; then if [[ -n "$PCI_BLOCKED" ]]; then
# shellcheck disable=SC2097,SC2098 # shellcheck disable=SC2097,SC2098
PCI_WHITELIST="$PCI_BLACKLIST" \ PCI_ALLOWED="$PCI_BLOCKED" \
PCI_BLACKLIST="" \ PCI_BLOCKED="" \
DRIVER_OVERRIDE="pci-stub" \ DRIVER_OVERRIDE="pci-stub" \
./scripts/setup.sh ./scripts/setup.sh
# Export our blacklist so it will take effect during next setup.sh # Export our blocked list so it will take effect during next setup.sh
export PCI_BLACKLIST export PCI_BLOCKED
fi fi
fi fi

4
doc/vmd.md
View File

@ -47,11 +47,11 @@ $ 5d:05.5 RAID bus controller: Intel Corporation Device 201d (rev 04)
$ d7:05.5 RAID bus controller: Intel Corporation Device 201d (rev 04) $ d7:05.5 RAID bus controller: Intel Corporation Device 201d (rev 04)
``` ```
Run setup.sh script with VMD devices set in PCI_WHITELIST. Run setup.sh script with VMD devices set in PCI_ALLOWED.
Example: Example:
``` ```
$ PCI_WHITELIST="0000:5d:05.5 0000:d7:05.5" scripts/setup.sh $ PCI_ALLOWED="0000:5d:05.5 0000:d7:05.5" scripts/setup.sh
``` ```
Check for available devices behind the VMD with spdk_lspci. Check for available devices behind the VMD with spdk_lspci.

22
scripts/common.sh
View File

@ -1,25 +1,25 @@
# Common shell utility functions # Common shell utility functions
# Check if PCI device is on PCI_WHITELIST and not on PCI_BLACKLIST # Check if PCI device is in PCI_ALLOWED and not in PCI_BLOCKED
# Env: # Env:
# if PCI_WHITELIST is empty assume device is whitelistened # if PCI_ALLOWED is empty assume device is allowed
# if PCI_BLACKLIST is empty assume device is NOT blacklistened # if PCI_BLOCKED is empty assume device is NOT blocked
# Params: # Params:
# $1 - PCI BDF # $1 - PCI BDF
function pci_can_use() { function pci_can_use() {
local i local i
# The '\ ' part is important # The '\ ' part is important
if [[ " $PCI_BLACKLIST " =~ \ $1\ ]]; then if [[ " $PCI_BLOCKED " =~ \ $1\ ]]; then
return 1 return 1
fi fi
if [[ -z "$PCI_WHITELIST" ]]; then if [[ -z "$PCI_ALLOWED" ]]; then
#no whitelist specified, bind all devices #no allow list specified, bind all devices
return 0 return 0
fi fi
for i in $PCI_WHITELIST; do for i in $PCI_ALLOWED; do
if [ "$i" == "$1" ]; then if [ "$i" == "$1" ]; then
return 0 return 0
fi fi
@ -135,7 +135,7 @@ iter_all_pci_sysfs() {
fi fi
} }
# This function will ignore PCI PCI_WHITELIST and PCI_BLACKLIST # This function will ignore PCI PCI_ALLOWED and PCI_BLOCKED
function iter_all_pci_class_code() { function iter_all_pci_class_code() {
local class local class
local subclass local subclass
@ -167,7 +167,7 @@ function iter_all_pci_class_code() {
fi fi
} }
# This function will ignore PCI PCI_WHITELIST and PCI_BLACKLIST # This function will ignore PCI PCI_ALLOWED and PCI_BLOCKED
function iter_all_pci_dev_id() { function iter_all_pci_dev_id() {
local ven_id local ven_id
local dev_id local dev_id
@ -199,7 +199,7 @@ function iter_pci_dev_id() {
done done
} }
# This function will filter out PCI devices using PCI_WHITELIST and PCI_BLACKLIST # This function will filter out PCI devices using PCI_ALLOWED and PCI_BLOCKED
# See function pci_can_use() # See function pci_can_use()
function iter_pci_class_code() { function iter_pci_class_code() {
local bdf="" local bdf=""
@ -213,7 +213,7 @@ function iter_pci_class_code() {
function nvme_in_userspace() { function nvme_in_userspace() {
# Check used drivers. If it's not vfio-pci or uio-pci-generic # Check used drivers. If it's not vfio-pci or uio-pci-generic
# then most likely PCI_WHITELIST option was used for setup.sh # then most likely PCI_ALLOWED option was used for setup.sh
# and we do not want to use that disk. # and we do not want to use that disk.
local bdf bdfs local bdf bdfs

26
scripts/setup.sh
View File

@ -59,16 +59,16 @@ function usage() {
echo " setting is used." echo " setting is used."
echo "CLEAR_HUGE If set to 'yes', the attempt to remove hugepages from all nodes will" echo "CLEAR_HUGE If set to 'yes', the attempt to remove hugepages from all nodes will"
echo " be made prior to allocation". echo " be made prior to allocation".
echo "PCI_WHITELIST" echo "PCI_ALLOWED"
echo "PCI_BLACKLIST Whitespace separated list of PCI devices (NVMe, I/OAT, VMD, Virtio)." echo "PCI_BLOCKED Whitespace separated list of PCI devices (NVMe, I/OAT, VMD, Virtio)."
echo " Each device must be specified as a full PCI address." echo " Each device must be specified as a full PCI address."
echo " E.g. PCI_WHITELIST=\"0000:01:00.0 0000:02:00.0\"" echo " E.g. PCI_ALLOWED=\"0000:01:00.0 0000:02:00.0\""
echo " To blacklist all PCI devices use a non-valid address." echo " To block all PCI devices use a non-valid address."
echo " E.g. PCI_WHITELIST=\"none\"" echo " E.g. PCI_BLOCKED=\"none\""
echo " If PCI_WHITELIST and PCI_BLACKLIST are empty or unset, all PCI devices" echo " If PCI_ALLOWED and PCI_BLOCKED are empty or unset, all PCI devices"
echo " will be bound." echo " will be bound."
echo " Each device in PCI_BLACKLIST will be ignored (driver won't be changed)." echo " Each device in PCI_BLOCKED will be ignored (driver won't be changed)."
echo " PCI_BLACKLIST has precedence over PCI_WHITELIST." echo " PCI_BLOCKED has precedence over PCI_ALLOWED."
echo "TARGET_USER User that will own hugepage mountpoint directory and vfio groups." echo "TARGET_USER User that will own hugepage mountpoint directory and vfio groups."
echo " By default the current user will be used." echo " By default the current user will be used."
echo "DRIVER_OVERRIDE Disable automatic vfio-pci/uio_pci_generic selection and forcefully" echo "DRIVER_OVERRIDE Disable automatic vfio-pci/uio_pci_generic selection and forcefully"
@ -235,7 +235,7 @@ function collect_devices() {
fi fi
fi fi
if [[ $dev_type == vmd ]]; then if [[ $dev_type == vmd ]]; then
if [[ $PCI_WHITELIST != *"$bdf"* ]]; then if [[ $PCI_ALLOWED != *"$bdf"* ]]; then
pci_dev_echo "$bdf" "Skipping not allowed VMD controller at $bdf" pci_dev_echo "$bdf" "Skipping not allowed VMD controller at $bdf"
in_use=1 in_use=1
fi fi
@ -717,15 +717,15 @@ if [ -z "$mode" ]; then
fi fi
: ${HUGEMEM:=2048} : ${HUGEMEM:=2048}
: ${PCI_WHITELIST:=""} : ${PCI_ALLOWED:=""}
: ${PCI_BLACKLIST:=""} : ${PCI_BLOCKED:=""}
if [ -n "$NVME_WHITELIST" ]; then if [ -n "$NVME_WHITELIST" ]; then
PCI_WHITELIST="$PCI_WHITELIST $NVME_WHITELIST" PCI_ALLOWED="$PCI_ALLOWED $NVME_WHITELIST"
fi fi
if [ -n "$SKIP_PCI" ]; then if [ -n "$SKIP_PCI" ]; then
PCI_WHITELIST="none" PCI_ALLOWED="none"
fi fi
if [ -z "$TARGET_USER" ]; then if [ -z "$TARGET_USER" ]; then

4
test/external_code/test_make.sh
View File

@ -9,7 +9,7 @@ set -e
SPDK_DIR=$1 SPDK_DIR=$1
# Skip all pci devices. These tests don't rely on them. # Skip all pci devices. These tests don't rely on them.
sudo PCI_WHITELIST="NONE" HUGEMEM="$HUGEMEM" $SPDK_DIR/scripts/setup.sh sudo PCI_ALLOWED="NONE" HUGEMEM="$HUGEMEM" $SPDK_DIR/scripts/setup.sh
make -C $SPDK_DIR clean make -C $SPDK_DIR clean
$SPDK_DIR/configure --with-shared --without-isal --without-ocf --disable-asan $SPDK_DIR/configure --with-shared --without-isal --without-ocf --disable-asan
@ -61,4 +61,4 @@ run_test "external_run_tc6" $test_root/hello_world/hello_bdev --json $test_root/
make -C $test_root clean make -C $test_root clean
make -C $SPDK_DIR -j$(nproc) clean make -C $SPDK_DIR -j$(nproc) clean
sudo PCI_WHITELIST="NONE" HUGEMEM="$HUGEMEM" $SPDK_DIR/scripts/setup.sh reset sudo PCI_ALLOWED="NONE" HUGEMEM="$HUGEMEM" $SPDK_DIR/scripts/setup.sh reset

6
test/ftl/ftl.sh
View File

@ -9,7 +9,7 @@ rpc_py=$rootdir/scripts/rpc.py
function at_ftl_exit() { function at_ftl_exit() {
# restore original driver # restore original driver
PCI_WHITELIST="$device" PCI_BLACKLIST="" DRIVER_OVERRIDE="$ocssd_original_dirver" $rootdir/scripts/setup.sh PCI_ALLOWED="$device" PCI_BLOCKED="" DRIVER_OVERRIDE="$ocssd_original_dirver" $rootdir/scripts/setup.sh
} }
read -r device _ <<< "$OCSSD_PCI_DEVICES" read -r device _ <<< "$OCSSD_PCI_DEVICES"
@ -26,8 +26,8 @@ ocssd_original_dirver="$(basename $(readlink /sys/bus/pci/devices/$device/driver
trap 'at_ftl_exit' SIGINT SIGTERM EXIT trap 'at_ftl_exit' SIGINT SIGTERM EXIT
# OCSSD is blacklisted so bind it to vfio/uio driver before testing # OCSSD is blocked so bind it to vfio/uio driver before testing
PCI_WHITELIST="$device" PCI_BLACKLIST="" DRIVER_OVERRIDE="" $rootdir/scripts/setup.sh PCI_ALLOWED="$device" PCI_BLOCKED="" DRIVER_OVERRIDE="" $rootdir/scripts/setup.sh
# Use first regular NVMe disk (non-OC) as non-volatile cache # Use first regular NVMe disk (non-OC) as non-volatile cache
nvme_disks=$($rootdir/scripts/gen_nvme.sh | jq -r \ nvme_disks=$($rootdir/scripts/gen_nvme.sh | jq -r \

2
test/nvme/cuse/nvme_ns_manage_cuse.sh
View File

@ -88,7 +88,7 @@ $NVME_CMD delete-ns ${nvme_dev} -n 0xffffffff || true
reset_nvme_if_aer_unsupported ${nvme_dev} reset_nvme_if_aer_unsupported ${nvme_dev}
sleep 1 sleep 1
PCI_WHITELIST="${bdf}" $rootdir/scripts/setup.sh PCI_ALLOWED="${bdf}" $rootdir/scripts/setup.sh
$SPDK_BIN_DIR/spdk_tgt -m 0x3 & $SPDK_BIN_DIR/spdk_tgt -m 0x3 &
spdk_tgt_pid=$! spdk_tgt_pid=$!

2
test/nvme/cuse/spdk_nvme_cli_cuse.sh
View File

@ -16,7 +16,7 @@ rpc_py=$rootdir/scripts/rpc.py
bdf=$(get_first_nvme_bdf) bdf=$(get_first_nvme_bdf)
PCI_WHITELIST="${bdf}" $rootdir/scripts/setup.sh reset PCI_ALLOWED="${bdf}" $rootdir/scripts/setup.sh reset
nvme_name=$(get_nvme_ctrlr_from_bdf ${bdf}) nvme_name=$(get_nvme_ctrlr_from_bdf ${bdf})
if [[ -z "$nvme_name" ]]; then if [[ -z "$nvme_name" ]]; then
echo "setup.sh failed bind kernel driver to ${bdf}" echo "setup.sh failed bind kernel driver to ${bdf}"

2
test/nvme/cuse/spdk_smartctl_cuse.sh
View File

@ -10,7 +10,7 @@ rpc_py=$rootdir/scripts/rpc.py
bdf=$(get_first_nvme_bdf) bdf=$(get_first_nvme_bdf)
PCI_WHITELIST="${bdf}" $rootdir/scripts/setup.sh reset PCI_ALLOWED="${bdf}" $rootdir/scripts/setup.sh reset
nvme_name=$(get_nvme_ctrlr_from_bdf ${bdf}) nvme_name=$(get_nvme_ctrlr_from_bdf ${bdf})
if [[ -z "$nvme_name" ]]; then if [[ -z "$nvme_name" ]]; then
echo "setup.sh failed bind kernel driver to ${bdf}" echo "setup.sh failed bind kernel driver to ${bdf}"

2
test/nvme/perf/common.sh
View File

@ -123,7 +123,7 @@ function get_numa_node() {
for bdf in $disks; do for bdf in $disks; do
local driver local driver
driver=$(grep DRIVER /sys/bus/pci/devices/$bdf/uevent | awk -F"=" '{print $2}') driver=$(grep DRIVER /sys/bus/pci/devices/$bdf/uevent | awk -F"=" '{print $2}')
# Use this check to ommit blacklisted devices ( not binded to driver with setup.sh script ) # Use this check to omit blocked devices ( not bound to driver with setup.sh script )
if [ "$driver" = "vfio-pci" ] || [ "$driver" = "uio_pci_generic" ]; then if [ "$driver" = "vfio-pci" ] || [ "$driver" = "uio_pci_generic" ]; then
cat /sys/bus/pci/devices/$bdf/numa_node cat /sys/bus/pci/devices/$bdf/numa_node
fi fi

2
test/vmd/vmd.sh
View File

@ -55,7 +55,7 @@ for bdf in $(iter_pci_dev_id 8086 $vmd_id); do
VMD_WHITELIST+=("$bdf") VMD_WHITELIST+=("$bdf")
fi fi
done done
PCI_WHITELIST="${VMD_WHITELIST[*]}" $rootdir/scripts/setup.sh PCI_ALLOWED="${VMD_WHITELIST[*]}" $rootdir/scripts/setup.sh
pci_devs=$($SPDK_BIN_DIR/spdk_lspci | grep "NVMe disk behind VMD" | awk '{print $1}') pci_devs=$($SPDK_BIN_DIR/spdk_lspci | grep "NVMe disk behind VMD" | awk '{print $1}')