Difference between revisions of "Documentation"
Jump to navigation
Jump to search
m (Fix repository links to the cgit tree/repo URLs) |
m (2026-10-30 wiki refresh: add Project Plan page (phases, gates, workstreams, next steps)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
== Start here == | == Start here == | ||
* [[Project Goals]] — what Open-IOV is for, and the status of each goal | |||
* [[Project Plan]] — the phases, gates, workstreams and what is next | |||
* [[Project Status]] — what works today, what is in progress, what is not started | * [[Project Status]] — what works today, what is in progress, what is not started | ||
* [[Install and First Run]] — build, load, and a stock guest driver in about half an hour | * [[Install and First Run]] — build, load, and a stock guest driver in about half an hour | ||
* [[System Overview]] — the architecture in one page | * [[System Overview]] — the architecture in one page | ||
* [[FAQ]] — common questions, including | * [[FAQ]] — common questions, including the current state of CUDA and 3D | ||
== Architecture == | == Architecture == | ||
| Line 20: | Line 22: | ||
* [[Physical GPU Backend and Guest Wiring]] — how guest work reaches real hardware | * [[Physical GPU Backend and Guest Wiring]] — how guest work reaches real hardware | ||
* [[Guest Driver Lifecycle: A Field Guide]] — boot to CUDA, with real control IDs and log signatures | * [[Guest Driver Lifecycle: A Field Guide]] — boot to CUDA, with real control IDs and log signatures | ||
* [[Performance]] — the cost model, tracing, gaps and improvement programme | |||
* [[Interfaces and Stability]] — which surfaces are contracts, which may change | |||
== CUDA == | == CUDA == | ||
* [[CUDA Userspace Driver]] — the <code>libcuda.so</code> deep dive | * [[CUDA Userspace Driver]] — the <code>libcuda.so</code> deep dive | ||
* [[The Execution Frontier]] — the GR compute-launch chain and its | * [[The Execution Frontier]] — the GR compute-launch chain and its leading edge | ||
== Graphics == | |||
* [[Graphics Execution]] — how OpenGL/Vulkan draw commands reach the physical engines | |||
* [[OpenGL]] — the stock guest GL stack on the emulated vGPU | |||
* [[Vulkan]] — the guest Vulkan pipeline on the emulated vGPU | |||
* [[DirectX]] — the Windows/DirectX target | |||
== Firmware interoperability == | == Firmware interoperability == | ||
Latest revision as of 17:12, 30 October 2026
An absence of critical technical documentation has historically slowed growth and adoption of developer ecosystems for GPU virtualization.
This CC-BY-4.0 licensed content can either be used with attribution, or used as inspiration for new documentation, created by GPU vendors for public commercial distribution as developer documentation.
Where possible, this documentation will clearly label dates and versions of observed-but-not-guaranteed behaviour vs. vendor-documented stable interfaces/behaviour with guarantees of forward or backward compatibility.
This is the index of the Open-IOV wiki. If you are new, read Project Status first, then System Overview. The wiki is a curated public view of the project's maintained documentation; each page names its canonical document in the repository.
Start here
- Project Goals — what Open-IOV is for, and the status of each goal
- Project Plan — the phases, gates, workstreams and what is next
- Project Status — what works today, what is in progress, what is not started
- Install and First Run — build, load, and a stock guest driver in about half an hour
- System Overview — the architecture in one page
- FAQ — common questions, including the current state of CUDA and 3D
Architecture
- System Overview — principle, layer map, data flows
- GSP and GSP-RM — the firmware interface the project emulates
- The Host Module (vgsp.ko) — virtual device, emulation core, memory model, forwarding
- The Guest Stack and CUDASW — what runs unmodified inside the guest
- The vGSP Execution Plane (vEP) — the execution and completion layer
- Introduction to GMMU — GPU address translation from first principles
- UVM in the Guest — unified memory, semaphores, page trees
- GMMU Multi-Tenant Protection — isolation design for multiple VMs and tenants
- Physical GPU Backend and Guest Wiring — how guest work reaches real hardware
- Guest Driver Lifecycle: A Field Guide — boot to CUDA, with real control IDs and log signatures
- Performance — the cost model, tracing, gaps and improvement programme
- Interfaces and Stability — which surfaces are contracts, which may change
CUDA
- CUDA Userspace Driver — the
libcuda.sodeep dive - The Execution Frontier — the GR compute-launch chain and its leading edge
Graphics
- Graphics Execution — how OpenGL/Vulkan draw commands reach the physical engines
- OpenGL — the stock guest GL stack on the emulated vGPU
- Vulkan — the guest Vulkan pipeline on the emulated vGPU
- DirectX — the Windows/DirectX target
Firmware interoperability
- GSP 570.144W Firmware Analysis — how the 28.5 MB image was decompiled and mapped
- Address Reference — firmware-side address tables
- risc-v-gsp-rm-debugger — the firmware runtime workbench (hooks, watchpoints, sessions)
- Historical protocol analyses, kept for the record: RPC Message Format · BAR Emulation Specification · WPR Management · Migration Protocol · GSP RPC Emulation · Error Codes · vGPU-IO Integration Guide
Portability and ecosystem
- Hardware and Software Matrix — Reference / Target / Experimental, honestly labelled
- HAAEEP and Collaboration — the agent-edge use case, collaboration and licensing models
Reference
- Glossary
- FAQ
- Error Codes — historical naming, superseded by the wire status values
History
This wiki previously hosted the OpenMdev / LibVF.IO project documentation (2021–2023). The pages below are archived for reference; they describe earlier projects and architectures, not Open-IOV.
- Introduction · Virtualization Fundamentals · Virtual I/O Internals · GPU Driver Internals · GPU Firmware · GPU Support · CPU Support · Hypervisor Support · Merged Drivers · OpenRM · AMDGPU · Intel · Mdev-GPU · GVM · Hyperborea · LIME Is Mediated Emulation · LibVF.IO Setup Guide · Looking Glass KVMFR · VGPU Unlock · GPU Software Bill Of Materials (SBOM)
Meta
- About Open-IOV
- Community
- Wiki architecture pages name their canonical source in the repository; when a page and its source disagree, the repository wins.