LLEF 2.0

.github/workflows/style.yml

@@ -0,0 +1,88 @@
+name: F0 style checking
+run-name: Running style checks on ${{ github.ref_name }} following push by ${{ github.actor }}
+
+on: push
+jobs:
+  Check-isort:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: python-isort
+        uses: isort/isort-action@v1.1.1
+        with: 
+          configuration: "--check-only --profile black --diff --verbose"
+  # Check-mypy:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+  #     - name: python-mypy
+  #       uses: jpetrucciani/mypy-check@master
+  #       with:
+  #         path: '.'
+  #         mypy_flags: '--config-file .mypy.ini'
+  Check-black:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: python-black
+        uses: psf/black@stable
+        with:
+          options: "--check --line-length=120"
+          src: "."
+  Check-flake8:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python environment
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: flake8 Lint
+        uses: py-actions/flake8@v2.3.0
+        with:
+          max-line-length: "120"
+          path: "."
+          ignore: "E203,W503"
+  # Check-pydocstyle:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+  #     - name: pydocstyle
+  #       uses: foundryzero/pydocstyle-action@v1.2.6
+  #       with:
+  #         path: "."
+
+  # Check-pylint:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v3
+  #     - name: pylint
+  #       uses: foundryzero/pylint-action@v1.0.6
+  #       with:
+  #         match: "binder_trace/**/*.py"
+  #         requirements_file: "binder_trace/requirements.txt"
+
+  Check-tox:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install tox tox-gh-actions
+    - name: Test with tox
+      run: tox

.gitignore

@@ -1 +1,2 @@
-__pycache__/
+__pycache__/
+.venv/

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+line_length = 120
+profile = black

.mypy.ini

@@ -0,0 +1,8 @@
+# Global options:
+
+[mypy]
+follow_imports = silent
+ignore_missing_imports = True
+show_column_numbers = True
+pretty = True
+strict = True

.pydocstyle

@@ -0,0 +1,2 @@
+[pydocstyle]
+match = (?!test_).*\.py

.pylintrc

@@ -0,0 +1,2 @@
+[FORMAT]
+max-line-length=120

README.md

@@ -59,20 +59,21 @@ Settings are stored in a file `.llef` located in your home directory formatted a
 
 ##### Available Settings
 
-| Setting            | Type    | Description                                        |
-| ------------------ | ------- | -------------------------------------------------- |
-| color_output       | Boolean | Enable/disable color terminal output               |
-| register_coloring  | Boolean | Enable/disable register coloring                   |
-| show_legend        | Boolean | Enable/disable legend output                       |
-| show_registers     | Boolean | Enable/disable registers output                    |
-| show_stack         | Boolean | Enable/disable stack output                        |
-| show_code          | Boolean | Enable/disable code output                         |
-| show_threads       | Boolean | Enable/disable threads output                      |
-| show_trace         | Boolean | Enable/disable trace output                        |
-| force_arch         | String  | Force register display architecture (experimental) |
-| rebase_addresses   | Boolean | Enable/disable address rebase output               |
-| rebase_offset      | Int     | Set the rebase offset (default 0x100000)           |
-| show_all_registers | Boolean | Enable/disable extended register output            |
+| Setting                 | Type    | Description                                        |
+| ----------------------- | ------- | -------------------------------------------------- |
+| color_output            | Boolean | Enable/disable color terminal output               |
+| register_coloring       | Boolean | Enable/disable register coloring                   |
+| show_legend             | Boolean | Enable/disable legend output                       |
+| show_registers          | Boolean | Enable/disable registers output                    |
+| show_stack              | Boolean | Enable/disable stack output                        |
+| show_code               | Boolean | Enable/disable code output                         |
+| show_threads            | Boolean | Enable/disable threads output                      |
+| show_trace              | Boolean | Enable/disable trace output                        |
+| force_arch              | String  | Force register display architecture (experimental) |
+| rebase_addresses        | Boolean | Enable/disable address rebase output               |
+| rebase_offset           | Int     | Set the rebase offset (default 0x100000)           |
+| show_all_registers      | Boolean | Enable/disable extended register output            |
+| enable_darwin_heap_scan | Boolean | Enable/disable more accurate heap scanning for Darwin-based platforms. Uses the Darwin malloc introspection API, executing code in the address space of the target application using LLDB's evaluation engine. |
 
 #### llefcolorsettings
 Allows setting LLEF GUI colors:

arch/__init__.py

@@ -1,4 +1,5 @@
 """Arch module __init__.py"""
+
 from typing import Type
 
 from lldb import SBTarget
@@ -7,10 +8,11 @@
 from arch.arm import Arm
 from arch.base_arch import BaseArch
 from arch.i386 import I386
-from arch.x86_64 import X86_64
 from arch.ppc import PPC
+from arch.x86_64 import X86_64
 from common.constants import MSG_TYPE
-from common.util import extract_arch_from_triple, print_message
+from common.output_util import print_message
+from common.util import extract_arch_from_triple
 
 # macOS devices running arm chips identify as arm64.
 # aarch64 and arm64 backends have been merged, so alias arm64 to aarch64.
