Cross compiling toolchains in Docker images
Go to file
Bensuperpc 7b16d801fb Fix build for non-x86 archtectures (By paleozogt) and update GOSU to 1.14
Fix build for non-x86 archtectures (By paleozogt) and update GOSU to 1.14

Signed-off-by: Bensuperpc <bensuperpc@gmail.com>
2022-04-25 09:45:36 +02:00
.github Bump actions/download-artifact from 2 to 3 2022-04-09 11:55:02 +02:00
android-arm Improve openSSL on android-* image 2021-08-27 13:19:31 +02:00
android-arm64 Improve openSSL on android-* image 2021-08-27 13:19:31 +02:00
android-x86 Improve openSSL on android-* image 2021-08-27 13:19:31 +02:00
android-x86_64 Improve openSSL on android-* image 2021-08-27 13:19:31 +02:00
common bump flatcc to fix issue building flatcc runtime on GCC 11 2022-03-30 09:45:08 -04:00
imagefiles Fix build for non-x86 archtectures (By paleozogt) and update GOSU to 1.14 2022-04-25 09:45:36 +02:00
linux-arm64 Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-arm64-full Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
linux-arm64-lts Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-arm64-musl Add linux-arm64-musl image 2020-11-10 23:52:43 +01:00
linux-armv5 Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-armv5-musl Update scripts 2021-10-13 19:44:08 +02:00
linux-armv5-uclibc feat: Support for linux-armv5-uclibc 2022-02-01 17:03:56 +02:00
linux-armv6 Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-armv6-lts Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-armv6-musl Add linux-armv6-musl image 2020-12-04 14:04:29 +01:00
linux-armv7 Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-armv7-lts Down linux version build fail with linux 5.12 or above 2021-10-16 13:51:40 +02:00
linux-armv7a Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-armv7l-musl Add linux-armv7l-musl image 2020-11-13 13:38:47 +01:00
linux-m68k-uclibc Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-mips Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-ppc64le Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-riscv32 Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-riscv64 Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-s390x Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
linux-x64 Add tbb 2021-10-24 19:29:02 +02:00
linux-x64-clang Fix llvm-ar and llvm-as 2021-10-17 13:53:26 +02:00
linux-x64-tinycc fix: disabled C tests for wrong architecture 2022-02-02 02:21:50 +02:00
linux-x86 Add tbb 2021-10-24 19:29:02 +02:00
linux-x86_64-full Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
linux-xtensa-uclibc Change ISL mirror with new official source: cfb7d07ae1 2021-10-12 10:05:21 +02:00
manylinux2014-aarch64 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
manylinux2014-x64 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
manylinux2014-x86 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
manylinux-common Revert "manylinux: Update scikit-build from 0.8.1 to 0.9.0" 2019-10-24 10:25:13 -04:00
test base: Add cmake wrapper scripts for CMAKE_TOOLCHAIN_FILE 2016-07-22 08:48:59 -04:00
tools Disable auto pulling image in scripts 2021-10-13 20:03:06 +02:00
web-wasi web-wasi: Add Emscripten CMake modifications 2022-02-22 23:14:30 -05:00
web-wasm web-wasm: Bump Emscripten to 3.1.5 2022-02-23 10:48:57 +01:00
windows-arm64 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-armv7 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-shared-x64 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-shared-x64-posix Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-shared-x86 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-static-x64 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-static-x64-posix Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
windows-static-x86 Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
.gitattributes git: Ensure we use lf endings 2018-08-20 14:24:47 -04:00
.gitignore Update build example in readme 2021-11-03 20:54:39 +01:00
Dockerfile.in Replace deprecated label 'MAINTAINER' by 'LABEL maintainer' 2021-10-04 12:51:28 +02:00
LICENSE Update LICENSE copyright dates and add @jcfr 2018-03-19 15:50:28 -04:00
Makefile removed leftover name from Makefile 2022-02-01 17:12:30 +02:00
README.md doc: Updating README adding date to list of retired images 2022-02-05 18:32:22 -05:00

dockcross

Cross compiling toolchains in Docker images.

image Shellcheck CI

GitHub GitHub commit activity

Features

  • Pre-built and configured toolchains for cross compiling.
  • Most images also contain an emulator for the target system.
  • Clean separation of build tools, source code, and build artifacts.
  • Commands in the container are run as the calling user, so that any created files have the expected ownership, (i.e. not root).
  • Make variables CC, CXX, LD, AS etc) are set to point to the appropriate tools in the container.
  • Recent CMake and ninja are precompiled.
  • Conan.io can be used as a package manager.
  • Toolchain files configured for CMake.
  • Current directory is mounted as the container's workdir, /work.
  • Works with the Docker for Mac and Docker for Windows.
  • Support using alternative container executor by setting OCI_EXE environment variable. By default, it searches for docker and podman executable.
  • crosstool-ng and buildroot configuration files.

