Skip to content

Commit

Permalink
Make sure that task reaper stopChan is closed no more than one time
Browse files Browse the repository at this point in the history
Signed-off-by: Nishant Totla <nishanttotla@gmail.com>
  • Loading branch information
nishanttotla committed Feb 1, 2018
1 parent a4b9c4c commit 4657b27
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions manager/orchestrator/taskreaper/task_reaper.go
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 instances. 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 must ensure that TaskReaper.Stop() is called
// only once to avoid a panic.
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() {
close(tr.stopChan)
})
<-tr.doneChan
}

0 comments on commit 4657b27

Please sign in to comment.