downloader_test.go 72.8 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/core"
30
	"github.com/ethereum/go-ethereum/core/state"
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 42 43
	testdb, _   = ethdb.NewMemDatabase()
	testKey, _  = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
	testAddress = crypto.PubkeyToAddress(testKey.PublicKey)
	genesis     = core.GenesisBlockForTesting(testdb, testAddress, big.NewInt(1000000000))
44
)
45

46
// Reduce some of the parameters to make the tester faster.
47
func init() {
48
	MaxForkAncestry = uint64(10000)
49 50 51
	blockCacheLimit = 1024
}

52 53 54 55
// 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.
56
func 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) {
57
	// Generate the block chain
58
	blocks, receipts := core.GenerateChain(parent, testdb, n, func(i int, block *core.BlockGen) {
59 60
		block.SetCoinbase(common.Address{seed})

61 62 63 64
		// If a heavy chain is requested, delay blocks to raise difficulty
		if heavy {
			block.OffsetTime(-1)
		}
65 66 67 68 69 70 71 72 73
		// If the block number is multiple of 3, send a bonus transaction to the miner
		if parent == genesis && i%3 == 0 {
			tx, err := types.NewTransaction(block.TxNonce(testAddress), common.Address{seed}, big.NewInt(1000), params.TxGas, nil, nil).SignECDSA(testKey)
			if err != nil {
				panic(err)
			}
			block.AddTx(tx)
		}
		// If the block number is a multiple of 5, add a bonus uncle to the block
74 75 76 77 78
		if i > 0 && i%5 == 0 {
			block.AddUncle(&types.Header{
				ParentHash: block.PrevBlock(i - 1).Hash(),
				Number:     big.NewInt(block.Number().Int64() - 1),
			})
79
		}
80
	})
81
	// Convert the block-chain into a hash-chain and header/block maps
82 83
	hashes := make([]common.Hash, n+1)
	hashes[len(hashes)-1] = parent.Hash()
84 85 86 87

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

88 89
	blockm := make(map[common.Hash]*types.Block, n+1)
	blockm[parent.Hash()] = parent
90

91 92 93
	receiptm := make(map[common.Hash]types.Receipts, n+1)
	receiptm[parent.Hash()] = parentReceipts

94 95
	for i, b := range blocks {
		hashes[len(hashes)-i-2] = b.Hash()
96
		headerm[b.Hash()] = b.Header()
97
		blockm[b.Hash()] = b
98
		receiptm[b.Hash()] = receipts[i]
99
	}
100
	return hashes, headerm, blockm, receiptm
101 102 103 104
}

// 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.
105
func 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) {
106
	// Create the common suffix
107
	hashes, headers, blocks, receipts := makeChain(n-f, 0, parent, parentReceipts, false)
108

109 110
	// Create the forks, making the second heavyer if non balanced forks were requested
	hashes1, headers1, blocks1, receipts1 := makeChain(f, 1, blocks[hashes[0]], receipts[hashes[0]], false)
111 112
	hashes1 = append(hashes1, hashes[1:]...)

113 114 115 116 117
	heavy := false
	if !balanced {
		heavy = true
	}
	hashes2, headers2, blocks2, receipts2 := makeChain(f, 2, blocks[hashes[0]], receipts[hashes[0]], heavy)
118 119 120 121 122 123 124 125 126 127
	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
	}
128 129 130 131 132
	for hash, receipt := range receipts {
		receipts1[hash] = receipt
		receipts2[hash] = receipt
	}
	return hashes1, hashes2, headers1, headers2, blocks1, blocks2, receipts1, receipts2
133 134
}

135
// downloadTester is a test simulator for mocking out local block chain.
136
type downloadTester struct {
137
	stateDb    ethdb.Database
138 139
	downloader *Downloader

140 141 142 143 144 145 146 147 148 149 150
	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
151 152

	lock sync.RWMutex
153 154
}

155
// newTester creates a new downloader test mocker.
156
func newTester() *downloadTester {
157
	tester := &downloadTester{
158
		ownHashes:    []common.Hash{genesis.Hash()},
159
		ownHeaders:   map[common.Hash]*types.Header{genesis.Hash(): genesis.Header()},
160
		ownBlocks:    map[common.Hash]*types.Block{genesis.Hash(): genesis},
161
		ownReceipts:  map[common.Hash]types.Receipts{genesis.Hash(): nil},
162 163
		ownChainTd:   map[common.Hash]*big.Int{genesis.Hash(): genesis.Difficulty()},
		peerHashes:   make(map[string][]common.Hash),
164
		peerHeaders:  make(map[string]map[common.Hash]*types.Header),
165
		peerBlocks:   make(map[string]map[common.Hash]*types.Block),
166
		peerReceipts: make(map[string]map[common.Hash]types.Receipts),
167
		peerChainTds: make(map[string]map[common.Hash]*big.Int),
168
	}
169
	tester.stateDb, _ = ethdb.NewMemDatabase()
170 171
	tester.stateDb.Put(genesis.Root().Bytes(), []byte{0x00})

172
	tester.downloader = New(tester.stateDb, new(event.TypeMux), tester.hasHeader, tester.hasBlock, tester.getHeader,
173
		tester.getBlock, tester.headHeader, tester.headBlock, tester.headFastBlock, tester.commitHeadBlock, tester.getTd,
174
		tester.insertHeaders, tester.insertBlocks, tester.insertReceipts, tester.rollback, tester.dropPeer)
175 176 177 178

	return tester
}

179
// sync starts synchronizing with a remote peer, blocking until it completes.
180
func (dl *downloadTester) sync(id string, td *big.Int, mode SyncMode) error {
181
	dl.lock.RLock()
182 183 184 185
	hash := dl.peerHashes[id][0]
	// If no particular TD was requested, load from the peer's blockchain
	if td == nil {
		td = big.NewInt(1)
186 187
		if diff, ok := dl.peerChainTds[id][hash]; ok {
			td = diff
188 189
		}
	}
190
	dl.lock.RUnlock()
191
	return dl.downloader.synchronise(id, hash, td, mode)
O
obscuren 已提交
192 193
}

194 195 196 197 198
// hasHeader checks if a header is present in the testers canonical chain.
func (dl *downloadTester) hasHeader(hash common.Hash) bool {
	return dl.getHeader(hash) != nil
}

199
// hasBlock checks if a block and associated state is present in the testers canonical chain.
200
func (dl *downloadTester) hasBlock(hash common.Hash) bool {
201 202 203 204 205 206
	block := dl.getBlock(hash)
	if block == nil {
		return false
	}
	_, err := dl.stateDb.Get(block.Root().Bytes())
	return err == nil
207 208 209 210
}

// getHeader retrieves a header from the testers canonical chain.
func (dl *downloadTester) getHeader(hash common.Hash) *types.Header {
211 212 213
	dl.lock.RLock()
	defer dl.lock.RUnlock()

214
	return dl.ownHeaders[hash]
215 216
}

217
// getBlock retrieves a block from the testers canonical chain.
218
func (dl *downloadTester) getBlock(hash common.Hash) *types.Block {
219 220 221
	dl.lock.RLock()
	defer dl.lock.RUnlock()

222 223 224
	return dl.ownBlocks[hash]
}

