Skip to content
github-actions[bot] edited this page Nov 20, 2026 · 4 revisions

GridLock Documentation Wiki (v0.8.7)

Welcome to the GridLock documentation wiki, synchronized automatically from docs/ on master.

GridLock Workspace Overview

Getting Started & Workflows

  • Installation and Building: Linux dependencies (Arch, Ubuntu/Debian, Fedora), AppImage usage on Wayland and X11, Meson/Ninja build, tutorial compilation, and CLI options.
  • Quickstart and Workflows: Launching local MPI jobs, attaching to live /proc OpenMPI/MPICH/SLURM jobs (Ctrl+Alt+P), debugging qemu-user -g and gdbserver targets (target remote), and importing #SBATCH scripts.
  • Tutorials Walkthrough: Step-by-step exercises for all 8 primary C++ MPI showcase programs (including catchpoint_exceptions.cpp) and 5 auxiliary demos in tutorial/.

User Reference

  • Keyboard Shortcuts and Quick Reference: Scannable lookup tables for execution controls (nexti, Ctrl+F10, PC jump, early return), Command Palette prefixes (>, @, #), floating tools (Ctrl+Alt+C/G/S/K/P), breakpoint lifecycle, GDB readline bindings, and CFG shortcuts.
  • User Manual: UI and Debugging: Perspectives (Alt+1..3), Command Palette, non-linear execution, non-destructive/temporary/regex breakpoints, SignalCatchpointDialog (Ctrl+Alt+S), CheckpointDialog (Ctrl+Alt+K), and GdbConsoleWidget readline ergonomics.
  • MPI Diagnostics and HPC Analysis: MPMD FIFO coordinator mechanics, ServerRackView, DeadlockAnalyzer, MpiNetworkLogWidget, DifferentialGrid outlier highlighting, and Package Manager (spack, dnf, pacman, apt).
  • Memory, Reverse Engineering, and Profiling: MemView (process_vm_readv, Diff Ranks, Export), MemoryProfilerWidget (smaps + LD_PRELOAD heap callers), ProgrammerCalculatorDialog (Ctrl+Alt+C), ArrayPlotDialog (Ctrl+Alt+G), persistent PointerGraphDialog, DisassemblyView (2D CFG + Decompiler + Xrefs + Alt+P patching), and RegisterView.
  • Configuration and Customization: PreferencesDialog, 12 built-in dark and light theme palettes, config.toml and .gridlock/ session files, and build auto-detection.

Architecture, Testing & Roadmap

  • Developer Architecture and Testing: Repository structure, coordinator and lazy-loading startup architecture, QSS disk cache, all 22 Meson test suites, coverage, and screenshot generation.
  • Engineering Roadmap: Completed v0.8.7 deliverables and planned milestones from v0.8.8 through v1.0.0.

Clone this wiki locally