forked from cockroachdb/cockroach
/
flow_scheduler.go
136 lines (120 loc) · 3.68 KB
/
flow_scheduler.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
// Copyright 2016 The Cockroach 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.
//
// Author: Radu Berinde (radu@cockroachlabs.com)
package distsqlrun
import (
"container/list"
"golang.org/x/net/context"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/stop"
"github.com/cockroachdb/cockroach/pkg/util/syncutil"
)
const maxRunningFlows = 500
const flowDoneChanSize = 8
// flowScheduler manages running flows and decides when to queue and when to
// start flows. The main interface it presents is ScheduleFlows, which passes a
// flow to be run.
type flowScheduler struct {
log.AmbientContext
stopper *stop.Stopper
flowDoneCh chan *Flow
mu struct {
syncutil.Mutex
numRunning int
queue *list.List
}
}
// flowWithCtx stores a flow to run and a context to run it with.
// TODO(asubiotto): Figure out if asynchronous flow execution can be rearranged
// to avoid the need to store the context.
type flowWithCtx struct {
ctx context.Context
flow *Flow
}
func newFlowScheduler(ambient log.AmbientContext, stopper *stop.Stopper) *flowScheduler {
fs := &flowScheduler{
AmbientContext: ambient,
stopper: stopper,
flowDoneCh: make(chan *Flow, flowDoneChanSize),
}
fs.mu.queue = list.New()
return fs
}
func (fs *flowScheduler) canRunFlow(_ *Flow) bool {
// TODO(radu): we will have more complex resource accounting (like memory).
// For now we just limit the number of concurrent flows.
return fs.mu.numRunning < maxRunningFlows
}
// runFlowNow starts the given flow; does not wait for the flow to complete.
func (fs *flowScheduler) runFlowNow(ctx context.Context, f *Flow) {
fs.mu.numRunning++
f.Start(ctx, func() { fs.flowDoneCh <- f })
// TODO(radu): we could replace the WaitGroup with a structure that keeps a
// refcount and automatically runs Cleanup() when the count reaches 0.
go func() {
f.Wait()
f.Cleanup(ctx)
}()
}
// ScheduleFlow is the main interface of the flow scheduler: it runs or enqueues
// the given flow.
func (fs *flowScheduler) ScheduleFlow(ctx context.Context, f *Flow) error {
return fs.stopper.RunTask(ctx, func(ctx context.Context) {
fs.mu.Lock()
defer fs.mu.Unlock()
if fs.canRunFlow(f) {
fs.runFlowNow(ctx, f)
} else {
fs.mu.queue.PushBack(&flowWithCtx{
ctx: ctx,
flow: f,
})
}
})
}
// Start launches the main loop of the scheduler.
func (fs *flowScheduler) Start() {
ctx := fs.AnnotateCtx(context.Background())
fs.stopper.RunWorker(ctx, func(context.Context) {
stopped := false
fs.mu.Lock()
defer fs.mu.Unlock()
for {
if stopped && fs.mu.numRunning == 0 {
// TODO(radu): somehow error out the flows that are still in the queue.
return
}
fs.mu.Unlock()
select {
case <-fs.flowDoneCh:
fs.mu.Lock()
fs.mu.numRunning--
if !stopped {
if frElem := fs.mu.queue.Front(); frElem != nil {
n := frElem.Value.(*flowWithCtx)
fs.mu.queue.Remove(frElem)
// Note: we use the flow's context instead of the worker
// context, to ensure that logging etc is relative to the
// specific flow.
fs.runFlowNow(n.ctx, n.flow)
}
}
case <-fs.stopper.ShouldStop():
fs.mu.Lock()
stopped = true
}
}
})
}