arazmj / gerdu

package lfucache

import (

	"encoding/json"

	"github.com/arazmj/gerdu/cache"

	"github.com/arazmj/gerdu/dlinklist"

	"github.com/arazmj/gerdu/metrics"

	"github.com/hashicorp/raft"

	"github.com/inhies/go-bytesize"

	"io"

	"sync"

)

// LFUCache data structure

type LFUCache struct {

	sync.RWMutex

	cache.UnImplementedCache

	size     bytesize.ByteSize

	capacity bytesize.ByteSize

	node     map[string]*dlinklist.Node

	freq     map[int]*dlinklist.DLinkedList

	minFreq  int

}

// NewCache LFUCache constructor

func NewCache(capacity bytesize.ByteSize) *LFUCache {

	return &LFUCache{

		size:     0,

		capacity: capacity,

		node:     map[string]*dlinklist.Node{},

		freq:     map[int]*dlinklist.DLinkedList{},

		minFreq:  0,

	}

}

// This is a helper function that used in the following two cases:

//

// 1. when Get(key)` is called; and

// 2. when Put(key, value)` is called and the key exists.

//

// The common point of these two cases is that:

//

// 1. no new node comes in, and

// 2. the node is visited one more times -> node.freq changed ->

// thus the place of this node will change

//

// The logic of this function is:

//

// 1. pop the node from the old DLinkedList (with freq `f`)

// 2. append the node to new DLinkedList (with freq `f+1`)

// 3. if old DLinkedList has size 0 and minFreq is `f`,

// update minFreq to `f+1`

//

// All of the above operations took O(1) time.

func (c *LFUCache) update(node *dlinklist.Node) {

	freq := node.Freq

	c.freq[freq].RemoveNode(node)

	if v, _ := c.freq[freq]; c.minFreq == freq && v.Size() == 0 {

		delete(c.freq, freq)

		c.minFreq++

	}

	node.Freq++

	freq = node.Freq

	if _, ok := c.freq[freq]; !ok {

		c.freq[freq] = dlinklist.NewLinkedList()

	}

	c.freq[freq].AddNode(node)

}

// Get through checking node[key], we can get the node in O(1) time.

// Just performs update, then we can return the value of node.

func (c *LFUCache) Get(key string) (value string, ok bool) {

	defer c.Unlock()

	c.Lock()

	if _, ok := c.node[key]; !ok {

		metrics.Miss.Inc()

		return "", false

	}

	metrics.Hits.Inc()

	node := c.node[key]

	c.update(node)

	return node.Value, true

}

// Put If `key` already exists in self._node, we do the same operations as `get`, except

// updating the node.val to new value.	Otherwise

// 1. if the cache reaches its capacity, pop the least frequently used item. (*)

// 2. add new node to self._node

// 3. add new node to the DLinkedList with frequency 1

// 4. reset minFreq to 1

//

// (*) How to pop the least frequently used item? Two facts:

// 1. we maintain the minFreq, the minimum possible frequency in cache.

// 2. All cache with the same frequency are stored as a DLinkedList, with

// recently used order (Always append at head)

// 3. The tail of the DLinkedList with minFreq is the least

//recently used one, pop it.

func (c *LFUCache) Put(key, value string) (created bool) {

	defer c.Unlock()

	c.Lock()

	if c.capacity == 0 {

		return

	}

	if _, ok := c.node[key]; ok {

		metrics.Hits.Inc()

		node := c.node[key]

		c.update(node)

		node.Value = value

		created = false

	} else {

		c.size += bytesize.ByteSize(len(value))

		for c.size > c.capacity {

			minList, ok := c.freq[c.minFreq]

			metrics.Deletes.Inc()

			if !ok || minList.Size() == 0 {

				delete(c.freq, c.minFreq)

				c.minFreq++

			} else {

				node := minList.PopTail()

				freq := node.Freq

				if v, _ := c.freq[c.minFreq]; c.minFreq == freq && v.Size() == 0 {

					delete(c.freq, freq)

					c.minFreq++

				}

				c.size -= bytesize.ByteSize(len(node.Value))

				delete(c.node, node.Key)

			}

		}

		metrics.Adds.Inc()

		node := &dlinklist.Node{

			Key:   key,

			Value: value,

			Freq:  1,

		}

		c.node[key] = node

		if _, ok := c.freq[1]; !ok {

			c.freq[1] = dlinklist.NewLinkedList()

		}

		c.freq[1].AddNode(node)

		c.minFreq = 1

		created = true

	}

	return created

}

//Delete deletes a key from LFU cache

func (c *LFUCache) Delete(key string) (ok bool) {

	node, ok := c.node[key]

	if !ok {

		return false

	}

	freq := node.Freq

	if v, _ := c.freq[c.minFreq]; c.minFreq == freq && v.Size() == 0 {

		metrics.Deletes.Inc()

		delete(c.freq, freq)

		c.minFreq++

	}

	delete(c.node, key)

	return true

}

func (c *LFUCache) Snapshot() (raft.FSMSnapshot, error) {

	c.RLock()

	defer c.RUnlock()

	o := make(map[string]string)

	for k, v := range c.node {

		o[k] = v.Value

	}

	return &fsmSnapshot{store: o}, nil

}

func (c *LFUCache) Restore(closer io.ReadCloser) error {

	o := make(map[string]string)

	if err := json.NewDecoder(closer).Decode(&o); err != nil {

		return err

	}

	// Set the state from the snapshot, no lock required according to

	// Hashicorp docs.

	for k, v := range o {

		c.Put(k, v)

	}

	return nil

}

type fsmSnapshot struct {

	store map[string]string

}

func (f *fsmSnapshot) Release() {}