Skip to content

Conversation

roypat
Copy link
Contributor

@roypat roypat commented Mar 24, 2025

Add a dedicated virtio_config.rs module that is bindgen'd from
virtio_config.h and contains exactly the VIRTIO_F constants. This avoid
the VIRTIO_F constants being redefined across bindgen'd modules for the
block, net and rng devices (or in the case of the balloon device, avoids
one device using another's bindgen module). Since this completely
eliminates all contents from virtio_rng.rs, delete that module.

Note that for some reason, my laptop's virtio_config.h was missing half
the constants, despite upstream 6.8 headers containing them. So I
bindgen'd this file on a .metal where all the constants were present in
the header.

Lastly, there's the question of the vsock modules, which has manually
written bindings in the uapi module, contained in vsock/mod.rs. I
tried autogenerating these, but bindgen chokes on the enum-constants
contained in virtio_vsock.h, so I'm leaving that as-is for now, apart
from deduplicating the VIRTIO_F_* constants.

Signed-off-by: Patrick Roy [email protected]## Changes

...

Reason

...

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

Copy link

codecov bot commented Mar 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.13%. Comparing base (0f3e8b3) to head (ad3fbc2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5110   +/-   ##
=======================================
  Coverage   83.13%   83.13%           
=======================================
  Files         249      249           
  Lines       26937    26937           
=======================================
  Hits        22393    22393           
  Misses       4544     4544           
Flag Coverage Δ
5.10-c5n.metal 83.51% <ø> (+<0.01%) ⬆️
5.10-m5n.metal 83.51% <ø> (+<0.01%) ⬆️
5.10-m6a.metal 82.70% <ø> (ø)
5.10-m6g.metal 79.56% <ø> (ø)
5.10-m6i.metal 83.50% <ø> (ø)
5.10-m7a.metal-48xl 82.70% <ø> (?)
5.10-m7g.metal 79.56% <ø> (ø)
6.1-c5n.metal 83.56% <ø> (+<0.01%) ⬆️
6.1-m5n.metal 83.55% <ø> (-0.01%) ⬇️
6.1-m6a.metal 82.75% <ø> (-0.01%) ⬇️
6.1-m6g.metal 79.56% <ø> (ø)
6.1-m6i.metal 83.55% <ø> (ø)
6.1-m7a.metal-48xl 82.75% <ø> (?)
6.1-m7g.metal 79.56% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@roypat roypat added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Mar 24, 2025
@roypat roypat force-pushed the virtio-gen-cleanup branch from e17dc26 to 8aae298 Compare March 25, 2025 11:18
Add a dedicated virtio_config.rs module that is bindgen'd from
virtio_config.h and contains exactly the VIRTIO_F constants. This avoid
the VIRTIO_F constants being redefined across bindgen'd modules for the
block, net and rng devices (or in the case of the balloon device, avoids
one device using another's bindgen module). Since this completely
eliminates all contents from virtio_rng.rs, delete that module.

Note that for some reason, my laptop's virtio_config.h was missing half
the constants, despite upstream 6.8 headers containing them. So I
bindgen'd this file on a .metal where all the constants were present in
the header.

Lastly, there's the question of the vsock modules, which has manually
written bindings in the uapi module, contained in `vsock/mod.rs`. I
tried autogenerating these, but bindgen chokes on the enum-constants
contained in virtio_vsock.h, so I'm leaving that as-is for now, apart
from deduplicating the VIRTIO_F_* constants.

Signed-off-by: Patrick Roy <[email protected]>
@roypat roypat force-pushed the virtio-gen-cleanup branch from 8aae298 to 9ffead8 Compare March 25, 2025 11:59
@roypat roypat enabled auto-merge (rebase) March 25, 2025 13:17
@roypat roypat merged commit 6b5f4b1 into firecracker-microvm:main Mar 25, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Awaiting review Indicates that a pull request is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants