summaryrefslogtreecommitdiffstats
path: root/docs/tools/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tools/README.md')
-rw-r--r--docs/tools/README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/tools/README.md b/docs/tools/README.md
index 232fbe5..c5ebb9f 100644
--- a/docs/tools/README.md
+++ b/docs/tools/README.md
@@ -17,6 +17,10 @@ from the driver components we studied by reverse engineering and decompilation
| `guest_test_agent.py` | `tools/guest_agent/` | Guest-side test agent (vsock/TCP) |
| `debug_guest_init.sh` | `scripts/` | One-command debug launch (QEMU + GDB + monitor) |
| `windows_guest_automation.sh` | `scripts/` | Windows guest automation via WinRM |
+| `rmq` | `tools/rmq/` | Host RM-API oracle: queries the host RM via `/dev/nvidia0` for ground-truth GPU/engine data |
+| `cudatool.py`, `callwalk.py`, `ghidra_decompile_at.sh`, `annotate_corpus.py` | `userspace/cuda/tools/` | CUDA userspace analysis: crash decode, callgraph walk, decompile-at, corpus annotation |
+| `guest_engines.c`, `ioctl_trace.c` | `tools/guest-diag/` | Guest-side engine-list dump and NVIDIA-ioctl tracer |
+| `ab.sh`, `vector_add.cu` | `tools/cuda-ab/` | Host-vs-guest CUDA A/B harness with diffable results |
### RM API Tooling (Planned)
| Tool | Documentation | Description |
@@ -65,7 +69,11 @@ tools/
## Integration with Open-IOV Stack
Tools will integrate with the host VFIO driver via:
- `/dev/nvidia*` character devices (existing nvidia.ko)
-- `open-iov-vfio.ko` debugfs interface (`/sys/kernel/debug/open-iov-vfio/`)
+- `open-iov-vfio.ko` observability: **there is currently no debugfs interface** —
+ stats and traces come from `dmesg`, and the module's write-only parameters
+ (`scan_guest_ram`, `scan_vidmem`, `scan_seq`, `sema_probe`, `scan_pt`,
+ `scan_masked`, `fill_vidmem`, `poke_guest`, `poke_fill`, `dump_vidmem`,
+ `dump_guest`) drive guest-memory inspection
- VFIO ioctls for guest state introspection
- GSP-RM telemetry via firmware analyzer / dynamic dispatcher