Redesign stoppable objects

Builds/CMake/RippledCore.cmake

@@ -461,7 +461,6 @@ target_sources (rippled PRIVATE
   src/ripple/core/impl/LoadMonitor.cpp
   src/ripple/core/impl/SNTPClock.cpp
   src/ripple/core/impl/SociDB.cpp
-  src/ripple/core/impl/Stoppable.cpp
   src/ripple/core/impl/TimeKeeper.cpp
   src/ripple/core/impl/Workers.cpp
   src/ripple/core/Pg.cpp
@@ -767,7 +766,6 @@ target_sources (rippled PRIVATE
   src/test/core/CryptoPRNG_test.cpp
   src/test/core/JobQueue_test.cpp
   src/test/core/SociDB_test.cpp
-  src/test/core/Stoppable_test.cpp
   src/test/core/Workers_test.cpp
   #[===============================[
      test sources:

src/ripple/app/ledger/InboundLedgers.h

@@ -21,7 +21,6 @@
 #define RIPPLE_APP_LEDGER_INBOUNDLEDGERS_H_INCLUDED
 
 #include <ripple/app/ledger/InboundLedger.h>
-#include <ripple/core/Stoppable.h>
 #include <ripple/protocol/RippleLedgerHash.h>
 #include <memory>
 
@@ -83,14 +82,13 @@ class InboundLedgers
     sweep() = 0;
 
     virtual void
-    onStop() = 0;
+    stop() = 0;
 };
 
 std::unique_ptr<InboundLedgers>
 make_InboundLedgers(
     Application& app,
     InboundLedgers::clock_type& clock,
-    Stoppable& parent,
     beast::insight::Collector::ptr const& collector);
 
 }  // namespace ripple

src/ripple/app/ledger/InboundTransactions.h

@@ -21,7 +21,6 @@
 #define RIPPLE_APP_LEDGER_INBOUNDTRANSACTIONS_H_INCLUDED
 
 #include <ripple/beast/clock/abstract_clock.h>
-#include <ripple/core/Stoppable.h>
 #include <ripple/overlay/Peer.h>
 #include <ripple/shamap/SHAMap.h>
 #include <memory>
@@ -85,12 +84,14 @@ class InboundTransactions
      */
     virtual void
     newRound(std::uint32_t seq) = 0;
+
+    virtual void
+    stop() = 0;
 };
 
 std::unique_ptr<InboundTransactions>
 make_InboundTransactions(
     Application& app,
-    Stoppable& parent,
     beast::insight::Collector::ptr const& collector,
     std::function<void(std::shared_ptr<SHAMap> const&, bool)> gotSet);
 

src/ripple/app/ledger/LedgerCleaner.h

@@ -23,41 +23,45 @@
 #include <ripple/app/main/Application.h>
 #include <ripple/beast/utility/Journal.h>
 #include <ripple/beast/utility/PropertyStream.h>
-#include <ripple/core/Stoppable.h>
 #include <ripple/json/json_value.h>
 #include <memory>
 
 namespace ripple {
-namespace detail {
 
 /** Check the ledger/transaction databases to make sure they have continuity */
-class LedgerCleaner : public Stoppable, public beast::PropertyStream::Source
+class LedgerCleaner : public beast::PropertyStream::Source
 {
 protected:
-    explicit LedgerCleaner(Stoppable& parent);
+    LedgerCleaner() : beast::PropertyStream::Source("ledgercleaner")
+    {
+    }
 
 public:
-    /** Destroy the object. */
-    virtual ~LedgerCleaner() = 0;
+    virtual ~LedgerCleaner() = default;
+
+    virtual void
+    start() = 0;
+
+    virtual void
+    stop() = 0;
 
     /** Start a long running task to clean the ledger.
         The ledger is cleaned asynchronously, on an implementation defined
         thread. This function call does not block. The long running task
-        will be stopped if the Stoppable stops.
+        will be stopped by a call to stop().
 
         Thread safety:
             Safe to call from any thread at any time.
 
         @param parameters A Json object with configurable parameters.
     */
     virtual void
-    doClean(Json::Value const& parameters) = 0;
+    clean(Json::Value const& parameters) = 0;
 };
 
 std::unique_ptr<LedgerCleaner>
-make_LedgerCleaner(Application& app, Stoppable& parent, beast::Journal journal);
+make_LedgerCleaner(Application& app, beast::Journal journal);
 
-}  // namespace detail
 }  // namespace ripple
 
 #endif

src/ripple/app/ledger/LedgerMaster.h

@@ -23,18 +23,16 @@
 #include <ripple/app/ledger/AbstractFetchPackContainer.h>
 #include <ripple/app/ledger/InboundLedgers.h>
 #include <ripple/app/ledger/Ledger.h>
