summaryrefslogtreecommitdiff
path: root/agreement/fuzzer/schedulerFilter_test.go
blob: d6e00e773443ecf7edfe6e3b78606a0020ee122e (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
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
// 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 fuzzer

import (
	"encoding/json"
	"fmt"

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

var _ = fmt.Printf

type ScheduleOperation int

const (
	After      ScheduleOperation = iota // 0
	Before     ScheduleOperation = iota // 1
	Between    ScheduleOperation = iota // 2
	NotAfter   ScheduleOperation = iota // 3
	NotBefore  ScheduleOperation = iota // 4
	NotBetween ScheduleOperation = iota // 5
)

type SchedulerFilterSchedule struct {
	FirstTick, SecondTick int
	Operation             ScheduleOperation
	Nodes                 []int // which nodes would be affected
}

type SchedulerFilterConfig struct {
	Filters       []NetworkFilterFactory
	Schedule      []SchedulerFilterSchedule
	ScheduleName  string
	DebugMessages bool
}

type SchedulerFilter struct {
	NetworkFilter
	upstream   UpstreamFilter
	downstream DownstreamFilter
	enabled    bool
	nodeID     int
	filters    []NetworkFilter
	lastTick   int

	NetworkFilterFactory
	factoryConfig *SchedulerFilterConfig
}

func (n *SchedulerFilter) SendMessage(sourceNode, targetNode int, tag protocol.Tag, data []byte) {
	nextFilter := n.downstream
	if n.enabled && len(n.filters) > 0 {
		nextFilter = n.filters[0]
	}
	nextFilter.SendMessage(sourceNode, targetNode, tag, data)
}

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

func (n *SchedulerFilter) ReceiveMessage(sourceNode int, tag protocol.Tag, data []byte) {
	nextFilter := n.upstream
	if n.enabled && len(n.filters) > 0 {
		nextFilter = n.filters[len(n.filters)-1]
	}
	nextFilter.ReceiveMessage(sourceNode, tag, data)
}

func (n *SchedulerFilter) SetDownstreamFilter(f DownstreamFilter) {
	n.downstream = f
	if len(n.filters) > 0 {
		n.filters[len(n.filters)-1].SetDownstreamFilter(f)
	}
}

func (n *SchedulerFilter) SetUpstreamFilter(f UpstreamFilter) {
	n.upstream = f
	if len(n.filters) > 0 {
		n.filters[0].SetUpstreamFilter(f)
	}
}

func (n *SchedulerFilter) CreateFilter(nodeID int, fuzzer *Fuzzer) NetworkFilter {
	f := &SchedulerFilter{
		factoryConfig: n.factoryConfig,
		nodeID:        nodeID,
		filters:       make([]NetworkFilter, len(n.factoryConfig.Filters)),
	}
	for i, factory := range n.factoryConfig.Filters {
		f.filters[i] = factory.CreateFilter(nodeID, fuzzer)
	}
	for i := 1; i < len(f.filters); i++ {
		f.filters[i].SetUpstreamFilter(f.filters[i-1])
	}
	for i := 0; i < len(f.filters)-1; i++ {
		f.filters[i].SetDownstreamFilter(f.filters[i+1])
	}
	f.Evaluate(0)
	return f
}

func (n *SchedulerFilter) Tick(newClockTime int) bool {
	deltaTick := newClockTime - n.lastTick
	n.lastTick = newClockTime
	n.Evaluate(newClockTime)
	nextFilter := n.upstream
	if n.enabled && len(n.filters) > 0 {
		nextFilter = n.filters[len(n.filters)-1]
	}
	tickResult := nextFilter.Tick(newClockTime)
	if tickResult {
		return true
	}
	// return true if we're going to change state before the next tick.
	for i := newClockTime + 1; i < newClockTime+deltaTick*2; i++ {
		for _, schedule := range n.factoryConfig.Schedule {
			if enabled := schedule.Evaluate(i, n.nodeID); enabled != n.enabled {
				return true
			}
		}
	}
	return false
}

func MakeScheduleFilterFactory(config *SchedulerFilterConfig) *SchedulerFilter {
	n := &SchedulerFilter{
		factoryConfig: config,
	}
	return n
}

func (n *SchedulerFilter) Evaluate(timepoint int) {
	enabled := false
	for _, schedule := range n.factoryConfig.Schedule {
		if enabled = schedule.Evaluate(timepoint, n.nodeID); enabled {
			break
		}
	}
	if n.enabled != enabled && n.factoryConfig.DebugMessages {
		fmt.Printf("SchedulerFilter(%s) service-%v switch to %v at %v\n", n.factoryConfig.ScheduleName, n.nodeID, enabled, timepoint)
	}
	n.enabled = enabled
}

func (n *SchedulerFilterSchedule) Evaluate(timepoint int, nodeID int) bool {
	// make sure nodeId is in Nodes
	found := false
	for _, node := range n.Nodes {
		if node == nodeID {
			found = true
		}
	}
	if !found {
		return false
	}
	switch n.Operation {
	case After:
		return n.FirstTick < timepoint
	case Before:
		return n.FirstTick > timepoint
	case Between:
		return (n.FirstTick < timepoint) && (n.SecondTick > timepoint)
	case NotAfter:
		return !(n.FirstTick < timepoint)
	case NotBefore:
		return !(n.FirstTick > timepoint)
	case NotBetween:
		return !((n.FirstTick < timepoint) && (n.SecondTick > timepoint))
	default:
		return false
	}
}

// Unmarshall SchedulerFilter
func (n *SchedulerFilter) Unmarshal(b []byte) NetworkFilterFactory {
	type schedulerFilterConfigJSON struct {
		Name         string
		Filters      []interface{}
		Schedule     []SchedulerFilterSchedule
		ScheduleName string
	}

	var jsonConfig schedulerFilterConfigJSON
	if err := json.Unmarshal(b, &jsonConfig); err != nil {
		return nil
	}
	if jsonConfig.Name != "SchedulerFilter" {
		return nil
	}

	filters := []NetworkFilterFactory{}
	// generate a list of concrete filters
	for _, fuzzerFilterData := range jsonConfig.Filters {
		// convert the interface into a byte-stream.
		filterConfig, err := json.Marshal(fuzzerFilterData)
		if err != nil {
			return nil
		}
		var filterFactory NetworkFilterFactory
		for _, regFactory := range registeredFilterFactories {
			filterFactory = regFactory.Unmarshal(filterConfig)
			if filterFactory != nil {
				// we found a filter factory!
				break
			}
		}
		if filterFactory == nil {
			return nil
		}
		filters = append(filters, filterFactory)
	}

	sched := &SchedulerFilterConfig{
		Filters:       filters,
		Schedule:      jsonConfig.Schedule,
		ScheduleName:  jsonConfig.ScheduleName,
		DebugMessages: false,
	}
	return MakeScheduleFilterFactory(sched)
}

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