LLVM 18 support

Author: aykevl

.circleci/config.yml

@@ -10,12 +10,12 @@ commands:
     steps:
       - restore_cache:
           keys:
-            - llvm-source-17-v1
+            - llvm-source-18-v1
       - run:
           name: "Fetch LLVM source"
           command: make llvm-source
       - save_cache:
-          key: llvm-source-17-v1
+          key: llvm-source-18-v1
           paths:
             - llvm-project/clang/lib/Headers
             - llvm-project/clang/include
@@ -105,12 +105,12 @@ jobs:
       - test-linux:
           llvm: "15"
     resource_class: large
-  test-llvm17-go122:
+  test-llvm18-go122:
     docker:
       - image: golang:1.22-bullseye
     steps:
       - test-linux:
-          llvm: "17"
+          llvm: "18"
     resource_class: large
 
 workflows:
@@ -119,5 +119,5 @@ workflows:
       # This tests our lowest supported versions of Go and LLVM, to make sure at
       # least the smoke tests still pass.
       - test-llvm15-go118
-      # This tests LLVM 17 support when linking against system libraries.
-      - test-llvm17-go122
+      # This tests LLVM 18 support when linking against system libraries.
+      - test-llvm18-go122

.github/workflows/build-macos.yml

@@ -43,7 +43,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-${{ matrix.os }}-v2
+          key: llvm-source-18-${{ matrix.os }}-v2
           path: |
             llvm-project/clang/lib/Headers
             llvm-project/clang/include
@@ -68,7 +68,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-build
         with:
-          key: llvm-build-17-${{ matrix.os }}-v2
+          key: llvm-build-18-${{ matrix.os }}-v2
           path: llvm-build
       - name: Build LLVM
         if: steps.cache-llvm-build.outputs.cache-hit != 'true'
@@ -128,7 +128,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        version: [16, 17]
+        version: [16, 17, 18]
     steps:
       - name: Set up Homebrew
         uses: Homebrew/actions/setup-homebrew@master
@@ -152,8 +152,8 @@ jobs:
       - name: Check binary
         run: tinygo version
       - name: Build TinyGo (default LLVM)
-        if: matrix.version == 17
+        if: matrix.version == 18
         run: go install
       - name: Check binary
-        if: matrix.version == 17
+        if: matrix.version == 18
         run: tinygo version

.github/workflows/linux.yml

@@ -43,7 +43,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-linux-alpine-v2
+          key: llvm-source-18-linux-alpine-v1
           path: |
             llvm-project/clang/lib/Headers
             llvm-project/clang/include
@@ -68,7 +68,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-build
         with:
-          key: llvm-build-17-linux-alpine-v2
+          key: llvm-build-18-linux-alpine-v1
           path: llvm-build
       - name: Build LLVM
         if: steps.cache-llvm-build.outputs.cache-hit != 'true'
@@ -196,7 +196,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-linux-asserts-v2
+          key: llvm-source-18-linux-asserts-v1
           path: |
             llvm-project/clang/lib/Headers
             llvm-project/clang/include
@@ -221,7 +221,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-build
         with:
-          key: llvm-build-17-linux-asserts-v2
+          key: llvm-build-18-linux-asserts-v1
           path: llvm-build
       - name: Build LLVM
         if: steps.cache-llvm-build.outputs.cache-hit != 'true'
@@ -309,7 +309,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-linux-v2
+          key: llvm-source-18-linux-v1
           path: |
             llvm-project/clang/lib/Headers
             llvm-project/clang/include
@@ -334,7 +334,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-build
         with:
-          key: llvm-build-17-linux-${{ matrix.goarch }}-v2
+          key: llvm-build-18-linux-${{ matrix.goarch }}-v1
           path: llvm-build
       - name: Build LLVM
         if: steps.cache-llvm-build.outputs.cache-hit != 'true'

.github/workflows/llvm.yml

@@ -35,8 +35,8 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            tinygo/llvm-17
-            ghcr.io/${{ github.repository_owner }}/llvm-17
+            tinygo/llvm-18
+            ghcr.io/${{ github.repository_owner }}/llvm-18
           tags: |
             type=sha,format=long
             type=raw,value=latest

