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
|
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus 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 dexon-consensus 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 dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.
package db
import (
"encoding/json"
"io/ioutil"
"os"
"sync"
"github.com/dexon-foundation/dexon-consensus/common"
"github.com/dexon-foundation/dexon-consensus/core/crypto/dkg"
"github.com/dexon-foundation/dexon-consensus/core/types"
)
type blockSeqIterator struct {
idx int
db *MemBackedDB
}
// NextBlock implemenets BlockIterator.NextBlock method.
func (seq *blockSeqIterator) NextBlock() (types.Block, error) {
curIdx := seq.idx
seq.idx++
return seq.db.getBlockByIndex(curIdx)
}
// MemBackedDB is a memory backed DB implementation.
type MemBackedDB struct {
blocksLock sync.RWMutex
blockHashSequence common.Hashes
blocksByHash map[common.Hash]*types.Block
compactionChainTipLock sync.RWMutex
compactionChainTipHash common.Hash
compactionChainTipHeight uint64
dkgPrivateKeysLock sync.RWMutex
dkgPrivateKeys map[uint64]*dkg.PrivateKey
dkgMasterPrivateSharesLock sync.RWMutex
dkgMasterPrivateShares map[uint64]*dkg.PrivateKeyShares
persistantFilePath string
}
// NewMemBackedDB initialize a memory-backed database.
func NewMemBackedDB(persistantFilePath ...string) (
dbInst *MemBackedDB, err error) {
dbInst = &MemBackedDB{
blockHashSequence: common.Hashes{},
blocksByHash: make(map[common.Hash]*types.Block),
dkgPrivateKeys: make(map[uint64]*dkg.PrivateKey),
dkgMasterPrivateShares: make(map[uint64]*dkg.PrivateKeyShares),
}
if len(persistantFilePath) == 0 || len(persistantFilePath[0]) == 0 {
return
}
dbInst.persistantFilePath = persistantFilePath[0]
buf, err := ioutil.ReadFile(dbInst.persistantFilePath)
if err != nil {
if !os.IsNotExist(err) {
// Something unexpected happened.
return
}
// It's expected behavior that file doesn't exists, we should not
// report error on it.
err = nil
return
}
// Init this instance by file content, it's a temporary way
// to export those private field for JSON encoding.
toLoad := struct {
Sequence common.Hashes
ByHash map[common.Hash]*types.Block
}{}
err = json.Unmarshal(buf, &toLoad)
if err != nil {
return
}
dbInst.blockHashSequence = toLoad.Sequence
dbInst.blocksByHash = toLoad.ByHash
return
}
// HasBlock returns wheter or not the DB has a block identified with the hash.
func (m *MemBackedDB) HasBlock(hash common.Hash) bool {
m.blocksLock.RLock()
defer m.blocksLock.RUnlock()
_, ok := m.blocksByHash[hash]
return ok
}
// GetBlock returns a block given a hash.
func (m *MemBackedDB) GetBlock(hash common.Hash) (types.Block, error) {
m.blocksLock.RLock()
defer m.blocksLock.RUnlock()
return m.internalGetBlock(hash)
}
func (m *MemBackedDB) internalGetBlock(hash common.Hash) (types.Block, error) {
b, ok := m.blocksByHash[hash]
if !ok {
return types.Block{}, ErrBlockDoesNotExist
}
return *b, nil
}
// PutBlock inserts a new block into the database.
func (m *MemBackedDB) PutBlock(block types.Block) error {
if m.HasBlock(block.Hash) {
return ErrBlockExists
}
m.blocksLock.Lock()
defer m.blocksLock.Unlock()
m.blockHashSequence = append(m.blockHashSequence, block.Hash)
m.blocksByHash[block.Hash] = &block
return nil
}
// UpdateBlock updates a block in the database.
func (m *MemBackedDB) UpdateBlock(block types.Block) error {
if !m.HasBlock(block.Hash) {
return ErrBlockDoesNotExist
}
m.blocksLock.Lock()
defer m.blocksLock.Unlock()
m.blocksByHash[block.Hash] = &block
return nil
}
// PutCompactionChainTipInfo saves tip of compaction chain into the database.
func (m *MemBackedDB) PutCompactionChainTipInfo(
blockHash common.Hash, height uint64) error {
m.compactionChainTipLock.Lock()
defer m.compactionChainTipLock.Unlock()
if m.compactionChainTipHeight+1 != height {
return ErrInvalidCompactionChainTipHeight
}
m.compactionChainTipHeight = height
m.compactionChainTipHash = blockHash
return nil
}
// GetCompactionChainTipInfo get the tip info of compaction chain into the
// database.
func (m *MemBackedDB) GetCompactionChainTipInfo() (
hash common.Hash, height uint64) {
m.compactionChainTipLock.RLock()
defer m.compactionChainTipLock.RUnlock()
return m.compactionChainTipHash, m.compactionChainTipHeight
}
// HasDKGPrivateKey check existence of DKG private key of one round.
func (m *MemBackedDB) HasDKGPrivateKey(round uint64) (bool, error) {
m.dkgPrivateKeysLock.RLock()
defer m.dkgPrivateKeysLock.RUnlock()
_, exists := m.dkgPrivateKeys[round]
return exists, nil
}
// GetDKGPrivateKey get DKG private key of one round.
func (m *MemBackedDB) GetDKGPrivateKey(round uint64) (
dkg.PrivateKey, error) {
m.dkgPrivateKeysLock.RLock()
defer m.dkgPrivateKeysLock.RUnlock()
if prv, exists := m.dkgPrivateKeys[round]; exists {
return *prv, nil
}
return dkg.PrivateKey{}, ErrDKGPrivateKeyDoesNotExist
}
// PutDKGPrivateKey save DKG private key of one round.
func (m *MemBackedDB) PutDKGPrivateKey(
round uint64, prv dkg.PrivateKey) error {
m.dkgPrivateKeysLock.Lock()
defer m.dkgPrivateKeysLock.Unlock()
if _, exists := m.dkgPrivateKeys[round]; exists {
return ErrDKGPrivateKeyExists
}
m.dkgPrivateKeys[round] = &prv
return nil
}
// HasDKGMasterPrivateShares check existence of DKG master private shares of one round.
func (m *MemBackedDB) HasDKGMasterPrivateShares(round uint64) (bool, error) {
m.dkgMasterPrivateSharesLock.RLock()
defer m.dkgMasterPrivateSharesLock.RUnlock()
_, exists := m.dkgMasterPrivateShares[round]
return exists, nil
}
// GetDKGMasterPrivateShares get DKG master private shares of one round.
func (m *MemBackedDB) GetDKGMasterPrivateShares(round uint64) (
dkg.PrivateKeyShares, error) {
m.dkgMasterPrivateSharesLock.RLock()
defer m.dkgMasterPrivateSharesLock.RUnlock()
if shares, exists := m.dkgMasterPrivateShares[round]; exists {
return *shares, nil
}
return dkg.PrivateKeyShares{}, ErrDKGMasterPrivateSharesDoesNotExist
}
// PutOrUpdateDKGMasterPrivateShares save DKG master private shares of one round.
func (m *MemBackedDB) PutOrUpdateDKGMasterPrivateShares(
round uint64, shares dkg.PrivateKeyShares) error {
m.dkgMasterPrivateSharesLock.Lock()
defer m.dkgMasterPrivateSharesLock.Unlock()
m.dkgMasterPrivateShares[round] = &shares
return nil
}
// Close implement Closer interface, which would release allocated resource.
func (m *MemBackedDB) Close() (err error) {
// Save internal state to a pretty-print json file. It's a temporary way
// to dump private file via JSON encoding.
if len(m.persistantFilePath) == 0 {
return
}
m.blocksLock.RLock()
defer m.blocksLock.RUnlock()
toDump := struct {
Sequence common.Hashes
ByHash map[common.Hash]*types.Block
}{
Sequence: m.blockHashSequence,
ByHash: m.blocksByHash,
}
// Dump to JSON with 2-space indent.
buf, err := json.Marshal(&toDump)
if err != nil {
return
}
err = ioutil.WriteFile(m.persistantFilePath, buf, 0644)
return
}
func (m *MemBackedDB) getBlockByIndex(idx int) (types.Block, error) {
m.blocksLock.RLock()
defer m.blocksLock.RUnlock()
if idx >= len(m.blockHashSequence) {
return types.Block{}, ErrIterationFinished
}
hash := m.blockHashSequence[idx]
return m.internalGetBlock(hash)
}
// GetAllBlocks implement Reader.GetAllBlocks method, which allows caller
// to retrieve all blocks in DB.
func (m *MemBackedDB) GetAllBlocks() (BlockIterator, error) {
return &blockSeqIterator{db: m}, nil
}
|