diff options
| author | Arthur Hanson Rasmusson <arthur@vgpu.io> | 2026-09-23 13:48:07 -0400 |
|---|---|---|
| committer | Arthur Hanson Rasmusson <arthur@vgpu.io> | 2026-09-23 13:48:07 -0400 |
| commit | fade84f8b5b781d29daad40699d07928dedea550 (patch) | |
| tree | e4156b3d0a6a1c794c90ef6834b949321cdfb5cb /docs/VERSION_UPGRADE.md | |
| parent | c587eac377c1c5b720142edadebaace5cb1b17c0 (diff) | |
| download | open-iov-fade84f8b5b781d29daad40699d07928dedea550.tar.gz open-iov-fade84f8b5b781d29daad40699d07928dedea550.zip | |
docs: merge the legacy flat documents, add the CUDA deep-dive and link checks
* Merge and remove the pre-reboot flat documents, preserving their still-useful
material in the structured tree: debugging workflows and the EPT-livelock
case study (05-operations/02), performance microbenchmarks and A/B
methodology (05-operations/01), the version-upgrade runbook
(05-operations/02 section 4, with corrected host/guest framing), kernel-code
pitfalls (07-developers) and the OpenRM build/load order
(03-architecture/06 section 7). The remaining legacy files were verified
redundant and removed.
* docs/README now records where each migrated topic lives.
* Portability: the config YAML files are called out as design targets that no
code reads yet, with what adding support actually requires today.
* Getting started: the OpenRM step is marked optional (native vGPU-management
workflows only; the emulated path uses the distro driver).
* tools docs: rmtool/rmtop marked as planned, pointing at the implemented
tools/rmq subset.
* wiki: new CUDA-Userspace-Driver deep-dive page (public-safe, links the
canonical userspace/cuda analysis) and index update.
* scripts/check-docs-links.py plus a CI step so relative links cannot rot.
* STATE.md references to removed documents repointed.
Diffstat (limited to 'docs/VERSION_UPGRADE.md')
| -rw-r--r-- | docs/VERSION_UPGRADE.md | 144 |
1 files changed, 0 insertions, 144 deletions
diff --git a/docs/VERSION_UPGRADE.md b/docs/VERSION_UPGRADE.md deleted file mode 100644 index 3fc5de4..0000000 --- a/docs/VERSION_UPGRADE.md +++ /dev/null @@ -1,144 +0,0 @@ -# Open-IOV Version Upgrade Guide - -> **Status: superseded (historical).** Part of the pre-2026-09-23 docs; kept -> as a record. Current entry point: [docs/README.md](README.md). -> Version-upgrade replacements: -> [06-portability/hardware-software-matrix.md](06-portability/hardware-software-matrix.md) -> and -> [05-operations/02-debugging-and-maintenance-workflows.md](05-operations/02-debugging-and-maintenance-workflows.md). - -> How to support a new NVIDIA driver version (e.g. moving from 570.144 to a -> 610-series release) end-to-end: firmware acquisition → reverse engineering → -> config → host driver → guest validation. The goal is that a version bump is -> **configuration + analysis**, not a rewrite. - ---- - -## 0. Version discipline (read first) - -Four components must stay in lock-step; a mismatch between any two produces -failures that are indistinguishable from emulation bugs: - -``` -guest nvidia driver == host OpenRM nvidia.ko == host GSP firmware == emulation target (decompiled GSP) -``` - -Today that anchor is **570.144** everywhere. When you bump one, you bump all -four. Verify with `docs/DEBUGGING.md` §7 before any deep debugging. - ---- - -## 1. Acquire the new firmware + matching OpenRM tag - -1. Download the Linux x86_64 runfile for the target version: - `https://us.download.nvidia.com/XFree86/Linux-x86_64/<VER>/NVIDIA-Linux-x86_64-<VER>.run` - (the `tesla/` path 404s for consumer releases). -2. Extract the GSP firmware (`gsp_tu10x.bin` / arch-specific) — or fetch the - versioned blob from `linux-firmware.git`: - `nvidia/<VER>/gsp_tu10x.bin`. -3. Extract the `.fwimage` section (host boot image) and record the MD5: - ```bash - objcopy --only-section=.fwimage gsp_tu10x.bin gsp-<VER>.fwimage.bin - md5sum gsp-<VER>.fwimage.bin - ``` -4. Note the matching OpenRM tag at - `github.com/NVIDIA/open-gpu-kernel-modules` (e.g. `570.144`). - -## 2. Lay down versioned directories (never overwrite a working version) - -``` -firmware/<SERIES>-GSP/<VER>/ # e.g. firmware/61X-GSP/610.XX/ - gsp-<VER>.fwimage.bin - decompiled/ # ghidra output lands here -config/versions/<MAJOR>.yaml # e.g. config/versions/610.yaml -``` - -Copy the analysis scripts from the previous version dir -(`firmware/57X-GSP/570.144/*.py`) into the new one — they are script-relative. - -## 3. Reverse-engineer the new firmware (Ghidra headless) - -```bash -cd tools/ghidra -python3 analyze_fwimage.py \ - ../../firmware/<SERIES>-GSP/<VER>/gsp-<VER>.fwimage.bin \ - /tmp/ghidra_project_<VER> "gsp_<VER>" -cd ../../firmware/<SERIES>-GSP/<VER> -python3 analyze_firmware.py gsp-<VER>.fwimage.bin -``` - -What to extract (compare against `wiki/Address-Reference.md` for 570.144W): - -| Artifact | Why it matters | -|----------|----------------| -| Primary RPC dispatcher + jump table | RPC types/subcommands may shift | -| BAR trap / WPR handlers | BAR emulation behavior | -| Entry/boot sequence | GSP boot RPC ordering the guest driver expects | -| Migration tables | migration protocol (if enabled) | -| RPC message layouts | struct changes break the emulator silently | -| Version string/signature | runtime firmware matching | - -Sanity checks: still RV64IMAC? still the same 12 top-level RPC types? new -subcommands? Confidential-computing/TEE additions? - -## 4. Produce the version config - -Update `config/versions/<MAJOR>.yaml` with: -- `version.name/major/minor` and `firmware.gsp_version` -- discovered dispatcher/handler addresses (if tracked in yaml) -- `features` toggles per what the firmware actually has -- `symbols` (the nvidia.ko vGPU VFIO interface — verify against the new - OpenRM tag; renamed exports break the nvidia build) - -## 5. Update the runtime signature database - -`kernel/firmware_analyzer.c` matches firmware by CRC32/SHA256 + patterns. -Add the new entry to `known_signatures[]` (version string, hashes, discovered -addresses). This is what lets one `open-iov-vfio.ko` serve multiple firmware -versions safely. - -## 6. Rebuild host + guest against the new anchor - -1. Point `legacy-patches/nvidia/` at the new OpenRM tag (rebase our delta; verify - `modinfo nvidia.ko | grep depends` still shows `open-iov-vfio`). -2. `./scripts/stack_manager.sh build-all` (kernel → nvidia → userspace). -3. Install the new host firmware to `/lib/firmware/` - (`stack_manager.sh install-firmware`). -4. **Guest**: install the *matching* stock driver in the VM (runfile for the - exact version), replacing the old one. Keep the guest able to boot without - nvidia auto-loading during the swap (temporarily move dkms-built modules - aside — see `docs/DEBUGGING.md`). - -## 7. Validate (same checklist every version) - -Run the full bring-up checklist in `docs/DEBUGGING.md` §5: -module load → mdev → VM boot → guest probe → `nvidia-smi` → teardown -regression → unit test. Then the workload tests (CUDA vectorAdd, graphics). -Only after the checklist is green do performance comparisons -(`docs/PERFORMANCE.md`). - -## 8. Rollback plan - -Keep the previous version's directory + config untouched. Rollback = -`git checkout` the repo tag/commit for the old anchor + reinstall the old -guest driver. Because versions live in parallel directories, the working -setup is never destroyed by a forward attempt. - -## 9. Multi-version testing matrix (target state) - -For each supported anchor version × each supported GPU family -(`config/hardware/*.yaml`), the CI matrix should run the §7 checklist. When -adding a version, extend the matrix rather than replacing the old column — -regressions across versions are the cheapest bugs to catch. - -## 10. Common pitfalls (learned the hard way) - -- **Runfile version drift**: Ubuntu's `nvidia-driver-XXX-open` metapackages - can resolve to a *newer* major (570-open pulled 580). Always check the - candidate version before installing; prefer the exact-version runfile. -- **GSP firmware filename**: guest driver requests `nvidia/<VER>/gsp_tu10x.bin`; - a wrong-version firmware file = probe failure that looks like an emulation bug. -- **Kernel text addresses differ per build**: re-derive Ghidra addresses per - firmware; never carry 570.144 addresses into a 610 config. -- **Symbol renames across OpenRM tags**: `nvidia_vgpu_vfio_*` renames break - the nvidia build with `Unknown symbol` — check `kernel-open` diffs. |
