miner: Avoid stack-use-after-return in validationinterface

MarcoFalke · MarcoFalke · commit 7777f2a4bb1f · 2020-05-13T19:58:20.000-04:00
This is achieved by switching to a shared_ptr.

Also, switch the validationinterfaces in the tests to use shared_ptrs
for the same reason.
diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp
@@ -874,7 +874,7 @@ static UniValue getblocktemplate(const JSONRPCRequest& request)
     return result;
 }
 
-class submitblock_StateCatcher : public CValidationInterface
+class submitblock_StateCatcher final : public CValidationInterface
 {
 public:
     uint256 hash;
@@ -942,17 +942,17 @@ static UniValue submitblock(const JSONRPCRequest& request)
     }
 
     bool new_block;
-    submitblock_StateCatcher sc(block.GetHash());
-    RegisterValidationInterface(&sc);
+    auto sc = std::make_shared<submitblock_StateCatcher>(block.GetHash());
+    RegisterSharedValidationInterface(sc);
     bool accepted = ProcessNewBlock(Params(), blockptr, /* fForceProcessing */ true, /* fNewBlock */ &new_block);
-    UnregisterValidationInterface(&sc);
+    UnregisterSharedValidationInterface(sc);
     if (!new_block && accepted) {
         return "duplicate";
     }
-    if (!sc.found) {
+    if (!sc->found) {
         return "inconclusive";
     }
-    return BIP22ValidationResult(sc.state);
+    return BIP22ValidationResult(sc->state);
 }
 
 static UniValue submitheader(const JSONRPCRequest& request)
diff --git a/src/test/validation_block_tests.cpp b/src/test/validation_block_tests.cpp
@@ -32,7 +32,7 @@ struct MinerTestingSetup : public RegTestingSetup {
 
 BOOST_FIXTURE_TEST_SUITE(validation_block_tests, MinerTestingSetup)
 
-struct TestSubscriber : public CValidationInterface {
+struct TestSubscriber final : public CValidationInterface {
     uint256 m_expected_tip;
 
     explicit TestSubscriber(uint256 tip) : m_expected_tip(tip) {}
@@ -175,8 +175,8 @@ BOOST_AUTO_TEST_CASE(processnewblock_signals_ordering)
         LOCK(cs_main);
         initial_tip = ::ChainActive().Tip();
     }
-    TestSubscriber sub(initial_tip->GetBlockHash());
-    RegisterValidationInterface(&sub);
+    auto sub = std::make_shared<TestSubscriber>(initial_tip->GetBlockHash());
+    RegisterSharedValidationInterface(sub);
 
     // create a bunch of threads that repeatedly process a block generated above at random
     // this will create parallelism and randomness inside validation - the ValidationInterface
@@ -206,10 +206,10 @@ BOOST_AUTO_TEST_CASE(processnewblock_signals_ordering)
     }
     SyncWithValidationInterfaceQueue();
 
-    UnregisterValidationInterface(&sub);
+    UnregisterSharedValidationInterface(sub);
 
     LOCK(cs_main);
-    BOOST_CHECK_EQUAL(sub.m_expected_tip, ::ChainActive().Tip()->GetBlockHash());
+    BOOST_CHECK_EQUAL(sub->m_expected_tip, ::ChainActive().Tip()->GetBlockHash());
 }
 
 /**
diff --git a/src/test/validationinterface_tests.cpp b/src/test/validationinterface_tests.cpp
@@ -12,7 +12,6 @@
 
 BOOST_FIXTURE_TEST_SUITE(validationinterface_tests, TestingSetup)
 
-/**
 struct TestSubscriberNoop final : public CValidationInterface {
     void BlockChecked(const CBlock&, const BlockValidationState&) override {}
 };
@@ -34,9 +33,9 @@ BOOST_AUTO_TEST_CASE(unregister_validation_interface_race)
     std::thread sub{[&] {
         // keep going for about 1 sec, which is 250k iterations
         for (int i = 0; i < 250000; i++) {
-            TestSubscriberNoop sub{};
-            RegisterValidationInterface(&sub);
-            UnregisterValidationInterface(&sub);
+            auto sub = std::make_shared<TestSubscriberNoop>();
+            RegisterSharedValidationInterface(sub);
+            UnregisterSharedValidationInterface(sub);
         }
         // tell the other thread we are done
         generate = false;
@@ -46,7 +45,6 @@ BOOST_AUTO_TEST_CASE(unregister_validation_interface_race)
     sub.join();
     BOOST_CHECK(!generate);
 }
-*/
 
 class TestInterface : public CValidationInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -874,7 +874,7 @@ static UniValue getblocktemplate(const JSONRPCRequest& request)`
`874`	`874`	`return result;`
`875`	`875`	`}`
`876`	`876`
`877`		`-class submitblock_StateCatcher : public CValidationInterface`
	`877`	`+class submitblock_StateCatcher final : public CValidationInterface`
`878`	`878`	`{`
`879`	`879`	`public:`
`880`	`880`	`uint256 hash;`
`@@ -942,17 +942,17 @@ static UniValue submitblock(const JSONRPCRequest& request)`
`942`	`942`	`}`
`943`	`943`
`944`	`944`	`bool new_block;`
`945`		`- submitblock_StateCatcher sc(block.GetHash());`
`946`		`- RegisterValidationInterface(&sc);`
	`945`	`+ auto sc = std::make_shared<submitblock_StateCatcher>(block.GetHash());`
	`946`	`+ RegisterSharedValidationInterface(sc);`
`947`	`947`	`bool accepted = ProcessNewBlock(Params(), blockptr, /* fForceProcessing / true, / fNewBlock */ &new_block);`
`948`		`- UnregisterValidationInterface(&sc);`
	`948`	`+ UnregisterSharedValidationInterface(sc);`
`949`	`949`	`if (!new_block && accepted) {`
`950`	`950`	`return "duplicate";`
`951`	`951`	`}`
`952`		`- if (!sc.found) {`
	`952`	`+ if (!sc->found) {`
`953`	`953`	`return "inconclusive";`
`954`	`954`	`}`
`955`		`- return BIP22ValidationResult(sc.state);`
	`955`	`+ return BIP22ValidationResult(sc->state);`
`956`	`956`	`}`
`957`	`957`
`958`	`958`	`static UniValue submitheader(const JSONRPCRequest& request)`