Files
wazero/internal/gojs/syscall.go
Crypt Keeper 126bd9050d Removes context parameter from instruction-scoped operations (#923)
We originally had a `context.Context` for anything that might be
traced, but it turned out to be only useful for lifecycle and host functions.

For instruction-scoped aspects like memory updates, a context parameter is too
fine-grained and also invisible in practice. For example, most users will use
the compiler engine, and its memory, global or table access will never use go's
context.

Signed-off-by: Adrian Cole <adrian@tetrate.io>
2022-12-14 16:08:07 +09:00

606 lines
19 KiB
Go

package gojs
import (
"context"
"errors"
"fmt"
"io/fs"
"net/http"
"syscall"
"github.com/tetratelabs/wazero/api"
"github.com/tetratelabs/wazero/internal/gojs/spfunc"
"github.com/tetratelabs/wazero/internal/wasm"
"github.com/tetratelabs/wazero/sys"
)
const (
finalizeRefName = "syscall/js.finalizeRef"
stringValName = "syscall/js.stringVal"
valueGetName = "syscall/js.valueGet"
valueSetName = "syscall/js.valueSet"
valueDeleteName = "syscall/js.valueDelete" // stubbed
valueIndexName = "syscall/js.valueIndex"
valueSetIndexName = "syscall/js.valueSetIndex" // stubbed
valueCallName = "syscall/js.valueCall"
valueInvokeName = "syscall/js.valueInvoke" // stubbed
valueNewName = "syscall/js.valueNew"
valueLengthName = "syscall/js.valueLength"
valuePrepareStringName = "syscall/js.valuePrepareString"
valueLoadStringName = "syscall/js.valueLoadString"
valueInstanceOfName = "syscall/js.valueInstanceOf" // stubbed
copyBytesToGoName = "syscall/js.copyBytesToGo"
copyBytesToJSName = "syscall/js.copyBytesToJS"
)
// FinalizeRef implements js.finalizeRef, which is used as a
// runtime.SetFinalizer on the given reference.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L61
var FinalizeRef = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{finalizeRefName},
Name: finalizeRefName,
ParamTypes: []api.ValueType{i32},
ParamNames: []string{"r"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoFunc(finalizeRef),
},
})
func finalizeRef(ctx context.Context, stack []uint64) {
id := uint32(stack[0]) // 32-bits of the ref are the ID
getState(ctx).values.decrement(id)
}
// StringVal implements js.stringVal, which is used to load the string for
// `js.ValueOf(x)`. For example, this is used when setting HTTP headers.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L212
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L305-L308
var StringVal = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{stringValName},
Name: stringValName,
ParamTypes: []api.ValueType{i32, i32},
ParamNames: []string{"xAddr", "xLen"},
ResultTypes: []api.ValueType{i64},
ResultNames: []string{"ref"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(stringVal),
},
})
func stringVal(ctx context.Context, mod api.Module, stack []uint64) {
xAddr, xLen := uint32(stack[0]), uint32(stack[1])
x := string(mustRead(mod.Memory(), "x", xAddr, xLen))
stack[0] = storeRef(ctx, x)
}
// ValueGet implements js.valueGet, which is used to load a js.Value property
// by name, e.g. `v.Get("address")`. Notably, this is used by js.handleEvent to
// get the pending event.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L295
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L311-L316
var ValueGet = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{valueGetName},
Name: valueGetName,
ParamTypes: []api.ValueType{i64, i32, i32},
ParamNames: []string{"v", "pAddr", "pLen"},
ResultTypes: []api.ValueType{i64},
ResultNames: []string{"ref"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(valueGet),
},
})
func valueGet(ctx context.Context, mod api.Module, stack []uint64) {
vRef := stack[0]
pAddr := uint32(stack[1])
pLen := uint32(stack[2])
p := string(mustRead(mod.Memory(), "p", pAddr, pLen))
v := loadValue(ctx, ref(vRef))
var result interface{}
if g, ok := v.(jsGet); ok {
result = g.get(ctx, p)
} else if e, ok := v.(error); ok {
switch p {
case "message": // js (GOOS=js) error, can be anything.
result = e.Error()
case "code": // syscall (GOARCH=wasm) error, must match key in mapJSError in fs_js.go
result = mapJSError(e).Error()
default:
panic(fmt.Errorf("TODO: valueGet(v=%v, p=%s)", v, p))
}
} else {
panic(fmt.Errorf("TODO: valueGet(v=%v, p=%s)", v, p))
}
stack[0] = storeRef(ctx, result)
}
// ValueSet implements js.valueSet, which is used to store a js.Value property
// by name, e.g. `v.Set("address", a)`. Notably, this is used by js.handleEvent
// set the event result.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L309
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L318-L322
var ValueSet = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{valueSetName},
Name: valueSetName,
ParamTypes: []api.ValueType{i64, i32, i32, i64},
ParamNames: []string{"v", "pAddr", "pLen", "x"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(valueSet),
},
})
func valueSet(ctx context.Context, mod api.Module, stack []uint64) {
vRef := stack[0]
pAddr := uint32(stack[1])
pLen := uint32(stack[2])
xRef := stack[3]
v := loadValue(ctx, ref(vRef))
p := string(mustRead(mod.Memory(), "p", pAddr, pLen))
x := loadValue(ctx, ref(xRef))
if v == getState(ctx) {
switch p {
case "_pendingEvent":
if x == nil { // syscall_js.handleEvent
v.(*state)._pendingEvent = nil
return
}
}
} else if e, ok := v.(*event); ok { // syscall_js.handleEvent
switch p {
case "result":
e.result = x
return
}
} else if m, ok := v.(*object); ok {
m.properties[p] = x // e.g. opt.Set("method", req.Method)
return
}
panic(fmt.Errorf("TODO: valueSet(v=%v, p=%s, x=%v)", v, p, x))
}
// ValueDelete is stubbed as it isn't used in Go's main source tree.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L321
var ValueDelete = stubFunction(valueDeleteName)
// ValueIndex implements js.valueIndex, which is used to load a js.Value property
// by index, e.g. `v.Index(0)`. Notably, this is used by js.handleEvent to read
// event arguments
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L334
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L331-L334
var ValueIndex = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{valueIndexName},
Name: valueIndexName,
ParamTypes: []api.ValueType{i64, i32},
ParamNames: []string{"v", "i"},
ResultTypes: []api.ValueType{i64},
ResultNames: []string{"ref"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoFunc(valueIndex),
},
})
func valueIndex(ctx context.Context, stack []uint64) {
vRef := stack[0]
i := uint32(stack[1])
v := loadValue(ctx, ref(vRef))
result := v.(*objectArray).slice[i]
stack[0] = storeRef(ctx, result)
}
// ValueSetIndex is stubbed as it is only used for js.ValueOf when the input is
// []interface{}, which doesn't appear to occur in Go's source tree.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L348
var ValueSetIndex = stubFunction(valueSetIndexName)
// ValueCall implements js.valueCall, which is used to call a js.Value function
// by name, e.g. `document.Call("createElement", "div")`.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L394
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L343-L358
var ValueCall = spfunc.MustCallFromSP(true, &wasm.HostFunc{
ExportNames: []string{valueCallName},
Name: valueCallName,
ParamTypes: []api.ValueType{i64, i32, i32, i32, i32},
ParamNames: []string{"v", "mAddr", "mLen", "argsArray", "argsLen"},
ResultTypes: []api.ValueType{i64, i32, i32},
ResultNames: []string{"ref", "ok", "sp"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(valueCall),
},
})
func valueCall(ctx context.Context, mod api.Module, stack []uint64) {
vRef := stack[0]
mAddr := uint32(stack[1])
mLen := uint32(stack[2])
argsArray := uint32(stack[3])
argsLen := uint32(stack[4])
this := ref(vRef)
v := loadValue(ctx, this)
m := string(mustRead(mod.Memory(), "m", mAddr, mLen))
args := loadArgs(ctx, mod, argsArray, argsLen)
var xRef uint64
var ok, sp uint32
if c, isCall := v.(jsCall); !isCall {
panic(fmt.Errorf("TODO: valueCall(v=%v, m=%v, args=%v)", v, m, args))
} else if result, err := c.call(ctx, mod, this, m, args...); err != nil {
xRef = storeRef(ctx, err)
ok = 0
} else {
xRef = storeRef(ctx, result)
ok = 1
}
sp = refreshSP(mod)
stack[0], stack[1], stack[2] = xRef, uint64(ok), uint64(sp)
}
// ValueInvoke is stubbed as it isn't used in Go's main source tree.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L413
var ValueInvoke = stubFunction(valueInvokeName)
// ValueNew implements js.valueNew, which is used to call a js.Value, e.g.
// `array.New(2)`.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L432
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L380-L391
var ValueNew = spfunc.MustCallFromSP(true, &wasm.HostFunc{
ExportNames: []string{valueNewName},
Name: valueNewName,
ParamTypes: []api.ValueType{i64, i32, i32},
ParamNames: []string{"v", "argsArray", "argsLen"},
ResultTypes: []api.ValueType{i64, i32, i32},
ResultNames: []string{"ref", "ok", "sp"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(valueNew),
},
})
func valueNew(ctx context.Context, mod api.Module, stack []uint64) {
vRef := stack[0]
argsArray := uint32(stack[1])
argsLen := uint32(stack[2])
args := loadArgs(ctx, mod, argsArray, argsLen)
ref := ref(vRef)
v := loadValue(ctx, ref)
var xRef uint64
var ok, sp uint32
switch ref {
case refArrayConstructor:
result := &objectArray{}
xRef = storeRef(ctx, result)
ok = 1
case refUint8ArrayConstructor:
var result *byteArray
if n, ok := args[0].(float64); ok {
result = &byteArray{make([]byte, uint32(n))}
} else if n, ok := args[0].(uint32); ok {
result = &byteArray{make([]byte, n)}
} else if b, ok := args[0].(*byteArray); ok {
// In case of below, in HTTP, return the same ref
// uint8arrayWrapper := uint8Array.New(args[0])
result = b
} else {
panic(fmt.Errorf("TODO: valueNew(v=%v, args=%v)", v, args))
}
xRef = storeRef(ctx, result)
ok = 1
case refObjectConstructor:
result := &object{properties: map[string]interface{}{}}
xRef = storeRef(ctx, result)
ok = 1
case refHttpHeadersConstructor:
result := &headers{headers: http.Header{}}
xRef = storeRef(ctx, result)
ok = 1
case refJsDateConstructor:
xRef = uint64(refJsDate)
ok = 1
default:
panic(fmt.Errorf("TODO: valueNew(v=%v, args=%v)", v, args))
}
sp = refreshSP(mod)
stack[0], stack[1], stack[2] = xRef, uint64(ok), uint64(sp)
}
// ValueLength implements js.valueLength, which is used to load the length
// property of a value, e.g. `array.length`.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L372
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L396-L397
var ValueLength = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{valueLengthName},
Name: valueLengthName,
ParamTypes: []api.ValueType{i64},
ParamNames: []string{"v"},
ResultTypes: []api.ValueType{i32},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoFunc(valueLength),
},
})
func valueLength(ctx context.Context, stack []uint64) {
vRef := stack[0]
v := loadValue(ctx, ref(vRef))
l := uint32(len(v.(*objectArray).slice))
stack[0] = uint64(l)
}
// ValuePrepareString implements js.valuePrepareString, which is used to load
// the string for `o.String()` (via js.jsString) for string, boolean and
// number types. Notably, http.Transport uses this in RoundTrip to coerce the
// URL to a string.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L531
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L402-L405
var ValuePrepareString = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{valuePrepareStringName},
Name: valuePrepareStringName,
ParamTypes: []api.ValueType{i64},
ParamNames: []string{"v"},
ResultTypes: []api.ValueType{i64, i32},
ResultNames: []string{"ref", "len"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoFunc(valuePrepareString),
},
})
func valuePrepareString(ctx context.Context, stack []uint64) {
vRef := stack[0]
v := loadValue(ctx, ref(vRef))
s := valueString(v)
sRef := storeRef(ctx, s)
sLen := uint32(len(s))
stack[0], stack[1] = sRef, uint64(sLen)
}
// ValueLoadString implements js.valueLoadString, which is used copy a string
// value for `o.String()`.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L533
//
// https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L410-L412
var ValueLoadString = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{valueLoadStringName},
Name: valueLoadStringName,
ParamTypes: []api.ValueType{i64, i32, i32},
ParamNames: []string{"v", "bAddr", "bLen"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(valueLoadString),
},
})
func valueLoadString(ctx context.Context, mod api.Module, stack []uint64) {
vRef := stack[0]
bAddr := uint32(stack[1])
bLen := uint32(stack[2])
v := loadValue(ctx, ref(vRef))
s := valueString(v)
b := mustRead(mod.Memory(), "b", bAddr, bLen)
copy(b, s)
}
// ValueInstanceOf is stubbed as it isn't used in Go's main source tree.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L543
var ValueInstanceOf = stubFunction(valueInstanceOfName)
// CopyBytesToGo copies a JavaScript managed byte array to linear memory.
// For example, this is used to read an HTTP response body.
//
// # Results
//
// - n is the count of bytes written.
// - ok is false if the src was not a uint8Array.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L569
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L424-L433
var CopyBytesToGo = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{copyBytesToGoName},
Name: copyBytesToGoName,
ParamTypes: []api.ValueType{i32, i32, i32, i64},
ParamNames: []string{"dstAddr", "dstLen", "_", "src"},
ResultTypes: []api.ValueType{i32, i32},
ResultNames: []string{"n", "ok"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(copyBytesToGo),
},
})
func copyBytesToGo(ctx context.Context, mod api.Module, stack []uint64) {
dstAddr := uint32(stack[0])
dstLen := uint32(stack[1])
_ /* unknown */ = uint32(stack[2])
srcRef := stack[3]
dst := mustRead(mod.Memory(), "dst", dstAddr, dstLen) // nolint
v := loadValue(ctx, ref(srcRef))
var n, ok uint32
if src, isBuf := v.(*byteArray); isBuf {
n = uint32(copy(dst, src.slice))
ok = 1
}
stack[0], stack[1] = uint64(n), uint64(ok)
}
// CopyBytesToJS copies linear memory to a JavaScript managed byte array.
// For example, this is used to read an HTTP request body.
//
// # Results
//
// - n is the count of bytes written.
// - ok is false if the dst was not a uint8Array.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/js/js.go#L583
// and https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L438-L448
var CopyBytesToJS = spfunc.MustCallFromSP(false, &wasm.HostFunc{
ExportNames: []string{copyBytesToJSName},
Name: copyBytesToJSName,
ParamTypes: []api.ValueType{i64, i32, i32, i32},
ParamNames: []string{"dst", "srcAddr", "srcLen", "_"},
ResultTypes: []api.ValueType{i32, i32},
ResultNames: []string{"n", "ok"},
Code: &wasm.Code{
IsHostFunction: true,
GoFunc: api.GoModuleFunc(copyBytesToJS),
},
})
func copyBytesToJS(ctx context.Context, mod api.Module, stack []uint64) {
dstRef := stack[0]
srcAddr := uint32(stack[1])
srcLen := uint32(stack[2])
_ /* unknown */ = uint32(stack[3])
src := mustRead(mod.Memory(), "src", srcAddr, srcLen) // nolint
v := loadValue(ctx, ref(dstRef))
var n, ok uint32
if dst, isBuf := v.(*byteArray); isBuf {
if dst != nil { // empty is possible on EOF
n = uint32(copy(dst.slice, src))
}
ok = 1
}
stack[0], stack[1] = uint64(n), uint64(ok)
}
// refreshSP refreshes the stack pointer, which is needed prior to storeValue
// when in an operation that can trigger a Go event handler.
//
// See https://github.com/golang/go/blob/go1.19/misc/wasm/wasm_exec.js#L210-L213
func refreshSP(mod api.Module) uint32 {
// Cheat by reading global[0] directly instead of through a function proxy.
// https://github.com/golang/go/blob/go1.19/src/runtime/rt0_js_wasm.s#L87-L90
return uint32(mod.(*wasm.CallContext).GlobalVal(0))
}
// syscallErr is a (GOARCH=wasm) error, which must match a key in mapJSError.
//
// See https://github.com/golang/go/blob/go1.19/src/syscall/tables_js.go#L371-L494
type syscallErr struct {
s string
}
// Error implements error.
func (e *syscallErr) Error() string {
return e.s
}
// While usually I/O returns the correct errors, being explicit helps reduce
// chance of problems.
var (
ebadf = &syscallErr{"EBADF"}
einval = &syscallErr{"EBADF"}
eexist = &syscallErr{"EEXIST"}
enoent = &syscallErr{"ENOENT"}
enotdir = &syscallErr{"ENOTDIR"}
)
// mapJSError maps I/O errors as the message must be the code, ex. "EINVAL",
// not the message, ex. "invalid argument".
func mapJSError(err error) *syscallErr {
if e, ok := err.(*syscallErr); ok {
return e
}
switch {
case errors.Is(err, syscall.EBADF), errors.Is(err, fs.ErrClosed):
return ebadf
case errors.Is(err, syscall.EINVAL), errors.Is(err, fs.ErrInvalid):
return einval
case errors.Is(err, syscall.EEXIST), errors.Is(err, fs.ErrExist):
return eexist
case errors.Is(err, syscall.ENOENT), errors.Is(err, fs.ErrNotExist):
return enoent
case errors.Is(err, syscall.ENOTDIR):
return enotdir
default:
// panic so we can map the error before reaching JavaScript, which
// can't see the error message as it just prints "object".
panic(fmt.Errorf("unmapped error: %v", err))
}
}
// syscallOpen is like syscall.Open
func syscallOpen(mod api.Module, name string, flags, perm uint32) (uint32, error) {
fsc := mod.(*wasm.CallContext).Sys.FS()
return fsc.OpenFile(name)
}
// funcWrapper is the result of go's js.FuncOf ("_makeFuncWrapper" here).
//
// This ID is managed on the Go side an increments (possibly rolling over).
type funcWrapper uint32
// jsFn implements jsFn.invoke
func (f funcWrapper) invoke(ctx context.Context, mod api.Module, args ...interface{}) (interface{}, error) {
e := &event{id: uint32(f), this: args[0].(ref)}
if len(args) > 1 { // Ensure arguments are hashable.
e.args = &objectArray{args[1:]}
for i, v := range e.args.slice {
if s, ok := v.([]byte); ok {
args[i] = &byteArray{s}
} else if s, ok := v.([]interface{}); ok {
args[i] = &objectArray{s}
} else if e, ok := v.(error); ok {
args[i] = e
}
}
}
getState(ctx)._pendingEvent = e // Note: _pendingEvent reference is cleared during resume!
if _, err := mod.ExportedFunction("resume").Call(ctx); err != nil {
if _, ok := err.(*sys.ExitError); ok {
return nil, nil // allow error-handling to unwind when wasm calls exit due to a panic
} else {
return nil, err
}
}
return e.result, nil
}