Add Cgo support for NetBSD

.github/ISSUE_TEMPLATE/00-bug.yml

@@ -17,6 +17,7 @@ body:
       - label: macOS
       - label: Linux
       - label: FreeBSD
+      - label: NetBSD
       - label: Android
       - label: iOS
   validations:

.github/workflows/test.yml

@@ -209,6 +209,83 @@ jobs:
             echo "=> go test CGO_ENABLED=1"
             env CGO_ENABLED=1 go test -shuffle=on -v -count=10 ./...
 
+            if [ -z "$(echo ${{matrix.go}} | grep '^1.1')" ]; then
+              echo "=> go test race"
+              go test -race -shuffle=on -v -count=10 ./...
+            fi
+  netbsd:
+    strategy:
+      matrix:
+        go: ['1.21.13', '1.22.6', '1.23.0']
+    name: Test with Go ${{ matrix.go }} on NetBSD
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run in netbsd
+        uses: vmactions/netbsd-vm@v1
+        with:
+          usesh: true
+          prepare: |
+            /usr/sbin/pkg_add -v bash
+            ftp https://go.dev/dl/go${{matrix.go}}.netbsd-amd64.tar.gz
+            mkdir /usr/local
+            rm -fr /usr/local/go && tar -C /usr/local -xf go${{matrix.go}}.netbsd-amd64.tar.gz
+            ln -s /usr/local/go/bin/go /usr/local/bin
+          run: |
+            echo "Running tests on $(uname -a) at $PWD"
+
+            export PATH=$PATH:/usr/local/go/bin/
+
+            # verify Go is available
+            go version
+
+            echo "=> go build"
+            go build -v ./...
+            # Compile without optimization to check potential stack overflow.
+            # The option '-gcflags=all=-N -l' is often used at Visual Studio Code.
+            # See also https://go.googlesource.com/vscode-go/+/HEAD/docs/debugging.md#launch and the issue hajimehoshi/ebiten#2120.
+            go build "-gcflags=all=-N -l" -v ./...
+
+            # Check cross-compiling Windows binaries.
+            env GOOS=windows GOARCH=386 go build -v ./...
+            env GOOS=windows GOARCH=amd64 go build -v ./...
+            env GOOS=windows GOARCH=arm go build -v ./...
+            env GOOS=windows GOARCH=arm64 go build -v ./...
+
+            # Check cross-compiling macOS binaries.
+            env GOOS=darwin GOARCH=amd64 go build -v ./...
+            env GOOS=darwin GOARCH=arm64 go build -v ./...
+
+            # Check cross-compiling Linux binaries.
+            env GOOS=linux GOARCH=amd64 go build -v ./...
+            env GOOS=linux GOARCH=arm64 go build -v ./...
+
+            # Check cross-compiling FreeBSD binaries.
+            env GOOS=freebsd GOARCH=amd64 go build -gcflags="github.com/ebitengine/purego/internal/fakecgo=-std" -v ./...
+            env GOOS=freebsd GOARCH=arm64 go build -gcflags="github.com/ebitengine/purego/internal/fakecgo=-std" -v ./...
+
+            echo "=> go mod vendor"
+            mkdir /tmp/vendoring
+            cd /tmp/vendoring
+            go mod init foo
+            echo 'package main' > main.go
+            echo 'import (' >> main.go
+            echo '  _ "github.com/ebitengine/purego"' >> main.go
+            echo ')' >> main.go
+            echo 'func main() {}' >> main.go
+            go mod edit -replace github.com/ebitengine/purego=$GITHUB_WORKSPACE
+            go mod tidy
+            go mod vendor
+            go build -v .
+
+            # TODO: uncomment once Cgo is not required for NetBSD
+            # cd $GITHUB_WORKSPACE
+            # echo "=> go test CGO_ENABLED=0"
+            # env CGO_ENABLED=0 go test -gcflags="github.com/ebitengine/purego/internal/fakecgo=-std" -shuffle=on -v -count=10 ./...
+
+            echo "=> go test CGO_ENABLED=1"
+            env CGO_ENABLED=1 go test -shuffle=on -v -count=10 ./...
+
             if [ -z "$(echo ${{matrix.go}} | grep '^1.1')" ]; then
               echo "=> go test race"
               go test -race -shuffle=on -v -count=10 ./...

cgo.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2022 The Ebitengine Authors
 
-//go:build cgo && (darwin || freebsd || linux)
+//go:build cgo && (darwin || freebsd || netbsd || linux)
 
 package purego
 

dlfcn_netbsd.go

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024 The Ebitengine Authors
+
+package purego
+
+import "github.com/ebitengine/purego/internal/cgo"
+
+// Source for constants: https://github.com/NetBSD/src/blob/trunk/include/dlfcn.h
+
+const (
+	intSize      = 32 << (^uint(0) >> 63) // 32 or 64
+	RTLD_DEFAULT = 1<<intSize - 2         // Pseudo-handle for dlsym so search for any loaded symbol
+	RTLD_LAZY    = 0x00000001             // Relocations are performed at an implementation-dependent time.
+	RTLD_NOW     = 0x00000002             // Relocations are performed when the object is loaded.
+	RTLD_LOCAL   = 0x00000000             // All symbols are not made available for relocation processing by other modules.
+	RTLD_GLOBAL  = 0x00000100             // All symbols are available for relocation processing of other modules.
+)
+
+func Dlopen(path string, mode int) (uintptr, error) {
+	return cgo.Dlopen(path, mode)
+}
+
+func Dlsym(handle uintptr, name string) (uintptr, error) {
+	return cgo.Dlsym(handle, name)
+}
+
+func Dlclose(handle uintptr) error {
+	return cgo.Dlclose(handle)
+}
+
+func loadSymbol(handle uintptr, name string) (uintptr, error) {
+	return Dlsym(handle, name)
+}

