amd-debug-tools 0.2.7__py3-none-any.whl → 0.2.9__py3-none-any.whl

amd_debug/__init__.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 

amd_debug/acpi.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 import os

amd_debug/battery.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 from pyudev import Context
 

amd_debug/bios.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 """s2idle analysis tool"""
 import argparse

amd_debug/common.py

@@ -1,10 +1,10 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 """
 This module contains common utility functions and classes for various amd-debug-tools.
 """
 
+import asyncio
 import importlib.metadata
 import logging
 import os
@@ -12,7 +12,6 @@ import platform
 import time
 import struct
 import subprocess
-import re
 import sys
 from ast import literal_eval
 from datetime import date, timedelta
@@ -47,7 +46,7 @@ def get_group_color(group) -> str:
         color = Colors.WARNING
     elif group == "🗣️":
         color = Colors.HEADER
-    elif group == "💯":
+    elif any(mk in group for mk in ["💯", "🚫"]):
         color = Colors.UNDERLINE
     elif any(mk in group for mk in ["🦟", "🖴"]):
         color = Colors.DEBUG
@@ -238,18 +237,47 @@ def gb_to_pages(gb_value):
 
 def reboot():
     """Reboot the system"""
-    try:
-        import dbus  # pylint: disable=import-outside-toplevel
 
-        bus = dbus.SystemBus()
-        obj = bus.get_object("org.freedesktop.login1", "/org/freedesktop/login1")
-        intf = dbus.Interface(obj, "org.freedesktop.login1.Manager")
-        intf.Reboot(True)
+    async def reboot_dbus_fast():
+        """Reboot using dbus-fast"""
+        try:
+            from dbus_fast.aio import (  # pylint: disable=import-outside-toplevel
+                MessageBus,
+            )
+            from dbus_fast import BusType  # pylint: disable=import-outside-toplevel
+
+            bus = await MessageBus(bus_type=BusType.SYSTEM).connect()
+            introspection = await bus.introspect(
+                "org.freedesktop.login1", "/org/freedesktop/login1"
+            )
+            proxy_obj = bus.get_proxy_object(
+                "org.freedesktop.login1", "/org/freedesktop/login1", introspection
+            )
+            interface = proxy_obj.get_interface("org.freedesktop.login1.Manager")
+            await interface.call_reboot(True)
+
+        except ImportError:
+            return False
+        return True
+
+    def reboot_dbus():
+        """Reboot using python-dbus"""
+        try:
+            import dbus  # pylint: disable=import-outside-toplevel
+
+            bus = dbus.SystemBus()
+            obj = bus.get_object("org.freedesktop.login1", "/org/freedesktop/login1")
+            intf = dbus.Interface(obj, "org.freedesktop.login1.Manager")
+            intf.Reboot(True)
+        except ImportError:
+            return False
         return True
-    except ImportError:
-        fatal_error("Missing dbus")
-    except dbus.exceptions.DBusException as e:
-        fatal_error({e})
+
+    loop = asyncio.get_event_loop()
+    result = loop.run_until_complete(reboot_dbus_fast())
+    if not result:
+        return reboot_dbus()
+
     return True
 
 

amd_debug/database.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 from datetime import datetime
@@ -99,8 +98,8 @@ class SleepDatabase:
 
     def start_cycle(self, timestamp):
         """Start a new sleep cycle"""
+        assert self.db
         self.last_suspend = timestamp