225 226 227 228 229
// headHeader retrieves the current head header from the canonical chain.
func (dl *downloadTester) headHeader() *types.Header {
	dl.lock.RLock()
	defer dl.lock.RUnlock()

230
	for i := len(dl.ownHashes) - 1; i >= 0; i-- {
231
		if header := dl.ownHeaders[dl.ownHashes[i]]; header != nil {
232 233 234
			return header
		}
	}
235
	return genesis.Header()
236 237
}

238 239
// headBlock retrieves the current head block from the canonical chain.
func (dl *downloadTester) headBlock() *types.Block {
240 241 242
	dl.lock.RLock()
	defer dl.lock.RUnlock()

243
	for i := len(dl.ownHashes) - 1; i >= 0; i-- {
244
		if block := dl.ownBlocks[dl.ownHashes[i]]; block != nil {
245 246 247
			if _, err := dl.stateDb.Get(block.Root().Bytes()); err == nil {
				return block
			}
248 249
		}
	}
250
	return genesis
251 252
}

253 254 255 256 257 258
// headFastBlock retrieves the current head fast-sync block from the canonical chain.
func (dl *downloadTester) headFastBlock() *types.Block {
	dl.lock.RLock()
	defer dl.lock.RUnlock()

	for i := len(dl.ownHashes) - 1; i >= 0; i-- {
259
		if block := dl.ownBlocks[dl.ownHashes[i]]; block != nil {
260
			return block
261 262
		}
	}
263 264 265 266 267 268 269 270 271 272 273
	return genesis
}

// commitHeadBlock manually sets the head block to a given hash.
func (dl *downloadTester) commitHeadBlock(hash common.Hash) error {
	// For now only check that the state trie is correct
	if block := dl.getBlock(hash); block != nil {
		_, err := trie.NewSecure(block.Root(), dl.stateDb)
		return err
	}
	return fmt.Errorf("non existent block: %x", hash[:4])
274 275
}

276 277
// getTd retrieves the block's total difficulty from the canonical chain.
func (dl *downloadTester) getTd(hash common.Hash) *big.Int {
278 279 280
	dl.lock.RLock()
	defer dl.lock.RUnlock()

281 282 283
	return dl.ownChainTd[hash]
}

284
// insertHeaders injects a new batch of headers into the simulated chain.
285
func (dl *downloadTester) insertHeaders(headers []*types.Header, checkFreq int) (int, error) {
286 287 288
	dl.lock.Lock()
	defer dl.lock.Unlock()

L
Leif Jurvetson 已提交
289
	// Do a quick check, as the blockchain.InsertHeaderChain doesn't insert anything in case of errors
290 291 292 293 294 295 296 297 298
	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
299
	for i, header := range headers {
300 301 302
		if _, ok := dl.ownHeaders[header.Hash()]; ok {
			continue
		}
303 304 305 306 307
		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
308
		dl.ownChainTd[header.Hash()] = new(big.Int).Add(dl.ownChainTd[header.ParentHash], header.Difficulty)
309 310 311 312 313 314
	}
	return len(headers), nil
}

// insertBlocks injects a new batch of blocks into the simulated chain.
func (dl *downloadTester) insertBlocks(blocks types.Blocks) (int, error) {
315 316 317
	dl.lock.Lock()
	defer dl.lock.Unlock()

318
	for i, block := range blocks {
319
		if parent, ok := dl.ownBlocks[block.ParentHash()]; !ok {
320
			return i, errors.New("unknown parent")
321 322
		} else if _, err := dl.stateDb.Get(parent.Root().Bytes()); err != nil {
			return i, fmt.Errorf("unknown parent state %x: %v", parent.Root(), err)
323
		}
324 325 326 327
		if _, ok := dl.ownHeaders[block.Hash()]; !ok {
			dl.ownHashes = append(dl.ownHashes, block.Hash())
			dl.ownHeaders[block.Hash()] = block.Header()
		}
328
		dl.ownBlocks[block.Hash()] = block
329 330
		dl.stateDb.Put(block.Root().Bytes(), []byte{0x00})
		dl.ownChainTd[block.Hash()] = new(big.Int).Add(dl.ownChainTd[block.ParentHash()], block.Difficulty())
331 332 333 334
	}
	return len(blocks), nil
}

335 336
// insertReceipts injects a new batch of blocks into the simulated chain.
func (dl *downloadTester) insertReceipts(blocks types.Blocks, receipts []types.Receipts) (int, error) {
337 338 339 340
	dl.lock.Lock()
	defer dl.lock.Unlock()

	for i := 0; i < len(blocks) && i < len(receipts); i++ {
341 342 343
		if _, ok := dl.ownHeaders[blocks[i].Hash()]; !ok {
			return i, errors.New("unknown owner")
		}
344 345 346 347
		if _, ok := dl.ownBlocks[blocks[i].ParentHash()]; !ok {
			return i, errors.New("unknown parent")
		}
		dl.ownBlocks[blocks[i].Hash()] = blocks[i]
348
		dl.ownReceipts[blocks[i].Hash()] = receipts[i]
349 350 351 352
	}
	return len(blocks), nil
}

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
// rollback removes some recently added elements from the chain.
func (dl *downloadTester) rollback(hashes []common.Hash) {
	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])
	}
}

369
// newPeer registers a new block download source into the downloader.
370 371
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)
372 373 374 375 376
}

// 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.
377
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 {
378 379 380
	dl.lock.Lock()
	defer dl.lock.Unlock()

381 382 383
	var err error
	switch version {
	case 61:
384
		err = dl.downloader.RegisterPeer(id, version, hashes[0], dl.peerGetRelHashesFn(id, delay), dl.peerGetAbsHashesFn(id, delay), dl.peerGetBlocksFn(id, delay), nil, nil, nil, nil, nil)
385
	case 62:
386
		err = dl.downloader.RegisterPeer(id, version, hashes[0], nil, nil, nil, dl.peerGetRelHeadersFn(id, delay), dl.peerGetAbsHeadersFn(id, delay), dl.peerGetBodiesFn(id, delay), nil, nil)
387
	case 63:
388
		err = dl.downloader.RegisterPeer(id, version, hashes[0], nil, nil, nil, dl.peerGetRelHeadersFn(id, delay), dl.peerGetAbsHeadersFn(id, delay), dl.peerGetBodiesFn(id, delay), dl.peerGetReceiptsFn(id, delay), dl.peerGetNodeDataFn(id, delay))
389
	case 64:
390
		err = dl.downloader.RegisterPeer(id, version, hashes[0], nil, nil, nil, dl.peerGetRelHeadersFn(id, delay), dl.peerGetAbsHeadersFn(id, delay), dl.peerGetBodiesFn(id, delay), dl.peerGetReceiptsFn(id, delay), dl.peerGetNodeDataFn(id, delay))
391
	}
392
	if err == nil {
393
		// Assign the owned hashes, headers and blocks to the peer (deep copy)
394 395
		dl.peerHashes[id] = make([]common.Hash, len(hashes))
		copy(dl.peerHashes[id], hashes)
396

397
		dl.peerHeaders[id] = make(map[common.Hash]*types.Header)
398
		dl.peerBlocks[id] = make(map[common.Hash]*types.Block)
399
		dl.peerReceipts[id] = make(map[common.Hash]types.Receipts)
400
		dl.peerChainTds[id] = make(map[common.Hash]*big.Int)
401

402 403 404 405 406 407 408 409 410 411 412 413 414
		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]

415 416 417 418 419 420
			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])
				}
			}
