Skip to content

Latest commit

 

History

History
138 lines (102 loc) · 6.6 KB

README.md

File metadata and controls

138 lines (102 loc) · 6.6 KB
Raw

cross-toolchains

Additional Dockerfiles and crosstool-ng config files to build images for additional targets. These enable the use of additional targets, and different glibc or GCC versions.

First, clone cross and update the submodules.

git clone https://github.com/cross-rs/cross
cd cross
git submodule update --init --remote

Then, you can build your images as shown in Targets.

ℹ️ These images are not tested with CI, and therefore may break. Issues or pull requests to fix broken images are greatly appreciated. Each image is only confirmed to at least build once.

Configure

The config files are configured via cargo xtask configure-crosstool, which may be customized by the following flags/environment variables:

  • --gcc-version, GCC_VERSION: The GCC version (default 8.3.0)
  • --glibc-version, GLIBC_VERSION: The glibc version (default 2.17)
  • --linux-version, LINUX_VERSION: The Linux version (default 4.19.21)

If no targets are provided, all crosstool images will be configured, otherwise, only the selected targets will be built. For example:

# only configure the config file for a single target
$ cargo xtask configure-crosstool arm-unknown-linux-gnueabihf
# configure all config files for crosstool images
$ cargo xtask configure-crosstool

Targets

The image names don't map identically to the target names, to avoid conflicting with those provided in the cross repository. This table maps the target names to the image names:

Target Name Image Name
aarch64-apple-darwin aarch64-apple-darwin-cross
aarch64-apple-ios aarch64-apple-ios-cross
aarch64-pc-windows-msvc aarch64-pc-windows-msvc-cross
aarch64_be-unknown-linux-gnu aarch64_be-unknown-linux-gnu-cross
i686-apple-darwin i686-apple-darwin-cross
i686-pc-windows-msvc i686-pc-windows-msvc-cross
s390x-unknown-linux-gnu s390x-unknown-linux-gnu-cross
thumbv7a-pc-windows-msvc thumbv7a-pc-windows-msvc-cross
thumbv7neon-unknown-linux-musleabihf thumbv7neon-unknown-linux-musleabihf-cross
x86_64-apple-darwin x86_64-apple-darwin-cross
x86_64-pc-windows-msvc x86_64-pc-windows-msvc-cross
x86_64-unknown-linux-gnu x86_64-unknown-linux-gnu-sde-cross

For example, to build and run an image, you would configure the image with:

cargo build-docker-image s390x-unknown-linux-gnu-cross --tag local

And then update Cross.toml in your crate to specify the target:

[target.s390x-unknown-linux-gnu]
image = "ghcr.io/cross-rs/s390x-unknown-linux-gnu-cross:local"

Additional config files for any supported platforms are appreciated. Please note that many of these images are tier 3 targets, and do not have pre-built versions of the standard library. You must provide the build-std config option when building crates requiring std support.

Apple Targets

Due to licensing reasons, we cannot provide images of *-apple-darwin targets, nor host the macOS SDK. osxcross has instructions for how to package the sdk, which you can then provide to the Docker image as either a local file or download link. Pre-packaged tarballs can also be found online, however, for legal reasons, we do not provide links here.

Darwin Targets

You can provide either a download URL or a path to a local file when building:

$ cargo build-docker-image i686-apple-darwin-cross \
  --build-arg 'MACOS_SDK_URL=$URL'
$ cargo build-docker-image i686-apple-darwin-cross \
  --build-arg 'MACOS_SDK_DIR=$DIR' \
  --build-arg 'MACOS_SDK_FILE=$FILE'

If not provided, MACOS_SDK_DIR defaults to the build context of the Dockerfile. MACOS_SDK_FILE must be a file within this repository's docker/ folder. It also must keep the name given by osxcross, as version checks otherwise fail. For example:

$ mv osxcross/MacOSX11.3.sdk.tar.xz cross-toolchains/docker/MacOSX11.3.sdk.tar.xz
$ cargo build-docker-image aarch64-apple-darwin \
  --build-arg 'MACOS_SDK_FILE=MacOSX11.3.sdk.tar.xz'
# or
$ mv osxcross/MacOSX11.3.sdk.tar.xz cross-toolchains/docker/some-dir/MacOSX11.3.sdk.tar.xz
$ cargo build-docker-image aarch64-apple-darwin \
  --build-arg 'MACOS_SDK_DIR=some-dir' \
  --build-arg 'MACOS_SDK_FILE=MacOSX11.3.sdk.tar.xz'

Supported targets by SDK version (at least 10.7+):

  • i686-apple-darwin: SDK <= 10.13
  • x86_64-apple-darwin: SDK <= 13.0 or SDK <= 12.4
  • aarch64-apple-darwin: SDK >= 10.16 and (SDK <= 13.0 or SDK <= 12.4)

iOS Targets

You can provide either a download URL or a path to a local file when building:

$ cargo build-docker-image aarch64-apple-ios-cross \
  --build-arg 'IOS_SDK_URL=$URL'
$ cargo build-docker-image aarch64-apple-ios-cross \
  --build-arg 'IOS_SDK_DIR=$DIR' \
  --build-arg 'IOS_SDK_FILE=$FILE'

If not provided, IOS_SDK_DIR defaults to the build context of the Dockerfile. Note that this file must be a subdirectory of the build context.

Supported targets by SDK version (at least 9.3+):

  • aarch64-apple-ios: any SDK version
  • armv7-apple-ios: not supported
  • armv7s-apple-ios: not supported
  • i686-apple-ios: not supported
  • x86_64-apple-ios: not supported

Known Issues

  • Older toolchains, such as GCC v4.9.4, do not work with the hardcoded ISL v0.20.
  • s390x toolchains cannot be built with glibc below v2.20, due to missing symbols in nptl/sysdeps/s390/tls.h.
  • aarch64_be toolchains cannot be built with older glibc versions, due relocations (tested to work in v2.31, failed in v2.20).
  • MSVC and iOS targets may fail with more complex build systems, such as OpenSSL. macOS targets have no issues.

Code of Conduct

Contribution to this crate is organized under the terms of the Rust Code of Conduct, the maintainer of this crate, the cross-rs team, promises to intervene to uphold that code of conduct.