amd-debug-tools 0.2.5__tar.gz → 0.2.7__tar.gz

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amd-debug-tools
-Version: 0.2.5
+Version: 0.2.7
 Summary: debug tools for AMD systems
 Author-email: Mario Limonciello <superm1@kernel.org>
 License-Expression: MIT
@@ -131,7 +131,7 @@ The following optional arguments are supported for this command:
 If the tool is launched with an environment that can call `xdg-open`, the report
 will be opened in a browser.
 
-### `amd-s2idle version`
+### `amd-s2idle --version`
 This will print the version of the tool and exit.
 
 ### Debug output
@@ -164,7 +164,7 @@ The following optional arguments are supported for this command:
         --input INPUT  Optional input file to parse
         --tool-debug   Enable tool debug logging
 
-### `amd-bios version`
+### `amd-bios --version`
 This will print the version of the tool and exit.
 
 ## amd-pstate
@@ -172,6 +172,9 @@ This will print the version of the tool and exit.
 It will capture some state from the system as well as from the machine specific registers that
 amd-pstate uses.
 
+## amd-ttm
+`amd-ttm` is a tool used for managing the TTM memory settings on AMD systems.
+
 ## Compatibility scripts
 
 Compatibility scripts are provided for the previous names the tools went by:

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/README.md

@@ -107,7 +107,7 @@ The following optional arguments are supported for this command:
 If the tool is launched with an environment that can call `xdg-open`, the report
 will be opened in a browser.
 
-### `amd-s2idle version`
+### `amd-s2idle --version`
 This will print the version of the tool and exit.
 
 ### Debug output
@@ -140,7 +140,7 @@ The following optional arguments are supported for this command:
         --input INPUT  Optional input file to parse
         --tool-debug   Enable tool debug logging
 
-### `amd-bios version`
+### `amd-bios --version`
 This will print the version of the tool and exit.
 
 ## amd-pstate
@@ -148,6 +148,9 @@ This will print the version of the tool and exit.
 It will capture some state from the system as well as from the machine specific registers that
 amd-pstate uses.
 
+## amd-ttm
+`amd-ttm` is a tool used for managing the TTM memory settings on AMD systems.
+
 ## Compatibility scripts
 
 Compatibility scripts are provided for the previous names the tools went by:

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/pyproject.toml

@@ -50,3 +50,4 @@ license = "MIT"
 amd-s2idle = "amd_debug:amd_s2idle"
 amd-bios = "amd_debug:amd_bios"
 amd-pstate = "amd_debug:amd_pstate"
+amd-ttm = "amd_debug:amd_ttm"

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/__init__.py

@@ -23,8 +23,15 @@ def amd_pstate():
     return pstate.main()
 
 
+def amd_ttm():
+    """Launch the amd-ttm tool."""
+    from . import ttm  # pylint: disable=import-outside-toplevel
+
+    return ttm.main()
+
+
 def install_dep_superset():
-    """Install all supserset dependencies."""
+    """Install all superset dependencies."""
     from . import installer  # pylint: disable=import-outside-toplevel
 
     return installer.install_dep_superset()
@@ -36,6 +43,7 @@ def launch_tool(tool_name):
         "amd_s2idle.py": amd_s2idle,
         "amd_bios.py": amd_bios,
         "amd_pstate.py": amd_pstate,
+        "amd_ttm.py": amd_ttm,
         "install_deps.py": install_dep_superset,
     }
     if tool_name in tools:

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/bios.py

@@ -105,7 +105,9 @@ def parse_args():
         action="store_true",
         help="Enable tool debug logging",
     )
-    subparsers.add_parser("version", help="Show version information")
+    parser.add_argument(
+        "--version", action="store_true", help="Show version information"
+    )
 
     if len(sys.argv) == 1:
         parser.print_help(sys.stderr)
@@ -122,7 +124,7 @@ def parse_args():
     return args
 
 
-def main() -> None|int:
+def main() -> None | int:
     """Main function"""
     args = parse_args()
     ret = False
@@ -132,7 +134,7 @@ def main() -> None|int:
     elif args.command == "parse":
         app = AmdBios(args.input, args.tool_debug)
         ret = app.run()
-    elif args.command == "version":
+    elif args.version:
         print(version())
     show_log_info()
     if ret is False:

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/common.py

@@ -226,6 +226,45 @@ def get_pretty_distro() -> str:
     return distro
 
 