421 422
			if block, ok := blocks[hash]; ok {
				dl.peerBlocks[id][hash] = block
423 424
				if _, ok := dl.peerBlocks[id][block.ParentHash()]; ok {
					dl.peerChainTds[id][hash] = new(big.Int).Add(block.Difficulty(), dl.peerChainTds[id][block.ParentHash()])
425 426
				}
			}
427 428 429
			if receipt, ok := receipts[hash]; ok {
				dl.peerReceipts[id][hash] = receipt
			}
430
		}
431 432
	}
	return err
433 434
}

435 436
// dropPeer simulates a hard peer removal from the connection pool.
func (dl *downloadTester) dropPeer(id string) {
437 438 439
	dl.lock.Lock()
	defer dl.lock.Unlock()

440
	delete(dl.peerHashes, id)
441
	delete(dl.peerHeaders, id)
442
	delete(dl.peerBlocks, id)
443
	delete(dl.peerChainTds, id)
444 445 446 447

	dl.downloader.UnregisterPeer(id)
}

448
// peerGetRelHashesFn constructs a GetHashes function associated with a specific
449 450
// peer in the download tester. The returned function can be used to retrieve
// batches of hashes from the particularly requested peer.
451
func (dl *downloadTester) peerGetRelHashesFn(id string, delay time.Duration) func(head common.Hash) error {
452
	return func(head common.Hash) error {
453 454
		time.Sleep(delay)

455 456 457
		dl.lock.RLock()
		defer dl.lock.RUnlock()

458 459
		// Gather the next batch of hashes
		hashes := dl.peerHashes[id]
460
		result := make([]common.Hash, 0, MaxHashFetch)
461 462
		for i, hash := range hashes {
			if hash == head {
463
				i++
464 465 466 467 468
				for len(result) < cap(result) && i < len(hashes) {
					result = append(result, hashes[i])
					i++
				}
				break
469 470
			}
		}
471 472 473
		// Delay delivery a bit to allow attacks to unfold
		go func() {
			time.Sleep(time.Millisecond)
474
			dl.downloader.DeliverHashes(id, result)
475 476
		}()
		return nil
477
	}
478 479
}

480 481 482
// peerGetAbsHashesFn constructs a GetHashesFromNumber function associated with
// a particular peer in the download tester. The returned function can be used to
// retrieve batches of hashes from the particularly requested peer.
483
func (dl *downloadTester) peerGetAbsHashesFn(id string, delay time.Duration) func(uint64, int) error {
484 485 486
	return func(head uint64, count int) error {
		time.Sleep(delay)

487 488 489
		dl.lock.RLock()
		defer dl.lock.RUnlock()

490 491
		// Gather the next batch of hashes
		hashes := dl.peerHashes[id]
492 493
		result := make([]common.Hash, 0, count)
		for i := 0; i < count && len(hashes)-int(head)-1-i >= 0; i++ {
494 495 496 497 498
			result = append(result, hashes[len(hashes)-int(head)-1-i])
		}
		// Delay delivery a bit to allow attacks to unfold
		go func() {
			time.Sleep(time.Millisecond)
499
			dl.downloader.DeliverHashes(id, result)
500 501 502 503 504
		}()
		return nil
	}
}

505 506 507
// peerGetBlocksFn constructs a getBlocks function associated with a particular
// peer in the download tester. The returned function can be used to retrieve
// batches of blocks from the particularly requested peer.
508
func (dl *downloadTester) peerGetBlocksFn(id string, delay time.Duration) func([]common.Hash) error {
509
	return func(hashes []common.Hash) error {
510
		time.Sleep(delay)
511 512 513 514

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

515 516
		blocks := dl.peerBlocks[id]
		result := make([]*types.Block, 0, len(hashes))
517
		for _, hash := range hashes {
518 519
			if block, ok := blocks[hash]; ok {
				result = append(result, block)
520
			}
521
		}
522
		go dl.downloader.DeliverBlocks(id, result)
523 524 525 526 527

		return nil
	}
}

528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
// peerGetRelHeadersFn constructs a GetBlockHeaders function based on a hashed
// 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.
func (dl *downloadTester) peerGetRelHeadersFn(id string, delay time.Duration) func(common.Hash, int, int, bool) error {
	return func(origin common.Hash, amount int, skip int, reverse bool) error {
		// Find the canonical number of the hash
		dl.lock.RLock()
		number := uint64(0)
		for num, hash := range dl.peerHashes[id] {
			if hash == origin {
				number = uint64(len(dl.peerHashes[id]) - num - 1)
				break
			}
		}
		dl.lock.RUnlock()

		// Use the absolute header fetcher to satisfy the query
		return dl.peerGetAbsHeadersFn(id, delay)(number, amount, skip, reverse)
	}
}

549 550 551 552 553 554 555
// peerGetAbsHeadersFn constructs a GetBlockHeaders function based on a numbered
// 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.
func (dl *downloadTester) peerGetAbsHeadersFn(id string, delay time.Duration) func(uint64, int, int, bool) error {
	return func(origin uint64, amount int, skip int, reverse bool) error {
		time.Sleep(delay)

556 557 558
		dl.lock.RLock()
		defer dl.lock.RUnlock()

559
		// Gather the next batch of headers
560
		hashes := dl.peerHashes[id]
561
		headers := dl.peerHeaders[id]
562
		result := make([]*types.Header, 0, amount)
563 564
		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 {
565
				result = append(result, header)
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
			}
		}
		// Delay delivery a bit to allow attacks to unfold
		go func() {
			time.Sleep(time.Millisecond)
			dl.downloader.DeliverHeaders(id, result)
		}()
		return nil
	}
}

// peerGetBodiesFn constructs a getBlockBodies method associated with a particular
// peer in the download tester. The returned function can be used to retrieve
// batches of block bodies from the particularly requested peer.
func (dl *downloadTester) peerGetBodiesFn(id string, delay time.Duration) func([]common.Hash) error {
	return func(hashes []common.Hash) error {
		time.Sleep(delay)
583 584 585 586

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

587 588 589 590 591 592 593 594 595 596 597 598
		blocks := dl.peerBlocks[id]

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

		for _, hash := range hashes {
			if block, ok := blocks[hash]; ok {
				transactions = append(transactions, block.Transactions())
				uncles = append(uncles, block.Uncles())
			}
		}
		go dl.downloader.DeliverBodies(id, transactions, uncles)
599 600 601 602 603

		return nil
	}
}

