LLVM C API How to use it with Swift whoami iOS Apps Developer - - PowerPoint PPT Presentation

▶
llvm c api
SMART_READER_LITE
LIVE PREVIEW

LLVM C API How to use it with Swift whoami iOS Apps Developer - - PowerPoint PPT Presentation

Aug 28, 2022 809 likes •1.62k views

LLVM C API How to use it with Swift whoami iOS Apps Developer Compiler Hobbyist Internet User: https://twitter.com/1101_debian https://github.com/AlexDenisov http://lowlevelbits.org Outline Development Environment Hello

slide-1
SLIDE 1

LLVM C API

How to use it with Swift

slide-2
SLIDE 2

whoami

  • iOS Apps Developer
  • Compiler Hobbyist
  • Internet User:

https://twitter.com/1101_debian https://github.com/AlexDenisov http://lowlevelbits.org

slide-3
SLIDE 3

Outline

  • Development Environment
  • Hello LLVM World
  • Code Generation and Execution
  • QA
slide-4
SLIDE 4

Motivation

slide-5
SLIDE 5

Show how to:

Motivation

slide-6
SLIDE 6

Show how to:

  • Use LLVM tooling

Motivation

slide-7
SLIDE 7

Show how to:

  • Use LLVM tooling
  • Deal with common errors

Motivation

slide-8
SLIDE 8

Show how to:

  • Use LLVM tooling
  • Deal with common errors

=> Attract more developers

Motivation

slide-9
SLIDE 9

Demo

slide-10
SLIDE 10
slide-11
SLIDE 11
slide-12
SLIDE 12
slide-13
SLIDE 13
slide-14
SLIDE 14
slide-15
SLIDE 15
slide-16
SLIDE 16

Development Environment

slide-17
SLIDE 17
  • git
  • CMake
  • GNU/Make
  • Modern C++ Compiler

Development Environment

slide-18
SLIDE 18

$ export LLVM_SOURCE_DIR=$HOME/LLVM $ export LLVM_BUILD_DIR=$HOME/LLVMBuild $ export CPU_NUM=`sysctl -n hw.ncpu`

Development Environment

slide-19
SLIDE 19

$ git clone \ http://llvm.org/git/llvm.git \ $LLVM_SOURCE_DIR $ mkdir $LLVM_BUILD_DIR

Development Environment

slide-20
SLIDE 20

$ git clone \ http://llvm.org/git/llvm.git \ $LLVM_SOURCE_DIR $ mkdir $LLVM_BUILD_DIR $ cd $LLVM_BUILD_DIR $ cmake $LLVM_SOURCE_DIR

Development Environment

slide-21
SLIDE 21

$ git clone \ http://llvm.org/git/llvm.git \ $LLVM_SOURCE_DIR $ mkdir $LLVM_BUILD_DIR $ cd $LLVM_BUILD_DIR $ cmake $LLVM_SOURCE_DIR $ make LLVMCore -j $CPU_NUM

Development Environment

slide-22
SLIDE 22

Hello World!

slide-23
SLIDE 23

import LLVM_C

Hello World

slide-24
SLIDE 24

import LLVM_C let name = "Hello World” let module = LLVMModuleCreateWithName(name)

Hello World

slide-25
SLIDE 25

import LLVM_C let name = "Hello World” let module = LLVMModuleCreateWithName(name) LLVMDumpModule(module)

Hello World

slide-26
SLIDE 26

import LLVM_C let name = "Hello World” let module = LLVMModuleCreateWithName(name) LLVMDumpModule(module) LLVMDisposeModule(module)

Hello World

slide-27
SLIDE 27

$ xcrun -sdk macosx \ swiftc HelloWorld.swift

Hello World

slide-28
SLIDE 28

$ xcrun -sdk macosx \ swiftc HelloWorld.swift

Hello World

HelloWorld.swift:1:8: error: no such module 'LLVM_C' import LLVM_C ^

slide-29
SLIDE 29

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/

Hello World

slide-30
SLIDE 30

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/

Hello World

include/llvm-c/Types.h:17:10: note: while building module 'LLVM_Support_DataTypes' imported from include/llvm-c/Types.h: 17: #include "llvm/Support/DataTypes.h" ^ <module-includes>:1:9: note: in file included from <module- includes>:1: #import "Support/DataTypes.h" ^ include/llvm/Support/DataTypes.h:57:3: error: "Must #define __STDC_LIMIT_MACROS before #including Support/DataTypes.h" # error "Must #define __STDC_LIMIT_MACROS before #including Support/DataTypes.h"

slide-31
SLIDE 31

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/ \
  • Xcc -D__STDC_CONSTANT_MACROS \
  • Xcc -D__STDC_LIMIT_MACROS

Hello World

slide-32
SLIDE 32

