util: add flightcontrol sync primitive
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>docker-18.09
Tonis Tiigi
parent
fdde46f7ff
commit
e88c9468dd
|
|
@ -0,0 +1,187 @@
|
|||
package flightcontrol
|
||||
|
||||
import (
|
||||
"runtime"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
|
||||
"golang.org/x/net/context"
|
||||
)
|
||||
|
||||
// flightcontrol is like singleflight but with support for cancellation and
|
||||
// nested progress reporting
|
||||
|
||||
var errRetry = errors.Errorf("retry")
|
||||
|
||||
type Group struct {
|
||||
mu sync.Mutex // protects m
|
||||
m map[string]*call // lazily initialized
|
||||
}
|
||||
|
||||
func (g *Group) Do(ctx context.Context, key string, fn func(ctx context.Context) (interface{}, error)) (v interface{}, err error, shared bool) {
|
||||
g.mu.Lock()
|
||||
if g.m == nil {
|
||||
g.m = make(map[string]*call)
|
||||
}
|
||||
if c, ok := g.m[key]; ok { // register 2nd waiter
|
||||
g.mu.Unlock()
|
||||
v, err, shared := c.wait(ctx)
|
||||
if err == errRetry {
|
||||
runtime.Gosched()
|
||||
return g.Do(ctx, key, fn)
|
||||
}
|
||||
return v, err, shared
|
||||
}
|
||||
c := &call{fn: fn, ready: make(chan struct{})}
|
||||
g.m[key] = c
|
||||
go func() {
|
||||
// cleanup after a caller has returned
|
||||
<-c.ready
|
||||
g.mu.Lock()
|
||||
delete(g.m, key)
|
||||
g.mu.Unlock()
|
||||
}()
|
||||
g.mu.Unlock()
|
||||
return c.wait(ctx)
|
||||
}
|
||||
|
||||
type call struct {
|
||||
mu sync.Mutex
|
||||
result interface{}
|
||||
err error
|
||||
ready chan struct{}
|
||||
ctx *ctx
|
||||
fn func(ctx context.Context) (interface{}, error)
|
||||
}
|
||||
|
||||
func (c *call) wait(ctx context.Context) (v interface{}, err error, shared bool) {
|
||||
c.mu.Lock()
|
||||
// detect case where caller has just returned, let it clean up before
|
||||
select {
|
||||
case <-c.ready:
|
||||
c.mu.Unlock()
|
||||
return nil, errRetry, false
|
||||
default:
|
||||
}
|
||||
if c.ctx == nil { // first invocation, register shared context
|
||||
c.ctx = newContext()
|
||||
c.ctx.append(ctx)
|
||||
go func() {
|
||||
v, err := c.fn(c.ctx)
|
||||
c.mu.Lock()
|
||||
c.result = v
|
||||
c.err = err
|
||||
c.mu.Unlock()
|
||||
close(c.ready)
|
||||
}()
|
||||
} else {
|
||||
c.ctx.append(ctx)
|
||||
}
|
||||
c.mu.Unlock()
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
select {
|
||||
case <-c.ctx.Done():
|
||||
// if this cancelled the last context, then wait for function to shut down
|
||||
// and don't accept any more callers
|
||||
<-c.ready
|
||||
return c.result, c.err, false
|
||||
default:
|
||||
return nil, ctx.Err(), false
|
||||
}
|
||||
case <-c.ready:
|
||||
return c.result, c.err, false // shared not implemented yet
|
||||
}
|
||||
}
|
||||
|
||||
type ctx struct {
|
||||
mu sync.Mutex
|
||||
ctxs []context.Context
|
||||
done chan struct{}
|
||||
err error
|
||||
}
|
||||
|
||||
func newContext() *ctx {
|
||||
return &ctx{done: make(chan struct{})}
|
||||
}
|
||||
|
||||
func (c *ctx) append(ctx context.Context) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
c.ctxs = append(c.ctxs, ctx)
|
||||
go func() {
|
||||
select {
|
||||
case <-c.done:
|
||||
case <-ctx.Done():
|
||||
c.mu.Lock()
|
||||
c.signalDone()
|
||||
c.mu.Unlock()
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
// call with lock
|
||||
func (c *ctx) signalDone() {
|
||||
select {
|
||||
case <-c.done:
|
||||
default:
|
||||
var err error
|
||||
for _, ctx := range c.ctxs {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
err = ctx.Err()
|
||||
default:
|
||||
return
|
||||
}
|
||||
}
|
||||
c.err = err
|
||||
close(c.done)
|
||||
}
|
||||
}
|
||||
|
||||
func (c *ctx) Deadline() (deadline time.Time, ok bool) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
for _, ctx := range c.ctxs {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
default:
|
||||
dl, ok := ctx.Deadline()
|
||||
if ok {
|
||||
return dl, ok
|
||||
}
|
||||
}
|
||||
}
|
||||
return time.Time{}, false
|
||||
}
|
||||
|
||||
func (c *ctx) Done() <-chan struct{} {
|
||||
c.mu.Lock()
|
||||
c.signalDone()
|
||||
c.mu.Unlock()
|
||||
return c.done
|
||||
}
|
||||
|
||||
func (c *ctx) Err() error {
|
||||
select {
|
||||
case <-c.Done():
|
||||
return c.err
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
func (c *ctx) Value(key interface{}) interface{} {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
for _, ctx := range c.ctxs {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
default:
|
||||
return ctx.Value(key)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
|
@ -0,0 +1,158 @@
|
|||
package flightcontrol
|
||||
|
||||
import (
|
||||
"sync/atomic"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"golang.org/x/net/context"
|
||||
"golang.org/x/sync/errgroup"
|
||||
)
|
||||
|
||||
func TestNoCancel(t *testing.T) {
|
||||
g := &Group{}
|
||||
eg, ctx := errgroup.WithContext(context.Background())
|
||||
var r1, r2 string
|
||||
var counter int64
|
||||
f := testFunc(100*time.Millisecond, "bar", &counter)
|
||||
eg.Go(func() error {
|
||||
ret1, err, _ := g.Do(ctx, "foo", f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
r1 = ret1.(string)
|
||||
return nil
|
||||
})
|
||||
eg.Go(func() error {
|
||||
ret2, err, _ := g.Do(ctx, "foo", f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
r2 = ret2.(string)
|
||||
return nil
|
||||
})
|
||||
err := eg.Wait()
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, "bar", r1)
|
||||
assert.Equal(t, "bar", r2)
|
||||
assert.Equal(t, counter, int64(1))
|
||||
}
|
||||
|
||||
func TestCancelOne(t *testing.T) {
|
||||
g := &Group{}
|
||||
eg, ctx := errgroup.WithContext(context.Background())
|
||||
var r1, r2 string
|
||||
var counter int64
|
||||
f := testFunc(100*time.Millisecond, "bar", &counter)
|
||||
ctx2, cancel := context.WithCancel(ctx)
|
||||
eg.Go(func() error {
|
||||
ret1, err, _ := g.Do(ctx2, "foo", f)
|
||||
assert.Error(t, err)
|
||||
assert.Equal(t, errors.Cause(err), context.Canceled)
|
||||
if err == nil {
|
||||
r1 = ret1.(string)
|
||||
}
|
||||
return nil
|
||||
})
|
||||
eg.Go(func() error {
|
||||
ret2, err, _ := g.Do(ctx, "foo", f)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
r2 = ret2.(string)
|
||||
return nil
|
||||
})
|
||||
eg.Go(func() error {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
case <-time.After(30 * time.Millisecond):
|
||||
cancel()
|
||||
return nil
|
||||
}
|
||||
})
|
||||
err := eg.Wait()
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, "", r1)
|
||||
assert.Equal(t, "bar", r2)
|
||||
assert.Equal(t, counter, int64(1))
|
||||
}
|
||||
|
||||
func TestCancelBoth(t *testing.T) {
|
||||
g := &Group{}
|
||||
eg, ctx := errgroup.WithContext(context.Background())
|
||||
var r1, r2 string
|
||||
var counter int64
|
||||
f := testFunc(100*time.Millisecond, "bar", &counter)
|
||||
ctx2, cancel2 := context.WithCancel(ctx)
|
||||
ctx3, cancel3 := context.WithCancel(ctx)
|
||||
eg.Go(func() error {
|
||||
ret1, err, _ := g.Do(ctx2, "foo", f)
|
||||
assert.Error(t, err)
|
||||
assert.Equal(t, errors.Cause(err), context.Canceled)
|
||||
if err == nil {
|
||||
r1 = ret1.(string)
|
||||
}
|
||||
return nil
|
||||
})
|
||||
eg.Go(func() error {
|
||||
ret2, err, _ := g.Do(ctx3, "foo", f)
|
||||
assert.Error(t, err)
|
||||
assert.Equal(t, errors.Cause(err), context.Canceled)
|
||||
if err == nil {
|
||||
r2 = ret2.(string)
|
||||
}
|
||||
return nil
|
||||
})
|
||||
eg.Go(func() error {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
case <-time.After(20 * time.Millisecond):
|
||||
cancel2()
|
||||
return nil
|
||||
}
|
||||
})
|
||||
eg.Go(func() error {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
case <-time.After(50 * time.Millisecond):
|
||||
cancel3()
|
||||
return nil
|
||||
}
|
||||
})
|
||||
err := eg.Wait()
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, "", r1)
|
||||
assert.Equal(t, "", r2)
|
||||
assert.Equal(t, counter, int64(1))
|
||||
|
||||
ret1, err, _ := g.Do(context.TODO(), "foo", f)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, ret1, "bar")
|
||||
|
||||
f2 := testFunc(100*time.Millisecond, "baz", &counter)
|
||||
ret1, err, _ = g.Do(context.TODO(), "foo", f2)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, ret1, "baz")
|
||||
ret1, err, _ = g.Do(context.TODO(), "abc", f)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, ret1, "bar")
|
||||
|
||||
assert.Equal(t, counter, int64(4))
|
||||
}
|
||||
|
||||
func testFunc(wait time.Duration, ret string, counter *int64) func(ctx context.Context) (interface{}, error) {
|
||||
return func(ctx context.Context) (interface{}, error) {
|
||||
atomic.AddInt64(counter, 1)
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return nil, ctx.Err()
|
||||
case <-time.After(wait):
|
||||
return ret, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue