add GetDropped function

Author: karlseguin

cache.go

@@ -10,13 +10,15 @@ import (
 
 type Cache struct {
 	*Configuration
-	list        *list.List
-	size        int64
-	buckets     []*bucket
-	bucketMask  uint32
-	deletables  chan *Item
-	promotables chan *Item
-	donec       chan struct{}
+	list          *list.List
+	size          int64
+	buckets       []*bucket
+	bucketMask    uint32
+	deletables    chan *Item
+	promotables   chan *Item
+	donec         chan struct{}
+	getDroppedReq chan struct{}
+	getDroppedRes chan int
 }
 
 // Create a new cache with the specified configuration
@@ -27,6 +29,8 @@ func New(config *Configuration) *Cache {
 		Configuration: config,
 		bucketMask:    uint32(config.buckets) - 1,
 		buckets:       make([]*bucket, config.buckets),
+		getDroppedReq: make(chan struct{}),
+		getDroppedRes: make(chan int),
 	}
 	for i := 0; i < int(config.buckets); i++ {
 		c.buckets[i] = &bucket{
@@ -137,6 +141,13 @@ func (c *Cache) Stop() {
 	<-c.donec
 }
 
+// Gets the number of items removed from the cache due to memory pressure since
+// the last time GetDropped was called
+func (c *Cache) GetDropped() int {
+	c.getDroppedReq <- struct{}{}
+	return <-c.getDroppedRes
+}
+
 func (c *Cache) restart() {
 	c.deletables = make(chan *Item, c.deleteBuffer)
 	c.promotables = make(chan *Item, c.promoteBuffer)
@@ -170,18 +181,21 @@ func (c *Cache) promote(item *Item) {
 
 func (c *Cache) worker() {
 	defer close(c.donec)
-
+	dropped := 0
 	for {
 		select {
 		case item, ok := <-c.promotables:
 			if ok == false {
 				goto drain
 			}
 			if c.doPromote(item) && c.size > c.maxSize {
-				c.gc()
+				dropped += c.gc()
 			}
 		case item := <-c.deletables:
 			c.doDelete(item)
+		case _ = <-c.getDroppedReq:
+			c.getDroppedRes <- dropped
+			dropped = 0
 		}
 	}
 
@@ -227,11 +241,12 @@ func (c *Cache) doPromote(item *Item) bool {
 	return true
 }
 
-func (c *Cache) gc() {
+func (c *Cache) gc() int {
+	dropped := 0
 	element := c.list.Back()
 	for i := 0; i < c.itemsToPrune; i++ {
 		if element == nil {
-			return
+			return dropped
 		}
 		prev := element.Prev()
 		item := element.Value.(*Item)
@@ -242,8 +257,10 @@ func (c *Cache) gc() {
 			if c.onDelete != nil {
 				c.onDelete(item)
 			}
+			dropped += 1
 			item.promotions = -2
 		}
 		element = prev
 	}
+	return dropped
 }

cache_test.go

@@ -156,6 +156,8 @@ func (_ CacheTests) RemovesOldestItemWhenFullBySizer() {
 	Expect(cache.Get("2")).To.Equal(nil)
 	Expect(cache.Get("3")).To.Equal(nil)
 	Expect(cache.Get("4").Value().(*SizedItem).id).To.Equal(4)
+	Expect(cache.GetDropped()).To.Equal(4)
+	Expect(cache.GetDropped()).To.Equal(0)
 }
 
 func (_ CacheTests) SetUpdatesSizeOnDelta() {

layeredcache.go

@@ -10,13 +10,15 @@ import (
 
 type LayeredCache struct {
 	*Configuration
-	list        *list.List
-	buckets     []*layeredBucket
-	bucketMask  uint32
-	size        int64
-	deletables  chan *Item
-	promotables chan *Item
-	donec       chan struct{}
+	list          *list.List
+	buckets       []*layeredBucket
+	bucketMask    uint32
+	size          int64
+	deletables    chan *Item
+	promotables   chan *Item
+	donec         chan struct{}
+	getDroppedReq chan struct{}
+	getDroppedRes chan int
 }
 
 // Create a new layered cache with the specified configuration.
@@ -39,6 +41,8 @@ func Layered(config *Configuration) *LayeredCache {
 		bucketMask:    uint32(config.buckets) - 1,
 		buckets:       make([]*layeredBucket, config.buckets),
 		deletables:    make(chan *Item, config.deleteBuffer),
+		getDroppedReq: make(chan struct{}),
+		getDroppedRes: make(chan int),
 	}
 	for i := 0; i < int(config.buckets); i++ {
 		c.buckets[i] = &layeredBucket{
@@ -162,6 +166,13 @@ func (c *LayeredCache) Stop() {
 	<-c.donec
 }
 
+// Gets the number of items removed from the cache due to memory pressure since
+// the last time GetDropped was called
+func (c *LayeredCache) GetDropped() int {
+	c.getDroppedReq <- struct{}{}
+	return <-c.getDroppedRes
+}
+
 func (c *LayeredCache) restart() {
 	c.promotables = make(chan *Item, c.promoteBuffer)
 	c.donec = make(chan struct{})
@@ -189,14 +200,15 @@ func (c *LayeredCache) promote(item *Item) {
 
 func (c *LayeredCache) worker() {
 	defer close(c.donec)
+	dropped := 0
 	for {
 		select {
 		case item, ok := <-c.promotables:
 			if ok == false {
 				return
 			}
 			if c.doPromote(item) && c.size > c.maxSize {
-				c.gc()
+				dropped += c.gc()
 			}
 		case item := <-c.deletables:
 			if item.element == nil {
@@ -208,6 +220,9 @@ func (c *LayeredCache) worker() {
 				}
 				c.list.Remove(item.element)
 			}
+		case _ = <-c.getDroppedReq:
+			c.getDroppedRes <- dropped
+			dropped = 0
 		}
 	}
 }
@@ -229,11 +244,12 @@ func (c *LayeredCache) doPromote(item *Item) bool {
 	return true
 }
 
-func (c *LayeredCache) gc() {
+func (c *LayeredCache) gc() int {
 	element := c.list.Back()
+	dropped := 0
 	for i := 0; i < c.itemsToPrune; i++ {
 		if element == nil {
-			return
+			return dropped
 		}
 		prev := element.Prev()
 		item := element.Value.(*Item)
@@ -242,7 +258,9 @@ func (c *LayeredCache) gc() {
 			c.size -= item.size
 			c.list.Remove(element)
 			item.promotions = -2
+			dropped += 1
 		}
 		element = prev
 	}
+	return dropped
 }

layeredcache_test.go

@@ -170,6 +170,8 @@ func (_ LayeredCacheTests) RemovesOldestItemWhenFull() {
 	Expect(cache.Get("2", "a")).To.Equal(nil)
 	Expect(cache.Get("3", "a").Value()).To.Equal(3)
 	Expect(cache.Get("xx", "b").Value()).To.Equal(9001)
+	Expect(cache.GetDropped()).To.Equal(4)
+	Expect(cache.GetDropped()).To.Equal(0)
 }
 
 func newLayered() *LayeredCache {