downloader_test.go 71.9 KB
Newer Older
F
Felix Lange 已提交
1
// Copyright 2015 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
F
Felix Lange 已提交
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
F
Felix Lange 已提交
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,
F
Felix Lange 已提交
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
F
Felix Lange 已提交
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/>.
F
Felix Lange 已提交
16

17 18 19
package downloader

import (
20
	"errors"
21
	"fmt"
22
	"math/big"
23
	"sync"
24
	"sync/atomic"
25 26 27 28
	"testing"
	"time"

	"github.com/ethereum/go-ethereum/common"
29
	"github.com/ethereum/go-ethereum/consensus/ethash"
30
	"github.com/ethereum/go-ethereum/core"
31
	"github.com/ethereum/go-ethereum/core/types"
32
	"github.com/ethereum/go-ethereum/crypto"
33
	"github.com/ethereum/go-ethereum/ethdb"
O
obscuren 已提交
34
	"github.com/ethereum/go-ethereum/event"
35
	"github.com/ethereum/go-ethereum/params"
36
	"github.com/ethereum/go-ethereum/trie"
37 38
)

39
var (
40 41
	testKey, _  = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
	testAddress = crypto.PubkeyToAddress(testKey.PublicKey)
42
)
43

44
// Reduce some of the parameters to make the tester faster.
45
func init() {
46
	MaxForkAncestry = uint64(10000)
47 48
	blockCacheItems = 1024
	fsHeaderContCheck = 500 * time.Millisecond
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
}

// downloadTester is a test simulator for mocking out local block chain.
type downloadTester struct {
	downloader *Downloader

	genesis *types.Block   // Genesis blocks used by the tester and peers
	stateDb ethdb.Database // Database used by the tester for syncing from peers
	peerDb  ethdb.Database // Database of the peers containing all data

	ownHashes   []common.Hash                  // Hash chain belonging to the tester
	ownHeaders  map[common.Hash]*types.Header  // Headers belonging to the tester
	ownBlocks   map[common.Hash]*types.Block   // Blocks belonging to the tester
	ownReceipts map[common.Hash]types.Receipts // Receipts belonging to the tester
	ownChainTd  map[common.Hash]*big.Int       // Total difficulties of the blocks in the local chain

	peerHashes   map[string][]common.Hash                  // Hash chain belonging to different test peers
	peerHeaders  map[string]map[common.Hash]*types.Header  // Headers belonging to different test peers
	peerBlocks   map[string]map[common.Hash]*types.Block   // Blocks belonging to different test peers
	peerReceipts map[string]map[common.Hash]types.Receipts // Receipts belonging to different test peers
	peerChainTds map[string]map[common.Hash]*big.Int       // Total difficulties of the blocks in the peer chains

	peerMissingStates map[string]map[common.Hash]bool // State entries that fast sync should not return

	lock sync.RWMutex
}

// newTester creates a new downloader test mocker.
func newTester() *downloadTester {
	testdb, _ := ethdb.NewMemDatabase()
	genesis := core.GenesisBlockForTesting(testdb, testAddress, big.NewInt(1000000000))

	tester := &downloadTester{
		genesis:           genesis,
		peerDb:            testdb,
		ownHashes:         []common.Hash{genesis.Hash()},
		ownHeaders:        map[common.Hash]*types.Header{genesis.Hash(): genesis.Header()},
		ownBlocks:         map[common.Hash]*types.Block{genesis.Hash(): genesis},
		ownReceipts:       map[common.Hash]types.Receipts{genesis.Hash(): nil},
		ownChainTd:        map[common.Hash]*big.Int{genesis.Hash(): genesis.Difficulty()},
		peerHashes:        make(map[string][]common.Hash),
		peerHeaders:       make(map[string]map[common.Hash]*types.Header),
		peerBlocks:        make(map[string]map[common.Hash]*types.Block),
		peerReceipts:      make(map[string]map[common.Hash]types.Receipts),
		peerChainTds:      make(map[string]map[common.Hash]*big.Int),
		peerMissingStates: make(map[string]map[common.Hash]bool),
	}
	tester.stateDb, _ = ethdb.NewMemDatabase()
	tester.stateDb.Put(genesis.Root().Bytes(), []byte{0x00})

99
	tester.downloader = New(FullSync, tester.stateDb, new(event.TypeMux), tester, nil, tester.dropPeer)
100 101

	return tester
102 103
}

104 105 106 107
// makeChain creates a chain of n blocks starting at and including parent.
// the returned hash chain is ordered head->parent. In addition, every 3rd block
// contains a transaction and every 5th an uncle to allow testing correct block
// reassembly.
108
func (dl *downloadTester) makeChain(n int, seed byte, parent *types.Block, parentReceipts types.Receipts, heavy bool) ([]common.Hash, map[common.Hash]*types.Header, map[common.Hash]*types.Block, map[common.Hash]types.Receipts) {
109
	// Generate the block chain
110
	blocks, receipts := core.GenerateChain(params.TestChainConfig, parent, ethash.NewFaker(), dl.peerDb, n, func(i int, block *core.BlockGen) {
111 112
		block.SetCoinbase(common.Address{seed})

113 114 115 116
		// If a heavy chain is requested, delay blocks to raise difficulty
		if heavy {
			block.OffsetTime(-1)
		}
117
		// If the block number is multiple of 3, send a bonus transaction to the miner
118
		if parent == dl.genesis && i%3 == 0 {
J
Jeffrey Wilcke 已提交
119
			signer := types.MakeSigner(params.TestChainConfig, block.Number())
120
			tx, err := types.SignTx(types.NewTransaction(block.TxNonce(testAddress), common.Address{seed}, big.NewInt(1000), params.TxGas, nil, nil), signer, testKey)
121 122 123 124 125 126
			if err != nil {
				panic(err)
			}
			block.AddTx(tx)
		}
		// If the block number is a multiple of 5, add a bonus uncle to the block
127 128 129 130 131
		if i > 0 && i%5 == 0 {
			block.AddUncle(&types.Header{
				ParentHash: block.PrevBlock(i - 1).Hash(),
				Number:     big.NewInt(block.Number().Int64() - 1),
			})
132
		}
133
	})
134
	// Convert the block-chain into a hash-chain and header/block maps
135 136
	hashes := make([]common.Hash, n+1)
	hashes[len(hashes)-1] = parent.Hash()
137 138 139 140

	headerm := make(map[common.Hash]*types.Header, n+1)
	headerm[parent.Hash()] = parent.Header()

141 142
	blockm := make(map[common.Hash]*types.Block, n+1)
	blockm[parent.Hash()] = parent
143

144 145 146
	receiptm := make(map[common.Hash]types.Receipts, n+1)
	receiptm[parent.Hash()] = parentReceipts

147 148
	for i, b := range blocks {
		hashes[len(hashes)-i-2] = b.Hash()
149
		headerm[b.Hash()] = b.Header()
150
		blockm[b.Hash()] = b
151
		receiptm[b.Hash()] = receipts[i]
152
	}
153
	return hashes, headerm, blockm, receiptm
154 155 156 157
}

// makeChainFork creates two chains of length n, such that h1[:f] and
// h2[:f] are different but have a common suffix of length n-f.
158
func (dl *downloadTester) makeChainFork(n, f int, parent *types.Block, parentReceipts types.Receipts, balanced bool) ([]common.Hash, []common.Hash, map[common.Hash]*types.Header, map[common.Hash]*types.Header, map[common.Hash]*types.Block, map[common.Hash]*types.Block, map[common.Hash]types.Receipts, map[common.Hash]types.Receipts) {
159
	// Create the common suffix
160
	hashes, headers, blocks, receipts := dl.makeChain(n-f, 0, parent, parentReceipts, false)
161

162
	// Create the forks, making the second heavyer if non balanced forks were requested
163
	hashes1, headers1, blocks1, receipts1 := dl.makeChain(f, 1, blocks[hashes[0]], receipts[hashes[0]], false)
164 165
	hashes1 = append(hashes1, hashes[1:]...)

166 167 168 169
	heavy := false
	if !balanced {
		heavy = true
	}
170
	hashes2, headers2, blocks2, receipts2 := dl.makeChain(f, 2, blocks[hashes[0]], receipts[hashes[0]], heavy)
171 172 173 174 175 176 177 178 179 180
	hashes2 = append(hashes2, hashes[1:]...)

	for hash, header := range headers {
		headers1[hash] = header
		headers2[hash] = header
	}
	for hash, block := range blocks {
		blocks1[hash] = block
		blocks2[hash] = block
	}
181 182 183 184 185
	for hash, receipt := range receipts {
		receipts1[hash] = receipt
		receipts2[hash] = receipt
	}
	return hashes1, hashes2, headers1, headers2, blocks1, blocks2, receipts1, receipts2
186 187
}

188 189 190 191 192 193
// terminate aborts any operations on the embedded downloader and releases all
// held resources.
func (dl *downloadTester) terminate() {
	dl.downloader.Terminate()
}

194
// sync starts synchronizing with a remote peer, blocking until it completes.
195
func (dl *downloadTester) sync(id string, td *big.Int, mode SyncMode) error {
196
	dl.lock.RLock()
197 198 199 200
	hash := dl.peerHashes[id][0]
	// If no particular TD was requested, load from the peer's blockchain
	if td == nil {
		td = big.NewInt(1)
201 202
		if diff, ok := dl.peerChainTds[id][hash]; ok {
			td = diff
203 204
		}
	}
205
	dl.lock.RUnlock()
206 207 208 209 210 211 212 213 214 215 216

	// Synchronise with the chosen peer and ensure proper cleanup afterwards
	err := dl.downloader.synchronise(id, hash, td, mode)
	select {
	case <-dl.downloader.cancelCh:
		// Ok, downloader fully cancelled after sync cycle
	default:
		// Downloader is still accepting packets, can block a peer up
		panic("downloader active post sync cycle") // panic will be caught by tester
	}
	return err
O
obscuren 已提交
217 218
}

219
// HasHeader checks if a header is present in the testers canonical chain.
220
func (dl *downloadTester) HasHeader(hash common.Hash, number uint64) bool {
221
	return dl.GetHeaderByHash(hash) != nil
222 223
}

224
// HasBlockAndState checks if a block and associated state is present in the testers canonical chain.
225
func (dl *downloadTester) HasBlockAndState(hash common.Hash, number uint64) bool {
226
	block := dl.GetBlockByHash(hash)
227 228 229 230 231
	if block == nil {
		return false
	}
	_, err := dl.stateDb.Get(block.Root().Bytes())
	return err == nil
232 233
}

