Skip to contentSkip to conversation

doc/devbind: remove references to igb_uio

PATCH Superseded Stephen Hemminger 4 participants 7 messages Sep 6, 2020 – Nov 26, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc/devbind: remove references to igb_uio

We should be encouraging the use of vfio_pci for developers, not telling them to use igb_uio.

Also fix typo where .py suffix is visible in document.

---
 doc/guides/tools/devbind.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
doc/guides/tools/devbind.rst +10 -10
index a2910e103aab..52690f018648 100644
@@ -30,11 +30,11 @@ OPTIONS
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
         driver, other relevant information will be displayed:
         - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
         NOTE: if this flag is passed along with a bind/unbind option, the
         status display will always occur after the other operations have taken
         place.
@@ -69,7 +69,7 @@ OPTIONS
 
 .. warning::
 
-    While any user can run the ``dpdk-devbind.py`` script to view the status of the network ports,
+    While any user can run the ``dpdk-devbind`` script to view the status of the network ports,
     binding or unbinding network ports requires root privileges.
 
 
@@ -80,9 +80,9 @@ To display current device status::
 
    dpdk-devbind --status
 
-To bind eth1 from the current driver and move to use igb_uio::
+To bind eth1 from the current driver and move to use vfio_pci::
 
-   dpdk-devbind --bind=igb_uio eth1
+   dpdk-devbind --bind=vfio_pci eth1
 
 To unbind 0000:01:00.0 from using any driver::
 
@@ -92,7 +92,7 @@ To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver::
 
    dpdk-devbind -b ixgbe 02:00.0 02:00.1
 
-To check status of all network ports, assign one to the igb_uio driver and check status again::
+To check status of all network ports, assign one to the vfio_pci driver and check status again::
 
    # Check the status of the available devices.
    dpdk-devbind --status
@@ -105,12 +105,12 @@ To check status of all network ports, assign one to the igb_uio driver and check
    0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
 
 
-   # Bind the device to igb_uio.
-   sudo dpdk-devbind -b igb_uio 0000:0a:00.0
+   # Bind the device to vfio_pci.
+   sudo dpdk-devbind -b vfio_pci 0000:0a:00.0
 
 
    # Recheck the status of the devices.
    dpdk-devbind --status
    Network devices using DPDK-compatible driver
    ============================================
-   0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
+   0000:0a:00.0 '82599ES 10-Gigabit' drv=vfio_pci unused=
Signature · 1 line
2.27.0
#1 lore raw
Quoted 30 lines · Stephen Hemminger

We should be encouraging the use of vfio_pci for developers, not telling them to use igb_uio.

Also fix typo where .py suffix is visible in document.

---
 doc/guides/tools/devbind.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
doc/guides/tools/devbind.rst +3 -3
index a2910e103aab..52690f018648 100644
@@ -30,11 +30,11 @@ OPTIONS
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
         driver, other relevant information will be displayed:
         - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
         NOTE: if this flag is passed along with a bind/unbind option, the
         status display will always occur after the other operations have taken
         place.

doc/guides/tools/devbind.rst OPTIONS · line 73

Quoted 6 lines
doc/guides/tools/devbind.rst +1 -1
@@ -69,7 +69,7 @@ OPTIONS
 
 .. warning::
 
-    While any user can run the ``dpdk-devbind.py`` script to view the status of the network ports,
+    While any user can run the ``dpdk-devbind`` script to view the status of the network ports,
     binding or unbinding network ports requires root privileges.

Agree with all the replacements of igb_uio with vfio, but why remove the .py suffix here? The script won't run without giving its full name, so this removal seems unhelpful to the user.

#2 lore raw
Quoted 3 lines · On Mon, 7 Sep 2020 10:08:16 +0100 Bruce Richardson…

Agree with all the replacements of igb_uio with vfio, but why remove the .py suffix here? The script won't run without giving its full name, so this removal seems unhelpful to the user.

My misunderstanding, thought the install process was stripping the .py suffix

#3 lore raw

PATCH v2 1/1 doc/devbind: remove references to igb_uio

In reply to Stephen Hemminger

We should be encouraging the use of vfio_pci for developers, not telling them to use igb_uio.

---
v2 -- drop change about filename

 doc/guides/tools/devbind.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
doc/guides/tools/devbind.rst +9 -9
index a2910e103aab..5dcaf8c207dd 100644
@@ -30,11 +30,11 @@ OPTIONS
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
         driver, other relevant information will be displayed:
         - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
         NOTE: if this flag is passed along with a bind/unbind option, the
         status display will always occur after the other operations have taken
         place.
@@ -80,9 +80,9 @@ To display current device status::
 
    dpdk-devbind --status
 
-To bind eth1 from the current driver and move to use igb_uio::
+To bind eth1 from the current driver and move to use vfio_pci::
 
-   dpdk-devbind --bind=igb_uio eth1
+   dpdk-devbind --bind=vfio_pci eth1
 
 To unbind 0000:01:00.0 from using any driver::
 
@@ -92,7 +92,7 @@ To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver::
 
    dpdk-devbind -b ixgbe 02:00.0 02:00.1
 
-To check status of all network ports, assign one to the igb_uio driver and check status again::
+To check status of all network ports, assign one to the vfio_pci driver and check status again::
 
    # Check the status of the available devices.
    dpdk-devbind --status
@@ -105,12 +105,12 @@ To check status of all network ports, assign one to the igb_uio driver and check
    0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
 
 
