Rename MemoryDB to StateCacheDB

Update associated source references, tests and documentation.

Author: halfalicious

doc/database_layout.rst

@@ -106,4 +106,4 @@ implemenation is in
 For lower-level code accessing the database itself see
 `OverlayDB <https://github.com/ethereum/aleth/blob/master/libdevcore/OverlayDB.h>`__
 and
-`MemoryDB <https://github.com/ethereum/aleth/blob/master/libdevcore/MemoryDB.h>`__.
+`StateCacheDB` <https://github.com/ethereum/aleth/blob/master/libdevcore/StateCacheB.h>`__.

libdevcore/OverlayDB.cpp

@@ -101,7 +101,7 @@ void OverlayDB::commit()
 
 bytes OverlayDB::lookupAux(h256 const& _h) const
 {
-    bytes ret = MemoryDB::lookupAux(_h);
+    bytes ret = StateCacheDB::lookupAux(_h);
     if (!ret.empty() || !m_db)
         return ret;
 
@@ -124,7 +124,7 @@ void OverlayDB::rollback()
 
 std::string OverlayDB::lookup(h256 const& _h) const
 {
-    std::string ret = MemoryDB::lookup(_h);
+    std::string ret = StateCacheDB::lookup(_h);
     if (!ret.empty() || !m_db)
         return ret;
 
@@ -133,15 +133,15 @@ std::string OverlayDB::lookup(h256 const& _h) const
 
 bool OverlayDB::exists(h256 const& _h) const
 {
-    if (MemoryDB::exists(_h))
+    if (StateCacheDB::exists(_h))
         return true;
     return m_db && m_db->exists(toSlice(_h));
 }
 
 void OverlayDB::kill(h256 const& _h)
 {
 #if ETH_PARANOIA || 1
-    if (!MemoryDB::kill(_h))
+    if (!StateCacheDB::kill(_h))
     {
         if (m_db)
         {
@@ -158,7 +158,7 @@ void OverlayDB::kill(h256 const& _h)
         }
     }
 #else
-    MemoryDB::kill(_h);
+    StateCacheDB::kill(_h);
 #endif
 }
 

libdevcore/OverlayDB.h

@@ -25,12 +25,12 @@
 #include <libdevcore/db.h>
 #include <libdevcore/Common.h>
 #include <libdevcore/Log.h>
-#include <libdevcore/MemoryDB.h>
+#include <libdevcore/StateCacheDB.h>
 
 namespace dev
 {
 
-class OverlayDB: public MemoryDB
+class OverlayDB: public StateCacheDB
 {
 public:
     explicit OverlayDB(std::unique_ptr<db::DatabaseFace> _db = nullptr)
@@ -59,7 +59,7 @@ class OverlayDB: public MemoryDB
 	bytes lookupAux(h256 const& _h) const;
 
 private:
-	using MemoryDB::clear;
+	using StateCacheDB::clear;
 
     std::shared_ptr<db::DatabaseFace> m_db;
 };

libdevcore/MemoryDB.cpp libdevcore/StateCacheDB.cpplibdevcore/MemoryDB.cpp renamed to libdevcore/StateCacheDB.cpp

@@ -14,12 +14,12 @@
     You should have received a copy of the GNU General Public License
     along with cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
 */
-/** @file MemoryDB.cpp
+/** @file StateCacheDB.cpp
  * @author Gav Wood <i@gavwood.com>
  * @date 2014
  */
 
-#include "MemoryDB.h"
+#include "StateCacheDB.h"
 #include "Common.h"
 #include "CommonData.h"
 using namespace std;
@@ -28,7 +28,7 @@ using namespace dev;
 namespace dev
 {
 
-std::unordered_map<h256, std::string> MemoryDB::get() const
+std::unordered_map<h256, std::string> StateCacheDB::get() const
 {
 #if DEV_GUARDED_DB
     ReadGuard l(x_this);
@@ -40,7 +40,7 @@ std::unordered_map<h256, std::string> MemoryDB::get() const
     return ret;
 }
 
-MemoryDB& MemoryDB::operator=(MemoryDB const& _c)
+StateCacheDB& StateCacheDB::operator=(StateCacheDB const& _c)
 {
     if (this == &_c)
         return *this;
@@ -53,7 +53,7 @@ MemoryDB& MemoryDB::operator=(MemoryDB const& _c)
     return *this;
 }
 
-std::string MemoryDB::lookup(h256 const& _h) const
+std::string StateCacheDB::lookup(h256 const& _h) const
 {
 #if DEV_GUARDED_DB
     ReadGuard l(x_this);
@@ -69,7 +69,7 @@ std::string MemoryDB::lookup(h256 const& _h) const
     return std::string();
 }
 
-bool MemoryDB::exists(h256 const& _h) const
+bool StateCacheDB::exists(h256 const& _h) const
 {
 #if DEV_GUARDED_DB
     ReadGuard l(x_this);
@@ -80,7 +80,7 @@ bool MemoryDB::exists(h256 const& _h) const
     return false;
 }
 
-void MemoryDB::insert(h256 const& _h, bytesConstRef _v)
+void StateCacheDB::insert(h256 const& _h, bytesConstRef _v)
 {
 #if DEV_GUARDED_DB
     WriteGuard l(x_this);
@@ -98,7 +98,7 @@ void MemoryDB::insert(h256 const& _h, bytesConstRef _v)
 #endif
 }
 
-bool MemoryDB::kill(h256 const& _h)
+bool StateCacheDB::kill(h256 const& _h)
 {
 #if DEV_GUARDED_DB
     ReadGuard l(x_this);
@@ -114,7 +114,7 @@ bool MemoryDB::kill(h256 const& _h)
         else
         {
             // If we get to this point, then there was probably a node in the level DB which we need to remove and which we have previously
-            // used as part of the memory-based MemoryDB. Nothing to be worried about *as long as the node exists in the DB*.
+            // used as part of the memory-based StateCacheDB. Nothing to be worried about *as long as the node exists in the DB*.
             cdebug << "NOKILL-WAS" << _h;
         }
         cdebug << "KILL" << _h << "=>" << m_main[_h].second;
@@ -127,7 +127,7 @@ bool MemoryDB::kill(h256 const& _h)
     return false;
 }
 
-bytes MemoryDB::lookupAux(h256 const& _h) const
+bytes StateCacheDB::lookupAux(h256 const& _h) const
 {
 #if DEV_GUARDED_DB
     ReadGuard l(x_this);
@@ -138,23 +138,23 @@ bytes MemoryDB::lookupAux(h256 const& _h) const
     return bytes();
 }
 
-void MemoryDB::removeAux(h256 const& _h)
+void StateCacheDB::removeAux(h256 const& _h)
 {
 #if DEV_GUARDED_DB
     WriteGuard l(x_this);
 #endif
     m_aux[_h].second = false;
 }
 
-void MemoryDB::insertAux(h256 const& _h, bytesConstRef _v)
+void StateCacheDB::insertAux(h256 const& _h, bytesConstRef _v)
 {
 #if DEV_GUARDED_DB
     WriteGuard l(x_this);
 #endif
     m_aux[_h] = make_pair(_v.toBytes(), true);
 }
 
-void MemoryDB::purge()
+void StateCacheDB::purge()
 {
 #if DEV_GUARDED_DB
     WriteGuard l(x_this);
@@ -174,7 +174,7 @@ void MemoryDB::purge()
             it = m_aux.erase(it);
 }
 
-h256Hash MemoryDB::keys() const
+h256Hash StateCacheDB::keys() const
 {
 #if DEV_GUARDED_DB
     ReadGuard l(x_this);

libdevcore/MemoryDB.h libdevcore/StateCacheDB.hlibdevcore/MemoryDB.h renamed to libdevcore/StateCacheDB.h

@@ -14,32 +14,31 @@
     You should have received a copy of the GNU General Public License
     along with cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
 */
-/** @file MemoryDB.h
+/** @file StateCacheDB.h
  * @author Gav Wood <i@gavwood.com>
  * @date 2014
  */
 
 #pragma once
 
-#include <unordered_map>
 #include "Common.h"
 #include "Log.h"
 #include "RLP.h"
 
 namespace dev
 {
 
-class MemoryDB
+class StateCacheDB
 {
     friend class EnforceRefs;
 
 public:
-    MemoryDB() {}
-    MemoryDB(MemoryDB const& _c) { operator=(_c); }
+    StateCacheDB() {}
+    StateCacheDB(StateCacheDB const& _c) { operator=(_c); }
 
-    MemoryDB& operator=(MemoryDB const& _c);
+    StateCacheDB& operator=(StateCacheDB const& _c);
 
-    virtual ~MemoryDB() = default;
+    virtual ~StateCacheDB() = default;
 
     void clear() { m_main.clear(); m_aux.clear(); } // WARNING !!!! didn't originally clear m_refCount!!!
     std::unordered_map<h256, std::string> get() const;
@@ -69,15 +68,15 @@ class MemoryDB
 class EnforceRefs
 {
 public:
-    EnforceRefs(MemoryDB const& _o, bool _r): m_o(_o), m_r(_o.m_enforceRefs) { _o.m_enforceRefs = _r; }
+    EnforceRefs(StateCacheDB const& _o, bool _r): m_o(_o), m_r(_o.m_enforceRefs) { _o.m_enforceRefs = _r; }
     ~EnforceRefs() { m_o.m_enforceRefs = m_r; }
 
 private:
-    MemoryDB const& m_o;
+    StateCacheDB const& m_o;
     bool m_r;
 };
 
-inline std::ostream& operator<<(std::ostream& _out, MemoryDB const& _m)
+inline std::ostream& operator<<(std::ostream& _out, StateCacheDB const& _m)
 {
     for (auto const& i: _m.get())
     {

libethcore/BlockHeader.cpp

@@ -23,7 +23,7 @@
 #include <libdevcore/Log.h>
 #include <libdevcore/RLP.h>
 #include <libdevcore/TrieDB.h>
-#include <libdevcore/MemoryDB.h>
+#include <libdevcore/StateCacheDB.h>
 #include <libdevcore/TrieHash.h>
 #include <libethcore/Common.h>
 #include "Exceptions.h"
@@ -237,8 +237,8 @@ void BlockHeader::verify(Strictness _s, BlockHeader const& _parent, bytesConstRe
         LOG(m_logger) << "Expected trie root: " << toString(expectedRoot);
         if (m_transactionsRoot != expectedRoot)
         {
-            MemoryDB tm;
-            GenericTrieDB<MemoryDB> transactionsTrie(&tm);
+            StateCacheDB tm;
+            GenericTrieDB<StateCacheDB> transactionsTrie(&tm);
             transactionsTrie.init();
 
             vector<bytesConstRef> txs;

libethereum/ChainParams.cpp

@@ -187,8 +187,8 @@ void ChainParams::populateFromGenesis(bytes const& _genesisRLP, AccountMap const
 
 h256 ChainParams::calculateStateRoot(bool _force) const
 {
-    MemoryDB db;
-    SecureTrieDB<Address, MemoryDB> state(&db);
+    StateCacheDB db;
+    SecureTrieDB<Address, StateCacheDB> state(&db);
     state.init();
     if (!stateRoot || _force)
     {

libethereum/State.cpp

@@ -802,4 +802,4 @@ AddressHash dev::eth::commit(AccountMap const& _cache, SecureTrieDB<Address, DB>
 
 
 template AddressHash dev::eth::commit<OverlayDB>(AccountMap const& _cache, SecureTrieDB<Address, OverlayDB>& _state);
-template AddressHash dev::eth::commit<MemoryDB>(AccountMap const& _cache, SecureTrieDB<Address, MemoryDB>& _state);
+template AddressHash dev::eth::commit<StateCacheDB>(AccountMap const& _cache, SecureTrieDB<Address, StateCacheDB>& _state);