Skip to content
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

fix: exit ticktock goroutine when pool is closed #264

Merged
merged 1 commit into from
Dec 20, 2022
Merged

fix: exit ticktock goroutine when pool is closed #264

Show file tree
Hide file tree
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
65 changes: 46 additions & 19 deletions pool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ type Pool struct {
heartbeatDone int32
stopHeartbeat context.CancelFunc

ticktockDone int32
stopTicktock context.CancelFunc

now atomic.Value

options *Options
Expand Down Expand Up @@ -111,15 +114,44 @@ func (p *Pool) purgeStaleWorkers(ctx context.Context) {
}

// ticktock is a goroutine that updates the current time in the pool regularly.
func (p *Pool) ticktock() {
func (p *Pool) ticktock(ctx context.Context) {
ticker := time.NewTicker(nowTimeUpdateInterval)
defer ticker.Stop()
defer func() {
ticker.Stop()
atomic.StoreInt32(&p.ticktockDone, 1)
}()

for {
select {
case <-ctx.Done():
return
case <-ticker.C:
}

if p.IsClosed() {
Copy link
Owner

Choose a reason for hiding this comment

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

I think the better way to do this is to use context and select in for loop, like purgeStaleWorkers() does.
So you should pass the context to ticktock() and use an atomic int32 to indicate whether ticktock() is done, handle these properly in ReleaseTimeout() and Reboot().

In short, just do what exactly purgeStaleWorkers() has already done.

Copy link
Contributor Author

@GlebRadchenko GlebRadchenko Dec 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Addressed, but I'm still concerned if atomic int32 is helpful for ticktock case since there is no worker-related awaiting logic. lmk if you need anything else

break
}

for range ticker.C {
p.now.Store(time.Now())
}
}

func (p *Pool) startHeartbeat() {
// Start a goroutine to clean up expired workers periodically.
var ctx context.Context
ctx, p.stopHeartbeat = context.WithCancel(context.Background())
if !p.options.DisablePurge {
go p.purgeStaleWorkers(ctx)
}
}

func (p *Pool) startTicktock() {
p.now.Store(time.Now())
var ctx context.Context
ctx, p.stopTicktock = context.WithCancel(context.Background())
go p.ticktock(ctx)
}

func (p *Pool) nowTime() time.Time {
return p.now.Load().(time.Time)
}
Expand Down Expand Up @@ -166,15 +198,8 @@ func NewPool(size int, options ...Option) (*Pool, error) {

p.cond = sync.NewCond(p.lock)

// Start a goroutine to clean up expired workers periodically.
var ctx context.Context
ctx, p.stopHeartbeat = context.WithCancel(context.Background())
if !p.options.DisablePurge {
go p.purgeStaleWorkers(ctx)
}

p.now.Store(time.Now())
go p.ticktock()
p.startHeartbeat()
p.startTicktock()

return p, nil
}
Expand Down Expand Up @@ -259,17 +284,21 @@ func (p *Pool) Release() {

// ReleaseTimeout is like Release but with a timeout, it waits all workers to exit before timing out.
func (p *Pool) ReleaseTimeout(timeout time.Duration) error {
if p.IsClosed() || p.stopHeartbeat == nil {
if p.IsClosed() || p.stopHeartbeat == nil || p.stopTicktock == nil {
return ErrPoolClosed
}

p.stopHeartbeat()
p.stopHeartbeat = nil
p.stopTicktock()
p.stopTicktock = nil
p.Release()

endTime := time.Now().Add(timeout)
for time.Now().Before(endTime) {
if p.Running() == 0 && (p.options.DisablePurge || atomic.LoadInt32(&p.heartbeatDone) == 1) {
if p.Running() == 0 &&
(p.options.DisablePurge || atomic.LoadInt32(&p.heartbeatDone) == 1) &&
atomic.LoadInt32(&p.ticktockDone) == 1 {
return nil
}
time.Sleep(10 * time.Millisecond)
Expand All @@ -281,11 +310,9 @@ func (p *Pool) ReleaseTimeout(timeout time.Duration) error {
func (p *Pool) Reboot() {
if atomic.CompareAndSwapInt32(&p.state, CLOSED, OPENED) {
atomic.StoreInt32(&p.heartbeatDone, 0)
var ctx context.Context
ctx, p.stopHeartbeat = context.WithCancel(context.Background())
if !p.options.DisablePurge {
go p.purgeStaleWorkers(ctx)
}
p.startHeartbeat()
atomic.StoreInt32(&p.ticktockDone, 0)
p.startTicktock()
}
}

Expand Down
65 changes: 46 additions & 19 deletions pool_func.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ type PoolWithFunc struct {
heartbeatDone int32
stopHeartbeat context.CancelFunc

ticktockDone int32
stopTicktock context.CancelFunc

now atomic.Value

options *Options
Expand Down Expand Up @@ -134,15 +137,44 @@ func (p *PoolWithFunc) purgeStaleWorkers(ctx context.Context) {
}

// ticktock is a goroutine that updates the current time in the pool regularly.
func (p *PoolWithFunc) ticktock() {
func (p *PoolWithFunc) ticktock(ctx context.Context) {
ticker := time.NewTicker(nowTimeUpdateInterval)
defer ticker.Stop()
defer func() {
ticker.Stop()
atomic.StoreInt32(&p.ticktockDone, 1)
}()

for {
select {
case <-ctx.Done():
return
case <-ticker.C:
}

if p.IsClosed() {
break
}

for range ticker.C {
p.now.Store(time.Now())
}
}

func (p *PoolWithFunc) startHeartbeat() {
// Start a goroutine to clean up expired workers periodically.
var ctx context.Context
ctx, p.stopHeartbeat = context.WithCancel(context.Background())
if !p.options.DisablePurge {
go p.purgeStaleWorkers(ctx)
}
}

func (p *PoolWithFunc) startTicktock() {
p.now.Store(time.Now())
var ctx context.Context
ctx, p.stopTicktock = context.WithCancel(context.Background())
go p.ticktock(ctx)
}

func (p *PoolWithFunc) nowTime() time.Time {
return p.now.Load().(time.Time)
}
Expand Down Expand Up @@ -191,15 +223,8 @@ func NewPoolWithFunc(size int, pf func(interface{}), options ...Option) (*PoolWi
}
p.cond = sync.NewCond(p.lock)

// Start a goroutine to clean up expired workers periodically.
var ctx context.Context
ctx, p.stopHeartbeat = context.WithCancel(context.Background())
if !p.options.DisablePurge {
go p.purgeStaleWorkers(ctx)
}

p.now.Store(time.Now())
go p.ticktock()
p.startHeartbeat()
p.startTicktock()

return p, nil
}
Expand Down Expand Up @@ -288,17 +313,21 @@ func (p *PoolWithFunc) Release() {

// ReleaseTimeout is like Release but with a timeout, it waits all workers to exit before timing out.
func (p *PoolWithFunc) ReleaseTimeout(timeout time.Duration) error {
if p.IsClosed() || p.stopHeartbeat == nil {
if p.IsClosed() || p.stopHeartbeat == nil || p.stopTicktock == nil {
return ErrPoolClosed
}

p.stopHeartbeat()
p.stopHeartbeat = nil
p.stopTicktock()
p.stopTicktock = nil
p.Release()

endTime := time.Now().Add(timeout)
for time.Now().Before(endTime) {
if p.Running() == 0 && (p.options.DisablePurge || atomic.LoadInt32(&p.heartbeatDone) == 1) {
if p.Running() == 0 &&
(p.options.DisablePurge || atomic.LoadInt32(&p.heartbeatDone) == 1) &&
atomic.LoadInt32(&p.ticktockDone) == 1 {
return nil
}
time.Sleep(10 * time.Millisecond)
Expand All @@ -310,11 +339,9 @@ func (p *PoolWithFunc) ReleaseTimeout(timeout time.Duration) error {
func (p *PoolWithFunc) Reboot() {
if atomic.CompareAndSwapInt32(&p.state, CLOSED, OPENED) {
atomic.StoreInt32(&p.heartbeatDone, 0)
var ctx context.Context
ctx, p.stopHeartbeat = context.WithCancel(context.Background())
if !p.options.DisablePurge {
go p.purgeStaleWorkers(ctx)
}
p.startHeartbeat()
atomic.StoreInt32(&p.ticktockDone, 0)
p.startTicktock()
}
}

Expand Down