##// END OF EJS Templates
rust: module policy with importrust...
rust: module policy with importrust We introduce two rust+c module policies and a new `policy.importrust()` that makes use of them. This simple approach provides runtime switching of implementations, which is crucial for the performance measurements such as those Octobus does with ASV. It can also be useful for bug analysis. It also has the advantage of making conditionals in Rust callers more uniform, in particular abstracting over specifics like `demandimport` At this point, the build stays unchanged, with the rust-cpython based `rustext` module being built if HGWITHRUSTEXT=cpython. More transparency for the callers, i.e., just using `policy.importmod` would be a much longer term and riskier effort for the following reasons: 1. It would require to define common module boundaries for the three or four cases (pure, c, rust+ext, cffi) and that is premature with the Rust extension currently under heavy development in areas that are outside the scope of the C extensions. 2. It would imply internal API changes that are not currently wished, as the case of ancestors demonstrates. 3. The lack of data or property-like attributes (tp_member and tp_getset) in current `rust-cpython` makes it impossible to achieve direct transparent replacement of pure Python classes by Rust extension code, meaning that the caller sometimes has to be able to make adjustments or provide additional wrapping.
Georges Racinet -
r42651:810f66b4 default
Show More
Name Size Modified Last Commit Author
/ rust
.cargo
chg
hg-core
hg-cpython
hg-direct-ffi
hgcli
Cargo.lock Loading ...
Cargo.toml Loading ...
README.rst Loading ...

Mercurial Rust Code

This directory contains various Rust code for the Mercurial project.

The top-level Cargo.toml file defines a workspace containing all primary Mercurial crates.

Building

To build the Rust components:

$ cargo build

If you prefer a non-debug / release configuration:

$ cargo build --release

Features

The following Cargo features are available:

localdev (default)

Produce files that work with an in-source-tree build.

In this mode, the build finds and uses a python2.7 binary from PATH. The hg binary assumes it runs from rust/target/<target>hg and it finds Mercurial files at dirname($0)/../../../.

Build Mechanism

The produced hg binary is bound to a CPython installation. The binary links against and loads a CPython library that is discovered at build time (by a build.rs Cargo build script). The Python standard library defined by this CPython installation is also used.

Finding the appropriate CPython installation to use is done by the python27-sys crate's build.rs. Its search order is:

  1. PYTHON_SYS_EXECUTABLE environment variable.
  2. python executable on PATH
  3. python2 executable on PATH
  4. python2.7 executable on PATH

Additional verification of the found Python will be performed by our build.rs to ensure it meets Mercurial's requirements.

Details about the build-time configured Python are built into the produced hg binary. This means that a built hg binary is only suitable for a specific, well-defined role. These roles are controlled by Cargo features (see above).

Running

The hgcli crate produces an hg binary. You can run this binary via cargo run:

$ cargo run --manifest-path hgcli/Cargo.toml

Or directly:

$ target/debug/hg
$ target/release/hg

You can also run the test harness with this binary:

$ ./run-tests.py --with-hg ../rust/target/debug/hg

Note

Integration with the test harness is still preliminary. Remember to cargo build after changes because the test harness doesn't yet automatically build Rust code.