eth/filters: added bloombits filter benchmarks

eth/filters/bench_test.go

@@ -0,0 +1,246 @@
+// Copyright 2017 The go-ethereum Authors
+// This file is part of the go-ethereum library.
+//
+// The go-ethereum library is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// The go-ethereum library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
+
+package filters
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/common/bitutil"
+	"github.com/ethereum/go-ethereum/core"
+	"github.com/ethereum/go-ethereum/core/bloombits"
+	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/ethdb"
+	"github.com/ethereum/go-ethereum/event"
+	"github.com/ethereum/go-ethereum/node"
+	"github.com/golang/snappy"
+)
+
+func BenchmarkBloomBits512(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 512)
+}
+
+func BenchmarkBloomBits1k(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 1024)
+}
+
+func BenchmarkBloomBits2k(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 2048)
+}
+
+func BenchmarkBloomBits4k(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 4096)
+}
+
+func BenchmarkBloomBits8k(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 8192)
+}
+
+func BenchmarkBloomBits16k(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 16384)
+}
+
+func BenchmarkBloomBits32k(b *testing.B) {
+	benchmarkBloomBitsForSize(b, 32768)
+}
+
+func benchmarkBloomBitsForSize(b *testing.B, sectionSize uint64) {
+	benchmarkBloomBits(b, sectionSize, 0)
+	benchmarkBloomBits(b, sectionSize, 1)
+	benchmarkBloomBits(b, sectionSize, 2)
+}
+
+const benchFilterCnt = 2000
+
+func benchmarkBloomBits(b *testing.B, sectionSize uint64, comp int) {
+	benchDataDir := node.DefaultDataDir() + "/geth/chaindata"
+	fmt.Println("Running bloombits benchmark   section size:", sectionSize, "  compression method:", comp)
+
+	var (
+		compressFn   func([]byte) []byte
+		decompressFn func([]byte, int) ([]byte, error)
+	)
+	switch comp {
+	case 0:
+		// no compression
+		compressFn = func(data []byte) []byte {
+			return data
+		}
+		decompressFn = func(data []byte, target int) ([]byte, error) {
+			if len(data) != target {
+				panic(nil)
+			}
+			return data, nil
+		}
+	case 1:
+		// bitutil/compress.go
+		compressFn = bitutil.CompressBytes
+		decompressFn = bitutil.DecompressBytes
+	case 2:
+		// go snappy
+		compressFn = func(data []byte) []byte {
+			return snappy.Encode(nil, data)
+		}
+		decompressFn = func(data []byte, target int) ([]byte, error) {
+			decomp, err := snappy.Decode(nil, data)
+			if err != nil || len(decomp) != target {
+				panic(err)
+			}
+			return decomp, nil
+		}
+	}
+
+	db, err := ethdb.NewLDBDatabase(benchDataDir, 128, 1024)
+	if err != nil {
+		b.Fatalf("error opening database at %v: %v", benchDataDir, err)
+	}
+	head := core.GetHeadBlockHash(db)
+	if head == (common.Hash{}) {
+		b.Fatalf("chain data not found at %v", benchDataDir)
+	}
+
+	clearBloomBits(db)
+	fmt.Println("Generating bloombits data...")
+	headNum := core.GetBlockNumber(db, head)
+	if headNum < sectionSize+512 {
+		b.Fatalf("not enough blocks for running a benchmark")
+	}
+
+	start := time.Now()
+	cnt := (headNum - 512) / sectionSize
+	var dataSize, compSize uint64
+	for sectionIdx := uint64(0); sectionIdx < cnt; sectionIdx++ {
+		bc := bloombits.NewBloomBitsCreator(sectionSize)
+		var header *types.Header
+		for i := sectionIdx * sectionSize; i < (sectionIdx+1)*sectionSize; i++ {
+			hash := core.GetCanonicalHash(db, i)
+			header = core.GetHeader(db, hash, i)
+			if header == nil {
+				b.Fatalf("Error creating bloomBits data")
+			}
+			bc.AddHeaderBloom(header.Bloom)
+		}
+		for i := 0; i < bloombits.BloomLength; i++ {
+			data := bc.GetBitVector(uint(i))
+			comp := compressFn(data)
+			dataSize += uint64(len(data))
+			compSize += uint64(len(comp))
+			core.StoreBloomBits(db, uint64(i), sectionIdx, comp)
+		}
+		//if sectionIdx%50 == 0 {
+		//	fmt.Println(" section", sectionIdx, "/", cnt)
+		//}
+	}
+	core.StoreBloomBitsAvailable(db, cnt)
+
+	d := time.Since(start)
+	fmt.Println("Finished generating bloombits data")
+	fmt.Println(" ", d, "total  ", d/time.Duration(cnt*sectionSize), "per block")
+	fmt.Println(" data size:", dataSize, "  compressed size:", compSize, "  compression ratio:", float64(compSize)/float64(dataSize))
+
+	fmt.Println("Running filter benchmarks...")
+	start = time.Now()
+	mux := new(event.TypeMux)
+	var backend *testBackend
+
+	for i := 0; i < benchFilterCnt; i++ {
+		if i%20 == 0 {
+			db.Close()
+			db, _ = ethdb.NewLDBDatabase(benchDataDir, 128, 1024)
+			backend = &testBackend{mux, db}
+		}
+		filter := New(backend, sectionSize)
+		filter.decompress = decompressFn
+		var addr common.Address
+		addr[0] = byte(i)
+		addr[1] = byte(i / 256)
+		filter.SetAddresses([]common.Address{addr})
+		filter.SetBeginBlock(0)
+		filter.SetEndBlock(int64(cnt*sectionSize - 1))
+		if _, err := filter.Find(context.Background()); err != nil {
+			b.Error("filter.Find error:", err)
+		}
+	}
+	d = time.Since(start)
+	fmt.Println("Finished running filter benchmarks")
+	fmt.Println(" ", d, "total  ", d/time.Duration(benchFilterCnt), "per address", d*time.Duration(1000000)/time.Duration(benchFilterCnt*cnt*sectionSize), "per million blocks")
+	db.Close()
+}
+
+func forEachKey(db ethdb.Database, startPrefix, endPrefix []byte, fn func(key []byte)) {
+	it := db.(*ethdb.LDBDatabase).NewIterator()
+	it.Seek(startPrefix)
+	for it.Valid() {
+		key := it.Key()
+		cmpLen := len(key)
+		if len(endPrefix) < cmpLen {
+			cmpLen = len(endPrefix)
+		}
+		if bytes.Compare(key[:cmpLen], endPrefix) == 1 {
+			break
+		}
+		fn(common.CopyBytes(key))
+		it.Next()
+	}
+	it.Release()
+}
+
+var bloomBitsPrefix = []byte("bloomBits-")
+
+func clearBloomBits(db ethdb.Database) {
+	fmt.Println("Clearing bloombits data...")
+	forEachKey(db, bloomBitsPrefix, bloomBitsPrefix, func(key []byte) {
+		db.Delete(key)
+	})
+	core.StoreBloomBitsAvailable(db, 0)
+	fmt.Println("Cleared bloombits data")
+}
+
+func BenchmarkNoBloomBits(b *testing.B) {
+	benchDataDir := node.DefaultDataDir() + "/geth/chaindata"
+	fmt.Println("Running benchmark without bloombits")
+	db, err := ethdb.NewLDBDatabase(benchDataDir, 128, 1024)
+	if err != nil {
+		b.Fatalf("error opening database at %v: %v", benchDataDir, err)
+	}
+	head := core.GetHeadBlockHash(db)
+	if head == (common.Hash{}) {
+		b.Fatalf("chain data not found at %v", benchDataDir)
+	}
+	headNum := core.GetBlockNumber(db, head)
+
+	clearBloomBits(db)
+
+	fmt.Println("Running filter benchmarks...")
+	start := time.Now()
+	mux := new(event.TypeMux)
+	backend := &testBackend{mux, db}
+	filter := New(backend, 4096) // give any dummy section size, no bloombits data is available
+	var addr common.Address
+	filter.SetAddresses([]common.Address{addr})
+	filter.SetBeginBlock(0)
+	filter.SetEndBlock(int64(headNum))
+	filter.Find(context.Background())
+	d := time.Since(start)
+	fmt.Println("Finished running filter benchmarks")
+	fmt.Println(" ", d, "total  ", d*time.Duration(1000000)/time.Duration(headNum+1), "per million blocks")
+	db.Close()
+}

