gui: Throttle GUI update pace when -reindex #18121

hebasto · 2020-02-11T20:44:28Z

This is grabbed from #17565.

All laanwj's and ryanofsky's suggestions are implemented.

With this PR, the GUI does not freeze when a user runs:

$ ./src/qt/bitcoin-qt -reindex

luke-jr · 2020-02-12T01:35:32Z

utACK

Co-authored-by: Barry Deeney <mxaddict@codedmaster.com> Co-authored-by: Russell Yanofsky <russ@yanofsky.org> Github-Pull: bitcoin#18121 Rebased-From: 56bf425

laanwj · 2020-02-12T16:17:45Z

Thanks you for working on this!
Concept ACK

ryanofsky

Code review ACK 56bf425. This is a good minimal fix. It would be also be nice to have followup cleanup that passes the reindexing state directly to the handleNotifyBlockTip/handleNotifyHeaderTip handlers, so the GUI doesn't need to call back into the node in the middle of handling an event from the node. This would also make the initial sync and reindexing conditions more consistent, and maybe more efficient if there are a lot of notifications backed up in the queue, because throttling could still happen when reindexing finished but notifications from reindexing were still being processed.

ryanofsky · 2020-02-12T19:34:25Z

src/qt/clientmodel.cpp

@@ -243,7 +243,8 @@ static void BlockTipChanged(ClientModel *clientmodel, bool initialSync, int heig
        clientmodel->cachedBestHeaderTime = blockTime;
    }
    // if we are in-sync or if we notify a header update, update the UI regardless of last update time
