* [dpdk-dev] [PATCH v4 01/11] rte_ethdev: change comment to rte_dev_eth_mac_addr_add
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 02/11] mk: replace reference to blacklist/whitelist Stephen Hemminger
` (10 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
The comment used the term whitelist and was awkardly written.
Replace it with simpler direct description of adding a new address.
No code or API changes for this.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
lib/librte_ethdev/rte_ethdev.h | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 57e4a6ca58fd..cde6a9645360 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -3387,8 +3387,7 @@ int rte_eth_dev_priority_flow_ctrl_set(uint16_t port_id,
struct rte_eth_pfc_conf *pfc_conf);
/**
- * Add a MAC address to an internal array of addresses used to enable whitelist
- * filtering to accept packets only if the destination MAC address matches.
+ * Add a MAC address to an set of addresses used for accepting incoming packets.
*
* @param port_id
* The port identifier of the Ethernet device.
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 02/11] mk: replace reference to blacklist/whitelist
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 01/11] rte_ethdev: change comment to rte_dev_eth_mac_addr_add Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 03/11] check_maintainers: change variable names Stephen Hemminger
` (9 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
Use BLOCKLIST and ALLOWLIST in the make variable names.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
mk/rte.sdktest.mk | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/mk/rte.sdktest.mk b/mk/rte.sdktest.mk
index 803018ba3a70..6777e0c0f603 100644
--- a/mk/rte.sdktest.mk
+++ b/mk/rte.sdktest.mk
@@ -39,11 +39,11 @@ STRIPPED_PERFLIST=$(subst $(SPACESTR),,$(PERFLIST))
STRIPPED_DRIVERSLIST=$(subst $(SPACESTR),,$(DRIVERSLIST))
STRIPPED_DUMPLIST=$(subst $(SPACESTR),,$(DUMPLIST))
-coverage: BLACKLIST=-$(STRIPPED_PERFLIST)
-test-fast: BLACKLIST=-$(STRIPPED_PERFLIST),$(STRIPPED_DRIVERSLIST),$(STRIPPED_DUMPLIST)
-test-perf: WHITELIST=$(STRIPPED_PERFLIST)
-test-drivers: WHITELIST=$(STRIPPED_DRIVERSLIST)
-test-dump: WHITELIST=$(STRIPPED_DUMPLIST)
+coverage: BLOCKLIST=-$(STRIPPED_PERFLIST)
+test-fast: BLOCKLIST=-$(STRIPPED_PERFLIST),$(STRIPPED_DRIVERSLIST),$(STRIPPED_DUMPLIST)
+test-perf: ALLOWLIST=$(STRIPPED_PERFLIST)
+test-drivers: ALLOWLIST=$(STRIPPED_DRIVERSLIST)
+test-dump: ALLOWLIST=$(STRIPPED_DUMPLIST)
test test-fast test-perf test-drivers test-dump:
@mkdir -p $(AUTOTEST_DIR) ; \
@@ -52,7 +52,7 @@ test test-fast test-perf test-drivers test-dump:
python $(RTE_SDK)/app/test/autotest.py \
$(RTE_OUTPUT)/app/test \
$(RTE_TARGET) \
- $(BLACKLIST) $(WHITELIST); \
+ $(BLOCKLIST) $(ALLOWLIST); \
else \
echo "No test found, please do a 'make' first, or specify O=" ; \
fi
@@ -69,7 +69,7 @@ coverage:
python $(RTE_SDK)/app/test/autotest.py \
$(RTE_OUTPUT)/app/test \
$(RTE_TARGET) \
- $(BLACKLIST) $(WHITELIST) ; \
+ $(BLOCKLIST) $(ALLOWLIST) ; \
$(RTE_OUTPUT)/app/dpdk-procinfo --file-prefix=ring_perf -- -m; \
else \
echo "No test found, please do a 'make' first, or specify O=" ;\
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 03/11] check_maintainers: change variable names
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 01/11] rte_ethdev: change comment to rte_dev_eth_mac_addr_add Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 02/11] mk: replace reference to blacklist/whitelist Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 04/11] eal: replace usage of blacklist/whitelist in enum Stephen Hemminger
` (8 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
Change variable names in python script: replace whitelist
with include_files and blacklist with exclude_files.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
devtools/check-maintainers.sh | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/devtools/check-maintainers.sh b/devtools/check-maintainers.sh
index 85a300f0a029..df3f740b6e84 100755
--- a/devtools/check-maintainers.sh
+++ b/devtools/check-maintainers.sh
@@ -42,10 +42,10 @@ parse_fx () # <index file>
for line in $( (sed '/^-\+$/d' $1 ; echo) | sed 's,^$,§,') ; do
if echo "$line" | grep -q '^§$' ; then
# empty line delimit end of section
- whitelist=$(files $flines)
- blacklist=$(files $xlines)
- match=$(aminusb "$whitelist" "$blacklist")
- if [ -n "$whitelist" ] ; then
+ include_files=$(files $flines)
+ exclude_files=$(files $xlines)
+ match=$(aminusb "$include_files" "$exclude_files")
+ if [ -n "$include_files" ] ; then
printf "# $title "
maintainers=$(echo "$maintainers" | sed -r 's,.*<(.*)>.*,\1,')
maintainers=$(printf "$maintainers" | sed -e 's,^,<,' -e 's,$,>,')
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 04/11] eal: replace usage of blacklist/whitelist in enum
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (2 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 03/11] check_maintainers: change variable names Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 05/11] drivers: replace references to blacklist Stephen Hemminger
` (7 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi, Gaetan Rivet
The terms blacklist and whitelist are often seen as reminders
of the divisions in society. Instead, use more exact terms for
handling of which devices are used in DPDK.
This patch renames the enum values in the EAL include files.
As a backward compatible temporary migration tool, define
a replacement mapping for old values.
The old names relating to blacklist and whitelist are replaced
by block list and allow list, but applications may be using the
older compatibility macros. To help with conversion to new names
cause a message when the compatibility names are used.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
Acked-by: Gaetan Rivet <grive@u256.net>
---
lib/librte_eal/common/eal_common_devargs.c | 14 +++++++-------
lib/librte_eal/include/rte_bus.h | 8 ++++++--
lib/librte_eal/include/rte_dev.h | 8 ++++++--
lib/librte_eal/include/rte_devargs.h | 8 ++++++--
4 files changed, 25 insertions(+), 13 deletions(-)
diff --git a/lib/librte_eal/common/eal_common_devargs.c b/lib/librte_eal/common/eal_common_devargs.c
index 2123773ef840..d0d58358fee1 100644
--- a/lib/librte_eal/common/eal_common_devargs.c
+++ b/lib/librte_eal/common/eal_common_devargs.c
@@ -296,7 +296,7 @@ rte_devargs_insert(struct rte_devargs **da)
return 0;
}
-/* store a whitelist parameter for later parsing */
+/* store an allowlist parameter for later parsing */
int
rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
{
@@ -313,13 +313,13 @@ rte_devargs_add(enum rte_devtype devtype, const char *devargs_str)
goto fail;
devargs->type = devtype;
bus = devargs->bus;
- if (devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI)
- devargs->policy = RTE_DEV_BLACKLISTED;
+ if (devargs->type == RTE_DEVTYPE_BLOCKED_PCI)
+ devargs->policy = RTE_DEV_BLOCKED;
if (bus->conf.scan_mode == RTE_BUS_SCAN_UNDEFINED) {
- if (devargs->policy == RTE_DEV_WHITELISTED)
- bus->conf.scan_mode = RTE_BUS_SCAN_WHITELIST;
- else if (devargs->policy == RTE_DEV_BLACKLISTED)
- bus->conf.scan_mode = RTE_BUS_SCAN_BLACKLIST;
+ if (devargs->policy == RTE_DEV_ALLOWED)
+ bus->conf.scan_mode = RTE_BUS_SCAN_ALLOWLIST;
+ else if (devargs->policy == RTE_DEV_BLOCKED)
+ bus->conf.scan_mode = RTE_BUS_SCAN_BLOCKLIST;
}
TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
return 0;
diff --git a/lib/librte_eal/include/rte_bus.h b/lib/librte_eal/include/rte_bus.h
index d3034d0edf77..19309ad2ddd7 100644
--- a/lib/librte_eal/include/rte_bus.h
+++ b/lib/librte_eal/include/rte_bus.h
@@ -215,10 +215,14 @@ typedef int (*rte_bus_sigbus_handler_t)(const void *failure_addr);
*/
enum rte_bus_scan_mode {
RTE_BUS_SCAN_UNDEFINED,
- RTE_BUS_SCAN_WHITELIST,
- RTE_BUS_SCAN_BLACKLIST,
+ RTE_BUS_SCAN_ALLOWLIST,
+ RTE_BUS_SCAN_BLOCKLIST,
};
+/* Backwards compatibility will be deprecated */
+#define RTE_BUS_SCAN_WHITELIST RTE_BUS_SCAN_ALLOWLIST
+#define RTE_BUS_SCAN_BLACKLIST RTE_BUS_SCAN_BLOCKLIST
+
/**
* A structure used to configure bus operations.
*/
diff --git a/lib/librte_eal/include/rte_dev.h b/lib/librte_eal/include/rte_dev.h
index c8d985fb5cf9..1208b1e99b05 100644
--- a/lib/librte_eal/include/rte_dev.h
+++ b/lib/librte_eal/include/rte_dev.h
@@ -70,10 +70,14 @@ enum rte_kernel_driver {
* Device policies.
*/
enum rte_dev_policy {
- RTE_DEV_WHITELISTED,
- RTE_DEV_BLACKLISTED,
+ RTE_DEV_ALLOWED,
+ RTE_DEV_BLOCKED,
};
+/* Backwards compatiablity will be deprecated */
+#define RTE_DEV_WHITELISTED RTE_DEV_ALLOWED
+#define RTE_DEV_BLACKLISTED RTE_DEV_BLOCKED
+
/**
* A generic memory resource representation.
*/
diff --git a/lib/librte_eal/include/rte_devargs.h b/lib/librte_eal/include/rte_devargs.h
index 898efa0d667b..e1a4277ff167 100644
--- a/lib/librte_eal/include/rte_devargs.h
+++ b/lib/librte_eal/include/rte_devargs.h
@@ -29,11 +29,15 @@ extern "C" {
* Type of generic device
*/
enum rte_devtype {
- RTE_DEVTYPE_WHITELISTED_PCI,
- RTE_DEVTYPE_BLACKLISTED_PCI,
+ RTE_DEVTYPE_ALLOWED_PCI,
+ RTE_DEVTYPE_BLOCKED_PCI,
RTE_DEVTYPE_VIRTUAL,
};
+/* Backwards compatiablity will be removed later */
+#define RTE_DEVTYPE_WHITELISTED_PCI RTE_DEVTYPE_ALLOWED_PCI
+#define RTE_DEVTYPE_BLACKLISTED_PCI RTE_DEVTYPE_BLOCKED_PCI
+
/**
* Structure that stores a device given by the user with its arguments
*
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 05/11] drivers: replace references to blacklist
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (3 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 04/11] eal: replace usage of blacklist/whitelist in enum Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 06/11] eal: replace pci-whitelist/pci-blacklist options Stephen Hemminger
` (6 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
Use the new terminology blocked to describe when devices
are excluded from being used.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
drivers/bus/dpaa/dpaa_bus.c | 7 +++----
drivers/bus/fslmc/fslmc_bus.c | 9 ++++-----
drivers/bus/fslmc/fslmc_vfio.c | 8 ++++----
drivers/bus/pci/pci_common.c | 24 ++++++++++--------------
drivers/bus/vmbus/vmbus_common.c | 4 ++--
drivers/crypto/virtio/virtio_pci.c | 2 +-
drivers/net/fm10k/fm10k_ethdev.c | 2 +-
drivers/net/virtio/virtio_pci.c | 2 +-
8 files changed, 26 insertions(+), 32 deletions(-)
diff --git a/drivers/bus/dpaa/dpaa_bus.c b/drivers/bus/dpaa/dpaa_bus.c
index 32e872da5209..f08c3a6149da 100644
--- a/drivers/bus/dpaa/dpaa_bus.c
+++ b/drivers/bus/dpaa/dpaa_bus.c
@@ -568,7 +568,7 @@ rte_dpaa_bus_probe(void)
struct rte_dpaa_driver *drv;
FILE *svr_file = NULL;
unsigned int svr_ver;
- int probe_all = rte_dpaa_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST;
+ int probe_all = rte_dpaa_bus.bus.conf.scan_mode != RTE_BUS_SCAN_ALLOWLIST;
static int process_once;
/* If DPAA bus is not present nothing needs to be done */
@@ -630,13 +630,12 @@ rte_dpaa_bus_probe(void)
if (!drv->probe ||
(dev->device.devargs &&
- dev->device.devargs->policy == RTE_DEV_BLACKLISTED))
+ dev->device.devargs->policy == RTE_DEV_BLOCKED))
continue;
if (probe_all ||
(dev->device.devargs &&
- dev->device.devargs->policy ==
- RTE_DEV_WHITELISTED)) {
+ dev->device.devargs->policy == RTE_DEV_ALLOWED)) {
ret = drv->probe(drv, dev);
if (ret) {
DPAA_BUS_ERR("unable to probe:%s",
diff --git a/drivers/bus/fslmc/fslmc_bus.c b/drivers/bus/fslmc/fslmc_bus.c
index beb3dd008fbc..be4ab4ff3f64 100644
--- a/drivers/bus/fslmc/fslmc_bus.c
+++ b/drivers/bus/fslmc/fslmc_bus.c
@@ -403,7 +403,7 @@ rte_fslmc_probe(void)
return 0;
}
- probe_all = rte_fslmc_bus.bus.conf.scan_mode != RTE_BUS_SCAN_WHITELIST;
+ probe_all = rte_fslmc_bus.bus.conf.scan_mode != RTE_BUS_SCAN_ALLOWLIST;
/* In case of PA, the FD addresses returned by qbman APIs are physical
* addresses, which need conversion into equivalent VA address for
@@ -434,16 +434,15 @@ rte_fslmc_probe(void)
continue;
if (dev->device.devargs &&
- dev->device.devargs->policy == RTE_DEV_BLACKLISTED) {
- DPAA2_BUS_LOG(DEBUG, "%s Blacklisted, skipping",
+ dev->device.devargs->policy == RTE_DEV_BLOCKED) {
+ DPAA2_BUS_LOG(DEBUG, "%s Blocklisted, skipping",
dev->device.name);
continue;
}
if (probe_all ||
(dev->device.devargs &&
- dev->device.devargs->policy ==
- RTE_DEV_WHITELISTED)) {
+ dev->device.devargs->policy == RTE_DEV_ALLOWED)) {
ret = drv->probe(drv, dev);
if (ret) {
DPAA2_BUS_ERR("Unable to probe");
diff --git a/drivers/bus/fslmc/fslmc_vfio.c b/drivers/bus/fslmc/fslmc_vfio.c
index efe2c43d372a..3634db3f65a2 100644
--- a/drivers/bus/fslmc/fslmc_vfio.c
+++ b/drivers/bus/fslmc/fslmc_vfio.c
@@ -819,8 +819,8 @@ fslmc_vfio_process_group(void)
TAILQ_FOREACH_SAFE(dev, &rte_fslmc_bus.device_list, next, dev_temp) {
if (dev->dev_type == DPAA2_MPORTAL) {
if (dev->device.devargs &&
- dev->device.devargs->policy == RTE_DEV_BLACKLISTED) {
- DPAA2_BUS_LOG(DEBUG, "%s Blacklisted, skipping",
+ dev->device.devargs->policy == RTE_DEV_BLOCKED) {
+ DPAA2_BUS_LOG(DEBUG, "%s Blocklisted, skipping",
dev->device.name);
TAILQ_REMOVE(&rte_fslmc_bus.device_list,
dev, next);
@@ -852,8 +852,8 @@ fslmc_vfio_process_group(void)
TAILQ_FOREACH_SAFE(dev, &rte_fslmc_bus.device_list, next, dev_temp) {
if (dev->device.devargs &&
- dev->device.devargs->policy == RTE_DEV_BLACKLISTED) {
- DPAA2_BUS_LOG(DEBUG, "%s Blacklisted, skipping",
+ dev->device.devargs->policy == RTE_DEV_BLOCKED) {
+ DPAA2_BUS_LOG(DEBUG, "%s Blocklisted, skipping",
dev->device.name);
TAILQ_REMOVE(&rte_fslmc_bus.device_list, dev, next);
continue;
diff --git a/drivers/bus/pci/pci_common.c b/drivers/bus/pci/pci_common.c
index a8e5fd52c1d0..fe3a02e8049f 100644
--- a/drivers/bus/pci/pci_common.c
+++ b/drivers/bus/pci/pci_common.c
@@ -66,9 +66,8 @@ pci_name_set(struct rte_pci_device *dev)
dev->name, sizeof(dev->name));
devargs = pci_devargs_lookup(&dev->addr);
dev->device.devargs = devargs;
- /* In blacklist mode, if the device is not blacklisted, no
- * rte_devargs exists for it.
- */
+
+ /* If the device is blocked, no rte_devargs exists for it. */
if (devargs != NULL)
/* If an rte_devargs exists, the generic rte_device uses the
* given name as its name.
@@ -132,7 +131,7 @@ rte_pci_probe_one_driver(struct rte_pci_driver *dr,
loc = &dev->addr;
- /* The device is not blacklisted; Check if driver supports it */
+ /* The device is not blocked; Check if driver supports it */
if (!rte_pci_match(dr, dev))
/* Match of device and driver failed */
return 1;
@@ -141,12 +140,10 @@ rte_pci_probe_one_driver(struct rte_pci_driver *dr,
loc->domain, loc->bus, loc->devid, loc->function,
dev->device.numa_node);
- /* no initialization when blacklisted, return without error */
+ /* no initialization when marked as blocked, return without error */
if (dev->device.devargs != NULL &&
- dev->device.devargs->policy ==
- RTE_DEV_BLACKLISTED) {
- RTE_LOG(INFO, EAL, " Device is blacklisted, not"
- " initializing\n");
+ dev->device.devargs->policy == RTE_DEV_BLOCKED) {
+ RTE_LOG(INFO, EAL, " Device is blocked, not initializing\n");
return 1;
}
@@ -589,14 +586,13 @@ rte_pci_ignore_device(const struct rte_pci_addr *pci_addr)
struct rte_devargs *devargs = pci_devargs_lookup(pci_addr);
switch (rte_pci_bus.bus.conf.scan_mode) {
- case RTE_BUS_SCAN_WHITELIST:
- if (devargs && devargs->policy == RTE_DEV_WHITELISTED)
+ case RTE_BUS_SCAN_ALLOWLIST:
+ if (devargs && devargs->policy == RTE_DEV_ALLOWED)
return false;
break;
case RTE_BUS_SCAN_UNDEFINED:
- case RTE_BUS_SCAN_BLACKLIST:
- if (devargs == NULL ||
- devargs->policy != RTE_DEV_BLACKLISTED)
+ case RTE_BUS_SCAN_BLOCKLIST:
+ if (devargs == NULL || devargs->policy != RTE_DEV_BLOCKED)
return false;
break;
}
diff --git a/drivers/bus/vmbus/vmbus_common.c b/drivers/bus/vmbus/vmbus_common.c
index 4c9ac33ac6e4..b31678ad0564 100644
--- a/drivers/bus/vmbus/vmbus_common.c
+++ b/drivers/bus/vmbus/vmbus_common.c
@@ -101,7 +101,7 @@ vmbus_probe_one_driver(struct rte_vmbus_driver *dr,
VMBUS_LOG(INFO, "VMBUS device %s on NUMA socket %i",
guid, dev->device.numa_node);
- /* TODO add blacklisted */
+ /* TODO add block/allow logic */
/* map resources for device */
ret = rte_vmbus_map_device(dev);
@@ -177,7 +177,7 @@ rte_vmbus_probe(void)
rte_uuid_unparse(dev->device_id, ubuf, sizeof(ubuf));
- /* TODO: add whitelist/blacklist */
+ /* TODO: add allowlist/blocklist */
if (vmbus_probe_all_drivers(dev) < 0) {
VMBUS_LOG(NOTICE,
diff --git a/drivers/crypto/virtio/virtio_pci.c b/drivers/crypto/virtio/virtio_pci.c
index f490f6e28960..ae069794a683 100644
--- a/drivers/crypto/virtio/virtio_pci.c
+++ b/drivers/crypto/virtio/virtio_pci.c
@@ -438,7 +438,7 @@ virtio_read_caps(struct rte_pci_device *dev, struct virtio_crypto_hw *hw)
* Return -1:
* if there is error mapping with VFIO/UIO.
* if port map error when driver type is KDRV_NONE.
- * if whitelisted but driver type is KDRV_UNKNOWN.
+ * if marked as allowed but driver type is KDRV_UNKNOWN.
* Return 1 if kernel driver is managing the device.
* Return 0 on success.
*/
diff --git a/drivers/net/fm10k/fm10k_ethdev.c b/drivers/net/fm10k/fm10k_ethdev.c
index b574693bca48..389ad5995040 100644
--- a/drivers/net/fm10k/fm10k_ethdev.c
+++ b/drivers/net/fm10k/fm10k_ethdev.c
@@ -3083,7 +3083,7 @@ eth_fm10k_dev_init(struct rte_eth_dev *dev)
hw->hw_addr = (void *)pdev->mem_resource[0].addr;
if (hw->hw_addr == NULL) {
PMD_INIT_LOG(ERR, "Bad mem resource."
- " Try to blacklist unused devices.");
+ " Try to blocklist unused devices.");
return -EIO;
}
diff --git a/drivers/net/virtio/virtio_pci.c b/drivers/net/virtio/virtio_pci.c
index 29a354bf76df..5bec1fb6aa27 100644
--- a/drivers/net/virtio/virtio_pci.c
+++ b/drivers/net/virtio/virtio_pci.c
@@ -682,7 +682,7 @@ virtio_read_caps(struct rte_pci_device *dev, struct virtio_hw *hw)
* Return -1:
* if there is error mapping with VFIO/UIO.
* if port map error when driver type is KDRV_NONE.
- * if whitelisted but driver type is KDRV_UNKNOWN.
+ * if marked as allowed but driver type is KDRV_UNKNOWN.
* Return 1 if kernel driver is managing the device.
* Return 0 on success.
*/
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 06/11] eal: replace pci-whitelist/pci-blacklist options
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (4 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 05/11] drivers: replace references to blacklist Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 07/11] doc: replace references to blacklist/whitelist Stephen Hemminger
` (5 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
Replace pci-whitelist with pci-include and pci-blacklist with
pci-exclude. Allow the old options for now, but print a nag
warning since old options are deprecated.
The old -b and -w options will be removed in later release.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
lib/librte_eal/common/eal_common_options.c | 59 ++++++++++++++--------
lib/librte_eal/common/eal_options.h | 8 ++-
2 files changed, 44 insertions(+), 23 deletions(-)
diff --git a/lib/librte_eal/common/eal_common_options.c b/lib/librte_eal/common/eal_common_options.c
index a5426e12346a..5b2e85aa5f08 100644
--- a/lib/librte_eal/common/eal_common_options.c
+++ b/lib/librte_eal/common/eal_common_options.c
@@ -51,18 +51,20 @@
const char
eal_short_options[] =
- "b:" /* pci-blacklist */
+ "b:" /* deprecated */
"c:" /* coremask */
"s:" /* service coremask */
"d:" /* driver */
"h" /* help */
+ "i:" /* pci-include */
"l:" /* corelist */
"S:" /* service corelist */
"m:" /* memory size */
"n:" /* memory channels */
"r:" /* memory ranks */
"v" /* version */
- "w:" /* pci-whitelist */
+ "x:" /* pci-exclude */
+ "w:" /* deprecated */
;
const struct option
@@ -87,8 +89,8 @@ eal_long_options[] = {
{OPT_NO_PCI, 0, NULL, OPT_NO_PCI_NUM },
{OPT_NO_SHCONF, 0, NULL, OPT_NO_SHCONF_NUM },
{OPT_IN_MEMORY, 0, NULL, OPT_IN_MEMORY_NUM },
- {OPT_PCI_BLACKLIST, 1, NULL, OPT_PCI_BLACKLIST_NUM },
- {OPT_PCI_WHITELIST, 1, NULL, OPT_PCI_WHITELIST_NUM },
+ {OPT_PCI_EXCLUDE, 1, NULL, OPT_PCI_EXCLUDE_NUM },
+ {OPT_PCI_INCLUDE, 1, NULL, OPT_PCI_INCLUDE_NUM },
{OPT_PROC_TYPE, 1, NULL, OPT_PROC_TYPE_NUM },
{OPT_SOCKET_MEM, 1, NULL, OPT_SOCKET_MEM_NUM },
{OPT_SOCKET_LIMIT, 1, NULL, OPT_SOCKET_LIMIT_NUM },
@@ -102,6 +104,11 @@ eal_long_options[] = {
{OPT_MATCH_ALLOCATIONS, 0, NULL, OPT_MATCH_ALLOCATIONS_NUM},
{OPT_TELEMETRY, 0, NULL, OPT_TELEMETRY_NUM },
{OPT_NO_TELEMETRY, 0, NULL, OPT_NO_TELEMETRY_NUM },
+
+ /* legacy options that will be removed in next LTS */
+ {OPT_PCI_BLACKLIST, 1, NULL, OPT_PCI_BLACKLIST_NUM },
+ {OPT_PCI_WHITELIST, 1, NULL, OPT_PCI_WHITELIST_NUM },
+
{0, 0, NULL, 0 }
};
@@ -1414,29 +1421,36 @@ int
eal_parse_common_option(int opt, const char *optarg,
struct internal_config *conf)
{
- static int b_used;
- static int w_used;
+ static bool x_used, i_used;
switch (opt) {
- /* blacklist */
+ /* deprecated option */
case 'b':
- if (w_used)
- goto bw_used;
- if (eal_option_device_add(RTE_DEVTYPE_BLACKLISTED_PCI,
+ fprintf(stderr, "Option -b, --blacklist is deprecated, use -x, --pci-exclude option instead\n");
+ /* fallthrough */
+ case 'x':
+ /* excluded list */
+ if (i_used)
+ goto include_exclude;
+ if (eal_option_device_add(RTE_DEVTYPE_BLOCKED_PCI,
optarg) < 0) {
return -1;
}
- b_used = 1;
+ x_used = true;
break;
- /* whitelist */
+
case 'w':
- if (b_used)
- goto bw_used;
- if (eal_option_device_add(RTE_DEVTYPE_WHITELISTED_PCI,
+ fprintf(stderr, "Option -w, --whitelist is deprecated, use -i, --pci-include option instead\n");
+ /* fallthrough */
+ case 'i':
+ /* include device list */
+ if (x_used)
+ goto include_exclude;
+ if (eal_option_device_add(RTE_DEVTYPE_ALLOWED_PCI,
optarg) < 0) {
return -1;
}
- w_used = 1;
+ i_used = true;
break;
/* coremask */
case 'c': {
@@ -1715,9 +1729,10 @@ eal_parse_common_option(int opt, const char *optarg,
}
return 0;
-bw_used:
- RTE_LOG(ERR, EAL, "Options blacklist (-b) and whitelist (-w) "
- "cannot be used at the same time\n");
+
+include_exclude:
+ RTE_LOG(ERR, EAL,
+ "Options include (-i) and exclude (-x) can't be used at the same time\n");
return -1;
}
@@ -1926,14 +1941,14 @@ eal_common_usage(void)
" -n CHANNELS Number of memory channels\n"
" -m MB Memory to allocate (see also --"OPT_SOCKET_MEM")\n"
" -r RANKS Force number of memory ranks (don't detect)\n"
- " -b, --"OPT_PCI_BLACKLIST" Add a PCI device in black list.\n"
+ " -x, --"OPT_PCI_EXCLUDE" Add a PCI device in excluded list.\n"
" Prevent EAL from using this PCI device. The argument\n"
" format is <domain:bus:devid.func>.\n"
- " -w, --"OPT_PCI_WHITELIST" Add a PCI device in white list.\n"
+ " -i, --"OPT_PCI_INCLUDE" Add a PCI device in included list.\n"
" Only use the specified PCI devices. The argument format\n"
" is <[domain:]bus:devid.func>. This option can be present\n"
" several times (once per device).\n"
- " [NOTE: PCI whitelist cannot be used with -b option]\n"
+ " [NOTE: " OPT_PCI_INCLUDE " cannot be used with "OPT_PCI_EXCLUDE" option]\n"
" --"OPT_VDEV" Add a virtual device.\n"
" The argument format is <driver><id>[,key=val,...]\n"
" (ex: --vdev=net_pcap0,iface=eth2).\n"
diff --git a/lib/librte_eal/common/eal_options.h b/lib/librte_eal/common/eal_options.h
index 89769d48b487..c3c4d874122c 100644
--- a/lib/librte_eal/common/eal_options.h
+++ b/lib/librte_eal/common/eal_options.h
@@ -13,11 +13,17 @@ enum {
/* long options mapped to a short option */
#define OPT_HELP "help"
OPT_HELP_NUM = 'h',
+#define OPT_PCI_INCLUDE "pci-include"
+ OPT_PCI_INCLUDE_NUM = 'i',
+#define OPT_PCI_EXCLUDE "pci-exclude"
+ OPT_PCI_EXCLUDE_NUM = 'x',
+
+ /* legacy options that will be removed in next LTS */
#define OPT_PCI_BLACKLIST "pci-blacklist"
OPT_PCI_BLACKLIST_NUM = 'b',
#define OPT_PCI_WHITELIST "pci-whitelist"
OPT_PCI_WHITELIST_NUM = 'w',
-
+
/* first long only option value must be >= 256, so that we won't
* conflict with short options */
OPT_LONG_MIN_NUM = 256,
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 07/11] doc: replace references to blacklist/whitelist
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (5 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 06/11] eal: replace pci-whitelist/pci-blacklist options Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 08/11] app/test: use new allowlist and blocklist Stephen Hemminger
` (4 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
The terms blacklist and whitelist are no longer used.
Replace them in the documentation.
Most of this was automatic replacement, but in a couple of
places the language was awkward before and have tried to improve
the readabilty.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
doc/guides/cryptodevs/dpaa2_sec.rst | 4 ++--
doc/guides/cryptodevs/dpaa_sec.rst | 4 ++--
doc/guides/cryptodevs/qat.rst | 4 ++--
doc/guides/freebsd_gsg/build_sample_apps.rst | 2 +-
doc/guides/linux_gsg/build_sample_apps.rst | 2 +-
doc/guides/linux_gsg/eal_args.include.rst | 14 +++++++-------
doc/guides/nics/bnxt.rst | 6 +++---
doc/guides/nics/cxgbe.rst | 4 ++--
doc/guides/nics/dpaa.rst | 4 ++--
doc/guides/nics/dpaa2.rst | 4 ++--
doc/guides/nics/enic.rst | 6 +++---
doc/guides/nics/fail_safe.rst | 14 +++++++-------
doc/guides/nics/features.rst | 2 +-
doc/guides/nics/ice.rst | 2 +-
doc/guides/nics/mlx4.rst | 6 +++---
doc/guides/nics/mlx5.rst | 2 +-
doc/guides/nics/sfc_efx.rst | 2 +-
doc/guides/nics/tap.rst | 2 +-
doc/guides/prog_guide/env_abstraction_layer.rst | 7 +++----
doc/guides/prog_guide/multi_proc_support.rst | 4 ++--
doc/guides/rel_notes/known_issues.rst | 4 ++--
doc/guides/rel_notes/release_2_1.rst | 2 +-
doc/guides/sample_app_ug/bbdev_app.rst | 6 +++---
doc/guides/sample_app_ug/ipsec_secgw.rst | 4 ++--
doc/guides/sample_app_ug/l3_forward.rst | 2 +-
.../sample_app_ug/l3_forward_access_ctrl.rst | 2 +-
26 files changed, 57 insertions(+), 58 deletions(-)
diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst b/doc/guides/cryptodevs/dpaa2_sec.rst
index 3053636b8295..363c52f0422f 100644
--- a/doc/guides/cryptodevs/dpaa2_sec.rst
+++ b/doc/guides/cryptodevs/dpaa2_sec.rst
@@ -134,10 +134,10 @@ Supported DPAA2 SoCs
* LS2088A/LS2048A
* LS1088A/LS1048A
-Whitelisting & Blacklisting
+Allowlisting & Blocklisting
---------------------------
-For blacklisting a DPAA2 SEC device, following commands can be used.
+The DPAA2 SEC device can be blocked with the following:
.. code-block:: console
diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst
index db3c8e918945..295164523d22 100644
--- a/doc/guides/cryptodevs/dpaa_sec.rst
+++ b/doc/guides/cryptodevs/dpaa_sec.rst
@@ -82,10 +82,10 @@ Supported DPAA SoCs
* LS1046A/LS1026A
* LS1043A/LS1023A
-Whitelisting & Blacklisting
+Allowlisting & Blocklisting
---------------------------
-For blacklisting a DPAA device, following commands can be used.
+For blocking a DPAA device, following commands can be used.
.. code-block:: console
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 7f4036c3210e..423de7bf79d2 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -126,7 +126,7 @@ Limitations
optimisations in the GEN3 device. And if a GCM session is initialised on a
GEN3 device, then attached to an op sent to a GEN1/GEN2 device, it will not be
enqueued to the device and will be marked as failed. The simplest way to
- mitigate this is to use the bdf whitelist to avoid mixing devices of different
+ mitigate this is to use the bdf allowlist to avoid mixing devices of different
generations in the same process if planning to use for GCM.
* The mixed algo feature on GEN2 is not supported by all kernel drivers. Check
the notes under the Available Kernel Drivers table below for specific details.
@@ -261,7 +261,7 @@ adjusted to the number of VFs which the QAT common code will need to handle.
QAT VF may expose two crypto devices, sym and asym, it may happen that the
number of devices will be bigger than MAX_DEVS and the process will show an error
during PMD initialisation. To avoid this problem CONFIG_RTE_CRYPTO_MAX_DEVS may be
- increased or -w, pci-whitelist domain:bus:devid:func option may be used.
+ increased or -w, pci-allowlist domain:bus:devid:func option may be used.
QAT compression PMD needs intermediate buffers to support Deflate compression
diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst
index 2a68f5fc3820..4fba671e4f5b 100644
--- a/doc/guides/freebsd_gsg/build_sample_apps.rst
+++ b/doc/guides/freebsd_gsg/build_sample_apps.rst
@@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows:
is a list of cores to use instead of a core mask.
* ``-b <domain:bus:devid.func>``:
- Blacklisting of ports; prevent EAL from using specified PCI device
+ Blocklisting of ports; prevent EAL from using specified PCI device
(multiple ``-b`` options are allowed).
* ``--use-device``:
diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
index 2f606535c374..ebc6e3e02d74 100644
--- a/doc/guides/linux_gsg/build_sample_apps.rst
+++ b/doc/guides/linux_gsg/build_sample_apps.rst
@@ -102,7 +102,7 @@ The EAL options are as follows:
Number of memory channels per processor socket.
* ``-b <domain:bus:devid.func>``:
- Blacklisting of ports; prevent EAL from using specified PCI device
+ Blocklisting of ports; prevent EAL from using specified PCI device
(multiple ``-b`` options are allowed).
* ``--use-device``:
diff --git a/doc/guides/linux_gsg/eal_args.include.rst b/doc/guides/linux_gsg/eal_args.include.rst
index 0fe44579689b..41f399ccd608 100644
--- a/doc/guides/linux_gsg/eal_args.include.rst
+++ b/doc/guides/linux_gsg/eal_args.include.rst
@@ -44,20 +44,20 @@ Lcore-related options
Device-related options
~~~~~~~~~~~~~~~~~~~~~~
-* ``-b, --pci-blacklist <[domain:]bus:devid.func>``
+* ``-b, --pci-skip-probe <[domain:]bus:devid.func>``
- Blacklist a PCI device to prevent EAL from using it. Multiple -b options are
- allowed.
+ Skip probing a PCI device to prevent EAL from using it.
+ Multiple -b options are allowed.
.. Note::
- PCI blacklist cannot be used with ``-w`` option.
+ PCI skip probe cannot be used with the only list ``-w`` option.
-* ``-w, --pci-whitelist <[domain:]bus:devid.func>``
+* ``-w, --pci-only-list <[domain:]bus:devid.func>``
- Add a PCI device in white list.
+ Add a PCI device in to the list of probed devices.
.. Note::
- PCI whitelist cannot be used with ``-b`` option.
+ PCI only list cannot be used with the skip probe ``-b`` option.
* ``--vdev <device arguments>``
diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
index 6ff75d0a25e9..716d02beba3c 100644
--- a/doc/guides/nics/bnxt.rst
+++ b/doc/guides/nics/bnxt.rst
@@ -259,7 +259,7 @@ Unicast MAC Filter
^^^^^^^^^^^^^^^^^^
The application adds (or removes) MAC addresses to enable (or disable)
-whitelist filtering to accept packets.
+allowlist filtering to accept packets.
.. code-block:: console
@@ -270,7 +270,7 @@ Multicast MAC Filter
^^^^^^^^^^^^^^^^^^^^
Application adds (or removes) Multicast addresses to enable (or disable)
-whitelist filtering to accept packets.
+allowlist filtering to accept packets.
.. code-block:: console
@@ -278,7 +278,7 @@ whitelist filtering to accept packets.
testpmd> mcast_addr (add|remove) (port_id) (XX:XX:XX:XX:XX:XX)
Application adds (or removes) Multicast addresses to enable (or disable)
-whitelist filtering to accept packets.
+allowlist filtering to accept packets.
Note that the BNXT PMD supports up to 16 MC MAC filters. if the user adds more
than 16 MC MACs, the BNXT PMD puts the port into the Allmulticast mode.
diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
index 54a4c138998c..9aabf346060b 100644
--- a/doc/guides/nics/cxgbe.rst
+++ b/doc/guides/nics/cxgbe.rst
@@ -40,8 +40,8 @@ expose a single PCI bus address, thus, librte_pmd_cxgbe registers
itself as a PCI driver that allocates one Ethernet device per detected
port.
-For this reason, one cannot whitelist/blacklist a single port without
-whitelisting/blacklisting the other ports on the same device.
+For this reason, one cannot allowlist/blocklist a single port without
+allowlisting/blocklisting the other ports on the same device.
.. _t5-nics:
diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst
index 17839a920e60..efcbb7207734 100644
--- a/doc/guides/nics/dpaa.rst
+++ b/doc/guides/nics/dpaa.rst
@@ -162,10 +162,10 @@ Manager.
this pool.
-Whitelisting & Blacklisting
+Allowlisting & Blocklisting
---------------------------
-For blacklisting a DPAA device, following commands can be used.
+For blocking a DPAA device, following commands can be used.
.. code-block:: console
diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
index fdfa6fdd5aea..91b5c59f8c0f 100644
--- a/doc/guides/nics/dpaa2.rst
+++ b/doc/guides/nics/dpaa2.rst
@@ -527,10 +527,10 @@ which are lower than logging ``level``.
Using ``pmd.net.dpaa2`` as log matching criteria, all PMD logs can be enabled
which are lower than logging ``level``.
-Whitelisting & Blacklisting
+Allowlisting & Blocklisting
---------------------------
-For blacklisting a DPAA2 device, following commands can be used.
+For blocking a DPAA2 device, following commands can be used.
.. code-block:: console
diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index a28a7f4e477a..69bcfd5c8576 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -187,14 +187,14 @@ or ``vfio`` in non-IOMMU mode.
In the VM, the kernel enic driver may be automatically bound to the VF during
boot. Unbinding it currently hangs due to a known issue with the driver. To
-work around the issue, blacklist the enic module as follows.
+work around the issue, blocklist the enic module as follows.
Please see :ref:`Limitations <enic_limitations>` for limitations in
the use of SR-IOV.
.. code-block:: console
# cat /etc/modprobe.d/enic.conf
- blacklist enic
+ blocklist enic
# dracut --force
@@ -437,7 +437,7 @@ PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the
- VF devices are not usable directly from the host. They can only be used
as assigned devices on VM instances.
- Currently, unbind of the ENIC kernel mode driver 'enic.ko' on the VM
- instance may hang. As a workaround, enic.ko should be blacklisted or removed
+ instance may hang. As a workaround, enic.ko should be blocklisted or removed
from the boot process.
- pci_generic cannot be used as the uio module in the VM. igb_uio or
vfio in non-IOMMU mode can be used.
diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst
index b4a92f663b17..01ad66bec774 100644
--- a/doc/guides/nics/fail_safe.rst
+++ b/doc/guides/nics/fail_safe.rst
@@ -68,11 +68,11 @@ Fail-safe command line parameters
.. note::
- In case where the sub-device is also used as a whitelist device, using ``-w``
+ In case where the sub-device is also used as a allowlist device, using ``-w``
on the EAL command line, the fail-safe PMD will use the device with the
options provided to the EAL instead of its own parameters.
- When trying to use a PCI device automatically probed by the blacklist mode,
+ When trying to use a PCI device automatically probed by the blocklist mode,
the name for the fail-safe sub-device must be the full PCI id:
Domain:Bus:Device.Function, *i.e.* ``00:00:00.0`` instead of ``00:00.0``,
as the second form is historically accepted by the DPDK.
@@ -123,8 +123,8 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
#. To build a PMD and configure DPDK, refer to the document
:ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`.
-#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL
- operations to avoid probing it twice, as the PCI bus is in blacklist mode.
+#. Start testpmd. The sub-device ``84:00.0`` should be blocklisted from normal EAL
+ operations to avoid probing it twice, as the PCI bus is in blocklist mode.
.. code-block:: console
@@ -132,13 +132,13 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
--vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
-b 84:00.0 -b 00:04.0 -- -i
- If the sub-device ``84:00.0`` is not blacklisted, it will be probed by the
+ If the sub-device ``84:00.0`` is not blocklisted, it will be probed by the
EAL first. When the fail-safe then tries to initialize it the probe operation
fails.
- Note that PCI blacklist mode is the default PCI operating mode.
+ Note that PCI blocklist mode is the default PCI operating mode.
-#. Alternatively, it can be used alongside any other device in whitelist mode.
+#. Alternatively, it can be used alongside any other device in allowlist mode.
.. code-block:: console
diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index edd21c4d8e9d..6aecead6e019 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -247,7 +247,7 @@ Supports enabling/disabling receiving multicast frames.
Unicast MAC filter
------------------
-Supports adding MAC addresses to enable whitelist filtering to accept packets.
+Supports adding MAC addresses to enable allowlist filtering to accept packets.
* **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``.
* **[implements] rte_eth_dev_data**: ``mac_addrs``.
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 9a9f4a6bb093..865718fb83cd 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -61,7 +61,7 @@ Runtime Config Options
In pipeline mode, a flow can be set at one specific stage by setting parameter
``priority``. Currently, we support two stages: priority = 0 or !0. Flows with
priority 0 located at the first pipeline stage which typically be used as a firewall
- to drop the packet on a blacklist(we called it permission stage). At this stage,
+ to drop the packet on a blocklist(we called it permission stage). At this stage,
flow rules are created for the device's exact match engine: switch. Flows with priority
!0 located at the second stage, typically packets are classified here and be steered to
specific queue or queue group (we called it distribution stage), At this stage, flow
diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index 1f1e2f6c7767..dfdccb4aab7c 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -29,8 +29,8 @@ Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI
bus address, thus unlike most drivers, librte_pmd_mlx4 registers itself as a
PCI driver that allocates one Ethernet device per detected port.
-For this reason, one cannot white/blacklist a single port without also
-white/blacklisting the others on the same device.
+For this reason, one cannot white/blocklist a single port without also
+white/blocklisting the others on the same device.
Besides its dependency on libibverbs (that implies libmlx4 and associated
kernel support), librte_pmd_mlx4 relies heavily on system calls for control
@@ -422,7 +422,7 @@ devices managed by librte_pmd_mlx4.
eth4
eth5
-#. Optionally, retrieve their PCI bus addresses for whitelisting::
+#. Optionally, retrieve their PCI bus addresses for allowlisting::
{
for intf in eth2 eth3 eth4 eth5;
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 4b6d8fb4d55b..254a25e95f9a 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1454,7 +1454,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
eth32
eth33
-#. Optionally, retrieve their PCI bus addresses for whitelisting::
+#. Optionally, retrieve their PCI bus addresses for allowlisting::
{
for intf in eth2 eth3 eth4 eth5;
diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst
index be1c2fe1d67e..44115a666a94 100644
--- a/doc/guides/nics/sfc_efx.rst
+++ b/doc/guides/nics/sfc_efx.rst
@@ -290,7 +290,7 @@ Per-Device Parameters
~~~~~~~~~~~~~~~~~~~~~
The following per-device parameters can be passed via EAL PCI device
-whitelist option like "-w 02:00.0,arg1=value1,...".
+allowlist option like "-w 02:00.0,arg1=value1,...".
Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
boolean parameters value.
diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst
index 7e44f846206c..0e726bf87f73 100644
--- a/doc/guides/nics/tap.rst
+++ b/doc/guides/nics/tap.rst
@@ -191,7 +191,7 @@ following::
.. Note:
- Change the ``-b`` options to blacklist all of your physical ports. The
+ Change the ``-b`` options to blocklist all of your physical ports. The
following command line is all one line.
Also, ``-f themes/black-yellow.theme`` is optional if the default colors
diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index f64ae953d106..5965c15baa43 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -407,12 +407,11 @@ device having emitted a Device Removal Event. In such case, calling
callback. Care must be taken not to close the device from the interrupt handler
context. It is necessary to reschedule such closing operation.
-Blacklisting
+Blocklisting
~~~~~~~~~~~~
-The EAL PCI device blacklist functionality can be used to mark certain NIC ports as blacklisted,
-so they are ignored by the DPDK.
-The ports to be blacklisted are identified using the PCIe* description (Domain:Bus:Device.Function).
+The EAL PCI device blocklist functionality can be used to mark certain NIC ports as unavailale, so they are ignored by the DPDK.
+The ports to be blocklisted are identified using the PCIe* description (Domain:Bus:Device.Function).
Misc Functions
~~~~~~~~~~~~~~
diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index a84083b96c8a..14cb6db85661 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -30,7 +30,7 @@ after a primary process has already configured the hugepage shared memory for th
Secondary processes should run alongside primary process with same DPDK version.
Secondary processes which requires access to physical devices in Primary process, must
- be passed with the same whitelist and blacklist options.
+ be passed with the same allowlist and blocklist options.
To support these two process types, and other multi-process setups described later,
two additional command-line parameters are available to the EAL:
@@ -131,7 +131,7 @@ can use).
.. note::
Independent DPDK instances running side-by-side on a single machine cannot share any network ports.
- Any network ports being used by one process should be blacklisted in every other process.
+ Any network ports being used by one process should be blocklisted in every other process.
Running Multiple Independent Groups of DPDK Applications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst
index de0782136d3c..83a3b38c0ae0 100644
--- a/doc/guides/rel_notes/known_issues.rst
+++ b/doc/guides/rel_notes/known_issues.rst
@@ -523,8 +523,8 @@ Devices bound to igb_uio with VT-d enabled do not work on Linux kernel 3.15-3.17
DMAR:[fault reason 02] Present bit in context entry is clear
**Resolution/Workaround**:
- Use earlier or later kernel versions, or avoid driver binding on boot by blacklisting the driver modules.
- I.e., in the case of ``ixgbe``, we can pass the kernel command line option: ``modprobe.blacklist=ixgbe``.
+ Use earlier or later kernel versions, or avoid driver binding on boot by blocklisting the driver modules.
+ I.e., in the case of ``ixgbe``, we can pass the kernel command line option: ``modprobe.blocklist=ixgbe``.
This way we do not need to unbind the device to bind it to igb_uio.
**Affected Environment/Platform**:
diff --git a/doc/guides/rel_notes/release_2_1.rst b/doc/guides/rel_notes/release_2_1.rst
index beadc51ba438..6339172c64fa 100644
--- a/doc/guides/rel_notes/release_2_1.rst
+++ b/doc/guides/rel_notes/release_2_1.rst
@@ -472,7 +472,7 @@ Resolved Issues
* **devargs: Fix crash on failure.**
- This problem occurred when passing an invalid PCI id to the blacklist API in
+ This problem occurred when passing an invalid PCI id to the blocklist API in
devargs.
diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst
index 405e706a46e4..b722d0263772 100644
--- a/doc/guides/sample_app_ug/bbdev_app.rst
+++ b/doc/guides/sample_app_ug/bbdev_app.rst
@@ -79,7 +79,7 @@ This means that HW baseband device/s must be bound to a DPDK driver or
a SW baseband device/s (virtual BBdev) must be created (using --vdev).
To run the application in linux environment with the turbo_sw baseband device
-using the whitelisted port running on 1 encoding lcore and 1 decoding lcore
+using the allowlisted port running on 1 encoding lcore and 1 decoding lcore
issue the command:
.. code-block:: console
@@ -90,7 +90,7 @@ issue the command:
where, NIC0PCIADDR is the PCI address of the Rx port
This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the
-device gets linked to a corresponding ethernet port as whitelisted by
+device gets linked to a corresponding ethernet port as allowlisted by
the parameter -w.
3 cores are allocated to the application, and assigned as:
@@ -111,7 +111,7 @@ Using Packet Generator with baseband device sample application
To allow the bbdev sample app to do the loopback, an influx of traffic is required.
This can be done by using DPDK Pktgen to burst traffic on two ethernet ports, and
it will print the transmitted along with the looped-back traffic on Rx ports.
-Executing the command below will generate traffic on the two whitelisted ethernet
+Executing the command below will generate traffic on the two allowlisted ethernet
ports.
.. code-block:: console
diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst
index 81c5d4360615..bf1aefc0e120 100644
--- a/doc/guides/sample_app_ug/ipsec_secgw.rst
+++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
@@ -329,8 +329,8 @@ This means that if the application is using a single core and both hardware
and software crypto devices are detected, hardware devices will be used.
A way to achieve the case where you want to force the use of virtual crypto
-devices is to whitelist the Ethernet devices needed and therefore implicitly
-blacklisting all hardware crypto devices.
+devices is to allowlist the Ethernet devices needed and therefore implicitly
+blocklisting all hardware crypto devices.
For example, something like the following command line:
diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst
index 07c8d44936d6..69a29ab1314e 100644
--- a/doc/guides/sample_app_ug/l3_forward.rst
+++ b/doc/guides/sample_app_ug/l3_forward.rst
@@ -148,7 +148,7 @@ or
In this command:
-* -w option whitelist the event device supported by platform. Way to pass this device may vary based on platform.
+* -w option allowlist the event device supported by platform. Way to pass this device may vary based on platform.
* The --mode option defines PMD to be used for packet I/O.
diff --git a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
index a44fbcd52c3a..473326275e49 100644
--- a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
+++ b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
@@ -18,7 +18,7 @@ The application loads two types of rules at initialization:
* Route information rules, which are used for L3 forwarding
-* Access Control List (ACL) rules that blacklist (or block) packets with a specific characteristic
+* Access Control List (ACL) rules that blocklist (or block) packets with a specific characteristic
When packets are received from a port,
the application extracts the necessary information from the TCP/IP header of the received packet and
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 08/11] app/test: use new allowlist and blocklist
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (6 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 07/11] doc: replace references to blacklist/whitelist Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 09/11] doc: add note about blacklist/whitelist changes Stephen Hemminger
` (3 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
Test the renamed pci-blocklist and pci-allowlist arguments.
Use new terms in test variable names as well.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
app/test/autotest.py | 16 ++++++------
app/test/autotest_runner.py | 18 ++++++-------
app/test/test.c | 2 +-
app/test/test_eal_flags.c | 52 ++++++++++++++++++-------------------
4 files changed, 44 insertions(+), 44 deletions(-)
diff --git a/app/test/autotest.py b/app/test/autotest.py
index b42f48879cc2..14b39a2e3347 100644
--- a/app/test/autotest.py
+++ b/app/test/autotest.py
@@ -11,7 +11,7 @@
def usage():
print("Usage: autotest.py [test app|test iso image] ",
- "[target] [whitelist|-blacklist]")
+ "[target] [allowlist|-blocklist]")
if len(sys.argv) < 3:
usage()
@@ -19,18 +19,18 @@ def usage():
target = sys.argv[2]
-test_whitelist = None
-test_blacklist = None
+test_allowlist = None
+test_blocklist = None
-# get blacklist/whitelist
+# get blocklist/allowlist
if len(sys.argv) > 3:
testlist = sys.argv[3].split(',')
testlist = [test.lower() for test in testlist]
if testlist[0].startswith('-'):
testlist[0] = testlist[0].lstrip('-')
- test_blacklist = testlist
+ test_blocklist = testlist
else:
- test_whitelist = testlist
+ test_allowlist = testlist
cmdline = "%s -c f" % (sys.argv[1])
@@ -40,8 +40,8 @@ def usage():
# processes, so make it 1, otherwise make it 4. ignored for non-parallel tests
n_processes = 1 if "bsd" in target else 4
-runner = autotest_runner.AutotestRunner(cmdline, target, test_blacklist,
- test_whitelist, n_processes)
+runner = autotest_runner.AutotestRunner(cmdline, target, test_blocklist,
+ test_allowlist, n_processes)
runner.parallel_tests = autotest_data.parallel_test_list[:]
runner.non_parallel_tests = autotest_data.non_parallel_test_list[:]
diff --git a/app/test/autotest_runner.py b/app/test/autotest_runner.py
index 95e74c760dba..72180a172553 100644
--- a/app/test/autotest_runner.py
+++ b/app/test/autotest_runner.py
@@ -193,14 +193,14 @@ class AutotestRunner:
n_tests = 0
fails = 0
log_buffers = []
- blacklist = []
- whitelist = []
+ blocklist = []
+ allowlist = []
- def __init__(self, cmdline, target, blacklist, whitelist, n_processes):
+ def __init__(self, cmdline, target, blocklist, allowlist, n_processes):
self.cmdline = cmdline
self.target = target
- self.blacklist = blacklist
- self.whitelist = whitelist
+ self.blocklist = blocklist
+ self.allowlist = allowlist
self.skipped = []
self.parallel_tests = []
self.non_parallel_tests = []
@@ -274,7 +274,7 @@ def __process_result(self, result):
self.csvwriter.writerow([test_name, test_result, result_str])
# this function checks individual test and decides if this test should be in
- # the group by comparing it against whitelist/blacklist. it also checks if
+ # the group by comparing it against allowlist/blocklist. it also checks if
# the test is compiled into the binary, and marks it as skipped if necessary
def __filter_test(self, test):
test_cmd = test["Command"]
@@ -284,10 +284,10 @@ def __filter_test(self, test):
if "_autotest" in test_id:
test_id = test_id[:-len("_autotest")]
- # filter out blacklisted/whitelisted tests
- if self.blacklist and test_id in self.blacklist:
+ # filter out blocklisted/allowlisted tests
+ if self.blocklist and test_id in self.blocklist:
return False
- if self.whitelist and test_id not in self.whitelist:
+ if self.allowlist and test_id not in self.allowlist:
return False
# if test wasn't compiled in, remove it as well
diff --git a/app/test/test.c b/app/test/test.c
index 94d26ab1f67c..13253ccee0bb 100644
--- a/app/test/test.c
+++ b/app/test/test.c
@@ -61,7 +61,7 @@ do_recursive_call(void)
{ "test_master_lcore_flag", no_action },
{ "test_invalid_n_flag", no_action },
{ "test_no_hpet_flag", no_action },
- { "test_whitelist_flag", no_action },
+ { "test_allowlist_flag", no_action },
{ "test_invalid_b_flag", no_action },
{ "test_invalid_vdev_flag", no_action },
{ "test_invalid_r_flag", no_action },
diff --git a/app/test/test_eal_flags.c b/app/test/test_eal_flags.c
index 4ee809e3db2e..37807d10931d 100644
--- a/app/test/test_eal_flags.c
+++ b/app/test/test_eal_flags.c
@@ -30,7 +30,7 @@
#define no_hpet "--no-hpet"
#define no_huge "--no-huge"
#define no_shconf "--no-shconf"
-#define pci_whitelist "--pci-whitelist"
+#define pci_allowlist "--pci-allowlist"
#define vdev "--vdev"
#define memtest "memtest"
#define memtest1 "memtest1"
@@ -223,12 +223,12 @@ get_number_of_sockets(void)
#endif
/*
- * Test that the app doesn't run with invalid whitelist option.
+ * Test that the app doesn't run with invalid allowlist option.
* Final tests ensures it does run with valid options as sanity check (one
* test for with Domain+BDF, second for just with BDF)
*/
static int
-test_whitelist_flag(void)
+test_allowlist_flag(void)
{
unsigned i;
#ifdef RTE_EXEC_ENV_FREEBSD
@@ -245,45 +245,45 @@ test_whitelist_flag(void)
const char *wlinval[][7] = {
{prgname, prefix, mp_flag,
- pci_whitelist, "error", "", ""},
+ pci_allowlist, "error", "", ""},
{prgname, prefix, mp_flag,
- pci_whitelist, "0:0:0", "", ""},
+ pci_allowlist, "0:0:0", "", ""},
{prgname, prefix, mp_flag,
- pci_whitelist, "0:error:0.1", "", ""},
+ pci_allowlist, "0:error:0.1", "", ""},
{prgname, prefix, mp_flag,
- pci_whitelist, "0:0:0.1error", "", ""},
+ pci_allowlist, "0:0:0.1error", "", ""},
{prgname, prefix, mp_flag,
- pci_whitelist, "error0:0:0.1", "", ""},
+ pci_allowlist, "error0:0:0.1", "", ""},
{prgname, prefix, mp_flag,
- pci_whitelist, "0:0:0.1.2", "", ""},
+ pci_allowlist, "0:0:0.1.2", "", ""},
};
- /* Test with valid whitelist option */
+ /* Test with valid allowlist option */
const char *wlval1[] = {prgname, prefix, mp_flag,
- pci_whitelist, "00FF:09:0B.3"};
+ pci_allowlist, "00FF:09:0B.3"};
const char *wlval2[] = {prgname, prefix, mp_flag,
- pci_whitelist, "09:0B.3", pci_whitelist, "0a:0b.1"};
+ pci_allowlist, "09:0B.3", pci_allowlist, "0a:0b.1"};
const char *wlval3[] = {prgname, prefix, mp_flag,
- pci_whitelist, "09:0B.3,type=test",
- pci_whitelist, "08:00.1,type=normal",
+ pci_allowlist, "09:0B.3,type=test",
+ pci_allowlist, "08:00.1,type=normal",
};
for (i = 0; i < RTE_DIM(wlinval); i++) {
if (launch_proc(wlinval[i]) == 0) {
printf("Error - process did run ok with invalid "
- "whitelist parameter\n");
+ "allowlist parameter\n");
return -1;
}
}
if (launch_proc(wlval1) != 0 ) {
- printf("Error - process did not run ok with valid whitelist\n");
+ printf("Error - process did not run ok with valid allowlist\n");
return -1;
}
if (launch_proc(wlval2) != 0 ) {
- printf("Error - process did not run ok with valid whitelist value set\n");
+ printf("Error - process did not run ok with valid allowlist value set\n");
return -1;
}
if (launch_proc(wlval3) != 0 ) {
- printf("Error - process did not run ok with valid whitelist + args\n");
+ printf("Error - process did not run ok with valid allowlist + args\n");
return -1;
}
@@ -291,7 +291,7 @@ test_whitelist_flag(void)
}
/*
- * Test that the app doesn't run with invalid blacklist option.
+ * Test that the app doesn't run with invalid blocklist option.
* Final test ensures it does run with valid options as sanity check
*/
static int
@@ -317,7 +317,7 @@ test_invalid_b_flag(void)
{prgname, prefix, mp_flag, "-b", "error0:0:0.1"},
{prgname, prefix, mp_flag, "-b", "0:0:0.1.2"},
};
- /* Test with valid blacklist option */
+ /* Test with valid blocklist option */
const char *blval[] = {prgname, prefix, mp_flag,
"-b", "FF:09:0B.3"};
@@ -326,12 +326,12 @@ test_invalid_b_flag(void)
for (i = 0; i != RTE_DIM(blinval); i++) {
if (launch_proc(blinval[i]) == 0) {
printf("Error - process did run ok with invalid "
- "blacklist parameter\n");
+ "blocklist parameter\n");
return -1;
}
}
if (launch_proc(blval) != 0) {
- printf("Error - process did not run ok with valid blacklist value\n");
+ printf("Error - process did not run ok with valid blocklist value\n");
return -1;
}
return 0;
@@ -419,7 +419,7 @@ test_invalid_r_flag(void)
{prgname, prefix, mp_flag, "-r", "-1"},
{prgname, prefix, mp_flag, "-r", "17"},
};
- /* Test with valid blacklist option */
+ /* Test with valid blocklist option */
const char *rval[] = {prgname, prefix, mp_flag, "-r", "16"};
int i;
@@ -1489,9 +1489,9 @@ test_eal_flags(void)
return ret;
}
- ret = test_whitelist_flag();
+ ret = test_allowlist_flag();
if (ret < 0) {
- printf("Error in test_invalid_whitelist_flag()\n");
+ printf("Error in test_invalid_allowlist_flag()\n");
return ret;
}
@@ -1543,7 +1543,7 @@ REGISTER_TEST_COMMAND(eal_flags_master_opt_autotest, test_master_lcore_flag);
REGISTER_TEST_COMMAND(eal_flags_n_opt_autotest, test_invalid_n_flag);
REGISTER_TEST_COMMAND(eal_flags_hpet_autotest, test_no_hpet_flag);
REGISTER_TEST_COMMAND(eal_flags_no_huge_autotest, test_no_huge_flag);
-REGISTER_TEST_COMMAND(eal_flags_w_opt_autotest, test_whitelist_flag);
+REGISTER_TEST_COMMAND(eal_flags_w_opt_autotest, test_allowlist_flag);
REGISTER_TEST_COMMAND(eal_flags_b_opt_autotest, test_invalid_b_flag);
REGISTER_TEST_COMMAND(eal_flags_vdev_opt_autotest, test_invalid_vdev_flag);
REGISTER_TEST_COMMAND(eal_flags_r_opt_autotest, test_invalid_r_flag);
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 09/11] doc: add note about blacklist/whitelist changes
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (7 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 08/11] app/test: use new allowlist and blocklist Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 10/11] eal: mark old macros for blacklist/whitelist as deprecated Stephen Hemminger
` (2 subsequent siblings)
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
The blacklist/whitelist changes to API will not be a breaking
change for applications in this release but worth adding a note
to encourage migration.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
doc/guides/rel_notes/release_20_08.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/doc/guides/rel_notes/release_20_08.rst b/doc/guides/rel_notes/release_20_08.rst
index f19b748728e4..b9509f657b30 100644
--- a/doc/guides/rel_notes/release_20_08.rst
+++ b/doc/guides/rel_notes/release_20_08.rst
@@ -261,6 +261,12 @@ API Changes
* vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
queue and not per device, a qid parameter was added to the arguments list.
+* eal: The definitions related to including and excluding devices
+ has been changed from blacklist/whitelist to include/exclude.
+ There are compatiablity macros and command line mapping to accept
+ the old values but applications and scripts are strongly encouraged
+ to migrate to the new names.
+
ABI Changes
-----------
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 10/11] eal: mark old macros for blacklist/whitelist as deprecated
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (8 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 09/11] doc: add note about blacklist/whitelist changes Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 11/11] doc: update examples to new config options Stephen Hemminger
2020-07-14 6:05 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Luca Boccassi
Use of these macros in applications should cause a deprecation
warning.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Luca Boccassi <bluca@debian.org>
---
lib/librte_eal/include/rte_bus.h | 9 +++++++--
lib/librte_eal/include/rte_dev.h | 10 +++++++---
lib/librte_eal/include/rte_devargs.h | 10 +++++++---
3 files changed, 21 insertions(+), 8 deletions(-)
diff --git a/lib/librte_eal/include/rte_bus.h b/lib/librte_eal/include/rte_bus.h
index 19309ad2ddd7..aa0f3aa9c81b 100644
--- a/lib/librte_eal/include/rte_bus.h
+++ b/lib/librte_eal/include/rte_bus.h
@@ -220,8 +220,13 @@ enum rte_bus_scan_mode {
};
/* Backwards compatibility will be deprecated */
-#define RTE_BUS_SCAN_WHITELIST RTE_BUS_SCAN_ALLOWLIST
-#define RTE_BUS_SCAN_BLACKLIST RTE_BUS_SCAN_BLOCKLIST
+#define RTE_BUS_SCAN_WHITELIST \
+ _Pragma("GCC warning \"'RTE_BUS_SCAN_WHITELIST' macro is deprecated.\"") \
+ RTE_BUS_SCAN_ALLOWLIST
+
+#define RTE_BUS_SCAN_BLACKLIST \
+ _Pragma("GCC warning \"'RTE_BUS_SCAN_BLACKLIST' macro is deprecated.\"") \
+ RTE_BUS_SCAN_BLOCKLIST
/**
* A structure used to configure bus operations.
diff --git a/lib/librte_eal/include/rte_dev.h b/lib/librte_eal/include/rte_dev.h
index 1208b1e99b05..81dded1dad24 100644
--- a/lib/librte_eal/include/rte_dev.h
+++ b/lib/librte_eal/include/rte_dev.h
@@ -74,9 +74,13 @@ enum rte_dev_policy {
RTE_DEV_BLOCKED,
};
-/* Backwards compatiablity will be deprecated */
-#define RTE_DEV_WHITELISTED RTE_DEV_ALLOWED
-#define RTE_DEV_BLACKLISTED RTE_DEV_BLOCKED
+#define RTE_DEV_WHITELISTED \
+ _Pragma("GCC warning \"'RTE_DEV_WHITELISTED' macro is deprecated.\"") \
+ RTE_DEV_ALLOWED
+
+#define RTE_DEV_BLACKLISTED \
+ _Pragma("GCC warning \"'RTE_DEV_BLACKLISTED' macro is deprecated.\"") \
+ RTE_DEV_BLOCKED
/**
* A generic memory resource representation.
diff --git a/lib/librte_eal/include/rte_devargs.h b/lib/librte_eal/include/rte_devargs.h
index e1a4277ff167..535bff9a14fb 100644
--- a/lib/librte_eal/include/rte_devargs.h
+++ b/lib/librte_eal/include/rte_devargs.h
@@ -34,9 +34,13 @@ enum rte_devtype {
RTE_DEVTYPE_VIRTUAL,
};
-/* Backwards compatiablity will be removed later */
-#define RTE_DEVTYPE_WHITELISTED_PCI RTE_DEVTYPE_ALLOWED_PCI
-#define RTE_DEVTYPE_BLACKLISTED_PCI RTE_DEVTYPE_BLOCKED_PCI
+#define RTE_DEVTYPE_WHITELISTED_PCI \
+ _Pragma("GCC warning \"'RTE_DEVTYPE_WHITELISTED_PCI' macro is deprecated.\"") \
+ RTE_DEVTYPE_ALLOWED_PCI
+
+#define RTE_DEVTYPE_BLACKLISTED_PCI \
+ _Pragma("GCC warning \"'RTE_DEVTYPE_BLACKLISTED_PCI' macro is deprecated.\"") \
+ RTE_DEVTYPE_BLOCKED_PCI
/**
* Structure that stores a device given by the user with its arguments
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* [dpdk-dev] [PATCH v4 11/11] doc: update examples to new config options
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (9 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 10/11] eal: mark old macros for blacklist/whitelist as deprecated Stephen Hemminger
@ 2020-07-14 5:39 ` Stephen Hemminger
2020-07-14 6:05 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 5:39 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger
Replace -w with -i and -b with -x to reflect new usage.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/cryptodevs/qat.rst | 2 +-
doc/guides/eventdevs/octeontx2.rst | 20 ++++++++---------
doc/guides/linux_gsg/linux_drivers.rst | 4 ++--
doc/guides/mempool/octeontx2.rst | 4 ++--
doc/guides/nics/cxgbe.rst | 8 +++----
doc/guides/nics/enic.rst | 6 ++---
doc/guides/nics/fail_safe.rst | 4 ++--
doc/guides/nics/i40e.rst | 12 +++++-----
doc/guides/nics/ice.rst | 16 +++++++-------
doc/guides/nics/mlx4.rst | 10 ++++-----
doc/guides/nics/mlx5.rst | 10 ++++-----
doc/guides/nics/octeontx2.rst | 22 +++++++++----------
doc/guides/nics/tap.rst | 10 ++++-----
doc/guides/nics/thunderx.rst | 4 ++--
doc/guides/sample_app_ug/ipsec_secgw.rst | 2 +-
.../sample_app_ug/l3_forward_power_man.rst | 2 +-
doc/guides/sample_app_ug/vdpa.rst | 2 +-
doc/guides/tools/cryptoperf.rst | 6 ++---
doc/guides/tools/flow-perf.rst | 2 +-
19 files changed, 73 insertions(+), 73 deletions(-)
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 423de7bf79d2..38e5b0a96206 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -299,7 +299,7 @@ return 0 (thereby avoiding an MMIO) if the device is congested and number of pac
possible to enqueue is smaller.
To use this feature the user must set the parameter on process start as a device additional parameter::
- -w 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16
+ -i 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16
All parameters can be used with the same device regardless of order. Parameters are separated
by comma. When the same parameter is used more than once first occurrence of the parameter
diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst
index 6502f6415fb4..470ea5450432 100644
--- a/doc/guides/eventdevs/octeontx2.rst
+++ b/doc/guides/eventdevs/octeontx2.rst
@@ -66,7 +66,7 @@ Runtime Config Options
upper limit for in-flight events.
For example::
- -w 0002:0e:00.0,xae_cnt=16384
+ -i 0002:0e:00.0,xae_cnt=16384
- ``Force legacy mode``
@@ -74,7 +74,7 @@ Runtime Config Options
single workslot mode in SSO and disable the default dual workslot mode.
For example::
- -w 0002:0e:00.0,single_ws=1
+ -i 0002:0e:00.0,single_ws=1
- ``Event Group QoS support``
@@ -89,7 +89,7 @@ Runtime Config Options
default.
For example::
- -w 0002:0e:00.0,qos=[1-50-50-50]
+ -i 0002:0e:00.0,qos=[1-50-50-50]
- ``Selftest``
@@ -98,7 +98,7 @@ Runtime Config Options
The tests are run once the vdev creation is successfully complete.
For example::
- -w 0002:0e:00.0,selftest=1
+ -i 0002:0e:00.0,selftest=1
- ``TIM disable NPA``
@@ -107,7 +107,7 @@ Runtime Config Options
parameter disables NPA and uses software mempool to manage chunks
For example::
- -w 0002:0e:00.0,tim_disable_npa=1
+ -i 0002:0e:00.0,tim_disable_npa=1
- ``TIM modify chunk slots``
@@ -118,7 +118,7 @@ Runtime Config Options
to SSO. The default value is 255 and the max value is 4095.
For example::
- -w 0002:0e:00.0,tim_chnk_slots=1023
+ -i 0002:0e:00.0,tim_chnk_slots=1023
- ``TIM enable arm/cancel statistics``
@@ -126,7 +126,7 @@ Runtime Config Options
event timer adapter.
For example::
- -w 0002:0e:00.0,tim_stats_ena=1
+ -i 0002:0e:00.0,tim_stats_ena=1
- ``TIM limit max rings reserved``
@@ -136,7 +136,7 @@ Runtime Config Options
rings.
For example::
- -w 0002:0e:00.0,tim_rings_lmt=5
+ -i 0002:0e:00.0,tim_rings_lmt=5
- ``TIM ring control internal parameters``
@@ -146,7 +146,7 @@ Runtime Config Options
default values.
For Example::
- -w 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]
+ -i 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]
- ``Lock NPA contexts in NDC``
@@ -156,7 +156,7 @@ Runtime Config Options
For example::
- -w 0002:0e:00.0,npa_lock_mask=0xf
+ -i 0002:0e:00.0,npa_lock_mask=0xf
Debugging Options
~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 4eda3d5bf4fe..0c6f9f8572ee 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -104,11 +104,11 @@ parameter ``--vfio-vf-token``.
3. echo 2 > /sys/bus/pci/devices/0000:86:00.0/sriov_numvfs
4. Start the PF:
- ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -w 86:00.0 \
+ ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -i 86:00.0 \
--vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i
5. Start the VF:
- ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -w 86:02.0 \
+ ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -i 86:02.0 \
--vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i
Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d).
diff --git a/doc/guides/mempool/octeontx2.rst b/doc/guides/mempool/octeontx2.rst
index 49b45a04e8ec..507591d809c6 100644
--- a/doc/guides/mempool/octeontx2.rst
+++ b/doc/guides/mempool/octeontx2.rst
@@ -50,7 +50,7 @@ Runtime Config Options
for the application.
For example::
- -w 0002:02:00.0,max_pools=512
+ -i 0002:02:00.0,max_pools=512
With the above configuration, the driver will set up only 512 mempools for
the given application to save HW resources.
@@ -69,7 +69,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,npa_lock_mask=0xf
+ -i 0002:02:00.0,npa_lock_mask=0xf
Debugging Options
~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
index 9aabf346060b..870904cfd9b0 100644
--- a/doc/guides/nics/cxgbe.rst
+++ b/doc/guides/nics/cxgbe.rst
@@ -112,7 +112,7 @@ be passed as part of EAL arguments. For example,
.. code-block:: console
- testpmd -w 02:00.4,keep_ovlan=1 -- -i
+ testpmd -i 02:00.4,keep_ovlan=1 -- -i
Common Runtime Options
^^^^^^^^^^^^^^^^^^^^^^
@@ -317,7 +317,7 @@ CXGBE PF Only Runtime Options
.. code-block:: console
- testpmd -w 02:00.4,filtermode=0x88 -- -i
+ testpmd -i 02:00.4,filtermode=0x88 -- -i
- ``filtermask`` (default **0**)
@@ -344,7 +344,7 @@ CXGBE PF Only Runtime Options
.. code-block:: console
- testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i
+ testpmd -i 02:00.4,filtermode=0x88,filtermask=0x80 -- -i
.. _driver-compilation:
@@ -776,7 +776,7 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system.
.. code-block:: console
- ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
+ ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -i 0000:02:00.4 -- -i
Example output:
diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index 69bcfd5c8576..a67f169a87a8 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -312,7 +312,7 @@ enables overlay offload, it prints the following message on the console.
By default, PMD enables overlay offload if hardware supports it. To disable
it, set ``devargs`` parameter ``disable-overlay=1``. For example::
- -w 12:00.0,disable-overlay=1
+ -i 12:00.0,disable-overlay=1
By default, the NIC uses 4789 as the VXLAN port. The user may change
it through ``rte_eth_dev_udp_tunnel_port_{add,delete}``. However, as
@@ -378,7 +378,7 @@ vectorized handler, take the following steps.
PMD consider the vectorized handler when selecting the receive handler.
For example::
- -w 12:00.0,enable-avx2-rx=1
+ -i 12:00.0,enable-avx2-rx=1
As the current implementation is intended for field trials, by default, the
vectorized handler is not considered (``enable-avx2-rx=0``).
@@ -427,7 +427,7 @@ DPDK as untagged packets. In this case mbuf->vlan_tci and the PKT_RX_VLAN and
PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the
``devargs`` parameter ``ig-vlan-rewrite=untag``. For example::
- -w 12:00.0,ig-vlan-rewrite=untag
+ -i 12:00.0,ig-vlan-rewrite=untag
- **SR-IOV**
diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst
index 01ad66bec774..d913d63469e5 100644
--- a/doc/guides/nics/fail_safe.rst
+++ b/doc/guides/nics/fail_safe.rst
@@ -130,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
$RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
--vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
- -b 84:00.0 -b 00:04.0 -- -i
+ -x 84:00.0 -x 00:04.0 -- -i
If the sub-device ``84:00.0`` is not blocklisted, it will be probed by the
EAL first. When the fail-safe then tries to initialize it the probe operation
@@ -144,7 +144,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
$RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
--vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
- -w 81:00.0 -- -i
+ -i 81:00.0 -- -i
#. Start testpmd using a flexible device definition
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index cf1ae2d0b043..4f4072b3bf6f 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -203,7 +203,7 @@ Runtime Config Options
Adapter with both Linux kernel and DPDK PMD. To fix this issue, ``devargs``
parameter ``support-multi-driver`` is introduced, for example::
- -w 84:00.0,support-multi-driver=1
+ -i 84:00.0,support-multi-driver=1
With the above configuration, DPDK PMD will not change global registers, and
will switch PF interrupt from IntN to Int0 to avoid interrupt conflict between
@@ -230,7 +230,7 @@ Runtime Config Options
since it can get better perf in some real work loading cases. So ``devargs`` param
``use-latest-supported-vec`` is introduced, for example::
- -w 84:00.0,use-latest-supported-vec=1
+ -i 84:00.0,use-latest-supported-vec=1
- ``Enable validation for VF message`` (default ``not enabled``)
@@ -240,7 +240,7 @@ Runtime Config Options
Format -- "maximal-message@period-seconds:ignore-seconds"
For example::
- -w 84:00.0,vf_msg_cfg=80@120:180
+ -i 84:00.0,vf_msg_cfg=80@120:180
Vector RX Pre-conditions
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -475,7 +475,7 @@ no physical uplink on the associated NIC port.
To enable this feature, the user should pass a ``devargs`` parameter to the
EAL, for example::
- -w 84:00.0,enable_floating_veb=1
+ -i 84:00.0,enable_floating_veb=1
In this configuration the PMD will use the floating VEB feature for all the
VFs created by this PF device.
@@ -483,7 +483,7 @@ VFs created by this PF device.
Alternatively, the user can specify which VFs need to connect to this floating
VEB using the ``floating_veb_list`` argument::
- -w 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4
+ -i 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4
In this example ``VF1``, ``VF3`` and ``VF4`` connect to the floating VEB,
while other VFs connect to the normal VEB.
@@ -809,7 +809,7 @@ See :numref:`figure_intel_perf_test_setup` for the performance test setup.
7. The command line of running l3fwd would be something like the following::
- ./l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \
+ ./l3fwd -l 18-21 -n 4 -i 82:00.0 -i 85:00.0 \
-- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)'
This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 865718fb83cd..93eb2f0c2264 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -50,7 +50,7 @@ Runtime Config Options
But if user intend to use the device without OS package, user can take ``devargs``
parameter ``safe-mode-support``, for example::
- -w 80:00.0,safe-mode-support=1
+ -i 80:00.0,safe-mode-support=1
Then the driver will be initialized successfully and the device will enter Safe Mode.
NOTE: In Safe mode, only very limited features are available, features like RSS,
@@ -73,7 +73,7 @@ Runtime Config Options
use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``,
for example::
- -w 80:00.0,pipeline-mode-support=1
+ -i 80:00.0,pipeline-mode-support=1
- ``Flow Mark Support`` (default ``0``)
@@ -85,7 +85,7 @@ Runtime Config Options
2) a new offload like RTE_DEV_RX_OFFLOAD_FLOW_MARK be introduced as a standard way to hint.
Example::
- -w 80:00.0,flow-mark-support=1
+ -i 80:00.0,flow-mark-support=1
- ``Protocol extraction for per queue``
@@ -94,8 +94,8 @@ Runtime Config Options
The argument format is::
- -w 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
- -w 18:00.0,proto_xtr=<protocol>
+ -i 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
+ -i 18:00.0,proto_xtr=<protocol>
Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character
is used as a range separator and ``,`` is used as a single number separator.
@@ -106,14 +106,14 @@ Runtime Config Options
.. code-block:: console
- testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
+ testpmd -i 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
VLAN extraction, other queues run with no protocol extraction.
.. code-block:: console
- testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
+ testpmd -i 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
IPv6 extraction, other queues use the default VLAN extraction.
@@ -253,7 +253,7 @@ responses for the same from PF.
#. Bind the VF0, and run testpmd with 'cap=dcf' devarg::
- testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i
+ testpmd -l 22-25 -n 4 -i 18:01.0,cap=dcf -- -i
#. Monitor the VF2 interface network traffic::
diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index dfdccb4aab7c..f445dd51a65f 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -434,10 +434,10 @@ devices managed by librte_pmd_mlx4.
Example output::
- -w 0000:83:00.0
- -w 0000:83:00.0
- -w 0000:84:00.0
- -w 0000:84:00.0
+ -i 0000:83:00.0
+ -i 0000:83:00.0
+ -i 0000:84:00.0
+ -i 0000:84:00.0
.. note::
@@ -450,7 +450,7 @@ devices managed by librte_pmd_mlx4.
#. Start testpmd with basic parameters::
- testpmd -l 8-15 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i
+ testpmd -l 8-15 -n 4 -i 0000:83:00.0 -i 0000:84:00.0 -- --rxq=2 --txq=2 -i
Example output::
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 254a25e95f9a..bafabba518b5 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1466,10 +1466,10 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
Example output::
- -w 0000:05:00.1
- -w 0000:06:00.0
- -w 0000:06:00.1
- -w 0000:05:00.0
+ -i 0000:05:00.1
+ -i 0000:06:00.0
+ -i 0000:06:00.1
+ -i 0000:05:00.0
#. Request huge pages::
@@ -1477,7 +1477,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
#. Start testpmd with basic parameters::
- testpmd -l 8-15 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i
+ testpmd -l 8-15 -n 4 -i 05:00.0 -i 05:00.1 -i 06:00.0 -i 06:00.1 -- --rxq=2 --txq=2 -i
Example output::
diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst
index bb591a8b7e65..3d382446d1d1 100644
--- a/doc/guides/nics/octeontx2.rst
+++ b/doc/guides/nics/octeontx2.rst
@@ -74,7 +74,7 @@ use arm64-octeontx2-linux-gcc as target.
.. code-block:: console
- ./build/app/testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
+ ./build/app/testpmd -c 0x300 -i 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
EAL: Detected 24 lcore(s)
EAL: Detected 1 NUMA nodes
EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
@@ -127,7 +127,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,reta_size=256
+ -i 0002:02:00.0,reta_size=256
With the above configuration, reta table of size 256 is populated.
@@ -138,7 +138,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,flow_max_priority=10
+ -i 0002:02:00.0,flow_max_priority=10
With the above configuration, priority level was set to 10 (0-9). Max
priority level supported is 32.
@@ -150,7 +150,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,flow_prealloc_size=4
+ -i 0002:02:00.0,flow_prealloc_size=4
With the above configuration, pre alloc size was set to 4. Max pre alloc
size supported is 32.
@@ -162,7 +162,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,max_sqb_count=64
+ -i 0002:02:00.0,max_sqb_count=64
With the above configuration, each send queue's decscriptor buffer count is
limited to a maximum of 64 buffers.
@@ -174,7 +174,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,switch_header="higig2"
+ -i 0002:02:00.0,switch_header="higig2"
With the above configuration, higig2 will be enabled on that port and the
traffic on this port should be higig2 traffic only. Supported switch header
@@ -196,7 +196,7 @@ Runtime Config Options
For example to select the legacy mode(RSS tag adder as XOR)::
- -w 0002:02:00.0,tag_as_xor=1
+ -i 0002:02:00.0,tag_as_xor=1
- ``Max SPI for inbound inline IPsec`` (default ``1``)
@@ -205,7 +205,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,ipsec_in_max_spi=128
+ -i 0002:02:00.0,ipsec_in_max_spi=128
With the above configuration, application can enable inline IPsec processing
on 128 SAs (SPI 0-127).
@@ -216,7 +216,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,lock_rx_ctx=1
+ -i 0002:02:00.0,lock_rx_ctx=1
- ``Lock Tx contexts in NDC cache``
@@ -224,7 +224,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,lock_tx_ctx=1
+ -i 0002:02:00.0,lock_tx_ctx=1
.. note::
@@ -240,7 +240,7 @@ Runtime Config Options
For example::
- -w 0002:02:00.0,npa_lock_mask=0xf
+ -i 0002:02:00.0,npa_lock_mask=0xf
.. _otx2_tmapi:
diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst
index 0e726bf87f73..b5a0f51988aa 100644
--- a/doc/guides/nics/tap.rst
+++ b/doc/guides/nics/tap.rst
@@ -183,15 +183,15 @@ following::
sudo ./app/app/x86_64-native-linux-gcc/app/pktgen -l 1-5 -n 4 \
--proc-type auto --log-level debug --socket-mem 512,512 --file-prefix pg \
- --vdev=net_tap0 --vdev=net_tap1 -b 05:00.0 -b 05:00.1 \
- -b 04:00.0 -b 04:00.1 -b 04:00.2 -b 04:00.3 \
- -b 81:00.0 -b 81:00.1 -b 81:00.2 -b 81:00.3 \
- -b 82:00.0 -b 83:00.0 -- -T -P -m [2:3].0 -m [4:5].1 \
+ --vdev=net_tap0 --vdev=net_tap1 -x 05:00.0 -x 05:00.1 \
+ -x 04:00.0 -x 04:00.1 -x 04:00.2 -x 04:00.3 \
+ -x 81:00.0 -x 81:00.1 -x 81:00.2 -x 81:00.3 \
+ -x 82:00.0 -x 83:00.0 -- -T -P -m [2:3].0 -m [4:5].1 \
-f themes/black-yellow.theme
.. Note:
- Change the ``-b`` options to blocklist all of your physical ports. The
+ Change the ``-x`` options to exclude all of your physical ports. The
following command line is all one line.
Also, ``-f themes/black-yellow.theme`` is optional if the default colors
diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
index f42133e5464d..f1b27a3f269c 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
@@ -178,7 +178,7 @@ This section provides instructions to configure SR-IOV with Linux OS.
.. code-block:: console
- ./arm64-thunderx-linux-gcc/app/testpmd -l 0-3 -n 4 -w 0002:01:00.2 \
+ ./arm64-thunderx-linux-gcc/app/testpmd -l 0-3 -n 4 -i 0002:01:00.2 \
-- -i --no-flush-rx \
--port-topology=loop
@@ -398,7 +398,7 @@ This scheme is useful when application would like to insert vlan header without
Example:
.. code-block:: console
- -w 0002:01:00.2,skip_data_bytes=8
+ -i 0002:01:00.2,skip_data_bytes=8
Limitations
-----------
diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst
index bf1aefc0e120..fac75819a762 100644
--- a/doc/guides/sample_app_ug/ipsec_secgw.rst
+++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
@@ -337,7 +337,7 @@ For example, something like the following command line:
.. code-block:: console
./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
- -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3 \
+ -i 81:00.0 -i 81:00.1 -i 81:00.2 -i 81:00.3 \
--vdev "crypto_aesni_mb" --vdev "crypto_null" \
-- \
-p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst
index 0cc6f2e62e75..4cc55004cca8 100644
--- a/doc/guides/sample_app_ug/l3_forward_power_man.rst
+++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst
@@ -378,7 +378,7 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program
.. code-block:: console
- ./l3fwd-power -l xxx -n 4 -w 0000:xx:00.0 -w 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll="0,0,0" -l 14 -m 9 -h 1
+ ./l3fwd-power -l xxx -n 4 -i 0000:xx:00.0 -i 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll="0,0,0" -l 14 -m 9 -h 1
Where,
diff --git a/doc/guides/sample_app_ug/vdpa.rst b/doc/guides/sample_app_ug/vdpa.rst
index d66a724827af..e388c738a1e3 100644
--- a/doc/guides/sample_app_ug/vdpa.rst
+++ b/doc/guides/sample_app_ug/vdpa.rst
@@ -52,7 +52,7 @@ Take IFCVF driver for example:
.. code-block:: console
./vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \
- -w 0000:06:00.3,vdpa=1 -w 0000:06:00.4,vdpa=1 \
+ -i 0000:06:00.3,vdpa=1 -i 0000:06:00.4,vdpa=1 \
-- --interactive
.. note::
diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst
index 28b729dbda8b..334a4f558abd 100644
--- a/doc/guides/tools/cryptoperf.rst
+++ b/doc/guides/tools/cryptoperf.rst
@@ -417,7 +417,7 @@ Call application for performance throughput test of single Aesni MB PMD
for cipher encryption aes-cbc and auth generation sha1-hmac,
one million operations, burst size 32, packet size 64::
- dpdk-test-crypto-perf -l 6-7 --vdev crypto_aesni_mb -w 0000:00:00.0 --
+ dpdk-test-crypto-perf -l 6-7 --vdev crypto_aesni_mb -i 0000:00:00.0 --
--ptest throughput --devtype crypto_aesni_mb --optype cipher-then-auth
--cipher-algo aes-cbc --cipher-op encrypt --cipher-key-sz 16 --auth-algo
sha1-hmac --auth-op generate --auth-key-sz 64 --digest-sz 12
@@ -427,7 +427,7 @@ Call application for performance latency test of two Aesni MB PMD executed
on two cores for cipher encryption aes-cbc, ten operations in silent mode::
dpdk-test-crypto-perf -l 4-7 --vdev crypto_aesni_mb1
- --vdev crypto_aesni_mb2 -w 0000:00:00.0 -- --devtype crypto_aesni_mb
+ --vdev crypto_aesni_mb2 -i 0000:00:00.0 -- --devtype crypto_aesni_mb
--cipher-algo aes-cbc --cipher-key-sz 16 --cipher-iv-sz 16
--cipher-op encrypt --optype cipher-only --silent
--ptest latency --total-ops 10
@@ -437,7 +437,7 @@ for cipher encryption aes-gcm and auth generation aes-gcm,ten operations
in silent mode, test vector provide in file "test_aes_gcm.data"
with packet verification::
- dpdk-test-crypto-perf -l 4-7 --vdev crypto_openssl -w 0000:00:00.0 --
+ dpdk-test-crypto-perf -l 4-7 --vdev crypto_openssl -i 0000:00:00.0 --
--devtype crypto_openssl --aead-algo aes-gcm --aead-key-sz 16
--aead-iv-sz 16 --aead-op encrypt --aead-aad-sz 16 --digest-sz 16
--optype aead --silent --ptest verify --total-ops 10
diff --git a/doc/guides/tools/flow-perf.rst b/doc/guides/tools/flow-perf.rst
index cdedaf9a97d4..c03681525e60 100644
--- a/doc/guides/tools/flow-perf.rst
+++ b/doc/guides/tools/flow-perf.rst
@@ -61,7 +61,7 @@ with a ``--`` separator:
.. code-block:: console
- sudo ./dpdk-test-flow_perf -n 4 -w 08:00.0 -- --ingress --ether --ipv4 --queue --flows-count=1000000
+ sudo ./dpdk-test-flow_perf -n 4 -i 08:00.0 -- --ingress --ether --ipv4 --queue --flows-count=1000000
The command line options are:
--
2.26.2
^ permalink raw reply [flat|nested] 35+ messages in thread
* Re: [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 00/11] rename blacklist/whitelist to exclude/include Stephen Hemminger
` (10 preceding siblings ...)
2020-07-14 5:39 ` [dpdk-dev] [PATCH v4 11/11] doc: update examples to new config options Stephen Hemminger
@ 2020-07-14 6:05 ` Stephen Hemminger
11 siblings, 0 replies; 35+ messages in thread
From: Stephen Hemminger @ 2020-07-14 6:05 UTC (permalink / raw)
To: dev
On Mon, 13 Jul 2020 22:39:08 -0700
Stephen Hemminger <stephen@networkplumber.org> wrote:
> The terms blacklist and whitelist are often seen as reminders
> of the divisions in society. Instead, use more exact terms for
> handling of which devices are used in DPDK.
>
> This is a proposed change for DPDK 20.08 to replace the names
> blacklist and whitelist in API and command lines.
>
> The first three patches fix some other unnecessary use of
> blacklist/whitelist and have no user visible impact.
>
> The rest change the PCI blacklist to be blocklist and
> whitelist to be allowlist.
>
> Thank you for the support and review of this patch.
>
> v4 - change to use pci-include/pci-exclude for options
> incorporate review feedback
> keep old options (with approporiate deprecation notice)
> update examples in doc
>
> Stephen Hemminger (11):
> rte_ethdev: change comment to rte_dev_eth_mac_addr_add
> mk: replace reference to blacklist/whitelist
> check_maintainers: change variable names
> eal: replace usage of blacklist/whitelist in enum
> drivers: replace references to blacklist
> eal: replace pci-whitelist/pci-blacklist options
> doc: replace references to blacklist/whitelist
> app/test: use new allowlist and blocklist
> doc: add note about blacklist/whitelist changes
> eal: mark old macros for blacklist/whitelist as deprecated
> doc: update examples to new config options
>
> app/test/autotest.py | 16 ++---
> app/test/autotest_runner.py | 18 +++---
> app/test/test.c | 2 +-
> app/test/test_eal_flags.c | 52 ++++++++--------
> devtools/check-maintainers.sh | 8 +--
> doc/guides/cryptodevs/dpaa2_sec.rst | 4 +-
> doc/guides/cryptodevs/dpaa_sec.rst | 4 +-
> doc/guides/cryptodevs/qat.rst | 6 +-
> doc/guides/eventdevs/octeontx2.rst | 20 +++----
> doc/guides/freebsd_gsg/build_sample_apps.rst | 2 +-
> doc/guides/linux_gsg/build_sample_apps.rst | 2 +-
> doc/guides/linux_gsg/eal_args.include.rst | 14 ++---
> doc/guides/linux_gsg/linux_drivers.rst | 4 +-
> doc/guides/mempool/octeontx2.rst | 4 +-
> doc/guides/nics/bnxt.rst | 6 +-
> doc/guides/nics/cxgbe.rst | 12 ++--
> doc/guides/nics/dpaa.rst | 4 +-
> doc/guides/nics/dpaa2.rst | 4 +-
> doc/guides/nics/enic.rst | 12 ++--
> doc/guides/nics/fail_safe.rst | 18 +++---
> doc/guides/nics/features.rst | 2 +-
> doc/guides/nics/i40e.rst | 12 ++--
> doc/guides/nics/ice.rst | 18 +++---
> doc/guides/nics/mlx4.rst | 16 ++---
> doc/guides/nics/mlx5.rst | 12 ++--
> doc/guides/nics/octeontx2.rst | 22 +++----
> doc/guides/nics/sfc_efx.rst | 2 +-
> doc/guides/nics/tap.rst | 10 ++--
> doc/guides/nics/thunderx.rst | 4 +-
> .../prog_guide/env_abstraction_layer.rst | 7 +--
> doc/guides/prog_guide/multi_proc_support.rst | 4 +-
> doc/guides/rel_notes/known_issues.rst | 4 +-
> doc/guides/rel_notes/release_20_08.rst | 6 ++
> doc/guides/rel_notes/release_2_1.rst | 2 +-
> doc/guides/sample_app_ug/bbdev_app.rst | 6 +-
> doc/guides/sample_app_ug/ipsec_secgw.rst | 6 +-
> doc/guides/sample_app_ug/l3_forward.rst | 2 +-
> .../sample_app_ug/l3_forward_access_ctrl.rst | 2 +-
> .../sample_app_ug/l3_forward_power_man.rst | 2 +-
> doc/guides/sample_app_ug/vdpa.rst | 2 +-
> doc/guides/tools/cryptoperf.rst | 6 +-
> doc/guides/tools/flow-perf.rst | 2 +-
> drivers/bus/dpaa/dpaa_bus.c | 7 +--
> drivers/bus/fslmc/fslmc_bus.c | 9 ++-
> drivers/bus/fslmc/fslmc_vfio.c | 8 +--
> drivers/bus/pci/pci_common.c | 24 ++++----
> drivers/bus/vmbus/vmbus_common.c | 4 +-
> drivers/crypto/virtio/virtio_pci.c | 2 +-
> drivers/net/fm10k/fm10k_ethdev.c | 2 +-
> drivers/net/virtio/virtio_pci.c | 2 +-
> lib/librte_eal/common/eal_common_devargs.c | 14 ++---
> lib/librte_eal/common/eal_common_options.c | 59 ++++++++++++-------
> lib/librte_eal/common/eal_options.h | 8 ++-
> lib/librte_eal/include/rte_bus.h | 13 +++-
> lib/librte_eal/include/rte_dev.h | 12 +++-
> lib/librte_eal/include/rte_devargs.h | 12 +++-
> lib/librte_ethdev/rte_ethdev.h | 3 +-
> mk/rte.sdktest.mk | 14 ++---
> 58 files changed, 299 insertions(+), 255 deletions(-)
>
There are some bogus checkpatch complaints against patches in this
series. The new linux kernel checkpatch now complains about whitelist/blacklist
so any attempt to fix would hit that.
Also, Linux kernel checkpatch now wants the magic
fallthrough;
which in Linux kernel is a macro but does not exist in DPDK.
Someone want to fix checkpatch for that one?
^ permalink raw reply [flat|nested] 35+ messages in thread