Repository navigation
Description
Summary
The microVM defines four sandbox block roles: distro, runtime, custom, and scratch. Nothing produces or attaches a runtime or custom layer. Remove both roles, so sandbox storage has a read-only distro layer and writable scratch.
Why
- No producer.
build-distro-layerbuilds only the Ubuntudistrolayer, and the converter that would split images intodistro,runtime, andcustomis still proposed ("Image conversion" inremaining-production-work.md, which doc: replace doc/design with an architecture-only design guide #529 removed). - No consumer. CI, the sandbox lifecycle and managed-exec tests, the snapshot scenarios, and every documentation example attach only
distroandscratch.nvx-rsandaci_edge_sandboxesattach no sandbox blocks; they use the blockless managed root. - No end-to-end coverage. Outside unit tests, only the
sandbox-blocksscenario attaches the two roles, as zero-filled raw images; it checks discovery tokens and read-only flags without mounting anything. No test mounts more than one EROFS lower layer, or captures and restores a snapshot with more than one. - Unused ABI surface. The roles cost two virtio-mmio slots, two IRQs, and two shared-status words, plus the matching paths in the snapshot contract and the guest agent.
Where the roles live
OpenVMM (openvmm/ submodule; paths relative to it):
openvmm/openvmm_defs/src/microvm.rs:MicrovmSandboxBlockRole::{Runtime, Custom}, the slots at0xd0004000(IRQ 12) and0xd0005000(IRQ 9), shared-status offsets0x10and0x14,validate_microvm_sandbox_blocks("at most three read-only layers"), and tests.openvmm/openvmm_entry/src/cli_args/microvm.rs:--microvm-sandbox-blockrole parsing and the four-block limit.openvmm/openvmm_helpers/src/snapshot/microvm.rsandopenvmm/openvmm_entry/src/vm_controller/microvm.rs: manifest role names and the "one to three layers and scratch" capture rule.Guide/src/user_guide/openvmm/run.mdandGuide/src/reference/openvmm/management/cli.md.
NVX:
guest/common/nvx-init-agent: theruntimeandcustommounts, the three-layer limit, and thelowerdirstacking.scripts/nvx_tools/sandbox.py:LAYER_ROLESand the role addresses.scripts/nvx_tools/microvm_tests.pyandscripts/nvx_tools/microvm_test_scripts/sandbox-blocks.sh: thesandbox-blocksscenario.scripts/test_nvx_tools.py:test_launch_contract_orders_roles_and_builds_agent_command_line.doc/usage.mdanddoc/run.md.
Decisions
- Address layout. Keep
scratch(0xd0006000, IRQ 11, status word0x30018) and the control console where they are, and leave the freed windows, IRQs 9 and 12, and status words0x30010and0x30014unused. Fixed placement means an omitted device never shifts another; compacting would movescratchand the control console and change every machine contract. The architecture guide in doc: replace doc/design with an architecture-only design guide #529 documents this layout. - Existing snapshots. Restore maps manifest role names to the enum, so a snapshot that records
runtimeorcustomwould fail with the existing unsupported-role error. Confirm that no retained snapshot or template uses these roles. - Image model. The image preparation proposal, which doc: replace doc/design with an architecture-only design guide #529 removed, split curated images into
distro,runtime, andcustomfor cache reuse. Decide whether the converter flattens each image into onedistrolayer, or whether layering returns together with the converter.
Tasks
- OpenVMM: remove the
RuntimeandCustomroles, slots, IRQs, and status words from the CLI, the machine contract, snapshot capture and restore, and the tests; update the Guide. - NVX: promote the OpenVMM pin.
- Guest agent: accept only the
distrolayer and drop thelowerdirstacking. -
nvx.py sandbox: accept only--layer distro,.... - Tests: attach only
distroandscratchinsandbox-blocks, check that the freed slots are absent, and update the unit tests. - Docs: update
doc/usage.mdanddoc/run.md. The architecture guide indoc/design/already describes onlydistroandscratch.
Metadata
Metadata
Assignees
Labels
No labels
Activity
doc: add an architecture-only design guide in doc/design-doc
nvx-rs: accept only the distro layer and the scratch disk
nvx-rs: accept only the distro layer and the scratch disk
nvx-rs: accept only the distro layer and the scratch disk
nvx-rs: accept only the distro layer and the scratch disk
nvx-rs: accept only the distro layer and the scratch disk
nvx-rs: accept only the distro layer and the scratch disk
kernel: map shared status only for the six virtio-mmio slots
doc: describe the sandbox scripts' single distro layer
openvmm: remove the runtime and custom sandbox block roles
doc: map the removal of the runtime and custom roles in the OpenVMM r…
nvx-rs: refuse the runtime and custom layers in the fake OpenVMM
kernel: map shared status only for the six virtio-mmio slots
doc: describe the sandbox scripts' single distro layer
microVM: remove the runtime and custom sandbox block roles