database_util.go 23 KB
Newer Older
1
// Copyright 2015 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
5 6 7 8
// 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.
//
9
// The go-ethereum library is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 13 14
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
15
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16

17 18 19 20
package core

import (
	"bytes"
21
	"encoding/binary"
22
	"encoding/json"
23
	"errors"
24
	"fmt"
25
	"math/big"
26
	"sync"
27 28 29

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/core/types"
30
	"github.com/ethereum/go-ethereum/ethdb"
31
	"github.com/ethereum/go-ethereum/log"
32
	"github.com/ethereum/go-ethereum/metrics"
33
	"github.com/ethereum/go-ethereum/params"
34 35 36
	"github.com/ethereum/go-ethereum/rlp"
)

37
var (
38 39
	headHeaderKey = []byte("LastHeader")
	headBlockKey  = []byte("LastBlock")
40
	headFastKey   = []byte("LastFast")
41

42 43 44 45 46 47 48
	headerPrefix        = []byte("h")   // headerPrefix + num (uint64 big endian) + hash -> header
	tdSuffix            = []byte("t")   // headerPrefix + num (uint64 big endian) + hash + tdSuffix -> td
	numSuffix           = []byte("n")   // headerPrefix + num (uint64 big endian) + numSuffix -> hash
	blockHashPrefix     = []byte("H")   // blockHashPrefix + hash -> num (uint64 big endian)
	bodyPrefix          = []byte("b")   // bodyPrefix + num (uint64 big endian) + hash -> block body
	blockReceiptsPrefix = []byte("r")   // blockReceiptsPrefix + num (uint64 big endian) + hash -> block receipts
	preimagePrefix      = "secure-key-" // preimagePrefix + hash -> preimage
49

50 51
	txMetaSuffix   = []byte{0x01}
	receiptsPrefix = []byte("receipts-")
52 53 54

	mipmapPre    = []byte("mipmap-log-bloom-")
	MIPMapLevels = []uint64{1000000, 500000, 100000, 50000, 1000}
55

56
	configPrefix = []byte("ethereum-config-") // config prefix for the db
57 58 59 60 61 62 63 64 65

	// used by old (non-sequential keys) db, now only used for conversion
	oldBlockPrefix         = []byte("block-")
	oldHeaderSuffix        = []byte("-header")
	oldTdSuffix            = []byte("-td") // headerPrefix + num (uint64 big endian) + hash + tdSuffix -> td
	oldBodySuffix          = []byte("-body")
	oldBlockNumPrefix      = []byte("block-num-")
	oldBlockReceiptsPrefix = []byte("receipts-block-")
	oldBlockHashPrefix     = []byte("block-hash-") // [deprecated by the header/block split, remove eventually]
66 67

	ChainConfigNotFoundErr = errors.New("ChainConfig not found") // general config not found error
68 69

	mipmapBloomMu sync.Mutex // protect against race condition when updating mipmap blooms
70 71 72

	preimageCounter    = metrics.NewCounter("db/preimage/total")
	preimageHitCounter = metrics.NewCounter("db/preimage/hits")
73 74
)

75 76 77 78 79 80 81
// 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
}

82
// GetCanonicalHash retrieves a hash assigned to a canonical block number.
83
func GetCanonicalHash(db ethdb.Database, number uint64) common.Hash {
84
	data, _ := db.Get(append(append(headerPrefix, encodeBlockNumber(number)...), numSuffix...))
85
	if len(data) == 0 {
86 87 88 89
		data, _ = db.Get(append(oldBlockNumPrefix, big.NewInt(int64(number)).Bytes()...))
		if len(data) == 0 {
			return common.Hash{}
		}
90 91
	}
	return common.BytesToHash(data)
92 93
}

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
// missingNumber is returned by GetBlockNumber if no header with the
// given block hash has been stored in the database
const missingNumber = uint64(0xffffffffffffffff)

