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

tool: add cargo xflowey custom-vmfirmwareigvm-dll #291

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

daprilik
Copy link
Contributor

To quote the tool's CLI help:

Encapsulate an existing pre-built IGVM file into unsigned
vmfirmwareigvm.dll resource DLL.

Unlike build-igvm, this tool will NOT build OpenHCL from scratch. This
tool streamlines the process of building the in-tree vmfirmwareigvm_dll
crate (which requires setting various env vars, installing certain
dependencies, etc...).

NOTE: This tool is primarily intended for use by Microsoft employees, as
open-source deployments of OpenHCL typically load the IGVM file directly
(rather than being encapsulated in a resource-DLL).

Unfortunately, I still don't quite know what magic is required to properly cross-compile the vmfirmwareigvm_dll crate from WSL2 / Linux, as the dependency on rc.exe makes things a bit more complicated than the typical windows cross-compile case. In the meantime, I've added some checks to ensure folks are only running this tool on native windows.

@daprilik daprilik requested a review from a team as a code owner November 11, 2024 22:43
Copy link
Contributor Author

Choose a reason for hiding this comment

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

note: this is just a drive-by cleanup

@mattkur
Copy link
Contributor

mattkur commented Nov 12, 2024

Thanks for this! Would you add usage instructions to the guide?

@daprilik
Copy link
Contributor Author

Thanks for this! Would you add usage instructions to the guide?

Given that this is a Microsoft-employee oriented tool, I'm inclined to say that the documentation in the CLI is sufficient in the context of open-source. That said, I'll send out a PR which updates our Microsoft-internal guide to include a pointer to this new tool, as well as some extra docs on how to actually use the DLL internally.

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.

4 participants