-
Notifications
You must be signed in to change notification settings - Fork 197
/
topicResolverSender.go
358 lines (304 loc) · 12.4 KB
/
topicResolverSender.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
package topicResolverSender
import (
"fmt"
"sync"
"github.com/ElrondNetwork/elrond-go-core/core"
"github.com/ElrondNetwork/elrond-go-core/core/check"
"github.com/ElrondNetwork/elrond-go-core/core/random"
"github.com/ElrondNetwork/elrond-go-core/marshal"
logger "github.com/ElrondNetwork/elrond-go-logger"
"github.com/ElrondNetwork/elrond-go-p2p/message"
"github.com/ElrondNetwork/elrond-go/dataRetriever"
resolverDebug "github.com/ElrondNetwork/elrond-go/debug/resolver"
"github.com/ElrondNetwork/elrond-go/p2p"
)
const (
// topicRequestSuffix represents the topic name suffix
topicRequestSuffix = "_REQUEST"
minPeersToQuery = 2
preferredPeerIndex = -1
)
var _ dataRetriever.TopicResolverSender = (*topicResolverSender)(nil)
var log = logger.GetOrCreate("dataretriever/resolverstopicresolversender")
// ArgTopicResolverSender is the argument structure used to create new TopicResolverSender instance
type ArgTopicResolverSender struct {
Messenger dataRetriever.MessageHandler
TopicName string
PeerListCreator dataRetriever.PeerListCreator
Marshalizer marshal.Marshalizer
Randomizer dataRetriever.IntRandomizer
OutputAntiflooder dataRetriever.P2PAntifloodHandler
NumIntraShardPeers int
NumCrossShardPeers int
NumFullHistoryPeers int
CurrentNetworkEpochProvider dataRetriever.CurrentNetworkEpochProviderHandler
PreferredPeersHolder dataRetriever.PreferredPeersHolderHandler
SelfShardIdProvider dataRetriever.SelfShardIDProvider
PeersRatingHandler dataRetriever.PeersRatingHandler
TargetShardId uint32
}
type topicResolverSender struct {
messenger dataRetriever.MessageHandler
marshalizer marshal.Marshalizer
topicName string
peerListCreator dataRetriever.PeerListCreator
randomizer dataRetriever.IntRandomizer
outputAntiflooder dataRetriever.P2PAntifloodHandler
mutNumPeersToQuery sync.RWMutex
numIntraShardPeers int
numCrossShardPeers int
numFullHistoryPeers int
mutResolverDebugHandler sync.RWMutex
resolverDebugHandler dataRetriever.ResolverDebugHandler
currentNetworkEpochProviderHandler dataRetriever.CurrentNetworkEpochProviderHandler
preferredPeersHolderHandler dataRetriever.PreferredPeersHolderHandler
peersRatingHandler dataRetriever.PeersRatingHandler
selfShardId uint32
targetShardId uint32
}
// NewTopicResolverSender returns a new topic resolver instance
func NewTopicResolverSender(arg ArgTopicResolverSender) (*topicResolverSender, error) {
err := checkArgs(arg)
if err != nil {
return nil, err
}
resolver := &topicResolverSender{
messenger: arg.Messenger,
topicName: arg.TopicName,
peerListCreator: arg.PeerListCreator,
peersRatingHandler: arg.PeersRatingHandler,
marshalizer: arg.Marshalizer,
randomizer: arg.Randomizer,
targetShardId: arg.TargetShardId,
selfShardId: arg.SelfShardIdProvider.SelfId(),
outputAntiflooder: arg.OutputAntiflooder,
numIntraShardPeers: arg.NumIntraShardPeers,
numCrossShardPeers: arg.NumCrossShardPeers,
numFullHistoryPeers: arg.NumFullHistoryPeers,
currentNetworkEpochProviderHandler: arg.CurrentNetworkEpochProvider,
preferredPeersHolderHandler: arg.PreferredPeersHolder,
}
resolver.resolverDebugHandler = resolverDebug.NewDisabledInterceptorResolver()
return resolver, nil
}
func checkArgs(args ArgTopicResolverSender) error {
if check.IfNil(args.Messenger) {
return dataRetriever.ErrNilMessenger
}
if check.IfNil(args.Marshalizer) {
return dataRetriever.ErrNilMarshalizer
}
if check.IfNil(args.Randomizer) {
return dataRetriever.ErrNilRandomizer
}
if check.IfNil(args.PeerListCreator) {
return dataRetriever.ErrNilPeerListCreator
}
if check.IfNil(args.OutputAntiflooder) {
return dataRetriever.ErrNilAntifloodHandler
}
if check.IfNil(args.CurrentNetworkEpochProvider) {
return dataRetriever.ErrNilCurrentNetworkEpochProvider
}
if check.IfNil(args.PreferredPeersHolder) {
return dataRetriever.ErrNilPreferredPeersHolder
}
if check.IfNil(args.PeersRatingHandler) {
return dataRetriever.ErrNilPeersRatingHandler
}
if check.IfNil(args.SelfShardIdProvider) {
return dataRetriever.ErrNilSelfShardIDProvider
}
if args.NumIntraShardPeers < 0 {
return fmt.Errorf("%w for NumIntraShardPeers as the value should be greater or equal than 0",
dataRetriever.ErrInvalidValue)
}
if args.NumCrossShardPeers < 0 {
return fmt.Errorf("%w for NumCrossShardPeers as the value should be greater or equal than 0",
dataRetriever.ErrInvalidValue)
}
if args.NumFullHistoryPeers < 0 {
return fmt.Errorf("%w for NumFullHistoryPeers as the value should be greater or equal than 0",
dataRetriever.ErrInvalidValue)
}
if args.NumCrossShardPeers+args.NumIntraShardPeers < minPeersToQuery {
return fmt.Errorf("%w for NumCrossShardPeers, NumIntraShardPeers as their sum should be greater or equal than %d",
dataRetriever.ErrInvalidValue, minPeersToQuery)
}
return nil
}
// SendOnRequestTopic is used to send request data over channels (topics) to other peers
// This method only sends the request, the received data should be handled by interceptors
func (trs *topicResolverSender) SendOnRequestTopic(rd *dataRetriever.RequestData, originalHashes [][]byte) error {
buff, err := trs.marshalizer.Marshal(rd)
if err != nil {
return err
}
topicToSendRequest := trs.topicName + topicRequestSuffix
var numSentIntra, numSentCross int
var intraPeers, crossPeers []core.PeerID
fullHistoryPeers := make([]core.PeerID, 0)
if trs.currentNetworkEpochProviderHandler.EpochIsActiveInNetwork(rd.Epoch) {
crossPeers = trs.peerListCreator.CrossShardPeerList()
preferredPeer := trs.getPreferredPeer(trs.targetShardId)
numSentCross = trs.sendOnTopic(crossPeers, preferredPeer, topicToSendRequest, buff, trs.numCrossShardPeers, core.CrossShardPeer.String())
intraPeers = trs.peerListCreator.IntraShardPeerList()
preferredPeer = trs.getPreferredPeer(trs.selfShardId)
numSentIntra = trs.sendOnTopic(intraPeers, preferredPeer, topicToSendRequest, buff, trs.numIntraShardPeers, core.IntraShardPeer.String())
} else {
// TODO: select preferred peers of type full history as well.
fullHistoryPeers = trs.peerListCreator.FullHistoryList()
numSentIntra = trs.sendOnTopic(fullHistoryPeers, "", topicToSendRequest, buff, trs.numFullHistoryPeers, core.FullHistoryPeer.String())
}
trs.callDebugHandler(originalHashes, numSentIntra, numSentCross)
if numSentCross+numSentIntra == 0 {
return fmt.Errorf("%w, topic: %s, crossPeers: %d, intraPeers: %d, fullHistoryPeers: %d",
dataRetriever.ErrSendRequest,
trs.topicName,
len(crossPeers),
len(intraPeers),
len(fullHistoryPeers))
}
return nil
}
func (trs *topicResolverSender) callDebugHandler(originalHashes [][]byte, numSentIntra int, numSentCross int) {
trs.mutResolverDebugHandler.RLock()
defer trs.mutResolverDebugHandler.RUnlock()
trs.resolverDebugHandler.LogRequestedData(trs.topicName, originalHashes, numSentIntra, numSentCross)
}
func createIndexList(listLength int) []int {
indexes := make([]int, listLength)
for i := 0; i < listLength; i++ {
indexes[i] = i
}
return indexes
}
func (trs *topicResolverSender) sendOnTopic(
peerList []core.PeerID,
preferredPeer core.PeerID,
topicToSendRequest string,
buff []byte,
maxToSend int,
peerType string,
) int {
if len(peerList) == 0 || maxToSend == 0 {
return 0
}
histogramMap := make(map[string]int)
topRatedPeersList := trs.peersRatingHandler.GetTopRatedPeersFromList(peerList, maxToSend)
indexes := createIndexList(len(topRatedPeersList))
shuffledIndexes := random.FisherYatesShuffle(indexes, trs.randomizer)
logData := make([]interface{}, 0)
msgSentCounter := 0
shouldSendToPreferredPeer := preferredPeer != "" && maxToSend > 1
if shouldSendToPreferredPeer {
shuffledIndexes = append([]int{preferredPeerIndex}, shuffledIndexes...)
}
for idx := 0; idx < len(shuffledIndexes); idx++ {
peer := getPeerID(shuffledIndexes[idx], topRatedPeersList, preferredPeer, peerType, topicToSendRequest, histogramMap)
err := trs.sendToConnectedPeer(topicToSendRequest, buff, peer)
if err != nil {
continue
}
logData = append(logData, peerType)
logData = append(logData, peer.Pretty())
msgSentCounter++
if msgSentCounter == maxToSend {
break
}
}
log.Trace("requests are sent to", logData...)
log.Trace("request peers histogram", "max peers to send", maxToSend, "topic", topicToSendRequest, "histogram", histogramMap)
return msgSentCounter
}
func getPeerID(index int, peersList []core.PeerID, preferredPeer core.PeerID, peerType string, topic string, histogramMap map[string]int) core.PeerID {
if index == preferredPeerIndex {
histogramMap["preferred"]++
log.Trace("sending request to preferred peer", "peer", preferredPeer.Pretty(), "topic", topic, "peer type", peerType)
return preferredPeer
}
histogramMap[peerType]++
return peersList[index]
}
func (trs *topicResolverSender) getPreferredPeer(shardID uint32) core.PeerID {
peersInShard, found := trs.getPreferredPeersInShard(shardID)
if !found {
return ""
}
randomIdx := trs.randomizer.Intn(len(peersInShard))
return peersInShard[randomIdx]
}
func (trs *topicResolverSender) getPreferredPeersInShard(shardID uint32) ([]core.PeerID, bool) {
preferredPeers := trs.preferredPeersHolderHandler.Get()
peers, found := preferredPeers[shardID]
if !found || len(peers) == 0 {
return nil, false
}
return peers, true
}
// Send is used to send an array buffer to a connected peer
// It is used when replying to a request
func (trs *topicResolverSender) Send(buff []byte, peer core.PeerID) error {
return trs.sendToConnectedPeer(trs.topicName, buff, peer)
}
func (trs *topicResolverSender) sendToConnectedPeer(topic string, buff []byte, peer core.PeerID) error {
msg := &message.Message{
DataField: buff,
PeerField: peer,
TopicField: topic,
}
shouldAvoidAntiFloodCheck := trs.preferredPeersHolderHandler.Contains(peer)
if shouldAvoidAntiFloodCheck {
return trs.messenger.SendToConnectedPeer(topic, buff, peer)
}
err := trs.outputAntiflooder.CanProcessMessage(msg, peer)
if err != nil {
return fmt.Errorf("%w while sending %d bytes to peer %s",
err,
len(buff),
p2p.PeerIdToShortString(peer),
)
}
return trs.messenger.SendToConnectedPeer(topic, buff, peer)
}
// ResolverDebugHandler returns the debug handler used in resolvers
func (trs *topicResolverSender) ResolverDebugHandler() dataRetriever.ResolverDebugHandler {
trs.mutResolverDebugHandler.RLock()
defer trs.mutResolverDebugHandler.RUnlock()
return trs.resolverDebugHandler
}
// SetResolverDebugHandler sets the debug handler used in resolvers
func (trs *topicResolverSender) SetResolverDebugHandler(handler dataRetriever.ResolverDebugHandler) error {
if check.IfNil(handler) {
return dataRetriever.ErrNilResolverDebugHandler
}
trs.mutResolverDebugHandler.Lock()
trs.resolverDebugHandler = handler
trs.mutResolverDebugHandler.Unlock()
return nil
}
// RequestTopic returns the topic with the request suffix used for sending requests
func (trs *topicResolverSender) RequestTopic() string {
return trs.topicName + topicRequestSuffix
}
// TargetShardID returns the target shard ID for this resolver should serve data
func (trs *topicResolverSender) TargetShardID() uint32 {
return trs.targetShardId
}
// SetNumPeersToQuery will set the number of intra shard and cross shard number of peers to query
func (trs *topicResolverSender) SetNumPeersToQuery(intra int, cross int) {
trs.mutNumPeersToQuery.Lock()
trs.numIntraShardPeers = intra
trs.numCrossShardPeers = cross
trs.mutNumPeersToQuery.Unlock()
}
// NumPeersToQuery will return the number of intra shard and cross shard number of peer to query
func (trs *topicResolverSender) NumPeersToQuery() (int, int) {
trs.mutNumPeersToQuery.RLock()
defer trs.mutNumPeersToQuery.RUnlock()
return trs.numIntraShardPeers, trs.numCrossShardPeers
}
// IsInterfaceNil returns true if there is no value under the interface
func (trs *topicResolverSender) IsInterfaceNil() bool {
return trs == nil
}