234 235
// GetHeader retrieves a header from the testers canonical chain.
func (dl *downloadTester) GetHeaderByHash(hash common.Hash) *types.Header {
236 237 238
	dl.lock.RLock()
	defer dl.lock.RUnlock()

239
	return dl.ownHeaders[hash]
240 241
}

242 243
// GetBlock retrieves a block from the testers canonical chain.
func (dl *downloadTester) GetBlockByHash(hash common.Hash) *types.Block {
244 245 246
	dl.lock.RLock()
	defer dl.lock.RUnlock()

247 248 249
	return dl.ownBlocks[hash]
}

250 251
// CurrentHeader retrieves the current head header from the canonical chain.
func (dl *downloadTester) CurrentHeader() *types.Header {
252 253 254
	dl.lock.RLock()
	defer dl.lock.RUnlock()

255
	for i := len(dl.ownHashes) - 1; i >= 0; i-- {
256
		if header := dl.ownHeaders[dl.ownHashes[i]]; header != nil {
257 258 259
			return header
		}
	}
260
	return dl.genesis.Header()
261 262
}

263 264
// CurrentBlock retrieves the current head block from the canonical chain.
func (dl *downloadTester) CurrentBlock() *types.Block {
265 266 267
	dl.lock.RLock()
	defer dl.lock.RUnlock()

268
	for i := len(dl.ownHashes) - 1; i >= 0; i-- {
269
		if block := dl.ownBlocks[dl.ownHashes[i]]; block != nil {
270 271 272
			if _, err := dl.stateDb.Get(block.Root().Bytes()); err == nil {
				return block
			}
273 274
		}
	}
275
	return dl.genesis
276 277
}

278 279
// CurrentFastBlock retrieves the current head fast-sync block from the canonical chain.
func (dl *downloadTester) CurrentFastBlock() *types.Block {
280 281 282 283
	dl.lock.RLock()
	defer dl.lock.RUnlock()

	for i := len(dl.ownHashes) - 1; i >= 0; i-- {
284
		if block := dl.ownBlocks[dl.ownHashes[i]]; block != nil {
285
			return block
286 287
		}
	}
288
	return dl.genesis
289 290
}

291
// FastSyncCommitHead manually sets the head block to a given hash.
292
func (dl *downloadTester) FastSyncCommitHead(hash common.Hash) error {
293
	// For now only check that the state trie is correct
294
	if block := dl.GetBlockByHash(hash); block != nil {
295
		_, err := trie.NewSecure(block.Root(), trie.NewDatabase(dl.stateDb), 0)
296 297 298
		return err
	}
	return fmt.Errorf("non existent block: %x", hash[:4])
299 300
}

301 302
// GetTd retrieves the block's total difficulty from the canonical chain.
func (dl *downloadTester) GetTd(hash common.Hash, number uint64) *big.Int {
303 304 305
	dl.lock.RLock()
	defer dl.lock.RUnlock()

306 307 308
	return dl.ownChainTd[hash]
}

309 310
// InsertHeaderChain injects a new batch of headers into the simulated chain.
func (dl *downloadTester) InsertHeaderChain(headers []*types.Header, checkFreq int) (int, error) {
311 312 313
	dl.lock.Lock()
	defer dl.lock.Unlock()

L
Leif Jurvetson 已提交
314
	// Do a quick check, as the blockchain.InsertHeaderChain doesn't insert anything in case of errors
315 316 317 318 319 320 321 322 323
	if _, ok := dl.ownHeaders[headers[0].ParentHash]; !ok {
		return 0, errors.New("unknown parent")
	}
	for i := 1; i < len(headers); i++ {
		if headers[i].ParentHash != headers[i-1].Hash() {
			return i, errors.New("unknown parent")
		}
	}
	// Do a full insert if pre-checks passed
324
	for i, header := range headers {
325 326 327
		if _, ok := dl.ownHeaders[header.Hash()]; ok {
			continue
		}
328 329 330 331 332
		if _, ok := dl.ownHeaders[header.ParentHash]; !ok {
			return i, errors.New("unknown parent")
		}
		dl.ownHashes = append(dl.ownHashes, header.Hash())
		dl.ownHeaders[header.Hash()] = header
333
		dl.ownChainTd[header.Hash()] = new(big.Int).Add(dl.ownChainTd[header.ParentHash], header.Difficulty)
334 335 336 337
	}
	return len(headers), nil
}

338 339
// InsertChain injects a new batch of blocks into the simulated chain.
func (dl *downloadTester) InsertChain(blocks types.Blocks) (int, error) {
340 341 342
	dl.lock.Lock()
	defer dl.lock.Unlock()

343
	for i, block := range blocks {
344
		if parent, ok := dl.ownBlocks[block.ParentHash()]; !ok {
345
			return i, errors.New("unknown parent")
346 347
		} else if _, err := dl.stateDb.Get(parent.Root().Bytes()); err != nil {
			return i, fmt.Errorf("unknown parent state %x: %v", parent.Root(), err)
348
		}
349 350 351 352
		if _, ok := dl.ownHeaders[block.Hash()]; !ok {
			dl.ownHashes = append(dl.ownHashes, block.Hash())
			dl.ownHeaders[block.Hash()] = block.Header()
		}
353
		dl.ownBlocks[block.Hash()] = block
354 355
		dl.stateDb.Put(block.Root().Bytes(), []byte{0x00})
		dl.ownChainTd[block.Hash()] = new(big.Int).Add(dl.ownChainTd[block.ParentHash()], block.Difficulty())
356 357 358 359
	}
	return len(blocks), nil
}

360 361
// InsertReceiptChain injects a new batch of receipts into the simulated chain.
func (dl *downloadTester) InsertReceiptChain(blocks types.Blocks, receipts []types.Receipts) (int, error) {
362 363 364 365
	dl.lock.Lock()
	defer dl.lock.Unlock()

	for i := 0; i < len(blocks) && i < len(receipts); i++ {
366 367 368
		if _, ok := dl.ownHeaders[blocks[i].Hash()]; !ok {
			return i, errors.New("unknown owner")
		}
369 370 371 372
		if _, ok := dl.ownBlocks[blocks[i].ParentHash()]; !ok {
			return i, errors.New("unknown parent")
		}
		dl.ownBlocks[blocks[i].Hash()] = blocks[i]
373
		dl.ownReceipts[blocks[i].Hash()] = receipts[i]
374 375 376 377
	}
	return len(blocks), nil
}

378 379
// Rollback removes some recently added elements from the chain.
func (dl *downloadTester) Rollback(hashes []common.Hash) {
380 381 382 383 384 385 386 387 388 389 390 391 392 393
	dl.lock.Lock()
	defer dl.lock.Unlock()

	for i := len(hashes) - 1; i >= 0; i-- {
		if dl.ownHashes[len(dl.ownHashes)-1] == hashes[i] {
			dl.ownHashes = dl.ownHashes[:len(dl.ownHashes)-1]
		}
		delete(dl.ownChainTd, hashes[i])
		delete(dl.ownHeaders, hashes[i])
		delete(dl.ownReceipts, hashes[i])
		delete(dl.ownBlocks, hashes[i])
	}
}

394
// newPeer registers a new block download source into the downloader.
395 396
func (dl *downloadTester) newPeer(id string, version int, hashes []common.Hash, headers map[common.Hash]*types.Header, blocks map[common.Hash]*types.Block, receipts map[common.Hash]types.Receipts) error {
	return dl.newSlowPeer(id, version, hashes, headers, blocks, receipts, 0)
397 398 399 400 401
}

// newSlowPeer registers a new block download source into the downloader, with a
// specific delay time on processing the network packets sent to it, simulating
// potentially slow network IO.
402
func (dl *downloadTester) newSlowPeer(id string, version int, hashes []common.Hash, headers map[common.Hash]*types.Header, blocks map[common.Hash]*types.Block, receipts map[common.Hash]types.Receipts, delay time.Duration) error {
403 404 405
	dl.lock.Lock()
	defer dl.lock.Unlock()

406
	var err = dl.downloader.RegisterPeer(id, version, &downloadTesterPeer{dl: dl, id: id, delay: delay})
407
	if err == nil {
408
		// Assign the owned hashes, headers and blocks to the peer (deep copy)
409 410
		dl.peerHashes[id] = make([]common.Hash, len(hashes))
		copy(dl.peerHashes[id], hashes)
411

412
		dl.peerHeaders[id] = make(map[common.Hash]*types.Header)
413
		dl.peerBlocks[id] = make(map[common.Hash]*types.Block)
414
		dl.peerReceipts[id] = make(map[common.Hash]types.Receipts)
415
		dl.peerChainTds[id] = make(map[common.Hash]*big.Int)
416
		dl.peerMissingStates[id] = make(map[common.Hash]bool)
417

418 419 420 421 422 423 424 425 426 427 428 429 430
		genesis := hashes[len(hashes)-1]
		if header := headers[genesis]; header != nil {
			dl.peerHeaders[id][genesis] = header
			dl.peerChainTds[id][genesis] = header.Difficulty
		}
		if block := blocks[genesis]; block != nil {
			dl.peerBlocks[id][genesis] = block
			dl.peerChainTds[id][genesis] = block.Difficulty()
		}

		for i := len(hashes) - 2; i >= 0; i-- {
			hash := hashes[i]

431 432 433 434 435 436
			if header, ok := headers[hash]; ok {
				dl.peerHeaders[id][hash] = header
				if _, ok := dl.peerHeaders[id][header.ParentHash]; ok {
					dl.peerChainTds[id][hash] = new(big.Int).Add(header.Difficulty, dl.peerChainTds[id][header.ParentHash])
				}
			}
437 438
			if block, ok := blocks[hash]; ok {
				dl.peerBlocks[id][hash] = block
439 440
				if _, ok := dl.peerBlocks[id][block.ParentHash()]; ok {
					dl.peerChainTds[id][hash] = new(big.Int).Add(block.Difficulty(), dl.peerChainTds[id][block.ParentHash()])
441 442
				}
			}
443 444 445
			if receipt, ok := receipts[hash]; ok {
				dl.peerReceipts[id][hash] = receipt
			}
446
		}
447 448
	}
	return err
449 450
}

451 452
// dropPeer simulates a hard peer removal from the connection pool.
func (dl *downloadTester) dropPeer(id string) {
453 454 455
	dl.lock.Lock()
	defer dl.lock.Unlock()

456
	delete(dl.peerHashes, id)
457
	delete(dl.peerHeaders, id)
458
	delete(dl.peerBlocks, id)
459
	delete(dl.peerChainTds, id)
460 461 462 463

	dl.downloader.UnregisterPeer(id)
}

