Branch data     Line data    Source code

       1                 :            : // Copyright (c) 2020 The Bitcoin Core developers
       2                 :            : // Distributed under the MIT software license, see the accompanying
       3                 :            : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :            : 
       5                 :            : #include <boost/test/unit_test.hpp>
       6                 :            : #include <consensus/validation.h>
       7                 :            : #include <primitives/block.h>
       8                 :            : #include <scheduler.h>
       9                 :            : #include <test/util/setup_common.h>
      10                 :            : #include <util/check.h>
      11                 :            : #include <kernel/chain.h>
      12                 :            : #include <validationinterface.h>
      13                 :            : 
      14                 :            : #include <atomic>
      15                 :            : 
      16                 :          0 : BOOST_FIXTURE_TEST_SUITE(validationinterface_tests, ChainTestingSetup)
      17                 :            : 
      18                 :            : struct TestSubscriberNoop final : public CValidationInterface {
      19                 :          0 :     void BlockChecked(const CBlock&, const BlockValidationState&) override {}
      20                 :            : };
      21                 :            : 
      22                 :          0 : BOOST_AUTO_TEST_CASE(unregister_validation_interface_race)
      23                 :            : {
      24                 :          0 :     std::atomic<bool> generate{true};
      25                 :            : 
      26                 :            :     // Start thread to generate notifications
      27                 :          0 :     std::thread gen{[&] {
      28                 :          0 :         const CBlock block_dummy;
      29                 :          0 :         BlockValidationState state_dummy;
      30                 :          0 :         while (generate) {
      31                 :          0 :             GetMainSignals().BlockChecked(block_dummy, state_dummy);
      32                 :            :         }
      33                 :          0 :     }};
      34                 :            : 
      35                 :            :     // Start thread to consume notifications
      36                 :          0 :     std::thread sub{[&] {
      37                 :            :         // keep going for about 1 sec, which is 250k iterations
      38                 :          0 :         for (int i = 0; i < 250000; i++) {
      39                 :          0 :             auto sub = std::make_shared<TestSubscriberNoop>();
      40                 :          0 :             RegisterSharedValidationInterface(sub);
      41                 :          0 :             UnregisterSharedValidationInterface(sub);
      42                 :          0 :         }
      43                 :            :         // tell the other thread we are done
      44                 :          0 :         generate = false;
      45                 :          0 :     }};
      46                 :            : 
      47                 :          0 :     gen.join();
      48                 :          0 :     sub.join();
      49                 :          0 :     BOOST_CHECK(!generate);
      50                 :          0 : }
      51                 :            : 
      52                 :            : class TestInterface : public CValidationInterface
      53                 :            : {
      54                 :            : public:
      55                 :          0 :     TestInterface(std::function<void()> on_call = nullptr, std::function<void()> on_destroy = nullptr)
      56                 :          0 :         : m_on_call(std::move(on_call)), m_on_destroy(std::move(on_destroy))
      57                 :          0 :     {
      58                 :          0 :     }
      59                 :          0 :     virtual ~TestInterface()
      60                 :          0 :     {
      61                 :          0 :         if (m_on_destroy) m_on_destroy();
      62                 :          0 :     }
      63                 :          0 :     void BlockChecked(const CBlock& block, const BlockValidationState& state) override
      64                 :            :     {
      65                 :          0 :         if (m_on_call) m_on_call();
      66                 :          0 :     }
      67                 :          0 :     static void Call()
      68                 :            :     {
      69                 :          0 :         CBlock block;
      70                 :          0 :         BlockValidationState state;
      71                 :          0 :         GetMainSignals().BlockChecked(block, state);
      72                 :          0 :     }
      73                 :            :     std::function<void()> m_on_call;
      74                 :          0 :     std::function<void()> m_on_destroy;
      75                 :            : };
      76                 :            : 
      77                 :            : // Regression test to ensure UnregisterAllValidationInterfaces calls don't
      78                 :            : // destroy a validation interface while it is being called. Bug:
      79                 :            : // https://github.com/bitcoin/bitcoin/pull/18551
      80                 :          0 : BOOST_AUTO_TEST_CASE(unregister_all_during_call)
      81                 :            : {
      82                 :          0 :     bool destroyed = false;
      83                 :          0 :     RegisterSharedValidationInterface(std::make_shared<TestInterface>(
      84                 :          0 :         [&] {
      85                 :            :             // First call should decrements reference count 2 -> 1
      86                 :          0 :             UnregisterAllValidationInterfaces();
      87                 :          0 :             BOOST_CHECK(!destroyed);
      88                 :            :             // Second call should not decrement reference count 1 -> 0
      89                 :          0 :             UnregisterAllValidationInterfaces();
      90                 :          0 :             BOOST_CHECK(!destroyed);
      91                 :          0 :         },
      92                 :          0 :         [&] { destroyed = true; }));
      93                 :          0 :     TestInterface::Call();
      94                 :          0 :     BOOST_CHECK(destroyed);
      95                 :          0 : }
      96                 :            : 
      97                 :          0 : BOOST_AUTO_TEST_SUITE_END()