featurebase/roaring
2019-06-20 14:36:38 -05:00
..
testdata cleanup #1622 2018-09-06 16:27:10 -05:00
btree.go Make containers copy-on-write 2019-05-30 16:36:20 -05:00
btree_test.go Make containers copy-on-write 2019-05-30 16:36:20 -05:00
container_stash.go on freeze, unmap mapped containers 2019-05-31 16:17:06 -05:00
containers_btree.go Make containers copy-on-write 2019-05-30 16:36:20 -05:00
containers_slice.go handle insertions correctly 2019-06-10 15:22:38 -05:00
containers_test.go Make containers copy-on-write 2019-05-30 16:36:20 -05:00
fuzz_test.go Implemented previous fixes not present 2019-06-19 13:38:23 -05:00
fuzzer.go Added Licensing 2019-06-14 11:11:53 -05:00
inst.go Add license headers to files missing them and CI check to verify they are present. Fixes #1633 2019-04-12 11:30:41 -05:00
nop_inst.go Add license headers to files missing them and CI check to verify they are present. Fixes #1633 2019-04-12 11:30:41 -05:00
README.md Provided example on how to copy Pilosa fragments in README.md 2019-06-17 08:40:31 -05:00
roaring.go Returned files to original version 2019-06-20 14:35:35 -05:00
roaring_helpers_test.go Make containers copy-on-write 2019-05-30 16:36:20 -05:00
roaring_internal_test.go Revised test for pilosa roaring no containers 2019-06-20 14:36:38 -05:00
roaring_nop_paranoia.go Add license headers to files missing them and CI check to verify they are present. Fixes #1633 2019-04-12 11:30:41 -05:00
roaring_nop_stats.go Add license headers to files missing them and CI check to verify they are present. Fixes #1633 2019-04-12 11:30:41 -05:00
roaring_paranoia.go Add license headers to files missing them and CI check to verify they are present. Fixes #1633 2019-04-12 11:30:41 -05:00
roaring_stats.go Add license headers to files missing them and CI check to verify they are present. Fixes #1633 2019-04-12 11:30:41 -05:00
roaring_test.go Make containers copy-on-write 2019-05-30 16:36:20 -05:00

The Fuzzer

For complete documentation on go-fuzz, please see: https://github.com/dvyukov/go-fuzz

The fuzzer in relation to the roaring package checks the Bitmap.UnmarshalBinary function found in roaring.go. In order to use the fuzzer, you can follow these steps:

cd $GOPATH/src/github.com/pilosa/pilosa/roaring

go-fuzz-build ./

You must now make the workdir/corpus directory. This is achieved by:

mkdir workdir/corpus

The fuzzer needs some input to start the fuzzing with. Copy some sample Pilosa fragments into the workdir/corpus folder. For example:

cp ~/.pilosa/my-index/my-field/views/standard/fragments/0 workdir/corpus

Once you have copied your sample inputs, you are ready to run the fuzzer:

go-fuzz -bin=roaring-fuzz.zip -workdir=workdir -func=FuzzBitmapUnmarshalBianry

Understanding the Fuzzer Output

The fuzzer will output something similar to the follwoing:

2015/04/25 12:39:53 workers: 8, corpus: 124 (12s ago), crashers: 37, restarts: 1/15, execs: 35342 (2941/sec), cover: 403, uptime: 12s

The most important part of the output is the crashers and cover. The crashers records how many combinations were discovered that fail and the cover tells you how much code is being accessed. For a complete explanation of the output, please see: https://github.com/dvyukov/go-fuzz.

The fuzzer will document the crashers in a folder labeled "crashers." It will record the fragment and the error that was produced in two separate files within this folder. This is the final product.

Happy Fuzzing!