/
executor.go
155 lines (140 loc) · 4.7 KB
/
executor.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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package executor
import (
"sync"
"sync/atomic"
"github.com/uber/cadence/common"
"github.com/uber/cadence/common/metrics"
)
type (
// Task defines the interface for a runnable task
Task interface {
// Run should execute the task and return well known status codes
Run() TaskStatus
}
// Executor defines the interface for any executor which can
// accept tasks and execute them based on some policy
Executor interface {
// Start starts the executor
Start()
// Stop stops the executor
Stop()
// Submit is a blocking call that accepts a task to execute
Submit(task Task) bool
// TaskCount returns the number of outstanding tasks in the executor
TaskCount() int64
}
// fixedPoolExecutor is an implementation of an executor that uses fixed size
// goroutine pool. This executor also supports deferred execution of tasks
// for fairness
fixedPoolExecutor struct {
size int
maxDeferred int
runQ *runQueue
outstanding int64
status int32
metrics metrics.Client
metricScope int
stopC chan struct{}
stopWG sync.WaitGroup
}
// TaskStatus is the return code from a Task
TaskStatus int
)
const (
// TaskStatusDone indicates task is finished successfully
TaskStatusDone TaskStatus = iota
// TaskStatusDefer indicates task should be scheduled again for execution at later time
TaskStatusDefer
// TaskStatusErr indicates task is finished with errors
TaskStatusErr
)
// NewFixedSizePoolExecutor returns an implementation of task executor that maintains
// a fixed size pool of goroutines.The returned executor also allows task processing to
// to be deferred for fairness. To defer processing of a task, simply return TaskStatsDefer
// from your task.Run method. When a task is deferred, it will be added to the tail of a
// deferredTaskQ which in turn will be processed after the current runQ is drained
func NewFixedSizePoolExecutor(size int, maxDeferred int, metrics metrics.Client, scope int) Executor {
stopC := make(chan struct{})
return &fixedPoolExecutor{
size: size,
maxDeferred: maxDeferred,
runQ: newRunQueue(size, stopC),
metrics: metrics,
metricScope: scope,
stopC: stopC,
}
}
// Start starts the executor
func (e *fixedPoolExecutor) Start() {
if !atomic.CompareAndSwapInt32(&e.status, common.DaemonStatusInitialized, common.DaemonStatusStarted) {
return
}
for i := 0; i < e.size; i++ {
e.stopWG.Add(1)
go e.worker()
}
}
// Stop stops the executor
func (e *fixedPoolExecutor) Stop() {
if !atomic.CompareAndSwapInt32(&e.status, common.DaemonStatusStarted, common.DaemonStatusStopped) {
return
}
close(e.stopC)
e.stopWG.Wait()
}
// Submit is a blocking call that accepts a task for execution
func (e *fixedPoolExecutor) Submit(task Task) bool {
if !e.alive() {
return false
}
added := e.runQ.add(task)
if added {
atomic.AddInt64(&e.outstanding, 1)
}
return added
}
// TaskCount returns the total of number of tasks currently outstanding
func (e *fixedPoolExecutor) TaskCount() int64 {
return atomic.LoadInt64(&e.outstanding)
}
func (e *fixedPoolExecutor) worker() {
defer e.stopWG.Done()
for e.alive() {
task, ok := e.runQ.remove()
if !ok {
return
}
status := task.Run()
if status == TaskStatusDefer {
if e.runQ.deferredCount() < e.maxDeferred {
e.runQ.addAndDefer(task)
e.metrics.IncCounter(e.metricScope, metrics.ExecutorTasksDeferredCount)
continue
}
e.metrics.IncCounter(e.metricScope, metrics.ExecutorTasksDroppedCount)
}
atomic.AddInt64(&e.outstanding, -1)
}
}
func (e *fixedPoolExecutor) alive() bool {
return atomic.LoadInt32(&e.status) == common.DaemonStatusStarted
}