github.com/jxskiss/gopkg/v2@v2.14.9-0.20240514120614-899f3e7952b4/perf/gopool/pool_test.go

// Copyright 2021 ByteDance Inc.
// Copyright 2023 Shawn Wang <jxskiss@126.com>.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package gopool

import (
	"context"
	"runtime"
	"sync"
	"sync/atomic"
	"testing"
	"time"
)

const benchmarkTimes = 10000

func DoCopyStack(a, b int) int {
	if b < 100 {
		return DoCopyStack(0, b+1)
	}
	return 0
}

func testFunc() {
	DoCopyStack(0, 0)
}

func TestPool(t *testing.T) {
	cfg := NewConfig()
	cfg.AdhocWorkerLimit = 100
	p := NewPool(cfg)
	testWithPool(t, p, 100)
}

func TestPoolWithPermanentWorkers(t *testing.T) {
	p := NewPool(&Config{
		PermanentWorkerNum: 100,
		AdhocWorkerLimit:   100,
	})
	testWithPool(t, p, 100)
}

func testWithPool(t *testing.T, p *Pool, adhocLimit int32) {
	var n int32
	var wg sync.WaitGroup
	for i := 0; i < 2000; i++ {
		wg.Add(1)
		p.Go(func() {
			defer wg.Done()
			atomic.AddInt32(&n, 1)
			if x := p.AdhocWorkerCount(); x > adhocLimit {
				t.Errorf("adhoc worker count, want <= %d, got %d", adhocLimit, x)
			}
		})
	}
	wg.Wait()
	if n != 2000 {
		t.Error(n)
	}
	time.Sleep(100 * time.Millisecond)
	if x := p.AdhocWorkerCount(); x != 0 {
		t.Errorf("adhoc worker count, want 0, got %d", x)
	}
}

func TestPoolPanic(t *testing.T) {
	p := NewPool(&Config{AdhocWorkerLimit: 100})
	var wg sync.WaitGroup
	wg.Add(1)
	p.Go(func() {
		defer wg.Done()
		panic("test panic")
	})
	wg.Wait()
}

func BenchmarkDefaultPool(b *testing.B) {
	p := NewPool(&Config{
		AdhocWorkerLimit: runtime.GOMAXPROCS(0),
	})
	benchmarkWithPool(b, p)
}

func BenchmarkPoolWithPermanentWorkers(b *testing.B) {
	p := NewPool(&Config{
		PermanentWorkerNum: runtime.GOMAXPROCS(0),
		AdhocWorkerLimit:   runtime.GOMAXPROCS(0),
	})
	benchmarkWithPool(b, p)
}

func benchmarkWithPool(b *testing.B, p *Pool) {
	var wg sync.WaitGroup
	b.ReportAllocs()
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		wg.Add(benchmarkTimes)
		for j := 0; j < benchmarkTimes; j++ {
			p.Go(func() {
				testFunc()
				wg.Done()
			})
		}
		wg.Wait()
	}
}

func BenchmarkGo(b *testing.B) {
	var wg sync.WaitGroup
	b.ReportAllocs()
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		wg.Add(benchmarkTimes)
		for j := 0; j < benchmarkTimes; j++ {
			go func() {
				testFunc()
				wg.Done()
			}()
		}
		wg.Wait()
	}
}

type incInt32Data struct {
	wg *sync.WaitGroup
	n  *int32
}

func testIncInt32(_ context.Context, arg incInt32Data) {
	defer arg.wg.Done()
	atomic.AddInt32(arg.n, 1)
}

func TestTypedPool(t *testing.T) {
	cfg := NewConfig()
	cfg.AdhocWorkerLimit = 100
	p := NewTypedPool(cfg, testIncInt32)
	testWithTypedPool(t, p)
}

func TestTypedPoolWithPermanentWorkers(t *testing.T) {
	cfg := &Config{
		PermanentWorkerNum: 100,
		AdhocWorkerLimit:   100,
	}
	p := NewTypedPool(cfg, testIncInt32)
	testWithTypedPool(t, p)
}

