/
db.go
325 lines (282 loc) · 7.95 KB
/
db.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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/*
* Copyright 2019 Insolar Technologies
*
* 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 storage
import (
"context"
"path/filepath"
"sync"
"github.com/dgraph-io/badger"
"github.com/insolar/insolar/configuration"
"github.com/insolar/insolar/core"
"github.com/insolar/insolar/ledger/storage/jet"
"github.com/insolar/insolar/ledger/storage/record"
"github.com/pkg/errors"
)
const (
scopeIDLifeline byte = 1
scopeIDRecord byte = 2
scopeIDJetDrop byte = 3
scopeIDPulse byte = 4
scopeIDSystem byte = 5
scopeIDMessage byte = 6
scopeIDBlob byte = 7
sysGenesis byte = 1
sysLatestPulse byte = 2
sysHeavyClientState byte = 3
sysLastSyncedPulseOnHeavy byte = 4
sysJetList byte = 5
sysDropSizeHistory byte = 6
)
// DBContext provides base db methods
//go:generate minimock -i github.com/insolar/insolar/ledger/storage.DBContext -o ./ -s _mock.go
type DBContext interface {
BeginTransaction(update bool) (*TransactionManager, error)
View(ctx context.Context, fn func(*TransactionManager) error) error
Update(ctx context.Context, fn func(*TransactionManager) error) error
IterateRecordsOnPulse(
ctx context.Context,
jetID core.RecordID,
pulse core.PulseNumber,
handler func(id core.RecordID, rec record.Record) error,
) error
StoreKeyValues(ctx context.Context, kvs []core.KV) error
GetBadgerDB() *badger.DB
Close() error
set(ctx context.Context, key, value []byte) error
get(ctx context.Context, key []byte) ([]byte, error)
// TODO i.markin 28.01.19: Delete after switching to conveyor architecture.
waitingFlight()
iterate(ctx context.Context,
prefix []byte,
handler func(k, v []byte) error,
) error
}
// DB represents BadgerDB storage implementation.
type DB struct {
PlatformCryptographyScheme core.PlatformCryptographyScheme `inject:""`
db *badger.DB
// dropLock protects dropWG from concurrent calls to Add and Wait
dropLock sync.Mutex
// dropWG guards inflight updates before jet drop calculated.
dropWG sync.WaitGroup
// for BadgerDB it is normal to have transaction conflicts
// and these conflicts we should resolve by ourself
// so txretiries is our knob to tune up retry logic.
txretiries int
idlocker *IDLocker
jetHeavyClientLocker *IDLocker
closeLock sync.RWMutex
isClosed bool
}
func setOptions(o *badger.Options) *badger.Options {
newo := &badger.Options{}
if o != nil {
*newo = *o
} else {
*newo = badger.DefaultOptions
}
return newo
}
// NewDB returns storage.DB with BadgerDB instance initialized by opts.
// Creates database in provided dir or in current directory if dir parameter is empty.
func NewDB(conf configuration.Ledger, opts *badger.Options) (DBContext, error) {
opts = setOptions(opts)
dir, err := filepath.Abs(conf.Storage.DataDirectory)
if err != nil {
return nil, err
}
opts.Dir = dir
opts.ValueDir = dir
bdb, err := badger.Open(*opts)
if err != nil {
return nil, errors.Wrap(err, "local database open failed")
}
db := &DB{
db: bdb,
txretiries: conf.Storage.TxRetriesOnConflict,
idlocker: NewIDLocker(),
jetHeavyClientLocker: NewIDLocker(),
}
return db, nil
}
// Close wraps BadgerDB Close method.
//
// From https://godoc.org/github.com/dgraph-io/badger#DB.Close:
// «It's crucial to call it to ensure all the pending updates make their way to disk.
// Calling DB.Close() multiple times is not safe and wouldcause panic.»
func (db *DB) Close() error {
db.closeLock.Lock()
defer db.closeLock.Unlock()
if db.isClosed {
return ErrClosed
}
db.isClosed = true
return db.db.Close()
}
// Stop stops DB component.
func (db *DB) Stop(ctx context.Context) error {
return db.Close()
}
// BeginTransaction opens a new transaction.
// All methods called on returned transaction manager will persist changes
// only after success on "Commit" call.
func (db *DB) BeginTransaction(update bool) (*TransactionManager, error) {
db.closeLock.RLock()
defer db.closeLock.RUnlock()
if db.isClosed {
return nil, ErrClosed
}
if update {
db.dropLock.Lock()
db.dropWG.Add(1)
db.dropLock.Unlock()
}
return &TransactionManager{
db: db,
update: update,
txupdates: make(map[string]keyval),
}, nil
}
// View accepts transaction function. All calls to received transaction manager will be consistent.
func (db *DB) View(ctx context.Context, fn func(*TransactionManager) error) error {
tx, err := db.BeginTransaction(false)
if err != nil {
return err
}
defer tx.Discard()
return fn(tx)
}
// Update accepts transaction function and commits changes. All calls to received transaction manager will be
// consistent and written tp disk or an error will be returned.
func (db *DB) Update(ctx context.Context, fn func(*TransactionManager) error) error {
tries := db.txretiries
var tx *TransactionManager
var err error
for {
tx, err = db.BeginTransaction(true)
if err != nil {
return err
}
err = fn(tx)
if err != nil {
break
}
err = tx.Commit()
if err == nil {
break
}
if err != badger.ErrConflict {
break
}
if tries < 1 {
if db.txretiries > 0 {
err = ErrConflictRetriesOver
} else {
err = ErrConflict
}
break
}
tries--
tx.Discard()
}
tx.Discard()
return err
}
// GetBadgerDB return badger.DB instance (for internal usage, like tests)
func (db *DB) GetBadgerDB() *badger.DB {
return db.db
}
// IterateRecordsOnPulse iterates over records on provided Jet ID and Pulse.
func (db *DB) IterateRecordsOnPulse(
ctx context.Context,
jetID core.RecordID,
pulse core.PulseNumber,
handler func(id core.RecordID, rec record.Record) error,
) error {
_, jetPrefix := jet.Jet(jetID)
prefix := prefixkey(scopeIDRecord, jetPrefix, pulse.Bytes())
return db.iterate(ctx, prefix, func(k, v []byte) error {
id := core.NewRecordID(pulse, k)
rec := record.DeserializeRecord(v)
err := handler(*id, rec)
if err != nil {
return err
}
return nil
})
}
// StoreKeyValues stores provided key/value pairs.
func (db *DB) StoreKeyValues(ctx context.Context, kvs []core.KV) error {
return db.Update(ctx, func(tx *TransactionManager) error {
for _, rec := range kvs {
err := tx.set(ctx, rec.K, rec.V)
if err != nil {
return err
}
}
return nil
})
}
func (db *DB) GetPlatformCryptographyScheme() core.PlatformCryptographyScheme {
return db.PlatformCryptographyScheme
}
// get wraps matching transaction manager method.
func (db *DB) get(ctx context.Context, key []byte) ([]byte, error) {
tx, err := db.BeginTransaction(false)
if err != nil {
return nil, err
}
defer tx.Discard()
return tx.get(ctx, key)
}
// set wraps matching transaction manager method.
func (db *DB) set(ctx context.Context, key, value []byte) error {
return db.Update(ctx, func(tx *TransactionManager) error {
return tx.set(ctx, key, value)
})
}
func (db *DB) waitingFlight() {
db.dropLock.Lock()
db.dropWG.Wait()
db.dropLock.Unlock()
}
func (db *DB) iterate(
ctx context.Context,
prefix []byte,
handler func(k, v []byte) error,
) error {
db.closeLock.RLock()
defer db.closeLock.RUnlock()
if db.isClosed {
return ErrClosed
}
return db.db.View(func(txn *badger.Txn) error {
it := txn.NewIterator(badger.DefaultIteratorOptions)
defer it.Close()
for it.Seek(prefix); it.ValidForPrefix(prefix); it.Next() {
key := it.Item().KeyCopy(nil)[len(prefix):]
value, err := it.Item().ValueCopy(nil)
if err != nil {
return err
}
err = handler(key, value)
if err != nil {
return err
}
}
return nil
})
}