mleku/wazero
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Renames Runtime.DecodeModule to CompileModule (#351)

Browse Source 
The best way to reduce performance impact of instantiating a module
multiple times is lowering it to wazero's IR or even generating
assembly. This renames `DecodeModule` to `CompileModule` to allow that
sort of side-effect to be obvious even if it isn't currently
implemented.

Signed-off-by: Adrian Cole <adrian@tetrate.io>
This commit is contained in:
Crypt Keeper
2022-03-09 13:59:19 +08:00
committed by GitHub
parent 50d9fa58a1
commit 2114dfc492
5 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
builder.go
View File

@@ -114,7 +114,7 @@ func (b *moduleBuilder) Build() (*Module, error) {
}
}
// InstantiateModule implements ModuleBuilder.InstantiateModule
// Instantiate implements ModuleBuilder.Instantiate
func (b *moduleBuilder) Instantiate() (wasm.Module, error) {
if module, err := b.Build(); err != nil {
return nil, err

6
wasi.go
View File

@@ -88,9 +88,9 @@ func WASISnapshotPreview1WithConfig(c *WASIConfig) *Module {
// wasi, _ := r.NewHostModule(wazero.WASISnapshotPreview1())
// module, _ := StartWASICommandFromSource(r, source)
//
// Note: This is a convenience utility that chains Runtime.DecodeModule with StartWASICommand.
// Note: This is a convenience utility that chains Runtime.CompileModule with StartWASICommand.
func StartWASICommandFromSource(r Runtime, source []byte) (wasm.Module, error) {
if decoded, err := r.DecodeModule(source); err != nil {
if decoded, err := r.CompileModule(source); err != nil {
return nil, err
} else {
return StartWASICommand(r, decoded)
@@ -104,7 +104,7 @@ func StartWASICommandFromSource(r Runtime, source []byte) (wasm.Module, error) {
// Ex.
// r := wazero.NewRuntime()
// wasi, _ := r.NewHostModule(wazero.WASISnapshotPreview1())
// decoded, _ := r.DecodeModule(source)
// decoded, _ := r.CompileModule(source)
// module, _ := StartWASICommand(r, decoded)
//
// Prerequisites of the "Current Unstable ABI" from wasi.ModuleSnapshotPreview1:

2
wasi_test.go
View File

@@ -27,7 +27,7 @@ func TestStartWASICommand_UsesStoreContext(t *testing.T) {
_, err = r.InstantiateModule(WASISnapshotPreview1())
require.NoError(t, err)
decoded, err := r.DecodeModule([]byte(`(module $wasi_test.go
decoded, err := r.CompileModule([]byte(`(module $wasi_test.go
(import "" "start" (func $start))
(memory 1)
(export "_start" (func $start))

21
wasm.go
View File

@@ -14,7 +14,7 @@ import (
//
// Ex.
// r := wazero.NewRuntime()
// decoded, _ := r.DecodeModule(source)
// decoded, _ := r.CompileModule(source)
// module, _ := r.InstantiateModule(decoded)
//
// See https://www.w3.org/TR/2019/REC-wasm-core-1-20191205/
@@ -32,11 +32,12 @@ type Runtime interface {
// Module returns exports from an instantiated module or nil if there aren't any.
Module(moduleName string) wasm.Module
// DecodeModule decodes the WebAssembly 1.0 (20191205) text or binary source or errs if invalid.
// CompileModule decodes the WebAssembly 1.0 (20191205) text or binary source or errs if invalid.
// Any pre-compilation done after decoding the source is dependent on the RuntimeConfig.
//
// Note: the name defaults to what was decoded from the custom name section.
// Note: The resulting module name defaults to what was decoded from the custom name section.
// See https://www.w3.org/TR/2019/REC-wasm-core-1-20191205/#name-section%E2%91%A0
DecodeModule(source []byte) (*Module, error)
CompileModule(source []byte) (*Module, error)
// InstantiateModuleFromSource instantiates a module from the WebAssembly 1.0 (20191205) text or binary source or
// errs if invalid.
@@ -44,15 +45,15 @@ type Runtime interface {
// Ex.
// module, _ := wazero.NewRuntime().InstantiateModuleFromSource(source)
//
// Note: This is a convenience utility that chains DecodeModule with InstantiateModule. To instantiate the same source
// multiple times, use DecodeModule as InstantiateModule avoids redundant decoding and/or compilation.
// Note: This is a convenience utility that chains CompileModule with InstantiateModule. To instantiate the same
// source multiple times, use CompileModule as InstantiateModule avoids redundant decoding and/or compilation.
InstantiateModuleFromSource(source []byte) (wasm.Module, error)
// InstantiateModule instantiates the module namespace or errs if the configuration was invalid.
//
// Ex.
// r := wazero.NewRuntime()
// decoded, _ := r.DecodeModule(source)
// decoded, _ := r.CompileModule(source)
// module, _ := r.InstantiateModule(decoded)
//
// Note: The last value of RuntimeConfig.WithContext is used for any WebAssembly 1.0 (20191205) Start ExportedFunction.
@@ -84,8 +85,8 @@ func (r *runtime) Module(moduleName string) wasm.Module {
return r.store.Module(moduleName)
}
// DecodeModule implements Runtime.DecodeModule
func (r *runtime) DecodeModule(source []byte) (*Module, error) {
// CompileModule implements Runtime.CompileModule
func (r *runtime) CompileModule(source []byte) (*Module, error) {
if source == nil {
return nil, errors.New("source == nil")
}
@@ -121,7 +122,7 @@ func (r *runtime) DecodeModule(source []byte) (*Module, error) {
// InstantiateModuleFromSource implements Runtime.InstantiateModuleFromSource
func (r *runtime) InstantiateModuleFromSource(source []byte) (wasm.Module, error) {
if decoded, err := r.DecodeModule(source); err != nil {
if decoded, err := r.CompileModule(source); err != nil {
return nil, err
} else {
return r.InstantiateModule(decoded)

12
wasm_test.go
View File

@@ -52,7 +52,7 @@ func TestRuntime_DecodeModule(t *testing.T) {
tc := tt
t.Run(tc.name, func(t *testing.T) {
decoded, err := r.DecodeModule(tc.source)
decoded, err := r.CompileModule(tc.source)
require.NoError(t, err)
require.Equal(t, tc.expectedName, decoded.name)
})
@@ -86,7 +86,7 @@ func TestRuntime_DecodeModule_Errors(t *testing.T) {
tc := tt
t.Run(tc.name, func(t *testing.T) {
_, err := r.DecodeModule(tc.source)
_, err := r.CompileModule(tc.source)
require.EqualError(t, err, tc.expectedErr)
})
}
@@ -96,7 +96,7 @@ func TestRuntime_DecodeModule_Errors(t *testing.T) {
// names. This pattern is used in wapc-go.
func TestDecodedModule_WithName(t *testing.T) {
r := NewRuntime()
base, err := r.DecodeModule([]byte(`(module $0 (memory 1))`))
base, err := r.CompileModule([]byte(`(module $0 (memory 1))`))
require.NoError(t, err)
require.Equal(t, "0", base.name)
@@ -138,7 +138,7 @@ func TestModule_Memory(t *testing.T) {
r := NewRuntime()
t.Run(tc.name, func(t *testing.T) {
decoded, err := r.DecodeModule([]byte(tc.wat))
decoded, err := r.CompileModule([]byte(tc.wat))
require.NoError(t, err)
// Instantiate the module and get the export of the above hostFn
@@ -276,7 +276,7 @@ func TestFunction_Context(t *testing.T) {
source := requireImportAndExportFunction(t, r, hostFn, functionName)
// Instantiate the module and get the export of the above hostFn
decoded, err := r.DecodeModule(source)
decoded, err := r.CompileModule(source)
require.NoError(t, err)
module, err := r.InstantiateModule(decoded)
@@ -306,7 +306,7 @@ func TestRuntime_NewModule_UsesStoreContext(t *testing.T) {
_, err := r.NewModuleBuilder("").ExportFunction("start", start).Instantiate()
require.NoError(t, err)
decoded, err := r.DecodeModule([]byte(`(module $runtime_test.go
decoded, err := r.CompileModule([]byte(`(module $runtime_test.go
(import "" "start" (func $start))
(start $start)
)`))