dlfcn_test.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023 The Ebitengine Authors
 
-//go:build darwin || freebsd || linux
+//go:build darwin || freebsd || linux || netbsd
 
 package purego_test
 
@@ -54,7 +54,7 @@ func buildSharedLib(compilerEnv, libFile string, sources ...string) error {
 	}
 
 	var args []string
-	if runtime.GOOS == "freebsd" {
+	if runtime.GOOS == "freebsd" || runtime.GOOS == "netbsd" {
 		args = []string{"-shared", "-Wall", "-Werror", "-fPIC", "-o", libFile}
 	} else {
 		args = []string{"-shared", "-Wall", "-Werror", "-o", libFile}

examples/libc/main.go

@@ -20,6 +20,8 @@ func getSystemLibrary() string {
 		return "libc.so.6"
 	case "freebsd":
 		return "libc.so.7"
+	case "netbsd":
+		return "libc.so"
 	case "windows":
 		return "ucrtbase.dll"
 	default:

examples/libc/main_unix.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023 The Ebitengine Authors
 
-//go:build darwin || freebsd || linux
+//go:build darwin || freebsd || linux || netbsd
 
 package main
 

func.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2022 The Ebitengine Authors
 
-//go:build darwin || freebsd || linux || windows
+//go:build darwin || freebsd || linux || netbsd || windows
 
 package purego
 

func_test.go

@@ -17,10 +17,12 @@ func getSystemLibrary() (string, error) {
 	switch runtime.GOOS {
 	case "darwin":
 		return "/usr/lib/libSystem.B.dylib", nil
-	case "linux":
-		return "libc.so.6", nil
 	case "freebsd":
 		return "libc.so.7", nil
+	case "linux":
+		return "libc.so.6", nil
+	case "netbsd":
+		return "libc.so", nil
 	case "windows":
 		return "ucrtbase.dll", nil
 	default:
@@ -43,7 +45,7 @@ func TestRegisterFunc(t *testing.T) {
 }
 
 func Test_qsort(t *testing.T) {
-	if runtime.GOARCH != "arm64" && runtime.GOARCH != "amd64" {
+	if runtime.GOARCH != "arm64" && runtime.GOARCH != "amd64" || runtime.GOOS == "netbsd" {
 		t.Skip("Platform doesn't support Floats")
 		return
 	}
@@ -72,7 +74,7 @@ func Test_qsort(t *testing.T) {
 }
 
 func TestRegisterFunc_Floats(t *testing.T) {
-	if runtime.GOARCH != "arm64" && runtime.GOARCH != "amd64" {
+	if runtime.GOARCH != "arm64" && runtime.GOARCH != "amd64" || runtime.GOOS == "netbsd" {
 		t.Skip("Platform doesn't support Floats")
 		return
 	}
@@ -111,7 +113,7 @@ func TestRegisterFunc_Floats(t *testing.T) {
 }
 
 func TestRegisterLibFunc_Bool(t *testing.T) {
-	if runtime.GOARCH != "arm64" && runtime.GOARCH != "amd64" {
+	if runtime.GOARCH != "arm64" && runtime.GOARCH != "amd64" || runtime.GOOS == "netbsd" {
 		t.Skip("Platform doesn't support callbacks")
 		return
 	}

go_runtime.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2022 The Ebitengine Authors
 
-//go:build darwin || freebsd || linux || windows
+//go:build darwin || freebsd || linux || netbsd || windows
 
 package purego
 

internal/cgo/dlfcn_cgo_unix.go

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2024 The Ebitengine Authors
 
-//go:build freebsd || linux
+//go:build freebsd || linux || netbsd
 
 package cgo
 
 /*
- #cgo LDFLAGS: -ldl
+#cgo !netbsd LDFLAGS: -ldl
 
 #include <dlfcn.h>
 #include <stdlib.h>

internal/cgo/syscall_cgo_unix.go

@@ -1,15 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2022 The Ebitengine Authors
 
-//go:build freebsd || (linux && !(arm64 || amd64))
+//go:build freebsd || (linux && !(arm64 || amd64)) || netbsd
 
 package cgo
 
 // this file is placed inside internal/cgo and not package purego
 // because Cgo and assembly files can't be in the same package.
 
 /*
- #cgo LDFLAGS: -ldl
+#cgo !netbsd LDFLAGS: -ldl
 
 #include <stdint.h>
 #include <dlfcn.h>

internal/load/load_unix.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2024 The Ebitengine Authors
 
-//go:build darwin || freebsd || linux
+//go:build darwin || freebsd || linux || netbsd
 
 package load
 

syscall.go

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2022 The Ebitengine Authors
 
-//go:build darwin || freebsd || linux || windows
+//go:build darwin || freebsd || linux || netbsd || windows
 
 package purego
 

syscall_cgo_netbsd.go

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024 The Ebitengine Authors
+
+//go:build cgo
+
+package purego
+
+import (
+	"github.com/ebitengine/purego/internal/cgo"
+)
+
+var syscall15XABI0 = uintptr(cgo.Syscall15XABI0)
+
+//go:nosplit
+func syscall_syscall15X(fn, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15 uintptr) (r1, r2, err uintptr) {
+	return cgo.Syscall15X(fn, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15)
+}
+
+func NewCallback(_ interface{}) uintptr {
+	panic("purego: NewCallback is not supported on NetBSD")
+}