From 781915f183c6e09474c6192d1aaba8e99c4990de Mon Sep 17 00:00:00 2001
From: Nick Johnson <arachnid@notdot.net>
Date: Fri, 19 Aug 2016 15:19:51 +0100
Subject: core/vm: Refactor tracing to make Tracer the main interface

This CL makes several refactors:
 - Define a Tracer interface, implementing the `CaptureState` method
 - Add the VM environment as the first argument of
   `Tracer.CaptureState`
 - Rename existing functionality `StructLogger` an make it an
   implementation of `Tracer`
 - Delete `StructLogCollector` and make `StructLogger` collect the logs
   directly
 - Change all callers to use the new `StructLogger` where necessary and
   extract logs from that.
 - Deletes the apparently obsolete and likely nonfunctional 'TraceCall'
   from the eth API.

Callers that only wish accumulated logs can use the `StructLogger`
implementation straightforwardly. Callers that wish to efficiently
capture VM traces and operate on them without excessive copying can now
implement the `Tracer` interface to receive VM state at each step and
do with it as they wish.

This CL also removes the accumulation of logs from the vm.Environment;
this was necessary as part of the refactor, but also simplifies it by
removing a responsibility that doesn't directly belong to the
Environment.
---
 cmd/evm/main.go | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)

(limited to 'cmd')

diff --git a/cmd/evm/main.go b/cmd/evm/main.go
index aa48f6ede..09cc9ee1f 100644
--- a/cmd/evm/main.go
+++ b/cmd/evm/main.go
@@ -117,10 +117,13 @@ func run(ctx *cli.Context) error {
 	statedb, _ := state.New(common.Hash{}, db)
 	sender := statedb.CreateAccount(common.StringToAddress("sender"))
 
+	logger := vm.NewStructLogger(nil)
+
 	vmenv := NewEnv(statedb, common.StringToAddress("evmuser"), common.Big(ctx.GlobalString(ValueFlag.Name)), vm.Config{
 		Debug:     ctx.GlobalBool(DebugFlag.Name),
 		ForceJit:  ctx.GlobalBool(ForceJitFlag.Name),
 		EnableJit: !ctx.GlobalBool(DisableJitFlag.Name),
+		Tracer:    logger,
 	})
 
 	tstart := time.Now()
@@ -157,7 +160,7 @@ func run(ctx *cli.Context) error {
 		statedb.Commit()
 		fmt.Println(string(statedb.Dump()))
 	}
-	vm.StdErrFormat(vmenv.StructLogs())
+	vm.StdErrFormat(logger.StructLogs())
 
 	if ctx.GlobalBool(SysStatFlag.Name) {
 		var mem runtime.MemStats
@@ -209,7 +212,6 @@ func NewEnv(state *state.StateDB, transactor common.Address, value *big.Int, cfg
 		value:      value,
 		time:       big.NewInt(time.Now().Unix()),
 	}
-	cfg.Logger.Collector = env
 
 	env.evm = vm.New(env, cfg)
 	return env
@@ -242,12 +244,6 @@ func (self *VMEnv) GetHash(n uint64) common.Hash {
 	}
 	return common.Hash{}
 }
-func (self *VMEnv) AddStructLog(log vm.StructLog) {
-	self.logs = append(self.logs, log)
-}
-func (self *VMEnv) StructLogs() []vm.StructLog {
-	return self.logs
-}
 func (self *VMEnv) AddLog(log *vm.Log) {
 	self.state.AddLog(log)
 }
-- 
cgit