604 605 606 607 608 609 610 611 612 613
// peerGetReceiptsFn constructs a getReceipts method associated with a particular
// peer in the download tester. The returned function can be used to retrieve
// batches of block receipts from the particularly requested peer.
func (dl *downloadTester) peerGetReceiptsFn(id string, delay time.Duration) func([]common.Hash) error {
	return func(hashes []common.Hash) error {
		time.Sleep(delay)

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

614
		receipts := dl.peerReceipts[id]
615

616
		results := make([][]*types.Receipt, 0, len(hashes))
617
		for _, hash := range hashes {
618 619
			if receipt, ok := receipts[hash]; ok {
				results = append(results, receipt)
620 621
			}
		}
622
		go dl.downloader.DeliverReceipts(id, results)
623 624 625 626 627

		return nil
	}
}

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
// peerGetNodeDataFn constructs a getNodeData method associated with a particular
// peer in the download tester. The returned function can be used to retrieve
// batches of node state data from the particularly requested peer.
func (dl *downloadTester) peerGetNodeDataFn(id string, delay time.Duration) func([]common.Hash) error {
	return func(hashes []common.Hash) error {
		time.Sleep(delay)

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

		results := make([][]byte, 0, len(hashes))
		for _, hash := range hashes {
			if data, err := testdb.Get(hash.Bytes()); err == nil {
				results = append(results, data)
			}
		}
		go dl.downloader.DeliverNodeData(id, results)

		return nil
	}
}

650 651 652
// 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) {
653 654 655 656 657 658 659
	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
660 661 662 663 664 665 666 667
	headers, blocks := lengths[0], lengths[0]

	minReceipts, maxReceipts := lengths[0]-fsMinFullBlocks-fsPivotInterval, lengths[0]-fsMinFullBlocks
	if minReceipts < 0 {
		minReceipts = 1
	}
	if maxReceipts < 0 {
		maxReceipts = 1
668 669 670 671 672
	}
	// Update the counters for each subsequent fork
	for _, length := range lengths[1:] {
		headers += length - common
		blocks += length - common
673 674 675

		minReceipts += length - common - fsMinFullBlocks - fsPivotInterval
		maxReceipts += length - common - fsMinFullBlocks
676
	}
677 678
	switch tester.downloader.mode {
	case FullSync:
679
		minReceipts, maxReceipts = 1, 1
680
	case LightSync:
681
		blocks, minReceipts, maxReceipts = 1, 1, 1
682 683 684 685 686 687 688
	}
	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)
	}
689 690
	if rs := len(tester.ownReceipts); rs < minReceipts || rs > maxReceipts {
		t.Fatalf("synchronised receipts mismatch: have %v, want between [%v, %v]", rs, minReceipts, maxReceipts)
691
	}
692 693
	// Verify the state trie too for fast syncs
	if tester.downloader.mode == FastSync {
694 695 696 697 698 699 700 701 702
		index := 0
		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 {
			if statedb, err := state.New(tester.ownHeaders[tester.ownHashes[index]].Root, tester.stateDb); statedb == nil || err != nil {
				t.Fatalf("state reconstruction failed: %v", err)
703 704 705
			}
		}
	}
706 707
}

708 709 710
// 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.
711 712 713 714 715 716 717 718 719
func TestCanonicalSynchronisation61(t *testing.T)      { testCanonicalSynchronisation(t, 61, FullSync) }
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) {
720 721
	t.Parallel()

722 723
	// Create a small enough block chain to download
	targetBlocks := blockCacheLimit - 15
724
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
725

726
	tester := newTester()
727
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
728

729
	// Synchronise with the peer and make sure all relevant data was retrieved
730
	if err := tester.sync("peer", nil, mode); err != nil {
731
		t.Fatalf("failed to synchronise blocks: %v", err)
732
	}
733
	assertOwnChain(t, tester, targetBlocks+1)
734 735
}

736 737
// Tests that if a large batch of blocks are being downloaded, it is throttled
// until the cached blocks are retrieved.
738 739 740 741 742 743 744 745
func TestThrottling61(t *testing.T)     { testThrottling(t, 61, FullSync) }
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) {
746 747
	// Create a long block chain to download and the tester
	targetBlocks := 8 * blockCacheLimit
748
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
749

750
	tester := newTester()
751
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
752

753
	// Wrap the importer to allow stepping
754
	blocked, proceed := uint32(0), make(chan struct{})
755 756
	tester.downloader.chainInsertHook = func(results []*fetchResult) {
		atomic.StoreUint32(&blocked, uint32(len(results)))
757
		<-proceed
758
	}
759 760 761
	// Start a synchronisation concurrently
	errc := make(chan error)
	go func() {
762
		errc <- tester.sync("peer", nil, mode)
763 764
	}()
	// Iteratively take some blocks, always checking the retrieval count
765 766 767 768 769 770 771 772
	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
		}
773
		// Wait a bit for sync to throttle itself
774
		var cached, frozen int
775
		for start := time.Now(); time.Since(start) < 3*time.Second; {
776
			time.Sleep(25 * time.Millisecond)
777

778 779
			tester.lock.Lock()
			tester.downloader.queue.lock.Lock()
780 781 782
			cached = len(tester.downloader.queue.blockDonePool)
			if mode == FastSync {
				if receipts := len(tester.downloader.queue.receiptDonePool); receipts < cached {
783 784 785
					if tester.downloader.queue.resultCache[receipts].Header.Number.Uint64() < tester.downloader.queue.fastSyncPivot {
						cached = receipts
					}
786 787
				}
			}
788 789
			frozen = int(atomic.LoadUint32(&blocked))
			retrieved = len(tester.ownBlocks)
790 791
			tester.downloader.queue.lock.Unlock()
			tester.lock.Unlock()
792

793
			if cached == blockCacheLimit || retrieved+cached+frozen == targetBlocks+1 {
794 795 796
				break
			}
		}
797 798
		// Make sure we filled up the cache, then exhaust it
		time.Sleep(25 * time.Millisecond) // give it a chance to screw up
799 800 801 802 803 804

		tester.lock.RLock()
		retrieved = len(tester.ownBlocks)
		tester.lock.RUnlock()
		if cached != blockCacheLimit && retrieved+cached+frozen != targetBlocks+1 {
			t.Fatalf("block count mismatch: have %v, want %v (owned %v, blocked %v, target %v)", cached, blockCacheLimit, retrieved, frozen, targetBlocks+1)
805
		}
806 807 808 809
		// Permit the blocked blocks to import
		if atomic.LoadUint32(&blocked) > 0 {
			atomic.StoreUint32(&blocked, uint32(0))
			proceed <- struct{}{}
810
		}
811 812
	}
	// Check that we haven't pulled more blocks than available
813
	assertOwnChain(t, tester, targetBlocks+1)
814 815
	if err := <-errc; err != nil {
		t.Fatalf("block synchronization failed: %v", err)
816 817
	}
}
818

819 820 821
// 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.
822 823 824 825 826 827 828 829 830
func TestForkedSync61(t *testing.T)      { testForkedSync(t, 61, FullSync) }
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) {
831 832
	t.Parallel()

833 834
	// Create a long enough forked chain
	common, fork := MaxHashFetch, 2*MaxHashFetch
835
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := makeChainFork(common+fork, fork, genesis, nil, true)
836

837
	tester := newTester()
838 839
	tester.newPeer("fork A", protocol, hashesA, headersA, blocksA, receiptsA)
	tester.newPeer("fork B", protocol, hashesB, headersB, blocksB, receiptsB)
840 841

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

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

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
// Tests that synchronising against a much shorter but much heavyer fork works
// corrently and is not dropped.
func TestHeavyForkedSync61(t *testing.T)      { testHeavyForkedSync(t, 61, FullSync) }
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()

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

	tester := newTester()
	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})
}

