Use x/sys for better OS coverage (#111)

Author: anuraaga

.github/workflows/ci.yaml

@@ -85,6 +85,29 @@ jobs:
           # Windows runner seems to not have enough CPU performance to keep up without a memory limit
           GOMEMLIMIT: ${{ github.event_name != 'pull_request' && '1GiB' || '' }}
 
+  test-bsd:
+      runs-on: ubuntu-latest
+
+      steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.work
+
+      - name: Build
+        run: go test -c .
+        env:
+          GOOS: freebsd
+
+      - name: Test
+        uses: cross-platform-actions/[email protected]
+        with:
+          operating_system: freebsd
+          version: '14.0'
+          shell: bash
+          run: ./go-re2.test -test.v -test.short
+          sync_files: runner-to-vm
+
   # Runs tests using wazero inside a minimal golang docker image. This makes sure the code builds
   # even when there is no C toolchain available. It is possible for code to work fine with CGO_ENABLED=0
   # but not build without a C toolchain available, e.g. if C source files are checked into the repo

go.mod

@@ -5,6 +5,7 @@ go 1.20
 require (
 	github.com/tetratelabs/wazero v1.7.2
 	github.com/wasilibs/nottinygc v0.4.0
+	golang.org/x/sys v0.21.0
 )
 
 require github.com/magefile/mage v1.15.1-0.20230912152418-9f54e0f83e2a // indirect

go.sum

@@ -1,5 +1,8 @@
 github.com/magefile/mage v1.15.1-0.20230912152418-9f54e0f83e2a h1:tdPcGgyiH0K+SbsJBBm2oPyEIOTAvLBwD9TuUwVtZho=
+github.com/magefile/mage v1.15.1-0.20230912152418-9f54e0f83e2a/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
 github.com/tetratelabs/wazero v1.7.2 h1:1+z5nXJNwMLPAWaTePFi49SSTL0IMx/i3Fg8Yc25GDc=
 github.com/tetratelabs/wazero v1.7.2/go.mod h1:ytl6Zuh20R/eROuyDaGPkp82O9C/DJfXAwJfQ3X6/7Y=
 github.com/wasilibs/nottinygc v0.4.0 h1:h1TJMihMC4neN6Zq+WKpLxgd9xCFMw7O9ETLwY2exJQ=
 github.com/wasilibs/nottinygc v0.4.0/go.mod h1:oDcIotskuYNMpqMF23l7Z8uzD4TC0WXHK8jetlB3HIo=
+golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
+golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=

internal/alloc/alloc_unix.go

@@ -28,9 +28,9 @@ package alloc
 
 import (
 	"math"
-	"syscall"
 
 	"github.com/tetratelabs/wazero/experimental"
+	"golang.org/x/sys/unix"
 )
 
 func Allocator() experimental.MemoryAllocator {
@@ -39,25 +39,25 @@ func Allocator() experimental.MemoryAllocator {
 
 func mmappedAllocator(cap, max uint64) experimental.LinearMemory {
 	// Round up to the page size.
-	rnd := uint64(syscall.Getpagesize() - 1)
+	rnd := uint64(unix.Getpagesize() - 1)
 	max = (max + rnd) &^ rnd
 	cap = (cap + rnd) &^ rnd
 
 	if max > math.MaxInt {
 		// This ensures int(max) overflows to a negative value,
-		// and syscall.Mmap returns EINVAL.
+		// and unix.Mmap returns EINVAL.
 		max = math.MaxUint64
 	}
 	// Reserve max bytes of address space, to ensure we won't need to move it.
 	// A protected, private, anonymous mapping should not commit memory.
-	b, err := syscall.Mmap(-1, 0, int(max), syscall.PROT_NONE, syscall.MAP_PRIVATE|syscall.MAP_ANON)
+	b, err := unix.Mmap(-1, 0, int(max), unix.PROT_NONE, unix.MAP_PRIVATE|unix.MAP_ANON)
 	if err != nil {
 		panic(err)
 	}
 	// Commit the initial cap bytes of memory.
-	err = syscall.Mprotect(b[:cap], syscall.PROT_READ|syscall.PROT_WRITE)
+	err = unix.Mprotect(b[:cap], unix.PROT_READ|unix.PROT_WRITE)
 	if err != nil {
-		_ = syscall.Munmap(b)
+		_ = unix.Munmap(b)
 		panic(err)
 	}
 	return &mmappedMemory{buf: b[:cap]}
@@ -75,11 +75,11 @@ func (m *mmappedMemory) Reallocate(size uint64) []byte {
 	res := uint64(cap(m.buf))
 	if com < size && size < res {
 		// Round up to the page size.
-		rnd := uint64(syscall.Getpagesize() - 1)
+		rnd := uint64(unix.Getpagesize() - 1)
 		new := (size + rnd) &^ rnd
 
 		// Commit additional memory up to new bytes.
-		err := syscall.Mprotect(m.buf[com:new], syscall.PROT_READ|syscall.PROT_WRITE)
+		err := unix.Mprotect(m.buf[com:new], unix.PROT_READ|unix.PROT_WRITE)
 		if err != nil {
 			panic(err)
 		}
@@ -91,7 +91,7 @@ func (m *mmappedMemory) Reallocate(size uint64) []byte {
 }
 
 func (m *mmappedMemory) Free() {
-	err := syscall.Munmap(m.buf[:cap(m.buf)])
+	err := unix.Munmap(m.buf[:cap(m.buf)])
 	if err != nil {
 		panic(err)
 	}

internal/alloc/alloc_windows.go

@@ -5,26 +5,10 @@ package alloc
 import (
 	"fmt"
 	"math"
-	"syscall"
 	"unsafe"
 
 	"github.com/tetratelabs/wazero/experimental"
-)
-
-var (
-	kernel32         = syscall.NewLazyDLL("kernel32.dll")
-	procVirtualAlloc = kernel32.NewProc("VirtualAlloc")
-	procVirtualFree  = kernel32.NewProc("VirtualFree")
-)
-
-const (
-	windows_MEM_COMMIT     uintptr = 0x00001000
-	windows_MEM_RESERVE    uintptr = 0x00002000
-	windows_MEM_RELEASE    uintptr = 0x00008000
-	windows_PAGE_READWRITE uintptr = 0x00000004
-
-	// https://cs.opensource.google/go/x/sys/+/refs/tags/v0.20.0:windows/syscall_windows.go;l=131
-	windows_PAGE_SIZE uint64 = 4096
+	"golang.org/x/sys/windows"
 )
 
 func Allocator() experimental.MemoryAllocator {
@@ -33,7 +17,7 @@ func Allocator() experimental.MemoryAllocator {
 
 func virtualAllocator(cap, max uint64) experimental.LinearMemory {
 	// Round up to the page size.
-	rnd := windows_PAGE_SIZE - 1
+	rnd := uint64(windows.Getpagesize() - 1)
 	max = (max + rnd) &^ rnd
 	cap = (cap + rnd) &^ rnd
 
@@ -45,15 +29,15 @@ func virtualAllocator(cap, max uint64) experimental.LinearMemory {
 
 	// Reserve, but don't commit, max bytes of address space, to ensure we won't need to move it.
 	// This does not commit memory.
-	r, _, err := procVirtualAlloc.Call(0, uintptr(max), windows_MEM_RESERVE, windows_PAGE_READWRITE)
-	if r == 0 {
+	r, err := windows.VirtualAlloc(0, uintptr(max), windows.MEM_RESERVE, windows.PAGE_READWRITE)
+	if err != nil {
 		panic(fmt.Errorf("alloc_windows: failed to reserve memory: %w", err))
 	}
 
 	// Commit the initial cap bytes of memory.
-	r, _, err = procVirtualAlloc.Call(r, uintptr(cap), windows_MEM_COMMIT, windows_PAGE_READWRITE)
-	if r == 0 {
-		_, _, _ = procVirtualFree.Call(r, 0, windows_MEM_RELEASE)
+	r, err = windows.VirtualAlloc(r, uintptr(cap), windows.MEM_COMMIT, windows.PAGE_READWRITE)
+	if err != nil {
+		_ = windows.VirtualFree(r, 0, windows.MEM_RELEASE)
 		panic(fmt.Errorf("alloc_windows: failed to commit initial memory: %w", err))
 	}
 
@@ -74,12 +58,12 @@ func (m *virtualMemory) Reallocate(size uint64) []byte {
 	res := uint64(cap(m.buf))
 	if com < size && size < res {
 		// Round up to the page size.
-		rnd := windows_PAGE_SIZE - 1
+		rnd := uint64(windows.Getpagesize() - 1)
 		new := (size + rnd) &^ rnd
 
 		// Commit additional memory up to new bytes.
-		r, _, err := procVirtualAlloc.Call(m.addr, uintptr(new), windows_MEM_COMMIT, windows_PAGE_READWRITE)
-		if r == 0 {
+		_, err := windows.VirtualAlloc(m.addr, uintptr(new), windows.MEM_COMMIT, windows.PAGE_READWRITE)
+		if err != nil {
 			panic(fmt.Errorf("alloc_windows: failed to commit memory: %w", err))
 		}
 
@@ -91,8 +75,8 @@ func (m *virtualMemory) Reallocate(size uint64) []byte {
 }
 
 func (m *virtualMemory) Free() {
-	r, _, err := procVirtualFree.Call(m.addr, 0, windows_MEM_RELEASE)
-	if r == 0 {
+	err := windows.VirtualFree(m.addr, 0, windows.MEM_RELEASE)
+	if err != nil {
 		panic(fmt.Errorf("alloc_windows: failed to release memory: %w", err))
 	}
 	m.addr = 0

internal/e2e/go.mod

@@ -4,6 +4,9 @@ go 1.20
 
 require github.com/wasilibs/go-re2 v1.5.2
 
-require github.com/tetratelabs/wazero v1.7.2 // indirect
+require (
+	github.com/tetratelabs/wazero v1.7.2 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+)
 
 replace github.com/wasilibs/go-re2 => ../..

internal/e2e/go.sum

@@ -1,3 +1,4 @@
 github.com/magefile/mage v1.15.1-0.20230912152418-9f54e0f83e2a h1:tdPcGgyiH0K+SbsJBBm2oPyEIOTAvLBwD9TuUwVtZho=
 github.com/tetratelabs/wazero v1.7.2 h1:1+z5nXJNwMLPAWaTePFi49SSTL0IMx/i3Fg8Yc25GDc=
 github.com/wasilibs/nottinygc v0.4.0 h1:h1TJMihMC4neN6Zq+WKpLxgd9xCFMw7O9ETLwY2exJQ=
+golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=

stress_test.go

@@ -38,7 +38,7 @@ require (
 	github.com/yargevad/filepathx v1.0.0 // indirect
 	golang.org/x/crypto v0.1.0 // indirect
 	golang.org/x/net v0.1.0 // indirect
-	golang.org/x/sys v0.2.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

wafbench/go.mod

@@ -390,8 +390,7 @@ golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.2.0 h1:ljd4t30dBnAvMZaQCevtY0xLLD0A+bRZXbgLMLU1F/A=
-golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.1-0.20181227161524-e6919f6577db/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=