xref: /llvm-project/libcxx/utils/ci/Dockerfile (revision d8a0709b1090350a7fe3604d8ab78c7d62f10698)
1# ===----------------------------------------------------------------------===##
2#
3# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4# See https://llvm.org/LICENSE.txt for license information.
5# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6#
7# ===----------------------------------------------------------------------===##
8#
9# This file defines the buildkite and github actions builder images.
10# You can build both images using:
11#
12#   docker compose build
13#
14# Or you can select a single image to build
15#
16#  docker compose build buildkite-builder
17#
18# The final images can be found at
19#
20#  ghcr.io/libcxx/buildkite-builder
21#  ghcr.io/libcxx/actions-builder
22#  ghcr.io/libcxx/android-buildkite-builder
23#
24# Members of the github.com/libcxx/ organizations can push new images to the CI.
25# This is done by GitHub actions in the https://github.com/libcxx/builders repo.
26#
27# ===----------------------------------------------------------------------===##
28#                     Running the buildkite image
29# ===----------------------------------------------------------------------===##
30#
31# To start a Buildkite Agent, run it as:
32#   $ docker run --env-file <secrets> -it $(docker build -q libcxx/utils/ci)
33#
34# The environment variables in `<secrets>` should be the ones necessary
35# to run a BuildKite agent:
36#
37#   BUILDKITE_AGENT_TOKEN=<token>
38#
39# If you're only looking to run the Docker image locally for debugging a
40# build bot, see the `run-buildbot-container` script located in this directory.
41
42
43# HACK: We set the base image in the docker-compose file depending on the final target (buildkite vs github actions).
44# This means we have a much slower container build, but we can use the same Dockerfile for both targets.
45ARG BASE_IMAGE
46FROM $BASE_IMAGE AS builder-base
47
48# Make sure apt-get doesn't try to prompt for stuff like our time zone, etc.
49ENV DEBIAN_FRONTEND=noninteractive
50
51# populated in the docker-compose file
52ARG GCC_LATEST_VERSION
53ENV GCC_LATEST_VERSION=${GCC_LATEST_VERSION}
54
55# populated in the docker-compose file
56ARG LLVM_HEAD_VERSION
57ENV LLVM_HEAD_VERSION=${LLVM_HEAD_VERSION}
58
59# HACK: The github actions runner image already has sudo and requires its use. The buildkite base image does not.
60# Reconcile this.
61RUN <<EOF
62  apt-get update || true
63  apt-get install -y sudo || true
64  echo "ALL ALL = (ALL) NOPASSWD: ALL" | tee /etc/sudoers || true
65EOF
66
67# Installing tzdata before other packages avoids the time zone prompts.
68# These prompts seem to ignore DEBIAN_FRONTEND=noninteractive.
69RUN sudo apt-get update \
70    && sudo apt-get install -y \
71        tzdata
72
73RUN sudo apt-get update \
74    && sudo apt-get install -y \
75        bash \
76        ccache \
77        curl \
78        gdb \
79        git \
80        gpg \
81        language-pack-en \
82        language-pack-fr \
83        language-pack-ja \
84        language-pack-ru \
85        language-pack-zh-hans \
86        libedit-dev \
87        libncurses5-dev \
88        libpython3-dev \
89        libxml2-dev \
90        lsb-release \
91        make \
92        python3 \
93        python3-dev \
94        python3-packaging \
95        python3-setuptools \
96        python3-psutil \
97        software-properties-common \
98        swig \
99        unzip \
100        uuid-dev \
101        wget \
102        xz-utils \
103    && sudo rm -rf /var/lib/apt/lists/*
104
105# Install various tools used by the build or the test suite
106#RUN apt-get update && apt-get install -y ninja-build python3 python3-distutils python3-psutil git gdb ccache
107# TODO add ninja-build once 1.11 is available in Ubuntu, also remove the manual installation.
108RUN <<EOF
109  set -e
110  wget -qO /tmp/ninja.gz https://github.com/ninja-build/ninja/releases/latest/download/ninja-linux.zip
111  gunzip /tmp/ninja.gz
112  chmod a+x /tmp/ninja
113  sudo mv /tmp/ninja /usr/local/bin/ninja
114EOF
115
116
117# These two locales are not enabled by default so generate them
118RUN <<EOF
119  set -e
120  printf "fr_CA ISO-8859-1\ncs_CZ ISO-8859-2" | sudo tee -a /etc/locale.gen
121  sudo mkdir /usr/local/share/i1en/
122  printf "fr_CA ISO-8859-1\ncs_CZ ISO-8859-2" | sudo tee -a /usr/local/share/i1en/SUPPORTED
123  sudo locale-gen
124EOF
125
126# Install Clang <latest>, <latest-1> and ToT, which are the ones we support.
127# We also install <latest-2> because we need to support the "latest-1" of the
128# current LLVM release branch, which is effectively the <latest-2> of the
129# tip-of-trunk LLVM. For example, after branching LLVM 14 but before branching
130# LLVM 15, we still need to have Clang 12 in this Docker image because the LLVM
131# 14 release branch CI uses it. The tip-of-trunk CI will never use Clang 12,
132# though.
133RUN <<EOF
134  set -e
135  sudo apt-get update
136  wget https://apt.llvm.org/llvm.sh -O /tmp/llvm.sh
137  chmod +x /tmp/llvm.sh
138  sudo /tmp/llvm.sh $(($LLVM_HEAD_VERSION - 3)) all  # for CI transitions
139  sudo /tmp/llvm.sh $(($LLVM_HEAD_VERSION - 2)) all  # previous release
140  sudo /tmp/llvm.sh $(($LLVM_HEAD_VERSION - 1)) all  # latest release
141  sudo /tmp/llvm.sh $LLVM_HEAD_VERSION          all  # current ToT
142  sudo apt-get install -y libomp5-$LLVM_HEAD_VERSION
143  sudo rm -rf /var/lib/apt/lists/*
144EOF
145
146# Install the most recent GCC, like clang install the previous version as a transition.
147RUN <<EOF
148  set -e
149  sudo git clone https://github.com/compiler-explorer/infra.git /tmp/ce-infra
150  (cd /tmp/ce-infra && sudo make ce)
151  sudo /tmp/ce-infra/bin/ce_install install compilers/c++/x86/gcc $GCC_LATEST_VERSION.1.0
152  sudo /tmp/ce-infra/bin/ce_install install compilers/c++/x86/gcc $((GCC_LATEST_VERSION - 1)).1.0
153  sudo ln -s /opt/compiler-explorer/gcc-$GCC_LATEST_VERSION.1.0/bin/gcc /usr/bin/gcc-$GCC_LATEST_VERSION
154  sudo ln -s /opt/compiler-explorer/gcc-$GCC_LATEST_VERSION.1.0/bin/g++ /usr/bin/g++-$GCC_LATEST_VERSION
155  sudo ln -s /opt/compiler-explorer/gcc-$((GCC_LATEST_VERSION - 1)).1.0/bin/gcc /usr/bin/gcc-$((GCC_LATEST_VERSION - 1))
156  sudo ln -s /opt/compiler-explorer/gcc-$((GCC_LATEST_VERSION - 1)).1.0/bin/g++ /usr/bin/g++-$((GCC_LATEST_VERSION - 1))
157  sudo rm -rf /tmp/ce-infra
158EOF
159
160RUN <<EOF
161    # Install a recent CMake
162    set -e
163    wget https://github.com/Kitware/CMake/releases/download/v3.24.4/cmake-3.24.4-linux-x86_64.sh -O /tmp/install-cmake.sh
164    sudo bash /tmp/install-cmake.sh --prefix=/usr --exclude-subdir --skip-license
165    rm /tmp/install-cmake.sh
166EOF
167
168# ===----------------------------------------------------------------------===##
169#                       Android Builder Base Image
170# ===----------------------------------------------------------------------===##
171
172FROM ubuntu:jammy AS android-builder-base
173
174ARG ANDROID_CLANG_VERSION
175ARG ANDROID_CLANG_PREBUILTS_COMMIT
176ARG ANDROID_SYSROOT_BID
177
178RUN apt-get update && apt-get install -y curl bzip2 git unzip
179
180# Install the Android platform tools (e.g. adb) into /opt/android/sdk.
181RUN <<EOF
182  set -e
183  mkdir -p /opt/android/sdk
184  cd /opt/android/sdk
185  curl -LO https://dl.google.com/android/repository/platform-tools-latest-linux.zip
186  unzip platform-tools-latest-linux.zip
187  rm platform-tools-latest-linux.zip
188EOF
189
190# Install the current Android compiler. Specify the prebuilts commit to retrieve
191# this compiler version even after it's removed from HEAD.
192
193ENV ANDROID_CLANG_VERSION=$ANDROID_CLANG_VERSION
194ENV ANDROID_CLANG_PREBUILTS_COMMIT=$ANDROID_CLANG_PREBUILTS_COMMIT
195RUN <<EOF
196    set -e
197    git clone --filter=blob:none --sparse \
198        https://android.googlesource.com/platform/prebuilts/clang/host/linux-x86 \
199        /opt/android/clang
200    git -C /opt/android/clang checkout ${ANDROID_CLANG_PREBUILTS_COMMIT}
201    git -C /opt/android/clang sparse-checkout add clang-${ANDROID_CLANG_VERSION}
202    rm -fr /opt/android/clang/.git
203    ln -sf /opt/android/clang/clang-${ANDROID_CLANG_VERSION} /opt/android/clang/clang-current
204    # The "git sparse-checkout" and "ln" commands succeed even if nothing was
205    # checked out, so use this "ls" command to fix that.
206    ls /opt/android/clang/clang-current/bin/clang
207EOF
208
209# Install an Android sysroot. New AOSP sysroots are available at
210# https://ci.android.com/builds/branches/aosp-main/grid, the "ndk" target. The
211# NDK also makes its sysroot prebuilt available at
212# https://android.googlesource.com/platform/prebuilts/ndk/+/refs/heads/dev/platform/sysroot.
213
214ENV ANDROID_SYSROOT_BID=$ANDROID_SYSROOT_BID
215RUN <<EOF
216  set -e
217  cd /opt/android
218  curl -L -o ndk_platform.tar.bz2 \
219      https://androidbuildinternal.googleapis.com/android/internal/build/v3/builds/${ANDROID_SYSROOT_BID}/ndk/attempts/latest/artifacts/ndk_platform.tar.bz2/url
220  tar xf ndk_platform.tar.bz2
221  rm ndk_platform.tar.bz2
222EOF
223
224# ===----------------------------------------------------------------------===##
225#                    Buildkite Builder Image
226# ===----------------------------------------------------------------------===##
227#
228# IMAGE: ghcr.io/libcxx/buildkite-builder.
229#
230FROM builder-base AS buildkite-builder
231
232# Create the libcxx-builder user, regardless of if we use it or not
233RUN sudo useradd --create-home libcxx-builder
234
235USER libcxx-builder
236WORKDIR /home/libcxx-builder
237
238# Install the Buildkite agent and dependencies. This must be done as non-root
239# for the Buildkite agent to be installed in a path where we can find it.
240RUN <<EOF
241  set -e
242  cd /home/libcxx-builder
243  curl -sL https://raw.githubusercontent.com/buildkite/agent/main/install.sh -o /tmp/install-agent.sh
244  bash /tmp/install-agent.sh
245  rm /tmp/install-agent.sh
246  echo "tags=\"queue=libcxx-builders,arch=$(uname -m),os=linux\"" \
247    >> /home/libcxx-builder/.buildkite-agent/buildkite-agent.cfg
248EOF
249
250USER libcxx-builder
251WORKDIR /home/libcxx-builder
252
253ENV PATH="${PATH}:/home/libcxx-builder/.buildkite-agent/bin"
254
255CMD ["buildkite-agent", "start"]
256
257# ===----------------------------------------------------------------------===##
258#                    Android Buildkite Builder Image
259# ===----------------------------------------------------------------------===##
260#
261# IMAGE: ghcr.io/libcxx/android-buildkite-builder.
262#
263FROM buildkite-builder AS android-buildkite-builder
264
265COPY --from=android-builder-base /opt/android /opt/android
266COPY ./vendor/android/container-setup.sh /opt/android/container-setup.sh
267
268ENV PATH="/opt/android/sdk/platform-tools:${PATH}"
269
270USER root
271
272# Install Docker
273RUN <<EOF
274  set -e
275  curl -fsSL https://get.docker.com -o /tmp/get-docker.sh
276  sh /tmp/get-docker.sh
277  rm /tmp/get-docker.sh
278
279  # Install Docker. Mark the binary setuid so it can be run without prefixing it
280  # with sudo. Adding the container user to the docker group doesn't work because
281  # /var/run/docker.sock is owned by the host's docker GID, not the container's
282  # docker GID.
283  chmod u+s /usr/bin/docker
284EOF
285
286USER libcxx-builder
287WORKDIR /home/libcxx-builder
288
289# Reset the configuration, we pass the configuration via the environment.
290RUN cp /home/libcxx-builder/.buildkite-agent/buildkite-agent.dist.cfg \
291       /home/libcxx-builder/.buildkite-agent/buildkite-agent.cfg
292
293# Modify the Buildkite agent cmdline to do Android setup stuff first.
294CMD /opt/android/container-setup.sh && buildkite-agent start
295
296# ===----------------------------------------------------------------------===##
297#                    Github Actions Builder Image
298# ===----------------------------------------------------------------------===##
299#
300# IMAGE: ghcr.io/libcxx/actions-builder.
301#
302FROM builder-base AS actions-builder
303
304WORKDIR /home/runner
305USER runner
306