-
Notifications
You must be signed in to change notification settings - Fork 72
Add fuzz input maintenance docs to the readme #121
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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 |
---|---|---|
@@ -1,6 +1,3 @@ | ||
If you are adding fuzz seeds, please "merge" the seeds before submitting this | ||
pull request, then remove the instruction text here. | ||
|
||
You can use the libFuzzer option `-merge=1` (recommended with | ||
`-use_value_profile=1`) or the `--m_dir` option of the fuzz runner: | ||
https://github.com/bitcoin/bitcoin/blob/master/test/fuzz/test_runner.py | ||
Please see the | ||
[README.md](https://github.com/bitcoin-core/qa-assets/blob/main/README.md) for | ||
instructions on how to contribute new inputs. |
This file contains hidden or 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 |
---|---|---|
@@ -1,2 +1,40 @@ | ||
# qa-assets | ||
Bitcoin Core related blobs used for quality assurance | ||
|
||
Bitcoin Core related blobs used for quality assurance. | ||
|
||
## Fuzz inputs | ||
|
||
`qa-assets/fuzz_seed_corpus` contains one input corpus per fuzz target (one | ||
folder per target named the same as each target). | ||
|
||
### Contributing inputs | ||
|
||
*For documentation on how to fuzz Bitcoin Core please see | ||
[fuzzing.md](https://github.com/bitcoin/bitcoin/blob/master/doc/fuzzing.md).* | ||
|
||
If you want to contribute fuzz inputs, please "merge" the inputs before | ||
submitting a pull request. You can use the libFuzzer option `-merge=1` | ||
(recommended with `-use_value_profile=1`) or the `--m_dir` option of the fuzz | ||
runner: | ||
[`test_runner.py`](https://github.com/bitcoin/bitcoin/blob/master/test/fuzz/test_runner.py). | ||
|
||
### Pruning inputs | ||
|
||
* Over time fuzz engines reduce inputs (produce a smaller input that yields the | ||
same coverage statistics), which causes our copora to accumulate larger | ||
non-reduced inputs. | ||
* Code changes can lead to inputs losing their coverage. | ||
|
||
To avoid corpora bloat, stale inputs and potential CI timeouts, we usually | ||
prune/minimize our copora around the branch-off point using the | ||
dergoegge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[`delete_nonreduced_fuzz_inputs.sh`](https://raw.githubusercontent.com/bitcoin-core/bitcoin-maintainer-tools/main/delete_nonreduced_fuzz_inputs.sh) | ||
script (Recommended to run in a fresh VM, see documentation in the script). The | ||
script is usually run twice to ensure that the results are "somewhat" | ||
reproducible (e.g. | ||
https://github.com/bitcoin-core/qa-assets/pull/119#issuecomment-1518019457). | ||
|
||
After pruning the corpora, the coverage should not have dropped at all. | ||
|
||
dergoegge marked this conversation as resolved.
Show resolved
Hide resolved
|
||
### Pulling inputs from oss-fuzz | ||
|
||
Use `download_oss_fuzz_inputs.py` to pull fuzz inputs from oss-fuzz. |
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.
Uh oh!
There was an error while loading. Please reload this page.