Examples

  1. dockcross make: Build the Makefile in the current directory.
  2. dockcross cmake -Bbuild -H. -GNinja: Run CMake with a build directory ./build for a CMakeLists.txt file in the current directory and generate ninja build configuration files.
  3. dockcross ninja -Cbuild: Run ninja in the ./build directory.
  4. dockcross bash -c '$CC test/C/hello.c -o hello': Build the hello.c file with the compiler identified with the CC environmental variable in the build environment.
  5. dockcross bash: Run an interactive shell in the build environment.

Note that commands are executed verbatim. If any shell processing for environment variable expansion or redirection is required, please use

bash -c "<command args>"

Installation

This image does not need to be run manually. Instead, there is a helper script to execute build commands on source code existing on the local host filesystem. This script is bundled with the image.

To install the helper script, run one of the images with no arguments, and redirect the output to a file:

docker run --rm CROSS_COMPILER_IMAGE_NAME > ./dockcross
chmod +x ./dockcross
mv ./dockcross ~/bin/

Where CROSS_COMPILER_IMAGE_NAME is the name of the cross-compiler toolchain Docker instance, e.g: dockcross/linux-armv7.

Only 64-bit x86_64 images are provided, a 64-bit x86_64 host system is required.

Usage

For the impatient, here's how to compile a hello world for armv7:

git clone https://github.com/dockcross/dockcross.git
cd dockcross
docker run --rm dockcross/linux-armv7 > ./dockcross-linux-armv7
chmod +x ./dockcross-linux-armv7
./dockcross-linux-armv7 bash -c '$CC test/C/hello.c -o hello_arm'

Note how invoking any toolchain command (make, gcc, etc.) is just a matter of prepending the dockcross script on the commandline:

./dockcross-linux-armv7 [command] [args...]

The dockcross script will execute the given command-line inside the container, along with all arguments passed after the command. Commands that evaluate environmental variables in the image, like $CC or $CXX above, should be executed in [bash -c]. The present working directory is mounted within the image, which can be used to make source code available in the Docker container.

Summary cross compilers

Image name Target arch Compiler Target OS
dockcross/base - - -
dockcross/android-arm ARMv7 Clang Android
dockcross/android-arm64 ARMv8 Clang Android
dockcross/android-x86 x86 Clang Android
dockcross/android-x86_64 x86_64 Clang Android
dockcross/linux-arm64 ARMv8 GCC Linux
dockcross/linux-arm64-lts ARMv8 GCC 8.5.0 + Glibc 2.27 Linux
dockcross/linux-arm64-full ARMv8 GCC + libs Linux
dockcross/linux-arm64-musl ARMv8 GCC + musl Linux
dockcross/linux-armv5 ARMv5 GCC Linux
dockcross/linux-armv5-musl ARMv5 GCC + musl Linux
dockcross/linux-armv5-uclibc ARMv5 GCC + uclibc Linux
dockcross/linux-armv6 ARMv6 GCC Linux
dockcross/linux-armv6-lts ARMv6 GCC 8.5.0 + Glibc 2.28 Linux
dockcross/linux-armv6-musl ARMv6 GCC + musl Linux
dockcross/linux-armv7 ARMv7 GCC Linux
dockcross/linux-armv7-lts ARMv7 GCC 8.5.0 + Glibc 2.28 Linux
dockcross/linux-armv7a ARMv7a GCC Linux
dockcross/linux-armv7l-musl ARMv7l GCC + musl Linux
dockcross/linux-mips mips GCC Linux
dockcross/linux-s390x s390x GCC Linux
dockcross/linux-ppc64le ppc64le GCC Linux
dockcross/linux-riscv32 riscv32 GCC Linux
dockcross/linux-riscv64 riscv64 GCC Linux
dockcross/linux-m68k-uclibc m68k GCC + uclibc Linux
dockcross/linux-xtensa-uclibc xtensa GCC + uclibc Linux
dockcross/manylinux2014-x86 x86 GCC Linux
dockcross/manylinux2014-x64 x86_64 GCC Linux
dockcross/linux-x86 x86 GCC Linux
dockcross/linux-x64 x86_64 GCC Linux
dockcross/linux-x86_64-full x86_64 GCC + libs Linux
dockcross/linux-x64-clang x86_64 Clang Linux
dockcross/linux-x64-tinycc x86_64 tinycc + GCC Linux
dockcross/web-wasm Wasm LLVM Web (JS)
dockcross/web-wasi Wasm LLVM Web (Universal)
dockcross/windows-shared-x86 x86 GCC Windows
dockcross/windows-shared-x64 x86_64 GCC Windows
dockcross/windows-shared-x64-posix x86_64 GCC Windows
dockcross/windows-static-x86 x86 GCC Windows
dockcross/windows-static-x64 x86_64 GCC Windows
dockcross/windows-static-x64-posix x86_64 GCC Windows
dockcross/windows-armv7 ARMv7 Clang Windows
dockcross/windows-arm64 ARMv8 Clang Windows

