Refactor Ledger and LedgerEntrySet:

Member functions and free functions on Ledger and LedgerEntrySet are
rewritten in terms of new abstract interfaces `BasicView` and `View`,
representing the set of non-decomposable primitives necessary to read
and write state map items in a ledger, and to overlay a discardable
view onto a Ledger that can calculate metadata during transaction
processing. const-correctness is enforced through the parameter and
return types.

The MetaView now supports multi-level stacking: A MetaView can be
stacked on top of either a Ledger or another MetaView, up to any
number of levels.

The getSLEi member function is removed. The CachedView wrapper
replaces it, wrapping a View such that any function called with a
CachedView will go through the SLECache.

* Add BasicView, View, CachedView
* Rename LedgerEntrySet to MetaView
* Factor out free functions
* Consolidate free functions in ViewAPI
* Remove unused class members and free functions
This commit is contained in:
Vinnie Falco
2015-06-13 20:33:47 -07:00
parent 7d329570f4
commit d468deee12
115 changed files with 5530 additions and 4521 deletions

View File

@@ -0,0 +1,833 @@
//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012, 2013 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#include <BeastConfig.h>
#include <ripple/protocol/Quality.h>
#include <ripple/app/main/Application.h>
#include <ripple/ledger/CachedView.h>
#include <ripple/app/ledger/MetaView.h>
#include <ripple/ledger/DeferredCredits.h>
#include <ripple/ledger/ViewAPI.h>
#include <ripple/basics/Log.h>
#include <ripple/basics/StringUtilities.h>
#include <ripple/json/to_string.h>
#include <ripple/protocol/JsonFields.h>
#include <ripple/protocol/Indexes.h>
namespace ripple {
// #define META_DEBUG
// VFALCO TODO Replace this macro with a documented language constant
//
/** Maximum number of entries in a directory page
A change would be protocol-breaking.
*/
#ifndef DIR_NODE_MAX
#define DIR_NODE_MAX 32
#endif
MetaView::MetaView(Ledger::ref ledger,
uint256 const& transactionID,
std::uint32_t ledgerID,
TransactionEngineParams params)
: parent_(&*ledger)
, mParams(params)
{
mSet.init (transactionID, ledgerID);
}
MetaView::MetaView (BasicView& parent,
bool openLedger)
: parent_ (&parent)
, mParams (openLedger
? tapOPEN_LEDGER : tapNONE)
{
}
MetaView::MetaView (Ledger::ref ledger,
TransactionEngineParams tep)
: parent_(&*ledger)
, mParams (tep)
{
}
MetaView::MetaView (MetaView const& other)
: parent_(other.parent_)
, items_(other.items_)
, mDeferredCredits(other.mDeferredCredits)
, mSet(other.mSet)
// VFALCO NOTE This is a change in behavior,
// previous version set tapNONE
, mParams(other.mParams)
, mSeq(other.mSeq + 1)
{
}
//------------------------------------------------------------------------------
std::shared_ptr<SLE> const&
MetaView::copyOnRead (
list_type::iterator iter)
{
if (iter->second.mSeq != mSeq)
{
iter->second.mSeq = mSeq;
iter->second.mEntry = std::make_shared<SLE>(
*iter->second.mEntry);
}
return iter->second.mEntry;
}
bool
MetaView::exists (Keylet const& k) const
{
assert(k.key.isNonZero());
auto const iter = items_.find(k.key);
if (iter == items_.end())
return parent_->exists(k);
if (iter->second.mAction == taaDELETE)
return false;
if (! k.check(*iter->second.mEntry))
return false;
return true;
}
/* This works by first calculating succ() on the parent,
then calculating succ() our internal list, and taking
the lower of the two.
*/
boost::optional<uint256>
MetaView::succ (uint256 const& key,
boost::optional<uint256> last) const
{
boost::optional<uint256> next = key;
list_type::const_iterator iter;
// Find parent successor that is
// not also deleted in our list
do
{
next = parent_->succ(*next, last);
if (! next)
break;
iter = items_.find(*next);
}
while (iter != items_.end() &&
iter->second.mAction == taaDELETE);
// Find non-deleted successor in our list
for (iter = items_.upper_bound(key);
iter != items_.end (); ++iter)
{
if (iter->second.mAction != taaDELETE)
{
// Found both, return the lower key
if (! next || next > iter->first)
next = iter->first;
break;
}
}
// Nothing in our list, return
// what we got from the parent.
if (last && next >= last)
return boost::none;
return next;
}
std::shared_ptr<SLE const>
MetaView::read (Keylet const& k) const
{
assert(k.key.isNonZero());
if (k.key.isZero())
return nullptr;
// VFALCO TODO Shouldn't we create taaCACHED
// items to optimize reads?
auto const iter = items_.find(k.key);
if (iter == items_.end())
{
auto const sle =
parent_->read(k);
if (! sle)
return nullptr;
return sle;
}
if (iter->second.mAction == taaDELETE)
return nullptr;
auto const& sle =
iter->second.mEntry;
if (! k.check(*sle))
return nullptr;
return sle;
}
bool
MetaView::unchecked_erase (uint256 const& key)
{
auto const iter =
items_.lower_bound(key);
if (iter == items_.end() ||
iter->first != key)
{
assert(parent_->exists(
keylet::unchecked(key)));
using namespace std;
items_.emplace_hint(iter, piecewise_construct,
forward_as_tuple(key), forward_as_tuple(
make_shared<SLE>(*parent_->read(
keylet::unchecked(key))),
taaDELETE, mSeq));
return true;
}
if (iter->second.mAction == taaCREATE)
{
items_.erase(iter);
return true;
}
assert(iter->second.mAction != taaDELETE);
iter->second.mAction = taaDELETE;
return true;
}
void
MetaView::unchecked_insert(
std::shared_ptr<SLE>&& sle)
{
auto const iter =
items_.lower_bound(sle->key());
if (iter == items_.end() ||
iter->first != sle->key())
{
// VFALCO return Keylet from SLE
assert(! parent_->exists(Keylet{
sle->getType(), sle->key()}));
using namespace std;
items_.emplace_hint(iter, piecewise_construct,
forward_as_tuple(sle->key()),
forward_as_tuple(move(sle),
taaCREATE, mSeq));
return;
}
switch(iter->second.mAction)
{
case taaMODIFY:
throw std::runtime_error(
"insert after modify");
case taaCREATE:
throw std::runtime_error(
"insert after create");
case taaCACHED:
throw std::runtime_error(
"insert after peek");
case taaDELETE:
default:
break;
};
// VFALCO return Keylet from SLE
assert(parent_->exists(
Keylet{sle->getType(), sle->key()}));
iter->second.mSeq = mSeq;
iter->second.mEntry = std::move(sle);
iter->second.mAction = taaMODIFY;
}
void
MetaView::unchecked_replace (std::shared_ptr<SLE>&& sle)
{
auto const iter =
items_.lower_bound(sle->key());
if (iter == items_.end() ||
iter->first != sle->key())
{
// VFALCO return Keylet from SLE
assert(parent_->exists(Keylet{
sle->getType(), sle->key()}));
using namespace std;
items_.emplace_hint(iter, piecewise_construct,
forward_as_tuple(sle->key()),
forward_as_tuple(move(sle),
taaMODIFY, mSeq));
return;
}
if (iter->second.mAction == taaDELETE)
throw std::runtime_error(
"replace after delete");
if (iter->second.mAction != taaCREATE)
iter->second.mAction = taaMODIFY;
iter->second.mSeq = mSeq;
iter->second.mEntry = std::move(sle);
}
STAmount
MetaView::deprecatedBalance(
AccountID const& account, AccountID const& issuer,
STAmount const& amount) const
{
if (mDeferredCredits)
return mDeferredCredits->adjustedBalance(
account, issuer, amount);
return amount;
}
std::shared_ptr<SLE>
MetaView::peek (Keylet const& k)
{
assert(k.key.isNonZero());
if (k.key.isZero())
return nullptr;
auto iter = items_.lower_bound(k.key);
if (iter == items_.end() ||
iter->first != k.key)
{
auto const sle =
parent_->read(k);
if (! sle)
return nullptr;
// Make our own copy
iter = items_.emplace_hint (iter,
std::piecewise_construct,
std::forward_as_tuple(sle->getIndex()),
std::forward_as_tuple(
std::make_shared<SLE>(
*sle), taaCACHED, mSeq));
return iter->second.mEntry;
}
if (iter->second.mAction == taaDELETE)
return nullptr;
auto sle =
copyOnRead(iter);
if (! k.check(*sle))
return nullptr;
return sle;
}
void
MetaView::erase (std::shared_ptr<SLE> const& sle)
{
auto const iter =
items_.find(sle->getIndex());
assert(iter != items_.end());
if (iter == items_.end())
return;
assert(iter->second.mSeq == mSeq);
assert(iter->second.mEntry == sle);
assert(iter->second.mAction != taaDELETE);
if (iter->second.mAction == taaDELETE)
return;
if (iter->second.mAction == taaCREATE)
{
items_.erase(iter);
return;
}
assert(iter->second.mAction == taaCACHED ||
iter->second.mAction == taaMODIFY);
iter->second.mAction = taaDELETE;
}
void
MetaView::insert (std::shared_ptr<SLE> const& sle)
{
auto const iter = items_.lower_bound(sle->key());
if (iter == items_.end() ||
iter->first != sle->key())
{
// VFALCO return Keylet from SLE
assert(! parent_->exists(
Keylet{sle->getType(), sle->key()}));
items_.emplace_hint(iter, std::piecewise_construct,
std::forward_as_tuple(sle->getIndex()),
std::forward_as_tuple(sle, taaCREATE, mSeq));
return;
}
switch(iter->second.mAction)
{
case taaMODIFY:
throw std::runtime_error(
"insert after modify");
case taaCREATE:
// This could be made to work (?)
throw std::runtime_error(
"insert after create");
case taaCACHED:
throw std::runtime_error(
"insert after copy");
default:
break;
}
// Existed in parent, deleted here
assert(parent_->exists(
Keylet{sle->getType(), sle->key()}));
iter->second.mSeq = mSeq;
iter->second.mEntry = sle;
iter->second.mAction = taaMODIFY;
}
void
MetaView::update (std::shared_ptr<SLE> const& sle)
{
auto const iter = items_.lower_bound(sle->key());
if (iter == items_.end() ||
iter->first != sle->key())
{
// VFALCO return Keylet from SLE
assert(parent_->exists(
Keylet{sle->getType(), sle->key()}));
items_.emplace_hint(iter, std::piecewise_construct,
std::forward_as_tuple(sle->key()),
std::forward_as_tuple(sle, taaMODIFY, mSeq));
return;
}
// VFALCO Should we throw?
assert(iter->second.mSeq == mSeq);
assert(iter->second.mEntry == sle);
if (iter->second.mAction == taaDELETE)
throw std::runtime_error(
"update after delete");
if (iter->second.mAction != taaCREATE)
iter->second.mAction = taaMODIFY;
}
bool
MetaView::openLedger() const
{
return mParams & tapOPEN_LEDGER;
}
void
MetaView::deprecatedCreditHint(
AccountID const& from, AccountID const& to,
STAmount const& amount)
{
if (mDeferredCredits)
return mDeferredCredits->credit(
from, to, amount);
}
//------------------------------------------------------------------------------
void MetaView::apply()
{
// Write back the account states
for (auto& item : items_)
{
// VFALCO TODO rvalue move the mEntry, make
// sure the mNodes is not used after
// this function is called.
auto& sle = item.second.mEntry;
switch (item.second.mAction)
{
case taaCACHED:
assert(parent_->exists(
keylet::child(item.first)));
break;
case taaCREATE:
// VFALCO Is this logging necessary anymore?
WriteLog (lsDEBUG, View) <<
"applyTransaction: taaCREATE: " << sle->getText ();
parent_->unchecked_insert(std::move(sle));
break;
case taaMODIFY:
{
WriteLog (lsDEBUG, View) <<
"applyTransaction: taaMODIFY: " << sle->getText ();
parent_->unchecked_replace(std::move(sle));
break;
}
case taaDELETE:
WriteLog (lsDEBUG, View) <<
"applyTransaction: taaDELETE: " << sle->getText ();
parent_->unchecked_erase(sle->key());
break;
}
}
// Safety precaution since we moved the
// entries out, apply() cannot be called twice.
items_.clear();
}
void MetaView::swapWith (MetaView& e)
{
using std::swap;
swap (parent_, e.parent_);
items_.swap (e.items_);
mSet.swap (e.mSet);
swap (mParams, e.mParams);
swap (mSeq, e.mSeq);
swap (mDeferredCredits, e.mDeferredCredits);
}
Json::Value MetaView::getJson (int) const
{
Json::Value ret (Json::objectValue);
Json::Value nodes (Json::arrayValue);
for (auto it = items_.begin (), end = items_.end (); it != end; ++it)
{
Json::Value entry (Json::objectValue);
entry[jss::node] = to_string (it->first);
switch (it->second.mEntry->getType ())
{
case ltINVALID:
entry[jss::type] = "invalid";
break;
case ltACCOUNT_ROOT:
entry[jss::type] = "acccount_root";
break;
case ltDIR_NODE:
entry[jss::type] = "dir_node";
break;
case ltRIPPLE_STATE:
entry[jss::type] = "ripple_state";
break;
case ltNICKNAME:
entry[jss::type] = "nickname";
break;
case ltOFFER:
entry[jss::type] = "offer";
break;
default:
assert (false);
}
switch (it->second.mAction)
{
case taaCACHED:
entry[jss::action] = "cache";
break;
case taaMODIFY:
entry[jss::action] = "modify";
break;
case taaDELETE:
entry[jss::action] = "delete";
break;
case taaCREATE:
entry[jss::action] = "create";
break;
default:
assert (false);
}
nodes.append (entry);
}
ret[jss::nodes] = nodes;
ret[jss::metaData] = mSet.getJson (0);
return ret;
}
//------------------------------------------------------------------------------
std::shared_ptr<SLE>
MetaView::getForMod (uint256 const& key,
Mods& mods)
{
auto iter = items_.find (key);
if (iter != items_.end ())
{
if (iter->second.mAction == taaDELETE)
{
WriteLog (lsFATAL, View) <<
"Trying to thread to deleted node";
return nullptr;
}
if (iter->second.mAction == taaCACHED)
iter->second.mAction = taaMODIFY;
return copyOnRead(iter);
}
{
auto miter = mods.find (key);
if (miter != mods.end ())
{
assert (miter->second);
return miter->second;
}
}
// VFALCO NOTE Should this be read() or peek()?
auto const csle = parent_->read(
keylet::unchecked(key));
if (! csle)
return nullptr;
// Need to make a copy here
auto sle =
std::make_shared<SLE>(*csle);
mods.emplace(key, sle);
return sle;
}
bool
MetaView::threadTx (RippleAddress const& to,
Mods& mods)
{
auto const sle = getForMod(keylet::account(
to.getAccountID()).key, mods);
#ifdef META_DEBUG
WriteLog (lsTRACE, View) << "Thread to " << threadTo.getAccountID ();
#endif
if (! sle)
{
WriteLog (lsFATAL, View) <<
"Threading to non-existent account: " << to.humanAccountID ();
assert (false);
return false;
}
return threadTx (sle, mods);
}
bool
MetaView::threadTx(
std::shared_ptr<SLE> const& to,
Mods& mods)
{
uint256 prevTxID;
std::uint32_t prevLgrID;
if (! to->thread(mSet.getTxID(),
mSet.getLgrSeq(), prevTxID, prevLgrID))
return false;
if (prevTxID.isZero () ||
TransactionMetaSet::thread(
mSet.getAffectedNode(to,
sfModifiedNode), prevTxID,
prevLgrID))
return true;
assert (false);
return false;
}
bool
MetaView::threadOwners(std::shared_ptr<
SLE const> const& sle, Mods& mods)
{
// thread new or modified sle to owner or owners
if (sle->hasOneOwner())
{
// thread to owner's account
#ifdef META_DEBUG
WriteLog (lsTRACE, View) << "Thread to single owner";
#endif
return threadTx (sle->getOwner(), mods);
}
else if (sle->hasTwoOwners ()) // thread to owner's accounts
{
#ifdef META_DEBUG
WriteLog (lsTRACE, View) << "Thread to two owners";
#endif
return threadTx(sle->getFirstOwner(), mods) &&
threadTx(sle->getSecondOwner(), mods);
}
return false;
}
void
MetaView::calcRawMeta (Serializer& s,
TER result, std::uint32_t index)
{
// calculate the raw meta data and return it. This must be called before the set is committed
// Entries modified only as a result of building the transaction metadata
Mods newMod;
for (auto& it : items_)
{
auto type = &sfGeneric;
switch (it.second.mAction)
{
case taaMODIFY:
#ifdef META_DEBUG
WriteLog (lsTRACE, View) << "Modified Node " << it.first;
#endif
type = &sfModifiedNode;
break;
case taaDELETE:
#ifdef META_DEBUG
WriteLog (lsTRACE, View) << "Deleted Node " << it.first;
#endif
type = &sfDeletedNode;
break;
case taaCREATE:
#ifdef META_DEBUG
WriteLog (lsTRACE, View) << "Created Node " << it.first;
#endif
type = &sfCreatedNode;
break;
default: // ignore these
break;
}
if (type == &sfGeneric)
continue;
auto const origNode =
parent_->read(keylet::unchecked(it.first));
auto curNode = it.second.mEntry;
if ((type == &sfModifiedNode) && (*curNode == *origNode))
continue;
std::uint16_t nodeType = curNode
? curNode->getFieldU16 (sfLedgerEntryType)
: origNode->getFieldU16 (sfLedgerEntryType);
mSet.setAffectedNode (it.first, *type, nodeType);
if (type == &sfDeletedNode)
{
assert (origNode && curNode);
threadOwners (origNode, newMod); // thread transaction to owners
STObject prevs (sfPreviousFields);
for (auto const& obj : *origNode)
{
// go through the original node for modified fields saved on modification
if (obj.getFName ().shouldMeta (SField::sMD_ChangeOrig) && !curNode->hasMatchingEntry (obj))
prevs.emplace_back (obj);
}
if (!prevs.empty ())
mSet.getAffectedNode (it.first).emplace_back (std::move(prevs));
STObject finals (sfFinalFields);
for (auto const& obj : *curNode)
{
// go through the final node for final fields
if (obj.getFName ().shouldMeta (SField::sMD_Always | SField::sMD_DeleteFinal))
finals.emplace_back (obj);
}
if (!finals.empty ())
mSet.getAffectedNode (it.first).emplace_back (std::move(finals));
}
else if (type == &sfModifiedNode)
{
assert (curNode && origNode);
if (curNode->isThreadedType ()) // thread transaction to node it modified
threadTx (curNode, newMod);
STObject prevs (sfPreviousFields);
for (auto const& obj : *origNode)
{
// search the original node for values saved on modify
if (obj.getFName ().shouldMeta (SField::sMD_ChangeOrig) && !curNode->hasMatchingEntry (obj))
prevs.emplace_back (obj);
}
if (!prevs.empty ())
mSet.getAffectedNode (it.first).emplace_back (std::move(prevs));
STObject finals (sfFinalFields);
for (auto const& obj : *curNode)
{
// search the final node for values saved always
if (obj.getFName ().shouldMeta (SField::sMD_Always | SField::sMD_ChangeNew))
finals.emplace_back (obj);
}
if (!finals.empty ())
mSet.getAffectedNode (it.first).emplace_back (std::move(finals));
}
else if (type == &sfCreatedNode) // if created, thread to owner(s)
{
assert (curNode && !origNode);
threadOwners (curNode, newMod);
if (curNode->isThreadedType ()) // always thread to self
threadTx (curNode, newMod);
STObject news (sfNewFields);
for (auto const& obj : *curNode)
{
// save non-default values
if (!obj.isDefault () && obj.getFName ().shouldMeta (SField::sMD_Create | SField::sMD_Always))
news.emplace_back (obj);
}
if (!news.empty ())
mSet.getAffectedNode (it.first).emplace_back (std::move(news));
}
else assert (false);
}
// add any new modified nodes to the modification set
for (auto& it : newMod)
update (it.second);
mSet.addRaw (s, result, index);
WriteLog (lsTRACE, View) << "Metadata:" << mSet.getJson (0);
}
void MetaView::enableDeferredCredits (bool enable)
{
assert(enable == !mDeferredCredits);
if (!enable)
{
mDeferredCredits.reset ();
return;
}
if (!mDeferredCredits)
mDeferredCredits.emplace ();
}
bool MetaView::areCreditsDeferred () const
{
return static_cast<bool> (mDeferredCredits);
}
ScopedDeferCredits::ScopedDeferCredits (MetaView& l)
: les_ (l), enabled_ (false)
{
if (!les_.areCreditsDeferred ())
{
WriteLog (lsTRACE, DeferredCredits) << "Enable";
les_.enableDeferredCredits (true);
enabled_ = true;
}
}
ScopedDeferCredits::~ScopedDeferCredits ()
{
if (enabled_)
{
WriteLog (lsTRACE, DeferredCredits) << "Disable";
les_.enableDeferredCredits (false);
}
}
} // ripple