Use cbindgen via Rust API (backport #14013)
#14139
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
* move cbindgen to Rust build * add include guard * allow cmdline build and compile-time build * write `qiskit.h` to `crates/cext` and use Makefile to correctly move or regenerate the file lazily * try cleaner build setup write header into target/qiskit.h and copy into dist/c/include with Makefile. The cargo build script tracks changes in target/qiskit.h and rebuilds if changed/deleted Not sure if this is the best way but it seems to work :) * try fix build deps, and fix clippy * fix merge artifact this is probably why CI doesn't work, we need to ensure the cdylib is built * include dir creation as dependency (cherry picked from commit 241818b)
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the following people are relevant to this code:
|
Cryoris
approved these changes
Mar 31, 2025
Pull Request Test Coverage Report for Build 14174535970Details
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
We currently generate the header using
cbindgenas command line tool. This works, butcbindgenhas (ok almost all)This PR moves to using the Rust API of
cbindgenand builds the header as part of theqiskit-cextcompilation process. This fixes all the above points. The one down side is that thecbindgen.tomlwas a bit nicer to read IMO, but that's a small price to pay.It would be nice to backport this to
stable/2.0for a smoother build process for users.Details
Makefileis slightly simpler now since we don't need to separately call the command line tool to generate the header file.This is an automatic backport of pull request #14013 done by [Mergify](https://mergify.com).