464 465 466 467
type downloadTesterPeer struct {
	dl    *downloadTester
	id    string
	delay time.Duration
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
	lock  sync.RWMutex
}

// setDelay is a thread safe setter for the network delay value.
func (dlp *downloadTesterPeer) setDelay(delay time.Duration) {
	dlp.lock.Lock()
	defer dlp.lock.Unlock()

	dlp.delay = delay
}

// waitDelay is a thread safe way to sleep for the configured time.
func (dlp *downloadTesterPeer) waitDelay() {
	dlp.lock.RLock()
	delay := dlp.delay
	dlp.lock.RUnlock()

	time.Sleep(delay)
486 487 488
}

// Head constructs a function to retrieve a peer's current head hash
489
// and total difficulty.
490 491 492
func (dlp *downloadTesterPeer) Head() (common.Hash, *big.Int) {
	dlp.dl.lock.RLock()
	defer dlp.dl.lock.RUnlock()
493

494
	return dlp.dl.peerHashes[dlp.id][0], nil
495 496
}

497
// RequestHeadersByHash constructs a GetBlockHeaders function based on a hashed
498 499
// origin; associated with a particular peer in the download tester. The returned
// function can be used to retrieve batches of headers from the particular peer.
500 501 502 503 504 505 506 507
func (dlp *downloadTesterPeer) RequestHeadersByHash(origin common.Hash, amount int, skip int, reverse bool) error {
	// Find the canonical number of the hash
	dlp.dl.lock.RLock()
	number := uint64(0)
	for num, hash := range dlp.dl.peerHashes[dlp.id] {
		if hash == origin {
			number = uint64(len(dlp.dl.peerHashes[dlp.id]) - num - 1)
			break
508 509
		}
	}
510 511 512 513
	dlp.dl.lock.RUnlock()

	// Use the absolute header fetcher to satisfy the query
	return dlp.RequestHeadersByNumber(number, amount, skip, reverse)
514 515
}

516
// RequestHeadersByNumber constructs a GetBlockHeaders function based on a numbered
517 518
// origin; associated with a particular peer in the download tester. The returned
// function can be used to retrieve batches of headers from the particular peer.
519
func (dlp *downloadTesterPeer) RequestHeadersByNumber(origin uint64, amount int, skip int, reverse bool) error {
520
	dlp.waitDelay()
521 522 523 524 525 526 527 528 529 530 531

	dlp.dl.lock.RLock()
	defer dlp.dl.lock.RUnlock()

	// Gather the next batch of headers
	hashes := dlp.dl.peerHashes[dlp.id]
	headers := dlp.dl.peerHeaders[dlp.id]
	result := make([]*types.Header, 0, amount)
	for i := 0; i < amount && len(hashes)-int(origin)-1-i*(skip+1) >= 0; i++ {
		if header, ok := headers[hashes[len(hashes)-int(origin)-1-i*(skip+1)]]; ok {
			result = append(result, header)
532 533
		}
	}
534 535 536 537 538 539
	// Delay delivery a bit to allow attacks to unfold
	go func() {
		time.Sleep(time.Millisecond)
		dlp.dl.downloader.DeliverHeaders(dlp.id, result)
	}()
	return nil
540 541
}

542
// RequestBodies constructs a getBlockBodies method associated with a particular
543 544
// peer in the download tester. The returned function can be used to retrieve
// batches of block bodies from the particularly requested peer.
545
func (dlp *downloadTesterPeer) RequestBodies(hashes []common.Hash) error {
546
	dlp.waitDelay()
547

548 549
	dlp.dl.lock.RLock()
	defer dlp.dl.lock.RUnlock()
550

551
	blocks := dlp.dl.peerBlocks[dlp.id]
552

553 554
	transactions := make([][]*types.Transaction, 0, len(hashes))
	uncles := make([][]*types.Header, 0, len(hashes))
555

556 557 558 559
	for _, hash := range hashes {
		if block, ok := blocks[hash]; ok {
			transactions = append(transactions, block.Transactions())
			uncles = append(uncles, block.Uncles())
560
		}
561
	}
562 563 564
	go dlp.dl.downloader.DeliverBodies(dlp.id, transactions, uncles)

	return nil
565 566
}

567
// RequestReceipts constructs a getReceipts method associated with a particular
568 569
// peer in the download tester. The returned function can be used to retrieve
// batches of block receipts from the particularly requested peer.
570
func (dlp *downloadTesterPeer) RequestReceipts(hashes []common.Hash) error {
571
	dlp.waitDelay()
572

573 574
	dlp.dl.lock.RLock()
	defer dlp.dl.lock.RUnlock()
575

576
	receipts := dlp.dl.peerReceipts[dlp.id]
577

578 579 580 581
	results := make([][]*types.Receipt, 0, len(hashes))
	for _, hash := range hashes {
		if receipt, ok := receipts[hash]; ok {
			results = append(results, receipt)
582 583
		}
	}
584 585 586
	go dlp.dl.downloader.DeliverReceipts(dlp.id, results)

	return nil
587 588
}

589
// RequestNodeData constructs a getNodeData method associated with a particular
590 591
// peer in the download tester. The returned function can be used to retrieve
// batches of node state data from the particularly requested peer.
592
func (dlp *downloadTesterPeer) RequestNodeData(hashes []common.Hash) error {
593
	dlp.waitDelay()
594 595 596 597 598 599 600 601 602

	dlp.dl.lock.RLock()
	defer dlp.dl.lock.RUnlock()

	results := make([][]byte, 0, len(hashes))
	for _, hash := range hashes {
		if data, err := dlp.dl.peerDb.Get(hash.Bytes()); err == nil {
			if !dlp.dl.peerMissingStates[dlp.id][hash] {
				results = append(results, data)
603 604 605
			}
		}
	}
606 607 608
	go dlp.dl.downloader.DeliverNodeData(dlp.id, results)

	return nil
609 610
}

611 612 613
// assertOwnChain checks if the local chain contains the correct number of items
// of the various chain components.
func assertOwnChain(t *testing.T, tester *downloadTester, length int) {
614 615 616 617 618 619 620
	assertOwnForkedChain(t, tester, 1, []int{length})
}

// assertOwnForkedChain checks if the local forked chain contains the correct
// number of items of the various chain components.
func assertOwnForkedChain(t *testing.T, tester *downloadTester, common int, lengths []int) {
	// Initialize the counters for the first fork
621
	headers, blocks, receipts := lengths[0], lengths[0], lengths[0]-fsMinFullBlocks
622

623 624
	if receipts < 0 {
		receipts = 1
625 626 627 628 629
	}
	// Update the counters for each subsequent fork
	for _, length := range lengths[1:] {
		headers += length - common
		blocks += length - common
630
		receipts += length - common - fsMinFullBlocks
631
	}
632 633
	switch tester.downloader.mode {
	case FullSync:
634
		receipts = 1
635
	case LightSync:
636
		blocks, receipts = 1, 1
637 638 639 640 641 642 643
	}
	if hs := len(tester.ownHeaders); hs != headers {
		t.Fatalf("synchronised headers mismatch: have %v, want %v", hs, headers)
	}
	if bs := len(tester.ownBlocks); bs != blocks {
		t.Fatalf("synchronised blocks mismatch: have %v, want %v", bs, blocks)
	}
644 645
	if rs := len(tester.ownReceipts); rs != receipts {
		t.Fatalf("synchronised receipts mismatch: have %v, want %v", rs, receipts)
646
	}
647
	// Verify the state trie too for fast syncs
648 649
	/*if tester.downloader.mode == FastSync {
		pivot := uint64(0)
650
		var index int
651 652 653 654 655 656
		if pivot := int(tester.downloader.queue.fastSyncPivot); pivot < common {
			index = pivot
		} else {
			index = len(tester.ownHashes) - lengths[len(lengths)-1] + int(tester.downloader.queue.fastSyncPivot)
		}
		if index > 0 {
657
			if statedb, err := state.New(tester.ownHeaders[tester.ownHashes[index]].Root, state.NewDatabase(trie.NewDatabase(tester.stateDb))); statedb == nil || err != nil {
658
				t.Fatalf("state reconstruction failed: %v", err)
659 660
			}
		}
661
	}*/
662 663
}

664 665 666
// Tests that simple synchronization against a canonical chain works correctly.
// In this test common ancestor lookup should be short circuited and not require
// binary searching.
667 668 669 670 671 672 673 674
func TestCanonicalSynchronisation62(t *testing.T)      { testCanonicalSynchronisation(t, 62, FullSync) }
func TestCanonicalSynchronisation63Full(t *testing.T)  { testCanonicalSynchronisation(t, 63, FullSync) }
func TestCanonicalSynchronisation63Fast(t *testing.T)  { testCanonicalSynchronisation(t, 63, FastSync) }
func TestCanonicalSynchronisation64Full(t *testing.T)  { testCanonicalSynchronisation(t, 64, FullSync) }
func TestCanonicalSynchronisation64Fast(t *testing.T)  { testCanonicalSynchronisation(t, 64, FastSync) }
func TestCanonicalSynchronisation64Light(t *testing.T) { testCanonicalSynchronisation(t, 64, LightSync) }

func testCanonicalSynchronisation(t *testing.T, protocol int, mode SyncMode) {
675 676
	t.Parallel()

677
	tester := newTester()
678 679
	defer tester.terminate()

680
	// Create a small enough block chain to download
681
	targetBlocks := blockCacheItems - 15
682 683
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)

684
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
685

686
	// Synchronise with the peer and make sure all relevant data was retrieved
687
	if err := tester.sync("peer", nil, mode); err != nil {
688
		t.Fatalf("failed to synchronise blocks: %v", err)
689
	}
690
	assertOwnChain(t, tester, targetBlocks+1)
691 692
}

693 694
// Tests that if a large batch of blocks are being downloaded, it is throttled
// until the cached blocks are retrieved.
695 696 697 698 699 700 701
func TestThrottling62(t *testing.T)     { testThrottling(t, 62, FullSync) }
func TestThrottling63Full(t *testing.T) { testThrottling(t, 63, FullSync) }
func TestThrottling63Fast(t *testing.T) { testThrottling(t, 63, FastSync) }
func TestThrottling64Full(t *testing.T) { testThrottling(t, 64, FullSync) }
func TestThrottling64Fast(t *testing.T) { testThrottling(t, 64, FastSync) }

func testThrottling(t *testing.T, protocol int, mode SyncMode) {
702
	t.Parallel()
703
	tester := newTester()
704 705
	defer tester.terminate()

706
	// Create a long block chain to download and the tester
707
	targetBlocks := 8 * blockCacheItems
708 709
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)

710
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
711

712
	// Wrap the importer to allow stepping
