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

add JSON output format to cpuid-gen #832

Merged
merged 9 commits into from
Jan 11, 2025
Merged

Conversation

gjcolombo
Copy link
Contributor

@gjcolombo gjcolombo commented Jan 11, 2025

Add a JSON output format to cpuid-gen, which prints output suitable for inserting into an instance spec that can be fed to propolis-cli.

This is useful for ad hoc testing of hypervisor enlightenments. Enlightenments are exposed through special CPUID leaves in the hypervisor leaf range (0x4000_0000 to 0x4000_FFFF). To expose enlightenments, Propolis thus needs to pass the correct CPUID values to bhyve. However, if Propolis starts setting CPUID values for the hypervisor leaves, it will also need to set them for the standard and extended leaves. This implies that, to enable enlightenments, Propolis's instance-ensure API (or propolis-standalone's VM setup logic) will need a complete set of standard/extended CPUID values to apply. For propolis-server, the easiest way to do this is to use propolis-cli new --spec. The goal of this change is to make it easy to get a CPUID JSON blob to paste into this command's input spec.

While dorking around with this change, I discovered that the propolis-cli new --spec switch was not properly marked as exclusive with the --config-toml switch. Fix that up as well.

Finally, if propolis-server fails to convert an API spec to its internal instance spec type, and the resulting error has a source, print both the error and the source. This allows the display of messages like "leaf 7 is specified both with and without a subleaf" when appropriate.

Tested by booting some ad hoc propolis-server VMs using propolis-cli and the new output from cpuid-gen.

@gjcolombo gjcolombo requested a review from pfmooney January 11, 2025 01:05
@gjcolombo gjcolombo requested a review from pfmooney January 11, 2025 01:31
bin/propolis-utils/src/bin/cpuid-gen.rs Outdated Show resolved Hide resolved
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

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

i had a few very minor suggestions you may find useful, but this looks good to me!

bin/propolis-utils/src/bin/cpuid-gen.rs Outdated Show resolved Hide resolved
bin/propolis-utils/src/bin/cpuid-gen.rs Show resolved Hide resolved
@gjcolombo gjcolombo merged commit 6bad892 into master Jan 11, 2025
11 checks passed
@gjcolombo gjcolombo deleted the gjcolombo/cpuid-gen-json branch January 11, 2025 19:03
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