+def bytes_to_gb(bytes_value):
+    """Convert bytes to GB"""
+    return bytes_value * 4096 / (1024 * 1024 * 1024)
+
+
+def gb_to_pages(gb_value):
+    """Convert GB into bytes"""
+    return int(gb_value * (1024 * 1024 * 1024) / 4096)
+
+
+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)
+        return True
+    except ImportError:
+        fatal_error("Missing dbus")
+    except dbus.exceptions.DBusException as e:
+        fatal_error({e})
+    return True
+
+
+def get_system_mem():
+    """Get the total system memory in GB using /proc/meminfo"""
+    with open(os.path.join("/", "proc", "meminfo"), "r", encoding="utf-8") as f:
+        for line in f:
+            if line.startswith("MemTotal:"):
+                # MemTotal line format: "MemTotal:       16384516 kB"
+                # Extract the number and convert from kB to GB
+                mem_kb = int(line.split()[1])
+                return mem_kb / (1024 * 1024)
+    raise ValueError("Could not find MemTotal in /proc/meminfo")
+
+
 def is_root() -> bool:
     """Check if the user is root"""
     return os.geteuid() == 0

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/installer.py

@@ -446,8 +446,8 @@ def parse_args():
     return parser.parse_args()
 
 
-def install_dep_superset() -> None|int:
-    """Install all python supserset dependencies"""
+def install_dep_superset() -> None | int:
+    """Install all python superset dependencies"""
     args = parse_args()
     tool = Installer(tool_debug=args.tool_debug)
     tool.set_requirements(

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/prerequisites.py

@@ -128,6 +128,28 @@ class PrerequisiteValidator(AmdTool):
         if not self.db.get_last_prereq_ts():
             self.run()
 
+    def capture_nvidia(self):
+        """Capture the NVIDIA GPU state"""
+        p = os.path.join("/", "proc", "driver", "nvidia", "version")
+        if not os.path.exists(p):
+            return True
+        try:
+            self.db.record_debug_file(p)
+        except PermissionError:
+            self.db.record_prereq("NVIDIA GPU version not readable", "👀")
+            return True
+        p = os.path.join("/", "proc", "driver", "nvidia", "gpus")
+        if not os.path.exists(p):
+            return True
+        for root, _dirs, files in os.walk(p, topdown=False):
+            for f in files:
+                try:
+                    self.db.record_debug(f"NVIDIA {f}")
+                    self.db.record_debug_file(os.path.join(root, f))
+                except PermissionError:
+                    self.db.record_prereq("NVIDIA GPU {f} not readable", "👀")
+        return True
+
     def capture_edid(self):
         """Capture and decode the EDID data"""
         edids = self.display.get_edid()
@@ -1227,9 +1249,8 @@ class PrerequisiteValidator(AmdTool):
         # ignore kernel warnings
         taint &= ~BIT(9)
         if taint != 0:
-            self.db.record_prereq(f"Kernel is tainted: {taint}", "❌")
+            self.db.record_prereq(f"Kernel is tainted: {taint}", "🚦")
             self.failures += [TaintedKernel()]
-            return False
         return True
 
     def run(self):
@@ -1244,6 +1265,7 @@ class PrerequisiteValidator(AmdTool):
             self.capture_logind,
             self.capture_pci_acpi,
             self.capture_edid,
+            self.capture_nvidia,
         ]
         checks = []
 

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/pstate.py

@@ -293,18 +293,20 @@ def parse_args():
         action="store_true",
         help="Enable tool debug logging",
     )
-    subparsers.add_parser("version", help="Show version information")
+    parser.add_argument(
+        "--version", action="store_true", help="Show version information"
+    )
     if len(sys.argv) == 1:
         parser.print_help(sys.stderr)
         sys.exit(1)
     return parser.parse_args()
 
 
-def main() -> None|int:
+def main() -> None | int:
     """Main function"""
     args = parse_args()
     ret = False
-    if args.command == "version":
+    if args.version:
         print(version())
         return
     elif args.command == "triage":

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/s2idle.py

@@ -385,7 +385,9 @@ def parse_args():
             help="Enable tool debug logging",
         )
 
-    subparsers.add_parser("version", help="Show version information")
+    parser.add_argument(
+        "--version", action="store_true", help="Show version information"
+    )
 
     if len(sys.argv) == 1:
         parser.print_help(sys.stderr)
@@ -394,7 +396,7 @@ def parse_args():
     return parser.parse_args()
 
 
