summaryrefslogtreecommitdiffstats
path: root/wiki/README.md
diff options
context:
space:
mode:
authorArthur Hanson Rasmusson <arthur@vgpu.io>2026-10-12 00:32:00 -0400
committerArthur Hanson Rasmusson <arthur@vgpu.io>2026-10-12 00:32:00 -0400
commitcff1461ef459e98dea063abc72ae0819fea7b5ce (patch)
treedbceb906db4bb6c2e0e621eed2515a06e701236d /wiki/README.md
parent40a01810c77838b3876ecea8fed2f5d72e08a378 (diff)
downloadopen-iov-cff1461ef459e98dea063abc72ae0819fea7b5ce.tar.gz
open-iov-cff1461ef459e98dea063abc72ae0819fea7b5ce.zip
site: open-iov.org 2026 documentation update
- tools/site: Markdown-to-MediaWiki converter (tracked-paths-only link mapping, local-marker scan, About-message insert), WikiBot publisher with diff/check modes and publish manifest, live site auditor, image uploader, site-only page sources (landing page, About, index, sidebar, banner templates, About-message template). - wiki: new public deep-dive sources (project status, install, FAQ, system overview, GSP and GSP-RM, execution frontier, host module, guest stack, UVM, physical backend, driver lifecycle, risc-v-gsp-rm-debugger, hardware/software matrix, HAAEEP, glossary); refreshed CUDA userspace status; corrected cross-document links; README rewritten for the new set. - wiki/.publish-manifest.json records each published revision for rollback.
Diffstat (limited to 'wiki/README.md')
-rw-r--r--wiki/README.md87
1 files changed, 58 insertions, 29 deletions
diff --git a/wiki/README.md b/wiki/README.md
index d04f70f..a8ecec1 100644
--- a/wiki/README.md
+++ b/wiki/README.md
@@ -1,34 +1,63 @@
-# vGPU-IO Wiki
+# vGPU-IO Wiki Sources
> **The authoritative entry point is [`../docs/README.md`](../docs/README.md).**
-> The CUDA userspace driver analysis lives at
-> [`../userspace/cuda/READ-ME-FIRST.md`](../userspace/cuda/READ-ME-FIRST.md).
+> The Markdown files in this directory are the tracked sources for the public
+> wiki at https://open-iov.org — they are converted to MediaWiki wikitext by
+> [`../tools/site/md2wiki.py`](../tools/site/md2wiki.py) and published by
+> [`../tools/site/publish.py`](../tools/site/publish.py) (see
+> [`../tools/site/README.md`](../tools/site/README.md)).
> `open-iov.org/` is an archived 2023 copy of the previous project wiki, kept
> for historical reference only.
-## Documentation Index
-
-### Core Analysis
-- [The vGSP Execution Plane (vEP)](Execution-Plane.md) - The work/execution layer of `vgsp.ko`: guest pushes to physical execution and guest-visible completion (condensed; canonical doc [`../docs/03-architecture/13-vexecution-plane.md`](../docs/03-architecture/13-vexecution-plane.md))
-- [GMMU Multi-Tenant Protection](GMMU-Multi-Tenant-Protection.md) - Multi-mdev isolation design and paged-attention (vLLM) tenant/agent protection at the GMMU: service-state ownership, per-context page directories, VRAM oversubscription (condensed; canonical doc [`../docs/03-architecture/14-multi-tenant-gmmu-protection.md`](../docs/03-architecture/14-multi-tenant-gmmu-protection.md))
-- [GSP 570.144W Firmware Analysis](GSP-570.144W-Firmware-Analysis.md) - Firmware decompilation and address record
-- [Address Reference](Address-Reference.md) - Firmware-side address tables
-- [CUDA Userspace Driver](CUDA-Userspace-Driver.md) - `libcuda.so` deep dive: layer model, guest interface, forwarding status, crash-path lesson and lookup tooling
-- [RPC Message Format](RPC-Message-Format.md) - Legacy mailbox wire format (superseded)
-- [BAR Emulation Specification](BAR-Emulation-Specification.md) - BAR_TRAP RPC analysis (superseded)
-- [WPR Management](WPR-Management.md) - WPR handler analysis (superseded)
-- [Migration Protocol](Migration-Protocol.md) - Firmware MIGRATE RPC analysis (superseded)
-- [GSP RPC Emulation](GSP-RPC-Emulation.md) - Earlier emulation-mode design (superseded)
-
-### Integration Guides
-- [vGPU-IO Integration Guide](vGPU-IO-Integration-Guide.md) - Earlier integration design (superseded)
-- Kernel RPC client and message building - superseded by [docs/03-architecture/03-gsp-and-gsp-rm.md](../docs/03-architecture/03-gsp-and-gsp-rm.md) (the `Kernel-RPC-Client.md` page was never landed)
-- Testing and validation - superseded by [docs/07-developers/onboarding-and-standards.md](../docs/07-developers/onboarding-and-standards.md) (the `Testing-and-Validation.md` page was never landed)
-
-### Reference
-- [Error Codes](Error-Codes.md) - Historical error naming (superseded by NV_STATUS values)
-- [Glossary](Glossary.md) - Historical glossary (superseded)
-- [GPU Driver Internals](GPU_Driver_Internals.md) - Imported 2023 material (superseded)
-- [GPU Firmware](GPU_Firmware.md) - Imported 2023 material (superseded)
-- [GPU SBOM](GPU_SBOM.md) - Imported 2023 material (superseded)
-- [Virtual I/O Internals](Virtual_IO_Internals.md) - Imported 2023 material (superseded)
+## Wiki sources (published)
+
+### Start here
+- [Project Status](Project-Status.md) — the dated, honest state of the project
+- [Install and First Run](Install-and-First-Run.md) — build, load, stock guest driver
+- [FAQ](FAQ.md) — common questions
+
+### Architecture
+- [System Overview](System-Overview.md) — the one-page mental model
+- [GSP and GSP-RM](GSP-and-GSP-RM.md) — the firmware interface the project emulates
+- [The Host Module (vgsp.ko)](Host-Module.md) — virtual device, emulation core, memory model, forwarding
+- [The Guest Stack and CUDASW](Guest-Stack-and-CUDASW.md) — what runs unmodified in the guest
+- [The vGSP Execution Plane (vEP)](Execution-Plane.md) — execution and completion layer
+- [Introduction to the GMMU](Introduction-to-GMMU.md) — GPU address translation from first principles
+- [UVM in the Guest](UVM-in-the-Guest.md) — unified memory as a correctness oracle
+- [GMMU Multi-Tenant Protection](GMMU-Multi-Tenant-Protection.md) — isolation design (design stage)
+- [Physical GPU Backend and Guest Wiring](Physical-GPU-Backend.md) — how work reaches real hardware
+- [Guest Driver Lifecycle: A Field Guide](Driver-Lifecycle-Field-Guide.md) — boot to CUDA with real IDs
+
+### CUDA
+- [CUDA Userspace Driver](CUDA-Userspace-Driver.md) — the `libcuda.so` deep dive
+- [The Execution Frontier](Execution-Frontier.md) — the GR compute-launch chain and its wall
+
+### Firmware and reverse engineering
+- [GSP 570.144W Firmware Analysis](GSP-570.144W-Firmware-Analysis.md)
+- [Address Reference](Address-Reference.md)
+- [risc-v-gsp-rm-debugger](Riscv-GSP-RM-Debugger.md) — the firmware runtime workbench
+- Historical protocol analyses (superseded, kept for the record):
+ [RPC Message Format](RPC-Message-Format.md),
+ [BAR Emulation Specification](BAR-Emulation-Specification.md),
+ [WPR Management](WPR-Management.md), [Migration Protocol](Migration-Protocol.md),
+ [GSP RPC Emulation](GSP-RPC-Emulation.md), [Error Codes](Error-Codes.md),
+ [vGPU-IO Integration Guide](vGPU-IO-Integration-Guide.md)
+
+### Portability, ecosystem, reference
+- [Hardware and Software Matrix](Hardware-Software-Matrix.md)
+- [HAAEEP and Collaboration](HAAEEP-and-Collaboration.md)
+- [Glossary](Reference-Glossary.md)
+
+## Historical imports (not published from here)
+`GPU_Driver_Internals.md`, `GPU_Firmware.md`, `GPU_SBOM.md`,
+`Virtual_IO_Internals.md` and `Glossary.md` are 2023-era imports of the
+previous wiki; the live pages carry historical banners and are not re-published
+from these sources.
+
+## Publishing
+Sources here are converted and published with the tooling in
+[`../tools/site/`](../tools/site/README.md). Site-only pages (Main Page, About,
+Community, sidebar, templates) live in
+[`../tools/site/pages/`](../tools/site/pages/). Every publish is recorded in
+[`.publish-manifest.json`](.publish-manifest.json) (source hash → revision ids)
+and audited by `tools/site/check_site.py`.