semaphore: panic on negative weights The semaphore.Weighted API accepts int64 for weights. If a negative weight is passed, it mathematically corrupts the internal state tracker (s.cur) and bypasses the package's existing safety checks. This adds strict boundary validation to panic immediately if a negative weight is provided. Fixes golang/go#80183 Change-Id: I7e74bad404a8b99aef7e3d2189dda43f8ea644c2 GitHub-Last-Rev: ee6289c356f4626ebca52dbe86d856cc713d7be0 GitHub-Pull-Request: golang/sync#31 Reviewed-on: https://go-review.googlesource.com/c/sync/+/796080 Reviewed-by: Damien Neil <dneil@google.com> Reviewed-by: Zain Yousef <zain.19dj@gmail.com> Reviewed-by: Alan Donovan <adonovan@google.com> LUCI-TryBot-Result: golang-scoped@luci-project-accounts.iam.gserviceaccount.com <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Alan Donovan <adonovan@google.com>
diff --git a/semaphore/semaphore.go b/semaphore/semaphore.go index 040c5bc..96a035a 100644 --- a/semaphore/semaphore.go +++ b/semaphore/semaphore.go
@@ -24,7 +24,7 @@ } // Weighted provides a way to bound concurrent access to a resource. -// The callers can request access with a given weight. +// The callers can request access with a given non-negative weight. type Weighted struct { size int64 cur int64 @@ -32,10 +32,13 @@ waiters list.List } -// Acquire acquires the semaphore with a weight of n, blocking until resources +// Acquire acquires the semaphore with a non-negative weight of n, blocking until resources // are available or ctx is done. On success, returns nil. On failure, returns // ctx.Err() and leaves the semaphore unchanged. func (s *Weighted) Acquire(ctx context.Context, n int64) error { + if n < 0 { + panic("semaphore: n < 0") + } done := ctx.Done() s.mu.Lock() @@ -106,9 +109,12 @@ } } -// TryAcquire acquires the semaphore with a weight of n without blocking. +// TryAcquire acquires the semaphore with a non-negative weight of n without blocking. // On success, returns true. On failure, returns false and leaves the semaphore unchanged. func (s *Weighted) TryAcquire(n int64) bool { + if n < 0 { + panic("semaphore: n < 0") + } s.mu.Lock() success := s.size-s.cur >= n && s.waiters.Len() == 0 if success { @@ -118,8 +124,11 @@ return success } -// Release releases the semaphore with a weight of n. +// Release releases the semaphore with a non-negative weight of n. func (s *Weighted) Release(n int64) { + if n < 0 { + panic("semaphore: n < 0") + } s.mu.Lock() s.cur -= n if s.cur < 0 {
diff --git a/semaphore/semaphore_test.go b/semaphore/semaphore_test.go index 0fa08a9..1a2eb7a 100644 --- a/semaphore/semaphore_test.go +++ b/semaphore/semaphore_test.go
@@ -56,6 +56,40 @@ w.Release(1) } +func TestWeightedNegativeWeightPanic(t *testing.T) { + t.Parallel() + + ctx := context.Background() + w := semaphore.NewWeighted(1) + + func() { + defer func() { + if recover() == nil { + t.Fatal("Acquire with negative weight did not panic") + } + }() + w.Acquire(ctx, -1) + }() + + func() { + defer func() { + if recover() == nil { + t.Fatal("TryAcquire with negative weight did not panic") + } + }() + w.TryAcquire(-1) + }() + + func() { + defer func() { + if recover() == nil { + t.Fatal("Release with negative weight did not panic") + } + }() + w.Release(-1) + }() +} + func TestWeightedTryAcquire(t *testing.T) { t.Parallel()