713
	blocked, proceed := uint32(0), make(chan struct{})
714 715
	tester.downloader.chainInsertHook = func(results []*fetchResult) {
		atomic.StoreUint32(&blocked, uint32(len(results)))
716
		<-proceed
717
	}
718 719 720
	// Start a synchronisation concurrently
	errc := make(chan error)
	go func() {
721
		errc <- tester.sync("peer", nil, mode)
722 723
	}()
	// Iteratively take some blocks, always checking the retrieval count
724 725 726 727 728 729 730 731
	for {
		// Check the retrieval count synchronously (! reason for this ugly block)
		tester.lock.RLock()
		retrieved := len(tester.ownBlocks)
		tester.lock.RUnlock()
		if retrieved >= targetBlocks+1 {
			break
		}
732
		// Wait a bit for sync to throttle itself
733
		var cached, frozen int
734
		for start := time.Now(); time.Since(start) < 3*time.Second; {
735
			time.Sleep(25 * time.Millisecond)
736

737 738
			tester.lock.Lock()
			tester.downloader.queue.lock.Lock()
739 740 741
			cached = len(tester.downloader.queue.blockDonePool)
			if mode == FastSync {
				if receipts := len(tester.downloader.queue.receiptDonePool); receipts < cached {
742 743 744
					//if tester.downloader.queue.resultCache[receipts].Header.Number.Uint64() < tester.downloader.queue.fastSyncPivot {
					cached = receipts
					//}
745 746
				}
			}
747 748
			frozen = int(atomic.LoadUint32(&blocked))
			retrieved = len(tester.ownBlocks)
749 750
			tester.downloader.queue.lock.Unlock()
			tester.lock.Unlock()
751

752
			if cached == blockCacheItems || retrieved+cached+frozen == targetBlocks+1 {
753 754 755
				break
			}
		}
756 757
		// Make sure we filled up the cache, then exhaust it
		time.Sleep(25 * time.Millisecond) // give it a chance to screw up
758 759 760 761

		tester.lock.RLock()
		retrieved = len(tester.ownBlocks)
		tester.lock.RUnlock()
762 763
		if cached != blockCacheItems && retrieved+cached+frozen != targetBlocks+1 {
			t.Fatalf("block count mismatch: have %v, want %v (owned %v, blocked %v, target %v)", cached, blockCacheItems, retrieved, frozen, targetBlocks+1)
764
		}
765 766 767 768
		// Permit the blocked blocks to import
		if atomic.LoadUint32(&blocked) > 0 {
			atomic.StoreUint32(&blocked, uint32(0))
			proceed <- struct{}{}
769
		}
770 771
	}
	// Check that we haven't pulled more blocks than available
772
	assertOwnChain(t, tester, targetBlocks+1)
773 774
	if err := <-errc; err != nil {
		t.Fatalf("block synchronization failed: %v", err)
775 776
	}
}
777

778 779 780
// Tests that simple synchronization against a forked chain works correctly. In
// this test common ancestor lookup should *not* be short circuited, and a full
// binary search should be executed.
781 782 783 784 785 786 787 788
func TestForkedSync62(t *testing.T)      { testForkedSync(t, 62, FullSync) }
func TestForkedSync63Full(t *testing.T)  { testForkedSync(t, 63, FullSync) }
func TestForkedSync63Fast(t *testing.T)  { testForkedSync(t, 63, FastSync) }
func TestForkedSync64Full(t *testing.T)  { testForkedSync(t, 64, FullSync) }
func TestForkedSync64Fast(t *testing.T)  { testForkedSync(t, 64, FastSync) }
func TestForkedSync64Light(t *testing.T) { testForkedSync(t, 64, LightSync) }

