Subversion Repositories QNX 8.QNX8 LLVM/Clang compiler suite

Rev

Rev 34 | Rev 36 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. #!/bin/sh
  2. # LLVM/Clang toolchain cross-compilation script for QNX 8.0 by Pierre-Marie Baty <pm@pmbaty.com>
  3.  
  4. # NOTE TO SELF: DO NOT USE $0 AS THIS SCRIPT CAN BE RUN *OR* SOURCED! (see build-llvm.sh in the VM)
  5.  
  6. export QNXSDK_VERSION="8.0.0" # version of the QNX SDK in use, in <major>.<minor>.<revision> format
  7. export QNXSDK_PATH="../qnx800" # relative location from the path of this script where to find the QNX platform SDK
  8. export QNXSDK_HOSTPATH="host/linux/x86_64" # relative location in QNXSDK_PATH of the tree containing the build tools that are runnable on the build host
  9. export QNXSDK_TARGETPATH="target/qnx" # relative location in QNXSDK_PATH of the tree containing the QNX8 system header files
  10.  
  11. export BUILD_DIR_NAME="llvm-build" # name of the directory on the build host's desktop where the LLVM sources will be built
  12. export BUILD_TARGET_ARCH="x86_64" # CPU architecture to build LLVM for, either "x86_64" or "aarch64"
  13.  
  14. export LLVM_VERSION="16.0.6" # version of LLVM that will be built (ideally the same version as the libc++ supplied by QNX in their platform SDK)
  15. export LLVM_SOURCES_FILE="llvmorg-${LLVM_VERSION}.tar.gz" # name of the file containing LLVM version LLVM_VERSION sources
  16. export LLVM_SOURCES_URL="https://github.com/llvm/llvm-project/archive/refs/tags/${LLVM_SOURCES_FILE}" # download URL of LLVM_SOURCES_FILE
  17. export LLVM_SOURCES_DIR="llvm-project-llvmorg-${LLVM_VERSION}" # name of directory created when extracting LLVM_SOURCES_FILE
  18.  
  19. export LLVM_PROJECTS_TO_BUILD="clang;lld;polly" # semicolon-separated list of LLVM projects to build (full list: "clang;clang-tools-extra;cross-project-tests;libc;libclc;lld;lldb;openmp;polly;pstl")
  20. export LLVM_RUNTIMES_TO_BUILD="compiler-rt" # semicolon-separated list of LLVM runtimes to build (full list: "compiler-rt;libc;libcxx;libcxxabi;libunwind;openmp")
  21. export LLVM_BUILD_CONFIGURATION_TYPE="MinSizeRel" # build configuration, one of "Debug", "Release", "RelWithDebugInfo" or "MinSizeRel"
  22.  
  23. export REQUIRED_TOOLS="wget python3 cmake gcc g++ ninja ccache" # list of build tools required to build all this on the build host
  24.  
  25. # see where we are
  26. export CURRENT_DIR="$(pwd)"
  27.  
  28. print_error_and_die()
  29. {
  30.         # a handy function that does what it says. Args: error strings to print, one line per argument
  31.         test -z "${COLUMNS}" && COLUMNS=80
  32.         echo ""
  33.         while [ -n "${1}" ]; do
  34.                 echo "${1}"|fold -s -w "${COLUMNS}"
  35.                 shift
  36.         done
  37.         echo ""
  38.         exit 1
  39. }
  40.  
  41. # verify we're a x86_64 Linux host
  42. if [ ! "$(uname)" = "Linux" ] || [ ! "$(uname -m)" = "x86_64" ]; then
  43.         print_error_and_die "Error: this script requires a x86_64 Linux machine (possibly a virtual machine, or WSL) as the build host."
  44. fi
  45.  
  46. # verify that we have the required tools
  47. for REQUIRED_TOOL in ${REQUIRED_TOOLS}; do
  48.         "${REQUIRED_TOOL}" --version > /dev/null 2>&1 || print_error_and_die \
  49.                 "Error: this script requires at the very least the following tools installed:" \
  50.                 "       $(echo "${REQUIRED_TOOLS}"|sed 's/ /\n  /g')" \
  51.                 "Please install them (possibly as binary packages with apt-get) and try again." \
  52.                 "More specifically, the following tool was not found: '${REQUIRED_TOOL}'"
  53. done
  54.  
  55. # verify that we have the QNX platform SDK
  56. if [ ! -d "${QNXSDK_PATH}/${QNXSDK_HOSTPATH}" ] || [ ! -d "${QNXSDK_PATH}/${QNXSDK_TARGETPATH}" ]; then
  57.         print_error_and_die "Error: the ${QNXSDK_PATH} path doesn't contain a QNX SDK. It must contain the 'host' and 'target' directories of the QNX SDP for the targeted version of QNX and the ${BUILD_TARGET_ARCH} platform. Please deploy these directories and try again."
  58. fi
  59.  
  60. # change to an immediately visible path, i.e. the user's desktop (failsafe to $HOME if xdg-user-dir is unavailable or points to a nonexistent directory)
  61. STAGING_PATH="$(xdg-user-dir DESKTOP 2>/dev/null || echo "${HOME}")"
  62. test -d "${STAGING_PATH}" || STAGING_PATH="${HOME}"
  63. cd "${STAGING_PATH}"
  64.  
  65. # are we running the Windows Subsystem for Linux, instead of a real Linux ?
  66. if [ -n "${WSL_DISTRO_NAME}" ]; then
  67.         # yes. In order to avoid the horrible 9p protocol for file interchange between NTFS and ext4 (a remarkably bad idea by Microsoft),
  68.         # use the copy of the QNX SDP that our caller is supposed to have put in our $HOME in the WSL2 filesystem. The speed gain is considerable.
  69.         QNXSDK_CANONICAL_PATH="${HOME}/$(basename "${QNXSDK_PATH}")"
  70.         if [ ! -d "${QNXSDK_CANONICAL_PATH}/${QNXSDK_HOSTPATH}" ] || [ ! -d "${QNXSDK_CANONICAL_PATH}/${QNXSDK_TARGETPATH}" ]; then
  71.                 print_error_and_die "Error: the QNX SDP hasn't been deployed to ${QNXSDK_CANONICAL_PATH}. Please do so and run this script again."
  72.         fi
  73. else
  74.         # we're not in WSL. We can expect reasonably good file access speeds to the QNX SDP that's bundled with this repository, so just use it.
  75.         QNXSDK_CANONICAL_PATH="$(realpath "${CURRENT_DIR}/${QNXSDK_PATH}")"
  76. fi
  77.  
  78. # verify that the symlinks are deployed in the SDK -- just test one of them in each relevant directory ($QNX_HOST for the tools, $QNX_TARGET for the sysroot)
  79. if [ ! -e "${QNXSDK_CANONICAL_PATH}/${QNXSDK_HOSTPATH}/usr/bin/gcc" ] || [ ! -e "${QNXSDK_CANONICAL_PATH}/${QNXSDK_TARGETPATH}/usr/include/readline.h" ]; then
  80.         print_error_and_die \
  81.                 "Error: the toolchain platform-specific symbolic links have not been deployed in this QNX SDK. Please run" \
  82.                 "(on a POSIX machine:)" \
  83.                 "       cd ${QNXSDK_CANONICAL_PATH}" \
  84.                 "       find . -name symlinks.lst -exec ./symlinks.sh {} create \\; && printf 'present' > .symlinks-state" \
  85.                 "(else on a Windows machine:)" \
  86.                 "       cd ${QNXSDK_CANONICAL_PATH}" \
  87.                 "       host\\win64\\x86_64\\usr\\bin\\busybox.exe sh -c \"find . -name symlinks.lst -exec ./symlinks.sh {} create \\; && printf 'present' > .symlinks-state\"" \
  88.                 "Note that this step WILL take time on a Win32 machine, but is only done once."
  89. fi
  90.  
  91. # Create a symlink in /tmp that will lead to the QNX platform SDK so as to avoid spaces in paths if it doesn't exist already
  92. # (this is totally prohibitive with the official QNX toolchain)
  93. if [ ! -L /tmp/qnxsdk ] || [ ! "$(readlink /tmp/qnxsdk)" = "${QNXSDK_CANONICAL_PATH}" ]; then
  94.         echo "Creating symlink to QNX toolchain in /tmp/qnxsdk..."
  95.         rm -rf /tmp/qnxsdk 2>/dev/null
  96.         ln -fs "${QNXSDK_CANONICAL_PATH}" /tmp/qnxsdk || exit 1
  97. fi
  98.  
  99. # setup the environment
  100. export QNX_HOST="/tmp/qnxsdk/${QNXSDK_HOSTPATH}"
  101. export QNX_TARGET="/tmp/qnxsdk/${QNXSDK_TARGETPATH}"
  102. export MAKEFLAGS="-I${QNX_TARGET}/usr/include"
  103. export PATH="${QNX_HOST}/usr/bin:${PATH}"
  104.  
  105. # print the build environment
  106. echo "QNX_HOST=${QNX_HOST}"
  107. echo "QNX_TARGET=${QNX_TARGET}"
  108. echo "MAKEFLAGS=${MAKEFLAGS}"
  109.  
  110. # construct the target triple (actually a quadruple)
  111. export TARGET_ARCH="${BUILD_TARGET_ARCH}"
  112. test "${BUILD_TARGET_ARCH}" = "x86_64" && export TARGET_VENDOR="pc" || export TARGET_VENDOR="unknown"
  113. export TARGET_KERNEL="nto"
  114. export TARGET_SYSTEM="qnx${QNXSDK_VERSION}"
  115. export TARGET_TRIPLE="${TARGET_ARCH}-${TARGET_VENDOR}-${TARGET_KERNEL}-${TARGET_SYSTEM}"
  116. echo "Will build for ${TARGET_TRIPLE}"
  117.  
  118. # download the involved source packages and unpack them if not done yet
  119. download_and_unpack_if_necessary()
  120. {
  121.         # helper function that downloads a sources tarball, extracts it and patches it if necessary
  122.         # args: <sources dirname> <sources filename> <download URL> [optional patchset URL]
  123.         test -d "${1}" && return 0 # if sources directory already exists, nothing to do
  124.         if [ ! -s "${CURRENT_DIR}/${2}" ]; then # if sources archive isn't a nonempty file...
  125.                 echo "Downloading ${1} sources from ${3}..."
  126.                 if ! wget -O "${CURRENT_DIR}/${2}" "${3}"; then
  127.                         # remove output file in case an error occurs
  128.                         rm -f "${CURRENT_DIR}/${2}"
  129.                         exit 1
  130.                 fi
  131.         fi
  132.         echo "Extracting ${1} sources..."
  133.         cd "$(dirname "${1}")"
  134.         if echo "${2}"|grep -q "\.tar\.bz2$"; then
  135.                 # BZip2 tarball
  136.                 tar xjf "${CURRENT_DIR}/${2}" || exit 1
  137.         elif echo "${2}"|grep -q "\.tar\.xz$"; then
  138.                 # XZ tarball
  139.                 tar xJf "${CURRENT_DIR}/${2}" || exit 1
  140.         elif echo "${2}"|grep -q "\.tar\.gz$"; then
  141.                 # GZipped tarball
  142.                 tar xzf "${CURRENT_DIR}/${2}" || exit 1
  143.         else
  144.                 print_error_and_die "Error: unsupported file extension. Please improve the download_and_unpack_if_necessary() shell function to support it."
  145.         fi
  146.         # make sure the expected directory is here after extraction
  147.         if [ ! -d "${1}" ]; then
  148.                 print_error_and_die "Error: couldn't find ${1} in extracted sources."
  149.         fi
  150.         # do we have a patchset to apply ?
  151.         if [ -n "${4}" ]; then
  152.                 echo "Downloading ${1} patchset from ${4}..."
  153.                 wget -O "${CURRENT_DIR}/${2}.patchset" "${4}" || exit 1
  154.                 echo "Applying patchset..."
  155.                 OLDDIR="$(pwd)"
  156.                 cd "${1}"
  157.                 patch -N -Z -p1 < "${CURRENT_DIR}/${2}.patchset" || exit 1
  158.                 cd "${OLDDIR}"
  159.                 unset OLDDIR
  160.         fi
  161.         return 0
  162. }
  163. download_and_unpack_if_necessary "${LLVM_SOURCES_DIR}" "${LLVM_SOURCES_FILE}" "${LLVM_SOURCES_URL}" || exit 1
  164.  
  165. # create the build directory
  166. echo "Wiping out build directory..."
  167. test -e "${BUILD_DIR_NAME}" && rm -rf "${BUILD_DIR_NAME}"
  168. mkdir "${BUILD_DIR_NAME}" || exit 1
  169. cd "${BUILD_DIR_NAME}" || exit 1
  170.  
  171. # create the QNX CMake toolchain file
  172. test -e "${TARGET_TRIPLE}.cmake" || echo '# '${TARGET_TRIPLE}' CMake toolchain file by Pierre-Marie Baty <pm@pmbaty.com>
  173.  
  174. SET(CMAKE_SYSTEM_NAME "QNX")
  175. SET(CMAKE_SYSTEM_VERSION "'${QNXSDK_VERSION}'")
  176.  
  177. SET(QNX "1")
  178. SET(QNXNTO "1")
  179. SET(QNX_HOST "$ENV{QNX_HOST}")
  180. SET(QNX_TARGET "$ENV{QNX_TARGET}")
  181. SET(QNX_PROCESSOR "'${TARGET_ARCH}'")
  182.  
  183. SET(CMAKE_ASM_COMPILER "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-gcc")
  184. SET(CMAKE_ASM_COMPILER_TARGET "gcc_nto${QNX_PROCESSOR}")
  185.  
  186. SET(CMAKE_C_COMPILER "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-gcc")
  187. SET(CMAKE_C_COMPILER_TARGET "gcc_nto${QNX_PROCESSOR}")
  188. SET(CMAKE_C_FLAGS_DEBUG "-g")
  189. SET(CMAKE_C_FLAGS_MINSIZEREL "-Os -DNDEBUG")
  190. SET(CMAKE_C_FLAGS_RELEASE "-O3 -DNDEBUG")
  191. SET(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -g")
  192. SET(CMAKE_C_FLAGS "-D_QNX_SOURCE=1 -I${QNX_TARGET}/usr/include/devs/include_'${TARGET_ARCH}' -I${QNX_TARGET}/usr/include/devs -DDONT_DEFINE_BSD -DDONT_DEFINE___FreeBSD_kernel__ -DDONT_DEFINE_FSCALE -DDONT_DEFINE_MACHINE")
  193.  
  194. SET(CMAKE_CXX_COMPILER "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-g++")
  195. SET(CMAKE_CXX_COMPILER_TARGET "gcc_nto${QNX_PROCESSOR}")
  196. SET(CMAKE_CXX_FLAGS_DEBUG "-g")
  197. SET(CMAKE_CXX_FLAGS_MINSIZEREL "-Os -DNDEBUG")
  198. SET(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG")
  199. SET(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2 -g")
  200. SET(CMAKE_CXX_FLAGS "-D_QNX_SOURCE=1 -I${QNX_TARGET}/usr/include/devs/include_'${TARGET_ARCH}' -I${QNX_TARGET}/usr/include/devs -DDONT_DEFINE_BSD -DDONT_DEFINE___FreeBSD_kernel__ -DDONT_DEFINE_FSCALE -DDONT_DEFINE_MACHINE")
  201.  
  202. SET(CMAKE_LINKER "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-ld.bfd")
  203. SET(CMAKE_SHARED_LINKER_FLAGS "-lsocket")
  204. SET(CMAKE_EXE_LINKER_FLAGS "-lsocket")
  205.  
  206. SET(CMAKE_RANLIB "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-ranlib")
  207.  
  208. SET(CMAKE_NM "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-nm")
  209.  
  210. SET(CMAKE_AR "${QNX_HOST}/usr/bin/'${TARGET_TRIPLE}'-ar")
  211.  
  212. SET(CMAKE_FIND_ROOT_PATH "${QNX_TARGET}")
  213. SET(CMAKE_FIND_ROOT_PATH_HOST_PROGRAM NEVER)
  214. SET(CMAKE_FIND_ROOT_PATH_HOST_LIBRARY ONLY)
  215. SET(CMAKE_FIND_ROOT_PATH_HOST_INCLUDE ONLY)
  216. ' > "${TARGET_TRIPLE}.cmake"
  217.  
  218. backup_and_patch_if_necessary()
  219. {
  220.         # handy function that patches a file in LLVM_SOURCES_DIR with a given sed replacement regex if necessary, creating backups
  221.         # args: <file pathname> <grep_string_to_test_for_presence_of_patch> <sed regex> [<second regex> [...]]
  222.         _PATCHEE_PATHNAME="${1}"
  223.         _PATCHED_PATTERN="${2}"
  224.         # test if already patched
  225.         grep -q "${_PATCHED_PATTERN}" "../${LLVM_SOURCES_DIR}/${_PATCHEE_PATHNAME}" && return
  226.         # tell what we're about to do
  227.         echo "Patching ${_PATCHEE_PATHNAME}..."
  228.         _DOTTED_NAME="$(echo "${_PATCHEE_PATHNAME}"|tr '/' '.')"
  229.         # have a backup first
  230.         test -f "${CURRENT_DIR}/${_DOTTED_NAME} [ORIGINAL]" || cp "../${LLVM_SOURCES_DIR}/${_PATCHEE_PATHNAME}" "${CURRENT_DIR}/${_DOTTED_NAME} [ORIGINAL]" || exit 1
  231.         # perform the patch
  232.         cp -f "${CURRENT_DIR}/${_DOTTED_NAME} [ORIGINAL]" "${CURRENT_DIR}/${_DOTTED_NAME} [PATCHED]" || exit 1
  233.         while [ -n "${3}" ]; do
  234.                 sed -E -i "${3}" "${CURRENT_DIR}/${_DOTTED_NAME} [PATCHED]"
  235.                 shift
  236.         done
  237.         # verify that we did it successfully
  238.         if ! grep -q "${_PATCHED_PATTERN}" "${CURRENT_DIR}/${_DOTTED_NAME} [PATCHED]"; then
  239.                 print_error_and_die "Error: the file ${_PATCHEE_PATHNAME} could not be patched. Please investigate and fix manually."
  240.         fi
  241.         # and put the patched file in place
  242.         cp -f "${CURRENT_DIR}/${_DOTTED_NAME} [PATCHED]" "../${LLVM_SOURCES_DIR}/${_PATCHEE_PATHNAME}" || exit 1
  243. }
  244.  
  245. # patch llvm/lib/Support/Unix/Path.inc if not done yet
  246. # replace:
  247. #       defined(__FreeBSD_kernel__)
  248. # with:
  249. #       (defined(__FreeBSD_kernel__) || defined(__QNXNTO__))
  250. # RATIONALE: the concerned parts of the QNX platform SDK (/usr/include/devs/*) are actually largely based on FreeBSD code, to conveniently use the FreeBSD network stack.
  251. # NONETHELESS, QNX *IS NOT* FreeBSD and "__FreeBSD_kernel__" *SHOULD NOT* be defined, else userland code may falsely assume a genuine FreeBSD include tree to be available,
  252. # which leads to compilation errors caused by include files assumed to be there whereas they are in fact nowhere to be found (ex: /usr/include/sys/user.h, among others).
  253. # The QNX8 platform SDK has thus been patched to NOT define __FreeBSD_kernel__ when the -DDONT_DEFINE___FreeBSD_kernel__ flag is passed, and the feature tests in Path.inc
  254. # that branch into FreeBSD APIs (which ones *are* exposed in the QNX libc since QNX largely shares FreeBSD code) are about to be patched right now to accept __QNXNTO__ too.
  255. # Additionally, support for statfs()/fstatfs() has been restored in the QNX8 platform SDK in /usr/include/devs/sys/mount.h where it was claimed but absent from the QNX8 libc.
  256. # FIXME: these hacks should be moved elsewhere not to pollute the QNX8 platform SDK -- it *SHOULD* be possible to build without devs
  257. backup_and_patch_if_necessary "llvm/lib/Support/Unix/Path.inc" __QNXNTO__ \
  258.         's@defined\(__FreeBSD_kernel__\)@\(defined\(__FreeBSD_kernel__\) \|\| \defined\(__QNXNTO__\)\)@g'
  259.  
  260. # Clang front-end patches
  261. if echo "${LLVM_PROJECTS_TO_BUILD}"|tr ';' '\n'|grep -q "clang"; then
  262.  
  263.         # patch clang/lib/Frontend/InitPreprocessor.cpp
  264.         # replace:
  265.         #         TI.getTargetDefines(LangOpts, Builder);
  266.         # with:
  267.         #         TI.getTargetDefines(LangOpts, Builder);
  268.         #       #ifdef __QNXNTO__
  269.         #         Builder.defineMacro("__QNXNTO__", "1");
  270.         #         Builder.defineMacro("__QNX__", "800"); // <-- set to QNX SDK version, without the intermediary dots
  271.         #         Builder.defineMacro("__X86_64__", "1"); // <-- set to either __X86_64__ or __AARCH64EL__ depending on the build target
  272.         #         Builder.defineMacro("__LITTLEENDIAN__", "1");
  273.         #         Builder.defineMacro("__ELF__", "1");
  274.         #       #endif
  275.         # RATIONALE: this adds the QNX-specific implicit preprocessor definitions. This is not the orthodox way of doing it. But we're in a hurry.
  276.         test "${BUILD_TARGET_ARCH}" = "x86_64" && PLATORM_NATIVE_ARCH_DEFINE="__X86_64__" || PLATORM_NATIVE_ARCH_DEFINE="__AARCH64EL__"
  277.         backup_and_patch_if_necessary "clang/lib/Frontend/InitPreprocessor.cpp" __QNXNTO__ \
  278.                 's@TI\.getTargetDefines\(LangOpts, Builder\);@TI\.getTargetDefines\(LangOpts, Builder\);\n#ifdef __QNXNTO__\n  Builder.defineMacro\("__QNXNTO__", "1"\);\n  Builder.defineMacro("__QNX__", "'$(echo "${QNXSDK_VERSION}"|tr -d '.')'");\n  Builder.defineMacro\("'${PLATORM_NATIVE_ARCH_DEFINE}'", "1"\);\n  Builder.defineMacro\("__LITTLEENDIAN__", "1"\);\n  Builder.defineMacro\("__ELF__", "1"\);\n#endif@'
  279. fi
  280.  
  281. # LLDB patches
  282. if echo "${LLVM_PROJECTS_TO_BUILD}"|tr ';' '\n'|grep -q "lldb"; then
  283.  
  284.         # patch lldb/Source/Host/common/Host.cpp if not done yet
  285.         # replace:
  286.         #       defined(SIGINFO)
  287.         # with:
  288.         #       (defined(SIGINFO) && !defined(__QNXNTO__))
  289.         # RATIONALE: once upon a time (probably in the early steps of the design of their OS), the QNX people defined SIGINFO to the value of SIGUSR1 for a mysterious reason,
  290.         # defeating the purpose of SIGUSR1 completely, which should be a User-Definable signal as mandated by POSIX. Consequently, any userland code that enumerates POSIX signals
  291.         # hits the same value twice, and all is left to solve this problem is to filter either one out. Since SIGINFO, contrarily to SIGUSR1, is an optional signal,
  292.         # this is the value that will be left out. It is not possible to correct this in the platform SDK since all the precompiled userland programs supplied by QNX
  293.         # expect the value of SIGUSR1 for SIGINFO.
  294.         backup_and_patch_if_necessary "lldb/source/Host/common/Host.cpp" __QNXNTO__ \
  295.                 's@defined\(SIGINFO\)@\(defined\(SIGINFO\) \&\& \!defined\(__QNXNTO__\)\)@g'
  296.        
  297.         # FIXME: another patch is needed for LLDB. Basically, the ptrace() POSIX system call doesn't exist on QNX. Instead
  298.         # QNX use their own debug utility: pdebug. Note the /proc filesystem can be used to access a debuggee's virtual memory space.
  299.         # in lldb/source/Host/posix/ProcessLauncherPosixFork.cpp line 196:
  300.         #   if (ptrace(PT_TRACE_ME, 0, nullptr, 0) == -1) // <--- undefined: ptrace, PT_TRACE_ME
  301. fi
  302.  
  303. # compiler-rt patches
  304. if echo "${LLVM_RUNTIMES_TO_BUILD}"|tr ';' '\n'|grep -q "compiler-rt"; then
  305.  
  306.         # patch compiler-rt/lib/builtins/enable_execute_stack.c if not done yet
  307.         # replace:
  308.         #       #include "int_lib.h"
  309.         # with:
  310.         #       #ifdef __QNXNTO__
  311.         #       #define _QNX_SOURCE 1
  312.         #       #endif
  313.         #       #include "int_lib.h"
  314.         # RATIONALE: the QNX people decided to hide most of the UNIX APIs of their libc behind a mandatory _QNX_SOURCE definition to separate the Neutrino primitives from the rest maybe.
  315.         # This name does not "enforce" any standard at all (like _POSIX_SOURCE and similar names), it's just a convenient hack for the QNX people to hide stuff.
  316.         # To put things back on track and expose the POSIX interfaces of their libc to the world, _QNX_SOURCE has been added to the toolchain CMake file, but it happens that
  317.         # when building compiler-rt specifically, the CMAKE_C_FLAGS directive is ignored. Patching the source file seems like the best option to fix that.
  318.         backup_and_patch_if_necessary "compiler-rt/lib/builtins/enable_execute_stack.c" __QNXNTO__ \
  319.                 's@#include "int_lib.h"@#ifdef __QNXNTO__\n#define _QNX_SOURCE 1\n#endif\n#include "int_lib.h"@'
  320.  
  321.         # patch compiler-rt/lib/profile/InstrProfilingUtil.c
  322.         # replace:
  323.         #       #include <sys/mman.h>
  324.         # with:
  325.         #       #ifdef __QNXNTO__
  326.         #       #include <devs/sys/mman.h>
  327.         #       #endif
  328.         #       #include <sys/mman.h>
  329.         # RATIONALE: QNX doesn't define MADV_DONTNEED (but does so for POSIX_MADV_DONTNEED), unfortunately compiler-rt needs the former. By luck, its value is defined in
  330.         # the extra platform headers they borrowed from FreeBSD, i.e. devs/sys/mman.h, and it has the same value, so include both to fix the problem.
  331.         backup_and_patch_if_necessary "compiler-rt/lib/profile/InstrProfilingUtil.c" __QNXNTO__ \
  332.                 's@#include <sys/mman.h>@#ifdef __QNXNTO__\n#include <devs/sys/mman.h>\n#endif\n#include <sys/mman.h>@'
  333.  
  334.         # patch compiler-rt/lib/orc/endianness.h
  335.         # replace:
  336.         #       #elif defined(__MVS__)
  337.         # with:
  338.         #       #elif defined(__QNXNTO__)
  339.         #       #define BYTE_ORDER __BYTE_ORDER__
  340.         #       #elif defined(__MVS__)
  341.         # RATIONALE: QNX doesn't provide a <machine/endian.h> header directly: the user must specify the machine-specific include path (e.g. -isystem ${QNX_TARGET}/usr/include/devs/include_x86_64)
  342.         # Instead of going through platform detection logic, we supply the only definition this file needs, which is opportunisticly the same one that GCC and Clang provide implicitly.
  343.         backup_and_patch_if_necessary "compiler-rt/lib/orc/endianness.h" __QNXNTO__ \
  344.                 's@#elif defined\(__MVS__\)@#elif defined\(__QNXNTO__\)\n#define BYTE_ORDER __BYTE_ORDER__\n#elif defined\(__MVS__\)@'
  345. fi
  346.  
  347. # libunwind patches
  348. if echo "${LLVM_RUNTIMES_TO_BUILD}"|tr ';' '\n'|grep -q "libunwind"; then
  349.  
  350.         # patch libunwind/src/libunwind.cpp
  351.         # replace:
  352.         #       #include <libunwind.h>:
  353.         # with:
  354.         #       #ifdef __QNXNTO__
  355.         #       #define _QNX_SOURCE 1
  356.         #       #endif
  357.         #       #include <libunwind.h>
  358.         # RATIONALE: the pthreads implementation in QNX 'steals' things from the POSIX.1 standard and hides them behind the __EXT_QNX macro,
  359.         # which is defined when either _QNX_SOURCE or __EXT without anything else is defined. This is not correct and low-level libraries
  360.         # such as libunwind that do not define either of those fail to build. Also note that a FreeBSD-compatible header was added to the QNX8
  361.         # platform SDK: /usr/include/link.h, which defines Elf types as Elf64/Elf32 types depending on the architecture and adds some glue.
  362.         backup_and_patch_if_necessary "libunwind/src/libunwind.cpp" __QNXNTO__ \
  363.                 's@#include <libunwind.h>@#ifdef __QNXNTO__\n#define _QNX_SOURCE 1\n#endif\n#include <libunwind.h>@'
  364. fi
  365.  
  366. # libc++ patches
  367. if echo "${LLVM_PROJECTS_TO_BUILD}"|tr ';' '\n'|grep -q "libcxx"; then
  368.  
  369.         # patch libcxx/include/__config
  370.         # replace:
  371.         #       #      define _LIBCPP_HAS_THREAD_API_WIN32
  372.         # with:
  373.         #       #      define _LIBCPP_HAS_THREAD_API_WIN32
  374.         #       #    elif defined(__QNXNTO__)
  375.         #       #      define _LIBCPP_HAS_THREAD_API_PTHREAD
  376.         #       #      define _LIBCPP_HAS_COND_CLOCKWAIT
  377.         #       #      define _LIBCPP_HAS_CLOCK_GETTIME
  378.         # RATIONALE: simply bring QNX among the list of systems known by libc++ to expose a pthreads API; while we're at it inform it that pthread_cond_clockwait() is available
  379.         # and that the standard POSIX clock_gettime() is available to return a realtime wall clock value in nanoseconds (this might not be the optimal way of getting it though).
  380.         backup_and_patch_if_necessary "libcxx/include/__config" __QNXNTO__ \
  381.                 's@#      define _LIBCPP_HAS_THREAD_API_WIN32@#      define _LIBCPP_HAS_THREAD_API_WIN32\n#    elif defined(__QNXNTO__)\n#      define _LIBCPP_HAS_THREAD_API_PTHREAD\n#      define _LIBCPP_HAS_COND_CLOCKWAIT\n#      define _LIBCPP_HAS_CLOCK_GETTIME@'
  382.        
  383.         # patch libcxx/include/__locale
  384.         # replace:
  385.         #       # include <__support/openbsd/xlocale.h>
  386.         # with:
  387.         #       # include <__support/openbsd/xlocale.h>
  388.         #       #elif defined(__QNXNTO__)
  389.         #       # include <__support/qnx/xlocale.h>
  390.         # and:
  391.         #       #elif defined(__MVS__)
  392.         # with:
  393.         #       #elif defined(__QNXNTO__)
  394.         #           typedef short mask;
  395.         #           static const mask space  = (_CN|_SP|_XS);
  396.         #           static const mask print  = (_DI|_LO|_PU|_SP|_UP|_XA);
  397.         #           static const mask cntrl  = _BB;
  398.         #           static const mask upper  = _UP;
  399.         #           static const mask lower  = _LO;
  400.         #           static const mask alpha  = (_LO|_UP|_XA);
  401.         #           static const mask digit  = _DI;
  402.         #           static const mask punct  = _PU;
  403.         #           static const mask xdigit = _XD;
  404.         #           static const mask blank  = (_SP|_XB);
  405.         #           static const mask __regex_word = 0x1000;
  406.         #       #elif defined(__MVS__)
  407.         # RATIONALE: add QNX-specific locale C++ bindings and definitions
  408.         backup_and_patch_if_necessary "libcxx/include/__locale" __QNXNTO__ \
  409.                 's@# include <__support/openbsd/xlocale.h>@# include <__support/openbsd/xlocale.h>\n#elif defined\(__QNXNTO__\)\n# include <__support/qnx/xlocale.h>@' \
  410.                 's@#elif defined\(__MVS__\)@#elif defined\(__QNXNTO__\)\n    typedef short mask;\n    static const mask space  = \(_CN\|_SP\|_XS\);\n    static const mask print  = \(_DI\|_LO\|_PU\|_SP\|_UP\|_XA\);\n    static const mask cntrl  = _BB;\n    static const mask upper  = _UP;\n    static const mask lower  = _LO;\n    static const mask alpha  = \(_LO\|_UP\|_XA\);\n    static const mask digit  = _DI;\n    static const mask punct  = _PU;\n    static const mask xdigit = _XD;\n    static const mask blank  = \(_SP\|_XB\);\n    static const mask __regex_word = 0x1000;\n#elif defined\(__MVS__\)@'
  411.        
  412.         # patch libcxx/include/CMakeLists.txt
  413.         # replace:
  414.         #         __support/openbsd/xlocale.h
  415.         # with:
  416.         #         __support/openbsd/xlocale.h
  417.         #         __support/qnx/xlocale.h
  418.         # RATIONALE: add QNX-specific locale C++ bindings and definitions
  419.         backup_and_patch_if_necessary "libcxx/include/CMakeLists.txt" qnx/xlocale.h \
  420.                 's@  __support/openbsd/xlocale.h@  __support/openbsd/xlocale.h\n  __support/qnx/xlocale.h@'
  421.        
  422.         # add __support/qnx/xlocale.h to the libc++ source tree
  423.         # RATIONALE: add QNX-specific locale C++ bindings and definitions
  424.         test -d "../${LLVM_SOURCES_DIR}/libcxx/include/__support/qnx" || mkdir "../${LLVM_SOURCES_DIR}/libcxx/include/__support/qnx" || exit 1
  425.         test -f "../${LLVM_SOURCES_DIR}/libcxx/include/__support/qnx/xlocale.h" || cp "${QNX_TARGET}/usr/include/c++/v1/__support/qnx/xlocale.h" "../${LLVM_SOURCES_DIR}/libcxx/include/__support/qnx/xlocale.h" || exit 1
  426.        
  427.         # patch libcxx/include/locale
  428.         # replace:
  429.         #       !defined(__BIONIC__) && !defined(_NEWLIB_VERSION) && !defined(__EMSCRIPTEN__)
  430.         # with:
  431.         #       !defined(__BIONIC__) && !defined(_NEWLIB_VERSION) && !defined(__EMSCRIPTEN__) && !defined(__QNXNTO__)
  432.         # RATIONALE: QNX doesn't have catopen() to open a "message catalog"
  433.         backup_and_patch_if_necessary "libcxx/include/locale" __QNXNTO__ \
  434.                 's@\!defined\(__BIONIC__\) \&\& \!defined\(_NEWLIB_VERSION\) \&\& \!defined\(__EMSCRIPTEN__\)@!defined\(__BIONIC__\) \&\& !defined\(_NEWLIB_VERSION\) \&\& !defined\(__EMSCRIPTEN__\) \&\& !defined\(__QNXNTO__\)@'
  435.        
  436.         # patch libcxx/include/setjmp.h
  437.         # replace:
  438.         #       #endif // __cplusplus
  439.         # with:
  440.         #       #ifdef __QNXNTO__
  441.         #       #undef longjmp
  442.         #       [[noreturn]] inline void longjmp(jmp_buf env, int val) { ::siglongjmp(env, val); }
  443.         #       #endif // __QNXNTO__
  444.         #      
  445.         #       #endif // __cplusplus
  446.         # RATIONALE: restore the thread signal mask when calling longjmp() by calling siglongjmp() instead (not sure why, but that's how they do it in the libc++ 16.0.6 they ship with their SDK)
  447.         # FIXME: is this a good idea really? It looks like by calling siglongjmp() instead of longjmp() after setjmp() the QNX people did a broken implementation !?
  448.         backup_and_patch_if_necessary "libcxx/include/setjmp.h" __QNXNTO__ \
  449.                 's@#endif // __cplusplus@#ifdef __QNXNTO__\n#undef longjmp\n\[\[noreturn\]\] inline void longjmp\(jmp_buf env, int val\) { ::siglongjmp\(env, val\); }\n#endif // __QNXNTO_\n\n#endif // __cplusplus@'
  450. fi
  451.  
  452. # polly patches
  453. if echo "${LLVM_PROJECTS_TO_BUILD}"|tr ';' '\n'|grep -q "polly"; then
  454.  
  455.         # patch polly/lib/External/isl/imath/imath.c
  456.         # replace:
  457.         #       /* Select min/max. */
  458.         # with:
  459.         #       #ifdef __QNXNTO__
  460.         #       #undef MIN
  461.         #       #undef MAX
  462.         #       #endif // __QNXNTO__
  463.         #       /* Select min/max. */
  464.         # RATIONALE: QNX already defines MIN/MAX as macros, but polly intends to define them as inline functions. Perhaps this could be avoided by passing _POSIX_SOURCE instead of _QNX_SOURCE.
  465.         backup_and_patch_if_necessary "polly/lib/External/isl/imath/imath.c" __QNXNTO__ \
  466.                 's@\/\* Select min\/max. \*\/@#ifdef __QNXNTO__\n#undef MIN\n#undef MAX\n#endif\n\/\* Select min\/max. \*\/@'
  467. fi
  468.  
  469. # now configure LLVM...
  470. echo "Configuring LLVM build..."
  471. export CCACHE_DIR="$(realpath "../${LLVM_SOURCES_DIR}/.ccache")"
  472. cmake \
  473.     -D CMAKE_TOOLCHAIN_FILE="${TARGET_TRIPLE}.cmake" \
  474.     -D CMAKE_BUILD_TYPE="${LLVM_BUILD_CONFIGURATION_TYPE}" \
  475.     -D CMAKE_INSTALL_PREFIX="/usr/bin" \
  476.     -D CMAKE_STAGING_PREFIX="${CURRENT_DIR}/llvm-build/${BUILD_TARGET_ARCH}" \
  477.     -D CMAKE_C_COMPILER_LAUNCHER="ccache" \
  478.     -D CMAKE_CXX_COMPILER_LAUNCHER="ccache" \
  479.     -D HAVE_STEADY_CLOCK="0" \
  480.     -D LLVM_HOST_TRIPLE="${TARGET_TRIPLE}" \
  481.     -D LLVM_ENABLE_PROJECTS="${LLVM_PROJECTS_TO_BUILD}" \
  482.     -D LLVM_ENABLE_RUNTIMES="${LLVM_RUNTIMES_TO_BUILD}" \
  483.     -D LLVM_TARGETS_TO_BUILD="AArch64;X86" \
  484.     -D DEFAULT_SYSROOT="../../../../../${QNXSDK_TARGETPATH}/${BUILD_TARGET_ARCH}" \
  485.     -D CLANG_DEFAULT_LINKER="ld" \
  486.     -D CLANG_DEFAULT_CXX_STDLIB="libc++" \
  487.     -D COMPILER_RT_BUILD_SANITIZERS="OFF" \
  488.     -D COMPILER_RT_BUILD_XRAY="OFF" \
  489.     -D COMPILER_RT_BUILD_MEMPROF="OFF" \
  490.     -D COMPILER_RT_BUILD_LIBFUZZER="OFF" \
  491.     -D COMPILER_RT_BUILD_PROFILE="OFF" \
  492.     -G Ninja \
  493.     "../${LLVM_SOURCES_DIR}/llvm" || exit 1
  494.  
  495. # and do the Lord's work. https://youtu.be/jcyYmCnkbEE
  496. echo "Building LLVM..."
  497. cmake --build . --target install || exit 1
  498.  
  499. test -z "${WSL_DISTRO_NAME}" && /bin/printf "\n\xF0\x9F\x8D\xBE\x20\x43\x68\x61\x6d\x70\x61\x67\x6e\x65\x2e\n"
  500. exit 0
  501.  
  502. # NOTE: LLD might not produce usable executables on QNX without a GNU LD-compatible linker script (-T option) that defines
  503. # the *SAME* program headers as those generated by the GNU linker! (PHDRS directive). QNX is particularly picky on the layout
  504. # of loadable segments (PT_LOAD): whereas GNU ld generate usually two (one for code, one for data), LLD generates a lot more,
  505. # with different access permissions - and while this is technically correct ELF format (and even more secure), this unusual
  506. # program header layout can be refused by QNX ("can't load xxx: exec format error"). Same if you use ld with '-z separate-code'.
  507. # Also, it is likely that GCC's crti.o/crtn.o being filtered out by LLD from the output executables prevent them to run on QNX.
  508. # https://stackoverflow.com/questions/18091463/why-does-an-assembly-program-only-work-when-linked-with-crt1-o-crti-o-and-crtn-o
  509. # CAVEAT: well worth the read if you intend to use LLD: https://maskray.me/blog/2020-12-19-lld-and-gnu-linker-incompatibilities
  510.  
  511. # TODO optional: port compiler_rt sanitizer bindings and build sanitizers, xray, memprof, libfuzzer and profile
  512. # TODO optional: port lldb bindings and build lldb (implement ptrace)
  513.