Difference between revisions of "Documentation"

From Open-IOV
Jump to navigation Jump to search
(→‎API Documentation: Added Open Flow Data Plane Abstraction API reference.)
m (Fix repository links to the cgit tree/repo URLs)
 
(106 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{About message}}


===Abstract===
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 [https://git.vgpu.io/open-iov.git/ repository].
[https://openmdev.io/index.php/Introductory_Concepts_&_Definitions Introductory Concepts & Definitions]


[[Merged Drivers]]
== Start here ==
* [[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 "why is nvidia-smi working but CUDA not?"


[https://projectacrn.github.io/2.1/developer-guides/hld/ivshmem-hld.html Inter-VM Shared Memory (IVSHMEM)]
== Architecture ==
===Guides===
* [[System Overview]] — principle, layer map, data flows
[https://openmdev.io/index.php/LibVF.IO_Setup_Guide LibVF.IO Setup Guide]
* [[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


[https://looking-glass.io/docs/stable/ Looking Glass Quickstart Guide]
== CUDA ==
* [[CUDA Userspace Driver]] — the <code>libcuda.so</code> deep dive
* [[The Execution Frontier]] — the GR compute-launch chain and its current wall


[https://doc.dpdk.org/guides-16.04/prog_guide/ivshmem_lib.html Data Pane Development Kit: IVSHMEM Programming Guide]
== Firmware and reverse engineering ==
* [[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]]


[https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF PCI passthrough via OVMF]
== Portability and ecosystem ==
* [[Hardware and Software Matrix]] — Reference / Target / Experimental, honestly labelled
* [[HAAEEP and Collaboration]] — the agent-edge use case, collaboration and licensing models


[https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/index RedHat Virtualization Deployment and Administration Guide]
== Reference ==
===Support===
* [[Glossary]]
[https://openmdev.io/index.php/GPU_Support GPU Support]
* [[FAQ]]
* [[Error Codes]] — historical naming, superseded by the wire status values


[https://openmdev.io/index.php/CPU_Support CPU Support]
== 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.


[https://openmdev.io/index.php/Hypervisor_Support Hypervisor Support]
* [[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)]]


=== API Documentation ===
== Meta ==
[https://projectacrn.github.io/2.1/api/GVT-g_api.html Intel GVT-g APIs]
* [[Open-IOV:About|About Open-IOV]]
 
* [[Community]]
[https://broadcom-switch.github.io/of-dpa/doc/html/OFDPA_OVERVIEW.html Broadcom OpenFlow Data Plane Abstraction (OF-DPA)]
* Wiki architecture pages name their canonical source in the repository; when a page and its source disagree, the repository wins.
 
===Projects===
[https://openmdev.io/index.php/Looking_Glass_KVMFR Looking Glass]
 
[https://openmdev.io/index.php/Qubes_OS Qubes OS]
 
[https://openmdev.io/index.php/LibVF.IO LibVF.IO]
 
[https://openmdev.io/index.php/Scream Scream]
 
[https://openmdev.io/index.php/Intel_Project_Celadon Intel Celadon]
 
[https://openmdev.io/index.php/VGPU_Unlock vGPU_Unlock]
 
[https://openmdev.io/index.php/Virgl_3D_GPU_Project Virgl 3D GPU Project]

Latest revision as of 04:40, 12 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 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 "why is nvidia-smi working but CUDA not?"

Architecture

CUDA

Firmware and reverse engineering

Portability and ecosystem

Reference

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.

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.
Retrieved from "https://open-iov.org/index.php?title=Documentation&oldid=23974"