Updates TinyGo to use Go 1.20 features (#26)

TinyGo 0.27 doesn't fully support Go 1.20, but it supports what we need.
Particularly, `unsafe.SliceData` and `unsafe.StringData` were added to
TinyGo 0.27 ahead of the more complete Go 1.20 version: 0.28 (not yet
out).

Using the approach elaborated in wazero [1.2.0](https://github.com/tetratelabs/wazero/releases/tag/v1.2.0)
TinyGo examples resulted in significant performance benefits, benefits
far more than just the part around the runtime.

Signed-off-by: Adrian Cole <adrian@tetrate.io>

Author: codefromthecrypt

.github/workflows/commit.yaml

@@ -25,7 +25,7 @@ jobs:
     strategy:
       matrix:
         go-version:  # Note: Go only supports 2 versions: https://go.dev/doc/devel/release#policy
-          - "1.19"
+          - "1.20"
 
     steps:
       - uses: actions/checkout@v3
@@ -50,17 +50,16 @@ jobs:
     strategy:
       matrix:
         go-version:  # Note: Go only supports 2 versions: https://go.dev/doc/devel/release#policy
-          - "1.19"
+          - "1.20"
         tinygo-version:  # Note: TinyGo only supports latest: https://github.com/tinygo-org/tinygo/releases
           - "0.27.0"  # Latest
 
     steps:
       - uses: actions/checkout@v3
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go-version }}
-          cache: true
 
       - name: "Set up TinyGo"
         run: |  # Installing via curl so commands are similar on OS/x

.github/workflows/testdata.yaml

@@ -27,17 +27,16 @@ jobs:
     strategy:
       matrix:
         go-version:  # Note: Go only supports 2 versions: https://go.dev/doc/devel/release#policy
-          - "1.19"
+          - "1.20"
         tinygo-version:  # Note: TinyGo only supports latest: https://github.com/tinygo-org/tinygo/releases
           - "0.27.0"  # Latest
 
     steps:
       - uses: actions/checkout@v3
 
-      - uses: actions/setup-go@v3
-        with:  # Not cache: true because we also cache go-build and golangci-lint
+      - uses: actions/setup-go@v4
+        with:
           go-version: ${{ matrix.go-version }}
-          cache: true
 
       - name: "Set up TinyGo"
         run: |  # Installing via curl so commands are similar on OS/x
@@ -48,7 +47,7 @@ jobs:
 
       - name: "Set up wat2wasm"
         run: |  # Needed for testdata. wabt includes wat2wasm.
-          wabt_version=1.0.32
+          wabt_version=1.0.33
           wabt_url=https://github.com/WebAssembly/wabt/releases/download/${wabt_version}/wabt-${wabt_version}-ubuntu.tar.gz
           curl -sSL ${wabt_url} | tar --strip-components 2 -C /usr/local/bin -xzf - wabt-${wabt_version}/bin/wat2wasm
 

.golangci.yml

@@ -1,6 +1,6 @@
 # This is built using - https://golangci-lint.run/usage/configuration/
 run:
-  go: '1.19'
+  go: '1.20'
   modules-download-mode: readonly
   tests: false
 

Makefile

@@ -1,5 +1,6 @@
-gosimports    := github.com/rinchsan/gosimports/cmd/gosimports@v0.3.7
-golangci_lint := github.com/golangci/golangci-lint/cmd/golangci-lint@v1.51.2
+gofumpt       := mvdan.cc/gofumpt@v0.5.0
+gosimports    := github.com/rinchsan/gosimports/cmd/gosimports@v0.3.8
+golangci_lint := github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2
 
 .PHONY: testdata
 testdata:
@@ -43,12 +44,8 @@ lint: $(golangci_lint_path)
 
 .PHONY: format
 format:
-	@find . -type f -name '*.go' | xargs gofmt -s -w
-	@for f in `find . -name '*.go'`; do \
-	    awk '/^import \($$/,/^\)$$/{if($$0=="")next}{print}' $$f > /tmp/fmt; \
-	    mv /tmp/fmt $$f; \
-	done
-	@go run $(gosimports) -local github.com/http-wasm/http-wasm-guest-tinygo -w $(shell find . -name '*.go' -type f)
+	@go run $(gofumpt) -l -w .
+	@go run $(gosimports) -local github.com/http-wasm/ -w $(shell find . -name '*.go' -type f)
 
 .PHONY: check
 check:

examples/router/main.wasm

@@ -1,3 +1,6 @@
 module github.com/http-wasm/http-wasm-guest-tinygo
 
-go 1.19
+// TinyGo 0.27 doesn't fully support Go 1.20, but it supports what we need.
+// Particularly, unsafe.SliceData, unsafe.StringData were added to TinyGo 0.27.
+// See https://github.com/tinygo-org/tinygo/commit/c43958972c3ffcd51e65414a346e53779edb9f97
+go 1.20

examples/wasi/main.wasm

@@ -2,7 +2,7 @@ package handler
 
 import (
 	"io"
-	"unsafe"
+	"runtime"
 
 	"github.com/http-wasm/http-wasm-guest-tinygo/handler/api"
 	"github.com/http-wasm/http-wasm-guest-tinygo/handler/internal/imports"
@@ -40,13 +40,14 @@ func (b wasmBody) WriteTo(w io.Writer) (written uint64, err error) {
 
 // ReadN implements the same method as documented on api.Body.
 func (b wasmBody) Read(bytes []byte) (size uint32, eof bool) {
-	limit := uint32(len(bytes))
-	if limit == 0 { // invalid, but prevent crashing.
-		return 0, false
+	ptr, limit := mem.SliceToPtr(bytes)
+	if limit == 0 {
+		return // invalid, but prevent crashing.
 	}
 
-	ptr := uintptr(unsafe.Pointer(&bytes[0])) // TODO: mem.SliceToPtr
-	return read(b, ptr, limit)
+	size, eof = read(b, uintptr(ptr), limit)
+	runtime.KeepAlive(bytes) // keep bytes alive until ptr is no longer needed.
+	return
 }
 
 func read(b wasmBody, ptr uintptr, limit imports.BufLimit) (size uint32, eof bool) {
@@ -58,21 +59,22 @@ func read(b wasmBody, ptr uintptr, limit imports.BufLimit) (size uint32, eof boo
 
 // Write implements the same method as documented on api.Body.
 func (b wasmBody) Write(bytes []byte) {
-	size := uint32(len(bytes))
-	if size == 0 { // invalid, but prevent crashing.
+	ptr, size := mem.SliceToPtr(bytes)
+	if size == 0 {
 		return
 	}
 
-	ptr := uintptr(unsafe.Pointer(&bytes[0])) // TODO: mem.SliceToPtr
-	imports.WriteBody(imports.BodyKind(b), ptr, size)
+	imports.WriteBody(imports.BodyKind(b), uintptr(ptr), size)
+	runtime.KeepAlive(bytes) // keep bytes alive until ptr is no longer needed.
 }
 
 // WriteString implements the same method as documented on api.Body.
 func (b wasmBody) WriteString(s string) {
 	ptr, size := mem.StringToPtr(s)
-	if size == 0 { // invalid, but prevent crashing.
+	if size == 0 {
 		return
 	}
 
-	imports.WriteBody(imports.BodyKind(b), ptr, size)
+	imports.WriteBody(imports.BodyKind(b), uintptr(ptr), size)
+	runtime.KeepAlive(s) // keep s alive until ptr is no longer needed.
 }

go.mod

@@ -1,6 +1,7 @@
 package handler
 
 import (
+	"runtime"
 	"unsafe"
 
 	"github.com/http-wasm/http-wasm-guest-tinygo/handler/api"
@@ -30,9 +31,11 @@ func (w wasmHeader) Names() (names []string) {
 	}
 	// Otherwise, we have to allocate a new buffer for the large entry.
 	buf := make([]byte, size)
-	ptr := uintptr(unsafe.Pointer(&buf[0]))
-	_ = imports.GetHeaderNames(imports.HeaderKind(w), ptr, size)
-	return mem.GetNULTerminated(buf)
+	ptr := unsafe.Pointer(unsafe.SliceData(buf))
+	_ = imports.GetHeaderNames(imports.HeaderKind(w), uintptr(ptr), size)
+	names = mem.GetNULTerminated(buf)
+	runtime.KeepAlive(buf) // keep buf alive until ptr is no longer needed.
+	return
 }
 
 // Get implements the same method as documented on api.Request.
@@ -48,10 +51,12 @@ func (w wasmHeader) Get(name string) (value string, ok bool) {
 // GetAll implements the same method as documented on api.Request.
 func (w wasmHeader) GetAll(name string) (names []string) {
 	namePtr, nameSize := mem.StringToPtr(name)
-	countLen := imports.GetHeaderValues(imports.HeaderKind(w), namePtr, nameSize, mem.ReadBufPtr, mem.ReadBufLimit)
+	countLen := imports.GetHeaderValues(imports.HeaderKind(w), uintptr(namePtr), nameSize, mem.ReadBufPtr, mem.ReadBufLimit)
+	runtime.KeepAlive(name) // keep name alive until ptr is no longer needed.
 	if countLen == 0 {
 		return
 	}
+
 	size := uint32(countLen)
 	if size == 0 {
 		return
@@ -61,27 +66,35 @@ func (w wasmHeader) GetAll(name string) (names []string) {
 	}
 	// Otherwise, we have to allocate a new buffer for the large entry.
 	buf := make([]byte, size)
-	ptr := uintptr(unsafe.Pointer(&buf[0]))
-	_ = imports.GetHeaderValues(imports.HeaderKind(w), namePtr, nameSize, ptr, size)
-	return mem.GetNULTerminated(buf)
+	ptr := unsafe.Pointer(unsafe.SliceData(buf))
+	_ = imports.GetHeaderValues(imports.HeaderKind(w), uintptr(namePtr), nameSize, uintptr(ptr), size)
+	names = mem.GetNULTerminated(buf)
+	runtime.KeepAlive(name) // keep name alive until ptr is no longer needed.
+	runtime.KeepAlive(buf)  // keep buf alive until ptr is no longer needed.
+	return
 }
 
 // Set implements the same method as documented on api.Request.
 func (w wasmHeader) Set(name, value string) {
 	namePtr, nameSize := mem.StringToPtr(name)
 	valuePtr, valueSize := mem.StringToPtr(value)
-	imports.SetHeaderValue(imports.HeaderKind(w), namePtr, nameSize, valuePtr, valueSize)
+	imports.SetHeaderValue(imports.HeaderKind(w), uintptr(namePtr), nameSize, uintptr(valuePtr), valueSize)
+	runtime.KeepAlive(name)  // keep name alive until ptr is no longer needed.
+	runtime.KeepAlive(value) // keep value alive until ptr is no longer needed.
 }
 
 // Add implements the same method as documented on api.Request.
 func (w wasmHeader) Add(name, value string) {
 	namePtr, nameSize := mem.StringToPtr(name)
 	valuePtr, valueSize := mem.StringToPtr(value)
-	imports.AddHeaderValue(imports.HeaderKind(w), namePtr, nameSize, valuePtr, valueSize)
+	imports.AddHeaderValue(imports.HeaderKind(w), uintptr(namePtr), nameSize, uintptr(valuePtr), valueSize)
+	runtime.KeepAlive(name)  // keep name alive until ptr is no longer needed.
+	runtime.KeepAlive(value) // keep value alive until ptr is no longer needed.
 }
 
 // Remove implements the same method as documented on api.Request.
 func (w wasmHeader) Remove(name string) {
 	namePtr, nameSize := mem.StringToPtr(name)
-	imports.RemoveHeader(imports.HeaderKind(w), namePtr, nameSize)
+	imports.RemoveHeader(imports.HeaderKind(w), uintptr(namePtr), nameSize)
+	runtime.KeepAlive(name) // keep name alive until ptr is no longer needed.
 }

handler/body.go

@@ -1,6 +1,8 @@
 package handler
 
 import (
+	"runtime"
+
 	"github.com/http-wasm/http-wasm-guest-tinygo/handler/api"
 	"github.com/http-wasm/http-wasm-guest-tinygo/handler/internal/imports"
 	"github.com/http-wasm/http-wasm-guest-tinygo/handler/internal/mem"
@@ -36,5 +38,6 @@ func (wasmHost) Log(level api.LogLevel, message string) {
 		return // don't incur host call overhead
 	}
 	ptr, size := mem.StringToPtr(message)
-	imports.Log(level, ptr, size)
+	imports.Log(level, uintptr(ptr), size)
+	runtime.KeepAlive(message) // keep message alive until ptr is no longer needed.
 }