igvm: move VMSA & other arch-only definitions outside of crate
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- rust
- Domain
- operating-systems
Research direction
Start by reading the initial discussion in #109 and auditing the VMSA and other architecture-specific definitions in the igvm and igvm_defs crates. Identify which raw fields IGVM needs, including possible sev_features data and IntoBytes/FromBytes handling; done means the unnecessary hardware definitions are no longer authoritative crate definitions.
Written by the indexing model from the issue text.
Description
Architectural definitions should not live in this crate unless they're necessary, to avoid needing to update them as new hardware/capabilities arrive. For the most part, only the raw binary data is needed. This applies to VMSA and potentially other things inside this crate.
Jon and I discussed this offline that I think it might make more sense to move away from defining some of these architectural definitions in the igvm and igvm_defs crate themselves, and defer to just being an opaque type outside of bits we need within IGVM itself. For example, we think that we might need sev_features for some CoRIM validation in the future, but we'd mark the rest of the fields as reserved, and leave it as convertible to a 4K u8 slice via IntoBytes/FromBytes.I think this would apply to quite a few things in this crate so I need to sit down and find some time to refactor this, but would mean every time hardware changes/adds a new feature, we're not required to add all these definitions because IGVM shouldn't be the authoritative definition for specific hardware.
This does mean consumers of this crate will need to carry their own definition of hardware specific fields, but I think that's fine. I wonder if we should have a snp_defs crate in this case that consumers can use?
Thoughts?
See #109 for initial discussion.
- Dominant language
- Rust
- Stars
- 155
- Forks
- 42
- Avg merge
- 1h 58m
- Merged PRs (30d)
- 2
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/igvm
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Memory Map SemanticsOpen
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
discover: `sudo RTK_DISABLED=$VAR …` is not detected as a bypass when `sudo` is a transparent prefixOpenarea:cli bug good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
skill:code-review
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
component:sight
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
agentic-os-org/ANOLISA#4115 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
rivet-dev/rivet#5819 · 1 comment ·
Maintainers usually reply within 1 day
-
A-io-database bug needs triage python
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day