Undefined symbols for architecture x86_64: "_LLVMAddFunction", referenced from: _main in HelloWorld-f367c0.o __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMAppendBasicBlock", referenced from: _main in HelloWorld-f367c0.o __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMBuildAdd", referenced from: _main in HelloWorld-f367c0.o "_LLVMBuildCall", referenced from: __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMBuildRet", referenced from: _main in HelloWorld-f367c0.o __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMConstInt", referenced from: __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMCreateBuilder", referenced from: _main in HelloWorld-f367c0.o __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMCreateExecutionEngineForModule", referenced from: __TF10HelloWorld14runSumFunctionFTSiSi_Si in HelloWorld-f367c0.o "_LLVMDeleteFunction", referenced from:

Hello World

slide-33
SLIDE 33

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/ \
  • Xcc -D__STDC_CONSTANT_MACROS \
  • Xcc -D__STDC_LIMIT_MACROS \
  • lLLVMCore -lLLVMSupport \
  • L $LLVM_BUILD_DIR/lib

Hello World

slide-34
SLIDE 34

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/ \
  • Xcc -D__STDC_CONSTANT_MACROS \
  • Xcc -D__STDC_LIMIT_MACROS \
  • lLLVMCore -lLLVMSupport \
  • L $LLVM_BUILD_DIR/lib \
  • lc++ -lncurses

Hello World

slide-35
SLIDE 35

Hello World

$ ./HelloWorld

slide-36
SLIDE 36

$ ./HelloWorld ; ModuleID = 'Hello World'

Hello World

slide-37
SLIDE 37

Code Generation

slide-38
SLIDE 38

int sum(int a, int b) { int result = a + b; return result; }

Code Generation

slide-39
SLIDE 39

let int32 = LLVMInt32Type()

Code Generation

slide-40
SLIDE 40

let int32 = LLVMInt32Type() let returnType = int32

Code Generation

slide-41
SLIDE 41

let int32 = LLVMInt32Type() let returnType = int32 var paramTypes = UnsafeMutablePointer.alloc(2) paramTypes.initializeFrom([int32, int32])

Code Generation

slide-42
SLIDE 42

let int32 = LLVMInt32Type() let returnType = int32 var paramTypes = UnsafeMutablePointer.alloc(2) paramTypes.initializeFrom([int32, int32]) let functionType = LLVMFunctionType(returnType, paramTypes, 2, 0)

Code Generation

slide-43
SLIDE 43

let functionType = LLVMFunctionType(returnType, paramTypes, 2, 0) let sumFunction = LLVMAddFunction(module, "sum", functionType)

Code Generation

slide-44
SLIDE 44

Code Generation

$ ./HelloWorld

slide-45
SLIDE 45

$ ./HelloWorld ; ModuleID = 'Hello World’ declare i32 @sum(i32, i32)

Code Generation

slide-46
SLIDE 46

let builder = LLVMCreateBuilder()

Code Generation

slide-47
SLIDE 47

let builder = LLVMCreateBuilder() let entryBlock = LLVMAppendBasicBlock(sumFunction, "entry") LLVMPositionBuilderAtEnd(builder, entryBlock)

Code Generation

slide-48
SLIDE 48

let a = LLVMGetParam(sumFunction, 0) let b = LLVMGetParam(sumFunction, 1)

Code Generation

slide-49
SLIDE 49

let a = LLVMGetParam(sumFunction, 0) let b = LLVMGetParam(sumFunction, 1) let result = LLVMBuildAdd(builder, a, b, "entry")

Code Generation

slide-50
SLIDE 50

let a = LLVMGetParam(sumFunction, 0) let b = LLVMGetParam(sumFunction, 1) let result = LLVMBuildAdd(builder, a, b, "entry") LLVMBuildRet(builder, result)

Code Generation

slide-51
SLIDE 51

$ ./HelloWorld

Code Generation

slide-52
SLIDE 52

$ ./HelloWorld ; ModuleID = 'Hello World’ define i32 @sum(i32, i32) { entry: %result = add i32 %0, %1 ret i32 %result }

Code Generation

slide-53
SLIDE 53

Code Execution

slide-54
SLIDE 54

int sum(int a, int b) { int result = a + b; return result; }

Code Execution

slide-55
SLIDE 55

int sum(int a, int b) { int result = a + b; return result; } int main() { return sum(5, 6); }

Code Execution

slide-56
SLIDE 56

func runSumFunction(a: Int, _ b: Int) -> Int { return 0 } runSumFunction(5, 6)

Code Execution

slide-57
SLIDE 57

