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
|
// Copyright 2018 The dexon-consensus-core Authors
// This file is part of the dexon-consensus-core library.
//
// The dexon-consensus-core 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-core 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-core library. If not, see
// <http://www.gnu.org/licenses/>.
package core
import (
"container/heap"
"fmt"
"sync"
"github.com/dexon-foundation/dexon-consensus-core/common"
"github.com/dexon-foundation/dexon-consensus-core/core/crypto"
"github.com/dexon-foundation/dexon-consensus-core/core/types"
)
// Errors for compaction chain module.
var (
ErrBlockNotRegistered = fmt.Errorf(
"block not registered")
ErrNotInitiazlied = fmt.Errorf(
"not initialized")
)
type finalizedBlockHeap = types.ByFinalizationHeight
type compactionChain struct {
gov Governance
tsigVerifier *TSigVerifierCache
blocks map[common.Hash]*types.Block
pendingBlocks []*types.Block
pendingFinalizedBlocks *finalizedBlockHeap
blocksLock sync.RWMutex
prevBlockLock sync.RWMutex
prevBlock *types.Block
}
func newCompactionChain(gov Governance) *compactionChain {
pendingFinalizedBlocks := &finalizedBlockHeap{}
heap.Init(pendingFinalizedBlocks)
return &compactionChain{
gov: gov,
tsigVerifier: NewTSigVerifierCache(gov, 7),
blocks: make(map[common.Hash]*types.Block),
pendingFinalizedBlocks: pendingFinalizedBlocks,
}
}
func (cc *compactionChain) init(initBlock *types.Block) {
cc.prevBlockLock.Lock()
defer cc.prevBlockLock.Unlock()
cc.prevBlock = initBlock
}
func (cc *compactionChain) registerBlock(block *types.Block) {
if cc.blockRegistered(block.Hash) {
return
}
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
cc.blocks[block.Hash] = block
}
func (cc *compactionChain) blockRegistered(hash common.Hash) (exist bool) {
cc.blocksLock.RLock()
defer cc.blocksLock.RUnlock()
_, exist = cc.blocks[hash]
return
}
func (cc *compactionChain) processBlock(block *types.Block) error {
prevBlock := cc.lastBlock()
if prevBlock == nil {
return ErrNotInitiazlied
}
block.Finalization.Height = prevBlock.Finalization.Height + 1
cc.prevBlockLock.Lock()
defer cc.prevBlockLock.Unlock()
cc.prevBlock = block
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
cc.pendingBlocks = append(cc.pendingBlocks, block)
return nil
}
func (cc *compactionChain) processFinalizedBlock(block *types.Block) {
if block.Finalization.Height <= cc.lastBlock().Finalization.Height {
return
}
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
heap.Push(cc.pendingFinalizedBlocks, block)
return
}
func (cc *compactionChain) extractFinalizedBlocks() []*types.Block {
prevBlock := cc.lastBlock()
blocks := func() []*types.Block {
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
blocks := []*types.Block{}
prevHeight := prevBlock.Finalization.Height
for cc.pendingFinalizedBlocks.Len() != 0 {
tip := (*cc.pendingFinalizedBlocks)[0]
// Pop blocks that are already confirmed.
if tip.Finalization.Height <= prevBlock.Finalization.Height {
heap.Pop(cc.pendingFinalizedBlocks)
continue
}
// Since we haven't verified the finalized block,
// it is possible to be forked.
if tip.Finalization.Height == prevHeight ||
tip.Finalization.Height == prevHeight+1 {
prevHeight = tip.Finalization.Height
blocks = append(blocks, tip)
heap.Pop(cc.pendingFinalizedBlocks)
} else {
break
}
}
return blocks
}()
toPending := []*types.Block{}
confirmed := []*types.Block{}
for _, b := range blocks {
if b.Hash == prevBlock.Hash &&
b.Finalization.Height == prevBlock.Finalization.Height {
continue
}
round := b.Position.Round
v, ok, err := cc.tsigVerifier.UpdateAndGet(round)
if err != nil {
continue
}
if !ok {
toPending = append(toPending, b)
continue
}
if ok := v.VerifySignature(b.Hash, crypto.Signature{
Type: "bls",
Signature: b.Finalization.Randomness}); !ok {
continue
}
// Fork resolution: choose block with smaller hash.
if prevBlock.Finalization.Height ==
b.Finalization.Height {
//TODO(jimmy-dexon): remove this panic after test.
if true {
// workaround to `go vet` error
panic(fmt.Errorf(
"forked finalized block %s,%s", prevBlock.Hash, b.Hash))
}
if b.Hash.Less(prevBlock.Hash) {
confirmed = confirmed[:len(confirmed)-1]
} else {
continue
}
}
if b.Finalization.Height-prevBlock.Finalization.Height > 1 {
toPending = append(toPending, b)
continue
}
confirmed = append(confirmed, b)
prevBlock = b
}
func() {
if len(confirmed) == 0 {
return
}
cc.prevBlockLock.Lock()
defer cc.prevBlockLock.Unlock()
cc.prevBlock = prevBlock
}()
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
for _, b := range toPending {
heap.Push(cc.pendingFinalizedBlocks, b)
}
return confirmed
}
func (cc *compactionChain) extractBlocks() []*types.Block {
deliveringBlocks := make([]*types.Block, 0)
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
for len(cc.pendingBlocks) != 0 &&
(len(cc.pendingBlocks[0].Finalization.Randomness) != 0 ||
cc.pendingBlocks[0].Position.Round == 0) {
var block *types.Block
block, cc.pendingBlocks = cc.pendingBlocks[0], cc.pendingBlocks[1:]
delete(cc.blocks, block.Hash)
deliveringBlocks = append(deliveringBlocks, block)
}
return deliveringBlocks
}
func (cc *compactionChain) processBlockRandomnessResult(
rand *types.BlockRandomnessResult) error {
if !cc.blockRegistered(rand.BlockHash) {
return ErrBlockNotRegistered
}
cc.blocksLock.Lock()
defer cc.blocksLock.Unlock()
cc.blocks[rand.BlockHash].Finalization.Randomness = rand.Randomness
return nil
}
func (cc *compactionChain) lastBlock() *types.Block {
cc.prevBlockLock.RLock()
defer cc.prevBlockLock.RUnlock()
return cc.prevBlock
}
|