Repository navigation
User Manual
Welcome to the official user documentation for GridLock, the next-generation Qt6/C++23 IDE designed specifically for High-Performance Computing (HPC) and MPI debugging.
| Guide | Description |
|---|---|
| 🎨 Interface & Layout Guide | Master the 3-column layout, bottom docks, and Vim-style shortcuts. |
| 🚀 Advanced Debugging | Leverage the Deadlock Detector, FPE Trapper, Memory Exports, and more. |
| 🌐 HPC & Remote Workflows | Configure SLURM, SSH keys, and Spack environments for cluster execution. |
GridLock was built from the ground up to solve the unique challenges of debugging massive parallel MPI applications, adhering to three core principles:
1. Wayland-Native
We bypass X11 legacy overhead. GridLock uses pure Wayland to render dense data streams without tearing.
2. Zero-Copy Architecture
Reading memory from 1,000 MPI ranks shouldn't freeze your IDE. We useprocess_vm_readvand shared memory to inspect debuggee state instantly, achieving zero-copy overhead. Features like the Memory Diff Engine rely on this to compare massive memory regions simultaneously across ranks.
3. Session Bookmarking Don't lose track of your work across multi-day debugging marathons. GridLock natively serializes your active breakpoints, watched variables, and UI state into lightweight TOML workspaces.
4. Keyboard-Centric & Chorded
Mouse travel is wasted time. GridLock implements a global Command Pattern with Vim-style chorded shortcuts, allowing you to manipulate windows, toggle breakpoints, and step through code without lifting your hands.
graph TD;
A[User Action] -->|Vim Chords| B(Command Manager);
B --> C{Action Type};
C -->|UI Shift| D[QSplitter Layout];
C -->|DAP Request| E[Zero-Copy Backend];
E -->|process_vm_readv| F[(MPI Ranks)];
Jump into the Interface Guide to get started!
As of version 0.5.3, GridLock includes an experimental, Work-In-Progress (WIP) interactive tutorial suite. This mode is designed for testing debugger integrations and demonstrating the IDE's core features (e.g., Deadlock Detection, Memory Diffing).
To launch the interactive tutorial:
./build/gridlock --tutorial-modeNote: This feature is currently in active development.
👩💻 Developers: Looking to build or contribute to GridLock? See the Developer Documentation.
GridLock Repository | Releases | Report an Issue | Roadmap | Accessibility | License (MIT)
Documentation mirrored from docs/ on master.
User Guides
Architecture & Plan
Developer Docs