func testWithTypedPool(t *testing.T, p *TypedPool[incInt32Data]) {
	var n int32
	var wg sync.WaitGroup
	for i := 0; i < 2000; i++ {
		wg.Add(1)
		p.Go(incInt32Data{&wg, &n})
	}
	wg.Wait()
	if n != 2000 {
		t.Error(n)
	}
	time.Sleep(100 * time.Millisecond)
	if x := p.AdhocWorkerCount(); x != 0 {
		t.Errorf("adhoc worker count, want 0, got %d", x)
	}
}

func TestTypedPoolPanic(t *testing.T) {
	cfg := &Config{AdhocWorkerLimit: 100}
	p := NewTypedPool(cfg, func(_ context.Context, arg incInt32Data) {
		defer arg.wg.Done()
		panic("test panic")
	})

	var n int32
	var wg sync.WaitGroup
	wg.Add(1)
	p.Go(incInt32Data{&wg, &n})
	wg.Wait()
}

func BenchmarkTypedPool(b *testing.B) {
	cfg := &Config{
		AdhocWorkerLimit: runtime.GOMAXPROCS(0),
	}
	p := NewTypedPool(cfg, func(_ context.Context, wg *sync.WaitGroup) {
		testFunc()
		wg.Done()
	})
	benchmarkWithTypedPool(b, p)
}

func BenchmarkTypedPoolWithPermanentWorkers(b *testing.B) {
	cfg := &Config{
		PermanentWorkerNum: runtime.GOMAXPROCS(0),
		AdhocWorkerLimit:   runtime.GOMAXPROCS(0),
	}
	p := NewTypedPool(cfg, func(_ context.Context, wg *sync.WaitGroup) {
		testFunc()
		wg.Done()
	})
	benchmarkWithTypedPool(b, p)
}

func benchmarkWithTypedPool(b *testing.B, p *TypedPool[*sync.WaitGroup]) {
	var wg sync.WaitGroup
	b.ReportAllocs()
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		wg.Add(benchmarkTimes)
		for j := 0; j < benchmarkTimes; j++ {
			p.Go(&wg)
		}
		wg.Wait()
	}
}

func TestSetAdhocWorkerLimit(t *testing.T) {
	pool := NewPool(&Config{AdhocWorkerLimit: 100})
	wg := &sync.WaitGroup{}

	wg.Add(100)
	for i := 0; i < 100; i++ {
		go func() {
			pool.SetAdhocWorkerLimit(80)
			wg.Done()
		}()
	}
	wg.Wait()
	if x := pool.AdhocWorkerLimit(); x != 80 {
		t.Errorf("adhoc worker limit not match, want 80, got %d", x)
	}
	if x := pool.AdhocWorkerCount(); x != 0 {
		t.Errorf("adhoc worker count not match, want 0, got %d", x)
	}

	wg.Add(100)
	for i := 0; i < 100; i++ {
		go func() {
			pool.SetAdhocWorkerLimit(100)
			wg.Done()
		}()
	}
	wg.Wait()
	if x := pool.AdhocWorkerLimit(); x != 100 {
		t.Errorf("adhoc worker limit not match, want 100, got %d", x)
	}
	if x := pool.AdhocWorkerCount(); x != 0 {
		t.Errorf("adhoc worker count not match, want 0, got %d", x)
	}

	wg.Add(100)
	for i := 0; i < 100; i++ {
		limit := 80 + 20*(i%2)
		go func() {
			pool.SetAdhocWorkerLimit(limit)
			wg.Done()
		}()
	}
	wg.Wait()
	if x := pool.AdhocWorkerLimit(); x != 100 && x != 80 {
		t.Errorf("adhoc worker limit not match, got %d", x)
	}
	if x := pool.AdhocWorkerCount(); x != 0 {
		t.Errorf("adhoc worker count not match, want 0, got %d", x)
	}
}