LLVM 13 (#106)

* gh: bump code version

* llvm: add task to build llvm using env. variables

* docker: install python in llvm image and bump llvm version

* docker: fixes for llvm 13

* docker: set env. variable for right venv creation

* llvm: fix typo in makefile

* docker: bump cpp-sysroot image

* python: update task to build llvm

* faasmtools: export stack_pointer and mutable globals

* update remaining references to clang-10

* gha: fix libc step

* deps: bump faabric-base to 0.4.0

* libc: not re-build in the tests

* docker: update llvm dockerfile to install toolchain and re-build to use cflags without simd

* gh: remove libc build

* nits: minor formatting changes

* gh: bump faabric submodule and point clapack to the faasm branch

* makefile: add exe ldflags

* makefile: undo change

* build: re-introduce simd

* revert simd and pin wasi-libc to latest commit

* faasmtools: enable simd

* docker: remove comment

* ffi: add extra import to build ctypes statically in cpython

* faabric: bump submodule after merge

Author: csegarragonz

.env

@@ -1,3 +1,3 @@
-SYSROOT_VERSION=0.1.12
-SYSROOT_CLI_IMAGE=faasm/cpp-sysroot:0.1.12
+SYSROOT_VERSION=0.2.0
+SYSROOT_CLI_IMAGE=faasm/cpp-sysroot:0.2.0
 COMPOSE_PROJECT_NAME=cpp-dev

.github/workflows/tests.yml

@@ -19,7 +19,7 @@ jobs:
     if: github.event.pull_request.draft == false
     runs-on: ubuntu-20.04
     container:
-      image: faasm/cpp-sysroot:0.1.12
+      image: faasm/cpp-sysroot:0.2.0
     steps:
       # --- Update code ---
       - name: "Checkout code"
@@ -30,8 +30,6 @@ jobs:
       - name: "Set the GH workspace as a safe git directory"
         run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
       # --- Build libraries to wasm ---
-      - name: "Build libc"
-        run: ./bin/inv_wrapper.sh libc
       - name: "Build libfaasm"
         run: ./bin/inv_wrapper.sh libfaasm
       - name: "Build libfaasmp"

.gitmodules

@@ -13,6 +13,7 @@
 [submodule "third-party/faasm-clapack"]
     path = third-party/faasm-clapack
     url = https://github.com/faasm/faasm-clapack
+	branch = faasm
 [submodule "third-party/faabric"]
     path = third-party/faabric
     url = https://github.com/faasm/faabric.git

Makefile renamed to LLVM.makefile

@@ -1,22 +1,22 @@
 # Project directories
-PROJ_ROOT=${CURDIR}
-LLVM_PROJ_DIR=$(PROJ_ROOT)/third-party/llvm-project
+LLVM_PROJ_DIR=${FAASM_LLVM_DIR}
 
-TOOLCHAIN_DIR=$(PROJ_ROOT)
+TOOLCHAIN_DIR=${FAASM_CPP_PROJ_ROOT}
 TOOLCHAIN_FILE=$(TOOLCHAIN_DIR)/WasiToolchain.cmake
 
 # Install dirs
-FAASM_LOCAL_DIR=/usr/local/faasm
+FAASM_LOCAL_DIR=${FAASM_LOCAL_DIR_ENV}
 PREFIX=$(FAASM_LOCAL_DIR)/toolchain
-FAASM_SYSROOT=/usr/local/faasm/llvm-sysroot
+FAASM_SYSROOT=$(FAASM_LOCAL_DIR)/llvm-sysroot
 
-CLANG_VERSION=10.0.1
+CLANG_VERSION=${FAASM_LLVM_VERSION}
+CLANG_VERSION_MAJOR := $(shell echo $(CLANG_VERSION) | cut -f1 -d.)
 
-BUILD_DIR=$(LLVM_PROJ_DIR)/build
+BUILD_DIR=${FAASM_LLVM_BUILD_DIR}
 LLVM_CONFIG=$(BUILD_DIR)/llvm/bin/llvm-config
 AR=$(BUILD_DIR)/llvm/bin/llvm-ar
 
-WASI_LIBC_DIR=$(PROJ_ROOT)/third-party/wasi-libc
+WASI_LIBC_DIR=${FAASM_WASI_LIBC_DIR}
 
 # -------------------------------------------
 # This is adapted from the wasi-sdk Makefile found here:
@@ -42,8 +42,8 @@ clean-all:
 $(BUILD_DIR)/llvm.BUILT:
 	mkdir -p $(BUILD_DIR)/llvm
 	cd $(BUILD_DIR)/llvm; cmake -G Ninja \
-		-DCMAKE_C_COMPILER=/usr/bin/clang-10 \
-		-DCMAKE_CXX_COMPILER=/usr/bin/clang++-10 \
+		-DCMAKE_C_COMPILER=/usr/bin/clang-$(CLANG_VERSION_MAJOR) \
+		-DCMAKE_CXX_COMPILER=/usr/bin/clang++-$(CLANG_VERSION_MAJOR) \
 		-DCMAKE_BUILD_TYPE=MinSizeRel \
 		-DCMAKE_INSTALL_PREFIX=$(PREFIX) \
 		-DLLVM_TARGETS_TO_BUILD=WebAssembly \
@@ -69,6 +69,7 @@ $(BUILD_DIR)/llvm.BUILT:
 
 # WASI libc
 $(BUILD_DIR)/libc.BUILT: $(BUILD_DIR)/llvm.BUILT
+	mkdir -p $(WASI_LIBC_DIR)/build
 	cd $(WASI_LIBC_DIR); $(MAKE) \
 		THREAD_MODEL=faasm \
 		WASM_CC=$(PREFIX)/bin/clang \
@@ -86,6 +87,7 @@ $(BUILD_DIR)/compiler-rt.BUILT: $(BUILD_DIR)/libc.BUILT
 		-DCOMPILER_RT_BUILD_XRAY=OFF \
 		-DCOMPILER_RT_INCLUDE_TESTS=OFF \
 		-DCOMPILER_RT_HAS_FPIC_FLAG=OFF \
+		-DCOMPILER_RT_ENABLE_IOS=OFF \
 		-DCOMPILER_RT_DEFAULT_TARGET_ONLY=ON \
 		-DLLVM_CONFIG_PATH=$(LLVM_CONFIG) \
 		-DCMAKE_INSTALL_PREFIX=$(PREFIX)/lib/clang/$(CLANG_VERSION)/ \
@@ -102,7 +104,7 @@ $(BUILD_DIR)/libcxx.BUILT: $(BUILD_DIR)/compiler-rt.BUILT
 		-DCMAKE_TOOLCHAIN_FILE=$(TOOLCHAIN_FILE) \
 		-DCMAKE_BUILD_TYPE=RelWithDebugInfo \
 		-DCMAKE_CXX_COMPILER_WORKS=ON \
-                -DCMAKE_C_COMPILER_WORKS=ON \
+    	-DCMAKE_C_COMPILER_WORKS=ON \
 		-DCMAKE_VERBOSE_MAKEFILE:BOOL=ON \
 		-DCMAKE_INSTALL_PREFIX=$(FAASM_SYSROOT) \
 		-DLLVM_COMPILER_CHECKED=ON \

VERSION

@@ -1 +1 @@
-0.1.12
+0.2.0

docker/cpp-sysroot.dockerfile

@@ -1,7 +1,7 @@
-FROM faasm/llvm:10.0.1 as llvm
+FROM faasm/llvm:13.0.1 as llvm
 
 # faabric-base image is not re-built often, so tag may be behind
-FROM faasm/faabric-base:0.3.5
+FROM faasm/faabric-base:0.4.0
 SHELL ["/bin/bash", "-c"]
 ENV CPP_DOCKER="on"
 
@@ -17,7 +17,7 @@ RUN mkdir -p /code \
         https://github.com/faasm/cpp \
         /code/cpp \
     && cd /code/cpp \
-    # Update submodules (not LLVM)
+    && git submodule update --init -f third-party/llvm-project \
     && git submodule update --init -f third-party/faabric \
     && git submodule update --init -f third-party/faasm-clapack \
     && git submodule update --init -f third-party/libffi \
@@ -44,6 +44,8 @@ RUN cd /code/cpp \
         libfaasmpi --native --shared \
     # Install toolchain files
     && inv install \
+    # First build libc
+    && inv llvm.libc \
     # Build Faasm WASM libraries
     && inv \
         libemscripten \
@@ -52,7 +54,6 @@ RUN cd /code/cpp \
         libfaasmpi \
     # Lastly, build the libraries that populate the sysroot
     && inv \
-        libc \
         clapack \
         clapack --clean --shared \
         libffi \

docker/llvm.dockerfile

@@ -1,20 +1,31 @@
 FROM ubuntu:20.04
 
+SHELL ["/bin/bash", "-c"]
+ENV CPP_DOCKER="on"
+
 # Install APT dependencies
 ARG DEBIAN_FRONTEND=noninteractive
 RUN apt update \
+    && apt install -y \
+        curl \
+        gpg \
+        software-properties-common \
+        wget \
+    && wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add - \
+    && add-apt-repository -y -n "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-13 main" \
+    && add-apt-repository -y -n ppa:ubuntu-toolchain-r/test \
+    && apt update \
     && apt upgrade -y \
     && apt install -y \
         autoconf \
-        clang-10 \
-        curl \
+        clang-13 \
         build-essential \
         git \
-        gpg \
         ninja-build \
         pkg-config \
-        software-properties-common \
-        wget
+        python3-dev \
+        python3-pip \
+        python3-venv
 
 # Install up-to-date CMake
 RUN apt remove --purge --auto-remove cmake \
@@ -35,6 +46,9 @@ RUN mkdir -p /code \
     && cd /code/cpp \
     && git submodule update --init -f third-party/llvm-project \
     && git submodule update --init -f third-party/wasi-libc \
-    && make \
+    && ./bin/create_venv.sh \
+    && source venv/bin/activate \
+    && inv install \
+    && inv llvm.build \
     && /usr/local/faasm/toolchain/bin/clang --version \
     && rm -rf /code

docs/upgrade-llvm.md

@@ -3,50 +3,46 @@
 To upgrade the underlying LLVM version you need to:
 
 - Update the _submodule_ in this project (see below)
-- Update the version in `docker/sysroot.dockerfile`
-- Update the version in `faasmtools`
-- Update `Makefile`
-- Grep the project for any other mentions of the LLVM version
-- Run the `inv container.toolchain` task
-- Test it out
-- Run the `inv container.push-toolchain` task
+- Update the version in `docker/cpp-sysroot.dockerfile`
+- Update the version in `faasmtools/env.py`
+- Tag and push the code
+- Re-build the LLVM container (will take some time): `inv docker.build -c llvm`
+- Re-build the cpp-sysroot container: `inv docker.build -c cpp-sysroot`
 
 ## Updating the LLVM submodule
 
 Find the commit related to tag name for the desired release in
 [the LLVM repo](https://github.com/llvm/llvm-project/releases) (e.g.
-`llvmorg-10.0.1`), then:
+`llvmorg-13.0.1`), then:
 
 ```bash
 cd third-party/llvm-project
 git checkout main
 git fetch origin
-git checkout <tag-name>
+git checkout faasm
+git rebase <tag_name>
 ```
 
 # Rebuilding LLVM
 
 To rebuild LLVM, there a couple of options. To rebuild just libc:
 
 ```bash
-make clean-libc
-make
+inv llvm.libc --clean
 ```
 
 To rebuilding all the libs, i.e. libc, libcxx, libcxxabi and
 compiler-rt:
 
 ```bash
-make clean-libs
-make
+inv llvm.libs --clean
 ```
 
 The final option is to rebuild _everything_, including Clang. This only
 necessary if you need to change the underlying LLVM or Clang configuration:
 
 ```bash
-make clean-all
-make
+inv llvm --clean
 ```
 
 ## Troubleshooting the build

