/
db.go
370 lines (318 loc) · 11 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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/*
Copyright IBM Corp. 2016 All Rights Reserved.
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 db
import (
"fmt"
"io"
"os"
"path"
"strings"
"github.com/op/go-logging"
"github.com/spf13/viper"
"github.com/tecbot/gorocksdb"
)
var dbLogger = logging.MustGetLogger("db")
var rocksDBLogLevelMap = map[string]gorocksdb.InfoLogLevel{
"debug": gorocksdb.DebugInfoLogLevel,
"info": gorocksdb.InfoInfoLogLevel,
"warn": gorocksdb.WarnInfoLogLevel,
"error": gorocksdb.ErrorInfoLogLevel,
"fatal": gorocksdb.FatalInfoLogLevel}
const blockchainCF = "blockchainCF"
const stateCF = "stateCF"
const stateDeltaCF = "stateDeltaCF"
const indexesCF = "indexesCF"
const persistCF = "persistCF"
var columnfamilies = []string{
blockchainCF, // blocks of the block chain
stateCF, // world state
stateDeltaCF, // open transaction state
indexesCF, // tx uuid -> blockno
persistCF, // persistent per-peer state (consensus)
}
// OpenchainDB encapsulates rocksdb's structures
type OpenchainDB struct {
DB *gorocksdb.DB
BlockchainCF *gorocksdb.ColumnFamilyHandle
StateCF *gorocksdb.ColumnFamilyHandle
StateDeltaCF *gorocksdb.ColumnFamilyHandle
IndexesCF *gorocksdb.ColumnFamilyHandle
PersistCF *gorocksdb.ColumnFamilyHandle
}
var openchainDB = create()
// Create create an openchainDB instance
func create() *OpenchainDB {
return &OpenchainDB{}
}
// GetDBHandle gets an opened openchainDB singleton. Note that method Start must always be invoked before this method.
func GetDBHandle() *OpenchainDB {
return openchainDB
}
// Start the db, init the openchainDB instance and open the db. Note this method has no guarantee correct behavior concurrent invocation.
func Start() {
openchainDB.open()
}
// Stop the db. Note this method has no guarantee correct behavior concurrent invocation.
func Stop() {
openchainDB.close()
}
// GetFromBlockchainCF get value for given key from column family - blockchainCF
func (openchainDB *OpenchainDB) GetFromBlockchainCF(key []byte) ([]byte, error) {
return openchainDB.Get(openchainDB.BlockchainCF, key)
}
// GetFromBlockchainCFSnapshot get value for given key from column family in a DB snapshot - blockchainCF
func (openchainDB *OpenchainDB) GetFromBlockchainCFSnapshot(snapshot *gorocksdb.Snapshot, key []byte) ([]byte, error) {
return openchainDB.getFromSnapshot(snapshot, openchainDB.BlockchainCF, key)
}
// GetFromStateCF get value for given key from column family - stateCF
func (openchainDB *OpenchainDB) GetFromStateCF(key []byte) ([]byte, error) {
return openchainDB.Get(openchainDB.StateCF, key)
}
// GetFromStateDeltaCF get value for given key from column family - stateDeltaCF
func (openchainDB *OpenchainDB) GetFromStateDeltaCF(key []byte) ([]byte, error) {
return openchainDB.Get(openchainDB.StateDeltaCF, key)
}
// GetFromIndexesCF get value for given key from column family - indexCF
func (openchainDB *OpenchainDB) GetFromIndexesCF(key []byte) ([]byte, error) {
return openchainDB.Get(openchainDB.IndexesCF, key)
}
// GetBlockchainCFIterator get iterator for column family - blockchainCF
func (openchainDB *OpenchainDB) GetBlockchainCFIterator() *gorocksdb.Iterator {
return openchainDB.GetIterator(openchainDB.BlockchainCF)
}
// GetStateCFIterator get iterator for column family - stateCF
func (openchainDB *OpenchainDB) GetStateCFIterator() *gorocksdb.Iterator {
return openchainDB.GetIterator(openchainDB.StateCF)
}
// GetStateCFSnapshotIterator get iterator for column family - stateCF. This iterator
// is based on a snapshot and should be used for long running scans, such as
// reading the entire state. Remember to call iterator.Close() when you are done.
func (openchainDB *OpenchainDB) GetStateCFSnapshotIterator(snapshot *gorocksdb.Snapshot) *gorocksdb.Iterator {
return openchainDB.getSnapshotIterator(snapshot, openchainDB.StateCF)
}
// GetStateDeltaCFIterator get iterator for column family - stateDeltaCF
func (openchainDB *OpenchainDB) GetStateDeltaCFIterator() *gorocksdb.Iterator {
return openchainDB.GetIterator(openchainDB.StateDeltaCF)
}
// GetSnapshot returns a point-in-time view of the DB. You MUST call snapshot.Release()
// when you are done with the snapshot.
func (openchainDB *OpenchainDB) GetSnapshot() *gorocksdb.Snapshot {
return openchainDB.DB.NewSnapshot()
}
func getDBPath() string {
dbPath := viper.GetString("peer.fileSystemPath")
if dbPath == "" {
panic("DB path not specified in configuration file. Please check that property 'peer.fileSystemPath' is set")
}
if !strings.HasSuffix(dbPath, "/") {
dbPath = dbPath + "/"
}
return dbPath + "db"
}
// Open open underlying rocksdb
func (openchainDB *OpenchainDB) open() {
dbPath := getDBPath()
missing, err := dirMissingOrEmpty(dbPath)
if err != nil {
panic(fmt.Sprintf("Error while trying to open DB: %s", err))
}
dbLogger.Debugf("Is db path [%s] empty [%t]", dbPath, missing)
if missing {
err = os.MkdirAll(path.Dir(dbPath), 0755)
if err != nil {
panic(fmt.Sprintf("Error making directory path [%s]: %s", dbPath, err))
}
}
opts := gorocksdb.NewDefaultOptions()
defer opts.Destroy()
maxLogFileSize := viper.GetInt("peer.db.maxLogFileSize")
if maxLogFileSize > 0 {
dbLogger.Infof("Setting rocksdb maxLogFileSize to %d", maxLogFileSize)
opts.SetMaxLogFileSize(maxLogFileSize)
}
keepLogFileNum := viper.GetInt("peer.db.keepLogFileNum")
if keepLogFileNum > 0 {
dbLogger.Infof("Setting rocksdb keepLogFileNum to %d", keepLogFileNum)
opts.SetKeepLogFileNum(keepLogFileNum)
}
logLevelStr := viper.GetString("peer.db.loglevel")
logLevel, ok := rocksDBLogLevelMap[logLevelStr]
if ok {
dbLogger.Infof("Setting rocks db InfoLogLevel to %d", logLevel)
opts.SetInfoLogLevel(logLevel)
}
opts.SetCreateIfMissing(missing)
opts.SetCreateIfMissingColumnFamilies(true)
cfNames := []string{"default"}
cfNames = append(cfNames, columnfamilies...)
var cfOpts []*gorocksdb.Options
for range cfNames {
cfOpts = append(cfOpts, opts)
}
db, cfHandlers, err := gorocksdb.OpenDbColumnFamilies(opts, dbPath, cfNames, cfOpts)
if err != nil {
panic(fmt.Sprintf("Error opening DB: %s", err))
}
openchainDB.DB = db
openchainDB.BlockchainCF = cfHandlers[1]
openchainDB.StateCF = cfHandlers[2]
openchainDB.StateDeltaCF = cfHandlers[3]
openchainDB.IndexesCF = cfHandlers[4]
openchainDB.PersistCF = cfHandlers[5]
}
// Close releases all column family handles and closes rocksdb
func (openchainDB *OpenchainDB) close() {
openchainDB.BlockchainCF.Destroy()
openchainDB.StateCF.Destroy()
openchainDB.StateDeltaCF.Destroy()
openchainDB.IndexesCF.Destroy()
openchainDB.PersistCF.Destroy()
openchainDB.DB.Close()
}
// DeleteState delets ALL state keys/values from the DB. This is generally
// only used during state synchronization when creating a new state from
// a snapshot.
func (openchainDB *OpenchainDB) DeleteState() error {
err := openchainDB.DB.DropColumnFamily(openchainDB.StateCF)
if err != nil {
dbLogger.Errorf("Error dropping state CF: %s", err)
return err
}
err = openchainDB.DB.DropColumnFamily(openchainDB.StateDeltaCF)
if err != nil {
dbLogger.Errorf("Error dropping state delta CF: %s", err)
return err
}
opts := gorocksdb.NewDefaultOptions()
defer opts.Destroy()
openchainDB.StateCF, err = openchainDB.DB.CreateColumnFamily(opts, stateCF)
if err != nil {
dbLogger.Errorf("Error creating state CF: %s", err)
return err
}
openchainDB.StateDeltaCF, err = openchainDB.DB.CreateColumnFamily(opts, stateDeltaCF)
if err != nil {
dbLogger.Errorf("Error creating state delta CF: %s", err)
return err
}
return nil
}
// Get returns the valud for the given column family and key
func (openchainDB *OpenchainDB) Get(cfHandler *gorocksdb.ColumnFamilyHandle, key []byte) ([]byte, error) {
opt := gorocksdb.NewDefaultReadOptions()
defer opt.Destroy()
slice, err := openchainDB.DB.GetCF(opt, cfHandler, key)
if err != nil {
dbLogger.Errorf("Error while trying to retrieve key: %s", key)
return nil, err
}
defer slice.Free()
if slice.Data() == nil {
return nil, nil
}
data := makeCopy(slice.Data())
return data, nil
}
// Put saves the key/value in the given column family
func (openchainDB *OpenchainDB) Put(cfHandler *gorocksdb.ColumnFamilyHandle, key []byte, value []byte) error {
opt := gorocksdb.NewDefaultWriteOptions()
defer opt.Destroy()
err := openchainDB.DB.PutCF(opt, cfHandler, key, value)
if err != nil {
dbLogger.Errorf("Error while trying to write key: %s", key)
return err
}
return nil
}
// Delete delets the given key in the specified column family
func (openchainDB *OpenchainDB) Delete(cfHandler *gorocksdb.ColumnFamilyHandle, key []byte) error {
opt := gorocksdb.NewDefaultWriteOptions()
defer opt.Destroy()
err := openchainDB.DB.DeleteCF(opt, cfHandler, key)
if err != nil {
dbLogger.Errorf("Error while trying to delete key: %s", key)
return err
}
return nil
}
func (openchainDB *OpenchainDB) getFromSnapshot(snapshot *gorocksdb.Snapshot, cfHandler *gorocksdb.ColumnFamilyHandle, key []byte) ([]byte, error) {
opt := gorocksdb.NewDefaultReadOptions()
defer opt.Destroy()
opt.SetSnapshot(snapshot)
slice, err := openchainDB.DB.GetCF(opt, cfHandler, key)
if err != nil {
dbLogger.Errorf("Error while trying to retrieve key: %s", key)
return nil, err
}
defer slice.Free()
data := append([]byte(nil), slice.Data()...)
return data, nil
}
// GetIterator returns an iterator for the given column family
func (openchainDB *OpenchainDB) GetIterator(cfHandler *gorocksdb.ColumnFamilyHandle) *gorocksdb.Iterator {
opt := gorocksdb.NewDefaultReadOptions()
opt.SetFillCache(true)
defer opt.Destroy()
return openchainDB.DB.NewIteratorCF(opt, cfHandler)
}
func (openchainDB *OpenchainDB) getSnapshotIterator(snapshot *gorocksdb.Snapshot, cfHandler *gorocksdb.ColumnFamilyHandle) *gorocksdb.Iterator {
opt := gorocksdb.NewDefaultReadOptions()
defer opt.Destroy()
opt.SetSnapshot(snapshot)
iter := openchainDB.DB.NewIteratorCF(opt, cfHandler)
return iter
}
func dirMissingOrEmpty(path string) (bool, error) {
dirExists, err := dirExists(path)
if err != nil {
return false, err
}
if !dirExists {
return true, nil
}
dirEmpty, err := dirEmpty(path)
if err != nil {
return false, err
}
if dirEmpty {
return true, nil
}
return false, nil
}
func dirExists(path string) (bool, error) {
_, err := os.Stat(path)
if err == nil {
return true, nil
}
if os.IsNotExist(err) {
return false, nil
}
return false, err
}
func dirEmpty(path string) (bool, error) {
f, err := os.Open(path)
if err != nil {
return false, err
}
defer f.Close()
_, err = f.Readdir(1)
if err == io.EOF {
return true, nil
}
return false, err
}
func makeCopy(src []byte) []byte {
dest := make([]byte, len(src))
copy(dest, src)
return dest
}