Flush CValidationInterface callbacks prior to destruction

TheBlueMatt · TheBlueMatt · commit 3192975f1d17 · 2017-07-07T12:55:57.000-04:00
Note that the CScheduler thread cant be running at this point,
it has already been stopped with the rest of the init threadgroup.
Thus, just calling any remaining loose callbacks during Shutdown()
is sane.
diff --git a/src/init.cpp b/src/init.cpp
@@ -215,6 +215,19 @@ void Shutdown()
         fFeeEstimatesInitialized = false;
     }
 
+    // FlushStateToDisk generates a SetBestChain callback, which we should avoid missing
+    FlushStateToDisk();
+
+    // After there are no more peers/RPC left to give us new data which may generate
+    // CValidationInterface callbacks, flush them...
+    GetMainSignals().FlushBackgroundCallbacks();
+
+    // Any future callbacks will be dropped. This should absolutely be safe - if
+    // missing a callback results in an unrecoverable situation, unclean shutdown
+    // would too. The only reason to do the above flushes is to let the wallet catch
+    // up with our current chain to avoid any strange pruning edge cases and make
+    // next startup faster by avoiding rescan.
+
     {
         LOCK(cs_main);
         if (pcoinsTip != NULL) {
diff --git a/src/scheduler.cpp b/src/scheduler.cpp
@@ -191,3 +191,12 @@ void SingleThreadedSchedulerClient::AddToProcessQueue(std::function<void (void)>
     }
     MaybeScheduleProcessQueue();
 }
+
+void SingleThreadedSchedulerClient::EmptyQueue() {
+    bool should_continue = true;
+    while (should_continue) {
+        ProcessQueue();
+        LOCK(m_cs_callbacks_pending);
+        should_continue = !m_callbacks_pending.empty();
+    }
+}
diff --git a/src/scheduler.h b/src/scheduler.h
@@ -101,6 +101,9 @@ class SingleThreadedSchedulerClient {
 public:
     SingleThreadedSchedulerClient(CScheduler *pschedulerIn) : m_pscheduler(pschedulerIn) {}
     void AddToProcessQueue(std::function<void (void)> func);
+
+    // Processes all remaining queue members on the calling thread, blocking until queue is empty
+    void EmptyQueue();
 };
 
 #endif
diff --git a/src/test/test_bitcoin.cpp b/src/test/test_bitcoin.cpp
@@ -94,6 +94,7 @@ TestingSetup::~TestingSetup()
         UnregisterNodeSignals(GetNodeSignals());
         threadGroup.interrupt_all();
         threadGroup.join_all();
+        GetMainSignals().FlushBackgroundCallbacks();
         GetMainSignals().UnregisterBackgroundSignalScheduler();
         UnloadBlockIndex();
         delete pcoinsTip;
diff --git a/src/validationinterface.cpp b/src/validationinterface.cpp
@@ -44,6 +44,10 @@ void CMainSignals::UnregisterBackgroundSignalScheduler() {
     m_internals.reset(nullptr);
 }
 
+void CMainSignals::FlushBackgroundCallbacks() {
+    m_internals->m_schedulerClient.EmptyQueue();
+}
+
 CMainSignals& GetMainSignals()
 {
     return g_signals;
diff --git a/src/validationinterface.h b/src/validationinterface.h
@@ -79,6 +79,8 @@ class CMainSignals {
     void RegisterBackgroundSignalScheduler(CScheduler& scheduler);
     /** Unregister a CScheduler to give callbacks which should run in the background - these callbacks will now be dropped! */
     void UnregisterBackgroundSignalScheduler();
+    /** Call any remaining callbacks on the calling thread */
+    void FlushBackgroundCallbacks();
 
     void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload);
     void TransactionAddedToMempool(const CTransactionRef &);

Original file line number	Diff line number	Diff line change
`@@ -191,3 +191,12 @@ void SingleThreadedSchedulerClient::AddToProcessQueue(std::function<void (void)>`
`191`	`191`	`}`
`192`	`192`	`MaybeScheduleProcessQueue();`
`193`	`193`	`}`
	`194`	`+`
	`195`	`+void SingleThreadedSchedulerClient::EmptyQueue() {`
	`196`	`+ bool should_continue = true;`
	`197`	`+ while (should_continue) {`
	`198`	`+ ProcessQueue();`
	`199`	`+ LOCK(m_cs_callbacks_pending);`
	`200`	`+ should_continue = !m_callbacks_pending.empty();`
	`201`	`+ }`
	`202`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,10 @@ void CMainSignals::UnregisterBackgroundSignalScheduler() {`
`44`	`44`	`m_internals.reset(nullptr);`
`45`	`45`	`}`
`46`	`46`
	`47`	`+void CMainSignals::FlushBackgroundCallbacks() {`
	`48`	`+ m_internals->m_schedulerClient.EmptyQueue();`
	`49`	`+}`
	`50`	`+`
`47`	`51`	`CMainSignals& GetMainSignals()`
`48`	`52`	`{`
`49`	`53`	`return g_signals;`