{ lib, stdenv, llvm_meta , pkgsBuildBuild , fetch , fetchpatch , cmake , python3 , libffi , enableGoldPlugin ? libbfd.hasPluginAPI , libbfd , libpfm , libxml2 , ncurses , version , release_version , zlib , buildLlvmTools , debugVersion ? false , doCheck ? stdenv.isLinux && (!stdenv.isx86_32) && (stdenv.hostPlatform == stdenv.buildPlatform) , enableManpages ? false , enableSharedLibraries ? !stdenv.hostPlatform.isStatic # broken for Ampere eMAG 8180 (c2.large.arm on Packet) #56245 # broken for the armv7l builder , enablePFM ? stdenv.isLinux && !stdenv.hostPlatform.isAarch , enablePolly ? false }: let inherit (lib) optional optionals optionalString; # Used when creating a versioned symlinks of libLLVM.dylib versionSuffixes = with lib; let parts = splitVersion release_version; in imap (i: _: concatStringsSep "." (take i parts)) parts; # Ordinarily we would just the `doCheck` and `checkDeps` functionality # `mkDerivation` gives us to manage our test dependencies (instead of breaking # out `doCheck` as a package level attribute). # # Unfortunately `lit` does not forward `$PYTHONPATH` to children processes, in # particular the children it uses to do feature detection. # # This means that python deps we add to `checkDeps` (which the python # interpreter is made aware of via `$PYTHONPATH` – populated by the python # setup hook) are not picked up by `lit` which causes it to skip tests. # # Adding `python3.withPackages (ps: [ ... ])` to `checkDeps` also doesn't work # because this package is shadowed in `$PATH` by the regular `python3` # package. # # So, we "manually" assemble one python derivation for the package to depend # on, taking into account whether checks are enabled or not: python = if doCheck then let checkDeps = ps: with ps; [ psutil ]; in python3.withPackages checkDeps else python3; in stdenv.mkDerivation (rec { pname = "llvm"; inherit version; src = fetch "llvm" "0r1p5didv4rkgxyvbkyz671xddg6i3dxvbpsi1xxipkla0l9pk0v"; polly_src = fetch "polly" "16qkns4ab4x0azrvhy4j7cncbyb2rrbdrqj87zphvqxm5pvm8m1h"; unpackPhase = '' unpackFile $src mv llvm-${version}* llvm sourceRoot=$PWD/llvm '' + optionalString enablePolly '' unpackFile $polly_src mv polly-* $sourceRoot/tools/polly ''; outputs = [ "out" "lib" "dev" "python" ]; nativeBuildInputs = [ cmake python ] ++ optional enableManpages python3.pkgs.sphinx; buildInputs = [ libxml2 libffi ] ++ optional enablePFM libpfm; # exegesis propagatedBuildInputs = [ ncurses zlib ]; patches = [ # backport, fix building rust crates with lto (fetchpatch { url = "https://github.com/llvm-mirror/llvm/commit/da1fb72bb305d6bc1f3899d541414146934bf80f.patch"; sha256 = "0p81gkhc1xhcx0hmnkwyhrn8x8l8fd24xgaj1whni29yga466dwc"; }) (fetchpatch { url = "https://github.com/llvm-mirror/llvm/commit/cc1f2a595ead516812a6c50398f0f3480ebe031f.patch"; sha256 = "0k6k1p5yisgwx417a67s7sr9930rqh1n0zv5jvply8vjjy4b3kf8"; }) # When cross-compiling we configure llvm-config-native with an approximation # of the flags used for the normal LLVM build. To avoid the need for building # a native libLLVM.so (which would fail) we force llvm-config to be linked # statically against the necessary LLVM components always. ../../llvm-config-link-static.patch ./gnu-install-dirs.patch # Fix invalid std::string(nullptr) for GCC 12 (fetchpatch { name = "nvptx-gcc-12.patch"; url = "https://github.com/llvm/llvm-project/commit/99e64623ec9b31def9375753491cc6093c831809.patch"; sha256 = "0zjfjgavqzi2ypqwqnlvy6flyvdz8hi1anwv0ybwnm2zqixg7za3"; stripLen = 1; }) ../../llvm-7-musl.patch ] ++ lib.optional enablePolly ./gnu-install-dirs-polly.patch; postPatch = optionalString stdenv.isDarwin '' substituteInPlace cmake/modules/AddLLVM.cmake \ --replace 'set(_install_name_dir INSTALL_NAME_DIR "@rpath")' "set(_install_name_dir)" \ --replace 'set(_install_rpath "@loader_path/../''${CMAKE_INSTALL_LIBDIR}" ''${extra_libdir})' "" '' + '' # FileSystem permissions tests fail with various special bits substituteInPlace unittests/Support/CMakeLists.txt \ --replace "Path.cpp" "" rm unittests/Support/Path.cpp '' + optionalString stdenv.hostPlatform.isMusl '' patch -p1 -i ${../../TLI-musl.patch} substituteInPlace unittests/Support/CMakeLists.txt \ --replace "add_subdirectory(DynamicLibrary)" "" rm unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp '' + optionalString stdenv.hostPlatform.isAarch32 '' # skip failing X86 test cases on armv7l rm test/DebugInfo/X86/debug_addr.ll rm test/tools/llvm-dwarfdump/X86/debug_addr.s rm test/tools/llvm-dwarfdump/X86/debug_addr_address_size_mismatch.s rm test/tools/llvm-dwarfdump/X86/debug_addr_dwarf4.s rm test/tools/llvm-dwarfdump/X86/debug_addr_unsupported_version.s rm test/tools/llvm-dwarfdump/X86/debug_addr_version_mismatch.s '' + optionalString (stdenv.hostPlatform.system == "armv6l-linux") '' # Seems to require certain floating point hardware (NEON?) rm test/ExecutionEngine/frem.ll '' + '' patchShebangs test/BugPoint/compile-custom.ll.py '' + '' # Tweak tests to ignore namespace part of type to support # gcc-12: https://gcc.gnu.org/PR103598. # The change below mangles strings like: # CHECK-NEXT: Starting llvm::Function pass manager run. # to: # CHECK-NEXT: Starting {{.*}}Function pass manager run. for f in \ test/Other/new-pass-manager.ll \ test/Other/new-pm-defaults.ll \ test/Other/new-pm-lto-defaults.ll \ test/Other/new-pm-thinlto-defaults.ll \ test/Other/pass-pipeline-parsing.ll \ test/Transforms/Inline/cgscc-incremental-invalidate.ll \ test/Transforms/Inline/clear-analyses.ll \ test/Transforms/LoopUnroll/unroll-loop-invalidation.ll \ test/Transforms/SCCP/preserve-analysis.ll \ test/Transforms/SROA/dead-inst.ll \ test/tools/gold/X86/new-pm.ll \ ; do echo "PATCH: $f" substituteInPlace $f \ --replace 'Starting llvm::' 'Starting {{.*}}' \ --replace 'Finished llvm::' 'Finished {{.*}}' done ''; preConfigure = '' # Workaround for configure flags that need to have spaces cmakeFlagsArray+=( -DLLVM_LIT_ARGS='-svj''${NIX_BUILD_CORES} --no-progress-bar' ) ''; # hacky fix: created binaries need to be run before installation preBuild = '' mkdir -p $out/ ln -sv $PWD/lib $out ''; cmakeFlags = with stdenv; let # These flags influence llvm-config's BuildVariables.inc in addition to the # general build. We need to make sure these are also passed via # CROSS_TOOLCHAIN_FLAGS_NATIVE when cross-compiling or llvm-config-native # will return different results from the cross llvm-config. # # Some flags don't need to be repassed because LLVM already does so (like # CMAKE_BUILD_TYPE), others are irrelevant to the result. flagsForLlvmConfig = [ "-DLLVM_INSTALL_CMAKE_DIR=${placeholder "dev"}/lib/cmake/llvm/" "-DLLVM_ENABLE_RTTI=ON" ] ++ optionals enableSharedLibraries [ "-DLLVM_LINK_LLVM_DYLIB=ON" ]; in flagsForLlvmConfig ++ [ "-DCMAKE_BUILD_TYPE=${if debugVersion then "Debug" else "Release"}" "-DLLVM_INSTALL_UTILS=ON" # Needed by rustc "-DLLVM_BUILD_TESTS=${if doCheck then "ON" else "OFF"}" "-DLLVM_ENABLE_FFI=ON" "-DLLVM_HOST_TRIPLE=${stdenv.hostPlatform.config}" "-DLLVM_DEFAULT_TARGET_TRIPLE=${stdenv.hostPlatform.config}" "-DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=WebAssembly" "-DLLVM_ENABLE_DUMP=ON" ] ++ optionals enableManpages [ "-DLLVM_BUILD_DOCS=ON" "-DLLVM_ENABLE_SPHINX=ON" "-DSPHINX_OUTPUT_MAN=ON" "-DSPHINX_OUTPUT_HTML=OFF" "-DSPHINX_WARNINGS_AS_ERRORS=OFF" ] ++ optionals (enableGoldPlugin) [ "-DLLVM_BINUTILS_INCDIR=${libbfd.dev}/include" ] ++ optionals (isDarwin) [ "-DLLVM_ENABLE_LIBCXX=ON" "-DCAN_TARGET_i386=false" ] ++ optionals (stdenv.hostPlatform != stdenv.buildPlatform) [ "-DCMAKE_CROSSCOMPILING=True" "-DLLVM_TABLEGEN=${buildLlvmTools.llvm}/bin/llvm-tblgen" ( let nativeCC = pkgsBuildBuild.targetPackages.stdenv.cc; nativeBintools = nativeCC.bintools.bintools; nativeToolchainFlags = [ "-DCMAKE_C_COMPILER=${nativeCC}/bin/${nativeCC.targetPrefix}cc" "-DCMAKE_CXX_COMPILER=${nativeCC}/bin/${nativeCC.targetPrefix}c++" "-DCMAKE_AR=${nativeBintools}/bin/${nativeBintools.targetPrefix}ar" "-DCMAKE_STRIP=${nativeBintools}/bin/${nativeBintools.targetPrefix}strip" "-DCMAKE_RANLIB=${nativeBintools}/bin/${nativeBintools.targetPrefix}ranlib" ]; # We need to repass the custom GNUInstallDirs values, otherwise CMake # will choose them for us, leading to wrong results in llvm-config-native nativeInstallFlags = [ "-DCMAKE_INSTALL_PREFIX=${placeholder "out"}" "-DCMAKE_INSTALL_BINDIR=${placeholder "out"}/bin" "-DCMAKE_INSTALL_INCLUDEDIR=${placeholder "dev"}/include" "-DCMAKE_INSTALL_LIBDIR=${placeholder "lib"}/lib" "-DCMAKE_INSTALL_LIBEXECDIR=${placeholder "lib"}/libexec" ]; in "-DCROSS_TOOLCHAIN_FLAGS_NATIVE:list=" + lib.concatStringsSep ";" (lib.concatLists [ flagsForLlvmConfig nativeToolchainFlags nativeInstallFlags ]) ) ]; postBuild = '' rm -fR $out ''; preCheck = '' export LD_LIBRARY_PATH=$LD_LIBRARY_PATH''${LD_LIBRARY_PATH:+:}$PWD/lib ''; postInstall = '' mkdir -p $python/share mv $out/share/opt-viewer $python/share/opt-viewer moveToOutput "bin/llvm-config*" "$dev" substituteInPlace "$dev/lib/cmake/llvm/LLVMExports-${if debugVersion then "debug" else "release"}.cmake" \ --replace "\''${_IMPORT_PREFIX}/lib/lib" "$lib/lib/lib" \ --replace "$out/bin/llvm-config" "$dev/bin/llvm-config" substituteInPlace "$dev/lib/cmake/llvm/LLVMConfig.cmake" \ --replace 'set(LLVM_BINARY_DIR "''${LLVM_INSTALL_PREFIX}")' 'set(LLVM_BINARY_DIR "''${LLVM_INSTALL_PREFIX}'"$lib"'")' '' + optionalString (stdenv.isDarwin && enableSharedLibraries) '' ${lib.concatMapStringsSep "\n" (v: '' ln -s $lib/lib/libLLVM.dylib $lib/lib/libLLVM-${v}.dylib '') versionSuffixes} '' + optionalString (stdenv.buildPlatform != stdenv.hostPlatform) '' cp NATIVE/bin/llvm-config $dev/bin/llvm-config-native ''; inherit doCheck; checkTarget = "check-all"; requiredSystemFeatures = [ "big-parallel" ]; meta = llvm_meta // { homepage = "https://llvm.org/"; description = "A collection of modular and reusable compiler and toolchain technologies"; longDescription = '' The LLVM Project is a collection of modular and reusable compiler and toolchain technologies. Despite its name, LLVM has little to do with traditional virtual machines. The name "LLVM" itself is not an acronym; it is the full name of the project. LLVM began as a research project at the University of Illinois, with the goal of providing a modern, SSA-based compilation strategy capable of supporting both static and dynamic compilation of arbitrary programming languages. Since then, LLVM has grown to be an umbrella project consisting of a number of subprojects, many of which are being used in production by a wide variety of commercial and open source projects as well as being widely used in academic research. Code in the LLVM project is licensed under the "Apache 2.0 License with LLVM exceptions". ''; }; } // lib.optionalAttrs enableManpages { pname = "llvm-manpages"; buildPhase = '' make docs-llvm-man ''; propagatedBuildInputs = []; installPhase = '' make -C docs install ''; postPatch = null; postInstall = null; outputs = [ "out" ]; doCheck = false; meta = llvm_meta // { description = "man pages for LLVM ${version}"; }; })