Skip to contentSkip to conversation

remove dpdk-setup.sh

PATCH Applied David Marchand 6 participants 9 messages Nov 27, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 remove dpdk-setup.sh

This old script relied on deprecated stuff, and especially make. It also applied some scary 666 permissions on files under /dev/vfio.

Its deprecation had been notified in a previous release, remove it.

---
 doc/guides/bbdevs/acc100.rst               |  15 +-
 doc/guides/bbdevs/fpga_5gnr_fec.rst        |  20 +-
 doc/guides/bbdevs/fpga_lte_fec.rst         |  20 +-
 doc/guides/faq/faq.rst                     |   3 +-
 doc/guides/linux_gsg/build_dpdk.rst        |   5 -
 doc/guides/linux_gsg/build_sample_apps.rst |   5 -
 doc/guides/linux_gsg/index.rst             |   1 -
 doc/guides/linux_gsg/linux_drivers.rst     |   1 -
 doc/guides/linux_gsg/quick_start.rst       | 304 ----------
 doc/guides/rel_notes/deprecation.rst       |   5 -
 doc/guides/rel_notes/release_20_11.rst     |   2 +
 usertools/dpdk-setup.sh                    | 609 ---------------------
 12 files changed, 6 insertions(+), 984 deletions(-)
 delete mode 100644 doc/guides/linux_gsg/quick_start.rst
 delete mode 100755 usertools/dpdk-setup.sh
doc/guides/bbdevs/acc100.rst +1 -14
index 9c37bc3be1..129216b65e 100644
@@ -96,7 +96,7 @@ Bind PF UIO driver(s)
 Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
 ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
 
-The igb_uio driver may be bound to the PF PCI device using one of three methods:
+The igb_uio driver may be bound to the PF PCI device using one of two methods:
 
 
 1. PCI functions (physical or virtual, depending on the use case) can be bound to
@@ -120,19 +120,6 @@ the UIO driver by repeating this command for every function.
 where the PCI device ID (example: 0000:06:00.0) is obtained using lspci -vd8086:0d5c
 
 
-3. A third way to bind is to use ``dpdk-setup.sh`` tool
-
-.. code-block:: console
-
-  cd <dpdk-top-level-directory>
-  ./usertools/dpdk-setup.sh
-
-  select 'Bind Ethernet/Crypto/Baseband device to IGB UIO module'
-  enter PCI device ID
-  select 'Display current Ethernet/Crypto/Baseband device settings' to confirm binding
-
-In a similar way the ACC100 5G/4G FEC PF may be bound with vfio-pci as any PCIe device.
-
 Enable Virtual Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
doc/guides/bbdevs/fpga_5gnr_fec.rst +1 -19
index 161f5e2ae4..814dbf1720 100644
@@ -82,7 +82,7 @@ Bind PF UIO driver(s)
 Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
 ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
 
-The igb_uio driver may be bound to the PF PCI device using one of three methods:
+The igb_uio driver may be bound to the PF PCI device using one of two methods:
 
 
 1. PCI functions (physical or virtual, depending on the use case) can be bound to
@@ -105,24 +105,6 @@ the UIO driver by repeating this command for every function.
 where the PCI device ID (example: 0000:06:00.0) is obtained using lspci -vd8086:0d8f
 
 
-3. A third way to bind is to use ``dpdk-setup.sh`` tool
-
-.. code-block:: console
-
-  cd <dpdk-top-level-directory>
-  ./usertools/dpdk-setup.sh
-
-  select 'Bind Ethernet/Crypto/Baseband device to IGB UIO module'
-  or
-  select 'Bind Ethernet/Crypto/Baseband device to VFIO module' depending on driver required
-  enter PCI device ID
-  select 'Display current Ethernet/Crypto/Baseband device settings' to confirm binding
-
-
-In the same way the FPGA 5GNR FEC PF can be bound with vfio, but vfio driver does not
-support SR-IOV configuration right out of the box, so it will need to be patched.
-
-
 Enable Virtual Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
doc/guides/bbdevs/fpga_lte_fec.rst +1 -19
index e268e5b9dc..4d9ac86e9f 100644
@@ -81,7 +81,7 @@ Bind PF UIO driver(s)
 Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
 ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
 
