featurebase/roaring
Seebs 8095455355 container performance benchmarking
This adds a series of archetypal containers that represent the
common use cases (arrays, bitmaps, or runs of various cardinalities)
and runs the basic operations against them for benchmarking purposes.

`benchpretty` is an app to snatch the BenchmarkCt* lines from
benchmark runs and display them in a possibly more usable form,
mostly as a precursor to cool analysis things.

This also adds a test to verify that intersectionCount(a, b)
is the same as intersect(a, b).N() for all the archetypal
containers.

This also includes a performance fix for intersectBitmapRun which
was spotted while running these tests.
2020-10-22 14:33:03 -05:00
..
benchpretty container performance benchmarking 2020-10-22 14:33:03 -05:00
testdata cleanup #1622 2018-09-06 16:27:10 -05:00
btree.go roaring: fix use-after-free in b-tree bitmap update 2020-05-20 12:01:21 -04:00
btree_test.go enforce append-like semantics for *Container more consistently 2020-09-28 12:19:24 -05:00
container_archetypes.go container performance benchmarking 2020-10-22 14:33:03 -05:00
container_stash.go Check more carefully for, and also fix, containers with invalid N 2020-10-14 10:03:18 -05:00
containers_btree.go enforce append-like semantics for *Container more consistently 2020-09-28 12:19:24 -05:00
containers_slice.go when updating a container, drop the single-container cache 2020-08-17 11:23:47 -05:00
containers_test.go all test green on rbf. WOOT. 2020-08-12 21:08:30 +00:00
fuzz_test.go generalize test strings and break out old UnmarshalBinary code 2019-08-05 17:39:47 -05:00
fuzzer.go blue_green migration. holdbkg.go holder goroutine. 2020-09-11 14:24:15 -05:00
generation_debug.go Sources and Generations: tracking mmapped files 2019-11-12 12:14:29 -06:00
generation_nodebug.go Sources and Generations: tracking mmapped files 2019-11-12 12:14:29 -06: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
naive.go added go-fuzz testing for roaring ops vs naive implementation 2019-06-25 10:47:53 -05:00
naive_test.go Lower scale of some random-value tests 2020-06-08 12:10:40 -05:00
nop_inst.go double the nolint comments, double the checking 2019-10-11 15:17:51 -05:00
README.md Fixed typo 2019-06-17 16:47:28 -05:00
roaring.go container performance benchmarking 2020-10-22 14:33:03 -05:00
roaring_container_test.go container performance benchmarking 2020-10-22 14:33:03 -05:00
roaring_helpers_test.go all test green on rbf. WOOT. 2020-08-12 21:08:30 +00:00
roaring_internal_test.go Merge branch 'master' into impossible 2020-10-14 18:40:50 -05:00
roaring_nop_paranoia.go Check more carefully for, and also fix, containers with invalid N 2020-10-14 10:03:18 -05:00
roaring_nop_sentinel.go switched naive_test.go to table driven tests 2019-06-25 17:25:07 -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 Check more carefully for, and also fix, containers with invalid N 2020-10-14 10:03:18 -05:00
roaring_sentinel.go switched naive_test.go to table driven tests 2019-06-25 17:25:07 -05:00
roaring_stats.go v2.0.0 2019-10-08 14:56:17 -06:00
roaring_test.go test that roaring.Container.UnionInPlace does 2020-08-24 17:06:41 -05:00
source.go Sources and Generations: tracking mmapped files 2019-11-12 12:14:29 -06:00
unmarshal_binary.go enforce append-like semantics for *Container more consistently 2020-09-28 12:19:24 -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=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!