dolt/go/store/nbs/manifest_cache.go

// Copyright 2019 Dolthub, Inc.
//
// 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.
//
// This file incorporates work covered by the following copyright and
// permission notice:
//
// Copyright 2016 Attic Labs, Inc. All rights reserved.
// Licensed under the Apache License, version 2.0:
// http://www.apache.org/licenses/LICENSE-2.0

package nbs

import (
	"container/list"
	"fmt"
	"time"

	"sync"
)

func newManifestCache(maxSize uint64) *manifestCache {
	return &manifestCache{
		maxSize: maxSize,
		cache:   map[string]manifestCacheEntry{},
		mu:      &sync.Mutex{},
	}
}

type manifestCacheEntry struct {
	lruEntry *list.Element
	contents manifestContents
	t        time.Time
}

type manifestCache struct {
	totalSize uint64
	maxSize   uint64
	mu        *sync.Mutex
	lru       list.List
	cache     map[string]manifestCacheEntry
}

// Get() checks the searches the cache for an entry. If it exists, it moves it's
// lru entry to the back of the queue and returns (value, true). Otherwise, it
// returns (nil, false).
func (mc *manifestCache) Get(db string) (contents manifestContents, t time.Time, present bool) {
	mc.mu.Lock()
	defer mc.mu.Unlock()

	if entry, ok := mc.entry(db); ok {
		contents, t, present = entry.contents, entry.t, true
	}
	return
}

// entry() checks if the value is in the cache. If not in the cache, it returns an
// empty manifestCacheEntry and false. It it is in the cache, it moves it to
// to the back of lru and returns the entry and true.
func (mc *manifestCache) entry(key string) (manifestCacheEntry, bool) {
	entry, ok := mc.cache[key]
	if !ok {
		return manifestCacheEntry{}, false
	}
	mc.lru.MoveToBack(entry.lruEntry)
	return entry, true
}

// Put inserts |contents| into the cache with the key |db|, replacing any
// currently cached value. Put() will add this element to the cache at the
// back of the queue as long it's size does not exceed maxSize. If the
// addition of this entry causes the size of the cache to exceed maxSize, the
// necessary entries at the front of the queue will be deleted in order to
// keep the total cache size below maxSize. |t| must be *prior* to initiating
// the call which read/wrote |contents|.
func (mc *manifestCache) Put(db string, contents manifestContents, t time.Time) error {
	mc.mu.Lock()
	defer mc.mu.Unlock()

	if entry, ok := mc.entry(db); ok {
		mc.totalSize -= entry.contents.size()
		mc.lru.Remove(entry.lruEntry)
		delete(mc.cache, db)
	}

	if contents.size() <= mc.maxSize {
		newEl := mc.lru.PushBack(db)
		ce := manifestCacheEntry{lruEntry: newEl, contents: contents, t: t}
		mc.cache[db] = ce
		mc.totalSize += ce.contents.size()
		for el := mc.lru.Front(); el != nil && mc.totalSize > mc.maxSize; {
			key1 := el.Value.(string)
			ce, ok := mc.cache[key1]
			if !ok {
				return fmt.Errorf("manifestCache is missing expected value for %s", key1)
			}
			next := el.Next()
			delete(mc.cache, key1)
			mc.totalSize -= ce.contents.size()
			mc.lru.Remove(el)
			el = next
		}
	}

	return nil
}

// Delete removes a key from the cache.
func (mc *manifestCache) Delete(db string) {
	mc.mu.Lock()
	defer mc.mu.Unlock()

	if entry, ok := mc.entry(db); ok {
		mc.totalSize -= entry.contents.size()
		mc.lru.Remove(entry.lruEntry)
		delete(mc.cache, db)
	}

	return
}