cross

“Zero setup” cross compilation and “cross testing” of Rust crates

This project is developed and maintained by the [cross-rs] team. It was previously maintained by the Rust Embedded Working Group Tools team. New contributors are welcome! Please join our [Matrix room] and say hi.

<p align="center"> <img alt="`cross test`ing a crate for the aarch64-unknown-linux-gnu target" src="assets/cross-test.png" title="`cross test`ing a crate for the aarch64-unknown-linux-gnu target" > <br> <em>`cross test`ing a crate for the aarch64-unknown-linux-gnu target</em> </p>

Features

• cross will provide all the ingredients needed for cross compilation without touching your system installation.

• cross provides an environment, cross toolchain and cross compiled libraries, that produces the most portable binaries.

• “cross testing”, cross can test crates for architectures other than i686 and x86_64.

• The stable, beta and nightly channels are supported.

Dependencies

See our Getting Started guide for detailed installation instructions.

• rustup
• A Linux kernel with [binfmt_misc] support is required for cross testing.

One of these container engines is required. If both are installed, cross will default to docker.

• [Docker]. Note that on Linux non-sudo users need to be in the docker group or use rootless docker. Read the container engine [install guide][docker_install] for the required installation and post-installation steps. Requires version 20.10 (API 1.40) or later.
• [Podman]. Requires version 3.4.0 or later.

Installation

cargo install cross --git https://github.com/cross-rs/cross

It's also possible to directly download the pre-compiled release binaries or use cargo-binstall.

Usage

cross has the exact same CLI as Cargo but relies on Docker or Podman. For Docker, you'll have to start the daemon before you can use it.

# (ONCE PER BOOT, on Linux)
# Start the Docker daemon, if it's not already running using systemd
# on WSL2 and other systems using SysVinit, use `sudo service docker start`.
$ sudo systemctl start docker

# MAGIC! This Just Works
$ cross build --target aarch64-unknown-linux-gnu

# EVEN MORE MAGICAL! This also Just Works
$ cross test --target mips64-unknown-linux-gnuabi64

# Obviously, this also Just Works
$ cross rustc --target powerpc-unknown-linux-gnu --release -- -C lto

Additional documentation can be found on the wiki or the docs/ subfolder.

Configuration

Configuring cross behavior

You have four options to configure cross. All of these options use the TOML format for configuration and the possible configuration values are documented [here][config_file].

Option 1: Configuring cross directly in your Cargo.toml

You can directly set [configuration values][config_file] in your Cargo.toml file, under the [workspace.metadata.cross] table, i.e. key prefix. An example config snippet would look like this:

[workspace.metadata.cross.target.aarch64-unknown-linux-gnu]
# Install libssl-dev:arm64, see <https://github.com/cross-rs/cross/blob/main/docs/custom_images.md#adding-dependencies-to-existing-images>
pre-build = [
    "dpkg --add-architecture $CROSS_DEB_ARCH",
    "apt-get update && apt-get --assume-yes install libssl-dev:$CROSS_DEB_ARCH"
]
[workspace.metadata.cross.target.armv7-unknown-linux-gnueabi]
image = "my/image:latest"
[workspace.metadata.cross.build]
env.volumes = ["A_DIRECTORY=/path/to/volume"]

Option 2: Configuring cross via a Cross.toml file

You can put your [configuration][config_file] inside a Cross.toml file in your project root directory.

Option 3: Using CROSS_CONFIG to specify the location of your configuration

By setting the CROSS_CONFIG environment variable, you can tell cross where it should search for the config file. This way you are not limited to a Cross.toml file in the project root.

Option 4: Configuring cross through environment variables

Besides the TOML-based configuration files, config can be passed through [environment variables][docs_env_vars], too.

Docker in Docker

When running cross from inside a container, cross needs access to the hosts docker daemon itself. This is normally achieved by mounting the docker daemons socket /var/run/docker.sock. For example:

$ docker run -v /var/run/docker.sock:/var/run/docker.sock -v .:/project \
  -w /project my/development-image:tag cross build --target mips64-unknown-linux-gnuabi64

The image running cross requires the rust development tools to be installed.

With this setup cross must find and mount the correct host paths into the container used for cross compilation. This includes the original project directory as well as the root path of the parent container to give access to the rust build tools.

To inform cross that it is running inside a container set CROSS_CONTAINER_IN_CONTAINER=true.

A development or CI container can be created like this:

FROM rust:1

