Scripts to acquire and use UE's Linux toolchain

5 files changed, 126 insertions, 0 deletions

diff --git a/scripts/ue_build_linux/README.md b/scripts/ue_build_linux/README.md
new file mode 100755
index 000000000..8cd589610
--- /dev/null
+++ b/scripts/ue_build_linux/README.md
@@ -0,0 +1,31 @@
+# Build Zen with the UE Linux toolchain

+

+This folder contains scripts to build Zen using the UE Linux toolchain. It

+works by using the --sysroot= option to redirect compilers and linkers to find

+headers and libraries. There are a few components involved;

+

+1) get_ue_toolchain.sh <toolchain_dir>

+

+This will download the required components from Perforce and struicture them in

+such a way that they can be used by both vcpkg and xmake when building Zen.

+

+2) ue_build.sh <toolchain_dir> <prog> [args...] 

+

+Given the toolchain location downloaded in step (1), this script sets up a

+suitable environment and execs the "prog [args...]". It is expected that this

+is used to invoke xmake to build Zen;

+

+```

+$ scripts/ue_linux_build/ue_build.sh ~/uetools xmake config --mode=debug --vcpkg=~/vcpkg

+$ scripts/ue_linux_build/ue_build.sh ~/uetools xmake build

+```

+

+It is possible that `--toolchain=clang` may be required as a configuration

+option. The ue_build.sh script can also be source into the current shell,,

+although it is worth noting that this has never been tried.

+

+3) clang / clang++

+

+These acts as shims to the binaries in `toolchain_dir`, adding in the required

+command line arguments to use the correct headers and libraries. The ue_build.sh

+script adjusts $PATH appropriately.

diff --git a/scripts/ue_build_linux/clang b/scripts/ue_build_linux/clang
new file mode 100755
index 000000000..f3af44c9c
--- /dev/null
+++ b/scripts/ue_build_linux/clang
@@ -0,0 +1,2 @@
+#!/bin/sh
+exec $UE_TOOLCHAIN_DIR/bin/clang --sysroot=$UE_TOOLCHAIN_DIR $CFLAGS $*
diff --git a/scripts/ue_build_linux/clang++ b/scripts/ue_build_linux/clang++
new file mode 100755
index 000000000..d2ebda549
--- /dev/null
+++ b/scripts/ue_build_linux/clang++
@@ -0,0 +1,2 @@
+#!/bin/sh
+exec $UE_TOOLCHAIN_DIR/bin/clang++ --sysroot=$UE_TOOLCHAIN_DIR -stdlib=libc++ $CXXFLAGS $*
diff --git a/scripts/ue_build_linux/get_ue_toolchain.sh b/scripts/ue_build_linux/get_ue_toolchain.sh
new file mode 100755
index 000000000..67fd922c2
--- /dev/null
+++ b/scripts/ue_build_linux/get_ue_toolchain.sh
@@ -0,0 +1,64 @@
+#!/bin/bash
+
+die() { echo "ERROR: $1"; exit; }
+
+if [ -z $1 ]; then
+	echo "usage: $(basename ${BASH_SOURCE[0]}) <output_dir>"
+	exit
+fi
+
+if [ -e $1 ]; then
+	rmdir $1
+	if [ $? -gt 0 ]; then
+		die "$1 is not empty"
+		exit
+	fi
+fi
+
+mkdir -p $1
+cd $1
+
+p4 login -s
+if [ $? -gt 0 ]; then
+	die "Not logged into Perforce"
+fi
+
+# Perforce paths
+if [ -z $AUTOSDK_PATH ]; then
+	AUTOSDK_PATH=//depot/CarefullyRedist/HostLinux/Linux_x64/v21_clang-15.0.1-centos7/x86_64-unknown-linux-gnu
+fi
+
+if [ -z $UE_PATH ]; then
+	UE_PATH=//UE5/Main
+fi
+
+if [ -z $UE_LIBCXX_PATH ]; then
+	UE_LIBCXX_PATH=$UE_PATH/Engine/Source/ThirdParty/Unix/LibCxx
+fi
+
+p4_print() {
+	echo -n $1
+	p4 print -q -o$2/$(basename $1) $1
+	echo
+}
+
+# toolchain
+p4_print $AUTOSDK_PATH/bin/clang* bin
+#p4_print $AUTOSDK_PATH/bin/lld bin
+
+p4_print $AUTOSDK_PATH/lib/gcc/... lib/gcc
+p4_print $AUTOSDK_PATH/lib/clang/*/include/... lib/clang/*/include
+
+# headers
+p4_print $AUTOSDK_PATH/usr/include/...h usr/include
+
+# libraries
+p4_print $AUTOSDK_PATH/lib64/* lib64
+p4_print $AUTOSDK_PATH/usr/lib64/* usr/lib64
+
+mkdir -p usr/lib
+mv usr/lib64/*.o usr/lib
+
+# ue's libc++
+p4_print $UE_LIBCXX_PATH/include/... include
+p4_print $UE_LIBCXX_PATH/lib/Unix/x86_64-unknown-linux-gnu/* lib64
diff --git a/scripts/ue_build_linux/ue_build.sh b/scripts/ue_build_linux/ue_build.sh
new file mode 100755
index 000000000..a15028560
--- /dev/null
+++ b/scripts/ue_build_linux/ue_build.sh
@@ -0,0 +1,27 @@
+#!/bin/bash
+
+die() { echo ERROR: $1; exit 1; }
+
+# Validate input
+if [ -z $1 ]; then
+	echo "usage: $0 <ue_toolchain_dir>"
+	exit 1
+fi
+
+if ! [ -d $1 ]; then
+	die "$1 is not a directory"
+fi
+
+if [ -z $1 ]; then
+	die "$1/bin/clang++ does not exist"
+fi
+
+export UE_TOOLCHAIN_DIR=$(realpath $1)
+export CC="clang"
+export CXX="clang++"
+export LD="clang++"
+
+export PATH="$(realpath $(dirname ${BASH_SOURCE[0]})):$PATH"
+
+shift
+exec $*