Merge pull request #1095 from ethereum/fix/ethash-listener

Added more events to EthashListener

Author: mkalinin

ethereumj-core/src/main/java/org/ethereum/mine/Ethash.java

@@ -38,9 +38,16 @@
 import java.util.concurrent.atomic.AtomicLong;
 
 import static org.ethereum.crypto.HashUtil.sha3;
-import static org.ethereum.mine.EthashListener.DatasetStatus.DATASET_GENERATED;
+import static org.ethereum.mine.EthashListener.DatasetStatus.DATASET_READY;
+import static org.ethereum.mine.EthashListener.DatasetStatus.DATASET_PREPARE;
+import static org.ethereum.mine.EthashListener.DatasetStatus.FULL_DATASET_GENERATED;
 import static org.ethereum.mine.EthashListener.DatasetStatus.FULL_DATASET_GENERATE_START;
+import static org.ethereum.mine.EthashListener.DatasetStatus.FULL_DATASET_LOADED;
+import static org.ethereum.mine.EthashListener.DatasetStatus.FULL_DATASET_LOAD_START;
+import static org.ethereum.mine.EthashListener.DatasetStatus.LIGHT_DATASET_GENERATED;
 import static org.ethereum.mine.EthashListener.DatasetStatus.LIGHT_DATASET_GENERATE_START;
+import static org.ethereum.mine.EthashListener.DatasetStatus.LIGHT_DATASET_LOADED;
+import static org.ethereum.mine.EthashListener.DatasetStatus.LIGHT_DATASET_LOAD_START;
 import static org.ethereum.util.ByteUtil.longToBytes;
 import static org.ethereum.mine.MinerIfc.MiningResult;
 
@@ -106,26 +113,28 @@ public Ethash(SystemProperties config, long blockNumber) {
     }
 
     public int[] getCacheLight() {
-        return getCacheLight(true);
+        fireDatatasetStatusUpdate(DATASET_PREPARE);
+        int[] res = getCacheLightImpl();
+        fireDatatasetStatusUpdate(DATASET_READY);
+        return res;
     }
 
     /**
      * Checks whether light DAG is already generated and loads it
      * from cache, otherwise generates it
-     *
-     * @param fireFinished whether to fire {@link EthashListener.DatasetStatus#DATASET_GENERATED}
-     *                     after light DAG generation is finished
      * @return  Light DAG
      */