# set CROSS_CONTAINER_IN_CONTAINER to inform `cross` that it is executed from within a container
ENV CROSS_CONTAINER_IN_CONTAINER=true

# install `cross`
RUN cargo install cross

...

Limitations: Finding the mount point for the containers root directory is currently only available for the overlayfs2 storage driver. In order to access the parent containers rust setup, the child container mounts the parents overlayfs. The parent must not be stopped before the child container, as the overlayfs can not be unmounted correctly by Docker if the child container still accesses it.

Explicitly choose the container engine

By default, cross tries to use [Docker] or [Podman], in that order. If you want to choose a container engine explicitly, you can set the binary name (or path) using the CROSS_CONTAINER_ENGINE environment variable.

For example in case you want use [Podman], you can set CROSS_CONTAINER_ENGINE=podman.

Supported targets

A target is considered as “supported” if cross can cross compile a “non-trivial” (binary) crate, usually Cargo, for that target.

Testing support (cross test) is more complicated. It relies on QEMU emulation, so testing may fail due to QEMU bugs rather than bugs in your crate. That said, a target has a ✓ in test column of the table below if it can run the compiler-builtins test suite.

Also, testing is very slow. cross test runs units tests sequentially because QEMU gets upset when you spawn multiple threads. This means that, if one of your unit tests spawns threads, then it's more likely to fail or, worst, never terminate.

| Target | libc | GCC | C++ | QEMU | test | |----------------------------------------|-------:|-------:|:---:|------:|:------:| | aarch64-linux-android [1] | 9.0.8 | 9.0.8 | ✓ | 6.1.0 | ✓ | | aarch64-unknown-linux-gnu | 2.31 | 9.4.0 | ✓ | 6.1.0 | ✓ | | aarch64-unknown-linux-gnu:centos [7] | 2.17 | 4.8.5 | | 4.2.1 | ✓ | | aarch64-unknown-linux-musl | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | aarch64_be-unknown-linux-gnu | 2.36 | 14.2.0 | ✓ | 6.1.0 | ✓ | | arm-linux-androideabi [1] | 9.0.8 | 9.0.8 | ✓ | 6.1.0 | ✓ | | arm-unknown-linux-gnueabi | 2.31 | 9.4.0 | ✓ | 6.1.0 | ✓ | | arm-unknown-linux-gnueabihf | 2.31 | 8.5.0 | ✓ | 6.1.0 | ✓ | | arm-unknown-linux-musleabi | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | arm-unknown-linux-musleabihf | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | armv5te-unknown-linux-gnueabi | 2.31 | 9.4.0 | ✓ | 6.1.0 | ✓ | | armv5te-unknown-linux-musleabi | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | armv7-linux-androideabi [1] | 9.0.8 | 9.0.8 | ✓ | 6.1.0 | ✓ | | armv7-unknown-linux-gnueabi | 2.31 | 9.4.0 | ✓ | 6.1.0 | ✓ | | armv7-unknown-linux-gnueabihf | 2.31 | 9.4.0 | ✓ | 6.1.0 | ✓ | | armv7-unknown-linux-musleabi | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | armv7-unknown-linux-musleabihf | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | i586-unknown-linux-gnu | 2.31 | 9.4.0 | ✓ | N/A | ✓ | | i586-unknown-linux-musl | 1.2.3 | 9.2.0 | ✓ | N/A | ✓ | | i686-unknown-freebsd | 1.6 | 13.3.0 | ✓ | N/A | | | i686-linux-android [1] | 9.0.8 | 9.0.8 | ✓ | 6.1.0 | ✓ | | i686-pc-windows-gnu | N/A | 9.4 | ✓ | N/A | ✓ | | i686-unknown-linux-gnu | 2.31 | 9.4.0 | ✓ | 6.1.0 | ✓ | | loongarch64-unknown-linux-gnu | 2.36 | 14.2.0 | ✓ | 8.2.2 | ✓ | | loongarch64-unknown-linux-musl | 1.2.5 | 14.2.0 | ✓ | 8.2.2 | ✓ | | mips-unknown-linux-gnu | 2.30 | 9.4.0 | ✓ | 6.1.0 | ✓ | | mips-unknown-linux-musl | 1.2.3 | 9.2.0 | ✓ | 6.1.0 | ✓ | | mips64-unknown-linux-gnuabi64 | 2.30 | 9.4.0 | ✓ | 6.1.0 | ✓ | | mips64-unknown-linux-muslabi64 | 1.2.3 | 9.2