diff --git a/contrab/freelru/LICENSE b/contrab/freelru/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/contrab/freelru/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/contrab/freelru/NOTICE b/contrab/freelru/NOTICE new file mode 100644 index 0000000..9b1c877 --- /dev/null +++ b/contrab/freelru/NOTICE @@ -0,0 +1,2 @@ +Go LRU Hashmap +Copyright 2022 Elasticsearch B.V. diff --git a/contrab/freelru/README.md b/contrab/freelru/README.md index 206fbba..72bec81 100644 --- a/contrab/freelru/README.md +++ b/contrab/freelru/README.md @@ -1,3 +1,4 @@ # freelru -kanged from github.com/elastic/go-freelru@v0.14.0 \ No newline at end of file +upstream: github.com/elastic/go-freelru@v0.16.0 +source: github.com/sagernet/go-freelru@1b34934a560d528d1866415d440625ed2a2560fe diff --git a/contrab/freelru/cache.go b/contrab/freelru/cache.go index 338e6dc..319e662 100644 --- a/contrab/freelru/cache.go +++ b/contrab/freelru/cache.go @@ -19,19 +19,17 @@ package freelru import "time" -type Cache[K comparable, V any] interface { +type Cache[K comparable, V comparable] interface { // SetLifetime sets the default lifetime of LRU elements. // Lifetime 0 means "forever". SetLifetime(lifetime time.Duration) - SetUpdateLifetimeOnGet(update bool) - - SetHealthCheck(healthCheck HealthCheckCallback[K, V]) - // SetOnEvict sets the OnEvict callback function. // The onEvict function is called for each evicted lru entry. SetOnEvict(onEvict OnEvictCallback[K, V]) + SetHealthCheck(healthCheck HealthCheckCallback[K, V]) + // Len returns the number of elements stored in the cache. Len() int @@ -49,13 +47,20 @@ type Cache[K comparable, V any] interface { // and the return value indicates that the key was not found. Get(key K) (V, bool) - GetWithLifetime(key K) (value V, lifetime time.Time, ok bool) + GetWithLifetime(key K) (V, time.Time, bool) + + // GetAndRefresh returns the value associated with the key, setting it as the most + // recently used item. + // The lifetime of the found cache item is refreshed, even if it was already expired. + GetAndRefresh(key K) (V, bool) + + GetAndRefreshOrAdd(key K, constructor func() (V, bool)) (V, bool) // Peek looks up a key's value from the cache, without changing its recent-ness. // If the found entry is already expired, the evict function is called. Peek(key K) (V, bool) - PeekWithLifetime(key K) (value V, lifetime time.Time, ok bool) + PeekWithLifetime(key K) (V, time.Time, bool) UpdateLifetime(key K, value V, lifetime time.Duration) bool diff --git a/contrab/freelru/lru.go b/contrab/freelru/lru.go index 8096015..7f732ea 100644 --- a/contrab/freelru/lru.go +++ b/contrab/freelru/lru.go @@ -26,14 +26,14 @@ import ( ) // OnEvictCallback is the type for the eviction function. -type OnEvictCallback[K comparable, V any] func(K, V) +type OnEvictCallback[K comparable, V comparable] func(K, V) // HashKeyCallback is the function that creates a hash from the passed key. type HashKeyCallback[K comparable] func(K) uint32 -type HealthCheckCallback[K comparable, V any] func(K, V) bool +type HealthCheckCallback[K comparable, V comparable] func(K, V) bool -type element[K comparable, V any] struct { +type element[K comparable, V comparable] struct { key K value V @@ -63,14 +63,13 @@ const emptyBucket = math.MaxUint32 // LRU implements a non-thread safe fixed size LRU cache. type LRU[K comparable, V comparable] struct { - buckets []uint32 // contains positions of bucket lists or 'emptyBucket' - elements []element[K, V] - onEvict OnEvictCallback[K, V] - hash HashKeyCallback[K] - healthCheck HealthCheckCallback[K, V] - lifetime time.Duration - updateLifetimeOnGet bool - metrics Metrics + buckets []uint32 // contains positions of bucket lists or 'emptyBucket' + elements []element[K, V] + onEvict OnEvictCallback[K, V] + hash HashKeyCallback[K] + healthCheck HealthCheckCallback[K, V] + lifetime time.Duration + metrics Metrics // used for element clearing after removal or expiration emptyKey K @@ -101,10 +100,6 @@ func (lru *LRU[K, V]) SetLifetime(lifetime time.Duration) { lru.lifetime = lifetime } -func (lru *LRU[K, V]) SetUpdateLifetimeOnGet(update bool) { - lru.updateLifetimeOnGet = update -} - // SetOnEvict sets the OnEvict callback function. // The onEvict function is called for each evicted lru entry. // Eviction happens @@ -181,7 +176,13 @@ func (lru *LRU[K, V]) hashToBucketPos(hash uint32) uint32 { if lru.mask != 0 { return hash & lru.mask } - return hash % lru.size + return fastModulo(hash, lru.size) +} + +// fastModulo calculates x % n without using the modulo operator (~4x faster). +// Reference: https://lemire.me/blog/2016/06/27/a-fast-alternative-to-the-modulo-reduction/ +func fastModulo(x, n uint32) uint32 { + return uint32((uint64(x) * uint64(n)) >> 32) //nolint:gosec } // hashToPos converts a key into a position in the elements array. @@ -308,30 +309,50 @@ func (lru *LRU[K, V]) clearKeyAndValue(pos uint32) { lru.elements[pos].value = lru.emptyValue } -func (lru *LRU[K, V]) findKey(hash uint32, key K, updateLifetimeOnGet bool) (uint32, int64, bool) { +func (lru *LRU[K, V]) findKey(hash uint32, key K) (uint32, bool) { _, startPos := lru.hashToPos(hash) if startPos == emptyBucket { - return emptyBucket, 0, false + return emptyBucket, false } pos := startPos for { if key == lru.elements[pos].key { - elem := lru.elements[pos] - if (elem.expire != 0 && elem.expire <= now()) || (lru.healthCheck != nil && !lru.healthCheck(key, elem.value)) { + if lru.elements[pos].expire != 0 && lru.elements[pos].expire <= now() || (lru.healthCheck != nil && !lru.healthCheck(key, lru.elements[pos].value)) { lru.removeAt(pos) - return emptyBucket, elem.expire, false + return emptyBucket, false } - if updateLifetimeOnGet { - lru.elements[pos].expire = expire(lru.lifetime) - } - return pos, elem.expire, true + return pos, true } pos = lru.elements[pos].nextBucket if pos == startPos { // Key not found - return emptyBucket, 0, false + return emptyBucket, false + } + } +} + +func (lru *LRU[K, V]) findKeyNoExpire(hash uint32, key K) (uint32, bool) { + _, startPos := lru.hashToPos(hash) + if startPos == emptyBucket { + return emptyBucket, false + } + + pos := startPos + for { + if key == lru.elements[pos].key { + if lru.healthCheck != nil && !lru.healthCheck(key, lru.elements[pos].value) { + lru.removeAt(pos) + return emptyBucket, false + } + return pos, true + } + + pos = lru.elements[pos].nextBucket + if pos == startPos { + // Key not found + return emptyBucket, false } } } @@ -444,46 +465,109 @@ func (lru *LRU[K, V]) add(hash uint32, key K, value V) (evicted bool) { // If the found cache item is already expired, the evict function is called // and the return value indicates that the key was not found. func (lru *LRU[K, V]) Get(key K) (value V, ok bool) { - value, _, ok = lru.get(lru.hash(key), key) - return + return lru.get(lru.hash(key), key) } -func (lru *LRU[K, V]) GetWithLifetime(key K) (value V, lifetime time.Time, ok bool) { - value, expireMills, ok := lru.get(lru.hash(key), key) - lifetime = time.UnixMilli(expireMills) - return -} - -func (lru *LRU[K, V]) get(hash uint32, key K) (value V, expire int64, ok bool) { - if pos, expire, ok := lru.findKey(hash, key, lru.updateLifetimeOnGet); ok { +func (lru *LRU[K, V]) get(hash uint32, key K) (value V, ok bool) { + if pos, ok := lru.findKey(hash, key); ok { if pos != lru.head { lru.unlinkElement(pos) lru.setHead(pos) } lru.metrics.Hits++ - return lru.elements[pos].value, expire, ok + return lru.elements[pos].value, ok } lru.metrics.Misses++ return } +func (lru *LRU[K, V]) GetWithLifetime(key K) (value V, lifetime time.Time, ok bool) { + return lru.getWithLifetime(lru.hash(key), key) +} + +func (lru *LRU[K, V]) getWithLifetime(hash uint32, key K) (value V, lifetime time.Time, ok bool) { + if pos, ok := lru.findKey(hash, key); ok { + if pos != lru.head { + lru.unlinkElement(pos) + lru.setHead(pos) + } + lru.metrics.Hits++ + return lru.elements[pos].value, time.UnixMilli(lru.elements[pos].expire), ok + } + + lru.metrics.Misses++ + return +} + +// GetAndRefresh returns the value associated with the key, setting it as the most +// recently used item. +// The lifetime of the found cache item is refreshed, even if it was already expired. +func (lru *LRU[K, V]) GetAndRefresh(key K) (V, bool) { + return lru.getAndRefresh(lru.hash(key), key) +} + +func (lru *LRU[K, V]) getAndRefresh(hash uint32, key K) (value V, ok bool) { + if pos, ok := lru.findKeyNoExpire(hash, key); ok { + if pos != lru.head { + lru.unlinkElement(pos) + lru.setHead(pos) + } + lru.metrics.Hits++ + lru.elements[pos].expire = expire(lru.lifetime) + return lru.elements[pos].value, ok + } + + lru.metrics.Misses++ + return +} + +func (lru *LRU[K, V]) GetAndRefreshOrAdd(key K, constructor func() (V, bool)) (V, bool) { + return lru.getAndRefreshOrAdd(lru.hash(key), key, constructor) +} + +func (lru *LRU[K, V]) getAndRefreshOrAdd(hash uint32, key K, constructor func() (V, bool)) (value V, ok bool) { + if pos, ok := lru.findKeyNoExpire(hash, key); ok { + if pos != lru.head { + lru.unlinkElement(pos) + lru.setHead(pos) + } + lru.metrics.Hits++ + lru.elements[pos].expire = expire(lru.lifetime) + return lru.elements[pos].value, ok + } + + lru.metrics.Misses++ + value, ok = constructor() + if !ok { + return + } + lru.addWithLifetime(hash, key, value, lru.lifetime) + lru.PurgeExpired() + return value, false +} + // Peek looks up a key's value from the cache, without changing its recent-ness. // If the found entry is already expired, the evict function is called. func (lru *LRU[K, V]) Peek(key K) (value V, ok bool) { - value, _, ok = lru.peek(lru.hash(key), key) + return lru.peek(lru.hash(key), key) +} + +func (lru *LRU[K, V]) peek(hash uint32, key K) (value V, ok bool) { + if pos, ok := lru.findKey(hash, key); ok { + return lru.elements[pos].value, ok + } + return } func (lru *LRU[K, V]) PeekWithLifetime(key K) (value V, lifetime time.Time, ok bool) { - value, expireMills, ok := lru.peek(lru.hash(key), key) - lifetime = time.UnixMilli(expireMills) - return + return lru.peekWithLifetime(lru.hash(key), key) } -func (lru *LRU[K, V]) peek(hash uint32, key K) (value V, expire int64, ok bool) { - if pos, expireMills, ok := lru.findKey(hash, key, false); ok { - return lru.elements[pos].value, expireMills, ok +func (lru *LRU[K, V]) peekWithLifetime(hash uint32, key K) (value V, lifetime time.Time, ok bool) { + if pos, ok := lru.findKey(hash, key); ok { + return lru.elements[pos].value, time.UnixMilli(lru.elements[pos].expire), ok } return @@ -525,12 +609,12 @@ func (lru *LRU[K, V]) updateLifetime(hash uint32, key K, value V, lifetime time. // Contains checks for the existence of a key, without changing its recent-ness. // If the found entry is already expired, the evict function is called. func (lru *LRU[K, V]) Contains(key K) (ok bool) { - _, _, ok = lru.peek(lru.hash(key), key) + _, ok = lru.peek(lru.hash(key), key) return } func (lru *LRU[K, V]) contains(hash uint32, key K) (ok bool) { - _, _, ok = lru.peek(hash, key) + _, ok = lru.peek(hash, key) return } @@ -542,7 +626,7 @@ func (lru *LRU[K, V]) Remove(key K) (removed bool) { } func (lru *LRU[K, V]) remove(hash uint32, key K) (removed bool) { - if pos, _, ok := lru.findKey(hash, key, false); ok { + if pos, ok := lru.findKeyNoExpire(hash, key); ok { lru.removeAt(pos) return ok } @@ -592,8 +676,8 @@ func (lru *LRU[K, V]) Keys() []K { // The evict function is called for each expired item. // The LRU metrics are reset. func (lru *LRU[K, V]) Purge() { - lruLen := lru.len - for i := uint32(0); i < lruLen; i++ { + l := lru.len + for i := uint32(0); i < l; i++ { _, _, _ = lru.RemoveOldest() } @@ -603,8 +687,8 @@ func (lru *LRU[K, V]) Purge() { // PurgeExpired purges all expired items from the LRU. // The evict function is called for each expired item. func (lru *LRU[K, V]) PurgeExpired() { - lruLen := lru.len - for i := uint32(0); i < lruLen; i++ { + l := lru.len + for i := uint32(0); i < l; i++ { pos := lru.elements[lru.head].next if lru.elements[pos].expire != 0 { if lru.elements[pos].expire > now() { diff --git a/contrab/freelru/sharedlru.go b/contrab/freelru/shardedlru.go similarity index 88% rename from contrab/freelru/sharedlru.go rename to contrab/freelru/shardedlru.go index 1b43dc2..e6aca65 100644 --- a/contrab/freelru/sharedlru.go +++ b/contrab/freelru/shardedlru.go @@ -32,14 +32,6 @@ func (lru *ShardedLRU[K, V]) SetLifetime(lifetime time.Duration) { } } -func (lru *ShardedLRU[K, V]) SetUpdateLifetimeOnGet(update bool) { - for shard := range lru.lrus { - lru.mus[shard].Lock() - lru.lrus[shard].SetUpdateLifetimeOnGet(update) - lru.mus[shard].Unlock() - } -} - // SetOnEvict sets the OnEvict callback function. // The onEvict function is called for each evicted lru entry. func (lru *ShardedLRU[K, V]) SetOnEvict(onEvict OnEvictCallback[K, V]) { @@ -174,7 +166,13 @@ func (lru *ShardedLRU[K, V]) Add(key K, value V) (evicted bool) { // If the found cache item is already expired, the evict function is called // and the return value indicates that the key was not found. func (lru *ShardedLRU[K, V]) Get(key K) (value V, ok bool) { - value, _, ok = lru.GetWithLifetime(key) + hash := lru.hash(key) + shard := (hash >> 16) & lru.mask + + lru.mus[shard].Lock() + value, ok = lru.lrus[shard].get(hash, key) + lru.mus[shard].Unlock() + return } @@ -183,16 +181,47 @@ func (lru *ShardedLRU[K, V]) GetWithLifetime(key K) (value V, lifetime time.Time shard := (hash >> 16) & lru.mask lru.mus[shard].Lock() - value, expireMills, ok := lru.lrus[shard].get(hash, key) + value, lifetime, ok = lru.lrus[shard].getWithLifetime(hash, key) lru.mus[shard].Unlock() - lifetime = time.UnixMilli(expireMills) + + return +} + +// GetAndRefresh returns the value associated with the key, setting it as the most +// recently used item. +// The lifetime of the found cache item is refreshed, even if it was already expired. +func (lru *ShardedLRU[K, V]) GetAndRefresh(key K) (value V, ok bool) { + hash := lru.hash(key) + shard := (hash >> 16) & lru.mask + + lru.mus[shard].Lock() + value, ok = lru.lrus[shard].getAndRefresh(hash, key) + lru.mus[shard].Unlock() + + return +} + +func (lru *ShardedLRU[K, V]) GetAndRefreshOrAdd(key K, constructor func() (V, bool)) (value V, updated bool) { + hash := lru.hash(key) + shard := (hash >> 16) & lru.mask + + lru.mus[shard].Lock() + value, updated = lru.lrus[shard].getAndRefreshOrAdd(hash, key, constructor) + lru.mus[shard].Unlock() + return } // Peek looks up a key's value from the cache, without changing its recent-ness. // If the found entry is already expired, the evict function is called. func (lru *ShardedLRU[K, V]) Peek(key K) (value V, ok bool) { - value, _, ok = lru.PeekWithLifetime(key) + hash := lru.hash(key) + shard := (hash >> 16) & lru.mask + + lru.mus[shard].Lock() + value, ok = lru.lrus[shard].peek(hash, key) + lru.mus[shard].Unlock() + return } @@ -201,9 +230,9 @@ func (lru *ShardedLRU[K, V]) PeekWithLifetime(key K) (value V, lifetime time.Tim shard := (hash >> 16) & lru.mask lru.mus[shard].Lock() - value, expireMills, ok := lru.lrus[shard].peek(hash, key) + value, lifetime, ok = lru.lrus[shard].peekWithLifetime(hash, key) lru.mus[shard].Unlock() - lifetime = time.UnixMilli(expireMills) + return } diff --git a/contrab/freelru/syncedlru.go b/contrab/freelru/syncedlru.go new file mode 100644 index 0000000..d42da70 --- /dev/null +++ b/contrab/freelru/syncedlru.go @@ -0,0 +1,257 @@ +package freelru + +import ( + "sync" + "time" +) + +type SyncedLRU[K comparable, V comparable] struct { + mu sync.RWMutex + lru *LRU[K, V] +} + +var _ Cache[int, int] = (*SyncedLRU[int, int])(nil) + +// SetLifetime sets the default lifetime of LRU elements. +// Lifetime 0 means "forever". +func (lru *SyncedLRU[K, V]) SetLifetime(lifetime time.Duration) { + lru.mu.Lock() + lru.lru.SetLifetime(lifetime) + lru.mu.Unlock() +} + +// SetOnEvict sets the OnEvict callback function. +// The onEvict function is called for each evicted lru entry. +func (lru *SyncedLRU[K, V]) SetOnEvict(onEvict OnEvictCallback[K, V]) { + lru.mu.Lock() + lru.lru.SetOnEvict(onEvict) + lru.mu.Unlock() +} + +func (lru *SyncedLRU[K, V]) SetHealthCheck(healthCheck HealthCheckCallback[K, V]) { + lru.mu.Lock() + lru.lru.SetHealthCheck(healthCheck) + lru.mu.Unlock() +} + +// NewSynced creates a new thread-safe LRU hashmap with the given capacity. +func NewSynced[K comparable, V comparable](capacity uint32, hash HashKeyCallback[K]) (*SyncedLRU[K, V], + error, +) { + return NewSyncedWithSize[K, V](capacity, capacity, hash) +} + +func NewSyncedWithSize[K comparable, V comparable](capacity, size uint32, + hash HashKeyCallback[K], +) (*SyncedLRU[K, V], error) { + lru, err := NewWithSize[K, V](capacity, size, hash) + if err != nil { + return nil, err + } + return &SyncedLRU[K, V]{lru: lru}, nil +} + +// Len returns the number of elements stored in the cache. +func (lru *SyncedLRU[K, V]) Len() (length int) { + lru.mu.RLock() + length = lru.lru.Len() + lru.mu.RUnlock() + + return +} + +// AddWithLifetime adds a key:value to the cache with a lifetime. +// Returns true, true if key was updated and eviction occurred. +func (lru *SyncedLRU[K, V]) AddWithLifetime(key K, value V, lifetime time.Duration) (evicted bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + evicted = lru.lru.addWithLifetime(hash, key, value, lifetime) + lru.mu.Unlock() + + return +} + +// Add adds a key:value to the cache. +// Returns true, true if key was updated and eviction occurred. +func (lru *SyncedLRU[K, V]) Add(key K, value V) (evicted bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + evicted = lru.lru.add(hash, key, value) + lru.mu.Unlock() + + return +} + +// Get returns the value associated with the key, setting it as the most +// recently used item. +// If the found cache item is already expired, the evict function is called +// and the return value indicates that the key was not found. +func (lru *SyncedLRU[K, V]) Get(key K) (value V, ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + value, ok = lru.lru.get(hash, key) + lru.mu.Unlock() + + return +} + +func (lru *SyncedLRU[K, V]) GetWithLifetime(key K) (value V, lifetime time.Time, ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + value, lifetime, ok = lru.lru.getWithLifetime(hash, key) + lru.mu.Unlock() + + return +} + +// GetAndRefresh returns the value associated with the key, setting it as the most +// recently used item. +// The lifetime of the found cache item is refreshed, even if it was already expired. +func (lru *SyncedLRU[K, V]) GetAndRefresh(key K) (value V, ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + value, ok = lru.lru.getAndRefresh(hash, key) + lru.mu.Unlock() + + return +} + +func (lru *SyncedLRU[K, V]) GetAndRefreshOrAdd(key K, constructor func() (V, bool)) (value V, updated bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + value, updated = lru.lru.getAndRefreshOrAdd(hash, key, constructor) + lru.mu.Unlock() + + return +} + +// Peek looks up a key's value from the cache, without changing its recent-ness. +// If the found entry is already expired, the evict function is called. +func (lru *SyncedLRU[K, V]) Peek(key K) (value V, ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + value, ok = lru.lru.peek(hash, key) + lru.mu.Unlock() + + return +} + +func (lru *SyncedLRU[K, V]) PeekWithLifetime(key K) (value V, lifetime time.Time, ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + value, lifetime, ok = lru.lru.peekWithLifetime(hash, key) + lru.mu.Unlock() + + return +} + +func (lru *SyncedLRU[K, V]) UpdateLifetime(key K, value V, lifetime time.Duration) (ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + ok = lru.lru.updateLifetime(hash, key, value, lifetime) + lru.mu.Unlock() + + return +} + +// Contains checks for the existence of a key, without changing its recent-ness. +// If the found entry is already expired, the evict function is called. +func (lru *SyncedLRU[K, V]) Contains(key K) (ok bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + ok = lru.lru.contains(hash, key) + lru.mu.Unlock() + + return +} + +// Remove removes the key from the cache. +// The return value indicates whether the key existed or not. +// The evict function is being called if the key existed. +func (lru *SyncedLRU[K, V]) Remove(key K) (removed bool) { + hash := lru.lru.hash(key) + + lru.mu.Lock() + removed = lru.lru.remove(hash, key) + lru.mu.Unlock() + + return +} + +// RemoveOldest removes the oldest entry from the cache. +// Key, value and an indicator of whether the entry has been removed is returned. +// The evict function is called for the removed entry. +func (lru *SyncedLRU[K, V]) RemoveOldest() (key K, value V, removed bool) { + lru.mu.Lock() + key, value, removed = lru.lru.RemoveOldest() + lru.mu.Unlock() + + return +} + +// Keys returns a slice of the keys in the cache, from oldest to newest. +// Expired entries are not included. +// The evict function is called for each expired item. +func (lru *SyncedLRU[K, V]) Keys() (keys []K) { + lru.mu.Lock() + keys = lru.lru.Keys() + lru.mu.Unlock() + + return +} + +// Purge purges all data (key and value) from the LRU. +// The evict function is called for each expired item. +// The LRU metrics are reset. +func (lru *SyncedLRU[K, V]) Purge() { + lru.mu.Lock() + lru.lru.Purge() + lru.mu.Unlock() +} + +// PurgeExpired purges all expired items from the LRU. +// The evict function is called for each expired item. +func (lru *SyncedLRU[K, V]) PurgeExpired() { + lru.mu.Lock() + lru.lru.PurgeExpired() + lru.mu.Unlock() +} + +// Metrics returns the metrics of the cache. +func (lru *SyncedLRU[K, V]) Metrics() Metrics { + lru.mu.Lock() + metrics := lru.lru.Metrics() + lru.mu.Unlock() + return metrics +} + +// ResetMetrics resets the metrics of the cache and returns the previous state. +func (lru *SyncedLRU[K, V]) ResetMetrics() Metrics { + lru.mu.Lock() + metrics := lru.lru.ResetMetrics() + lru.mu.Unlock() + return metrics +} + +// just used for debugging +func (lru *SyncedLRU[K, V]) dump() { + lru.mu.RLock() + lru.lru.dump() + lru.mu.RUnlock() +} + +func (lru *SyncedLRU[K, V]) PrintStats() { + lru.mu.RLock() + lru.lru.PrintStats() + lru.mu.RUnlock() +}