docs: VM Implementation Guide

This commit is contained in:
Paweł Bylica 2018-10-18 14:49:10 +02:00
parent d54035828a
commit a7f93cf307
No known key found for this signature in database
GPG Key ID: 7A0C037434FE77EF
2 changed files with 56 additions and 9 deletions

View File

@ -9,6 +9,7 @@ to access Ethereum environment and state.
# Guides
- [Host Implementation Guide](@ref hostguide)
- [VM Implementation Guide](@ref vmguide)
# Versioning {#versioning}

46
docs/VM_Guide.md Normal file
View File

@ -0,0 +1,46 @@
# EVMC VM Implementation Guide {#vmguide}
> How to add EVMC interface to Your Ethereum VM implementation.
## An example
You can start with [the example implementation of EVMC VM interface in C](@ref example_vm.c).
## VM instance
The VM instance is described by the ::evmc_instance struct. It contains the
basic static information about the VM like name and version. The struct also
includes the VM methods (in form of function pointers) to allow the Host
to interact with the VM.
Some methods are optional. The VM must implement at least all mandatory ones.
The instance struct must also include the EVMC ABI version (::EVMC_ABI_VERSION)
it was build with. This allows the Host to check the ABI compatibility when
loading VMs dynamically.
The VM instance is created and returned as a pointer from a special "create"
function. The EVMC recommends to name the function by the VM codename,
e.g. ::evmc_create_example_vm().
## VM methods implementation
Each VM methods takes the pointer to the ::evmc_instance as the first argument.
The VM implementation can extend the ::evmc_instance struct for storing internal
data. This allow implementing the VM in object-oriented manner.
The most important method is ::evmc_instance::execute() because it executes EVM code.
Remember that the Host is allowed to invoke the execute method concurrently
so do not store data related to a particular execution context in the VM instance.
## Resource management
All additional resources allocated when the VM instance is created must be
freed when the destroy method is invoked.
The VM implementation can also attach additional resources to the ::evmc_result
of an execution. These resource must be freed when the ::evmc_result::release()
method is invoked.
*Have fun!*