Init new debugger

Author: chinosu

debugger2/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

debugger2/pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+asyncio_mode = auto
+asyncio_default_fixture_loop_scope = "function"
+addopts = --doctest-modules -s -v

debugger2/src/debugger/__init__.py

@@ -0,0 +1,2 @@
+from .debugger import Debugger, Frame
+from .compile import compile

debugger2/src/debugger/base_debugger.py

@@ -0,0 +1,134 @@
+from asyncio import create_subprocess_exec
+from asyncio import create_task
+from asyncio import Queue
+from asyncio import to_thread
+from asyncio import Event
+from asyncio import iscoroutinefunction
+from asyncio.subprocess import PIPE
+from contextlib import suppress
+from pathlib import Path
+import os
+
+from . import mion
+
+
+def panic(*args, **kwargs):
+    raise AssertionError(*args, **kwargs)
+
+
+class BaseDebugger:
+    def __init__(self) -> None:
+        do_nothing = lambda *args, **kwargs: None
+        self.oob_handler = do_nothing
+        self.inferior_handler = do_nothing
+        self._inferior_dispatch_done = Event()
+        self._inferior_dispatch_done.set()
+        self._did_init = False
+
+    async def init(self, executable_path: str | Path) -> None:
+        self.fd_master, self.fd_slave = os.openpty()
+        self.process = await create_subprocess_exec(
+            "gdb",
+            "--interpreter=mi4",
+            "--quiet",
+            "-nx",
+            "-nh",
+            "--tty",
+            os.ttyname(self.fd_slave),
+            "--args",
+            str(executable_path),
+            stdin=PIPE,
+            stdout=PIPE,
+        )
+
+        self.result_queue = Queue[tuple[str, dict]]()
+        create_task(self._stdout_dispatch())
+        create_task(self._inferior_dispatch())
+        self._did_init = True
+        return self
+
+    async def deinit(self) -> None:
+        if not self._did_init:
+            return
+
+        self.process.stdin.write_eof()  # or write `-gdb-exit`
+        await self.process.stdin.drain()
+        await self.process.wait()
+
+        self.result_queue.shutdown()
+        await self.result_queue.join()
+
+        os.close(self.fd_master)
+        os.close(self.fd_slave)
+        await self._inferior_dispatch_done.wait()
+
+    async def run_command(self, command: str):
+        self.process.stdin.write(f"{command}\n".encode())
+        await self.process.stdin.drain()
+
+        subkind, result = await self.result_queue.get()
+        self.result_queue.task_done()
+        assert (
+            subkind in mion.RESULT_CLASS
+        ), f"Command '{command}' returned unexpected status {subkind}"
+        return result
+
+    def on_oob[F](self, func: F) -> F:
+        """oob = out of band"""
+        self.oob_handler = func
+        return func
+
+    def on_inferior[F](self, func: F) -> F:
+        """inferior = inferior output"""
+        self.inferior_handler = func
+        return func
+
+    async def _stdout_dispatch(self) -> None:
+        while line := await self.process.stdout.readline():
+            line = line.strip().decode()
+            if line == "(gdb)":
+                continue
+
+            kind, message = line[:1], line[1:]
+            match kind:
+                case mion.RESULT:
+                    subkind, message = _split_subkind(message)
+                    await self.result_queue.put((subkind, mion.loads(message)))
+                case _ if kind in mion.ASYNC:
+                    subkind, message = _split_subkind(message)
+                    if iscoroutinefunction(self.oob_handler):
+                        await self.oob_handler((subkind, mion.loads(message)))
+                    else:
+                        self.oob_handler((subkind, mion.loads(message)))
+                case _ if kind in mion.STREAM:
+                    if iscoroutinefunction(self.oob_handler):
+                        await self.oob_handler(message)
+                    else:
+                        self.oob_handler(message)
+                case _:
+                    panic(f"Received unknown message from GDB: {kind}")
+
+    async def _inferior_dispatch(self) -> None:
+        self._inferior_dispatch_done.clear()
+        with suppress(OSError):
+            while output := await to_thread(os.read, self.fd_master, 512):
+                if iscoroutinefunction(self.inferior_handler):
+                    await self.inferior_handler(output.decode())
+                else:
+                    self.inferior_handler(output.decode())
+        self._inferior_dispatch_done.set()
+
+
+def _split_subkind(message: str) -> tuple[str, str]:
+    """
+    >>> _split_subkind('abc')
+    ('abc', '')
+    >>> _split_subkind('abc,def')
+    ('abc', 'def')
+    >>> _split_subkind('abc,def,ghi')
+    ('abc', 'def,ghi')
+    """
+
+    if "," in message:
+        return tuple(message.split(",", 1))
+    return message, ""

debugger2/src/debugger/compile.py

@@ -0,0 +1,23 @@
+from asyncio import create_subprocess_exec
+from asyncio.subprocess import PIPE
+from pathlib import Path
+
+
+async def compile(source_path: str | Path, output_path: str | Path) -> None:
+    clang = await create_subprocess_exec(
+        "clang",
+        str(source_path),
+        "-o",
+        str(output_path),
+        "-g",
+        "-O0",
+        # "-Wall",
+        # "-Wextra",
+        # "-Werror",
+        stdin=PIPE,
+        stdout=PIPE,
+        stderr=PIPE,
+    )
+    stdout, stderr = await clang.communicate()
+    exit_code = await clang.wait()
+    assert exit_code == 0, ("Failed to compile source code", stderr)