func testForkedSync(t *testing.T, protocol int, mode SyncMode) {
789 790
	t.Parallel()

791
	tester := newTester()
792 793
	defer tester.terminate()

794 795 796 797
	// Create a long enough forked chain
	common, fork := MaxHashFetch, 2*MaxHashFetch
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := tester.makeChainFork(common+fork, fork, tester.genesis, nil, true)

798 799
	tester.newPeer("fork A", protocol, hashesA, headersA, blocksA, receiptsA)
	tester.newPeer("fork B", protocol, hashesB, headersB, blocksB, receiptsB)
800 801

	// Synchronise with the peer and make sure all blocks were retrieved
802
	if err := tester.sync("fork A", nil, mode); err != nil {
803 804
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
805 806
	assertOwnChain(t, tester, common+fork+1)

807
	// Synchronise with the second peer and make sure that fork is pulled too
808
	if err := tester.sync("fork B", nil, mode); err != nil {
809 810
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
811
	assertOwnForkedChain(t, tester, common+1, []int{common + fork + 1, common + fork + 1})
812 813
}

814 815 816 817 818 819 820 821 822 823 824 825 826
// Tests that synchronising against a much shorter but much heavyer fork works
// corrently and is not dropped.
func TestHeavyForkedSync62(t *testing.T)      { testHeavyForkedSync(t, 62, FullSync) }
func TestHeavyForkedSync63Full(t *testing.T)  { testHeavyForkedSync(t, 63, FullSync) }
func TestHeavyForkedSync63Fast(t *testing.T)  { testHeavyForkedSync(t, 63, FastSync) }
func TestHeavyForkedSync64Full(t *testing.T)  { testHeavyForkedSync(t, 64, FullSync) }
func TestHeavyForkedSync64Fast(t *testing.T)  { testHeavyForkedSync(t, 64, FastSync) }
func TestHeavyForkedSync64Light(t *testing.T) { testHeavyForkedSync(t, 64, LightSync) }

func testHeavyForkedSync(t *testing.T, protocol int, mode SyncMode) {
	t.Parallel()

	tester := newTester()
827 828
	defer tester.terminate()

829 830 831 832
	// Create a long enough forked chain
	common, fork := MaxHashFetch, 4*MaxHashFetch
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := tester.makeChainFork(common+fork, fork, tester.genesis, nil, false)

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
	tester.newPeer("light", protocol, hashesA, headersA, blocksA, receiptsA)
	tester.newPeer("heavy", protocol, hashesB[fork/2:], headersB, blocksB, receiptsB)

	// Synchronise with the peer and make sure all blocks were retrieved
	if err := tester.sync("light", nil, mode); err != nil {
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
	assertOwnChain(t, tester, common+fork+1)

	// Synchronise with the second peer and make sure that fork is pulled too
	if err := tester.sync("heavy", nil, mode); err != nil {
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
	assertOwnForkedChain(t, tester, common+1, []int{common + fork + 1, common + fork/2 + 1})
}

// Tests that chain forks are contained within a certain interval of the current
// chain head, ensuring that malicious peers cannot waste resources by feeding
// long dead chains.
func TestBoundedForkedSync62(t *testing.T)      { testBoundedForkedSync(t, 62, FullSync) }
func TestBoundedForkedSync63Full(t *testing.T)  { testBoundedForkedSync(t, 63, FullSync) }
func TestBoundedForkedSync63Fast(t *testing.T)  { testBoundedForkedSync(t, 63, FastSync) }
func TestBoundedForkedSync64Full(t *testing.T)  { testBoundedForkedSync(t, 64, FullSync) }
func TestBoundedForkedSync64Fast(t *testing.T)  { testBoundedForkedSync(t, 64, FastSync) }
func TestBoundedForkedSync64Light(t *testing.T) { testBoundedForkedSync(t, 64, LightSync) }

func testBoundedForkedSync(t *testing.T, protocol int, mode SyncMode) {
	t.Parallel()

	tester := newTester()
863 864
	defer tester.terminate()

865 866 867 868
	// Create a long enough forked chain
	common, fork := 13, int(MaxForkAncestry+17)
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := tester.makeChainFork(common+fork, fork, tester.genesis, nil, true)

869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
	tester.newPeer("original", protocol, hashesA, headersA, blocksA, receiptsA)
	tester.newPeer("rewriter", protocol, hashesB, headersB, blocksB, receiptsB)

	// Synchronise with the peer and make sure all blocks were retrieved
	if err := tester.sync("original", nil, mode); err != nil {
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
	assertOwnChain(t, tester, common+fork+1)

	// Synchronise with the second peer and ensure that the fork is rejected to being too old
	if err := tester.sync("rewriter", nil, mode); err != errInvalidAncestor {
		t.Fatalf("sync failure mismatch: have %v, want %v", err, errInvalidAncestor)
	}
}

// Tests that chain forks are contained within a certain interval of the current
// chain head for short but heavy forks too. These are a bit special because they
// take different ancestor lookup paths.
func TestBoundedHeavyForkedSync62(t *testing.T)      { testBoundedHeavyForkedSync(t, 62, FullSync) }
func TestBoundedHeavyForkedSync63Full(t *testing.T)  { testBoundedHeavyForkedSync(t, 63, FullSync) }
func TestBoundedHeavyForkedSync63Fast(t *testing.T)  { testBoundedHeavyForkedSync(t, 63, FastSync) }
func TestBoundedHeavyForkedSync64Full(t *testing.T)  { testBoundedHeavyForkedSync(t, 64, FullSync) }
func TestBoundedHeavyForkedSync64Fast(t *testing.T)  { testBoundedHeavyForkedSync(t, 64, FastSync) }
func TestBoundedHeavyForkedSync64Light(t *testing.T) { testBoundedHeavyForkedSync(t, 64, LightSync) }

func testBoundedHeavyForkedSync(t *testing.T, protocol int, mode SyncMode) {
	t.Parallel()

	tester := newTester()
898 899
	defer tester.terminate()

900 901 902 903
	// Create a long enough forked chain
	common, fork := 13, int(MaxForkAncestry+17)
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := tester.makeChainFork(common+fork, fork, tester.genesis, nil, false)

904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
	tester.newPeer("original", protocol, hashesA, headersA, blocksA, receiptsA)
	tester.newPeer("heavy-rewriter", protocol, hashesB[MaxForkAncestry-17:], headersB, blocksB, receiptsB) // Root the fork below the ancestor limit

	// Synchronise with the peer and make sure all blocks were retrieved
	if err := tester.sync("original", nil, mode); err != nil {
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
	assertOwnChain(t, tester, common+fork+1)

	// Synchronise with the second peer and ensure that the fork is rejected to being too old
	if err := tester.sync("heavy-rewriter", nil, mode); err != errInvalidAncestor {
		t.Fatalf("sync failure mismatch: have %v, want %v", err, errInvalidAncestor)
	}
}

919 920
// Tests that an inactive downloader will not accept incoming block headers and
// bodies.
921
func TestInactiveDownloader62(t *testing.T) {
922
	t.Parallel()
923

924
	tester := newTester()
925
	defer tester.terminate()
926 927 928

	// Check that neither block headers nor bodies are accepted
	if err := tester.downloader.DeliverHeaders("bad peer", []*types.Header{}); err != errNoSyncActive {
929 930
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
931
	if err := tester.downloader.DeliverBodies("bad peer", [][]*types.Transaction{}, [][]*types.Header{}); err != errNoSyncActive {
932 933 934 935
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
}

936 937 938
// Tests that an inactive downloader will not accept incoming block headers,
// bodies and receipts.
func TestInactiveDownloader63(t *testing.T) {
939
	t.Parallel()
940

941
	tester := newTester()
942
	defer tester.terminate()
943 944 945 946 947 948 949 950 951 952 953 954

	// Check that neither block headers nor bodies are accepted
	if err := tester.downloader.DeliverHeaders("bad peer", []*types.Header{}); err != errNoSyncActive {
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
	if err := tester.downloader.DeliverBodies("bad peer", [][]*types.Transaction{}, [][]*types.Header{}); err != errNoSyncActive {
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
	if err := tester.downloader.DeliverReceipts("bad peer", [][]*types.Receipt{}); err != errNoSyncActive {
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
}
955

956 957 958 959 960 961 962 963 964
// Tests that a canceled download wipes all previously accumulated state.
func TestCancel62(t *testing.T)      { testCancel(t, 62, FullSync) }
func TestCancel63Full(t *testing.T)  { testCancel(t, 63, FullSync) }
func TestCancel63Fast(t *testing.T)  { testCancel(t, 63, FastSync) }
func TestCancel64Full(t *testing.T)  { testCancel(t, 64, FullSync) }
func TestCancel64Fast(t *testing.T)  { testCancel(t, 64, FastSync) }
func TestCancel64Light(t *testing.T) { testCancel(t, 64, LightSync) }

func testCancel(t *testing.T, protocol int, mode SyncMode) {
965 966
	t.Parallel()

967 968 969
	tester := newTester()
	defer tester.terminate()

970
	// Create a small enough block chain to download and the tester
971
	targetBlocks := blockCacheItems - 15
972 973 974
	if targetBlocks >= MaxHashFetch {
		targetBlocks = MaxHashFetch - 15
	}
975 976 977
	if targetBlocks >= MaxHeaderFetch {
		targetBlocks = MaxHeaderFetch - 15
	}
978
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)
979

980
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
981 982

	// Make sure canceling works with a pristine downloader
983
	tester.downloader.Cancel()
984 985
	if !tester.downloader.queue.Idle() {
		t.Errorf("download queue not idle")
986 987
	}
	// Synchronise with the peer, but cancel afterwards
988
	if err := tester.sync("peer", nil, mode); err != nil {
989 990
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
991
	tester.downloader.Cancel()
992 993
	if !tester.downloader.queue.Idle() {
		t.Errorf("download queue not idle")
994 995 996
	}
}

997
// Tests that synchronisation from multiple peers works as intended (multi thread sanity test).
998 999 1000 1001 1002 1003 1004 1005
func TestMultiSynchronisation62(t *testing.T)      { testMultiSynchronisation(t, 62, FullSync) }
func TestMultiSynchronisation63Full(t *testing.T)  { testMultiSynchronisation(t, 63, FullSync) }
func TestMultiSynchronisation63Fast(t *testing.T)  { testMultiSynchronisation(t, 63, FastSync) }
func TestMultiSynchronisation64Full(t *testing.T)  { testMultiSynchronisation(t, 64, FullSync) }
func TestMultiSynchronisation64Fast(t *testing.T)  { testMultiSynchronisation(t, 64, FastSync) }
func TestMultiSynchronisation64Light(t *testing.T) { testMultiSynchronisation(t, 64, LightSync) }

func testMultiSynchronisation(t *testing.T, protocol int, mode SyncMode) {
1006 1007
	t.Parallel()

1008 1009 1010
	tester := newTester()
	defer tester.terminate()

1011
	// Create various peers with various parts of the chain
1012
	targetPeers := 8
1013
	targetBlocks := targetPeers*blockCacheItems - 15
1014
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)
1015

1016 1017
	for i := 0; i < targetPeers; i++ {
		id := fmt.Sprintf("peer #%d", i)
1018
		tester.newPeer(id, protocol, hashes[i*blockCacheItems:], headers, blocks, receipts)
1019
	}
1020
	if err := tester.sync("peer #0", nil, mode); err != nil {
1021 1022
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1023
	assertOwnChain(t, tester, targetBlocks+1)
1024 1025
}

1026
// Tests that synchronisations behave well in multi-version protocol environments
L
Leif Jurvetson 已提交
1027
// and not wreak havoc on other nodes in the network.
1028 1029 1030 1031 1032 1033 1034 1035
func TestMultiProtoSynchronisation62(t *testing.T)      { testMultiProtoSync(t, 62, FullSync) }
func TestMultiProtoSynchronisation63Full(t *testing.T)  { testMultiProtoSync(t, 63, FullSync) }
func TestMultiProtoSynchronisation63Fast(t *testing.T)  { testMultiProtoSync(t, 63, FastSync) }
func TestMultiProtoSynchronisation64Full(t *testing.T)  { testMultiProtoSync(t, 64, FullSync) }
func TestMultiProtoSynchronisation64Fast(t *testing.T)  { testMultiProtoSync(t, 64, FastSync) }
func TestMultiProtoSynchronisation64Light(t *testing.T) { testMultiProtoSync(t, 64, LightSync) }

func testMultiProtoSync(t *testing.T, protocol int, mode SyncMode) {
1036 1037
	t.Parallel()

1038 1039 1040
	tester := newTester()
	defer tester.terminate()

1041
	// Create a small enough block chain to download
1042
	targetBlocks := blockCacheItems - 15
1043
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)
1044 1045

	// Create peers of every type
1046
	tester.newPeer("peer 62", 62, hashes, headers, blocks, nil)
1047 1048
	tester.newPeer("peer 63", 63, hashes, headers, blocks, receipts)
	tester.newPeer("peer 64", 64, hashes, headers, blocks, receipts)
1049

1050 1051
	// Synchronise with the requested peer and make sure all blocks were retrieved
	if err := tester.sync(fmt.Sprintf("peer %d", protocol), nil, mode); err != nil {
1052 1053
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1054 1055
	assertOwnChain(t, tester, targetBlocks+1)

1056
	// Check that no peers have been dropped off
1057
	for _, version := range []int{62, 63, 64} {
1058 1059 1060 1061 1062 1063 1064
		peer := fmt.Sprintf("peer %d", version)
		if _, ok := tester.peerHashes[peer]; !ok {
			t.Errorf("%s dropped", peer)
		}
	}
}

1065
// Tests that if a block is empty (e.g. header only), no body request should be
1066
// made, and instead the header should be assembled into a whole block in itself.
1067 1068 1069 1070 1071 1072 1073 1074
func TestEmptyShortCircuit62(t *testing.T)      { testEmptyShortCircuit(t, 62, FullSync) }
func TestEmptyShortCircuit63Full(t *testing.T)  { testEmptyShortCircuit(t, 63, FullSync) }
func TestEmptyShortCircuit63Fast(t *testing.T)  { testEmptyShortCircuit(t, 63, FastSync) }
func TestEmptyShortCircuit64Full(t *testing.T)  { testEmptyShortCircuit(t, 64, FullSync) }
func TestEmptyShortCircuit64Fast(t *testing.T)  { testEmptyShortCircuit(t, 64, FastSync) }
func TestEmptyShortCircuit64Light(t *testing.T) { testEmptyShortCircuit(t, 64, LightSync) }

func testEmptyShortCircuit(t *testing.T, protocol int, mode SyncMode) {
1075 1076
	t.Parallel()

1077
	tester := newTester()
1078 1079
	defer tester.terminate()

1080
	// Create a block chain to download
1081
	targetBlocks := 2*blockCacheItems - 15
1082 1083
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)

1084
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
1085 1086

	// Instrument the downloader to signal body requests
1087
	bodiesHave, receiptsHave := int32(0), int32(0)
1088
	tester.downloader.bodyFetchHook = func(headers []*types.Header) {
1089
		atomic.AddInt32(&bodiesHave, int32(len(headers)))
1090 1091
	}
	tester.downloader.receiptFetchHook = func(headers []*types.Header) {
1092
		atomic.AddInt32(&receiptsHave, int32(len(headers)))
1093 1094
	}
	// Synchronise with the peer and make sure all blocks were retrieved
1095
	if err := tester.sync("peer", nil, mode); err != nil {
1096 1097
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1098 1099
	assertOwnChain(t, tester, targetBlocks+1)

1100
	// Validate the number of block bodies that should have been requested
1101
	bodiesNeeded, receiptsNeeded := 0, 0
1102
	for _, block := range blocks {
1103
		if mode != LightSync && block != tester.genesis && (len(block.Transactions()) > 0 || len(block.Uncles()) > 0) {
1104
			bodiesNeeded++
1105
		}
1106
	}
1107 1108
	for _, receipt := range receipts {
		if mode == FastSync && len(receipt) > 0 {
1109 1110 1111
			receiptsNeeded++
		}
	}
1112 1113
	if int(bodiesHave) != bodiesNeeded {
		t.Errorf("body retrieval count mismatch: have %v, want %v", bodiesHave, bodiesNeeded)
1114
	}
1115 1116
	if int(receiptsHave) != receiptsNeeded {
		t.Errorf("receipt retrieval count mismatch: have %v, want %v", receiptsHave, receiptsNeeded)
1117 1118 1119
	}
}

1120 1121
// Tests that headers are enqueued continuously, preventing malicious nodes from
// stalling the downloader by feeding gapped header chains.
1122 1123 1124 1125 1126 1127 1128 1129
func TestMissingHeaderAttack62(t *testing.T)      { testMissingHeaderAttack(t, 62, FullSync) }
func TestMissingHeaderAttack63Full(t *testing.T)  { testMissingHeaderAttack(t, 63, FullSync) }
func TestMissingHeaderAttack63Fast(t *testing.T)  { testMissingHeaderAttack(t, 63, FastSync) }
func TestMissingHeaderAttack64Full(t *testing.T)  { testMissingHeaderAttack(t, 64, FullSync) }
func TestMissingHeaderAttack64Fast(t *testing.T)  { testMissingHeaderAttack(t, 64, FastSync) }
func TestMissingHeaderAttack64Light(t *testing.T) { testMissingHeaderAttack(t, 64, LightSync) }

func testMissingHeaderAttack(t *testing.T, protocol int, mode SyncMode) {
1130 1131
	t.Parallel()

1132
	tester := newTester()
1133
	defer tester.terminate()
1134

1135
	// Create a small enough block chain to download
1136
	targetBlocks := blockCacheItems - 15
1137 1138
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)

1139
	// Attempt a full sync with an attacker feeding gapped headers
1140
	tester.newPeer("attack", protocol, hashes, headers, blocks, receipts)
1141
	missing := targetBlocks / 2
1142
	delete(tester.peerHeaders["attack"], hashes[missing])
1143

1144
	if err := tester.sync("attack", nil, mode); err == nil {
1145 1146 1147
		t.Fatalf("succeeded attacker synchronisation")
	}
	// Synchronise with the valid peer and make sure sync succeeds
1148
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
1149
	if err := tester.sync("valid", nil, mode); err != nil {
1150 1151
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1152
	assertOwnChain(t, tester, targetBlocks+1)
1153 1154 1155 1156
}

// Tests that if requested headers are shifted (i.e. first is missing), the queue
// detects the invalid numbering.
1157 1158 1159 1160 1161 1162 1163 1164
func TestShiftedHeaderAttack62(t *testing.T)      { testShiftedHeaderAttack(t, 62, FullSync) }
func TestShiftedHeaderAttack63Full(t *testing.T)  { testShiftedHeaderAttack(t, 63, FullSync) }
func TestShiftedHeaderAttack63Fast(t *testing.T)  { testShiftedHeaderAttack(t, 63, FastSync) }
func TestShiftedHeaderAttack64Full(t *testing.T)  { testShiftedHeaderAttack(t, 64, FullSync) }
func TestShiftedHeaderAttack64Fast(t *testing.T)  { testShiftedHeaderAttack(t, 64, FastSync) }
func TestShiftedHeaderAttack64Light(t *testing.T) { testShiftedHeaderAttack(t, 64, LightSync) }

func testShiftedHeaderAttack(t *testing.T, protocol int, mode SyncMode) {
1165 1166
	t.Parallel()

1167
	tester := newTester()
1168
	defer tester.terminate()
1169

1170
	// Create a small enough block chain to download
1171
	targetBlocks := blockCacheItems - 15
1172 1173
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)

1174
	// Attempt a full sync with an attacker feeding shifted headers
1175
	tester.newPeer("attack", protocol, hashes, headers, blocks, receipts)
1176
	delete(tester.peerHeaders["attack"], hashes[len(hashes)-2])
1177
	delete(tester.peerBlocks["attack"], hashes[len(hashes)-2])
1178
	delete(tester.peerReceipts["attack"], hashes[len(hashes)-2])
1179

1180
	if err := tester.sync("attack", nil, mode); err == nil {
1181 1182 1183
		t.Fatalf("succeeded attacker synchronisation")
	}
	// Synchronise with the valid peer and make sure sync succeeds
1184
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
1185
	if err := tester.sync("valid", nil, mode); err != nil {
1186 1187 1188 1189 1190 1191
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
	assertOwnChain(t, tester, targetBlocks+1)
}

// Tests that upon detecting an invalid header, the recent ones are rolled back
1192 1193
// for various failure scenarios. Afterwards a full sync is attempted to make
// sure no state was corrupted.
1194 1195 1196 1197 1198
func TestInvalidHeaderRollback63Fast(t *testing.T)  { testInvalidHeaderRollback(t, 63, FastSync) }
func TestInvalidHeaderRollback64Fast(t *testing.T)  { testInvalidHeaderRollback(t, 64, FastSync) }
func TestInvalidHeaderRollback64Light(t *testing.T) { testInvalidHeaderRollback(t, 64, LightSync) }

func testInvalidHeaderRollback(t *testing.T, protocol int, mode SyncMode) {
1199 1200
	t.Parallel()

1201
	tester := newTester()
1202
	defer tester.terminate()
1203

1204
	// Create a small enough block chain to download
1205
	targetBlocks := 3*fsHeaderSafetyNet + 256 + fsMinFullBlocks
1206 1207
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)

1208 1209
	// Attempt to sync with an attacker that feeds junk during the fast sync phase.
	// This should result in the last fsHeaderSafetyNet headers being rolled back.
1210
	tester.newPeer("fast-attack", protocol, hashes, headers, blocks, receipts)
1211
	missing := fsHeaderSafetyNet + MaxHeaderFetch + 1
1212 1213
	delete(tester.peerHeaders["fast-attack"], hashes[len(hashes)-missing])

1214
	if err := tester.sync("fast-attack", nil, mode); err == nil {
1215 1216
		t.Fatalf("succeeded fast attacker synchronisation")
	}
1217
	if head := tester.CurrentHeader().Number.Int64(); int(head) > MaxHeaderFetch {
1218
		t.Errorf("rollback head mismatch: have %v, want at most %v", head, MaxHeaderFetch)
1219
	}
1220 1221 1222
	// Attempt to sync with an attacker that feeds junk during the block import phase.
	// This should result in both the last fsHeaderSafetyNet number of headers being
	// rolled back, and also the pivot point being reverted to a non-block status.
1223
	tester.newPeer("block-attack", protocol, hashes, headers, blocks, receipts)
1224
	missing = 3*fsHeaderSafetyNet + MaxHeaderFetch + 1
1225
	delete(tester.peerHeaders["fast-attack"], hashes[len(hashes)-missing]) // Make sure the fast-attacker doesn't fill in
1226 1227
	delete(tester.peerHeaders["block-attack"], hashes[len(hashes)-missing])

1228
	if err := tester.sync("block-attack", nil, mode); err == nil {
1229 1230
		t.Fatalf("succeeded block attacker synchronisation")
	}
1231
	if head := tester.CurrentHeader().Number.Int64(); int(head) > 2*fsHeaderSafetyNet+MaxHeaderFetch {
1232 1233
		t.Errorf("rollback head mismatch: have %v, want at most %v", head, 2*fsHeaderSafetyNet+MaxHeaderFetch)
	}
1234
	if mode == FastSync {
1235
		if head := tester.CurrentBlock().NumberU64(); head != 0 {
1236
			t.Errorf("fast sync pivot block #%d not rolled back", head)
1237
		}
1238
	}
1239 1240 1241 1242 1243
	// Attempt to sync with an attacker that withholds promised blocks after the
	// fast sync pivot point. This could be a trial to leave the node with a bad
	// but already imported pivot block.
	tester.newPeer("withhold-attack", protocol, hashes, headers, blocks, receipts)
	missing = 3*fsHeaderSafetyNet + MaxHeaderFetch + 1
1244

1245 1246 1247 1248 1249
	tester.downloader.syncInitHook = func(uint64, uint64) {
		for i := missing; i <= len(hashes); i++ {
			delete(tester.peerHeaders["withhold-attack"], hashes[len(hashes)-i])
		}
		tester.downloader.syncInitHook = nil
1250
	}
1251

1252 1253 1254
	if err := tester.sync("withhold-attack", nil, mode); err == nil {
		t.Fatalf("succeeded withholding attacker synchronisation")
	}
1255
	if head := tester.CurrentHeader().Number.Int64(); int(head) > 2*fsHeaderSafetyNet+MaxHeaderFetch {
1256
		t.Errorf("rollback head mismatch: have %v, want at most %v", head, 2*fsHeaderSafetyNet+MaxHeaderFetch)
1257 1258
	}
	if mode == FastSync {
1259
		if head := tester.CurrentBlock().NumberU64(); head != 0 {
1260 1261
			t.Errorf("fast sync pivot block #%d not rolled back", head)
		}
1262
	}
1263 1264 1265
	// Synchronise with the valid peer and make sure sync succeeds. Since the last
	// rollback should also disable fast syncing for this process, verify that we
	// did a fresh full sync. Note, we can't assert anything about the receipts
L
Leif Jurvetson 已提交
1266
	// since we won't purge the database of them, hence we can't use assertOwnChain.
1267 1268
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
	if err := tester.sync("valid", nil, mode); err != nil {
1269 1270
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1271 1272
	if hs := len(tester.ownHeaders); hs != len(headers) {
		t.Fatalf("synchronised headers mismatch: have %v, want %v", hs, len(headers))
1273
	}
1274 1275 1276 1277
	if mode != LightSync {
		if bs := len(tester.ownBlocks); bs != len(blocks) {
			t.Fatalf("synchronised blocks mismatch: have %v, want %v", bs, len(blocks))
		}
1278
	}
1279 1280
}

1281 1282
// Tests that a peer advertising an high TD doesn't get to stall the downloader
// afterwards by not sending any useful hashes.
1283 1284 1285 1286 1287 1288 1289 1290
func TestHighTDStarvationAttack62(t *testing.T)      { testHighTDStarvationAttack(t, 62, FullSync) }
func TestHighTDStarvationAttack63Full(t *testing.T)  { testHighTDStarvationAttack(t, 63, FullSync) }
func TestHighTDStarvationAttack63Fast(t *testing.T)  { testHighTDStarvationAttack(t, 63, FastSync) }
func TestHighTDStarvationAttack64Full(t *testing.T)  { testHighTDStarvationAttack(t, 64, FullSync) }
func TestHighTDStarvationAttack64Fast(t *testing.T)  { testHighTDStarvationAttack(t, 64, FastSync) }
func TestHighTDStarvationAttack64Light(t *testing.T) { testHighTDStarvationAttack(t, 64, LightSync) }

func testHighTDStarvationAttack(t *testing.T, protocol int, mode SyncMode) {
1291 1292
	t.Parallel()

1293
	tester := newTester()
1294
	defer tester.terminate()
1295

1296
	hashes, headers, blocks, receipts := tester.makeChain(0, 0, tester.genesis, nil, false)
1297
	tester.newPeer("attack", protocol, []common.Hash{hashes[0]}, headers, blocks, receipts)
1298

1299
	if err := tester.sync("attack", big.NewInt(1000000), mode); err != errStallingPeer {
1300 1301 1302 1303
		t.Fatalf("synchronisation error mismatch: have %v, want %v", err, errStallingPeer)
	}
}

1304
// Tests that misbehaving peers are disconnected, whilst behaving ones are not.
1305 1306 1307 1308 1309
func TestBlockHeaderAttackerDropping62(t *testing.T) { testBlockHeaderAttackerDropping(t, 62) }
func TestBlockHeaderAttackerDropping63(t *testing.T) { testBlockHeaderAttackerDropping(t, 63) }
func TestBlockHeaderAttackerDropping64(t *testing.T) { testBlockHeaderAttackerDropping(t, 64) }

func testBlockHeaderAttackerDropping(t *testing.T, protocol int) {
1310 1311
	t.Parallel()

1312
	// Define the disconnection requirement for individual hash fetch errors
1313 1314 1315 1316
	tests := []struct {
		result error
		drop   bool
	}{
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
		{nil, false},                        // Sync succeeded, all is well
		{errBusy, false},                    // Sync is already in progress, no problem
		{errUnknownPeer, false},             // Peer is unknown, was already dropped, don't double drop
		{errBadPeer, true},                  // Peer was deemed bad for some reason, drop it
		{errStallingPeer, true},             // Peer was detected to be stalling, drop it
		{errNoPeers, false},                 // No peers to download from, soft race, no issue
		{errTimeout, true},                  // No hashes received in due time, drop the peer
		{errEmptyHeaderSet, true},           // No headers were returned as a response, drop as it's a dead end
		{errPeersUnavailable, true},         // Nobody had the advertised blocks, drop the advertiser
		{errInvalidAncestor, true},          // Agreed upon ancestor is not acceptable, drop the chain rewriter
		{errInvalidChain, true},             // Hash chain was detected as invalid, definitely drop
		{errInvalidBlock, false},            // A bad peer was detected, but not the sync origin
		{errInvalidBody, false},             // A bad peer was detected, but not the sync origin
		{errInvalidReceipt, false},          // A bad peer was detected, but not the sync origin
		{errCancelBlockFetch, false},        // Synchronisation was canceled, origin may be innocent, don't drop
		{errCancelHeaderFetch, false},       // Synchronisation was canceled, origin may be innocent, don't drop
		{errCancelBodyFetch, false},         // Synchronisation was canceled, origin may be innocent, don't drop
		{errCancelReceiptFetch, false},      // Synchronisation was canceled, origin may be innocent, don't drop
		{errCancelHeaderProcessing, false},  // Synchronisation was canceled, origin may be innocent, don't drop
		{errCancelContentProcessing, false}, // Synchronisation was canceled, origin may be innocent, don't drop
1337 1338
	}
	// Run the tests and check disconnection status
1339
	tester := newTester()
1340 1341
	defer tester.terminate()

1342 1343 1344
	for i, tt := range tests {
		// Register a new peer and ensure it's presence
		id := fmt.Sprintf("test %d", i)
1345
		if err := tester.newPeer(id, protocol, []common.Hash{tester.genesis.Hash()}, nil, nil, nil); err != nil {
1346 1347 1348 1349 1350 1351 1352 1353
			t.Fatalf("test %d: failed to register new peer: %v", i, err)
		}
		if _, ok := tester.peerHashes[id]; !ok {
			t.Fatalf("test %d: registered peer not found", i)
		}
		// Simulate a synchronisation and check the required result
		tester.downloader.synchroniseMock = func(string, common.Hash) error { return tt.result }

1354
		tester.downloader.Synchronise(id, tester.genesis.Hash(), big.NewInt(1000), FullSync)
1355 1356 1357 1358 1359
		if _, ok := tester.peerHashes[id]; !ok != tt.drop {
			t.Errorf("test %d: peer drop mismatch for %v: have %v, want %v", i, tt.result, !ok, tt.drop)
		}
	}
}
1360

1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
// Tests that synchronisation progress (origin block number, current block number
// and highest block number) is tracked and updated correctly.
func TestSyncProgress62(t *testing.T)      { testSyncProgress(t, 62, FullSync) }
func TestSyncProgress63Full(t *testing.T)  { testSyncProgress(t, 63, FullSync) }
func TestSyncProgress63Fast(t *testing.T)  { testSyncProgress(t, 63, FastSync) }
func TestSyncProgress64Full(t *testing.T)  { testSyncProgress(t, 64, FullSync) }
func TestSyncProgress64Fast(t *testing.T)  { testSyncProgress(t, 64, FastSync) }
func TestSyncProgress64Light(t *testing.T) { testSyncProgress(t, 64, LightSync) }

func testSyncProgress(t *testing.T, protocol int, mode SyncMode) {
1371 1372
	t.Parallel()

1373 1374 1375
	tester := newTester()
	defer tester.terminate()

1376
	// Create a small enough block chain to download
1377
	targetBlocks := blockCacheItems - 15
1378
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)
1379

1380
	// Set a sync init hook to catch progress changes
1381 1382 1383 1384 1385 1386 1387
	starting := make(chan struct{})
	progress := make(chan struct{})

	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1388
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1389 1390
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != 0 {
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, 0)
1391
	}
1392
	// Synchronise half the blocks and check initial progress
1393
	tester.newPeer("peer-half", protocol, hashes[targetBlocks/2:], headers, blocks, receipts)
1394 1395 1396 1397 1398
	pending := new(sync.WaitGroup)
	pending.Add(1)

	go func() {
		defer pending.Done()
1399
		if err := tester.sync("peer-half", nil, mode); err != nil {
E
Egon Elbre 已提交
1400
			panic(fmt.Sprintf("failed to synchronise blocks: %v", err))
1401 1402 1403
		}
	}()
	<-starting
1404 1405
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != uint64(targetBlocks/2+1) {
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, targetBlocks/2+1)
1406 1407 1408 1409
	}
	progress <- struct{}{}
	pending.Wait()

1410
	// Synchronise all the blocks and check continuation progress
1411
	tester.newPeer("peer-full", protocol, hashes, headers, blocks, receipts)
1412 1413 1414 1415
	pending.Add(1)

	go func() {
		defer pending.Done()
1416
		if err := tester.sync("peer-full", nil, mode); err != nil {
E
Egon Elbre 已提交
1417
			panic(fmt.Sprintf("failed to synchronise blocks: %v", err))
1418 1419 1420
		}
	}()
	<-starting
1421 1422
	if progress := tester.downloader.Progress(); progress.StartingBlock != uint64(targetBlocks/2+1) || progress.CurrentBlock != uint64(targetBlocks/2+1) || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Completing progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, targetBlocks/2+1, targetBlocks/2+1, targetBlocks)
1423 1424 1425
	}
	progress <- struct{}{}
	pending.Wait()
1426 1427

	// Check final progress after successful sync
1428 1429
	if progress := tester.downloader.Progress(); progress.StartingBlock != uint64(targetBlocks/2+1) || progress.CurrentBlock != uint64(targetBlocks) || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, targetBlocks/2+1, targetBlocks, targetBlocks)
1430
	}
1431 1432
}

1433
// Tests that synchronisation progress (origin block number and highest block
1434 1435
// number) is tracked and updated correctly in case of a fork (or manual head
// revertal).
1436 1437 1438 1439 1440 1441 1442 1443
func TestForkedSyncProgress62(t *testing.T)      { testForkedSyncProgress(t, 62, FullSync) }
func TestForkedSyncProgress63Full(t *testing.T)  { testForkedSyncProgress(t, 63, FullSync) }
func TestForkedSyncProgress63Fast(t *testing.T)  { testForkedSyncProgress(t, 63, FastSync) }
func TestForkedSyncProgress64Full(t *testing.T)  { testForkedSyncProgress(t, 64, FullSync) }
func TestForkedSyncProgress64Fast(t *testing.T)  { testForkedSyncProgress(t, 64, FastSync) }
func TestForkedSyncProgress64Light(t *testing.T) { testForkedSyncProgress(t, 64, LightSync) }

func testForkedSyncProgress(t *testing.T, protocol int, mode SyncMode) {
1444 1445
	t.Parallel()

1446 1447 1448
	tester := newTester()
	defer tester.terminate()

1449 1450
	// Create a forked chain to simulate origin revertal
	common, fork := MaxHashFetch, 2*MaxHashFetch
1451
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := tester.makeChainFork(common+fork, fork, tester.genesis, nil, true)
1452

1453
	// Set a sync init hook to catch progress changes
1454 1455 1456 1457 1458 1459 1460
	starting := make(chan struct{})
	progress := make(chan struct{})

	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1461
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1462 1463
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != 0 {
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, 0)
1464
	}
1465
	// Synchronise with one of the forks and check progress
1466
	tester.newPeer("fork A", protocol, hashesA, headersA, blocksA, receiptsA)
1467 1468 1469 1470 1471
	pending := new(sync.WaitGroup)
	pending.Add(1)

	go func() {
		defer pending.Done()
1472
		if err := tester.sync("fork A", nil, mode); err != nil {
E
Egon Elbre 已提交
1473
			panic(fmt.Sprintf("failed to synchronise blocks: %v", err))
1474 1475 1476
		}
	}()
	<-starting
1477 1478
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != uint64(len(hashesA)-1) {
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, len(hashesA)-1)
1479 1480 1481 1482 1483
	}
	progress <- struct{}{}
	pending.Wait()

	// Simulate a successful sync above the fork
1484
	tester.downloader.syncStatsChainOrigin = tester.downloader.syncStatsChainHeight
1485

1486
	// Synchronise with the second fork and check progress resets
1487
	tester.newPeer("fork B", protocol, hashesB, headersB, blocksB, receiptsB)
1488 1489 1490 1491
	pending.Add(1)

	go func() {
		defer pending.Done()
1492
		if err := tester.sync("fork B", nil, mode); err != nil {
E
Egon Elbre 已提交
1493
			panic(fmt.Sprintf("failed to synchronise blocks: %v", err))
1494 1495 1496
		}
	}()
	<-starting
1497 1498
	if progress := tester.downloader.Progress(); progress.StartingBlock != uint64(common) || progress.CurrentBlock != uint64(len(hashesA)-1) || progress.HighestBlock != uint64(len(hashesB)-1) {
		t.Fatalf("Forking progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, common, len(hashesA)-1, len(hashesB)-1)
1499 1500 1501
	}
	progress <- struct{}{}
	pending.Wait()
1502 1503

	// Check final progress after successful sync
1504 1505
	if progress := tester.downloader.Progress(); progress.StartingBlock != uint64(common) || progress.CurrentBlock != uint64(len(hashesB)-1) || progress.HighestBlock != uint64(len(hashesB)-1) {
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, common, len(hashesB)-1, len(hashesB)-1)
1506
	}
1507 1508
}

1509
// Tests that if synchronisation is aborted due to some failure, then the progress
1510 1511
// origin is not updated in the next sync cycle, as it should be considered the
// continuation of the previous sync and not a new instance.
1512 1513 1514 1515 1516 1517 1518 1519
func TestFailedSyncProgress62(t *testing.T)      { testFailedSyncProgress(t, 62, FullSync) }
func TestFailedSyncProgress63Full(t *testing.T)  { testFailedSyncProgress(t, 63, FullSync) }
func TestFailedSyncProgress63Fast(t *testing.T)  { testFailedSyncProgress(t, 63, FastSync) }
func TestFailedSyncProgress64Full(t *testing.T)  { testFailedSyncProgress(t, 64, FullSync) }
func TestFailedSyncProgress64Fast(t *testing.T)  { testFailedSyncProgress(t, 64, FastSync) }
func TestFailedSyncProgress64Light(t *testing.T) { testFailedSyncProgress(t, 64, LightSync) }

func testFailedSyncProgress(t *testing.T, protocol int, mode SyncMode) {
1520 1521
	t.Parallel()

1522 1523 1524
	tester := newTester()
	defer tester.terminate()

1525
	// Create a small enough block chain to download
1526
	targetBlocks := blockCacheItems - 15
1527
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks, 0, tester.genesis, nil, false)
1528

1529
	// Set a sync init hook to catch progress changes
1530 1531 1532 1533 1534 1535 1536
	starting := make(chan struct{})
	progress := make(chan struct{})

	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1537
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1538 1539
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != 0 {
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, 0)
1540 1541
	}
	// Attempt a full sync with a faulty peer
1542
	tester.newPeer("faulty", protocol, hashes, headers, blocks, receipts)
1543
	missing := targetBlocks / 2
1544
	delete(tester.peerHeaders["faulty"], hashes[missing])
1545
	delete(tester.peerBlocks["faulty"], hashes[missing])
1546
	delete(tester.peerReceipts["faulty"], hashes[missing])
1547 1548 1549 1550 1551 1552

	pending := new(sync.WaitGroup)
	pending.Add(1)

	go func() {
		defer pending.Done()
1553
		if err := tester.sync("faulty", nil, mode); err == nil {
E
Egon Elbre 已提交
1554
			panic("succeeded faulty synchronisation")
1555 1556 1557
		}
	}()
	<-starting
1558 1559
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, targetBlocks)
1560 1561 1562 1563
	}
	progress <- struct{}{}
	pending.Wait()