-def main() -> None|int:
+def main() -> None | int:
     """Main function"""
     args = parse_args()
     ret = False
@@ -427,7 +429,7 @@ def main() -> None|int:
             args.logind,
             args.bios_debug,
         )
-    elif args.action == "version":
+    elif args.version:
         print(version())
         return
     else:

amd_debug_tools-0.2.7/src/amd_debug/ttm.py

@@ -0,0 +1,157 @@
+#!/usr/bin/python3
+# SPDX-License-Identifier: MIT
+"""TTM configuration tool"""
+
+import os
+import argparse
+from amd_debug.common import (
+    AmdTool,
+    bytes_to_gb,
+    gb_to_pages,
+    get_system_mem,
+    relaunch_sudo,
+    print_color,
+    reboot,
+    version,
+)
+
+TTM_PARAM_PATH = "/sys/module/ttm/parameters/pages_limit"
+MODPROBE_CONF_PATH = "/etc/modprobe.d/ttm.conf"
+# Maximum percentage of total system memory to allow for TTM
+MAX_MEMORY_PERCENTAGE = 90
+
+
+def maybe_reboot() -> bool:
+    """Prompt to reboot system"""
+    response = input("Would you like to reboot the system now? (y/n): ").strip().lower()
+    if response in ("y", "yes"):
+        return reboot()
+    return True
+
+
+class AmdTtmTool(AmdTool):
+    """Class for handling TTM page configuration"""
+
+    def __init__(self, logging):
+        log_prefix = "ttm" if logging else None
+        super().__init__(log_prefix)
+
+    def get(self) -> bool:
+        """Read current page limit"""
+        try:
+            with open(TTM_PARAM_PATH, "r", encoding="utf-8") as f:
+                pages = int(f.read().strip())
+                gb_value = bytes_to_gb(pages)
+                print_color(
+                    f"Current TTM pages limit: {pages} pages ({gb_value:.2f} GB)", "💻"
+                )
+        except FileNotFoundError:
+            print_color(f"Error: Could not find {TTM_PARAM_PATH}", "❌")
+            return False
+
+        total = get_system_mem()
+        if total > 0:
+            print_color(f"Total system memory: {total:.2f} GB", "💻")
+
+        return True
+
+    def set(self, gb_value) -> bool:
+        """Set a new page limit"""
+        relaunch_sudo()
+
+        # Check against system memory
+        total = get_system_mem()
+        if total > 0:
+            max_recommended_gb = total * MAX_MEMORY_PERCENTAGE / 100
+
+            if gb_value > total:
+                print_color(
+                    f"{gb_value:.2f} GB is greater than total system memory ({total:.2f} GB)",
+                    "❌",
+                )
+                return False
+
+            if gb_value > max_recommended_gb:
+                print_color(
+                    f"Warning: The requested value ({gb_value:.2f} GB) exceeds {MAX_MEMORY_PERCENTAGE}% of your system memory ({max_recommended_gb:.2f} GB).",
+                    "🚦",
+                )
+                response = (
+                    input(
+                        "This could cause system instability. Continue anyway? (y/n): "
+                    )
+                    .strip()
+                    .lower()
+                )
+                if response not in ("y", "yes"):
+                    print_color("Operation cancelled.", "🚦")
+                    return False
+
+        pages = gb_to_pages(gb_value)
+
+        with open(MODPROBE_CONF_PATH, "w", encoding="utf-8") as f:
+            f.write(f"options ttm pages_limit={pages}\n")
+        print_color(
+            f"Successfully set TTM pages limit to {pages} pages ({gb_value:.2f} GB)",
+            "🐧",
+        )
+        print_color(f"Configuration written to {MODPROBE_CONF_PATH}", "🐧")
+        print_color("NOTE: You need to reboot for changes to take effect.", "○")
+
+        return maybe_reboot()
+
+    def clear(self) -> bool:
+        """Clears the page limit"""
+        if not os.path.exists(MODPROBE_CONF_PATH):
+            print_color(f"{MODPROBE_CONF_PATH} doesn't exist", "❌")
+            return False
+
+        relaunch_sudo()
+
+        os.remove(MODPROBE_CONF_PATH)
+        print_color(f"Configuration {MODPROBE_CONF_PATH} removed", "🐧")
+
+        return maybe_reboot()
+
+
+def parse_args():
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(description="Manage TTM pages limit")
+    parser.add_argument("--set", type=float, help="Set pages limit in GB")
+    parser.add_argument(
+        "--clear", action="store_true", help="Clear a previously set page limit"
+    )
+    parser.add_argument(
+        "--version", action="store_true", help="Show version information"
+    )
+    parser.add_argument(
+        "--tool-debug",
+        action="store_true",
+        help="Enable tool debug logging",
+    )
+
+    return parser.parse_args()
+
+
+def main() -> None | int:
+    """Main function"""
+
+    args = parse_args()
+    tool = AmdTtmTool(args.tool_debug)
+    ret = False
+
+    if args.version:
+        print(version())
+        return
+    elif args.set is not None:
+        if args.set <= 0:
+            print("Error: GB value must be greater than 0")
+            return 1
+        ret = tool.set(args.set)
+    elif args.clear:
+        ret = tool.clear()
+    else:
+        ret = tool.get()
+    if ret is False:
+        return 1
+    return

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug/validator.py

