diff options
Diffstat (limited to 'debug/risc-v-gsp-rm-vm/docs/04-PLUGINS.md')
| -rw-r--r-- | debug/risc-v-gsp-rm-vm/docs/04-PLUGINS.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/debug/risc-v-gsp-rm-vm/docs/04-PLUGINS.md b/debug/risc-v-gsp-rm-vm/docs/04-PLUGINS.md index db9ee27..b0e6767 100644 --- a/debug/risc-v-gsp-rm-vm/docs/04-PLUGINS.md +++ b/debug/risc-v-gsp-rm-vm/docs/04-PLUGINS.md @@ -1,11 +1,11 @@ -# 04 — writing green-eye plugins +# 04 — writing risc-v-gsp-rm-debugger plugins > **# TOOL IN DEVELOPMENT - NOT READY YET!** See 00 for status. A plugin is a Python module exposing `register(ge)`. It is loaded before the session runs (CLI `--plugin PATH`, `GREENEYE_PLUGINS`, or the bundled `plugins/` directory) and can add instrumentation, CLI commands and harness -logic without touching green-eye itself. +logic without touching risc-v-gsp-rm-debugger itself. ## 1. The API object @@ -46,7 +46,7 @@ findings are replayable and comparable like any other event. ## 3. The four plugin classes -**(a) Runtime RE tools** — add analysis that green-eye does not have: +**(a) Runtime RE tools** — add analysis that risc-v-gsp-rm-debugger does not have: ```python def register(ge): @@ -103,15 +103,15 @@ def register(ge): Run it with: ```bash -./greeneye.sh run examples/scripts/trace_rpc.py --plugin plugins/example_plugin.py +./risc-v-gsp-rm-debugger.sh run examples/scripts/trace_rpc.py --plugin plugins/example_plugin.py ``` ## 5. Testing a plugin -1. Load it against the demo firmware (`./greeneye.sh demo --plugin …`) — the +1. Load it against the demo firmware (`./risc-v-gsp-rm-debugger.sh demo --plugin …`) — the session must remain green and the plugin's events must appear in `events.jsonl`. -2. Unit-test pure logic outside green-eye; keep hooks small. +2. Unit-test pure logic outside risc-v-gsp-rm-debugger; keep hooks small. 3. Never let a plugin assume a particular firmware: gate on `ge.symbols.get(name)` and log a skip instead of failing. |