feat: implement Golang SDK

sanposhiho · sanposhiho · commit 333e4272297f · 2024-12-16T00:35:40.000+09:00
diff --git a/Makefile b/Makefile
@@ -3,13 +3,13 @@ gosimports    := github.com/rinchsan/gosimports/cmd/gosimports@v0.3.8
 golangci_lint := github.com/golangci/golangci-lint/cmd/golangci-lint@v1.61.0
 
 examples/advanced/main.wasm: examples/advanced/main.go
-	@(cd $(@D); tinygo build -o main.wasm -gc=custom -tags=custommalloc -scheduler=none --no-debug -target=wasi .)
+	@(cd $(@D); GOARCH=wasm GOOS=wasip1 gotip build -buildmode=c-shared -tags wasm -o main.wasm .)
 
 internal/e2e/scheduler_perf/wasm/nodenumber/main.wasm: internal/e2e/scheduler_perf/wasm/nodenumber/main.go
 	@(cd $(@D); tinygo build -o main.wasm -gc=custom -tags=custommalloc -scheduler=none --no-debug -target=wasi .)
 
 %/main.wasm: %/main.go
-	@(cd $(@D); tinygo build -o main.wasm -scheduler=none --no-debug -target=wasi .)
+	@(cd $(@D); GOARCH=wasm GOOS=wasip1 gotip build -buildmode=c-shared -tags wasm -o main.wasm .)
 
 .PHONY: build-tinygo
 build-tinygo: examples/nodenumber/main.wasm examples/advanced/main.wasm examples/imagelocality/main.wasm guest/testdata/cyclestate/main.wasm guest/testdata/filter/main.wasm guest/testdata/score/main.wasm \
diff --git a/examples/advanced/go.mod b/examples/advanced/go.mod
@@ -3,15 +3,11 @@ module sigs.k8s.io/kube-scheduler-wasm-extension/examples/advanced
 go 1.22.0
 
 require (
-	github.com/wasilibs/nottinygc v0.4.0
 	sigs.k8s.io/kube-scheduler-wasm-extension/guest v0.0.0-00010101000000-000000000000
 	sigs.k8s.io/kube-scheduler-wasm-extension/kubernetes/proto v0.0.0-00010101000000-000000000000
 )
 
-require (
-	github.com/magefile/mage v1.14.0 // indirect
-	google.golang.org/protobuf v1.30.0 // indirect
-)
+require google.golang.org/protobuf v1.30.0 // indirect
 
 replace sigs.k8s.io/kube-scheduler-wasm-extension/guest => ./../../guest
 
