featurebase/roaring
Seebs 74ae1fd598 export and improve DifferenceInPlace
We don't need to manually copy each individual item and keep
checking for the second index being out of bounds for every
item, we know it can't change at this point, so we can just bump
it over. We want this operation because BitmapRewriter can
use it to simplify trimming in some cases.
2022-04-12 12:24:22 -05:00
..
benchpretty Upgrade go.mod to featurebase/v3 2022-01-21 10:57:05 -07:00
testdata cleanup #1622 2018-09-06 16:27:10 -05:00
add.go add copyright notice back in 2021-12-10 11:01:04 -06:00
add_test.go add copyright notice back in 2021-12-10 11:01:04 -06:00
btree.go roaring: fix use-after-free in b-tree bitmap update 2020-05-20 12:01:21 -04:00
btree_test.go remove references to LICENSE and checks for it in source files 2021-11-19 10:38:06 -06:00
container_archetypes.go add copyright notice back in 2021-12-10 11:01:04 -06:00
container_stash.go implement RemakeContainerFrom and helper function for it 2022-04-12 12:24:22 -05:00
containers_btree.go add copyright notice back in 2021-12-10 11:01:04 -06:00
containers_slice.go add copyright notice back in 2021-12-10 11:01:04 -06:00
containers_test.go implement RemakeContainerFrom and helper function for it 2022-04-12 12:24:22 -05:00
filter.go create BitmapRewriter/ApplyRewriter, parallel to BitmapFilter 2022-04-12 12:24:22 -05:00
filter_internal_test.go Upgrade go.mod to featurebase/v3 2022-01-21 10:57:05 -07:00
fuzz_test.go add copyright notice back in 2021-12-10 11:01:04 -06:00
fuzzer.go add copyright notice back in 2021-12-10 11:01:04 -06:00
inst.go add copyright notice back in 2021-12-10 11:01:04 -06:00
naive.go add copyright notice back in 2021-12-10 11:01:04 -06:00
naive_test.go add copyright notice back in 2021-12-10 11:01:04 -06:00
nop_inst.go add copyright notice back in 2021-12-10 11:01:04 -06:00
printutil.go Upgrade go.mod to featurebase/v3 2022-01-21 10:57:05 -07:00
printutil_test.go Upgrade go.mod to featurebase/v3 2022-01-21 10:57:05 -07:00
README.md Fixed typo 2019-06-17 16:47:28 -05:00
roaring.go export and improve DifferenceInPlace 2022-04-12 12:24:22 -05:00
roaring_container_test.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_helpers_test.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_internal_test.go export and improve DifferenceInPlace 2022-04-12 12:24:22 -05:00
roaring_nop_paranoia.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_nop_sentinel.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_nop_stats.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_paranoia.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_sentinel.go add copyright notice back in 2021-12-10 11:01:04 -06:00
roaring_stats.go Upgrade go.mod to featurebase/v3 2022-01-21 10:57:05 -07:00
roaring_test.go Upgrade go.mod to featurebase/v3 2022-01-21 10:57:05 -07:00
unmarshal_binary.go add copyright notice back in 2021-12-10 11:01:04 -06: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=FuzzBitmapUnmarshalBinary

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!