llvm-api-swift

llvm-api-swift is a library representing Swift LLVM API, a pure Swift interface to the LLVM API and its associated libraries. It provides native, easy-to-use components to create compilers codegen backend. It contains LLVM bindings, components and toolset for efficiently use LLVM as compilers backend implementation on Swift.

Compatibility with LLVM-C API

When creating the library, we were guided by full compatibility with LLVM-C API. For this reason, structurally the library tries to inherit the LLVM-C API tree, thereby dividing the library structure into subdirectories. And filling the components also with the appropriate LLVM-C API. When implementing Swift types, we were guided by the approach of abstracting away from C types, completely transforming them into Swift types. At the same time adhering to the principles of a safety and reliability implementation - without explicit memory management, means of safe techniques, functions provided by Swift.

Requirements

• Supported OS: MacOS 12.0 or above

• Swift lang: 5.9 or above

• Install LLVM:

brew install llvm

• Set Environment variables, that provided during brew llvm install
• initialize pkg-config:

./utils/make-pkg-config.swift

NOTE: Every time, when LLVM is updated or installed new version should be run pkg-config step.

Supported LLVM version

• v17.0

Troubleshooting

If LLVM-C head files during compulation doesn't found, make sure that you:

• installed LLVM

llv --version

• Set environment variables for your terminal (for example in .zshrc). To get instruction about variables run:

brew info llvm

• run pkg-config utility:

./utils/make-pkg-config.swift

• if utility doesn't have access right to run:

chmod +x ./utils/make-pkg-config.swift
./utils/make-pkg-config.swift

LICENS: MIT