Merge pull request #1182 from ethereum/feature/vmhook-extracting

VM hook redesign (optimized)

Author: mkalinin

ethereumj-core/build.gradle

@@ -114,7 +114,7 @@ ext {
     slf4jVersion = '1.7.7'
     leveldbVersion = '0.7'
     scastleVersion = '1.58.0.0'
-    springVersion = '4.2.0.RELEASE'
+    springVersion = '4.3.19.RELEASE'
     hibernateVersion = '4.3.7.Final'
     junitVersion = '4.11'
 }

ethereumj-core/src/main/java/org/ethereum/core/BlockchainImpl.java

@@ -229,6 +229,11 @@ public BlockchainImpl withParentBlockHeaderValidator(ParentBlockHeaderValidator
         return this;
     }
 
+    public BlockchainImpl withVmHook(VMHook vmHook) {
+        this.vmHook = vmHook;
+        return this;
+    }
+
     private void initConst(SystemProperties config) {
         minerCoinbase = config.getMinerCoinbase();
         minerExtraData = config.getMineExtraData();

ethereumj-core/src/main/java/org/ethereum/util/blockchain/StandaloneBlockchain.java

@@ -42,6 +42,7 @@
 import org.ethereum.validator.DependentBlockHeaderRuleAdapter;
 import org.ethereum.vm.DataWord;
 import org.ethereum.vm.LogInfo;
+import org.ethereum.vm.hook.VMHook;
 import org.ethereum.vm.program.invoke.ProgramInvokeFactoryImpl;
 import org.iq80.leveldb.DBException;
 import org.spongycastle.util.encoders.Hex;
@@ -82,6 +83,7 @@ public class StandaloneBlockchain implements LocalBlockchain {
     PruneManager pruneManager;
 
     private BlockSummary lastSummary;
+    private VMHook vmHook = VMHook.EMPTY;
 
     class PendingTx {
         ECKey sender;
@@ -193,6 +195,11 @@ public StandaloneBlockchain withDbDelay(long dbDelay) {
         return this;
     }
 
+    public StandaloneBlockchain withVmHook(VMHook vmHook) {
+        this.vmHook = vmHook;
+        return this;
+    }
+
     private Map<PendingTx, Transaction> createTransactions(Block parent) {
         Map<PendingTx, Transaction> txes = new LinkedHashMap<>();
         Map<ByteArrayWrapper, Long> nonces = new HashMap<>();
@@ -484,7 +491,8 @@ private BlockchainImpl createBlockchain(Genesis genesis) {
 
         BlockchainImpl blockchain = new BlockchainImpl(blockStore, repository)
                 .withEthereumListener(listener)
-                .withSyncManager(new SyncManager());
+                .withSyncManager(new SyncManager())
+                .withVmHook(vmHook);
         blockchain.setParentHeaderValidator(new DependentBlockHeaderRuleAdapter());
         blockchain.setProgramInvokeFactory(programInvokeFactory);
         blockchain.setPruneManager(pruneManager);

ethereumj-core/src/main/java/org/ethereum/vm/VM.java

@@ -20,7 +20,6 @@
 import org.ethereum.config.BlockchainConfig;
 import org.ethereum.config.SystemProperties;
 import org.ethereum.db.ContractDetails;
-import org.ethereum.vm.hook.BackwardCompatibilityVmHook;
 import org.ethereum.vm.hook.VMHook;
 import org.ethereum.vm.program.Program;
 import org.ethereum.vm.program.Stack;
@@ -34,7 +33,9 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.function.Consumer;
 import java.util.function.Function;
+import java.util.stream.Stream;
 
 import static org.ethereum.crypto.HashUtil.sha3;
 import static org.ethereum.util.ByteUtil.EMPTY_BYTE_ARRAY;
@@ -89,7 +90,6 @@ public class VM {
     // used to reduce expensive BigInt arithmetic
     private static BigInteger MAX_MEM_SIZE = BigInteger.valueOf(Integer.MAX_VALUE);
 
-
     /* Keeps track of the number of steps performed in this VM */
     private int vmCounter = 0;
 
@@ -111,8 +111,11 @@ public class VM {
     }};
 
     private final SystemProperties config;
-    private final VMHook hook;
 
+    // deprecated field that holds VM hook. Will be removed in the future releases.
+    private static VMHook deprecatedHook = VMHook.EMPTY;
+    private final boolean hasHooks;
+    private final VMHook[] hooks;
 
     public VM() {
         this(SystemProperties.getDefault(), VMHook.EMPTY);
@@ -123,7 +126,16 @@ public VM(SystemProperties config, VMHook hook) {
         this.config = config;
         this.vmTrace = config.vmTrace();
         this.dumpBlock = config.dumpBlock();
-        this.hook = new BackwardCompatibilityVmHook(hook);
+        this.hooks = Stream.of(deprecatedHook, hook)
+                .filter(h -> !h.isEmpty())
+                .toArray(VMHook[]::new);
+        this.hasHooks = this.hooks.length > 0;
+    }
+
+    private void onHookEvent(Consumer<VMHook> consumer) {
+        for (VMHook hook : this.hooks) {
+            consumer.accept(hook);
+        }
     }
 
     private long calcMemGas(GasCost gasCosts, long oldMemSize, BigInteger newMemSize, long copySize) {
@@ -422,7 +434,9 @@ else if (!currentValue.isZero() && newValue.isZero()) {
                 this.dumpLine(op, gasBefore, gasCost + callGas, memWords, program);
             }
 
-            hook.step(program, op);
+            if (hasHooks) {
+                onHookEvent(hook -> hook.step(program, op));
+            }
 
             // Execute operation
             switch (op) {
@@ -1413,7 +1427,9 @@ public void play(Program program) {
         if (program.byTestingSuite()) return;
 
         try {
-            hook.startPlay(program);
+            if (hasHooks) {
+                onHookEvent(hook -> hook.startPlay(program));
+            }
 
             while (!program.isStopped()) {
                 this.step(program);
@@ -1425,7 +1441,9 @@ public void play(Program program) {
             logger.error("\n !!! StackOverflowError: update your java run command with -Xss2M (-Xss8M for tests) !!!\n", soe);
             System.exit(-1);
         } finally {
-            hook.stopPlay(program);
+            if (hasHooks) {
+                onHookEvent(hook -> hook.stopPlay(program));
+            }
         }
     }
 
@@ -1436,7 +1454,7 @@ public void play(Program program) {
     @Deprecated
     public static void setVmHook(VMHook vmHook) {
         logger.warn("VM.setVmHook(VMHook vmHook) is deprecated method. Define your hook component as a Spring bean.");
-        BackwardCompatibilityVmHook.setDeprecatedHook(vmHook);
+        VM.deprecatedHook = vmHook;
     }
 
     /**

ethereumj-core/src/main/java/org/ethereum/vm/hook/BackwardCompatibilityVmHook.java

@@ -25,8 +25,6 @@
 import org.springframework.context.annotation.Primary;
 import org.springframework.stereotype.Component;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Optional;
 import java.util.function.Consumer;
 
@@ -39,35 +37,40 @@ public class RootVmHook implements VMHook {
 
     private static final Logger logger = LoggerFactory.getLogger("VM");
 
-    private final List<VMHook> hooks;
+    private VMHook[] hooks;
 
     @Autowired
-    public RootVmHook(Optional<List<VMHook>> hooks) {
-        this.hooks = hooks.orElseGet(ArrayList::new);
+    public RootVmHook(Optional<VMHook[]> hooks) {
+        this.hooks = hooks.orElseGet(() -> new VMHook[] {});
     }
 
-    private void safeProxyToAll(Consumer<VMHook> action) {
-        this.hooks.forEach(hook -> {
+    private void proxySafeToAll(Consumer<VMHook> action) {
+        for (VMHook hook : hooks) {
             try {
                 action.accept(hook);
             } catch (Throwable t) {
                 logger.error("VM hook execution error: ", t);
             }
-        });
+        }
     }
 
     @Override
     public void startPlay(Program program) {
-        safeProxyToAll(hook -> hook.startPlay(program));
+        proxySafeToAll(hook -> hook.startPlay(program));
     }
 
     @Override
     public void step(Program program, OpCode opcode) {
-        safeProxyToAll(hook -> hook.step(program, opcode));
+        proxySafeToAll(hook -> hook.step(program, opcode));
     }
 
     @Override
     public void stopPlay(Program program) {
-        safeProxyToAll(hook -> hook.stopPlay(program));
+        proxySafeToAll(hook -> hook.stopPlay(program));
+    }
+
+    @Override
+    public boolean isEmpty() {
+        return hooks.length == 0;
     }
 }

ethereumj-core/src/main/java/org/ethereum/vm/hook/RootVmHook.java

@@ -34,6 +34,14 @@ default void step(Program program, OpCode opcode) {
     default void stopPlay(Program program) {
     }
 
+    default boolean isEmpty() {
+        return false;
+    }
+
     VMHook EMPTY = new VMHook() {
+        @Override
+        public boolean isEmpty() {
+            return true;
+        }
     };
 }