doc: add known issue when hot-unplug igb_uio device
authorJeff Guo <jia.guo@intel.com>
Tue, 20 Nov 2018 15:09:31 +0000 (23:09 +0800)
committerThomas Monjalon <thomas@monjalon.net>
Fri, 23 Nov 2018 02:10:33 +0000 (03:10 +0100)
When device has been bound to igb_uio driver and application is running,
hot-unplugging the device may cause kernel crash.

Signed-off-by: Jeff Guo <jia.guo@intel.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
doc/guides/rel_notes/known_issues.rst

index a2c7d3d..a1face9 100644 (file)
@@ -805,3 +805,24 @@ Restricted vdev ethdev operations supported in secondary process
 
 **Driver/Module**:
    Virtual Device Poll Mode Driver (PMD).
+
+
+Kernel crash when hot-unplug igb_uio device while DPDK application is running
+-----------------------------------------------------------------------------
+
+**Description**:
+   When device has been bound to igb_uio driver and application is running,
+   hot-unplugging the device may cause kernel crash.
+
+**Reason**:
+   When device is hot-unplugged, igb_uio driver will be removed which will destroy UIO resources.
+   Later trying to access any uio resource will cause kernel crash.
+
+**Resolution/Workaround**:
+   If using DPDK for PCI HW hot-unplug, prefer to bind device with VFIO instead of IGB_UIO.
+
+**Affected Environment/Platform**:
+    ALL.
+
+**Driver/Module**:
+   ``igb_uio`` module.