Extracts CompileConfig and consolidates code. (#533)

This performs several changes to allow compilation config to be
centralized and scoped properly. The immediate effects are that we can
now process external types during `Runtime.CompileModule` instead of
doing so later during `Runtime.InstantiateModule`. Another nice side
effect is memory size problems can err at a source line instead of
having to be handled in several places.

There are some API effects to this, and to pay for them, some less used
APIs were removed. The "easy APIs" are left alone. For example, the APIs
to compile and instantiate a module from Go or Wasm in one step are left
alone.

Here are the changes, some of which are only for consistency. Rationale
is summarized in each point.
* ModuleBuilder.Build -> ModuleBuilder.Compile
  * The result of this is similar to `CompileModule`, and pairs better
    with `ModuleBuilder.Instantiate` which is like `InstantiateModule`.
* CompiledCode -> CompiledModule
  * We punted on this name, the result is more than just code. This is
    better I think and more consistent as it introduces less terms.
* Adds CompileConfig param to Runtime.CompileModule.
  * This holds existing features and will have future ones, such as
    mapping externtypes to uint64 for wasm that doesn't yet support it.
* Merges Runtime.InstantiateModuleWithConfig with Runtime.InstantiateModule
  * This allows us to explain APIs in terms of implicit or explicit
    compilation and config, vs implicit, kindof implicit, and explicit.
* Removes Runtime.InstantiateModuleFromCodeWithConfig
  * Similar to above, this API only saves the compilation step and also
    difficult to reason with from a name POV.
* RuntimeConfig.WithMemory(CapacityPages|LimitPages) -> CompileConfig.WithMemorySizer
  * This allows all error handling to be attached to the source line
  * This also allows someone to reduce unbounded memory while knowing
    what its minimum is.
* ModuleConfig.With(Import|ImportModule) -> CompileConfig.WithImportRenamer
  * This allows more types of import manipulation, also without
    conflating functions with globals.
* Adds api.ExternType
  * Needed for ImportRenamer and will be needed later for ExportRenamer.

Signed-off-by: Adrian Cole <adrian@tetrate.io>
This commit is contained in:
Crypt Keeper
2022-05-09 11:02:32 +08:00
committed by GitHub
parent 0561190cb9
commit 8f8c9ee205
47 changed files with 784 additions and 1104 deletions

View File

@@ -18,16 +18,20 @@ import (
// hello := func() {
// fmt.Fprintln(stdout, "hello!")
// }
// env, _ := r.NewModuleBuilder("env").ExportFunction("hello", hello).Instantiate(ctx)
// env, _ := r.NewModuleBuilder("env").
// ExportFunction("hello", hello).
// Instantiate(ctx)
//
// If the same module may be instantiated multiple times, it is more efficient to separate steps. Ex.
//
// env, _ := r.NewModuleBuilder("env").ExportFunction("get_random_string", getRandomString).Build(ctx)
// compiled, _ := r.NewModuleBuilder("env").
// ExportFunction("get_random_string", getRandomString).
// Compile(ctx, wazero.NewCompileConfig())
//
// env1, _ := r.InstantiateModuleWithConfig(ctx, env, NewModuleConfig().WithName("env.1"))
// env1, _ := r.InstantiateModule(ctx, compiled, wazero.NewModuleConfig().WithName("env.1"))
// defer env1.Close(ctx)
//
// env2, _ := r.InstantiateModuleWithConfig(ctx, env, NewModuleConfig().WithName("env.2"))
// env2, _ := r.InstantiateModule(ctx, compiled, wazero.NewModuleConfig().WithName("env.2"))
// defer env2.Close(ctx)
//
// Notes:
@@ -152,12 +156,13 @@ type ModuleBuilder interface {
// See https://www.w3.org/TR/2019/REC-wasm-core-1-20191205/#syntax-globaltype
ExportGlobalF64(name string, v float64) ModuleBuilder
// Build returns a module to instantiate, or returns an error if any of the configuration is invalid.
Build(context.Context) (CompiledCode, error)
// Compile returns a module to instantiate, or an error if any of the configuration is invalid.
Compile(context.Context, CompileConfig) (CompiledModule, error)
// Instantiate is a convenience that calls Build, then Runtime.InstantiateModule
// Instantiate is a convenience that calls Build, then Runtime.InstantiateModule, using default configuration.
//
// Note: Fields in the builder are copied during instantiation: Later changes do not affect the instantiated result.
// Note: To avoid using configuration defaults, use Compile instead.
Instantiate(context.Context) (api.Module, error)
}
@@ -197,17 +202,13 @@ func (b *moduleBuilder) ExportFunctions(nameToGoFunc map[string]interface{}) Mod
// ExportMemory implements ModuleBuilder.ExportMemory
func (b *moduleBuilder) ExportMemory(name string, minPages uint32) ModuleBuilder {
mem := &wasm.Memory{Min: minPages, Max: b.r.memoryLimitPages}
mem.Cap = b.r.memoryCapacityPages(mem.Min, nil)
b.nameToMemory[name] = mem
b.nameToMemory[name] = &wasm.Memory{Min: minPages}
return b
}
// ExportMemoryWithMax implements ModuleBuilder.ExportMemoryWithMax
func (b *moduleBuilder) ExportMemoryWithMax(name string, minPages, maxPages uint32) ModuleBuilder {
mem := &wasm.Memory{Min: minPages, Max: maxPages, IsMaxEncoded: true}
mem.Cap = b.r.memoryCapacityPages(mem.Min, &maxPages)
b.nameToMemory[name] = mem
b.nameToMemory[name] = &wasm.Memory{Min: minPages, Max: maxPages, IsMaxEncoded: true}
return b
}
@@ -249,16 +250,22 @@ func (b *moduleBuilder) ExportGlobalF64(name string, v float64) ModuleBuilder {
return b
}
// Build implements ModuleBuilder.Build
func (b *moduleBuilder) Build(ctx context.Context) (CompiledCode, error) {
// Compile implements ModuleBuilder.Compile
func (b *moduleBuilder) Compile(ctx context.Context, cConfig CompileConfig) (CompiledModule, error) {
config, ok := cConfig.(*compileConfig)
if !ok {
panic(fmt.Errorf("unsupported wazero.CompileConfig implementation: %#v", cConfig))
}
// Verify the maximum limit here, so we don't have to pass it to wasm.NewHostModule
memoryLimitPages := b.r.memoryLimitPages
for name, mem := range b.nameToMemory {
if err := mem.ValidateMinMax(memoryLimitPages); err != nil {
return nil, fmt.Errorf("memory[%s] %v", name, err)
var maxP *uint32
if mem.IsMaxEncoded {
maxP = &mem.Max
}
if err := b.r.setMemoryCapacity(name, mem); err != nil {
return nil, err
mem.Min, mem.Cap, mem.Max = config.memorySizer(mem.Min, maxP)
if err := mem.Validate(); err != nil {
return nil, fmt.Errorf("memory[%s] %v", name, err)
}
}
@@ -276,7 +283,7 @@ func (b *moduleBuilder) Build(ctx context.Context) (CompiledCode, error) {
// Instantiate implements ModuleBuilder.Instantiate
func (b *moduleBuilder) Instantiate(ctx context.Context) (api.Module, error) {
if compiled, err := b.Build(ctx); err != nil {
if compiled, err := b.Compile(ctx, NewCompileConfig()); err != nil {
return nil, err
} else {
if err = b.r.store.Engine.CompileModule(ctx, compiled.(*compiledCode).module); err != nil {
@@ -284,6 +291,6 @@ func (b *moduleBuilder) Instantiate(ctx context.Context) (api.Module, error) {
}
// *wasm.ModuleInstance cannot be tracked, so we release the cache inside this function.
defer compiled.Close(ctx)
return b.r.InstantiateModuleWithConfig(ctx, compiled, NewModuleConfig().WithName(b.moduleName))
return b.r.InstantiateModule(ctx, compiled, NewModuleConfig().WithName(b.moduleName))
}
}