summaryrefslogtreecommitdiff
path: root/agreement/fuzzer/clockedFilter_test.go
blob: 9ff93be65c43f9352062c9922b169941bdac1ddf (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
// Copyright (C) 2019-2024 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 fuzzer

import (
	"encoding/json"
	"fmt"

	"github.com/algorand/go-algorand/protocol"
)

type ClockedFilter struct {
	NetworkFilter

	upstream   UpstreamFilter
	downstream DownstreamFilter

	nodeID            int
	prevExternalClock int
	localClock        float32
	ratio             float32

	NetworkFilterFactory
	clockAspectRatio map[int]float32
}

func MakeClockedFilter(ratio map[int]float32) *ClockedFilter {
	return &ClockedFilter{
		clockAspectRatio: ratio,
	}
}

func (n *ClockedFilter) SendMessage(sourceNode, targetNode int, tag protocol.Tag, data []byte) {
	n.downstream.SendMessage(sourceNode, targetNode, tag, data)
}

func (n *ClockedFilter) GetDownstreamFilter() DownstreamFilter {
	return n.downstream
}

func (n *ClockedFilter) ReceiveMessage(sourceNode int, tag protocol.Tag, data []byte) {
	n.upstream.ReceiveMessage(sourceNode, tag, data)
}

func (n *ClockedFilter) SetDownstreamFilter(f DownstreamFilter) {
	n.downstream = f
}

func (n *ClockedFilter) SetUpstreamFilter(f UpstreamFilter) {
	n.upstream = f
}

func (n *ClockedFilter) CreateFilter(nodeID int, fuzzer *Fuzzer) NetworkFilter {
	f := &ClockedFilter{
		nodeID: nodeID,
	}
	if ratio, has := n.clockAspectRatio[n.nodeID]; has {
		f.ratio = ratio
		if ratio <= 0.0 {
			panic(fmt.Errorf("Invalid ratio specified (%v)", ratio))
		}
	} else {
		f.ratio = 1.0
	}
	return f
}

func (n *ClockedFilter) Tick(newClockTime int) bool {
	delta := newClockTime - n.prevExternalClock
	n.localClock += float32(delta) * n.ratio
	n.prevExternalClock = newClockTime
	return n.upstream.Tick(int(n.localClock))
}

// Unmarshall ClockedFilter
func (n *ClockedFilter) Unmarshal(b []byte) NetworkFilterFactory {
	type clockedFilterJSON struct {
		Name             string
		ClockAspectRatio map[int]float32
	}

	var jsonConfig clockedFilterJSON
	if err := json.Unmarshal(b, &jsonConfig); err != nil {
		return nil
	}
	if jsonConfig.Name != "ClockedFilter" {
		return nil
	}
	return &ClockedFilter{
		clockAspectRatio: jsonConfig.ClockAspectRatio,
	}
}

// register ClockedFilter
func init() {
	registeredFilterFactories = append(registeredFilterFactories, &ClockedFilter{})
}