Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: rename page_size_kib to page_size #4948

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

acsmyth
Copy link

@acsmyth acsmyth commented Dec 6, 2024

Changes

  • update page_size_kib name to the more accurate page_size, since it's actually in bytes, not KiB.
    ...

Reason

Minor API break with the uffd socket, but since it's relatively new, deleting the incorrectly-named field outright seems better than deprecating it / leaving it around.

...

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 Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.07%. Comparing base (1f94a59) to head (b7355b4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4948   +/-   ##
=======================================
  Coverage   84.07%   84.07%           
=======================================
  Files         251      251           
  Lines       28059    28059           
=======================================
  Hits        23592    23592           
  Misses       4467     4467           
Flag Coverage Δ
5.10-c5n.metal 84.65% <100.00%> (ø)
5.10-m5n.metal 84.63% <100.00%> (-0.01%) ⬇️
5.10-m6a.metal 83.93% <100.00%> (-0.01%) ⬇️
5.10-m6g.metal 80.74% <100.00%> (ø)
5.10-m6i.metal 84.62% <100.00%> (-0.01%) ⬇️
5.10-m7g.metal 80.74% <100.00%> (ø)
6.1-c5n.metal 84.65% <100.00%> (ø)
6.1-m5n.metal 84.63% <100.00%> (-0.01%) ⬇️
6.1-m6a.metal 83.94% <100.00%> (+<0.01%) ⬆️
6.1-m6g.metal 80.74% <100.00%> (ø)
6.1-m6i.metal 84.62% <100.00%> (ø)
6.1-m7g.metal 80.74% <100.00%> (ø)

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.

Comment on lines +54 to +55
kernel_page_size = int(stdout.split()[1])
assert kernel_page_size > 4096
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this intended? the smaps file does report this value in kB:

KernelPageSize:        4 kB

I think this should be left as-is.

Copy link
Contributor

Choose a reason for hiding this comment

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

Other than that, it looks good to me. Thanks for your contribution! :)

@roypat
Copy link
Contributor

roypat commented Dec 13, 2024

Hi @acsmyth,
thanks for catching this! The team's discussed this, and we agreed that although huge pages support is somewhat new, this would still be a breaking change, and so there should be some sort of transition period for users of Firecracker. So for that reason, I think we should just carry two fields for a while (e.g. both page_size and page_size_kib with the broken semantics). That being said, I think most of your PR can go through unchanged, we'll only need to readd page_size_kib to GuestRegionUffdMapping and set it to the same value as page_size in create_guest_memory. We'd also need to add something to DEPRECATED.md warning that we'll remove page_size_kib in an upcoming version.

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