aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/allegro/bigcache/shard.go
blob: 56a9fb089590c09c86d3a2d4fc8e4f59a3dfe4af (plain) (blame)
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
package bigcache

import (
    "fmt"
    "sync"
    "sync/atomic"

    "github.com/allegro/bigcache/queue"
)

type onRemoveCallback func(wrappedEntry []byte, reason RemoveReason)

type cacheShard struct {
    hashmap     map[uint64]uint32
    entries     queue.BytesQueue
    lock        sync.RWMutex
    entryBuffer []byte
    onRemove    onRemoveCallback

    isVerbose  bool
    logger     Logger
    clock      clock
    lifeWindow uint64

    stats Stats
}

func (s *cacheShard) get(key string, hashedKey uint64) ([]byte, error) {
    s.lock.RLock()
    itemIndex := s.hashmap[hashedKey]

    if itemIndex == 0 {
        s.lock.RUnlock()
        s.miss()
        return nil, notFound(key)
    }

    wrappedEntry, err := s.entries.Get(int(itemIndex))
    if err != nil {
        s.lock.RUnlock()
        s.miss()
        return nil, err
    }
    if entryKey := readKeyFromEntry(wrappedEntry); key != entryKey {
        if s.isVerbose {
            s.logger.Printf("Collision detected. Both %q and %q have the same hash %x", key, entryKey, hashedKey)
        }
        s.lock.RUnlock()
        s.collision()
        return nil, notFound(key)
    }
    s.lock.RUnlock()
    s.hit()
    return readEntry(wrappedEntry), nil
}

func (s *cacheShard) set(key string, hashedKey uint64, entry []byte) error {
    currentTimestamp := uint64(s.clock.epoch())

    s.lock.Lock()

    if previousIndex := s.hashmap[hashedKey]; previousIndex != 0 {
        if previousEntry, err := s.entries.Get(int(previousIndex)); err == nil {
            resetKeyFromEntry(previousEntry)
        }
    }

    if oldestEntry, err := s.entries.Peek(); err == nil {
        s.onEvict(oldestEntry, currentTimestamp, s.removeOldestEntry)
    }

    w := wrapEntry(currentTimestamp, hashedKey, key, entry, &s.entryBuffer)

    for {
        if index, err := s.entries.Push(w); err == nil {
            s.hashmap[hashedKey] = uint32(index)
            s.lock.Unlock()
            return nil
        }
        if s.removeOldestEntry(NoSpace) != nil {
            s.lock.Unlock()
            return fmt.Errorf("entry is bigger than max shard size")
        }
    }
}

func (s *cacheShard) del(key string, hashedKey uint64) error {
    s.lock.RLock()
    itemIndex := s.hashmap[hashedKey]

    if itemIndex == 0 {
        s.lock.RUnlock()
        s.delmiss()
        return notFound(key)
    }

    wrappedEntry, err := s.entries.Get(int(itemIndex))
    if err != nil {
        s.lock.RUnlock()
        s.delmiss()
        return err
    }
    s.lock.RUnlock()

    s.lock.Lock()
    {
        delete(s.hashmap, hashedKey)
        s.onRemove(wrappedEntry, Deleted)
        resetKeyFromEntry(wrappedEntry)
    }
    s.lock.Unlock()

    s.delhit()
    return nil
}

func (s *cacheShard) onEvict(oldestEntry []byte, currentTimestamp uint64, evict func(reason RemoveReason) error) bool {
    oldestTimestamp := readTimestampFromEntry(oldestEntry)
    if currentTimestamp-oldestTimestamp > s.lifeWindow {
        evict(Expired)
        return true
    }
    return false
}

func (s *cacheShard) cleanUp(currentTimestamp uint64) {
    s.lock.Lock()
    for {
        if oldestEntry, err := s.entries.Peek(); err != nil {
            break
        } else if evicted := s.onEvict(oldestEntry, currentTimestamp, s.removeOldestEntry); !evicted {
            break
        }
    }
    s.lock.Unlock()
}

func (s *cacheShard) getOldestEntry() ([]byte, error) {
    return s.entries.Peek()
}

func (s *cacheShard) getEntry(index int) ([]byte, error) {
    return s.entries.Get(index)
}

func (s *cacheShard) copyKeys() (keys []uint32, next int) {
    keys = make([]uint32, len(s.hashmap))

    s.lock.RLock()

    for _, index := range s.hashmap {
        keys[next] = index
        next++
    }

    s.lock.RUnlock()
    return keys, next
}

func (s *cacheShard) removeOldestEntry(reason RemoveReason) error {
    oldest, err := s.entries.Pop()
    if err == nil {
        hash := readHashFromEntry(oldest)
        delete(s.hashmap, hash)
        s.onRemove(oldest, reason)
        return nil
    }
    return err
}

func (s *cacheShard) reset(config Config) {
    s.lock.Lock()
    s.hashmap = make(map[uint64]uint32, config.initialShardSize())
    s.entryBuffer = make([]byte, config.MaxEntrySize+headersSizeInBytes)
    s.entries.Reset()
    s.lock.Unlock()
}

func (s *cacheShard) len() int {
    s.lock.RLock()
    res := len(s.hashmap)
    s.lock.RUnlock()
    return res
}

func (s *cacheShard) capacity() int {
    s.lock.RLock()
    res := s.entries.Capacity()
    s.lock.RUnlock()
    return res
}

func (s *cacheShard) getStats() Stats {
    var stats = Stats{
        Hits:       atomic.LoadInt64(&s.stats.Hits),
        Misses:     atomic.LoadInt64(&s.stats.Misses),
        DelHits:    atomic.LoadInt64(&s.stats.DelHits),
        DelMisses:  atomic.LoadInt64(&s.stats.DelMisses),
        Collisions: atomic.LoadInt64(&s.stats.Collisions),
    }
    return stats
}

func (s *cacheShard) hit() {
    atomic.AddInt64(&s.stats.Hits, 1)
}

func (s *cacheShard) miss() {
    atomic.AddInt64(&s.stats.Misses, 1)
}

func (s *cacheShard) delhit() {
    atomic.AddInt64(&s.stats.DelHits, 1)
}

func (s *cacheShard) delmiss() {
    atomic.AddInt64(&s.stats.DelMisses, 1)
}

func (s *cacheShard) collision() {
    atomic.AddInt64(&s.stats.Collisions, 1)
}

func initNewShard(config Config, callback onRemoveCallback, clock clock) *cacheShard {
    return &cacheShard{
        hashmap:     make(map[uint64]uint32, config.initialShardSize()),
        entries:     *queue.NewBytesQueue(config.initialShardSize()*config.MaxEntrySize, config.maximumShardSize(), config.Verbose),
        entryBuffer: make([]byte, config.MaxEntrySize+headersSizeInBytes),
        onRemove:    callback,

        isVerbose:  config.Verbose,
        logger:     newLogger(config.Logger),
        clock:      clock,
        lifeWindow: uint64(config.LifeWindow.Seconds()),
    }
}