firecracker icon indicating copy to clipboard operation
firecracker copied to clipboard

Move part of `utils` into `vmm`

Open ShadowCurse opened this issue 1 year ago • 1 comments

Changes

  • Move vmm related parts of utils into vmm.
  • Remove reexport of vmm_sys_utils

Reason

utils crate contained a bunch of helper functions/structs, but most of them were only used by vmm crate, so the coupling between these 2 crates was very high. This created an issue where if we want to add some utility function/struct to use in vmm, we need to add it instead to the utils crate, because vmm by itself does not have utils module. (not including utilities which only contain testing code). By moving part of utils into vmm/utils we remove vmm dependency on utils and make it easier to add/modify utility functions/structs in vmm. Additionally we can remove reexporting of vmm_sys_utils from both utils and vmm/utils. This helps with core readability as now there is only 1 place to import vmm_sys_utils items from: the vmm_sys_utils crate itself.

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

  • [ ] If a specific issue led to this PR, this PR closes the issue.
  • [ ] The description of changes is clear and encompassing.
  • [ ] Any required documentation changes (code and docs) are included in this PR.
  • [ ] API changes follow the Runbook for Firecracker API changes.
  • [ ] User-facing changes are mentioned in CHANGELOG.md.
  • [ ] All added/changed functionality is tested.
  • [ ] New TODOs link to an issue.
  • [ ] Commits meet contribution quality standards.

  • [ ] This functionality cannot be added in rust-vmm.

ShadowCurse avatar Aug 14 '24 09:08 ShadowCurse

Codecov Report

Attention: Patch coverage is 76.19048% with 10 lines in your changes missing coverage. Please review.

Project coverage is 84.35%. Comparing base (c86a562) to head (33e07b9). Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
src/vmm/src/utils/mod.rs 73.33% 4 Missing :warning:
src/jailer/src/env.rs 0.00% 3 Missing :warning:
src/jailer/src/main.rs 0.00% 2 Missing :warning:
src/vmm/src/rpc_interface.rs 80.00% 1 Missing :warning:
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4730   +/-   ##
=======================================
  Coverage   84.34%   84.35%           
=======================================
  Files         249      249           
  Lines       27512    27504    -8     
=======================================
- Hits        23206    23200    -6     
+ Misses       4306     4304    -2     
Flag Coverage Δ
5.10-c5n.metal 84.57% <76.19%> (-0.01%) :arrow_down:
5.10-m5n.metal 84.55% <76.19%> (-0.01%) :arrow_down:
5.10-m6a.metal 83.84% <76.19%> (-0.01%) :arrow_down:
5.10-m6g.metal 80.93% <76.19%> (-0.01%) :arrow_down:
5.10-m6i.metal 84.54% <76.19%> (-0.01%) :arrow_down:
5.10-m7g.metal 80.93% <76.19%> (-0.01%) :arrow_down:
6.1-c5n.metal 84.57% <76.19%> (?)
6.1-m5n.metal 84.55% <76.19%> (?)
6.1-m6a.metal 83.84% <76.19%> (?)
6.1-m6g.metal 80.93% <76.19%> (?)
6.1-m6i.metal 84.55% <76.19%> (?)
6.1-m7g.metal 80.93% <76.19%> (?)

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 16 '24 10:08 codecov[bot]