The list of docker images that are no longer maintained.

Image name Target arch Compiler Target OS End of life (EOL)
dockcross/manylinux-x86 x86 GCC manylinux 2019-05-22
dockcross/manylinux-x64 x86 GCC manylinux 2019-05-22
dockcross/linux-mipsel mipsel GCC 4.9 Debian 8 2021-06-27
dockcross/manylinux1-x86 x86 GCC manylinux 2021-08-05
dockcross/manylinux1-x64 x86_64 GCC manylinux 2021-08-05
dockcross/manylinux2010-x86 x86 GCC manylinux 2021-08-05
dockcross/manylinux2010-x64 x86_64 GCC manylinux 2021-08-05

Cross compilers

dockcross/base

Docker Image Size (tag) Docker Pulls Docker Stars

Base image for other toolchain images. From Debian Jessie with GCC, make, autotools, CMake, Ninja, Git, and Python.

dockcross/android-arm

Docker Image Size (tag) Docker Pulls

The Android NDK standalone toolchain for the arm architecture.

dockcross/android-arm64

Docker Image Size (tag) Docker Pulls

The Android NDK standalone toolchain for the arm64 architecture.

dockcross/android-x86

Docker Image Size (tag) Docker Pulls

The Android NDK standalone toolchain for the x86 architecture.

dockcross/android-x86_64

Docker Image Size (tag) Docker Pulls

The Android NDK standalone toolchain for the x86_64 architecture.

dockcross/linux-arm64

Docker Image Size (tag) Docker Pulls

Cross compiler for the 64-bit ARM platform on Linux, also known as AArch64.

dockcross/linux-arm64-lts

Docker Image Size (tag) Docker Pulls

Cross compiler for the 64-bit ARM platform on Linux, also known as AArch64, with Long-term support (For Ubuntu 18.04 or Debian Buster). With GCC 8.5.0 and GLibc 2.27.

dockcross/linux-arm64-full

Docker Image Size (tag) Docker Pulls

Cross compiler for the 64-bit ARM platform on Linux, with cross-libs: SDL2, OpenSSL, Boost, OpenCV and Qt5 (minimal).

dockcross/linux-arm64-musl

Docker Image Size (tag) Docker Pulls

Cross compiler for the 64-bit ARM platform on Linux (also known as AArch64), using musl as base "libc".

dockcross/linux-armv5

Docker Image Size (tag) Docker Pulls

Linux armv5 cross compiler toolchain for legacy devices like the Parrot AR Drone.

dockcross/linux-armv5-musl

Docker Image Size (tag) Docker Pulls

Linux armv5 cross compiler toolchain using musl as base "libc".

dockcross/linux-armv5-uclibc

Docker Image Size (tag) Docker Pulls

Linux armv5 cross compiler toolchain for legacy devices like wrt routers Linux kernel 2.6 uclibc as base "libc".

dockcross/linux-armv6

Docker Image Size (tag) Docker Pulls

Linux ARMv6 cross compiler toolchain for the Raspberry Pi

dockcross/linux-armv6-lts

Docker Image Size (tag) Docker Pulls

Linux ARMv6 cross compiler toolchain for the Raspberry Pi (Debian buster...)

dockcross/linux-armv6-musl

Docker Image Size (tag) Docker Pulls

Linux ARMv6 cross compiler toolchain for the Raspberry Pi, etc, using musl as base "libc".

dockcross/linux-armv7

Docker Image Size (tag) Docker Pulls

Generic Linux armv7 cross compiler toolchain.

dockcross/linux-armv7-lts

Docker Image Size (tag) Docker Pulls

Linux ARMv7 cross compiler toolchain for the Raspberry Pi (Debian buster...)

dockcross/linux-armv7a

Docker Image Size (tag) Docker Pulls

