Difference between revisions of "OpenGL"

From Open-IOV
Jump to navigation Jump to search
(New page (2026-10-30 wiki refresh): OpenGL)
 
m (2026-11-09 wiki refresh: display/KMS bring-up (NvKms, /dev/dri, GL 4.6), direct-GL channel submissions, current X/GLX completion wall)
Line 5: Line 5:
<blockquote>'''Scope.''' How a stock guest OpenGL application's commands travel through the unmodified NVIDIA stack on the emulated vGPU, and the honest state of running OpenGL on it. The host-side execution machinery shared by all graphics APIs is on [[Graphics Execution|<code>Graphics-Execution.md</code>]]; CUDA compute is on [[The Execution Frontier|<code>Execution-Frontier.md</code>]]. Canonical sources: [https://git.vgpu.io/open-iov.git/tree/docs/04-implementation/05-graphics-execution-plan.md <code>../docs/04-implementation/05-graphics-execution-plan.md</code>] (the plan and milestones), [https://git.vgpu.io/open-iov.git/tree/docs/04-implementation/04-real-render-walls.md <code>../docs/04-implementation/04-real-render-walls.md</code>] (the measured walls) and [https://git.vgpu.io/open-iov.git/tree/docs/03-architecture/02-guest-stack-and-cudasw.md <code>../docs/03-architecture/02-guest-stack-and-cudasw.md</code>] (the guest stack). The docs tree wins on disagreement.</blockquote>
<blockquote>'''Scope.''' How a stock guest OpenGL application's commands travel through the unmodified NVIDIA stack on the emulated vGPU, and the honest state of running OpenGL on it. The host-side execution machinery shared by all graphics APIs is on [[Graphics Execution|<code>Graphics-Execution.md</code>]]; CUDA compute is on [[The Execution Frontier|<code>Execution-Frontier.md</code>]]. Canonical sources: [https://git.vgpu.io/open-iov.git/tree/docs/04-implementation/05-graphics-execution-plan.md <code>../docs/04-implementation/05-graphics-execution-plan.md</code>] (the plan and milestones), [https://git.vgpu.io/open-iov.git/tree/docs/04-implementation/04-real-render-walls.md <code>../docs/04-implementation/04-real-render-walls.md</code>] (the measured walls) and [https://git.vgpu.io/open-iov.git/tree/docs/03-architecture/02-guest-stack-and-cudasw.md <code>../docs/03-architecture/02-guest-stack-and-cudasw.md</code>] (the guest stack). The docs tree wins on disagreement.</blockquote>


Status: 2026-10-30, tree <code>master @ b4930168</code>. Tags: <code>[live]</code> observed with the stock guest driver; <code>[wip]</code> partial; <code>[wall]</code> current blocker; <code>[target]</code> defined success state.
Status: 2026-11-09, tree <code>master @ 4acc81e8</code>. Tags: <code>[live]</code> observed with the stock guest driver; <code>[wip]</code> partial; <code>[wall]</code> current blocker; <code>[target]</code> defined success state.


== 1. The guest OpenGL stack ==
== 1. The guest OpenGL stack ==
Line 24: Line 24:
* '''Indirect GLX''' — the client's GL protocol is serialised to the X server, which executes it against its own GL context. Here the X server's channel carries the graphics stream.
* '''Indirect GLX''' — the client's GL protocol is serialised to the X server, which executes it against its own GL context. Here the X server's channel carries the graphics stream.


On the emulated vGPU the readable command source today is the '''X server's channel''', whose graphics-class (<code>0xC597</code>, <code>TURING_A</code>) sections the emulation captures and executes ([[Graphics Execution|<code>Graphics-Execution.md</code>]] §3).
On the emulated vGPU the readable command sources today are the '''direct GL client's own channels''' — the GR channel <code>0xbeef0100</code> and its CE siblings <code>0xbeef0101</code>/<code>0xbeef0102</code> — and the '''X server's channels''', whose graphics-class (<code>0xC597</code>, <code>TURING_A</code>) sections the emulation captures and whose DDX kick channel (<code>0xbfef0002</code>) is decoded from its ring head ([[Graphics Execution|<code>Graphics-Execution.md</code>]] §3).


