Swifty-LLVM is a Swifty interface for the LLVM compiler infrastructure, currently wrapping LLVM's C API.
See also: swift-llvm-bindings
This package requires Swift 5.9
This package requires LLVM 17. Major versions of LLVM are not interchangeable or backward-compatible.
If you are using this package for development we strongly recommend
the use of an LLVM with assertions enabled such as
these; otherwise it's much
too easy to violate LLVM's preconditions without knowing it. This
package's devcontainer (in the .devcontainer subdirectory) has
assert-enabled LLVM builds preinstalled in /opt/llvm-Debug and
/opt/llvm-MinSizeRel.
If you want to build with the Swift Package Manager and you choose
to get LLVM some other way, you'll need an installation with an
llvm-config executable, which we will use to create a pkg-config
file for LLVM.
-
Configure: choose a build-directory and a CMake build type (usually
DebugorRelease) and then, where<LLVM>is the path to the root directory of your LLVM installation,cmake -D CMAKE_BUILD_TYPE=<build-type> \ -D LLVM_DIR=<LLVM>/lib/cmake/llvm \ -G Ninja -S . -B <build-directory>(on Windows substitute your shell's line continuation character for
\or just remove the line breaks and backslashes).If you want to run tests, add
-DBUILD_TESTING=1.Note: on macOS, if you are not using your Xcode's default toolchain, you may need
-D CMAKE_Swift_COMPILER=swiftcto prevent CMake from using Xcode's defaultswift.If this command fails it could be because you have an LLVM without CMake support installed; we suggest you try one of these packages instead.
-
Build:
cmake --build <build-directory> -
Test (requires
-DBUILD_TESTING=1in step 1):ctest --parallel --test-dir <build-directory>
-
Generate Xcode project: choose a build-directory and then, where
<LLVM>is the path to the root directory of your LLVM installation,cmake -D LLVM_DIR=<LLVM>/lib/cmake/llvm \ -G Xcode -S . -B <build-directory>If you want to run tests, add
-DBUILD_TESTING=1. -
Profit: open the
.xcodeprojfile in the build-directory and use Xcode's UI to build and test.
First, you need to create a pkgconfig file specific to your
installation and make it visible to your build tools. We use a bash
script as follows in the top-level directory of this project:
./Tools/make-pkgconfig.sh ./llvm.pcif you are on Windows, your git installation (which is required for
Swift) contains a bash executable so you can do something like:
C:\Program Files\Git\bin\bash ./Tools/make-pkgconfig.sh ./llvm.pcThe command above generates llvm.pc in the current directory and
prints its contents to the terminal. You can either add its directory
to your PKG_CONFIG_PATH environment variable for use with
command-line tools:
export PKG_CONFIG_PATH=$PWDor you can put it somewhere that pkg_config already searches (needed
for use with Xcode):
sudo mkdir -p /usr/local/lib/pkgconfig && sudo mv llvm.pc /usr/local/lib/pkgconfig/Once llvm.pc is set up, you should be able to build this project
using Swift package manager:
swift build -c releaseTo test your compiler,
swift test -c release --parallel- Add
platforms: [.macOS("xxx")]toPackage.swiftwherexxxis your macOS version to address the warning complaining that an "object file was built for newer macOS version than being linked". - You may need to add the path to
zstdlibrary inllvm.pc.