1564
	// Synchronise with a good peer and check that the progress origin remind the same after a failure
1565
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
1566 1567 1568 1569
	pending.Add(1)

	go func() {
		defer pending.Done()
1570
		if err := tester.sync("valid", nil, mode); err != nil {
E
Egon Elbre 已提交
1571
			panic(fmt.Sprintf("failed to synchronise blocks: %v", err))
1572 1573 1574
		}
	}()
	<-starting
1575 1576
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock > uint64(targetBlocks/2) || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Completing progress mismatch: have %v/%v/%v, want %v/0-%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, targetBlocks/2, targetBlocks)
1577 1578 1579
	}
	progress <- struct{}{}
	pending.Wait()
1580 1581

	// Check final progress after successful sync
1582 1583
	if progress := tester.downloader.Progress(); progress.StartingBlock > uint64(targetBlocks/2) || progress.CurrentBlock != uint64(targetBlocks) || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want 0-%v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, targetBlocks/2, targetBlocks, targetBlocks)
1584
	}
1585 1586 1587
}

// Tests that if an attacker fakes a chain height, after the attack is detected,
1588 1589 1590 1591 1592 1593 1594 1595 1596
// the progress height is successfully reduced at the next sync invocation.
func TestFakedSyncProgress62(t *testing.T)      { testFakedSyncProgress(t, 62, FullSync) }
func TestFakedSyncProgress63Full(t *testing.T)  { testFakedSyncProgress(t, 63, FullSync) }
func TestFakedSyncProgress63Fast(t *testing.T)  { testFakedSyncProgress(t, 63, FastSync) }
func TestFakedSyncProgress64Full(t *testing.T)  { testFakedSyncProgress(t, 64, FullSync) }
func TestFakedSyncProgress64Fast(t *testing.T)  { testFakedSyncProgress(t, 64, FastSync) }
func TestFakedSyncProgress64Light(t *testing.T) { testFakedSyncProgress(t, 64, LightSync) }

