build-clang-with-args.sh

#!/bin/bash
# Copyright lowRISC contributors.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

## build-clang-with-args.sh
#
# This requires a gcc toolchain dir made by `build-gcc-with-args.sh`
#
# Builds:
# - Clang/LLVM
#
# Then:
# - Appends to `buildinfo` with the clang info
# - Adds cross-compilation configuration files for certain build systems
# - Creates a tar file of the whole install directory

set -e
set -x
set -o pipefail

if ! [ "$#" -ge 3 ]; then
  echo "Usage: $0 <config_name> <target> <dest_dir> <march> <mabi> <mcmodel> <cflags...>"
  exit 2
fi;

## Take configuration from arguments
# This is the name for the tar file.
# Suggested to be the gcc config with s/gcc/clang/. Will be updated if it
# contains 'gcc'
toolchain_name="${1}"
# This is the expected gcc target triple (so we can set a default, and invoke gcc)
toolchain_target="${2}"
# This is the directory where we want the toolchain to added to
toolchain_dest="${3}"
# -march option default value
march="${4}"
# -mabi option default value
mabi="${5}"
# -mcmodel option default value
mcmodel="${6}"
# Remaining cflags for build configurations
toolchain_cflags=("${@:7}")

build_top_dir="${PWD}"

# For *_VERSION variables
# shellcheck source=sw-versions.sh
source "${build_top_dir}/sw-versions.sh"

tag_name="${RELEASE_TAG:-HEAD}"
host_arch="${HOST_ARCH:-x86_64}"
toolchain_full_name="${toolchain_name}-${host_arch}-${tag_name}"

mkdir -p "${build_top_dir}/build"
cd "${build_top_dir}/build"


llvm_dir="${build_top_dir}/build/llvm-project"
if [ ! -d "${llvm_dir}" ]; then
  git clone --branch ${LLVM_BRANCH} ${LLVM_URL} "${llvm_dir}"
fi
cd "${llvm_dir}"
git fetch origin
git checkout --force "${LLVM_VERSION}"

# Clang Symlinks
clang_links_to_create="clang++"
clang_links_to_create+=";${toolchain_target}-clang;${toolchain_target}-clang++"
# LLD Symlinks
lld_links_to_create="ld.lld;ld64.lld"
lld_links_to_create+=";${toolchain_target}-ld.lld;${toolchain_target}-ld64.lld"

llvm_build_dir="${build_top_dir}/build/llvm-build"

# Delete old build artifacts (if they exist)
rm -rf "${llvm_build_dir}"

mkdir -p "${llvm_build_dir}"
cd "${llvm_build_dir}"

# TODO:
# - Stage 2 Build
# - Build compiler-rt and other runtimes

llvm_tools="llvm-ar"
llvm_tools+=";llvm-cov"
llvm_tools+=";llvm-dwarfdump"
llvm_tools+=";llvm-nm"
llvm_tools+=";llvm-objcopy"
llvm_tools+=";llvm-objdump"
llvm_tools+=";llvm-profdata"
llvm_tools+=";llvm-ranlib"
llvm_tools+=";llvm-readelf"
llvm_tools+=";llvm-readobj"
llvm_tools+=";llvm-size"
llvm_tools+=";llvm-strings"
llvm_tools+=";llvm-strip"
llvm_tools+=";llvm-symbolizer"

llvm_distribution_components="clang;"
llvm_distribution_components+=";clang-format"
llvm_distribution_components+=";clang-tidy"
llvm_distribution_components+=";clang-resource-headers"
llvm_distribution_components+=";libclang"
llvm_distribution_components+=";lld"
llvm_distribution_components+=";scan-build"
llvm_distribution_components+=";scan-view"
llvm_distribution_components+=";${llvm_tools}"