== 2. What an NVIDIA GL frame involves (observed shapes) ==
== 2. What an NVIDIA GL frame involves (observed shapes) ==
Line 30: Line 30:
* '''Context and state setup''' — shader programs (SASS) uploaded to device memory, constant/descriptor banks, render targets and depth surfaces allocated and mapped.
* '''Context and state setup''' — shader programs (SASS) uploaded to device memory, constant/descriptor banks, render targets and depth surfaces allocated and mapped.
* '''Per-draw work''' — a graphics-class method stream: state binds (viewport, render target, ZS, blend/ROP), program and constant binds, vertex/index data, and draw-issuing methods that drive the fixed-function pipeline (vertex fetch, primitive assembly, rasterisation, fragment work, ROP).
* '''Per-draw work''' — a graphics-class method stream: state binds (viewport, render target, ZS, blend/ROP), program and constant binds, vertex/index data, and draw-issuing methods that drive the fixed-function pipeline (vertex fetch, primitive assembly, rasterisation, fragment work, ROP).
* '''Program/descriptor delivery''' — the driver uploads shader code and descriptors through its copy/utility-channel inline-data path; this upload is the piece the emulation must materialise for the engine to run ''real'' programs ([[Vulkan|<code>Vulkan.md</code>]] has the mirror-image of the same gap).
* '''Program/descriptor delivery''' — the driver uploads shader code and descriptors through its copy/utility-channel inline-data path. The GL draw path decodes these uploads and the engine executes the draw; Vulkan's inline-to-memory arm is the remaining mirror-image gap ([[Vulkan|<code>Vulkan.md</code>]]).
* '''Present''' — the X server's present/readback path runs as light 2D-class and copy-engine operations; the emulator decodes and executes those shapes.
* '''Present''' — the X server's present/readback path runs as light 2D-class and copy-engine operations; the emulator decodes and executes those shapes.


Line 45: Line 45:
| <code>[live]</code>
| <code>[live]</code>
|-
|-
| <code>glxinfo -B</code> reports the NVIDIA renderer (OpenGL 4.6.0, driver 570.144)
| nvidia-modeset/NvKms registers (<code>/dev/dri/card0</code>, <code>renderD128</code>, <code>fb0</code>); <code>nvidia-smi -L</code> enumerates
| <code>[live]</code> (campaign configuration)
|-
| <code>glxinfo -B</code> reports the NVIDIA renderer (OpenGL 4.6.0, driver 570.144, direct rendering)
| <code>[live]</code>
| <code>[live]</code>
|-
|-
Line 51: Line 54:
| <code>[live]</code>
| <code>[live]</code>
|-
|-
| GZDoom launches and runs on the emulated vGPU
| GZDoom obtains a real GL context; windowed GZDoom reaches renderer startup
| <code>[live]</code> (menu/frames black)
| <code>[live]</code> (menu/frames black)
|-
|-
Line 64: Line 67:
|-
|-
| Direct GL client: device-init gate handled; client channels allocate; readback path returns with no GL error
| Direct GL client: device-init gate handled; client channels allocate; readback path returns with no GL error
| <code>[wip]</code>
| <code>[live]</code>
|-
|-
| Direct GL client submits its per-frame draws
| Direct GL client submits and retires its per-frame draws (GR <code>0xbeef0100</code>, CE <code>0xbeef0101</code>/<code>0xbeef0102</code>); DDX kick channel decoded
| <code>[wall]</code> (no submissions observed)
| <code>[live]</code>
|-
| X GLX context-creation completion and the client kick-slot word
| <code>[wall]</code>
|-
|-
| Non-black rendered frames through the emulated vGPU
| Non-black rendered frames through the emulated vGPU
Line 82: Line 88:
== 5. Milestones on this path ==
== 5. Milestones on this path ==


The graphics plan defines M-GL1 (client context-init decodes and executes; the client leaves its retry loop), M-GL2 (<code>glxgears</code> non-black), M-GL3 (GZDoom GL non-black through the mdev), M-GL4 (60 fps, no forcing), M-GL5 (two VMs, two mdevs), M-GL6 (split-screen video). The project sits '''between M-GL1 and M-GL2''': the interface work is done — the client creates its channels and its readback path is clean — and pixels are the gate.
The graphics plan defines M-GL1 (client context-init decodes and executes; the client leaves its retry loop), M-GL2 (<code>glxgears</code> non-black), M-GL3 (GZDoom GL non-black through the mdev), M-GL4 (60 fps, no forcing), M-GL5 (two VMs, two mdevs), M-GL6 (split-screen video). The project sits '''between M-GL1 and M-GL2''': the interface and execution work is done — the display/KMS stack registers, X settles, the client submits and retires its GR/CE channels, and the engine authors stores — and the remaining gate is the X GLX context-creation completion plus the client kick-slot word before the first rendered frame.


== 6. What is not claimed ==
== 6. What is not claimed ==

Revision as of 17:57, 9 November 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.

OpenGL

Scope. How a stock guest OpenGL application's commands travel through the unmodified NVIDIA stack on the emulated vGPU, and the honest state of running OpenGL on it. The host-side execution machinery shared by all graphics APIs is on Graphics-Execution.md; CUDA compute is on Execution-Frontier.md. Canonical sources: ../docs/04-implementation/05-graphics-execution-plan.md (the plan and milestones), ../docs/04-implementation/04-real-render-walls.md (the measured walls) and ../docs/03-architecture/02-guest-stack-and-cudasw.md (the guest stack). The docs tree wins on disagreement.

Status: 2026-11-09, tree master @ 4acc81e8. Tags: [live] observed with the stock guest driver; [wip] partial; [wall] current blocker; [target] defined success state.

