forked from 0xPolygon/pbft-consensus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
transport.go
267 lines (222 loc) · 5.87 KB
/
transport.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
package e2e
import (
"log"
"math/rand"
"sync"
"time"
"github.com/0xPolygon/pbft-consensus"
)
type transport struct {
lock sync.Mutex
logger *log.Logger
nodes map[pbft.NodeID]transportHandler
hook transportHook
}
func (t *transport) addHook(hook transportHook) {
t.lock.Lock()
defer t.lock.Unlock()
t.hook = hook
}
func (t *transport) getHook() transportHook {
t.lock.Lock()
defer t.lock.Unlock()
return t.hook
}
type transportHandler func(pbft.NodeID, *pbft.MessageReq)
func (t *transport) Register(name pbft.NodeID, handler transportHandler) {
if t.nodes == nil {
t.nodes = map[pbft.NodeID]transportHandler{}
}
t.nodes[name] = handler
}
func (t *transport) Gossip(msg *pbft.MessageReq) error {
for to, handler := range t.nodes {
if msg.From == to {
continue
}
go func(to pbft.NodeID, handler transportHandler) {
send := true
if hook := t.getHook(); hook != nil {
send = hook.Gossip(msg.From, to, msg)
}
if send {
handler(to, msg)
t.logger.Printf("[TRACE] Message sent to %s - %s", to, msg)
} else {
t.logger.Printf("[TRACE] Message not sent to %s - %s", to, msg)
}
}(to, handler)
}
return nil
}
type transportHook interface {
Connects(from, to pbft.NodeID) bool
Gossip(from, to pbft.NodeID, msg *pbft.MessageReq) bool
Reset()
GetPartitions() map[string][]string
}
type sender pbft.NodeID
type receivers []pbft.NodeID
// Encapsulates message routing for certain round
type roundMetadata struct {
round uint64
routingMap map[sender]receivers
}
// Callback which enables determining which message should be gossiped
type gossipHandler func(sender, receiver pbft.NodeID, msg *pbft.MessageReq) bool
// Transport implementation which enables specifying custom gossiping logic
type genericGossipTransport struct {
flowMap map[uint64]roundMetadata
gossipHandler gossipHandler
}
// Initialize new generic gossip transport
func newGenericGossipTransport() *genericGossipTransport {
defaultGossipHandler := func(sender, receiver pbft.NodeID, msg *pbft.MessageReq) bool {
return true
}
return &genericGossipTransport{
flowMap: make(map[uint64]roundMetadata),
gossipHandler: defaultGossipHandler,
}
}
// Function which attaches gossip handler
func (t *genericGossipTransport) withGossipHandler(gossipHandler gossipHandler) *genericGossipTransport {
t.gossipHandler = gossipHandler
return t
}
// Function which sets message routing per round mapping
func (t *genericGossipTransport) withFlowMap(flowMap map[uint64]roundMetadata) *genericGossipTransport {
t.flowMap = flowMap
return t
}
// Function determining whether a message should be gossiped, based on provided flow map, which describes messages routing per round.
func (t *genericGossipTransport) shouldGossipBasedOnMsgFlowMap(msg *pbft.MessageReq, senderId pbft.NodeID, receiverId pbft.NodeID) bool {
roundMedatada, ok := t.flowMap[msg.View.Round]
if !ok {
return false
}
if roundMedatada.round == msg.View.Round {
receivers, ok := roundMedatada.routingMap[sender(senderId)]
if !ok {
return false
}
foundReceiver := false
for _, v := range receivers {
if v == receiverId {
foundReceiver = true
break
}
}
return foundReceiver
}
return true
}
func (t *genericGossipTransport) Gossip(from, to pbft.NodeID, msg *pbft.MessageReq) bool {
if t.gossipHandler != nil {
return t.gossipHandler(from, to, msg)
}
return true
}
func (t *genericGossipTransport) Connects(from, to pbft.NodeID) bool {
return true
}
func (t *genericGossipTransport) Reset() {
t.gossipHandler = nil
}
func (t *genericGossipTransport) GetPartitions() map[string][]string {
return nil
}
// latency transport
type randomTransport struct {
jitterMax time.Duration
}
func newRandomTransport(jitterMax time.Duration) transportHook {
return &randomTransport{jitterMax: jitterMax}
}
func (r *randomTransport) Connects(from, to pbft.NodeID) bool {
return true
}
func (r *randomTransport) Gossip(from, to pbft.NodeID, msg *pbft.MessageReq) bool {
// adds random latency between the queries
if r.jitterMax != 0 {
tt := timeJitter(r.jitterMax)
time.Sleep(tt)
}
return true
}
func (r *randomTransport) Reset() {
// no impl
}
func (r *randomTransport) GetPartitions() map[string][]string {
return nil
}
type partitionTransport struct {
jitterMax time.Duration
lock sync.Mutex
subsets map[string][]string
}
func newPartitionTransport(jitterMax time.Duration) *partitionTransport {
return &partitionTransport{jitterMax: jitterMax}
}
func (p *partitionTransport) isConnected(from, to pbft.NodeID) bool {
if p.subsets == nil {
return true
}
subset, ok := p.subsets[string(from)]
if !ok {
// if not set, they are connected
return true
}
found := false
for _, i := range subset {
if i == string(to) {
found = true
break
}
}
return found
}
func (p *partitionTransport) Connects(from, to pbft.NodeID) bool {
p.lock.Lock()
defer p.lock.Unlock()
return p.isConnected(from, to)
}
func (p *partitionTransport) Reset() {
p.lock.Lock()
defer p.lock.Unlock()
p.subsets = nil
}
func (p *partitionTransport) GetPartitions() map[string][]string {
return p.subsets
}
func (p *partitionTransport) addSubset(from string, to []string) {
if p.subsets == nil {
p.subsets = map[string][]string{}
}
if p.subsets[from] == nil {
p.subsets[from] = []string{}
}
p.subsets[from] = append(p.subsets[from], to...)
}
func (p *partitionTransport) Partition(subsets ...[]string) {
p.lock.Lock()
for _, subset := range subsets {
for _, i := range subset {
p.addSubset(i, subset)
}
}
p.lock.Unlock()
}
func (p *partitionTransport) Gossip(from, to pbft.NodeID, msg *pbft.MessageReq) bool {
p.lock.Lock()
isConnected := p.isConnected(from, to)
p.lock.Unlock()
if !isConnected {
return false
}
time.Sleep(timeJitter(p.jitterMax))
return true
}
func timeJitter(jitterMax time.Duration) time.Duration {
return time.Duration(uint64(rand.Int63()) % uint64(jitterMax))
}