diff --git a/examples/advanced/go.sum b/examples/advanced/go.sum
@@ -1,11 +1,6 @@
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
-github.com/magefile/mage v1.14.0 h1:6QDX3g6z1YvJ4olPhT1wksUcSa/V0a1B+pJb73fBjyo=
-github.com/magefile/mage v1.14.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
-github.com/wasilibs/nottinygc v0.4.0 h1:h1TJMihMC4neN6Zq+WKpLxgd9xCFMw7O9ETLwY2exJQ=
-github.com/wasilibs/nottinygc v0.4.0/go.mod h1:oDcIotskuYNMpqMF23l7Z8uzD4TC0WXHK8jetlB3HIo=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng=
diff --git a/examples/advanced/main.go b/examples/advanced/main.go
@@ -1,5 +1,3 @@
-//go:build tinygo.wasm
-
 /*
    Copyright 2023 The Kubernetes Authors.
 
@@ -20,11 +18,7 @@
 // 'tinygo build -target=wasi'. See /guest/RATIONALE.md for details.
 package main
 
-// Override the default GC with a more performant one.
-// Note: this requires tinygo flags: -gc=custom -tags=custommalloc
 import (
-	_ "github.com/wasilibs/nottinygc"
-
 	"sigs.k8s.io/kube-scheduler-wasm-extension/examples/advanced/plugin"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/config"
 	"sigs.k8s.io/kube-scheduler-wasm-extension/guest/enqueue"
@@ -36,7 +30,7 @@ import (
 
 // main is compiled to an exported Wasm function named "_start", called by the
 // Wasm scheduler plugin during initialization.
-func main() {
+func init() {
 	// The plugin package uses only normal Go code, which allows it to be
 	// unit testable via `tinygo test -target=wasi` as well normal `go test`.
 	//
@@ -53,3 +47,5 @@ func main() {
 	prescore.SetPlugin(plugin)
 	score.SetPlugin(plugin)
 }
+
+func main() {}
diff --git a/examples/advanced/main.wasm b/examples/advanced/main.wasm
diff --git a/examples/imagelocality/main.wasm b/examples/imagelocality/main.wasm
diff --git a/examples/nodenumber/main.go b/examples/nodenumber/main.go
@@ -33,14 +33,16 @@ import (
 
 // main is compiled to a WebAssembly function named "_start", called by the
 // wasm scheduler plugin during initialization.
-func main() {
+func init() {
 	p, err := New(klog.Get(), config.Get())
 	if err != nil {
 		panic(err)
 	}
 	plugin.Set(p)
 }
 
+func main() {}
+
 func New(klog klogapi.Klog, jsonConfig []byte) (api.Plugin, error) {
 	var args nodeNumberArgs
 	if jsonConfig != nil {
diff --git a/examples/nodenumber/main.wasm b/examples/nodenumber/main.wasm
diff --git a/guest/bind/bind.go b/guest/bind/bind.go
@@ -52,7 +52,7 @@ var _ func() uint32 = _bind
 
 // _bind is only exported to the host.
 //
-//export bind
+//go:wasmexport bind
 func _bind() uint32 { //nolint
 	if bind == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/config/imports.go b/guest/config/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/config/imports_stub.go b/guest/config/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/enqueue/enqueue.go b/guest/enqueue/enqueue.go
@@ -43,7 +43,7 @@ var _ func() = _enqueue
 
 // enqueue is only exported to the host.
 //
-//export enqueue
+//go:wasmexport enqueue
 func _enqueue() {
 	if enqueue == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/enqueue/imports.go b/guest/enqueue/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/enqueue/imports_stub.go b/guest/enqueue/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/filter/filter.go b/guest/filter/filter.go
@@ -57,7 +57,7 @@ var _ func() uint32 = _filter
 
 // filter is only exported to the host.
 //
-//export filter
+//go:wasmexport filter
 func _filter() uint32 { //nolint
 	if filter == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/handle/eventrecorder/imports.go b/guest/handle/eventrecorder/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/handle/eventrecorder/imports_stub.go b/guest/handle/eventrecorder/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/handle/imports.go b/guest/handle/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/handle/imports_stub.go b/guest/handle/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/internal/imports/imports.go b/guest/internal/imports/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/internal/imports/imports_stub.go b/guest/internal/imports/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/internal/prefilter/imports.go b/guest/internal/prefilter/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/internal/prefilter/imports_stub.go b/guest/internal/prefilter/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/internal/prefilter/prefilter_exports.go b/guest/internal/prefilter/prefilter_exports.go
@@ -44,7 +44,7 @@ var _ func() uint32 = _prefilter
 
 // _prefilter is only exported to the host.
 //
-//export prefilter
+//go:wasmexport prefilter
 func _prefilter() uint32 { //nolint
 	// This function begins a new scheduling cycle: zero out any cycle state.
 	currentPod = nil
diff --git a/guest/klog/imports.go b/guest/klog/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/klog/imports_stub.go b/guest/klog/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/klog/klog_test.go b/guest/klog/klog_test.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/postbind/postbind.go b/guest/postbind/postbind.go
@@ -57,7 +57,7 @@ var _ func() = _postbind
 
 // _postbind is only exported to the host.
 //
-//export postbind
+//go:wasmexport postbind
 func _postbind() { //nolint
 	if postbind == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/postfilter/imports.go b/guest/postfilter/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/postfilter/imports_stub.go b/guest/postfilter/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/postfilter/postfilter.go b/guest/postfilter/postfilter.go
@@ -65,7 +65,7 @@ var _ func() uint64 = _postfilter
 
 // _postfilter is only exported to the host.
 //
-//export postfilter
+//go:wasmexport postfilter
 func _postfilter() uint64 { //nolint
 
 	if postfilter == nil { // Then, the user didn't define one.
diff --git a/guest/prebind/prebind.go b/guest/prebind/prebind.go
@@ -57,7 +57,7 @@ var _ func() uint32 = _prebind
 
 // _prebind is only exported to the host.
 //
-//export prebind
+//go:wasmexport prebind
 func _prebind() uint32 { //nolint
 	if prebind == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/prescore/imports.go b/guest/prescore/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/prescore/imports_stub.go b/guest/prescore/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/prescore/prescore.go b/guest/prescore/prescore.go
@@ -70,7 +70,7 @@ var _ func() uint32 = _prescore
 
 // prescore is only exported to the host.
 //
-//export prescore
+//go:wasmexport prescore
 func _prescore() uint32 {
 	if prescore == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/reserve/reserve.go b/guest/reserve/reserve.go
@@ -61,7 +61,7 @@ var (
 
 // _reserve is only exported to the host.
 //
-//export reserve
+//go:wasmexport reserve
 func _reserve() uint32 { //nolint
 	if reserve == nil { // Then, the user didn't define one.
 		// Unlike most plugins we always export reserve so that we can reset
@@ -77,7 +77,7 @@ func _reserve() uint32 { //nolint
 
 // _unreserve is only exported to the host.
 //
-//export unreserve
+//go:wasmexport unreserve
 func _unreserve() { //nolint
 	if reserve == nil { // Then, the user didn't define one.
 		// Unlike most plugins we always export unreserve so that we can reset
diff --git a/guest/score/score.go b/guest/score/score.go
@@ -61,7 +61,7 @@ var _ func() uint64 = _score
 
 // score is only exported to the host.
 //
-//export score
+//go:wasmexport score
 func _score() uint64 {
 	if score == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/scoreextensions/imports.go b/guest/scoreextensions/imports.go
@@ -1,4 +1,4 @@
-//go:build tinygo.wasm
+//go:build wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/scoreextensions/imports_stub.go b/guest/scoreextensions/imports_stub.go
@@ -1,4 +1,4 @@
-//go:build !tinygo.wasm
+//go:build !wasm
 
 /*
    Copyright 2023 The Kubernetes Authors.
diff --git a/guest/scoreextensions/scoreextensions.go b/guest/scoreextensions/scoreextensions.go
@@ -59,7 +59,7 @@ var _ func() uint32 = _normalizescore
 
 // normalizescore is only exported to the host.
 //
-//export normalizescore
+//go:wasmexport normalizescore
 func _normalizescore() uint32 {
 	if scoreextensions == nil { // Then, the user didn't define one.
 		// This is likely caused by use of plugin.Set(p), where 'p' didn't
diff --git a/guest/testdata/bind/main.wasm b/guest/testdata/bind/main.wasm
diff --git a/guest/testdata/cyclestate/main.wasm b/guest/testdata/cyclestate/main.wasm
diff --git a/guest/testdata/filter/main.wasm b/guest/testdata/filter/main.wasm
diff --git a/guest/testdata/handle/main.wasm b/guest/testdata/handle/main.wasm
diff --git a/guest/testdata/permit/main.wasm b/guest/testdata/permit/main.wasm
diff --git a/guest/testdata/reserve/main.wasm b/guest/testdata/reserve/main.wasm
diff --git a/guest/testdata/score/main.wasm b/guest/testdata/score/main.wasm
diff --git a/internal/e2e/scheduler_perf/wasm/nodenumber/main.wasm b/internal/e2e/scheduler_perf/wasm/nodenumber/main.wasm
diff --git a/scheduler/plugin/guest.go b/scheduler/plugin/guest.go
@@ -86,7 +86,7 @@ func (pl *wasmPlugin) newGuest(ctx context.Context) (*guest, error) {
 	// A guest may have an instantiation error, which writes to stdout or stderr.
 	// Capture stdout and stderr during instantiation.
 	var out bytes.Buffer
-	moduleConfig = moduleConfig.WithStdout(&out).WithStderr(&out)
+	moduleConfig = moduleConfig.WithStdout(&out).WithStderr(&out).WithStartFunctions("_initialize")
 
 	// Set any args used for testing
 	moduleConfig = moduleConfig.WithArgs(pl.guestArgs...)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//go:build tinygo.wasm`
	`1`	`+//go:build wasm`
`2`	`2`
`3`	`3`	`/*`
`4`	`4`	`Copyright 2023 The Kubernetes Authors.`