func runSumFunction(a: Int, _ b: Int) -> Int { let returnType = int32 let functionType = LLVMFunctionType(returnType, nil, 0, 0) let wrapperFunction = LLVMAddFunction(module, "", functionType) // …

Code Execution

slide-58
SLIDE 58

func runSumFunction(a: Int, _ b: Int) -> Int { // … let entryBlock = LLVMAppendBasicBlock(wrapperFunction, "entry") LLVMPositionBuilderAtEnd(builder, entryBlock) // …

Code Execution

slide-59
SLIDE 59

func runSumFunction(a: Int, _ b: Int) -> Int { // … let argumentsSize = strideof(LLVMValueRef) * 2 let arguments = UnsafeMutablePointer.alloc(argumentsSize) let argA = LLVMConstInt(int32, UInt64(a), 0) let argB = LLVMConstInt(int32, UInt64(b), 0) arguments.initializeFrom([argA, argB]) // …

Code Execution

slide-60
SLIDE 60

func runSumFunction(a: Int, _ b: Int) -> Int { // … let callTemp = LLVMBuildCall(builder, sumFunction, arguments, 2, "sum_temp") LLVMBuildRet(builder, callTemp) return 0

Code Execution

slide-61
SLIDE 61

Code Execution

$ ./HelloWorld

slide-62
SLIDE 62

$ ./HelloWorld ; ModuleID = 'Hello World’ define i32 @sum(i32, i32) { entry: %result = add i32 %0, %1 ret i32 %result } define i32 @0() { entry: %sum_temp = call i32 @sum(i32 5, i32 6) ret i32 %sum_temp }

Code Execution

slide-63
SLIDE 63

let engineSize = strideof(LLVMExecutionEngineRef) let engine = UnsafeMutablePointer.alloc(engineSize) let errorSize = strideof(UnsafeMutablePointer<Int8>) let error = UnsafeMutablePointer.alloc(errorSize)

Code Execution

slide-64
SLIDE 64

let res = LLVMCreateExecutionEngineForModule(engine, module, error) if res != 0 { let msg = String.fromCString(error.memory) print("\(msg)") exit(1) }

Code Execution

slide-65
SLIDE 65

let value = LLVMRunFunction(engine.memory, wrapperFunction, 0, nil) let result = LLVMGenericValueToInt(value, 0) return Int(result)

Code Execution

slide-66
SLIDE 66

LLVMLinkInMCJIT()

Code Execution

slide-67
SLIDE 67

LLVMLinkInMCJIT() LLVMInitializeNativeTarget() LLVMInitializeNativeAsmPrinter()

Code Execution

slide-68
SLIDE 68

Code Execution

$ cd $LLVM_BUILD_DIR $ make llvm-config -j $CPU_NUM

slide-69
SLIDE 69

Code Execution

$ $LLVM_BUILD_DIR/bin/llvm-config \

  • -libs mcjit native
slide-70
SLIDE 70

Code Execution

$ $LLVM_BUILD_DIR/bin/llvm-config \

  • -libs mcjit native
  • lLLVMX86Disassembler -lLLVMX86AsmParser -lLLVMX86CodeGen
  • lLLVMSelectionDAG -lLLVMAsmPrinter -lLLVMCodeGen
  • lLLVMScalarOpts -lLLVMInstCombine -lLLVMInstrumentation
  • lLLVMProfileData -lLLVMTransformUtils -lLLVMBitWriter
  • lLLVMX86Desc -lLLVMMCDisassembler -lLLVMX86Info
  • lLLVMX86AsmPrinter -lLLVMX86Utils -lLLVMMCJIT
  • lLLVMExecutionEngine -lLLVMTarget -lLLVMAnalysis
  • lLLVMRuntimeDyld -lLLVMObject -lLLVMMCParser
  • lLLVMBitReader -lLLVMMC -lLLVMCore -lLLVMSupport
slide-71
SLIDE 71

Code Execution

$ $LLVM_BUILD_DIR/bin/llvm-config \

  • -libs mcjit native | \

sed "s/-l//g" | \ xargs make -j $CPU_NUM

slide-72
SLIDE 72

Code Execution

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/ \
  • Xcc -D__STDC_CONSTANT_MACROS \
  • Xcc -D__STDC_LIMIT_MACROS \
  • lLLVMCore -lLLVMSupport \
  • L $LLVM_BUILD_DIR/lib \
  • lc++ -lncurses
slide-73
SLIDE 73

Code Execution

$ xcrun -sdk macosx \ swiftc HelloWorld.swift \

  • I $LLVM_SOURCE_DIR/include/ \
  • I $LLVM_BUILD_DIR/include/ \
  • Xcc -D__STDC_CONSTANT_MACROS \
  • Xcc -D__STDC_LIMIT_MACROS \

`$LLVM_BUILD_DIR/bin/llvm-config \ —libs mcjit native` \

  • L $LLVM_BUILD_DIR/lib \
  • lc++ -lncurses
slide-74
SLIDE 74

Code Execution

func runSumFunction(a: Int, _ b: Int) -> Int { // … } let sum1 = runSumFunction(5, 6) let sum2 = runSumFunction(10, 42)

slide-75
SLIDE 75

$ ./HelloWorld 


Code Execution

slide-76
SLIDE 76

$ ./HelloWorld 11
 52

Code Execution

slide-77
SLIDE 77

What’s next?

slide-78
SLIDE 78

What’s next?

  • http://lowlevelbits.org/how-to-use-llvm-api-with-swift/
  • http://github.com/AlexDenisov/swift_llvm
  • http://llvm.org/docs/tutorial/index.html
  • http://github.com/AlexDenisov/SwiftKaleidoscope
slide-79
SLIDE 79

Thank You!

http://lowlevelbits.org AlexDenisov,