Skip to content

Ensure task reaper stopChan is closed no more than once #2491

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.

Sign up for GitHub

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

Merged
anshulpundir merged 1 commit into from
Feb 1, 2018
Merged

Ensure task reaper stopChan is closed no more than once #2491

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions manager/orchestrator/taskreaper/task_reaper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package taskreaper

import (
"sort"
"sync"
"time"

"github.com/docker/swarmkit/api"
Expand All @@ -24,6 +25,9 @@ const (
type TaskReaper struct {
store *store.MemoryStore

// closeOnce ensures that stopChan is closed only once
closeOnce sync.Once

// taskHistory is the number of tasks to keep
taskHistory int64

Expand Down Expand Up @@ -281,9 +285,14 @@ func (tr *TaskReaper) tick() {
}

// Stop stops the TaskReaper and waits for the main loop to exit.
// Stop can be called in two cases. One when the manager is
// shutting down, and the other when the manager (the leader) is
// becoming a follower. Since these two instances could race with
// each other, we use closeOnce here to ensure that TaskReaper.Stop()
// is called only once to avoid a panic.
Copy link
Copy Markdown
Contributor Author

@nishanttotla nishanttotla Feb 1, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anshulpundir added a comment here.

func (tr *TaskReaper) Stop() {
// TODO(dperny) calling stop on the task reaper twice will cause a panic
// because we try to close a channel that will already have been closed.
close(tr.stopChan)
tr.closeOnce.Do(func() {
Copy link
Copy Markdown
Contributor

@anshulpundir anshulpundir Jan 26, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the reason to have multiple invocation for this function ?

Copy link
Copy Markdown
Contributor

@anshulpundir anshulpundir Jan 30, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kicked off a rebuild. Lets close this out soon ? @nishanttotla

close(tr.stopChan)
})
<-tr.doneChan
}