From patchwork Sat Oct 24 01:01:42 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 82052 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 34A19A04B0; Sat, 24 Oct 2020 03:02:19 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id B0FD4685E; Sat, 24 Oct 2020 03:02:01 +0200 (CEST) Received: from mail-pf1-f196.google.com (mail-pf1-f196.google.com [209.85.210.196]) by dpdk.org (Postfix) with ESMTP id 0097AF12 for ; Sat, 24 Oct 2020 03:01:57 +0200 (CEST) Received: by mail-pf1-f196.google.com with SMTP id e7so2777723pfn.12 for ; Fri, 23 Oct 2020 18:01:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=zwXAYdSR0PegyLNlzdwjLJFaS4AjUpddhtWdSetsrtM=; b=j8qKDv8dECsvXjFQptsFRTddGZKkxq7mZv8VZFYrXwCinQ5sYEVtlgmUNaWIJmmylm KWqJDZc7ooLtRNEZk+nSSTmK1n7/81RATm8i/0zU2a9LB03rD2yTCAYSQizlOuznb0Iy mFRICNDICOJSSTWVKCXDZNnbJ+TUdmZRheUCdz++gfl46uN3x1y2ZgR4eN5k4WJsu0P6 t19Zwtcugq1dAirk1CgcLCF3lntK149JRGsbNZLW3fViFnekOwSSe3YWKMiYm5WhuLur R3GUWtgM1bcvvhQFwTHYRVSLiBzVZB8yU2FiFfMf4R7D/KXDVWemZVaLQGchPkRC8CQE CH1g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=zwXAYdSR0PegyLNlzdwjLJFaS4AjUpddhtWdSetsrtM=; b=ChFG70C0XXsd924EF97nIt7cqFBBcafYDhsc752Hqn9kQCiB623zQdh83Y0RcfOxRm 8H6g89ziC5TZHBwqYNH4k4RkYVwXnal3cvoasdOA2vJBZopL7Gtjv4kP8h3qXI1jfv0K IuDIdpA3oydcekBBhfEEIR+x+5X+Gy5ePWqSKY/oU7ZXLqPZJbQOwqTJ2Sb0l/D7Ephx rdBPhdFkATl8k/aT/HGXnelZRuN6FDVjpQ1KmSZfH7OS+jNEIpygiZg6FdSplQzGdRag yR4/Tv8fNe1QPSXCCwPMRBLLRcTRg1fEZ14EovkAdcH6bYxFDY+6w6ID/TRI+QYnTDqg xB4Q== X-Gm-Message-State: AOAM532SWkC0QjD8wzQFYv/E49mHExOL2O6XPZtuT6vhr60HGnSBtZ3b q+S8dizQTXTiZMBY+1ISXCFOoyF95Pv6r7Q0 X-Google-Smtp-Source: ABdhPJysYpq5jvFgk+QN+TNCvNLEnxfFLmxNHOjRyQIn2tk8/oNwj2F3WcRb3lEhhB12YMRhP+5GTw== X-Received: by 2002:a63:5c5f:: with SMTP id n31mr3828157pgm.397.1603501315582; Fri, 23 Oct 2020 18:01:55 -0700 (PDT) Received: from hermes.corp.microsoft.com (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id w19sm3356439pfn.174.2020.10.23.18.01.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Oct 2020 18:01:54 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Luca Boccassi , Gaetan Rivet Date: Fri, 23 Oct 2020 18:01:42 -0700 Message-Id: <20201024010146.27689-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201024010146.27689-1-stephen@networkplumber.org> References: <20200922143202.8755-1-stephen@networkplumber.org> <20201024010146.27689-1-stephen@networkplumber.org> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 1/5] eal: replace usage of blacklist/whitelist in enum X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 Acked-by: Luca Boccassi Acked-by: Gaetan Rivet --- lib/librte_eal/common/eal_common_devargs.c | 14 +++++++------- lib/librte_eal/include/rte_bus.h | 10 ++++++++-- lib/librte_eal/include/rte_dev.h | 10 ++++++++-- lib/librte_eal/include/rte_devargs.h | 10 ++++++++-- 4 files changed, 31 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..fcf3d9a3ccb2 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 in allowed list 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) + 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..80b154fb982c 100644 --- a/lib/librte_eal/include/rte_bus.h +++ b/lib/librte_eal/include/rte_bus.h @@ -215,10 +215,16 @@ 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 removed */ +#define RTE_BUS_SCAN_WHITELIST \ + RTE_DEPRECATED(RTE_BUS_SCAN_WHITELIST) RTE_BUS_SCAN_ALLOWLIST +#define RTE_BUS_SCAN_BLACKLIST \ + RTE_DEPRECATED(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 81905b3ae35f..6dd72c11a14a 100644 --- a/lib/librte_eal/include/rte_dev.h +++ b/lib/librte_eal/include/rte_dev.h @@ -52,10 +52,16 @@ typedef void (*rte_dev_event_cb_fn)(const char *device_name, * Device policies. */ enum rte_dev_policy { - RTE_DEV_WHITELISTED, - RTE_DEV_BLACKLISTED, + RTE_DEV_ALLOWED, + RTE_DEV_BLOCKED, }; +/* Backwards compatibility will be removed */ +#define RTE_DEV_WHITELISTED \ + RTE_DEPRECATED(RTE_DEV_WHITELISTED) RTE_DEV_ALLOWED +#define RTE_DEV_BLACKLISTED \ + RTE_DEPRECATED(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..296f19324fae 100644 --- a/lib/librte_eal/include/rte_devargs.h +++ b/lib/librte_eal/include/rte_devargs.h @@ -29,11 +29,17 @@ extern "C" { * Type of generic device */ enum rte_devtype { - RTE_DEVTYPE_WHITELISTED_PCI, - RTE_DEVTYPE_BLACKLISTED_PCI, + RTE_DEVTYPE_ALLOWED, + RTE_DEVTYPE_BLOCKED, RTE_DEVTYPE_VIRTUAL, }; +/* Backwards compatibility will be removed later */ +#define RTE_DEVTYPE_WHITELISTED_PCI \ + RTE_DEPRECATED(RTE_DEVTYPE_WHITELISTED_PCI) RTE_DEVTYPE_ALLOWED +#define RTE_DEVTYPE_BLACKLISTED_PCI \ + RTE_DEPRECATED(RTE_DEVTYPE_BLACKLISTED_PCI) RTE_DEVTYPE_BLOCKED + /** * Structure that stores a device given by the user with its arguments * From patchwork Sat Oct 24 01:01:43 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 82053 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9E394A04B0; Sat, 24 Oct 2020 03:02:38 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4CD716A6D; Sat, 24 Oct 2020 03:02:03 +0200 (CEST) Received: from mail-pf1-f193.google.com (mail-pf1-f193.google.com [209.85.210.193]) by dpdk.org (Postfix) with ESMTP id 928225A17 for ; Sat, 24 Oct 2020 03:01:59 +0200 (CEST) Received: by mail-pf1-f193.google.com with SMTP id 126so2376156pfu.4 for ; Fri, 23 Oct 2020 18:01:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=+GsOVWqwCBmjwIbOwEIZ6jgZ0tB4TkeqYDXWZ+NLO6Y=; b=y3Q47bNTF3PYqPUSS7cuCNAJsJgSDDsiMMx4r6rjCB+wUKnf3hwd+eBf3xwLBP4d/S ULzYXZ3ehsvszoLsRaoOjZ3DJGrLmLzE394pG4HeRCllz2mfOqkUC/d6DbD2Z9abQobz T0mlDKRN6Bto2EnP9enuXXXMFXCcZjEyuIWcInJS4KzIQzqjxWzuAnhsf10G0lYBkLxf T0NQwz+vz3GA72QBBiygVM1GDgoocUDqNoHFFG0dxbiUPzxQ2T7/XgTXI9Rji/3RCUjE HlbbnjL/3IFO5npsc3IcptELyq3aPkonJaxhBdLy8HWozDrv1izkORw6/gZ2QGDVTund YbYA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=+GsOVWqwCBmjwIbOwEIZ6jgZ0tB4TkeqYDXWZ+NLO6Y=; b=XcxBOByjlH+gVRpNAqYw//nIIP6I1UL49GgmPhrz77D7NkyT20YOTsAu1zPHHhsJ/Z /16Ht+v3ewo818VRFPrtUQxwnhU3F2cSyNGHwEs8Ss2xGahau1gNlWwQnvIULaB4J6Np x891Q/M7qh/vd9MB29bb0wkHvt+9pmZrXqj6pOv1fWakgg9VNG0nVMWsHHhYUR/S00E5 45Ge5J5E6oIDjPe50SvifaD+ePEOmZJtXPCuXS4PvF55mfTciQZ6i8wHYe4M1SYmccAL qy6WK4ArRtVyNd92xspGtgWhfp1jAZkAEu1g9NnOGzn+iwHlhudHgRnv8fJ5pLHZ9k1d wc0A== X-Gm-Message-State: AOAM533eT+jJ+RxXWm536J46yDNMTNTrScqufmE9m9RaVaCrzLKJLwdB 2DmgbCU8UUiaUEmXHjEvleqc/0Xn6BLVPMa+ X-Google-Smtp-Source: ABdhPJymIzRjmMHvmj/My4EpDSIbguTjrmU20gqsSDiHPMO8nzmbYcC+bXxXtyg7FAI1Euwc+815FQ== X-Received: by 2002:a63:f701:: with SMTP id x1mr4015702pgh.378.1603501317170; Fri, 23 Oct 2020 18:01:57 -0700 (PDT) Received: from hermes.corp.microsoft.com (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id w19sm3356439pfn.174.2020.10.23.18.01.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Oct 2020 18:01:56 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Luca Boccassi , Hemant Agrawal Date: Fri, 23 Oct 2020 18:01:43 -0700 Message-Id: <20201024010146.27689-3-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201024010146.27689-1-stephen@networkplumber.org> References: <20200922143202.8755-1-stephen@networkplumber.org> <20201024010146.27689-1-stephen@networkplumber.org> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 2/5] drivers: replace references to blacklist X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Use the new terminology blocked to describe when devices are excluded from being used. Signed-off-by: Stephen Hemminger Acked-by: Luca Boccassi Acked-by: Hemant Agrawal --- drivers/bus/dpaa/dpaa_bus.c | 7 +++---- drivers/bus/fslmc/fslmc_bus.c | 9 ++++----- drivers/bus/fslmc/fslmc_vfio.c | 12 ++++++------ drivers/bus/pci/pci_common.c | 24 ++++++++++-------------- drivers/bus/vmbus/vmbus_common.c | 4 ++-- drivers/crypto/virtio/virtio_pci.c | 2 +- drivers/net/virtio/virtio_pci.c | 2 +- 7 files changed, 27 insertions(+), 33 deletions(-) diff --git a/drivers/bus/dpaa/dpaa_bus.c b/drivers/bus/dpaa/dpaa_bus.c index c94c72106f2c..a1f6a60f0760 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 aba55b46d8da..ebcc8e1edae7 100644 --- a/drivers/bus/fslmc/fslmc_vfio.c +++ b/drivers/bus/fslmc/fslmc_vfio.c @@ -812,13 +812,13 @@ fslmc_vfio_process_group(void) if (dev->dev_type == DPAA2_MPORTAL) { dpmcp_count++; if (dev->device.devargs && - dev->device.devargs->policy == RTE_DEV_BLACKLISTED) + dev->device.devargs->policy == RTE_DEV_BLOCKED) is_dpmcp_in_blocklist = true; } if (dev->dev_type == DPAA2_IO) { dpio_count++; if (dev->device.devargs && - dev->device.devargs->policy == RTE_DEV_BLACKLISTED) + dev->device.devargs->policy == RTE_DEV_BLOCKED) is_dpio_in_blocklist = true; } } @@ -829,8 +829,8 @@ fslmc_vfio_process_group(void) if (dev->dev_type == DPAA2_MPORTAL) { current_device++; 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); @@ -876,8 +876,8 @@ fslmc_vfio_process_group(void) if (dev->dev_type == DPAA2_IO) current_device++; 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 39eea464b4c0..b24c0697130e 100644 --- a/drivers/bus/pci/pci_common.c +++ b/drivers/bus/pci/pci_common.c @@ -67,9 +67,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. @@ -172,7 +171,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; @@ -181,12 +180,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; } @@ -629,14 +626,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/virtio/virtio_pci.c b/drivers/net/virtio/virtio_pci.c index 9915eabf68b0..d6b950ee6925 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. */ From patchwork Sat Oct 24 01:01:44 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 82054 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 37767A04B0; Sat, 24 Oct 2020 03:02:59 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 245507F84; Sat, 24 Oct 2020 03:02:07 +0200 (CEST) Received: from mail-pg1-f195.google.com (mail-pg1-f195.google.com [209.85.215.195]) by dpdk.org (Postfix) with ESMTP id D85566938 for ; Sat, 24 Oct 2020 03:02:00 +0200 (CEST) Received: by mail-pg1-f195.google.com with SMTP id b23so2637326pgb.3 for ; Fri, 23 Oct 2020 18:02:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=NOTeE5zk5wuD3EOl/55XFKZzm8DAdp63HbwR3Xxd0XU=; b=W0do7B2XwNrJAIeAkjKllM8XxzZgYPgvrmfneo+CJPcf94Az/mZYXpaYEQO6/CinOw T7FOGwtQ4NRA+h064PD+aZ8Gy9RaWU5WmWb2q7C1AX4w/FMJcuYq2xvIA5snQ7qH0va7 eg7GInoL4+ytMJSZvsxZsTgK55RZ5v8SZ8Bqi/sH+YOjZ7mJeQzHe7oXisuwAcn3SeZt NUZz7DXLKY/L3zRJDuFmMGa80xK3siCTQqcX+akR6M/DcqKNdUHkgQDqHNJoWJ9UnHjh jhuzGqyiikrQ2E3wx863ZxRIR8V7Dw+mkq10ieyLfFKIaCxPO7wHYWr4/QqcC7s2+Glc rs3Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=NOTeE5zk5wuD3EOl/55XFKZzm8DAdp63HbwR3Xxd0XU=; b=dfrX6W/Wf6I0sGVQQzsOmNHRm5dawsbsWbyjmmnx/IM62K2158tC3b5ZL52C5lraRb 27GlePp88Dqdl6wyLbwLqIsy8ywFfb+XBQGBAGfA48XjvVe3wBJZ/IBuII7KLLr2aZnH kp75YPFqKJtWBNbIrrlpAQg7X00BQjqKqSt3ehYbuLXljgYQwTVuBS1eFsiWAvudKSUR KCPEmDvKgvaVRITU8icAHATqkD6j9YKNnJ1vGKWoOf5qA3H1h2hk0ni831/XtnhsiNqK Hwa6KO7tRr3qXThBIm5KIUORXeqME3DHtafjmK4fXfqG7XwsPK8jqGHp87RBfjLk+RLC /SbA== X-Gm-Message-State: AOAM533wJjidQsB1M2yUaccJm86wNiJNmT9pUKMZep8Aev5HbnM3h+Od 7RPu6q+QkgphbuHaHvDd5mb0NLTyb1WtR4VS X-Google-Smtp-Source: ABdhPJwpr+AP3ZU+5lKV+ZsMng3Mv60JpaJqmDzgKWVBlYGoNoebGZIzTMLA25nXKwIPH2EWPuAZEA== X-Received: by 2002:a63:9d04:: with SMTP id i4mr3996866pgd.375.1603501318524; Fri, 23 Oct 2020 18:01:58 -0700 (PDT) Received: from hermes.corp.microsoft.com (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id w19sm3356439pfn.174.2020.10.23.18.01.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Oct 2020 18:01:57 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Luca Boccassi Date: Fri, 23 Oct 2020 18:01:44 -0700 Message-Id: <20201024010146.27689-4-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201024010146.27689-1-stephen@networkplumber.org> References: <20200922143202.8755-1-stephen@networkplumber.org> <20201024010146.27689-1-stephen@networkplumber.org> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 3/5] eal: replace pci-whitelist/pci-blacklist options X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Replace -w / --pci-whitelist with -a / --allow options and --pci-blacklist with --block. The -b short option remains unchanged. Allow the old options for now, but print a nag warning since old options are deprecated. Signed-off-by: Stephen Hemminger Acked-by: Luca Boccassi --- lib/librte_eal/common/eal_common_options.c | 70 +++++++++++++--------- lib/librte_eal/common/eal_options.h | 9 ++- 2 files changed, 51 insertions(+), 28 deletions(-) diff --git a/lib/librte_eal/common/eal_common_options.c b/lib/librte_eal/common/eal_common_options.c index 7b3341683662..cf6c3770730a 100644 --- a/lib/librte_eal/common/eal_common_options.c +++ b/lib/librte_eal/common/eal_common_options.c @@ -52,7 +52,8 @@ const char eal_short_options[] = - "b:" /* pci-blacklist */ + "a:" /* allow */ + "b:" /* block */ "c:" /* coremask */ "s:" /* service coremask */ "d:" /* driver */ @@ -63,7 +64,8 @@ eal_short_options[] = "n:" /* memory channels */ "r:" /* memory ranks */ "v" /* version */ - "w:" /* pci-whitelist */ + "w:" /* whitelist (deprecated) */ + "B:" /* blacklist (deprecated) */ ; const struct option @@ -89,8 +91,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_DEV_BLOCK, 1, NULL, OPT_DEV_BLOCK_NUM }, + {OPT_DEV_ALLOW, 1, NULL, OPT_DEV_ALLOW_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 }, @@ -105,6 +107,11 @@ eal_long_options[] = { {OPT_TELEMETRY, 0, NULL, OPT_TELEMETRY_NUM }, {OPT_NO_TELEMETRY, 0, NULL, OPT_NO_TELEMETRY_NUM }, {OPT_FORCE_MAX_SIMD_BITWIDTH, 1, NULL, OPT_FORCE_MAX_SIMD_BITWIDTH_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 } }; @@ -1447,29 +1454,37 @@ 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 */ + case 'B': + fprintf(stderr, + "Option --pci-blacklist is deprecated, use -b, --block instead\n"); + /* fallthrough */ case 'b': - if (w_used) - goto bw_used; - if (eal_option_device_add(RTE_DEVTYPE_BLACKLISTED_PCI, + /* excluded list */ + if (i_used) + goto include_exclude; + if (eal_option_device_add(RTE_DEVTYPE_BLOCKED, 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, --pci-whitelist is deprecated, use -a, --allow option instead\n"); + /* fallthrough */ + case 'i': + /* include device list */ + if (x_used) + goto include_exclude; + if (eal_option_device_add(RTE_DEVTYPE_ALLOWED, optarg) < 0) { return -1; } - w_used = 1; + i_used = true; break; /* coremask */ case 'c': { @@ -1760,9 +1775,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; } @@ -1997,14 +2013,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" - " Prevent EAL from using this PCI device. The argument\n" - " format is .\n" - " -w, --"OPT_PCI_WHITELIST" Add a PCI device in white 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" + " -b, --"OPT_DEV_BLOCK" Add a device to the excluded list.\n" + " Prevent EAL from using this device. The argument\n" + " format for PCI devices is .\n" + " -a, --"OPT_DEV_ALLOW" Add a device to the included list.\n" + " Only use the specified devices. The argument format\n" + " for PCI devices is <[domain:]bus:devid.func>.\n" + " This option can be present several times.\n" + " [NOTE: " OPT_DEV_ALLOW " cannot be used with "OPT_DEV_BLOCK" option]\n" " --"OPT_VDEV" Add a virtual device.\n" " The argument format is [,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 aec8a17d722e..e621c26098c3 100644 --- a/lib/librte_eal/common/eal_options.h +++ b/lib/librte_eal/common/eal_options.h @@ -13,8 +13,15 @@ enum { /* long options mapped to a short option */ #define OPT_HELP "help" OPT_HELP_NUM = 'h', +#define OPT_DEV_ALLOW "allow" + OPT_DEV_ALLOW_NUM = 'a', +#define OPT_DEV_BLOCK "block" + OPT_DEV_BLOCK_NUM = 'b', + + /* legacy options that will be removed in next LTS */ #define OPT_PCI_BLACKLIST "pci-blacklist" - OPT_PCI_BLACKLIST_NUM = 'b', + OPT_PCI_BLACKLIST_NUM = 'B', + #define OPT_PCI_WHITELIST "pci-whitelist" OPT_PCI_WHITELIST_NUM = 'w', From patchwork Sat Oct 24 01:01:45 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 82055 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2CE87A04B0; Sat, 24 Oct 2020 03:03:20 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A73949AF1; Sat, 24 Oct 2020 03:02:08 +0200 (CEST) Received: from mail-pf1-f175.google.com (mail-pf1-f175.google.com [209.85.210.175]) by dpdk.org (Postfix) with ESMTP id 7F2E76CCB for ; Sat, 24 Oct 2020 03:02:02 +0200 (CEST) Received: by mail-pf1-f175.google.com with SMTP id x13so2784783pfa.9 for ; Fri, 23 Oct 2020 18:02:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=/FM/6WqHA/0RomRVrudvcyF/UMVw41qCLqizPMb8bHg=; b=EX6WYz1GF3dwh+o0GhZzSZu1ScwLOWmRy3PVlTSXgRD7SjamVgaaN/1/fB5MDIbZfX yCIothktA4dvpU9b7+k2UCSz77OS3RKbzP+xtVoV5dfsFVEoTekxw5sZmwhOh17w5SFW Tqxd/ENdrIkAnNJMCHlDDAnuVu7J/ZOZRZ6oshy4d8J0gpKwOpnpEy+wD47dAj8Eni4p zaB/TxPKVAKdBeYTqePJZL/99C3YFC6Lub7xWtB/yE0q5/soB0Yq+Hpk5WiS1rDTzywE Vpp/N6Hy1icOrkPBt9HUiSaaH4RuUBJFqHcU9Cl9N2Zkza9TR7MT36xWJkqOyhiSzO9A 8x7Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=/FM/6WqHA/0RomRVrudvcyF/UMVw41qCLqizPMb8bHg=; b=gOzmjFem+fvkclf+3JQBpougki4XIbH9zH6YYFquTeXhKQKLAr2l6sO6z73LbKBTFJ VnHZYwaHdT/kRWbffRtoiv3gboRSoBMoxoSw84zAqAnsRcGZcgqqxHTtc3UWjIhhvPQi Xv1BbUxreP/wO3voL1J7GRAHYEvx9x0FmaC4uwtS4wtWmSg5jTdZB16WhZ6RoOeGfrME OYUoGmavSQiKeXQ6XQgEhej9fLelx86HH4B9MBYCW5g8LaauxLJJiaxX8KC+cbdHGcJJ K4v3WuJgTaT5B9hOthwgRqpSBGFN4Bwr3+PIWvwvh0/g7PugL7BmCE4/tl3JQhfy8+s5 Zj1A== X-Gm-Message-State: AOAM533OxkB4wJ7Kf6cwCKrQ+jcSuWPh11Ya/rZGFI13EJPojC77lHdc PlHAnCdCQkslbyatZLO6jHqifZxfClbnH7JQ X-Google-Smtp-Source: ABdhPJz4fkOwX1+N3cX8mZVvLuL+6OH68FtFpuVIkB+WTgftYpc0JkfGYTTFk4N4rXsMAGIYMds58w== X-Received: by 2002:a63:1d22:: with SMTP id d34mr4140059pgd.152.1603501320072; Fri, 23 Oct 2020 18:02:00 -0700 (PDT) Received: from hermes.corp.microsoft.com (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id w19sm3356439pfn.174.2020.10.23.18.01.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Oct 2020 18:01:59 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Luca Boccassi Date: Fri, 23 Oct 2020 18:01:45 -0700 Message-Id: <20201024010146.27689-5-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201024010146.27689-1-stephen@networkplumber.org> References: <20200922143202.8755-1-stephen@networkplumber.org> <20201024010146.27689-1-stephen@networkplumber.org> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 4/5] app/test: use new allowlist and blocklist X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Test the renamed blocklist and allowlist arguments. Use new terms in test variable names as well. Signed-off-by: Stephen Hemminger Acked-by: Luca Boccassi --- 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 9eef1efbe565..988d054ba6c8 100644 --- a/app/test/autotest.py +++ b/app/test/autotest.py @@ -10,7 +10,7 @@ def usage(): print("Usage: autotest.py [test app|test iso image] ", - "[target] [whitelist|-blacklist]") + "[target] [allowlist|-blocklist]") if len(sys.argv) < 3: usage() @@ -18,18 +18,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]) @@ -39,8 +39,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 998fe57a55d1..9fb94ae27352 100644 --- a/app/test/autotest_runner.py +++ b/app/test/autotest_runner.py @@ -188,14 +188,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 = [] @@ -269,7 +269,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"] @@ -279,10 +279,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 f27a56e03390..d78eb04a25e4 100644 --- a/app/test/test.c +++ b/app/test/test.c @@ -61,7 +61,7 @@ do_recursive_call(void) { "test_main_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 da119d4e4a92..3d3032bb4577 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 allow "--allow" #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 allow 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_allow_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", "", ""}, + allow, "error", "", ""}, {prgname, prefix, mp_flag, - pci_whitelist, "0:0:0", "", ""}, + allow, "0:0:0", "", ""}, {prgname, prefix, mp_flag, - pci_whitelist, "0:error:0.1", "", ""}, + allow, "0:error:0.1", "", ""}, {prgname, prefix, mp_flag, - pci_whitelist, "0:0:0.1error", "", ""}, + allow, "0:0:0.1error", "", ""}, {prgname, prefix, mp_flag, - pci_whitelist, "error0:0:0.1", "", ""}, + allow, "error0:0:0.1", "", ""}, {prgname, prefix, mp_flag, - pci_whitelist, "0:0:0.1.2", "", ""}, + allow, "0:0:0.1.2", "", ""}, }; - /* Test with valid whitelist option */ + /* Test with valid allow option */ const char *wlval1[] = {prgname, prefix, mp_flag, - pci_whitelist, "00FF:09:0B.3"}; + allow, "00FF:09:0B.3"}; const char *wlval2[] = {prgname, prefix, mp_flag, - pci_whitelist, "09:0B.3", pci_whitelist, "0a:0b.1"}; + allow, "09:0B.3", allow, "0a:0b.1"}; const char *wlval3[] = {prgname, prefix, mp_flag, - pci_whitelist, "09:0B.3,type=test", - pci_whitelist, "08:00.1,type=normal", + allow, "09:0B.3,type=test", + allow, "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"); + "allow 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 allow\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 allow 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 allow + 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; @@ -1492,9 +1492,9 @@ test_eal_flags(void) return ret; } - ret = test_whitelist_flag(); + ret = test_allow_flag(); if (ret < 0) { - printf("Error in test_invalid_whitelist_flag()\n"); + printf("Error in test_invalid_allow_flag()\n"); return ret; } @@ -1546,7 +1546,7 @@ REGISTER_TEST_COMMAND(eal_flags_main_opt_autotest, test_main_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_allow_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); From patchwork Sat Oct 24 01:01:46 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 82056 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id A3493A04B0; Sat, 24 Oct 2020 03:03:39 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 27BB29AFF; Sat, 24 Oct 2020 03:02:12 +0200 (CEST) Received: from mail-pg1-f195.google.com (mail-pg1-f195.google.com [209.85.215.195]) by dpdk.org (Postfix) with ESMTP id 498048D9A for ; Sat, 24 Oct 2020 03:02:06 +0200 (CEST) Received: by mail-pg1-f195.google.com with SMTP id x13so2628351pgp.7 for ; Fri, 23 Oct 2020 18:02:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=wPRs8aG4ox2f+bEyC68rNZkgzHzSQF+6SAEd8LLetE8=; b=RO5YvQWecGtl7IEKtNuQdsP1JX17FNH3TUNStvnqsqdfa4ybZnaE41+jLu8/WykGDc HtC5gHa2F7JahBIhtOQPFf+3DiFdFYBRGVo8++OvpL6znAywSAIbqIH6IG6Nc339++yg +T2GPDfW/E0W48Rl0Jy8e3ewaJtAD2qZ46XVQiKiL6BfgMybaPVS3Yd/umlAovjXNPcH bG9bV3dtKv0TYj2ORBLrjEvCDliFuVLpYO+g+Bz4wWrzn9QIlAaRqS41aXtQ8BigmnXO OWQpJsVYhaQ4fZRQ05aN8xN/+hyIJu3qru/TjjNhWkYULbxUIkXYrJ3Qr2kLwkVG1e0y 4P1g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=wPRs8aG4ox2f+bEyC68rNZkgzHzSQF+6SAEd8LLetE8=; b=pbX8lSx5nrHC0E1Xeu2B5FUy+V0HkmLbC2k2MwwpdGLFvInUhXMV/Pk7mHYLKKvCXS Wt6QSCaVP5bEnLK1l8+GQKmznCco361ORcsezsWOhzor1Hb/Le2R/A49OufuLcWb85j3 umPhjGyKRig74EiiWUnZMM9gbaVH8zXr5qtWcyLyMEeZhjHX1it1PVG+1yFWfyJl64ll xOpfXaTs39KppiPPkpB/vKAikUxYy5kK0dVxNjBdN96kS32DKDbhapk2L5o04U63MfnM I45M8Sw0lAFoeAEUQ1waPfpoBYvzN5RGKj2CGsah0yTEzzThp3LosGzeTBzVVf2+Eq2G ratA== X-Gm-Message-State: AOAM532u+hf+Z5+3vS+ciY4WdK6ePCIWCIcV3OZk4e3PiR7ctJor0Bze mQxqC0HYSfgCISgZax+lnI2zzYiE2OT00rd4 X-Google-Smtp-Source: ABdhPJxiMSoJCO/R6ezDPI3qjgqH0wJiC6jkAJlxvRfWN++1IVZNpaZAjT7fumH8/s2Z8zBwatzMNA== X-Received: by 2002:a63:1903:: with SMTP id z3mr3961251pgl.449.1603501321650; Fri, 23 Oct 2020 18:02:01 -0700 (PDT) Received: from hermes.corp.microsoft.com (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id w19sm3356439pfn.174.2020.10.23.18.02.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Oct 2020 18:02:00 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Luca Boccassi Date: Fri, 23 Oct 2020 18:01:46 -0700 Message-Id: <20201024010146.27689-6-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20201024010146.27689-1-stephen@networkplumber.org> References: <20200922143202.8755-1-stephen@networkplumber.org> <20201024010146.27689-1-stephen@networkplumber.org> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 5/5] doc: change references to blacklist and whitelist X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" There are two areas where documentation needed update. The first was use of whitelist when describing address filtering. The other is the legacy -w whitelist option for PCI which is used in many examples Signed-off-by: Stephen Hemminger Acked-by: Luca Boccassi --- doc/guides/cryptodevs/dpaa2_sec.rst | 6 ++-- doc/guides/cryptodevs/dpaa_sec.rst | 6 ++-- doc/guides/cryptodevs/qat.rst | 12 ++++---- 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 | 18 ++++++------ doc/guides/nics/cxgbe.rst | 12 ++++---- doc/guides/nics/dpaa.rst | 6 ++-- doc/guides/nics/dpaa2.rst | 6 ++-- doc/guides/nics/enic.rst | 6 ++-- doc/guides/nics/fail_safe.rst | 16 +++++------ doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 16 +++++------ doc/guides/nics/ice.rst | 28 +++++++++++++------ doc/guides/nics/ixgbe.rst | 4 +-- doc/guides/nics/mlx4.rst | 18 ++++++------ doc/guides/nics/mlx5.rst | 14 +++++----- doc/guides/nics/nfb.rst | 2 +- doc/guides/nics/octeontx2.rst | 23 +++++++-------- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 2 +- doc/guides/nics/thunderx.rst | 4 +-- .../prog_guide/env_abstraction_layer.rst | 6 ++-- doc/guides/prog_guide/multi_proc_support.rst | 4 +-- doc/guides/prog_guide/poll_mode_drv.rst | 6 ++-- .../prog_guide/switch_representation.rst | 6 ++-- doc/guides/rel_notes/release_20_11.rst | 5 ++++ doc/guides/sample_app_ug/bbdev_app.rst | 14 +++++----- .../sample_app_ug/eventdev_pipeline.rst | 4 +-- doc/guides/sample_app_ug/ipsec_secgw.rst | 12 ++++---- doc/guides/sample_app_ug/l3_forward.rst | 7 +++-- .../sample_app_ug/l3_forward_access_ctrl.rst | 2 +- .../sample_app_ug/l3_forward_power_man.rst | 3 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/tools/cryptoperf.rst | 6 ++-- doc/guides/tools/flow-perf.rst | 2 +- doc/guides/tools/testregex.rst | 2 +- 41 files changed, 175 insertions(+), 155 deletions(-) diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst b/doc/guides/cryptodevs/dpaa2_sec.rst index 080768a2e766..83565d71752d 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 ---------------------------- +Allowing & Blocking +------------------- -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 da14a68d9cff..bac82421bca2 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 ---------------------------- +Allowing & Blocking +------------------- -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 f77ce91f76ee..f8d3d77474ff 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -127,7 +127,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 PCI 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. @@ -237,7 +237,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 RTE_CRYPTO_MAX_DEVS may be - increased or -w, pci-whitelist domain:bus:devid:func option may be used. + increased or -a, allow domain:bus:devid:func option may be used. QAT compression PMD needs intermediate buffers to support Deflate compression @@ -275,7 +275,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 + -a 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 @@ -632,19 +632,19 @@ Testing QAT SYM crypto PMD can be tested by running the test application:: cd .//app/test - ./dpdk-test -l1 -n1 -w + ./dpdk-test -l1 -n1 -a RTE>>cryptodev_qat_autotest QAT ASYM crypto PMD can be tested by running the test application:: cd .//app/test - ./dpdk-test -l1 -n1 -w + ./dpdk-test -l1 -n1 -a RTE>>cryptodev_qat_asym_autotest QAT compression PMD can be tested by running the test application:: cd .//app/test - ./dpdk-test -l1 -n1 -w + ./dpdk-test -l1 -n1 -a RTE>>compressdev_autotest diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst index 4f06e069847a..496b7199c8c9 100644 --- a/doc/guides/eventdevs/octeontx2.rst +++ b/doc/guides/eventdevs/octeontx2.rst @@ -55,7 +55,7 @@ Runtime Config Options upper limit for in-flight events. For example:: - -w 0002:0e:00.0,xae_cnt=16384 + -a 0002:0e:00.0,xae_cnt=16384 - ``Force legacy mode`` @@ -63,7 +63,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 + -a 0002:0e:00.0,single_ws=1 - ``Event Group QoS support`` @@ -78,7 +78,7 @@ Runtime Config Options default. For example:: - -w 0002:0e:00.0,qos=[1-50-50-50] + -a 0002:0e:00.0,qos=[1-50-50-50] - ``Selftest`` @@ -87,7 +87,7 @@ Runtime Config Options The tests are run once the vdev creation is successfully complete. For example:: - -w 0002:0e:00.0,selftest=1 + -a 0002:0e:00.0,selftest=1 - ``TIM disable NPA`` @@ -96,7 +96,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 + -a 0002:0e:00.0,tim_disable_npa=1 - ``TIM modify chunk slots`` @@ -107,7 +107,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 + -a 0002:0e:00.0,tim_chnk_slots=1023 - ``TIM enable arm/cancel statistics`` @@ -115,7 +115,7 @@ Runtime Config Options event timer adapter. For example:: - -w 0002:0e:00.0,tim_stats_ena=1 + -a 0002:0e:00.0,tim_stats_ena=1 - ``TIM limit max rings reserved`` @@ -125,7 +125,7 @@ Runtime Config Options rings. For example:: - -w 0002:0e:00.0,tim_rings_lmt=5 + -a 0002:0e:00.0,tim_rings_lmt=5 - ``TIM ring control internal parameters`` @@ -135,7 +135,7 @@ Runtime Config Options default values. For Example:: - -w 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0] + -a 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0] - ``Lock NPA contexts in NDC`` @@ -145,7 +145,7 @@ Runtime Config Options For example:: - -w 0002:0e:00.0,npa_lock_mask=0xf + -a 0002:0e:00.0,npa_lock_mask=0xf Debugging Options ----------------- 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 ``: - 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 542246df686a..043a1dcee109 100644 --- a/doc/guides/linux_gsg/build_sample_apps.rst +++ b/doc/guides/linux_gsg/build_sample_apps.rst @@ -53,7 +53,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b ``: - 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 01afa1b42f94..dbd48ab4fafa 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, --block <[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 ``-a`` option. -* ``-w, --pci-whitelist <[domain:]bus:devid.func>`` +* ``-a, --allow <[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 `` diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index 080b44955a11..ef8798569a80 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -93,11 +93,11 @@ parameter ``--vfio-vf-token``. 3. echo 2 > /sys/bus/pci/devices/0000:86:00.0/sriov_numvfs 4. Start the PF: - /app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ + /app/dpdk-testpmd -l 22-25 -n 4 -a 86:00.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i 5. Start the VF: - /app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ + /app/dpdk-testpmd -l 26-29 -n 4 -a 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 53f09a52dbb5..1272c1e72b7b 100644 --- a/doc/guides/mempool/octeontx2.rst +++ b/doc/guides/mempool/octeontx2.rst @@ -42,7 +42,7 @@ Runtime Config Options for the application. For example:: - -w 0002:02:00.0,max_pools=512 + -a 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. @@ -61,7 +61,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,npa_lock_mask=0xf + -a 0002:02:00.0,npa_lock_mask=0xf Debugging Options ~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index 2540ddd5c2f5..97033958b758 100644 --- a/doc/guides/nics/bnxt.rst +++ b/doc/guides/nics/bnxt.rst @@ -258,8 +258,8 @@ The BNXT PMD supports hardware-based packet filtering: Unicast MAC Filter ^^^^^^^^^^^^^^^^^^ -The application adds (or removes) MAC addresses to enable (or disable) -whitelist filtering to accept packets. +The application can add (or remove) MAC addresses to enable (or disable) +filtering on MAC address used to accept packets. .. code-block:: console @@ -269,8 +269,8 @@ whitelist filtering to accept packets. Multicast MAC Filter ^^^^^^^^^^^^^^^^^^^^ -Application adds (or removes) Multicast addresses to enable (or disable) -whitelist filtering to accept packets. +The application can add (or remove) Multicast addresses that enable (or disable) +filtering on multicast MAC address used 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. @@ -683,7 +683,7 @@ The feature uses a newly implemented control-plane firmware interface which optimizes flow insertions and deletions. This is a tech preview feature, and is disabled by default. It can be enabled -using bnxt devargs. For ex: "-w 0000:0d:00.0,host-based-truflow=1”. +using bnxt devargs. For ex: "-a 0000:0d:00.0,host-based-truflow=1”. Notes ----- @@ -725,7 +725,7 @@ when the PMD is initialized on a PF or trusted-VF. The user can specify the list of VF IDs of the VFs for which the representors are needed by using the ``devargs`` option ``representor``.:: - -w DBDF,representor=[0,1,4] + -a DBDF,representor=[0,1,4] Note that currently hot-plugging of representor ports is not supported so all the required representors must be specified on the creation of the PF or the @@ -750,12 +750,12 @@ same host domain, additional dev args have been added to the PMD. The sample command line with the new ``devargs`` looks like this:: - -w 0000:06:02.0,host-based-truflow=1,representor=[1],rep-based-pf=8,\ + -a 0000:06:02.0,host-based-truflow=1,representor=[1],rep-based-pf=8,\ rep-is-pf=1,rep-q-r2f=1,rep-fc-r2f=0,rep-q-f2r=1,rep-fc-f2r=1 .. code-block:: console - testpmd -l1-4 -n2 -w 0008:01:00.0,host-based-truflow=1,\ + testpmd -l1-4 -n2 -a 0008:01:00.0,host-based-truflow=1,\ representor=[0], rep-based-pf=8,rep-is-pf=0,rep-q-r2f=1,rep-fc-r2f=1,\ rep-q-f2r=0,rep-fc-f2r=1 --log-level="pmd.*",8 -- -i --rxq=3 --txq=3 diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 442ab1511c64..8c2985cad04a 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 allow/block a single port without +allowing/blocking the other ports on the same device. .. _t5-nics: @@ -96,7 +96,7 @@ be passed as part of EAL arguments. For example, .. code-block:: console - dpdk-testpmd -w 02:00.4,keep_ovlan=1 -- -i + dpdk-testpmd -a 02:00.4,keep_ovlan=1 -- -i Common Runtime Options ~~~~~~~~~~~~~~~~~~~~~~ @@ -301,7 +301,7 @@ CXGBE PF Only Runtime Options .. code-block:: console - dpdk-testpmd -w 02:00.4,filtermode=0x88 -- -i + dpdk-testpmd -a 02:00.4,filtermode=0x88 -- -i - ``filtermask`` (default **0**) @@ -328,7 +328,7 @@ CXGBE PF Only Runtime Options .. code-block:: console - dpdk-testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i + dpdk-testpmd -a 02:00.4,filtermode=0x88,filtermask=0x80 -- -i .. _driver-compilation: @@ -760,7 +760,7 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system. .. code-block:: console - .//app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + .//app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i Example output: diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 1deb7faaa50c..9ae5109234eb 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -163,10 +163,10 @@ Manager. this pool. -Whitelisting & Blacklisting ---------------------------- +Allowing & Blocking +------------------- -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 01e37d462102..b79780abc1a5 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -503,10 +503,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 ---------------------------- +Allowing & Blocking +------------------- -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 c62448768376..163ae3f47b11 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -305,7 +305,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 + -a 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 @@ -371,7 +371,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 + -a 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``). @@ -420,7 +420,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 + -a 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 e1b5c80d6c91..9a9cf5bfbc3d 100644 --- a/doc/guides/nics/fail_safe.rst +++ b/doc/guides/nics/fail_safe.rst @@ -48,7 +48,7 @@ Fail-safe command line parameters This parameter allows the user to define a sub-device. The ```` part of this parameter must be a valid device definition. It follows the same format - provided to any ``-w`` or ``--vdev`` options. + provided to any ``-a`` or ``--vdev`` options. Enclosing the device definition within parentheses here allows using additional sub-device parameters if need be. They will be passed on to the @@ -56,11 +56,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 an allowed device, using ``-a`` 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 command line, 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. @@ -111,8 +111,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 `. -#. 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 blocked from normal EAL + operations to avoid probing it twice, as the PCI bus is in blocklist mode. .. code-block:: console @@ -120,13 +120,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 blocked, 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 allow mode. .. code-block:: console diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 234bf066b9f6..6458bfc42e1f 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -261,7 +261,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 incoming filtering of 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/i40e.rst b/doc/guides/nics/i40e.rst index 5cf85d94cc34..488a9ec22450 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -172,7 +172,7 @@ Runtime Config Options The number of reserved queue per VF is determined by its host PF. If the PCI address of an i40e PF is aaaa:bb.cc, the number of reserved queues per - VF can be configured with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. + VF can be configured with EAL parameter like -a aaaa:bb.cc,queue-num-per-vf=n. The value n can be 1, 2, 4, 8 or 16. If no such parameter is configured, the number of reserved queues per VF is 4 by default. If VF request more than reserved queues per VF, PF will able to allocate max to 16 queues after a VF @@ -185,7 +185,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 + -a 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 @@ -200,7 +200,7 @@ Runtime Config Options port representors for on initialization of the PF PMD by passing the VF IDs of the VFs which are required.:: - -w DBDF,representor=[0,1,4] + -a DBDF,representor=[0,1,4] Currently hot-plugging of representor ports is not supported so all required representors must be specified on the creation of the PF. @@ -212,7 +212,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 + -a 84:00.0,use-latest-supported-vec=1 - ``Enable validation for VF message`` (default ``not enabled``) @@ -222,7 +222,7 @@ Runtime Config Options Format -- "maximal-message@period-seconds:ignore-seconds" For example:: - -w 84:00.0,vf_msg_cfg=80@120:180 + -a 84:00.0,vf_msg_cfg=80@120:180 Vector RX Pre-conditions ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -458,7 +458,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 + -a 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. @@ -466,7 +466,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 + -a 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. @@ -802,7 +802,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:: - ./dpdk-l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \ + ./dpdk-l3fwd -l 18-21 -n 4 -a 82:00.0 -a 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 a2aea1233376..6e4d53968f75 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -30,7 +30,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 + -a 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, @@ -41,7 +41,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 @@ -53,7 +53,19 @@ Runtime Config Options use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``, for example:: - -w 80:00.0,pipeline-mode-support=1 + -a 80:00.0,pipeline-mode-support=1 + +- ``Flow Mark Support`` (default ``0``) + + This is a hint to the driver to select the data path that supports flow mark extraction + by default. + NOTE: This is an experimental devarg, it will be removed when any of below conditions + is ready. + 1) all data paths support flow mark (currently vPMD does not) + 2) a new offload like RTE_DEV_RX_OFFLOAD_FLOW_MARK be introduced as a standard way to hint. + Example:: + + -a 80:00.0,flow-mark-support=1 - ``Protocol extraction for per queue`` @@ -62,8 +74,8 @@ Runtime Config Options The argument format is:: - -w 18:00.0,proto_xtr=[...] - -w 18:00.0,proto_xtr= + -a 18:00.0,proto_xtr=[...] + -a 18:00.0,proto_xtr= Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character is used as a range separator and ``,`` is used as a single number separator. @@ -74,14 +86,14 @@ Runtime Config Options .. code-block:: console - dpdk-testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]' + dpdk-testpmd -a 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 - dpdk-testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]' + dpdk-testpmd -a 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. @@ -233,7 +245,7 @@ responses for the same from PF. #. Bind the VF0, and run testpmd with 'cap=dcf' devarg:: - dpdk-testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i + dpdk-testpmd -l 22-25 -n 4 -a 18:01.0,cap=dcf -- -i #. Monitor the VF2 interface network traffic:: diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst index 1f424b38ac3d..c801dbae8146 100644 --- a/doc/guides/nics/ixgbe.rst +++ b/doc/guides/nics/ixgbe.rst @@ -89,7 +89,7 @@ be passed as part of EAL arguments. For example, .. code-block:: console - testpmd -w af:10.0,pflink_fullchk=1 -- -i + testpmd -a af:10.0,pflink_fullchk=1 -- -i - ``pflink_fullchk`` (default **0**) @@ -277,7 +277,7 @@ option ``representor`` the user can specify which virtual functions to create port representors for on initialization of the PF PMD by passing the VF IDs of the VFs which are required.:: - -w DBDF,representor=[0,1,4] + -a DBDF,representor=[0,1,4] Currently hot-plugging of representor ports is not supported so all required representors must be specified on the creation of the PF. diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index ed920e91ad51..cea7e8c2c4e3 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -24,8 +24,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 use block (or allow) a single port without also +blocking (o allowing) 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 @@ -381,7 +381,7 @@ devices managed by librte_pmd_mlx4. eth4 eth5 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for use in allow argument:: { for intf in eth2 eth3 eth4 eth5; @@ -389,14 +389,14 @@ devices managed by librte_pmd_mlx4. (cd "/sys/class/net/${intf}/device/" && pwd -P); done; } | - sed -n 's,.*/\(.*\),-w \1,p' + sed -n 's,.*/\(.*\),-a \1,p' Example output:: - -w 0000:83:00.0 - -w 0000:83:00.0 - -w 0000:84:00.0 - -w 0000:84:00.0 + -a 0000:83:00.0 + -a 0000:83:00.0 + -a 0000:84:00.0 + -a 0000:84:00.0 .. note:: @@ -409,7 +409,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 -a 0000:83:00.0 -a 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 afa65a1379a5..5077e06a98a2 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -1488,7 +1488,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 use in allow list:: { for intf in eth2 eth3 eth4 eth5; @@ -1496,14 +1496,14 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. (cd "/sys/class/net/${intf}/device/" && pwd -P); done; } | - sed -n 's,.*/\(.*\),-w \1,p' + sed -n 's,.*/\(.*\),-a \1,p' Example output:: - -w 0000:05:00.1 - -w 0000:06:00.0 - -w 0000:06:00.1 - -w 0000:05:00.0 + -a 0000:05:00.1 + -a 0000:06:00.0 + -a 0000:06:00.1 + -a 0000:05:00.0 #. Request huge pages:: @@ -1511,7 +1511,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 -a 05:00.0 -a 05:00.1 -a 06:00.0 -a 06:00.1 -- --rxq=2 --txq=2 -i Example output:: diff --git a/doc/guides/nics/nfb.rst b/doc/guides/nics/nfb.rst index ecea3ecff074..e987f331048c 100644 --- a/doc/guides/nics/nfb.rst +++ b/doc/guides/nics/nfb.rst @@ -63,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - .//app/dpdk-testpmd -w b3:00.0,timestamp=1 -- + .//app/dpdk-testpmd -a b3:00.0,timestamp=1 -- When the timestamps are enabled with the *devarg*, a timestamp validity flag is set in the MBUFs containing received frames and timestamp is inserted into the `rte_mbuf` struct. diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst index 7c04b5e60040..3c42e8585835 100644 --- a/doc/guides/nics/octeontx2.rst +++ b/doc/guides/nics/octeontx2.rst @@ -63,7 +63,8 @@ for details. .. code-block:: console - .//app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + .//app/dpdk-testpmd -c 0x300 -a 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 @@ -116,7 +117,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,reta_size=256 + -a 0002:02:00.0,reta_size=256 With the above configuration, reta table of size 256 is populated. @@ -127,7 +128,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,flow_max_priority=10 + -a 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. @@ -139,7 +140,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,flow_prealloc_size=4 + -a 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. @@ -151,7 +152,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,max_sqb_count=64 + -a 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. @@ -163,7 +164,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,switch_header="higig2" + -a 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 @@ -185,7 +186,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 + -a 0002:02:00.0,tag_as_xor=1 - ``Max SPI for inbound inline IPsec`` (default ``1``) @@ -194,7 +195,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,ipsec_in_max_spi=128 + -a 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). @@ -205,7 +206,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,lock_rx_ctx=1 + -a 0002:02:00.0,lock_rx_ctx=1 - ``Lock Tx contexts in NDC cache`` @@ -213,7 +214,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,lock_tx_ctx=1 + -a 0002:02:00.0,lock_tx_ctx=1 .. note:: @@ -229,7 +230,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,npa_lock_mask=0xf + -a 0002:02:00.0,npa_lock_mask=0xf .. _otx2_tmapi: diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index 959b52c1c333..64322442a003 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -295,7 +295,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,...". +allow option like "-a 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..3ce696b605d1 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 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 a928a790e389..9da4281c8bd3 100644 --- a/doc/guides/nics/thunderx.rst +++ b/doc/guides/nics/thunderx.rst @@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - .//app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + .//app/dpdk-testpmd -l 0-3 -n 4 -a 0002:01:00.2 \ -- -i --no-flush-rx \ --port-topology=loop @@ -377,7 +377,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 + -a 0002:01:00.2,skip_data_bytes=8 Limitations ----------- diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index a470fd7f29bb..9af4d6192fd4 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -407,12 +407,12 @@ 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, +The EAL PCI device blocklist functionality can be used to mark certain NIC ports as unavailable, so they are ignored by the DPDK. -The ports to be blacklisted are identified using the PCIe* description (Domain:Bus:Device.Function). +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..2d083b8a4f68 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 allow and block 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/prog_guide/poll_mode_drv.rst b/doc/guides/prog_guide/poll_mode_drv.rst index 86e0a141e6c7..239ec820eaf5 100644 --- a/doc/guides/prog_guide/poll_mode_drv.rst +++ b/doc/guides/prog_guide/poll_mode_drv.rst @@ -374,9 +374,9 @@ parameters to those ports. this argument allows user to specify which switch ports to enable port representors for.:: - -w DBDF,representor=0 - -w DBDF,representor=[0,4,6,9] - -w DBDF,representor=[0-31] + -a DBDF,representor=0 + -a DBDF,representor=[0,4,6,9] + -a DBDF,representor=[0-31] Note: PMDs are not required to support the standard device arguments and users should consult the relevant PMD documentation to see support devargs. diff --git a/doc/guides/prog_guide/switch_representation.rst b/doc/guides/prog_guide/switch_representation.rst index cc1d0d7569cb..07ba12bea67e 100644 --- a/doc/guides/prog_guide/switch_representation.rst +++ b/doc/guides/prog_guide/switch_representation.rst @@ -59,9 +59,9 @@ which can be thought as a software "patch panel" front-end for applications. :: - -w pci:dbdf,representor=0 - -w pci:dbdf,representor=[0-3] - -w pci:dbdf,representor=[0,5-11] + -a pci:dbdf,representor=0 + -a pci:dbdf,representor=[0-3] + -a pci:dbdf,representor=[0,5-11] - As virtual devices, they may be more limited than their physical counterparts, for instance by exposing only a subset of device diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst index d8ac359e51d4..57069ae4db4c 100644 --- a/doc/guides/rel_notes/release_20_11.rst +++ b/doc/guides/rel_notes/release_20_11.rst @@ -543,6 +543,11 @@ API Changes * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size`` from ``struct rte_sched_subport_params``. +* eal: The definitions related to including and excluding devices + has been changed from blacklist/whitelist to include/exclude. + There are compatibility 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 ----------- diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index 7c5a45b72afb..b2af9a0755d6 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -61,19 +61,19 @@ 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 allow option for pci device running on 1 encoding lcore and 1 decoding lcore issue the command: .. code-block:: console - $ .//examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w \ + $ .//examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a \ -c 0x38 --socket-mem=2,2 --file-prefix=bbdev -- -e 0x10 -d 0x20 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 -the parameter -w. +device gets linked to a corresponding ethernet port as allowed by +the parameter -a. 3 cores are allocated to the application, and assigned as: - core 3 is the main and used to print the stats live on screen, @@ -93,20 +93,20 @@ 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 allowed ethernet ports. .. code-block:: console $ ./pktgen-3.4.0/app/x86_64-native-linux-gcc/pktgen -c 0x3 \ - --socket-mem=1,1 --file-prefix=pg -w -- -m 1.0 -P + --socket-mem=1,1 --file-prefix=pg -a -- -m 1.0 -P where: * ``-c COREMASK``: A hexadecimal bitmask of cores to run on * ``--socket-mem``: Memory to allocate on specific sockets (use comma separated values) * ``--file-prefix``: Prefix for hugepage filenames -* ``-w ``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a ``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. * ``-m ``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode diff --git a/doc/guides/sample_app_ug/eventdev_pipeline.rst b/doc/guides/sample_app_ug/eventdev_pipeline.rst index b4fc587a09e2..41ee8b7ee3f4 100644 --- a/doc/guides/sample_app_ug/eventdev_pipeline.rst +++ b/doc/guides/sample_app_ug/eventdev_pipeline.rst @@ -46,8 +46,8 @@ these settings is shown below: .. code-block:: console - .//examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 / - -e4 -w FF00 -s4 -n0 -c32 -W1000 -D + .//examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 \ + -e4 -a FF00 -s4 -n0 -c32 -W1000 -D The application has some sanity checking built-in, so if there is a function (e.g.; the RX core) which doesn't have a cpu core mask assigned, the application diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst index 1f37dccf8bb7..cb637abdfaf4 100644 --- a/doc/guides/sample_app_ug/ipsec_secgw.rst +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst @@ -323,15 +323,15 @@ 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 allowed the Ethernet devices needed and therefore implicitly +blocklisting all hardware crypto devices. For example, something like the following command line: .. code-block:: console .//examples/dpdk-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 \ + -a 81:00.0 -a 81:00.1 -a 81:00.2 -a 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)" \ @@ -929,13 +929,13 @@ The user must setup the following environment variables: * ``REMOTE_IFACE``: interface name for the test-port on the DUT. -* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-w ') +* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a ') Also the user can optionally setup: * ``SGW_LCORE``: lcore to run ipsec-secgw on (default value is 0) -* ``CRYPTO_DEV``: crypto device to be used ('-w '). If none specified +* ``CRYPTO_DEV``: crypto device to be used ('-a '). If none specified appropriate vdevs will be created by the script Scripts can be used for multiple test scenarios. To check all available @@ -1023,4 +1023,4 @@ Available options: * ``-h`` Show usage. If is specified, only tests for that mode will be invoked. For the -list of available modes please refer to run_test.sh. \ No newline at end of file +list of available modes please refer to run_test.sh. diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst index 7acbd7404e3b..5d53bf633db7 100644 --- a/doc/guides/sample_app_ug/l3_forward.rst +++ b/doc/guides/sample_app_ug/l3_forward.rst @@ -138,17 +138,18 @@ Following is the sample command: .. code-block:: console - .//examples/dpdk-l3fwd -l 0-3 -n 4 -w -- -p 0x3 --eventq-sched=ordered + .//examples/dpdk-l3fwd -l 0-3 -n 4 -a -- -p 0x3 --eventq-sched=ordered or .. code-block:: console - .//examples/dpdk-l3fwd -l 0-3 -n 4 -w -- -p 0x03 --mode=eventdev --eventq-sched=ordered + .//examples/dpdk-l3fwd -l 0-3 -n 4 -a \ + -- -p 0x03 --mode=eventdev --eventq-sched=ordered In this command: -* -w option whitelist the event device supported by platform. Way to pass this device may vary based on platform. +* -a option adds 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 4a96800ec648..eee5d8185061 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 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 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 d7e1dc581328..831f2bf58f99 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,8 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - .//examples/dpdk-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 + .//examples/dpdk-l3fwd-power -l xxx -n 4 -a 0000:xx:00.0 -a 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 a8bedbab5321..9a7743146b82 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 ./dpdk-vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \ - -w 0000:06:00.3,vdpa=1 -w 0000:06:00.4,vdpa=1 \ + -w 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive .. note:: diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index 29340d94e801..73cabf0098d3 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -394,7 +394,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 -a 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 @@ -404,7 +404,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 -a 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 @@ -414,7 +414,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 -a 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 7e5dc0c54b1a..4771e8ecf04d 100644 --- a/doc/guides/tools/flow-perf.rst +++ b/doc/guides/tools/flow-perf.rst @@ -59,7 +59,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 -a 08:00.0 -- --ingress --ether --ipv4 --queue --flows-count=1000000 The command line options are: diff --git a/doc/guides/tools/testregex.rst b/doc/guides/tools/testregex.rst index 4317aab533e2..112b2bb773e7 100644 --- a/doc/guides/tools/testregex.rst +++ b/doc/guides/tools/testregex.rst @@ -70,4 +70,4 @@ The data file, will be used as a source data for the RegEx to work on. The tool has a number of command line options. Here is the sample command line:: - ./dpdk-test-regex -w 83:00.0 -- --rules rule_file.rof2 --data data_file.txt --job 100 + ./dpdk-test-regex -a 83:00.0 -- --rules rule_file.rof2 --data data_file.txt --job 100