aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/app.go
blob: 9f399cea7834121f6f2e5d8a628f1b476cb251d0 (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
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
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus 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 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 library. If not, see
// <http://www.gnu.org/licenses/>.

package simulation

import (
    "encoding/json"
    "fmt"
    "sync"
    "time"

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

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"`
}

const (
    // Block received or created in agreement.
    blockEventReceived int = iota
    // Block confirmed in agreement, sent into lattice
    blockEventConfirmed
    // Block delivered by lattice.
    blockEventDelivered
    // Block is ready (Randomness calculated)
    blockEventReady
    // Block is witness
    blockEventWitnessed

    blockEventCount
)

// simApp is an DEXON app for simulation.
type simApp struct {
    NodeID          types.NodeID
    Outputs         []*types.Block
    Early           bool
    netModule       *test.Network
    stateModule     *test.State
    DeliverID       int
    blockTimestamps map[common.Hash][]time.Time
    blockSeen       map[common.Hash]time.Time
    // uncofirmBlocks stores the blocks whose timestamps are not ready.
    unconfirmedBlocks  map[types.NodeID]common.Hashes
    blockByHash        map[common.Hash]*types.Block
    blockByHashMutex   sync.RWMutex
    latestWitness      types.Witness
    latestWitnessReady *sync.Cond
    lock               sync.RWMutex
}

// newSimApp returns point to a new instance of simApp.
func newSimApp(
    id types.NodeID, netModule *test.Network, stateModule *test.State) *simApp {
    return &simApp{
        NodeID:             id,
        netModule:          netModule,
        stateModule:        stateModule,
        DeliverID:          0,
        blockSeen:          make(map[common.Hash]time.Time),
        blockTimestamps:    make(map[common.Hash][]time.Time),
        unconfirmedBlocks:  make(map[types.NodeID]common.Hashes),
        blockByHash:        make(map[common.Hash]*types.Block),
        latestWitnessReady: sync.NewCond(&sync.Mutex{}),
    }
}

// BlockConfirmed implements core.Application.
func (a *simApp) BlockConfirmed(block types.Block) {
    a.blockByHashMutex.Lock()
    defer a.blockByHashMutex.Unlock()
    // TODO(jimmy-dexon) : Remove block in this hash if it's no longer needed.
    a.blockByHash[block.Hash] = &block
    a.blockSeen[block.Hash] = time.Now().UTC()
    a.updateBlockEvent(block.Hash)
}

// VerifyBlock implements core.Application.
func (a *simApp) VerifyBlock(block *types.Block) types.BlockVerifyStatus {
    return types.VerifyOK
}

// getAckedBlocks will return all unconfirmed blocks' hash with lower Height
// than the block with ackHash.
func (a *simApp) getAckedBlocks(ackHash common.Hash) (output common.Hashes) {
    // TODO(jimmy-dexon): Why there are some acks never seen?
    ackBlock, exist := a.blockByHash[ackHash]
    if !exist {
        return
    }
    hashes, exist := a.unconfirmedBlocks[ackBlock.ProposerID]
    if !exist {
        return
    }
    for i, blockHash := range hashes {
        if a.blockByHash[blockHash].Position.Height > ackBlock.Position.Height {
            output, a.unconfirmedBlocks[ackBlock.ProposerID] = hashes[:i], hashes[i:]
            break
        }
    }

    // All of the Height of unconfirmed blocks are lower than the acked block.
    if len(output) == 0 {
        output, a.unconfirmedBlocks[ackBlock.ProposerID] = hashes, common.Hashes{}
    }
    return
}

// PreparePayload implements core.Application.
func (a *simApp) PreparePayload(position types.Position) ([]byte, error) {
    return a.stateModule.PackRequests()
}

// PrepareWitness implements core.Application.
func (a *simApp) PrepareWitness(height uint64) (types.Witness, error) {
    a.latestWitnessReady.L.Lock()
    defer a.latestWitnessReady.L.Unlock()
    for a.latestWitness.Height < height {
        a.latestWitnessReady.Wait()
    }
    return a.latestWitness, nil
}

// TotalOrderingDelivered is called when blocks are delivered by the total
// ordering algorithm.
func (a *simApp) TotalOrderingDelivered(
    blockHashes common.Hashes, mode uint32) {
    fmt.Println("OUTPUT", a.NodeID, mode, blockHashes)
    latencies := []time.Duration{}
    func() {
        a.lock.RLock()
        defer a.lock.RUnlock()
        for _, h := range blockHashes {
            latencies = append(latencies, time.Since(a.blockTimestamps[h][blockEventReceived]))
        }
    }()
    blockList := &BlockList{
        ID:             a.DeliverID,
        BlockHash:      blockHashes,
        ConfirmLatency: latencies,
    }
    // #nosec G104
    a.netModule.Report(blockList)
    a.DeliverID++
}

// BlockDelivered is called when a block in compaction chain is delivered.
func (a *simApp) BlockDelivered(
    blockHash common.Hash, pos types.Position, result types.FinalizationResult) {

    if len(result.Randomness) == 0 && pos.Round > 0 {
        panic(fmt.Errorf("Block %s randomness is empty", blockHash))
    }
    func() {
        a.blockByHashMutex.Lock()
        defer a.blockByHashMutex.Unlock()
        if block, exist := a.blockByHash[blockHash]; exist {
            if err := a.stateModule.Apply(block.Payload); err != nil {
                if err != test.ErrDuplicatedChange {
                    panic(err)
                }
            }
            var witnessBlockHash common.Hash
            if err := witnessBlockHash.UnmarshalText(block.Witness.Data); err != nil {
                panic(err)
            }
            a.updateBlockEvent(witnessBlockHash)
        } else {
            panic(fmt.Errorf("Block is not confirmed yet: %s", blockHash))
        }
    }()
    func() {
        a.latestWitnessReady.L.Lock()
        defer a.latestWitnessReady.L.Unlock()
        data, err := blockHash.MarshalText()
        if err != nil {
            panic(err)
        }
        a.latestWitness = types.Witness{
            Height: result.Height,
            Data:   data,
        }
        a.latestWitnessReady.Broadcast()
    }()

    a.updateBlockEvent(blockHash)

    seenTime, exist := a.blockSeen[blockHash]
    if !exist {
        return
    }
    now := time.Now()
    payload := []timestampMessage{
        {
            BlockHash: blockHash,
            Event:     blockSeen,
            Timestamp: seenTime,
        },
        {
            BlockHash: blockHash,
            Event:     timestampConfirm,
            Timestamp: now,
        },
    }
    jsonPayload, err := json.Marshal(payload)
    if err != nil {
        fmt.Println(err)
        return
    }
    msg := &message{
        Type:    blockTimestamp,
        Payload: jsonPayload,
    }
    // #nosec G104
    a.netModule.Report(msg)
}

// BlockReceived is called when a block is received in agreement.
func (a *simApp) BlockReceived(hash common.Hash) {
    a.updateBlockEvent(hash)
}

// BlockReady is called when a block is ready.
func (a *simApp) BlockReady(hash common.Hash) {
    a.updateBlockEvent(hash)
}

func (a *simApp) updateBlockEvent(hash common.Hash) {
    a.lock.Lock()
    defer a.lock.Unlock()
    a.blockTimestamps[hash] = append(a.blockTimestamps[hash], time.Now().UTC())
    if len(a.blockTimestamps[hash]) == blockEventCount {
        msg := &test.BlockEventMessage{
            BlockHash:  hash,
            Timestamps: a.blockTimestamps[hash],
        }
        if err := a.netModule.Report(msg); err != nil {
            panic(err)
        }
        delete(a.blockTimestamps, hash)
    }
}