-#include <ripple/app/ledger/LedgerCleaner.h>
 #include <ripple/app/ledger/LedgerHistory.h>
 #include <ripple/app/ledger/LedgerHolder.h>
 #include <ripple/app/ledger/LedgerReplay.h>
 #include <ripple/app/main/Application.h>
 #include <ripple/app/misc/CanonicalTXSet.h>
 #include <ripple/basics/RangeSet.h>
 #include <ripple/basics/StringUtilities.h>
+#include <ripple/basics/UptimeClock.h>
 #include <ripple/basics/chrono.h>
 #include <ripple/beast/insight/Collector.h>
-#include <ripple/beast/utility/PropertyStream.h>
-#include <ripple/core/Stoppable.h>
 #include <ripple/protocol/Protocol.h>
 #include <ripple/protocol/RippleLedgerHash.h>
 #include <ripple/protocol/STValidation.h>
@@ -69,7 +67,7 @@ class ReportingShouldProxy : public std::runtime_error
 // Tracks the current ledger and any ledgers in the process of closing
 // Tracks ledger history
 // Tracks held transactions
-class LedgerMaster : public Stoppable, public AbstractFetchPackContainer
+class LedgerMaster : public AbstractFetchPackContainer
 {
 public:
     // Age for last validated ledger if the process has yet to validate.
@@ -79,7 +77,6 @@ class LedgerMaster : public Stoppable, public AbstractFetchPackContainer
     explicit LedgerMaster(
         Application& app,
         Stopwatch& stopwatch,
-        Stoppable& parent,
         beast::insight::Collector::ptr const& collector,
         beast::Journal journal);
 
@@ -259,11 +256,6 @@ class LedgerMaster : public Stoppable, public AbstractFetchPackContainer
 
     bool
     fixIndex(LedgerIndex ledgerIndex, LedgerHash const& ledgerHash);
-    void
-    doLedgerCleaner(Json::Value const& parameters);
-
-    beast::PropertyStream::Source&
-    getPropertySource();
 
     void
     clearPriorLedgers(LedgerIndex seq);
@@ -385,8 +377,6 @@ class LedgerMaster : public Stoppable, public AbstractFetchPackContainer
     std::recursive_mutex mCompleteLock;
     RangeSet<std::uint32_t> mCompleteLedgers;
 
-    std::unique_ptr<detail::LedgerCleaner> mLedgerCleaner;
-
     // Publish thread is running.
     bool mAdvanceThread{false};
 

src/ripple/app/ledger/LedgerReplayer.h

@@ -24,7 +24,6 @@
 #include <ripple/app/ledger/LedgerReplayTask.h>
 #include <ripple/app/main/Application.h>
 #include <ripple/beast/utility/Journal.h>
-#include <ripple/core/Stoppable.h>
 
 #include <memory>
 #include <mutex>
@@ -70,14 +69,13 @@ std::uint32_t constexpr MAX_QUEUED_TASKS = 100;
 /**
  * Manages the lifetime of ledger replay tasks.
  */
-class LedgerReplayer final : public Stoppable
+class LedgerReplayer final
 {
 public:
     LedgerReplayer(
         Application& app,
         InboundLedgers& inboundLedgers,
-        std::unique_ptr<PeerSetBuilder> peerSetBuilder,
-        Stoppable& parent);
+        std::unique_ptr<PeerSetBuilder> peerSetBuilder);
 
     ~LedgerReplayer();
 
@@ -125,7 +123,7 @@ class LedgerReplayer final : public Stoppable
     sweep();
 
     void
-    onStop() override;
+    stop();
 
 private:
     mutable std::mutex mtx_;

src/ripple/app/ledger/OrderBookDB.cpp

@@ -27,11 +27,8 @@
 
 namespace ripple {
 
-OrderBookDB::OrderBookDB(Application& app, Stoppable& parent)
-    : Stoppable("OrderBookDB", parent)
-    , app_(app)
-    , mSeq(0)
-    , j_(app.journal("OrderBookDB"))
+OrderBookDB::OrderBookDB(Application& app)
+    : app_(app), mSeq(0), j_(app.journal("OrderBookDB"))
 {
 }
 
@@ -101,7 +98,7 @@ OrderBookDB::update(std::shared_ptr<ReadView const> const& ledger)
     {
         for (auto& sle : ledger->sles)
         {
-            if (isStopping())
+            if (app_.isStopping())
             {
                 JLOG(j_.info())
                     << "OrderBookDB::update exiting due to isStopping";

src/ripple/app/ledger/OrderBookDB.h

@@ -28,10 +28,10 @@
 
 namespace ripple {
 
-class OrderBookDB : public Stoppable
+class OrderBookDB
 {
 public:
-    OrderBookDB(Application& app, Stoppable& parent);
+    OrderBookDB(Application& app);
 
     void
     setup(std::shared_ptr<ReadView const> const& ledger);

src/ripple/app/ledger/impl/InboundLedgers.cpp

@@ -33,7 +33,7 @@
 
 namespace ripple {
 
-class InboundLedgersImp : public InboundLedgers, public Stoppable
+class InboundLedgersImp : public InboundLedgers
 {
 private:
     Application& app_;
@@ -49,11 +49,9 @@ class InboundLedgersImp : public InboundLedgers, public Stoppable
     InboundLedgersImp(
         Application& app,
         clock_type& clock,
-        Stoppable& parent,
         beast::insight::Collector::ptr const& collector,
         std::unique_ptr<PeerSetBuilder> peerSetBuilder)
-        : Stoppable("InboundLedgers", parent)
-        , app_(app)
+        : app_(app)
         , fetchRate_(clock.now())
         , j_(app.journal("InboundLedger"))
         , m_clock(clock)
@@ -74,13 +72,15 @@ class InboundLedgersImp : public InboundLedgers, public Stoppable
         assert(
             reason != InboundLedger::Reason::SHARD ||
             (seq != 0 && app_.getShardStore()));
-        if (isStopping())
-            return {};
 
         bool isNew = true;
         std::shared_ptr<InboundLedger> inbound;
         {
             ScopedLockType sl(mLock);
+            if (stopping_)
+            {
+                return {};
+            }
             auto it = mLedgers.find(hash);
             if (it != mLedgers.end())
             {
@@ -389,14 +389,12 @@ class InboundLedgersImp : public InboundLedgers, public Stoppable
     }
 
     void
-    onStop() override
+    stop() override
     {
         ScopedLockType lock(mLock);
-
+        stopping_ = true;
         mLedgers.clear();
         mRecentFailures.clear();
-
-        stopped();
     }
 
 private:
@@ -405,6 +403,7 @@ class InboundLedgersImp : public InboundLedgers, public Stoppable
     using ScopedLockType = std::unique_lock<std::recursive_mutex>;
     std::recursive_mutex mLock;
 
+    bool stopping_ = false;
     using MapType = hash_map<uint256, std::shared_ptr<InboundLedger>>;
     MapType mLedgers;
 
@@ -421,11 +420,10 @@ std::unique_ptr<InboundLedgers>
 make_InboundLedgers(
     Application& app,
     InboundLedgers::clock_type& clock,
-    Stoppable& parent,
     beast::insight::Collector::ptr const& collector)
 {
     return std::make_unique<InboundLedgersImp>(
-        app, clock, parent, collector, make_PeerSetBuilder(app));
+        app, clock, collector, make_PeerSetBuilder(app));
 }
 
 }  // namespace ripple

src/ripple/app/ledger/impl/InboundTransactions.cpp

@@ -58,19 +58,15 @@ class InboundTransactionSet
     }
 };
 
-class InboundTransactionsImp : public InboundTransactions, public Stoppable
+class InboundTransactionsImp : public InboundTransactions
 {
 public:
-    Application& app_;
-
     InboundTransactionsImp(
         Application& app,
-        Stoppable& parent,
         beast::insight::Collector::ptr const& collector,
         std::function<void(std::shared_ptr<SHAMap> const&, bool)> gotSet,
         std::unique_ptr<PeerSetBuilder> peerSetBuilder)
-        : Stoppable("InboundTransactions", parent)
-        , app_(app)
+        : app_(app)
         , m_seq(0)
         , m_zeroSet(m_map[uint256()])
         , m_gotSet(std::move(gotSet))
@@ -118,7 +114,7 @@ class InboundTransactionsImp : public InboundTransactions, public Stoppable
                 return it->second.mSet;
             }
 
-            if (!acquire || isStopping())
+            if (!acquire || stopping_)
                 return std::shared_ptr<SHAMap>();
 
             ta = std::make_shared<TransactionAcquire>(
@@ -242,20 +238,21 @@ class InboundTransactionsImp : public InboundTransactions, public Stoppable
     }
 
     void
-    onStop() override
+    stop() override
     {
         std::lock_guard lock(mLock);
-
+        stopping_ = true;
         m_map.clear();
-
-        stopped();
     }
 
 private:
     using MapType = hash_map<uint256, InboundTransactionSet>;
 
+    Application& app_;
+
     std::recursive_mutex mLock;
 
+    bool stopping_{false};
     MapType m_map;
     std::uint32_t m_seq;
 
@@ -274,12 +271,11 @@ InboundTransactions::~InboundTransactions() = default;
 std::unique_ptr<InboundTransactions>
 make_InboundTransactions(
     Application& app,
-    Stoppable& parent,
     beast::insight::Collector::ptr const& collector,
     std::function<void(std::shared_ptr<SHAMap> const&, bool)> gotSet)
 {
     return std::make_unique<InboundTransactionsImp>(
-        app, parent, collector, std::move(gotSet), make_PeerSetBuilder(app));
+        app, collector, std::move(gotSet), make_PeerSetBuilder(app));
 }
 
 }  // namespace ripple