-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
numbered.go
184 lines (161 loc) · 4.54 KB
/
numbered.go
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*
Copyright 2019 The Vitess Authors.
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 pools
import (
"fmt"
"sync"
"time"
"vitess.io/vitess/go/cache"
)
// Numbered allows you to manage resources by tracking them with numbers.
// There are no interface restrictions on what you can track.
type Numbered struct {
mu sync.Mutex
empty *sync.Cond // Broadcast when pool becomes empty
resources map[int64]*numberedWrapper
recentlyUnregistered *cache.LRUCache
}
type numberedWrapper struct {
val any
inUse bool
purpose string
}
type unregistered struct {
reason string
timeUnregistered time.Time
}
// NewNumbered creates a new numbered
func NewNumbered() *Numbered {
n := &Numbered{
resources: make(map[int64]*numberedWrapper),
recentlyUnregistered: cache.NewLRUCache(1000, func(_ any) int64 {
return 1
}),
}
n.empty = sync.NewCond(&n.mu)
return n
}
// Register starts tracking a resource by the supplied id.
// It does not lock the object.
// It returns an error if the id already exists.
func (nu *Numbered) Register(id int64, val any) error {
// Optimistically assume we're not double registering.
resource := &numberedWrapper{
val: val,
}
nu.mu.Lock()
defer nu.mu.Unlock()
_, ok := nu.resources[id]
if ok {
return fmt.Errorf("already present")
}
nu.resources[id] = resource
return nil
}
// Unregister forgets the specified resource. If the resource is not present, it's ignored.
func (nu *Numbered) Unregister(id int64, reason string) {
success := nu.unregister(id)
if success {
nu.recentlyUnregistered.Set(
fmt.Sprintf("%v", id), &unregistered{reason: reason, timeUnregistered: time.Now()})
}
}
// unregister forgets the resource, if it exists. Returns whether or not the resource existed at
// time of Unregister.
func (nu *Numbered) unregister(id int64) bool {
nu.mu.Lock()
defer nu.mu.Unlock()
_, ok := nu.resources[id]
delete(nu.resources, id)
if len(nu.resources) == 0 {
nu.empty.Broadcast()
}
return ok
}
// Get locks the resource for use. It accepts a purpose as a string.
// If it cannot be found, it returns a "not found" error. If in use,
// it returns a "in use: purpose" error.
func (nu *Numbered) Get(id int64, purpose string) (val any, err error) {
nu.mu.Lock()
defer nu.mu.Unlock()
nw, ok := nu.resources[id]
if !ok {
if val, ok := nu.recentlyUnregistered.Get(fmt.Sprintf("%v", id)); ok {
unreg := val.(*unregistered)
return nil, fmt.Errorf("ended at %v (%v)", unreg.timeUnregistered.Format("2006-01-02 15:04:05.000 MST"), unreg.reason)
}
return nil, fmt.Errorf("not found")
}
if nw.inUse {
return nil, fmt.Errorf("in use: %s", nw.purpose)
}
nw.inUse = true
nw.purpose = purpose
return nw.val, nil
}
// Put unlocks a resource for someone else to use.
func (nu *Numbered) Put(id int64) bool {
nu.mu.Lock()
defer nu.mu.Unlock()
if nw, ok := nu.resources[id]; ok {
nw.inUse = false
nw.purpose = ""
return true
}
return false
}
// GetAll returns the list of all resources in the pool.
func (nu *Numbered) GetAll() (vals []any) {
nu.mu.Lock()
defer nu.mu.Unlock()
vals = make([]any, 0, len(nu.resources))
for _, nw := range nu.resources {
vals = append(vals, nw.val)
}
return vals
}
// GetByFilter returns a list of resources that match the filter.
// It does not return any resources that are already locked.
func (nu *Numbered) GetByFilter(purpose string, match func(val any) bool) (vals []any) {
nu.mu.Lock()
defer nu.mu.Unlock()
for _, nw := range nu.resources {
if nw.inUse {
continue
}
if match(nw.val) {
nw.inUse = true
nw.purpose = purpose
vals = append(vals, nw.val)
}
}
return vals
}
// WaitForEmpty returns as soon as the pool becomes empty
func (nu *Numbered) WaitForEmpty() {
nu.mu.Lock()
defer nu.mu.Unlock()
for len(nu.resources) != 0 {
nu.empty.Wait()
}
}
// StatsJSON returns stats in JSON format
func (nu *Numbered) StatsJSON() string {
return fmt.Sprintf("{\"Size\": %v}", nu.Size())
}
// Size returns the current size
func (nu *Numbered) Size() int64 {
nu.mu.Lock()
defer nu.mu.Unlock()
return int64(len(nu.resources))
}