Branch data Line data Source code
1 : : // Copyright (c) 2022-present 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 <chain.h>
6 : : #include <chainparams.h>
7 : : #include <clientversion.h>
8 : : #include <node/blockstorage.h>
9 : : #include <node/context.h>
10 : : #include <node/kernel_notifications.h>
11 : : #include <script/solver.h>
12 : : #include <primitives/block.h>
13 : : #include <util/chaintype.h>
14 : : #include <validation.h>
15 : :
16 : : #include <boost/test/unit_test.hpp>
17 : : #include <test/util/common.h>
18 : : #include <test/util/logging.h>
19 : : #include <test/util/setup_common.h>
20 : :
21 : : using kernel::CBlockFileInfo;
22 : : using node::STORAGE_HEADER_BYTES;
23 : : using node::BlockManager;
24 : : using node::KernelNotifications;
25 : : using node::MAX_BLOCKFILE_SIZE;
26 : :
27 : : // use BasicTestingSetup here for the data directory configuration, setup, and cleanup
28 : : BOOST_FIXTURE_TEST_SUITE(blockmanager_tests, BasicTestingSetup)
29 : :
30 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(blockmanager_find_block_pos)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
31 : : {
32 [ + - ]: 1 : const auto params {CreateChainParams(ArgsManager{}, ChainType::MAIN)};
33 [ - + - + ]: 1 : KernelNotifications notifications{Assert(m_node.shutdown_request), m_node.exit_status, *Assert(m_node.warnings)};
34 [ + - ]: 1 : const BlockManager::Options blockman_opts{
35 : 1 : .chainparams = *params,
36 : : .blocks_dir = m_args.GetBlocksDirPath(),
37 : : .notifications = notifications,
38 : : .block_tree_db_params = DBParams{
39 [ + - ]: 2 : .path = m_args.GetDataDirNet() / "blocks" / "index",
40 : : .cache_bytes = 0,
41 : : },
42 [ + - + - ]: 2 : };
43 [ - + + - : 1 : BlockManager blockman{*Assert(m_node.shutdown_signal), blockman_opts};
+ - ]
44 : : // simulate adding a genesis block normally
45 [ + - ]: 1 : LOCK(::cs_main);
46 [ + - + - : 1 : BOOST_CHECK_EQUAL(blockman.WriteBlock(params->GenesisBlock(), 0).nPos, STORAGE_HEADER_BYTES);
+ - ]
47 : : // simulate what happens during reindex
48 : : // simulate a well-formed genesis block being found at offset 8 in the blk00000.dat file
49 : : // the block is found at offset 8 because there is an 8 byte serialization header
50 : : // consisting of 4 magic bytes + 4 length bytes before each block in a well-formed blk file.
51 [ + - ]: 1 : const FlatFilePos pos{0, STORAGE_HEADER_BYTES};
52 [ + - ]: 1 : blockman.UpdateBlockInfo(params->GenesisBlock(), 0, pos);
53 : : // now simulate what happens after reindex for the first new block processed
54 : : // the actual block contents don't matter, just that it's a block.
55 : : // verify that the write position is at offset 0x12d.
56 : : // this is a check to make sure that https://github.com/bitcoin/bitcoin/issues/21379 does not recur
57 : : // 8 bytes (for serialization header) + 285 (for serialized genesis block) = 293
58 : : // add another 8 bytes for the second block's serialization header and we get 293 + 8 = 301
59 [ + - ]: 1 : FlatFilePos actual{blockman.WriteBlock(params->GenesisBlock(), 1)};
60 [ + - + - : 1 : BOOST_CHECK_EQUAL(actual.nPos, STORAGE_HEADER_BYTES + ::GetSerializeSize(TX_WITH_WITNESS(params->GenesisBlock())) + STORAGE_HEADER_BYTES);
+ - ]
61 : 1 : }
62 : :
63 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockmanager_scan_unlink_already_pruned_files, TestChain100Setup)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
64 : : {
65 : : // Cap last block file size, and mine new block in a new block file.
66 [ - + ]: 1 : auto& chainman{*Assert(m_node.chainman)};
67 : 1 : auto& blockman{chainman.m_blockman};
68 [ + - - + : 4 : const CBlockIndex* old_tip{WITH_LOCK(chainman.GetMutex(), return chainman.ActiveChain().Tip())};
+ - ]
69 [ + - + - ]: 3 : WITH_LOCK(chainman.GetMutex(), blockman.GetBlockFileInfo(old_tip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE);
70 [ + - ]: 2 : CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
71 : :
72 : : // Prune the older block file, but don't unlink it
73 : 1 : int file_number;
74 : 1 : {
75 : 1 : LOCK(chainman.GetMutex());
76 : 1 : file_number = old_tip->GetBlockPos().nFile;
77 [ + - ]: 1 : blockman.PruneOneBlockFile(file_number);
78 : 0 : }
79 : :
80 : 1 : const FlatFilePos pos(file_number, 0);
81 : :
82 : : // Check that the file is not unlinked after ScanAndUnlinkAlreadyPrunedFiles
83 : : // if m_have_pruned is not yet set
84 [ + - ]: 3 : WITH_LOCK(chainman.GetMutex(), blockman.ScanAndUnlinkAlreadyPrunedFiles());
85 [ + - + - ]: 2 : BOOST_CHECK(!blockman.OpenBlockFile(pos, true).IsNull());
86 : :
87 : : // Check that the file is unlinked after ScanAndUnlinkAlreadyPrunedFiles
88 : : // once m_have_pruned is set
89 : 1 : blockman.m_have_pruned = true;
90 [ + - ]: 3 : WITH_LOCK(chainman.GetMutex(), blockman.ScanAndUnlinkAlreadyPrunedFiles());
91 [ + - + - ]: 2 : BOOST_CHECK(blockman.OpenBlockFile(pos, true).IsNull());
92 : :
93 : : // Check that calling with already pruned files doesn't cause an error
94 [ + - ]: 3 : WITH_LOCK(chainman.GetMutex(), blockman.ScanAndUnlinkAlreadyPrunedFiles());
95 : :
96 : : // Check that the new tip file has not been removed
97 [ + - - + : 4 : const CBlockIndex* new_tip{WITH_LOCK(chainman.GetMutex(), return chainman.ActiveChain().Tip())};
+ - ]
98 [ + - ]: 1 : BOOST_CHECK_NE(old_tip, new_tip);
99 [ + - ]: 2 : const int new_file_number{WITH_LOCK(chainman.GetMutex(), return new_tip->GetBlockPos().nFile)};
100 : 1 : const FlatFilePos new_pos(new_file_number, 0);
101 [ + - + - ]: 2 : BOOST_CHECK(!blockman.OpenBlockFile(new_pos, true).IsNull());
102 : 1 : }
103 : :
104 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockmanager_block_data_availability, TestChain100Setup)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
105 : : {
106 : : // The goal of the function is to return the first not pruned block in the range [upper_block, lower_block].
107 : 1 : LOCK(::cs_main);
108 : 1 : auto& chainman = m_node.chainman;
109 [ + - ]: 1 : auto& blockman = chainman->m_blockman;
110 [ + - ]: 1 : const CBlockIndex& tip = *chainman->ActiveTip();
111 : :
112 : : // Function to prune all blocks from 'last_pruned_block' down to the genesis block
113 : 2 : const auto& func_prune_blocks = [&](CBlockIndex* last_pruned_block)
114 : : {
115 : 1 : LOCK(::cs_main);
116 : 1 : CBlockIndex* it = last_pruned_block;
117 [ + + + - ]: 53 : while (it != nullptr && it->nStatus & BLOCK_HAVE_DATA) {
118 : 51 : it->nStatus &= ~BLOCK_HAVE_DATA;
119 : 51 : it = it->pprev;
120 : : }
121 : 1 : };
122 : :
123 : : // 1) Return genesis block when all blocks are available
124 [ + - + - : 2 : BOOST_CHECK_EQUAL(&blockman.GetFirstBlock(tip, BLOCK_HAVE_DATA), chainman->ActiveChain()[0]);
- + + - +
- ]
125 [ + - + - : 3 : BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *chainman->ActiveChain()[0]));
- + + - +
- + - ]
126 : :
127 : : // 2) Check lower_block when all blocks are available
128 [ + - + - ]: 1 : CBlockIndex* lower_block = chainman->ActiveChain()[tip.nHeight / 2];
129 [ + - + - : 2 : BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *lower_block));
+ - + - ]
130 : :
131 : : // Ensure we don't fail due to the expected absence of undo data in the genesis block
132 [ + - - + ]: 1 : CBlockIndex* upper_block = chainman->ActiveChain()[2];
133 [ + - - + ]: 1 : CBlockIndex* genesis = chainman->ActiveChain()[0];
134 [ + - + - : 2 : BOOST_CHECK(blockman.CheckBlockDataAvailability(*upper_block, *genesis, BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO}));
+ - + - ]
135 : : // Ensure we detect absence of undo data in the first block
136 [ + - - + ]: 1 : chainman->ActiveChain()[1]->nStatus &= ~BLOCK_HAVE_UNDO;
137 [ + - + - : 2 : BOOST_CHECK(!blockman.CheckBlockDataAvailability(tip, *genesis, BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO}));
+ - + - ]
138 : :
139 : : // Prune half of the blocks
140 : 1 : int height_to_prune = tip.nHeight / 2;
141 [ + - + - ]: 1 : CBlockIndex* first_available_block = chainman->ActiveChain()[height_to_prune + 1];
142 : 1 : CBlockIndex* last_pruned_block = first_available_block->pprev;
143 [ + - ]: 1 : func_prune_blocks(last_pruned_block);
144 : :
145 : : // 3) The last block not pruned is in-between upper-block and the genesis block
146 [ + - + - : 1 : BOOST_CHECK_EQUAL(&blockman.GetFirstBlock(tip, BLOCK_HAVE_DATA), first_available_block);
+ - ]
147 [ + - + - : 2 : BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *first_available_block));
+ - + - ]
148 [ + - + - : 2 : BOOST_CHECK(!blockman.CheckBlockDataAvailability(tip, *last_pruned_block));
+ - + - ]
149 : :
150 : : // Simulate that the first available block is missing undo data and
151 : : // detect this by using a status mask.
152 : 1 : first_available_block->nStatus &= ~BLOCK_HAVE_UNDO;
153 [ + - + - : 2 : BOOST_CHECK(!blockman.CheckBlockDataAvailability(tip, *first_available_block, BlockStatus{BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO}));
+ - + - ]
154 [ + - + - : 2 : BOOST_CHECK(blockman.CheckBlockDataAvailability(tip, *first_available_block, BlockStatus{BLOCK_HAVE_DATA}));
+ - + - ]
155 : 1 : }
156 : :
157 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockmanager_block_data_part, TestChain100Setup)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
158 : : {
159 : 1 : LOCK(::cs_main);
160 : 1 : auto& chainman{m_node.chainman};
161 [ + - ]: 1 : auto& blockman{chainman->m_blockman};
162 [ + - ]: 1 : const CBlockIndex& tip{*chainman->ActiveTip()};
163 : 1 : const FlatFilePos tip_block_pos{tip.GetBlockPos()};
164 : :
165 [ + - ]: 1 : auto block{blockman.ReadRawBlock(tip_block_pos)};
166 [ + - + - : 2 : BOOST_REQUIRE(block);
+ - ]
167 [ + - - + : 1 : BOOST_REQUIRE_GE(block->size(), 200);
+ - ]
168 : :
169 : 8 : const auto expect_part{[&](size_t offset, size_t size) {
170 : 7 : auto res{blockman.ReadRawBlock(tip_block_pos, std::pair{offset, size})};
171 [ + - + - : 14 : BOOST_CHECK(res);
+ - ]
172 [ + - ]: 7 : const auto& part{res.value()};
173 [ + - + - : 14 : BOOST_CHECK_EQUAL_COLLECTIONS(part.begin(), part.end(), block->begin() + offset, block->begin() + offset + size);
+ - ]
174 : 8 : }};
175 : :
176 [ + - ]: 1 : expect_part(0, 20);
177 [ - + + - ]: 1 : expect_part(0, block->size() - 1);
178 [ - + + - ]: 1 : expect_part(0, block->size() - 10);
179 [ - + + - ]: 1 : expect_part(0, block->size());
180 [ - + + - ]: 1 : expect_part(1, block->size() - 1);
181 [ + - ]: 1 : expect_part(10, 20);
182 [ - + + - ]: 1 : expect_part(block->size() - 1, 1);
183 [ + - ]: 2 : }
184 : :
185 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockmanager_block_data_part_error, TestChain100Setup)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
186 : : {
187 : 1 : LOCK(::cs_main);
188 : 1 : auto& chainman{m_node.chainman};
189 [ + - ]: 1 : auto& blockman{chainman->m_blockman};
190 [ + - ]: 1 : const CBlockIndex& tip{*chainman->ActiveTip()};
191 : 1 : const FlatFilePos tip_block_pos{tip.GetBlockPos()};
192 : :
193 [ + - ]: 1 : auto block{blockman.ReadRawBlock(tip_block_pos)};
194 [ + - + - : 2 : BOOST_REQUIRE(block);
+ - ]
195 [ + - - + : 1 : BOOST_REQUIRE_GE(block->size(), 200);
+ - ]
196 : :
197 : 15 : const auto expect_part_error{[&](size_t offset, size_t size) {
198 : 14 : auto res{blockman.ReadRawBlock(tip_block_pos, std::pair{offset, size})};
199 [ + - + - : 28 : BOOST_CHECK(!res);
+ - ]
200 [ + - + - ]: 14 : BOOST_CHECK_EQUAL(res.error(), node::ReadRawError::BadPartRange);
201 : 15 : }};
202 : :
203 [ + - ]: 1 : expect_part_error(0, 0);
204 [ - + + - ]: 1 : expect_part_error(0, block->size() + 1);
205 [ + - ]: 1 : expect_part_error(0, std::numeric_limits<size_t>::max());
206 [ - + + - ]: 1 : expect_part_error(1, block->size());
207 [ - + + - ]: 1 : expect_part_error(2, block->size() - 1);
208 [ - + + - ]: 1 : expect_part_error(block->size() - 1, 2);
209 [ - + + - ]: 1 : expect_part_error(block->size() - 2, 3);
210 [ - + + - ]: 1 : expect_part_error(block->size() + 1, 0);
211 [ - + + - ]: 1 : expect_part_error(block->size() + 1, 1);
212 [ - + + - ]: 1 : expect_part_error(block->size() + 2, 2);
213 [ - + + - ]: 1 : expect_part_error(block->size(), 0);
214 [ - + + - ]: 1 : expect_part_error(block->size(), 1);
215 [ + - ]: 1 : expect_part_error(std::numeric_limits<size_t>::max(), 1);
216 [ + - ]: 1 : expect_part_error(std::numeric_limits<size_t>::max(), std::numeric_limits<size_t>::max());
217 [ + - ]: 2 : }
218 : :
219 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockmanager_readblock_hash_mismatch, TestingSetup)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
220 : : {
221 : 1 : CBlockIndex index;
222 : 1 : {
223 : 1 : LOCK(cs_main);
224 [ + - ]: 1 : const auto tip{m_node.chainman->ActiveTip()};
225 : 1 : index.nStatus = tip->nStatus;
226 : 1 : index.nDataPos = tip->nDataPos;
227 [ + - ]: 1 : index.phashBlock = &uint256::ONE; // mismatched block hash
228 : 0 : }
229 : :
230 [ + - + - ]: 2 : ASSERT_DEBUG_LOG("GetHash() doesn't match index");
231 : 1 : CBlock block;
232 [ + - + - : 2 : BOOST_CHECK(!m_node.chainman->m_blockman.ReadBlock(block, index));
+ - ]
233 : 1 : }
234 : :
235 [ + - + - : 7 : BOOST_AUTO_TEST_CASE(blockmanager_flush_block_file)
+ - + - -
+ - + + -
+ - + - +
- + - + -
- + - + +
- + - + -
+ - + - +
- - + - +
+ - + - +
- + - + -
+ - + - -
+ - + + -
+ - + - +
- + - + -
- + - + +
- ]
236 : : {
237 [ - + - + ]: 1 : KernelNotifications notifications{Assert(m_node.shutdown_request), m_node.exit_status, *Assert(m_node.warnings)};
238 : 1 : node::BlockManager::Options blockman_opts{
239 [ + - ]: 1 : .chainparams = Params(),
240 : : .blocks_dir = m_args.GetBlocksDirPath(),
241 : : .notifications = notifications,
242 : : .block_tree_db_params = DBParams{
243 [ + - ]: 2 : .path = m_args.GetDataDirNet() / "blocks" / "index",
244 : : .cache_bytes = 0,
245 : : },
246 [ + - + - ]: 2 : };
247 [ - + + - : 1 : BlockManager blockman{*Assert(m_node.shutdown_signal), blockman_opts};
+ - ]
248 : :
249 : : // Test blocks with no transactions, not even a coinbase
250 : 1 : CBlock block1;
251 : 1 : block1.nVersion = 1;
252 : 1 : CBlock block2;
253 : 1 : block2.nVersion = 2;
254 : 1 : CBlock block3;
255 : 1 : block3.nVersion = 3;
256 : :
257 : : // They are 80 bytes header + 1 byte 0x00 for vtx length
258 : 1 : constexpr int TEST_BLOCK_SIZE{81};
259 : :
260 : : // Blockstore is empty
261 [ + - ]: 1 : LOCK(::cs_main);
262 [ + - + - : 1 : BOOST_CHECK_EQUAL(blockman.CalculateCurrentUsage(), 0);
+ - ]
263 : :
264 : : // Write the first block to a new location.
265 [ + - ]: 1 : FlatFilePos pos1{blockman.WriteBlock(block1, /*nHeight=*/1)};
266 : :
267 : : // Write second block
268 [ + - ]: 1 : FlatFilePos pos2{blockman.WriteBlock(block2, /*nHeight=*/2)};
269 : :
270 : : // Two blocks in the file
271 [ + - + - : 1 : BOOST_CHECK_EQUAL(blockman.CalculateCurrentUsage(), (TEST_BLOCK_SIZE + STORAGE_HEADER_BYTES) * 2);
+ - ]
272 : :
273 : : // First two blocks are written as expected
274 : : // Errors are expected because block data is junk, thrown AFTER successful read
275 : 1 : CBlock read_block;
276 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(read_block.nVersion, 0);
277 : 1 : {
278 [ + - + - ]: 2 : ASSERT_DEBUG_LOG("Errors in block header");
279 [ + - + - : 2 : BOOST_CHECK(!blockman.ReadBlock(read_block, pos1, {}));
+ - + - ]
280 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(read_block.nVersion, 1);
281 : 1 : }
282 : 1 : {
283 [ + - + - ]: 2 : ASSERT_DEBUG_LOG("Errors in block header");
284 [ + - + - : 2 : BOOST_CHECK(!blockman.ReadBlock(read_block, pos2, {}));
+ - + - ]
285 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(read_block.nVersion, 2);
286 : 1 : }
287 : :
288 : : // During reindex, the flat file block storage will not be written to.
289 : : // UpdateBlockInfo will, however, update the blockfile metadata.
290 : : // Verify this behavior by attempting (and failing) to write block 3 data
291 : : // to block 2 location.
292 [ + - ]: 1 : CBlockFileInfo* block_data = blockman.GetBlockFileInfo(0);
293 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(block_data->nBlocks, 2);
294 [ + - ]: 1 : blockman.UpdateBlockInfo(block3, /*nHeight=*/3, /*pos=*/pos2);
295 : : // Metadata is updated...
296 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(block_data->nBlocks, 3);
297 : : // ...but there are still only two blocks in the file
298 [ + - + - : 1 : BOOST_CHECK_EQUAL(blockman.CalculateCurrentUsage(), (TEST_BLOCK_SIZE + STORAGE_HEADER_BYTES) * 2);
+ - ]
299 : :
300 : : // Block 2 was not overwritten:
301 [ + - + - : 2 : BOOST_CHECK(!blockman.ReadBlock(read_block, pos2, {}));
+ - + - ]
302 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(read_block.nVersion, 2);
303 [ + - ]: 2 : }
304 : :
305 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(prune_lock_update_and_delete, TestingSetup)
+ - + - -
+ + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- + - + -
+ - + - +
- + - - +
+ - + - +
- + - + -
+ - - + +
- ]
306 : : {
307 : 1 : LOCK(::cs_main);
308 [ - + + - ]: 1 : auto& chainman{*Assert(m_node.chainman)};
309 : 1 : auto& blockman{chainman.m_blockman};
310 : :
311 : : // Create a prune lock
312 [ + - + - ]: 1 : blockman.UpdatePruneLock("test_lock", node::PruneLockInfo{.height_first = 100});
313 : :
314 : : // Update it to a new height
315 [ + - + - ]: 1 : blockman.UpdatePruneLock("test_lock", node::PruneLockInfo{.height_first = 200});
316 : :
317 : : // Delete existing prune lock
318 [ + - + - : 2 : BOOST_CHECK(blockman.DeletePruneLock("test_lock"));
+ - + - +
- ]
319 : :
320 : : // Verify deletion worked by trying to delete the same lock again
321 [ + - + - : 2 : BOOST_CHECK(!blockman.DeletePruneLock("test_lock"));
+ - + - +
- ]
322 : :
323 : : // Deleting a non-existent lock returns false
324 [ + - + - : 2 : BOOST_CHECK(!blockman.DeletePruneLock("nonexistent"));
+ - + - +
- ]
325 : 1 : }
326 : :
327 : : BOOST_AUTO_TEST_SUITE_END()
|
