/
bimultimap.go
380 lines (340 loc) · 9.58 KB
/
bimultimap.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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
/*
Copyright 2022 The Kubernetes 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 selectors
import (
"fmt"
"strings"
"sync"
pkglabels "k8s.io/apimachinery/pkg/labels"
)
// BiMultimap is an efficient, bi-directional mapping of object
// keys. Associations are created by putting keys with a selector.
type BiMultimap struct {
mux sync.RWMutex
// Objects.
labeledObjects map[Key]*labeledObject
selectingObjects map[Key]*selectingObject
// Associations.
labeledBySelecting map[selectorKey]*labeledObjects
selectingByLabeled map[labelsKey]*selectingObjects
}
// NewBiMultimap creates a map.
func NewBiMultimap() *BiMultimap {
return &BiMultimap{
labeledObjects: make(map[Key]*labeledObject),
selectingObjects: make(map[Key]*selectingObject),
labeledBySelecting: make(map[selectorKey]*labeledObjects),
selectingByLabeled: make(map[labelsKey]*selectingObjects),
}
}
// Key is a tuple of name and namespace.
type Key struct {
Name string
Namespace string
}
// Parse turns a string in the format namespace/name into a Key.
func Parse(s string) (key Key) {
ns := strings.SplitN(s, "/", 2)
if len(ns) == 2 {
key.Namespace = ns[0]
key.Name = ns[1]
} else {
key.Name = ns[0]
}
return key
}
func (k Key) String() string {
return fmt.Sprintf("%v/%v", k.Namespace, k.Name)
}
type selectorKey struct {
key string
namespace string
}
type selectingObject struct {
key Key
selector pkglabels.Selector
// selectorKey is a stable serialization of selector for
// association caching.
selectorKey selectorKey
}
type selectingObjects struct {
objects map[Key]*selectingObject
refCount int
}
type labelsKey struct {
key string
namespace string
}
type labeledObject struct {
key Key
labels map[string]string
// labelsKey is a stable serialization of labels for association
// caching.
labelsKey labelsKey
}
type labeledObjects struct {
objects map[Key]*labeledObject
refCount int
}
// Put inserts or updates an object and the incoming associations
// based on the object labels.
func (m *BiMultimap) Put(key Key, labels map[string]string) {
m.mux.Lock()
defer m.mux.Unlock()
labelsKey := labelsKey{
key: pkglabels.Set(labels).String(),
namespace: key.Namespace,
}
if l, ok := m.labeledObjects[key]; ok {
// Update labeled object.
if labelsKey == l.labelsKey {
// No change to labels.
return
}
// Delete before readding.
m.delete(key)
}
// Add labeled object.
labels = copyLabels(labels)
labeledObject := &labeledObject{
key: key,
labels: labels,
labelsKey: labelsKey,
}
m.labeledObjects[key] = labeledObject
// Add associations.
if _, ok := m.selectingByLabeled[labelsKey]; !ok {
// Cache miss. Scan selecting objects.
selecting := &selectingObjects{
objects: make(map[Key]*selectingObject),
}
set := pkglabels.Set(labels)
for _, s := range m.selectingObjects {
if s.key.Namespace != key.Namespace {
continue
}
if s.selector.Matches(set) {
selecting.objects[s.key] = s
}
}
// Associate selecting with labeled.
m.selectingByLabeled[labelsKey] = selecting
}
selecting := m.selectingByLabeled[labelsKey]
selecting.refCount += 1
for _, sObject := range selecting.objects {
// Associate labeled with selecting.
labeled := m.labeledBySelecting[sObject.selectorKey]
labeled.objects[labeledObject.key] = labeledObject
}
}
// Delete removes a labeled object and incoming associations.
func (m *BiMultimap) Delete(key Key) {
m.mux.Lock()
defer m.mux.Unlock()
m.delete(key)
}
func (m *BiMultimap) delete(key Key) {
if _, ok := m.labeledObjects[key]; !ok {
// Does not exist.
return
}
labeledObject := m.labeledObjects[key]
labelsKey := labeledObject.labelsKey
defer delete(m.labeledObjects, key)
if _, ok := m.selectingByLabeled[labelsKey]; !ok {
// No associations.
return
}
// Remove associations.
for _, selectingObject := range m.selectingByLabeled[labelsKey].objects {
selectorKey := selectingObject.selectorKey
// Delete selectingObject to labeledObject association.
delete(m.labeledBySelecting[selectorKey].objects, key)
}
m.selectingByLabeled[labelsKey].refCount -= 1
// Garbage collect labeledObject to selectingObject associations.
if m.selectingByLabeled[labelsKey].refCount == 0 {
delete(m.selectingByLabeled, labelsKey)
}
}
// Exists returns true if the labeled object is present in the map.
func (m *BiMultimap) Exists(key Key) bool {
m.mux.Lock()
defer m.mux.Unlock()
_, exists := m.labeledObjects[key]
return exists
}
// PutSelector inserts or updates an object with a selector. Associations
// are created or updated based on the selector.
func (m *BiMultimap) PutSelector(key Key, selector pkglabels.Selector) {
m.mux.Lock()
defer m.mux.Unlock()
selectorKey := selectorKey{
key: selector.String(),
namespace: key.Namespace,
}
if s, ok := m.selectingObjects[key]; ok {
// Update selecting object.
if selectorKey == s.selectorKey {
// No change to selector.
return
}
// Delete before readding.
m.deleteSelector(key)
}
// Add selecting object.
selectingObject := &selectingObject{
key: key,
selector: selector,
selectorKey: selectorKey,
}
m.selectingObjects[key] = selectingObject
// Add associations.
if _, ok := m.labeledBySelecting[selectorKey]; !ok {
// Cache miss. Scan labeled objects.
labeled := &labeledObjects{
objects: make(map[Key]*labeledObject),
}
for _, l := range m.labeledObjects {
if l.key.Namespace != key.Namespace {
continue
}
set := pkglabels.Set(l.labels)
if selector.Matches(set) {
labeled.objects[l.key] = l
}
}
// Associate labeled with selecting.
m.labeledBySelecting[selectorKey] = labeled
}
labeled := m.labeledBySelecting[selectorKey]
labeled.refCount += 1
for _, labeledObject := range labeled.objects {
// Associate selecting with labeled.
selecting := m.selectingByLabeled[labeledObject.labelsKey]
selecting.objects[selectingObject.key] = selectingObject
}
}
// DeleteSelector deletes a selecting object and associations created by its
// selector.
func (m *BiMultimap) DeleteSelector(key Key) {
m.mux.Lock()
defer m.mux.Unlock()
m.deleteSelector(key)
}
func (m *BiMultimap) deleteSelector(key Key) {
if _, ok := m.selectingObjects[key]; !ok {
// Does not exist.
return
}
selectingObject := m.selectingObjects[key]
selectorKey := selectingObject.selectorKey
defer delete(m.selectingObjects, key)
if _, ok := m.labeledBySelecting[selectorKey]; !ok {
// No associations.
return
}
// Remove associations.
for _, labeledObject := range m.labeledBySelecting[selectorKey].objects {
labelsKey := labeledObject.labelsKey
// Delete labeledObject to selectingObject association.
delete(m.selectingByLabeled[labelsKey].objects, key)
}
m.labeledBySelecting[selectorKey].refCount -= 1
// Garbage collect selectingObjects to labeledObject associations.
if m.labeledBySelecting[selectorKey].refCount == 0 {
delete(m.labeledBySelecting, selectorKey)
}
}
// SelectorExists returns true if the selecting object is present in the map.
func (m *BiMultimap) SelectorExists(key Key) bool {
m.mux.Lock()
defer m.mux.Unlock()
_, exists := m.selectingObjects[key]
return exists
}
// KeepOnly retains only the specified labeled objects and deletes the
// rest. Like calling Delete for all keys not specified.
func (m *BiMultimap) KeepOnly(keys []Key) {
m.mux.Lock()
defer m.mux.Unlock()
keyMap := make(map[Key]bool)
for _, k := range keys {
keyMap[k] = true
}
for k := range m.labeledObjects {
if !keyMap[k] {
m.delete(k)
}
}
}
// KeepOnlySelectors retains only the specified selecting objects and
// deletes the rest. Like calling DeleteSelector for all keys not
// specified.
func (m *BiMultimap) KeepOnlySelectors(keys []Key) {
m.mux.Lock()
defer m.mux.Unlock()
keyMap := make(map[Key]bool)
for _, k := range keys {
keyMap[k] = true
}
for k := range m.selectingObjects {
if !keyMap[k] {
m.deleteSelector(k)
}
}
}
// Select finds objects associated with a selecting object. If the
// given key was found in the map `ok` will be true. Otherwise false.
func (m *BiMultimap) Select(key Key) (keys []Key, ok bool) {
m.mux.RLock()
defer m.mux.RUnlock()
selectingObject, ok := m.selectingObjects[key]
if !ok {
// Does not exist.
return nil, false
}
keys = make([]Key, 0)
if labeled, ok := m.labeledBySelecting[selectingObject.selectorKey]; ok {
for _, labeledObject := range labeled.objects {
keys = append(keys, labeledObject.key)
}
}
return keys, true
}
// ReverseSelect finds objects selecting the given object. If the
// given key was found in the map `ok` will be true. Otherwise false.
func (m *BiMultimap) ReverseSelect(key Key) (keys []Key, ok bool) {
m.mux.RLock()
defer m.mux.RUnlock()
labeledObject, ok := m.labeledObjects[key]
if !ok {
// Does not exist.
return []Key{}, false
}
keys = make([]Key, 0)
if selecting, ok := m.selectingByLabeled[labeledObject.labelsKey]; ok {
for _, selectingObject := range selecting.objects {
keys = append(keys, selectingObject.key)
}
}
return keys, true
}
func copyLabels(labels map[string]string) map[string]string {
l := make(map[string]string)
for k, v := range labels {
l[k] = v
}
return l
}