888
// Tests that an inactive downloader will not accept incoming hashes and blocks.
889
func TestInactiveDownloader61(t *testing.T) {
890
	t.Parallel()
891
	tester := newTester()
892 893

	// Check that neither hashes nor blocks are accepted
894
	if err := tester.downloader.DeliverHashes("bad peer", []common.Hash{}); err != errNoSyncActive {
895 896
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
897
	if err := tester.downloader.DeliverBlocks("bad peer", []*types.Block{}); err != errNoSyncActive {
898 899 900 901
		t.Errorf("error mismatch: have %v, want %v", err, errNoSyncActive)
	}
}

902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
// 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 TestBoundedForkedSync61(t *testing.T)      { testBoundedForkedSync(t, 61, FullSync) }
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()

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

	tester := newTester()
	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 TestBoundedHeavyForkedSync61(t *testing.T)      { testBoundedHeavyForkedSync(t, 61, FullSync) }
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()

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

	tester := newTester()
	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)
	}
}

970 971
// Tests that an inactive downloader will not accept incoming block headers and
// bodies.
972
func TestInactiveDownloader62(t *testing.T) {
973
	t.Parallel()
974
	tester := newTester()
975 976 977

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

985 986 987
// Tests that an inactive downloader will not accept incoming block headers,
// bodies and receipts.
func TestInactiveDownloader63(t *testing.T) {
988
	t.Parallel()
989
	tester := newTester()
990 991 992 993 994 995 996 997 998 999 1000 1001

	// 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)
	}
}
1002

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
// Tests that a canceled download wipes all previously accumulated state.
func TestCancel61(t *testing.T)      { testCancel(t, 61, FullSync) }
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) {
1013 1014
	t.Parallel()

1015 1016 1017 1018 1019
	// Create a small enough block chain to download and the tester
	targetBlocks := blockCacheLimit - 15
	if targetBlocks >= MaxHashFetch {
		targetBlocks = MaxHashFetch - 15
	}
1020 1021 1022
	if targetBlocks >= MaxHeaderFetch {
		targetBlocks = MaxHeaderFetch - 15
	}
1023
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1024

1025
	tester := newTester()
1026
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
1027 1028 1029

	// Make sure canceling works with a pristine downloader
	tester.downloader.cancel()
1030 1031
	if !tester.downloader.queue.Idle() {
		t.Errorf("download queue not idle")
1032 1033
	}
	// Synchronise with the peer, but cancel afterwards
1034
	if err := tester.sync("peer", nil, mode); err != nil {
1035 1036 1037
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
	tester.downloader.cancel()
1038 1039
	if !tester.downloader.queue.Idle() {
		t.Errorf("download queue not idle")
1040 1041 1042
	}
}

1043
// Tests that synchronisation from multiple peers works as intended (multi thread sanity test).
1044 1045 1046 1047 1048 1049 1050 1051 1052
func TestMultiSynchronisation61(t *testing.T)      { testMultiSynchronisation(t, 61, FullSync) }
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) {
1053 1054
	t.Parallel()

1055
	// Create various peers with various parts of the chain
1056
	targetPeers := 8
1057
	targetBlocks := targetPeers*blockCacheLimit - 15
1058
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1059

1060
	tester := newTester()
1061 1062
	for i := 0; i < targetPeers; i++ {
		id := fmt.Sprintf("peer #%d", i)
1063
		tester.newPeer(id, protocol, hashes[i*blockCacheLimit:], headers, blocks, receipts)
1064
	}
1065
	if err := tester.sync("peer #0", nil, mode); err != nil {
1066 1067
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1068
	assertOwnChain(t, tester, targetBlocks+1)
1069 1070
}

1071
// Tests that synchronisations behave well in multi-version protocol environments
L
Leif Jurvetson 已提交
1072
// and not wreak havoc on other nodes in the network.
1073 1074 1075 1076 1077 1078 1079 1080 1081
func TestMultiProtoSynchronisation61(t *testing.T)      { testMultiProtoSync(t, 61, FullSync) }
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) {
1082 1083
	t.Parallel()

1084 1085
	// Create a small enough block chain to download
	targetBlocks := blockCacheLimit - 15
1086
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1087 1088

	// Create peers of every type
1089 1090 1091
	tester := newTester()
	tester.newPeer("peer 61", 61, hashes, nil, blocks, nil)
	tester.newPeer("peer 62", 62, hashes, headers, blocks, nil)
1092 1093
	tester.newPeer("peer 63", 63, hashes, headers, blocks, receipts)
	tester.newPeer("peer 64", 64, hashes, headers, blocks, receipts)
1094

1095 1096
	// 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 {
1097 1098
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1099 1100
	assertOwnChain(t, tester, targetBlocks+1)

1101 1102 1103 1104 1105 1106 1107 1108 1109
	// Check that no peers have been dropped off
	for _, version := range []int{61, 62, 63, 64} {
		peer := fmt.Sprintf("peer %d", version)
		if _, ok := tester.peerHashes[peer]; !ok {
			t.Errorf("%s dropped", peer)
		}
	}
}