-   # Bind the device to igb_uio.
-   sudo dpdk-devbind -b igb_uio 0000:0a:00.0
+   # Bind the device to vfio_pci.
+   sudo dpdk-devbind -b vfio_pci 0000:0a:00.0
 
 
    # Recheck the status of the devices.
    dpdk-devbind --status
    Network devices using DPDK-compatible driver
    ============================================
-   0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
+   0000:0a:00.0 '82599ES 10-Gigabit' drv=vfio_pci unused=
Signature · 1 line
2.27.0
#4 lore raw
Quoted 30 lines · Stephen Hemminger

We should be encouraging the use of vfio_pci for developers, not telling them to use igb_uio.

---
v2 -- drop change about filename

  doc/guides/tools/devbind.rst | 18 +++++++++---------
  1 file changed, 9 insertions(+), 9 deletions(-)
doc/guides/tools/devbind.rst +3 -3
index a2910e103aab..5dcaf8c207dd 100644
@@ -30,11 +30,11 @@ OPTIONS
          Print the current status of all known network interfaces.
          For each device, it displays the PCI domain, bus, slot and function,
          along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
          driver, other relevant information will be displayed:
          - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
          NOTE: if this flag is passed along with a bind/unbind option, the
          status display will always occur after the other operations have taken
          place.

doc/guides/tools/devbind.rst To display current device status:: · line 85

Quoted 8 lines
doc/guides/tools/devbind.rst +2 -2
@@ -80,9 +80,9 @@ To display current device status::
 
     dpdk-devbind --status
 
-To bind eth1 from the current driver and move to use igb_uio::
+To bind eth1 from the current driver and move to use vfio_pci::
 
-   dpdk-devbind --bind=igb_uio eth1
+   dpdk-devbind --bind=vfio_pci eth1

Module name is 'vfio_pci' but driver name is 'vfio-pci', for this document I guess all instances should be 'vfio-pci'.

Quoted 29 lines
doc/guides/tools/devbind.rst +4 -4
  To unbind 0000:01:00.0 from using any driver::
 
@@ -92,7 +92,7 @@ To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver::
 
     dpdk-devbind -b ixgbe 02:00.0 02:00.1
 
-To check status of all network ports, assign one to the igb_uio driver and check status again::
+To check status of all network ports, assign one to the vfio_pci driver and check status again::
 
     # Check the status of the available devices.
     dpdk-devbind --status
@@ -105,12 +105,12 @@ To check status of all network ports, assign one to the igb_uio driver and check
     0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
 
 
-   # Bind the device to igb_uio.
-   sudo dpdk-devbind -b igb_uio 0000:0a:00.0
+   # Bind the device to vfio_pci.
+   sudo dpdk-devbind -b vfio_pci 0000:0a:00.0
 
 
     # Recheck the status of the devices.
     dpdk-devbind --status
     Network devices using DPDK-compatible driver
     ============================================
-   0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
+   0000:0a:00.0 '82599ES 10-Gigabit' drv=vfio_pci unused=
#5 lore raw
Quoted 31 lines · Ferruh Yigit
Quoted 30 lines · Stephen Hemminger

We should be encouraging the use of vfio_pci for developers, not telling them to use igb_uio.

---
v2 -- drop change about filename

  doc/guides/tools/devbind.rst | 18 +++++++++---------
  1 file changed, 9 insertions(+), 9 deletions(-)
doc/guides/tools/devbind.rst +3 -3
index a2910e103aab..5dcaf8c207dd 100644
@@ -30,11 +30,11 @@ OPTIONS
          Print the current status of all known network interfaces.
          For each device, it displays the PCI domain, bus, slot and function,
          along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
          driver, other relevant information will be displayed:
          - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
          NOTE: if this flag is passed along with a bind/unbind option, the
          status display will always occur after the other operations have taken
          place.
@@ -80,9 +80,9 @@ To display current device status::
Quoted 9 lines

doc/guides/tools/devbind.rst To display current device status:: · line 85

Quoted 5 lines
doc/guides/tools/devbind.rst +2 -2
     dpdk-devbind --status
-To bind eth1 from the current driver and move to use igb_uio::
+To bind eth1 from the current driver and move to use vfio_pci::
-   dpdk-devbind --bind=igb_uio eth1
+   dpdk-devbind --bind=vfio_pci eth1

Module name is 'vfio_pci' but driver name is 'vfio-pci', for this document I guess all instances should be 'vfio-pci'.

Yes, I believe all instances of vfio_pci should be replaced with the "-"ed version. With that change:

#6 lore raw
Quoted 8 lines · Bruce Richardson
Quoted 5 lines · Ferruh Yigit
Quoted 4 lines · Stephen Hemminger

We should be encouraging the use of vfio_pci for developers, not telling them to use igb_uio.

Quoted 7 lines
Quoted 3 lines

Module name is 'vfio_pci' but driver name is 'vfio-pci', for this document I guess all instances should be 'vfio-pci'.

Yes, I believe all instances of vfio_pci should be replaced with the "-"ed version. With that change:

Indeed, passing vfio_pci fails:

$ sudo ./usertools/dpdk-devbind.py --bind=vfio_pci 0000:01:00.0
Error: bind failed for 0000:01:00.0 - Cannot open
/sys/bus/pci/drivers/vfio_pci/bind
Error: unbind failed for 0000:01:00.0 - Cannot open /sys/bus/pci/drivers//unbind
$ ./usertools/dpdk-devbind.py --status |grep 0000:01:00.0
0000:01:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection 10fb'
drv=vfio-pci unused=ixgbe

Fixed and applied.

Signature · 1 line
David Marchand