mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-20 21:54:30 +00:00
c74b645360
## Why this should be merged Allows for `ava-labs/coreth` equivalent modifications of `rawdb.InspectDatabase()` through external logic injection. ## How this works Variadic options to: 1. Record a database statistic; 2. Mark a database statistic as metadata; 3. Filter statistics for printing. ## How this was tested Testable example acting as a unit test. --------- Signed-off-by: Arran Schlosberg <519948+ARR4N@users.noreply.github.com> Co-authored-by: Quentin McGaw <quentin.mcgaw@avalabs.org>
90 lines
3.2 KiB
Go
90 lines
3.2 KiB
Go
// Copyright 2025 the libevm authors.
|
|
//
|
|
// The libevm additions to go-ethereum are free software: you can redistribute
|
|
// them and/or modify them 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 libevm additions are distributed in the hope that they 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 rawdb
|
|
|
|
import (
|
|
"github.com/ava-labs/libevm/common"
|
|
"github.com/ava-labs/libevm/libevm/options"
|
|
)
|
|
|
|
// An InspectDatabaseOption configures the behaviour of [InspectDatabase]. For
|
|
// each type of option, only one instance can be used in the same call to
|
|
// InspectDatabase().
|
|
type InspectDatabaseOption = options.Option[inspectDatabaseConfig]
|
|
|
|
type inspectDatabaseConfig struct {
|
|
statRecorder func([]byte, common.StorageSize) bool
|
|
isMeta func([]byte) bool
|
|
statsTransformer func([][]string) [][]string
|
|
}
|
|
|
|
func (c inspectDatabaseConfig) recordStat(key []byte, size common.StorageSize) bool {
|
|
if r := c.statRecorder; r != nil {
|
|
return r(key, size)
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (c inspectDatabaseConfig) isMetadata(key []byte) bool {
|
|
if m := c.isMeta; m != nil {
|
|
return m(key)
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (c inspectDatabaseConfig) transformStats(stats [][]string) [][]string {
|
|
if f := c.statsTransformer; f != nil {
|
|
return f(stats)
|
|
}
|
|
return stats
|
|
}
|
|
|
|
func newInspectOpt(fn func(*inspectDatabaseConfig)) InspectDatabaseOption {
|
|
return options.Func[inspectDatabaseConfig](fn)
|
|
}
|
|
|
|
// WithDatabaseStatRecorder returns an option that results in `rec` being called
|
|
// for every `key` not otherwise matched by the [InspectDatabase] iterator loop.
|
|
// The returned boolean signals whether the recorder matches the key, thus
|
|
// stopping further matches.
|
|
func WithDatabaseStatRecorder(rec func(key []byte, size common.StorageSize) bool) InspectDatabaseOption {
|
|
return newInspectOpt(func(c *inspectDatabaseConfig) {
|
|
c.statRecorder = rec
|
|
})
|
|
}
|
|
|
|
// A DatabaseStat stores total size and counts for a parameter measured by
|
|
// [InspectDatabase]. It is exported for use with [WithDatabaseStatRecorder].
|
|
type DatabaseStat = stat
|
|
|
|
// WithDatabaseMetadataKeys returns an option that results in the `key` size
|
|
// being counted with the metadata statistic i.f.f. the function returns true.
|
|
func WithDatabaseMetadataKeys(isMetadata func(key []byte) bool) InspectDatabaseOption {
|
|
return newInspectOpt(func(c *inspectDatabaseConfig) {
|
|
c.isMeta = isMetadata
|
|
})
|
|
}
|
|
|
|
// WithDatabaseStatsTransformer returns an option that causes all statistics rows to
|
|
// be passed to the provided function, with its return value being printed
|
|
// instead of the original values.
|
|
// Each row contains 4 columns: database, category, size and count.
|
|
func WithDatabaseStatsTransformer(transform func(rows [][]string) [][]string) InspectDatabaseOption {
|
|
return newInspectOpt(func(c *inspectDatabaseConfig) {
|
|
c.statsTransformer = transform
|
|
})
|
|
}
|