faasmtools/build.py

@@ -72,7 +72,9 @@
 # introduced them upstream. Use of atomics means we can't link things together:
 # https://reviews.llvm.org/D59281
 WASM_CFLAGS = [
-    "-O3 -mno-atomics",
+    "-O3",
+    "-mno-atomics",
+    "-msimd128",
     "--sysroot={}".format(WASM_SYSROOT),
     "-m32",
     "-DANSI",
@@ -116,7 +118,9 @@
     "-Xlinker --export=__heap_base",
     "-Xlinker --export=__data_end",
     "-Xlinker --export={}".format(FAASM_WASM_CTORS_FUNC_NAME),
+    "-Xlinker --export=__stack_pointer",
     "-Xlinker --max-memory={}".format(FAASM_WASM_MAX_MEMORY),
+    "-Xlinker --features=mutable-globals,simd128",
     "-Wl,-z,stack-size={} -Wl".format(FAASM_WASM_STACK_SIZE),
     "-Wl,--initial-memory={}".format(FAASM_WASM_INITIAL_MEMORY_SIZE),
 ]

faasmtools/env.py

@@ -11,7 +11,12 @@
 
 # Versioning
 VERSION_FILE = join(PROJ_ROOT, "VERSION")
-LLVM_VERSION = "10.0.1"
+
+# LLVM variables
+LLVM_VERSION = "13.0.1"
+LLVM_DIR = join(THIRD_PARTY_DIR, "llvm-project")
+LLVM_MAKEFILE = join(PROJ_ROOT, "LLVM.makefile")
+WASI_LIBC_DIR = join(THIRD_PARTY_DIR, "wasi-libc")
 
 
 def get_version():

