Merge pull request #513 from aionnetwork/db-archive-states

Archive states & prune refactor

modAionBase/src/org/aion/base/db/IKeyValueStore.java

@@ -1,4 +1,4 @@
-/*******************************************************************************
+/* ******************************************************************************
  * Copyright (c) 2017-2018 Aion foundation.
  *
  *     This file is part of the aion network project.
@@ -42,14 +42,11 @@
 /**
  * Functionality for a key-value cache allowing itemized updates.
  *
- * @param <K>
- *            the data type of the keys
- * @param <V>
- *            the data type of the values
+ * @param <K> the data type of the keys
+ * @param <V> the data type of the values
  * @author Alexandra Roatis
- * @implNote For the underlying DB connection, if [isClosed() == true], then all
- *           function calls which are documented to throw RuntimeException, will
- *           throw a RuntimeException.
+ * @implNote For the underlying DB connection, if [isClosed() == true], then all function calls
+ *     which are documented to throw RuntimeException, will throw a RuntimeException.
  */
 public interface IKeyValueStore<K, V> extends AutoCloseable {
 
@@ -60,115 +57,103 @@ public interface IKeyValueStore<K, V> extends AutoCloseable {
      * Returns if the DB is empty or not.
      *
      * @return True if number of keys > 0, false otherwise
-     * @throws RuntimeException
-     *             if the data store is closed
+     * @throws RuntimeException if the data store is closed
      */
     boolean isEmpty();
 
     /**
      * Returns the set of keys for the database.
      *
      * @return Set of keys
-     * @throws RuntimeException
-     *             if the data store is closed
-     * @apiNote Returns an empty set if the database keys could not be
-     *          retrieved.
+     * @throws RuntimeException if the data store is closed
+     * @apiNote Returns an empty set if the database keys could not be retrieved.
      */
     Set<K> keys();
 
     /**
-     * get retrieves a value from the database, returning an optional, it is
-     * fulfilled if a value was able to be retrieved from the DB, otherwise the
-     * optional is empty
+     * get retrieves a value from the database, returning an optional, it is fulfilled if a value
+     * was able to be retrieved from the DB, otherwise the optional is empty
      *
      * @param k
-     * @throws RuntimeException
-     *             if the data store is closed
-     * @throws IllegalArgumentException
-     *             if the key is null
+     * @throws RuntimeException if the data store is closed
+     * @throws IllegalArgumentException if the key is null
      */
     Optional<V> get(K k);
 
     // Updates for individual keys
     // -------------------------------------------------------------------------------------
 
     /**
-     * Places or updates a value into the cache at the corresponding key. Makes
-     * no guarantees about when the value is actually inserted into the
-     * underlying data store.
+     * Places or updates a value into the cache at the corresponding key. Makes no guarantees about
+     * when the value is actually inserted into the underlying data store.
      *
-     * @param k
-     *            the key for the new entry
-     * @param v
-     *            the value for the new entry
-     * @throws RuntimeException
-     *             if the underlying data store is closed
-     * @throws IllegalArgumentException
-     *             if the key is null
-     * @implNote The choice of when to push the changes to the data store is
-     *           left up to the implementation.
+     * @param k the key for the new entry
+     * @param v the value for the new entry
+     * @throws RuntimeException if the underlying data store is closed
+     * @throws IllegalArgumentException if the key is null
+     * @implNote The choice of when to push the changes to the data store is left up to the
+     *     implementation.
      * @apiNote Put must have the following properties:
-     *          <ol>
-     *          <li>Creates a new entry in the cache, if the key-value pair does
-     *          not exist in the cache or underlying data store.</li>
-     *          <li>Updates the entry in the cache when the key-value pair
-     *          already exists.
-     *          <li>Deletes the entry when given a {@code null} value.</li>
-     *          </ol>
+     *     <ol>
+     *       <li>Creates a new entry in the cache, if the key-value pair does not exist in the cache
+     *           or underlying data store.
+     *       <li>Updates the entry in the cache when the key-value pair already exists.
+     *       <li>Deletes the entry when given a {@code null} value.
+     *     </ol>
      */
     void put(K k, V v);
 
     /**
-     * Delete an entry from the cache, marking it for deletion inside the data
-     * store. Makes no guarantees about when the value is actually deleted from
-     * the underlying data store.
+     * Delete an entry from the cache, marking it for deletion inside the data store. Makes no
+     * guarantees about when the value is actually deleted from the underlying data store.
      *
-     * @param k
-     *            the key of the entry to be deleted
-     * @throws RuntimeException
-     *             if the underlying data store is closed
-     * @throws IllegalArgumentException
-     *             if the key is null
-     * @implNote The choice of when to push the changes to the data store is
-     *           left up to the implementation.
+     * @param k the key of the entry to be deleted
+     * @throws RuntimeException if the underlying data store is closed
+     * @throws IllegalArgumentException if the key is null
+     * @implNote The choice of when to push the changes to the data store is left up to the
+     *     implementation.
      */
     void delete(K k);
 
     // Batch Updates
     // ---------------------------------------------------------------------------------------------------
 
     /**
-     * Puts or updates the data store with the given <i>key-value</i> pairs, as
-     * follows:
+     * Puts or updates the data store with the given <i>key-value</i> pairs, as follows:
+     *
      * <ul>
-     * <li>if the <i>key</i> is present in the data store, the stored
-     * <i>value</i> is overwritten</li>
-     * <li>if the <i>key</i> is not present in the data store, the new
-     * <i>key-value</i> pair is stored</li>
-     * <li>if the <i>value</i> is null, the matching stored <i>key</i> will be
-     * deleted from the data store, or</li>
+     *   <li>if the <i>key</i> is present in the data store, the stored <i>value</i> is overwritten
+     *   <li>if the <i>key</i> is not present in the data store, the new <i>key-value</i> pair is
+     *       stored
+     *   <li>if the <i>value</i> is null, the matching stored <i>key</i> will be deleted from the
+     *       data store, or
      * </ul>
      *
-     * @param inputMap
-     *            a {@link Map} of key-value pairs to be updated in the database
-     * @throws RuntimeException
-     *             if the data store is closed
-     * @throws IllegalArgumentException
-     *             if the map contains a null key
+     * @param inputMap a {@link Map} of key-value pairs to be updated in the database
+     * @throws RuntimeException if the data store is closed
+     * @throws IllegalArgumentException if the map contains a null key
      */
     void putBatch(Map<K, V> inputMap);
 
-    void putToBatch(byte[] key, byte[] value);
+    void putToBatch(K key, V value);
+
     void commitBatch();
 
     /**
      * Similar to delete, except operates on a list of keys
      *
      * @param keys
-     * @throws RuntimeException
-     *             if the data store is closed
-     * @throws IllegalArgumentException
-     *             if the collection contains a null key
+     * @throws RuntimeException if the data store is closed
+     * @throws IllegalArgumentException if the collection contains a null key
      */
     void deleteBatch(Collection<K> keys);
+
+    /**
+     * Checks that the data store connection is open. Throws a {@link RuntimeException} if the data
+     * store connection is closed.
+     *
+     * @implNote Always do this check after acquiring a lock on the class/data. Otherwise it might
+     *     produce inconsistent results due to lack of synchronization.
+     */
+    void check();
 }

modAionBase/src/org/aion/base/db/IPruneConfig.java

@@ -0,0 +1,37 @@
+package org.aion.base.db;
+
+/**
+ * Interface for pruning configuration parameters.
+ *
+ * @author Alexandra Roatis
+ */
+public interface IPruneConfig {
+
+    /**
+     * Indicates if pruning should be enabled or disabled.
+     *
+     * @return {@code true} when pruning enabled, {@code false} when pruning disabled.
+     */
+    boolean isEnabled();
+
+    /**
+     * Indicates if archiving should be enabled or disabled.
+     *
+     * @return {@code true} when archiving enabled, {@code false} when archiving disabled.
+     */
+    boolean isArchived();
+
+    /**
+     * @return the number of topmost blocks for which the full data should be maintained on disk.
+     */
+    int getCurrentCount();
+
+    /**
+     * Gets the rate at which blocks should be archived (for which the full data should be
+     * maintained on disk). Blocks that are exact multiples of the returned value should be
+     * persisted on disk, regardless of other pruning.
+     *
+     * @return integer value representing the archive rate
+     */
+    int getArchiveRate();
+}

modAionBase/src/org/aion/base/db/IRepositoryConfig.java

@@ -1,4 +1,4 @@
-/*******************************************************************************
+/* ******************************************************************************
  * Copyright (c) 2017-2018 Aion foundation.
  *
  *     This file is part of the aion network project.
@@ -37,19 +37,17 @@
 import java.util.Properties;
 
 /**
- * Represents a configuration interface accepted that should be accepted by the
- * repository to implement necessary configs
+ * Represents a configuration interface accepted that should be accepted by the repository to
+ * implement necessary configs
  *
  * @author yao
  */
 public interface IRepositoryConfig {
 
-    /**
-     * @return absolute path to the DB folder containing files
-     */
+    /** @return absolute path to the DB folder containing files */
     String getDbPath();
 
-    int getPrune();
+    IPruneConfig getPruneConfig();
 
     IContractDetails contractDetailsImpl();