-    private synchronized int[] getCacheLight(boolean fireFinished) {
+    private synchronized int[] getCacheLightImpl() {
         if (cacheLight == null) {
             File file = new File(config.ethashDir(), "mine-dag-light.dat");
             if (fileCacheEnabled && file.canRead()) {
+                fireDatatasetStatusUpdate(LIGHT_DATASET_LOAD_START);
                 try (ObjectInputStream ois = new ObjectInputStream(new FileInputStream(file))) {
                     logger.info("Loading light dataset from " + file.getAbsolutePath());
                     long bNum = ois.readLong();
                     if (bNum == blockNumber) {
                         cacheLight = (int[]) ois.readObject();
+                        fireDatatasetStatusUpdate(LIGHT_DATASET_LOADED);
                         logger.info("Dataset loaded.");
                     } else {
                         logger.info("Dataset block number miss: " + bNum + " != " + blockNumber);
@@ -152,24 +161,25 @@ private synchronized int[] getCacheLight(boolean fireFinished) {
                         throw new RuntimeException(e);
                     }
                 }
-                if (fireFinished) {
-                    fireDatatasetStatusUpdate(DATASET_GENERATED);
-                }
+                fireDatatasetStatusUpdate(LIGHT_DATASET_GENERATED);
             }
         }
         return cacheLight;
     }
 
     public synchronized int[] getFullDataset() {
+        fireDatatasetStatusUpdate(DATASET_PREPARE);
         if (fullData == null) {
             File file = new File(config.ethashDir(), "mine-dag.dat");
             if (fileCacheEnabled && file.canRead()) {
+                fireDatatasetStatusUpdate(FULL_DATASET_LOAD_START);
                 try (ObjectInputStream ois = new ObjectInputStream(new FileInputStream(file))) {
                     logger.info("Loading dataset from " + file.getAbsolutePath());
                     long bNum = ois.readLong();
                     if (bNum == blockNumber) {
                         fullData = (int[]) ois.readObject();
                         logger.info("Dataset loaded.");
+                        fireDatatasetStatusUpdate(FULL_DATASET_LOADED);
                     } else {
                         logger.info("Dataset block number miss: " + bNum + " != " + blockNumber);
                     }
@@ -181,8 +191,8 @@ public synchronized int[] getFullDataset() {
             if (fullData == null){
 
                 logger.info("Calculating full dataset...");
-                int[] cacheLight = getCacheLight(false);
                 fireDatatasetStatusUpdate(FULL_DATASET_GENERATE_START);
+                int[] cacheLight = getCacheLightImpl();
                 fullData = getEthashAlgo().calcDataset(getFullSize(), cacheLight);
                 logger.info("Full dataset calculated.");
 
@@ -196,9 +206,10 @@ public synchronized int[] getFullDataset() {
                         throw new RuntimeException(e);
                     }
                 }
-                fireDatatasetStatusUpdate(DATASET_GENERATED);
+                fireDatatasetStatusUpdate(FULL_DATASET_GENERATED);
             }
         }
+        fireDatatasetStatusUpdate(DATASET_READY);
         return fullData;
     }
 

ethereumj-core/src/main/java/org/ethereum/mine/EthashListener.java

@@ -23,20 +23,57 @@
 public interface EthashListener extends MinerListener {
 
     enum DatasetStatus {
+        /**
+         * Dataset requested and will be prepared
+         */
+        DATASET_PREPARE,
         /**
          * Indicates start of light DAG generation
+         * If full dataset is requested, its event
+         * {@link #FULL_DATASET_GENERATE_START} fires before this one
          */
         LIGHT_DATASET_GENERATE_START,
+        /**
+         * Indicates that light dataset is already generated
+         * and will be loaded from disk though it could be outdated
+         * and therefore {@link #LIGHT_DATASET_LOADED} will not be fired
+         */
+        LIGHT_DATASET_LOAD_START,
+        /**
+         * Indicates end of loading light dataset from disk
+         */
+        LIGHT_DATASET_LOADED,
+        /**
+         * Indicates finish of light dataset generation
+         */
+        LIGHT_DATASET_GENERATED,
         /**
          * Indicates start of full DAG generation
          * Full DAG generation is a heavy procedure
-         * which could take a lot of time
+         * which could take a lot of time.
+         * Also full dataset requires light dataset
+         * so it will be either generated or loaded from
+         * disk as part of this job
          */
         FULL_DATASET_GENERATE_START,
         /**
-         * Indicates end of DAG generation stage
+         * Indicates that full dataset is already generated
+         * and will be loaded from disk though it could be outdated
+         * and therefore {@link #FULL_DATASET_LOADED} will not be fired
+         */
+        FULL_DATASET_LOAD_START,
+        /**
+         * Indicates end of full dataset loading from disk
+         */
+        FULL_DATASET_LOADED,
+        /**
+         * Indicates finish of full dataset generation
+         */
+        FULL_DATASET_GENERATED,
+        /**
+         * Requested dataset is complete and ready for use
          */
-        DATASET_GENERATED,
+        DATASET_READY,
     }
 
     void onDatasetUpdate(DatasetStatus datasetStatus);

ethereumj-core/src/main/java/org/ethereum/samples/PrivateMinerSample.java

@@ -106,8 +106,8 @@ public void onDatasetUpdate(EthashListener.DatasetStatus minerStatus) {
             if (minerStatus.equals(EthashListener.DatasetStatus.FULL_DATASET_GENERATE_START)) {
                 logger.info("Generating Full Dataset (may take up to 10 min if not cached)...");
             }
-            if (minerStatus.equals(EthashListener.DatasetStatus.DATASET_GENERATED)) {
-                logger.info("Full dataset generated (loaded).");
+            if (minerStatus.equals(DatasetStatus.FULL_DATASET_GENERATED)) {
+                logger.info("Full dataset generated.");
             }
         }