summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-mempool/simple.go
blob: c9f4598901b341a5c979db6b48c924cebbd30984 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
package mempool

import (
	"unsafe"
)

// SimplePool provides a type-safe form
// of UnsafePool using generics.
//
// Note it is NOT safe for concurrent
// use, you must protect it yourself!
type SimplePool[T any] struct {
	UnsafeSimplePool

	// New is an optionally provided
	// allocator used when no value
	// is available for use in pool.
	New func() T

	// Reset is an optionally provided
	// value resetting function called
	// on passed value to Put().
	Reset func(T) bool
}

func (p *SimplePool[T]) Get() T {
	if ptr := p.UnsafeSimplePool.Get(); ptr != nil {
		return *(*T)(ptr)
	}
	var t T
	if p.New != nil {
		t = p.New()
	}
	return t
}

func (p *SimplePool[T]) Put(t T) {
	if p.Reset != nil && !p.Reset(t) {
		return
	}
	ptr := unsafe.Pointer(&t)
	p.UnsafeSimplePool.Put(ptr)
}

// UnsafeSimplePool provides an incredibly
// simple memory pool implementation
// that stores ptrs to memory values,
// and regularly flushes internal pool
// structures according to CheckGC().
//
// Note it is NOT safe for concurrent
// use, you must protect it yourself!
type UnsafeSimplePool struct {

	// Check determines how often to flush
	// internal pools based on underlying
	// current and victim pool sizes. It gets
	// called on every pool Put() operation.
	//
	// A flush will start a new current
	// pool, make victim the old current,
	// and drop the existing victim pool.
	Check func(current, victim int) bool

	current []unsafe.Pointer
	victim  []unsafe.Pointer
}

func (p *UnsafeSimplePool) Get() unsafe.Pointer {
	// First try current list.
	if len(p.current) > 0 {
		ptr := p.current[len(p.current)-1]
		p.current = p.current[:len(p.current)-1]
		return ptr
	}

	// Fallback to victim.
	if len(p.victim) > 0 {
		ptr := p.victim[len(p.victim)-1]
		p.victim = p.victim[:len(p.victim)-1]
		return ptr
	}

	return nil
}

func (p *UnsafeSimplePool) Put(ptr unsafe.Pointer) {
	p.current = append(p.current, ptr)

	// Get GC check func.
	if p.Check == nil {
		p.Check = defaultCheck
	}

	if p.Check(len(p.current), len(p.victim)) {
		p.GC() // garbage collection time!
	}
}

func (p *UnsafeSimplePool) GC() {
	p.victim = p.current
	p.current = nil
}

func (p *UnsafeSimplePool) Size() int {
	return len(p.current) + len(p.victim)
}

func defaultCheck(current, victim int) bool {
	return current-victim > 128 || victim > 256
}