Merge pull request #1422 from hyperledger/wasm-call

Implement cross-engine call dispatch for eWASM

Author: Silas Davis

Makefile

@@ -193,7 +193,7 @@ solidity: $(patsubst %.sol, %.sol.go, $(wildcard ./execution/solidity/*.sol)) bu
 
 # Solang fixtures
 .PHONY: solang
-solang: $(patsubst %.solang, %.solang.go, $(wildcard ./execution/wasm/*.solang)) build_burrow
+solang: $(patsubst %.solang, %.solang.go, $(wildcard ./execution/solidity/*.solang) $(wildcard ./execution/wasm/*.solang)) build_burrow
 
 %.solang.go: %.solang
 	@burrow compile --wasm $^
@@ -210,7 +210,7 @@ test_js:
 	@cd ${BURROW_TS_PATH} && yarn test
 
 .PHONY: test
-test: check bin/solc
+test: check bin/solc bin/solang
 	@tests/scripts/bin_wrapper.sh go test ./... ${GO_TEST_ARGS}
 
 .PHONY: test_keys
@@ -255,6 +255,11 @@ bin/solc: ./tests/scripts/deps/solc.sh
 	@tests/scripts/deps/solc.sh bin/solc
 	@touch bin/solc
 
+bin/solang: ./tests/scripts/deps/solang.sh
+	@mkdir -p bin
+	@tests/scripts/deps/solang.sh bin/solang
+	@touch bin/solang
+
 # test burrow with checks for race conditions
 .PHONY: test_race
 test_race: build_race

binary/integer.go

@@ -67,6 +67,24 @@ func SignExtend(x *big.Int, n uint) *big.Int {
 	}
 }
 
+// Reverse bytes in-place
+func reverse(bs []byte) []byte {
+	n := len(bs) - 1
+	for i := 0; i < len(bs)/2; i++ {
+		bs[i], bs[n-i] = bs[n-i], bs[i]
+	}
+	return bs
+}
+
+// Note: this function destructively reverses its input slice - pass a copy if the original is used elsewhere
+func BigIntFromLittleEndianBytes(bs []byte) *big.Int {
+	return new(big.Int).SetBytes(reverse(bs))
+}
+
+func BigIntToLittleEndianBytes(x *big.Int) []byte {
+	return reverse(x.Bytes())
+}
+
 func andMask(n uint) *big.Int {
 	x := new(big.Int)
 	return x.Sub(x.Lsh(big1, n), big1)

binary/integer_test.go

@@ -133,6 +133,13 @@ func TestSignExtend(t *testing.T) {
 		"0000 0000 0000 0000 0000 0000 0000 0000 0001 0000 1000 0000 1101 0011 1001 0000")
 }
 
+func TestLittleEndian(t *testing.T) {
+	x, ok := new(big.Int).SetString("234890234579042368982348972347234789897", 10)
+	require.True(t, ok)
+	y := BigIntFromLittleEndianBytes(BigIntToLittleEndianBytes(x))
+	require.Equal(t, x.Cmp(y), 0)
+}
+
 func assertSignExtend(t *testing.T, extendedBits int, embeddedBits uint, inputString, expectedString string) bool {
 	input := intFromString(t, extendedBits, inputString)
 	expected := intFromString(t, extendedBits, expectedString)

cmd/burrow/commands/compile.go

@@ -40,7 +40,7 @@ func Compile(output Output) func(cmd *cli.Cmd) {
 				}
 
 				if resp.Warning != "" {
-					output.Fatalf(resp.Warning)
+					output.Printf(resp.Warning)
 				}
 
 				f, err := os.Create(solfile + ".go")

deploy/def/jobs.go

@@ -317,6 +317,8 @@ type Build struct {
 	Instance string `mapstructure:"instance" json:"instance" yaml:"instance" toml:"instance"`
 	// (Optional) Path to store an extra copy of the bin file
 	Store string `mapstructure:"store" json:"store" yaml:"store" toml:"store"`
+	// (Optional) Use solang to compile to wasm
+	Wasm bool `mapstructure:"wasm" json:"wasm" yaml:"wasm" toml:"wasm"`
 }
 
 func (job *Build) Validate() error {
@@ -361,6 +363,8 @@ type Deploy struct {
 	Variables []*abi.Variable
 	// (Optional) Path to store an extra copy of the bin file
 	Store string `mapstructure:"store" json:"store" yaml:"store" toml:"store"`
+	// (Optional) Use solang to compile to wasm
+	Wasm bool `mapstructure:"wasm" json:"wasm" yaml:"wasm" toml:"wasm"`
 }
 
 func (job *Deploy) Validate() error {

deploy/jobs/job_manager.go

@@ -22,6 +22,7 @@ const (
 type solidityCompilerWork struct {
 	contractName string
 	workDir      string
+	wasm         bool
 }
 
 type compilerJob struct {
@@ -31,33 +32,28 @@ type compilerJob struct {
 	done         chan struct{}
 }
 
-func solcRunner(jobs chan *compilerJob, logger *logging.Logger) {
+func solidityRunner(jobs chan *compilerJob, logger *logging.Logger) {
 	for {
 		job, ok := <-jobs
 		if !ok {
-			break
+			return
 		}
-		resp, err := compilers.EVM(job.work.contractName, false, job.work.workDir, nil, logger)
-		(*job).compilerResp = resp
-		(*job).err = err
-		close(job.done)
-	}
-}
+		if job.work.wasm {
+			resp, err := compilers.WASM(job.work.contractName, job.work.workDir, logger)
+			(*job).compilerResp = resp
+			(*job).err = err
+
+		} else {
+			resp, err := compilers.EVM(job.work.contractName, false, job.work.workDir, nil, logger)
+			(*job).compilerResp = resp
+			(*job).err = err
 
-func solangRunner(jobs chan *compilerJob, logger *logging.Logger) {
-	for {
-		job, ok := <-jobs
-		if !ok {
-			return
 		}
-		resp, err := compilers.WASM(job.work.contractName, job.work.workDir, logger)
-		(*job).compilerResp = resp
-		(*job).err = err
 		close(job.done)
 	}
 }
 
-func queueCompilerWork(job *def.Job, playbook *def.Playbook, jobs chan *compilerJob) error {
+func queueCompilerWork(job *def.Job, playbook *def.Playbook, jobs chan *compilerJob, forceWasm bool) error {
 	payload, err := job.Payload()
 	if err != nil {
 		return fmt.Errorf("could not get Job payload: %v", payload)
@@ -71,6 +67,7 @@ func queueCompilerWork(job *def.Job, playbook *def.Playbook, jobs chan *compiler
 			work: solidityCompilerWork{
 				contractName: job.Build.Contract,
 				workDir:      playbook.Path,
+				wasm:         job.Build.Wasm || forceWasm,
 			},
 		}
 		job.Intermediate = &intermediate
@@ -82,21 +79,22 @@ func queueCompilerWork(job *def.Job, playbook *def.Playbook, jobs chan *compiler
 				work: solidityCompilerWork{
 					contractName: job.Deploy.Contract,
 					workDir:      playbook.Path,
+					wasm:         job.Deploy.Wasm || forceWasm,
 				},
 			}
 			job.Intermediate = &intermediate
 			jobs <- &intermediate
 		}
 	case *def.Proposal:
 		for _, job := range job.Proposal.Jobs {
-			err = queueCompilerWork(job, playbook, jobs)
+			err = queueCompilerWork(job, playbook, jobs, forceWasm)
 			if err != nil {
 				return err
 			}
 		}
 	case *def.Meta:
 		for _, job := range job.Meta.Playbook.Jobs {
-			err = queueCompilerWork(job, playbook, jobs)
+			err = queueCompilerWork(job, playbook, jobs, forceWasm)
 			if err != nil {
 				return err
 			}
@@ -318,15 +316,11 @@ func ExecutePlaybook(args *def.DeployArgs, playbook *def.Playbook, client *def.C
 	defer close(jobs)
 
 	for i := 0; i < concurrentSolc; i++ {
-		if args.Wasm {
-			go solangRunner(jobs, logger)
-		} else {
-			go solcRunner(jobs, logger)
-		}
+		go solidityRunner(jobs, logger)
 	}
 
 	for _, job := range playbook.Jobs {
-		queueCompilerWork(job, playbook, jobs)
+		queueCompilerWork(job, playbook, jobs, args.Wasm)
 	}
 
 	err = doJobs(playbook, args, client, logger)

execution/config.go

@@ -3,6 +3,8 @@ package execution
 import (
 	"fmt"
 
+	"github.com/hyperledger/burrow/execution/engine"
+
 	"github.com/hyperledger/burrow/execution/evm"
 )
 
@@ -36,16 +38,16 @@ func DefaultExecutionConfig() *ExecutionConfig {
 
 type Option func(*executor)
 
-func VMOptions(vmOptions evm.Options) func(*executor) {
+func VMOptions(vmOptions engine.Options) func(*executor) {
 	return func(exe *executor) {
 		exe.vmOptions = vmOptions
 	}
 }
 
 func (ec *ExecutionConfig) ExecutionOptions() ([]Option, error) {
 	var exeOptions []Option
-	vmOptions := evm.Options{
-		MemoryProvider:           evm.DefaultDynamicMemoryProvider,
+	vmOptions := engine.Options{
+		MemoryProvider:           engine.DefaultDynamicMemoryProvider,
 		CallStackMaxDepth:        ec.CallStackMaxDepth,
 		DataStackInitialCapacity: ec.DataStackInitialCapacity,
 		DataStackMaxDepth:        ec.DataStackMaxDepth,

execution/contexts/call_context.go

@@ -2,16 +2,16 @@ package contexts
 
 import (
 	"fmt"
+	"math/big"
+
+	"github.com/hyperledger/burrow/execution/vms"
 
 	"github.com/hyperledger/burrow/acm"
 	"github.com/hyperledger/burrow/acm/acmstate"
 	"github.com/hyperledger/burrow/crypto"
 	"github.com/hyperledger/burrow/execution/engine"
 	"github.com/hyperledger/burrow/execution/errors"
-	"github.com/hyperledger/burrow/execution/evm"
 	"github.com/hyperledger/burrow/execution/exec"
-	"github.com/hyperledger/burrow/execution/native"
-	"github.com/hyperledger/burrow/execution/wasm"
 	"github.com/hyperledger/burrow/logging"
 	"github.com/hyperledger/burrow/logging/structure"
 	"github.com/hyperledger/burrow/txs/payload"
@@ -21,7 +21,7 @@ import (
 const GasLimit = uint64(1000000)
 
 type CallContext struct {
-	EVM           *evm.EVM
+	VMS           *vms.VirtualMachines
 	State         acmstate.ReaderWriter
 	MetadataState acmstate.MetadataReaderWriter
 	Blockchain    engine.Blockchain
@@ -135,7 +135,7 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 		callee = crypto.NewContractAddress(caller, ctx.txe.TxHash)
 		code = ctx.tx.Data
 		wcode = ctx.tx.WASM
-		err := native.CreateAccount(txCache, callee)
+		err := engine.CreateAccount(txCache, callee)
 		if err != nil {
 			return err
 		}
@@ -144,7 +144,7 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 			"init_code", code)
 
 		// store abis
-		err = native.UpdateContractMeta(txCache, metaCache, callee, ctx.tx.ContractMeta)
+		err = engine.UpdateContractMeta(txCache, metaCache, callee, ctx.tx.ContractMeta)
 		if err != nil {
 			return err
 		}
@@ -184,19 +184,20 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 	var ret []byte
 	var err error
 	txHash := ctx.txe.Envelope.Tx.Hash()
-	gas := ctx.tx.GasLimit
+	gas := new(big.Int).SetUint64(ctx.tx.GasLimit)
 
 	params := engine.CallParams{
 		Origin: caller,
 		Caller: caller,
 		Callee: callee,
 		Input:  ctx.tx.Data,
-		Value:  value,
-		Gas:    &gas,
+		Value:  *new(big.Int).SetUint64(value),
+		Gas:    gas,
 	}
 
 	if len(wcode) != 0 {
-		ret, err = wasm.RunWASM(txCache, params, wcode)
+		// TODO: accept options
+		ret, err = ctx.VMS.WVM.Execute(txCache, ctx.Blockchain, ctx.txe, params, wcode)
 		if err != nil {
 			// Failure. Charge the gas fee. The 'value' was otherwise not transferred.
 			ctx.Logger.InfoMsg("Error on WASM execution",
@@ -206,7 +207,7 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 		} else {
 			ctx.Logger.TraceMsg("Successful execution")
 			if createContract {
-				err := native.InitWASMCode(txCache, callee, ret)
+				err := engine.InitWASMCode(txCache, callee, ret)
 				if err != nil {
 					return err
 				}
@@ -218,10 +219,10 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 		}
 	} else {
 		// EVM
-		ctx.EVM.SetNonce(txHash)
-		ctx.EVM.SetLogger(ctx.Logger.With(structure.TxHashKey, txHash))
+		ctx.VMS.EVM.SetNonce(txHash)
+		ctx.VMS.EVM.SetLogger(ctx.Logger.With(structure.TxHashKey, txHash))
 
-		ret, err = ctx.EVM.Execute(txCache, ctx.Blockchain, ctx.txe, params, code)
+		ret, err = ctx.VMS.EVM.Execute(txCache, ctx.Blockchain, ctx.txe, params, code)
 
 		if err != nil {
 			// Failure. Charge the gas fee. The 'value' was otherwise not transferred.
@@ -233,7 +234,7 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 		} else {
 			ctx.Logger.TraceMsg("Successful execution")
 			if createContract {
-				err := native.InitEVMCode(txCache, callee, ret)
+				err := engine.InitEVMCode(txCache, callee, ret)
 				if err != nil {
 					return err
 				}
@@ -245,7 +246,8 @@ func (ctx *CallContext) Deliver(inAcc, outAcc *acm.Account, value uint64) error
 		}
 		ctx.CallEvents(err)
 	}
-	ctx.txe.Return(ret, ctx.tx.GasLimit-gas)
+	// Gas starts life as a uint64 and should only been reduced (used up) over a transaction so .Uint64() is safe
+	ctx.txe.Return(ret, ctx.tx.GasLimit-gas.Uint64())
 	// Create a receipt from the ret and whether it erred.
 	ctx.Logger.TraceMsg("VM Call complete",
 		"caller", caller,

execution/defaults/options.go

@@ -0,0 +1,21 @@
+package defaults
+
+import (
+	"github.com/hyperledger/burrow/execution/engine"
+	"github.com/hyperledger/burrow/execution/native"
+	"github.com/hyperledger/burrow/logging"
+)
+
+func CompleteOptions(options engine.Options) engine.Options {
+	// Set defaults
+	if options.MemoryProvider == nil {
+		options.MemoryProvider = engine.DefaultDynamicMemoryProvider
+	}
+	if options.Logger == nil {
+		options.Logger = logging.NewNoopLogger()
+	}
+	if options.Natives == nil {
+		options.Natives = native.MustDefaultNatives()
+	}
+	return options
+}