backport: Merge bitcoin/bitcoin#22508, 26009, 25831, 24675

[vijaydasmp]

BTC Backport

[coderabbitai]

Walkthrough

This pull request updates various parts of the codebase to improve file path handling and control loop execution during fuzz testing. In several components—including CLI, initialization, GUI utilities, RPC, and system modules—calls that retrieve configuration file paths have been changed from using a simple string-based argument getter (GetArg) to a path-aware variant (GetPathArg). Additionally, variables and function parameters for file paths have been updated to use the filesystem path type (fs::path) instead of strings for clearer type safety. Meanwhile, a number of fuzz test targets have had their unbounded while loops replaced with a LIMITED_WHILE macro, imposing iteration limits (commonly 10,000 iterations, with some variations) to prevent excessive looping. Minor modifications include changes to macro definitions and logging adjustments, with no overall changes to the core functional logic.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bcd14b0 and 3934e13.

📒 Files selected for processing (34)

• src/bitcoin-cli.cpp (1 hunks)
• src/init/common.cpp (1 hunks)
• src/qt/guiutil.cpp (1 hunks)
• src/rpc/request.cpp (1 hunks)
• src/sync.h (1 hunks)
• src/test/fuzz/addrman.cpp (2 hunks)
• src/test/fuzz/autofile.cpp (1 hunks)
• src/test/fuzz/bloom_filter.cpp (1 hunks)
• src/test/fuzz/buffered_file.cpp (1 hunks)
• src/test/fuzz/chain.cpp (1 hunks)
• src/test/fuzz/coins_view.cpp (2 hunks)
• src/test/fuzz/connman.cpp (1 hunks)
• src/test/fuzz/crypto_aes256.cpp (1 hunks)
• src/test/fuzz/crypto_aes256cbc.cpp (1 hunks)
• src/test/fuzz/crypto_chacha20.cpp (1 hunks)
• src/test/fuzz/crypto_hkdf_hmac_sha256_l32.cpp (1 hunks)
• src/test/fuzz/cuckoocache.cpp (1 hunks)
• src/test/fuzz/merkleblock.cpp (1 hunks)
• src/test/fuzz/net.cpp (1 hunks)
• src/test/fuzz/netbase_dns_lookup.cpp (1 hunks)
• src/test/fuzz/node_eviction.cpp (1 hunks)
• src/test/fuzz/policy_estimator.cpp (2 hunks)
• src/test/fuzz/pow.cpp (1 hunks)
• src/test/fuzz/process_messages.cpp (1 hunks)
• src/test/fuzz/rpc.cpp (2 hunks)
• src/test/fuzz/script_descriptor_cache.cpp (1 hunks)
• src/test/fuzz/script_ops.cpp (1 hunks)
• src/test/fuzz/script_sign.cpp (2 hunks)
• src/test/fuzz/scriptnum_ops.cpp (1 hunks)
• src/test/fuzz/torcontrol.cpp (1 hunks)
• src/test/fuzz/versionbits.cpp (1 hunks)
• src/test/util/chainstate.h (2 hunks)
• src/util/system.cpp (5 hunks)
• src/util/system.h (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (4)

src/init/common.cpp (2)

src/util/system.h (1)

• GetConfigFile (108-108)

src/util/system.cpp (2)

• GetConfigFile (873-876)
• GetConfigFile (873-873)

src/bitcoin-cli.cpp (2)

src/util/system.h (1)

• GetConfigFile (108-108)

src/util/system.cpp (2)

• GetConfigFile (873-876)
• GetConfigFile (873-873)

src/qt/guiutil.cpp (3)

src/util/system.h (1)

• GetConfigFile (108-108)

src/util/system.cpp (2)

• GetConfigFile (873-876)
• GetConfigFile (873-873)

src/bitcoin-cli.cpp (1)

• gArgs (441-447)

src/test/util/chainstate.h (1)

src/rpc/blockchain.cpp (6)

• result (131-131)
• result (268-268)
• result (550-550)
• result (2256-2256)
• result (2424-2424)
• result (2712-2712)

🔇 Additional comments (47)

src/test/fuzz/script_ops.cpp (1)

18-18: Improved safety with iteration limit.

The change replaces an unbounded while loop with a LIMITED_WHILE macro that caps iterations at 1,000,000. This prevents potential infinite loops during fuzz testing while still allowing sufficient iterations for comprehensive testing of script operations.

Notably, this limit is 100x higher than the 10,000 limit used in most other fuzz targets, suggesting script operations testing requires more iterations to be effective.

src/test/fuzz/autofile.cpp (1)

21-21: Enhanced fuzz testing stability.

The change replaces an unbounded while loop with a LIMITED_WHILE macro that caps iterations at 10,000. This prevents potential infinite loops during fuzz testing while maintaining effective coverage.

This modification is consistent with similar changes in other fuzz targets and follows best practices for resource-constrained testing environments.

src/test/fuzz/crypto_aes256.cpp (1)

22-22: Improved fuzz testing robustness.

The change replaces an unbounded while loop with a LIMITED_WHILE macro that caps iterations at a reasonable 10,000 limit. This prevents potential infinite loops or excessive resource consumption during AES256 encryption/decryption testing.

The functional behavior remains unchanged, while the safety of the fuzz testing infrastructure is improved.

src/test/fuzz/script_descriptor_cache.cpp (1)

19-19: Enhanced fuzz test safety with iteration limit.

The change replaces an unbounded while loop with a LIMITED_WHILE macro that caps iterations at 10,000. This prevents potential infinite loops during descriptor cache fuzz testing while maintaining effective test coverage.

This modification follows the pattern applied consistently across the fuzz testing framework, improving the overall stability and reliability of the test suite.

src/test/fuzz/process_messages.cpp (1)

58-58: Good improvement to limit the fuzz test iterations

Replacing the unbounded while loop with a LIMITED_WHILE macro capped at 10,000 iterations will prevent excessive resource consumption during fuzz testing while maintaining effective test coverage.

src/test/fuzz/crypto_aes256cbc.cpp (1)

24-24: Good improvement to prevent infinite loop scenarios

Applying the LIMITED_WHILE macro with a 10,000 iteration limit is a sensible safeguard against potential resource exhaustion in this crypto fuzz test.

src/test/fuzz/net.cpp (1)

50-50: Appropriate loop constraint added

The change from an unbounded while loop to a bounded LIMITED_WHILE macro with 10,000 iterations provides a good balance between thorough testing and resource protection.

src/test/fuzz/scriptnum_ops.cpp (1)

31-31: Good addition of iteration limit with appropriate higher threshold

Using a LIMITED_WHILE macro with a 1,000,000 iteration limit is appropriate for this script number operations test. The higher limit (compared to 10,000 in other fuzz tests) makes sense given the complexity of numeric operations being tested.

src/test/fuzz/pow.cpp (1)

31-31: Good use of iteration limiting in fuzz testing.

Replacing the unbounded while loop with a LIMITED_WHILE macro that caps iterations at 10,000 prevents excessive processing during fuzzing, which could lead to timeouts or resource exhaustion. This is a good defensive practice for fuzz tests.

src/test/fuzz/buffered_file.cpp (1)

32-32: Preventing potential infinite loops in fuzz test.

The LIMITED_WHILE macro with a 10,000 iteration limit is a good addition for fuzz testing. It mitigates the risk of indefinite looping when ConsumeBool() repeatedly returns true, which could occur with certain input data patterns during fuzzing.

src/test/fuzz/versionbits.cpp (1)

203-203: Clear documentation of loop control strategy.

The added comment explains why this particular loop doesn't need the LIMITED_WHILE macro—it already has an early exit mechanism via the remaining_bytes check. This explanation is helpful for future maintenance and code review.

src/test/fuzz/merkleblock.cpp (1)

37-37: Good protection against excessive iterations.

Adding the LIMITED_WHILE macro with a 10,000 iteration limit improves the robustness of this fuzz test by preventing it from potentially running for too many iterations when inserting transaction IDs. This is consistent with the approach used in other fuzz tests in this PR.

src/test/fuzz/netbase_dns_lookup.cpp (1)

25-25: The change improves fuzzing robustness by adding iteration limits.

The replacement of the unbounded while loop with LIMITED_WHILE macro that caps iterations at 10,000 is a good safety measure to prevent potential infinite loops or excessive execution during fuzz testing.

src/test/fuzz/connman.cpp (1)

51-51: Loop iteration limit properly implemented.

The change from an unbounded while loop to a LIMITED_WHILE macro with a 10,000 iteration limit enhances the robustness of the fuzz testing by preventing excessive or infinite loops.

src/test/fuzz/bloom_filter.cpp (1)

27-27: Good improvement to fuzzing safety.

Replacing the unbounded while loop that depends on remaining bytes with a LIMITED_WHILE macro that adds a 10,000 iteration cap prevents potential resource exhaustion during fuzzing while maintaining the same logic.

src/test/fuzz/chain.cpp (1)

40-40: Appropriate iteration limit added.

The addition of the 10,000 iteration limit via the LIMITED_WHILE macro is consistent with the changes in other fuzz testing files and provides a good safety measure against potential infinite loops.

src/test/fuzz/addrman.cpp (2)

253-253: Improved fuzz testing safety by limiting loop iterations.

The change adds a 10,000 iteration limit to the main loop in the addrman fuzz target, preventing potential infinite loops while preserving the fuzzing logic.

---

273-273: Added iteration limit to nested address creation loop.

Similar to the main loop, this nested loop now has a 10,000 iteration limit to prevent excessive or infinite iterations when creating test addresses.

src/test/fuzz/coins_view.cpp (2)

55-55: Enhanced fuzz testing robustness with iteration limit.

Added a 10,000 iteration limit to the main fuzzing loop that tests various coin view operations, preventing potential infinite loops while maintaining test coverage.

---

122-122: Limited nested coin map population loop.

Added a 10,000 iteration cap to the inner loop that populates the coins map with test entries, preventing potential excessive iterations during fuzzing.

src/test/fuzz/crypto_chacha20.cpp (1)

23-23: Set a 1,000 iteration limit for ChaCha20 test loop.

Added iteration limiting to prevent potential infinite loops in ChaCha20 cryptographic testing. Note that this uses a lower limit (1,000) compared to the 10,000 limit used in other fuzz targets.

src/test/fuzz/cuckoocache.cpp (1)

40-40: Limited cuckoocache test iterations for safer fuzzing.

Added a 10,000 iteration limit to the loop that tests cache insertion and lookup operations, preventing potential infinite loops while preserving test coverage.

src/test/fuzz/node_eviction.cpp (1)

21-21: Improved fuzz test safety with iteration limits

This change replaces an unbounded while loop with a LIMITED_WHILE macro that caps the number of iterations at 10,000. This is a good safety improvement that prevents the test from potentially running indefinitely.

src/test/fuzz/script_sign.cpp (2)

51-51: Added iteration limit to prevent infinite loops

Replacing the unbounded loop with LIMITED_WHILE adds a safety constraint of 10,000 iterations maximum, which is a good practice for fuzz testing.

---

126-126: Limited loop iterations for safer fuzzing

Similar to the earlier change in this file, this adds a 10,000 iteration limit to the loop that populates the coins map, preventing potential infinite loops during fuzzing.

src/test/fuzz/crypto_hkdf_hmac_sha256_l32.cpp (1)

21-21: Added iteration cap for HKDF expansion testing

Good change to limit the loop to a maximum of 10,000 iterations, ensuring the fuzz test doesn't run indefinitely while still providing thorough testing of the HKDF expansion functionality.

src/test/fuzz/torcontrol.cpp (1)

47-47: Improved torcontrol fuzzing with iteration limit

This change enhances the fuzz testing by adding a 10,000 iteration limit to the previously unbounded loop. This prevents excessive resource usage while maintaining comprehensive test coverage of the TorController callbacks.

src/test/fuzz/rpc.cpp (2)

299-301: Loop iteration limitation improves fuzzing robustness.

The addition of the LIMITED_WHILE macro with a 100-iteration cap is a good improvement over the unbounded while loop. This prevents potential infinite loops during fuzzing that could occur if the fuzzed_data_provider continuously returns true, making testing more reliable and efficient.

---

353-355: Loop iteration limitation improves fuzzing reliability.

Similar to the previous change, limiting RPC argument generation to 100 iterations prevents excessive execution time or potential infinite loops during fuzzing. This is consistent with the change in the ConsumeArrayRPCArgument function and helps ensure the test completes in a reasonable timeframe.

src/test/fuzz/policy_estimator.cpp (2)

27-27: Loop iteration limitation enhances testing efficiency.

The addition of the LIMITED_WHILE macro with a 10,000-iteration cap is a good improvement over the unbounded while loop. This prevents potential infinite loops during fuzzing, ensuring the test completes within a reasonable timeframe without getting stuck if the fuzzed_data_provider continuously returns true.

---

43-43: Inner loop iteration limitation provides additional protection.

Implementing the 10,000-iteration limit on this inner loop is consistent with the outer loop change and provides an additional layer of protection against excessive or infinite execution. This is especially important when generating memory pool entries to avoid excessive resource consumption.

src/qt/guiutil.cpp (1)

655-655: Better path handling using GetPathArg instead of GetArg

The change from gArgs.GetArg to gArgs.GetPathArg improves type safety by properly handling the configuration file path as a filesystem path rather than a regular string. This aligns with similar changes made across the codebase.

src/test/util/chainstate.h (2)

10-10: Added logging header for LogPrintf

This addition is necessary to support the change from Boost Test message to LogPrintf on lines 38-39.

---

38-39: Replaced Boost Test message with LogPrintf

The code now uses the internal logging mechanism via LogPrintf instead of relying on Boost Test for logging the UTXO snapshot creation. This is a more consistent approach for logging within the codebase.

src/sync.h (1)

315-316: Removed unnecessary semicolon in macro definition

The trailing semicolon was removed from the LOCK2 macro definition. This is a sensible change since semicolons in macro definitions can sometimes cause unexpected behavior when the macro is expanded, especially in certain contexts like conditionals or loops.

src/bitcoin-cli.cpp (1)

840-840: Better path handling using GetPathArg instead of GetArg

Similar to the change in guiutil.cpp, this modification improves type safety by using the path-specific function GetPathArg instead of GetArg for retrieving the configuration file path. This is part of a consistent approach to properly handle file paths throughout the codebase.

src/util/system.h (1)

108-108: Improved type safety by updating the parameter type

The function signature has been updated to use fs::path instead of std::string for the parameter, which enhances type safety and better represents the intended usage.

src/init/common.cpp (1)

162-162: Improved type safety with GetPathArg

The code now uses GetPathArg instead of GetArg to retrieve the configuration file path, which returns an fs::path instead of a string. This aligns with the updated GetConfigFile function signature and provides better type safety for file path handling.

src/rpc/request.cpp (2)

69-69: Changed COOKIEAUTH_FILE type to const char const*

Replaced std::string with const char* const for the string literal, which is a more efficient representation for constants.

---

74-78: Improved path handling using fs::path

The code now uses GetPathArg which returns an fs::path instead of a string, eliminating the need for string-to-path conversions. This provides better type safety and consistency with the file system path handling throughout the codebase.

src/util/system.cpp (7)

551-551: Removed unnecessary fs::path constructor

Simplified the code by removing the explicit fs::path constructor wrap for BITCOIN_SETTINGS_FILENAME. Since GetPathArg can implicitly convert a const char* to an fs::path, this explicit construction was redundant.

---

873-875: Updated GetConfigFile function signature to use fs::path

Changed the parameter type from std::string to fs::path and renamed the parameter for better clarity. This provides better type safety for file path handling and is consistent with other changes in the codebase.

---

974-975: Improved path handling in ReadConfigFiles

Updated the variable type from std::string to fs::path and changed the method from GetArg to GetPathArg. This ensures type safety and consistency with the updated GetConfigFile function signature.

---

979-979: Updated error message to use PathToString

Added fs::PathToString to convert the fs::path to a string for inclusion in the error message. This is necessary because the conf_path variable is now an fs::path instead of a string.

---

984-984: Updated ReadConfigStream call to use PathToString

Added fs::PathToString to convert the fs::path to a string for the second argument of the ReadConfigStream function call. This ensures compatibility with the function's expected string parameter.

---

1022-1022: Added PathFromString for conversion to fs::path

Updated the call to GetConfigFile to use fs::PathFromString to convert the string to an fs::path to match the updated function signature. This ensures proper type conversion for the function call.

---

1049-1049: Updated variable name in GetConfigFile call

Changed the variable name from confPath to conf_path to match the variable name update in the rest of the function. This maintains consistency in the code.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[vijaydasmp]

Hello @UdjinM6 @knst requesting review

[UdjinM6]

utACK 3934e13

[knst]

LGTM 3934e13