checkout_build_install_llvm.sh

#!/bin/bash -eux
# Copyright 2016 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
################################################################################

NPROC=$(nproc)

TARGET_TO_BUILD=
case $(uname -m) in
    x86_64)
      TARGET_TO_BUILD=X86
      ARCHITECTURE_DEPS="g++-multilib"
      # Use chromium's clang revision.
      export CC=$WORK/llvm-stage1/bin/clang
      export CXX=$WORK/llvm-stage1/bin/clang++
      ;;
    aarch64)
      TARGET_TO_BUILD=AArch64
      # g++ multilib is not needed on AArch64 because we don't care about i386.
      # We need to install clang and lld using apt because the binary downloaded
      # from Chrome's developer tools doesn't support AArch64.
      # TODO(metzman): Make x86_64 use the distro's clang for consistency once
      # we support AArch64 fully.
      ARCHITECTURE_DEPS="clang lld g++"
      export CC=clang
      export CXX=clang++
      ;;
    *)
      echo "Error: unsupported target $(uname -m)"
      exit 1
      ;;
esac

INTROSPECTOR_DEP_PACKAGES="texinfo bison flex"
# zlib1g-dev is needed for llvm-profdata to handle coverage data from rust compiler
LLVM_DEP_PACKAGES="build-essential make ninja-build git python3 python3-distutils binutils-dev zlib1g-dev $ARCHITECTURE_DEPS $INTROSPECTOR_DEP_PACKAGES"

apt-get update && apt-get install -y $LLVM_DEP_PACKAGES --no-install-recommends

# For manual bumping.
# On each bump a full trial run for everything (fuzzing engines, sanitizers,
# languages, projects, ...) is needed.
# Check CMAKE_VERSION infra/base-images/base-clang/Dockerfile was released
# recently enough to fully support this clang version.
OUR_LLVM_REVISION=llvmorg-18.1.8

mkdir $SRC/chromium_tools
cd $SRC/chromium_tools
git clone https://chromium.googlesource.com/chromium/src/tools/clang
cd clang
# Pin clang script due to https://github.com/google/oss-fuzz/issues/7617
git checkout 9eb79319239629c1b23cf7a59e5ebb2bab319a34

LLVM_SRC=$SRC/llvm-project
# Checkout
CHECKOUT_RETRIES=10
function clone_with_retries {
  REPOSITORY=$1
  LOCAL_PATH=$2
  CHECKOUT_RETURN_CODE=1

  # Disable exit on error since we might encounter some failures while retrying.
  set +e
  for i in $(seq 1 $CHECKOUT_RETRIES); do
    rm -rf $LOCAL_PATH
    git clone $REPOSITORY $LOCAL_PATH
    CHECKOUT_RETURN_CODE=$?
    if [ $CHECKOUT_RETURN_CODE -eq 0 ]; then
      break
    fi
  done

  # Re-enable exit on error. If checkout failed, script will exit.
  set -e
  return $CHECKOUT_RETURN_CODE
}
clone_with_retries https://github.com/llvm/llvm-project.git $LLVM_SRC

git -C $LLVM_SRC checkout $OUR_LLVM_REVISION
echo "Using LLVM revision: $OUR_LLVM_REVISION"

# For fuzz introspector.
echo "Applying introspector changes"
OLD_WORKING_DIR=$PWD
cd $LLVM_SRC
cp -rf /fuzz-introspector/frontends/llvm/include/llvm/Transforms/FuzzIntrospector/ ./llvm/include/llvm/Transforms/FuzzIntrospector
cp -rf /fuzz-introspector/frontends/llvm/lib/Transforms/FuzzIntrospector ./llvm/lib/Transforms/FuzzIntrospector

# LLVM currently does not support dynamically loading LTO passes. Thus, we
# hardcode it into Clang instead. Ref: https://reviews.llvm.org/D77704
/fuzz-introspector/frontends/llvm/patch-llvm.sh
cd $OLD_WORKING_DIR

mkdir -p $WORK/llvm-stage2 $WORK/llvm-stage1
python3 $SRC/chromium_tools/clang/scripts/update.py --output-dir $WORK/llvm-stage1

cd $WORK/llvm-stage2
cmake -G "Ninja" \
  -DLIBCXX_ENABLE_SHARED=OFF \
  -DLIBCXX_ENABLE_STATIC_ABI_LIBRARY=ON \
  -DLIBCXXABI_ENABLE_SHARED=OFF \
  -DCMAKE_BUILD_TYPE=Release \
  -DLLVM_ENABLE_RUNTIMES="compiler-rt;libcxx;libcxxabi" \
  -DLLVM_TARGETS_TO_BUILD="$TARGET_TO_BUILD" \
  -DLLVM_ENABLE_PROJECTS="clang;lld" \
  -DLLVM_BINUTILS_INCDIR="/usr/include/" \
  -DLIBCXXABI_USE_LLVM_UNWINDER=OFF \
  $LLVM_SRC/llvm

ninja -j $NPROC
ninja install
rm -rf $WORK/llvm-stage1 $WORK/llvm-stage2

