Skip to content

Conversation

zulinx86
Copy link
Contributor

@zulinx86 zulinx86 commented Sep 22, 2025

Fixes #5438.

Changes / Reason

The Linux kernel introduced some arch_prctl() APIs (ARCH_GET_XCOMP_SUPP,
ARCH_GET_XCOMP_PERM and ARCH_REQ_XCOMP_PERM) to support dynamic XSTATE
feature enabling for "userspace applications" in 5.16 [1]. To support
that for "KVM guest", v5.17 introduced additional arch_prctl() APIs
(ARCH_GET_XCOMP_GUEST_PERM and ARCH_REQ_XCOMP_GUEST_PERM) [2]. Note that
ARCH_XCOMP_GUEST_SUPP does not exist, so regardless of userspace
application or KVM guest, ARCH_GET_XCOMP_SUPP is used to retrieve
supported features. As a result, kernel versions >= 5.16 and < 5.17
report supported features via ARCH_GET_XCOMP_SUPP but
ARCH_REQ_XCOMP_GUEST_PERM fail with EINVAL.

[1]: https://github.com/torvalds/linux/commit/db8268df0983adc2bb1fb48c9e5f7bfbb5f617f3
[2]: https://github.com/torvalds/linux/commit/980fe2fddcff21937c93532b4597c8ea450346c1

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 checkbuild --all to verify that the PR passes
    build checks on all supported architectures.
  • 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 Sep 22, 2025

Codecov Report

❌ Patch coverage is 55.55556% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.75%. Comparing base (a7356c1) to head (977402c).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
src/vmm/src/arch/x86_64/xstate.rs 55.55% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5447      +/-   ##
==========================================
- Coverage   82.76%   82.75%   -0.02%     
==========================================
  Files         263      263              
  Lines       27300    27307       +7     
==========================================
+ Hits        22594    22597       +3     
- Misses       4706     4710       +4     
Flag Coverage Δ
5.10-m5n.metal 82.93% <33.33%> (-0.02%) ⬇️
5.10-m6a.metal 82.18% <33.33%> (-0.02%) ⬇️
5.10-m6g.metal 79.54% <ø> (ø)
5.10-m6i.metal 82.93% <33.33%> (-0.02%) ⬇️
5.10-m7a.metal-48xl 82.17% <33.33%> (-0.02%) ⬇️
5.10-m7g.metal 79.53% <ø> (-0.01%) ⬇️
5.10-m7i.metal-24xl 82.89% <33.33%> (-0.02%) ⬇️
5.10-m7i.metal-48xl 82.89% <33.33%> (-0.02%) ⬇️
5.10-m8g.metal-24xl 79.53% <ø> (ø)
5.10-m8g.metal-48xl 79.54% <ø> (+<0.01%) ⬆️
6.1-m5n.metal 82.95% <0.00%> (-0.03%) ⬇️
6.1-m6a.metal 82.21% <0.00%> (-0.03%) ⬇️
6.1-m6g.metal 79.53% <ø> (-0.01%) ⬇️
6.1-m6i.metal 82.95% <0.00%> (-0.02%) ⬇️
6.1-m7a.metal-48xl 82.19% <0.00%> (-0.03%) ⬇️
6.1-m7g.metal 79.54% <ø> (ø)
6.1-m7i.metal-24xl 82.96% <22.22%> (-0.02%) ⬇️
6.1-m7i.metal-48xl 82.97% <22.22%> (-0.02%) ⬇️
6.1-m8g.metal-24xl 79.53% <ø> (ø)
6.1-m8g.metal-48xl 79.53% <ø> (ø)

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.

@zulinx86 zulinx86 added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Oct 1, 2025
Manciukic
Manciukic previously approved these changes Oct 1, 2025
@Manciukic
Copy link
Contributor

I think we should add a changelog entry.

It is the kernel commit that actually is needed for ARCH_GET_XCOMP_SUPP.

Signed-off-by: Takahiro Itazuri <[email protected]>
The link would be helpful for people who don't have much context around
that.

Signed-off-by: Takahiro Itazuri <[email protected]>
The Linux kernel introduced some arch_prctl() APIs (ARCH_GET_XCOMP_SUPP,
ARCH_GET_XCOMP_PERM and ARCH_REQ_XCOMP_PERM) to support dynamic XSTATE
feature enabling for "userspace applications" in 5.16 [1]. To support
that for "KVM guest", v5.17 introduced additional arch_prctl() APIs
(ARCH_GET_XCOMP_GUEST_PERM and ARCH_REQ_XCOMP_GUEST_PERM) [2]. Note that
ARCH_XCOMP_GUEST_SUPP does not exist, so regardless of userspace
application or KVM guest, ARCH_GET_XCOMP_SUPP is used to retrieve
supported features. As a result, kernel versions >= 5.16 and < 5.17
report supported features via ARCH_GET_XCOMP_SUPP but
ARCH_REQ_XCOMP_GUEST_PERM fail with EINVAL.

[1]: torvalds/linux@db8268d
[2]: torvalds/linux@980fe2f
Signed-off-by: Takahiro Itazuri <[email protected]>
@zulinx86 zulinx86 merged commit d93f562 into firecracker-microvm:main Oct 2, 2025
6 of 7 checks passed
@zulinx86 zulinx86 deleted the xstate branch October 2, 2025 08:34
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.

[Bug] VM Failing to start on XSTATE check
3 participants