-
Notifications
You must be signed in to change notification settings - Fork 324
/
kvstorewithbuffer.go
285 lines (244 loc) · 6.73 KB
/
kvstorewithbuffer.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
package db
import (
"bytes"
"context"
"fmt"
"github.com/pkg/errors"
"github.com/iotexproject/iotex-core/db/batch"
"github.com/iotexproject/iotex-core/pkg/log"
)
type (
withBuffer interface {
batch.Snapshot
SerializeQueue(batch.WriteInfoSerialize, batch.WriteInfoFilter) []byte
MustPut(string, []byte, []byte)
MustDelete(string, []byte)
Size() int
}
// KVStoreWithBuffer defines a KVStore with a buffer, which enables snapshot, revert,
// and transaction with multiple writes
KVStoreWithBuffer interface {
KVStore
withBuffer
}
// kvStoreWithBuffer is an implementation of KVStore, which buffers all the changes
kvStoreWithBuffer struct {
store KVStore
buffer batch.CachedBatch
}
// KVStoreFlusher is a wrapper of KVStoreWithBuffer, which has flush api
KVStoreFlusher interface {
SerializeQueue() []byte
Flush() error
KVStoreWithBuffer() KVStoreWithBuffer
BaseKVStore() KVStore
}
flusher struct {
kvb *kvStoreWithBuffer
serializeFilter batch.WriteInfoFilter
serialize batch.WriteInfoSerialize
flushTranslate batch.WriteInfoTranslate
}
// KVStoreFlusherOption sets option for KVStoreFlusher
KVStoreFlusherOption func(*flusher) error
)
// SerializeFilterOption sets the filter for serialize write queue
func SerializeFilterOption(filter batch.WriteInfoFilter) KVStoreFlusherOption {
return func(f *flusher) error {
if filter == nil {
return errors.New("filter cannot be nil")
}
f.serializeFilter = filter
return nil
}
}
// SerializeOption sets the serialize function for write queue
func SerializeOption(wis batch.WriteInfoSerialize) KVStoreFlusherOption {
return func(f *flusher) error {
if wis == nil {
return errors.New("serialize function cannot be nil")
}
f.serialize = wis
return nil
}
}
// FlushTranslateOption sets the translate for flush
func FlushTranslateOption(wit batch.WriteInfoTranslate) KVStoreFlusherOption {
return func(f *flusher) error {
if wit == nil {
return errors.New("translate cannot be nil")
}
f.flushTranslate = wit
return nil
}
}
// NewKVStoreFlusher returns kv store flusher
func NewKVStoreFlusher(store KVStore, buffer batch.CachedBatch, opts ...KVStoreFlusherOption) (KVStoreFlusher, error) {
if store == nil {
return nil, errors.New("store cannot be nil")
}
if buffer == nil {
return nil, errors.New("buffer cannot be nil")
}
f := &flusher{
kvb: &kvStoreWithBuffer{
store: store,
buffer: buffer,
},
}
for _, opt := range opts {
if err := opt(f); err != nil {
return nil, errors.Wrap(err, "failed to apply option")
}
}
return f, nil
}
func (f *flusher) Flush() error {
if err := f.kvb.store.WriteBatch(f.kvb.buffer.Translate(f.flushTranslate)); err != nil {
return err
}
f.kvb.buffer.Lock()
f.kvb.buffer.ClearAndUnlock()
return nil
}
func (f *flusher) SerializeQueue() []byte {
return f.kvb.SerializeQueue(f.serialize, f.serializeFilter)
}
func (f *flusher) KVStoreWithBuffer() KVStoreWithBuffer {
return f.kvb
}
func (f *flusher) BaseKVStore() KVStore {
return f.kvb.store
}
func (kvb *kvStoreWithBuffer) Start(ctx context.Context) error {
return kvb.store.Start(ctx)
}
func (kvb *kvStoreWithBuffer) Stop(ctx context.Context) error {
return kvb.store.Stop(ctx)
}
func (kvb *kvStoreWithBuffer) Snapshot() int {
return kvb.buffer.Snapshot()
}
func (kvb *kvStoreWithBuffer) RevertSnapshot(sid int) error {
return kvb.buffer.RevertSnapshot(sid)
}
func (kvb *kvStoreWithBuffer) ResetSnapshots() {
kvb.buffer.ResetSnapshots()
}
func (kvb *kvStoreWithBuffer) SerializeQueue(
serialize batch.WriteInfoSerialize,
filter batch.WriteInfoFilter,
) []byte {
return kvb.buffer.SerializeQueue(serialize, filter)
}
func (kvb *kvStoreWithBuffer) Size() int {
return kvb.buffer.Size()
}
func (kvb *kvStoreWithBuffer) Get(ns string, key []byte) ([]byte, error) {
value, err := kvb.buffer.Get(ns, key)
if errors.Cause(err) == batch.ErrNotExist {
value, err = kvb.store.Get(ns, key)
}
if errors.Cause(err) == batch.ErrAlreadyDeleted {
err = errors.Wrapf(ErrNotExist, "failed to get key %x in %s, deleted in buffer level", key, ns)
}
return value, err
}
func (kvb *kvStoreWithBuffer) Put(ns string, key, value []byte) error {
kvb.buffer.Put(ns, key, value, fmt.Sprintf("faild to put %x in %s", key, ns))
return nil
}
func (kvb *kvStoreWithBuffer) MustPut(ns string, key, value []byte) {
kvb.buffer.Put(ns, key, value, fmt.Sprintf("faild to put %x in %s", key, ns))
}
func (kvb *kvStoreWithBuffer) Delete(ns string, key []byte) error {
kvb.buffer.Delete(ns, key, fmt.Sprintf("failed to delete %x in %s", key, ns))
return nil
}
func (kvb *kvStoreWithBuffer) MustDelete(ns string, key []byte) {
kvb.buffer.Delete(ns, key, fmt.Sprintf("failed to delete %x in %s", key, ns))
}
func (kvb *kvStoreWithBuffer) Filter(ns string, cond Condition, minKey, maxKey []byte) ([][]byte, [][]byte, error) {
fk, fv, err := kvb.store.Filter(ns, cond, minKey, maxKey)
if err != nil {
return fk, fv, err
}
// filter the entries in buffer
checkMin := len(minKey) > 0
checkMax := len(maxKey) > 0
for i := 0; i < kvb.buffer.Size(); i++ {
entry, err := kvb.buffer.Entry(i)
if err != nil {
return nil, nil, err
}
if entry.Namespace() != ns {
continue
}
k, v := entry.Key(), entry.Value()
if checkMin && bytes.Compare(k, minKey) == -1 {
continue
}
if checkMax && bytes.Compare(k, maxKey) == 1 {
continue
}
if cond(k, v) {
switch entry.WriteType() {
case batch.Put:
// if DB contains the same key, that should be obsoleted
for i := range fk {
if bytes.Equal(fk[i], k) {
fk = append(fk[:i], fk[i+1:]...)
fv = append(fv[:i], fv[i+1:]...)
break
}
}
fk = append(fk, k)
fv = append(fv, v)
case batch.Delete:
for i := range fk {
if bytes.Equal(fk[i], k) {
fk = append(fk[:i], fk[i+1:]...)
fv = append(fv[:i], fv[i+1:]...)
break
}
}
}
}
}
return fk, fv, nil
}
func (kvb *kvStoreWithBuffer) WriteBatch(b batch.KVStoreBatch) (err error) {
b.Lock()
defer func() {
if err == nil {
// clear the batch if commit succeeds
b.ClearAndUnlock()
} else {
b.Unlock()
}
}()
writes := make([]*batch.WriteInfo, b.Size())
for i := 0; i < b.Size(); i++ {
write, e := b.Entry(i)
if e != nil {
return e
}
if write.WriteType() != batch.Put && write.WriteType() != batch.Delete {
return errors.Errorf("invalid write type %d", write.WriteType())
}
writes[i] = write
}
kvb.buffer.Lock()
defer kvb.buffer.Unlock()
for _, write := range writes {
switch write.WriteType() {
case batch.Put:
kvb.buffer.Put(write.Namespace(), write.Key(), write.Value(), write.Error())
case batch.Delete:
kvb.buffer.Delete(write.Namespace(), write.Key(), write.Error())
default:
log.S().Panic("unexpected write type")
}
}
return nil
}