Crates for Microsoft Hypervisor ioctls and bindings
License: Apache License 2.0
Microsoft Hypervisor wrappers. This repository provides two crates which are mshv-bindings and mshv-ioctls. These crates will provide the APIs and definitions to create a VMM on Microsoft Hypervisor along with other rust-vmm crates.
The mshv-{ioctls, bindings} can be used on x86_64 only.
cargo buildTest (/dev/mshv requires root):
sudo -E ~/.cargo/bin/cargo test
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
Right now the run function of vcpu requires the caller to pass in a buffer.
That buffer is zeroed before given to run. That's wasteful. And then there are two moves for that buffer, one from caller to callee and the other is from callee to caller. Figure out a better API.
I don't want run to take MaybeUninit<hv_message> though. If anything the buffer can be part of vcpu. We will still have one move
(copy) operation when we give it back to the caller.
In the latest scripts/generate_binding.py, we know we need the following files in Linux kernel source code to generate the bindings.
I am confused because I cannot find these files in the latest mainline Linux kernel source code. So, I need some help.
Kenji Mouri
Currently there is no unified way to produce mshv-bindings/src/bindings.rs. Given the file must be generated some times and some customizations are already applied there, there should be scirpt checked in to unify the dev work on this piece.
Is this crate usable outside of Microsoft, or do licensing restrictions on the hypervisor make it unusable?
These crates are still using the Rust 2018 edition. When we have cycles to spare we can move to the 2021 edition. Hopefully it is a straightforward change.
This issue is for tracking the progress on creating an Internal CI at Microsoft so that can be invoked in every PR to validate the changes.
The licensing part of Microsoft Hypervisor is still in progress and that is the reason for creating the CI at Microsoft.
We need to make sure the following conditions are met.
It would be very helpful, and allow us to reduce the amount of unsafe code we have, if more structs could derive AsBytes and FromBytes, specifically those in https://github.com/rust-vmm/mshv/blob/main/mshv-bindings/src/bindings.rs and https://github.com/rust-vmm/mshv/blob/main/mshv-bindings/src/regs.rs.
Unit tests are missing for all the SEV-SNP related IOCTLs
marvin:~/src/cloud-hypervisor (main)$ cargo report future-incompatibilities --id 4
The following warnings were discovered during the build. These warnings are an
indication that the packages contain code that will become an error in a
future release of Rust. These warnings typically cover changes to close
soundness problems, unintended or undocumented behavior, or critical problems
that cannot be fixed in a backwards-compatible fashion, and are not expected
to be in wide use.
Each warning should contain a link for more information on what the warning
means and how to resolve it.
To solve this problem, you can try the following approaches:
- If the issue is not solved by updating the dependencies, a fix has to be
implemented by those dependencies. You can help with that by notifying the
maintainers of this problem (e.g. by creating a bug report) or by proposing a
fix to the maintainers (e.g. by creating a pull request):
- [email protected]
- Repository: <not found>
- Detailed warning command: `cargo report future-incompatibilities --id 4 --package [email protected]`
- If waiting for an upstream fix is not an option, you can use the `[patch]`
section in `Cargo.toml` to use your own version of the dependency. For more
information, see:
https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
The package `mshv-bindings v0.1.1 (https://github.com/rust-vmm/mshv?branch=main#bf854308)` currently triggers the following future incompatibility lints:
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:17:13
> |
> 17 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:31:13
> |
> 31 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:43:13
> |
> 43 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:55:13
> |
> 55 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:67:13
> |
> 67 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:79:13
> |
> 79 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:93:13
> |
> 93 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:107:13
> |
> 107 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:119:13
> |
> 119 | self.u.payload.as_ptr() as *const [u8; std::mem::size_of::<hv_x64_apic_eoi_message>()]
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:130:13
> |
> 130 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
> warning: reference to packed field is unaligned
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:142:13
> |
> 142 | self.u.payload.as_ptr()
> | ^^^^^^^^^^^^^^^^^^^^^^^
> |
> note: the lint level is defined here
> --> /home/rob/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
> |
> 17 | #![allow(unaligned_references)]
> | ^^^^^^^^^^^^^^^^^^^^
> = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
> = note: for more information, see issue #82523 <https://github.com/rust-lang/rust/issues/82523>
> = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
> = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers)
>
The vfio-ioctls depends on these two crates, so they need to be published.
Right now arguments to the bindgen are limited in the script. We should be able to pass the argument more flexible way.
example: ./script//generate_binding.py -k "/blah" -o "blah" [rest of arg to the bindgen directly copied]
I'm using Rust 1.64 and it reports an issue.
Run cargo report future-incompatibilities --id 1 in Cloud Hypervisor build gives the following (only one of several is listed).
warning: reference to packed field is unaligned
--> /home/cloud/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/unmarshal.rs:142:13
|
142 | self.u.payload.as_ptr()
| ^^^^^^^^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> /home/cloud/.cargo/git/checkouts/mshv-cc59226ef45dad4f/bf85430/mshv-bindings/src/lib.rs:17:10
|
17 | #![allow(unaligned_references)]
| ^^^^^^^^^^^^^^^^^^^^
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
= note: for more information, see issue #82523 rust-lang/rust#82523
= note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced)
= help: copy the field contents to a local variable, or replace the reference with a raw pointer and useread_unaligned/write_unaligned(loads and stores via*pmust be properly aligned even when using raw pointers)
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.