0
0
Fork 0

added gtreap in-memory, copy-on-write KVStore

This commit is contained in:
Steve Yen 2015-01-12 11:10:44 -08:00
parent d68c52e621
commit 603c3af8bb
4 changed files with 680 additions and 0 deletions

View File

@ -101,6 +101,7 @@ import (
// kv stores
_ "github.com/blevesearch/bleve/index/store/boltdb"
_ "github.com/blevesearch/bleve/index/store/inmem"
_ "github.com/blevesearch/bleve/index/store/gtreap"
// byte array converters
_ "github.com/blevesearch/bleve/analysis/byte_array_converters/ignore"

View File

@ -0,0 +1,353 @@
// Copyright (c) 2015 Couchbase, Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the
// License. You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an "AS
// IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language
// governing permissions and limitations under the License.
// Package gtreap provides an in-memory implementation of the
// KVStore interfaces using the gtreap balanced-binary treap,
// copy-on-write data structure.
package gtreap
import (
"bytes"
"math/rand"
"sync"
"github.com/blevesearch/bleve/index/store"
"github.com/blevesearch/bleve/registry"
"github.com/steveyen/gtreap"
)
const Name = "gtreap"
func init() {
registry.RegisterKVStore(Name, StoreConstructor)
}
func StoreConstructor(config map[string]interface{}) (store.KVStore, error) {
return &Store{t: gtreap.NewTreap(itemCompare)}, nil
}
type Item struct {
k []byte
v []byte
}
func itemCompare(a, b interface{}) int {
return bytes.Compare(a.(*Item).k, b.(*Item).k)
}
type Store struct {
m sync.Mutex
t *gtreap.Treap
}
type Reader struct {
t *gtreap.Treap
}
type Writer struct {
s *Store
m sync.Mutex
t *gtreap.Treap
}
type Iterator struct {
t *gtreap.Treap
m sync.Mutex
cancelCh chan struct{}
nextCh chan *Item
curr *Item
currOk bool
}
func newIterator(t *gtreap.Treap) *Iterator {
return &Iterator{t: t}
}
type Batch struct {
w *Writer
m sync.Mutex
ks [][]byte
vs [][]byte
ms map[string]store.AssociativeMergeChain
}
func (s *Store) Close() error {
s.m.Lock()
s.t = nil
s.m.Unlock()
return nil
}
func (s *Store) Reader() (store.KVReader, error) {
s.m.Lock()
t := s.t
s.m.Unlock()
return &Reader{t: t}, nil
}
func (s *Store) Writer() (store.KVWriter, error) {
s.m.Lock()
t := s.t
s.m.Unlock()
return &Writer{s: s, t: t}, nil
}
func (w *Reader) Get(k []byte) (v []byte, err error) {
itm := w.t.Get(&Item{k: k})
if itm != nil {
return itm.(*Item).v, nil
}
return nil, nil
}
func (w *Reader) Iterator(k []byte) store.KVIterator {
return newIterator(w.t).restart(&Item{k: k})
}
func (w *Reader) Close() error {
return nil
}
func (w *Writer) Get(k []byte) (v []byte, err error) {
w.m.Lock()
t := w.t
w.m.Unlock()
itm := t.Get(&Item{k: k})
if itm != nil {
return itm.(*Item).v, nil
}
return nil, nil
}
func (w *Writer) Iterator(k []byte) store.KVIterator {
w.m.Lock()
t := w.t
w.m.Unlock()
return newIterator(t).restart(&Item{k: k})
}
func (w *Writer) Close() error {
w.m.Lock()
w.t = nil
w.m.Unlock()
return nil
}
func (w *Writer) Set(k, v []byte) (err error) {
w.s.m.Lock()
w.s.t = w.s.t.Upsert(&Item{k: k, v: v}, rand.Int())
t := w.s.t
w.s.m.Unlock()
w.m.Lock()
w.t = t
w.m.Unlock()
return nil
}
func (w *Writer) Delete(k []byte) (err error) {
w.m.Lock()
w.t = w.t.Delete(&Item{k: k})
w.m.Unlock()
return nil
}
func (w *Writer) NewBatch() store.KVBatch {
return &Batch{w: w, ms: map[string]store.AssociativeMergeChain{}}
}
func (w *Iterator) SeekFirst() {
min := w.t.Min()
if min != nil {
w.restart(min.(*Item))
} else {
w.restart(nil)
}
}
func (w *Iterator) Seek(k []byte) {
w.restart(&Item{k: k})
}
func (w *Iterator) restart(start *Item) *Iterator {
cancelCh := make(chan struct{})
nextCh := make(chan *Item, 1)
w.m.Lock()
if w.cancelCh != nil {
close(w.cancelCh)
}
w.cancelCh = cancelCh
w.nextCh = nextCh
w.curr = nil
w.currOk = false
w.m.Unlock()
go func() {
if start != nil {
w.t.VisitAscend(start, func(itm gtreap.Item) bool {
select {
case <-cancelCh:
return false
case nextCh <- itm.(*Item):
return true
}
})
}
close(nextCh)
}()
w.Next()
return w
}
func (w *Iterator) Next() {
w.m.Lock()
nextCh := w.nextCh
w.m.Unlock()
w.curr, w.currOk = <-nextCh
}
func (w *Iterator) Current() ([]byte, []byte, bool) {
w.m.Lock()
defer w.m.Unlock()
if !w.currOk || w.curr == nil {
return nil, nil, false
}
return w.curr.k, w.curr.v, w.currOk
}
func (w *Iterator) Key() []byte {
k, _, ok := w.Current()
if !ok {
return nil
}
return k
}
func (w *Iterator) Value() []byte {
_, v, ok := w.Current()
if !ok {
return nil
}
return v
}
func (w *Iterator) Valid() bool {
_, _, ok := w.Current()
return ok
}
func (w *Iterator) Close() error {
w.m.Lock()
if w.cancelCh != nil {
close(w.cancelCh)
}
w.cancelCh = nil
w.nextCh = nil
w.curr = nil
w.currOk = false
w.m.Unlock()
return nil
}
func (w *Batch) Set(k, v []byte) {
w.m.Lock()
w.ks = append(w.ks, k)
w.vs = append(w.vs, v)
w.m.Unlock()
}
func (w *Batch) Delete(k []byte) {
w.m.Lock()
w.ks = append(w.ks, k)
w.vs = append(w.vs, nil)
w.m.Unlock()
}
func (w *Batch) Merge(k []byte, oper store.AssociativeMerge) {
key := string(k)
w.m.Lock()
w.ms[key] = append(w.ms[key], oper)
w.m.Unlock()
}
func (w *Batch) Execute() (err error) {
w.m.Lock()
ks := w.ks
w.ks = nil
vs := w.vs
w.vs = nil
ms := w.ms
w.ms = map[string]store.AssociativeMergeChain{}
w.m.Unlock()
done := false
for !done {
w.w.s.m.Lock()
torig := w.w.s.t
w.w.s.m.Unlock()
t := torig
for key, mc := range ms {
k := []byte(key)
itm := t.Get(&Item{k: k})
v := []byte(nil)
if itm != nil {
v = itm.(*Item).v
}
v, err := mc.Merge(k, v)
if err != nil {
return err
}
if v != nil {
t = t.Upsert(&Item{k: k, v: v}, rand.Int())
} else {
t = t.Delete(&Item{k: k})
}
}
for i, k := range ks {
v := vs[i]
if v != nil {
t = t.Upsert(&Item{k: k, v: v}, rand.Int())
} else {
t = t.Delete(&Item{k: k})
}
}
w.w.s.m.Lock()
if w.w.s.t == torig {
w.w.s.t = t
done = true
}
w.w.s.m.Unlock()
}
return nil
}
func (w *Batch) Close() error {
w.m.Lock()
w.ks = nil
w.vs = nil
w.ms = nil
w.m.Unlock()
return nil
}

View File

@ -0,0 +1,218 @@
// Copyright (c) 2014 Couchbase, Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the
// License. You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an "AS
// IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
// express or implied. See the License for the specific language
// governing permissions and limitations under the License.
package gtreap
import (
"reflect"
"testing"
"github.com/blevesearch/bleve/index/store"
)
func TestGTreapStore(t *testing.T) {
s, err := StoreConstructor(nil)
if err != nil {
t.Fatal(err)
}
CommonTestKVStore(t, s)
}
func TestReaderIsolation(t *testing.T) {
s, err := StoreConstructor(nil)
if err != nil {
t.Fatal(err)
}
CommonTestReaderIsolation(t, s)
}
func CommonTestKVStore(t *testing.T, s store.KVStore) {
writer, err := s.Writer()
if err != nil {
t.Error(err)
}
err = writer.Set([]byte("a"), []byte("val-a"))
if err != nil {
t.Fatal(err)
}
err = writer.Set([]byte("z"), []byte("val-z"))
if err != nil {
t.Fatal(err)
}
err = writer.Delete([]byte("z"))
if err != nil {
t.Fatal(err)
}
batch := writer.NewBatch()
batch.Set([]byte("b"), []byte("val-b"))
batch.Set([]byte("c"), []byte("val-c"))
batch.Set([]byte("d"), []byte("val-d"))
batch.Set([]byte("e"), []byte("val-e"))
batch.Set([]byte("f"), []byte("val-f"))
batch.Set([]byte("g"), []byte("val-g"))
batch.Set([]byte("h"), []byte("val-h"))
batch.Set([]byte("i"), []byte("val-i"))
batch.Set([]byte("j"), []byte("val-j"))
err = batch.Execute()
if err != nil {
t.Fatal(err)
}
writer.Close()
reader, err := s.Reader()
if err != nil {
t.Error(err)
}
defer reader.Close()
it := reader.Iterator([]byte("b"))
key, val, valid := it.Current()
if !valid {
t.Fatalf("valid false, expected true")
}
if string(key) != "b" {
t.Fatalf("expected key b, got %s", key)
}
if string(val) != "val-b" {
t.Fatalf("expected value val-b, got %s", val)
}
it.Next()
key, val, valid = it.Current()
if !valid {
t.Fatalf("valid false, expected true")
}
if string(key) != "c" {
t.Fatalf("expected key c, got %s", key)
}
if string(val) != "val-c" {
t.Fatalf("expected value val-c, got %s", val)
}
it.Seek([]byte("i"))
key, val, valid = it.Current()
if !valid {
t.Fatalf("valid false, expected true")
}
if string(key) != "i" {
t.Fatalf("expected key i, got %s", key)
}
if string(val) != "val-i" {
t.Fatalf("expected value val-i, got %s", val)
}
it.Close()
}
func CommonTestReaderIsolation(t *testing.T, s store.KVStore) {
// insert a kv pair
writer, err := s.Writer()
if err != nil {
t.Error(err)
}
err = writer.Set([]byte("a"), []byte("val-a"))
if err != nil {
t.Fatal(err)
}
writer.Close()
// create an isolated reader
reader, err := s.Reader()
if err != nil {
t.Error(err)
}
defer reader.Close()
// verify that we see the value already inserted
val, err := reader.Get([]byte("a"))
if err != nil {
t.Error(err)
}
if !reflect.DeepEqual(val, []byte("val-a")) {
t.Errorf("expected val-a, got nil")
}
// verify that an iterator sees it
count := 0
it := reader.Iterator([]byte{0})
defer it.Close()
for it.Valid() {
it.Next()
count++
}
if count != 1 {
t.Errorf("expected iterator to see 1, saw %d", count)
}
// add something after the reader was created
writer, err = s.Writer()
if err != nil {
t.Error(err)
}
err = writer.Set([]byte("b"), []byte("val-b"))
if err != nil {
t.Fatal(err)
}
writer.Close()
// ensure that a newer reader sees it
newReader, err := s.Reader()
if err != nil {
t.Error(err)
}
defer newReader.Close()
val, err = newReader.Get([]byte("b"))
if err != nil {
t.Error(err)
}
if !reflect.DeepEqual(val, []byte("val-b")) {
t.Errorf("expected val-b, got nil")
}
// ensure that the director iterator sees it
count = 0
it = newReader.Iterator([]byte{0})
defer it.Close()
for it.Valid() {
it.Next()
count++
}
if count != 2 {
t.Errorf("expected iterator to see 2, saw %d", count)
}
// but that the isolated reader does not
val, err = reader.Get([]byte("b"))
if err != nil {
t.Error(err)
}
if val != nil {
t.Errorf("expected nil, got %v", val)
}
// and ensure that the iterator on the isolated reader also does not
count = 0
it = reader.Iterator([]byte{0})
defer it.Close()
for it.Valid() {
it.Next()
count++
}
if count != 1 {
t.Errorf("expected iterator to see 1, saw %d", count)
}
}

View File

@ -0,0 +1,108 @@
// Copyright (c) 2014 Couchbase, Inc.
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
// except in compliance with the License. You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software distributed under the
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
// either express or implied. See the License for the specific language governing permissions
// and limitations under the License.
package upside_down
import (
"testing"
"github.com/blevesearch/bleve/index/store/gtreap"
)
func BenchmarkGTreapIndexing1Workers(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndex(b, s, 1)
}
func BenchmarkGTreapIndexing2Workers(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndex(b, s, 2)
}
func BenchmarkGTreapIndexing4Workers(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndex(b, s, 4)
}
// batches
func BenchmarkGTreapIndexing1Workers10Batch(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndexBatch(b, s, 1, 10)
}
func BenchmarkGTreapIndexing2Workers10Batch(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndexBatch(b, s, 2, 10)
}
func BenchmarkGTreapIndexing4Workers10Batch(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndexBatch(b, s, 4, 10)
}
func BenchmarkGTreapIndexing1Workers100Batch(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndexBatch(b, s, 1, 100)
}
func BenchmarkGTreapIndexing2Workers100Batch(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndexBatch(b, s, 2, 100)
}
func BenchmarkGTreapIndexing4Workers100Batch(b *testing.B) {
s, err := gtreap.StoreConstructor(nil)
if err != nil {
b.Fatal(err)
}
defer s.Close()
CommonBenchmarkIndexBatch(b, s, 4, 100)
}