aboutsummaryrefslogtreecommitdiffstats
path: root/les/flowcontrol/manager.go
blob: 28cc6f0fe763c9e5ebba860a4e0610aee8407955 (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
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum 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 go-ethereum 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 go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

// Package flowcontrol implements a client side flow control mechanism
package flowcontrol

import (
    "sync"
    "time"

    "github.com/ethereum/go-ethereum/common/mclock"
)

const rcConst = 1000000

type cmNode struct {
    node                         *ClientNode
    lastUpdate                   mclock.AbsTime
    serving, recharging          bool
    rcWeight                     uint64
    rcValue, rcDelta, startValue int64
    finishRecharge               mclock.AbsTime
}

func (node *cmNode) update(time mclock.AbsTime) {
    dt := int64(time - node.lastUpdate)
    node.rcValue += node.rcDelta * dt / rcConst
    node.lastUpdate = time
    if node.recharging && time >= node.finishRecharge {
        node.recharging = false
        node.rcDelta = 0
        node.rcValue = 0
    }
}

func (node *cmNode) set(serving bool, simReqCnt, sumWeight uint64) {
    if node.serving && !serving {
        node.recharging = true
        sumWeight += node.rcWeight
    }
    node.serving = serving
    if node.recharging && serving {
        node.recharging = false
        sumWeight -= node.rcWeight
    }

    node.rcDelta = 0
    if serving {
        node.rcDelta = int64(rcConst / simReqCnt)
    }
    if node.recharging {
        node.rcDelta = -int64(node.node.cm.rcRecharge * node.rcWeight / sumWeight)
        node.finishRecharge = node.lastUpdate + mclock.AbsTime(node.rcValue*rcConst/(-node.rcDelta))
    }
}

type ClientManager struct {
    lock                             sync.Mutex
    nodes                            map[*cmNode]struct{}
    simReqCnt, sumWeight, rcSumValue uint64
    maxSimReq, maxRcSum              uint64
    rcRecharge                       uint64
    resumeQueue                      chan chan bool
    time                             mclock.AbsTime
}

func NewClientManager(rcTarget, maxSimReq, maxRcSum uint64) *ClientManager {
    cm := &ClientManager{
        nodes:       make(map[*cmNode]struct{}),
        resumeQueue: make(chan chan bool),
        rcRecharge:  rcConst * rcConst / (100*rcConst/rcTarget - rcConst),
        maxSimReq:   maxSimReq,
        maxRcSum:    maxRcSum,
    }
    go cm.queueProc()
    return cm
}

func (self *ClientManager) Stop() {
    self.lock.Lock()
    defer self.lock.Unlock()

    // signal any waiting accept routines to return false
    self.nodes = make(map[*cmNode]struct{})
    close(self.resumeQueue)
}

func (self *ClientManager) addNode(cnode *ClientNode) *cmNode {
    time := mclock.Now()
    node := &cmNode{
        node:           cnode,
        lastUpdate:     time,
        finishRecharge: time,
        rcWeight:       1,
    }
    self.lock.Lock()
    defer self.lock.Unlock()

    self.nodes[node] = struct{}{}
    self.update(mclock.Now())
    return node
}

func (self *ClientManager) removeNode(node *cmNode) {
    self.lock.Lock()
    defer self.lock.Unlock()

    time := mclock.Now()
    self.stop(node, time)
    delete(self.nodes, node)
    self.update(time)
}

// recalc sumWeight
func (self *ClientManager) updateNodes(time mclock.AbsTime) (rce bool) {
    var sumWeight, rcSum uint64
    for node := range self.nodes {
        rc := node.recharging
        node.update(time)
        if rc && !node.recharging {
            rce = true
        }
        if node.recharging {
            sumWeight += node.rcWeight
        }
        rcSum += uint64(node.rcValue)
    }
    self.sumWeight = sumWeight
    self.rcSumValue = rcSum
    return
}

func (self *ClientManager) update(time mclock.AbsTime) {
    for {
        firstTime := time
        for node := range self.nodes {
            if node.recharging && node.finishRecharge < firstTime {
                firstTime = node.finishRecharge
            }
        }
        if self.updateNodes(firstTime) {
            for node := range self.nodes {
                if node.recharging {
                    node.set(node.serving, self.simReqCnt, self.sumWeight)
                }
            }
        } else {
            self.time = time
            return
        }
    }
}

func (self *ClientManager) canStartReq() bool {
    return self.simReqCnt < self.maxSimReq && self.rcSumValue < self.maxRcSum
}

func (self *ClientManager) queueProc() {
    for rc := range self.resumeQueue {
        for {
            time.Sleep(time.Millisecond * 10)
            self.lock.Lock()
            self.update(mclock.Now())
            cs := self.canStartReq()
            self.lock.Unlock()
            if cs {
                break
            }
        }
        close(rc)
    }
}

func (self *ClientManager) accept(node *cmNode, time mclock.AbsTime) bool {
    self.lock.Lock()
    defer self.lock.Unlock()

    self.update(time)
    if !self.canStartReq() {
        resume := make(chan bool)
        self.lock.Unlock()
        self.resumeQueue <- resume
        <-resume
        self.lock.Lock()
        if _, ok := self.nodes[node]; !ok {
            return false // reject if node has been removed or manager has been stopped
        }
    }
    self.simReqCnt++
    node.set(true, self.simReqCnt, self.sumWeight)
    node.startValue = node.rcValue
    self.update(self.time)
    return true
}

func (self *ClientManager) stop(node *cmNode, time mclock.AbsTime) {
    if node.serving {
        self.update(time)
        self.simReqCnt--
        node.set(false, self.simReqCnt, self.sumWeight)
        self.update(time)
    }
}

func (self *ClientManager) processed(node *cmNode, time mclock.AbsTime) (rcValue, rcCost uint64) {
    self.lock.Lock()
    defer self.lock.Unlock()

    self.stop(node, time)
    return uint64(node.rcValue), uint64(node.rcValue - node.startValue)
}