├── .gitignore ├── CMakeLists.txt ├── CODEOWNERS ├── LICENSE.txt ├── Package.swift ├── README.md └── Sources ├── CMakeLists.txt ├── Clang ├── CMakeLists.txt └── Clang_AST.apinotes └── LLVM ├── CMakeLists.txt ├── LLVM_Utils.apinotes └── LLVM_Utils.swift /.gitignore: -------------------------------------------------------------------------------- 1 | # Finder 2 | .DS_Store 3 | 4 | # Xcode 5 | xcuserdata 6 | *.xcodeproj 7 | 8 | # Visual Studio 9 | .vs 10 | 11 | # Visual Studio Code 12 | .vscode 13 | 14 | # JetBrains IDEs 15 | .idea 16 | 17 | # clangd 18 | .cache 19 | .clangd 20 | 21 | # SwiftPM 22 | .build 23 | .swiftpm 24 | 25 | # CMake 26 | CMakeCache.txt 27 | CMakeFiles 28 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.18) 2 | 3 | project(SwiftLLVMBindings LANGUAGES C Swift) 4 | 5 | if(CMAKE_SYSTEM_NAME STREQUAL Windows) 6 | option(BUILD_SHARED_LIBS "Build shared libraries by default" YES) 7 | endif() 8 | 9 | set(min_supported_swift_version 5.9) 10 | if(CMAKE_Swift_COMPILER_VERSION VERSION_LESS "${min_supported_swift_version}") 11 | message(FATAL_ERROR "Outdated Swift compiler: " 12 | "Swift ${min_supported_swift_version} or newer is required.") 13 | endif() 14 | 15 | find_package(LLVM CONFIG REQUIRED) 16 | message(STATUS "Found LLVM headers: ${LLVM_MAIN_INCLUDE_DIR}") 17 | message(STATUS "Found LLVM generated headers: ${LLVM_INCLUDE_DIR}") 18 | 19 | add_subdirectory(Sources) 20 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @egorzhdan 2 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | 204 | 205 | ## Runtime Library Exception to the Apache 2.0 License: ## 206 | 207 | 208 | As an exception, if you use this Software to compile your source code and 209 | portions of this Software are embedded into the binary product as a result, 210 | you may redistribute such product without providing attribution as would 211 | otherwise be required by Sections 4(a), 4(b) and 4(d) of the License. 212 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.9 2 | // WARNING: Swift Package Manager support is experimental, please consider using CMake to build this project. 3 | 4 | import PackageDescription 5 | import class Foundation.ProcessInfo 6 | 7 | let env = ProcessInfo.processInfo.environment 8 | 9 | func getLLVMSwiftSettings() -> [SwiftSetting]? { 10 | let env = ProcessInfo.processInfo.environment 11 | guard let llvmHeaderPath = env["SWIFT_LLVM_BINDINGS_PATH_TO_LLVM_HEADERS"] else { 12 | print("please pass an environment variable to swift-package: " + 13 | "SWIFT_LLVM_BINDINGS_PATH_TO_LLVM_HEADERS " + 14 | "(e.g. swift/llvm-project/llvm/include)") 15 | return nil 16 | } 17 | let llvmModuleMapPath = "\(llvmHeaderPath)/module.modulemap" 18 | guard let llvmGeneratedHeaderPath = env["SWIFT_LLVM_BINDINGS_PATH_TO_LLVM_GENERATED_HEADERS"] else { 19 | print("please pass an environment variable to swift-package: " + 20 | "SWIFT_LLVM_BINDINGS_PATH_TO_LLVM_GENERATED_HEADERS " + 21 | "(e.g. swift/build/Ninja-DebugAssert/llvm-macosx-arm64/include)") 22 | return nil 23 | } 24 | 25 | return [ 26 | .interoperabilityMode(.Cxx), 27 | .unsafeFlags([ 28 | "-I\(llvmHeaderPath)", 29 | "-Xcc", "-I\(llvmHeaderPath)", 30 | "-I\(llvmGeneratedHeaderPath)", 31 | "-Xcc", "-I\(llvmGeneratedHeaderPath)", 32 | "-Xcc", "-fmodule-map-file=\(llvmModuleMapPath)", 33 | ]), 34 | ] 35 | } 36 | 37 | let package = Package( 38 | name: "SwiftLLVMBindings", 39 | products: [ 40 | .library(name: "SwiftLLVM_Utils", targets: ["SwiftLLVM_Utils"]), 41 | ], 42 | targets: [ 43 | .target( 44 | name: "SwiftLLVM_Utils", 45 | path: "Sources/LLVM", 46 | exclude: ["CMakeLists.txt", "LLVM_Utils.apinotes"], 47 | sources: ["LLVM_Utils.swift"], 48 | swiftSettings: getLLVMSwiftSettings() 49 | ), 50 | ], 51 | cxxLanguageStandard: .cxx17 52 | ) 53 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Swift Bindings for LLVM 2 | 3 | Swift Bindings for LLVM is a part of the Swift project, and aims to make it 4 | easier and more convenient to use [LLVM](https://github.com/llvm/llvm-project) 5 | APIs from Swift code. 6 | It relies on the experimental Swift/C++ Interoperability, which allows calling 7 | C++ APIs directly from Swift, removing the need for a C bridging layer. 8 | 9 | This is a work-in-progress. The design of the bindings will be changing as 10 | Swift/C++ Interoperability evolves. 11 | 12 | ## Trying it out 13 | 14 | ### Within the Swift compiler project 15 | 16 | (This will be updated once the Swift compiler starts using Swift LLVM Bindings.) 17 | 18 | ### As a standalone project 19 | 20 | A [Swift toolchain](https://www.swift.org/download/) is required to build the 21 | project. The minimum supported Swift version is 5.9. 22 | 23 | Since the bindings rely on LLVM headers, you will need a fresh checkout of LLVM 24 | locally. Both upstream LLVM 25 | ([llvm/llvm-project](https://github.com/llvm/llvm-project)) and Apple's 26 | LLVM fork ([swiftlang/llvm-project](https://github.com/swiftlang/llvm-project)) 27 | are supported. 28 | 29 | Similarly to LLVM, CMake is used to build the bindings. To configure the build 30 | process, run the following command: 31 | 32 | ``` 33 | cmake -G Ninja \ 34 | -D CMAKE_BUILD_TYPE=Debug \ 35 | -D CMAKE_Swift_COMPILER=/Library/Developer/Toolchains/swift-xyz.xctoolchain/usr/bin/swiftc \ 36 | -D LLVM_DIR={PATH_TO_LLVM_BUILD_ROOT}/lib/cmake/llvm \ 37 | -B {PATH_TO_BUILD_ROOT} 38 | ``` 39 | 40 | To build all of the bindings, run: 41 | 42 | ``` 43 | cmake --build {PATH_TO_BUILD_ROOT} --target all 44 | ``` 45 | 46 | To build the bindings for a specific LLVM module (e.g. `LLVM_Utils`), run: 47 | 48 | ``` 49 | cmake --build {PATH_TO_BUILD_ROOT} --target LLVM_Utils 50 | ``` 51 | 52 | ## Branching scheme 53 | 54 | `llvm.org/main` branch tracks the `main` branch 55 | of ([llvm/llvm-project](https://github.com/llvm/llvm-project)). 56 | 57 | `stable/YYYYMMDD` branch tracks the corresponding `stable/YYYYMMDD` branch 58 | of ([swiftlang/llvm-project](https://github.com/swiftlang/llvm-project)). 59 | 60 | ## Contributing 61 | 62 | If you are working on a feature that you intend to use in SwiftCompilerSources, 63 | you should create pull requests against two branches: `llvm.org/main` 64 | and `stable/YYYYMMDD`. If you are merging the pull requests yourself, please 65 | make sure you merge the pull request to `llvm.org/main` branch first. 66 | 67 | Otherwise, you should create pull requests against `llvm.org/main` branch only. 68 | -------------------------------------------------------------------------------- /Sources/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | add_subdirectory(LLVM) 2 | add_subdirectory(Clang) 3 | -------------------------------------------------------------------------------- /Sources/Clang/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | install(FILES Clang_AST.apinotes 2 | DESTINATION include/apinotes) 3 | -------------------------------------------------------------------------------- /Sources/Clang/Clang_AST.apinotes: -------------------------------------------------------------------------------- 1 | Name: Clang_AST 2 | Namespaces: 3 | - Name: clang 4 | Tags: 5 | - Name: Decl 6 | SwiftImportAs: reference 7 | SwiftRetainOp: immortal 8 | SwiftReleaseOp: immortal 9 | -------------------------------------------------------------------------------- /Sources/LLVM/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | add_library(LLVM_Utils 2 | LLVM_Utils.swift) 3 | target_compile_options(LLVM_Utils PUBLIC 4 | "-emit-module" 5 | "SHELL:-Xcc -std=c++17" 6 | "SHELL:-Xcc -fapinotes" 7 | "SHELL:-Xcc -fapinotes-modules" 8 | "SHELL:-Xcc -iapinotes-modules -Xcc ${CMAKE_CURRENT_SOURCE_DIR}" 9 | "-cxx-interoperability-mode=default") 10 | target_include_directories(LLVM_Utils PUBLIC 11 | "${LLVM_MAIN_INCLUDE_DIR}" 12 | "${LLVM_INCLUDE_DIR}") 13 | install(TARGETS LLVM_Utils 14 | ARCHIVE DESTINATION lib 15 | LIBRARY DESTINATION lib) 16 | install(FILES LLVM_Utils.apinotes 17 | DESTINATION include/apinotes) 18 | -------------------------------------------------------------------------------- /Sources/LLVM/LLVM_Utils.apinotes: -------------------------------------------------------------------------------- 1 | Name: LLVM_Utils 2 | Namespaces: 3 | - Name: llvm 4 | Tags: 5 | - Name: LLVMContext 6 | SwiftImportAs: reference 7 | SwiftRetainOp: immortal 8 | SwiftReleaseOp: immortal 9 | -------------------------------------------------------------------------------- /Sources/LLVM/LLVM_Utils.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Swift.org open source project 4 | // 5 | // Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors 6 | // Licensed under Apache License v2.0 with Runtime Library Exception 7 | // 8 | // See https://swift.org/LICENSE.txt for license information 9 | // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors 10 | // 11 | //===----------------------------------------------------------------------===// 12 | 13 | @_exported import LLVM_Utils // Clang module 14 | 15 | extension String { 16 | public init(_ stringRef: llvm.StringRef) { 17 | self.init(stringRef.str()) 18 | } 19 | 20 | public func withStringRef(_ body: (llvm.StringRef) -> Result) -> Result { 21 | var str = self 22 | return str.withUTF8 { buffer in 23 | return body(llvm.StringRef(buffer.baseAddress, buffer.count)) 24 | } 25 | } 26 | } 27 | 28 | extension StaticString { 29 | public func withStringRef(_ body: (llvm.StringRef) -> Result) -> Result { 30 | return self.withUTF8Buffer { buffer in 31 | return body(llvm.StringRef(buffer.baseAddress, buffer.count)) 32 | } 33 | } 34 | } 35 | 36 | extension std.string { 37 | public init(_ stringRef: llvm.StringRef) { 38 | self = stringRef.str() 39 | } 40 | } 41 | 42 | public func ==(lhs: llvm.StringRef, rhs: StaticString) -> Bool { 43 | #if $NewCxxMethodSafetyHeuristics 44 | let lhsBuffer = UnsafeBufferPointer( 45 | start: lhs.bytes_begin(), 46 | count: Int(lhs.bytes_end() - lhs.bytes_begin())) 47 | #else 48 | let lhsBuffer = UnsafeBufferPointer( 49 | start: lhs.__bytes_beginUnsafe(), 50 | count: Int(lhs.__bytes_endUnsafe() - lhs.__bytes_beginUnsafe())) 51 | #endif 52 | return rhs.withUTF8Buffer { (rhsBuffer: UnsafeBufferPointer) in 53 | if lhsBuffer.count != rhsBuffer.count { return false } 54 | return lhsBuffer.elementsEqual(rhsBuffer, by: ==) 55 | } 56 | } 57 | 58 | extension llvm.Twine: ExpressibleByStringLiteral { 59 | public init(stringLiteral value: String) { 60 | self.init(value) 61 | } 62 | } 63 | --------------------------------------------------------------------------------