@@ -23,7 +25,7 @@
     "aarch64": Aarch64,
     "arm64": Aarch64,
     "arm64e": Aarch64,
-    "powerpc": PPC
+    "powerpc": PPC,
 }
 
 

arch/aarch64.py

@@ -68,6 +68,4 @@ class Aarch64(BaseArch):
         "m": 0xF,
     }
 
-    flag_registers = [
-        FlagRegister("cpsr", _cpsr_register_bit_masks)
-    ]
+    flag_registers = [FlagRegister("cpsr", _cpsr_register_bit_masks)]

arch/arm.py

@@ -47,6 +47,4 @@ class Arm(BaseArch):
         "t": 0x20,
     }
 
-    flag_registers = [
-        FlagRegister("cpsr", _cpsr_register_bit_masks)
-    ]
+    flag_registers = [FlagRegister("cpsr", _cpsr_register_bit_masks)]

arch/base_arch.py

@@ -8,6 +8,7 @@
 @dataclass
 class FlagRegister:
     """FlagRegister dataclass to store register name / bitmask associations"""
+
     name: str
     bit_masks: Dict[str, int]
 

arch/i386.py

@@ -1,4 +1,5 @@
 """i386 architecture definition."""
+
 from arch.base_arch import BaseArch, FlagRegister
 
 
@@ -47,5 +48,5 @@ class I386(BaseArch):
 
     flag_registers = [
         FlagRegister("eflags", _eflags_register_bit_masks),
-        FlagRegister("rflags", _eflags_register_bit_masks)
+        FlagRegister("rflags", _eflags_register_bit_masks),
     ]

arch/ppc.py

@@ -1,4 +1,5 @@
 """PowerPC architecture definition."""
+
 from arch.base_arch import BaseArch, FlagRegister
 
 
@@ -42,10 +43,10 @@ class PPC(BaseArch):
         "cr0_lt": 0x80000000,
         "cr0_gt": 0x40000000,
         "cr0_eq": 0x20000000,
-        "cr0_so": 0x10000000
+        "cr0_so": 0x10000000,
     }
 
     flag_registers = [
         FlagRegister("cr", _cr_register_bit_masks),
-        FlagRegister("xer", _xer_register_bit_masks)
+        FlagRegister("xer", _xer_register_bit_masks),
     ]

arch/x86_64.py

@@ -1,4 +1,5 @@
 """x86_64 architecture definition."""
+
 from arch.base_arch import BaseArch, FlagRegister
 
 
@@ -51,5 +52,5 @@ class X86_64(BaseArch):
     # rflags and eflags bit masks are identical for the lower 32-bits
     flag_registers = [
         FlagRegister("rflags", _eflag_register_bit_masks),
-        FlagRegister("eflags", _eflag_register_bit_masks)
+        FlagRegister("eflags", _eflag_register_bit_masks),
     ]

commands/base_command.py

@@ -11,6 +11,8 @@
 class BaseCommand(ABC):
     """An abstract base class for all commands."""
 
+    alias_set = {}
+
     @abstractmethod
     def __init__(self) -> None:
         pass
@@ -52,8 +54,11 @@ def lldb_self_register(cls, debugger: SBDebugger, module_name: str) -> None:
         if cls.container is not None:
             command = f"command script add -c {module_name}.{cls.__name__} {cls.container.container_verb} {cls.program}"
         else:
-            command = (
-                f"command script add -c {module_name}.{cls.__name__} {cls.program}"
-            )
+            command = f"command script add -c {module_name}.{cls.__name__} {cls.program}"
 
         debugger.HandleCommand(command)
+
+        # If alias_set exists, then load it into LLDB.
+        for alias, arguments in cls.alias_set.items():
+            alias_command = f"command alias {alias} {cls.program} {arguments}"
+            debugger.HandleCommand(alias_command)

commands/base_container.py

@@ -1,4 +1,5 @@
 """Base container definition."""
+
 from abc import ABC, abstractmethod
 
 from lldb import SBDebugger
@@ -25,5 +26,7 @@ def get_long_help() -> str:
     @classmethod
     def lldb_self_register(cls, debugger: SBDebugger, _: str) -> None:
         """Automatically register a container."""
-        container_command = f'command container add -h "{cls.get_long_help()}" -H "{cls.get_short_help()}" {cls.container_verb}'
+        container_command = (
+            f'command container add -h "{cls.get_long_help()}" -H "{cls.get_short_help()}" {cls.container_verb}'
+        )
         debugger.HandleCommand(container_command)

commands/base_settings.py

@@ -1,13 +1,14 @@
 """Base settings command class."""
+
 import argparse
 import shlex
-from typing import Any, Dict
 from abc import ABC, abstractmethod
+from typing import Any, Dict
 
 from lldb import SBCommandReturnObject, SBDebugger, SBExecutionContext
 
 from commands.base_command import BaseCommand
-from common.util import output_line
+from common.output_util import output_line
 
 
 class BaseSettingsCommand(BaseCommand, ABC):