-The igb_uio driver may be bound to the PF PCI device using one of three methods:
+The igb_uio driver may be bound to the PF PCI device using one of two methods:
 
 
 1. PCI functions (physical or virtual, depending on the use case) can be bound to
@@ -104,24 +104,6 @@ the UIO driver by repeating this command for every function.
 where the PCI device ID (example: 0000:06:00.0) is obtained using lspci -vd1172:
 
 
-3. A third way to bind is to use ``dpdk-setup.sh`` tool
-
-.. code-block:: console
-
-  cd <dpdk-top-level-directory>
-  ./usertools/dpdk-setup.sh
-
-  select 'Bind Ethernet/Crypto/Baseband device to IGB UIO module'
-  or
-  select 'Bind Ethernet/Crypto/Baseband device to VFIO module' depending on driver required
-  enter PCI device ID
-  select 'Display current Ethernet/Crypto/Baseband device settings' to confirm binding
-
-
-In the same way the FPGA LTE FEC PF can be bound with vfio, but vfio driver does not
-support SR-IOV configuration right out of the box, so it will need to be patched.
-
-
 Enable Virtual Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
doc/guides/faq/faq.rst +1 -2
index ee8c1697b4..2aec432d75 100644
@@ -22,8 +22,7 @@ When you stop and restart the test application, it looks to see if the pages are
 If you look in the directory, you will see ``n`` number of 2M pages files. If you specified 1024, you will see 1024 page files.
 These are then placed in memory segments to get contiguous memory.
 
-If you need to change the number of pages, it is easier to first remove the pages. The usertools/dpdk-setup.sh script provides an option to do this.
-See the "Quick Start Setup Script" section in the :ref:`DPDK Getting Started Guide <linux_gsg>` for more information.
+If you need to change the number of pages, it is easier to first remove the pages.
 
 
 If I execute "l2fwd -l 0-3 -m 64 -n 3 -- -p 3", I get the following output, indicating that there are no socket 0 hugepages to allocate the mbuf and ring structures to?
doc/guides/linux_gsg/build_dpdk.rst +0 -5
index 8ce0f23097..f78eef2517 100644
@@ -6,11 +6,6 @@
 Compiling the DPDK Target from Source
 =====================================
 
-.. note::
-
-    Parts of this process can also be done using the setup script described in
-    the :ref:`linux_setup_script` section of this document.
-
 Uncompress DPDK and Browse Sources
 ----------------------------------
 
doc/guides/linux_gsg/build_sample_apps.rst +0 -5
index 994db4b6a0..78652549a7 100644
@@ -7,11 +7,6 @@ Running Sample Applications
 The chapter describes how to compile and run applications in a DPDK environment.
 It also provides a pointer to where sample applications are stored.
 
-.. note::
-
-    Parts of this process can also be done using the setup script described the
-    :ref:`linux_setup_script` section of this document.
-
 Compiling a Sample Application
 ------------------------------
 
doc/guides/linux_gsg/index.rst +0 -1
index 0f9f6242c1..16a9a67260 100644
@@ -18,5 +18,4 @@ Getting Started Guide for Linux
     build_sample_apps
     linux_eal_parameters
     enable_func
-    quick_start
     nic_perf_intel_platform
doc/guides/linux_gsg/linux_drivers.rst +0 -1
index 2d750b4c33..65373f1448 100644
@@ -107,7 +107,6 @@ Also, to use VFIO, both kernel and BIOS must support and be configured to use IO
     ``vfio-pci`` module doesn't support the creation of virtual functions before Linux version 5.7.
 
 For proper operation of VFIO when running DPDK applications as a non-privileged user, correct permissions should also be set up.
-This can be done by using the DPDK setup script (called dpdk-setup.sh and located in the usertools directory).
 
 .. note::
 
doc/guides/linux_gsg/quick_start.rst deleted +0 -304

304 lines not on this page · raw message

doc/guides/rel_notes/deprecation.rst +0 -5
index 1271a7cf28..f418285d28 100644
@@ -100,8 +100,3 @@ Deprecation Notices
 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
   content. On Linux and FreeBSD, supported prior to DPDK 20.11,
   original structure will be kept until DPDK 21.11.
-
-* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
-  ``make``. Given environments are too much variables for such a simple script,
-  it will be removed in DPDK 20.11.
-  Some useful parts may be converted into specific scripts.
doc/guides/rel_notes/release_20_11.rst +2 -0
index 24a078c995..7405a9864f 100644
@@ -457,6 +457,8 @@ Removed Items
 
 * Removed TEP termination sample application.
 