1110
// Tests that if a block is empty (e.g. header only), no body request should be
1111
// made, and instead the header should be assembled into a whole block in itself.
1112 1113 1114 1115 1116 1117 1118 1119
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) {
1120 1121
	t.Parallel()

1122 1123
	// Create a block chain to download
	targetBlocks := 2*blockCacheLimit - 15
1124
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1125

1126
	tester := newTester()
1127
	tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
1128 1129

	// Instrument the downloader to signal body requests
1130
	bodiesHave, receiptsHave := int32(0), int32(0)
1131
	tester.downloader.bodyFetchHook = func(headers []*types.Header) {
1132
		atomic.AddInt32(&bodiesHave, int32(len(headers)))
1133 1134
	}
	tester.downloader.receiptFetchHook = func(headers []*types.Header) {
1135
		atomic.AddInt32(&receiptsHave, int32(len(headers)))
1136 1137
	}
	// Synchronise with the peer and make sure all blocks were retrieved
1138
	if err := tester.sync("peer", nil, mode); err != nil {
1139 1140
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1141 1142
	assertOwnChain(t, tester, targetBlocks+1)

1143
	// Validate the number of block bodies that should have been requested
1144
	bodiesNeeded, receiptsNeeded := 0, 0
1145
	for _, block := range blocks {
1146 1147
		if mode != LightSync && block != genesis && (len(block.Transactions()) > 0 || len(block.Uncles()) > 0) {
			bodiesNeeded++
1148
		}
1149
	}
1150
	for hash, receipt := range receipts {
1151
		if mode == FastSync && len(receipt) > 0 && headers[hash].Number.Uint64() <= tester.downloader.queue.fastSyncPivot {
1152 1153 1154
			receiptsNeeded++
		}
	}
1155 1156
	if int(bodiesHave) != bodiesNeeded {
		t.Errorf("body retrieval count mismatch: have %v, want %v", bodiesHave, bodiesNeeded)
1157
	}
1158 1159
	if int(receiptsHave) != receiptsNeeded {
		t.Errorf("receipt retrieval count mismatch: have %v, want %v", receiptsHave, receiptsNeeded)
1160 1161 1162
	}
}

1163 1164
// Tests that headers are enqueued continuously, preventing malicious nodes from
// stalling the downloader by feeding gapped header chains.
1165 1166 1167 1168 1169 1170 1171 1172
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) {
1173 1174
	t.Parallel()

1175 1176
	// Create a small enough block chain to download
	targetBlocks := blockCacheLimit - 15
1177
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1178

1179
	tester := newTester()
1180 1181

	// Attempt a full sync with an attacker feeding gapped headers
1182
	tester.newPeer("attack", protocol, hashes, headers, blocks, receipts)
1183
	missing := targetBlocks / 2
1184
	delete(tester.peerHeaders["attack"], hashes[missing])
1185

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

// Tests that if requested headers are shifted (i.e. first is missing), the queue
// detects the invalid numbering.
1199 1200 1201 1202 1203 1204 1205 1206
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) {
1207 1208
	// Create a small enough block chain to download
	targetBlocks := blockCacheLimit - 15
1209
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1210

1211
	tester := newTester()
1212 1213

	// Attempt a full sync with an attacker feeding shifted headers
1214
	tester.newPeer("attack", protocol, hashes, headers, blocks, receipts)
1215
	delete(tester.peerHeaders["attack"], hashes[len(hashes)-2])
1216
	delete(tester.peerBlocks["attack"], hashes[len(hashes)-2])
1217
	delete(tester.peerReceipts["attack"], hashes[len(hashes)-2])
1218

1219
	if err := tester.sync("attack", nil, mode); err == nil {
1220 1221 1222
		t.Fatalf("succeeded attacker synchronisation")
	}
	// Synchronise with the valid peer and make sure sync succeeds
1223
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
1224
	if err := tester.sync("valid", nil, mode); err != nil {
1225 1226 1227 1228 1229 1230
		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
1231 1232
// for various failure scenarios. Afterwards a full sync is attempted to make
// sure no state was corrupted.
1233 1234 1235 1236 1237 1238
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) {
	// Create a small enough block chain to download
1239
	targetBlocks := 3*fsHeaderSafetyNet + fsMinFullBlocks
1240
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1241

1242
	tester := newTester()
1243

1244 1245
	// 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.
1246
	tester.newPeer("fast-attack", protocol, hashes, headers, blocks, receipts)
1247
	missing := fsHeaderSafetyNet + MaxHeaderFetch + 1
1248 1249
	delete(tester.peerHeaders["fast-attack"], hashes[len(hashes)-missing])

1250
	if err := tester.sync("fast-attack", nil, mode); err == nil {
1251 1252 1253
		t.Fatalf("succeeded fast attacker synchronisation")
	}
	if head := tester.headHeader().Number.Int64(); int(head) > MaxHeaderFetch {
1254
		t.Errorf("rollback head mismatch: have %v, want at most %v", head, MaxHeaderFetch)
1255
	}
1256 1257 1258
	// 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.
1259
	tester.newPeer("block-attack", protocol, hashes, headers, blocks, receipts)
1260
	missing = 3*fsHeaderSafetyNet + MaxHeaderFetch + 1
1261
	delete(tester.peerHeaders["fast-attack"], hashes[len(hashes)-missing]) // Make sure the fast-attacker doesn't fill in
1262 1263
	delete(tester.peerHeaders["block-attack"], hashes[len(hashes)-missing])

1264
	if err := tester.sync("block-attack", nil, mode); err == nil {
1265 1266
		t.Fatalf("succeeded block attacker synchronisation")
	}
1267 1268 1269
	if head := tester.headHeader().Number.Int64(); int(head) > 2*fsHeaderSafetyNet+MaxHeaderFetch {
		t.Errorf("rollback head mismatch: have %v, want at most %v", head, 2*fsHeaderSafetyNet+MaxHeaderFetch)
	}
1270
	if mode == FastSync {
1271 1272
		if head := tester.headBlock().NumberU64(); head != 0 {
			t.Errorf("fast sync pivot block #%d not rolled back", head)
1273
		}
1274
	}
1275 1276 1277 1278 1279
	// 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
1280

1281 1282 1283 1284 1285 1286
	tester.downloader.noFast = false
	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
1287
	}
1288

1289 1290 1291 1292 1293
	if err := tester.sync("withhold-attack", nil, mode); err == nil {
		t.Fatalf("succeeded withholding attacker synchronisation")
	}
	if head := tester.headHeader().Number.Int64(); int(head) > 2*fsHeaderSafetyNet+MaxHeaderFetch {
		t.Errorf("rollback head mismatch: have %v, want at most %v", head, 2*fsHeaderSafetyNet+MaxHeaderFetch)
1294 1295
	}
	if mode == FastSync {
1296 1297 1298
		if head := tester.headBlock().NumberU64(); head != 0 {
			t.Errorf("fast sync pivot block #%d not rolled back", head)
		}
1299
	}
1300 1301 1302
	// 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 已提交
1303
	// since we won't purge the database of them, hence we can't use assertOwnChain.
1304 1305
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
	if err := tester.sync("valid", nil, mode); err != nil {
1306 1307
		t.Fatalf("failed to synchronise blocks: %v", err)
	}
1308 1309
	if hs := len(tester.ownHeaders); hs != len(headers) {
		t.Fatalf("synchronised headers mismatch: have %v, want %v", hs, len(headers))
1310
	}
1311 1312 1313 1314
	if mode != LightSync {
		if bs := len(tester.ownBlocks); bs != len(blocks) {
			t.Fatalf("synchronised blocks mismatch: have %v, want %v", bs, len(blocks))
		}
1315
	}
1316 1317
}

1318 1319
// Tests that a peer advertising an high TD doesn't get to stall the downloader
// afterwards by not sending any useful hashes.
1320 1321 1322 1323 1324 1325 1326 1327 1328
func TestHighTDStarvationAttack61(t *testing.T)      { testHighTDStarvationAttack(t, 61, FullSync) }
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) {
1329 1330
	t.Parallel()

1331
	tester := newTester()
1332
	hashes, headers, blocks, receipts := makeChain(0, 0, genesis, nil, false)
1333

1334
	tester.newPeer("attack", protocol, []common.Hash{hashes[0]}, headers, blocks, receipts)
1335
	if err := tester.sync("attack", big.NewInt(1000000), mode); err != errStallingPeer {
1336 1337 1338 1339
		t.Fatalf("synchronisation error mismatch: have %v, want %v", err, errStallingPeer)
	}
}

