Files
node/x/merkledb/cache.go
T
Hanzo AI 6de839a515 codec: rip github.com/luxfi/codec from leaf-misc (Wave 1D)
Wave 1D of the luxfi/codec final rip: leaf-misc tier under node/.
This batch removes the direct codec/wrappers, codec/linearcodec, and
codec.Manager imports from p2p network protocol, IP/port encoding,
indexer/keystore on-disk storage, warp socket IPC, x/archivedb +
merkledb internals, and the primary-network wallet UTXO loader.

Migration shape:

(a) codec/wrappers.Packer + length constants
    → node/utils/wrappers (same shape, already in tree as the local
      canonical home for binary IO helpers). 14 files: indexer/,
      network/, utils/ips/, utils/metric/, warp/, x/.

(b) codec.Manager + linearcodec for on-disk container storage
    → hand-rolled big-endian binary marshal/unmarshal. Hard cut;
      no codec-version prefix; payload size bounded explicitly:
      - indexer/codec.go: marshalContainer/unmarshalContainer
      - service/keystore/codec.go: marshalHash/unmarshalHash and
        marshalUser/unmarshalUser, 16 MiB blob cap retained.

(c) codec.Manager for cross-chain UTXO parsing (wallet/network/primary)
    → utxo.ParseUTXO via the ZAP wire dispatcher already registered
      by node/vms/components/lux. Drops the per-chain codec.Manager
      slot from FetchState; AddAllUTXOs no longer takes a codec.
      Underscore-import of vms/components/lux ensures the dispatcher
      is wired even for callers that don't already pull platformvm.

No snow/snowman/snowball/avalanche/avm/subnet residue introduced.
2026-06-05 11:57:14 -07:00

111 lines
2.9 KiB
Go

// Copyright (C) 2019-2025, Lux Industries Inc. All rights reserved.
// See the file LICENSE for licensing terms.
package merkledb
import (
"errors"
"sync"
"github.com/luxfi/container/linked"
"github.com/luxfi/node/utils/wrappers"
)
var errEmptyCacheTooLarge = errors.New("cache is empty yet still too large")
// A cache that calls [onEviction] on the evicted element.
type onEvictCache[K comparable, V any] struct {
lock sync.RWMutex
maxSize int
currentSize int
fifo *linked.Hashmap[K, V]
size func(K, V) int
// Must not call any method that grabs [c.lock]
// because this would cause a deadlock.
onEviction func(K, V) error
}
// [size] must always return a positive number.
func newOnEvictCache[K comparable, V any](
maxSize int,
size func(K, V) int,
onEviction func(K, V) error,
) onEvictCache[K, V] {
return onEvictCache[K, V]{
maxSize: maxSize,
fifo: linked.NewHashmap[K, V](),
size: size,
onEviction: onEviction,
}
}
// Get an element from this cache.
func (c *onEvictCache[K, V]) Get(key K) (V, bool) {
c.lock.RLock()
defer c.lock.RUnlock()
return c.fifo.Get(key)
}
// Put an element into this cache. If this causes an element
// to be evicted, calls [c.onEviction] on the evicted element
// and returns the error from [c.onEviction]. Otherwise, returns nil.
func (c *onEvictCache[K, V]) Put(key K, value V) error {
c.lock.Lock()
defer c.lock.Unlock()
if oldValue, replaced := c.fifo.Get(key); replaced {
c.currentSize -= c.size(key, oldValue)
}
c.currentSize += c.size(key, value)
c.fifo.Put(key, value) // Mark as MRU
return c.resize(c.maxSize)
}
// Flush removes all elements from the cache.
//
// Returns the first non-nil error returned by [c.onEviction], if any.
//
// If [c.onEviction] errors, it will still be called for any subsequent elements
// and the cache will still be emptied.
func (c *onEvictCache[K, V]) Flush() error {
c.lock.Lock()
defer c.lock.Unlock()
return c.resize(0)
}
// removeOldest returns and removes the oldest element from this cache.
//
// Assumes [c.lock] is held.
func (c *onEvictCache[K, V]) removeOldest() (K, V, bool) {
k, v, exists := c.fifo.Oldest()
if exists {
c.currentSize -= c.size(k, v)
c.fifo.Delete(k)
}
return k, v, exists
}
// resize removes the oldest elements from the cache until the cache is not
// larger than the provided target.
//
// Assumes [c.lock] is held.
func (c *onEvictCache[K, V]) resize(target int) error {
// Note that we can't use [c.fifo]'s iterator because [c.onEviction]
// modifies [c.fifo], which violates the iterator's invariant.
var errs wrappers.Errs
for c.currentSize > target {
k, v, exists := c.removeOldest()
if !exists {
// This should really never happen unless the size of an entry
// changed or the target size is negative.
return errEmptyCacheTooLarge
}
errs.Add(c.onEviction(k, v))
}
return errs.Err
}