// GetBlockNumber returns the block number assigned to a block hash
// if the corresponding header is present in the database
func GetBlockNumber(db ethdb.Database, hash common.Hash) uint64 {
	data, _ := db.Get(append(blockHashPrefix, hash.Bytes()...))
	if len(data) != 8 {
		data, _ := db.Get(append(append(oldBlockPrefix, hash.Bytes()...), oldHeaderSuffix...))
		if len(data) == 0 {
			return missingNumber
		}
		header := new(types.Header)
		if err := rlp.Decode(bytes.NewReader(data), header); err != nil {
109
			log.Crit("Failed to decode block header", "err", err)
110 111 112 113 114 115
		}
		return header.Number.Uint64()
	}
	return binary.BigEndian.Uint64(data)
}

116 117 118 119
// GetHeadHeaderHash retrieves the hash of the current canonical head block's
// header. The difference between this and GetHeadBlockHash is that whereas the
// last block hash is only updated upon a full block import, the last header
// hash is updated already at header import, allowing head tracking for the
120
// light synchronization mechanism.
121
func GetHeadHeaderHash(db ethdb.Database) common.Hash {
122
	data, _ := db.Get(headHeaderKey)
123 124 125 126 127 128
	if len(data) == 0 {
		return common.Hash{}
	}
	return common.BytesToHash(data)
}

129
// GetHeadBlockHash retrieves the hash of the current canonical head block.
130
func GetHeadBlockHash(db ethdb.Database) common.Hash {
131
	data, _ := db.Get(headBlockKey)
132 133 134 135 136 137
	if len(data) == 0 {
		return common.Hash{}
	}
	return common.BytesToHash(data)
}

138 139 140 141 142 143 144 145 146 147 148 149
// GetHeadFastBlockHash retrieves the hash of the current canonical head block during
// fast synchronization. The difference between this and GetHeadBlockHash is that
// whereas the last block hash is only updated upon a full block import, the last
// fast hash is updated when importing pre-processed blocks.
func GetHeadFastBlockHash(db ethdb.Database) common.Hash {
	data, _ := db.Get(headFastKey)
	if len(data) == 0 {
		return common.Hash{}
	}
	return common.BytesToHash(data)
}