func/CMakeLists.txt

@@ -20,7 +20,6 @@ if (CMAKE_SYSTEM_NAME STREQUAL "Wasm")
     set(CMAKE_EXECUTABLE_SUFFIX ".wasm")
 endif ()
 
-
 if (CMAKE_SYSTEM_NAME STREQUAL "Wasm")
     # ----------------------
     # Wasm build

native_clang.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
-export CXX=/usr/bin/clang++-10
-export CC=/usr/bin/clang-10
-export CPP=/usr/bin/clang-cpp-10
-export LINK=/usr/bin/clang++-10
+export CXX=/usr/bin/clang++-13
+export CC=/usr/bin/clang-13
+export CPP=/usr/bin/clang-cpp-13
+export LINK=/usr/bin/clang++-13
 

sysroot_extras/libffi.imports

@@ -1 +1,2 @@
 ffi_call
+ffi_prep_closure_loc

tasks/__init__.py

@@ -6,13 +6,13 @@
 from . import func
 from . import git
 from . import install
-from . import libc
 from . import libemscripten
 from . import libfaasm
 from . import libfaasmp
 from . import libfaasmpi
 from . import libfake
 from . import libffi
+from . import llvm
 from . import zlib
 
 ns = Collection(
@@ -22,12 +22,12 @@
     func,
     git,
     install,
-    libc,
     libemscripten,
     libfaasm,
     libfaasmp,
     libfaasmpi,
     libfake,
     libffi,
+    llvm,
     zlib,
 )

