aboutsummaryrefslogtreecommitdiffstats
path: root/core/nonblocking-application.go
blob: cb83b17399940b43e09d3fa671a0d0a29c87e506 (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
// 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 core

import (
    "fmt"
    "sync"
    "time"

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

type blockConfirmedEvent struct {
    block *types.Block
}

type stronglyAckedEvent struct {
    blockHash common.Hash
}

type totalOrderingDeliverEvent struct {
    blockHashes common.Hashes
    early       bool
}

type deliverBlockEvent struct {
    blockHash common.Hash
    timestamp time.Time
}

type notaryAckEvent struct {
    notaryAck *types.NotaryAck
}

// nonBlockingApplication implements Application and is a decorator for
// Application that makes the methods to be non-blocking.
type nonBlockingApplication struct {
    app          Application
    eventChan    chan interface{}
    events       []interface{}
    eventsChange *sync.Cond
    running      sync.WaitGroup
}

func newNonBlockingApplication(app Application) *nonBlockingApplication {
    nonBlockingApp := &nonBlockingApplication{
        app:          app,
        eventChan:    make(chan interface{}, 6),
        events:       make([]interface{}, 0, 100),
        eventsChange: sync.NewCond(&sync.Mutex{}),
    }
    go nonBlockingApp.run()
    return nonBlockingApp
}

func (app *nonBlockingApplication) addEvent(event interface{}) {
    app.eventsChange.L.Lock()
    defer app.eventsChange.L.Unlock()
    app.events = append(app.events, event)
    app.eventsChange.Broadcast()
}

func (app *nonBlockingApplication) run() {
    // This go routine consume the first event from events and call the
    // corresponding method of app.
    for {
        var event interface{}
        func() {
            app.eventsChange.L.Lock()
            defer app.eventsChange.L.Unlock()
            for len(app.events) == 0 {
                app.eventsChange.Wait()
            }
            event = app.events[0]
            app.events = app.events[1:]
            app.running.Add(1)
        }()
        switch e := event.(type) {
        case stronglyAckedEvent:
            app.app.StronglyAcked(e.blockHash)
        case blockConfirmedEvent:
            app.app.BlockConfirmed(e.block)
        case totalOrderingDeliverEvent:
            app.app.TotalOrderingDeliver(e.blockHashes, e.early)
        case deliverBlockEvent:
            app.app.DeliverBlock(e.blockHash, e.timestamp)
        case notaryAckEvent:
            app.app.NotaryAckDeliver(e.notaryAck)
        default:
            fmt.Printf("Unknown event %v.", e)
        }
        app.running.Done()
        app.eventsChange.Broadcast()
    }
}

// wait will wait for all event in events finishes.
func (app *nonBlockingApplication) wait() {
    app.eventsChange.L.Lock()
    defer app.eventsChange.L.Unlock()
    for len(app.events) > 0 {
        app.eventsChange.Wait()
    }
    app.running.Wait()
}

// PreparePayload cannot be non-blocking.
func (app *nonBlockingApplication) PreparePayload(
    position types.Position) []byte {
    return app.app.PreparePayload(position)
}

// VerifyPayloads cannot be non-blocking.
func (app *nonBlockingApplication) VerifyPayloads(payloads []byte) bool {
    return app.app.VerifyPayloads(payloads)
}

// BlockConfirmed is called when a block is confirmed and added to lattice.
func (app *nonBlockingApplication) BlockConfirmed(block *types.Block) {
    app.addEvent(blockConfirmedEvent{block})
}

// StronglyAcked is called when a block is strongly acked.
func (app *nonBlockingApplication) StronglyAcked(blockHash common.Hash) {
    app.addEvent(stronglyAckedEvent{blockHash})
}

// TotalOrderingDeliver is called when the total ordering algorithm deliver
// a set of block.
func (app *nonBlockingApplication) TotalOrderingDeliver(
    blockHashes common.Hashes, early bool) {
    app.addEvent(totalOrderingDeliverEvent{blockHashes, early})
}

// DeliverBlock is called when a block is add to the compaction chain.
func (app *nonBlockingApplication) DeliverBlock(
    blockHash common.Hash, timestamp time.Time) {
    app.addEvent(deliverBlockEvent{blockHash, timestamp})
}

// NotaryAckDeliver is called when a notary ack is created.
func (app *nonBlockingApplication) NotaryAckDeliver(notaryAck *types.NotaryAck) {
    app.addEvent(notaryAckEvent{notaryAck})
}