# libFuzzer sources.
cp -r $LLVM_SRC/compiler-rt/lib/fuzzer $SRC/libfuzzer

# Use the clang we just built from now on.
export CC=clang
export CXX=clang++

function free_disk_space {
    rm -rf $LLVM_SRC $SRC/chromium_tools
    apt-get autoremove --purge -y $LLVM_DEP_PACKAGES
    # Delete unneeded parts of LLVM to reduce image size.
    # See https://github.com/google/oss-fuzz/issues/5170
    LLVM_TOOLS_TMPDIR=/tmp/llvm-tools
    mkdir $LLVM_TOOLS_TMPDIR
    # Move binaries with llvm- prefix that we want into LLVM_TOOLS_TMPDIR.
    mv \
      /usr/local/bin/llvm-ar \
      /usr/local/bin/llvm-as \
      /usr/local/bin/llvm-config \
      /usr/local/bin/llvm-cov \
      /usr/local/bin/llvm-objcopy \
      /usr/local/bin/llvm-nm \
      /usr/local/bin/llvm-profdata \
      /usr/local/bin/llvm-ranlib \
      /usr/local/bin/llvm-symbolizer \
      /usr/local/bin/llvm-undname \
      /usr/local/bin/llvm-readelf \
      $LLVM_TOOLS_TMPDIR

    # Delete remaining llvm- binaries.
    rm -rf /usr/local/bin/llvm-*

    # Restore the llvm- binaries we want to keep.
    mv $LLVM_TOOLS_TMPDIR/* /usr/local/bin/
    rm -rf $LLVM_TOOLS_TMPDIR

    # Remove binaries from LLVM build that we don't need.
    rm -f \
      /usr/local/bin/bugpoint \
      /usr/local/bin/llc \
      /usr/local/bin/lli \
      /usr/local/bin/clang-check \
      /usr/local/bin/clang-refactor \
      /usr/local/bin/clang-offload-wrapper \
      /usr/local/bin/clang-offload-bundler \
      /usr/local/bin/clang-repl \
      /usr/local/bin/clang-check \
      /usr/local/bin/clang-refactor \
      /usr/local/bin/c-index-test \
      /usr/local/bin/clang-rename \
      /usr/local/bin/clang-scan-deps \
      /usr/local/bin/clang-extdef-mapping \
      /usr/local/bin/diagtool \
      /usr/local/bin/sanstats \
      /usr/local/bin/dsymutil \
      /usr/local/bin/verify-uselistorder \
      /usr/local/bin/clang-format

    # Remove unneeded clang libs, CMake files from LLVM build, lld libs, and the
    # libraries.
    # Note: we need fuzzer_no_main libraries for atheris. Don't delete.
    rm -rf \
      /usr/local/lib/libclang* \
      /usr/local/lib/liblld* \
      /usr/local/lib/cmake/
}

if [ "$TARGET_TO_BUILD" == "AArch64" ]
then
  free_disk_space
  # Exit now on AArch64. We don't need to rebuild libc++ because on AArch64 we
  # do not support MSAN nor do we care about i386.
  exit 0
fi

function cmake_libcxx {
  extra_args="$@"
  cmake -G "Ninja" \
      -DLIBCXX_ENABLE_SHARED=OFF \
      -DLIBCXX_ENABLE_STATIC_ABI_LIBRARY=ON \
      -DLIBCXXABI_ENABLE_SHARED=OFF \
      -DLIBCXXABI_USE_LLVM_UNWINDER=OFF \
      -DCMAKE_BUILD_TYPE=Release \
      -DLLVM_ENABLE_PIC=ON \
      -DLLVM_TARGETS_TO_BUILD="$TARGET_TO_BUILD" \
      -DLLVM_ENABLE_RUNTIMES="libcxx;libcxxabi" \
      -DLLVM_BINUTILS_INCDIR="/usr/include/" \
      $extra_args \
      -S $LLVM_SRC/runtimes
}

# 32-bit libraries.
mkdir -p $WORK/i386
cd $WORK/i386
cmake_libcxx \
    -DCMAKE_INSTALL_PREFIX=/usr/i386/ \
    -DCMAKE_C_FLAGS="-m32" \
    -DCMAKE_CXX_FLAGS="-m32"

ninja -j $NPROC cxx
ninja install-cxx
rm -rf $WORK/i386

# MemorySanitizer instrumented libraries.
mkdir -p $WORK/msan
cd $WORK/msan

# https://github.com/google/oss-fuzz/issues/1099
cat <<EOF > $WORK/msan/ignorelist.txt
fun:__gxx_personality_*
EOF

cmake_libcxx \
    -DLLVM_USE_SANITIZER=Memory \
    -DCMAKE_INSTALL_PREFIX=/usr/msan/ \
    -DCMAKE_CXX_FLAGS="-fsanitize-ignorelist=$WORK/msan/ignorelist.txt"

ninja -j $NPROC cxx
ninja install-cxx
rm -rf $WORK/msan

free_disk_space