/
orphan_manage.go
177 lines (149 loc) · 4.15 KB
/
orphan_manage.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
package protocol
import (
"sync"
"time"
log "github.com/sirupsen/logrus"
"github.com/bytom/bystack/protocol/bc"
"github.com/bytom/bystack/protocol/bc/types"
"github.com/bytom/bystack/testutil"
)
var (
orphanBlockTTL = 60 * time.Minute
orphanExpireWorkInterval = 3 * time.Minute
numOrphanBlockLimit = 256
)
type OrphanBlock struct {
*types.Block
expiration time.Time
}
func NewOrphanBlock(block *types.Block, expiration time.Time) *OrphanBlock {
return &OrphanBlock{
Block: block,
expiration: expiration,
}
}
func (o *OrphanBlock) Equals(o1 *OrphanBlock) bool {
return testutil.DeepEqual(o.Block, o1.Block)
}
// OrphanManage is use to handle all the orphan block
type OrphanManage struct {
orphan map[bc.Hash]*OrphanBlock
prevOrphans map[bc.Hash][]*bc.Hash
mtx sync.RWMutex
}
// NewOrphanManage return a new orphan block
func NewOrphanManage() *OrphanManage {
o := &OrphanManage{
orphan: make(map[bc.Hash]*OrphanBlock),
prevOrphans: make(map[bc.Hash][]*bc.Hash),
}
go o.orphanExpireWorker()
return o
}
// NewOrphanManageWithData return a new orphan manage with specify data
func NewOrphanManageWithData(orphan map[bc.Hash]*OrphanBlock, prevOrphans map[bc.Hash][]*bc.Hash) *OrphanManage {
return &OrphanManage{
orphan: orphan,
prevOrphans: prevOrphans,
}
}
// Add will add the block to OrphanManage
func (o *OrphanManage) Add(block *types.Block) {
blockHash := block.Hash()
o.mtx.Lock()
defer o.mtx.Unlock()
if _, ok := o.orphan[blockHash]; ok {
return
}
if len(o.orphan) >= numOrphanBlockLimit {
o.deleteLRU()
log.WithFields(log.Fields{"module": logModule, "hash": blockHash.String(), "height": block.Height}).Info("the number of orphan blocks exceeds the limit")
}
o.orphan[blockHash] = &OrphanBlock{block, time.Now().Add(orphanBlockTTL)}
o.prevOrphans[block.PreviousBlockHash] = append(o.prevOrphans[block.PreviousBlockHash], &blockHash)
log.WithFields(log.Fields{"module": logModule, "hash": blockHash.String(), "height": block.Height}).Info("add block to orphan")
}
// BlockExist check is the block in OrphanManage
func (o *OrphanManage) BlockExist(hash *bc.Hash) bool {
o.mtx.RLock()
_, ok := o.orphan[*hash]
o.mtx.RUnlock()
return ok
}
// Delete will delete the block from OrphanManage
func (o *OrphanManage) Delete(hash *bc.Hash) {
o.mtx.Lock()
defer o.mtx.Unlock()
o.delete(hash)
}
func (o *OrphanManage) Equals(o1 *OrphanManage) bool {
if o1 == nil {
return false
}
for hash, block := range o.orphan {
if block1, ok := o1.orphan[hash]; !ok || !block.Equals(block1) {
return false
}
}
return testutil.DeepEqual(o.prevOrphans, o1.prevOrphans)
}
// Get return the orphan block by hash
func (o *OrphanManage) Get(hash *bc.Hash) (*types.Block, bool) {
o.mtx.RLock()
block, ok := o.orphan[*hash]
o.mtx.RUnlock()
return block.Block, ok
}
// GetPrevOrphans return the list of child orphans
func (o *OrphanManage) GetPrevOrphans(hash *bc.Hash) ([]*bc.Hash, bool) {
o.mtx.RLock()
prevOrphans, ok := o.prevOrphans[*hash]
o.mtx.RUnlock()
return prevOrphans, ok
}
func (o *OrphanManage) delete(hash *bc.Hash) {
block, ok := o.orphan[*hash]
if !ok {
return
}
delete(o.orphan, *hash)
prevOrphans, ok := o.prevOrphans[block.Block.PreviousBlockHash]
if !ok || len(prevOrphans) == 1 {
delete(o.prevOrphans, block.Block.PreviousBlockHash)
return
}
for i, preOrphan := range prevOrphans {
if *preOrphan == *hash {
o.prevOrphans[block.Block.PreviousBlockHash] = append(prevOrphans[:i], prevOrphans[i+1:]...)
return
}
}
}
func (o *OrphanManage) deleteLRU() {
var deleteBlock *OrphanBlock
for _, orphan := range o.orphan {
if deleteBlock == nil || orphan.expiration.Before(deleteBlock.expiration) {
deleteBlock = orphan
}
}
if deleteBlock != nil {
blockHash := deleteBlock.Block.Hash()
o.delete(&blockHash)
}
}
func (o *OrphanManage) orphanExpireWorker() {
ticker := time.NewTicker(orphanExpireWorkInterval)
for now := range ticker.C {
o.orphanExpire(now)
}
ticker.Stop()
}
func (o *OrphanManage) orphanExpire(now time.Time) {
o.mtx.Lock()
defer o.mtx.Unlock()
for hash, orphan := range o.orphan {
if orphan.expiration.Before(now) {
o.delete(&hash)
}
}
}