log: show reindex progress in `ImportBlocks` #33353

l0rinc commented at 7:08 PM on September 9, 2025: contributor

Summary

When triggering a reindex, users have no indication of progress.

Fix

This patch precomputes the total number of block files so progress can be shown. Instead of only displaying which block file is being processed, it now shows the percent complete.

Reproducer + expected results

cmake -B build -DCMAKE_BUILD_TYPE=Release && make -C build -j && ./build/bin/bitcoind -datadir=demo -reindex

Before, the block files were shown one-by-one, there's no way to see how much work is left:

Reindexing block file blk00000.dat...
Loaded 119920 blocks from external file in 1228ms
Reindexing block file blk00001.dat...
Loaded 10671 blocks from external file in 284ms
Reindexing block file blk00002.dat...
Loaded 5459 blocks from external file in 263ms
Reindexing block file blk00003.dat...
Loaded 5595 blocks from external file in 267ms

After the change we add a percentage:

Reindexing block file blk00000.dat (0% complete)...
Loaded 119920 blocks from external file in 1255ms
Reindexing block file blk00001.dat (1% complete)...
Loaded 10671 blocks from external file in 303ms
Reindexing block file blk00002.dat (2% complete)...
Loaded 5459 blocks from external file in 278ms
Reindexing block file blk00003.dat (3% complete)...
Loaded 5595 blocks from external file in 285ms

DrahtBot commented at 7:08 PM on September 9, 2025: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33353.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	rkrux, danielabrozzoni, maflcko
Concept ACK	Raimo33, enirox001

If your review is incorrectly listed, please copy-paste <code></code> into the comment that the bot should ignore.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#33854 (fix assumevalid is ignored during reindex by Eunovo)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

l0rinc renamed this:
~~logs: show reindex progress in `ImportBlocks`~~
log: show reindex progress in `ImportBlocks`
on Sep 9, 2025

DrahtBot added the label Utils/log/libs on Sep 9, 2025

logs: show reindex progress in `ImportBlocks`

### Summary

When triggering a reindex, users had no indication of how many files remained or how far along the process was.

### Fix

This patch prefetches the target file block file count to be able to show progress information.
Instead of just displaying which block file is being processed, it now indicates how many files remain.

### Reproducer + expected results

Running
```bash
cmake -B build && make -C build -DCMAKE_BUILD_TYPE=Release && ./build/bin/bitcoind -datadir=demo -reindex
```
Shows the block files one-by-one currently, there's no way to see how much work is left:
```
Reindexing block file blk00000.dat...
Loaded 119920 blocks from external file in 1228ms
Reindexing block file blk00001.dat...
Loaded 10671 blocks from external file in 284ms
Reindexing block file blk00002.dat...
Loaded 5459 blocks from external file in 263ms
Reindexing block file blk00003.dat...
Loaded 5595 blocks from external file in 267ms
```

After the change:
```
Reindexing block file blk00000.dat (0% complete)...
Loaded 119920 blocks from external file in 1255ms
Reindexing block file blk00001.dat (1% complete)...
Loaded 10671 blocks from external file in 303ms
Reindexing block file blk00002.dat (2% complete)...
Loaded 5459 blocks from external file in 278ms
Reindexing block file blk00003.dat (3% complete)...
Loaded 5595 blocks from external file in 285ms
```

d7de5b109f

l0rinc force-pushed on Sep 9, 2025

in src/node/blockstorage.cpp:1238 in d7de5b109f

1239 |              AutoFile file{chainman.m_blockman.OpenBlockFile(pos, /*fReadOnly=*/true)};
1240 |              if (file.IsNull()) {
1241 |                  break; // This error is logged in OpenBlockFile
1242 |              }
1243 | -            LogInfo("Reindexing block file blk%05u.dat...", (unsigned int)nFile);
1244 | +            LogInfo("Reindexing block file blk%05u.dat (%d%% complete)...", (unsigned int)nFile, nFile * 100 / total_files);

Raimo33 commented at 2:50 PM on September 13, 2025:

precompute the division?

enirox001 commented at 7:08 PM on September 16, 2025:

Consider computing the progress as (nFile + 1) * 100 / total_files so the indicator advances past 0% on the first file. Is there a reason we intentionally show 0% initially?

enirox001 commented at 7:08 PM on September 16, 2025:

Use a defensive guard when computing percent, e.g. total_files ? (100 * (nFile + 1) / total_files) : 0, to avoid accidental divide-by-zero after future refactors.

enirox001 commented at 7:12 PM on September 16, 2025:

Would it make sense to log nFile+1/total_files (e.g. 4/125) alongside the percent? That gives clearer, more granular progress than an integer percent alone.

l0rinc commented at 9:18 PM on September 16, 2025:

Thanks @enirox001, I think the 0% is fine and we've just calculated total_files, no need to guard and the percentage is the same as the nFile+1/total_files, I don't see the need to duplicate it.

luke-jr commented at 7:26 AM on September 18, 2025:

Files are not necessarily the same size/complexity...

l0rinc commented at 4:32 PM on September 18, 2025:

It's just an approximation - or do you think Reindexing block file blk%05u.dat (5/123)... would be clearer? We have progress in blocks as well, they're all just approximations...

Raimo33 commented at 4:34 PM on September 18, 2025:

i think percentage is fine. it just means % of blocks instead of % of time

Raimo33 commented at 2:52 PM on September 13, 2025: contributor

Concept ACK

enirox001 commented at 7:18 PM on September 16, 2025: contributor

Concept ACK d7de5b1

I tested this locally, the percentage logging provides a clear indication of progress during reindex and is useful visibility while the node processes block files.

I have left a few non-blocking nits for consideration.

rkrux approved

rkrux commented at 1:20 PM on November 7, 2025: contributor

lgtm ACK d7de5b109f69293b375729363b4e5038f3fb6b15

I don't see a harm in logging the approximate completeness percentage, would be helpful instead for the user imo.

DrahtBot requested review from enirox001 on Nov 7, 2025

DrahtBot requested review from Raimo33 on Nov 7, 2025

danielabrozzoni commented at 3:17 PM on December 17, 2025: member

tACK d7de5b109f69293b375729363b4e5038f3fb6b15 - code reviewed and tested on my archival node.

Nice to see this!

It’s true that not every file will take the same amount of time to reindex, but I think it’s better to have a rough estimate than no estimate at all.

maflcko commented at 3:23 PM on December 17, 2025: member

review ACK d7de5b109f69293b375729363b4e5038f3fb6b15 💇

<details><summary>Show signature</summary>

Signature:

untrusted comment: signature from minisign secret key on empty file; verify via: minisign -Vm "${path_to_any_empty_file}" -P RWTRmVTMeKV5noAMqVlsMugDDCyyTSbA3Re5AkUrhvLVln0tSaFWglOw -x "${path_to_this_whole_four_line_signature_blob}"
RUTRmVTMeKV5npGrKx1nqXCw5zeVHdtdYURB/KlyA/LMFgpNCs+SkW9a8N95d+U4AP1RJMi+krxU1A3Yux4bpwZNLvVBKy0wLgM=
trusted comment: review ACK d7de5b109f69293b375729363b4e5038f3fb6b15 💇
aqqS+UF4GRZ2hhr2z6UZi5SbxIG6N3cgTncLBI8EfMgU0tNzZRxZ2tQbsCfABosZ7rNtBKf1cilYhKPcKFF7BQ==

</details>

l0rinc commented at 10:53 PM on December 17, 2025: contributor

rfm?

glozow merged this on Dec 22, 2025

glozow closed this on Dec 22, 2025

sedited referenced this in commit f8db928648 on Dec 27, 2025

joshdoman referenced this in commit 57661ceac9 on Dec 27, 2025

stickies-v referenced this in commit 9fa736f8e4 on Jan 22, 2026

stringintech referenced this in commit f651a10526 on Feb 1, 2026

l0rinc deleted the branch on Mar 2, 2026