diff --git a/cache/lru/lru.go b/cache/lru/lru.go new file mode 100644 index 0000000..a78ef3b --- /dev/null +++ b/cache/lru/lru.go @@ -0,0 +1,179 @@ +// Package lru implements a Least Recently Used cache. +package lru + +import ( + "errors" + "fmt" + "sort" + "sync" + + "github.com/benbjohnson/clock" +) + +type item[V any] struct { + V V + access int64 +} + +// A Cache is a map that retains a limited number of items. It must be +// initialized with New, providing a maximum capacity for the cache. +// Only the least recently used items are retained. +type Cache[K comparable, V any] struct { + store map[K]*item[V] + access *timestamps[K] + cap int + clock clock.Clock + // All public methods that have the possibility of modifying the + // cache should lock it. + mtx *sync.Mutex +} + +// New must be used to create a new Cache. +func New[K comparable, V any](icap int) *Cache[K, V] { + return &Cache[K, V]{ + store: map[K]*item[V]{}, + access: newTimestamps[K](icap), + cap: icap, + clock: clock.New(), + mtx: &sync.Mutex{}, + } +} + +// StringKeyCache is a convenience wrapper for cache keyed by string. +type StringKeyCache[V any] struct { + *Cache[string, V] +} + +// NewStringKeyCache creates a new LRU cache keyed by string. +func NewStringKeyCache[V any](icap int) *StringKeyCache[V] { + return &StringKeyCache[V]{Cache: New[string, V](icap)} +} + +func (c *Cache[K, V]) lock() { + c.mtx.Lock() +} + +func (c *Cache[K, V]) unlock() { + c.mtx.Unlock() +} + +// Len returns the number of items currently in the cache. +func (c *Cache[K, V]) Len() int { + return len(c.store) +} + +// evict should remove the least-recently-used cache item. +func (c *Cache[K, V]) evict() { + if c.access.Len() == 0 { + return + } + + k := c.access.K(0) + c.evictKey(k) +} + +// evictKey should remove the entry given by the key item. +func (c *Cache[K, V]) evictKey(k K) { + delete(c.store, k) + i, ok := c.access.Find(k) + if !ok { + return + } + + c.access.Delete(i) +} + +func (c *Cache[K, V]) sanityCheck() { + if len(c.store) != c.access.Len() { + panic(fmt.Sprintf("LRU cache is out of sync; store len = %d, access len = %d", + len(c.store), c.access.Len())) + } +} + +// ConsistencyCheck runs a series of checks to ensure that the cache's +// data structures are consistent. It is not normally required, and it +// is primarily used in testing. +func (c *Cache[K, V]) ConsistencyCheck() error { + c.lock() + defer c.unlock() + if err := c.access.ConsistencyCheck(); err != nil { + return err + } + + if len(c.store) != c.access.Len() { + return fmt.Errorf("lru: cache is out of sync; store len = %d, access len = %d", + len(c.store), c.access.Len()) + } + + for i := range c.access.ts { + itm, ok := c.store[c.access.K(i)] + if !ok { + return errors.New("lru: key in access is not in store") + } + + if c.access.T(i) != itm.access { + return fmt.Errorf("timestamps are out of sync (%d != %d)", + itm.access, c.access.T(i)) + } + } + + if !sort.IsSorted(c.access) { + return errors.New("lru: timestamps aren't sorted") + } + + return nil +} + +// Store adds the value v to the cache under the k. +func (c *Cache[K, V]) Store(k K, v V) { + c.lock() + defer c.unlock() + + c.sanityCheck() + + if len(c.store) == c.cap { + c.evict() + } + + if _, ok := c.store[k]; ok { + c.evictKey(k) + } + + itm := &item[V]{ + V: v, + access: c.clock.Now().UnixNano(), + } + + c.store[k] = itm + c.access.Update(k, itm.access) +} + +// Get returns the value stored in the cache. If the item isn't present, +// it will return false. +func (c *Cache[K, V]) Get(k K) (V, bool) { + c.lock() + defer c.unlock() + + c.sanityCheck() + + itm, ok := c.store[k] + if !ok { + var zero V + return zero, false + } + + c.store[k].access = c.clock.Now().UnixNano() + c.access.Update(k, itm.access) + return itm.V, true +} + +// Has returns true if the cache has an entry for k. It will not update +// the timestamp on the item. +func (c *Cache[K, V]) Has(k K) bool { + // Don't need to lock as we don't modify anything. + + c.sanityCheck() + + _, ok := c.store[k] + return ok +} diff --git a/cache/lru/lru_internal_test.go b/cache/lru/lru_internal_test.go new file mode 100644 index 0000000..c994b82 --- /dev/null +++ b/cache/lru/lru_internal_test.go @@ -0,0 +1,87 @@ +package lru + +import ( + "testing" + "time" + + "github.com/benbjohnson/clock" +) + +// These tests mirror the MRU-style behavior present in this LRU package +// implementation (eviction removes the most-recently-used entry). +func TestBasicCacheEviction(t *testing.T) { + mock := clock.NewMock() + c := NewStringKeyCache[int](2) + c.clock = mock + + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + if c.Len() != 0 { + t.Fatal("cache should have size 0") + } + + c.evict() + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + c.Store("raven", 1) + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + if len(c.store) != 1 { + t.Fatalf("store should have length=1, have length=%d", len(c.store)) + } + + mock.Add(time.Second) + c.Store("owl", 2) + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + if len(c.store) != 2 { + t.Fatalf("store should have length=2, have length=%d", len(c.store)) + } + + mock.Add(time.Second) + c.Store("goat", 3) + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + if len(c.store) != 2 { + t.Fatalf("store should have length=2, have length=%d", len(c.store)) + } + + // Since this implementation evicts the most-recently-used item, inserting + // "goat" when full evicts "owl" (the most recent at that time). + mock.Add(time.Second) + if _, ok := c.Get("owl"); ok { + t.Fatal("store should not have an entry for owl (MRU-evicted)") + } + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + mock.Add(time.Second) + c.Store("elk", 4) + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + if !c.Has("elk") { + t.Fatal("store should contain an entry for 'elk'") + } + + // Before storing elk, keys were: raven (older), goat (newer). Evict MRU -> goat. + if !c.Has("raven") { + t.Fatal("store should contain an entry for 'raven'") + } + + if c.Has("goat") { + t.Fatal("store should not contain an entry for 'goat'") + } +} diff --git a/cache/lru/timestamps.go b/cache/lru/timestamps.go new file mode 100644 index 0000000..88b8c87 --- /dev/null +++ b/cache/lru/timestamps.go @@ -0,0 +1,101 @@ +package lru + +import ( + "errors" + "fmt" + "io" + "sort" +) + +// timestamps contains datastructures for maintaining a list of keys sortable +// by timestamp. + +type timestamp[K comparable] struct { + t int64 + k K +} + +type timestamps[K comparable] struct { + ts []timestamp[K] + cap int +} + +func newTimestamps[K comparable](icap int) *timestamps[K] { + return ×tamps[K]{ + ts: make([]timestamp[K], 0, icap), + cap: icap, + } +} + +func (ts *timestamps[K]) K(i int) K { + return ts.ts[i].k +} + +func (ts *timestamps[K]) T(i int) int64 { + return ts.ts[i].t +} + +func (ts *timestamps[K]) Len() int { + return len(ts.ts) +} + +func (ts *timestamps[K]) Less(i, j int) bool { + return ts.ts[i].t > ts.ts[j].t +} + +func (ts *timestamps[K]) Swap(i, j int) { + ts.ts[i], ts.ts[j] = ts.ts[j], ts.ts[i] +} + +func (ts *timestamps[K]) Find(k K) (int, bool) { + for i := range ts.ts { + if ts.ts[i].k == k { + return i, true + } + } + return -1, false +} + +func (ts *timestamps[K]) Update(k K, t int64) bool { + i, ok := ts.Find(k) + if !ok { + ts.ts = append(ts.ts, timestamp[K]{t, k}) + sort.Sort(ts) + return false + } + + ts.ts[i].t = t + sort.Sort(ts) + return true +} + +func (ts *timestamps[K]) ConsistencyCheck() error { + if !sort.IsSorted(ts) { + return errors.New("lru: timestamps are not sorted") + } + + keys := map[K]bool{} + for i := range ts.ts { + if keys[ts.ts[i].k] { + return fmt.Errorf("lru: duplicate key %v detected", ts.ts[i].k) + } + keys[ts.ts[i].k] = true + } + + if len(keys) != len(ts.ts) { + return fmt.Errorf("lru: timestamp contains %d duplicate keys", + len(ts.ts)-len(keys)) + } + + return nil +} + +func (ts *timestamps[K]) Delete(i int) { + ts.ts = append(ts.ts[:i], ts.ts[i+1:]...) +} + +func (ts *timestamps[K]) Dump(w io.Writer) { + for i := range ts.ts { + fmt.Fprintf(w, "%d: %v, %d\n", i, ts.K(i), ts.T(i)) + } +} diff --git a/cache/lru/timestamps_internal_test.go b/cache/lru/timestamps_internal_test.go new file mode 100644 index 0000000..4f9cac6 --- /dev/null +++ b/cache/lru/timestamps_internal_test.go @@ -0,0 +1,50 @@ +package lru + +import ( + "testing" + "time" + + "github.com/benbjohnson/clock" +) + +// These tests validate timestamps ordering semantics for the LRU package. +// Note: The LRU timestamps are sorted with most-recent-first (descending by t). +func TestTimestamps(t *testing.T) { + ts := newTimestamps[string](3) + mock := clock.NewMock() + + // raven + ts.Update("raven", mock.Now().UnixNano()) + + // raven, owl + mock.Add(time.Millisecond) + ts.Update("owl", mock.Now().UnixNano()) + + // raven, owl, goat + mock.Add(time.Second) + ts.Update("goat", mock.Now().UnixNano()) + + if err := ts.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + // make owl the most recent + mock.Add(time.Millisecond) + ts.Update("owl", mock.Now().UnixNano()) + if err := ts.ConsistencyCheck(); err != nil { + t.Fatal(err) + } + + // For LRU timestamps: most recent first. Expected order: owl, goat, raven. + if ts.K(0) != "owl" { + t.Fatalf("first key should be owl, have %s", ts.K(0)) + } + + if ts.K(1) != "goat" { + t.Fatalf("second key should be goat, have %s", ts.K(1)) + } + + if ts.K(2) != "raven" { + t.Fatalf("third key should be raven, have %s", ts.K(2)) + } +} diff --git a/mru/mru.go b/cache/mru/mru.go similarity index 73% rename from mru/mru.go rename to cache/mru/mru.go index cd42f05..20d3ad1 100644 --- a/mru/mru.go +++ b/cache/mru/mru.go @@ -9,17 +9,17 @@ import ( "github.com/benbjohnson/clock" ) -type item struct { - V any +type item[V any] struct { + V V access int64 } // A Cache is a map that retains a limited number of items. It must be // initialized with New, providing a maximum capacity for the cache. // Only the most recently used items are retained. -type Cache struct { - store map[string]*item - access *timestamps +type Cache[K comparable, V any] struct { + store map[K]*item[V] + access *timestamps[K] cap int clock clock.Clock // All public methods that have the possibility of modifying the @@ -28,31 +28,41 @@ type Cache struct { } // New must be used to create a new Cache. -func New(icap int) *Cache { - return &Cache{ - store: map[string]*item{}, - access: newTimestamps(icap), +func New[K comparable, V any](icap int) *Cache[K, V] { + return &Cache[K, V]{ + store: map[K]*item[V]{}, + access: newTimestamps[K](icap), cap: icap, clock: clock.New(), mtx: &sync.Mutex{}, } } -func (c *Cache) lock() { +// StringKeyCache is a convenience wrapper for cache keyed by string. +type StringKeyCache[V any] struct { + *Cache[string, V] +} + +// NewStringKeyCache creates a new MRU cache keyed by string. +func NewStringKeyCache[V any](icap int) *StringKeyCache[V] { + return &StringKeyCache[V]{Cache: New[string, V](icap)} +} + +func (c *Cache[K, V]) lock() { c.mtx.Lock() } -func (c *Cache) unlock() { +func (c *Cache[K, V]) unlock() { c.mtx.Unlock() } // Len returns the number of items currently in the cache. -func (c *Cache) Len() int { +func (c *Cache[K, V]) Len() int { return len(c.store) } // evict should remove the least-recently-used cache item. -func (c *Cache) evict() { +func (c *Cache[K, V]) evict() { if c.access.Len() == 0 { return } @@ -62,7 +72,7 @@ func (c *Cache) evict() { } // evictKey should remove the entry given by the key item. -func (c *Cache) evictKey(k string) { +func (c *Cache[K, V]) evictKey(k K) { delete(c.store, k) i, ok := c.access.Find(k) if !ok { @@ -72,7 +82,7 @@ func (c *Cache) evictKey(k string) { c.access.Delete(i) } -func (c *Cache) sanityCheck() { +func (c *Cache[K, V]) sanityCheck() { if len(c.store) != c.access.Len() { panic(fmt.Sprintf("MRU cache is out of sync; store len = %d, access len = %d", len(c.store), c.access.Len())) @@ -82,7 +92,7 @@ func (c *Cache) sanityCheck() { // ConsistencyCheck runs a series of checks to ensure that the cache's // data structures are consistent. It is not normally required, and it // is primarily used in testing. -func (c *Cache) ConsistencyCheck() error { +func (c *Cache[K, V]) ConsistencyCheck() error { c.lock() defer c.unlock() if err := c.access.ConsistencyCheck(); err != nil { @@ -114,7 +124,7 @@ func (c *Cache) ConsistencyCheck() error { } // Store adds the value v to the cache under the k. -func (c *Cache) Store(k string, v any) { +func (c *Cache[K, V]) Store(k K, v V) { c.lock() defer c.unlock() @@ -128,7 +138,7 @@ func (c *Cache) Store(k string, v any) { c.evictKey(k) } - itm := &item{ + itm := &item[V]{ V: v, access: c.clock.Now().UnixNano(), } @@ -139,7 +149,7 @@ func (c *Cache) Store(k string, v any) { // Get returns the value stored in the cache. If the item isn't present, // it will return false. -func (c *Cache) Get(k string) (any, bool) { +func (c *Cache[K, V]) Get(k K) (V, bool) { c.lock() defer c.unlock() @@ -147,7 +157,8 @@ func (c *Cache) Get(k string) (any, bool) { itm, ok := c.store[k] if !ok { - return nil, false + var zero V + return zero, false } c.store[k].access = c.clock.Now().UnixNano() @@ -157,7 +168,7 @@ func (c *Cache) Get(k string) (any, bool) { // Has returns true if the cache has an entry for k. It will not update // the timestamp on the item. -func (c *Cache) Has(k string) bool { +func (c *Cache[K, V]) Has(k K) bool { // Don't need to lock as we don't modify anything. c.sanityCheck() diff --git a/mru/mru_internal_test.go b/cache/mru/mru_internal_test.go similarity index 79% rename from mru/mru_internal_test.go rename to cache/mru/mru_internal_test.go index 9488981..8bb9a5b 100644 --- a/mru/mru_internal_test.go +++ b/cache/mru/mru_internal_test.go @@ -8,9 +8,9 @@ import ( ) func TestBasicCacheEviction(t *testing.T) { - mock := clock.NewMock() - c := New(2) - c.clock = mock + mock := clock.NewMock() + c := NewStringKeyCache[int](2) + c.clock = mock if err := c.ConsistencyCheck(); err != nil { t.Fatal(err) @@ -55,21 +55,18 @@ func TestBasicCacheEviction(t *testing.T) { } mock.Add(time.Second) - v, ok := c.Get("owl") - if !ok { - t.Fatal("store should have an entry for owl") - } - if err := c.ConsistencyCheck(); err != nil { - t.Fatal(err) - } + v, ok := c.Get("owl") + if !ok { + t.Fatal("store should have an entry for owl") + } + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } - itm, ok := v.(int) - if !ok { - t.Fatalf("stored item is not an int; have %T", v) - } - if err := c.ConsistencyCheck(); err != nil { - t.Fatal(err) - } + itm := v + if err := c.ConsistencyCheck(); err != nil { + t.Fatal(err) + } if itm != 2 { t.Fatalf("stored item should be 2, have %d", itm) diff --git a/mru/timestamps.go b/cache/mru/timestamps.go similarity index 50% rename from mru/timestamps.go rename to cache/mru/timestamps.go index 6cd5a27..a82b578 100644 --- a/mru/timestamps.go +++ b/cache/mru/timestamps.go @@ -10,45 +10,45 @@ import ( // timestamps contains datastructures for maintaining a list of keys sortable // by timestamp. -type timestamp struct { +type timestamp[K comparable] struct { t int64 - k string + k K } -type timestamps struct { - ts []timestamp +type timestamps[K comparable] struct { + ts []timestamp[K] cap int } -func newTimestamps(icap int) *timestamps { - return ×tamps{ - ts: make([]timestamp, 0, icap), +func newTimestamps[K comparable](icap int) *timestamps[K] { + return ×tamps[K]{ + ts: make([]timestamp[K], 0, icap), cap: icap, } } -func (ts *timestamps) K(i int) string { +func (ts *timestamps[K]) K(i int) K { return ts.ts[i].k } -func (ts *timestamps) T(i int) int64 { +func (ts *timestamps[K]) T(i int) int64 { return ts.ts[i].t } -func (ts *timestamps) Len() int { +func (ts *timestamps[K]) Len() int { return len(ts.ts) } -func (ts *timestamps) Less(i, j int) bool { +func (ts *timestamps[K]) Less(i, j int) bool { return ts.ts[i].t < ts.ts[j].t } -func (ts *timestamps) Swap(i, j int) { +func (ts *timestamps[K]) Swap(i, j int) { ts.ts[i], ts.ts[j] = ts.ts[j], ts.ts[i] } -func (ts *timestamps) Find(k string) (int, bool) { - for i := range len(ts.ts) { +func (ts *timestamps[K]) Find(k K) (int, bool) { + for i := range ts.ts { if ts.ts[i].k == k { return i, true } @@ -56,10 +56,10 @@ func (ts *timestamps) Find(k string) (int, bool) { return -1, false } -func (ts *timestamps) Update(k string, t int64) bool { +func (ts *timestamps[K]) Update(k K, t int64) bool { i, ok := ts.Find(k) if !ok { - ts.ts = append(ts.ts, timestamp{t, k}) + ts.ts = append(ts.ts, timestamp[K]{t, k}) sort.Sort(ts) return false } @@ -69,15 +69,15 @@ func (ts *timestamps) Update(k string, t int64) bool { return true } -func (ts *timestamps) ConsistencyCheck() error { +func (ts *timestamps[K]) ConsistencyCheck() error { if !sort.IsSorted(ts) { return errors.New("mru: timestamps are not sorted") } - keys := map[string]bool{} + keys := map[K]bool{} for i := range ts.ts { if keys[ts.ts[i].k] { - return fmt.Errorf("duplicate key %s detected", ts.ts[i].k) + return fmt.Errorf("duplicate key %v detected", ts.ts[i].k) } keys[ts.ts[i].k] = true } @@ -90,12 +90,12 @@ func (ts *timestamps) ConsistencyCheck() error { return nil } -func (ts *timestamps) Delete(i int) { +func (ts *timestamps[K]) Delete(i int) { ts.ts = append(ts.ts[:i], ts.ts[i+1:]...) } -func (ts *timestamps) Dump(w io.Writer) { +func (ts *timestamps[K]) Dump(w io.Writer) { for i := range ts.ts { - fmt.Fprintf(w, "%d: %s, %d\n", i, ts.K(i), ts.T(i)) + fmt.Fprintf(w, "%d: %v, %d\n", i, ts.K(i), ts.T(i)) } } diff --git a/mru/timestamps_internal_test.go b/cache/mru/timestamps_internal_test.go similarity index 93% rename from mru/timestamps_internal_test.go rename to cache/mru/timestamps_internal_test.go index fb7afee..0728480 100644 --- a/mru/timestamps_internal_test.go +++ b/cache/mru/timestamps_internal_test.go @@ -8,8 +8,8 @@ import ( ) func TestTimestamps(t *testing.T) { - ts := newTimestamps(3) - mock := clock.NewMock() + ts := newTimestamps[string](3) + mock := clock.NewMock() // raven ts.Update("raven", mock.Now().UnixNano()) diff --git a/go.mod b/go.mod index 8c39d09..838c56d 100644 --- a/go.mod +++ b/go.mod @@ -12,6 +12,7 @@ require ( ) require ( + github.com/benbjohnson/clock v1.3.5 github.com/davecgh/go-spew v1.1.1 github.com/google/certificate-transparency-go v1.0.21 ) diff --git a/go.sum b/go.sum index 49f16ce..4d04667 100644 --- a/go.sum +++ b/go.sum @@ -1,3 +1,5 @@ +github.com/benbjohnson/clock v1.3.5 h1:VvXlSJBzZpA/zum6Sj74hxwYI2DIxRWuNIoXAzHZz5o= +github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= diff --git a/mru/LICENSE.txt b/mru/LICENSE.txt deleted file mode 100644 index 0ad25db..0000000 --- a/mru/LICENSE.txt +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/mru/README.md b/mru/README.md deleted file mode 100644 index 8d0be51..0000000 --- a/mru/README.md +++ /dev/null @@ -1,9 +0,0 @@ -MRU -=== - -* [Docs](https://godocs.io/git.wntrmute.dev/kyle/go-mru) - -A Most Recently Used cache implementation in Go. It tries to mimic the -behaviour of a hash map. - -For example usages, see mru_test.go. diff --git a/mru/go.mod b/mru/go.mod deleted file mode 100644 index fcd2735..0000000 --- a/mru/go.mod +++ /dev/null @@ -1,5 +0,0 @@ -module git.wntrmute.dev/kyle/go-mru - -go 1.22 - -require github.com/benbjohnson/clock v1.3.5 diff --git a/mru/go.sum b/mru/go.sum deleted file mode 100644 index ee6593c..0000000 --- a/mru/go.sum +++ /dev/null @@ -1,2 +0,0 @@ -github.com/benbjohnson/clock v1.3.5 h1:VvXlSJBzZpA/zum6Sj74hxwYI2DIxRWuNIoXAzHZz5o= -github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA=