Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(lib/runtime/wasmer): common setupVM function #2685

Merged
merged 5 commits into from
Jul 26, 2022
Merged

chore(lib/runtime/wasmer): common setupVM function #2685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5924203
Common `setupVM` function
qdm12 Jul 20, 2022
720726e
Move instance `Stop` after setupVM succeeds
qdm12 Jul 20, 2022
0d59c3d
Fix thread safety issue in `UpdateRuntimeCode`
qdm12 Jul 20, 2022
d6cf546
Explicit runtime stop call in `dot/state/initialize.go`
qdm12 Jul 20, 2022
2ee6693
Clear allocator when closing instance
qdm12 Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions dot/state/initialize.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ func (s *Service) Initialise(gen *genesis.Genesis, header *types.Header, t *trie
if err != nil {
return err
}
rt.Stop()

// write initial genesis values to database
if err = s.storeInitialValues(gen.GenesisData(), t); err != nil {
Expand Down Expand Up @@ -116,8 +117,6 @@ func (s *Service) loadBabeConfigurationFromRuntime(r runtime.Instance) (*types.B
return nil, fmt.Errorf("failed to fetch genesis babe configuration: %w", err)
}

r.Stop()

if s.BabeThresholdDenominator != 0 {
babeCfg.C1 = s.BabeThresholdNumerator
babeCfg.C2 = s.BabeThresholdDenominator
Expand Down
167 changes: 81 additions & 86 deletions lib/runtime/wasmer/instance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ type Instance struct {
ctx *runtime.Context
isClosed bool
codeHash common.Hash
sync.Mutex
mutex sync.Mutex
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note this was changed since I was having trouble finding references to the Lock/Unlock methods.

As a side note, I think we should avoid embedding things due to that, and also because it exports methods we might not want exported actually (like here, the mutex should be private).

}

// NewRuntimeFromGenesis creates a runtime instance from the genesis data
Expand Down Expand Up @@ -82,54 +82,14 @@ func NewInstanceFromFile(fp string, cfg runtime.InstanceConfig) (*Instance, erro
}

// NewInstance instantiates a runtime from raw wasm bytecode
func NewInstance(code []byte, cfg runtime.InstanceConfig) (*Instance, error) {
if len(code) == 0 {
return nil, errors.New("code is empty")
}

var err error
code, err = decompressWasm(code)
if err != nil {
return nil, fmt.Errorf("cannot decompress WASM code: %w", err)
}

func NewInstance(code []byte, cfg runtime.InstanceConfig) (instance *Instance, err error) {
logger.Patch(log.SetLevel(cfg.LogLvl), log.SetCallerFunc(true))

imports, err := importsNodeRuntime()
if err != nil {
return nil, fmt.Errorf("creating node runtime imports: %w", err)
}

// Provide importable memory for newer runtimes
// TODO: determine memory descriptor size that the runtime wants from the wasm. (#1268)
// should be doable w/ wasmer 1.0.0.
memory, err := wasm.NewMemory(23, 0)
if err != nil {
return nil, err
}

_, err = imports.AppendMemory("memory", memory)
wasmInstance, allocator, err := setupVM(code)
if err != nil {
return nil, err
return nil, fmt.Errorf("setting up VM: %w", err)
}

// Instantiates the WebAssembly module.
instance, err := wasm.NewInstanceWithImports(code, imports)
if err != nil {
return nil, err
}

// TODO: get __heap_base exported value from runtime.
// wasmer 0.3.x does not support this, but wasmer 1.0.0 does (#1268)
heapBase := runtime.DefaultHeapBase

// Assume imported memory is used if runtime does not export any
if !instance.HasMemory() {
instance.Memory = memory
}

allocator := runtime.NewAllocator(instance.Memory, heapBase)

runtimeCtx := &runtime.Context{
Storage: cfg.Storage,
Allocator: allocator,
Expand All @@ -141,17 +101,13 @@ func NewInstance(code []byte, cfg runtime.InstanceConfig) (*Instance, error) {
SigVerifier: crypto.NewSignatureVerifier(logger),
OffchainHTTPSet: offchain.NewHTTPSet(),
}
wasmInstance.SetContextData(runtimeCtx)

logger.Debugf("NewInstance called with runtimeCtx: %v", runtimeCtx)
instance.SetContextData(runtimeCtx)

inst := &Instance{
vm: instance,
return &Instance{
vm: wasmInstance,
ctx: runtimeCtx,
codeHash: cfg.CodeHash,
}

return inst, nil
}, nil
}

// decompressWasm decompresses a Wasm blob that may or may not be compressed with zstd
Expand Down Expand Up @@ -181,87 +137,126 @@ func (in *Instance) GetContext() *runtime.Context {
}

// UpdateRuntimeCode updates the runtime instance to run the given code
func (in *Instance) UpdateRuntimeCode(code []byte) error {
in.Stop()

err := in.setupInstanceVM(code)
func (in *Instance) UpdateRuntimeCode(code []byte) (err error) {
wasmInstance, allocator, err := setupVM(code)
if err != nil {
return err
return fmt.Errorf("setting up VM: %w", err)
}

in.mutex.Lock()
defer in.mutex.Unlock()

in.close()

in.ctx.Allocator = allocator
wasmInstance.SetContextData(in.ctx)

in.vm = wasmInstance

return nil
}

// CheckRuntimeVersion calculates runtime Version for runtime blob passed in
func (in *Instance) CheckRuntimeVersion(code []byte) (runtime.Version, error) {
tmp := &Instance{
ctx: in.ctx,
in.mutex.Lock()
defer in.mutex.Unlock()

wasmInstance, allocator, err := setupVM(code)
if err != nil {
return nil, fmt.Errorf("setting up VM: %w", err)
}

in.Lock()
defer in.Unlock()
in.ctx.Allocator = allocator // TODO we should no change the allocator of the parent instance
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line does the same thing as it did before.
It also looks like some very dangerous risky replacement, but it's changed in the next PR #2687 where CheckRuntimeVersion no longer depends on an existing instance.

wasmInstance.SetContextData(in.ctx)

err := tmp.setupInstanceVM(code)
if err != nil {
return nil, err
instance := Instance{
vm: wasmInstance,
ctx: in.ctx,
}

return tmp.Version()
return instance.Version()
}

func (in *Instance) setupInstanceVM(code []byte) error {
var (
ErrCodeEmpty = errors.New("code is empty")
)

func setupVM(code []byte) (instance wasm.Instance,
allocator *runtime.FreeingBumpHeapAllocator, err error) {
if len(code) == 0 {
return instance, nil, ErrCodeEmpty
}

code, err = decompressWasm(code)
if err != nil {
return instance, nil, fmt.Errorf("decompressing WASM code: %w", err)
}

imports, err := importsNodeRuntime()
if err != nil {
return err
return instance, nil, fmt.Errorf("creating node runtime imports: %w", err)
}

// Provide importable memory for newer runtimes
// TODO: determine memory descriptor size that the runtime wants from the wasm.
// should be doable w/ wasmer 1.0.0. (#1268)
memory, err := wasm.NewMemory(23, 0)
if err != nil {
return err
return instance, nil, fmt.Errorf("creating web assembly memory: %w", err)
}

_, err = imports.AppendMemory("memory", memory)
if err != nil {
return err
return instance, nil, fmt.Errorf("appending memory to imports: %w", err)
}

// Instantiates the WebAssembly module.
in.vm, err = wasm.NewInstanceWithImports(code, imports)
instance, err = wasm.NewInstanceWithImports(code, imports)
if err != nil {
return err
return instance, nil, fmt.Errorf("creating web assembly instance: %w", err)
}

// Assume imported memory is used if runtime does not export any
if !in.vm.HasMemory() {
in.vm.Memory = memory
if !instance.HasMemory() {
instance.Memory = memory
}

// TODO: get __heap_base exported value from runtime.
// wasmer 0.3.x does not support this, but wasmer 1.0.0 does (#1268)
heapBase := runtime.DefaultHeapBase

in.ctx.Allocator = runtime.NewAllocator(in.vm.Memory, heapBase)
in.vm.SetContextData(in.ctx)
return nil
allocator = runtime.NewAllocator(instance.Memory, heapBase)

return instance, allocator, nil
}

// SetContextStorage sets the runtime's storage. It should be set before calls to the below functions.
func (in *Instance) SetContextStorage(s runtime.Storage) {
in.Lock()
defer in.Unlock()
in.mutex.Lock()
defer in.mutex.Unlock()
in.ctx.Storage = s
}

// Stop func
// Stop closes the WASM instance, its imports and clears
// the context allocator in a thread-safe way.
func (in *Instance) Stop() {
in.Lock()
defer in.Unlock()
if !in.isClosed {
in.vm.Close()
in.isClosed = true
in.mutex.Lock()
defer in.mutex.Unlock()
in.close()
}

// close closes the wasm instance (and its imports)
// and clears the context allocator. If the instance
// has previously been closed, it simply returns.
// It is NOT THREAD SAFE to use.
func (in *Instance) close() {
if in.isClosed {
return
}

in.vm.Close()
in.ctx.Allocator.Clear()
in.isClosed = true
}

var (
Expand All @@ -271,8 +266,8 @@ var (

// Exec calls the given function with the given data
func (in *Instance) Exec(function string, data []byte) (result []byte, err error) {
in.Lock()
defer in.Unlock()
in.mutex.Lock()
defer in.mutex.Unlock()

if in.isClosed {
return nil, ErrInstanceIsStopped
Expand Down