-
Notifications
You must be signed in to change notification settings - Fork 35.7k
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
util: Add Assume() identity function #20255
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -276,6 +276,33 @@ configure option adds `-DDEBUG_LOCKORDER` to the compiler flags. This inserts | |
run-time checks to keep track of which locks are held and adds warnings to the | ||
`debug.log` file if inconsistencies are detected. | ||
|
||
### Assertions and Checks | ||
|
||
The util file `src/util/check.h` offers helpers to protect against coding and | ||
internal logic bugs. They must never be used to validate user, network or any | ||
other input. | ||
|
||
* `assert` or `Assert` should be used to document assumptions when any | ||
violation would mean that it is not safe to continue program execution. The | ||
code is always compiled with assertions enabled. | ||
- For example, a nullptr dereference or any other logic bug in validation | ||
code means the program code is faulty and must terminate immediately. | ||
* `CHECK_NONFATAL` should be used for recoverable internal logic bugs. On | ||
failure, it will throw an exception, which can be caught to recover from the | ||
error. | ||
- For example, a nullptr dereference or any other logic bug in RPC code | ||
means that the RPC code is faulty and can not be executed. However, the | ||
logic bug can be shown to the user and the program can continue to run. | ||
* `Assume` should be used to document assumptions when program execution can | ||
safely continue even if the assumption is violated. In debug builds it | ||
behaves like `Assert`/`assert` to notify developers and testers about | ||
nonfatal errors. In production it doesn't warn or log anything, though the | ||
expression is always evaluated. | ||
- For example it can be assumed that a variable is only initialized once, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/For example it can/For example, it may/ |
||
but a failed assumption does not result in a fatal bug. A failed | ||
assumption may or may not result in a slightly degraded user experience, | ||
but it is safe to continue program execution. | ||
maflcko marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Valgrind suppressions file | ||
|
||
Valgrind is a programming tool for memory debugging, memory leak detection, and | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/can not/cannot/