Merge pull request #2945 from dhsrivas/iommu

io/iommu: Validate pci_addr input and update check_dmesg()

Author: narasimhan-v

io/iommu/iommu_tests.py

@@ -32,8 +32,8 @@ def change_domain_check(dom, pci_addr, def_dom):
     Check if the domain changed successfully to "dom" for "pci_addr"
 
     :param dom: domain type
-    :param def_dom: default domain of pci device(pci_addr)
-    :param pci_addr: pci device
+    :param def_dom: default domain of pci address (pci_addr)
+    :param pci_addr: full pci address including domain (0000:03:00.0)
     return: bool
     """
     output = genio.read_one_line(
@@ -49,7 +49,7 @@ def reset_check(pci_addr):
     """
     Check if reset for "pci_addr" is successful
 
-    :param pci_addr: pci device
+    :param pci_addr: full pci address including domain (0000:03:00.0)
     return: bool
     """
     cmd = f"lspci -vvs {pci_addr}"
@@ -64,7 +64,7 @@ def rescan_check(pci_addr):
     """
     Check if rescan for pci_addr is successful
 
-    :param pci_addr: pci device
+    :param pci_addr: full pci address including domain (0000:03:00.0)
     return: bool
     """
     cmd = f"lspci -vvs {pci_addr}"
@@ -81,7 +81,7 @@ class IommuTest(Test):
     reset and rescan is used to form sub-tests that test and exercise iommu
     code.
 
-    :param device: Name of the pci device
+    :param device: full pci address including domain (0000:03:00.0)
     """
 
     def setUp(self):
@@ -91,13 +91,22 @@ def setUp(self):
         self.pci_devices = self.params.get('pci_devices', default=None)
         self.count = int(self.params.get('count', default=1))
         self.domains = ["DMA", "DMA-FQ", "identity", "auto"]
+        self.dmesg_grep = self.params.get('dmesg_grep', default='')
         if not self.pci_devices:
             self.cancel("No pci device given")
         smm = SoftwareManager()
         if not smm.check_installed("pciutils") and not smm.install("pciutils"):
             self.cancel("pciutils package not found and installing failed")
+
         # Check the number of devices in iommu-group for pci device passed.
         for pci_addr in self.pci_devices.split(" "):
+
+            # Check if device input is valid
+            cmd = f"lspci -s {pci_addr}"
+            out = process.run(cmd, ignore_status=True, shell=True).stdout_text
+            if not out:
+                self.cancel(f"{pci_addr} not found on the system")
+
             driver = pci.get_driver(pci_addr)
             if driver is None:
                 self.cancel("Device passed is not bound to any driver")
@@ -112,16 +121,17 @@ def setUp(self):
                 self.cancel(f"{pci_addr} belongs to iommu group having more "
                             "than one device but system does not support "
                             "domain type change for such device")
-        cmd = "dmesg -C"
+
+        cmd = "dmesg -T --level=alert,crit,err,warn > dmesg_initial.txt"
         process.run(cmd, ignore_status=True, shell=True, sudo=True)
 
     # TODO: Need to push this to avocado utils later
     def unbind(self, driver, pci_addr):
         """
         Unbind the device
 
-        :param driver: driver of the pci device(pci_addr)
-        :param pci_addr: pci device to be unbind from driver
+        :param driver: driver of the pci address (pci_addr)
+        :param pci_addr: full pci address including domain (0000:03:00.0)
         return: None
         """
         genio.write_file(f'/sys/bus/pci/drivers/{driver}/unbind', pci_addr)
@@ -137,8 +147,8 @@ def change_domain(self, dom, def_dom, pci_addr):
         Change the domain of device to dom
 
         :param dom: domain type
-        :param def_dom: default domain of pci device(pci_addr)
-        :param pci_addr: pci device
+        :param def_dom: default domain of pci address (pci_addr)
+        :param pci_addr: full pci address including domain (0000:03:00.0)
         return: None
         """
         genio.write_file(f'/sys/bus/pci/devices/{pci_addr}/iommu_group/type',
@@ -154,8 +164,8 @@ def bind(self, driver, pci_addr):
         """
         Bind the device to driver
 
-        :param driver: driver of the pci device(pci_addr)
-        :param pci_addr: pci device
+        :param driver: driver of the pci address (pci_addr)
+        :param pci_addr: full pci address including domain (0000:03:00.0)
         return: None
         """
         genio.write_file(f"/sys/bus/pci/drivers/{driver}/bind", pci_addr)
@@ -171,7 +181,7 @@ def reset(self, pci_addr):
         """
         Remove the device
 
-        :param pci_addr: pci device
+        :param pci_addr: full pci address including domain (0000:03:00.0)
         return: None
         """
         genio.write_file(f'/sys/bus/pci/devices/{pci_addr}/remove', '1')
@@ -185,7 +195,7 @@ def rescan(self, pci_addr):
         """
         Rescan the system
 
-        :param pci_addr: pci device
+        :param pci_addr: full pci address including domain (0000:03:00.0)
         return: None
         """
         genio.write_file('/sys/bus/pci/rescan', '1')
@@ -198,9 +208,9 @@ def get_params(self, pci_addr):
         """
         Get device parameter-driver, group, default domain(def_dom)
 
-        :param pci_addr: pci device
-        return: driver (driver of pci device),
-                def_dom (default domain of pci device)
+        :param pci_addr: full pci address including domain (0000:03:00.0)
+        return: driver (driver of pci address (pci_addr)),
+                def_dom (default domain of pci address (pci_addr))
         """
         driver = pci.get_driver(pci_addr)
 
@@ -217,9 +227,9 @@ def check(self, def_dom, pci_addr, driver):
         """
         Check if the PCI device is in default domain
 
-        :param def_dom: default domain of pci device(pci_addr)
-        :param pci_addr: pci device
-        :param driver: driver of the pci device(pci_addr)
+        :param def_dom: default domain of pci address (pci_addr)
+        :param pci_addr: full pci address including domain (0000:03:00.0)
+        :param driver: driver of the pci address (pci_addr)
         return: None
         """
         output = genio.read_one_line(
@@ -383,8 +393,19 @@ def check_dmesg(self):
         """
         Checks for any error or failure messages in dmesg after test
         """
-        cmd = "dmesg -T --level=alert,crit,err,warn"
-        out = process.run(cmd, ignore_status=True, shell=True, sudo=True)
-        output = out.stdout_text
-        if output:
-            self.fail(f"Kernel Errors: {output}")
+
+        cmd = "dmesg -T --level=alert,crit,err,warn > dmesg_final.txt"
+        process.run(cmd, ignore_status=True, shell=True, sudo=True)
+
+        cmd = "diff dmesg_final.txt dmesg_initial.txt"
+        if self.dmesg_grep != '':
+            cmd = f"{cmd} | grep -i -e '{self.dmesg_grep}'"
+        dmesg_diff = process.run(cmd, ignore_status=True, shell=True, sudo=True).stdout_text
+        if dmesg_diff != '':
+            self.whiteboard = f"{dmesg_diff}"
+            self.fail("Running test logged warn,err,alert,crit logs in dmesg. "
+                      "Please refer whiteboard of the test result")
+
+        # Clean temprorary files created
+        cmd = "rm dmesg_final.txt dmesg_initial.txt"
+        process.run(cmd, ignore_status=True, shell=True, sudo=True)