mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-12-05 10:12:48 +01:00
test: add cache entry linked list tests
Co-Authored-By: l0rinc <pap.lorinc@gmail.com>
This commit is contained in:
Andrew Toth
219
src/test/coinscachepair_tests.cpp
Normal file
219
src/test/coinscachepair_tests.cpp
Normal file
@@ -0,0 +1,219 @@
|
||||
// Copyright (c) 2024-present The Bitcoin Core developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#include <coins.h>
|
||||
|
||||
#include <boost/test/unit_test.hpp>
|
||||
|
||||
#include <list>
|
||||
|
||||
BOOST_AUTO_TEST_SUITE(coinscachepair_tests)
|
||||
|
||||
static constexpr auto NUM_NODES{4};
|
||||
|
||||
std::list<CoinsCachePair> CreatePairs(CoinsCachePair& sentinel)
|
||||
{
|
||||
std::list<CoinsCachePair> nodes;
|
||||
for (auto i{0}; i < NUM_NODES; ++i) {
|
||||
nodes.emplace_back();
|
||||
|
||||
auto node{std::prev(nodes.end())};
|
||||
node->second.AddFlags(CCoinsCacheEntry::DIRTY, *node, sentinel);
|
||||
|
||||
BOOST_CHECK_EQUAL(node->second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(node->second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &(*node));
|
||||
|
||||
if (i > 0) {
|
||||
BOOST_CHECK_EQUAL(std::prev(node)->second.Next(), &(*node));
|
||||
BOOST_CHECK_EQUAL(node->second.Prev(), &(*std::prev(node)));
|
||||
}
|
||||
}
|
||||
return nodes;
|
||||
}
|
||||
|
||||
BOOST_AUTO_TEST_CASE(linked_list_iteration)
|
||||
{
|
||||
CoinsCachePair sentinel;
|
||||
sentinel.second.SelfRef(sentinel);
|
||||
auto nodes{CreatePairs(sentinel)};
|
||||
|
||||
// Check iterating through pairs is identical to iterating through a list
|
||||
auto node{sentinel.second.Next()};
|
||||
for (const auto& expected : nodes) {
|
||||
BOOST_CHECK_EQUAL(&expected, node);
|
||||
node = node->second.Next();
|
||||
}
|
||||
BOOST_CHECK_EQUAL(node, &sentinel);
|
||||
|
||||
// Check iterating through pairs is identical to iterating through a list
|
||||
// Clear the flags during iteration
|
||||
node = sentinel.second.Next();
|
||||
for (const auto& expected : nodes) {
|
||||
BOOST_CHECK_EQUAL(&expected, node);
|
||||
auto next = node->second.Next();
|
||||
node->second.ClearFlags();
|
||||
node = next;
|
||||
}
|
||||
BOOST_CHECK_EQUAL(node, &sentinel);
|
||||
// Check that sentinel's next and prev are itself
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
|
||||
|
||||
// Delete the nodes from the list to make sure there are no dangling pointers
|
||||
for (auto it{nodes.begin()}; it != nodes.end(); it = nodes.erase(it)) {
|
||||
BOOST_CHECK_EQUAL(it->second.GetFlags(), 0);
|
||||
}
|
||||
}
|
||||
|
||||
BOOST_AUTO_TEST_CASE(linked_list_iterate_erase)
|
||||
{
|
||||
CoinsCachePair sentinel;
|
||||
sentinel.second.SelfRef(sentinel);
|
||||
auto nodes{CreatePairs(sentinel)};
|
||||
|
||||
// Check iterating through pairs is identical to iterating through a list
|
||||
// Erase the nodes as we iterate through, but don't clear flags
|
||||
// The flags will be cleared by the CCoinsCacheEntry's destructor
|
||||
auto node{sentinel.second.Next()};
|
||||
for (auto expected{nodes.begin()}; expected != nodes.end(); expected = nodes.erase(expected)) {
|
||||
BOOST_CHECK_EQUAL(&(*expected), node);
|
||||
node = node->second.Next();
|
||||
}
|
||||
BOOST_CHECK_EQUAL(node, &sentinel);
|
||||
|
||||
// Check that sentinel's next and prev are itself
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
|
||||
}
|
||||
|
||||
BOOST_AUTO_TEST_CASE(linked_list_random_deletion)
|
||||
{
|
||||
CoinsCachePair sentinel;
|
||||
sentinel.second.SelfRef(sentinel);
|
||||
auto nodes{CreatePairs(sentinel)};
|
||||
|
||||
// Create linked list sentinel->n1->n2->n3->n4->sentinel
|
||||
auto n1{nodes.begin()};
|
||||
auto n2{std::next(n1)};
|
||||
auto n3{std::next(n2)};
|
||||
auto n4{std::next(n3)};
|
||||
|
||||
// Delete n2
|
||||
// sentinel->n1->n3->n4->sentinel
|
||||
nodes.erase(n2);
|
||||
// Check that n1 now points to n3, and n3 still points to n4
|
||||
// Also check that flags were not altered
|
||||
BOOST_CHECK_EQUAL(n1->second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(n1->second.Next(), &(*n3));
|
||||
BOOST_CHECK_EQUAL(n3->second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(n3->second.Next(), &(*n4));
|
||||
BOOST_CHECK_EQUAL(n3->second.Prev(), &(*n1));
|
||||
|
||||
// Delete n1
|
||||
// sentinel->n3->n4->sentinel
|
||||
nodes.erase(n1);
|
||||
// Check that sentinel now points to n3, and n3 still points to n4
|
||||
// Also check that flags were not altered
|
||||
BOOST_CHECK_EQUAL(n3->second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &(*n3));
|
||||
BOOST_CHECK_EQUAL(n3->second.Next(), &(*n4));
|
||||
BOOST_CHECK_EQUAL(n3->second.Prev(), &sentinel);
|
||||
|
||||
// Delete n4
|
||||
// sentinel->n3->sentinel
|
||||
nodes.erase(n4);
|
||||
// Check that sentinel still points to n3, and n3 points to sentinel
|
||||
// Also check that flags were not altered
|
||||
BOOST_CHECK_EQUAL(n3->second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &(*n3));
|
||||
BOOST_CHECK_EQUAL(n3->second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &(*n3));
|
||||
|
||||
// Delete n3
|
||||
// sentinel->sentinel
|
||||
nodes.erase(n3);
|
||||
// Check that sentinel's next and prev are itself
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
|
||||
}
|
||||
|
||||
BOOST_AUTO_TEST_CASE(linked_list_add_flags)
|
||||
{
|
||||
CoinsCachePair sentinel;
|
||||
sentinel.second.SelfRef(sentinel);
|
||||
CoinsCachePair n1;
|
||||
CoinsCachePair n2;
|
||||
|
||||
// Check that adding 0 flag has no effect
|
||||
n1.second.AddFlags(0, n1, sentinel);
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), 0);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &sentinel);
|
||||
|
||||
// Check that adding DIRTY flag inserts it into linked list and sets flags
|
||||
n1.second.AddFlags(CCoinsCacheEntry::DIRTY, n1, sentinel);
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(n1.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(n1.second.Prev(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &n1);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n1);
|
||||
|
||||
// Check that adding FRESH flag on new node inserts it after n1
|
||||
n2.second.AddFlags(CCoinsCacheEntry::FRESH, n2, sentinel);
|
||||
BOOST_CHECK_EQUAL(n2.second.GetFlags(), CCoinsCacheEntry::FRESH);
|
||||
BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(n2.second.Prev(), &n1);
|
||||
BOOST_CHECK_EQUAL(n1.second.Next(), &n2);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
|
||||
|
||||
// Check that adding 0 flag has no effect, and doesn't change position
|
||||
n1.second.AddFlags(0, n1, sentinel);
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(n1.second.Next(), &n2);
|
||||
BOOST_CHECK_EQUAL(n1.second.Prev(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &n1);
|
||||
BOOST_CHECK_EQUAL(n2.second.Prev(), &n1);
|
||||
|
||||
// Check that we can add extra flags, but they don't change our position
|
||||
n1.second.AddFlags(CCoinsCacheEntry::FRESH, n1, sentinel);
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), CCoinsCacheEntry::DIRTY | CCoinsCacheEntry::FRESH);
|
||||
BOOST_CHECK_EQUAL(n1.second.Next(), &n2);
|
||||
BOOST_CHECK_EQUAL(n1.second.Prev(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &n1);
|
||||
BOOST_CHECK_EQUAL(n2.second.Prev(), &n1);
|
||||
|
||||
// Check that we can clear flags then re-add them
|
||||
n1.second.ClearFlags();
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), 0);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &n2);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
|
||||
BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(n2.second.Prev(), &sentinel);
|
||||
|
||||
// Check that calling `ClearFlags` with 0 flags has no effect
|
||||
n1.second.ClearFlags();
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), 0);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &n2);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
|
||||
BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(n2.second.Prev(), &sentinel);
|
||||
|
||||
// Adding 0 still has no effect
|
||||
n1.second.AddFlags(0, n1, sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Next(), &n2);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n2);
|
||||
BOOST_CHECK_EQUAL(n2.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(n2.second.Prev(), &sentinel);
|
||||
|
||||
// But adding DIRTY re-inserts it after n2
|
||||
n1.second.AddFlags(CCoinsCacheEntry::DIRTY, n1, sentinel);
|
||||
BOOST_CHECK_EQUAL(n1.second.GetFlags(), CCoinsCacheEntry::DIRTY);
|
||||
BOOST_CHECK_EQUAL(n2.second.Next(), &n1);
|
||||
BOOST_CHECK_EQUAL(n1.second.Prev(), &n2);
|
||||
BOOST_CHECK_EQUAL(n1.second.Next(), &sentinel);
|
||||
BOOST_CHECK_EQUAL(sentinel.second.Prev(), &n1);
|
||||
}
|
||||
|
||||
BOOST_AUTO_TEST_SUITE_END()
|
||||
Reference in New Issue
Block a user