150 151
// GetHeaderRLP retrieves a block header in its raw RLP database encoding, or nil
// if the header's not found.
152 153 154 155 156
func GetHeaderRLP(db ethdb.Database, hash common.Hash, number uint64) rlp.RawValue {
	data, _ := db.Get(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
	if len(data) == 0 {
		data, _ = db.Get(append(append(oldBlockPrefix, hash.Bytes()...), oldHeaderSuffix...))
	}
157 158 159
	return data
}

160 161
// GetHeader retrieves the block header corresponding to the hash, nil if none
// found.
162 163
func GetHeader(db ethdb.Database, hash common.Hash, number uint64) *types.Header {
	data := GetHeaderRLP(db, hash, number)
164 165 166
	if len(data) == 0 {
		return nil
	}
167 168
	header := new(types.Header)
	if err := rlp.Decode(bytes.NewReader(data), header); err != nil {
169
		log.Error("Invalid block header RLP", "hash", hash, "err", err)
170 171
		return nil
	}
172
	return header
173 174
}

175
// GetBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
176 177 178 179 180
func GetBodyRLP(db ethdb.Database, hash common.Hash, number uint64) rlp.RawValue {
	data, _ := db.Get(append(append(bodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
	if len(data) == 0 {
		data, _ = db.Get(append(append(oldBlockPrefix, hash.Bytes()...), oldBodySuffix...))
	}
181
	return data
182 183
}

184 185
// GetBody retrieves the block body (transactons, uncles) corresponding to the
// hash, nil if none found.
186 187
func GetBody(db ethdb.Database, hash common.Hash, number uint64) *types.Body {
	data := GetBodyRLP(db, hash, number)
188 189
	if len(data) == 0 {
		return nil
190
	}
191
	body := new(types.Body)
192
	if err := rlp.Decode(bytes.NewReader(data), body); err != nil {
193
		log.Error("Invalid block body RLP", "hash", hash, "err", err)
194
		return nil
195
	}
196
	return body
197 198
}

199 200
// GetTd retrieves a block's total difficulty corresponding to the hash, nil if
// none found.
201 202
func GetTd(db ethdb.Database, hash common.Hash, number uint64) *big.Int {
	data, _ := db.Get(append(append(append(headerPrefix, encodeBlockNumber(number)...), hash[:]...), tdSuffix...))
203
	if len(data) == 0 {
204 205 206 207
		data, _ = db.Get(append(append(oldBlockPrefix, hash.Bytes()...), oldTdSuffix...))
		if len(data) == 0 {
			return nil
		}
208
	}
209 210
	td := new(big.Int)
	if err := rlp.Decode(bytes.NewReader(data), td); err != nil {
211
		log.Error("Invalid block total difficulty RLP", "hash", hash, "err", err)
212 213
		return nil
	}
214
	return td
215 216
}

217
// GetBlock retrieves an entire block corresponding to the hash, assembling it
218 219 220 221 222
// back from the stored header and body. If either the header or body could not
// be retrieved nil is returned.
//
// Note, due to concurrent download of header and block body the header and thus
// canonical hash can be stored in the database but the body data not (yet).
223
func GetBlock(db ethdb.Database, hash common.Hash, number uint64) *types.Block {
224
	// Retrieve the block header and body contents
225
	header := GetHeader(db, hash, number)
226 227 228
	if header == nil {
		return nil
	}
229
	body := GetBody(db, hash, number)
230
	if body == nil {
231 232
		return nil
	}
233 234
	// Reassemble the block and return
	return types.NewBlockWithHeader(header).WithBody(body.Transactions, body.Uncles)
235 236
}

237 238
// GetBlockReceipts retrieves the receipts generated by the transactions included
// in a block given by its hash.
239 240
func GetBlockReceipts(db ethdb.Database, hash common.Hash, number uint64) types.Receipts {
	data, _ := db.Get(append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash[:]...))
241
	if len(data) == 0 {
242 243 244 245
		data, _ = db.Get(append(oldBlockReceiptsPrefix, hash.Bytes()...))
		if len(data) == 0 {
			return nil
		}
246 247 248
	}
	storageReceipts := []*types.ReceiptForStorage{}
	if err := rlp.DecodeBytes(data, &storageReceipts); err != nil {
249
		log.Error("Invalid receipt array RLP", "hash", hash, "err", err)
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
		return nil
	}
	receipts := make(types.Receipts, len(storageReceipts))
	for i, receipt := range storageReceipts {
		receipts[i] = (*types.Receipt)(receipt)
	}
	return receipts
}

// GetTransaction retrieves a specific transaction from the database, along with
// its added positional metadata.
func GetTransaction(db ethdb.Database, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64) {
	// Retrieve the transaction itself from the database
	data, _ := db.Get(hash.Bytes())
	if len(data) == 0 {
		return nil, common.Hash{}, 0, 0
	}
	var tx types.Transaction
	if err := rlp.DecodeBytes(data, &tx); err != nil {
		return nil, common.Hash{}, 0, 0
	}
	// Retrieve the blockchain positional metadata
	data, _ = db.Get(append(hash.Bytes(), txMetaSuffix...))
	if len(data) == 0 {
		return nil, common.Hash{}, 0, 0
	}
	var meta struct {
		BlockHash  common.Hash
		BlockIndex uint64
		Index      uint64
	}
	if err := rlp.DecodeBytes(data, &meta); err != nil {
		return nil, common.Hash{}, 0, 0
	}
	return &tx, meta.BlockHash, meta.BlockIndex, meta.Index
}

// GetReceipt returns a receipt by hash
288 289
func GetReceipt(db ethdb.Database, hash common.Hash) *types.Receipt {
	data, _ := db.Get(append(receiptsPrefix, hash[:]...))
290 291 292 293 294 295
	if len(data) == 0 {
		return nil
	}
	var receipt types.ReceiptForStorage
	err := rlp.DecodeBytes(data, &receipt)
	if err != nil {
296
		log.Error("Invalid receipt RLP", "hash", hash, "err", err)
297 298 299 300
	}
	return (*types.Receipt)(&receipt)
}

301
// WriteCanonicalHash stores the canonical hash for the given block number.
302
func WriteCanonicalHash(db ethdb.Database, hash common.Hash, number uint64) error {
303
	key := append(append(headerPrefix, encodeBlockNumber(number)...), numSuffix...)
304
	if err := db.Put(key, hash.Bytes()); err != nil {
305
		log.Crit("Failed to store number to hash mapping", "err", err)
306
	}
307 308 309
	return nil
}

310
// WriteHeadHeaderHash stores the head header's hash.
311
func WriteHeadHeaderHash(db ethdb.Database, hash common.Hash) error {
312
	if err := db.Put(headHeaderKey, hash.Bytes()); err != nil {
313
		log.Crit("Failed to store last header's hash", "err", err)
314
	}
315 316 317 318
	return nil
}

// WriteHeadBlockHash stores the head block's hash.
319
func WriteHeadBlockHash(db ethdb.Database, hash common.Hash) error {
320
	if err := db.Put(headBlockKey, hash.Bytes()); err != nil {
321
		log.Crit("Failed to store last block's hash", "err", err)
322 323 324
	}
	return nil
}
325

326 327 328
// WriteHeadFastBlockHash stores the fast head block's hash.
func WriteHeadFastBlockHash(db ethdb.Database, hash common.Hash) error {
	if err := db.Put(headFastKey, hash.Bytes()); err != nil {
329
		log.Crit("Failed to store last fast block's hash", "err", err)
330 331 332 333
	}
	return nil
}

334
// WriteHeader serializes a block header into the database.
335
func WriteHeader(db ethdb.Database, header *types.Header) error {
336
	data, err := rlp.EncodeToBytes(header)
337 338 339
	if err != nil {
		return err
	}
340 341 342 343 344
	hash := header.Hash().Bytes()
	num := header.Number.Uint64()
	encNum := encodeBlockNumber(num)
	key := append(blockHashPrefix, hash...)
	if err := db.Put(key, encNum); err != nil {
345
		log.Crit("Failed to store hash to number mapping", "err", err)
346 347
	}
	key = append(append(headerPrefix, encNum...), hash...)
348
	if err := db.Put(key, data); err != nil {
349
		log.Crit("Failed to store header", "err", err)
350 351 352
	}
	return nil
}
353

354
// WriteBody serializes the body of a block into the database.
355
func WriteBody(db ethdb.Database, hash common.Hash, number uint64, body *types.Body) error {
356
	data, err := rlp.EncodeToBytes(body)
357 358 359
	if err != nil {
		return err
	}
360 361 362 363 364
	return WriteBodyRLP(db, hash, number, data)
}

// WriteBodyRLP writes a serialized body of a block into the database.
func WriteBodyRLP(db ethdb.Database, hash common.Hash, number uint64, rlp rlp.RawValue) error {
365
	key := append(append(bodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
366
	if err := db.Put(key, rlp); err != nil {
367
		log.Crit("Failed to store block body", "err", err)
368 369 370 371 372
	}
	return nil
}

// WriteTd serializes the total difficulty of a block into the database.
373
func WriteTd(db ethdb.Database, hash common.Hash, number uint64, td *big.Int) error {
374
	data, err := rlp.EncodeToBytes(td)
375 376
	if err != nil {
		return err
377
	}
378
	key := append(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...), tdSuffix...)
379
	if err := db.Put(key, data); err != nil {
380
		log.Crit("Failed to store block total difficulty", "err", err)
381 382 383
	}
	return nil
}
384

385
// WriteBlock serializes a block into the database, header and body separately.
386
func WriteBlock(db ethdb.Database, block *types.Block) error {
387
	// Store the body first to retain database consistency
388
	if err := WriteBody(db, block.Hash(), block.NumberU64(), block.Body()); err != nil {
389 390 391 392 393 394
		return err
	}
	// Store the header too, signaling full block ownership
	if err := WriteHeader(db, block.Header()); err != nil {
		return err
	}
395 396
	return nil
}
397

398 399 400
// WriteBlockReceipts stores all the transaction receipts belonging to a block
// as a single receipt slice. This is used during chain reorganisations for
// rescheduling dropped transactions.
401
func WriteBlockReceipts(db ethdb.Database, hash common.Hash, number uint64, receipts types.Receipts) error {
402 403 404 405 406 407 408 409 410 411
	// Convert the receipts into their storage form and serialize them
	storageReceipts := make([]*types.ReceiptForStorage, len(receipts))
	for i, receipt := range receipts {
		storageReceipts[i] = (*types.ReceiptForStorage)(receipt)
	}
	bytes, err := rlp.EncodeToBytes(storageReceipts)
	if err != nil {
		return err
	}
	// Store the flattened receipt slice
412 413
	key := append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash.Bytes()...)
	if err := db.Put(key, bytes); err != nil {
414
		log.Crit("Failed to store block receipts", "err", err)
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
	}
	return nil
}

// WriteTransactions stores the transactions associated with a specific block
// into the given database. Beside writing the transaction, the function also
// stores a metadata entry along with the transaction, detailing the position
// of this within the blockchain.
func WriteTransactions(db ethdb.Database, block *types.Block) error {
	batch := db.NewBatch()

	// Iterate over each transaction and encode it with its metadata
	for i, tx := range block.Transactions() {
		// Encode and queue up the transaction for storage
		data, err := rlp.EncodeToBytes(tx)
		if err != nil {
			return err
		}
433
		if err = batch.Put(tx.Hash().Bytes(), data); err != nil {
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
			return err
		}
		// Encode and queue up the transaction metadata for storage
		meta := struct {
			BlockHash  common.Hash
			BlockIndex uint64
			Index      uint64
		}{
			BlockHash:  block.Hash(),
			BlockIndex: block.NumberU64(),
			Index:      uint64(i),
		}
		data, err = rlp.EncodeToBytes(meta)
		if err != nil {
			return err
		}
		if err := batch.Put(append(tx.Hash().Bytes(), txMetaSuffix...), data); err != nil {
			return err
		}
	}
	// Write the scheduled data into the database
	if err := batch.Write(); err != nil {
456
		log.Crit("Failed to store transactions", "err", err)
457 458 459 460
	}
	return nil
}

461 462 463 464 465 466 467 468 469 470
// WriteReceipt stores a single transaction receipt into the database.
func WriteReceipt(db ethdb.Database, receipt *types.Receipt) error {
	storageReceipt := (*types.ReceiptForStorage)(receipt)
	data, err := rlp.EncodeToBytes(storageReceipt)
	if err != nil {
		return err
	}
	return db.Put(append(receiptsPrefix, receipt.TxHash.Bytes()...), data)
}

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
// WriteReceipts stores a batch of transaction receipts into the database.
func WriteReceipts(db ethdb.Database, receipts types.Receipts) error {
	batch := db.NewBatch()

	// Iterate over all the receipts and queue them for database injection
	for _, receipt := range receipts {
		storageReceipt := (*types.ReceiptForStorage)(receipt)
		data, err := rlp.EncodeToBytes(storageReceipt)
		if err != nil {
			return err
		}
		if err := batch.Put(append(receiptsPrefix, receipt.TxHash.Bytes()...), data); err != nil {
			return err
		}
	}
	// Write the scheduled data into the database
	if err := batch.Write(); err != nil {
488
		log.Crit("Failed to store receipts", "err", err)
489 490 491 492
	}
	return nil
}

493
// DeleteCanonicalHash removes the number to hash canonical mapping.
494
func DeleteCanonicalHash(db ethdb.Database, number uint64) {
495
	db.Delete(append(append(headerPrefix, encodeBlockNumber(number)...), numSuffix...))
496 497
}

498
// DeleteHeader removes all block header data associated with a hash.
499 500 501
func DeleteHeader(db ethdb.Database, hash common.Hash, number uint64) {
	db.Delete(append(blockHashPrefix, hash.Bytes()...))
	db.Delete(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
502 503 504
}

// DeleteBody removes all block body data associated with a hash.
505 506
func DeleteBody(db ethdb.Database, hash common.Hash, number uint64) {
	db.Delete(append(append(bodyPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
507 508 509
}

// DeleteTd removes all block total difficulty data associated with a hash.
510 511
func DeleteTd(db ethdb.Database, hash common.Hash, number uint64) {
	db.Delete(append(append(append(headerPrefix, encodeBlockNumber(number)...), hash.Bytes()...), tdSuffix...))
512 513 514
}

// DeleteBlock removes all block data associated with a hash.
515 516 517 518 519
func DeleteBlock(db ethdb.Database, hash common.Hash, number uint64) {
	DeleteBlockReceipts(db, hash, number)
	DeleteHeader(db, hash, number)
	DeleteBody(db, hash, number)
	DeleteTd(db, hash, number)
520 521
}

522
// DeleteBlockReceipts removes all receipt data associated with a block hash.
523 524
func DeleteBlockReceipts(db ethdb.Database, hash common.Hash, number uint64) {
	db.Delete(append(append(blockReceiptsPrefix, encodeBlockNumber(number)...), hash.Bytes()...))
525 526 527 528 529 530 531 532 533 534 535 536 537
}

// DeleteTransaction removes all transaction data associated with a hash.
func DeleteTransaction(db ethdb.Database, hash common.Hash) {
	db.Delete(hash.Bytes())
	db.Delete(append(hash.Bytes(), txMetaSuffix...))
}

// DeleteReceipt removes all receipt data associated with a transaction hash.
func DeleteReceipt(db ethdb.Database, hash common.Hash) {
	db.Delete(append(receiptsPrefix, hash.Bytes()...))
}

538 539 540 541 542 543 544 545 546 547 548 549 550 551
// returns a formatted MIP mapped key by adding prefix, canonical number and level
//
// ex. fn(98, 1000) = (prefix || 1000 || 0)
func mipmapKey(num, level uint64) []byte {
	lkey := make([]byte, 8)
	binary.BigEndian.PutUint64(lkey, level)
	key := new(big.Int).SetUint64(num / level * level)

	return append(mipmapPre, append(lkey, key.Bytes()...)...)
}

// WriteMapmapBloom writes each address included in the receipts' logs to the
// MIP bloom bin.
func WriteMipmapBloom(db ethdb.Database, number uint64, receipts types.Receipts) error {
552 553 554
	mipmapBloomMu.Lock()
	defer mipmapBloomMu.Unlock()

555 556 557 558 559 560
	batch := db.NewBatch()
	for _, level := range MIPMapLevels {
		key := mipmapKey(number, level)
		bloomDat, _ := db.Get(key)
		bloom := types.BytesToBloom(bloomDat)
		for _, receipt := range receipts {
561
			for _, log := range receipt.Logs {
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
				bloom.Add(log.Address.Big())
			}
		}
		batch.Put(key, bloom.Bytes())
	}
	if err := batch.Write(); err != nil {
		return fmt.Errorf("mipmap write fail for: %d: %v", number, err)
	}
	return nil
}

// GetMipmapBloom returns a bloom filter using the number and level as input
// parameters. For available levels see MIPMapLevels.
func GetMipmapBloom(db ethdb.Database, number, level uint64) types.Bloom {
	bloomDat, _ := db.Get(mipmapKey(number, level))
	return types.BytesToBloom(bloomDat)
}
579

580 581 582 583 584 585 586 587 588 589 590 591 592 593
// PreimageTable returns a Database instance with the key prefix for preimage entries.
func PreimageTable(db ethdb.Database) ethdb.Database {
	return ethdb.NewTable(db, preimagePrefix)
}

// WritePreimages writes the provided set of preimages to the database. `number` is the
// current block number, and is used for debug messages only.
func WritePreimages(db ethdb.Database, number uint64, preimages map[common.Hash][]byte) error {
	table := PreimageTable(db)
	batch := table.NewBatch()
	hitCount := 0
	for hash, preimage := range preimages {
		if _, err := table.Get(hash.Bytes()); err != nil {
			batch.Put(hash.Bytes(), preimage)
594
			hitCount++
595 596 597 598 599 600 601 602 603 604 605 606
		}
	}
	preimageCounter.Inc(int64(len(preimages)))
	preimageHitCounter.Inc(int64(hitCount))
	if hitCount > 0 {
		if err := batch.Write(); err != nil {
			return fmt.Errorf("preimage write fail for block %d: %v", number, err)
		}
	}
	return nil
}

607 608 609 610 611 612 613 614 615 616 617 618 619
// GetBlockChainVersion reads the version number from db.
func GetBlockChainVersion(db ethdb.Database) int {
	var vsn uint
	enc, _ := db.Get([]byte("BlockchainVersion"))
	rlp.DecodeBytes(enc, &vsn)
	return int(vsn)
}

// WriteBlockChainVersion writes vsn as the version number to db.
func WriteBlockChainVersion(db ethdb.Database, vsn int) {
	enc, _ := rlp.EncodeToBytes(uint(vsn))
	db.Put([]byte("BlockchainVersion"), enc)
}
620 621

// WriteChainConfig writes the chain config settings to the database.
622
func WriteChainConfig(db ethdb.Database, hash common.Hash, cfg *params.ChainConfig) error {
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
	// short circuit and ignore if nil config. GetChainConfig
	// will return a default.
	if cfg == nil {
		return nil
	}

	jsonChainConfig, err := json.Marshal(cfg)
	if err != nil {
		return err
	}

	return db.Put(append(configPrefix, hash[:]...), jsonChainConfig)
}

// GetChainConfig will fetch the network settings based on the given hash.
638
func GetChainConfig(db ethdb.Database, hash common.Hash) (*params.ChainConfig, error) {
639 640 641 642 643
	jsonChainConfig, _ := db.Get(append(configPrefix, hash[:]...))
	if len(jsonChainConfig) == 0 {
		return nil, ChainConfigNotFoundErr
	}

644
	var config params.ChainConfig
645 646 647 648 649 650
	if err := json.Unmarshal(jsonChainConfig, &config); err != nil {
		return nil, err
	}

	return &config, nil
}
651 652 653

// FindCommonAncestor returns the last common ancestor of two block headers
func FindCommonAncestor(db ethdb.Database, a, b *types.Header) *types.Header {
654 655
	for bn := b.Number.Uint64(); a.Number.Uint64() > bn; {
		a = GetHeader(db, a.ParentHash, a.Number.Uint64()-1)
656 657 658 659
		if a == nil {
			return nil
		}
	}
660 661
	for an := a.Number.Uint64(); an < b.Number.Uint64(); {
		b = GetHeader(db, b.ParentHash, b.Number.Uint64()-1)
662 663 664 665 666
		if b == nil {
			return nil
		}
	}
	for a.Hash() != b.Hash() {
667
		a = GetHeader(db, a.ParentHash, a.Number.Uint64()-1)
668 669 670
		if a == nil {
			return nil
		}
671
		b = GetHeader(db, b.ParentHash, b.Number.Uint64()-1)
672 673 674 675 676 677
		if b == nil {
			return nil
		}
	}
	return a
}