status-im/nim-drchaos
2
0
Fork 0
mirror of https://github.com/status-im/nim-drchaos.git synced 2025-02-16 12:57:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

add notes

Browse Source
This commit is contained in:
Antonis Geralis 2022-09-12 19:06:02 +03:00
parent 2ec768c1fb
commit 9b99d3c4af
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -72,6 +72,24 @@ More articulate examples, such as fuzzing a graph library are in the `examples/`
Defining a `==` proc for the input type is necessary. `proc default(_: typedesc[T]): T` can also
be overloaded. Which is especially useful when `nil` for `ref` is not an acceptable value.
### Needed config
Add these flags to either `filename.nims`, `config.nims`, `nim.cfg` or directly pass to the compiler:
```nim
--cc: clang
--define: useMalloc
--noMain: on
--define: noSignalHandler
--passC: "-fsanitize=fuzzer,address,undefined"
--passL: "-fsanitize=fuzzer,address,undefined"
#--define: release
--debugger: native
```
Alternatively, drchaos provides structured input for fuzzing with [nim-testutils](https://github.com/status-im/nim-testutils)
Which includes a convenient [testrunner](https://github.com/status-im/nim-testutils/blob/master/testutils/readme.md)
### Post-processors
Sometimes it is necessary to adjust the random input in order to add magic values or