cmake "${llvm_dir}/llvm" \
  -Wno-dev \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_INSTALL_PREFIX="${toolchain_dest}" \
  -DLLVM_TARGETS_TO_BUILD="RISCV" \
  -DLLVM_ENABLE_PROJECTS="clang;lld;clang-tools-extra" \
  -DLLVM_ENABLE_BACKTRACES=Off \
  -DLLVM_DEFAULT_TARGET_TRIPLE="${toolchain_target}" \
  -DLLVM_STATIC_LINK_CXX_STDLIB=On \
  -DCLANG_VENDOR="lowRISC" \
  -DBUG_REPORT_URL="toolchains@lowrisc.org" \
  -DLLVM_INCLUDE_EXAMPLES=Off \
  -DLLVM_INCLUDE_DOCS=Off \
  -DLLVM_INSTALL_TOOLCHAIN_ONLY=On \
  -DLLVM_INSTALL_BINUTILS_SYMLINKS=Off \
  -DCLANG_LINKS_TO_CREATE="${clang_links_to_create}" \
  -DLLD_SYMLINKS_TO_CREATE="${lld_links_to_create}" \
  -DLLVM_TOOLCHAIN_TOOLS="${llvm_tools}" \
  -DLLVM_DISTRIBUTION_COMPONENTS="${llvm_distribution_components}"

cmake --build "${llvm_build_dir}" \
  --parallel $(( $(nproc) + 2 )) \
  --target install-distribution

cd "${build_top_dir}"

## Create Toolchain Files!
# These don't yet add cflags ldflags
"${build_top_dir}/generate-clang-cmake-toolchain.sh" \
  "${toolchain_target}" "${toolchain_dest}" "${toolchain_cflags[@]}"
"${build_top_dir}/generate-clang-meson-cross-file.sh" \
  "${toolchain_target}" "${toolchain_dest}" ${march} ${mabi} ${mcmodel} \
  "${toolchain_cflags[@]}"

# Copy LLVM licenses into toolchain
mkdir -p "${toolchain_dest}/share/licenses/llvm"
cp "${llvm_dir}/llvm/LICENSE.TXT" "${toolchain_dest}/share/licenses/llvm"

ls -l "${toolchain_dest}"

# Write out build info
set +o pipefail # head causes pipe failures, so we have to switch off pipefail while we use it.
ct_ng_version_string="$( (set +o pipefail; ct-ng version | head -n1) )"
clang_version_string="$("${toolchain_dest}/bin/clang" --version | head -n1)"
gcc_version_string="$("${toolchain_dest}/bin/${toolchain_target}-gcc" --version | head -n1)"
build_date="$(date -u)"
set -o pipefail

tee "${toolchain_dest}/buildinfo" <<BUILDINFO
Report toolchain bugs to toolchains@lowrisc.org (include this file)

lowRISC toolchain config:  ${toolchain_name}
lowRISC toolchain version: ${tag_name}

Clang version:
  ${clang_version_string}
  (git: ${LLVM_URL} ${LLVM_VERSION})

GCC version:
  ${gcc_version_string}

Crosstool-ng version:
  ${ct_ng_version_string}
  (git: ${CROSSTOOL_NG_URL} ${CROSSTOOL_NG_VERSION})

C Flags:
  -march=${march} -mabi=${mabi} -mcmodel=${mcmodel} ${toolchain_cflags[@]}

Built at ${build_date} on $(hostname)
BUILDINFO

tee "${toolchain_dest}/buildinfo.json" <<BUILDINFO_JSON
{
  "toolchain_config": "${toolchain_name}",
  "kind": "combined",
  "version": "${tag_name}",
  "clang_version": "${clang_version_string}",
  "clang_url": "${LLVM_URL}",
  "clang_git": "${LLVM_VERSION}",
  "gcc_version": "${gcc_version_string}",
  "crosstool-ng_version": "${ct_ng_version_string}",
  "crosstool-ng_url": "${CROSSTOOL_NG_URL}",
  "crosstool-ng_git": "${CROSSTOOL_NG_VERSION}",
  "build_date": "${build_date}",
  "build_host": "$(hostname)"
}
BUILDINFO_JSON

# If `ARTIFACT_STAGING_DIR` is not set, we don't want to leave the final binary
# in the root directory.
artifact_dir="${ARTIFACT_STAGING_DIR:-${build_top_dir}/build}"

# Package up toolchain directory
"${build_top_dir}/create-prefixed-archive.sh" \
  "${toolchain_full_name}" \
  "${toolchain_dest}" \
  "${artifact_dir}"