tasks/format_code.py

@@ -31,7 +31,6 @@ def format(ctx, check=False):
 
     flake8_cmd = [
         "python3 -m flake8",
-        "{}".format("--format" if not check else ""),
         " ".join(files_to_check),
     ]
     flake8_cmd = " ".join(flake8_cmd)
@@ -52,7 +51,7 @@ def format(ctx, check=False):
     )
 
     clang_cmd = [
-        "clang-format-10",
+        "clang-format-13",
         "--dry-run --Werror" if check else "-i",
         " ".join(files_to_check),
     ]

tasks/lib.py

@@ -4,7 +4,7 @@
     FAASM_NATIVE_DIR,
     WASM_SYSROOT,
 )
-from faasmtools.env import PROJ_ROOT
+from faasmtools.env import LLVM_VERSION, PROJ_ROOT
 from os.path import exists, join
 from os import environ, makedirs
 from shutil import rmtree
@@ -33,9 +33,10 @@ def build_faasm_lib(subdir, clean=False, native=False, shared=False):
     makedirs(build_dir, exist_ok=True)
 
     if native:
+        llvm_major = LLVM_VERSION.split(".")[0]
         extras = [
-            "-DCMAKE_C_COMPILER=/usr/bin/clang-10",
-            "-DCMAKE_CXX_COMPILER=/usr/bin/clang++-10",
+            "-DCMAKE_C_COMPILER=/usr/bin/clang-{}".format(llvm_major),
+            "-DCMAKE_CXX_COMPILER=/usr/bin/clang++-{}".format(llvm_major),
         ]
     else:
         extras = [