-    if (fHeader || !initialSync || now - nLastUpdateNotification > MODEL_UPDATE_DELAY) {
+    // If the command line option -reindex is specified, the GUI update pace is throttled down.


In commit "gui: Throttle GUI update pace when -reindex" (56bf425)

Comment is a little misleading because throttling doesn't happen just generally when -reindex is specified, it does stop when the reindex is over.

Would suggest changing to: "During initial sync, block notifications, and header notifications from reindexing are both throttled."

ryanofsky · 2020-02-12T19:57:45Z

src/qt/clientmodel.cpp

@@ -243,7 +243,8 @@ static void BlockTipChanged(ClientModel *clientmodel, bool initialSync, int heig
        clientmodel->cachedBestHeaderTime = blockTime;
    }
    // if we are in-sync or if we notify a header update, update the UI regardless of last update time
-    if (fHeader || !initialSync || now - nLastUpdateNotification > MODEL_UPDATE_DELAY) {
+    // If the command line option -reindex is specified, the GUI update pace is throttled down.
+    if ((fHeader && !clientmodel->node().getReindex()) || !initialSync || now - nLastUpdateNotification > MODEL_UPDATE_DELAY) {


In commit "gui: Throttle GUI update pace when -reindex" (56bf425)

I think it would be best to put !initialSync condition first to be clear throttling only happens during initial sync.

Co-authored-by: Barry Deeney <mxaddict@codedmaster.com> Co-authored-by: Russell Yanofsky <russ@yanofsky.org>

hebasto · 2020-02-12T22:00:29Z

Updated 56bf425 -> c9fe612 (pr18121.01 -> pr18121.02, compare).

@ryanofsky
Thank you for your review. All your comments have been addressed.

luke-jr · 2020-02-12T22:34:13Z

src/qt/clientmodel.cpp

-    // if we are in-sync or if we notify a header update, update the UI regardless of last update time
-    if (fHeader || !initialSync || now - nLastUpdateNotification > MODEL_UPDATE_DELAY) {
+
+    // During initial sync, block notifications, and header notifications from reindexing are both throttled.


I find this very confusing, and even if I look past the grammar error, probably outright wrong since header notifications are only throttled for reindex, not initial sync?

IIUC, fReindex==true implies initialSync==true:

bitcoin/src/validation.cpp

Lines 1281 to 1282 in 2bdc476

if (fImporting || fReindex)

return true;

Anyway, mind suggesting a better wording?

I find this very confusing, and even if I look past the grammar error, probably outright wrong since header notifications are only throttled for reindex, not initial sync?

This is pretty confusing, and I was probably trying to pack too much information in a short comment. There should be chances to clean this up in the future with followups from #18136 or #18121 (review)

Ideally the code would just be more direct and not need a comment stating what it does:

enum NotificationType { BLOCK_TIP_CHANGED, HEADER_TIP_CHANGED }; enum NotificationStatus { INIT_REINDEX, INIT_DOWNLOAD, POST_INIT }; void HandleNotification(NotificationType notification, NotificationStatus status) { bool throttle = status == INIT_REINDEX || (status == INIT_DOWNLOAD && notification == BLOCK_TIP_CHANGED); if (!throttle || now - nLastUpdateNotification > MODEL_UPDATE_DELAY) ...

Addressed in #18152

DrahtBot · 2020-02-12T23:05:28Z

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

Conflicts

Reviewers, this pull request conflicts with the following ones:

gui: Balance/TxStatus polling update based on last block hash. #17993 (gui: Avoid redundant cs_main locks in balance polling. by furszy)

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.

jonasschnelli · 2020-02-13T07:46:49Z

utACK c9fe612

c9fe612 gui: Throttle GUI update pace when -reindex (Hennadii Stepanov) Pull request description: This is grabbed from #17565. All **laanwj**'s and **ryanofsky**'s suggestions are implemented. With this PR, the GUI does not freeze when a user runs: ``` $ ./src/qt/bitcoin-qt -reindex ``` ACKs for top commit: jonasschnelli: utACK c9fe612 Tree-SHA512: c7be316cb73d3d286bdf8429a960f71777d13a73d059869a64e23ad276499252b561a3a5b9613c4c1ad58cc0de26283c1ec72be745c401f604eaa05f70bf7d64

- [0.19] wallet: Reset reused transactions cache bitcoin#18083 - 0.19: Backports bitcoin#17792 - psbt: handle unspendable psbts bitcoin#17524 - qt: Fix comparison function signature bitcoin#17634 - psbt: check that various indexes and amounts are within bounds bitcoin#17156 - [0.19] psbt: check that various indexes and amounts are within bounds bitcoin#18079 - [0.19] Final backports for 0.19.1 bitcoin#17988 - Bug: IsUsedDestination shouldn't use key id as script id for ScriptHash bitcoin#17924 - qt: Fix deprecated QCharRef usage bitcoin#18101 - gui: Throttle GUI update pace when -reindex bitcoin#18121 - gui: Fix race in WalletModel::pollBalanceChanged bitcoin#18123 - gui: Fix unintialized WalletView::progressDialog bitcoin#18062 - Bugfix: GUI: Hide the HD/encrypt icons earlier so they get re-shown if another wallet is open bitcoin#18007 - bug-fix macos: give free bytes to F_PREALLOCATE bitcoin#17887 - test: add missing #include to fix compiler errors bitcoin#17980 - zmq: Fix due to invalid argument and multiple notifiers bitcoin#17445

a0d0f1c refactor: Remove Node:: queries from GUI (Hennadii Stepanov) 06d519f qt: Add SynchronizationState enum to signal parameter (Hennadii Stepanov) 3c709aa refactor: Remove Node::getReindex() call from GUI (Hennadii Stepanov) 1dab574 refactor: Pass SynchronizationState enum to GUI (Hennadii Stepanov) 2bec309 refactor: Remove unused bool parameter in RPCNotifyBlockChange() (Hennadii Stepanov) 1df7701 refactor: Remove unused bool parameter in BlockNotifyGenesisWait() (Hennadii Stepanov) Pull request description: This PR is a followup of #18121 and: - addresses confusion about GUI notification throttling conditions (**luke-jr**'s [comment](#18121 (comment)), **ryanofsky**'s [comment](#18121 (comment))) - removes `isInitialBlockDownload()` call from the GUI back to the node (on macOS). See: **ryanofsky**'s [comment](#18121 (review)) ACKs for top commit: jonasschnelli: Core Review ACK a0d0f1c (modulo [question](#18152 (review))). ryanofsky: Code review ACK a0d0f1c. Only changes since last review were rebase and tweaking SynchronizationState enum declaration as suggested (thanks!) Tree-SHA512: b6a712a710666e763aeee0d5440de1391a4c6c8f7fa661888773e1ba59e9e0f83654ee384d4edc704031be7eb25616e5eca2a6e26058d3efb7f64c47f9ed7316

Summary: ``` With this PR, the GUI does not freeze when a user runs: $ ./src/qt/bitcoin-qt -reindex ``` Backport of core [[bitcoin/bitcoin#18121 | PR18121]]. Test Plan: ninja all check ./src/qt/bitcoin-qt -reindex Check the GUI sync progress no longer causes epileptic seizure to the user. Reviewers: #bitcoin_abc, majcosta Reviewed By: #bitcoin_abc, majcosta Differential Revision: https://reviews.bitcoinabc.org/D8323

c9fe612 gui: Throttle GUI update pace when -reindex (Hennadii Stepanov) Pull request description: This is grabbed from bitcoin#17565. All **laanwj**'s and **ryanofsky**'s suggestions are implemented. With this PR, the GUI does not freeze when a user runs: ``` $ ./src/qt/bitcoin-qt -reindex ``` ACKs for top commit: jonasschnelli: utACK c9fe612 Tree-SHA512: c7be316cb73d3d286bdf8429a960f71777d13a73d059869a64e23ad276499252b561a3a5b9613c4c1ad58cc0de26283c1ec72be745c401f604eaa05f70bf7d64

fanquake added the GUI label Feb 11, 2020

hebasto requested review from ryanofsky and laanwj February 11, 2020 20:47

ryanofsky approved these changes Feb 12, 2020

View reviewed changes

gui: Throttle GUI update pace when -reindex

c9fe612

Co-authored-by: Barry Deeney <mxaddict@codedmaster.com> Co-authored-by: Russell Yanofsky <russ@yanofsky.org>

hebasto force-pushed the 20200211-reindex-gui branch from 56bf425 to c9fe612 Compare February 12, 2020 21:53

hebasto requested a review from ryanofsky February 12, 2020 22:01

luke-jr reviewed Feb 12, 2020

View reviewed changes

DrahtBot mentioned this pull request Feb 12, 2020

gui: Balance/TxStatus polling update based on last block hash. #17993

Merged

jonasschnelli merged commit c9fe612 into bitcoin:master Feb 13, 2020

hebasto deleted the 20200211-reindex-gui branch February 13, 2020 18:07

hebasto mentioned this pull request Feb 15, 2020

qt: Use SynchronizationState enum for signals to GUI #18152

Merged

MarkLTZ mentioned this pull request Apr 4, 2020

Bitcoin PR tracking litecoinz-core/litecoinz#14

Closed

ryanofsky mentioned this pull request May 18, 2020

gui: Long or blocking calls should be async #16874

Closed

bitcoin locked as resolved and limited conversation to collaborators Feb 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gui: Throttle GUI update pace when -reindex #18121

gui: Throttle GUI update pace when -reindex #18121

hebasto commented Feb 11, 2020 •

edited by fanquake

luke-jr commented Feb 12, 2020

laanwj commented Feb 12, 2020

ryanofsky left a comment

ryanofsky Feb 12, 2020 •

edited

hebasto Feb 12, 2020

ryanofsky Feb 12, 2020

hebasto Feb 12, 2020

hebasto commented Feb 12, 2020

luke-jr Feb 12, 2020

hebasto Feb 13, 2020

ryanofsky Feb 13, 2020 •

edited

hebasto Feb 15, 2020

DrahtBot commented Feb 12, 2020

jonasschnelli commented Feb 13, 2020

gui: Throttle GUI update pace when -reindex #18121

gui: Throttle GUI update pace when -reindex #18121

Conversation

hebasto commented Feb 11, 2020 • edited by fanquake

luke-jr commented Feb 12, 2020

laanwj commented Feb 12, 2020

ryanofsky left a comment

Choose a reason for hiding this comment

ryanofsky Feb 12, 2020 • edited

Choose a reason for hiding this comment

hebasto Feb 12, 2020

Choose a reason for hiding this comment

ryanofsky Feb 12, 2020

Choose a reason for hiding this comment

hebasto Feb 12, 2020

Choose a reason for hiding this comment

hebasto commented Feb 12, 2020

luke-jr Feb 12, 2020

Choose a reason for hiding this comment

hebasto Feb 13, 2020

Choose a reason for hiding this comment

ryanofsky Feb 13, 2020 • edited

Choose a reason for hiding this comment

hebasto Feb 15, 2020

Choose a reason for hiding this comment

DrahtBot commented Feb 12, 2020

Conflicts

jonasschnelli commented Feb 13, 2020

hebasto commented Feb 11, 2020 •

edited by fanquake

ryanofsky Feb 12, 2020 •

edited

ryanofsky Feb 13, 2020 •

edited