Skip to content

Document portable network device ABI - #515

Merged
Pedro Henrique Penna (ppenna) merged 1 commit into
devfrom
docs/network-device-abi
Oct 13, 2026
Merged

Pedro Henrique Penna (ppenna) merged 1 commit into
devfrom
docs/network-device-abi

Conversation

@ppenna

Copy link
Copy Markdown
Contributor

Summary

This makes the portable networking contract and host/guest boundary explicit across KVM, MSHV, and WHP.

  • document the virtio-net and Consomme architecture, fixed device setup, and static dual-stack guest bootstrap
  • describe packet forwarding, egress policy precedence and enforcement, host-local access, explicit port forwarding, and DNS proxy behavior
  • define bounded flow and DNS state plus snapshot and restore guarantees

Validation

  • git diff --cached --check (before commit)
  • Documentation-only change; no runtime tests run

Expand the machine and device ABI specification so the portable networking contract is explicit across KVM, MSHV, and WHP.

Describe the virtio-net and Consomme architecture, static dual-stack guest bootstrap, packet forwarding path, host-local access, explicit ingress forwarding, and DNS proxy behavior.

Define egress rule precedence and enforcement boundaries, bounded flow and DNS state, and snapshot and restore guarantees, including state that is deliberately not serialized.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 12, 2026 19:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documented behavior aligns with the pinned OpenVMM implementation, including pre-listener enforcement of the 64-forward limit.

0 open findings

What changed in this PR

Documents the portable network ABI across KVM, MSHV, and WHP.

Changes:

  • Defines networking architecture, addressing, forwarding, and policy enforcement.
  • Documents host-local access, DNS proxying, bounded state, and snapshot behavior.
File Description
doc/​design/​machine-and-device-abi.md Expands the portable networking contract and host/guest boundary.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@ppenna
Pedro Henrique Penna (ppenna) merged commit 29294aa into dev Oct 13, 2026
28 checks passed
@ppenna
Pedro Henrique Penna (ppenna) deleted the docs/network-device-abi branch October 13, 2026 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants