diff options
Diffstat (limited to 'debug/risc-v-gsp-rm-vm/README.md')
| -rw-r--r-- | debug/risc-v-gsp-rm-vm/README.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/debug/risc-v-gsp-rm-vm/README.md b/debug/risc-v-gsp-rm-vm/README.md index 627e1d5..a1e4b9b 100644 --- a/debug/risc-v-gsp-rm-vm/README.md +++ b/debug/risc-v-gsp-rm-vm/README.md @@ -1,4 +1,4 @@ -# green-eye — GSP runtime analysis in a RISC-V QEMU VM +# risc-v-gsp-rm-debugger — GSP runtime analysis in a RISC-V QEMU VM > **# TOOL IN DEVELOPMENT - NOT READY YET!** > Experimental tooling for simulating and inspecting the GSP firmware's @@ -6,7 +6,7 @@ > reverse engineering. It is a development-only, out-of-tree tool: never a > dependency of the shipped driver and never present in a guest. -green-eye boots GSP/uproc firmware in `qemu-system-riscv64`, attaches over +risc-v-gsp-rm-debugger boots GSP/uproc firmware in `qemu-system-riscv64`, attaches over QEMU's gdbstub with a GDB-free Python client, and exposes Frida-like instrumentation: hooks, breakpoints, watchpoints, memory dumping, structure decoding, snapshot diffing, session recording, plugins and a Ghidra bridge. @@ -23,27 +23,27 @@ Start with [`docs/00-OVERVIEW.md`](docs/00-OVERVIEW.md). cd open-iov/debug/risc-v-gsp-rm-vm make demo # build the bundled RV64 uproc demo (clang + lld) -./greeneye.sh demo # boot it, hook handlers, watch counters, record + analyze -./greeneye.sh demo --backend native # same run on the deterministic native sim -./greeneye.sh record --backend native --trace --duration 0.5 # exec/access trace -./greeneye.sh info # environment / tooling check +./risc-v-gsp-rm-debugger.sh demo # boot it, hook handlers, watch counters, record + analyze +./risc-v-gsp-rm-debugger.sh demo --backend native # same run on the deterministic native sim +./risc-v-gsp-rm-debugger.sh record --backend native --trace --duration 0.5 # exec/access trace +./risc-v-gsp-rm-debugger.sh info # environment / tooling check ``` Interactively instrument a session: ```bash -./greeneye.sh attach --kernel firmware/uproc_demo/build/uproc_demo.elf -greeneye> bp rpc_sum -greeneye> watch gsp_ctrl+0x10 8 w -greeneye> x 0x80000840 64 -greeneye> c 2 +./risc-v-gsp-rm-debugger.sh attach --kernel firmware/uproc_demo/build/uproc_demo.elf +risc-v-gsp-rm-debugger> bp rpc_sum +risc-v-gsp-rm-debugger> watch gsp_ctrl+0x10 8 w +risc-v-gsp-rm-debugger> x 0x80000840 64 +risc-v-gsp-rm-debugger> c 2 ``` Or launch a target separately and attach to it by port: ```bash -./greeneye.sh launch --kernel <elf> # prints the gdbstub port, keeps QEMU alive -./greeneye.sh attach --port <port> --kernel <elf> +./risc-v-gsp-rm-debugger.sh launch --kernel <elf> # prints the gdbstub port, keeps QEMU alive +./risc-v-gsp-rm-debugger.sh attach --port <port> --kernel <elf> ``` Requirements: QEMU (`qemu-system-misc` on Ubuntu gives @@ -80,7 +80,7 @@ dumps/ recorded sessions (gitignored) | [01-DESIGN](docs/01-DESIGN.md) | architecture and data model | | [02-USAGE](docs/02-USAGE.md) | CLI and REPL recipes | | [03-SCRIPTING](docs/03-SCRIPTING.md) | Python API + probe specs | -| [04-PLUGINS](docs/04-PLUGINS.md) | writing green-eye plugins | +| [04-PLUGINS](docs/04-PLUGINS.md) | writing risc-v-gsp-rm-debugger plugins | | [05-GHIDRA-BRIDGE](docs/05-GHIDRA-BRIDGE.md) | static/dynamic address join | | [06-ACCURACY](docs/06-ACCURACY.md) | simulation fidelity and measurement | | [07-PORTABILITY-PLAYBOOKS](docs/07-PORTABILITY-PLAYBOOKS.md) | new GSP/device/arch runs | @@ -89,7 +89,7 @@ dumps/ recorded sessions (gitignored) | [10-RELATED-WORK](docs/10-RELATED-WORK.md) | Frida/GDB/QEMU-plugin comparison | | [11-GSP-RM-SERVICE-DEVELOPER-GUIDE](docs/11-GSP-RM-SERVICE-DEVELOPER-GUIDE.md) | writing, injecting and debugging firmware services | | [12-INJECTION-SDK](docs/12-INJECTION-SDK.md) | injection blob/ABI specification | -| [13-GHIDRA-CONTROL](docs/13-GHIDRA-CONTROL.md) | driving green-eye from GhidraScripts | +| [13-GHIDRA-CONTROL](docs/13-GHIDRA-CONTROL.md) | driving risc-v-gsp-rm-debugger from GhidraScripts | | [14-ADVERSARIAL-INTEROP-GUIDE](docs/14-ADVERSARIAL-INTEROP-GUIDE.md) | navigating unpredictable/adversarial firmware change | | [15-AGENTIC-GSP-IDE](docs/15-AGENTIC-GSP-IDE.md) | agentic workflows and runbooks | | [16-CUSTOM-SIMULATOR](docs/16-CUSTOM-SIMULATOR.md) | non-QEMU simulator design; M1 native backend + M1.5 trace status/usage | @@ -106,7 +106,7 @@ dumps/ recorded sessions (gitignored) | [27-TOOL-AUDIT](docs/27-TOOL-AUDIT.md) | tool audit: purpose, tests, usage, status | | [28-PORTING-AUTOMATION](docs/28-PORTING-AUTOMATION.md) | driver-version sweep and new-device scaffolds (pilot, dry-run default) | | [29-PACKAGING-AND-TRIALING](docs/29-PACKAGING-AND-TRIALING.md) | trial simulation packages (pilot) | -| [GREEN-EYE-ROADMAP](GREEN-EYE-ROADMAP.md) | the long-term program (H1–H7) | +| [RISC-V-GSP-RM-DEBUGGER-ROADMAP](RISC-V-GSP-RM-DEBUGGER-ROADMAP.md) | the long-term program (H1–H7) | <!-- change (2026-10-02): add docs 28/29 to the documentation map; scope: doc map only; benefit: new tool-tree documents are linked from the tree front |