Update test/fuzzing/README

This commit is contained in:
Behdad Esfahbod 2022-08-03 11:31:04 -06:00
parent c80e32972f
commit e68e874da6
3 changed files with 18 additions and 26 deletions

View File

@ -39,11 +39,7 @@ ninja -C build
## Test with the Fuzzer
```shell
CXXFLAGS="-fsanitize=address,fuzzer-no-link" meson fuzzbuild --default-library=static -Dfuzzer_ldflags="-fsanitize=address,fuzzer" -Dexperimental_api=true
ninja -Cfuzzbuild test/fuzzing/hb-{shape,draw,subset,set}-fuzzer
fuzzbuild/test/fuzzing/hb-subset-fuzzer test/fuzzing/fonts
```
FOr fuzzing, see `test/fuzzing/README.md`.
## Profiling

View File

@ -1,21 +0,0 @@
In order to build the fuzzer one needs to build HarfBuzz and
harfbuzz/test/fuzzing/hb-fuzzer.cc with:
- Using the most recent Clang
- With -fsanitize=address (or =undefined, or a combination)
- With -fsanitize-coverage=edge[,8bit-counters,trace-cmp]
- With various defines that limit worst case exponential behavior.
See FUZZING_CPPFLAGS in harfbuzz/src/Makefile.am for the list.
- link against libFuzzer
To run the fuzzer one needs to first obtain a test corpus as a directory
containing interesting fonts. A good starting point is inside
harfbuzz/test/shaping/fonts/fonts/.
Then, run the fuzzer like this:
./hb-fuzzer -max_len=2048 CORPUS_DIR
Where max_len specifies the maximal length of font files to handle.
The smaller the faster.
For more details consult the following locations:
- http://llvm.org/docs/LibFuzzer.html or
- https://github.com/google/libfuzzer-bot/tree/master/harfbuzz
- https://github.com/harfbuzz/harfbuzz/issues/139

17
test/fuzzing/README.md Normal file
View File

@ -0,0 +1,17 @@
To build the fuzzers with libFuzzer to perform actual fuzzing, build with:
```shell
CXX=clang++ CXXFLAGS="-fsanitize=address,fuzzer-no-link" meson fuzzbuild --default-library=static -Dfuzzer_ldflags="-fsanitize=address,fuzzer"
ninja -Cfuzzbuild
```
Then, run the fuzzer like this:
fuzzbuild/test/fuzzing/hb-{shape,draw,subset,set}-fuzzer [-max_len=2048] [CORPUS_DIR]
Where max_len specifies the maximal length of font files to handle.
The smaller the faster.
For more details consult the following locations:
- http://llvm.org/docs/LibFuzzer.html