use cache_db wrapper for caching functionality

Author: DracoLi

x/blockdb/cache_db.go

@@ -0,0 +1,79 @@
+// Copyright (C) 2019-2025, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package blockdb
+
+import (
+	"slices"
+
+	"go.uber.org/zap"
+
+	"github.com/ava-labs/avalanchego/cache/lru"
+	"github.com/ava-labs/avalanchego/database"
+)
+
+var _ database.HeightIndex = (*cacheDB)(nil)
+
+type cacheDB struct {
+	db    *Database
+	cache *lru.Cache[BlockHeight, BlockData]
+}
+
+func newCacheDB(db *Database, size uint16) *cacheDB {
+	return &cacheDB{
+		db:    db,
+		cache: lru.NewCache[BlockHeight, BlockData](int(size)),
+	}
+}
+
+func (c *cacheDB) Get(height BlockHeight) (BlockData, error) {
+	c.db.closeMu.RLock()
+	defer c.db.closeMu.RUnlock()
+
+	if c.db.closed {
+		c.db.log.Error("Failed Get: database closed", zap.Uint64("height", height))
+		return nil, database.ErrClosed
+	}
+
+	if cached, ok := c.cache.Get(height); ok {
+		return slices.Clone(cached), nil
+	}
+	data, err := c.db.getWithoutLock(height)
+	if err != nil {
+		return nil, err
+	}
+	c.cache.Put(height, slices.Clone(data))
+	return data, nil
+}
+
+func (c *cacheDB) Put(height BlockHeight, data BlockData) error {
+	if err := c.db.Put(height, data); err != nil {
+		return err
+	}
+
+	c.cache.Put(height, slices.Clone(data))
+	return nil
+}
+
+func (c *cacheDB) Has(height BlockHeight) (bool, error) {
+	c.db.closeMu.RLock()
+	defer c.db.closeMu.RUnlock()
+
+	if c.db.closed {
+		c.db.log.Error("Failed Has: database closed", zap.Uint64("height", height))
+		return false, database.ErrClosed
+	}
+
+	if _, ok := c.cache.Get(height); ok {
+		return true, nil
+	}
+	return c.db.hasWithoutLock(height)
+}
+
+func (c *cacheDB) Close() error {
+	if err := c.db.Close(); err != nil {
+		return err
+	}
+	c.cache.Flush()
+	return nil
+}

x/blockdb/entry_cache_test.go renamed to x/blockdb/cache_db_test.go

