339 lines
8.6 KiB
Cheetah
339 lines
8.6 KiB
Cheetah
package {{.PackageName}}
|
|
|
|
// The package is used as a template, don't use it directly!
|
|
|
|
import (
|
|
"fmt"
|
|
"runtime"
|
|
"sync"
|
|
"time"
|
|
)
|
|
|
|
// Attr is cachmap attribute
|
|
type {{.ValueType}}CacheAttr struct {
|
|
// An (optional) function that is called with the key and value when an
|
|
// item is evicted from the cache. (Including when it is deleted manually, but
|
|
// not when it is overwritten.) Set to nil to disable.
|
|
OnEvicted func(k string, v {{.ValueType}})
|
|
|
|
DefaultCleanupInterval time.Duration // Default clean interval, this is a time interval to cleanup expired items
|
|
DefaultExpiration time.Duration // Default expiration duration
|
|
Size int64 // Initial size of map
|
|
}
|
|
|
|
// Item struct
|
|
type Item struct {
|
|
Object {{.ValueType}}
|
|
Expiration int64
|
|
}
|
|
|
|
// Expired returns true if the item has expired.
|
|
func (item Item) Expired() bool {
|
|
return item.Expiration != 0 && time.Now().UnixNano() > item.Expiration
|
|
}
|
|
|
|
const (
|
|
// NoExpiration is for use with functions that take no expiration time.
|
|
NoExpiration time.Duration = -1
|
|
// DefaultExpiration is for use with functions that take an
|
|
// expiration time. Equivalent to passing in the same expiration
|
|
// duration as was given to New() when the cache was
|
|
// created (e.g. 5 minutes.)
|
|
DefaultExpiration time.Duration = 0
|
|
)
|
|
|
|
// Cache struct
|
|
type {{.ValueType}}Cache struct {
|
|
*cache
|
|
// If this is confusing, see the comment at the bottom of New()
|
|
}
|
|
|
|
type cache struct {
|
|
defaultExpiration time.Duration
|
|
items map[string]Item
|
|
mu sync.RWMutex
|
|
onEvicted func(string, {{.ValueType}})
|
|
janitor *janitor
|
|
}
|
|
|
|
// Add an item to the cache, replacing any existing item. If the duration is 0
|
|
// (DefaultExpiration), the cache's default expiration time is used. If it is -1
|
|
// (NoExpiration), the item never expires.
|
|
func (c *cache) Set(k string, x {{.ValueType}}, d time.Duration) {
|
|
// "Inlining" of set
|
|
var e int64
|
|
if d == DefaultExpiration {
|
|
d = c.defaultExpiration
|
|
}
|
|
if d > 0 {
|
|
e = time.Now().Add(d).UnixNano()
|
|
}
|
|
c.mu.Lock()
|
|
c.items[k] = Item{
|
|
Object: x,
|
|
Expiration: e,
|
|
}
|
|
// TODO: Calls to mu.Unlock are currently not deferred because defer
|
|
// adds ~200 ns (as of go1.)
|
|
c.mu.Unlock()
|
|
}
|
|
|
|
func (c *cache) set(k string, x {{.ValueType}}, d time.Duration) {
|
|
var e int64
|
|
if d == DefaultExpiration {
|
|
d = c.defaultExpiration
|
|
}
|
|
if d > 0 {
|
|
e = time.Now().Add(d).UnixNano()
|
|
}
|
|
c.items[k] = Item{
|
|
Object: x,
|
|
Expiration: e,
|
|
}
|
|
}
|
|
|
|
// Add an item to the cache only if an item doesn't already exist for the given
|
|
// key, or if the existing item has expired. Returns an error otherwise.
|
|
func (c *cache) Add(k string, x {{.ValueType}}, d time.Duration) error {
|
|
c.mu.Lock()
|
|
_, found := c.get(k)
|
|
if found {
|
|
c.mu.Unlock()
|
|
return fmt.Errorf("Item %s already exists", k)
|
|
}
|
|
c.set(k, x, d)
|
|
c.mu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
// Set a new value for the cache key only if it already exists, and the existing
|
|
// item hasn't expired. Returns an error otherwise.
|
|
func (c *cache) Replace(k string, x {{.ValueType}}, d time.Duration) error {
|
|
c.mu.Lock()
|
|
_, found := c.get(k)
|
|
if !found {
|
|
c.mu.Unlock()
|
|
return fmt.Errorf("Item %s doesn't exist", k)
|
|
}
|
|
c.set(k, x, d)
|
|
c.mu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
// Get an item from the cache. Returns the item or nil, and a bool indicating
|
|
// whether the key was found.
|
|
func (c *cache) Get(k string) ({{.ValueType}}, bool) {
|
|
c.mu.RLock()
|
|
// "Inlining" of get and Expired
|
|
item, found := c.items[k]
|
|
// TODO: inline time.Now implementation
|
|
if !found || item.Expiration > 0 && time.Now().UnixNano() > item.Expiration {
|
|
c.mu.RUnlock()
|
|
return {{.ZeroValue}}, false
|
|
}
|
|
c.mu.RUnlock()
|
|
return item.Object, true
|
|
}
|
|
|
|
func (c *cache) get(k string) (*{{.ValueType}}, bool) {
|
|
item, found := c.items[k]
|
|
if !found || item.Expiration > 0 && time.Now().UnixNano() > item.Expiration {
|
|
return nil, false
|
|
}
|
|
return &item.Object, true
|
|
}
|
|
|
|
{{ if call .IsNumberic .RealType }}
|
|
|
|
// Increment an item of type int, int8, int16, int32, int64, uintptr, uint,
|
|
// uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the
|
|
// item's value is not an integer, if it was not found, or if it is not
|
|
// possible to increment it by n. To retrieve the incremented value, use one
|
|
// of the specialized methods, e.g. IncrementInt64.
|
|
func (c *cache) Increment(k string, n {{.ValueType}}) error {
|
|
c.mu.Lock()
|
|
v, found := c.items[k]
|
|
if !found || v.Expired() {
|
|
c.mu.Unlock()
|
|
return fmt.Errorf("Item %s not found", k)
|
|
}
|
|
v.Object += n
|
|
c.items[k] = v
|
|
c.mu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
// Decrement an item of type int, int8, int16, int32, int64, uintptr, uint,
|
|
// uint8, uint32, or uint64, float32 or float64 by n. Returns an error if the
|
|
// item's value is not an integer, if it was not found, or if it is not
|
|
// possible to decrement it by n. To retrieve the decremented value, use one
|
|
// of the specialized methods, e.g. DecrementInt64.
|
|
func (c *cache) Decrement(k string, n {{.ValueType}}) error {
|
|
// TODO: Implement Increment and Decrement more cleanly.
|
|
// (Cannot do Increment(k, n*-1) for uints.)
|
|
c.mu.Lock()
|
|
v, found := c.items[k]
|
|
if !found || v.Expired() {
|
|
c.mu.Unlock()
|
|
return fmt.Errorf("Item not found")
|
|
}
|
|
c.items[k] = v
|
|
c.mu.Unlock()
|
|
return nil
|
|
}
|
|
|
|
{{end}}
|
|
|
|
// Delete an item from the cache. Does nothing if the key is not in the cache.
|
|
func (c *cache) Delete(k string) {
|
|
// fast path
|
|
if c.onEvicted == nil {
|
|
c.mu.Lock()
|
|
c.deleteFast(k)
|
|
c.mu.Unlock()
|
|
return
|
|
}
|
|
// slow path
|
|
c.mu.Lock()
|
|
v, evicted := c.delete(k)
|
|
c.mu.Unlock()
|
|
if evicted {
|
|
c.onEvicted(k, v)
|
|
}
|
|
}
|
|
|
|
func (c *cache) delete(k string) ({{.ValueType}}, bool) {
|
|
if v, found := c.items[k]; found {
|
|
delete(c.items, k)
|
|
return v.Object, true
|
|
}
|
|
return {{.ZeroValue}}, false
|
|
}
|
|
|
|
func (c *cache) deleteFast(k string) {
|
|
delete(c.items, k)
|
|
}
|
|
|
|
type keyAndValue struct {
|
|
key string
|
|
value {{.ValueType}}
|
|
}
|
|
|
|
// Delete all expired items from the cache.
|
|
func (c *cache) DeleteExpired() {
|
|
var evictedItems []keyAndValue
|
|
now := time.Now().UnixNano()
|
|
// fast path
|
|
if c.onEvicted == nil {
|
|
c.mu.Lock()
|
|
for k, v := range c.items {
|
|
// "Inlining" of expired
|
|
if v.Expiration > 0 && now > v.Expiration {
|
|
c.deleteFast(k)
|
|
}
|
|
}
|
|
c.mu.Unlock()
|
|
return
|
|
}
|
|
// slow path
|
|
c.mu.Lock()
|
|
for k, v := range c.items {
|
|
// "Inlining" of expired
|
|
if v.Expiration > 0 && now > v.Expiration {
|
|
ov, evicted := c.delete(k)
|
|
if evicted {
|
|
evictedItems = append(evictedItems, keyAndValue{k, ov})
|
|
}
|
|
}
|
|
}
|
|
c.mu.Unlock()
|
|
for _, v := range evictedItems {
|
|
c.onEvicted(v.key, v.value)
|
|
}
|
|
}
|
|
|
|
// Returns the number of items in the cache. This may include items that have
|
|
// expired, but have not yet been cleaned up. Equivalent to len(c.Items()).
|
|
func (c *cache) ItemCount() int {
|
|
c.mu.RLock()
|
|
n := len(c.items)
|
|
c.mu.RUnlock()
|
|
return n
|
|
}
|
|
|
|
// Delete all items from the cache.
|
|
func (c *cache) Flush() {
|
|
c.mu.Lock()
|
|
c.items = map[string]Item{}
|
|
c.mu.Unlock()
|
|
}
|
|
|
|
type janitor struct {
|
|
Interval time.Duration
|
|
stop chan bool
|
|
}
|
|
|
|
func (j *janitor) Run(c *cache) {
|
|
j.stop = make(chan bool)
|
|
ticker := time.NewTicker(j.Interval)
|
|
for {
|
|
select {
|
|
case <-ticker.C:
|
|
c.DeleteExpired()
|
|
case <-j.stop:
|
|
ticker.Stop()
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func stopJanitor(c *{{.ValueType}}Cache) {
|
|
c.janitor.stop <- true
|
|
}
|
|
|
|
func runJanitor(c *cache, ci time.Duration) {
|
|
j := &janitor{
|
|
Interval: ci,
|
|
}
|
|
c.janitor = j
|
|
go j.Run(c)
|
|
}
|
|
|
|
func newCache(de time.Duration, m map[string]Item) *cache {
|
|
if de == 0 {
|
|
de = -1
|
|
}
|
|
c := &cache{
|
|
defaultExpiration: de,
|
|
items: m,
|
|
}
|
|
return c
|
|
}
|
|
|
|
func newCacheWithJanitor(de time.Duration, ci time.Duration, m map[string]Item, onEvicted func(k string, v {{.ValueType}})) *{{.ValueType}}Cache {
|
|
c := newCache(de, m)
|
|
c.onEvicted = onEvicted
|
|
// This trick ensures that the janitor goroutine (which--granted it
|
|
// was enabled--is running DeleteExpired on c forever) does not keep
|
|
// the returned C object from being garbage collected. When it is
|
|
// garbage collected, the finalizer stops the janitor goroutine, after
|
|
// which c can be collected.
|
|
C := &{{.ValueType}}Cache{c}
|
|
if ci > 0 {
|
|
runJanitor(c, ci)
|
|
runtime.SetFinalizer(C, stopJanitor)
|
|
}
|
|
return C
|
|
}
|
|
|
|
// New Returns a new cache with a given default expiration duration and
|
|
// cleanup interval. If the expiration duration is less than one
|
|
// (or NoExpiration), the items in the cache never expire (by default),
|
|
// and must be deleted manually. If the cleanup interval is less than one,
|
|
// expired items are not deleted from the cache before calling c.DeleteExpired().
|
|
//
|
|
func New{{.ValueType}}Cache(attr {{.ValueType}}CacheAttr) *{{.ValueType}}Cache {
|
|
items := make(map[string]Item, attr.Size)
|
|
return newCacheWithJanitor(attr.DefaultExpiration, attr.DefaultCleanupInterval, items, attr.OnEvicted)
|
|
}
|