.github/workflows/nix.yml

@@ -24,7 +24,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-linux-nix-v2
+          key: llvm-source-18-linux-nix-v1
           path: |
             llvm-project/compiler-rt
       - name: Download LLVM source

.github/workflows/sizediff-install-pkgs.sh

@@ -2,11 +2,11 @@
 # still works after checking out the dev branch (that is, when going from LLVM
 # 16 to LLVM 17 for example, both Clang 16 and Clang 17 are installed).
 
-echo 'deb https://apt.llvm.org/jammy/ llvm-toolchain-jammy-17 main' | sudo tee /etc/apt/sources.list.d/llvm.list
+echo 'deb https://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main' | sudo tee /etc/apt/sources.list.d/llvm.list
 wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
 sudo apt-get update
 sudo apt-get install --no-install-recommends -y \
-    llvm-17-dev \
-    clang-17 \
-    libclang-17-dev \
-    lld-17
+    llvm-18-dev \
+    clang-18 \
+    libclang-18-dev \
+    lld-18

.github/workflows/sizediff.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/cache@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-sizediff-v2
+          key: llvm-source-18-sizediff-v1
           path: |
             llvm-project/compiler-rt
       - name: Download LLVM source

.github/workflows/windows.yml

@@ -41,7 +41,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-source
         with:
-          key: llvm-source-17-windows-v2
+          key: llvm-source-18-windows-v1
           path: |
             llvm-project/clang/lib/Headers
             llvm-project/clang/include
@@ -66,7 +66,7 @@ jobs:
         uses: actions/cache/restore@v4
         id: cache-llvm-build
         with:
-          key: llvm-build-17-windows-v2
+          key: llvm-build-18-windows-v1
           path: llvm-build
       - name: Build LLVM
         if: steps.cache-llvm-build.outputs.cache-hit != 'true'

GNUmakefile

@@ -10,7 +10,7 @@ LLD_SRC ?= $(LLVM_PROJECTDIR)/lld
 
 # Try to autodetect LLVM build tools.
 # Versions are listed here in descending priority order.
-LLVM_VERSIONS = 17 16 15
+LLVM_VERSIONS = 18 17 16 15
 errifempty = $(if $(1),$(1),$(error $(2)))
 detect = $(shell which $(call errifempty,$(firstword $(foreach p,$(2),$(shell command -v $(p) 2> /dev/null && echo $(p)))),failed to locate $(1) at any of: $(2)))
 toolSearchPathsVersion = $(1)-$(2)
@@ -239,7 +239,7 @@ gen-device-renesas: build/gen-device-svd
 
 # Get LLVM sources.
 $(LLVM_PROJECTDIR)/llvm:
-	git clone -b esp-17.0.1_20240419 --depth=1 https://github.com/espressif/llvm-project $(LLVM_PROJECTDIR)
+	git clone -b xtensa_release_18.1.2 --depth=1 https://github.com/espressif/llvm-project $(LLVM_PROJECTDIR)
 llvm-source: $(LLVM_PROJECTDIR)/llvm
 
 # Configure LLVM.

builder/build.go

