aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/network.go
blob: 90f3aec67ed4a324a7c66e4ffb9f3a14a37ce745 (plain) (blame)
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
// Copyright 2018 The dexon-consensus-core Authors
// This file is part of the dexon-consensus-core library.
//
// The dexon-consensus-core library is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The dexon-consensus-core library 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 Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus-core library. If not, see
// <http://www.gnu.org/licenses/>.

package simulation

import (
    "context"
    "encoding/json"
    "fmt"
    "net"
    "strconv"
    "time"

    "github.com/dexon-foundation/dexon-consensus-core/common"
    "github.com/dexon-foundation/dexon-consensus-core/core/test"
    "github.com/dexon-foundation/dexon-consensus-core/core/types"
    "github.com/dexon-foundation/dexon-consensus-core/simulation/config"
)

type messageType string

const (
    shutdownAck    messageType = "shutdownAck"
    blockTimestamp messageType = "blockTimestamps"
)

// message is a struct for peer sending message to server.
type message struct {
    Type    messageType     `json:"type"`
    Payload json.RawMessage `json:"payload"`
}

type timestampEvent string

const (
    blockSeen        timestampEvent = "blockSeen"
    timestampConfirm timestampEvent = "timestampConfirm"
    timestampAck     timestampEvent = "timestampAck"
)

// TimestampMessage is a struct for peer sending consensus timestamp information
// to server.
type timestampMessage struct {
    BlockHash common.Hash    `json:"hash"`
    Event     timestampEvent `json:"event"`
    Timestamp time.Time      `json:"timestamp"`
}

type infoStatus string

const (
    statusInit     infoStatus = "init"
    statusNormal   infoStatus = "normal"
    statusShutdown infoStatus = "shutdown"
)

// infoMessage is a struct used by peerServer's /info.
type infoMessage struct {
    Status infoStatus                   `json:"status"`
    Peers  map[types.ValidatorID]string `json:"peers"`
}

// network implements core.Network interface and other methods for simulation
// based on test.TransportClient.
type network struct {
    cfg           config.Networking
    ctx           context.Context
    ctxCancel     context.CancelFunc
    trans         test.TransportClient
    fromTransport <-chan *test.TransportEnvelope
    toConsensus   chan interface{}
    toValidator   chan interface{}
}

// newNetwork setup network stuffs for validators, which provides an
// implementation of core.Network based on test.TransportClient.
func newNetwork(vID types.ValidatorID, cfg config.Networking) (n *network) {
    // Construct latency model.
    latency := &test.NormalLatencyModel{
        Mean:  cfg.Mean,
        Sigma: cfg.Sigma,
    }
    // Construct basic network instance.
    n = &network{
        cfg:         cfg,
        toValidator: make(chan interface{}, 1000),
        toConsensus: make(chan interface{}, 1000),
    }
    n.ctx, n.ctxCancel = context.WithCancel(context.Background())
    // Construct transport layer.
    switch cfg.Type {
    case config.NetworkTypeTCPLocal:
        n.trans = test.NewTCPTransportClient(
            vID, latency, &jsonMarshaller{}, true)
    case config.NetworkTypeTCP:
        n.trans = test.NewTCPTransportClient(
            vID, latency, &jsonMarshaller{}, false)
    case config.NetworkTypeFake:
        n.trans = test.NewFakeTransportClient(vID, latency)
    default:
        panic(fmt.Errorf("unknown network type: %v", cfg.Type))
    }
    return
}

// BroadcastVote implements core.Network interface.
func (n *network) BroadcastVote(vote *types.Vote) {
    if err := n.trans.Broadcast(vote); err != nil {
        panic(err)
    }
}

// BroadcastBlock implements core.Network interface.
func (n *network) BroadcastBlock(block *types.Block) {
    if err := n.trans.Broadcast(block); err != nil {
        panic(err)
    }
}

// BroadcastNotaryAck implements core.Network interface.
func (n *network) BroadcastNotaryAck(notaryAck *types.NotaryAck) {
    if err := n.trans.Broadcast(notaryAck); err != nil {
        panic(err)
    }
}

// ReceiveChan implements core.Network interface.
func (n *network) ReceiveChan() <-chan interface{} {
    return n.toConsensus
}

// receiveChanForValidator returns a channel for validators' specific
// messages.
func (n *network) receiveChanForValidator() <-chan interface{} {
    return n.toValidator
}

// setup transport layer.
func (n *network) setup(serverEndpoint interface{}) (err error) {
    // Join the p2p network.
    switch n.cfg.Type {
    case config.NetworkTypeTCP, config.NetworkTypeTCPLocal:
        addr := net.JoinHostPort(n.cfg.PeerServer, strconv.Itoa(peerPort))
        n.fromTransport, err = n.trans.Join(addr)
    case config.NetworkTypeFake:
        n.fromTransport, err = n.trans.Join(serverEndpoint)
    default:
        err = fmt.Errorf("unknown network type: %v", n.cfg.Type)
    }
    if err != nil {
        return
    }
    return
}

// run the main loop.
func (n *network) run() {
    // The dispatcher declararion:
    // to consensus or validator, that's the question.
    disp := func(e *test.TransportEnvelope) {
        switch e.Msg.(type) {
        case *types.Block, *types.Vote, *types.NotaryAck:
            n.toConsensus <- e.Msg
        default:
            n.toValidator <- e.Msg
        }
    }
MainLoop:
    for {
        select {
        case <-n.ctx.Done():
            break MainLoop
        default:
        }
        select {
        case <-n.ctx.Done():
            break MainLoop
        case e, ok := <-n.fromTransport:
            if !ok {
                break MainLoop
            }
            disp(e)
        }
    }
}

// Close stop the network.
func (n *network) Close() (err error) {
    n.ctxCancel()
    close(n.toConsensus)
    n.toConsensus = nil
    close(n.toValidator)
    n.toValidator = nil
    if err = n.trans.Close(); err != nil {
        return
    }
    return
}

// report exports 'Report' method of test.TransportClient.
func (n *network) report(msg interface{}) error {
    return n.trans.Report(msg)
}

// peers exports 'Peers' method of test.Transport.
func (n *network) peers() map[types.ValidatorID]struct{} {
    return n.trans.Peers()
}