mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-08-20 10:52:25 +00:00
beacon/light: moved canonicalStore to separate file
This commit is contained in:
zsfelfoldi
parent
3a46f01060
commit
2baa1bf1d7
2 changed files with 139 additions and 114 deletions
139
beacon/light/canonical.go
Normal file
139
beacon/light/canonical.go
Normal file
|
|
@ -0,0 +1,139 @@
|
||||||
|
// Copyright 2023 The go-ethereum Authors
|
||||||
|
// This file is part of the go-ethereum library.
|
||||||
|
//
|
||||||
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// (at your option) any later version.
|
||||||
|
//
|
||||||
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU Lesser General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU Lesser General Public License
|
||||||
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
package light
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/binary"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/ethereum/go-ethereum/common/lru"
|
||||||
|
"github.com/ethereum/go-ethereum/ethdb"
|
||||||
|
"github.com/ethereum/go-ethereum/log"
|
||||||
|
)
|
||||||
|
|
||||||
|
// canonicalStore stores instances of the given type in a database and caches
|
||||||
|
// them in memory, associated with a continuous range of period numbers.
|
||||||
|
// Note: canonicalStore is not thread safe and it is the caller's responsibility
|
||||||
|
// to avoid concurrent access.
|
||||||
|
type canonicalStore[T any] struct {
|
||||||
|
db ethdb.KeyValueStore
|
||||||
|
keyPrefix []byte
|
||||||
|
periods Range
|
||||||
|
cache *lru.Cache[uint64, T]
|
||||||
|
encode func(T) ([]byte, error)
|
||||||
|
decode func([]byte) (T, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// newCanonicalStore creates a new canonicalStore.
|
||||||
|
func newCanonicalStore[T any](db ethdb.KeyValueStore, keyPrefix []byte,
|
||||||
|
encode func(T) ([]byte, error), decode func([]byte) (T, error)) *canonicalStore[T] {
|
||||||
|
cs := &canonicalStore[T]{
|
||||||
|
db: db,
|
||||||
|
keyPrefix: keyPrefix,
|
||||||
|
encode: encode,
|
||||||
|
decode: decode,
|
||||||
|
cache: lru.NewCache[uint64, T](100),
|
||||||
|
}
|
||||||
|
var (
|
||||||
|
iter = db.NewIterator(keyPrefix, nil)
|
||||||
|
kl = len(keyPrefix)
|
||||||
|
)
|
||||||
|
for iter.Next() {
|
||||||
|
if len(iter.Key()) != kl+8 {
|
||||||
|
log.Warn("Invalid key length in the canonical chain database", "key", fmt.Sprintf("%#x", iter.Key()))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
period := binary.BigEndian.Uint64(iter.Key()[kl : kl+8])
|
||||||
|
if cs.periods.First == 0 {
|
||||||
|
cs.periods.First = period
|
||||||
|
} else if cs.periods.Next != period {
|
||||||
|
log.Warn("Gap in the canonical chain database")
|
||||||
|
break // continuity guaranteed
|
||||||
|
}
|
||||||
|
cs.periods.Next = period + 1
|
||||||
|
}
|
||||||
|
iter.Release()
|
||||||
|
return cs
|
||||||
|
}
|
||||||
|
|
||||||
|
// databaseKey returns the database key belonging to the given period.
|
||||||
|
func (cs *canonicalStore[T]) databaseKey(period uint64) []byte {
|
||||||
|
var (
|
||||||
|
kl = len(cs.keyPrefix)
|
||||||
|
key = make([]byte, kl+8)
|
||||||
|
)
|
||||||
|
copy(key[:kl], cs.keyPrefix)
|
||||||
|
binary.BigEndian.PutUint64(key[kl:], period)
|
||||||
|
return key
|
||||||
|
}
|
||||||
|
|
||||||
|
// add adds the given item to the database. It also ensures that the range remains
|
||||||
|
// continuous. Can be used either with a batch or database backend.
|
||||||
|
func (cs *canonicalStore[T]) add(backend ethdb.KeyValueWriter, period uint64, value T) error {
|
||||||
|
if !cs.periods.CanExpand(period) {
|
||||||
|
return fmt.Errorf("period expansion is not allowed, first: %d, next: %d, period: %d", cs.periods.First, cs.periods.Next, period)
|
||||||
|
}
|
||||||
|
enc, err := cs.encode(value)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := backend.Put(cs.databaseKey(period), enc); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cs.cache.Add(period, value)
|
||||||
|
cs.periods.Expand(period)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// deleteFrom removes items starting from the given period.
|
||||||
|
func (cs *canonicalStore[T]) deleteFrom(batch ethdb.Batch, fromPeriod uint64) (deleted Range) {
|
||||||
|
if fromPeriod >= cs.periods.Next {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if fromPeriod < cs.periods.First {
|
||||||
|
fromPeriod = cs.periods.First
|
||||||
|
}
|
||||||
|
deleted = Range{First: fromPeriod, Next: cs.periods.Next}
|
||||||
|
for period := fromPeriod; period < cs.periods.Next; period++ {
|
||||||
|
batch.Delete(cs.databaseKey(period))
|
||||||
|
cs.cache.Remove(period)
|
||||||
|
}
|
||||||
|
if fromPeriod > cs.periods.First {
|
||||||
|
cs.periods.Next = fromPeriod
|
||||||
|
} else {
|
||||||
|
cs.periods = Range{}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// get returns the item at the given period or the null value of the given type
|
||||||
|
// if no item is present.
|
||||||
|
// Note: get is thread safe in itself and therefore can be called either with
|
||||||
|
// locked or unlocked chain mutex.
|
||||||
|
func (cs *canonicalStore[T]) get(period uint64) (value T, ok bool) {
|
||||||
|
if value, ok = cs.cache.Get(period); ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if enc, err := cs.db.Get(cs.databaseKey(period)); err == nil {
|
||||||
|
if v, err := cs.decode(enc); err == nil {
|
||||||
|
value, ok = v, true
|
||||||
|
} else {
|
||||||
|
log.Error("Error decoding canonical store value", "error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
@ -17,7 +17,6 @@
|
||||||
package light
|
package light
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/binary"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"math"
|
"math"
|
||||||
|
|
@ -513,116 +512,3 @@ func (s *CommitteeChain) verifyUpdate(update *types.LightClientUpdate) (bool, er
|
||||||
}
|
}
|
||||||
return ok, err
|
return ok, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// canonicalStore stores instances of the given type in a database and caches
|
|
||||||
// them in memory, associated with a continuous range of period numbers.
|
|
||||||
// Note: canonicalStore is not thread safe and it is the caller's responsibility
|
|
||||||
// to avoid concurrent access.
|
|
||||||
type canonicalStore[T any] struct {
|
|
||||||
db ethdb.KeyValueStore
|
|
||||||
keyPrefix []byte
|
|
||||||
periods Range
|
|
||||||
cache *lru.Cache[uint64, T]
|
|
||||||
encode func(T) ([]byte, error)
|
|
||||||
decode func([]byte) (T, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// newCanonicalStore creates a new canonicalStore.
|
|
||||||
func newCanonicalStore[T any](db ethdb.KeyValueStore, keyPrefix []byte,
|
|
||||||
encode func(T) ([]byte, error), decode func([]byte) (T, error)) *canonicalStore[T] {
|
|
||||||
cs := &canonicalStore[T]{
|
|
||||||
db: db,
|
|
||||||
keyPrefix: keyPrefix,
|
|
||||||
encode: encode,
|
|
||||||
decode: decode,
|
|
||||||
cache: lru.NewCache[uint64, T](100),
|
|
||||||
}
|
|
||||||
var (
|
|
||||||
iter = db.NewIterator(keyPrefix, nil)
|
|
||||||
kl = len(keyPrefix)
|
|
||||||
)
|
|
||||||
for iter.Next() {
|
|
||||||
if len(iter.Key()) != kl+8 {
|
|
||||||
log.Warn("Invalid key length in the canonical chain database", "key", fmt.Sprintf("%#x", iter.Key()))
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
period := binary.BigEndian.Uint64(iter.Key()[kl : kl+8])
|
|
||||||
if cs.periods.First == 0 {
|
|
||||||
cs.periods.First = period
|
|
||||||
} else if cs.periods.Next != period {
|
|
||||||
log.Warn("Gap in the canonical chain database")
|
|
||||||
break // continuity guaranteed
|
|
||||||
}
|
|
||||||
cs.periods.Next = period + 1
|
|
||||||
}
|
|
||||||
iter.Release()
|
|
||||||
return cs
|
|
||||||
}
|
|
||||||
|
|
||||||
// databaseKey returns the database key belonging to the given period.
|
|
||||||
func (cs *canonicalStore[T]) databaseKey(period uint64) []byte {
|
|
||||||
var (
|
|
||||||
kl = len(cs.keyPrefix)
|
|
||||||
key = make([]byte, kl+8)
|
|
||||||
)
|
|
||||||
copy(key[:kl], cs.keyPrefix)
|
|
||||||
binary.BigEndian.PutUint64(key[kl:], period)
|
|
||||||
return key
|
|
||||||
}
|
|
||||||
|
|
||||||
// add adds the given item to the database. It also ensures that the range remains
|
|
||||||
// continuous. Can be used either with a batch or database backend.
|
|
||||||
func (cs *canonicalStore[T]) add(backend ethdb.KeyValueWriter, period uint64, value T) error {
|
|
||||||
if !cs.periods.CanExpand(period) {
|
|
||||||
return fmt.Errorf("period expansion is not allowed, first: %d, next: %d, period: %d", cs.periods.First, cs.periods.Next, period)
|
|
||||||
}
|
|
||||||
enc, err := cs.encode(value)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if err := backend.Put(cs.databaseKey(period), enc); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
cs.cache.Add(period, value)
|
|
||||||
cs.periods.Expand(period)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// deleteFrom removes items starting from the given period.
|
|
||||||
func (cs *canonicalStore[T]) deleteFrom(batch ethdb.Batch, fromPeriod uint64) (deleted Range) {
|
|
||||||
if fromPeriod >= cs.periods.Next {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if fromPeriod < cs.periods.First {
|
|
||||||
fromPeriod = cs.periods.First
|
|
||||||
}
|
|
||||||
deleted = Range{First: fromPeriod, Next: cs.periods.Next}
|
|
||||||
for period := fromPeriod; period < cs.periods.Next; period++ {
|
|
||||||
batch.Delete(cs.databaseKey(period))
|
|
||||||
cs.cache.Remove(period)
|
|
||||||
}
|
|
||||||
if fromPeriod > cs.periods.First {
|
|
||||||
cs.periods.Next = fromPeriod
|
|
||||||
} else {
|
|
||||||
cs.periods = Range{}
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// get returns the item at the given period or the null value of the given type
|
|
||||||
// if no item is present.
|
|
||||||
// Note: get is thread safe in itself and therefore can be called either with
|
|
||||||
// locked or unlocked chain mutex.
|
|
||||||
func (cs *canonicalStore[T]) get(period uint64) (value T, ok bool) {
|
|
||||||
if value, ok = cs.cache.Get(period); ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if enc, err := cs.db.Get(cs.databaseKey(period)); err == nil {
|
|
||||||
if v, err := cs.decode(enc); err == nil {
|
|
||||||
value, ok = v, true
|
|
||||||
} else {
|
|
||||||
log.Error("Error decoding canonical store value", "error", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue