mirror of
https://gitlab.com/pulsechaincom/prysm-pulse.git
synced 2024-12-25 12:57:18 +00:00
02966e64d8
* Add Wrapper to LRU Cache to handle Invalid Parameters #9461 * Regenerate BUILD.bazel and simplify tests using lru.Cache * Fix: fuzz_exports.go build error * Fix: block_fuzz.go * Revert lru.Cache interface * Remove redundant err check in pending_attestations_queue_test.go * Add tests for lru wrapper * Use lru package in prysm/shared instead of lruwrpr * Fix: goimports * Fix: BUILD.bazel Co-authored-by: Nishant Das <nishdas93@gmail.com>
79 lines
2.5 KiB
Go
79 lines
2.5 KiB
Go
package cache
|
|
|
|
import (
|
|
"sync"
|
|
|
|
lru "github.com/hashicorp/golang-lru"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promauto"
|
|
"github.com/prysmaticlabs/prysm/beacon-chain/state"
|
|
ethpb "github.com/prysmaticlabs/prysm/proto/prysm/v1alpha1"
|
|
"github.com/prysmaticlabs/prysm/shared/hashutil"
|
|
lruwrpr "github.com/prysmaticlabs/prysm/shared/lru"
|
|
)
|
|
|
|
var (
|
|
// maxCheckpointStateSize defines the max number of entries check point to state cache can contain.
|
|
// Choosing 10 to account for multiple forks, this allows 5 forks per epoch boundary with 2 epochs
|
|
// window to accept attestation based on latest spec.
|
|
maxCheckpointStateSize = 10
|
|
|
|
// Metrics.
|
|
checkpointStateMiss = promauto.NewCounter(prometheus.CounterOpts{
|
|
Name: "check_point_state_cache_miss",
|
|
Help: "The number of check point state requests that aren't present in the cache.",
|
|
})
|
|
checkpointStateHit = promauto.NewCounter(prometheus.CounterOpts{
|
|
Name: "check_point_state_cache_hit",
|
|
Help: "The number of check point state requests that are present in the cache.",
|
|
})
|
|
)
|
|
|
|
// CheckpointStateCache is a struct with 1 queue for looking up state by checkpoint.
|
|
type CheckpointStateCache struct {
|
|
cache *lru.Cache
|
|
lock sync.RWMutex
|
|
}
|
|
|
|
// NewCheckpointStateCache creates a new checkpoint state cache for storing/accessing processed state.
|
|
func NewCheckpointStateCache() *CheckpointStateCache {
|
|
return &CheckpointStateCache{
|
|
cache: lruwrpr.New(maxCheckpointStateSize),
|
|
}
|
|
}
|
|
|
|
// StateByCheckpoint fetches state by checkpoint. Returns true with a
|
|
// reference to the CheckpointState info, if exists. Otherwise returns false, nil.
|
|
func (c *CheckpointStateCache) StateByCheckpoint(cp *ethpb.Checkpoint) (state.BeaconState, error) {
|
|
c.lock.RLock()
|
|
defer c.lock.RUnlock()
|
|
h, err := hashutil.HashProto(cp)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
item, exists := c.cache.Get(h)
|
|
|
|
if exists && item != nil {
|
|
checkpointStateHit.Inc()
|
|
// Copy here is unnecessary since the return will only be used to verify attestation signature.
|
|
return item.(state.BeaconState), nil
|
|
}
|
|
|
|
checkpointStateMiss.Inc()
|
|
return nil, nil
|
|
}
|
|
|
|
// AddCheckpointState adds CheckpointState object to the cache. This method also trims the least
|
|
// recently added CheckpointState object if the cache size has ready the max cache size limit.
|
|
func (c *CheckpointStateCache) AddCheckpointState(cp *ethpb.Checkpoint, s state.ReadOnlyBeaconState) error {
|
|
c.lock.Lock()
|
|
defer c.lock.Unlock()
|
|
h, err := hashutil.HashProto(cp)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
c.cache.Add(h, s)
|
|
return nil
|
|
}
|