@@ -11,29 +11,29 @@ import (
 )
 
 func TestCacheOnMiss(t *testing.T) {
-	db, _ := newTestDatabase(t, DefaultConfig())
+	db := newCacheDatabase(t, DefaultConfig())
 	height := uint64(20)
 	block := randomBlock(t)
 	require.NoError(t, db.Put(height, block))
 
 	// Evict the entry from cache to simulate a cache miss
-	db.blockCache.Evict(height)
+	db.cache.Evict(height)
 
 	// Read the block - should populate the cache on cache miss
 	_, err := db.Get(height)
 	require.NoError(t, err)
 
-	_, ok := db.blockCache.Get(height)
+	_, ok := db.cache.Get(height)
 	require.True(t, ok)
 }
 
 func TestCacheGet(t *testing.T) {
-	db, _ := newTestDatabase(t, DefaultConfig())
+	db := newCacheDatabase(t, DefaultConfig())
 	height := uint64(30)
 	block := randomBlock(t)
 
 	// Populate cache directly without writing to database
-	db.blockCache.Put(height, block)
+	db.cache.Put(height, block)
 
 	// Get should return the block from cache
 	data, err := db.Get(height)
@@ -42,12 +42,12 @@ func TestCacheGet(t *testing.T) {
 }
 
 func TestCacheHas(t *testing.T) {
-	db, _ := newTestDatabase(t, DefaultConfig())
+	db := newCacheDatabase(t, DefaultConfig())
 	height := uint64(40)
 	block := randomBlock(t)
 
 	// Populate cache directly without writing to database
-	db.blockCache.Put(height, block)
+	db.cache.Put(height, block)
 
 	// Has should return true from cache even though block is not in database
 	has, err := db.Has(height)
@@ -56,7 +56,7 @@ func TestCacheHas(t *testing.T) {
 }
 
 func TestCachePutStoresClone(t *testing.T) {
-	db, _ := newTestDatabase(t, DefaultConfig())
+	db := newCacheDatabase(t, DefaultConfig())
 	height := uint64(40)
 	block := randomBlock(t)
 	clone := slices.Clone(block)
@@ -66,13 +66,13 @@ func TestCachePutStoresClone(t *testing.T) {
 	clone[0] = 99
 
 	// Cache should have the original unmodified data
-	cached, ok := db.blockCache.Get(height)
+	cached, ok := db.cache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, block, cached)
 }
 
 func TestCacheGetReturnsClone(t *testing.T) {
-	db, _ := newTestDatabase(t, DefaultConfig())
+	db := newCacheDatabase(t, DefaultConfig())
 	height := uint64(50)
 	block := randomBlock(t)
 	require.NoError(t, db.Put(height, block))
@@ -83,7 +83,7 @@ func TestCacheGetReturnsClone(t *testing.T) {
 	data[0] = 99
 
 	// Cache should still have the original unmodified data
-	cached, ok := db.blockCache.Get(height)
+	cached, ok := db.cache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, block, cached)
 
@@ -94,20 +94,20 @@ func TestCacheGetReturnsClone(t *testing.T) {
 }
 
 func TestCachePutOverridesSameHeight(t *testing.T) {
-	db, _ := newTestDatabase(t, DefaultConfig())
+	db := newCacheDatabase(t, DefaultConfig())
 	height := uint64(60)
 	b1 := randomBlock(t)
 	require.NoError(t, db.Put(height, b1))
 
 	// Verify first block is in cache
-	cached, ok := db.blockCache.Get(height)
+	cached, ok := db.cache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, b1, cached)
 
 	// Put second block at same height and verify it overrides the first one
 	b2 := randomBlock(t)
 	require.NoError(t, db.Put(height, b2))
-	cached, ok = db.blockCache.Get(height)
+	cached, ok = db.cache.Get(height)
 	require.True(t, ok)
 	require.Equal(t, b2, cached)
 	require.NotEqual(t, b1, cached)

x/blockdb/config.go

@@ -12,7 +12,7 @@ const DefaultMaxDataFileSize = 500 * 1024 * 1024 * 1024
 const DefaultMaxDataFiles = 10
 
 // DefaultBlockCacheSize is the default size of the block cache.
-const DefaultBlockCacheSize = 256
+const DefaultBlockCacheSize uint16 = 256
 
 // DatabaseConfig contains configuration parameters for BlockDB.
 type DatabaseConfig struct {
@@ -32,7 +32,7 @@ type DatabaseConfig struct {
 	MaxDataFiles int
 
 	// BlockCacheSize is the size of the block cache (default: 256).
-	BlockCacheSize int
+	BlockCacheSize uint16
 
 	// CheckpointInterval defines how frequently (in blocks) the index file header is updated (default: 1024).
 	CheckpointInterval uint64
@@ -99,7 +99,7 @@ func (c DatabaseConfig) WithMaxDataFiles(maxFiles int) DatabaseConfig {
 }
 
 // WithBlockCacheSize returns a copy of the config with BlockCacheSize set to the given value.
-func (c DatabaseConfig) WithBlockCacheSize(size int) DatabaseConfig {
+func (c DatabaseConfig) WithBlockCacheSize(size uint16) DatabaseConfig {
 	c.BlockCacheSize = size
 	return c
 }
@@ -127,8 +127,5 @@ func (c DatabaseConfig) Validate() error {
 	if c.MaxDataFileSize == 0 {
 		return errors.New("MaxDataFileSize must be positive")
 	}
-	if c.BlockCacheSize < 1 {
-		return errors.New("BlockCacheSize cannot be less than 1")
-	}
 	return nil
 }

x/blockdb/database.go

@@ -12,7 +12,6 @@ import (
 	"math"
 	"os"
 	"path/filepath"
-	"slices"
 	"sync"
 	"sync/atomic"
 
@@ -177,7 +176,6 @@ type Database struct {
 	log        logging.Logger
 	closed     bool
 	fileCache  *lru.Cache[int, *os.File]
-	blockCache *lru.Cache[BlockHeight, BlockData]
 	compressor compression.Compressor
 
 	// closeMu prevents the database from being closed while in use and prevents
@@ -199,7 +197,7 @@ type Database struct {
 // Parameters:
 //   - config: Configuration parameters
 //   - log: Logger instance for structured logging
-func New(config DatabaseConfig, log logging.Logger) (*Database, error) {
+func New(config DatabaseConfig, log logging.Logger) (database.HeightIndex, error) {
 	if err := config.Validate(); err != nil {
 		return nil, err
 	}
@@ -225,7 +223,6 @@ func New(config DatabaseConfig, log logging.Logger) (*Database, error) {
 				f.Close()
 			}
 		}),
-		blockCache: lru.NewCache[BlockHeight, BlockData](config.BlockCacheSize),
 		compressor: compressor,
 	}
 
@@ -234,7 +231,7 @@ func New(config DatabaseConfig, log logging.Logger) (*Database, error) {
 		zap.String("dataDir", config.DataDir),
 		zap.Uint64("maxDataFileSize", config.MaxDataFileSize),
 		zap.Int("maxDataFiles", config.MaxDataFiles),
-		zap.Int("blockCacheSize", config.BlockCacheSize),
+		zap.Uint16("blockCacheSize", config.BlockCacheSize),
 	)
 
 	if err := s.openAndInitializeIndex(); err != nil {
@@ -260,6 +257,9 @@ func New(config DatabaseConfig, log logging.Logger) (*Database, error) {
 		zap.Uint64("maxBlockHeight", maxHeight),
 	)
 
+	if config.BlockCacheSize > 0 {
+		return newCacheDB(s, config.BlockCacheSize), nil
+	}
 	return s, nil
 }
 
@@ -279,7 +279,6 @@ func (s *Database) Close() error {
 	}
 
 	s.closeFiles()
-	s.blockCache.Flush()
 
 	s.log.Info("Block database closed successfully")
 	return err
@@ -291,9 +290,7 @@ func (s *Database) Put(height BlockHeight, block BlockData) error {
 	defer s.closeMu.RUnlock()
 
 	if s.closed {
-		s.log.Error("Failed to write block: database is closed",
-			zap.Uint64("height", height),
-		)
+		s.log.Error("Failed Put: database closed", zap.Uint64("height", height))
 		return database.ErrClosed
 	}
 
@@ -376,7 +373,6 @@ func (s *Database) Put(height BlockHeight, block BlockData) error {
 		)
 		return err
 	}
-	s.blockCache.Put(height, slices.Clone(block))
 
 	s.log.Debug("Block written successfully",
 		zap.Uint64("height", height),
@@ -441,10 +437,10 @@ func (s *Database) Get(height BlockHeight) (BlockData, error) {
 		return nil, database.ErrClosed
 	}
 
-	if c, ok := s.blockCache.Get(height); ok {
-		return slices.Clone(c), nil
-	}
+	return s.getWithoutLock(height)
+}
 
+func (s *Database) getWithoutLock(height BlockHeight) (BlockData, error) {
 	indexEntry, err := s.readBlockIndex(height)
 	if err != nil {
 		return nil, err
@@ -495,7 +491,6 @@ func (s *Database) Get(height BlockHeight) (BlockData, error) {
 		return nil, fmt.Errorf("checksum mismatch: calculated %d, stored %d", calculatedChecksum, bh.Checksum)
 	}
 
-	s.blockCache.Put(height, slices.Clone(decompressed))
 	return decompressed, nil
 }
 
@@ -509,9 +504,10 @@ func (s *Database) Has(height BlockHeight) (bool, error) {
 		return false, database.ErrClosed
 	}
 
-	if _, ok := s.blockCache.Get(height); ok {
-		return true, nil
-	}
+	return s.hasWithoutLock(height)
+}
+
+func (s *Database) hasWithoutLock(height BlockHeight) (bool, error) {
 	_, err := s.readBlockIndex(height)
 	if err != nil {
 		if errors.Is(err, database.ErrNotFound) || errors.Is(err, ErrInvalidBlockHeight) {