@@ -773,7 +773,7 @@ func Build(pkgName, outpath, tmpdir string, config *compileopts.Config) (BuildRe
 			if sizeLevel >= 2 {
 				// Workaround with roughly the same effect as
 				// https://reviews.llvm.org/D119342.
-				// Can hopefully be removed in LLVM 18.
+				// Can hopefully be removed in LLVM 19.
 				ldflags = append(ldflags,
 					"-mllvm", "--rotation-max-header-size=0")
 			}

cgo/libclang_config_llvm17.go

@@ -1,4 +1,4 @@
-//go:build !byollvm && !llvm15 && !llvm16
+//go:build !byollvm && llvm17
 
 package cgo
 

cgo/libclang_config_llvm18.go

@@ -0,0 +1,15 @@
+//go:build !byollvm && !llvm15 && !llvm16 && !llvm17
+
+package cgo
+
+/*
+#cgo linux        CFLAGS:  -I/usr/include/llvm-18 -I/usr/include/llvm-c-18 -I/usr/lib/llvm-18/include
+#cgo darwin,amd64 CFLAGS:  -I/usr/local/opt/llvm@18/include
+#cgo darwin,arm64 CFLAGS:  -I/opt/homebrew/opt/llvm@18/include
+#cgo freebsd      CFLAGS:  -I/usr/local/llvm18/include
+#cgo linux        LDFLAGS: -L/usr/lib/llvm-18/lib -lclang
+#cgo darwin,amd64 LDFLAGS: -L/usr/local/opt/llvm@18/lib -lclang
+#cgo darwin,arm64 LDFLAGS: -L/opt/homebrew/opt/llvm@18/lib -lclang
+#cgo freebsd      LDFLAGS: -L/usr/local/llvm18/lib -lclang
+*/
+import "C"

compiler/asserts.go

@@ -135,7 +135,7 @@ func (b *builder) createChanBoundsCheck(elementSize uint64, bufSize llvm.Value,
 
 	// Calculate (^uintptr(0)) >> 1, which is the max value that fits in an
 	// uintptr if uintptrs were signed.
-	maxBufSize := llvm.ConstLShr(llvm.ConstNot(llvm.ConstInt(b.uintptrType, 0, false)), llvm.ConstInt(b.uintptrType, 1, false))
+	maxBufSize := b.CreateLShr(llvm.ConstNot(llvm.ConstInt(b.uintptrType, 0, false)), llvm.ConstInt(b.uintptrType, 1, false), "")
 	if elementSize > maxBufSize.ZExtValue() {
 		b.addError(pos, fmt.Sprintf("channel element type is too big (%v bytes)", elementSize))
 		return
@@ -150,7 +150,7 @@ func (b *builder) createChanBoundsCheck(elementSize uint64, bufSize llvm.Value,
 
 	// Make sure maxBufSize has the same type as bufSize.
 	if maxBufSize.Type() != bufSize.Type() {
-		maxBufSize = llvm.ConstZExt(maxBufSize, bufSize.Type())
+		maxBufSize = b.CreateZExt(maxBufSize, bufSize.Type(), "")
 	}
 
 	// Do the check for a too large (or negative) buffer size.

compiler/intrinsics.go

@@ -23,6 +23,8 @@ func (b *builder) defineIntrinsicFunction() {
 		b.createMemoryCopyImpl()
 	case name == "runtime.memzero":
 		b.createMemoryZeroImpl()
+	case name == "runtime.stacksave":
+		b.createStackSaveImpl()
 	case name == "runtime.KeepAlive":
 		b.createKeepAliveImpl()
 	case strings.HasPrefix(name, "runtime/volatile.Load"):
@@ -77,6 +79,14 @@ func (b *builder) createMemoryZeroImpl() {
 	b.CreateRetVoid()
 }
 
+// createStackSaveImpl creates a call to llvm.stacksave.p0 to read the current
+// stack pointer.
+func (b *builder) createStackSaveImpl() {
+	b.createFunctionStart(true)
+	sp := b.readStackPointer()
+	b.CreateRet(sp)
+}
+
 // Return the llvm.memset.p0.i8 function declaration.
 func (c *compilerContext) getMemsetFunc() llvm.Value {
 	fnName := "llvm.memset.p0.i" + strconv.Itoa(c.uintptrType.IntTypeWidth())

compiler/llvm.go

@@ -451,10 +451,14 @@ func (c *compilerContext) isThumb() bool {
 // readStackPointer emits a LLVM intrinsic call that returns the current stack
 // pointer as an *i8.
 func (b *builder) readStackPointer() llvm.Value {
-	stacksave := b.mod.NamedFunction("llvm.stacksave")
+	name := "llvm.stacksave.p0"
+	if llvmutil.Version() < 18 {
+		name = "llvm.stacksave" // backwards compatibility with LLVM 17 and below
+	}
+	stacksave := b.mod.NamedFunction(name)
 	if stacksave.IsNil() {
 		fnType := llvm.FunctionType(b.dataPtrType, nil, false)
-		stacksave = llvm.AddFunction(b.mod, "llvm.stacksave", fnType)
+		stacksave = llvm.AddFunction(b.mod, name, fnType)
 	}
 	return b.CreateCall(stacksave.GlobalValueType(), stacksave, nil, "")
 }

compiler/llvmutil/llvm.go

@@ -8,6 +8,9 @@
 package llvmutil
 
 import (
+	"strconv"
+	"strings"
+
 	"tinygo.org/x/go-llvm"
 )
 
@@ -203,3 +206,13 @@ func AppendToGlobal(mod llvm.Module, globalName string, values ...llvm.Value) {
 	used.SetInitializer(usedInitializer)
 	used.SetLinkage(llvm.AppendingLinkage)
 }
+
+// Return the LLVM major version.
+func Version() int {
+	majorStr := strings.Split(llvm.Version, ".")[0]
+	major, err := strconv.Atoi(majorStr)
+	if err != nil {
+		panic("unexpected error while parsing LLVM version: " + err.Error()) // should not happen
+	}
+	return major
+}

flake.nix

@@ -78,7 +78,7 @@
             export MD5SUM=md5sum
 
             # Ugly hack to make the Clang resources directory available.
-            export GOFLAGS="\"-ldflags=-X github.com/tinygo-org/tinygo/goenv.clangResourceDir=${llvmPackages_17.clang.cc.lib}/lib/clang/17"\"
+            export GOFLAGS="\"-ldflags=-X github.com/tinygo-org/tinygo/goenv.clangResourceDir=${llvmPackages_17.clang.cc.lib}/lib/clang/17" -tags=llvm17\"
           '';
         };
       }

go.mod

@@ -21,7 +21,7 @@ require (
 	golang.org/x/sys v0.16.0
 	golang.org/x/tools v0.17.0
 	gopkg.in/yaml.v2 v2.4.0
-	tinygo.org/x/go-llvm v0.0.0-20240106122909-c2c543540318
+	tinygo.org/x/go-llvm v0.0.0-20240518103902-697964f2a9dc
 )
 
 require (

go.sum

@@ -105,5 +105,5 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-tinygo.org/x/go-llvm v0.0.0-20240106122909-c2c543540318 h1:4KjZvPtcN1UwobevcGbdzeinx0L1i8HDdJu84bu7NI8=
-tinygo.org/x/go-llvm v0.0.0-20240106122909-c2c543540318/go.mod h1:GFbusT2VTA4I+l4j80b17KFK+6whv69Wtny5U+T8RR0=
+tinygo.org/x/go-llvm v0.0.0-20240518103902-697964f2a9dc h1:TCzibFa4oLu+njEP3fnRUmZ+QQeb8BjtOwctgcjzL0k=
+tinygo.org/x/go-llvm v0.0.0-20240518103902-697964f2a9dc/go.mod h1:GFbusT2VTA4I+l4j80b17KFK+6whv69Wtny5U+T8RR0=

src/runtime/runtime.go

@@ -41,11 +41,9 @@ func memmove(dst, src unsafe.Pointer, size uintptr)
 // like llvm.memset.p0.i32(ptr, 0, size, false).
 func memzero(ptr unsafe.Pointer, size uintptr)
 
-// This intrinsic returns the current stack pointer.
-// It is normally used together with llvm.stackrestore but also works to get the
-// current stack pointer in a platform-independent way.
-//
-//export llvm.stacksave
+// Return the current stack pointer using the llvm.stacksave.p0 intrinsic.
+// It is normally used together with llvm.stackrestore.p0 but also works to get
+// the current stack pointer in a platform-independent way.
 func stacksave() unsafe.Pointer
 
 //export strlen

transform/optimizer.go

@@ -52,7 +52,7 @@ func Optimize(mod llvm.Module, config *compileopts.Config) []error {
 		// Run some preparatory passes for the Go optimizer.
 		po := llvm.NewPassBuilderOptions()
 		defer po.Dispose()
-		err := mod.RunPasses("globaldce,globalopt,ipsccp,instcombine,adce,function-attrs", llvm.TargetMachine{}, po)
+		err := mod.RunPasses("globaldce,globalopt,ipsccp,instcombine<no-verify-fixpoint>,adce,function-attrs", llvm.TargetMachine{}, po)
 		if err != nil {
 			return []error{fmt.Errorf("could not build pass pipeline: %w", err)}
 		}