Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Faster initial block index load for low memory machines #1433

Merged
merged 1 commit into from
Apr 27, 2024

Conversation

psolstice
Copy link
Contributor

@psolstice psolstice commented Apr 15, 2024

Code changes brief

Linux only: detect if there is <2GB available RAM and then lower the number of block headers to perform a full check on during startup

Summary by CodeRabbit

  • New Features
    • Enhanced startup performance for systems with lower RAM by adjusting the number of blocks checked.

Copy link

coderabbitai bot commented Apr 15, 2024

Walkthrough

The recent modifications enhance the blockchain software by dynamically adjusting the initial block verification process based on the system's RAM availability. This adaptive approach reduces the load on low-memory systems by checking fewer blocks during startup, thus optimizing performance and resource utilization.

Changes

File Change Summary
src/txdb.h, src/txdb.cpp Introduced a conditional RAM check to adjust the number of blocks verified at startup. Added a constant for the default number of blocks to check on low-memory systems.

Poem

🐇💻 Ode to Adaptive Blocks 🌟

In the realm where bytes frolic and play,
A wise rabbit tweaked the blockchain's sway.
"Less is more," it thought with a hop,
For those with RAM not a lot.
Now systems breathe with lighter loads,
Smoothly hopping down digital roads.


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 17aab98 and dd67914.
Files selected for processing (2)
  • src/txdb.cpp (3 hunks)
  • src/txdb.h (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

@@ -47,6 +47,8 @@ static const int64_t nMaxCoinsDBCache = 8;
static const bool DEFAULT_FULL_BLOCKINDEX_CHECK = false;
//! If not doing full check of block index, check only N of the latest blocks
static const int DEFAULT_BLOCKINDEX_NUMBER_OF_BLOCKS_TO_CHECK = 10000;
//! Check fewer blocks if low on memory
static const int DEFAULT_BLOCKINDEX_LOWMEM_NUMBER_OF_BLOCKS_TO_CHECK = 50;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider reviewing the value of DEFAULT_BLOCKINDEX_LOWMEM_NUMBER_OF_BLOCKS_TO_CHECK.

The reduction to 50 blocks from the default 10,000 could potentially compromise the security and integrity of the block validation process on systems with low memory. It's advisable to assess the risks associated with this significant reduction and possibly consider a higher threshold that balances performance with security.

Comment on lines +374 to +379
#ifdef __linux__
struct sysinfo sysInfo;

if (sysinfo(&sysInfo) == 0 && sysInfo.freeram < 2ul*1024ul*1024ul*1024ul)
nBlocksToCheck = DEFAULT_BLOCKINDEX_LOWMEM_NUMBER_OF_BLOCKS_TO_CHECK;
#endif
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review the implementation of the memory check and conditional logic.

The use of sysinfo to determine the available RAM and adjust the number of blocks to check is a critical change. Ensure that this logic is robust and consider edge cases, such as systems close to the 2GB threshold. Additionally, validate that the sysinfo function provides reliable results across different Linux distributions and hardware configurations.

Copy link
Contributor

@levonpetrosyan93 levonpetrosyan93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@reubenyap reubenyap merged commit 8819b89 into master Apr 27, 2024
6 checks passed
@reubenyap reubenyap deleted the progpow-mem-issue branch April 27, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants