Repository navigation
Developer Guide
Welcome to the internal architecture and developer documentation for GridLock. This repository contains the high-level design, build instructions, and subsystem overviews required to contribute to our Qt6/C++23 MPI debugger.
| Subsystem | Description |
|---|---|
| 🏗️ Environment Setup & Build | OS matrices, Meson/Ninja targets, and CQtDeployer packaging. |
| ⚙️ Backend Architecture Core | GDB/DAP/LSP Coordinators, Zero-Copy Memory Engine, and Security. |
| 🖼️ UI Internals & Views | Qt6 widgets, models, Wayland rendering, and theming. |
| 🧪 Testing & CI Pipelines | Headless TDD pipeline, SYS_PTRACE, and unit test suite. |
GridLock utilizes a heavily decoupled architecture where the pure Wayland Qt6 UI interacts with target MPI processes through sanitized, stateful coordinator abstractions.
graph TD;
subgraph Qt6 Frontend
UI[MainWindow / QSplitter]
Docks[Bottom Docks]
end
subgraph Core Coordinators
UI -->|Event| GRC[GdbRankCoordinator]
UI -->|Event| DAP[DapCoordinator]
Docks -->|Event| GRC
end
subgraph Security & Transport
GRC -->|Raw MI Command| MISan[MiSanitizer]
MISan -->|Validated MI| PTY[Pseudo-TTY / Subprocess]
end
subgraph OS & Target
PTY --> GDB[GDB/MI Process]
GDB -->|ptrace| Target[(MPI Debuggee)]
end
classDef frontend fill:#2a2b3c,stroke:#89b4fa,stroke-width:2px,color:#cdd6f4;
classDef core fill:#2a2b3c,stroke:#a6e3a1,stroke-width:2px,color:#cdd6f4;
classDef sec fill:#2a2b3c,stroke:#f38ba8,stroke-width:2px,color:#cdd6f4;
classDef target fill:#2a2b3c,stroke:#f9e2af,stroke-width:2px,color:#cdd6f4;
class UI,Docks frontend;
class GRC,DAP core;
class MISan,PTY sec;
class GDB,Target target;
This decoupled approach ensures that UI events never directly spawn unsafe shell commands, and raw memory is always routed through boundary validators before being rendered.
🧑💻 Users: Looking for the end-user manual and interface guides? See the User Documentation.
GridLock Repository | Releases | Report an Issue | Roadmap | Accessibility | License (MIT)
Documentation mirrored from docs/ on master.
User Guides
Architecture & Plan
Developer Docs