##// END OF EJS Templates
rust-cpython: mark all PyLeaked methods as unsafe...
rust-cpython: mark all PyLeaked methods as unsafe Unfortunately, these methods can be abused to obtain the inner 'static reference. The simplest (pseudo-code) example is: let leaked: PyLeaked<&'static _> = shared.leak_immutable(); let static_ref: &'static _ = &*leaked.try_borrow(py)?; // PyLeakedRef::deref() tries to bound the lifetime to itself, but // the underlying data is a &'static reference, so the returned // reference can be &'static. This problem can be easily fixed by coercing the lifetime, but there are many other ways to achieve that, and there wouldn't be a generic solution: let leaked: PyLeaked<&'static [_]> = shared.leak_immutable(); let leaked_iter: PyLeaked<slice::Iter<'static, _>> = unsafe { leaked.map(|v| v.iter()) }; let static_slice: &'static [_] = leaked_iter.try_borrow(py)?.as_slice(); So basically I failed to design the safe borrowing interface. Maybe we'll instead have to add much more restricted interface on top of the unsafe PyLeaked methods? For instance, Iterator::next() could be implemented if its Item type is not &'a (where 'a may be cheated.) Anyway, this seems not an easy issue, so it's probably better to leave the current interface as unsafe, and get broader comments while upstreaming this feature.
Yuya Nishihara -
r44668:71457ff6 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. Rust is not required to use (or build) Mercurial, but using it improves performance in some areas.

There are currently three independent rust projects: - chg. An implementation of chg, in rust instead of C. - hgcli. A experiment for starting hg in rust rather than in python,

by linking with the python runtime. Probably meant to be replaced by PyOxidizer at some point.
  • hg-core (and hg-cpython/hg-directffi): implementation of some functionality of mercurial in rust, e.g. ancestry computations in revision graphs or pull discovery. The top-level Cargo.toml file defines a workspace containing these crates.

Using hg-core

Local use (you need to clean previous build artifacts if you have built without rust previously):

$ HGWITHRUSTEXT=cpython make local # to use ./hg
$ HGWITHRUSTEXT=cpython make tests # to run all tests
$ (cd tests; HGWITHRUSTEXT=cpython ./run-tests.py) # only the .t
$ ./hg debuginstall | grep rust # to validate rust is in use
checking module policy (rust+c-allow)

Setting HGWITHRUSTEXT to other values like true is deprecated and enables only a fraction of the rust code.

Developing hg-core

Simply run:

$ cargo build --release

It is possible to build without --release, but it is not recommended if performance is of any interest: there can be an order of magnitude of degradation when removing --release.

For faster builds, you may want to skip code generation:

$ cargo check

You can run only the rust-specific tests (as opposed to tests of mercurial as a whole) with:

$ cargo test --all