rust: implementation of `hg` This commit provides a mostly-working implementation of the `hg` script in Rust along with scaffolding to support Rust in the repository. If you are familiar with Rust, the contents of the added rust/ directory should be pretty straightforward. We create an "hgcli" package that implements a binary application to run Mercurial. The output of this package is an "hg" binary. Our Rust `hg` (henceforth "rhg") essentially is a port of the existing `hg` Python script. The main difference is the creation of the embedded CPython interpreter is handled by the binary itself instead of relying on the shebang. In that sense, rhg is more similar to the "exe wrapper" we currently use on Windows. However, unlike the exe wrapper, rhg does not call the `hg` Python script. Instead, it uses the CPython APIs to import mercurial modules and call appropriate functions. The amount of code here is surprisingly small. It is my intent to replace the existing C-based exe wrapper with rhg. Preferably in the next Mercurial release. This should be achievable - at least for some Mercurial distributions. The future/timeline for rhg on other platforms is less clear. We already ship a hg.exe on Windows. So if we get the quirks with Rust worked out, shipping a Rust-based hg.exe should hopefully not be too contentious. Now onto the implementation. We're using python27-sys and the cpython crates for talking to the CPython API. We currently don't use too much functionality of the cpython crate and could have probably cut it out. However, it does provide a reasonable abstraction over unsafe {} CPython function calls. While we still have our fair share of those, at least we're not dealing with too much refcounting, error checking, etc. So I think the use of the cpython crate is justified. Plus, there is not-yet-implemented functionality that could benefit from cpython. I see our use of this crate only increasing. The cpython and python27-sys crates are not without their issues. The cpython crate didn't seem to account for the embedding use case in its design. Instead, it seems to assume that you are building a Python extension. It is making some questionable decisions around certain CPython APIs. For example, it insists that PyEval_ThreadsInitialized() is called and that the Python code likely isn't the main thread in the underlying application. It is also missing some functionality that is important for embedded use cases (such as exporting the path to the Python interpreter from its build script). After spending several hours trying to wrangle python27-sys and cpython, I gave up and forked the project on GitHub. Our Cargo.toml tracks this fork. I'm optimistic that the upstream project will accept our contributions and we can eventually unfork. There is a non-trivial amount of code in our custom Cargo build script. Our build.rs (which is called as part of building the hgcli crate): * Validates that the Python interpreter that was detected by the python27-sys crate provides a shared library (we only support shared library linking at this time - although this restriction could be loosened). * Validates that the Python is built with UCS-4 support. This ensures maximum Unicode compatibility. * Exports variables to the crate build allowing the built crate to e.g. find the path to the Python interpreter. The produced rhg should be considered alpha quality. There are several known deficiencies. Many of these are documented with inline TODOs. Probably the biggest limitation of rhg is that it assumes it is running from the ./rust/target/<target> directory of a source distribution. So, rhg is currently not very practical for real-world use. But, if you can `cargo build` it, running the binary *should* yield a working Mercurial CLI. In order to support using rhg with the test harness, we needed to hack up run-tests.py so the path to Mercurial's Python files is set properly. The change is extremely hacky and is only intended to be a stop-gap until the test harness gains first-class support for installing rhg. This will likely occur after we support running rhg outside the source directory. Despite its officially alpha quality, rhg copes extremely well with the test harness (at least on Linux). Using `run-tests.py --with-hg ../rust/target/debug/hg`, I only encounter the following failures: * test-run-tests.t -- Warnings emitted about using an unexpected Mercurial library. This is due to the hacky nature of setting the Python directory when run-tests.py detected rhg. * test-devel-warnings.t -- Expected stack trace missing frame for `hg` (This is expected since we no longer have an `hg` script!) * test-convert.t -- Test running `$PYTHON "$BINDIR"/hg`, which obviously assumes `hg` is a Python script. * test-merge-tools.t -- Same assumption about `hg` being executable with Python. * test-http-bad-server.t -- Seeing exit code 255 instead of 1 around line 358. * test-blackbox.t -- Exit code 255 instead of 1. * test-basic.t -- Exit code 255 instead of 1. It certainly looks like we have a bug around exit code handling. I don't think it is severe enough to hold up review and landing of this initial implementation. Perfect is the enemy of good. Differential Revision: https://phab.mercurial-scm.org/D1581

     1

===================

     2

Mercurial Rust Code

     3

===================

     4

     5

This directory contains various Rust code for the Mercurial project.

     6

     7

The top-level ``Cargo.toml`` file defines a workspace containing

     8

all primary Mercurial crates.

     9

    10

Building

    11

========

    12

    13

To build the Rust components::

    14

    15

   $ cargo build

    16

    17

If you prefer a non-debug / release configuration::

    18

    19

   $ cargo build --release

    20

    21

Features

    22

--------

    23

    24

The following Cargo features are available:

    25

    26

localdev (default)

    27

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

    28

    29

   In this mode, the build finds and uses a ``python2.7`` binary from

    30

   ``PATH``. The ``hg`` binary assumes it runs from ``rust/target/<target>hg``

    31

   and it finds Mercurial files at ``dirname($0)/../../../``.

    32

    33

Build Mechanism

    34

---------------

    35

    36

The produced ``hg`` binary is *bound* to a CPython installation. The

    37

binary links against and loads a CPython library that is discovered

    38

at build time (by a ``build.rs`` Cargo build script). The Python

    39

standard library defined by this CPython installation is also used.

    40

    41

Finding the appropriate CPython installation to use is done by

    42

the ``python27-sys`` crate's ``build.rs``. Its search order is::

    43

    44

1. ``PYTHON_SYS_EXECUTABLE`` environment variable.

    45

2. ``python`` executable on ``PATH``

    46

3. ``python2`` executable on ``PATH``

    47

4. ``python2.7`` executable on ``PATH``

    48

    49

Additional verification of the found Python will be performed by our

    50

``build.rs`` to ensure it meets Mercurial's requirements.

    51

    52

Details about the build-time configured Python are built into the

    53

produced ``hg`` binary. This means that a built ``hg`` binary is only

    54

suitable for a specific, well-defined role. These roles are controlled

    55

by Cargo features (see above).

    56

    57

Running

    58

=======

    59

    60

The ``hgcli`` crate produces an ``hg`` binary. You can run this binary

    61

via ``cargo run``::

    62

    63

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

    64

    65

Or directly::

    66

    67

   $ target/debug/hg

    68

   $ target/release/hg

    69

    70

You can also run the test harness with this binary::

    71

    72

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

    73

    74

.. note::

    75

    76

   Integration with the test harness is still preliminary. Remember to

    77

   ``cargo build`` after changes because the test harness doesn't yet

    78

   automatically build Rust code.