1. The guest OpenGL stack

On Linux, an OpenGL application does not talk to the kernel driver directly: it talks to the GL implementation, and — when a display is involved — through the X server's GLX extension:

application (toolkit / SDL / GLFW / raw GLX)
  -> libGL (dispatch)                    -> libGLX_nvidia (NVIDIA GLX client)
  -> libnvidia-glcore (the vendor GL engine: state, programs, shaders, draws)
  -> ioctls + mappings to nvidia.ko      -> channels, buffers, synchronization
X server (Xorg)
  -> GLX extension module (glxserver_nvidia) and the NVIDIA DDX (X driver)
  -> owns the screen, drawables and the present path

Two forms of operation exist, and both are visible in the guest:

  • Direct rendering — the normal desktop case. The GL client builds GPU commands in its own process and the X server coordinates buffers and presents. The client's channel is the source of truth for per-draw state.
  • Indirect GLX — the client's GL protocol is serialised to the X server, which executes it against its own GL context. Here the X server's channel carries the graphics stream.

On the emulated vGPU the readable command sources today are the direct GL client's own channels — the GR channel 0xbeef0100 and its CE siblings 0xbeef0101/0xbeef0102 — and the X server's channels, whose graphics-class (0xC597, TURING_A) sections the emulation captures and whose DDX kick channel (0xbfef0002) is decoded from its ring head (Graphics-Execution.md §3).

2. What an NVIDIA GL frame involves (observed shapes)

  • Context and state setup — shader programs (SASS) uploaded to device memory, constant/descriptor banks, render targets and depth surfaces allocated and mapped.
  • Per-draw work — a graphics-class method stream: state binds (viewport, render target, ZS, blend/ROP), program and constant binds, vertex/index data, and draw-issuing methods that drive the fixed-function pipeline (vertex fetch, primitive assembly, rasterisation, fragment work, ROP).
  • Program/descriptor delivery — the driver uploads shader code and descriptors through its copy/utility-channel inline-data path. The GL draw path decodes these uploads and the engine executes the draw; Vulkan's inline-to-memory arm is the remaining mirror-image gap (Vulkan.md).
  • Present — the X server's present/readback path runs as light 2D-class and copy-engine operations; the emulator decodes and executes those shapes.

3. Status on the emulated vGPU

Rated honestly, against the milestone ladder in the plan:

Item State
X server initialises on the emulated vGPU (driver push-DMA sanity test, ScreenInit) [live]
nvidia-modeset/NvKms registers (/dev/dri/card0, renderD128, fb0); nvidia-smi -L enumerates [live] (campaign configuration)
glxinfo -B reports the NVIDIA renderer (OpenGL 4.6.0, driver 570.144, direct rendering) [live]
The X driver's RC-watchdog channel registers and its notifier is authored [live]
GZDoom obtains a real GL context; windowed GZDoom reaches renderer startup [live] (menu/frames black)
X server's 0xC597 graphics section captured and decoded [live]
Engine executes a launch built from the captured section (real sm_75 SASS retired) [live]
Verbatim 3D method-stream replay retired by the engine, no MMU fault [live]
Direct GL client: device-init gate handled; client channels allocate; readback path returns with no GL error [live]
Direct GL client submits and retires its per-frame draws (GR 0xbeef0100, CE 0xbeef0101/0xbeef0102); DDX kick channel decoded [live]
X GLX context-creation completion and the client kick-slot word [wall]
Non-black rendered frames through the emulated vGPU [wall]
60 fps sustained, no forcing (M-GL4) [target]

4. How OpenGL runs are verified

Instruments that matter, in order of usefulness: the X server log and xdpyinfo (did the server initialise?), glxinfo -B (which renderer is real), the application's own progress output, and frame capture at the GL source (a swap-hook capture is the ground truth for pixels — the X screen itself is not, on some stacks). Captures are decoded offline and scored: fraction of pixels above a luminance threshold, colour count, and frame-to-frame motion. A run counts only when the capture shows motion with the NVIDIA renderer in use.

5. Milestones on this path

The graphics plan defines M-GL1 (client context-init decodes and executes; the client leaves its retry loop), M-GL2 (glxgears non-black), M-GL3 (GZDoom GL non-black through the mdev), M-GL4 (60 fps, no forcing), M-GL5 (two VMs, two mdevs), M-GL6 (split-screen video). The project sits between M-GL1 and M-GL2: the interface and execution work is done — the display/KMS stack registers, X settles, the client submits and retires its GR/CE channels, and the engine authors stores — and the remaining gate is the X GLX context-creation completion plus the client kick-slot word before the first rendered frame.

6. What is not claimed

  • No OpenGL frame from the emulated vGPU has produced real rendered pixels yet; every capture so far is black.
  • No frame-rate or latency numbers.
  • The published two-VM GZDoom demo videos used the labelled virtio-gpu/ virgl path, not the emulated vGPU.

7. Related pages