doc: document vfio-pci usage with QAT PMD
diff mbox series

Message ID 20200908142047.331-1-adamx.dybkowski@intel.com
State Superseded, archived
Headers show
Series
  • doc: document vfio-pci usage with QAT PMD
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK
ci/travis-robot success Travis build: passed

Commit Message

Dybkowski, AdamX Sept. 8, 2020, 2:20 p.m. UTC
This patch marks the old igb-uio driver as unsecure when used
with the QAT PMD and updates all examples to recommend using
vfio-pci instead.
It also mentions security issues with the QAT CPM and provides
information about the new vfio-pci parameter 'disable_denylist'
available in Linux kernels 5.9 and later.

Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)

Comments

Trahe, Fiona Sept. 8, 2020, 4 p.m. UTC | #1
Hi Adam,

> -----Original Message-----
> From: Dybkowski, AdamX <adamx.dybkowski@intel.com>
> Sent: Tuesday, September 8, 2020 3:21 PM
> To: dev@dpdk.org; Trahe, Fiona <fiona.trahe@intel.com>; akhil.goyal@nxp.com; Mcnamara, John
> <john.mcnamara@intel.com>
> Cc: Dybkowski, AdamX <adamx.dybkowski@intel.com>
> Subject: [PATCH] doc: document vfio-pci usage with QAT PMD
> 
> This patch marks the old igb-uio driver as unsecure when used
> with the QAT PMD and updates all examples to recommend using
> vfio-pci instead.
> It also mentions security issues with the QAT CPM and provides
> information about the new vfio-pci parameter 'disable_denylist'
> available in Linux kernels 5.9 and later.
> 
> Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com>
> ---


//snip///
> +Load the vfio-pci driver, bind the VF PCI Device id to it and use lspci
> +to confirm the VF devices are now in use by vfio-pci kernel driver,
>  e.g. for the C62x device::
> 
>      cd to the top-level DPDK directory
>      modprobe uio
> -    insmod ./build/kmod/igb_uio.ko
> -    echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
> +    modprobe vfio-pci
[Fiona] it would be useful to also add a note here - something like
"Use modprobe vfio-pci disable_denylist=1" from kernel 5.9 onwards. See note in Section xxx above"

Apart from this 
Acked-by: Fiona Trahe <fiona.trahe@intel.com>

Patch
diff mbox series

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index e5d2cf499..bd4743aa7 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -462,7 +462,7 @@  Check that the VFs are available for use. For example ``lspci -d:37c9`` should
 list 48 VF devices available for a ``C62x`` device.
 
 To complete the installation follow the instructions in
-`Binding the available VFs to the DPDK UIO driver`_.
+`Binding the available VFs to the vfio-pci driver`_.
 
 .. Note::
 
@@ -534,7 +534,7 @@  Confirm the presence of 48 VF devices - 16 per PF::
     lspci -d:37c9
 
 
-To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
+To complete the installation - follow instructions in `Binding the available VFs to the vfio-pci driver`_.
 
 .. Note::
 
@@ -584,10 +584,21 @@  To complete the installation - follow instructions in `Binding the available VFs
       sudo yum install kernel-devel-`uname -r`
 
 
-Binding the available VFs to the DPDK UIO driver
+Binding the available VFs to the vfio-pci driver
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Unbind the VFs from the stock driver so they can be bound to the uio driver.
+Notice:
+
+* Please note that due to security issues, the usage of older DPDK igb-uio
+  driver is not recommended. This document shows how to use the more secure
+  vfio-pci driver.
+* If QAT fails to bind to vfio-pci on Linux kernel 5.9+, please see the
+  QATE-39220 and QATE-7495 issues in
+  `01.org doc <https://01.org/sites/default/files/downloads/336211-015-qatsoftwareforlinux-rn-hwv1.7-final.pdf>`_
+  which details the constraint about trusted guests and add `disable_denylist=1`
+  to the vfio-pci params to use QAT. See also `this patch description <https://lkml.org/lkml/2020/7/23/1155>`_.
+
+Unbind the VFs from the stock driver so they can be bound to the vfio-pci driver.
 
 For an Intel(R) QuickAssist Technology DH895xCC device
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -635,25 +646,25 @@  VFs are different adjust the unbind command below::
         done; \
     done
 
-Bind to the DPDK uio driver
+Bind to the vfio-pci driver
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
-to confirm the VF devices are now in use by igb_uio kernel driver,
+Load the vfio-pci driver, bind the VF PCI Device id to it and use lspci
+to confirm the VF devices are now in use by vfio-pci kernel driver,
 e.g. for the C62x device::
 
     cd to the top-level DPDK directory
     modprobe uio
-    insmod ./build/kmod/igb_uio.ko
-    echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
+    modprobe vfio-pci
+    echo "8086 37c9" > /sys/bus/pci/drivers/vfio-pci/new_id
     lspci -vvd:37c9
 
 
-Another way to bind the VFs to the DPDK UIO driver is by using the
+Another way to bind the VFs to the vfio-pci driver is by using the
 ``dpdk-devbind.py`` script::
 
     cd to the top-level DPDK directory
-    ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
+    ./usertools/dpdk-devbind.py -b vfio-pci 0000:03:01.1
 
 Testing
 ~~~~~~~