summaryrefslogtreecommitdiff
path: root/network/peersheap.go
blob: 03224b0ea58056843d6ff8734311a2d1ae6bd1eb (plain)
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
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package network

type peersHeap struct {
	wn *WebsocketNetwork
}

// Push implements heap.Interface
func (ph peersHeap) Push(x interface{}) {
	wn := ph.wn
	p := x.(*wsPeer)
	wn.peers = append(wn.peers, p)
	p.peerIndex = len(wn.peers) - 1
}

// Pop implements heap.Interface
func (ph peersHeap) Pop() interface{} {
	wn := ph.wn
	end := len(wn.peers) - 1
	p := wn.peers[end]
	wn.peers[end] = nil // remove the entry from the peers list, so that the GC can recycle it's memory as needed.
	wn.peers = wn.peers[:end]
	return p
}

// Len implements heap.Interface
func (ph peersHeap) Len() int {
	wn := ph.wn
	return len(wn.peers)
}

// Swap implements heap.Interface
func (ph peersHeap) Swap(i, j int) {
	wn := ph.wn
	pi := wn.peers[i]
	pj := wn.peers[j]
	wn.peers[i] = pj
	wn.peers[j] = pi
	pi.peerIndex = j
	pj.peerIndex = i
}

// Less implements heap.Interface
func (ph peersHeap) Less(i, j int) bool {
	wn := ph.wn
	pi := wn.peers[i]
	pj := wn.peers[j]

	// Outgoing + explicitly listed peers are the highest priority
	if pj.outgoing || checkPrioPeers(wn, pj) {
		return false
	}
	if pi.outgoing || checkPrioPeers(wn, pi) {
		return true
	}

	// Bigger weight means lower position in wn.peers
	return pi.prioWeight > pj.prioWeight
}

func checkPrioPeers(wn *WebsocketNetwork, wp *wsPeer) bool {
	pp := wn.config.PriorityPeers
	if pp == nil {
		return false
	}

	addr := wp.OriginAddress()
	if addr == "" {
		return false
	}

	return pp[addr]
}