amd-debug-tools 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

amd_debug/__init__.py

@@ -42,4 +42,4 @@ def launch_tool(tool_name):
         return tools[tool_name]()
     else:
         print(f"\033[91mUnknown exe: {tool_name}\033[0m")
-        return False
+        return 1

amd_debug/bios.py

@@ -122,7 +122,7 @@ def parse_args():
     return args
 
 
-def main():
+def main() -> None|int:
     """Main function"""
     args = parse_args()
     ret = False
@@ -135,4 +135,6 @@ def main():
     elif args.command == "version":
         print(version())
     show_log_info()
-    return ret
+    if ret is False:
+        return 1
+    return

amd_debug/failures.py

@@ -142,7 +142,7 @@ class MissingDriver(S0i3Failure):
         self.description = f"{slot} driver is missing"
         self.explanation = (
             f"No driver has been bound to PCI device {slot} "
-            "Without a driver, the hardware may be able to enter a low power. "
+            "Without a driver, the hardware may be able to enter a low power "
             "state, but there may be spurious wake up events."
         )
 

amd_debug/installer.py

@@ -446,7 +446,7 @@ def parse_args():
     return parser.parse_args()
 
 
-def install_dep_superset() -> bool:
+def install_dep_superset() -> None|int:
     """Install all python supserset dependencies"""
     args = parse_args()
     tool = Installer(tool_debug=args.tool_debug)
@@ -465,4 +465,6 @@ def install_dep_superset() -> bool:
     if ret:
         print_color("All dependencies installed", "✅")
     show_log_info()
-    return ret
+    if ret is False:
+        return 1
+    return

amd_debug/kernel.py

@@ -19,6 +19,7 @@ def get_kernel_command_line() -> str:
         "apparmor",
         "audit",
         "auto",
+        "bluetooth.disable_ertm",
         "boot",
         "BOOT_IMAGE",
         "console",
@@ -29,6 +30,7 @@ def get_kernel_command_line() -> str:
         "earlycon",
         "earlyprintk",
         "ether",
+        "init",
         "initrd",
         "ip",
         "LANG",
@@ -47,7 +49,9 @@ def get_kernel_command_line() -> str:
         "nfs.nfs4_unique_id",
         "nfsroot",
         "noplymouth",
+        "nowatchdog",
         "ostree",
+        "preempt",
         "quiet",
         "rd.dm.uuid",
         "rd.luks.allow-discards",
@@ -66,12 +70,15 @@ def get_kernel_command_line() -> str:
         "ro",
         "root",
         "rootflags",
+        "rootfstype",
         "roothash",
         "rw",
         "security",
+        "selinux",
         "showopts",
         "splash",
         "swap",
+        "systemd.machine_id",
         "systemd.mask",
         "systemd.show_status",
         "systemd.unit",
@@ -82,6 +89,7 @@ def get_kernel_command_line() -> str:
         "verbose",
         "vt.handoff",
         "zfs",
+        "zswap.enabled",
     ]
     # remove anything that starts with something in filtered from cmdline
     return " ".join([x for x in cmdline.split() if not x.startswith(tuple(filtered))])

amd_debug/prerequisites.py

@@ -134,22 +134,19 @@ class PrerequisiteValidator(AmdTool):
         if len(edids) == 0:
             self.db.record_debug("No EDID data found")
             return True
-
         for name, p in edids.items():
             output = None
-            for cmd in ["di-edid-decode", "edid-decode"]:
+            for tool in ["di-edid-decode", "edid-decode"]:
                 try:
-                    cmd = ["edid-decode", p]
+                    cmd = [tool, p]
                     output = subprocess.check_output(
                         cmd, stderr=subprocess.DEVNULL
-                    ).decode("utf-8")
+                    ).decode("utf-8", errors="ignore")
                     break
                 except FileNotFoundError:
                     self.db.record_debug(f"{cmd} not installed")
                 except subprocess.CalledProcessError as e:
-                    self.db.record_debug(
-                        f"failed to capture edid with {cmd}: {e.output}"
-                    )
+                    pass
             if not output:
                 self.db.record_prereq("Failed to capture EDID table", "👀")
             else:
@@ -245,7 +242,6 @@ class PrerequisiteValidator(AmdTool):
         for dev in self.pyudev.list_devices(subsystem="pci", DRIVER="nvme"):
             # https://git.kernel.org/torvalds/c/e79a10652bbd3
             if minimum_kernel(6, 10):
-                self.db.record_debug("New enough kernel to avoid NVME check")
                 break
             pci_slot_name = dev.properties["PCI_SLOT_NAME"]
             vendor = dev.properties.get("ID_VENDOR_FROM_DATABASE", "")
@@ -319,7 +315,6 @@ class PrerequisiteValidator(AmdTool):
         # not needed to check in newer kernels
         # see https://github.com/torvalds/linux/commit/77f1972bdcf7513293e8bbe376b9fe837310ee9c
         if minimum_kernel(6, 10):
-            self.db.record_debug("New enough kernel to avoid HSMP check")
             return True
         f = os.path.join("/", "boot", f"config-{platform.uname().release}")
         if os.path.exists(f):
@@ -527,7 +522,7 @@ class PrerequisiteValidator(AmdTool):
                 f"{keys['sys_vendor']} {keys['product_name']} ({keys['product_family']})",
                 "💻",
             )
-            debug_str = "DMI data:\n"
+            debug_str = "DMI|value\n"
             for key, value in keys.items():
                 if (
                     "product_name" in key
@@ -535,7 +530,7 @@ class PrerequisiteValidator(AmdTool):
                     or "product_family" in key
                 ):
                     continue
-                debug_str += f"{key}: {value}\n"
+                debug_str += f"{key}| {value}\n"
             self.db.record_debug(debug_str)
         return True
 
@@ -600,6 +595,9 @@ class PrerequisiteValidator(AmdTool):
                 with open(target, "rb") as r:
                     r.seek(0x70)
                     found = struct.unpack("<I", r.read(4))[0] & BIT(21)
+            except FileNotFoundError:
+                self.db.record_prereq("FADT check unavailable", "🚦")
+                return True
             except PermissionError:
                 self.db.record_prereq("FADT check unavailable", "🚦")
                 return True
@@ -916,7 +914,7 @@ class PrerequisiteValidator(AmdTool):
         devices = []
         for dev in self.pyudev.list_devices(subsystem="pci"):
             devices.append(dev)
-        debug_str = "PCI devices\n"
+        debug_str = "PCI Slot | Vendor | Class | ID | ACPI path\n"
         for dev in devices:
             pci_id = dev.properties["PCI_ID"].lower()
             pci_slot_name = dev.properties["PCI_SLOT_NAME"]
@@ -939,15 +937,12 @@ class PrerequisiteValidator(AmdTool):
             p = os.path.join(dev.sys_path, "firmware_node", "path")
             if os.path.exists(p):
                 acpi = read_file(p)
-                debug_str += (
-                    f"{prefix}{pci_slot_name} : "
-                    f"{database_vendor} {database_class} [{pci_id}] : {acpi}\n"
-                )
             else:
-                debug_str += (
-                    f"{prefix}{pci_slot_name} : "
-                    f"{database_vendor} {database_class} [{pci_id}]\n"
-                )
+                acpi = ""
+            debug_str += (
+                f"{prefix}{pci_slot_name} | "
+                f"{database_vendor} | {database_class} | {pci_id} | {acpi}\n"
+            )
         if debug_str:
             self.db.record_debug(debug_str)
 
@@ -964,12 +959,8 @@ class PrerequisiteValidator(AmdTool):
                 if status == 0:
                     continue
             devices.append(dev)
-        debug_str = "ACPI name: ACPI path [driver]\n"
+        debug_str = "ACPI name | ACPI path | Kernel driver\n"
         for dev in devices:
-            if dev == devices[-1]:
-                prefix = "└─"
-            else:
-                prefix = "│ "
             p = os.path.join(dev.sys_path, "path")
             pth = read_file(p)
             p = os.path.join(dev.sys_path, "physical_node", "driver")
@@ -977,7 +968,7 @@ class PrerequisiteValidator(AmdTool):
                 driver = os.path.basename(os.readlink(p))
             else:
                 driver = None
-            debug_str += f"{prefix}{dev.sys_name}: {pth} [{driver}]\n"
+            debug_str += f"{dev.sys_name} | {pth} | {driver}\n"
         if debug_str:
             self.db.record_debug(debug_str)
         return True