+* Removed the deprecated ``dpdk-setup.sh`` script.
+
 
 API Changes
 -----------
usertools/dpdk-setup.sh deleted +0 -609

609 lines not on this page · raw message

Signature · 1 line
2.23.0
Acked-by
#3 lore raw
Quoted 5 lines · Thomas Monjalon
Quoted 5 lines
Quoted 5 lines

This old script relied on deprecated stuff, and especially make. It also applied some scary 666 permissions on files under /dev/vfio.

Its deprecation had been notified in a previous release, remove it.

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

---

No objection to removal

#4 lore raw
In reply to David Marchand
Quoted 7 lines · David Marchand

This old script relied on deprecated stuff, and especially make. It also applied some scary 666 permissions on files under /dev/vfio.

Its deprecation had been notified in a previous release, remove it.

Forgot to Cc: techboard and Ferruh.

Signature · 1 line
David Marchand
Acked-by on v1 1/1
#5 lore raw
In reply to David Marchand
Quoted 6 lines · David Marchand

This old script relied on deprecated stuff, and especially make. It also applied some scary 666 permissions on files under /dev/vfio.

Its deprecation had been notified in a previous release, remove it.

Quoted 16 lines
---
 doc/guides/bbdevs/acc100.rst               |  15 +-
 doc/guides/bbdevs/fpga_5gnr_fec.rst        |  20 +-
 doc/guides/bbdevs/fpga_lte_fec.rst         |  20 +-
 doc/guides/faq/faq.rst                     |   3 +-
 doc/guides/linux_gsg/build_dpdk.rst        |   5 -
 doc/guides/linux_gsg/build_sample_apps.rst |   5 -
 doc/guides/linux_gsg/index.rst             |   1 -
 doc/guides/linux_gsg/linux_drivers.rst     |   1 -
 doc/guides/linux_gsg/quick_start.rst       | 304 ----------
 doc/guides/rel_notes/deprecation.rst       |   5 -
 doc/guides/rel_notes/release_20_11.rst     |   2 +
 usertools/dpdk-setup.sh                    | 609 ---------------------
 12 files changed, 6 insertions(+), 984 deletions(-)
 delete mode 100644 doc/guides/linux_gsg/quick_start.rst
 delete mode 100755 usertools/dpdk-setup.sh

Thanks,
Maxime

author Acked-by Bruce Richardson Acked-by Thomas Monjalon Acked-by Ferruh Yigit Acked-by Maxime Coquelin on v1 1/1 Applied
#6 lore raw
In reply to David Marchand
Quoted 7 lines · David Marchand

This old script relied on deprecated stuff, and especially make. It also applied some scary 666 permissions on files under /dev/vfio.

Its deprecation had been notified in a previous release, remove it.

Applied.

Signature · 1 line
David Marchand
Acked-by Bruce Richardson Acked-by Thomas Monjalon Acked-by Ferruh Yigit Acked-by Maxime Coquelin Applied
#7 lore raw

Hi David
I don’t believe that the patch should also remove from doc the side note related to vfio-pci which is not specific to that setup script. Not at my desk, sorry for bad email formatting.
Nic

________________________________
From: David Marchand <[email protected]>
Sent: Friday, November 27, 2020 8:12:01 AM
To: dev <[email protected]>
Cc: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>; Ray Kinsella <[email protected]>; Neil Horman <[email protected]>; Richardson, Bruce <[email protected]>; Yigit, Ferruh <[email protected]>; [email protected] <[email protected]>; Maxime Coquelin <[email protected]>
Subject: Re: [dpdk-dev] [PATCH] remove dpdk-setup.sh

Quoted 7 lines · David Marchand

This old script relied on deprecated stuff, and especially make. It also applied some scary 666 permissions on files under /dev/vfio.

Its deprecation had been notified in a previous release, remove it.

Applied.

--
David Marchand

#8 lore raw
Quoted 3 lines · Nicolas

Hi David
I don’t believe that the patch should also remove from doc the side note related to vfio-pci which is not specific to that setup script.

Indeed, fixed.
Thanks!

Signature · 1 line
David Marchand