aboutsummaryrefslogtreecommitdiffstats
path: root/core/syncer/terminator.go
blob: 03c22effcfd61113071ad7fc0eb16ad05c3caf8f (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
// Copyright 2019 The dexon-consensus 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 syncer

import (
    "context"
    "time"

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

type configReader interface {
    Configuration(round uint64) *types.Config
}

// Terminator is reponsible for signaling if syncer object should be terminated.
type Terminator struct {
    recovery     core.Recovery
    configReader configReader
    ping         chan types.Position
    polling      time.Duration
    ctx          context.Context
    cancel       context.CancelFunc
    logger       common.Logger
}

// NewTerminator creats a new terminator object.
func NewTerminator(
    recovery core.Recovery,
    configReader configReader,
    polling time.Duration,
    logger common.Logger) *Terminator {
    tt := &Terminator{
        recovery:     recovery,
        configReader: configReader,
        ping:         make(chan types.Position),
        polling:      polling,
        logger:       logger,
    }
    return tt
}

// Ping the terminator so it won't produce the termination signal.
func (tt *Terminator) Ping(position types.Position) {
    tt.ping <- position
}

// Start the terminator.
func (tt *Terminator) Start(timeout time.Duration) {
    tt.Stop()
    tt.ctx, tt.cancel = context.WithCancel(context.Background())
    go func() {
        var lastPos types.Position
    MonitorLoop:
        for {
            select {
            case <-tt.ctx.Done():
                return
            default:
            }
            select {
            case <-tt.ctx.Done():
                return
            case pos := <-tt.ping:
                if !pos.Newer(lastPos) {
                    tt.logger.Warn("Ping with older height",
                        "pos", pos, "lastPos", lastPos)
                    continue
                }
                lastPos = pos
            case <-time.After(timeout):
                tt.logger.Info("Calling Recovery.ProposeSkipBlock",
                    "height", lastPos.Height)
                tt.recovery.ProposeSkipBlock(lastPos.Height)
                break MonitorLoop
            }
        }
        go func() {
            for {
                select {
                case <-tt.ctx.Done():
                    return
                case <-tt.ping:
                }
            }
        }()
        defer tt.cancel()
        threshold := uint64(
            utils.GetConfigWithPanic(tt.configReader, lastPos.Round, tt.logger).
                NotarySetSize / 2)
        tt.logger.Info("Threshold for recovery", "votes", threshold)
    ResetLoop:
        for {
            votes, err := tt.recovery.Votes(lastPos.Height)
            if err != nil {
                tt.logger.Error("Failed to get recovery votes", "height", lastPos.Height)
            } else if votes > threshold {
                tt.logger.Info("Threshold for recovery reached!")
                break ResetLoop
            }
            select {
            case <-tt.ctx.Done():
                return
            case <-time.After(tt.polling):
            }
        }
    }()
}

// Stop the terminator.
func (tt *Terminator) Stop() {
    if tt.cancel != nil {
        tt.cancel()
    }
}

// Terminated return a closed channel if syncer should be terminated.
func (tt *Terminator) Terminated() <-chan struct{} {
    return tt.ctx.Done()
}