-
         # increment the counters so that systemd hooks work
         cur = self.db.cursor()
         cur.execute(
@@ -124,11 +123,13 @@ class SleepDatabase:
 
     def sync(self) -> None:
         """Sync the database to disk"""
+        assert self.db
         self.db.commit()
 
     def record_debug(self, message, level=6) -> None:
         """Helper function to record a message to debug database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             "INSERT into debug (t0, id, message, priority) VALUES (?, ?, ?, ?)",
@@ -151,6 +152,8 @@ class SleepDatabase:
 
     def record_battery_energy(self, name, energy, full, unit):
         """Helper function to record battery energy"""
+        assert self.db
+        assert self.last_suspend
         cur = self.db.cursor()
         cur.execute(
             "SELECT * FROM battery WHERE t0=?",
@@ -180,6 +183,7 @@ class SleepDatabase:
     def record_cycle_data(self, message, symbol) -> None:
         """Helper function to record a message to cycle_data database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             """
@@ -207,6 +211,7 @@ class SleepDatabase:
     ) -> None:
         """Helper function to record a sleep cycle into the cycle database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             """
@@ -227,6 +232,7 @@ class SleepDatabase:
     def record_prereq(self, message, symbol) -> None:
         """Helper function to record a message to prereq_data database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             """
@@ -246,6 +252,7 @@ class SleepDatabase:
 
     def report_prereq(self, t0) -> list:
         """Helper function to report the prereq_data database"""
+        assert self.db
         if t0 is None:
             return []
         cur = self.db.cursor()
@@ -255,10 +262,11 @@ class SleepDatabase:
         )
         return cur.fetchall()
 
-    def report_debug(self, t0) -> str:
+    def report_debug(self, t0) -> list:
         """Helper function to report the debug database"""
+        assert self.db
         if t0 is None:
-            return ""
+            return []
         cur = self.db.cursor()
         cur.execute(
             "SELECT message, priority FROM debug WHERE t0=?",
@@ -268,6 +276,7 @@ class SleepDatabase:
 
     def report_cycle(self, t0=None) -> list:
         """Helper function to report a cycle from database"""
+        assert self.db
         if t0 is None:
             assert self.last_suspend
             t0 = self.last_suspend
@@ -280,7 +289,9 @@ class SleepDatabase:
 
     def report_cycle_data(self, t0=None) -> str:
         """Helper function to report a table matching a timestamp from cycle_data database"""
+        assert self.db
         if t0 is None:
+            assert self.last_suspend
             t0 = self.last_suspend
         cur = self.db.cursor()
         cur.execute(
@@ -294,7 +305,9 @@ class SleepDatabase:
 
     def report_battery(self, t0=None) -> list:
         """Helper function to report a line from battery database"""
+        assert self.db
         if t0 is None:
+            assert self.last_suspend
             t0 = self.last_suspend
         cur = self.db.cursor()
         cur.execute(
@@ -305,19 +318,23 @@ class SleepDatabase:
 
     def get_last_prereq_ts(self) -> int:
         """Helper function to report the last line from prereq database"""
+        assert self.db
         cur = self.db.cursor()
         cur.execute("SELECT * FROM prereq_data ORDER BY t0 DESC LIMIT 1")
         result = cur.fetchone()
-        return result[0] if result else None
+        return result[0] if result else 0
 
     def get_last_cycle(self) -> list:
         """Helper function to report the last line from battery database"""
+        assert self.db
         cur = self.db.cursor()
         cur.execute("SELECT t0 FROM cycle ORDER BY t0 DESC LIMIT 1")
         return cur.fetchone()
 
     def report_summary_dataframe(self, since, until) -> object:
         """Helper function to report a dataframe from the database"""
+        assert self.db
+
         import pandas as pd  # pylint: disable=import-outside-toplevel
 
         pd.set_option("display.precision", 2)

amd_debug/display.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # SPDX-License-Identifier: MIT
 """Display analysis"""
 import os
@@ -12,7 +11,7 @@ class Display:
 
     def __init__(self):
         self.pyudev = Context()
-        self.edid = {}
+        self.edid = []
 
         for dev in self.pyudev.list_devices(subsystem="drm"):
             if not "card" in dev.device_path:
@@ -27,7 +26,7 @@ class Display:
             f = read_file(p)
             if f != "enabled":
                 continue
-            self.edid[dev.sys_name] = os.path.join(dev.sys_path, "edid")
+            self.edid.append(os.path.join(dev.sys_path, "edid"))
 
     def get_edid(self) -> list:
         """Get the path for EDID data for all connected displays"""

amd_debug/failures.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 from datetime import timedelta
@@ -48,6 +47,19 @@ class RtcAlarmWrong(S0i3Failure):
         self.url = "https://github.com/systemd/systemd/issues/24279"
 
 
+class MissingGpu(S0i3Failure):
+    """GPU device is missing"""
+
+    def __init__(self):
+        super().__init__()
+        self.description = "GPU device is missing"
+        self.explanation = (
+            "Running the s2idle sequence without an integrated GPU is likely "
+            "to cause problems. If you have a mux in BIOS, enable the integrated "
+            "GPU."
+        )
+
+
 class MissingAmdgpu(S0i3Failure):
     """AMDGPU driver is missing"""
 
@@ -467,7 +479,7 @@ class MissingIommuACPI(S0i3Failure):
         super().__init__()
         self.description = f"Device {device} missing from ACPI tables"
         self.explanation = (
-            "The ACPI device {device} is required for suspend to work when the IOMMU is enabled. "
+            f"The ACPI device {device} is required for suspend to work when the IOMMU is enabled. "
             "Please check your BIOS settings and if configured correctly, report a bug to your system vendor."
         )
         self.url = "https://gitlab.freedesktop.org/drm/amd/-/issues/3738#note_2667140"

amd_debug/installer.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 """
@@ -197,7 +196,7 @@ class DisplayInfoPackage(DistroPackage):
     def __init__(self):
         super().__init__(
             deb="libdisplay-info-bin",
-            rpm="libdisplay-info",
+            rpm="libdisplay-info-tools",
             arch="libdisplay-info",
             message=Headers.MissingDiEdidDecode,
         )

amd_debug/kernel.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # SPDX-License-Identifier: MIT
 """Kernel log analysis"""
 
@@ -158,7 +157,7 @@ class KernelLogger:
     def seek_tail(self, tim=None):
         """Seek to the end of the log"""
 
-    def process_callback(self, callback, priority):
+    def process_callback(self, callback, priority=None):
         """Process the log"""
 
     def match_line(self, _matches) -> str:
@@ -175,7 +174,7 @@ class InputFile(KernelLogger):
 
     def __init__(self, fname):
         self.since_support = False
-        self.buffer = None
+        self.buffer = ""
         self.seeked = False
         self.buffer = read_file(fname)
 
@@ -190,7 +189,7 @@ class DmesgLogger(KernelLogger):
 
     def __init__(self):
         self.since_support = False
-        self.buffer = None
+        self.buffer = ""
         self.seeked = False
 
         cmd = ["dmesg", "-h"]
@@ -204,7 +203,7 @@ class DmesgLogger(KernelLogger):
         self._refresh_head()
 
     def _refresh_head(self):
-        self.buffer = []
+        self.buffer = ""
         self.seeked = False
         result = subprocess.run(self.command, check=True, capture_output=True)
         if result.returncode == 0:
@@ -262,7 +261,11 @@ class CySystemdLogger(KernelLogger):
     """Class for logging using systemd journal using cython"""
 
     def __init__(self):
-        from cysystemd.reader import JournalReader, JournalOpenMode, Rule
+        from cysystemd.reader import (
+            JournalReader,
+            JournalOpenMode,
+            Rule,
+        )  # pylint: disable=import-outside-toplevel
 
         boot_reader = JournalReader()
         boot_reader.open(JournalOpenMode.SYSTEM)
@@ -384,6 +387,6 @@ def get_kernel_log(input_file=None) -> KernelLogger:
             kernel_log = DmesgLogger()
         except subprocess.CalledProcessError as e:
             fatal_error(f"{e}")
-            kernel_log = None
+            kernel_log = KernelLogger()
     logging.debug("Kernel log provider: %s", kernel_log.__class__.__name__)
     return kernel_log

amd_debug/prerequisites.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 """
@@ -21,7 +20,7 @@ import pyudev
 
 from amd_debug.wake import WakeIRQ
 from amd_debug.display import Display
-from amd_debug.kernel import get_kernel_log, SystemdLogger, DmesgLogger
+from amd_debug.kernel import get_kernel_log, SystemdLogger, CySystemdLogger, DmesgLogger
 from amd_debug.common import (
     apply_prefix_wrapper,
     BIT,
@@ -58,6 +57,7 @@ from amd_debug.failures import (
     MissingAmdgpu,
     MissingAmdgpuFirmware,
     MissingAmdPmc,
+    MissingGpu,
     MissingDriver,
     MissingIommuACPI,
     MissingIommuPolicy,
@@ -156,7 +156,7 @@ class PrerequisiteValidator(AmdTool):
         if len(edids) == 0:
             self.db.record_debug("No EDID data found")
             return True
-        for name, p in edids.items():
+        for p in edids:
             output = None
             for tool in ["di-edid-decode", "edid-decode"]:
                 try:
@@ -167,16 +167,17 @@ class PrerequisiteValidator(AmdTool):
                     break
                 except FileNotFoundError:
                     self.db.record_debug(f"{cmd} not installed")
-                except subprocess.CalledProcessError as e:
+                except subprocess.CalledProcessError as _e:
                     pass
             if not output:
                 self.db.record_prereq("Failed to capture EDID table", "👀")
             else:
-                self.db.record_debug(apply_prefix_wrapper(f"EDID for {name}:", output))
+                self.db.record_debug(apply_prefix_wrapper(f"EDID for {p}:", output))
         return True
 
     def check_amdgpu(self):
         """Check for the AMDGPU driver"""
+        count = 0
         for device in self.pyudev.list_devices(subsystem="pci"):
             klass = device.properties.get("PCI_CLASS")
             if klass not in ["30000", "38000"]:
@@ -184,6 +185,7 @@ class PrerequisiteValidator(AmdTool):
             pci_id = device.properties.get("PCI_ID")
             if not pci_id.startswith("1002"):
                 continue
+            count += 1
             if device.properties.get("DRIVER") != "amdgpu":
                 self.db.record_prereq("GPU driver `amdgpu` not loaded", "❌")
                 self.failures += [MissingAmdgpu()]
@@ -191,6 +193,10 @@ class PrerequisiteValidator(AmdTool):
             slot = device.properties.get("PCI_SLOT_NAME")
 
             self.db.record_prereq(f"GPU driver `amdgpu` bound to {slot}", "✅")
+        if count == 0:
+            self.db.record_prereq("Integrated GPU not found", "❌")
+            self.failures += [MissingGpu()]
+            return False
         return True
 
     def check_amdgpu_parameters(self):
@@ -672,7 +678,9 @@ class PrerequisiteValidator(AmdTool):
         """Check the source for kernel logs"""
         if isinstance(self.kernel_log, SystemdLogger):
             self.db.record_prereq("Logs are provided via systemd", "✅")
-        if isinstance(self.kernel_log, DmesgLogger):
+        elif isinstance(self.kernel_log, CySystemdLogger):
+            self.db.record_prereq("Logs are provided via cysystemd", "✅")
+        elif isinstance(self.kernel_log, DmesgLogger):
             self.db.record_prereq(
                 "Logs are provided via dmesg, timestamps may not be accurate over multiple cycles",
                 "🚦",
@@ -740,6 +748,9 @@ class PrerequisiteValidator(AmdTool):
             p = os.path.join("/", "sys", "kernel", "debug", "gpio")
             try:
                 contents = read_file(p)
+            except FileNotFoundError:
+                self.db.record_prereq("GPIO debugfs not available", "👀")
+                contents = None
             except PermissionError:
                 self.db.record_debug(f"Unable to capture {p}")
                 contents = None
@@ -776,7 +787,7 @@ class PrerequisiteValidator(AmdTool):
                     "utf-8"
                 )
             except FileNotFoundError:
-                self.db.record_prereq(f"ethtool is missing", "👀")
+                self.db.record_prereq("ethtool is missing", "👀")
                 return True
             for line in output.split("\n"):
                 if "Supports Wake-on" in line:
@@ -1029,6 +1040,21 @@ class PrerequisiteValidator(AmdTool):
                     shutil.rmtree(tmpd)
         return True
 
+    def capture_cstates(self):
+        """Capture ACPI C state information for the first CPU (assumes the same for all CPUs)"""
+        base = os.path.join("/", "sys", "bus", "cpu", "devices", "cpu0", "cpuidle")
+        paths = {}
+        for root, _dirs, files in os.walk(base, topdown=False):
+            for fname in files:
+                target = os.path.join(root, fname)
+                with open(target, "rb") as f:
+                    paths[target] = f.read()
+        debug_str = "ACPI C-state information\n"
+        for path, data in paths.items():
+            prefix = "│ " if path != list(paths.keys())[-1] else "└─"
+            debug_str += f"{prefix}{path}: {data.decode('utf-8', 'ignore')}"
+        self.db.record_debug(debug_str)
+
     def capture_battery(self):
         """Capture battery information"""
         obj = Batteries()
@@ -1162,7 +1188,6 @@ class PrerequisiteValidator(AmdTool):
         if self.cpu_family == 0x1A and self.cpu_model in affected_1a:
             found_iommu = False
             found_acpi = False
-            found_dmar = False
             for dev in self.pyudev.list_devices(subsystem="iommu"):
                 found_iommu = True
                 debug_str += f"Found IOMMU {dev.sys_path}\n"
@@ -1266,6 +1291,7 @@ class PrerequisiteValidator(AmdTool):
             self.capture_pci_acpi,
             self.capture_edid,
             self.capture_nvidia,
+            self.capture_cstates,
         ]
         checks = []
 
@@ -1318,7 +1344,7 @@ class PrerequisiteValidator(AmdTool):
             if not check():
                 result = False
         if not result:
-            self.db.record_prereq(Headers.BrokenPrerequisites, "💯")
+            self.db.record_prereq(Headers.BrokenPrerequisites, "🚫")
         self.db.sync()
         clear_temporary_message(len(msg))
         return result
@@ -1337,7 +1363,7 @@ class PrerequisiteValidator(AmdTool):
                     logging.debug(line)
 
         if len(self.failures) == 0:
-            return True
+            return
         print_color(Headers.ExplanationReport, "🗣️")
         for item in self.failures:
             item.get_failure()

amd_debug/pstate.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 """CPPC triage script for AMD systems"""
 

amd_debug/s2idle.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 """s2idle analysis tool"""
 import argparse
@@ -75,7 +74,7 @@ def display_report_file(fname, fmt) -> None:
 def get_report_file(report_file, extension) -> str:
     """Prompt user for report file"""
     if extension == "stdout":
-        return None
+        return ""
     if not report_file:
         return f"amd-s2idle-report-{date.today()}.{extension}"
     return report_file
@@ -88,7 +87,7 @@ def get_report_format() -> str:
     return "html"
 
 
-def prompt_report_arguments(since, until, fname, fmt, report_debug) -> str:
+def prompt_report_arguments(since, until, fname, fmt, report_debug) -> list:
     """Prompt user for report configuration"""
     if not since:
         default = Defaults.since
@@ -213,8 +212,10 @@ def run_test_cycle(
 
     try:
         duration, wait, count = prompt_test_arguments(duration, wait, count, rand)
+        total_seconds = (duration + wait) * count
+        until_time = datetime.now() + timedelta(seconds=total_seconds)
         since, until, fname, fmt, report_debug = prompt_report_arguments(
-            datetime.now().isoformat(), Defaults.until.isoformat(), fname, fmt, True
+            datetime.now().isoformat(), until_time.isoformat(), fname, fmt, True
         )
     except KeyboardInterrupt:
         sys.exit("\nTest cancelled")

amd_debug/sleep_report.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 import os
@@ -488,7 +487,7 @@ class SleepReport(AmdTool):
             text = line.strip()
             if not text:
                 continue
-            for group in ["🗣️", "❌", "🚦", "🦟", "💯", "○"]:
+            for group in ["🗣️", "❌", "🚦", "🦟", "🚫", "○"]:
                 if line.startswith(group):
                     text = line.split(group)[-1]
                     color = get_group_color(group)

amd_debug/ttm.py

@@ -1,7 +1,7 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 """TTM configuration tool"""
 
+import asyncio
 import os
 import argparse
 from amd_debug.common import (

amd_debug/validator.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 import glob
@@ -435,7 +434,6 @@ class SleepValidator(AmdTool):
                 continue
             self.db.record_debug(
                 f"Woke up from input source {device} ({self.wakeup_count[device]}->{count})",
-                "💤",
             )
         self.wakeup_count = wakeup_count
 
@@ -470,7 +468,7 @@ class SleepValidator(AmdTool):
                 self.db.record_debug(f"HW sleep statistics file {p} is missing")
         if not self.hw_sleep_duration:
             self.db.record_cycle_data("Did not reach hardware sleep state", "❌")
-        return self.hw_sleep_duration
+        return self.hw_sleep_duration > 0
 
     def capture_command_line(self):
         """Capture the kernel command line to debug"""
@@ -583,7 +581,6 @@ class SleepValidator(AmdTool):
                     if bit_changed & BIT(bit):
                         self.db.record_debug(
                             f"Idle mask bit {bit} (0x{BIT(bit):x}) changed during suspend",
-                            "○",
                         )
         if self.upep:
             if self.upep_microsoft:
@@ -661,10 +658,10 @@ class SleepValidator(AmdTool):
             check()
         self.db.record_cycle(
             self.requested_duration,
-            self.active_gpios,
-            self.wakeup_irqs,
-            self.kernel_duration,
-            self.hw_sleep_duration,
+            ",".join(str(gpio) for gpio in self.active_gpios),
+            ",".join(str(irq) for irq in self.wakeup_irqs),
+            int(self.kernel_duration),
+            int(self.hw_sleep_duration),
         )
 
     def prep(self):

amd_debug/wake.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 import os