From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id C63F7A0540; Thu, 16 Jul 2020 01:04:33 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 585851BF0B; Thu, 16 Jul 2020 01:03:26 +0200 (CEST) Received: from mail-pg1-f196.google.com (mail-pg1-f196.google.com [209.85.215.196]) by dpdk.org (Postfix) with ESMTP id 10F051BEDF for ; Thu, 16 Jul 2020 01:03:22 +0200 (CEST) Received: by mail-pg1-f196.google.com with SMTP id w2so3838755pgg.10 for ; Wed, 15 Jul 2020 16:03:21 -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=2gwvhzvzqgPh0sihA0cuQTYg9CDgku4Q+EvkIjdjOe8=; b=TAf2d7hULNpiByUeD7dzc5UeHaM91P+fqlXjfQNOklBSPh6k/KhaklbhmKmD8wbVGH //4WERvlDDxbdyqKNC1qF8iI2JmsZoSTT05wm12gFah2wnVtOhgQr9VJQich3Z2RFcYA We8+J2Gd9kOQvo+6Tf8S+/A/hNHHAm8WzIG04We1akIy8+mlWYrr6xMZRBIgMyaAPFCn rRYNuVOQxdcNqnekGyXJpXw3qdGMQnY9xYN3piyfpCO828NliBKh0+YEqLNYfsHl+vv6 Q1T7vCmFUnCu3StigfrUzlJo69Bi7l40ZdzT+pY2DQ/tEFyEUgTAZcmdEP/0zOM4BwSB V3Pg== 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=2gwvhzvzqgPh0sihA0cuQTYg9CDgku4Q+EvkIjdjOe8=; b=Fr+YVX0+hfU7BSVWuE84FssQNqd6npIhn9gzU2fTQaeXzWPlE8ZkcbOT67nQv/CNEl zDjF0Q4ijxdE18mlRb7C+M6/Iw4m2Z1o1Y+MnzizOoPFG8YquJ84VQ980E1jI9wFjHXe Vr7MXbgXft8y3ApfDOxP4o4ztnc/0nlHW+o7w0CDbV3cQTLggHGUvJGHdAD3mGkcGqcc Jg5hPWPlSAJGiaJSEf5R6PO4ZTAzB0rND8bMl4tr6tlvO14uY/qqL3DGoknnH6h8vrS5 GcC5/ko4jEIeaxmI2gP6HmB5+h1nK3LrE4kaga7vBy+zmOFsd7MvgUYRJtO1XqBVBBMB 0TPA== X-Gm-Message-State: AOAM532YThQ1fbWbnCBSx9aRCz8GNqBdYBHSvHazb4Ic9TvD8KfX+Ums lgH5vpFQa/1jLDZIbjUDnc2EgjI+R0iW/w== X-Google-Smtp-Source: ABdhPJwrn3MGWcTMCwZxfIgznv42d69JQ7hWGOOk9PBxC2j+mEIbJrBFSLm/hUwvw4SrZ1uOtZlcbQ== X-Received: by 2002:a63:fc01:: with SMTP id j1mr1797567pgi.0.1594854199090; Wed, 15 Jul 2020 16:03:19 -0700 (PDT) Received: from hermes.lan (204-195-22-127.wavecable.com. [204.195.22.127]) by smtp.gmail.com with ESMTPSA id ji2sm2980888pjb.1.2020.07.15.16.03.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Jul 2020 16:03:17 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger , Luca Boccassi Date: Wed, 15 Jul 2020 16:02:57 -0700 Message-Id: <20200715230257.30810-10-stephen@networkplumber.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20200715230257.30810-1-stephen@networkplumber.org> References: <20200607170127.15694-1-stephen@networkplumber.org> <20200715230257.30810-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v5 9/9] doc: replace references to blacklist/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" The terms blacklist and whitelist are no longer used. Most of this was automatic replacement, but in a couple of places the language was awkward before and have tried to improve the readabilty. The blacklist/whitelist changes to API will not be a breaking change for applications in this release but worth adding a note to encourage migration. Update examples to new config options Replace -w with -i and -b with -x to reflect new usage. Signed-off-by: Stephen Hemminger Acked-by: Luca Boccassi --- doc/guides/cryptodevs/dpaa2_sec.rst | 4 ++-- doc/guides/cryptodevs/dpaa_sec.rst | 4 ++-- doc/guides/cryptodevs/qat.rst | 6 ++--- doc/guides/eventdevs/octeontx2.rst | 20 ++++++++--------- doc/guides/freebsd_gsg/build_sample_apps.rst | 2 +- doc/guides/linux_gsg/build_sample_apps.rst | 2 +- doc/guides/linux_gsg/eal_args.include.rst | 14 ++++++------ doc/guides/linux_gsg/linux_drivers.rst | 4 ++-- doc/guides/mempool/octeontx2.rst | 4 ++-- doc/guides/nics/bnxt.rst | 6 ++--- doc/guides/nics/cxgbe.rst | 12 +++++----- doc/guides/nics/dpaa.rst | 4 ++-- doc/guides/nics/dpaa2.rst | 4 ++-- doc/guides/nics/enic.rst | 12 +++++----- doc/guides/nics/fail_safe.rst | 22 +++++++++---------- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 12 +++++----- doc/guides/nics/ice.rst | 18 +++++++-------- doc/guides/nics/mlx4.rst | 16 +++++++------- doc/guides/nics/mlx5.rst | 12 +++++----- doc/guides/nics/octeontx2.rst | 22 +++++++++---------- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 10 ++++----- doc/guides/nics/thunderx.rst | 4 ++-- .../prog_guide/env_abstraction_layer.rst | 7 +++--- doc/guides/prog_guide/multi_proc_support.rst | 4 ++-- doc/guides/rel_notes/known_issues.rst | 4 ++-- doc/guides/rel_notes/release_20_08.rst | 6 +++++ doc/guides/rel_notes/release_2_1.rst | 2 +- doc/guides/sample_app_ug/bbdev_app.rst | 6 ++--- doc/guides/sample_app_ug/ipsec_secgw.rst | 6 ++--- doc/guides/sample_app_ug/l3_forward.rst | 2 +- .../sample_app_ug/l3_forward_access_ctrl.rst | 2 +- .../sample_app_ug/l3_forward_power_man.rst | 2 +- doc/guides/sample_app_ug/vdpa.rst | 2 +- doc/guides/tools/cryptoperf.rst | 6 ++--- doc/guides/tools/flow-perf.rst | 2 +- 37 files changed, 137 insertions(+), 132 deletions(-) diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst b/doc/guides/cryptodevs/dpaa2_sec.rst index 3053636b8295..363c52f0422f 100644 --- a/doc/guides/cryptodevs/dpaa2_sec.rst +++ b/doc/guides/cryptodevs/dpaa2_sec.rst @@ -134,10 +134,10 @@ Supported DPAA2 SoCs * LS2088A/LS2048A * LS1088A/LS1048A -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA2 SEC device, following commands can be used. +The DPAA2 SEC device can be blocked with the following: .. code-block:: console diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst index db3c8e918945..295164523d22 100644 --- a/doc/guides/cryptodevs/dpaa_sec.rst +++ b/doc/guides/cryptodevs/dpaa_sec.rst @@ -82,10 +82,10 @@ Supported DPAA SoCs * LS1046A/LS1026A * LS1043A/LS1023A -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA device, following commands can be used. +For blocking a DPAA device, following commands can be used. .. code-block:: console diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst index 7f4036c3210e..38e5b0a96206 100644 --- a/doc/guides/cryptodevs/qat.rst +++ b/doc/guides/cryptodevs/qat.rst @@ -126,7 +126,7 @@ Limitations optimisations in the GEN3 device. And if a GCM session is initialised on a GEN3 device, then attached to an op sent to a GEN1/GEN2 device, it will not be enqueued to the device and will be marked as failed. The simplest way to - mitigate this is to use the bdf whitelist to avoid mixing devices of different + mitigate this is to use the bdf allowlist to avoid mixing devices of different generations in the same process if planning to use for GCM. * The mixed algo feature on GEN2 is not supported by all kernel drivers. Check the notes under the Available Kernel Drivers table below for specific details. @@ -261,7 +261,7 @@ adjusted to the number of VFs which the QAT common code will need to handle. QAT VF may expose two crypto devices, sym and asym, it may happen that the number of devices will be bigger than MAX_DEVS and the process will show an error during PMD initialisation. To avoid this problem CONFIG_RTE_CRYPTO_MAX_DEVS may be - increased or -w, pci-whitelist domain:bus:devid:func option may be used. + increased or -w, pci-allowlist domain:bus:devid:func option may be used. QAT compression PMD needs intermediate buffers to support Deflate compression @@ -299,7 +299,7 @@ return 0 (thereby avoiding an MMIO) if the device is congested and number of pac possible to enqueue is smaller. To use this feature the user must set the parameter on process start as a device additional parameter:: - -w 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16 + -i 03:01.1,qat_sym_enq_threshold=32,qat_comp_enq_threshold=16 All parameters can be used with the same device regardless of order. Parameters are separated by comma. When the same parameter is used more than once first occurrence of the parameter diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst index 6502f6415fb4..470ea5450432 100644 --- a/doc/guides/eventdevs/octeontx2.rst +++ b/doc/guides/eventdevs/octeontx2.rst @@ -66,7 +66,7 @@ Runtime Config Options upper limit for in-flight events. For example:: - -w 0002:0e:00.0,xae_cnt=16384 + -i 0002:0e:00.0,xae_cnt=16384 - ``Force legacy mode`` @@ -74,7 +74,7 @@ Runtime Config Options single workslot mode in SSO and disable the default dual workslot mode. For example:: - -w 0002:0e:00.0,single_ws=1 + -i 0002:0e:00.0,single_ws=1 - ``Event Group QoS support`` @@ -89,7 +89,7 @@ Runtime Config Options default. For example:: - -w 0002:0e:00.0,qos=[1-50-50-50] + -i 0002:0e:00.0,qos=[1-50-50-50] - ``Selftest`` @@ -98,7 +98,7 @@ Runtime Config Options The tests are run once the vdev creation is successfully complete. For example:: - -w 0002:0e:00.0,selftest=1 + -i 0002:0e:00.0,selftest=1 - ``TIM disable NPA`` @@ -107,7 +107,7 @@ Runtime Config Options parameter disables NPA and uses software mempool to manage chunks For example:: - -w 0002:0e:00.0,tim_disable_npa=1 + -i 0002:0e:00.0,tim_disable_npa=1 - ``TIM modify chunk slots`` @@ -118,7 +118,7 @@ Runtime Config Options to SSO. The default value is 255 and the max value is 4095. For example:: - -w 0002:0e:00.0,tim_chnk_slots=1023 + -i 0002:0e:00.0,tim_chnk_slots=1023 - ``TIM enable arm/cancel statistics`` @@ -126,7 +126,7 @@ Runtime Config Options event timer adapter. For example:: - -w 0002:0e:00.0,tim_stats_ena=1 + -i 0002:0e:00.0,tim_stats_ena=1 - ``TIM limit max rings reserved`` @@ -136,7 +136,7 @@ Runtime Config Options rings. For example:: - -w 0002:0e:00.0,tim_rings_lmt=5 + -i 0002:0e:00.0,tim_rings_lmt=5 - ``TIM ring control internal parameters`` @@ -146,7 +146,7 @@ Runtime Config Options default values. For Example:: - -w 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0] + -i 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0] - ``Lock NPA contexts in NDC`` @@ -156,7 +156,7 @@ Runtime Config Options For example:: - -w 0002:0e:00.0,npa_lock_mask=0xf + -i 0002:0e:00.0,npa_lock_mask=0xf Debugging Options ~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/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 2f606535c374..ebc6e3e02d74 100644 --- a/doc/guides/linux_gsg/build_sample_apps.rst +++ b/doc/guides/linux_gsg/build_sample_apps.rst @@ -102,7 +102,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b ``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``: diff --git a/doc/guides/linux_gsg/eal_args.include.rst b/doc/guides/linux_gsg/eal_args.include.rst index 0fe44579689b..41f399ccd608 100644 --- a/doc/guides/linux_gsg/eal_args.include.rst +++ b/doc/guides/linux_gsg/eal_args.include.rst @@ -44,20 +44,20 @@ Lcore-related options Device-related options ~~~~~~~~~~~~~~~~~~~~~~ -* ``-b, --pci-blacklist <[domain:]bus:devid.func>`` +* ``-b, --pci-skip-probe <[domain:]bus:devid.func>`` - Blacklist a PCI device to prevent EAL from using it. Multiple -b options are - allowed. + Skip probing a PCI device to prevent EAL from using it. + Multiple -b options are allowed. .. Note:: - PCI blacklist cannot be used with ``-w`` option. + PCI skip probe cannot be used with the only list ``-w`` option. -* ``-w, --pci-whitelist <[domain:]bus:devid.func>`` +* ``-w, --pci-only-list <[domain:]bus:devid.func>`` - Add a PCI device in white list. + Add a PCI device in to the list of probed devices. .. Note:: - PCI whitelist cannot be used with ``-b`` option. + PCI only list cannot be used with the skip probe ``-b`` option. * ``--vdev `` diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index 4eda3d5bf4fe..0c6f9f8572ee 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -104,11 +104,11 @@ parameter ``--vfio-vf-token``. 3. echo 2 > /sys/bus/pci/devices/0000:86:00.0/sriov_numvfs 4. Start the PF: - ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -w 86:00.0 \ + ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -i 86:00.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i 5. Start the VF: - ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -w 86:02.0 \ + ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -i 86:02.0 \ --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d). diff --git a/doc/guides/mempool/octeontx2.rst b/doc/guides/mempool/octeontx2.rst index 49b45a04e8ec..507591d809c6 100644 --- a/doc/guides/mempool/octeontx2.rst +++ b/doc/guides/mempool/octeontx2.rst @@ -50,7 +50,7 @@ Runtime Config Options for the application. For example:: - -w 0002:02:00.0,max_pools=512 + -i 0002:02:00.0,max_pools=512 With the above configuration, the driver will set up only 512 mempools for the given application to save HW resources. @@ -69,7 +69,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,npa_lock_mask=0xf + -i 0002:02:00.0,npa_lock_mask=0xf Debugging Options ~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index 6ff75d0a25e9..716d02beba3c 100644 --- a/doc/guides/nics/bnxt.rst +++ b/doc/guides/nics/bnxt.rst @@ -259,7 +259,7 @@ Unicast MAC Filter ^^^^^^^^^^^^^^^^^^ The application adds (or removes) MAC addresses to enable (or disable) -whitelist filtering to accept packets. +allowlist filtering to accept packets. .. code-block:: console @@ -270,7 +270,7 @@ Multicast MAC Filter ^^^^^^^^^^^^^^^^^^^^ Application adds (or removes) Multicast addresses to enable (or disable) -whitelist filtering to accept packets. +allowlist filtering to accept packets. .. code-block:: console @@ -278,7 +278,7 @@ whitelist filtering to accept packets. testpmd> mcast_addr (add|remove) (port_id) (XX:XX:XX:XX:XX:XX) Application adds (or removes) Multicast addresses to enable (or disable) -whitelist filtering to accept packets. +allowlist filtering to accept packets. Note that the BNXT PMD supports up to 16 MC MAC filters. if the user adds more than 16 MC MACs, the BNXT PMD puts the port into the Allmulticast mode. diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 54a4c138998c..870904cfd9b0 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -40,8 +40,8 @@ expose a single PCI bus address, thus, librte_pmd_cxgbe registers itself as a PCI driver that allocates one Ethernet device per detected port. -For this reason, one cannot whitelist/blacklist a single port without -whitelisting/blacklisting the other ports on the same device. +For this reason, one cannot allowlist/blocklist a single port without +allowlisting/blocklisting the other ports on the same device. .. _t5-nics: @@ -112,7 +112,7 @@ be passed as part of EAL arguments. For example, .. code-block:: console - testpmd -w 02:00.4,keep_ovlan=1 -- -i + testpmd -i 02:00.4,keep_ovlan=1 -- -i Common Runtime Options ^^^^^^^^^^^^^^^^^^^^^^ @@ -317,7 +317,7 @@ CXGBE PF Only Runtime Options .. code-block:: console - testpmd -w 02:00.4,filtermode=0x88 -- -i + testpmd -i 02:00.4,filtermode=0x88 -- -i - ``filtermask`` (default **0**) @@ -344,7 +344,7 @@ CXGBE PF Only Runtime Options .. code-block:: console - testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i + testpmd -i 02:00.4,filtermode=0x88,filtermask=0x80 -- -i .. _driver-compilation: @@ -776,7 +776,7 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system. .. code-block:: console - ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -i 0000:02:00.4 -- -i Example output: diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 17839a920e60..efcbb7207734 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -162,10 +162,10 @@ Manager. this pool. -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA device, following commands can be used. +For blocking a DPAA device, following commands can be used. .. code-block:: console diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index fdfa6fdd5aea..91b5c59f8c0f 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -527,10 +527,10 @@ which are lower than logging ``level``. Using ``pmd.net.dpaa2`` as log matching criteria, all PMD logs can be enabled which are lower than logging ``level``. -Whitelisting & Blacklisting +Allowlisting & Blocklisting --------------------------- -For blacklisting a DPAA2 device, following commands can be used. +For blocking a DPAA2 device, following commands can be used. .. code-block:: console diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index a28a7f4e477a..a67f169a87a8 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -187,14 +187,14 @@ or ``vfio`` in non-IOMMU mode. In the VM, the kernel enic driver may be automatically bound to the VF during boot. Unbinding it currently hangs due to a known issue with the driver. To -work around the issue, blacklist the enic module as follows. +work around the issue, blocklist the enic module as follows. Please see :ref:`Limitations ` for limitations in the use of SR-IOV. .. code-block:: console # cat /etc/modprobe.d/enic.conf - blacklist enic + blocklist enic # dracut --force @@ -312,7 +312,7 @@ enables overlay offload, it prints the following message on the console. By default, PMD enables overlay offload if hardware supports it. To disable it, set ``devargs`` parameter ``disable-overlay=1``. For example:: - -w 12:00.0,disable-overlay=1 + -i 12:00.0,disable-overlay=1 By default, the NIC uses 4789 as the VXLAN port. The user may change it through ``rte_eth_dev_udp_tunnel_port_{add,delete}``. However, as @@ -378,7 +378,7 @@ vectorized handler, take the following steps. PMD consider the vectorized handler when selecting the receive handler. For example:: - -w 12:00.0,enable-avx2-rx=1 + -i 12:00.0,enable-avx2-rx=1 As the current implementation is intended for field trials, by default, the vectorized handler is not considered (``enable-avx2-rx=0``). @@ -427,7 +427,7 @@ DPDK as untagged packets. In this case mbuf->vlan_tci and the PKT_RX_VLAN and PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the ``devargs`` parameter ``ig-vlan-rewrite=untag``. For example:: - -w 12:00.0,ig-vlan-rewrite=untag + -i 12:00.0,ig-vlan-rewrite=untag - **SR-IOV** @@ -437,7 +437,7 @@ PKT_RX_VLAN_STRIPPED mbuf flags would not be set. This mode is enabled with the - VF devices are not usable directly from the host. They can only be used as assigned devices on VM instances. - Currently, unbind of the ENIC kernel mode driver 'enic.ko' on the VM - instance may hang. As a workaround, enic.ko should be blacklisted or removed + instance may hang. As a workaround, enic.ko should be blocklisted or removed from the boot process. - pci_generic cannot be used as the uio module in the VM. igb_uio or vfio in non-IOMMU mode can be used. diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst index b4a92f663b17..46d1224b048f 100644 --- a/doc/guides/nics/fail_safe.rst +++ b/doc/guides/nics/fail_safe.rst @@ -68,11 +68,11 @@ Fail-safe command line parameters .. note:: - In case where the sub-device is also used as a whitelist device, using ``-w`` + In case where the sub-device is also used as a allowlist device, using ``-w`` on the EAL command line, the fail-safe PMD will use the device with the options provided to the EAL instead of its own parameters. - When trying to use a PCI device automatically probed by the blacklist mode, + When trying to use a PCI device automatically probed by the blocklist mode, the name for the fail-safe sub-device must be the full PCI id: Domain:Bus:Device.Function, *i.e.* ``00:00:00.0`` instead of ``00:00.0``, as the second form is historically accepted by the DPDK. @@ -123,28 +123,28 @@ 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 blocklisted from normal EAL + operations to avoid probing it twice, as the PCI bus is in blocklist mode. .. code-block:: console $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ - -b 84:00.0 -b 00:04.0 -- -i + -x 84:00.0 -x 00:04.0 -- -i - If the sub-device ``84:00.0`` is not blacklisted, it will be probed by the + If the sub-device ``84:00.0`` is not blocklisted, it will be probed by the EAL first. When the fail-safe then tries to initialize it the probe operation fails. - Note that PCI blacklist mode is the default PCI operating mode. + Note that PCI blocklist mode is the default PCI operating mode. -#. Alternatively, it can be used alongside any other device in whitelist mode. +#. Alternatively, it can be used alongside any other device in allowlist mode. .. code-block:: console $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \ --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \ - -w 81:00.0 -- -i + -i 81:00.0 -- -i #. Start testpmd using a flexible device definition @@ -155,9 +155,9 @@ This section shows some example of using **testpmd** with a fail-safe PMD. #. Start testpmd, automatically probing the device 84:00.0 and using it with the fail-safe. - + .. code-block:: console - + $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \ --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index edd21c4d8e9d..6aecead6e019 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -247,7 +247,7 @@ Supports enabling/disabling receiving multicast frames. Unicast MAC filter ------------------ -Supports adding MAC addresses to enable whitelist filtering to accept packets. +Supports adding MAC addresses to enable allowlist filtering to accept packets. * **[implements] eth_dev_ops**: ``mac_addr_set``, ``mac_addr_add``, ``mac_addr_remove``. * **[implements] rte_eth_dev_data**: ``mac_addrs``. diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index cf1ae2d0b043..4f4072b3bf6f 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -203,7 +203,7 @@ Runtime Config Options Adapter with both Linux kernel and DPDK PMD. To fix this issue, ``devargs`` parameter ``support-multi-driver`` is introduced, for example:: - -w 84:00.0,support-multi-driver=1 + -i 84:00.0,support-multi-driver=1 With the above configuration, DPDK PMD will not change global registers, and will switch PF interrupt from IntN to Int0 to avoid interrupt conflict between @@ -230,7 +230,7 @@ Runtime Config Options since it can get better perf in some real work loading cases. So ``devargs`` param ``use-latest-supported-vec`` is introduced, for example:: - -w 84:00.0,use-latest-supported-vec=1 + -i 84:00.0,use-latest-supported-vec=1 - ``Enable validation for VF message`` (default ``not enabled``) @@ -240,7 +240,7 @@ Runtime Config Options Format -- "maximal-message@period-seconds:ignore-seconds" For example:: - -w 84:00.0,vf_msg_cfg=80@120:180 + -i 84:00.0,vf_msg_cfg=80@120:180 Vector RX Pre-conditions ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -475,7 +475,7 @@ no physical uplink on the associated NIC port. To enable this feature, the user should pass a ``devargs`` parameter to the EAL, for example:: - -w 84:00.0,enable_floating_veb=1 + -i 84:00.0,enable_floating_veb=1 In this configuration the PMD will use the floating VEB feature for all the VFs created by this PF device. @@ -483,7 +483,7 @@ VFs created by this PF device. Alternatively, the user can specify which VFs need to connect to this floating VEB using the ``floating_veb_list`` argument:: - -w 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4 + -i 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4 In this example ``VF1``, ``VF3`` and ``VF4`` connect to the floating VEB, while other VFs connect to the normal VEB. @@ -809,7 +809,7 @@ See :numref:`figure_intel_perf_test_setup` for the performance test setup. 7. The command line of running l3fwd would be something like the following:: - ./l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \ + ./l3fwd -l 18-21 -n 4 -i 82:00.0 -i 85:00.0 \ -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)' This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding, diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index 9a9f4a6bb093..93eb2f0c2264 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -50,7 +50,7 @@ Runtime Config Options But if user intend to use the device without OS package, user can take ``devargs`` parameter ``safe-mode-support``, for example:: - -w 80:00.0,safe-mode-support=1 + -i 80:00.0,safe-mode-support=1 Then the driver will be initialized successfully and the device will enter Safe Mode. NOTE: In Safe mode, only very limited features are available, features like RSS, @@ -61,7 +61,7 @@ Runtime Config Options In pipeline mode, a flow can be set at one specific stage by setting parameter ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with priority 0 located at the first pipeline stage which typically be used as a firewall - to drop the packet on a blacklist(we called it permission stage). At this stage, + to drop the packet on a blocklist(we called it permission stage). At this stage, flow rules are created for the device's exact match engine: switch. Flows with priority !0 located at the second stage, typically packets are classified here and be steered to specific queue or queue group (we called it distribution stage), At this stage, flow @@ -73,7 +73,7 @@ Runtime Config Options use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``, for example:: - -w 80:00.0,pipeline-mode-support=1 + -i 80:00.0,pipeline-mode-support=1 - ``Flow Mark Support`` (default ``0``) @@ -85,7 +85,7 @@ Runtime Config Options 2) a new offload like RTE_DEV_RX_OFFLOAD_FLOW_MARK be introduced as a standard way to hint. Example:: - -w 80:00.0,flow-mark-support=1 + -i 80:00.0,flow-mark-support=1 - ``Protocol extraction for per queue`` @@ -94,8 +94,8 @@ Runtime Config Options The argument format is:: - -w 18:00.0,proto_xtr=[...] - -w 18:00.0,proto_xtr= + -i 18:00.0,proto_xtr=[...] + -i 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. @@ -106,14 +106,14 @@ Runtime Config Options .. code-block:: console - testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]' + testpmd -i 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]' This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are VLAN extraction, other queues run with no protocol extraction. .. code-block:: console - testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]' + testpmd -i 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]' This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are IPv6 extraction, other queues use the default VLAN extraction. @@ -253,7 +253,7 @@ responses for the same from PF. #. Bind the VF0, and run testpmd with 'cap=dcf' devarg:: - testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i + testpmd -l 22-25 -n 4 -i 18:01.0,cap=dcf -- -i #. Monitor the VF2 interface network traffic:: diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 1f1e2f6c7767..f445dd51a65f 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -29,8 +29,8 @@ Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI bus address, thus unlike most drivers, librte_pmd_mlx4 registers itself as a PCI driver that allocates one Ethernet device per detected port. -For this reason, one cannot white/blacklist a single port without also -white/blacklisting the others on the same device. +For this reason, one cannot white/blocklist a single port without also +white/blocklisting the others on the same device. Besides its dependency on libibverbs (that implies libmlx4 and associated kernel support), librte_pmd_mlx4 relies heavily on system calls for control @@ -422,7 +422,7 @@ devices managed by librte_pmd_mlx4. eth4 eth5 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for allowlisting:: { for intf in eth2 eth3 eth4 eth5; @@ -434,10 +434,10 @@ devices managed by librte_pmd_mlx4. Example output:: - -w 0000:83:00.0 - -w 0000:83:00.0 - -w 0000:84:00.0 - -w 0000:84:00.0 + -i 0000:83:00.0 + -i 0000:83:00.0 + -i 0000:84:00.0 + -i 0000:84:00.0 .. note:: @@ -450,7 +450,7 @@ devices managed by librte_pmd_mlx4. #. Start testpmd with basic parameters:: - testpmd -l 8-15 -n 4 -w 0000:83:00.0 -w 0000:84:00.0 -- --rxq=2 --txq=2 -i + testpmd -l 8-15 -n 4 -i 0000:83:00.0 -i 0000:84:00.0 -- --rxq=2 --txq=2 -i Example output:: diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 4b6d8fb4d55b..bafabba518b5 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -1454,7 +1454,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. eth32 eth33 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for allowlisting:: { for intf in eth2 eth3 eth4 eth5; @@ -1466,10 +1466,10 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. Example output:: - -w 0000:05:00.1 - -w 0000:06:00.0 - -w 0000:06:00.1 - -w 0000:05:00.0 + -i 0000:05:00.1 + -i 0000:06:00.0 + -i 0000:06:00.1 + -i 0000:05:00.0 #. Request huge pages:: @@ -1477,7 +1477,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. #. Start testpmd with basic parameters:: - testpmd -l 8-15 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i + testpmd -l 8-15 -n 4 -i 05:00.0 -i 05:00.1 -i 06:00.0 -i 06:00.1 -- --rxq=2 --txq=2 -i Example output:: diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst index bb591a8b7e65..3d382446d1d1 100644 --- a/doc/guides/nics/octeontx2.rst +++ b/doc/guides/nics/octeontx2.rst @@ -74,7 +74,7 @@ use arm64-octeontx2-linux-gcc as target. .. code-block:: console - ./build/app/testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./build/app/testpmd -c 0x300 -i 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 EAL: Detected 24 lcore(s) EAL: Detected 1 NUMA nodes EAL: Multi-process socket /var/run/dpdk/rte/mp_socket @@ -127,7 +127,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,reta_size=256 + -i 0002:02:00.0,reta_size=256 With the above configuration, reta table of size 256 is populated. @@ -138,7 +138,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,flow_max_priority=10 + -i 0002:02:00.0,flow_max_priority=10 With the above configuration, priority level was set to 10 (0-9). Max priority level supported is 32. @@ -150,7 +150,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,flow_prealloc_size=4 + -i 0002:02:00.0,flow_prealloc_size=4 With the above configuration, pre alloc size was set to 4. Max pre alloc size supported is 32. @@ -162,7 +162,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,max_sqb_count=64 + -i 0002:02:00.0,max_sqb_count=64 With the above configuration, each send queue's decscriptor buffer count is limited to a maximum of 64 buffers. @@ -174,7 +174,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,switch_header="higig2" + -i 0002:02:00.0,switch_header="higig2" With the above configuration, higig2 will be enabled on that port and the traffic on this port should be higig2 traffic only. Supported switch header @@ -196,7 +196,7 @@ Runtime Config Options For example to select the legacy mode(RSS tag adder as XOR):: - -w 0002:02:00.0,tag_as_xor=1 + -i 0002:02:00.0,tag_as_xor=1 - ``Max SPI for inbound inline IPsec`` (default ``1``) @@ -205,7 +205,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,ipsec_in_max_spi=128 + -i 0002:02:00.0,ipsec_in_max_spi=128 With the above configuration, application can enable inline IPsec processing on 128 SAs (SPI 0-127). @@ -216,7 +216,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,lock_rx_ctx=1 + -i 0002:02:00.0,lock_rx_ctx=1 - ``Lock Tx contexts in NDC cache`` @@ -224,7 +224,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,lock_tx_ctx=1 + -i 0002:02:00.0,lock_tx_ctx=1 .. note:: @@ -240,7 +240,7 @@ Runtime Config Options For example:: - -w 0002:02:00.0,npa_lock_mask=0xf + -i 0002:02:00.0,npa_lock_mask=0xf .. _otx2_tmapi: diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index be1c2fe1d67e..44115a666a94 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -290,7 +290,7 @@ Per-Device Parameters ~~~~~~~~~~~~~~~~~~~~~ The following per-device parameters can be passed via EAL PCI device -whitelist option like "-w 02:00.0,arg1=value1,...". +allowlist option like "-w 02:00.0,arg1=value1,...". Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify boolean parameters value. diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst index 7e44f846206c..b5a0f51988aa 100644 --- a/doc/guides/nics/tap.rst +++ b/doc/guides/nics/tap.rst @@ -183,15 +183,15 @@ following:: sudo ./app/app/x86_64-native-linux-gcc/app/pktgen -l 1-5 -n 4 \ --proc-type auto --log-level debug --socket-mem 512,512 --file-prefix pg \ - --vdev=net_tap0 --vdev=net_tap1 -b 05:00.0 -b 05:00.1 \ - -b 04:00.0 -b 04:00.1 -b 04:00.2 -b 04:00.3 \ - -b 81:00.0 -b 81:00.1 -b 81:00.2 -b 81:00.3 \ - -b 82:00.0 -b 83:00.0 -- -T -P -m [2:3].0 -m [4:5].1 \ + --vdev=net_tap0 --vdev=net_tap1 -x 05:00.0 -x 05:00.1 \ + -x 04:00.0 -x 04:00.1 -x 04:00.2 -x 04:00.3 \ + -x 81:00.0 -x 81:00.1 -x 81:00.2 -x 81:00.3 \ + -x 82:00.0 -x 83:00.0 -- -T -P -m [2:3].0 -m [4:5].1 \ -f themes/black-yellow.theme .. Note: - Change the ``-b`` options to blacklist all of your physical ports. The + Change the ``-x`` options to exclude all of your physical ports. The following command line is all one line. Also, ``-f themes/black-yellow.theme`` is optional if the default colors diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst index f42133e5464d..f1b27a3f269c 100644 --- a/doc/guides/nics/thunderx.rst +++ b/doc/guides/nics/thunderx.rst @@ -178,7 +178,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./arm64-thunderx-linux-gcc/app/testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + ./arm64-thunderx-linux-gcc/app/testpmd -l 0-3 -n 4 -i 0002:01:00.2 \ -- -i --no-flush-rx \ --port-topology=loop @@ -398,7 +398,7 @@ This scheme is useful when application would like to insert vlan header without Example: .. code-block:: console - -w 0002:01:00.2,skip_data_bytes=8 + -i 0002:01:00.2,skip_data_bytes=8 Limitations ----------- diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst index f64ae953d106..5965c15baa43 100644 --- a/doc/guides/prog_guide/env_abstraction_layer.rst +++ b/doc/guides/prog_guide/env_abstraction_layer.rst @@ -407,12 +407,11 @@ device having emitted a Device Removal Event. In such case, calling callback. Care must be taken not to close the device from the interrupt handler context. It is necessary to reschedule such closing operation. -Blacklisting +Blocklisting ~~~~~~~~~~~~ -The EAL PCI device blacklist functionality can be used to mark certain NIC ports as blacklisted, -so they are ignored by the DPDK. -The ports to be blacklisted are identified using the PCIe* description (Domain:Bus:Device.Function). +The EAL PCI device blocklist functionality can be used to mark certain NIC ports as unavailale, so they are ignored by the DPDK. +The ports to be blocklisted are identified using the PCIe* description (Domain:Bus:Device.Function). Misc Functions ~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst index a84083b96c8a..14cb6db85661 100644 --- a/doc/guides/prog_guide/multi_proc_support.rst +++ b/doc/guides/prog_guide/multi_proc_support.rst @@ -30,7 +30,7 @@ after a primary process has already configured the hugepage shared memory for th Secondary processes should run alongside primary process with same DPDK version. Secondary processes which requires access to physical devices in Primary process, must - be passed with the same whitelist and blacklist options. + be passed with the same allowlist and blocklist options. To support these two process types, and other multi-process setups described later, two additional command-line parameters are available to the EAL: @@ -131,7 +131,7 @@ can use). .. note:: Independent DPDK instances running side-by-side on a single machine cannot share any network ports. - Any network ports being used by one process should be blacklisted in every other process. + Any network ports being used by one process should be blocklisted in every other process. Running Multiple Independent Groups of DPDK Applications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst index de0782136d3c..83a3b38c0ae0 100644 --- a/doc/guides/rel_notes/known_issues.rst +++ b/doc/guides/rel_notes/known_issues.rst @@ -523,8 +523,8 @@ Devices bound to igb_uio with VT-d enabled do not work on Linux kernel 3.15-3.17 DMAR:[fault reason 02] Present bit in context entry is clear **Resolution/Workaround**: - Use earlier or later kernel versions, or avoid driver binding on boot by blacklisting the driver modules. - I.e., in the case of ``ixgbe``, we can pass the kernel command line option: ``modprobe.blacklist=ixgbe``. + Use earlier or later kernel versions, or avoid driver binding on boot by blocklisting the driver modules. + I.e., in the case of ``ixgbe``, we can pass the kernel command line option: ``modprobe.blocklist=ixgbe``. This way we do not need to unbind the device to bind it to igb_uio. **Affected Environment/Platform**: diff --git a/doc/guides/rel_notes/release_20_08.rst b/doc/guides/rel_notes/release_20_08.rst index f19b748728e4..b9509f657b30 100644 --- a/doc/guides/rel_notes/release_20_08.rst +++ b/doc/guides/rel_notes/release_20_08.rst @@ -261,6 +261,12 @@ API Changes * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per queue and not per device, a qid parameter was added to the arguments list. +* eal: The definitions related to including and excluding devices + has been changed from blacklist/whitelist to include/exclude. + There are compatiablity macros and command line mapping to accept + the old values but applications and scripts are strongly encouraged + to migrate to the new names. + ABI Changes ----------- diff --git a/doc/guides/rel_notes/release_2_1.rst b/doc/guides/rel_notes/release_2_1.rst index beadc51ba438..6339172c64fa 100644 --- a/doc/guides/rel_notes/release_2_1.rst +++ b/doc/guides/rel_notes/release_2_1.rst @@ -472,7 +472,7 @@ Resolved Issues * **devargs: Fix crash on failure.** - This problem occurred when passing an invalid PCI id to the blacklist API in + This problem occurred when passing an invalid PCI id to the blocklist API in devargs. diff --git a/doc/guides/sample_app_ug/bbdev_app.rst b/doc/guides/sample_app_ug/bbdev_app.rst index 405e706a46e4..b722d0263772 100644 --- a/doc/guides/sample_app_ug/bbdev_app.rst +++ b/doc/guides/sample_app_ug/bbdev_app.rst @@ -79,7 +79,7 @@ This means that HW baseband device/s must be bound to a DPDK driver or a SW baseband device/s (virtual BBdev) must be created (using --vdev). To run the application in linux environment with the turbo_sw baseband device -using the whitelisted port running on 1 encoding lcore and 1 decoding lcore +using the allowlisted port running on 1 encoding lcore and 1 decoding lcore issue the command: .. code-block:: console @@ -90,7 +90,7 @@ issue the command: where, NIC0PCIADDR is the PCI address of the Rx port This command creates one virtual bbdev devices ``baseband_turbo_sw`` where the -device gets linked to a corresponding ethernet port as whitelisted by +device gets linked to a corresponding ethernet port as allowlisted by the parameter -w. 3 cores are allocated to the application, and assigned as: @@ -111,7 +111,7 @@ Using Packet Generator with baseband device sample application To allow the bbdev sample app to do the loopback, an influx of traffic is required. This can be done by using DPDK Pktgen to burst traffic on two ethernet ports, and it will print the transmitted along with the looped-back traffic on Rx ports. -Executing the command below will generate traffic on the two whitelisted ethernet +Executing the command below will generate traffic on the two allowlisted ethernet ports. .. code-block:: console diff --git a/doc/guides/sample_app_ug/ipsec_secgw.rst b/doc/guides/sample_app_ug/ipsec_secgw.rst index 81c5d4360615..fac75819a762 100644 --- a/doc/guides/sample_app_ug/ipsec_secgw.rst +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst @@ -329,15 +329,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 allowlist the Ethernet devices needed and therefore implicitly +blocklisting all hardware crypto devices. For example, something like the following command line: .. code-block:: console ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \ - -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3 \ + -i 81:00.0 -i 81:00.1 -i 81:00.2 -i 81:00.3 \ --vdev "crypto_aesni_mb" --vdev "crypto_null" \ -- \ -p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \ diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst index 07c8d44936d6..69a29ab1314e 100644 --- a/doc/guides/sample_app_ug/l3_forward.rst +++ b/doc/guides/sample_app_ug/l3_forward.rst @@ -148,7 +148,7 @@ or In this command: -* -w option whitelist the event device supported by platform. Way to pass this device may vary based on platform. +* -w option allowlist the event device supported by platform. Way to pass this device may vary based on platform. * The --mode option defines PMD to be used for packet I/O. diff --git a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst index a44fbcd52c3a..473326275e49 100644 --- a/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +++ b/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst @@ -18,7 +18,7 @@ The application loads two types of rules at initialization: * Route information rules, which are used for L3 forwarding -* Access Control List (ACL) rules that blacklist (or block) packets with a specific characteristic +* Access Control List (ACL) rules that blocklist (or block) packets with a specific characteristic When packets are received from a port, the application extracts the necessary information from the TCP/IP header of the received packet and diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst index 0cc6f2e62e75..4cc55004cca8 100644 --- a/doc/guides/sample_app_ug/l3_forward_power_man.rst +++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst @@ -378,7 +378,7 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - ./l3fwd-power -l xxx -n 4 -w 0000:xx:00.0 -w 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll="0,0,0" -l 14 -m 9 -h 1 + ./l3fwd-power -l xxx -n 4 -i 0000:xx:00.0 -i 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll="0,0,0" -l 14 -m 9 -h 1 Where, diff --git a/doc/guides/sample_app_ug/vdpa.rst b/doc/guides/sample_app_ug/vdpa.rst index d66a724827af..e388c738a1e3 100644 --- a/doc/guides/sample_app_ug/vdpa.rst +++ b/doc/guides/sample_app_ug/vdpa.rst @@ -52,7 +52,7 @@ Take IFCVF driver for example: .. code-block:: console ./vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \ - -w 0000:06:00.3,vdpa=1 -w 0000:06:00.4,vdpa=1 \ + -i 0000:06:00.3,vdpa=1 -i 0000:06:00.4,vdpa=1 \ -- --interactive .. note:: diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index 28b729dbda8b..334a4f558abd 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -417,7 +417,7 @@ Call application for performance throughput test of single Aesni MB PMD for cipher encryption aes-cbc and auth generation sha1-hmac, one million operations, burst size 32, packet size 64:: - dpdk-test-crypto-perf -l 6-7 --vdev crypto_aesni_mb -w 0000:00:00.0 -- + dpdk-test-crypto-perf -l 6-7 --vdev crypto_aesni_mb -i 0000:00:00.0 -- --ptest throughput --devtype crypto_aesni_mb --optype cipher-then-auth --cipher-algo aes-cbc --cipher-op encrypt --cipher-key-sz 16 --auth-algo sha1-hmac --auth-op generate --auth-key-sz 64 --digest-sz 12 @@ -427,7 +427,7 @@ Call application for performance latency test of two Aesni MB PMD executed on two cores for cipher encryption aes-cbc, ten operations in silent mode:: dpdk-test-crypto-perf -l 4-7 --vdev crypto_aesni_mb1 - --vdev crypto_aesni_mb2 -w 0000:00:00.0 -- --devtype crypto_aesni_mb + --vdev crypto_aesni_mb2 -i 0000:00:00.0 -- --devtype crypto_aesni_mb --cipher-algo aes-cbc --cipher-key-sz 16 --cipher-iv-sz 16 --cipher-op encrypt --optype cipher-only --silent --ptest latency --total-ops 10 @@ -437,7 +437,7 @@ for cipher encryption aes-gcm and auth generation aes-gcm,ten operations in silent mode, test vector provide in file "test_aes_gcm.data" with packet verification:: - dpdk-test-crypto-perf -l 4-7 --vdev crypto_openssl -w 0000:00:00.0 -- + dpdk-test-crypto-perf -l 4-7 --vdev crypto_openssl -i 0000:00:00.0 -- --devtype crypto_openssl --aead-algo aes-gcm --aead-key-sz 16 --aead-iv-sz 16 --aead-op encrypt --aead-aad-sz 16 --digest-sz 16 --optype aead --silent --ptest verify --total-ops 10 diff --git a/doc/guides/tools/flow-perf.rst b/doc/guides/tools/flow-perf.rst index cdedaf9a97d4..c03681525e60 100644 --- a/doc/guides/tools/flow-perf.rst +++ b/doc/guides/tools/flow-perf.rst @@ -61,7 +61,7 @@ with a ``--`` separator: .. code-block:: console - sudo ./dpdk-test-flow_perf -n 4 -w 08:00.0 -- --ingress --ether --ipv4 --queue --flows-count=1000000 + sudo ./dpdk-test-flow_perf -n 4 -i 08:00.0 -- --ingress --ether --ipv4 --queue --flows-count=1000000 The command line options are: -- 2.27.0