func testFakedSyncProgress(t *testing.T, protocol int, mode SyncMode) {
1597 1598
	t.Parallel()

1599 1600 1601
	tester := newTester()
	defer tester.terminate()

1602
	// Create a small block chain
1603
	targetBlocks := blockCacheItems - 15
1604
	hashes, headers, blocks, receipts := tester.makeChain(targetBlocks+3, 0, tester.genesis, nil, false)
1605

1606
	// Set a sync init hook to catch progress changes
1607 1608 1609 1610 1611 1612 1613
	starting := make(chan struct{})
	progress := make(chan struct{})

	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1614
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1615 1616
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != 0 {
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, 0)
1617 1618
	}
	//  Create and sync with an attacker that promises a higher chain than available
1619
	tester.newPeer("attack", protocol, hashes, headers, blocks, receipts)
1620
	for i := 1; i < 3; i++ {
1621
		delete(tester.peerHeaders["attack"], hashes[i])
1622
		delete(tester.peerBlocks["attack"], hashes[i])
1623
		delete(tester.peerReceipts["attack"], hashes[i])
1624 1625 1626 1627 1628 1629 1630
	}

	pending := new(sync.WaitGroup)
	pending.Add(1)

	go func() {
		defer pending.Done()
1631
		if err := tester.sync("attack", nil, mode); err == nil {
E
Egon Elbre 已提交
1632
			panic("succeeded attacker synchronisation")
1633 1634 1635
		}
	}()
	<-starting
