Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 45 additions & 10 deletions doc/openvmm-upstream-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
reorganization kept it there; see [Upstream status](#upstream-status).
- Mapped fork tip: `7677ad8d56a59864475012b63b6f01a22575c30d`, position 131. The graph, PR
summary, and commit mapping below cover positions 001-131.
- NVX's pinned OpenVMM revision: `ed8fc0713b4c6301d3b82ffe88817e70084d84b8`, position 229, the
head of microsoft/openvmm#4993, whose commit follows position 228, `d6addf8c1`, the head of
`feature/microvm/dev`, which microsoft/openvmm#4992 merged after position 227, `154548a0e`,
which microsoft/openvmm#4991 merged after position 226, `881619911`, which
- NVX's pinned OpenVMM revision: `98e5b3ca504ea18ffdcc7181e27516f7d7e5a6d7`, position 231, the
head of microsoft/openvmm#4994, whose two commits follow position 229, `ed8fc0713`, the head of
`feature/microvm/dev`, which microsoft/openvmm#4993 merged after position 228, `d6addf8c1`,
which microsoft/openvmm#4992 merged after position 227, `154548a0e`, which
microsoft/openvmm#4991 merged after position 226, `881619911`, which
microsoft/openvmm#4989 merged after position 225, `99aac19b3`, which
microsoft/openvmm#4988 merged after position 224, `adb7c8bc8`, which
microsoft/openvmm#4987 merged after position 223, `90f9e6180`. Positions 221-223, the
Expand All @@ -23,8 +24,8 @@
position 221 into positions 035 and 036, and combined v5.1 positions 222 and 223, the two commits
of microsoft/openvmm#4984, into position 220. Positions 001-147 keep their positions, v5.1
positions 149-220 are positions 148-219, and the tree of position 220 is the tree of
`3f2ab4c2f`; see [The v6.0 reorganization](#the-v60-reorganization). The pin is 98 commits past
the mapped tip on the same first-parent chain. Positions 132-229 are not yet assigned to PRs; see
`3f2ab4c2f`; see [The v6.0 reorganization](#the-v60-reorganization). The pin is 100 commits past
the mapped tip on the same first-parent chain. Positions 132-231 are not yet assigned to PRs; see
[Commits after the mapped tip](#commits-after-the-mapped-tip).
- Upstream main: `ba105dd7f00499acc1862456c179c0930cb2c8f7` (2026-11-06), the fork base itself;
see [Upstream main past the fork base](#upstream-main-past-the-fork-base).
Expand Down Expand Up @@ -263,6 +264,16 @@ successful, and a `Retain` console on a named pipe needs that write handling for
Position 014 stays whole in PR06. If the review of microsoft/openvmm#4609 narrows it as that of
microsoft/openvmm#4605 did, its write handling joins position 041 in PR13.

microsoft/openvmm#4553, upstream's SaveVM and RestoreVM for the management RPC, proposes no chain
commit either. It records a snapshot ID in the manifest's field 18, to which it moved the ID from
field 8, the chain's `state_size_bytes`, after microsoft/nvx#1210 raised the clash, and it reserves
fields 19 and 20 for `compatibility_bundle_digest` and `memory_artifacts`; position 231 keeps those
three fields free. It also changes `write_snapshot` in the snapshot publication of
`openvmm_helpers`, which PR11's positions 031-033 and later chain commits change. A rebase onto it
therefore adds `snapshot_id` to the chain's `SnapshotManifest` and reconciles the publication, and
NVX's pin of that rebase needs `nvx-rs`'s reader of a template's manifest, which refuses fields
that it does not know, to accept field 18.

| Roadmap PR | Positions | Upstream pull requests, in position order |
| --- | ---: | --- |
| PR01 | 002-004 | microsoft/openvmm#4595, microsoft/openvmm#4618, microsoft/openvmm#4615 |
Expand Down Expand Up @@ -971,7 +982,9 @@ ba105dd7f
-> restore listener of a disconnected boot console [227]
-> management RPC with the command line's microVM settings [228]
-> staged manifest removed before a failed capture resumes [229]
-> ed8fc0713 (NVX pin)
-> earlier snapshot formats refused before decoding [230]
-> manifest fields reserved for upstream [231]
-> 98e5b3ca5 (NVX pin)
```

For upstream review, PR01-PR06 and PR14 can be rebased independently onto current upstream main,
Expand All @@ -987,13 +1000,13 @@ reorganization folded the PR20 and PR12 fixups into the commits that they fix; s

## Commits after the mapped tip

The NVX pin extends the chain past position 131 without merges. None of the 98 later commits is a
The NVX pin extends the chain past position 131 without merges. None of the 100 later commits is a
fixup of a mapped PR, and none is yet classified or assigned to PRs. Each of positions 132-186
combines the v2.4 commits that the table lists, as v3.0 positions 145-160 and 162-200 did, which
developed one concept; "(part)" marks a v2.4 fixup that split across commits. Positions 187-191
followed the v3.0 reorganization, positions 192-205 are the ABI restart of the v4.0
reorganization, positions 206-211 followed it, positions 212-218 followed the v5.0
reorganization, positions 219 and 220 followed the v5.1 rebase, and positions 221-229 followed the
reorganization, positions 219 and 220 followed the v5.1 rebase, and positions 221-231 followed the
v6.0 reorganization, so they combine none, apart from position 220, which combines v5.1 positions
222 and 223. Each commit has the position that it
had in v5.1 through position 147, and one less from v5.1 position 149 on; see
Expand Down Expand Up @@ -1100,6 +1113,8 @@ at `e1ca353eb`, whose first 210 commits are those of `feature/microvm/release/v4
| 227 | `154548a0e` | - | - | - | - | microvm: let a restore attach a listener to a disconnected boot console (microsoft/openvmm#4991) |
| 228 | `d6addf8c1` | - | - | - | - | vmservice: carry microVM blocks, network, RAM file, and share policy (microsoft/openvmm#4992) |
| 229 | `ed8fc0713` | - | - | - | - | openvmm_helpers: don't resume beside a restorable staged snapshot (microsoft/openvmm#4993) |
| 230 | `8a994544a` | - | - | - | - | openvmm_helpers: refuse earlier snapshot formats before decoding them (microsoft/openvmm#4994) |
| 231 | `98e5b3ca5` | - | - | - | - | openvmm_helpers: reserve the manifest fields that upstream assigns (microsoft/openvmm#4994) |

The remarks that say whether commits apply to upstream main record what the v3.0 reorganization
found on its base, `b2676222b`, at the positions that the commits have now.
Expand Down Expand Up @@ -1191,7 +1206,16 @@ now removes its manifest first, and a cleanup that cannot prove the manifest gon
033's uncertain outcome, on which the controller of PR17's position 076 terminates the source,
where position 032 let it resume beside a snapshot that restore could open. It also rewords that
outcome's message, the controller's log, and the sentences on a failed publication that position
076 adds to the snapshot and snapshot format guides.
076 adds to the snapshot and snapshot format guides. Position 230 changes the manifest's decoding,
which PR11's position 031 bounds and checks and PR12's position 035 moves to the snapshot directory
that it opens: positions 195 and 205 restarted the manifest at version 2 and numbered its fields
without gaps, which gives some fields of earlier formats other types, so restore now decodes the
version and then the magic, each alone, and refuses any other with `E_SNAPSHOT_VERSION` before it
decodes the rest, and the version and magic checks of position 031's header check become helpers
that both share. It also says why in the manifest section of the snapshot format guide, which
position 195 rewrote. Position 231 adds a comment to the manifest's fields, which position 205
numbers, and a sentence to the snapshot format guide's rule for extending the manifest, that keep
fields 18-20 for upstream's SaveVM and RestoreVM, microsoft/openvmm#4553.
Assigning the later commits therefore means revisiting those PRs, not only appending new ones.

Position 177, by contrast, changes only `disk_blob`, which upstream main and the fork base
Expand Down Expand Up @@ -1378,6 +1402,17 @@ add, and their tests. Replaying it on upstream main conflicts in all four of its
main lacks the controller, the staging of positions 032 and 033, and those sentences, so it follows
PR11 and PR17 upstream.

Positions 230 and 231 change only the snapshot manifest of `openvmm_helpers`, its format checks,
and its restore, which PR11's positions 031 and 032, PR12's position 035, PR17's positions 074 and
076, PR19's positions 092 and 093, and positions 136, 147, 166, 184, 195, 204, 205, and 215 also
change, and the snapshot format guide's sections on the manifest. In those files they change only
the manifest's decoding and header check, which positions 031 and 035 add, and comment on the
fields that position 205 numbers, and they add tests that use the machine contract of PR17's
position 074. Replaying them on upstream main conflicts in all four of their files: upstream main
lacks the format magic and header check of position 031, the restore of position 035, the machine
contract of position 074, and the fields that position 205 numbers, so they follow PR11, PR12, and
PR17 upstream.

## PR summary

Each count is of v6.0 commits, which include the fixups that the v3.0, v4.0, v5.0, and v6.0
Expand Down
6 changes: 4 additions & 2 deletions doc/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -680,8 +680,10 @@ platform snapshot.
OpenVMM's v4 microVM restarted the versions of its contracts: microVM ABI 1,
boot layout 1, time ABI 1, restore packet 1, and snapshot manifest 2, whose
version 1 is upstream OpenVMM's. It reads no snapshot of an earlier OpenVMM,
whose manifest it refuses by its version with `E_SNAPSHOT_VERSION`, and
`nvx-rs` refuses a template of an earlier OpenVMM by its snapshot format.
whose manifest it refuses with `E_SNAPSHOT_VERSION` by its version, or by its
missing format magic for the earliest manifests of version 2, before it
decodes the rest, and `nvx-rs` refuses a template of an earlier OpenVMM by its
snapshot format.
Capture them again; to restore them as they are, use NVX commit
`304f8e1686b4fba188ad2d9c8d932498a6ca2980` with the OpenVMM that it pins.

Expand Down
Loading