Add structure for multiple Rust crates (Qiskit#9742)

* Add structure for multiplie Rust extension crates This is a precursor to adding an entirely separate and self-contained crate to handle parsing of OpenQASM 2 (not 3 - this is kind of like a trial run for that). It could conceivably still live within `qiskit._accelerate`, but having separate crates helps us enforce more sane API barriers, and has improvements in the incremental build time when working on only one of the Rust extensions. The intent after this commit is still to have `qiskit._accelerate` as an easy catch-all for accelerators for Python. Developers should not need to be concerned with defining a new crate for every new feature, and for the most part `_accelerate` is still logically interoperative within itself (for example, `NLayout` is used all over). This is just laying out the groundwork so more complex crate additions _can_ also be made. Some of the niceties to do with Cargo workspaces only became stabilised in Rust 1.64. In particular, inheritance from the workspace root for things like the package version, Rust version, and dependencies only came in then. For now, the `workspace.packages` key in the root `Cargo.toml` is ignored with a small warning during the build, but I've put it in place mostly to keep track of what we can change once the MSRV becomes 1.64 or greater (likely not til at least Terra 0.26). * Add README.md to crates/accelerate * Correct licence metadata
king-p3nguin · May 22, 2023 · c4dd0e7 · c4dd0e7
1 parent a468f52
commit c4dd0e7
Show file tree

Hide file tree

Showing 28 changed files with 119 additions and 83 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -45,8 +45,8 @@ jobs:
           stestr run
           # We set the --source-dir to '.' because we want all paths to appear relative to the repo
           # root (we need to combine them with the Python ones), but we only care about `grcov`
-          # keeping the `src/*` files; we don't care about coverage in dependencies.
-          grcov . --binary-path target/debug/ --source-dir . --output-type lcov --output-path rust.info --llvm --branch --parallel --keep-only 'src/*'
+          # keeping the `crates/*` files; we don't care about coverage in dependencies.
+          grcov . --binary-path target/debug/ --source-dir . --output-type lcov --output-path rust.info --llvm --branch --parallel --keep-only 'crates/*'
         env:
           QISKIT_TEST_CAPTURE_STREAMS: 1
           QISKIT_PARALLEL: FALSE

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,42 +1,14 @@
-[package]
-name = "qiskit-terra"
+[workspace]
+members = ["crates/*"]
+
+# This has no meaning until we're on Rust 1.64, but once we get there, the subpackages will be able
+# to inherit from this rather than needing to duplicate its content themselves.  Until we get there,
+# keep this in sync with each subpackage `Cargo.toml`'s `package` key.
+[workspace.package]
 version = "0.24.0"
 edition = "2021"
-# Keep in sync with README.md and rust-toolchain.toml.
-rust-version = "1.61"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[lib]
-name = "qiskit_accelerate"
-crate-type = ["cdylib"]
-
-[dependencies]
-rayon = "1.7"
-numpy = "0.18.0"
-rand = "0.8"
-rand_pcg = "0.3"
-rand_distr = "0.4.3"
-ahash = "0.8.3"
-num-complex = "0.4"
-num-bigint = "0.4"
-rustworkx-core = "0.12"
-
-[dependencies.pyo3]
-version = "0.18.1"
-features = ["extension-module", "hashbrown", "num-complex", "num-bigint", "indexmap"]
-
-[dependencies.ndarray]
-version = "^0.15.6"
-features = ["rayon"]
-
-[dependencies.hashbrown]
-version = "0.13.2"
-features = ["rayon"]
-
-[dependencies.indexmap]
-version = "1.9"
-features = ["rayon"]
+rust-version = "1.61"  # Keep in sync with README.md and rust-toolchain.toml.
+license = "Apache-2.0"
 
 [profile.release]
 lto = 'fat'

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -18,4 +18,4 @@ include test/python/notebooks/*.ipynb
 
 include Cargo.toml
 include Cargo.lock
-recursive-include src *
+recursive-include crates *
diff --git a/crates/accelerate/Cargo.toml b/crates/accelerate/Cargo.toml
@@ -0,0 +1,41 @@
+[package]
+name = "qiskit_accelerate"
+# The following options can be inherited with (e.g.) `version.workspace = true` once we hit Rust
+# 1.64.  Until then, keep in sync with the root `Cargo.toml`.
+version = "0.24.0"
+edition = "2021"
+rust-version = "1.61"
+license = "Apache-2.0"
+
+[lib]
+name = "qiskit_accelerate"
+crate-type = ["cdylib"]
+
+[dependencies]
+rayon = "1.7"
+numpy = "0.18.0"
+rand = "0.8"
+rand_pcg = "0.3"
+rand_distr = "0.4.3"
+ahash = "0.8.3"
+num-complex = "0.4"
+num-bigint = "0.4"
+rustworkx-core = "0.12"
+
+# The base version of PyO3 and setting a minimum feature set (e.g. probably just 'extension-module')
+# can be done in the workspace and inherited once we hit Rust 1.64.
+[dependencies.pyo3]
+version = "0.18.1"
+features = ["extension-module", "hashbrown", "indexmap", "num-complex", "num-bigint"]
+
+[dependencies.ndarray]
+version = "^0.15.6"
+features = ["rayon"]
+
+[dependencies.hashbrown]
+version = "0.13.2"
+features = ["rayon"]
+
+[dependencies.indexmap]
+version = "1.9"
+features = ["rayon"]
diff --git a/crates/accelerate/README.md b/crates/accelerate/README.md
@@ -0,0 +1,21 @@
+# `qiskit._accelerate`
+
+This crate provides a bits-and-pieces Python extension module for small, self-contained functions
+that are used by the main Python-space components to accelerate certain tasks.  If you're trying to
+speed up one particular Python function by replacing its innards with a Rust one, this is the best
+place to put the code.  This is _usually_ the right place to put Rust/Python interfacing code.
+
+The crate is made accessible as a private submodule, `qiskit._accelerate`.  There are submodules
+within that (largely matching the structure of the Rust code) mostly for grouping similar functions.
+
+Some examples of when it might be more appropriate to start a new crate instead of using the
+ready-made solution of `qiskit._accelerate`:
+
+* The feature you are developing will have a large amount of domain-specific Rust code and is a
+  large self-contained module.  If it reasonably works in a single Rust file, you probably just want
+  to put it here.
+
+* The Rust code is for re-use within other Qiskit crates and maintainability of the code will be
+  helped by using the crate system to provide API boundaries between the different sections.
+
+* You want to start writing your own procedural macros.
diff --git a/src/dense_layout.rs → crates/accelerate/src/dense_layout.rs b/src/dense_layout.rs → crates/accelerate/src/dense_layout.rs
diff --git a/src/edge_collections.rs → crates/accelerate/src/edge_collections.rs b/src/edge_collections.rs → crates/accelerate/src/edge_collections.rs
diff --git a/src/error_map.rs → crates/accelerate/src/error_map.rs b/src/error_map.rs → crates/accelerate/src/error_map.rs
diff --git a/src/euler_one_qubit_decomposer.rs → ...elerate/src/euler_one_qubit_decomposer.rs b/src/euler_one_qubit_decomposer.rs → ...elerate/src/euler_one_qubit_decomposer.rs
diff --git a/src/lib.rs → crates/accelerate/src/lib.rs b/src/lib.rs → crates/accelerate/src/lib.rs
diff --git a/src/nlayout.rs → crates/accelerate/src/nlayout.rs b/src/nlayout.rs → crates/accelerate/src/nlayout.rs
diff --git a/src/optimize_1q_gates.rs → crates/accelerate/src/optimize_1q_gates.rs b/src/optimize_1q_gates.rs → crates/accelerate/src/optimize_1q_gates.rs
diff --git a/src/pauli_exp_val.rs → crates/accelerate/src/pauli_exp_val.rs b/src/pauli_exp_val.rs → crates/accelerate/src/pauli_exp_val.rs
diff --git a/src/results/converters.rs → crates/accelerate/src/results/converters.rs b/src/results/converters.rs → crates/accelerate/src/results/converters.rs
diff --git a/src/results/marginalization.rs → ...accelerate/src/results/marginalization.rs b/src/results/marginalization.rs → ...accelerate/src/results/marginalization.rs
diff --git a/src/results/mod.rs → crates/accelerate/src/results/mod.rs b/src/results/mod.rs → crates/accelerate/src/results/mod.rs
diff --git a/src/sabre_layout.rs → crates/accelerate/src/sabre_layout.rs b/src/sabre_layout.rs → crates/accelerate/src/sabre_layout.rs
diff --git a/src/sabre_swap/layer.rs → crates/accelerate/src/sabre_swap/layer.rs b/src/sabre_swap/layer.rs → crates/accelerate/src/sabre_swap/layer.rs
diff --git a/src/sabre_swap/mod.rs → crates/accelerate/src/sabre_swap/mod.rs b/src/sabre_swap/mod.rs → crates/accelerate/src/sabre_swap/mod.rs
diff --git a/src/sabre_swap/neighbor_table.rs → ...celerate/src/sabre_swap/neighbor_table.rs b/src/sabre_swap/neighbor_table.rs → ...celerate/src/sabre_swap/neighbor_table.rs
diff --git a/src/sabre_swap/sabre_dag.rs → ...es/accelerate/src/sabre_swap/sabre_dag.rs b/src/sabre_swap/sabre_dag.rs → ...es/accelerate/src/sabre_swap/sabre_dag.rs
diff --git a/src/sabre_swap/swap_map.rs → crates/accelerate/src/sabre_swap/swap_map.rs b/src/sabre_swap/swap_map.rs → crates/accelerate/src/sabre_swap/swap_map.rs
diff --git a/src/sampled_exp_val.rs → crates/accelerate/src/sampled_exp_val.rs b/src/sampled_exp_val.rs → crates/accelerate/src/sampled_exp_val.rs
diff --git a/src/sparse_pauli_op.rs → crates/accelerate/src/sparse_pauli_op.rs b/src/sparse_pauli_op.rs → crates/accelerate/src/sparse_pauli_op.rs
diff --git a/src/stochastic_swap.rs → crates/accelerate/src/stochastic_swap.rs b/src/stochastic_swap.rs → crates/accelerate/src/stochastic_swap.rs
diff --git a/src/vf2_layout.rs → crates/accelerate/src/vf2_layout.rs b/src/vf2_layout.rs → crates/accelerate/src/vf2_layout.rs
diff --git a/setup.py b/setup.py
@@ -99,7 +99,9 @@
         "Documentation": "https://qiskit.org/documentation/",
         "Source Code": "https://github.com/Qiskit/qiskit-terra",
     },
-    rust_extensions=[RustExtension("qiskit._accelerate", "Cargo.toml", binding=Binding.PyO3)],
+    rust_extensions=[
+        RustExtension("qiskit._accelerate", "crates/accelerate/Cargo.toml", binding=Binding.PyO3)
+    ],
     zip_safe=False,
     entry_points={
         "qiskit.unitary_synthesis": [