1340
// Tests that misbehaving peers are disconnected, whilst behaving ones are not.
1341 1342 1343 1344 1345 1346
func TestBlockHeaderAttackerDropping61(t *testing.T) { testBlockHeaderAttackerDropping(t, 61) }
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) {
1347
	// Define the disconnection requirement for individual hash fetch errors
1348 1349 1350 1351
	tests := []struct {
		result error
		drop   bool
	}{
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
		{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
		{errEmptyHashSet, true},             // No hashes were returned as a response, drop as it's a dead end
		{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
		{errCancelHashFetch, false},         // Synchronisation was canceled, origin may be innocent, don't drop
		{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
1374 1375
	}
	// Run the tests and check disconnection status
1376
	tester := newTester()
1377 1378 1379
	for i, tt := range tests {
		// Register a new peer and ensure it's presence
		id := fmt.Sprintf("test %d", i)
1380
		if err := tester.newPeer(id, protocol, []common.Hash{genesis.Hash()}, nil, nil, nil); err != nil {
1381 1382 1383 1384 1385 1386 1387 1388
			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 }

1389
		tester.downloader.Synchronise(id, genesis.Hash(), big.NewInt(1000), FullSync)
1390 1391 1392 1393 1394
		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)
		}
	}
}
1395

1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406
// Tests that synchronisation progress (origin block number, current block number
// and highest block number) is tracked and updated correctly.
func TestSyncProgress61(t *testing.T)      { testSyncProgress(t, 61, FullSync) }
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) {
1407 1408
	t.Parallel()

1409 1410
	// Create a small enough block chain to download
	targetBlocks := blockCacheLimit - 15
1411
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1412

1413
	// Set a sync init hook to catch progress changes
1414 1415 1416
	starting := make(chan struct{})
	progress := make(chan struct{})

1417
	tester := newTester()
1418 1419 1420 1421
	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1422
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1423
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != 0 {
1424
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, 0)
1425
	}
1426
	// Synchronise half the blocks and check initial progress
1427
	tester.newPeer("peer-half", protocol, hashes[targetBlocks/2:], headers, blocks, receipts)
1428 1429 1430 1431 1432
	pending := new(sync.WaitGroup)
	pending.Add(1)

	go func() {
		defer pending.Done()
1433
		if err := tester.sync("peer-half", nil, mode); err != nil {
1434 1435 1436 1437
			t.Fatalf("failed to synchronise blocks: %v", err)
		}
	}()
	<-starting
1438
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != uint64(targetBlocks/2+1) {
1439
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, targetBlocks/2+1)
1440 1441 1442 1443
	}
	progress <- struct{}{}
	pending.Wait()

1444
	// Synchronise all the blocks and check continuation progress
1445
	tester.newPeer("peer-full", protocol, hashes, headers, blocks, receipts)
1446 1447 1448 1449
	pending.Add(1)

	go func() {
		defer pending.Done()
1450
		if err := tester.sync("peer-full", nil, mode); err != nil {
1451 1452 1453 1454
			t.Fatalf("failed to synchronise blocks: %v", err)
		}
	}()
	<-starting
1455
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != uint64(targetBlocks/2+1) || current != uint64(targetBlocks/2+1) || latest != uint64(targetBlocks) {
1456
		t.Fatalf("Completing progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, targetBlocks/2+1, targetBlocks/2+1, targetBlocks)
1457 1458 1459
	}
	progress <- struct{}{}
	pending.Wait()
1460 1461

	// Check final progress after successful sync
1462
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != uint64(targetBlocks/2+1) || current != uint64(targetBlocks) || latest != uint64(targetBlocks) {
1463 1464
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, targetBlocks/2+1, targetBlocks, targetBlocks)
	}
1465 1466
}

1467
// Tests that synchronisation progress (origin block number and highest block
1468 1469
// number) is tracked and updated correctly in case of a fork (or manual head
// revertal).
1470 1471 1472 1473 1474 1475 1476 1477 1478
func TestForkedSyncProgress61(t *testing.T)      { testForkedSyncProgress(t, 61, FullSync) }
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) {
1479 1480
	t.Parallel()

1481 1482
	// Create a forked chain to simulate origin revertal
	common, fork := MaxHashFetch, 2*MaxHashFetch
1483
	hashesA, hashesB, headersA, headersB, blocksA, blocksB, receiptsA, receiptsB := makeChainFork(common+fork, fork, genesis, nil, true)
1484

1485
	// Set a sync init hook to catch progress changes
1486 1487 1488
	starting := make(chan struct{})
	progress := make(chan struct{})

1489
	tester := newTester()
1490 1491 1492 1493
	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1494
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1495
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != 0 {
1496
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, 0)
1497
	}
1498
	// Synchronise with one of the forks and check progress
1499
	tester.newPeer("fork A", protocol, hashesA, headersA, blocksA, receiptsA)
1500 1501 1502 1503 1504
	pending := new(sync.WaitGroup)
	pending.Add(1)

	go func() {
		defer pending.Done()
1505
		if err := tester.sync("fork A", nil, mode); err != nil {
1506 1507 1508 1509
			t.Fatalf("failed to synchronise blocks: %v", err)
		}
	}()
	<-starting
1510
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != uint64(len(hashesA)-1) {
1511
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, len(hashesA)-1)
1512 1513 1514 1515 1516
	}
	progress <- struct{}{}
	pending.Wait()

	// Simulate a successful sync above the fork
1517
	tester.downloader.syncStatsChainOrigin = tester.downloader.syncStatsChainHeight
1518

1519
	// Synchronise with the second fork and check progress resets
1520
	tester.newPeer("fork B", protocol, hashesB, headersB, blocksB, receiptsB)
1521 1522 1523 1524
	pending.Add(1)

	go func() {
		defer pending.Done()
1525
		if err := tester.sync("fork B", nil, mode); err != nil {
1526 1527 1528 1529
			t.Fatalf("failed to synchronise blocks: %v", err)
		}
	}()
	<-starting
1530
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != uint64(common) || current != uint64(len(hashesA)-1) || latest != uint64(len(hashesB)-1) {
1531
		t.Fatalf("Forking progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, common, len(hashesA)-1, len(hashesB)-1)
1532 1533 1534
	}
	progress <- struct{}{}
	pending.Wait()
1535 1536

	// Check final progress after successful sync
1537
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != uint64(common) || current != uint64(len(hashesB)-1) || latest != uint64(len(hashesB)-1) {
1538 1539
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, common, len(hashesB)-1, len(hashesB)-1)
	}
1540 1541
}

1542
// Tests that if synchronisation is aborted due to some failure, then the progress
1543 1544
// 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.
1545 1546 1547 1548 1549 1550 1551 1552 1553
func TestFailedSyncProgress61(t *testing.T)      { testFailedSyncProgress(t, 61, FullSync) }
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) {
1554 1555
	t.Parallel()

1556 1557
	// Create a small enough block chain to download
	targetBlocks := blockCacheLimit - 15
1558
	hashes, headers, blocks, receipts := makeChain(targetBlocks, 0, genesis, nil, false)
1559

1560
	// Set a sync init hook to catch progress changes
1561 1562 1563
	starting := make(chan struct{})
	progress := make(chan struct{})

1564
	tester := newTester()
1565 1566 1567 1568
	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1569
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1570
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != 0 {
1571
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, 0)
1572 1573
	}
	// Attempt a full sync with a faulty peer
1574
	tester.newPeer("faulty", protocol, hashes, headers, blocks, receipts)
1575
	missing := targetBlocks / 2
1576
	delete(tester.peerHeaders["faulty"], hashes[missing])