1636 1637
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock != 0 || progress.HighestBlock != uint64(targetBlocks+3) {
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, 0, targetBlocks+3)
1638 1639 1640 1641
	}
	progress <- struct{}{}
	pending.Wait()

1642
	// Synchronise with a good peer and check that the progress height has been reduced to the true value
1643
	tester.newPeer("valid", protocol, hashes[3:], headers, blocks, receipts)
1644 1645 1646 1647
	pending.Add(1)

	go func() {
		defer pending.Done()
1648
		if err := tester.sync("valid", nil, mode); err != nil {
E
Egon Elbre 已提交
1649
			panic(fmt.Sprintf("failed to synchronise blocks: %v", err))
1650 1651 1652
		}
	}()
	<-starting
1653 1654
	if progress := tester.downloader.Progress(); progress.StartingBlock != 0 || progress.CurrentBlock > uint64(targetBlocks) || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Completing progress mismatch: have %v/%v/%v, want %v/0-%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, 0, targetBlocks, targetBlocks)
1655 1656 1657
	}
	progress <- struct{}{}
	pending.Wait()
1658 1659

	// Check final progress after successful sync
1660 1661
	if progress := tester.downloader.Progress(); progress.StartingBlock > uint64(targetBlocks) || progress.CurrentBlock != uint64(targetBlocks) || progress.HighestBlock != uint64(targetBlocks) {
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want 0-%v/%v/%v", progress.StartingBlock, progress.CurrentBlock, progress.HighestBlock, targetBlocks, targetBlocks, targetBlocks)
1662
	}
1663
}
1664 1665 1666

// This test reproduces an issue where unexpected deliveries would
// block indefinitely if they arrived at the right time.
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
// We use data driven subtests to manage this so that it will be parallel on its own
// and not with the other tests, avoiding intermittent failures.
func TestDeliverHeadersHang(t *testing.T) {
	testCases := []struct {
		protocol int
		syncMode SyncMode
	}{
		{62, FullSync},
		{63, FullSync},
		{63, FastSync},
		{64, FullSync},
		{64, FastSync},
		{64, LightSync},
	}
	for _, tc := range testCases {
		t.Run(fmt.Sprintf("protocol %d mode %v", tc.protocol, tc.syncMode), func(t *testing.T) {
			testDeliverHeadersHang(t, tc.protocol, tc.syncMode)
		})
	}
}
1687

1688 1689 1690
type floodingTestPeer struct {
	peer   Peer
	tester *downloadTester
1691
	pend   sync.WaitGroup
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
}

func (ftp *floodingTestPeer) Head() (common.Hash, *big.Int) { return ftp.peer.Head() }
func (ftp *floodingTestPeer) RequestHeadersByHash(hash common.Hash, count int, skip int, reverse bool) error {
	return ftp.peer.RequestHeadersByHash(hash, count, skip, reverse)
}
func (ftp *floodingTestPeer) RequestBodies(hashes []common.Hash) error {
	return ftp.peer.RequestBodies(hashes)
}
func (ftp *floodingTestPeer) RequestReceipts(hashes []common.Hash) error {
	return ftp.peer.RequestReceipts(hashes)
}
func (ftp *floodingTestPeer) RequestNodeData(hashes []common.Hash) error {
	return ftp.peer.RequestNodeData(hashes)
}

func (ftp *floodingTestPeer) RequestHeadersByNumber(from uint64, count, skip int, reverse bool) error {
	deliveriesDone := make(chan struct{}, 500)
	for i := 0; i < cap(deliveriesDone); i++ {
		peer := fmt.Sprintf("fake-peer%d", i)
1712 1713
		ftp.pend.Add(1)

1714 1715 1716
		go func() {
			ftp.tester.downloader.DeliverHeaders(peer, []*types.Header{{}, {}, {}, {}})
			deliveriesDone <- struct{}{}
1717
			ftp.pend.Done()
1718 1719 1720 1721 1722
		}()
	}
	// Deliver the actual requested headers.
	go ftp.peer.RequestHeadersByNumber(from, count, skip, reverse)
	// None of the extra deliveries should block.
1723
	timeout := time.After(60 * time.Second)
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
	for i := 0; i < cap(deliveriesDone); i++ {
		select {
		case <-deliveriesDone:
		case <-timeout:
			panic("blocked")
		}
	}
	return nil
}

1734 1735
func testDeliverHeadersHang(t *testing.T, protocol int, mode SyncMode) {
	t.Parallel()
1736 1737 1738 1739 1740

	master := newTester()
	defer master.terminate()

	hashes, headers, blocks, receipts := master.makeChain(5, 0, master.genesis, nil, false)
1741 1742
	for i := 0; i < 200; i++ {
		tester := newTester()
1743 1744
		tester.peerDb = master.peerDb

1745 1746 1747
		tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
		// Whenever the downloader requests headers, flood it with
		// a lot of unrequested header deliveries.
1748
		tester.downloader.peers.peers["peer"].peer = &floodingTestPeer{
1749 1750
			peer:   tester.downloader.peers.peers["peer"].peer,
			tester: tester,
1751 1752
		}
		if err := tester.sync("peer", nil, mode); err != nil {
1753
			t.Errorf("test %d: sync failed: %v", i, err)
1754
		}
1755
		tester.terminate()
1756

1757 1758
		// Flush all goroutines to prevent messing with subsequent tests
		tester.downloader.peers.peers["peer"].peer.(*floodingTestPeer).pend.Wait()
1759 1760
	}
}