eth/filters/filter.go

@@ -52,7 +52,8 @@ type Filter struct {
 	addresses  []common.Address
 	topics     [][]common.Hash
 
-	matcher *bloombits.Matcher
+	decompress func([]byte, int) ([]byte, error)
+	matcher    *bloombits.Matcher
 }
 
 // New creates a new filter which uses a bloom filter on blocks to figure out whether
@@ -63,6 +64,7 @@ func New(backend Backend, bloomBitsSection uint64) *Filter {
 		bloomBitsSection: bloomBitsSection,
 		db:               backend.ChainDb(),
 		matcher:          bloombits.NewMatcher(bloomBitsSection),
+		decompress:       bitutil.DecompressBytes,
 	}
 }
 
@@ -130,7 +132,7 @@ func (f *Filter) Find(ctx context.Context) (logs []*types.Log, err error) {
 // serveMatcher serves the bloomBits matcher by fetching the requested vectors
 // through the filter backend
 func (f *Filter) serveMatcher(ctx context.Context, stop chan struct{}, wg *sync.WaitGroup) chan error {
-	errChn := make(chan error)
+	errChn := make(chan error, 1)
 	wg.Add(10)
 	for i := 0; i < 10; i++ {
 		go func(i int) {
@@ -143,14 +145,20 @@ func (f *Filter) serveMatcher(ctx context.Context, stop chan struct{}, wg *sync.
 				}
 				data, err := f.backend.GetBloomBits(ctx, uint64(b), s)
 				if err != nil {
-					errChn <- err
+					select {
+					case errChn <- err:
+					case <-stop:
+					}
 					return
 				}
 				decomp := make([][]byte, len(data))
 				for i, d := range data {
 					var err error
-					if decomp[i], err = bitutil.DecompressBytes(d, int(f.bloomBitsSection)); err != nil {
+					if decomp[i], err = f.decompress(d, int(f.bloomBitsSection/8)); err != nil {
-						errChn <- err
+						select {
+						case errChn <- err:
+						case <-stop:
+						}
 						return
 					}
 				}