replace blacklist/whitelist with block/allow
Subsystems (4)
PATCH v6 5/5 doc: change references to blacklist and whitelist
In reply to Stephen HemmingerThere 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
--- 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(-)
doc/guides/cryptodevs/dpaa2_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/dpaa_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/qat.rst +6 -6
@@ -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 ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_autotest QAT ASYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_asym_autotest QAT compression PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>compressdev_autotest
doc/guides/eventdevs/octeontx2.rst +10 -10
@@ -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 -----------------
doc/guides/freebsd_gsg/build_sample_apps.rst +1 -1
@@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows: is a list of cores to use instead of a core mask. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -53,7 +53,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/eal_args.include.rst +7 -7
@@ -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 <device arguments>``
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -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: - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ + <build_dir>/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: - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ + <build_dir>/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).
doc/guides/mempool/octeontx2.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~
doc/guides/nics/bnxt.rst +9 -9
@@ -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
doc/guides/nics/cxgbe.rst +6 -6
@@ -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 - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/dpaa.rst +3 -3
@@ -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
doc/guides/nics/dpaa2.rst +3 -3
@@ -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
doc/guides/nics/enic.rst +3 -3
@@ -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**
doc/guides/nics/fail_safe.rst +8 -8
@@ -48,7 +48,7 @@ Fail-safe command line parameters This parameter allows the user to define a sub-device. The ``<iface>`` 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 <pmd_build_and_test>`. -#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL - operations to avoid probing it twice, as the PCI bus is in blacklist mode. +#. Start testpmd. The sub-device ``84:00.0`` should be 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
doc/guides/nics/features.rst +1 -1
@@ -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``.
doc/guides/nics/i40e.rst +8 -8
@@ -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,
doc/guides/nics/ice.rst +20 -8
@@ -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=<queues:protocol>[<queues:protocol>...] - -w 18:00.0,proto_xtr=<protocol> + -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...] + -a 18:00.0,proto_xtr=<protocol> Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
@@ -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::
doc/guides/nics/ixgbe.rst +2 -2
@@ -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.
doc/guides/nics/mlx4.rst +9 -9
@@ -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::
doc/guides/nics/mlx5.rst +7 -7
@@ -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::
doc/guides/nics/nfb.rst +1 -1
@@ -63,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> + ./<build_dir>/app/dpdk-testpmd -a b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> 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.
doc/guides/nics/octeontx2.rst +12 -11
@@ -63,7 +63,8 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/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:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -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.
doc/guides/nics/tap.rst +1 -1
@@ -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
doc/guides/nics/thunderx.rst +2 -2
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + ./<build_dir>/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 -----------
doc/guides/prog_guide/env_abstraction_layer.rst +3 -3
@@ -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 ~~~~~~~~~~~~~~
doc/guides/prog_guide/multi_proc_support.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/poll_mode_drv.rst +3 -3
@@ -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.
doc/guides/prog_guide/switch_representation.rst +3 -3
@@ -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
doc/guides/rel_notes/release_20_11.rst +5 -0
@@ -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 -----------
doc/guides/sample_app_ug/bbdev_app.rst +7 -7
@@ -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 - $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> \ + $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ -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 <NIC1PCIADDR> -- -m 1.0 -P + --socket-mem=1,1 --file-prefix=pg -a <NIC1PCIADDR> -- -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 <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. * ``-m <string>``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode
doc/guides/sample_app_ug/eventdev_pipeline.rst +2 -2
@@ -46,8 +46,8 @@ these settings is shown below: .. code-block:: console - ./<build_dir>/examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 / - -e4 -w FF00 -s4 -n0 -c32 -W1000 -D + ./<build_dir>/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
doc/guides/sample_app_ug/ipsec_secgw.rst +6 -6
@@ -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 ./<build_dir>/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 <pci-id>') +* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a <pci-id>') 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 <pci-id>'). If none specified +* ``CRYPTO_DEV``: crypto device to be used ('-a <pci-id>'). 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 <ipsec_mode> is specified, only tests for that mode will be invoked. For the -list of available modes please refer to run_test.sh. +list of available modes please refer to run_test.sh.
doc/guides/sample_app_ug/l3_forward.rst +4 -3
@@ -138,17 +138,18 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + -- -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.
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +1 -1
@@ -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
doc/guides/sample_app_ug/l3_forward_power_man.rst +2 -1
@@ -378,7 +378,8 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - ./<build_dir>/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 + ./<build_dir>/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,
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -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::
doc/guides/tools/cryptoperf.rst +3 -3
@@ -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
doc/guides/tools/flow-perf.rst +1 -1
@@ -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:
doc/guides/tools/testregex.rst +1 -1
@@ -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
Signature · 1 line
2.27.0
v7 cover replace blacklist/whitelist with allow/block
In reply to Stephen HemmingerThis patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v7 - fix options handling changes in test code.
this should fix the CI failures.
v6 - fix some confusion in handling options that was introduced
by earlier versions of the patch.
Stephen Hemminger (5):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options
doc: change references to blacklist and whitelist app/test: use new allowlist and blocklist
app/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 ++++++++------- 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 +- 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 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 67 ++++++++++++------- lib/librte_eal/common/eal_options.h | 9 ++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 58 files changed, 327 insertions(+), 272 deletions(-)
Signature · 1 line
2.27.0
PATCH v7 1/5 eal: replace usage of blacklist/whitelist in enum
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.
--- 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(-)
lib/librte_eal/common/eal_common_devargs.c +7 -7
@@ -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 ;
lib/librte_eal/include/rte_bus.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_dev.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_devargs.h +8 -2
@@ -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 *
Signature · 1 line
2.27.0
PATCH v7 2/5 drivers: replace references to blacklist
In reply to Stephen HemmingerUse the new terminology blocked to describe when devices are excluded from being used.
--- 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(-)
drivers/bus/dpaa/dpaa_bus.c +3 -4
@@ -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",
drivers/bus/fslmc/fslmc_bus.c +4 -5
@@ -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" );
drivers/bus/fslmc/fslmc_vfio.c +6 -6
@@ -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 ;
drivers/bus/pci/pci_common.c +10 -14
@@ -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 ; }
drivers/bus/vmbus/vmbus_common.c +2 -2
@@ -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,
drivers/crypto/virtio/virtio_pci.c +1 -1
@@ -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. */
drivers/net/virtio/virtio_pci.c +1 -1
@@ -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. */
Signature · 1 line
2.27.0
PATCH v7 3/5 eal: replace pci-whitelist/pci-blacklist options
In reply to Stephen HemmingerReplace -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.
--- lib/librte_eal/common/eal_common_options.c | 67 +++++++++++++--------- lib/librte_eal/common/eal_options.h | 9 ++- 2 files changed, 49 insertions(+), 27 deletions(-)
lib/librte_eal/common/eal_common_options.c +41 -26
@@ -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 } };
@@ -1448,28 +1455,35 @@ eal_parse_common_option(int opt, const char *optarg, struct internal_config *conf) {static int b_used; -static int w_used; +static int a_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 , - optarg) <0 ) { +/* excluded list */ +if (a_used) + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_BLOCKED , optarg) <0 ) {return -1 ; } b_used =1 ;break ; -/* whitelist */ +case 'w' : +fprintf (stderr, +"Option -w, --pci-whitelist is deprecated, use -a, --allow option instead\n" ); +/* fallthrough */ +case 'a' : +/* include device list */ if (b_used) - goto bw_used; -if (eal_option_device_add (RTE_DEVTYPE_WHITELISTED_PCI , - optarg) <0 ) { + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_ALLOWED , optarg) <0 ) {return -1 ; } - w_used =1 ; + a_used =1 ;break ;/* coremask */ case 'c' : {
@@ -1760,9 +1774,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" ); + +ba_conflict: +RTE_LOG (ERR ,EAL , +"Options allow (-a) and block (-b) can't be used at the same time\n" );return -1 ; }
@@ -1997,14 +2012,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 <domain:bus:devid.func>.\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 <domain:bus:devid.func>.\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 <driver><id>[,key=val,...]\n" " (ex: --vdev=net_pcap0,iface=eth2).\n"
lib/librte_eal/common/eal_options.h +8 -1
@@ -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',
Signature · 1 line
2.27.0
PATCH v7 4/5 doc: change references to blacklist and whitelist
In reply to Stephen HemmingerThere 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
--- 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(-)
doc/guides/cryptodevs/dpaa2_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/dpaa_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/qat.rst +6 -6
@@ -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 ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_autotest QAT ASYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_asym_autotest QAT compression PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>compressdev_autotest
doc/guides/eventdevs/octeontx2.rst +10 -10
@@ -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 -----------------
doc/guides/freebsd_gsg/build_sample_apps.rst +1 -1
@@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows: is a list of cores to use instead of a core mask. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -53,7 +53,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/eal_args.include.rst +7 -7
@@ -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 <device arguments>``
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -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: - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ + <build_dir>/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: - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ + <build_dir>/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).
doc/guides/mempool/octeontx2.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~
doc/guides/nics/bnxt.rst +9 -9
@@ -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
doc/guides/nics/cxgbe.rst +6 -6
@@ -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 - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/dpaa.rst +3 -3
@@ -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
doc/guides/nics/dpaa2.rst +3 -3
@@ -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
doc/guides/nics/enic.rst +3 -3
@@ -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**
doc/guides/nics/fail_safe.rst +8 -8
@@ -48,7 +48,7 @@ Fail-safe command line parameters This parameter allows the user to define a sub-device. The ``<iface>`` 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 <pmd_build_and_test>`. -#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL - operations to avoid probing it twice, as the PCI bus is in blacklist mode. +#. Start testpmd. The sub-device ``84:00.0`` should be 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
doc/guides/nics/features.rst +1 -1
@@ -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``.
doc/guides/nics/i40e.rst +8 -8
@@ -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,
doc/guides/nics/ice.rst +20 -8
@@ -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=<queues:protocol>[<queues:protocol>...] - -w 18:00.0,proto_xtr=<protocol> + -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...] + -a 18:00.0,proto_xtr=<protocol> Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
@@ -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::
doc/guides/nics/ixgbe.rst +2 -2
@@ -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.
doc/guides/nics/mlx4.rst +9 -9
@@ -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::
doc/guides/nics/mlx5.rst +7 -7
@@ -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::
doc/guides/nics/nfb.rst +1 -1
@@ -63,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> + ./<build_dir>/app/dpdk-testpmd -a b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> 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.
doc/guides/nics/octeontx2.rst +12 -11
@@ -63,7 +63,8 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/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:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -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.
doc/guides/nics/tap.rst +1 -1
@@ -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
doc/guides/nics/thunderx.rst +2 -2
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + ./<build_dir>/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 -----------
doc/guides/prog_guide/env_abstraction_layer.rst +3 -3
@@ -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 ~~~~~~~~~~~~~~
doc/guides/prog_guide/multi_proc_support.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/poll_mode_drv.rst +3 -3
@@ -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.
doc/guides/prog_guide/switch_representation.rst +3 -3
@@ -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
doc/guides/rel_notes/release_20_11.rst +5 -0
@@ -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 -----------
doc/guides/sample_app_ug/bbdev_app.rst +7 -7
@@ -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 - $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> \ + $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ -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 <NIC1PCIADDR> -- -m 1.0 -P + --socket-mem=1,1 --file-prefix=pg -a <NIC1PCIADDR> -- -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 <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. * ``-m <string>``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode
doc/guides/sample_app_ug/eventdev_pipeline.rst +2 -2
@@ -46,8 +46,8 @@ these settings is shown below: .. code-block:: console - ./<build_dir>/examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 / - -e4 -w FF00 -s4 -n0 -c32 -W1000 -D + ./<build_dir>/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
doc/guides/sample_app_ug/ipsec_secgw.rst +6 -6
@@ -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 ./<build_dir>/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 <pci-id>') +* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a <pci-id>') 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 <pci-id>'). If none specified +* ``CRYPTO_DEV``: crypto device to be used ('-a <pci-id>'). 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 <ipsec_mode> is specified, only tests for that mode will be invoked. For the -list of available modes please refer to run_test.sh. +list of available modes please refer to run_test.sh.
doc/guides/sample_app_ug/l3_forward.rst +4 -3
@@ -138,17 +138,18 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + -- -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.
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +1 -1
@@ -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
doc/guides/sample_app_ug/l3_forward_power_man.rst +2 -1
@@ -378,7 +378,8 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - ./<build_dir>/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 + ./<build_dir>/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,
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -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::
doc/guides/tools/cryptoperf.rst +3 -3
@@ -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
doc/guides/tools/flow-perf.rst +1 -1
@@ -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:
doc/guides/tools/testregex.rst +1 -1
@@ -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
Signature · 1 line
2.27.0
PATCH v7 5/5 app/test: use new allowlist and blocklist
In reply to Stephen HemmingerTest the renamed blocklist and allowlist arguments. Use new terms in test variable names as well.
--- app/test/autotest.py | 16 +++++------ app/test/autotest_runner.py | 18 ++++++------- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++++++++++++++------------------ 4 files changed, 45 insertions(+), 44 deletions(-)
app/test/autotest.py +8 -8
@@ -10,7 +10,7 @@ def usage(): print("Usage: autotest.py [test app|test iso image] ", - "[target] [whitelist|-blacklist]") + "[target] [allow|-block]") 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[:]
app/test/autotest_runner.py +9 -9
@@ -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
app/test/test.c +1 -1
@@ -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_allow_flag", no_action }, { "test_invalid_b_flag", no_action }, { "test_invalid_vdev_flag", no_action }, { "test_invalid_r_flag", no_action },
app/test/test_eal_flags.c +27 -26
140 lines not on this page · raw message
Signature · 1 line
2.27.0
v8 cover replace blacklist/whitelist with allow/block
In reply to Stephen HemmingerThis patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v8 - incorporate more of the feedback from David Marchand
fix the pci-blacklist option number and reformat the usage (All the usage message should be fixed format).
v7 - fix options handling changes in test code.
this should fix the CI failures.
v6 - fix some confusion in handling options that was introduced
by earlier versions of the patch.
Stephen Hemminger (5):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options
doc: change references to blacklist and whitelist app/test: use new allowlist and blocklist
app/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- 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 +- 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 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 58 files changed, 329 insertions(+), 273 deletions(-)
Signature · 1 line
2.27.0
PATCH v8 1/5 eal: replace usage of blacklist/whitelist in enum
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.
--- 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(-)
lib/librte_eal/common/eal_common_devargs.c +7 -7
@@ -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 ;
lib/librte_eal/include/rte_bus.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_dev.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_devargs.h +8 -2
@@ -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 *
Signature · 1 line
2.27.0
PATCH v8 2/5 drivers: replace references to blacklist
In reply to Stephen HemmingerUse the new terminology blocked to describe when devices are excluded from being used.
--- 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(-)
drivers/bus/dpaa/dpaa_bus.c +3 -4
@@ -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",
drivers/bus/fslmc/fslmc_bus.c +4 -5
@@ -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" );
drivers/bus/fslmc/fslmc_vfio.c +6 -6
@@ -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 ;
drivers/bus/pci/pci_common.c +10 -14
@@ -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 ; }
drivers/bus/vmbus/vmbus_common.c +2 -2
@@ -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,
drivers/crypto/virtio/virtio_pci.c +1 -1
@@ -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. */
drivers/net/virtio/virtio_pci.c +1 -1
@@ -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. */
Signature · 1 line
2.27.0
PATCH v8 3/5 eal: replace pci-whitelist/pci-blacklist options
In reply to Stephen HemmingerReplace -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.
--- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++++--------- lib/librte_eal/common/eal_options.h | 13 ++++- 2 files changed, 51 insertions(+), 28 deletions(-)
lib/librte_eal/common/eal_common_options.c +40 -26
@@ -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,7 @@ eal_short_options[] ="n:" /* memory channels */ "r:" /* memory ranks */ "v" /* version */ -"w:" /* pci-whitelist */ +"w:" /* pci-whitelist (deprecated) */ ; const struct option
@@ -89,8 +90,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 +106,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 } };
@@ -1448,28 +1454,35 @@ eal_parse_common_option(int opt, const char *optarg, struct internal_config *conf) {static int b_used; -static int w_used; +static int a_used;switch (opt) { -/* blacklist */ +case OPT_PCI_BLACKLIST_NUM : +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 , - optarg) <0 ) { +/* excluded list */ +if (a_used) + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_BLOCKED , optarg) <0 ) {return -1 ; } b_used =1 ;break ; -/* whitelist */ +case 'w' : +fprintf (stderr, +"Option -w, --pci-whitelist is deprecated, use -a, --allow option instead\n" ); +/* fallthrough */ +case 'a' : +/* include device list */ if (b_used) - goto bw_used; -if (eal_option_device_add (RTE_DEVTYPE_WHITELISTED_PCI , - optarg) <0 ) { + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_ALLOWED , optarg) <0 ) {return -1 ; } - w_used =1 ; + a_used =1 ;break ;/* coremask */ case 'c' : {
@@ -1760,9 +1773,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" ); + +ba_conflict: +RTE_LOG (ERR ,EAL , +"Options allow (-a) and block (-b) can't be used at the same time\n" );return -1 ; }
@@ -1997,14 +2011,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 <domain:bus:devid.func>.\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, --block Add a device to the excluded list.\n" +" Prevent EAL from using this device. The argument\n" +" format for PCI devices is <domain:bus:devid.func>.\n" +" -a, --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 <driver><id>[,key=val,...]\n" " (ex: --vdev=net_pcap0,iface=eth2).\n"
lib/librte_eal/common/eal_options.h +11 -2
@@ -13,8 +13,12 @@ enum {/* long options mapped to a short option */ #define OPT_HELP "help" OPT_HELP_NUM = 'h', -#define OPT_PCI_BLACKLIST "pci-blacklist" - OPT_PCI_BLACKLIST_NUM = 'b', +#define OPT_DEV_ALLOW "allow" + OPT_DEV_ALLOW_NUM = 'a', +#define OPT_DEV_BLOCK "block" + OPT_DEV_BLOCK_NUM = 'b', + +/* legacy option that will be removed in next LTS */ #define OPT_PCI_WHITELIST "pci-whitelist" OPT_PCI_WHITELIST_NUM = 'w',
@@ -89,6 +93,11 @@ enum {OPT_NO_TELEMETRY_NUM , #define OPT_FORCE_MAX_SIMD_BITWIDTH "force-max-simd-bitwidth"OPT_FORCE_MAX_SIMD_BITWIDTH_NUM , + +/* legacy option that will be removed in next LTS */ +#define OPT_PCI_BLACKLIST "pci-blacklist" +OPT_PCI_BLACKLIST_NUM , + OPT_LONG_MAX_NUM };
Signature · 1 line
2.27.0
PATCH v8 4/5 doc: change references to blacklist and whitelist
In reply to Stephen HemmingerThere 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
--- 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(-)
doc/guides/cryptodevs/dpaa2_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/dpaa_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/qat.rst +6 -6
@@ -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 ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_autotest QAT ASYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_asym_autotest QAT compression PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>compressdev_autotest
doc/guides/eventdevs/octeontx2.rst +10 -10
@@ -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 -----------------
doc/guides/freebsd_gsg/build_sample_apps.rst +1 -1
@@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows: is a list of cores to use instead of a core mask. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -53,7 +53,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/eal_args.include.rst +7 -7
@@ -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 <device arguments>``
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -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: - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ + <build_dir>/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: - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ + <build_dir>/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).
doc/guides/mempool/octeontx2.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~
doc/guides/nics/bnxt.rst +9 -9
@@ -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
doc/guides/nics/cxgbe.rst +6 -6
@@ -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 - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/dpaa.rst +3 -3
@@ -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
doc/guides/nics/dpaa2.rst +3 -3
@@ -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
doc/guides/nics/enic.rst +3 -3
@@ -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**
doc/guides/nics/fail_safe.rst +8 -8
@@ -48,7 +48,7 @@ Fail-safe command line parameters This parameter allows the user to define a sub-device. The ``<iface>`` 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 <pmd_build_and_test>`. -#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL - operations to avoid probing it twice, as the PCI bus is in blacklist mode. +#. Start testpmd. The sub-device ``84:00.0`` should be 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
doc/guides/nics/features.rst +1 -1
@@ -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``.
doc/guides/nics/i40e.rst +8 -8
@@ -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,
doc/guides/nics/ice.rst +20 -8
@@ -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=<queues:protocol>[<queues:protocol>...] - -w 18:00.0,proto_xtr=<protocol> + -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...] + -a 18:00.0,proto_xtr=<protocol> Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
@@ -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::
doc/guides/nics/ixgbe.rst +2 -2
@@ -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.
doc/guides/nics/mlx4.rst +9 -9
@@ -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::
doc/guides/nics/mlx5.rst +7 -7
@@ -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::
doc/guides/nics/nfb.rst +1 -1
@@ -63,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> + ./<build_dir>/app/dpdk-testpmd -a b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> 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.
doc/guides/nics/octeontx2.rst +12 -11
@@ -63,7 +63,8 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/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:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -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.
doc/guides/nics/tap.rst +1 -1
@@ -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
doc/guides/nics/thunderx.rst +2 -2
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + ./<build_dir>/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 -----------
doc/guides/prog_guide/env_abstraction_layer.rst +3 -3
@@ -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 ~~~~~~~~~~~~~~
doc/guides/prog_guide/multi_proc_support.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/poll_mode_drv.rst +3 -3
@@ -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.
doc/guides/prog_guide/switch_representation.rst +3 -3
@@ -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
doc/guides/rel_notes/release_20_11.rst +5 -0
@@ -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 -----------
doc/guides/sample_app_ug/bbdev_app.rst +7 -7
@@ -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 - $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> \ + $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ -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 <NIC1PCIADDR> -- -m 1.0 -P + --socket-mem=1,1 --file-prefix=pg -a <NIC1PCIADDR> -- -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 <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. * ``-m <string>``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode
doc/guides/sample_app_ug/eventdev_pipeline.rst +2 -2
@@ -46,8 +46,8 @@ these settings is shown below: .. code-block:: console - ./<build_dir>/examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 / - -e4 -w FF00 -s4 -n0 -c32 -W1000 -D + ./<build_dir>/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
doc/guides/sample_app_ug/ipsec_secgw.rst +6 -6
@@ -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 ./<build_dir>/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 <pci-id>') +* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a <pci-id>') 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 <pci-id>'). If none specified +* ``CRYPTO_DEV``: crypto device to be used ('-a <pci-id>'). 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 <ipsec_mode> is specified, only tests for that mode will be invoked. For the -list of available modes please refer to run_test.sh. +list of available modes please refer to run_test.sh.
doc/guides/sample_app_ug/l3_forward.rst +4 -3
@@ -138,17 +138,18 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + -- -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.
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +1 -1
@@ -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
doc/guides/sample_app_ug/l3_forward_power_man.rst +2 -1
@@ -378,7 +378,8 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - ./<build_dir>/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 + ./<build_dir>/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,
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -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::
doc/guides/tools/cryptoperf.rst +3 -3
@@ -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
doc/guides/tools/flow-perf.rst +1 -1
@@ -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:
doc/guides/tools/testregex.rst +1 -1
@@ -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
Signature · 1 line
2.27.0
PATCH v8 5/5 app/test: use new allowlist and blocklist
In reply to Stephen HemmingerTest the renamed blocklist and allowlist arguments. Use new terms in test variable names as well.
--- app/test/autotest.py | 16 +++++------ app/test/autotest_runner.py | 18 ++++++------- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++++++++++++++------------------ 4 files changed, 45 insertions(+), 44 deletions(-)
app/test/autotest.py +8 -8
@@ -10,7 +10,7 @@ def usage(): print("Usage: autotest.py [test app|test iso image] ", - "[target] [whitelist|-blacklist]") + "[target] [allow|-block]") 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[:]
app/test/autotest_runner.py +9 -9
@@ -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
app/test/test.c +1 -1
@@ -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_allow_flag", no_action }, { "test_invalid_b_flag", no_action }, { "test_invalid_vdev_flag", no_action }, { "test_invalid_r_flag", no_action },
app/test/test_eal_flags.c +27 -26
140 lines not on this page · raw message
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v8 0/5] replace blacklist/whitelist with allow/block
In reply to Stephen HemmingerQuoted 78 lines · On Sun, 25 Oct 2020 14:15:13 -0700 Stephen Hemminger…
This patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v8 - incorporate more of the feedback from David Marchand
fix the pci-blacklist option number and reformat the usage (All the usage message should be fixed format).v7 - fix options handling changes in test code.
this should fix the CI failures.v6 - fix some confusion in handling options that was introduced
by earlier versions of the patch.Stephen Hemminger (5):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options
doc: change references to blacklist and whitelist app/test: use new allowlist and blocklistapp/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- 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 +- 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 +-
Quoted 9 lines
drivers/net/virtio/virtio_pci.c | 2 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 58 files changed, 329 insertions(+), 273 deletions(-)
Any comments on this? What is timeline for merge?
v9 cover replace blacklist/whitelist with allow/block
In reply to Stephen HemmingerThis patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v9 - rebase to main and use the feedback from David Marchand
fix some more leftover places where previous names where still in documentation, comments, help etc. split out release note (so people look at it)
v8 - incorporate more of the feedback from David Marchand
fix the pci-blacklist option number and reformat the usage (All the usage message should be fixed format).
v7 - fix options handling changes in test code.
this should fix the CI failures.
Stephen Hemminger (6):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options app/test: use new allowlist and blocklist
doc: change references to blacklist and whitelist
doc: update release notes now for block allow changes
app/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- 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 | 20 +++--- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 16 ++--- doc/guides/nics/ice.rst | 16 ++--- 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 | 8 +-- 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/deprecation.rst | 23 ------- doc/guides/rel_notes/release_20_11.rst | 11 ++++ 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 +- 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 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 59 files changed, 326 insertions(+), 299 deletions(-)
Signature · 1 line
2.27.0
PATCH v9 1/6 eal: replace usage of blacklist/whitelist in enum
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.
--- 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(-)
lib/librte_eal/common/eal_common_devargs.c +7 -7
@@ -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 ;
lib/librte_eal/include/rte_bus.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_dev.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_devargs.h +8 -2
@@ -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 *
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 19 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>--- 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(-)
<snip>
lib/librte_eal/include/rte_devargs.h extern "C" { · line 42
Quoted 6 lines
lib/librte_eal/include/rte_devargs.h +6
-0+/* 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 +
This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
/Bruce
../lib/librte_eal/common/eal_common_options.c: In function ‘eal_parse_common_option’:../lib/librte_eal/common/eal_common_options.c:1458:13: error: "RTE_DEVTYPE_BLACKLISTED_PCI" is deprecated [-Werror]
1458 | if (eal_option_device_add(RTE_DEVTYPE_BLACKLISTED_PCI,
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../lib/librte_eal/common/eal_common_options.c:1468:13: error: "RTE_DEVTYPE_WHITELISTED_PCI" is deprecated [-Werror]
1468 | if (eal_option_device_add(RTE_DEVTYPE_WHITELISTED_PCI,
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~cc1: all warnings being treated as errors
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 32 lines · On Mon, 9 Nov 2020 13:49:31 +0000 Bruce Richardson…
Quoted 19 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>--- 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(-)<snip>
lib/librte_eal/include/rte_devargs.h extern "C" { · line 42
Quoted 6 lines
lib/librte_eal/include/rte_devargs.h +6
-0+/* 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 +This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
Quoted 1 line
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 8 lines · Stephen Hemminger
Quoted 5 lines
This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
Thomas fixed it while applying.
https://patchwork.dpdk.org/cover/80987/#122107
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 6 lines · David Marchand
Quoted 4 lines · Stephen Hemminger
Quoted 4 lines
This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
Quoted 9 lines
Quoted 4 lines
Quoted 1 line
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
Thomas fixed it while applying.
https://patchwork.dpdk.org/cover/80987/#122107
In this case I believe the below needs to be applied to patch 1, and then the inverse of it set as patch 4 to mark the compatibility macros as deprecated.
/Bruce
lib/librte_eal/include/rte_bus.h +2 -2
@@ -221,9 +221,9 @@ enum rte_bus_scan_mode {/* Backwards compatibility will be removed */ #define RTE_BUS_SCAN_WHITELIST \ - RTE_DEPRECATED(RTE_BUS_SCAN_WHITELIST) RTE_BUS_SCAN_ALLOWLIST + RTE_BUS_SCAN_ALLOWLIST#define RTE_BUS_SCAN_BLACKLIST \ - RTE_DEPRECATED(RTE_BUS_SCAN_BLACKLIST) RTE_BUS_SCAN_BLOCKLIST + RTE_BUS_SCAN_BLOCKLIST/** * A structure used to configure bus operations.
lib/librte_eal/include/rte_dev.h +2 -2
@@ -58,9 +58,9 @@ enum rte_dev_policy {/* Backwards compatibility will be removed */ #define RTE_DEV_WHITELISTED \ - RTE_DEPRECATED(RTE_DEV_WHITELISTED) RTE_DEV_ALLOWED + RTE_DEV_ALLOWED#define RTE_DEV_BLACKLISTED \ - RTE_DEPRECATED(RTE_DEV_BLACKLISTED) RTE_DEV_BLOCKED + RTE_DEV_BLOCKED/** * A generic memory resource representation.
lib/librte_eal/include/rte_devargs.h +2 -2
@@ -36,9 +36,9 @@ enum rte_devtype {/* Backwards compatibility will be removed later */ #define RTE_DEVTYPE_WHITELISTED_PCI \ - RTE_DEPRECATED(RTE_DEVTYPE_WHITELISTED_PCI) RTE_DEVTYPE_ALLOWED + RTE_DEVTYPE_ALLOWED#define RTE_DEVTYPE_BLACKLISTED_PCI \ - RTE_DEPRECATED(RTE_DEVTYPE_BLACKLISTED_PCI) RTE_DEVTYPE_BLOCKED + RTE_DEVTYPE_BLOCKED/** * Structure that stores a device given by the user with its arguments
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 13 lines · Bruce Richardson
Quoted 11 lines · David Marchand
Quoted 8 lines · Stephen Hemminger
Quoted 5 lines
This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
Quoted 7 lines
Quoted 4 lines
Thomas fixed it while applying.
https://patchwork.dpdk.org/cover/80987/#122107In this case I believe the below needs to be applied to patch 1, and then the inverse of it set as patch 4 to mark the compatibility macros as deprecated.
Or just squash the patches and be done with it, like I already commented. No one cares about this series anyway.
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 19 lines · David Marchand
Quoted 17 lines · Bruce Richardson
Quoted 15 lines · David Marchand
Quoted 8 lines · Stephen Hemminger
Quoted 5 lines
This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
Thomas fixed it while applying.
https://patchwork.dpdk.org/cover/80987/#122107
Quoted 7 lines
Quoted 3 lines
In this case I believe the below needs to be applied to patch 1, and then the inverse of it set as patch 4 to mark the compatibility macros as deprecated.
Or just squash the patches and be done with it, like I already commented. No one cares about this series anyway.
Ok, yep, that's fine too.
/Bruce
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 24 lines · On Mon, 9 Nov 2020 16:10:45 +0000 Bruce Richardson…
Quoted 23 lines · David Marchand
Quoted 20 lines · Bruce Richardson
Quoted 6 lines · David Marchand
Quoted 4 lines · Stephen Hemminger
Quoted 4 lines
This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
Quoted 9 lines
Quoted 4 lines
Quoted 1 line
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
Thomas fixed it while applying.
https://patchwork.dpdk.org/cover/80987/#122107In this case I believe the below needs to be applied to patch 1, and then the inverse of it set as patch 4 to mark the compatibility macros as deprecated.
Quoted 6 lines
Quoted 3 lines
Or just squash the patches and be done with it, like I already commented. No one cares about this series anyway.
Ok, yep, that's fine too.
/Bruce
Agree, go ahead and combine the patches.
They were split for testing and review.
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
In reply to Stephen HemmingerQuoted 35 lines · Stephen Hemminger
Quoted 32 lines · On Mon, 9 Nov 2020 13:49:31 +0000 Bruce Richardson…
Quoted 19 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>--- 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(-)<snip>
lib/librte_eal/include/rte_devargs.h extern "C" { · line 42
Quoted 6 lines
lib/librte_eal/include/rte_devargs.h +6
-0+/* 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 +This patch causes build failures which persist until patch 3, because of these deprecations. I think you need to define the backward-compatibility macros here, but only mark them deprecated at the end of the set.
Quoted 5 lines
Quoted 1 line
/Bruce
Is building without warnings in every step that important? The previous patch series for master/slave had the same effect
I assumed it was necessary, but maybe I'm mistaken.
Thomas, David, your feedback please? We really could do with getting this patchset into the LTS release!
/Bruce
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
In reply to Stephen HemmingerQuoted 18 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>--- 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(-)
<..>
lib/librte_eal/include/rte_devargs.h extern "C" { · line 34
Quoted 13 lines
lib/librte_eal/include/rte_devargs.h +2
-2@@ -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 ,
Any particular reason to drop the _PCI suffix from the enums and command line parameters? Does it apply to more than PCI devices nowadays?
Signature · 2 lines
Kind regards, Luca Boccassi
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 31 lines · On Tue, 10 Nov 2020 12:33:48 +0000 Luca Boccassi <[email protected]> wrote:
Quoted 18 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>--- 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(-)<..>
Quoted 9 lines
lib/librte_eal/include/rte_devargs.h +0
-1@@ -29,11 +29,17 @@ extern "C" {* Type of generic device */ enum rte_devtype { -RTE_DEVTYPE_WHITELISTED_PCI ,
Quoted 8 lines
lib/librte_eal/include/rte_devargs.h extern "C" { · line 34
Quoted 4 lines
lib/librte_eal/include/rte_devargs.h +2
-1-RTE_DEVTYPE_BLACKLISTED_PCI , +RTE_DEVTYPE_ALLOWED , +RTE_DEVTYPE_BLOCKED , RTE_DEVTYPE_VIRTUAL,Any particular reason to drop the
_PCIsuffix from the enums and command line parameters? Does it apply to more than PCI devices nowadays?
Yes, block/allow also works for VMBus devices and and I think other busses use it as well.
Re: [dpdk-dev] [PATCH v9 1/6] eal: replace usage of blacklist/whitelist in enum
Quoted 43 lines · Stephen Hemminger
Quoted 31 lines · On Tue, 10 Nov 2020 12:33:48 +0000 Luca Boccassi <[email protected]> wrote:
Quoted 18 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>--- 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(-)<..>
Quoted 9 lines
lib/librte_eal/include/rte_devargs.h +0
-1@@ -29,11 +29,17 @@ extern "C" {* Type of generic device */ enum rte_devtype { -RTE_DEVTYPE_WHITELISTED_PCI ,Quoted 8 lines
lib/librte_eal/include/rte_devargs.h extern "C" { · line 34
Quoted 4 lines
lib/librte_eal/include/rte_devargs.h +2
-1-RTE_DEVTYPE_BLACKLISTED_PCI , +RTE_DEVTYPE_ALLOWED , +RTE_DEVTYPE_BLOCKED , RTE_DEVTYPE_VIRTUAL,Any particular reason to drop the
_PCIsuffix from the enums and command line parameters? Does it apply to more than PCI devices nowadays?
Quoted 2 lines
Yes, block/allow also works for VMBus devices and and I think other busses use it as well.
Ok, makes sense, thanks.
Signature · 2 lines
Kind regards, Luca Boccassi
PATCH v9 2/6 drivers: replace references to blacklist
In reply to Stephen HemmingerUse the new terminology blocked to describe when devices are excluded from being used.
--- 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(-)
drivers/bus/dpaa/dpaa_bus.c +3 -4
@@ -584,7 +584,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 */
@@ -646,13 +646,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",
drivers/bus/fslmc/fslmc_bus.c +4 -5
@@ -420,7 +420,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
@@ -451,16 +451,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 Blocked, 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" );
drivers/bus/fslmc/fslmc_vfio.c +6 -6
@@ -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 Blocked, 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 Blocked, skipping" , dev->device.name);TAILQ_REMOVE (&rte_fslmc_bus.device_list, dev, next);continue ;
drivers/bus/pci/pci_common.c +10 -14
@@ -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 ; }
drivers/bus/vmbus/vmbus_common.c +2 -2
@@ -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,
drivers/crypto/virtio/virtio_pci.c +1 -1
@@ -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. */
drivers/net/virtio/virtio_pci.c +1 -1
@@ -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. */
Signature · 1 line
2.27.0
PATCH v9 3/6 eal: replace pci-whitelist/pci-blacklist options
In reply to Stephen HemmingerReplace -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.
--- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++++--------- lib/librte_eal/common/eal_options.h | 13 ++++- 2 files changed, 51 insertions(+), 28 deletions(-)
lib/librte_eal/common/eal_common_options.c +40 -26
@@ -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,7 @@ eal_short_options[] ="n:" /* memory channels */ "r:" /* memory ranks */ "v" /* version */ -"w:" /* pci-whitelist */ +"w:" /* pci-whitelist (deprecated) */ ; const struct option
@@ -89,8 +90,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 +106,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 } };
@@ -1448,28 +1454,35 @@ eal_parse_common_option(int opt, const char *optarg, struct internal_config *conf) {static int b_used; -static int w_used; +static int a_used;switch (opt) { -/* blacklist */ +case OPT_PCI_BLACKLIST_NUM : +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 , - optarg) <0 ) { +/* excluded list */ +if (a_used) + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_BLOCKED , optarg) <0 ) {return -1 ; } b_used =1 ;break ; -/* whitelist */ +case 'w' : +fprintf (stderr, +"Option -w, --pci-whitelist is deprecated, use -a, --allow option instead\n" ); +/* fallthrough */ +case 'a' : +/* include device list */ if (b_used) - goto bw_used; -if (eal_option_device_add (RTE_DEVTYPE_WHITELISTED_PCI , - optarg) <0 ) { + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_ALLOWED , optarg) <0 ) {return -1 ; } - w_used =1 ; + a_used =1 ;break ;/* coremask */ case 'c' : {
@@ -1760,9 +1773,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" ); + +ba_conflict: +RTE_LOG (ERR ,EAL , +"Options allow (-a) and block (-b) can't be used at the same time\n" );return -1 ; }
@@ -1997,14 +2011,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 <domain:bus:devid.func>.\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, --block Add a device to the excluded list.\n" +" Prevent EAL from using this device. The argument\n" +" format for PCI devices is <domain:bus:devid.func>.\n" +" -a, --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 <driver><id>[,key=val,...]\n" " (ex: --vdev=net_pcap0,iface=eth2).\n"
lib/librte_eal/common/eal_options.h +11 -2
@@ -13,8 +13,12 @@ enum {/* long options mapped to a short option */ #define OPT_HELP "help" OPT_HELP_NUM = 'h', -#define OPT_PCI_BLACKLIST "pci-blacklist" - OPT_PCI_BLACKLIST_NUM = 'b', +#define OPT_DEV_ALLOW "allow" + OPT_DEV_ALLOW_NUM = 'a', +#define OPT_DEV_BLOCK "block" + OPT_DEV_BLOCK_NUM = 'b', + +/* legacy option that will be removed in next LTS */ #define OPT_PCI_WHITELIST "pci-whitelist" OPT_PCI_WHITELIST_NUM = 'w',
@@ -89,6 +93,11 @@ enum {OPT_NO_TELEMETRY_NUM , #define OPT_FORCE_MAX_SIMD_BITWIDTH "force-max-simd-bitwidth"OPT_FORCE_MAX_SIMD_BITWIDTH_NUM , + +/* legacy option that will be removed in next LTS */ +#define OPT_PCI_BLACKLIST "pci-blacklist" +OPT_PCI_BLACKLIST_NUM , + OPT_LONG_MAX_NUM };
Signature · 1 line
2.27.0
PATCH v9 4/6 app/test: use new allowlist and blocklist
In reply to Stephen HemmingerTest the renamed blocklist and allowlist arguments. Use new terms in test variable names as well.
--- app/test/autotest.py | 16 +++++------ app/test/autotest_runner.py | 18 ++++++------- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++++++++++++++------------------ 4 files changed, 45 insertions(+), 44 deletions(-)
app/test/autotest.py +8 -8
@@ -10,7 +10,7 @@ def usage(): print("Usage: autotest.py [test app|test iso image] ", - "[target] [whitelist|-blacklist]") + "[target] [allow|-block]") 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[:]
app/test/autotest_runner.py +9 -9
@@ -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 blocked/allowed 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
app/test/test.c +1 -1
@@ -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_allow_flag", no_action }, { "test_invalid_b_flag", no_action }, { "test_invalid_vdev_flag", no_action }, { "test_invalid_r_flag", no_action },
app/test/test_eal_flags.c +27 -26
140 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v9 5/6 doc: change references to blacklist and whitelist
In reply to Stephen HemmingerThere 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
--- 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 | 20 ++++++++-------- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 16 ++++++------- doc/guides/nics/ice.rst | 16 ++++++------- 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 | 8 +++---- 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/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 +- 40 files changed, 161 insertions(+), 158 deletions(-)
doc/guides/cryptodevs/dpaa2_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/dpaa_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/qat.rst +6 -6
@@ -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
@@ -638,19 +638,19 @@ Testing QAT SYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_autotest QAT ASYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_asym_autotest QAT compression PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>compressdev_autotest
doc/guides/eventdevs/octeontx2.rst +10 -10
@@ -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 -----------------
doc/guides/freebsd_gsg/build_sample_apps.rst +1 -1
@@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows: is a list of cores to use instead of a core mask. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -53,7 +53,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/eal_args.include.rst +7 -7
@@ -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 <device arguments>``
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -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: - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ + <build_dir>/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: - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ + <build_dir>/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).
doc/guides/mempool/octeontx2.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~
doc/guides/nics/bnxt.rst +9 -9
@@ -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 -----
@@ -745,7 +745,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
@@ -770,12 +770,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
doc/guides/nics/cxgbe.rst +6 -6
@@ -40,8 +40,8 @@ expose a single PCI bus address, thus, librte_net_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_net_cxgbe in FreeBSD operating system. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/dpaa.rst +3 -3
@@ -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
doc/guides/nics/dpaa2.rst +3 -3
@@ -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
doc/guides/nics/enic.rst +3 -3
@@ -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**
doc/guides/nics/fail_safe.rst +10 -10
@@ -48,7 +48,7 @@ Fail-safe command line parameters This parameter allows the user to define a sub-device. The ``<iface>`` 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 <pmd_build_and_test>`. -#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL - operations to avoid probing it twice, as the PCI bus is in blacklist mode. +#. Start testpmd. The sub-device ``84:00.0`` should be blocked from normal EAL + operations to avoid probing it twice, as the PCI bus is in blocklist mode. .. code-block:: console
@@ -120,25 +120,25 @@ 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 ./<build_dir>/app/dpdk-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 + -a 81:00.0 -- -i #. Start testpmd using a flexible device definition .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -w ff:ff.f \ + ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -a ff:ff.f \ --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i #. Start testpmd, automatically probing the device 84:00.0 and using it with
doc/guides/nics/features.rst +1 -1
@@ -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``.
doc/guides/nics/i40e.rst +8 -8
@@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -452,7 +452,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.
@@ -460,7 +460,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.
@@ -796,7 +796,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,
doc/guides/nics/ice.rst +8 -8
@@ -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,7 @@ 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 - ``Protocol extraction for per queue``
@@ -62,8 +62,8 @@ Runtime Config Options The argument format is:: - -w 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...] - -w 18:00.0,proto_xtr=<protocol> + -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...] + -a 18:00.0,proto_xtr=<protocol> Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
@@ -74,14 +74,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 +233,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::
doc/guides/nics/ixgbe.rst +2 -2
@@ -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.
doc/guides/nics/mlx4.rst +9 -9
@@ -24,8 +24,8 @@ Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI bus address, thus unlike most drivers, librte_net_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_net_mlx4 relies heavily on system calls for control
@@ -381,7 +381,7 @@ devices managed by librte_net_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_net_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_net_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::
doc/guides/nics/mlx5.rst +7 -7
@@ -1524,7 +1524,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_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;
@@ -1532,14 +1532,14 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_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::
@@ -1547,7 +1547,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_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::
doc/guides/nics/nfb.rst +1 -1
@@ -63,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> + ./<build_dir>/app/dpdk-testpmd -a b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> 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.
doc/guides/nics/octeontx2.rst +12 -11
@@ -63,7 +63,8 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/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:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -350,7 +350,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.
doc/guides/nics/tap.rst +1 -1
@@ -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
doc/guides/nics/thunderx.rst +2 -2
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + ./<build_dir>/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 -----------
doc/guides/prog_guide/env_abstraction_layer.rst +4 -4
@@ -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 -~~~~~~~~~~~~ +Block list +~~~~~~~~~~ -The EAL PCI device blacklist functionality can be used to mark certain NIC ports as blacklisted, +The EAL PCI device block list 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 blocked are identified using the PCIe* description (Domain:Bus:Device.Function). Misc Functions ~~~~~~~~~~~~~~
doc/guides/prog_guide/multi_proc_support.rst +2 -2
@@ -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 added to block list in every other process. Running Multiple Independent Groups of DPDK Applications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/poll_mode_drv.rst +3 -3
@@ -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.
doc/guides/prog_guide/switch_representation.rst +3 -3
@@ -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
doc/guides/sample_app_ug/bbdev_app.rst +7 -7
@@ -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 - $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> \ + $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ -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 <NIC1PCIADDR> -- -m 1.0 -P + --socket-mem=1,1 --file-prefix=pg -a <NIC1PCIADDR> -- -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 <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. * ``-m <string>``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode
doc/guides/sample_app_ug/eventdev_pipeline.rst +2 -2
@@ -46,8 +46,8 @@ these settings is shown below: .. code-block:: console - ./<build_dir>/examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 / - -e4 -w FF00 -s4 -n0 -c32 -W1000 -D + ./<build_dir>/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
doc/guides/sample_app_ug/ipsec_secgw.rst +6 -6
@@ -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 ./<build_dir>/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 <pci-id>') +* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a <pci-id>') 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 <pci-id>'). If none specified +* ``CRYPTO_DEV``: crypto device to be used ('-a <pci-id>'). 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 <ipsec_mode> is specified, only tests for that mode will be invoked. For the -list of available modes please refer to run_test.sh. +list of available modes please refer to run_test.sh.
doc/guides/sample_app_ug/l3_forward.rst +4 -3
@@ -138,17 +138,18 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + -- -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.
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +1 -1
@@ -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
doc/guides/sample_app_ug/l3_forward_power_man.rst +2 -1
@@ -378,7 +378,8 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - ./<build_dir>/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 + ./<build_dir>/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,
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -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 \ + -a 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive .. note::
doc/guides/tools/cryptoperf.rst +3 -3
@@ -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
doc/guides/tools/flow-perf.rst +1 -1
@@ -65,7 +65,7 @@ with a ``--`` separator: .. code-block:: console - sudo ./dpdk-test-flow_perf -n 4 -w 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 + sudo ./dpdk-test-flow_perf -n 4 -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 The command line options are:
doc/guides/tools/testregex.rst +1 -1
@@ -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
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v9 5/6] doc: change references to blacklist and whitelist
Quoted 52 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>--- 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 | 20 ++++++++-------- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 16 ++++++------- doc/guides/nics/ice.rst | 16 ++++++------- 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 | 8 +++---- 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/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 +- 40 files changed, 161 insertions(+), 158 deletions(-)
<..>
doc/guides/nics/mlx4.rst Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI · line 28
Quoted 12 lines
doc/guides/nics/mlx4.rst +2
-2@@ -24,8 +24,8 @@ Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI bus address, thus unlike most drivers, librte_net_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.
Perhaps "one cannot use block" -> "one cannot block" reads better?
doc/guides/nics/mlx4.rst devices managed by librte_net_mlx4. · line 384
Quoted 8 lines
doc/guides/nics/mlx4.rst +1
-1Besides its dependency on libibverbs (that implies libmlx4 and associated kernel support), librte_net_mlx4 relies heavily on system calls for control@@ -381,7 +381,7 @@ devices managed by librte_net_mlx4. eth4 eth5 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for use in allow argument::
"for use in" -> "to be used with the" ?
Quoted 36 lines
doc/guides/nics/mlx4.rst +6
-6{ for intf in eth2 eth3 eth4 eth5;@@ -389,14 +389,14 @@ devices managed by librte_net_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_net_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::doc/guides/nics/mlx5.rst +0
-0
doc/guides/nics/mlx5.rst ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. · line 1527
Quoted 5 lines
doc/guides/nics/mlx5.rst +1
-1@@ -1524,7 +1524,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. eth32 eth33 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for use in allow list::
Same question as above
<..>
Quoted 14 lines
doc/guides/prog_guide/multi_proc_support.rst +1
-1@@ -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:
doc/guides/prog_guide/multi_proc_support.rst can use). · line 134
Quoted 5 lines
doc/guides/prog_guide/multi_proc_support.rst +1
-1@@ -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 added to block list in every other process.
"added to the block list"
<..>
doc/guides/sample_app_ug/ipsec_secgw.rst This means that if the application is using a single core and both hardware · line 327
Quoted 12 lines
doc/guides/sample_app_ug/ipsec_secgw.rst +2
-2@@ -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.
"to allowed" -> "to allow"
<..>
Quoted 13 lines
doc/guides/sample_app_ug/l3_forward.rst +1
-1@@ -138,17 +138,18 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered or
doc/guides/sample_app_ug/l3_forward.rst Following is the sample command: · line 152
Quoted 10 lines
doc/guides/sample_app_ug/l3_forward.rst +3
-2.. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + -- -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.
"adds" -> "allows" ?
Re: [dpdk-dev] [PATCH v9 5/6] doc: change references to blacklist and whitelist
In reply to Stephen HemmingerQuoted 10 lines · Stephen Hemminger
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>---
<snip>
doc/guides/nics/octeontx2.rst for details. · line 67
Quoted 3 lines
doc/guides/nics/octeontx2.rst +2
-1- ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/app/dpdk-testpmd -c 0x300 -a 0002:02:00.0 \ + -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
Git apply complains about whitespace before tab here. For the line continuation it should be fine to just indent with spaces.
/Bruce
PATCH v9 6/6 doc: update release notes now for block allow changes
In reply to Stephen HemmingerRemove the deprecation notice and add description to the release notes.
--- doc/guides/rel_notes/deprecation.rst | 23 ----------------------- doc/guides/rel_notes/release_20_11.rst | 11 +++++++++++ 2 files changed, 11 insertions(+), 23 deletions(-)
doc/guides/rel_notes/deprecation.rst +0 -23
@@ -28,29 +28,6 @@ Deprecation Notices * kvargs: The function ``rte_kvargs_process`` will get a new parameter for returning key match count. It will ease handling of no-match case. -* eal: The terms blacklist and whitelist to describe devices used - by DPDK will be replaced in the 20.11 relase. - This will apply to command line arguments as well as macros. - - The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED`` - and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED`` - ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be - replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED`` - respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and - ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with - ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``. - - The old macros will be marked as deprecated in 20.11 and any - usage will cause a compile warning. They will be removed in - a future release. - - The command line arguments to ``rte_eal_init`` will change from - ``-b, --pci-blacklist`` to ``-x, --exclude`` and - ``-w, --pci-whitelist`` to ``-i, --include``. - The old command line arguments will continue to be accepted in 20.11 - but will cause a runtime warning message. The old arguments will - be removed in a future release. - * eal: The function ``rte_eal_remote_launch`` will return new error codes after read or write error on the pipe, instead of calling ``rte_panic``.
doc/guides/rel_notes/release_20_11.rst +11 -0
@@ -644,6 +644,17 @@ API Changes * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size`` from ``struct rte_sched_subport_params``. +* eal: The selection of devices on the EAL command line has been + changed from ``--pci-blacklist`` and ``--pci-whitelist`` + to ``--block`` and ``--allow``. The short form option for + using a device is now ``-a`` instead of ``-w``. + + The internal macros for ``RTE_DEV_BLACKLISTED`` and ``RTE_DEV_WHITELISTED`` + have been replaced with ``RTE_DEV_BLOCKED`` and ``RTE_DEV_ALLOWED``. + + There are compatibility macros and command line mappings to accept + the old values but applications and scripts are strongly encouraged + to migrate to the new names. ABI Changes -----------
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v9 6/6] doc: update release notes now for block allow changes
Quoted 52 lines · Stephen Hemminger
Remove the deprecation notice and add description to the release notes.
Signed-off-by Stephen Hemminger <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 23 ----------------------- doc/guides/rel_notes/release_20_11.rst | 11 +++++++++++ 2 files changed, 11 insertions(+), 23 deletions(-)doc/guides/rel_notes/deprecation.rst +0
-23@@ -28,29 +28,6 @@ Deprecation Notices * kvargs: The function ``rte_kvargs_process`` will get a new parameter for returning key match count. It will ease handling of no-match case. -* eal: The terms blacklist and whitelist to describe devices used - by DPDK will be replaced in the 20.11 relase. - This will apply to command line arguments as well as macros. - - The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED`` - and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED`` - ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be - replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED`` - respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and - ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with - ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``. - - The old macros will be marked as deprecated in 20.11 and any - usage will cause a compile warning. They will be removed in - a future release. - - The command line arguments to ``rte_eal_init`` will change from - ``-b, --pci-blacklist`` to ``-x, --exclude`` and - ``-w, --pci-whitelist`` to ``-i, --include``. - The old command line arguments will continue to be accepted in 20.11 - but will cause a runtime warning message. The old arguments will - be removed in a future release. - * eal: The function ``rte_eal_remote_launch`` will return new error codes after read or write error on the pipe, instead of calling ``rte_panic``.doc/guides/rel_notes/release_20_11.rst +2
-0@@ -644,6 +644,17 @@ API Changes * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size`` from ``struct rte_sched_subport_params``. +* eal: The selection of devices on the EAL command line has been + changed from ``--pci-blacklist`` and ``--pci-whitelist``
doc/guides/rel_notes/release_20_11.rst API Changes · line 658
Quoted 10 lines
doc/guides/rel_notes/release_20_11.rst +9
-0+ to ``--block`` and ``--allow``. The short form option for + using a device is now ``-a`` instead of ``-w``. + + The internal macros for ``RTE_DEV_BLACKLISTED`` and ``RTE_DEV_WHITELISTED`` + have been replaced with ``RTE_DEV_BLOCKED`` and ``RTE_DEV_ALLOWED``. + + There are compatibility macros and command line mappings to accept + the old values but applications and scripts are strongly encouraged + to migrate to the new names.
Are all the other macro changes non-user visible? Do they need to be called out somewhere, or is the above enough?
/Bruce
Re: [dpdk-dev] [PATCH v9 6/6] doc: update release notes now for block allow changes
Quoted 5 lines
Are all the other macro changes non-user visible? Do they need to be called out somewhere, or is the above enough?
There are some internal enums used to pass things around but they should never have been used directly anyway. We don't have a way to mark macros and enums as internal.
Re: [dpdk-dev] [PATCH v9 0/6] replace blacklist/whitelist with allow/block
In reply to Stephen HemmingerQuoted 82 lines · Stephen Hemminger
This patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v9 - rebase to main and use the feedback from David Marchand
fix some more leftover places where previous names where still in documentation, comments, help etc. split out release note (so people look at it)v8 - incorporate more of the feedback from David Marchand
fix the pci-blacklist option number and reformat the usage (All the usage message should be fixed format).v7 - fix options handling changes in test code.
this should fix the CI failures.Stephen Hemminger (6):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options app/test: use new allowlist and blocklist
doc: change references to blacklist and whitelist
doc: update release notes now for block allow changesapp/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- 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 | 20 +++--- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 16 ++--- doc/guides/nics/ice.rst | 16 ++--- 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 | 8 +-- 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/deprecation.rst | 23 ------- doc/guides/rel_notes/release_20_11.rst | 11 ++++ 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 +- 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 +-
Quoted 9 lines
drivers/net/virtio/virtio_pci.c | 2 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 59 files changed, 326 insertions(+), 299 deletions(-)
I verified that no new build issues are introduced on various distro/archs combination via OBS.
Signature · 2 lines
Kind regards, Luca Boccassi
Re: [dpdk-dev] [PATCH v9 0/6] replace blacklist/whitelist with allow/block
Quoted 93 lines · Luca Boccassi
Quoted 82 lines · Stephen Hemminger
This patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v9 - rebase to main and use the feedback from David Marchand
fix some more leftover places where previous names where still in documentation, comments, help etc. split out release note (so people look at it)v8 - incorporate more of the feedback from David Marchand
fix the pci-blacklist option number and reformat the usage (All the usage message should be fixed format).v7 - fix options handling changes in test code.
this should fix the CI failures.Stephen Hemminger (6):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options app/test: use new allowlist and blocklist
doc: change references to blacklist and whitelist
doc: update release notes now for block allow changesapp/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- 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 | 20 +++--- doc/guides/nics/features.rst | 2 +- doc/guides/nics/i40e.rst | 16 ++--- doc/guides/nics/ice.rst | 16 ++--- 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 | 8 +-- 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/deprecation.rst | 23 ------- doc/guides/rel_notes/release_20_11.rst | 11 ++++ 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 +- 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 +-Quoted 9 lines
drivers/net/virtio/virtio_pci.c | 2 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 59 files changed, 326 insertions(+), 299 deletions(-)
Quoted 3 lines
I verified that no new build issues are introduced on various distro/archs combination via OBS.
For v10, I think this set should be squashed down to fewer (or perhaps 1) patch, to avoid intermediate build errors and to move the release notes updates into the actual patches making the changes.
Thanks,
/Bruce
v10 cover replace blacklist/whitelist with allow/block
In reply to Stephen HemmingerThis patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v10 - Incorporate feedback from Luca to documentation.
Split the compatabilty macros into two parts. First adds them, last marks them as deprecated.
Stephen Hemminger (7):
eal: replace usage of blacklist/whitelist in enum
drivers: replace references to blacklist
eal: replace pci-whitelist/pci-blacklist options
doc: update documentation to reflect new options app/test: use new allowlist and blocklist auto test comment fix
eal: mark old definitions as deprecated
app/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- 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 | 20 +++--- 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 | 22 +++---- 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 | 8 +-- 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 | 8 ++- .../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 +- 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 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 58 files changed, 330 insertions(+), 278 deletions(-)
Signature · 1 line
2.27.0
PATCH v10 1/7 eal: replace usage of blacklist/whitelist in enum
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.
--- lib/librte_eal/common/eal_common_devargs.c | 14 +++++++------- lib/librte_eal/include/rte_bus.h | 8 ++++++-- lib/librte_eal/include/rte_dev.h | 8 ++++++-- lib/librte_eal/include/rte_devargs.h | 8 ++++++-- 4 files changed, 25 insertions(+), 13 deletions(-)
lib/librte_eal/common/eal_common_devargs.c +7 -7
@@ -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 ;
lib/librte_eal/include/rte_bus.h +6 -2
@@ -215,10 +215,14 @@ typedef int (*rte_bus_sigbus_handler_t)(const void *failure_addr);*/ enum rte_bus_scan_mode {RTE_BUS_SCAN_UNDEFINED , -RTE_BUS_SCAN_WHITELIST , -RTE_BUS_SCAN_BLACKLIST , +RTE_BUS_SCAN_ALLOWLIST , +RTE_BUS_SCAN_BLOCKLIST , }; +/* Backwards compatibility will be removed */ +#define RTE_BUS_SCAN_WHITELIST RTE_BUS_SCAN_ALLOWLIST +#define RTE_BUS_SCAN_BLACKLIST RTE_BUS_SCAN_BLOCKLIST +/** * A structure used to configure bus operations. */
lib/librte_eal/include/rte_dev.h +6 -2
@@ -52,10 +52,14 @@ 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_DEV_ALLOWED +#define RTE_DEV_BLACKLISTED RTE_DEV_BLOCKED +/** * A generic memory resource representation. */
lib/librte_eal/include/rte_devargs.h +6 -2
@@ -29,11 +29,15 @@ 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_DEVTYPE_ALLOWED +#define RTE_DEVTYPE_BLACKLISTED_PCI RTE_DEVTYPE_BLOCKED +/** * Structure that stores a device given by the user with its arguments *
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 1/7] eal: replace usage of blacklist/whitelist in enum
Quoted 11 lines · Stephen Hemminger
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.
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Gaetan Rivet <[email protected]>
Quoted 6 lines
--- lib/librte_eal/common/eal_common_devargs.c | 14 +++++++------- lib/librte_eal/include/rte_bus.h | 8 ++++++-- lib/librte_eal/include/rte_dev.h | 8 ++++++-- lib/librte_eal/include/rte_devargs.h | 8 ++++++-- 4 files changed, 25 insertions(+), 13 deletions(-)
Signature · 2 lines
Kind regards, Luca Boccassi
PATCH v10 2/7 drivers: replace references to blacklist
In reply to Stephen HemmingerUse the new terminology blocked to describe when devices are excluded from being used.
--- 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(-)
drivers/bus/dpaa/dpaa_bus.c +3 -4
@@ -584,7 +584,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 */
@@ -646,13 +646,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",
drivers/bus/fslmc/fslmc_bus.c +4 -5
@@ -420,7 +420,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
@@ -451,16 +451,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 Blocked, 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" );
drivers/bus/fslmc/fslmc_vfio.c +6 -6
@@ -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 Blocked, 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 Blocked, skipping" , dev->device.name);TAILQ_REMOVE (&rte_fslmc_bus.device_list, dev, next);continue ;
drivers/bus/pci/pci_common.c +10 -14
@@ -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 ; }
drivers/bus/vmbus/vmbus_common.c +2 -2
@@ -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,
drivers/crypto/virtio/virtio_pci.c +1 -1
@@ -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. */
drivers/net/virtio/virtio_pci.c +1 -1
@@ -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. */
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 2/7] drivers: replace references to blacklist
Quoted 6 lines · Stephen Hemminger
Use the new terminology blocked to describe when devices are excluded from being used.
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Luca Boccassi <[email protected]>Acked-by Hemant Agrawal <[email protected]>
Quoted 9 lines
--- 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(-)
Signature · 2 lines
Kind regards, Luca Boccassi
PATCH v10 3/7 eal: replace pci-whitelist/pci-blacklist options
In reply to Stephen HemmingerReplace -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.
--- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++++--------- lib/librte_eal/common/eal_options.h | 13 ++++- 2 files changed, 49 insertions(+), 30 deletions(-)
lib/librte_eal/common/eal_common_options.c +38 -28
@@ -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,7 @@ eal_short_options[] ="n:" /* memory channels */ "r:" /* memory ranks */ "v" /* version */ -"w:" /* pci-whitelist */ +"w:" /* pci-whitelist (deprecated) */ ; const struct option
@@ -89,8 +90,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 +106,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 } };
@@ -1448,28 +1454,31 @@ eal_parse_common_option(int opt, const char *optarg, struct internal_config *conf) {static int b_used; -static int w_used; +static int a_used;switch (opt) { -/* blacklist */ +case OPT_PCI_BLACKLIST_NUM : +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 , - optarg) <0 ) { +if (a_used) + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_BLOCKED , optarg) <0 )return -1 ; - } b_used =1 ;break ; -/* whitelist */ +case 'w' : +fprintf (stderr, +"Option -w, --pci-whitelist is deprecated, use -a, --allow option instead\n" ); +/* fallthrough */ +case 'a' :if (b_used) - goto bw_used; -if (eal_option_device_add (RTE_DEVTYPE_WHITELISTED_PCI , - optarg) <0 ) { + goto ba_conflict; +if (eal_option_device_add (RTE_DEVTYPE_ALLOWED , optarg) <0 )return -1 ; - } - w_used =1 ; + a_used =1 ;break ;/* coremask */ case 'c' : {
@@ -1760,9 +1769,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" ); + +ba_conflict: +RTE_LOG (ERR ,EAL , +"Options allow (-a) and block (-b) can't be used at the same time\n" );return -1 ; }
@@ -1997,14 +2007,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 <domain:bus:devid.func>.\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, --block Add a device to the blocked list.\n" +" Prevent EAL from using this device. The argument\n" +" format for PCI devices is <domain:bus:devid.func>.\n" +" -a, --allow Add a device to the allow 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 <driver><id>[,key=val,...]\n" " (ex: --vdev=net_pcap0,iface=eth2).\n"
lib/librte_eal/common/eal_options.h +11 -2
@@ -13,8 +13,12 @@ enum {/* long options mapped to a short option */ #define OPT_HELP "help" OPT_HELP_NUM = 'h', -#define OPT_PCI_BLACKLIST "pci-blacklist" - OPT_PCI_BLACKLIST_NUM = 'b', +#define OPT_DEV_ALLOW "allow" + OPT_DEV_ALLOW_NUM = 'a', +#define OPT_DEV_BLOCK "block" + OPT_DEV_BLOCK_NUM = 'b', + +/* legacy option that will be removed in next LTS */ #define OPT_PCI_WHITELIST "pci-whitelist" OPT_PCI_WHITELIST_NUM = 'w',
@@ -89,6 +93,11 @@ enum {OPT_NO_TELEMETRY_NUM , #define OPT_FORCE_MAX_SIMD_BITWIDTH "force-max-simd-bitwidth"OPT_FORCE_MAX_SIMD_BITWIDTH_NUM , + +/* legacy option that will be removed in next LTS */ +#define OPT_PCI_BLACKLIST "pci-blacklist" +OPT_PCI_BLACKLIST_NUM , + OPT_LONG_MAX_NUM };
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 3/7] eal: replace pci-whitelist/pci-blacklist options
Quoted 7 lines · Stephen Hemminger
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.
Quoted 6 lines
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Luca Boccassi <[email protected]>--- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++++--------- lib/librte_eal/common/eal_options.h | 13 ++++- 2 files changed, 49 insertions(+), 30 deletions(-)
Signature · 2 lines
Kind regards, Luca Boccassi
Re: [dpdk-dev] [PATCH v10 3/7] eal: replace pci-whitelist/pci-blacklist options
In reply to Stephen Hemminger10/11/2020 23:55, Stephen Hemminger:
Quoted 3 lines
lib/librte_eal/common/eal_common_options.c +3
-0+/* 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 },
[...]
Quoted 3 lines
lib/librte_eal/common/eal_options.h +1
-0+/* legacy option that will be removed in next LTS */ #define OPT_PCI_WHITELIST "pci-whitelist" OPT_PCI_WHITELIST_NUM = 'w',
[...]
lib/librte_eal/common/eal_options.h enum { · line 99
Quoted 3 lines
lib/librte_eal/common/eal_options.h +3
-0+/* legacy option that will be removed in next LTS */ +#define OPT_PCI_BLACKLIST "pci-blacklist" + OPT_PCI_BLACKLIST_NUM,
Removal has not been decided yet.
I will change to "will be removed in future".
Re: [dpdk-dev] [PATCH v10 3/7] eal: replace pci-whitelist/pci-blacklist options
In reply to Stephen Hemminger10/11/2020 23:55, Stephen Hemminger:
Quoted 10 lines
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 <[email protected]>Acked-by Luca Boccassi <[email protected]>---
[...]
Quoted 3 lines
lib/librte_eal/common/eal_common_options.c +1
-2-if (eal_option_device_add (RTE_DEVTYPE_BLACKLISTED_PCI , - optarg) <0 ) { +if (eal_option_device_add (RTE_DEVTYPE_BLOCKED , optarg) <0 )
[...]
lib/librte_eal/common/eal_common_options.c eal_parse_common_option(int opt, const char *optarg, · line 1479
Quoted 3 lines
lib/librte_eal/common/eal_common_options.c +1
-2-if (eal_option_device_add (RTE_DEVTYPE_WHITELISTED_PCI , - optarg) <0 ) { +if (eal_option_device_add (RTE_DEVTYPE_ALLOWED , optarg) <0 )
This belongs to the first patch.
PATCH v10 4/7 doc: update documentation to reflect new options
In reply to Stephen HemmingerReplace old option syntax -w with -a and update any wording around blacklisting.
--- 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 | 20 ++++++------- 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 | 22 +++++++-------- 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 | 8 +++--- 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 | 8 ++++-- .../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, 178 insertions(+), 158 deletions(-)
doc/guides/cryptodevs/dpaa2_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/dpaa_sec.rst +3 -3
@@ -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
doc/guides/cryptodevs/qat.rst +6 -6
@@ -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
@@ -638,19 +638,19 @@ Testing QAT SYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_autotest QAT ASYM crypto PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>cryptodev_qat_asym_autotest QAT compression PMD can be tested by running the test application:: cd ./<build_dir>/app/test - ./dpdk-test -l1 -n1 -w <your qat bdf> + ./dpdk-test -l1 -n1 -a <your qat bdf> RTE>>compressdev_autotest
doc/guides/eventdevs/octeontx2.rst +10 -10
@@ -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 -----------------
doc/guides/freebsd_gsg/build_sample_apps.rst +1 -1
@@ -67,7 +67,7 @@ DPDK application. Some of the EAL options for FreeBSD are as follows: is a list of cores to use instead of a core mask. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -53,7 +53,7 @@ The EAL options are as follows: Number of memory channels per processor socket. * ``-b <domain:bus:devid.func>``: - Blacklisting of ports; prevent EAL from using specified PCI device + Blocklisting of ports; prevent EAL from using specified PCI device (multiple ``-b`` options are allowed). * ``--use-device``:
doc/guides/linux_gsg/eal_args.include.rst +7 -7
@@ -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 <device arguments>``
doc/guides/linux_gsg/linux_drivers.rst +2 -2
@@ -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: - <build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \ + <build_dir>/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: - <build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \ + <build_dir>/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).
doc/guides/mempool/octeontx2.rst +2 -2
@@ -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 ~~~~~~~~~~~~~~~~~
doc/guides/nics/bnxt.rst +9 -9
@@ -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 -----
@@ -745,7 +745,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
@@ -770,12 +770,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
doc/guides/nics/cxgbe.rst +6 -6
@@ -40,8 +40,8 @@ expose a single PCI bus address, thus, librte_net_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_net_cxgbe in FreeBSD operating system. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i + ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -a 0000:02:00.4 -- -i Example output:
doc/guides/nics/dpaa.rst +3 -3
@@ -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
doc/guides/nics/dpaa2.rst +3 -3
@@ -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
doc/guides/nics/enic.rst +3 -3
@@ -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**
doc/guides/nics/fail_safe.rst +10 -10
@@ -48,7 +48,7 @@ Fail-safe command line parameters This parameter allows the user to define a sub-device. The ``<iface>`` 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 <pmd_build_and_test>`. -#. Start testpmd. The sub-device ``84:00.0`` should be blacklisted from normal EAL - operations to avoid probing it twice, as the PCI bus is in blacklist mode. +#. Start testpmd. The sub-device ``84:00.0`` should be blocked from normal EAL + operations to avoid probing it twice, as the PCI bus is in blocklist mode. .. code-block:: console
@@ -120,25 +120,25 @@ 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 ./<build_dir>/app/dpdk-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 + -a 81:00.0 -- -i #. Start testpmd using a flexible device definition .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -w ff:ff.f \ + ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -a ff:ff.f \ --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i #. Start testpmd, automatically probing the device 84:00.0 and using it with
doc/guides/nics/features.rst +1 -1
@@ -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``.
doc/guides/nics/i40e.rst +8 -8
@@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -452,7 +452,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.
@@ -460,7 +460,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.
@@ -796,7 +796,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,
doc/guides/nics/ice.rst +20 -8
@@ -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=<queues:protocol>[<queues:protocol>...] - -w 18:00.0,proto_xtr=<protocol> + -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...] + -a 18:00.0,proto_xtr=<protocol> Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
@@ -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::
doc/guides/nics/ixgbe.rst +2 -2
@@ -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.
doc/guides/nics/mlx4.rst +9 -9
@@ -24,8 +24,8 @@ Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI bus address, thus unlike most drivers, librte_net_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 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_net_mlx4 relies heavily on system calls for control
@@ -381,7 +381,7 @@ devices managed by librte_net_mlx4. eth4 eth5 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses to be used with the allow argument:: { for intf in eth2 eth3 eth4 eth5;
@@ -389,14 +389,14 @@ devices managed by librte_net_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_net_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::
doc/guides/nics/mlx5.rst +7 -7
@@ -1524,7 +1524,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. eth32 eth33 -#. Optionally, retrieve their PCI bus addresses for whitelisting:: +#. Optionally, retrieve their PCI bus addresses for to be used with the allow list:: { for intf in eth2 eth3 eth4 eth5;
@@ -1532,14 +1532,14 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_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::
@@ -1547,7 +1547,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_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::
doc/guides/nics/nfb.rst +1 -1
@@ -63,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> + ./<build_dir>/app/dpdk-testpmd -a b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> 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.
doc/guides/nics/octeontx2.rst +11 -11
@@ -63,7 +63,7 @@ for details. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1 + ./<build_dir>/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 +116,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 +127,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 +139,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 +151,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 +163,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 +185,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 +194,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 +205,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 +213,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 +229,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:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -350,7 +350,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.
doc/guides/nics/tap.rst +1 -1
@@ -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
doc/guides/nics/thunderx.rst +2 -2
@@ -157,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS. .. code-block:: console - ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \ + ./<build_dir>/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 -----------
doc/guides/prog_guide/env_abstraction_layer.rst +4 -4
@@ -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 -~~~~~~~~~~~~ +Block list +~~~~~~~~~~ -The EAL PCI device blacklist functionality can be used to mark certain NIC ports as blacklisted, +The EAL PCI device block list 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 blocked are identified using the PCIe* description (Domain:Bus:Device.Function). Misc Functions ~~~~~~~~~~~~~~
doc/guides/prog_guide/multi_proc_support.rst +2 -2
@@ -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 blocked by every other process. Running Multiple Independent Groups of DPDK Applications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/poll_mode_drv.rst +3 -3
@@ -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.
doc/guides/prog_guide/switch_representation.rst +3 -3
@@ -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
doc/guides/rel_notes/release_20_11.rst +5 -0
@@ -644,6 +644,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 block/allow list. + 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 -----------
doc/guides/sample_app_ug/bbdev_app.rst +7 -7
@@ -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 - $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> \ + $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -a <NIC0PCIADDR> \ -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 <NIC1PCIADDR> -- -m 1.0 -P + --socket-mem=1,1 --file-prefix=pg -a <NIC1PCIADDR> -- -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 <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. * ``-m <string>``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode
doc/guides/sample_app_ug/eventdev_pipeline.rst +2 -2
@@ -46,8 +46,8 @@ these settings is shown below: .. code-block:: console - ./<build_dir>/examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 / - -e4 -w FF00 -s4 -n0 -c32 -W1000 -D + ./<build_dir>/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
doc/guides/sample_app_ug/ipsec_secgw.rst +6 -6
@@ -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 only use the Ethernet devices needed (via the allow flag) +and therefore implicitly blocking all hardware crypto devices. For example, something like the following command line: .. code-block:: console ./<build_dir>/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 <pci-id>') +* ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a <pci-id>') 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 <pci-id>'). If none specified +* ``CRYPTO_DEV``: crypto device to be used ('-a <pci-id>'). 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 <ipsec_mode> is specified, only tests for that mode will be invoked. For the -list of available modes please refer to run_test.sh. +list of available modes please refer to run_test.sh.
doc/guides/sample_app_ug/l3_forward.rst +5 -3
@@ -138,17 +138,19 @@ Following is the sample command: .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> -- -p 0x3 --eventq-sched=ordered or .. code-block:: console - ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered + ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -a <event device> \ + -- -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 allows the event device supported by platform. + The syntax used to indicate this device may vary based on platform. * The --mode option defines PMD to be used for packet I/O.
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +1 -1
@@ -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
doc/guides/sample_app_ug/l3_forward_power_man.rst +2 -1
@@ -378,7 +378,8 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program .. code-block:: console - ./<build_dir>/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 + ./<build_dir>/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,
doc/guides/sample_app_ug/vdpa.rst +1 -1
@@ -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 \ + -a 0000:06:00.3,vdpa=1 -a 0000:06:00.4,vdpa=1 \ -- --interactive .. note::
doc/guides/tools/cryptoperf.rst +3 -3
@@ -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
doc/guides/tools/flow-perf.rst +1 -1
@@ -65,7 +65,7 @@ with a ``--`` separator: .. code-block:: console - sudo ./dpdk-test-flow_perf -n 4 -w 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 + sudo ./dpdk-test-flow_perf -n 4 -a 08:00.0 -- --ingress --ether --ipv4 --queue --rules-count=1000000 The command line options are:
doc/guides/tools/testregex.rst +1 -1
@@ -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
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
Quoted 39 lines · Stephen Hemminger
Replace old option syntax -w with -a and update any wording around blacklisting.
Signed-off-by Stephen Hemminger <[email protected]>--- 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 | 20 ++++++------- 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 | 22 +++++++-------- 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 | 8 +++--- 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 ++++----
Quoted 8 lines
doc/guides/sample_app_ug/l3_forward.rst | 8 ++++-- .../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, 178 insertions(+), 158 deletions(-)
Signature · 2 lines
Kind regards, Luca Boccassi
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
11/11/2020 11:46, Luca Boccassi:
Quoted 4 lines · Stephen Hemminger
Quoted 1 line
41 files changed, 178 insertions(+), 158 deletions(-)Reviewed-by Luca Boccassi <[email protected]>
There are more occurences to fix:
git grep -Iw -- '-w' | wc -l
36
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
15/11/2020 20:58, Thomas Monjalon:
Quoted 10 lines
11/11/2020 11:46, Luca Boccassi:
Quoted 4 lines · Stephen Hemminger
Quoted 1 line
41 files changed, 178 insertions(+), 158 deletions(-)Reviewed-by Luca Boccassi <[email protected]>There are more occurences to fix:
git grep -Iw -- '-w' | wc -l
36
Even more (thanks David for the regex):
git grep -iE '(white|black)([[:space:]]|-)*list' -- ':^doc/guides/contributingcoding_style.rst' ':^doc/guides/rel_notes' doc | wc -l 12
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
15/11/2020 21:00, Thomas Monjalon:
Quoted 9 lines
15/11/2020 20:58, Thomas Monjalon:
Quoted 8 lines
11/11/2020 11:46, Luca Boccassi:
Quoted 4 lines · Stephen Hemminger
Quoted 1 line
41 files changed, 178 insertions(+), 158 deletions(-)Reviewed-by Luca Boccassi <[email protected]>There are more occurences to fix:
Quoted 7 lines
Quoted 2 lines
git grep -Iw -- '-w' | wc -l
36Even more (thanks David for the regex):
git grep -iE '(white|black)([[:space:]]|-)*list' -- ':^doc/guides/contributingcoding_style.rst' ':^doc/guides/rel_notes' doc | wc -l 12
One more doc update missing: the removal of the deprecation notice.
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
15/11/2020 22:38, Thomas Monjalon:
Quoted 13 lines
15/11/2020 21:00, Thomas Monjalon:
Quoted 12 lines
15/11/2020 20:58, Thomas Monjalon:
Quoted 10 lines
11/11/2020 11:46, Luca Boccassi:
Quoted 4 lines · Stephen Hemminger
Quoted 1 line
41 files changed, 178 insertions(+), 158 deletions(-)Reviewed-by Luca Boccassi <[email protected]>There are more occurences to fix:
git grep -Iw -- '-w' | wc -l
36
Quoted 6 lines
Quoted 4 lines
Even more (thanks David for the regex):
git grep -iE '(white|black)([[:space:]]|-)*list' -- ':^doc/guides/contributingcoding_style.rst' ':^doc/guides/rel_notes' doc | wc -l 12
One more doc update missing: the removal of the deprecation notice.
Will add these changes:
devtools/test-null.sh +1 -1
@@ -28,5 +28,5 @@ fi (sleep 1 && echo stop) | $testpmd -c $coremask --no-huge -m 20 \ - $libs -w 0:0.0 --vdev net_null1 --vdev net_null2 $eal_options -- \ + $libs -a 0:0.0 --vdev net_null1 --vdev net_null2 $eal_options -- \ --no-mlockall --total-num-mbufs=2048 $testpmd_options -ia
doc/guides/bbdevs/acc100.rst +1 -1
@@ -241,4 +241,4 @@ Specifically for the BBDEV ACC100 PMD, the command below can be used: .. code-block:: console ./pf_bb_config ACC100 -c acc100/acc100_config_vf_5g.cfg - ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data + ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
doc/guides/bbdevs/fpga_5gnr_fec.rst +1 -1
@@ -304,4 +304,4 @@ Specifically for the BBDEV FPGA 5GNR FEC PMD, the command below can be used: .. code-block:: console ./pf_bb_config FPGA_5GNR -c fpga_5gnr/fpga_5gnr_config_vf.cfg - ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data + ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
doc/guides/bbdevs/fpga_lte_fec.rst +1 -1
@@ -323,4 +323,4 @@ Specifically for the BBDEV FPGA LTE FEC PMD, the command below can be used: .. code-block:: console ./pf_bb_config FPGA_LTE -c fpga_lte/fpga_lte_config_vf.cfg - ./test-bbdev.py -e="-c 0xff0 -w${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data + ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./turbo_dec_default.data
doc/guides/nics/dpaa2.rst +3 -3
@@ -514,18 +514,18 @@ For blocking a DPAA2 device, following commands can be used. Where x is the device object id as configured in resource container. -Running secondary debug app without blacklist +Running secondary debug app without blocklist --------------------------------------------- dpaa2 hardware imposes limits on some H/W access devices like Management Control Port and H/W portal. This causes issue in their shared usages in case of multi-process applications. It can overcome by using -whitelist/blacklist in primary and secondary applications. +allowlist/blocklist in primary and secondary applications. In order to ease usage of standard debugging apps like dpdk-procinfo, dpaa2 driver reserves extra Management Control Port and H/W portal which can be used by debug application to debug any existing application without -blacklisting these devices in primary process. +blocking these devices in primary process. Limitations -----------
doc/guides/nics/enic.rst +2 -2
@@ -180,7 +180,7 @@ 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, block the enic module as follows. Please see :ref:`Limitations <enic_limitations>` for limitations in the use of SR-IOV.
@@ -430,7 +430,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 blocked 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.
doc/guides/nics/fm10k.rst +1 -1
@@ -19,7 +19,7 @@ resource tag) information, rather than the mac and vlan table. Currently this feature works only on PF. To enable this feature, the user should pass a devargs parameter to the eal -like "-w 84:00.0,enable_ftag=1", and the application should make sure an +like "-a 84:00.0,enable_ftag=1", and the application should make sure an appropriate FTAG is inserted for every frame on TX side. Vector PMD for FM10K
doc/guides/prog_guide/compressdev.rst +1 -1
@@ -19,7 +19,7 @@ Physical compression devices are discovered during the bus probe of the EAL func which is executed at DPDK initialization, based on their unique device identifier. For e.g. PCI devices can be identified using PCI BDF (bus/bridge, device, function). Specific physical compression devices, like other physical devices in DPDK can be -white-listed or black-listed using the EAL command line options. +listed using the EAL command line options. Virtual devices can be created by two mechanisms, either using the EAL command line options or from within the application using an EAL API directly.
doc/guides/prog_guide/cryptodev_lib.rst +1 -1
@@ -32,7 +32,7 @@ Physical Crypto devices are discovered during the PCI probe/enumeration of the EAL function which is executed at DPDK initialization, based on their PCI device identifier, each unique PCI BDF (bus/bridge, device, function). Specific physical Crypto devices, like other physical devices in DPDK -can be white-listed or black-listed using the EAL command line options. +can be listed using the EAL command line options. Virtual devices can be created by two mechanisms, either using the EAL command line options or from within the application using an EAL API directly.
doc/guides/prog_guide/regexdev.rst +1 -1
@@ -30,7 +30,7 @@ Physical RegEx devices are discovered during the PCI probe/enumeration of the EAL function which is executed at DPDK initialization, based on their PCI device identifier, each unique PCI BDF (bus/bridge, device, function). Specific physical ReEx devices, like other physical devices in DPDK -can be white-listed or black-listed using the EAL command line options. +can be listed using the EAL command line options. Device Identification
doc/guides/rel_notes/deprecation.rst +0 -11
@@ -28,17 +28,6 @@ Deprecation Notices * kvargs: The function ``rte_kvargs_process`` will get a new parameter for returning key match count. It will ease handling of no-match case. -* eal: The terms blacklist and whitelist to describe devices used - by DPDK will be replaced in the 20.11 relase. - This will apply to command line arguments. - - The command line arguments to ``rte_eal_init`` will change from - ``-b, --pci-blacklist`` to ``-x, --exclude`` and - ``-w, --pci-whitelist`` to ``-i, --include``. - The old command line arguments will continue to be accepted in 20.11 - but will cause a runtime warning message. The old arguments will - be removed in a future release. - * eal: The function ``rte_eal_remote_launch`` will return new error codes after read or write error on the pipe, instead of calling ``rte_panic``.
doc/guides/sample_app_ug/bbdev_app.rst +1 -1
@@ -106,7 +106,7 @@ 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 -* ``-a <NIC1PCIADDR>``: Add a PCI device in white list. The argument format is <[domain:]bus:devid.func>. +* ``-a <NIC1PCIADDR>``: Add a PCI device in allow list. The argument format is <[domain:]bus:devid.func>. * ``-m <string>``: Matrix for mapping ports to logical cores. * ``-P``: PROMISCUOUS mode
doc/guides/tools/comp_perf.rst +2 -2
@@ -53,9 +53,9 @@ See the DPDK Getting Started Guides for more information on these options. One lcore is needed for process admin, tests are run on all other cores. To run tests on two lcores, three lcores must be passed to the tool. -* ``-w <PCI>`` +* ``-a <PCI>`` - Add a PCI device in white list. + Add a PCI device in allow list. * ``--vdev <driver><id>``
doc/guides/tools/cryptoperf.rst +2 -2
@@ -65,9 +65,9 @@ See the DPDK Getting Started Guides for more information on these options. Set the hexadecimal bitmask of the cores to run on. The corelist is a list cores to use. -* ``-w <PCI>`` +* ``-a <PCI>`` - Add a PCI device in white list. + Add a PCI device in allow list. * ``--vdev <driver><id>``
drivers/bus/vmbus/vmbus_common.c +1 -1
@@ -206,7 +206,7 @@ vmbus_parse(const char *name, void *addr)/* * scan for matching device args on command line * example: -* -w 'vmbus:635a7ae3-091e-4410-ad59-667c4f8c04c3,latency=20' +* -a 'vmbus:635a7ae3-091e-4410-ad59-667c4f8c04c3,latency=20' */ struct rte_devargs *vmbus_devargs_lookup (struct rte_vmbus_device *dev)
drivers/net/bnxt/bnxt_ethdev.c +9 -9
@@ -5151,21 +5151,21 @@ bnxt_parse_dev_args(struct bnxt *bp, struct rte_devargs *devargs)/* * Handler for "truflow" devarg. -* Invoked as for ex: "-w 0000:00:0d.0,host-based-truflow=1" +* Invoked as for ex: "-a 0000:00:0d.0,host-based-truflow=1" */ rte_kvargs_process (kvlist,BNXT_DEVARG_TRUFLOW , bnxt_parse_devarg_truflow, bp);/* * Handler for "flow_xstat" devarg. -* Invoked as for ex: "-w 0000:00:0d.0,flow_xstat=1" +* Invoked as for ex: "-a 0000:00:0d.0,flow_xstat=1" */ rte_kvargs_process (kvlist,BNXT_DEVARG_FLOW_XSTAT , bnxt_parse_devarg_flow_xstat, bp);/* * Handler for "max_num_kflows" devarg. -* Invoked as for ex: "-w 000:00:0d.0,max_num_kflows=32" +* Invoked as for ex: "-a 000:00:0d.0,max_num_kflows=32" */ rte_kvargs_process (kvlist,BNXT_DEVARG_MAX_NUM_KFLOWS , bnxt_parse_devarg_max_num_kflows, bp);
@@ -5569,7 +5569,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev,if (kvlist) {/* * Handler for "rep_is_pf" devarg. -* Invoked as for ex: "-w 000:00:0d.0, +* Invoked as for ex: "-a 000:00:0d.0, * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>" */ ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_IS_PF,
@@ -5581,7 +5581,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev, }/* * Handler for "rep_based_pf" devarg. -* Invoked as for ex: "-w 000:00:0d.0, +* Invoked as for ex: "-a 000:00:0d.0, * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>" */ ret = rte_kvargs_process(kvlist,
@@ -5594,7 +5594,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev, }/* * Handler for "rep_based_pf" devarg. -* Invoked as for ex: "-w 000:00:0d.0, +* Invoked as for ex: "-a 000:00:0d.0, * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>" */ ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_Q_R2F,
@@ -5606,7 +5606,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev, }/* * Handler for "rep_based_pf" devarg. -* Invoked as for ex: "-w 000:00:0d.0, +* Invoked as for ex: "-a 000:00:0d.0, * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>" */ ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_Q_F2R,
@@ -5618,7 +5618,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev, }/* * Handler for "rep_based_pf" devarg. -* Invoked as for ex: "-w 000:00:0d.0, +* Invoked as for ex: "-a 000:00:0d.0, * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>" */ ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_FC_R2F,
@@ -5630,7 +5630,7 @@ static int bnxt_rep_port_probe(struct rte_pci_device *pci_dev, }/* * Handler for "rep_based_pf" devarg. -* Invoked as for ex: "-w 000:00:0d.0, +* Invoked as for ex: "-a 000:00:0d.0, * rep-based-pf=<pf index> rep-is-pf=<VF=0 or PF=1>" */ ret = rte_kvargs_process(kvlist, BNXT_DEVARG_REP_FC_F2R,
examples/ipsec-secgw/test/linux_test.sh +2 -2
@@ -14,7 +14,7 @@ # SGW_PATH - path to the ipsec-secgw binary to test # REMOTE_HOST - ip/hostname of the DUT # REMOTE_IFACE - iface name for the test-port on DUT -# ETH_DEV - ethernet device to be used on SUT by DPDK ('-w <pci-id>') +# ETH_DEV - ethernet device to be used on SUT by DPDK ('-a <pci-id>') # Also user can optionally setup: # SGW_LCORE - lcore to run ipsec-secgw on (default value is 0) # SGW_MODE - run ipsec-secgw in legacy mode or with use of library
@@ -29,7 +29,7 @@ # values: cpu-crypto/lookaside-none (unset on default) # CRYPTO_PRIM_TYPE - run ipsec-secgw with crypto primary type set # values: cpu-crypto (unset on default) -# CRYPTO_DEV - crypto device to be used ('-w <pci-id>') +# CRYPTO_DEV - crypto device to be used ('-a <pci-id>') # if none specified appropriate vdevs will be created by the script # SGW_MULTI_SEG - ipsec-secgw option to enable reassembly support and # specify size of reassembly table (i.e. SGW_MULTI_SEG=128)
examples/ipsec-secgw/test/run_test.sh +2 -2
@@ -8,10 +8,10 @@ # SGW_PATH - path to the ipsec-secgw binary to test # REMOTE_HOST - ip/hostname of the DUT # REMOTE_IFACE - iface name for the test-port on DUT -# ETH_DEV - ethernet device to be used on SUT by DPDK ('-w <pci-id>') +# ETH_DEV - ethernet device to be used on SUT by DPDK ('-a <pci-id>') # Also user can optionally setup: # SGW_LCORE - lcore to run ipsec-secgw on (default value is 0) -# CRYPTO_DEV - crypto device to be used ('-w <pci-id>') +# CRYPTO_DEV - crypto device to be used ('-a <pci-id>') # if none specified appropriate vdevs will be created by the script # SGW_MULTI_SEG - ipsec-secgw option to enable reassembly support and # specify size of reassembly table (i.e. SGW_MULTI_SEG=128)
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
In reply to Stephen Hemminger10/11/2020 23:55, Stephen Hemminger:
doc/guides/linux_gsg/eal_args.include.rst Lcore-related options · line 57
Quoted 7 lines
doc/guides/linux_gsg/eal_args.include.rst +2
-2-* ``-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.
Not exactly "probed" but "to be probed".
doc/guides/linux_gsg/eal_args.include.rst Lcore-related options · line 60
Quoted 4 lines
.. Note::
doc/guides/linux_gsg/eal_args.include.rst +1
-1- PCI whitelist cannot be used with ``-b`` option. + PCI only list cannot be used with the skip probe ``-b`` option.
"PCI only list", you mean "PCI allow list"?
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
In reply to Stephen Hemminger10/11/2020 23:55, Stephen Hemminger:
Quoted 6 lines
doc/guides/nics/ice.rst +3
-1- -w 80:00.0,pipeline-mode-support=1 + -a 80:00.0,pipeline-mode-support=1 + +- ``Flow Mark Support`` (default ``0``)
doc/guides/nics/ice.rst Runtime Config Options · line 68
Quoted 10 lines
doc/guides/nics/ice.rst +10
-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
It looks to be a rebase issue.
This is reverting "net/ice: remove devargs for flow mark".
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
In reply to Stephen Hemminger10/11/2020 23:55, Stephen Hemminger:
doc/guides/nics/mlx4.rst Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI · line 28
Quoted 6 lines
doc/guides/nics/mlx4.rst +2
-2-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 block (or allow) a single port without also +blocking (o allowing) the others on the same device.
Typo: "or allowing"
Re: [dpdk-dev] [PATCH v10 4/7] doc: update documentation to reflect new options
In reply to Stephen Hemminger10/11/2020 23:55, Stephen Hemminger:
Quoted 2 lines
Replace old option syntax -w with -a and update any wording around blacklisting.
I think the other updates for MAC filtering or module blocking should be in a separate patch, not with -w/-a changes.
PATCH v10 5/7 app/test: use new allowlist and blocklist
In reply to Stephen HemmingerTest the renamed blocklist and allowlist arguments. Use new terms in test variable names as well.
--- app/test/autotest.py | 16 +++++------ app/test/autotest_runner.py | 18 ++++++------- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++++++++++++++------------------ 4 files changed, 45 insertions(+), 44 deletions(-)
app/test/autotest.py +8 -8
@@ -10,7 +10,7 @@ def usage(): print("Usage: autotest.py [test app|test iso image] ", - "[target] [whitelist|-blacklist]") + "[target] [allow|-block]") 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[:]
app/test/autotest_runner.py +9 -9
@@ -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
app/test/test.c +1 -1
@@ -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_allow_flag", no_action }, { "test_invalid_b_flag", no_action }, { "test_invalid_vdev_flag", no_action }, { "test_invalid_r_flag", no_action },
app/test/test_eal_flags.c +27 -26
140 lines not on this page · raw message
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 5/7] app/test: use new allowlist and blocklist
Quoted 11 lines · Stephen Hemminger
Test the renamed blocklist and allowlist arguments. Use new terms in test variable names as well.
Signed-off-by Stephen Hemminger <[email protected]>Acked-by Luca Boccassi <[email protected]>--- app/test/autotest.py | 16 +++++------ app/test/autotest_runner.py | 18 ++++++------- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++++++++++++++------------------ 4 files changed, 45 insertions(+), 44 deletions(-)
Signature · 2 lines
Kind regards, Luca Boccassi
PATCH v10 6/7 auto test comment fix
In reply to Stephen Hemminger--- app/test/autotest_runner.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
app/test/autotest_runner.py +1 -1
@@ -279,7 +279,7 @@ def __filter_test(self, test): if "_autotest" in test_id: test_id = test_id[:-len("_autotest")] - # filter out blocklisted/allowlisted tests + # filter out blocked/allowed tests if self.blocklist and test_id in self.blocklist: return False if self.allowlist and test_id not in self.allowlist:
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 6/7] auto test comment fix
Quoted 3 lines · Stephen Hemminger
--- app/test/autotest_runner.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Signature · 2 lines
Kind regards, Luca Boccassi
PATCH v10 7/7 eal: mark old definitions as deprecated
In reply to Stephen HemmingerThis patch marks the compatiablity macros with RTE_DEPRECATED which causes a warning if used. There are no remaining warnings in the current release.
--- lib/librte_eal/include/rte_bus.h | 6 ++++-- lib/librte_eal/include/rte_dev.h | 6 ++++-- lib/librte_eal/include/rte_devargs.h | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
lib/librte_eal/include/rte_bus.h +4 -2
@@ -220,8 +220,10 @@ enum rte_bus_scan_mode { };/* Backwards compatibility will be removed */ -#define RTE_BUS_SCAN_WHITELIST RTE_BUS_SCAN_ALLOWLIST -#define RTE_BUS_SCAN_BLACKLIST RTE_BUS_SCAN_BLOCKLIST +#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.
lib/librte_eal/include/rte_dev.h +4 -2
@@ -57,8 +57,10 @@ enum rte_dev_policy { };/* Backwards compatibility will be removed */ -#define RTE_DEV_WHITELISTED RTE_DEV_ALLOWED -#define RTE_DEV_BLACKLISTED RTE_DEV_BLOCKED +#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.
lib/librte_eal/include/rte_devargs.h +4 -2
@@ -35,8 +35,10 @@ enum rte_devtype { };/* Backwards compatibility will be removed later */ -#define RTE_DEVTYPE_WHITELISTED_PCI RTE_DEVTYPE_ALLOWED -#define RTE_DEVTYPE_BLACKLISTED_PCI RTE_DEVTYPE_BLOCKED +#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
Signature · 1 line
2.27.0
Re: [dpdk-dev] [PATCH v10 7/7] eal: mark old definitions as deprecated
Quoted 10 lines · Stephen Hemminger
This patch marks the compatiablity macros with
RTE_DEPRECATEDwhich causes a warning if used. There are no remaining warnings in the current release.Signed-off-by Stephen Hemminger <[email protected]>--- lib/librte_eal/include/rte_bus.h | 6 ++++-- lib/librte_eal/include/rte_dev.h | 6 ++++-- lib/librte_eal/include/rte_devargs.h | 6 ++++-- 3 files changed, 12 insertions(+), 6 deletions(-)
Signature · 2 lines
Kind regards, Luca Boccassi
v11 cover replace blacklist/whitelist with block/allow
In reply to Stephen HemmingerThis patch series changes the use of the terms blacklist and whitelist and instead uses block and allow. The change is most visible in the options passed to DPDK programs for marking which devices to use.
The options are also shortened because they can be used for not just PCI devices. When DPDK was expanded to support other bus types the -b option was also uses for non-PCI devices. But the documentation and the name of the long option never changed.
v11 (Thomas): prepare clean patches for merging in -rc4. For details, see comments on v10.
Stephen Hemminger (4):
eal: replace usage of blacklist/whitelist in enums
eal: replace blacklist/whitelist options
test: rename blacklist/whitelist in autotest scripts
doc: replace usage of blacklist/whitelist
app/test/autotest.py | 16 ++--- app/test/autotest_runner.py | 18 ++--- app/test/test.c | 2 +- app/test/test_eal_flags.c | 53 +++++++-------- devtools/test-null.sh | 2 +- doc/guides/bbdevs/acc100.rst | 2 +- doc/guides/bbdevs/fpga_5gnr_fec.rst | 2 +- doc/guides/bbdevs/fpga_lte_fec.rst | 2 +- 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 | 12 ++-- doc/guides/nics/enic.rst | 10 +-- doc/guides/nics/fail_safe.rst | 20 +++--- doc/guides/nics/features.rst | 2 +- doc/guides/nics/fm10k.rst | 2 +- doc/guides/nics/i40e.rst | 16 ++--- doc/guides/nics/ice.rst | 16 ++--- 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 | 22 +++---- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 2 +- doc/guides/nics/thunderx.rst | 4 +- doc/guides/prog_guide/compressdev.rst | 2 +- doc/guides/prog_guide/cryptodev_lib.rst | 2 +- .../prog_guide/env_abstraction_layer.rst | 8 +-- doc/guides/prog_guide/multi_proc_support.rst | 4 +- doc/guides/prog_guide/poll_mode_drv.rst | 6 +- doc/guides/prog_guide/regexdev.rst | 2 +- .../prog_guide/switch_representation.rst | 6 +- doc/guides/rel_notes/deprecation.rst | 23 ------- doc/guides/rel_notes/release_20_11.rst | 6 ++ doc/guides/sample_app_ug/bbdev_app.rst | 14 ++-- .../sample_app_ug/eventdev_pipeline.rst | 4 +- doc/guides/sample_app_ug/ipsec_secgw.rst | 10 +-- doc/guides/sample_app_ug/l3_forward.rst | 8 ++- .../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/comp_perf.rst | 4 +- doc/guides/tools/cryptoperf.rst | 10 +-- doc/guides/tools/flow-perf.rst | 2 +- doc/guides/tools/testregex.rst | 2 +- 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 | 6 +- drivers/crypto/virtio/virtio_pci.c | 2 +- drivers/net/bnxt/bnxt_ethdev.c | 18 ++--- drivers/net/virtio/virtio_pci.c | 2 +- examples/ipsec-secgw/test/linux_test.sh | 4 +- examples/ipsec-secgw/test/run_test.sh | 4 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++-- lib/librte_eal/common/eal_common_options.c | 66 +++++++++++-------- lib/librte_eal/common/eal_options.h | 13 +++- lib/librte_eal/include/rte_bus.h | 10 ++- lib/librte_eal/include/rte_dev.h | 10 ++- lib/librte_eal/include/rte_devargs.h | 10 ++- 71 files changed, 349 insertions(+), 331 deletions(-)
Signature · 1 line
2.28.0
PATCH v11 1/4 eal: replace usage of blacklist/whitelist in enums
From: Stephen Hemminger <[email protected]>
Rename 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, marked as deprecated.
--- doc/guides/rel_notes/deprecation.rst | 14 +------------ 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 +- lib/librte_eal/common/eal_common_devargs.c | 14 ++++++------- lib/librte_eal/common/eal_common_options.c | 4 ++-- lib/librte_eal/include/rte_bus.h | 10 +++++++-- lib/librte_eal/include/rte_dev.h | 10 +++++++-- lib/librte_eal/include/rte_devargs.h | 10 +++++++-- 13 files changed, 61 insertions(+), 61 deletions(-)
doc/guides/rel_notes/deprecation.rst +1 -13
@@ -30,19 +30,7 @@ Deprecation Notices * eal: The terms blacklist and whitelist to describe devices used by DPDK will be replaced in the 20.11 relase. - This will apply to command line arguments as well as macros. - - The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED`` - and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED`` - ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be - replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED`` - respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and - ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with - ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``. - - The old macros will be marked as deprecated in 20.11 and any - usage will cause a compile warning. They will be removed in - a future release. + This will apply to command line arguments. The command line arguments to ``rte_eal_init`` will change from ``-b, --pci-blacklist`` to ``-x, --exclude`` and
drivers/bus/dpaa/dpaa_bus.c +3 -4
@@ -584,7 +584,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 */
@@ -646,13 +646,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",
drivers/bus/fslmc/fslmc_bus.c +4 -5
@@ -420,7 +420,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
@@ -451,16 +451,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 Blocked, 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" );
drivers/bus/fslmc/fslmc_vfio.c +6 -6
@@ -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 Blocked, 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 Blocked, skipping" , dev->device.name);TAILQ_REMOVE (&rte_fslmc_bus.device_list, dev, next);continue ;
drivers/bus/pci/pci_common.c +10 -14
@@ -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 ; }
drivers/bus/vmbus/vmbus_common.c +2 -2
@@ -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,
drivers/crypto/virtio/virtio_pci.c +1 -1
@@ -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. */
drivers/net/virtio/virtio_pci.c +1 -1
@@ -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. */
lib/librte_eal/common/eal_common_devargs.c +7 -7
@@ -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 ;
lib/librte_eal/common/eal_common_options.c +2 -2
@@ -1455,7 +1455,7 @@ eal_parse_common_option(int opt, const char *optarg,case 'b' :if (w_used) goto bw_used; -if (eal_option_device_add (RTE_DEVTYPE_BLACKLISTED_PCI , +if (eal_option_device_add (RTE_DEVTYPE_BLOCKED , optarg) <0 ) {return -1 ; }
@@ -1465,7 +1465,7 @@ eal_parse_common_option(int opt, const char *optarg,case 'w' :if (b_used) goto bw_used; -if (eal_option_device_add (RTE_DEVTYPE_WHITELISTED_PCI , +if (eal_option_device_add (RTE_DEVTYPE_ALLOWED , optarg) <0 ) {return -1 ; }
lib/librte_eal/include/rte_bus.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_dev.h +8 -2
@@ -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. */
lib/librte_eal/include/rte_devargs.h +8 -2
@@ -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 *
Signature · 1 line
2.28.0