Toolchain configured for ARMv7-A used in Beaglebone Black single board PC with TI SoC AM3358 on board, Cortex-A8.

dockcross/linux-armv7l-musl

Docker Image Size (tag) Docker Pulls

Toolchain configured for ARMv7-L, using musl as base "libc".

dockcross/linux-mips

Docker Image Size (tag) Docker Pulls

Linux mips cross compiler toolchain for big endian 32-bit hard float MIPS GNU systems.

dockcross/linux-s390x

Docker Image Size (tag) Docker Pulls

Linux s390x cross compiler toolchain for S390X GNU systems.

dockcross/linux-riscv64

Docker Image Size (tag) Docker Pulls

Linux risc-v 64bit cross compiler toolchain for risc-v 64bit GNU systems.

dockcross/linux-riscv32

Docker Image Size (tag) Docker Pulls

Linux risc-v 32bit cross compiler toolchain for risc-v 32bit GNU systems.

dockcross/linux-m68k-uclibc

Docker Image Size (tag) Docker Pulls

Linux m68k cross compiler toolchain for m68k GNU systems (http://www.mac.linux-m68k.org/ and http://www.linux-m68k.org/).

dockcross/linux-ppc64le

Docker Image Size (tag) Docker Pulls

Linux PowerPC 64 little endian cross compiler toolchain for the POWER8, etc. Important: Due to Issue #430, automatic build of newer images has been disabled.

dockcross/linux-x64

Docker Image Size (tag) Docker Pulls

Linux x86_64/amd64 compiler. Since the Docker image is natively x86_64, this is not actually a cross compiler.

dockcross/linux-x86_64-full

Docker Image Size (tag) Docker Pulls

Linux x86_64/amd64 compiler with libs: SDL2, OpenSSL, Boost, OpenCV and Qt5 (minimal).

dockcross/linux-x64-clang

Docker Image Size (tag) Docker Pulls

Linux clang x86_64/amd64 compiler. Since the Docker image is natively x86_64, this is not actually a cross compiler.

dockcross/linux-x86

Docker Image Size (tag) Docker Pulls

Linux i686 cross compiler.

dockcross/linux-x64-tinycc

Docker Image Size (tag) Docker Pulls

Linux tcc compiler for C compiler, and GCC for C++ compiler, for linux x86_64/amd64 arch.

dockcross/manylinux2014-x64

Docker Image Size (tag) Docker Pulls

Docker manylinux2014 image for building Linux x86_64 / amd64 Python wheel packages. It includes Python 3.5, 3.6, 3.7, 3.8, and 3.9. Also has support for the dockcross script, and it has installations of CMake, Ninja, and scikit-build. For CMake, it sets MANYLINUX2014 to "TRUE" in the toolchain.

dockcross/manylinux2014-x86

Docker Image Size (tag) Docker Pulls

Docker manylinux2014 image for building Linux i686 Python wheel packages. It includes Python 3.5, 3.6, 3.7, 3.8, and 3.9. Also has support for the dockcross script, and it has installations of CMake, Ninja, and scikit-build. For CMake, it sets MANYLINUX2014 to "TRUE" in the toolchain.

dockcross/manylinux2014-aarch64

Docker Image Size (tag) Docker Pulls

Docker manylinux2014 image for building Linux aarch64 / arm64 Python wheel packages. It includes Python 3.5, 3.6, 3.7, 3.8, and 3.9. Also has support for the dockcross script, and it has installations of CMake, Ninja, and scikit-build. For CMake, it sets MANYLINUX2014 to "TRUE" in the toolchain.

dockcross/web-wasm

Docker Image Size (tag) Docker Pulls

The Emscripten WebAssembly/JavaScript cross compiler.

dockcross/web-wasi

Docker Image Size (tag) Docker Pulls

The WebAssembly System Interface (WASI) SDK LLVM/Clang/WASI Sysroot cross compiler.

dockcross/windows-static-x64

Docker Image Size (tag) Docker Pulls

64-bit Windows cross-compiler based on MXE/MinGW-w64 with win32 threads and static linking.

dockcross/windows-static-x64-posix

Docker Image Size (tag) Docker Pulls

64-bit Windows cross-compiler based on MXE/MinGW-w64 with posix threads and static linking.

dockcross/windows-static-x86

Docker Image Size (tag) Docker Pulls

32-bit Windows cross-compiler based on MXE/MinGW-w64 with win32 threads and static linking.

dockcross/windows-shared-x64

Docker Image Size (tag) Docker Pulls

64-bit Windows cross-compiler based on MXE/MinGW-w64 with win32 threads and dynamic linking.

dockcross/windows-shared-x64-posix

Docker Image Size (tag) Docker Pulls

64-bit Windows cross-compiler based on MXE/MinGW-w64 with posix threads and dynamic linking.

dockcross/windows-shared-x86

Docker Image Size (tag) Docker Pulls

32-bit Windows cross-compiler based on MXE/MinGW-w64 with win32 threads and dynamic linking.

dockcross/windows-armv7

Docker Image Size (tag) Docker Pulls

ARMv7 32-bit Windows cross-compiler based on LLVM/MinGW-w64

dockcross/windows-arm64

Docker Image Size (tag) Docker Pulls

ARMv8 64-bit Windows cross-compiler based on llvm-mingw

Articles

Built-in update commands

A special update command can be executed that will update the source cross-compiler Docker image or the dockcross script itself.

  • dockcross [--] command [args...]: Forces a command to run inside the container (in case of a name clash with a built-in command), use -- before the command.
  • dockcross update-image: Fetch the latest version of the docker image.
  • dockcross update-script: Update the installed dockcross script with the one bundled in the image.
  • dockcross update: Update both the docker image, and the dockcross script.

Download all images

To easily download all images, the convenience target display_images could be used:

curl https://raw.githubusercontent.com/dockcross/dockcross/master/Makefile -o dockcross-Makefile
for image in $(make -f dockcross-Makefile display_images); do
  echo "Pulling dockcross/$image"
  docker pull dockcross/$image
done

Install all dockcross scripts

To automatically install in ~/bin the dockcross scripts for each images already downloaded, the convenience target display_images could be used:

curl https://raw.githubusercontent.com/dockcross/dockcross/master/Makefile -o dockcross-Makefile
for image in $(make -f dockcross-Makefile display_images); do
  if [[ $(docker images -q dockcross/$image) == "" ]]; then
    echo "~/bin/dockcross-$image skipping: image not found locally"
    continue
  fi
  echo "~/bin/dockcross-$image ok"
  docker run dockcross/$image > ~/bin/dockcross-$image && \
  chmod u+x  ~/bin/dockcross-$image
done

Dockcross configuration

The following environmental variables and command-line options are used. In all cases, the command-line option overrides the environment variable.

DOCKCROSS_CONFIG / --config|-c <path-to-config-file>

This file is sourced, if it exists, before executing the rest of the dockcross script.

Default: ~/.dockcross

DOCKCROSS_IMAGE / --image|-i <docker-image-name>

The Docker cross-compiler image to run.

Default: Image with which the script was created.

DOCKCROSS_ARGS / --args|-a <docker-run-args>

Extra arguments to pass to the docker run command. Quote the entire set of args if they contain spaces.

Per-project dockcross configuration

If a shell script named .dockcross is found in the current directory where the dockcross script is started, it is executed before the dockcross script command argument. The shell script is expected to have a shebang like #!/usr/bin/env bash.

For example, commands like git config --global advice.detachedHead false can be added to this script.

How to extend Dockcross images

In order to extend Dockcross images with your own commands, one must:

  1. Use FROM dockcross/<name_of_image>.
  2. Set DEFAULT_DOCKCROSS_IMAGE to a name of the tag you're planning to use for the image. This tag must then be used during the build phase, unless you mean to pass the resulting helper script the DOCKCROSS_IMAGE argument.

An example Dockerfile would be:

FROM dockcross/linux-armv7

ENV DEFAULT_DOCKCROSS_IMAGE my_cool_image
RUN apt-get install nano

And then in the shell:

docker build -t my_cool_image .                   ## Builds the dockcross image.
docker run my_cool_image > linux-armv7                ## Creates a helper script named linux-armv7.
chmod +x linux-armv7                          ## Gives the script execution permission.
./linux-armv7 bash                            ## Runs the helper script with the argument "bash", which starts an interactive container using your extended image.

What is the difference between dockcross and dockbuild ?

The key difference is that dockbuild images do NOT provide a toolchain file but they use the same method to conveniently isolate the build environment as dockcross.

dockbuild is used to build binaries for Linux x86_64/amd64 that will work across most Linux distributions. dockbuild performs a native Linux build where the host build system is a Linux x86_64 / amd64 Docker image (so that it can be used for building binaries on any system which can run Docker images) and the target runtime system is Linux x86_x64/ amd64.

dockcross is used to build binaries for many different platforms. dockcross performs a cross compilation where the host build system is a Linux x86_64 / amd64 Docker image (so that it can be used for building binaries on any system which can run Docker images) and the target runtime system varies.

---

Credits: