-
Notifications
You must be signed in to change notification settings - Fork 881
refactor: Separate TaskPool abstraction from Scheduler #7750
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Shaddoll
wants to merge
2
commits into
cadence-workflow:master
Choose a base branch
from
Shaddoll:scheduler
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| // Copyright (c) 2020 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 task | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync" | ||
| "sync/atomic" | ||
|
|
||
| "github.com/uber/cadence/common" | ||
| "github.com/uber/cadence/common/clock" | ||
| "github.com/uber/cadence/common/log" | ||
| "github.com/uber/cadence/common/metrics" | ||
| ) | ||
|
|
||
| type weightedRoundRobinTaskPool[K comparable] struct { | ||
| sync.Mutex | ||
| status int32 | ||
| pool *WeightedRoundRobinChannelPool[K, PriorityTask] | ||
| ctx context.Context | ||
| cancel context.CancelFunc | ||
| options *WeightedRoundRobinTaskPoolOptions[K] | ||
| logger log.Logger | ||
| taskCount atomic.Int64 // O(1) task count tracking | ||
| schedule []chan PriorityTask // Current schedule | ||
| scheduleIndex int // Current position in schedule | ||
| } | ||
|
|
||
| // NewWeightedRoundRobinTaskPool creates a new WRR task pool | ||
| func NewWeightedRoundRobinTaskPool[K comparable]( | ||
| logger log.Logger, | ||
| metricsClient metrics.Client, | ||
| timeSource clock.TimeSource, | ||
| options *WeightedRoundRobinTaskPoolOptions[K], | ||
| ) TaskPool { | ||
| metricsScope := metricsClient.Scope(metrics.TaskSchedulerScope) | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
|
||
| pool := &weightedRoundRobinTaskPool[K]{ | ||
| status: common.DaemonStatusInitialized, | ||
| pool: NewWeightedRoundRobinChannelPool[K, PriorityTask]( | ||
| logger, | ||
| metricsScope, | ||
| timeSource, | ||
| WeightedRoundRobinChannelPoolOptions{ | ||
| BufferSize: options.QueueSize, | ||
| IdleChannelTTLInSeconds: defaultIdleChannelTTLInSeconds, | ||
| }), | ||
| ctx: ctx, | ||
| cancel: cancel, | ||
| options: options, | ||
| logger: logger, | ||
| } | ||
|
|
||
| return pool | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) Start() { | ||
| if !atomic.CompareAndSwapInt32(&p.status, common.DaemonStatusInitialized, common.DaemonStatusStarted) { | ||
| return | ||
| } | ||
|
|
||
| p.pool.Start() | ||
|
|
||
| p.logger.Info("Weighted round robin task pool started.") | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) Stop() { | ||
| if !atomic.CompareAndSwapInt32(&p.status, common.DaemonStatusStarted, common.DaemonStatusStopped) { | ||
| return | ||
| } | ||
|
|
||
| p.cancel() | ||
| p.pool.Stop() | ||
|
|
||
| // Drain all tasks and nack them, updating the counter | ||
| taskChs := p.pool.GetAllChannels() | ||
| for _, taskCh := range taskChs { | ||
| p.drainAndNackTasks(taskCh) | ||
| } | ||
|
|
||
| p.logger.Info("Weighted round robin task pool stopped.") | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) Submit(task PriorityTask) error { | ||
| if p.isStopped() { | ||
| return ErrTaskSchedulerClosed | ||
| } | ||
|
|
||
| key := p.options.TaskToChannelKeyFn(task) | ||
| weight := p.options.ChannelKeyToWeightFn(key) | ||
|
|
||
| // Reject tasks with weight 0 - they won't be in the schedule | ||
| if weight <= 0 { | ||
| return ErrTaskWeightZero | ||
| } | ||
|
|
||
| taskCh, releaseFn := p.pool.GetOrCreateChannel(key, weight) | ||
| defer releaseFn() | ||
|
|
||
| select { | ||
| case taskCh <- task: | ||
| p.taskCount.Add(1) | ||
| if p.isStopped() { | ||
| p.drainAndNackTasks(taskCh) | ||
| } | ||
| return nil | ||
| case <-p.ctx.Done(): | ||
| return ErrTaskSchedulerClosed | ||
| } | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) TrySubmit(task PriorityTask) (bool, error) { | ||
| if p.isStopped() { | ||
| return false, ErrTaskSchedulerClosed | ||
| } | ||
|
|
||
| key := p.options.TaskToChannelKeyFn(task) | ||
| weight := p.options.ChannelKeyToWeightFn(key) | ||
|
|
||
| // Reject tasks with weight 0 - they won't be in the schedule | ||
| if weight <= 0 { | ||
| return false, ErrTaskWeightZero | ||
| } | ||
|
|
||
| taskCh, releaseFn := p.pool.GetOrCreateChannel(key, weight) | ||
| defer releaseFn() | ||
|
|
||
| select { | ||
| case taskCh <- task: | ||
| p.taskCount.Add(1) | ||
| if p.isStopped() { | ||
| p.drainAndNackTasks(taskCh) | ||
| } | ||
| return true, nil | ||
| case <-p.ctx.Done(): | ||
| return false, ErrTaskSchedulerClosed | ||
| default: | ||
| return false, nil | ||
| } | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) GetNextTask() (PriorityTask, bool) { | ||
| if p.isStopped() || p.Len() == 0 { | ||
| return nil, false | ||
| } | ||
|
|
||
| p.Lock() | ||
| defer p.Unlock() | ||
|
|
||
| // Get a fresh schedule if we don't have one or if we've reached the end | ||
| if p.schedule == nil || p.scheduleIndex >= len(p.schedule) { | ||
| p.schedule = p.pool.GetSchedule() | ||
| p.scheduleIndex = 0 | ||
| if len(p.schedule) == 0 { | ||
| return nil, false | ||
| } | ||
| } | ||
|
|
||
| for p.Len() > 0 { | ||
| select { | ||
| case task := <-p.schedule[p.scheduleIndex]: | ||
| // Found a task, advance index and return | ||
| p.scheduleIndex++ | ||
| p.taskCount.Add(-1) | ||
| return task, true | ||
| case <-p.ctx.Done(): | ||
| return nil, false | ||
| default: | ||
| // No task in this channel, try next | ||
| p.scheduleIndex++ | ||
|
|
||
| // If we've reached the end, get a fresh schedule and continue | ||
| if p.scheduleIndex >= len(p.schedule) { | ||
| p.schedule = p.pool.GetSchedule() | ||
| p.scheduleIndex = 0 | ||
| if len(p.schedule) == 0 { | ||
| return nil, false | ||
| } | ||
| } | ||
| } | ||
| } | ||
| return nil, false | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) Len() int { | ||
| return int(p.taskCount.Load()) | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) drainAndNackTasks(taskCh <-chan PriorityTask) { | ||
| for { | ||
| select { | ||
| case task := <-taskCh: | ||
| p.taskCount.Add(-1) | ||
| task.Nack(nil) | ||
| default: | ||
| return | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (p *weightedRoundRobinTaskPool[K]) isStopped() bool { | ||
| return atomic.LoadInt32(&p.status) == common.DaemonStatusStopped | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.