1577
	delete(tester.peerBlocks["faulty"], hashes[missing])
1578
	delete(tester.peerReceipts["faulty"], hashes[missing])
1579 1580 1581 1582 1583 1584

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

	go func() {
		defer pending.Done()
1585
		if err := tester.sync("faulty", nil, mode); err == nil {
1586 1587 1588 1589
			t.Fatalf("succeeded faulty synchronisation")
		}
	}()
	<-starting
1590
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != uint64(targetBlocks) {
1591
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, targetBlocks)
1592 1593 1594 1595
	}
	progress <- struct{}{}
	pending.Wait()

1596
	// Synchronise with a good peer and check that the progress origin remind the same after a failure
1597
	tester.newPeer("valid", protocol, hashes, headers, blocks, receipts)
1598 1599 1600 1601
	pending.Add(1)

	go func() {
		defer pending.Done()
1602
		if err := tester.sync("valid", nil, mode); err != nil {
1603 1604 1605 1606
			t.Fatalf("failed to synchronise blocks: %v", err)
		}
	}()
	<-starting
1607
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current > uint64(targetBlocks/2) || latest != uint64(targetBlocks) {
1608
		t.Fatalf("Completing progress mismatch: have %v/%v/%v, want %v/0-%v/%v", origin, current, latest, 0, targetBlocks/2, targetBlocks)
1609 1610 1611
	}
	progress <- struct{}{}
	pending.Wait()
1612 1613

	// Check final progress after successful sync
1614
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin > uint64(targetBlocks/2) || current != uint64(targetBlocks) || latest != uint64(targetBlocks) {
1615 1616
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want 0-%v/%v/%v", origin, current, latest, targetBlocks/2, targetBlocks, targetBlocks)
	}
1617 1618 1619
}

// Tests that if an attacker fakes a chain height, after the attack is detected,
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
// the progress height is successfully reduced at the next sync invocation.
func TestFakedSyncProgress61(t *testing.T)      { testFakedSyncProgress(t, 61, FullSync) }
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) {
1630 1631
	t.Parallel()

1632 1633
	// Create a small block chain
	targetBlocks := blockCacheLimit - 15
1634
	hashes, headers, blocks, receipts := makeChain(targetBlocks+3, 0, genesis, nil, false)
1635

1636
	// Set a sync init hook to catch progress changes
1637 1638 1639
	starting := make(chan struct{})
	progress := make(chan struct{})

1640
	tester := newTester()
1641 1642 1643 1644
	tester.downloader.syncInitHook = func(origin, latest uint64) {
		starting <- struct{}{}
		<-progress
	}
1645
	// Retrieve the sync progress and ensure they are zero (pristine sync)
1646
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != 0 {
1647
		t.Fatalf("Pristine progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, 0)
1648 1649
	}
	//  Create and sync with an attacker that promises a higher chain than available
1650
	tester.newPeer("attack", protocol, hashes, headers, blocks, receipts)
1651
	for i := 1; i < 3; i++ {
1652
		delete(tester.peerHeaders["attack"], hashes[i])
1653
		delete(tester.peerBlocks["attack"], hashes[i])
1654
		delete(tester.peerReceipts["attack"], hashes[i])
1655 1656 1657 1658 1659 1660 1661
	}

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

	go func() {
		defer pending.Done()
1662
		if err := tester.sync("attack", nil, mode); err == nil {
1663 1664 1665 1666
			t.Fatalf("succeeded attacker synchronisation")
		}
	}()
	<-starting
1667
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current != 0 || latest != uint64(targetBlocks+3) {
1668
		t.Fatalf("Initial progress mismatch: have %v/%v/%v, want %v/%v/%v", origin, current, latest, 0, 0, targetBlocks+3)
1669 1670 1671 1672
	}
	progress <- struct{}{}
	pending.Wait()

1673
	// Synchronise with a good peer and check that the progress height has been reduced to the true value
1674
	tester.newPeer("valid", protocol, hashes[3:], headers, blocks, receipts)
1675 1676 1677 1678
	pending.Add(1)

	go func() {
		defer pending.Done()
1679
		if err := tester.sync("valid", nil, mode); err != nil {
1680 1681 1682 1683
			t.Fatalf("failed to synchronise blocks: %v", err)
		}
	}()
	<-starting
1684
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin != 0 || current > uint64(targetBlocks) || latest != uint64(targetBlocks) {
1685
		t.Fatalf("Completing progress mismatch: have %v/%v/%v, want %v/0-%v/%v", origin, current, latest, 0, targetBlocks, targetBlocks)
1686 1687 1688
	}
	progress <- struct{}{}
	pending.Wait()
1689 1690

	// Check final progress after successful sync
1691
	if origin, current, latest, _, _ := tester.downloader.Progress(); origin > uint64(targetBlocks) || current != uint64(targetBlocks) || latest != uint64(targetBlocks) {
1692 1693
		t.Fatalf("Final progress mismatch: have %v/%v/%v, want 0-%v/%v/%v", origin, current, latest, targetBlocks, targetBlocks, targetBlocks)
	}
1694
}
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706

// This test reproduces an issue where unexpected deliveries would
// block indefinitely if they arrived at the right time.
func TestDeliverHeadersHang62(t *testing.T)      { testDeliverHeadersHang(t, 62, FullSync) }
func TestDeliverHeadersHang63Full(t *testing.T)  { testDeliverHeadersHang(t, 63, FullSync) }
func TestDeliverHeadersHang63Fast(t *testing.T)  { testDeliverHeadersHang(t, 63, FastSync) }
func TestDeliverHeadersHang64Full(t *testing.T)  { testDeliverHeadersHang(t, 64, FullSync) }
func TestDeliverHeadersHang64Fast(t *testing.T)  { testDeliverHeadersHang(t, 64, FastSync) }
func TestDeliverHeadersHang64Light(t *testing.T) { testDeliverHeadersHang(t, 64, LightSync) }

func testDeliverHeadersHang(t *testing.T, protocol int, mode SyncMode) {
	t.Parallel()
1707
	hashes, headers, blocks, receipts := makeChain(5, 0, genesis, nil, false)
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
	fakeHeads := []*types.Header{{}, {}, {}, {}}
	for i := 0; i < 200; i++ {
		tester := newTester()
		tester.newPeer("peer", protocol, hashes, headers, blocks, receipts)
		// Whenever the downloader requests headers, flood it with
		// a lot of unrequested header deliveries.
		tester.downloader.peers.peers["peer"].getAbsHeaders = func(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)
				go func() {
					tester.downloader.DeliverHeaders(peer, fakeHeads)
					deliveriesDone <- struct{}{}
				}()
			}
			// Deliver the actual requested headers.
			impl := tester.peerGetAbsHeadersFn("peer", 0)
			go impl(from, count, skip, reverse)
			// None of the extra deliveries should block.
			timeout := time.After(5 * time.Second)
			for i := 0; i < cap(deliveriesDone); i++ {
				select {
				case <-deliveriesDone:
				case <-timeout:
					panic("blocked")
				}
			}
			return nil
		}
		if err := tester.sync("peer", nil, mode); err != nil {
			t.Errorf("sync failed: %v", err)
		}
	}
}