226 lines
8.7 KiB
Go
226 lines
8.7 KiB
Go
// Copyright 2018 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 rawdb contains a collection of low level database accessors.
|
|
package rawdb
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/binary"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/metrics"
|
|
)
|
|
|
|
// The fields below define the low level database schema prefixing.
|
|
var (
|
|
// databaseVersionKey tracks the current database version.
|
|
databaseVersionKey = []byte("DatabaseVersion")
|
|
|
|
// headHeaderKey tracks the latest known header's hash.
|
|
headHeaderKey = []byte("LastHeader")
|
|
|
|
// headBlockKey tracks the latest known full block's hash.
|
|
headBlockKey = []byte("LastBlock")
|
|
|
|
// headFastBlockKey tracks the latest known incomplete block's hash during fast sync.
|
|
headFastBlockKey = []byte("LastFast")
|
|
|
|
// lastPivotKey tracks the last pivot block used by fast sync (to reenable on sethead).
|
|
lastPivotKey = []byte("LastPivot")
|
|
|
|
// fastTrieProgressKey tracks the number of trie entries imported during fast sync.
|
|
fastTrieProgressKey = []byte("TrieSync")
|
|
|
|
// snapshotRootKey tracks the hash of the last snapshot.
|
|
snapshotRootKey = []byte("SnapshotRoot")
|
|
|
|
// snapshotJournalKey tracks the in-memory diff layers across restarts.
|
|
snapshotJournalKey = []byte("SnapshotJournal")
|
|
|
|
// snapshotGeneratorKey tracks the snapshot generation marker across restarts.
|
|
snapshotGeneratorKey = []byte("SnapshotGenerator")
|
|
|
|
// snapshotRecoveryKey tracks the snapshot recovery marker across restarts.
|
|
snapshotRecoveryKey = []byte("SnapshotRecovery")
|
|
|
|
// snapshotSyncStatusKey tracks the snapshot sync status across restarts.
|
|
snapshotSyncStatusKey = []byte("SnapshotSyncStatus")
|
|
|
|
// txIndexTailKey tracks the oldest block whose transactions have been indexed.
|
|
txIndexTailKey = []byte("TransactionIndexTail")
|
|
|
|
// fastTxLookupLimitKey tracks the transaction lookup limit during fast sync.
|
|
fastTxLookupLimitKey = []byte("FastTransactionLookupLimit")
|
|
|
|
// Data item prefixes (use single byte to avoid mixing data types, avoid `i`, used for indexes).
|
|
headerPrefix = []byte("h") // headerPrefix + num (uint64 big endian) + hash -> header
|
|
headerTDSuffix = []byte("t") // headerPrefix + num (uint64 big endian) + hash + headerTDSuffix -> td
|
|
headerHashSuffix = []byte("n") // headerPrefix + num (uint64 big endian) + headerHashSuffix -> hash
|
|
headerNumberPrefix = []byte("H") // headerNumberPrefix + hash -> num (uint64 big endian)
|
|
|
|
blockBodyPrefix = []byte("b") // blockBodyPrefix + num (uint64 big endian) + hash -> block body
|
|
blockReceiptsPrefix = []byte("r") // blockReceiptsPrefix + num (uint64 big endian) + hash -> block receipts
|
|
|
|
txLookupPrefix = []byte("l") // txLookupPrefix + hash -> transaction/receipt lookup metadata
|
|
bloomBitsPrefix = []byte("B") // bloomBitsPrefix + bit (uint16 big endian) + section (uint64 big endian) + hash -> bloom bits
|
|
SnapshotAccountPrefix = []byte("a") // SnapshotAccountPrefix + account hash -> account trie value
|
|
SnapshotStoragePrefix = []byte("o") // SnapshotStoragePrefix + account hash + storage hash -> storage trie value
|
|
codePrefix = []byte("c") // codePrefix + code hash -> account code
|
|
|
|
preimagePrefix = []byte("secure-key-") // preimagePrefix + hash -> preimage
|
|
configPrefix = []byte("ethereum-config-") // config prefix for the db
|
|
|
|
uncleanShutdownKey = []byte("unclean-shutdown") // config prefix for the db
|
|
|
|
// Chain index prefixes (use `i` + single byte to avoid mixing data types).
|
|
BloomBitsIndexPrefix = []byte("iB") // BloomBitsIndexPrefix is the data table of a chain indexer to track its progress
|
|
|
|
preimageCounter = metrics.NewRegisteredCounter("db/preimage/total", nil)
|
|
preimageHitCounter = metrics.NewRegisteredCounter("db/preimage/hits", nil)
|
|
)
|
|
|
|
const (
|
|
// freezerHeaderTable indicates the name of the freezer header table.
|
|
freezerHeaderTable = "headers"
|
|
|
|
// freezerHashTable indicates the name of the freezer canonical hash table.
|
|
freezerHashTable = "hashes"
|
|
|
|
// freezerBodiesTable indicates the name of the freezer block body table.
|
|
freezerBodiesTable = "bodies"
|
|
|
|
// freezerReceiptTable indicates the name of the freezer receipts table.
|
|
freezerReceiptTable = "receipts"
|
|
|
|
// freezerDifficultyTable indicates the name of the freezer total difficulty table.
|
|
freezerDifficultyTable = "diffs"
|
|
)
|
|
|
|
// freezerNoSnappy configures whether compression is disabled for the ancient-tables.
|
|
// Hashes and difficulties don't compress well.
|
|
var freezerNoSnappy = map[string]bool{
|
|
freezerHeaderTable: false,
|
|
freezerHashTable: true,
|
|
freezerBodiesTable: false,
|
|
freezerReceiptTable: false,
|
|
freezerDifficultyTable: true,
|
|
}
|
|
|
|
// LegacyTxLookupEntry is the legacy TxLookupEntry definition with some unnecessary
|
|
// fields.
|
|
type LegacyTxLookupEntry struct {
|
|
BlockHash common.Hash
|
|
BlockIndex uint64
|
|
Index uint64
|
|
}
|
|
|
|
// encodeBlockNumber encodes a block number as big endian uint64
|
|
func encodeBlockNumber(number uint64) []byte {
|
|
enc := make([]byte, 8)
|
|
binary.BigEndian.PutUint64(enc, number)
|
|
return enc
|
|
}
|
|
|
|
// headerKeyPrefix = headerPrefix + num (uint64 big endian)
|
|
func headerKeyPrefix(number uint64) []byte {
|
|
return append(headerPrefix, encodeBlockNumber(number)...)
|
|
}
|
|
|
|
// headerKey = headerPrefix + num (uint64 big endian) + hash
|
|
func headerKey(number uint64, hash common.Hash) []byte {
|
|
return append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
|
|
}
|
|
|
|
// headerTDKey = headerPrefix + num (uint64 big endian) + hash + headerTDSuffix
|
|
func headerTDKey(number uint64, hash common.Hash) []byte {
|
|
return append(headerKey(number, hash), headerTDSuffix...)
|
|
}
|
|
|
|
// headerHashKey = headerPrefix + num (uint64 big endian) + headerHashSuffix
|
|
func headerHashKey(number uint64) []byte {
|
|
return append(append(headerPrefix, encodeBlockNumber(number)...), headerHashSuffix...)
|
|
}
|
|
|
|
// headerNumberKey = headerNumberPrefix + hash
|
|
func headerNumberKey(hash common.Hash) []byte {
|
|
return append(headerNumberPrefix, hash.Bytes()...)
|
|
}
|
|
|
|
// blockBodyKey = blockBodyPrefix + num (uint64 big endian) + hash
|
|
func blockBodyKey(number uint64, hash common.Hash) []byte {
|
|
return append(append(blockBodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
|
|
}
|
|
|
|
// blockReceiptsKey = blockReceiptsPrefix + num (uint64 big endian) + hash
|
|
func blockReceiptsKey(number uint64, hash common.Hash) []byte {
|
|
return append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
|
|
}
|
|
|
|
// txLookupKey = txLookupPrefix + hash
|
|
func txLookupKey(hash common.Hash) []byte {
|
|
return append(txLookupPrefix, hash.Bytes()...)
|
|
}
|
|
|
|
// accountSnapshotKey = SnapshotAccountPrefix + hash
|
|
func accountSnapshotKey(hash common.Hash) []byte {
|
|
return append(SnapshotAccountPrefix, hash.Bytes()...)
|
|
}
|
|
|
|
// storageSnapshotKey = SnapshotStoragePrefix + account hash + storage hash
|
|
func storageSnapshotKey(accountHash, storageHash common.Hash) []byte {
|
|
return append(append(SnapshotStoragePrefix, accountHash.Bytes()...), storageHash.Bytes()...)
|
|
}
|
|
|
|
// storageSnapshotsKey = SnapshotStoragePrefix + account hash + storage hash
|
|
func storageSnapshotsKey(accountHash common.Hash) []byte {
|
|
return append(SnapshotStoragePrefix, accountHash.Bytes()...)
|
|
}
|
|
|
|
// bloomBitsKey = bloomBitsPrefix + bit (uint16 big endian) + section (uint64 big endian) + hash
|
|
func bloomBitsKey(bit uint, section uint64, hash common.Hash) []byte {
|
|
key := append(append(bloomBitsPrefix, make([]byte, 10)...), hash.Bytes()...)
|
|
|
|
binary.BigEndian.PutUint16(key[1:], uint16(bit))
|
|
binary.BigEndian.PutUint64(key[3:], section)
|
|
|
|
return key
|
|
}
|
|
|
|
// preimageKey = preimagePrefix + hash
|
|
func preimageKey(hash common.Hash) []byte {
|
|
return append(preimagePrefix, hash.Bytes()...)
|
|
}
|
|
|
|
// codeKey = codePrefix + hash
|
|
func codeKey(hash common.Hash) []byte {
|
|
return append(codePrefix, hash.Bytes()...)
|
|
}
|
|
|
|
// IsCodeKey reports whether the given byte slice is the key of contract code,
|
|
// if so return the raw code hash as well.
|
|
func IsCodeKey(key []byte) (bool, []byte) {
|
|
if bytes.HasPrefix(key, codePrefix) && len(key) == common.HashLength+len(codePrefix) {
|
|
return true, key[len(codePrefix):]
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
// configKey = configPrefix + hash
|
|
func configKey(hash common.Hash) []byte {
|
|
return append(configPrefix, hash.Bytes()...)
|
|
}
|