Update bindings to v2024.4.0 #144
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This consists of using intel#142: ``` $ cargo xtask update 2024.4.0 $ cargo xtask codegen $ cargo test ``` The follow-on commits resolve the errors introduced by this update.
This change is an effort avoid missing new enum variants if they are added to OpenVINO's C headers. As it stands now, new variants could be missed until runtime, when the enum code can't be parsed and the library panics. Instead, this change generates a Rust `enum` for each C `enum` so that missing variants become a compile time error; if we update the bindings but don't handle these, we see a compile-time error.
The `openvino` crate depended on the previous constants generated by `bindgen`. This change uses the new Rust `enum`s instead, creating `From` and `Into` implementations to go between the Rust and C versions. Why not just pass through the `openvino_sys` enum as-is? The only real issue currently is documentation: the C headers start documentation with `<!` which seems a bit weird. I've also fixed up a few grammar problems in the documentation. But one day we may indeed be able to just reuse these types.
It wasn't clear to me why the function and the struct were kept in different places so I moved them together. I also added a `Version::parts` function.
Any test using `ElementType::U8` will cause problems when run on older versions of the library. This change manually ignores tests that depend on this by detecting the library version. For `Tensor`'s doc test, I chose to use a type not affected by the breaking change to keep things consistent.
See b2bdfb0 for the rationale for this.
rahulchaphalkar
approved these changes
Oct 9, 2024
| let mut parts = version.parts(); | ||
| let year: usize = parts.next().unwrap().parse().unwrap(); | ||
| let minor: usize = parts.next().unwrap().parse().unwrap(); | ||
| year <= 2024 || (year == 2024 && minor < 2) |
There was a problem hiding this comment.
@abrown Realized this half hour too late - this needs to be year < 2024 ||, was testing new version again and it skipped this test for 2024.4.
There was a problem hiding this comment.
Ugh, yeah, that's right. I'll fix it.
abrown
added a commit
to abrown/openvino-rs
that referenced
this pull request
Oct 9, 2024
@rahulchaphalkar pointed out that the first part of this check should filter out pre-2024 releases; fixes an issue in intel#144.
rahulchaphalkar
pushed a commit
that referenced
this pull request
Oct 9, 2024
@rahulchaphalkar pointed out that the first part of this check should filter out pre-2024 releases; fixes an issue in #144.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This uses #142 (not included here) to update the OpenVINO C headers to their latest version and generate Rust bindings for them. While doing this I discovered #143, which results in a breaking change to the bindings; since the
ov_element_type_evariants now have different values, users get wrong byte sizes (and out-of-bounds access to tensor memory viaTensor::get_*) if using these bindings with an implementation of OpenVINO older than 2024.2.0.Along the way, this fixes up how we generate C enums, now as Rust enums in order to see compile-time errors when new variants are introduced. The majority of the changes are due to propagating this change throughout the crates.
Closes #143, closes #20.