forked from karrick/congomap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
syncMutex.go
244 lines (219 loc) · 5.73 KB
/
syncMutex.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
package congomap
import (
"sync"
"time"
)
type syncMutexMap struct {
db map[string]expiringValue
duration time.Duration
halt chan struct{}
lock sync.RWMutex
lookup func(string) (interface{}, error)
reaper func(interface{})
ttl bool
loading map[string]*sync.WaitGroup
loading_lock sync.Mutex
}
// NewSyncMutexMap returns a map that uses sync.RWMutex to serialize
// access. Keys must be strings.
func NewSyncMutexMap(setters ...Setter) (Congomap, error) {
cgm := &syncMutexMap{
db: make(map[string]expiringValue),
halt: make(chan struct{}),
loading: make(map[string]*sync.WaitGroup),
}
for _, setter := range setters {
if err := setter(cgm); err != nil {
return nil, err
}
}
if cgm.lookup == nil {
cgm.lookup = func(_ string) (interface{}, error) {
return nil, ErrNoLookupDefined{}
}
}
go cgm.run()
return cgm, nil
}
// Lookup sets the lookup callback function for this Congomap for use
// when `LoadStore` is called and a requested key is not in the map.
func (cgm *syncMutexMap) Lookup(lookup func(string) (interface{}, error)) error {
cgm.lookup = lookup
return nil
}
// Reaper is used to specify what function is to be called when
// garbage collecting item from the Congomap.
func (cgm *syncMutexMap) Reaper(reaper func(interface{})) error {
cgm.reaper = reaper
return nil
}
// TTL sets the time-to-live for values stored in the Congomap.
func (cgm *syncMutexMap) TTL(duration time.Duration) error {
if duration <= 0 {
return ErrInvalidDuration(duration)
}
cgm.duration = duration
cgm.ttl = true
return nil
}
// Delete removes a key value pair from a Congomap.
func (cgm *syncMutexMap) Delete(key string) {
cgm.lock.Lock()
if cgm.reaper != nil {
if ev, ok := cgm.db[key]; ok {
cgm.reaper(ev.value)
}
}
delete(cgm.db, key)
cgm.lock.Unlock()
}
// GC forces elimination of keys in Congomap with values that have
// expired.
func (cgm *syncMutexMap) GC() {
if cgm.ttl {
cgm.lock.Lock()
now := time.Now().UnixNano()
var keysToRemove []string
for key, ev := range cgm.db {
if ev.expiry < now {
keysToRemove = append(keysToRemove, key)
}
}
for _, key := range keysToRemove {
if cgm.reaper != nil {
cgm.reaper(cgm.db[key].value)
}
delete(cgm.db, key)
}
cgm.lock.Unlock()
}
}
// Load gets the value associated with the given key. When the key is
// in the map, it returns the value associated with the key and
// true. Otherwise it returns nil for the value and false.
func (cgm *syncMutexMap) Load(key string) (interface{}, bool) {
cgm.lock.RLock()
defer cgm.lock.RUnlock()
ev, ok := cgm.db[key]
if ok && (!cgm.ttl || ev.expiry > time.Now().UnixNano()) {
return ev.value, true
}
return nil, false
}
// Store sets the value associated with the given key.
func (cgm *syncMutexMap) Store(key string, value interface{}) {
cgm.lock.Lock()
ev := expiringValue{value: value}
if cgm.ttl {
ev.expiry = time.Now().UnixNano() + int64(cgm.duration)
}
cgm.db[key] = ev
cgm.lock.Unlock()
}
// LoadStore gets the value associated with the given key if it's in
// the map. If it's not in the map, it calls the lookup function, and
// sets the value in the map to that returned by the lookup function.
func (cgm *syncMutexMap) LoadStore(key string) (interface{}, error) {
cgm.lock.Lock()
ev, ok := cgm.db[key]
if ok && (!cgm.ttl || ev.expiry > time.Now().UnixNano()) {
return ev.value, nil
}
cgm.lock.Unlock() // Unlock whole map, since we are just loading
// Lock the loading map
cgm.loading_lock.Lock()
wg, ok := cgm.loading[key]
// If someone else is already loading, lets just wait on them
if ok {
cgm.loading_lock.Unlock()
wg.Wait()
return cgm.LoadStore(key) // TODO: don't recurse?
} else {
// No one else is loading
// Lets create a wait group, and unlock the loading map
var wg sync.WaitGroup
wg.Add(1)
cgm.loading[key] = &wg
cgm.loading_lock.Unlock()
// Do the actual load
// key was expired or not in db
value, err := cgm.lookup(key)
if err != nil {
return nil, err
}
ev = expiringValue{value: value}
if cgm.ttl {
ev.expiry = time.Now().UnixNano() + int64(cgm.duration)
}
// We have the value, lets set it and remove the loading entry
cgm.lock.Lock()
cgm.db[key] = ev
cgm.lock.Unlock()
// Remove our entry of loading
cgm.loading_lock.Lock()
delete(cgm.loading, key)
cgm.loading_lock.Unlock()
// mark the thing as loaded
wg.Done()
return value, nil
}
}
// Keys returns an array of key values stored in the map.
func (cgm *syncMutexMap) Keys() (keys []string) {
cgm.lock.RLock()
defer cgm.lock.RUnlock()
keys = make([]string, 0, len(cgm.db))
for k := range cgm.db {
keys = append(keys, k)
}
return
}
// Pairs returns a channel through which key value pairs are
// read. Pairs will lock the Congomap so that no other accessors can
// be used until the returned channel is closed.
func (cgm *syncMutexMap) Pairs() <-chan *Pair {
cgm.lock.RLock()
pairs := make(chan *Pair)
go func(pairs chan<- *Pair) {
now := time.Now().UnixNano()
for k, v := range cgm.db {
if !cgm.ttl || (v.expiry > now) {
pairs <- &Pair{k, v.value}
}
}
close(pairs)
cgm.lock.RUnlock()
}(pairs)
return pairs
}
// Close releases resources used by the Congomap.
func (cgm *syncMutexMap) Close() error {
cgm.halt <- struct{}{}
return nil
}
// Halt releases resources used by the Congomap.
func (cgm *syncMutexMap) Halt() {
cgm.halt <- struct{}{}
}
func (cgm *syncMutexMap) run() {
duration := 5 * cgm.duration
if !cgm.ttl {
duration = time.Hour
} else if duration < time.Second {
duration = time.Minute
}
active := true
for active {
select {
case <-time.After(duration):
cgm.GC()
case <-cgm.halt:
active = false
}
}
if cgm.reaper != nil {
for _, ev := range cgm.db {
cgm.reaper(ev.value)
}
}
}