@@ -703,6 +703,22 @@ class SleepValidator(AmdTool):
         else:
             print_color("No RTC device found, please manually wake system", "🚦")
 
+    def toggle_nvidia(self, value):
+        """Write to the NVIDIA suspend interface"""
+        p = os.path.join("/", "proc", "driver", "nvidia", "suspend")
+        if not os.path.exists(p):
+            return True
+        fd = os.open(p, os.O_WRONLY | os.O_SYNC)
+        try:
+            os.write(fd, value)
+        except OSError as e:
+            self.db.record_cycle_data(f"Failed to set {value} in NVIDIA {e}", "❌")
+            return False
+        finally:
+            os.close(fd)
+        self.db.record_debug(f"Wrote {value} to NVIDIA driver")
+        return True
+
     @pm_debugging
     def suspend_system(self):
         """Suspend the system using the dbus or sysfs interface"""
@@ -744,6 +760,8 @@ class SleepValidator(AmdTool):
                 self.db.record_cycle_data("Missing dbus", "❌")
                 return False
         else:
+            if not self.toggle_nvidia(b"suspend"):
+                return False
             old = get_wakeup_count()
             p = os.path.join("/", "sys", "power", "state")
             fd = os.open(p, os.O_WRONLY | os.O_SYNC)
@@ -757,6 +775,8 @@ class SleepValidator(AmdTool):
                 return False
             finally:
                 os.close(fd)
+            if not self.toggle_nvidia(b"resume"):
+                return False
             return True
 
     def unlock_session(self):

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amd-debug-tools
-Version: 0.2.5
+Version: 0.2.7
 Summary: debug tools for AMD systems
 Author-email: Mario Limonciello <superm1@kernel.org>
 License-Expression: MIT
@@ -131,7 +131,7 @@ The following optional arguments are supported for this command:
 If the tool is launched with an environment that can call `xdg-open`, the report
 will be opened in a browser.
 
-### `amd-s2idle version`
+### `amd-s2idle --version`
 This will print the version of the tool and exit.
 
 ### Debug output
@@ -164,7 +164,7 @@ The following optional arguments are supported for this command:
         --input INPUT  Optional input file to parse
         --tool-debug   Enable tool debug logging
 
-### `amd-bios version`
+### `amd-bios --version`
 This will print the version of the tool and exit.
 
 ## amd-pstate
@@ -172,6 +172,9 @@ This will print the version of the tool and exit.
 It will capture some state from the system as well as from the machine specific registers that
 amd-pstate uses.
 
+## amd-ttm
+`amd-ttm` is a tool used for managing the TTM memory settings on AMD systems.
+
 ## Compatibility scripts
 
 Compatibility scripts are provided for the previous names the tools went by:

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug_tools.egg-info/SOURCES.txt

@@ -16,6 +16,7 @@ src/test_prerequisites.py
 src/test_pstate.py
 src/test_s2idle.py
 src/test_sleep_report.py
+src/test_ttm.py
 src/test_validator.py
 src/test_wake.py
 src/amd_debug/__init__.py
@@ -33,6 +34,7 @@ src/amd_debug/pstate.py
 src/amd_debug/s2idle-hook
 src/amd_debug/s2idle.py
 src/amd_debug/sleep_report.py
+src/amd_debug/ttm.py
 src/amd_debug/validator.py
 src/amd_debug/wake.py
 src/amd_debug/bash/amd-s2idle

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug_tools.egg-info/entry_points.txt

@@ -2,3 +2,4 @@
 amd-bios = amd_debug:amd_bios
 amd-pstate = amd_debug:amd_pstate
 amd-s2idle = amd_debug:amd_s2idle