@@ -1157,7 +1148,6 @@ class PrerequisiteValidator(AmdTool):
             if not found_iommu:
                 self.db.record_prereq("IOMMU disabled", "✅")
                 return True
-            debug_str += "DMA protection:\n"
             p = os.path.join("/", "sys", "firmware", "acpi", "tables", "IVRS")
             with open(p, "rb") as f:
                 data = f.read()

amd_debug/pstate.py

@@ -300,15 +300,17 @@ def parse_args():
     return parser.parse_args()
 
 
-def main():
+def main() -> None|int:
     """Main function"""
     args = parse_args()
     ret = False
     if args.command == "version":
         print(version())
-        return True
+        return
     elif args.command == "triage":
         triage = AmdPstateTriage(args.tool_debug)
         ret = triage.run()
     show_log_info()
-    return ret
+    if ret is False:
+        return 1
+    return

amd_debug/s2idle.py

@@ -120,7 +120,7 @@ def prompt_report_arguments(since, until, fname, fmt, report_debug) -> str:
     if report_debug is None:
         inp = (
             input(
-                f"{Headers.ReportDebugDescription} ({colorize_choices(Defaults.boolean_choices, "true")})? "
+                f"{Headers.ReportDebugDescription} ({colorize_choices(Defaults.boolean_choices, 'true')})? "
             )
             .lower()
             .capitalize()
@@ -211,6 +211,14 @@ def run_test_cycle(
         print("Failed to install dependencies")
         return False
 
+    try:
+        duration, wait, count = prompt_test_arguments(duration, wait, count, rand)
+        since, until, fname, fmt, report_debug = prompt_report_arguments(
+            datetime.now().isoformat(), Defaults.until.isoformat(), fname, fmt, True
+        )
+    except KeyboardInterrupt:
+        sys.exit("\nTest cancelled")
+
     try:
         app = PrerequisiteValidator(debug)
         run = app.run()
@@ -221,37 +229,32 @@ def run_test_cycle(
 
     if run or force:
         app = SleepValidator(tool_debug=debug, bios_debug=bios_debug)
-        try:
-            duration, wait, count = prompt_test_arguments(duration, wait, count, rand)
-            since, until, fname, fmt, report_debug = prompt_report_arguments(
-                datetime.now().isoformat(), Defaults.until.isoformat(), fname, fmt, True
-            )
-        except KeyboardInterrupt:
-            sys.exit("\nTest cancelled")
 
-        app.run(
+        run = app.run(
             duration=duration,
             wait=wait,
             count=count,
             rand=rand,
             logind=logind,
         )
+    else:
+        since = None
+        until = None
+
+    app = SleepReport(
+        since=since,
+        until=until,
+        fname=fname,
+        fmt=fmt,
+        tool_debug=debug,
+        report_debug=report_debug,
+    )
+    app.run()
 
-        app = SleepReport(
-            since=since,
-            until=until,
-            fname=fname,
-            fmt=fmt,
-            tool_debug=debug,
-            report_debug=report_debug,
-        )
-        app.run()
-
-        # open report in browser if it's html
-        display_report_file(fname, fmt)
+    # open report in browser if it's html
+    display_report_file(fname, fmt)
 
-        return True
-    return False
+    return True
 
 
 def install(debug) -> None:
@@ -308,10 +311,8 @@ def parse_args():
     test_cmd.add_argument(
         "--random",
         action="store_true",
-        help=(
-            "Run sleep cycles for random durations and wait, using the "
-            "--duration and --wait arguments as an upper bound",
-        ),
+        help="Run sleep cycles for random durations and wait, using the "
+        "--duration and --wait arguments as an upper bound",
     )
     test_cmd.add_argument(
         "--force",
@@ -393,7 +394,7 @@ def parse_args():
     return parser.parse_args()
 
 
-def main():
+def main() -> None|int:
     """Main function"""
     args = parse_args()
     ret = False
@@ -428,8 +429,10 @@ def main():
         )
     elif args.action == "version":
         print(version())
-        return True
+        return
     else:
         sys.exit("no action specified")
     show_log_info()
-    return ret
+    if ret is False:
+        return 1
+    return