mirrored from https://chromium.googlesource.com/infra/luci/luci-go
-
Notifications
You must be signed in to change notification settings - Fork 43
/
coordinator.go
260 lines (224 loc) · 6.92 KB
/
coordinator.go
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
// Copyright 2019 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package dispatcher
import (
"context"
"time"
"go.chromium.org/luci/common/clock"
"go.chromium.org/luci/common/errors"
"go.chromium.org/luci/common/sync/dispatcher/buffer"
)
type coordinatorState struct {
opts Options
buf *buffer.Buffer
itemCh <-chan interface{}
drainCh chan<- struct{}
resultCh chan workerResult
// Used as a wake-up timer for the coordinator to wake itself up when the
// buffer will have a batch available due to buffer timeout and/or qps limiter.
timer clock.Timer
// true if itemCh is closed
closed bool
// true if our context is canceled
canceled bool
}
type workerResult struct {
batch *buffer.Batch
err error
}
func (state *coordinatorState) dbg(msg string, args ...interface{}) {
if state.opts.testingDbg != nil {
state.opts.testingDbg(msg, args...)
}
}
func (state *coordinatorState) sendBatches(ctx context.Context, now time.Time, send SendFn) time.Duration {
if state.canceled {
for _, batch := range state.buf.ForceLeaseAll() {
state.dbg(" >dropping batch: canceled")
state.opts.DropFn(batch, false)
state.buf.ACK(batch)
}
return 0
}
// while the context is not canceled, send stuff batches we're able to send.
for ctx.Err() == nil {
// See if we're permitted to send.
res := state.opts.QPSLimit.ReserveN(now, 1)
if !res.OK() {
panic(errors.New(
"impossible; Options.QPSLimit is guaranteed to have Inf rate or burst >= 1"))
}
if delay := res.DelayFrom(now); delay != 0 {
// We have to wait until the next send token is available. Cancel the
// reservation for now, since we're going to wait via getNextTimingEvent.
res.CancelAt(now)
return delay
}
// We're allowed to send, see if there's actually anything to send.
if batchToSend := state.buf.LeaseOne(now); batchToSend != nil {
// got a batch! Send it.
state.dbg(" >sending batch")
go func() {
state.resultCh <- workerResult{
batch: batchToSend,
err: send(batchToSend),
}
}()
} else {
// Otherwise we're done sending batches for now. Cancel the reservation,
// since we can't use it.
res.CancelAt(now)
break
}
}
return 0
}
// getNextTimingEvent returns a clock.Timer channel which will activate when the
// later of the following happen:
// * buffer.NextSendTime
// * nextQPSToken
func (state *coordinatorState) getNextTimingEvent(now time.Time, nextQPSToken time.Duration) <-chan clock.TimerResult {
var resetDuration time.Duration
var msg string
if nextSend := state.buf.NextSendTime(); !nextSend.IsZero() && nextSend.After(now) {
resetDuration = nextSend.Sub(now)
msg = "waiting on batch.NextSendTime"
}
if nextQPSToken > resetDuration {
resetDuration = nextQPSToken
msg = "waiting on QPS limit"
}
if resetDuration > 0 {
if !state.timer.Stop() {
select {
case <-state.timer.GetC():
default:
// The timer was already drained in the main loop.
}
}
state.timer.Reset(resetDuration)
state.dbg(" |%s (%s)", msg, resetDuration)
return state.timer.GetC()
}
return nil
}
// getWorkChannel returns a channel to receive an individual work item on (from
// our client) if our buffer is willing to accept additional work items.
//
// Otherwise returns nil.
func (state *coordinatorState) getWorkChannel() <-chan interface{} {
if !state.closed && state.buf.CanAddItem() {
state.dbg(" |waiting on new data")
return state.itemCh
}
return nil
}
// handleResult is invoked once for each workerResult returned to the
// coordinator from a worker.
//
// This will ACK/NACK the Batch (once).
func (state *coordinatorState) handleResult(ctx context.Context, result workerResult) {
state.dbg(" GOT RESULT")
if result.err == nil {
state.dbg(" ACK")
state.buf.ACK(result.batch)
return
}
state.dbg(" ERR(%s)", result.err)
if retry := state.opts.ErrorFn(result.batch, result.err); !retry {
state.dbg(" NO RETRY (dropping batch)")
state.opts.DropFn(result.batch, false)
state.buf.ACK(result.batch)
return
}
if state.canceled {
state.dbg(" NO RETRY (dropping batch: canceled context)")
state.opts.DropFn(result.batch, false)
state.buf.ACK(result.batch)
return
}
state.dbg(" NACK")
state.buf.NACK(ctx, result.err, result.batch)
return
}
// coordinator is the main goroutine for managing the state of the Channel.
// Exactly one coordinator() function runs per Channel. This coordinates (!!)
// all of the internal channels of the external Channel object in one big select
// loop.
func (state *coordinatorState) run(ctx context.Context, send SendFn) {
defer close(state.drainCh)
if state.opts.DrainedFn != nil {
defer state.opts.DrainedFn()
}
defer state.opts.DropFn(nil, true)
defer close(state.resultCh)
defer state.timer.Stop()
loop:
for {
state.dbg("LOOP (closed: %t, canceled: %t): buf.Stats[%+v]",
state.closed, state.canceled, state.buf.Stats())
now := clock.Now(ctx)
resDelay := state.sendBatches(ctx, now, send)
// sendBatches may drain the buf if we're in the canceled state, so pull it
// again to see if it's empty.
if state.closed && state.buf.Stats().Empty() {
break loop
}
// Only select on ctx.Done if we haven't observed its cancelation yet.
var doneCh <-chan struct{}
if !state.canceled {
doneCh = ctx.Done()
}
select {
case <-doneCh:
state.dbg(" GOT CANCEL (via context)")
state.canceled = true
state.buf.Flush(now)
case result := <-state.resultCh:
state.handleResult(ctx, result)
case itm, ok := <-state.getWorkChannel():
if !ok {
state.dbg(" GOT DRAIN")
state.closed = true
state.buf.Flush(now)
continue
}
state.dbg(" GOT NEW DATA")
if state.canceled {
state.dbg(" dropped batch (canceled)")
state.opts.DropFn(&buffer.Batch{
Data: []interface{}{itm},
}, false)
continue
}
if dropped := state.buf.AddNoBlock(now, itm); dropped != nil {
state.dbg(" dropped batch")
state.opts.DropFn(dropped, false)
}
case result := <-state.getNextTimingEvent(now, resDelay):
if result.Incomplete() {
state.dbg(" GOT CANCEL (via timer)")
state.canceled = true
state.buf.Flush(now)
continue
}
state.dbg(" GOT TIMER WAKEUP")
// opportunistically attempt to send batches; either a new batch is ready
// to be cut or the qps timer is up. This lowers the upper bound variance
// and gets a bit closer to the QPS target.
state.sendBatches(ctx, result.Time, send)
}
}
state.dbg("DONE")
}