+amd-ttm = amd_debug:amd_ttm

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/amd_debug_tools.egg-info/top_level.txt

@@ -14,5 +14,6 @@ test_prerequisites
 test_pstate
 test_s2idle
 test_sleep_report
+test_ttm
 test_validator
 test_wake

{amd_debug_tools-0.2.5 → amd_debug_tools-0.2.7}/src/test_bios.py

@@ -33,8 +33,14 @@ class TestAmdBios(unittest.TestCase):
     @patch("amd_debug.bios.minimum_kernel")
     @patch("amd_debug.bios.AcpicaTracer")
     @patch("amd_debug.bios.print_color")
+    @patch("subprocess.run")
     def test_set_tracing_enable(
-        self, _mock_print, mock_acpica_tracer, mock_minimum_kernel, mock_relaunch_sudo
+        self,
+        _mock_run,
+        _mock_print,
+        mock_acpica_tracer,
+        mock_minimum_kernel,
+        mock_relaunch_sudo,
     ):
         """Test enabling tracing"""
         mock_minimum_kernel.return_value = True
@@ -53,8 +59,14 @@ class TestAmdBios(unittest.TestCase):
     @patch("amd_debug.bios.minimum_kernel")
     @patch("amd_debug.bios.AcpicaTracer")
     @patch("amd_debug.bios.print_color")
+    @patch("subprocess.run")
     def test_set_tracing_disable(
-        self, _mock_print, mock_acpica_tracer, mock_minimum_kernel, mock_relaunch_sudo
+        self,
+        _mock_run,
+        _mock_print,
+        mock_acpica_tracer,
+        mock_minimum_kernel,
+        mock_relaunch_sudo,
     ):
         """Test disabling tracing"""
         mock_minimum_kernel.return_value = True
@@ -71,7 +83,10 @@ class TestAmdBios(unittest.TestCase):
 
     @patch("amd_debug.bios.sscanf_bios_args")
     @patch("amd_debug.bios.print_color")
-    def test_analyze_kernel_log_line(self, mock_print_color, mock_sscanf_bios_args):
+    @patch("subprocess.run")
+    def test_analyze_kernel_log_line(
+        self, _mock_run, mock_print_color, mock_sscanf_bios_args
+    ):
         """Test analyzing kernel log line"""
         mock_sscanf_bios_args.return_value = "BIOS argument found"
 
@@ -85,8 +100,9 @@ class TestAmdBios(unittest.TestCase):
 
     @patch("amd_debug.bios.sscanf_bios_args")
     @patch("amd_debug.bios.print_color")
+    @patch("subprocess.run")
     def test_analyze_kernel_log_line_no_bios_args(
-        self, mock_print_color, mock_sscanf_bios_args
+        self, _mock_run, mock_print_color, mock_sscanf_bios_args
     ):
         """Test analyzing kernel log line with no BIOS arguments"""
         mock_sscanf_bios_args.return_value = None
@@ -140,12 +156,12 @@ class TestAmdBios(unittest.TestCase):
         self.assertFalse(args.enable)
         self.assertTrue(args.disable)
 
-    @patch("sys.argv", ["bios.py", "version"])
+    @patch("sys.argv", ["bios.py", "--version"])
     def test_parse_args_version_command(self):
         """Test parse_args with version command"""
 
         args = parse_args()
-        self.assertEqual(args.command, "version")
+        self.assertTrue(args.version)
 
     @patch("sys.argv", ["bios.py"])
     @patch("argparse.ArgumentParser.print_help")
@@ -227,7 +243,7 @@ class TestAmdBios(unittest.TestCase):
         self, _mock_print, mock_show_log_info, mock_version, mock_parse_args
     ):
         """Test main function with version command"""
-        mock_parse_args.return_value = argparse.Namespace(command="version")
+        mock_parse_args.return_value = argparse.Namespace(version=True, command=None)
         mock_version.return_value = "1.0.0"
 
         result = main()
@@ -241,7 +257,9 @@ class TestAmdBios(unittest.TestCase):
     @patch("amd_debug.bios.show_log_info")
     def test_main_invalid_command(self, mock_show_log_info, mock_parse_args):
         """Test main function with an invalid command"""
-        mock_parse_args.return_value = argparse.Namespace(command="invalid")
+        mock_parse_args.return_value = argparse.Namespace(
+            version=False, command="invalid"
+        )
 
         result = main()