github.com/tirogen/go-ethereum@v1.10.12-0.20221226051715-250cfede41b6/les/downloader/downloader.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  // Package downloader is a temporary package whilst working on the eth/66 blocking refactors.
    18  // After that work is done, les needs to be refactored to use the new package,
    19  // or alternatively use a stripped down version of it. Either way, we need to
    20  // keep the changes scoped so duplicating temporarily seems the sanest.
    21  package downloader
    22  
    23  import (
    24  	"errors"
    25  	"fmt"
    26  	"math/big"
    27  	"sync"
    28  	"sync/atomic"
    29  	"time"
    30  
    31  	"github.com/tirogen/go-ethereum"
    32  	"github.com/tirogen/go-ethereum/common"
    33  	"github.com/tirogen/go-ethereum/core/rawdb"
    34  	"github.com/tirogen/go-ethereum/core/state/snapshot"
    35  	"github.com/tirogen/go-ethereum/core/types"
    36  	"github.com/tirogen/go-ethereum/eth/protocols/eth"
    37  	"github.com/tirogen/go-ethereum/eth/protocols/snap"
    38  	"github.com/tirogen/go-ethereum/ethdb"
    39  	"github.com/tirogen/go-ethereum/event"
    40  	"github.com/tirogen/go-ethereum/log"
    41  	"github.com/tirogen/go-ethereum/metrics"
    42  	"github.com/tirogen/go-ethereum/params"
    43  )
    44  
    45  var (
    46  	MaxBlockFetch   = 128 // Amount of blocks to be fetched per retrieval request
    47  	MaxHeaderFetch  = 192 // Amount of block headers to be fetched per retrieval request
    48  	MaxSkeletonSize = 128 // Number of header fetches to need for a skeleton assembly
    49  	MaxReceiptFetch = 256 // Amount of transaction receipts to allow fetching per request
    50  	MaxStateFetch   = 384 // Amount of node state values to allow fetching per request
    51  
    52  	maxQueuedHeaders            = 32 * 1024                         // [eth/62] Maximum number of headers to queue for import (DOS protection)
    53  	maxHeadersProcess           = 2048                              // Number of header download results to import at once into the chain
    54  	maxResultsProcess           = 2048                              // Number of content download results to import at once into the chain
    55  	fullMaxForkAncestry  uint64 = params.FullImmutabilityThreshold  // Maximum chain reorganisation (locally redeclared so tests can reduce it)
    56  	lightMaxForkAncestry uint64 = params.LightImmutabilityThreshold // Maximum chain reorganisation (locally redeclared so tests can reduce it)
    57  
    58  	reorgProtThreshold   = 48 // Threshold number of recent blocks to disable mini reorg protection
    59  	reorgProtHeaderDelay = 2  // Number of headers to delay delivering to cover mini reorgs
    60  
    61  	fsHeaderCheckFrequency = 100             // Verification frequency of the downloaded headers during fast sync
    62  	fsHeaderSafetyNet      = 2048            // Number of headers to discard in case a chain violation is detected
    63  	fsHeaderForceVerify    = 24              // Number of headers to verify before and after the pivot to accept it
    64  	fsHeaderContCheck      = 3 * time.Second // Time interval to check for header continuations during state download
    65  	fsMinFullBlocks        = 64              // Number of blocks to retrieve fully even in fast sync
    66  )
    67  
    68  var (
    69  	errBusy                    = errors.New("busy")
    70  	errUnknownPeer             = errors.New("peer is unknown or unhealthy")
    71  	errBadPeer                 = errors.New("action from bad peer ignored")
    72  	errStallingPeer            = errors.New("peer is stalling")
    73  	errUnsyncedPeer            = errors.New("unsynced peer")
    74  	errNoPeers                 = errors.New("no peers to keep download active")
    75  	errTimeout                 = errors.New("timeout")
    76  	errEmptyHeaderSet          = errors.New("empty header set by peer")
    77  	errPeersUnavailable        = errors.New("no peers available or all tried for download")
    78  	errInvalidAncestor         = errors.New("retrieved ancestor is invalid")
    79  	errInvalidChain            = errors.New("retrieved hash chain is invalid")
    80  	errInvalidBody             = errors.New("retrieved block body is invalid")
    81  	errInvalidReceipt          = errors.New("retrieved receipt is invalid")
    82  	errCancelStateFetch        = errors.New("state data download canceled (requested)")
    83  	errCancelContentProcessing = errors.New("content processing canceled (requested)")
    84  	errCanceled                = errors.New("syncing canceled (requested)")
    85  	errNoSyncActive            = errors.New("no sync active")
    86  	errTooOld                  = errors.New("peer's protocol version too old")
    87  	errNoAncestorFound         = errors.New("no common ancestor found")
    88  )
    89  
    90  type Downloader struct {
    91  	mode uint32         // Synchronisation mode defining the strategy used (per sync cycle), use d.getMode() to get the SyncMode
    92  	mux  *event.TypeMux // Event multiplexer to announce sync operation events
    93  
    94  	checkpoint uint64   // Checkpoint block number to enforce head against (e.g. fast sync)
    95  	genesis    uint64   // Genesis block number to limit sync to (e.g. light client CHT)
    96  	queue      *queue   // Scheduler for selecting the hashes to download
    97  	peers      *peerSet // Set of active peers from which download can proceed
    98  
    99  	stateDB ethdb.Database // Database to state sync into (and deduplicate via)
   100  
   101  	// Statistics
   102  	syncStatsChainOrigin uint64 // Origin block number where syncing started at
   103  	syncStatsChainHeight uint64 // Highest block number known when syncing started
   104  	syncStatsState       stateSyncStats
   105  	syncStatsLock        sync.RWMutex // Lock protecting the sync stats fields
   106  
   107  	lightchain LightChain
   108  	blockchain BlockChain
   109  
   110  	// Callbacks
   111  	dropPeer peerDropFn // Drops a peer for misbehaving
   112  
   113  	// Status
   114  	synchroniseMock func(id string, hash common.Hash) error // Replacement for synchronise during testing
   115  	synchronising   int32
   116  	notified        int32
   117  	committed       int32
   118  	ancientLimit    uint64 // The maximum block number which can be regarded as ancient data.
   119  
   120  	// Channels
   121  	headerCh      chan dataPack        // Channel receiving inbound block headers
   122  	bodyCh        chan dataPack        // Channel receiving inbound block bodies
   123  	receiptCh     chan dataPack        // Channel receiving inbound receipts
   124  	bodyWakeCh    chan bool            // Channel to signal the block body fetcher of new tasks
   125  	receiptWakeCh chan bool            // Channel to signal the receipt fetcher of new tasks
   126  	headerProcCh  chan []*types.Header // Channel to feed the header processor new tasks
   127  
   128  	// State sync
   129  	pivotHeader *types.Header // Pivot block header to dynamically push the syncing state root
   130  	pivotLock   sync.RWMutex  // Lock protecting pivot header reads from updates
   131  
   132  	snapSync       bool         // Whether to run state sync over the snap protocol
   133  	SnapSyncer     *snap.Syncer // TODO(karalabe): make private! hack for now
   134  	stateSyncStart chan *stateSync
   135  	trackStateReq  chan *stateReq
   136  	stateCh        chan dataPack // Channel receiving inbound node state data
   137  
   138  	// Cancellation and termination
   139  	cancelPeer string         // Identifier of the peer currently being used as the master (cancel on drop)
   140  	cancelCh   chan struct{}  // Channel to cancel mid-flight syncs
   141  	cancelLock sync.RWMutex   // Lock to protect the cancel channel and peer in delivers
   142  	cancelWg   sync.WaitGroup // Make sure all fetcher goroutines have exited.
   143  
   144  	quitCh   chan struct{} // Quit channel to signal termination
   145  	quitLock sync.Mutex    // Lock to prevent double closes
   146  
   147  	// Testing hooks
   148  	syncInitHook     func(uint64, uint64)  // Method to call upon initiating a new sync run
   149  	bodyFetchHook    func([]*types.Header) // Method to call upon starting a block body fetch
   150  	receiptFetchHook func([]*types.Header) // Method to call upon starting a receipt fetch
   151  	chainInsertHook  func([]*fetchResult)  // Method to call upon inserting a chain of blocks (possibly in multiple invocations)
   152  }
   153  
   154  // LightChain encapsulates functions required to synchronise a light chain.
   155  type LightChain interface {
   156  	// HasHeader verifies a header's presence in the local chain.
   157  	HasHeader(common.Hash, uint64) bool
   158  
   159  	// GetHeaderByHash retrieves a header from the local chain.
   160  	GetHeaderByHash(common.Hash) *types.Header
   161  
   162  	// CurrentHeader retrieves the head header from the local chain.
   163  	CurrentHeader() *types.Header
   164  
   165  	// GetTd returns the total difficulty of a local block.
   166  	GetTd(common.Hash, uint64) *big.Int
   167  
   168  	// InsertHeaderChain inserts a batch of headers into the local chain.
   169  	InsertHeaderChain([]*types.Header, int) (int, error)
   170  
   171  	// SetHead rewinds the local chain to a new head.
   172  	SetHead(uint64) error
   173  }
   174  
   175  // BlockChain encapsulates functions required to sync a (full or fast) blockchain.
   176  type BlockChain interface {
   177  	LightChain
   178  
   179  	// HasBlock verifies a block's presence in the local chain.
   180  	HasBlock(common.Hash, uint64) bool
   181  
   182  	// HasFastBlock verifies a fast block's presence in the local chain.
   183  	HasFastBlock(common.Hash, uint64) bool
   184  
   185  	// GetBlockByHash retrieves a block from the local chain.
   186  	GetBlockByHash(common.Hash) *types.Block
   187  
   188  	// CurrentBlock retrieves the head block from the local chain.
   189  	CurrentBlock() *types.Block
   190  
   191  	// CurrentFastBlock retrieves the head fast block from the local chain.
   192  	CurrentFastBlock() *types.Block
   193  
   194  	// FastSyncCommitHead directly commits the head block to a certain entity.
   195  	FastSyncCommitHead(common.Hash) error
   196  
   197  	// InsertChain inserts a batch of blocks into the local chain.
   198  	InsertChain(types.Blocks) (int, error)
   199  
   200  	// InsertReceiptChain inserts a batch of receipts into the local chain.
   201  	InsertReceiptChain(types.Blocks, []types.Receipts, uint64) (int, error)
   202  
   203  	// Snapshots returns the blockchain snapshot tree to paused it during sync.
   204  	Snapshots() *snapshot.Tree
   205  }
   206  
   207  // New creates a new downloader to fetch hashes and blocks from remote peers.
   208  func New(checkpoint uint64, stateDb ethdb.Database, mux *event.TypeMux, chain BlockChain, lightchain LightChain, dropPeer peerDropFn) *Downloader {
   209  	if lightchain == nil {
   210  		lightchain = chain
   211  	}
   212  	dl := &Downloader{
   213  		stateDB:        stateDb,
   214  		mux:            mux,
   215  		checkpoint:     checkpoint,
   216  		queue:          newQueue(blockCacheMaxItems, blockCacheInitialItems),
   217  		peers:          newPeerSet(),
   218  		blockchain:     chain,
   219  		lightchain:     lightchain,
   220  		dropPeer:       dropPeer,
   221  		headerCh:       make(chan dataPack, 1),
   222  		bodyCh:         make(chan dataPack, 1),
   223  		receiptCh:      make(chan dataPack, 1),
   224  		bodyWakeCh:     make(chan bool, 1),
   225  		receiptWakeCh:  make(chan bool, 1),
   226  		headerProcCh:   make(chan []*types.Header, 1),
   227  		quitCh:         make(chan struct{}),
   228  		stateCh:        make(chan dataPack),
   229  		SnapSyncer:     snap.NewSyncer(stateDb, nil),
   230  		stateSyncStart: make(chan *stateSync),
   231  		//syncStatsState: stateSyncStats{
   232  		//	processed: rawdb.ReadFastTrieProgress(stateDb),
   233  		//},
   234  		trackStateReq: make(chan *stateReq),
   235  	}
   236  	go dl.stateFetcher()
   237  	return dl
   238  }
   239  
   240  // Progress retrieves the synchronisation boundaries, specifically the origin
   241  // block where synchronisation started at (may have failed/suspended); the block
   242  // or header sync is currently at; and the latest known block which the sync targets.
   243  //
   244  // In addition, during the state download phase of fast synchronisation the number
   245  // of processed and the total number of known states are also returned. Otherwise
   246  // these are zero.
   247  func (d *Downloader) Progress() ethereum.SyncProgress {
   248  	// Lock the current stats and return the progress
   249  	d.syncStatsLock.RLock()
   250  	defer d.syncStatsLock.RUnlock()
   251  
   252  	current := uint64(0)
   253  	mode := d.getMode()
   254  	switch {
   255  	case d.blockchain != nil && mode == FullSync:
   256  		current = d.blockchain.CurrentBlock().NumberU64()
   257  	case d.blockchain != nil && mode == FastSync:
   258  		current = d.blockchain.CurrentFastBlock().NumberU64()
   259  	case d.lightchain != nil:
   260  		current = d.lightchain.CurrentHeader().Number.Uint64()
   261  	default:
   262  		log.Error("Unknown downloader chain/mode combo", "light", d.lightchain != nil, "full", d.blockchain != nil, "mode", mode)
   263  	}
   264  	return ethereum.SyncProgress{
   265  		StartingBlock: d.syncStatsChainOrigin,
   266  		CurrentBlock:  current,
   267  		HighestBlock:  d.syncStatsChainHeight,
   268  		//PulledStates:  d.syncStatsState.processed,
   269  		//KnownStates:   d.syncStatsState.processed + d.syncStatsState.pending,
   270  	}
   271  }
   272  
   273  // Synchronising returns whether the downloader is currently retrieving blocks.
   274  func (d *Downloader) Synchronising() bool {
   275  	return atomic.LoadInt32(&d.synchronising) > 0
   276  }
   277  
   278  // RegisterPeer injects a new download peer into the set of block source to be
   279  // used for fetching hashes and blocks from.
   280  func (d *Downloader) RegisterPeer(id string, version uint, peer Peer) error {
   281  	var logger log.Logger
   282  	if len(id) < 16 {
   283  		// Tests use short IDs, don't choke on them
   284  		logger = log.New("peer", id)
   285  	} else {
   286  		logger = log.New("peer", id[:8])
   287  	}
   288  	logger.Trace("Registering sync peer")
   289  	if err := d.peers.Register(newPeerConnection(id, version, peer, logger)); err != nil {
   290  		logger.Error("Failed to register sync peer", "err", err)
   291  		return err
   292  	}
   293  	return nil
   294  }
   295  
   296  // RegisterLightPeer injects a light client peer, wrapping it so it appears as a regular peer.
   297  func (d *Downloader) RegisterLightPeer(id string, version uint, peer LightPeer) error {
   298  	return d.RegisterPeer(id, version, &lightPeerWrapper{peer})
   299  }
   300  
   301  // UnregisterPeer remove a peer from the known list, preventing any action from
   302  // the specified peer. An effort is also made to return any pending fetches into
   303  // the queue.
   304  func (d *Downloader) UnregisterPeer(id string) error {
   305  	// Unregister the peer from the active peer set and revoke any fetch tasks
   306  	var logger log.Logger
   307  	if len(id) < 16 {
   308  		// Tests use short IDs, don't choke on them
   309  		logger = log.New("peer", id)
   310  	} else {
   311  		logger = log.New("peer", id[:8])
   312  	}
   313  	logger.Trace("Unregistering sync peer")
   314  	if err := d.peers.Unregister(id); err != nil {
   315  		logger.Error("Failed to unregister sync peer", "err", err)
   316  		return err
   317  	}
   318  	d.queue.Revoke(id)
   319  
   320  	return nil
   321  }
   322  
   323  // Synchronise tries to sync up our local block chain with a remote peer, both
   324  // adding various sanity checks as well as wrapping it with various log entries.
   325  func (d *Downloader) Synchronise(id string, head common.Hash, td *big.Int, mode SyncMode) error {
   326  	err := d.synchronise(id, head, td, mode)
   327  
   328  	switch err {
   329  	case nil, errBusy, errCanceled:
   330  		return err
   331  	}
   332  	if errors.Is(err, errInvalidChain) || errors.Is(err, errBadPeer) || errors.Is(err, errTimeout) ||
   333  		errors.Is(err, errStallingPeer) || errors.Is(err, errUnsyncedPeer) || errors.Is(err, errEmptyHeaderSet) ||
   334  		errors.Is(err, errPeersUnavailable) || errors.Is(err, errTooOld) || errors.Is(err, errInvalidAncestor) {
   335  		log.Warn("Synchronisation failed, dropping peer", "peer", id, "err", err)
   336  		if d.dropPeer == nil {
   337  			// The dropPeer method is nil when `--copydb` is used for a local copy.
   338  			// Timeouts can occur if e.g. compaction hits at the wrong time, and can be ignored
   339  			log.Warn("Downloader wants to drop peer, but peerdrop-function is not set", "peer", id)
   340  		} else {
   341  			d.dropPeer(id)
   342  		}
   343  		return err
   344  	}
   345  	log.Warn("Synchronisation failed, retrying", "err", err)
   346  	return err
   347  }
   348  
   349  // synchronise will select the peer and use it for synchronising. If an empty string is given
   350  // it will use the best peer possible and synchronize if its TD is higher than our own. If any of the
   351  // checks fail an error will be returned. This method is synchronous
   352  func (d *Downloader) synchronise(id string, hash common.Hash, td *big.Int, mode SyncMode) error {
   353  	// Mock out the synchronisation if testing
   354  	if d.synchroniseMock != nil {
   355  		return d.synchroniseMock(id, hash)
   356  	}
   357  	// Make sure only one goroutine is ever allowed past this point at once
   358  	if !atomic.CompareAndSwapInt32(&d.synchronising, 0, 1) {
   359  		return errBusy
   360  	}
   361  	defer atomic.StoreInt32(&d.synchronising, 0)
   362  
   363  	// Post a user notification of the sync (only once per session)
   364  	if atomic.CompareAndSwapInt32(&d.notified, 0, 1) {
   365  		log.Info("Block synchronisation started")
   366  	}
   367  	// If snap sync was requested, create the snap scheduler and switch to fast
   368  	// sync mode. Long term we could drop fast sync or merge the two together,
   369  	// but until snap becomes prevalent, we should support both. TODO(karalabe).
   370  	if mode == SnapSync {
   371  		if !d.snapSync {
   372  			// Snap sync uses the snapshot namespace to store potentially flakey data until
   373  			// sync completely heals and finishes. Pause snapshot maintenance in the mean
   374  			// time to prevent access.
   375  			if snapshots := d.blockchain.Snapshots(); snapshots != nil { // Only nil in tests
   376  				snapshots.Disable()
   377  			}
   378  			log.Warn("Enabling snapshot sync prototype")
   379  			d.snapSync = true
   380  		}
   381  		mode = FastSync
   382  	}
   383  	// Reset the queue, peer set and wake channels to clean any internal leftover state
   384  	d.queue.Reset(blockCacheMaxItems, blockCacheInitialItems)
   385  	d.peers.Reset()
   386  
   387  	for _, ch := range []chan bool{d.bodyWakeCh, d.receiptWakeCh} {
   388  		select {
   389  		case <-ch:
   390  		default:
   391  		}
   392  	}
   393  	for _, ch := range []chan dataPack{d.headerCh, d.bodyCh, d.receiptCh} {
   394  		for empty := false; !empty; {
   395  			select {
   396  			case <-ch:
   397  			default:
   398  				empty = true
   399  			}
   400  		}
   401  	}
   402  	for empty := false; !empty; {
   403  		select {
   404  		case <-d.headerProcCh:
   405  		default:
   406  			empty = true
   407  		}
   408  	}
   409  	// Create cancel channel for aborting mid-flight and mark the master peer
   410  	d.cancelLock.Lock()
   411  	d.cancelCh = make(chan struct{})
   412  	d.cancelPeer = id
   413  	d.cancelLock.Unlock()
   414  
   415  	defer d.Cancel() // No matter what, we can't leave the cancel channel open
   416  
   417  	// Atomically set the requested sync mode
   418  	atomic.StoreUint32(&d.mode, uint32(mode))
   419  
   420  	// Retrieve the origin peer and initiate the downloading process
   421  	p := d.peers.Peer(id)
   422  	if p == nil {
   423  		return errUnknownPeer
   424  	}
   425  	return d.syncWithPeer(p, hash, td)
   426  }
   427  
   428  func (d *Downloader) getMode() SyncMode {
   429  	return SyncMode(atomic.LoadUint32(&d.mode))
   430  }
   431  
   432  // syncWithPeer starts a block synchronization based on the hash chain from the
   433  // specified peer and head hash.
   434  func (d *Downloader) syncWithPeer(p *peerConnection, hash common.Hash, td *big.Int) (err error) {
   435  	d.mux.Post(StartEvent{})
   436  	defer func() {
   437  		// reset on error
   438  		if err != nil {
   439  			d.mux.Post(FailedEvent{err})
   440  		} else {
   441  			latest := d.lightchain.CurrentHeader()
   442  			d.mux.Post(DoneEvent{latest})
   443  		}
   444  	}()
   445  	if p.version < eth.ETH66 {
   446  		return fmt.Errorf("%w: advertized %d < required %d", errTooOld, p.version, eth.ETH66)
   447  	}
   448  	mode := d.getMode()
   449  
   450  	log.Debug("Synchronising with the network", "peer", p.id, "eth", p.version, "head", hash, "td", td, "mode", mode)
   451  	defer func(start time.Time) {
   452  		log.Debug("Synchronisation terminated", "elapsed", common.PrettyDuration(time.Since(start)))
   453  	}(time.Now())
   454  
   455  	// Look up the sync boundaries: the common ancestor and the target block
   456  	latest, pivot, err := d.fetchHead(p)
   457  	if err != nil {
   458  		return err
   459  	}
   460  	if mode == FastSync && pivot == nil {
   461  		// If no pivot block was returned, the head is below the min full block
   462  		// threshold (i.e. new chain). In that case we won't really fast sync
   463  		// anyway, but still need a valid pivot block to avoid some code hitting
   464  		// nil panics on an access.
   465  		pivot = d.blockchain.CurrentBlock().Header()
   466  	}
   467  	height := latest.Number.Uint64()
   468  
   469  	origin, err := d.findAncestor(p, latest)
   470  	if err != nil {
   471  		return err
   472  	}
   473  	d.syncStatsLock.Lock()
   474  	if d.syncStatsChainHeight <= origin || d.syncStatsChainOrigin > origin {
   475  		d.syncStatsChainOrigin = origin
   476  	}
   477  	d.syncStatsChainHeight = height
   478  	d.syncStatsLock.Unlock()
   479  
   480  	// Ensure our origin point is below any fast sync pivot point
   481  	if mode == FastSync {
   482  		if height <= uint64(fsMinFullBlocks) {
   483  			origin = 0
   484  		} else {
   485  			pivotNumber := pivot.Number.Uint64()
   486  			if pivotNumber <= origin {
   487  				origin = pivotNumber - 1
   488  			}
   489  			// Write out the pivot into the database so a rollback beyond it will
   490  			// reenable fast sync
   491  			rawdb.WriteLastPivotNumber(d.stateDB, pivotNumber)
   492  		}
   493  	}
   494  	d.committed = 1
   495  	if mode == FastSync && pivot.Number.Uint64() != 0 {
   496  		d.committed = 0
   497  	}
   498  	if mode == FastSync {
   499  		// Set the ancient data limitation.
   500  		// If we are running fast sync, all block data older than ancientLimit will be
   501  		// written to the ancient store. More recent data will be written to the active
   502  		// database and will wait for the freezer to migrate.
   503  		//
   504  		// If there is a checkpoint available, then calculate the ancientLimit through
   505  		// that. Otherwise calculate the ancient limit through the advertised height
   506  		// of the remote peer.
   507  		//
   508  		// The reason for picking checkpoint first is that a malicious peer can give us
   509  		// a fake (very high) height, forcing the ancient limit to also be very high.
   510  		// The peer would start to feed us valid blocks until head, resulting in all of
   511  		// the blocks might be written into the ancient store. A following mini-reorg
   512  		// could cause issues.
   513  		if d.checkpoint != 0 && d.checkpoint > fullMaxForkAncestry+1 {
   514  			d.ancientLimit = d.checkpoint
   515  		} else if height > fullMaxForkAncestry+1 {
   516  			d.ancientLimit = height - fullMaxForkAncestry - 1
   517  		} else {
   518  			d.ancientLimit = 0
   519  		}
   520  		frozen, _ := d.stateDB.Ancients() // Ignore the error here since light client can also hit here.
   521  
   522  		// If a part of blockchain data has already been written into active store,
   523  		// disable the ancient style insertion explicitly.
   524  		if origin >= frozen && frozen != 0 {
   525  			d.ancientLimit = 0
   526  			log.Info("Disabling direct-ancient mode", "origin", origin, "ancient", frozen-1)
   527  		} else if d.ancientLimit > 0 {
   528  			log.Debug("Enabling direct-ancient mode", "ancient", d.ancientLimit)
   529  		}
   530  		// Rewind the ancient store and blockchain if reorg happens.
   531  		if origin+1 < frozen {
   532  			if err := d.lightchain.SetHead(origin + 1); err != nil {
   533  				return err
   534  			}
   535  		}
   536  	}
   537  	// Initiate the sync using a concurrent header and content retrieval algorithm
   538  	d.queue.Prepare(origin+1, mode)
   539  	if d.syncInitHook != nil {
   540  		d.syncInitHook(origin, height)
   541  	}
   542  	fetchers := []func() error{
   543  		func() error { return d.fetchHeaders(p, origin+1) }, // Headers are always retrieved
   544  		func() error { return d.fetchBodies(origin + 1) },   // Bodies are retrieved during normal and fast sync
   545  		func() error { return d.fetchReceipts(origin + 1) }, // Receipts are retrieved during fast sync
   546  		func() error { return d.processHeaders(origin+1, td) },
   547  	}
   548  	if mode == FastSync {
   549  		d.pivotLock.Lock()
   550  		d.pivotHeader = pivot
   551  		d.pivotLock.Unlock()
   552  
   553  		fetchers = append(fetchers, func() error { return d.processFastSyncContent() })
   554  	} else if mode == FullSync {
   555  		fetchers = append(fetchers, d.processFullSyncContent)
   556  	}
   557  	return d.spawnSync(fetchers)
   558  }
   559  
   560  // spawnSync runs d.process and all given fetcher functions to completion in
   561  // separate goroutines, returning the first error that appears.
   562  func (d *Downloader) spawnSync(fetchers []func() error) error {
   563  	errc := make(chan error, len(fetchers))
   564  	d.cancelWg.Add(len(fetchers))
   565  	for _, fn := range fetchers {
   566  		fn := fn
   567  		go func() { defer d.cancelWg.Done(); errc <- fn() }()
   568  	}
   569  	// Wait for the first error, then terminate the others.
   570  	var err error
   571  	for i := 0; i < len(fetchers); i++ {
   572  		if i == len(fetchers)-1 {
   573  			// Close the queue when all fetchers have exited.
   574  			// This will cause the block processor to end when
   575  			// it has processed the queue.
   576  			d.queue.Close()
   577  		}
   578  		if err = <-errc; err != nil && err != errCanceled {
   579  			break
   580  		}
   581  	}
   582  	d.queue.Close()
   583  	d.Cancel()
   584  	return err
   585  }
   586  
   587  // cancel aborts all of the operations and resets the queue. However, cancel does
   588  // not wait for the running download goroutines to finish. This method should be
   589  // used when cancelling the downloads from inside the downloader.
   590  func (d *Downloader) cancel() {
   591  	// Close the current cancel channel
   592  	d.cancelLock.Lock()
   593  	defer d.cancelLock.Unlock()
   594  
   595  	if d.cancelCh != nil {
   596  		select {
   597  		case <-d.cancelCh:
   598  			// Channel was already closed
   599  		default:
   600  			close(d.cancelCh)
   601  		}
   602  	}
   603  }
   604  
   605  // Cancel aborts all of the operations and waits for all download goroutines to
   606  // finish before returning.
   607  func (d *Downloader) Cancel() {
   608  	d.cancel()
   609  	d.cancelWg.Wait()
   610  }
   611  
   612  // Terminate interrupts the downloader, canceling all pending operations.
   613  // The downloader cannot be reused after calling Terminate.
   614  func (d *Downloader) Terminate() {
   615  	// Close the termination channel (make sure double close is allowed)
   616  	d.quitLock.Lock()
   617  	select {
   618  	case <-d.quitCh:
   619  	default:
   620  		close(d.quitCh)
   621  	}
   622  	d.quitLock.Unlock()
   623  
   624  	// Cancel any pending download requests
   625  	d.Cancel()
   626  }
   627  
   628  // fetchHead retrieves the head header and prior pivot block (if available) from
   629  // a remote peer.
   630  func (d *Downloader) fetchHead(p *peerConnection) (head *types.Header, pivot *types.Header, err error) {
   631  	p.log.Debug("Retrieving remote chain head")
   632  	mode := d.getMode()
   633  
   634  	// Request the advertised remote head block and wait for the response
   635  	latest, _ := p.peer.Head()
   636  	fetch := 1
   637  	if mode == FastSync {
   638  		fetch = 2 // head + pivot headers
   639  	}
   640  	go p.peer.RequestHeadersByHash(latest, fetch, fsMinFullBlocks-1, true)
   641  
   642  	ttl := d.peers.rates.TargetTimeout()
   643  	timeout := time.After(ttl)
   644  	for {
   645  		select {
   646  		case <-d.cancelCh:
   647  			return nil, nil, errCanceled
   648  
   649  		case packet := <-d.headerCh:
   650  			// Discard anything not from the origin peer
   651  			if packet.PeerId() != p.id {
   652  				log.Debug("Received headers from incorrect peer", "peer", packet.PeerId())
   653  				break
   654  			}
   655  			// Make sure the peer gave us at least one and at most the requested headers
   656  			headers := packet.(*headerPack).headers
   657  			if len(headers) == 0 || len(headers) > fetch {
   658  				return nil, nil, fmt.Errorf("%w: returned headers %d != requested %d", errBadPeer, len(headers), fetch)
   659  			}
   660  			// The first header needs to be the head, validate against the checkpoint
   661  			// and request. If only 1 header was returned, make sure there's no pivot
   662  			// or there was not one requested.
   663  			head := headers[0]
   664  			if (mode == FastSync || mode == LightSync) && head.Number.Uint64() < d.checkpoint {
   665  				return nil, nil, fmt.Errorf("%w: remote head %d below checkpoint %d", errUnsyncedPeer, head.Number, d.checkpoint)
   666  			}
   667  			if len(headers) == 1 {
   668  				if mode == FastSync && head.Number.Uint64() > uint64(fsMinFullBlocks) {
   669  					return nil, nil, fmt.Errorf("%w: no pivot included along head header", errBadPeer)
   670  				}
   671  				p.log.Debug("Remote head identified, no pivot", "number", head.Number, "hash", head.Hash())
   672  				return head, nil, nil
   673  			}
   674  			// At this point we have 2 headers in total and the first is the
   675  			// validated head of the chain. Check the pivot number and return,
   676  			pivot := headers[1]
   677  			if pivot.Number.Uint64() != head.Number.Uint64()-uint64(fsMinFullBlocks) {
   678  				return nil, nil, fmt.Errorf("%w: remote pivot %d != requested %d", errInvalidChain, pivot.Number, head.Number.Uint64()-uint64(fsMinFullBlocks))
   679  			}
   680  			return head, pivot, nil
   681  
   682  		case <-timeout:
   683  			p.log.Debug("Waiting for head header timed out", "elapsed", ttl)
   684  			return nil, nil, errTimeout
   685  
   686  		case <-d.bodyCh:
   687  		case <-d.receiptCh:
   688  			// Out of bounds delivery, ignore
   689  		}
   690  	}
   691  }
   692  
   693  // calculateRequestSpan calculates what headers to request from a peer when trying to determine the
   694  // common ancestor.
   695  // It returns parameters to be used for peer.RequestHeadersByNumber:
   696  //
   697  //	from  - starting block number
   698  //	count - number of headers to request
   699  //	skip  - number of headers to skip
   700  //
   701  // and also returns 'max', the last block which is expected to be returned by the remote peers,
   702  // given the (from,count,skip)
   703  func calculateRequestSpan(remoteHeight, localHeight uint64) (int64, int, int, uint64) {
   704  	var (
   705  		from     int
   706  		count    int
   707  		MaxCount = MaxHeaderFetch / 16
   708  	)
   709  	// requestHead is the highest block that we will ask for. If requestHead is not offset,
   710  	// the highest block that we will get is 16 blocks back from head, which means we
   711  	// will fetch 14 or 15 blocks unnecessarily in the case the height difference
   712  	// between us and the peer is 1-2 blocks, which is most common
   713  	requestHead := int(remoteHeight) - 1
   714  	if requestHead < 0 {
   715  		requestHead = 0
   716  	}
   717  	// requestBottom is the lowest block we want included in the query
   718  	// Ideally, we want to include the one just below our own head
   719  	requestBottom := int(localHeight - 1)
   720  	if requestBottom < 0 {
   721  		requestBottom = 0
   722  	}
   723  	totalSpan := requestHead - requestBottom
   724  	span := 1 + totalSpan/MaxCount
   725  	if span < 2 {
   726  		span = 2
   727  	}
   728  	if span > 16 {
   729  		span = 16
   730  	}
   731  
   732  	count = 1 + totalSpan/span
   733  	if count > MaxCount {
   734  		count = MaxCount
   735  	}
   736  	if count < 2 {
   737  		count = 2
   738  	}
   739  	from = requestHead - (count-1)*span
   740  	if from < 0 {
   741  		from = 0
   742  	}
   743  	max := from + (count-1)*span
   744  	return int64(from), count, span - 1, uint64(max)
   745  }
   746  
   747  // findAncestor tries to locate the common ancestor link of the local chain and
   748  // a remote peers blockchain. In the general case when our node was in sync and
   749  // on the correct chain, checking the top N links should already get us a match.
   750  // In the rare scenario when we ended up on a long reorganisation (i.e. none of
   751  // the head links match), we do a binary search to find the common ancestor.
   752  func (d *Downloader) findAncestor(p *peerConnection, remoteHeader *types.Header) (uint64, error) {
   753  	// Figure out the valid ancestor range to prevent rewrite attacks
   754  	var (
   755  		floor        = int64(-1)
   756  		localHeight  uint64
   757  		remoteHeight = remoteHeader.Number.Uint64()
   758  	)
   759  	mode := d.getMode()
   760  	switch mode {
   761  	case FullSync:
   762  		localHeight = d.blockchain.CurrentBlock().NumberU64()
   763  	case FastSync:
   764  		localHeight = d.blockchain.CurrentFastBlock().NumberU64()
   765  	default:
   766  		localHeight = d.lightchain.CurrentHeader().Number.Uint64()
   767  	}
   768  	p.log.Debug("Looking for common ancestor", "local", localHeight, "remote", remoteHeight)
   769  
   770  	// Recap floor value for binary search
   771  	maxForkAncestry := fullMaxForkAncestry
   772  	if d.getMode() == LightSync {
   773  		maxForkAncestry = lightMaxForkAncestry
   774  	}
   775  	if localHeight >= maxForkAncestry {
   776  		// We're above the max reorg threshold, find the earliest fork point
   777  		floor = int64(localHeight - maxForkAncestry)
   778  	}
   779  	// If we're doing a light sync, ensure the floor doesn't go below the CHT, as
   780  	// all headers before that point will be missing.
   781  	if mode == LightSync {
   782  		// If we don't know the current CHT position, find it
   783  		if d.genesis == 0 {
   784  			header := d.lightchain.CurrentHeader()
   785  			for header != nil {
   786  				d.genesis = header.Number.Uint64()
   787  				if floor >= int64(d.genesis)-1 {
   788  					break
   789  				}
   790  				header = d.lightchain.GetHeaderByHash(header.ParentHash)
   791  			}
   792  		}
   793  		// We already know the "genesis" block number, cap floor to that
   794  		if floor < int64(d.genesis)-1 {
   795  			floor = int64(d.genesis) - 1
   796  		}
   797  	}
   798  
   799  	ancestor, err := d.findAncestorSpanSearch(p, mode, remoteHeight, localHeight, floor)
   800  	if err == nil {
   801  		return ancestor, nil
   802  	}
   803  	// The returned error was not nil.
   804  	// If the error returned does not reflect that a common ancestor was not found, return it.
   805  	// If the error reflects that a common ancestor was not found, continue to binary search,
   806  	// where the error value will be reassigned.
   807  	if !errors.Is(err, errNoAncestorFound) {
   808  		return 0, err
   809  	}
   810  
   811  	ancestor, err = d.findAncestorBinarySearch(p, mode, remoteHeight, floor)
   812  	if err != nil {
   813  		return 0, err
   814  	}
   815  	return ancestor, nil
   816  }
   817  
   818  func (d *Downloader) findAncestorSpanSearch(p *peerConnection, mode SyncMode, remoteHeight, localHeight uint64, floor int64) (commonAncestor uint64, err error) {
   819  	from, count, skip, max := calculateRequestSpan(remoteHeight, localHeight)
   820  
   821  	p.log.Trace("Span searching for common ancestor", "count", count, "from", from, "skip", skip)
   822  	go p.peer.RequestHeadersByNumber(uint64(from), count, skip, false)
   823  
   824  	// Wait for the remote response to the head fetch
   825  	number, hash := uint64(0), common.Hash{}
   826  
   827  	ttl := d.peers.rates.TargetTimeout()
   828  	timeout := time.After(ttl)
   829  
   830  	for finished := false; !finished; {
   831  		select {
   832  		case <-d.cancelCh:
   833  			return 0, errCanceled
   834  
   835  		case packet := <-d.headerCh:
   836  			// Discard anything not from the origin peer
   837  			if packet.PeerId() != p.id {
   838  				log.Debug("Received headers from incorrect peer", "peer", packet.PeerId())
   839  				break
   840  			}
   841  			// Make sure the peer actually gave something valid
   842  			headers := packet.(*headerPack).headers
   843  			if len(headers) == 0 {
   844  				p.log.Warn("Empty head header set")
   845  				return 0, errEmptyHeaderSet
   846  			}
   847  			// Make sure the peer's reply conforms to the request
   848  			for i, header := range headers {
   849  				expectNumber := from + int64(i)*int64(skip+1)
   850  				if number := header.Number.Int64(); number != expectNumber {
   851  					p.log.Warn("Head headers broke chain ordering", "index", i, "requested", expectNumber, "received", number)
   852  					return 0, fmt.Errorf("%w: %v", errInvalidChain, errors.New("head headers broke chain ordering"))
   853  				}
   854  			}
   855  			// Check if a common ancestor was found
   856  			finished = true
   857  			for i := len(headers) - 1; i >= 0; i-- {
   858  				// Skip any headers that underflow/overflow our requested set
   859  				if headers[i].Number.Int64() < from || headers[i].Number.Uint64() > max {
   860  					continue
   861  				}
   862  				// Otherwise check if we already know the header or not
   863  				h := headers[i].Hash()
   864  				n := headers[i].Number.Uint64()
   865  
   866  				var known bool
   867  				switch mode {
   868  				case FullSync:
   869  					known = d.blockchain.HasBlock(h, n)
   870  				case FastSync:
   871  					known = d.blockchain.HasFastBlock(h, n)
   872  				default:
   873  					known = d.lightchain.HasHeader(h, n)
   874  				}
   875  				if known {
   876  					number, hash = n, h
   877  					break
   878  				}
   879  			}
   880  
   881  		case <-timeout:
   882  			p.log.Debug("Waiting for head header timed out", "elapsed", ttl)
   883  			return 0, errTimeout
   884  
   885  		case <-d.bodyCh:
   886  		case <-d.receiptCh:
   887  			// Out of bounds delivery, ignore
   888  		}
   889  	}
   890  	// If the head fetch already found an ancestor, return
   891  	if hash != (common.Hash{}) {
   892  		if int64(number) <= floor {
   893  			p.log.Warn("Ancestor below allowance", "number", number, "hash", hash, "allowance", floor)
   894  			return 0, errInvalidAncestor
   895  		}
   896  		p.log.Debug("Found common ancestor", "number", number, "hash", hash)
   897  		return number, nil
   898  	}
   899  	return 0, errNoAncestorFound
   900  }
   901  
   902  func (d *Downloader) findAncestorBinarySearch(p *peerConnection, mode SyncMode, remoteHeight uint64, floor int64) (commonAncestor uint64, err error) {
   903  	hash := common.Hash{}
   904  
   905  	// Ancestor not found, we need to binary search over our chain
   906  	start, end := uint64(0), remoteHeight
   907  	if floor > 0 {
   908  		start = uint64(floor)
   909  	}
   910  	p.log.Trace("Binary searching for common ancestor", "start", start, "end", end)
   911  
   912  	for start+1 < end {
   913  		// Split our chain interval in two, and request the hash to cross check
   914  		check := (start + end) / 2
   915  
   916  		ttl := d.peers.rates.TargetTimeout()
   917  		timeout := time.After(ttl)
   918  
   919  		go p.peer.RequestHeadersByNumber(check, 1, 0, false)
   920  
   921  		// Wait until a reply arrives to this request
   922  		for arrived := false; !arrived; {
   923  			select {
   924  			case <-d.cancelCh:
   925  				return 0, errCanceled
   926  
   927  			case packet := <-d.headerCh:
   928  				// Discard anything not from the origin peer
   929  				if packet.PeerId() != p.id {
   930  					log.Debug("Received headers from incorrect peer", "peer", packet.PeerId())
   931  					break
   932  				}
   933  				// Make sure the peer actually gave something valid
   934  				headers := packet.(*headerPack).headers
   935  				if len(headers) != 1 {
   936  					p.log.Warn("Multiple headers for single request", "headers", len(headers))
   937  					return 0, fmt.Errorf("%w: multiple headers (%d) for single request", errBadPeer, len(headers))
   938  				}
   939  				arrived = true
   940  
   941  				// Modify the search interval based on the response
   942  				h := headers[0].Hash()
   943  				n := headers[0].Number.Uint64()
   944  
   945  				var known bool
   946  				switch mode {
   947  				case FullSync:
   948  					known = d.blockchain.HasBlock(h, n)
   949  				case FastSync:
   950  					known = d.blockchain.HasFastBlock(h, n)
   951  				default:
   952  					known = d.lightchain.HasHeader(h, n)
   953  				}
   954  				if !known {
   955  					end = check
   956  					break
   957  				}
   958  				header := d.lightchain.GetHeaderByHash(h) // Independent of sync mode, header surely exists
   959  				if header.Number.Uint64() != check {
   960  					p.log.Warn("Received non requested header", "number", header.Number, "hash", header.Hash(), "request", check)
   961  					return 0, fmt.Errorf("%w: non-requested header (%d)", errBadPeer, header.Number)
   962  				}
   963  				start = check
   964  				hash = h
   965  
   966  			case <-timeout:
   967  				p.log.Debug("Waiting for search header timed out", "elapsed", ttl)
   968  				return 0, errTimeout
   969  
   970  			case <-d.bodyCh:
   971  			case <-d.receiptCh:
   972  				// Out of bounds delivery, ignore
   973  			}
   974  		}
   975  	}
   976  	// Ensure valid ancestry and return
   977  	if int64(start) <= floor {
   978  		p.log.Warn("Ancestor below allowance", "number", start, "hash", hash, "allowance", floor)
   979  		return 0, errInvalidAncestor
   980  	}
   981  	p.log.Debug("Found common ancestor", "number", start, "hash", hash)
   982  	return start, nil
   983  }
   984  
   985  // fetchHeaders keeps retrieving headers concurrently from the number
   986  // requested, until no more are returned, potentially throttling on the way. To
   987  // facilitate concurrency but still protect against malicious nodes sending bad
   988  // headers, we construct a header chain skeleton using the "origin" peer we are
   989  // syncing with, and fill in the missing headers using anyone else. Headers from
   990  // other peers are only accepted if they map cleanly to the skeleton. If no one
   991  // can fill in the skeleton - not even the origin peer - it's assumed invalid and
   992  // the origin is dropped.
   993  func (d *Downloader) fetchHeaders(p *peerConnection, from uint64) error {
   994  	p.log.Debug("Directing header downloads", "origin", from)
   995  	defer p.log.Debug("Header download terminated")
   996  
   997  	// Create a timeout timer, and the associated header fetcher
   998  	skeleton := true            // Skeleton assembly phase or finishing up
   999  	pivoting := false           // Whether the next request is pivot verification
  1000  	request := time.Now()       // time of the last skeleton fetch request
  1001  	timeout := time.NewTimer(0) // timer to dump a non-responsive active peer
  1002  	<-timeout.C                 // timeout channel should be initially empty
  1003  	defer timeout.Stop()
  1004  
  1005  	var ttl time.Duration
  1006  	getHeaders := func(from uint64) {
  1007  		request = time.Now()
  1008  
  1009  		ttl = d.peers.rates.TargetTimeout()
  1010  		timeout.Reset(ttl)
  1011  
  1012  		if skeleton {
  1013  			p.log.Trace("Fetching skeleton headers", "count", MaxHeaderFetch, "from", from)
  1014  			go p.peer.RequestHeadersByNumber(from+uint64(MaxHeaderFetch)-1, MaxSkeletonSize, MaxHeaderFetch-1, false)
  1015  		} else {
  1016  			p.log.Trace("Fetching full headers", "count", MaxHeaderFetch, "from", from)
  1017  			go p.peer.RequestHeadersByNumber(from, MaxHeaderFetch, 0, false)
  1018  		}
  1019  	}
  1020  	getNextPivot := func() {
  1021  		pivoting = true
  1022  		request = time.Now()
  1023  
  1024  		ttl = d.peers.rates.TargetTimeout()
  1025  		timeout.Reset(ttl)
  1026  
  1027  		d.pivotLock.RLock()
  1028  		pivot := d.pivotHeader.Number.Uint64()
  1029  		d.pivotLock.RUnlock()
  1030  
  1031  		p.log.Trace("Fetching next pivot header", "number", pivot+uint64(fsMinFullBlocks))
  1032  		go p.peer.RequestHeadersByNumber(pivot+uint64(fsMinFullBlocks), 2, fsMinFullBlocks-9, false) // move +64 when it's 2x64-8 deep
  1033  	}
  1034  	// Start pulling the header chain skeleton until all is done
  1035  	ancestor := from
  1036  	getHeaders(from)
  1037  
  1038  	mode := d.getMode()
  1039  	for {
  1040  		select {
  1041  		case <-d.cancelCh:
  1042  			return errCanceled
  1043  
  1044  		case packet := <-d.headerCh:
  1045  			// Make sure the active peer is giving us the skeleton headers
  1046  			if packet.PeerId() != p.id {
  1047  				log.Debug("Received skeleton from incorrect peer", "peer", packet.PeerId())
  1048  				break
  1049  			}
  1050  			headerReqTimer.UpdateSince(request)
  1051  			timeout.Stop()
  1052  
  1053  			// If the pivot is being checked, move if it became stale and run the real retrieval
  1054  			var pivot uint64
  1055  
  1056  			d.pivotLock.RLock()
  1057  			if d.pivotHeader != nil {
  1058  				pivot = d.pivotHeader.Number.Uint64()
  1059  			}
  1060  			d.pivotLock.RUnlock()
  1061  
  1062  			if pivoting {
  1063  				if packet.Items() == 2 {
  1064  					// Retrieve the headers and do some sanity checks, just in case
  1065  					headers := packet.(*headerPack).headers
  1066  
  1067  					if have, want := headers[0].Number.Uint64(), pivot+uint64(fsMinFullBlocks); have != want {
  1068  						log.Warn("Peer sent invalid next pivot", "have", have, "want", want)
  1069  						return fmt.Errorf("%w: next pivot number %d != requested %d", errInvalidChain, have, want)
  1070  					}
  1071  					if have, want := headers[1].Number.Uint64(), pivot+2*uint64(fsMinFullBlocks)-8; have != want {
  1072  						log.Warn("Peer sent invalid pivot confirmer", "have", have, "want", want)
  1073  						return fmt.Errorf("%w: next pivot confirmer number %d != requested %d", errInvalidChain, have, want)
  1074  					}
  1075  					log.Warn("Pivot seemingly stale, moving", "old", pivot, "new", headers[0].Number)
  1076  					pivot = headers[0].Number.Uint64()
  1077  
  1078  					d.pivotLock.Lock()
  1079  					d.pivotHeader = headers[0]
  1080  					d.pivotLock.Unlock()
  1081  
  1082  					// Write out the pivot into the database so a rollback beyond
  1083  					// it will reenable fast sync and update the state root that
  1084  					// the state syncer will be downloading.
  1085  					rawdb.WriteLastPivotNumber(d.stateDB, pivot)
  1086  				}
  1087  				pivoting = false
  1088  				getHeaders(from)
  1089  				continue
  1090  			}
  1091  			// If the skeleton's finished, pull any remaining head headers directly from the origin
  1092  			if skeleton && packet.Items() == 0 {
  1093  				skeleton = false
  1094  				getHeaders(from)
  1095  				continue
  1096  			}
  1097  			// If no more headers are inbound, notify the content fetchers and return
  1098  			if packet.Items() == 0 {
  1099  				// Don't abort header fetches while the pivot is downloading
  1100  				if atomic.LoadInt32(&d.committed) == 0 && pivot <= from {
  1101  					p.log.Debug("No headers, waiting for pivot commit")
  1102  					select {
  1103  					case <-time.After(fsHeaderContCheck):
  1104  						getHeaders(from)
  1105  						continue
  1106  					case <-d.cancelCh:
  1107  						return errCanceled
  1108  					}
  1109  				}
  1110  				// Pivot done (or not in fast sync) and no more headers, terminate the process
  1111  				p.log.Debug("No more headers available")
  1112  				select {
  1113  				case d.headerProcCh <- nil:
  1114  					return nil
  1115  				case <-d.cancelCh:
  1116  					return errCanceled
  1117  				}
  1118  			}
  1119  			headers := packet.(*headerPack).headers
  1120  
  1121  			// If we received a skeleton batch, resolve internals concurrently
  1122  			if skeleton {
  1123  				filled, proced, err := d.fillHeaderSkeleton(from, headers)
  1124  				if err != nil {
  1125  					p.log.Debug("Skeleton chain invalid", "err", err)
  1126  					return fmt.Errorf("%w: %v", errInvalidChain, err)
  1127  				}
  1128  				headers = filled[proced:]
  1129  				from += uint64(proced)
  1130  			} else {
  1131  				// If we're closing in on the chain head, but haven't yet reached it, delay
  1132  				// the last few headers so mini reorgs on the head don't cause invalid hash
  1133  				// chain errors.
  1134  				if n := len(headers); n > 0 {
  1135  					// Retrieve the current head we're at
  1136  					var head uint64
  1137  					if mode == LightSync {
  1138  						head = d.lightchain.CurrentHeader().Number.Uint64()
  1139  					} else {
  1140  						head = d.blockchain.CurrentFastBlock().NumberU64()
  1141  						if full := d.blockchain.CurrentBlock().NumberU64(); head < full {
  1142  							head = full
  1143  						}
  1144  					}
  1145  					// If the head is below the common ancestor, we're actually deduplicating
  1146  					// already existing chain segments, so use the ancestor as the fake head.
  1147  					// Otherwise we might end up delaying header deliveries pointlessly.
  1148  					if head < ancestor {
  1149  						head = ancestor
  1150  					}
  1151  					// If the head is way older than this batch, delay the last few headers
  1152  					if head+uint64(reorgProtThreshold) < headers[n-1].Number.Uint64() {
  1153  						delay := reorgProtHeaderDelay
  1154  						if delay > n {
  1155  							delay = n
  1156  						}
  1157  						headers = headers[:n-delay]
  1158  					}
  1159  				}
  1160  			}
  1161  			// Insert all the new headers and fetch the next batch
  1162  			if len(headers) > 0 {
  1163  				p.log.Trace("Scheduling new headers", "count", len(headers), "from", from)
  1164  				select {
  1165  				case d.headerProcCh <- headers:
  1166  				case <-d.cancelCh:
  1167  					return errCanceled
  1168  				}
  1169  				from += uint64(len(headers))
  1170  
  1171  				// If we're still skeleton filling fast sync, check pivot staleness
  1172  				// before continuing to the next skeleton filling
  1173  				if skeleton && pivot > 0 {
  1174  					getNextPivot()
  1175  				} else {
  1176  					getHeaders(from)
  1177  				}
  1178  			} else {
  1179  				// No headers delivered, or all of them being delayed, sleep a bit and retry
  1180  				p.log.Trace("All headers delayed, waiting")
  1181  				select {
  1182  				case <-time.After(fsHeaderContCheck):
  1183  					getHeaders(from)
  1184  					continue
  1185  				case <-d.cancelCh:
  1186  					return errCanceled
  1187  				}
  1188  			}
  1189  
  1190  		case <-timeout.C:
  1191  			if d.dropPeer == nil {
  1192  				// The dropPeer method is nil when `--copydb` is used for a local copy.
  1193  				// Timeouts can occur if e.g. compaction hits at the wrong time, and can be ignored
  1194  				p.log.Warn("Downloader wants to drop peer, but peerdrop-function is not set", "peer", p.id)
  1195  				break
  1196  			}
  1197  			// Header retrieval timed out, consider the peer bad and drop
  1198  			p.log.Debug("Header request timed out", "elapsed", ttl)
  1199  			headerTimeoutMeter.Mark(1)
  1200  			d.dropPeer(p.id)
  1201  
  1202  			// Finish the sync gracefully instead of dumping the gathered data though
  1203  			for _, ch := range []chan bool{d.bodyWakeCh, d.receiptWakeCh} {
  1204  				select {
  1205  				case ch <- false:
  1206  				case <-d.cancelCh:
  1207  				}
  1208  			}
  1209  			select {
  1210  			case d.headerProcCh <- nil:
  1211  			case <-d.cancelCh:
  1212  			}
  1213  			return fmt.Errorf("%w: header request timed out", errBadPeer)
  1214  		}
  1215  	}
  1216  }
  1217  
  1218  // fillHeaderSkeleton concurrently retrieves headers from all our available peers
  1219  // and maps them to the provided skeleton header chain.
  1220  //
  1221  // Any partial results from the beginning of the skeleton is (if possible) forwarded
  1222  // immediately to the header processor to keep the rest of the pipeline full even
  1223  // in the case of header stalls.
  1224  //
  1225  // The method returns the entire filled skeleton and also the number of headers
  1226  // already forwarded for processing.
  1227  func (d *Downloader) fillHeaderSkeleton(from uint64, skeleton []*types.Header) ([]*types.Header, int, error) {
  1228  	log.Debug("Filling up skeleton", "from", from)
  1229  	d.queue.ScheduleSkeleton(from, skeleton)
  1230  
  1231  	var (
  1232  		deliver = func(packet dataPack) (int, error) {
  1233  			pack := packet.(*headerPack)
  1234  			return d.queue.DeliverHeaders(pack.peerID, pack.headers, d.headerProcCh)
  1235  		}
  1236  		expire  = func() map[string]int { return d.queue.ExpireHeaders(d.peers.rates.TargetTimeout()) }
  1237  		reserve = func(p *peerConnection, count int) (*fetchRequest, bool, bool) {
  1238  			return d.queue.ReserveHeaders(p, count), false, false
  1239  		}
  1240  		fetch    = func(p *peerConnection, req *fetchRequest) error { return p.FetchHeaders(req.From, MaxHeaderFetch) }
  1241  		capacity = func(p *peerConnection) int { return p.HeaderCapacity(d.peers.rates.TargetRoundTrip()) }
  1242  		setIdle  = func(p *peerConnection, accepted int, deliveryTime time.Time) {
  1243  			p.SetHeadersIdle(accepted, deliveryTime)
  1244  		}
  1245  	)
  1246  	err := d.fetchParts(d.headerCh, deliver, d.queue.headerContCh, expire,
  1247  		d.queue.PendingHeaders, d.queue.InFlightHeaders, reserve,
  1248  		nil, fetch, d.queue.CancelHeaders, capacity, d.peers.HeaderIdlePeers, setIdle, "headers")
  1249  
  1250  	log.Debug("Skeleton fill terminated", "err", err)
  1251  
  1252  	filled, proced := d.queue.RetrieveHeaders()
  1253  	return filled, proced, err
  1254  }
  1255  
  1256  // fetchBodies iteratively downloads the scheduled block bodies, taking any
  1257  // available peers, reserving a chunk of blocks for each, waiting for delivery
  1258  // and also periodically checking for timeouts.
  1259  func (d *Downloader) fetchBodies(from uint64) error {
  1260  	log.Debug("Downloading block bodies", "origin", from)
  1261  
  1262  	var (
  1263  		deliver = func(packet dataPack) (int, error) {
  1264  			pack := packet.(*bodyPack)
  1265  			return d.queue.DeliverBodies(pack.peerID, pack.transactions, pack.uncles)
  1266  		}
  1267  		expire   = func() map[string]int { return d.queue.ExpireBodies(d.peers.rates.TargetTimeout()) }
  1268  		fetch    = func(p *peerConnection, req *fetchRequest) error { return p.FetchBodies(req) }
  1269  		capacity = func(p *peerConnection) int { return p.BlockCapacity(d.peers.rates.TargetRoundTrip()) }
  1270  		setIdle  = func(p *peerConnection, accepted int, deliveryTime time.Time) { p.SetBodiesIdle(accepted, deliveryTime) }
  1271  	)
  1272  	err := d.fetchParts(d.bodyCh, deliver, d.bodyWakeCh, expire,
  1273  		d.queue.PendingBlocks, d.queue.InFlightBlocks, d.queue.ReserveBodies,
  1274  		d.bodyFetchHook, fetch, d.queue.CancelBodies, capacity, d.peers.BodyIdlePeers, setIdle, "bodies")
  1275  
  1276  	log.Debug("Block body download terminated", "err", err)
  1277  	return err
  1278  }
  1279  
  1280  // fetchReceipts iteratively downloads the scheduled block receipts, taking any
  1281  // available peers, reserving a chunk of receipts for each, waiting for delivery
  1282  // and also periodically checking for timeouts.
  1283  func (d *Downloader) fetchReceipts(from uint64) error {
  1284  	log.Debug("Downloading transaction receipts", "origin", from)
  1285  
  1286  	var (
  1287  		deliver = func(packet dataPack) (int, error) {
  1288  			pack := packet.(*receiptPack)
  1289  			return d.queue.DeliverReceipts(pack.peerID, pack.receipts)
  1290  		}
  1291  		expire   = func() map[string]int { return d.queue.ExpireReceipts(d.peers.rates.TargetTimeout()) }
  1292  		fetch    = func(p *peerConnection, req *fetchRequest) error { return p.FetchReceipts(req) }
  1293  		capacity = func(p *peerConnection) int { return p.ReceiptCapacity(d.peers.rates.TargetRoundTrip()) }
  1294  		setIdle  = func(p *peerConnection, accepted int, deliveryTime time.Time) {
  1295  			p.SetReceiptsIdle(accepted, deliveryTime)
  1296  		}
  1297  	)
  1298  	err := d.fetchParts(d.receiptCh, deliver, d.receiptWakeCh, expire,
  1299  		d.queue.PendingReceipts, d.queue.InFlightReceipts, d.queue.ReserveReceipts,
  1300  		d.receiptFetchHook, fetch, d.queue.CancelReceipts, capacity, d.peers.ReceiptIdlePeers, setIdle, "receipts")
  1301  
  1302  	log.Debug("Transaction receipt download terminated", "err", err)
  1303  	return err
  1304  }
  1305  
  1306  // fetchParts iteratively downloads scheduled block parts, taking any available
  1307  // peers, reserving a chunk of fetch requests for each, waiting for delivery and
  1308  // also periodically checking for timeouts.
  1309  //
  1310  // As the scheduling/timeout logic mostly is the same for all downloaded data
  1311  // types, this method is used by each for data gathering and is instrumented with
  1312  // various callbacks to handle the slight differences between processing them.
  1313  //
  1314  // The instrumentation parameters:
  1315  //   - errCancel:   error type to return if the fetch operation is cancelled (mostly makes logging nicer)
  1316  //   - deliveryCh:  channel from which to retrieve downloaded data packets (merged from all concurrent peers)
  1317  //   - deliver:     processing callback to deliver data packets into type specific download queues (usually within `queue`)
  1318  //   - wakeCh:      notification channel for waking the fetcher when new tasks are available (or sync completed)
  1319  //   - expire:      task callback method to abort requests that took too long and return the faulty peers (traffic shaping)
  1320  //   - pending:     task callback for the number of requests still needing download (detect completion/non-completability)
  1321  //   - inFlight:    task callback for the number of in-progress requests (wait for all active downloads to finish)
  1322  //   - throttle:    task callback to check if the processing queue is full and activate throttling (bound memory use)
  1323  //   - reserve:     task callback to reserve new download tasks to a particular peer (also signals partial completions)
  1324  //   - fetchHook:   tester callback to notify of new tasks being initiated (allows testing the scheduling logic)
  1325  //   - fetch:       network callback to actually send a particular download request to a physical remote peer
  1326  //   - cancel:      task callback to abort an in-flight download request and allow rescheduling it (in case of lost peer)
  1327  //   - capacity:    network callback to retrieve the estimated type-specific bandwidth capacity of a peer (traffic shaping)
  1328  //   - idle:        network callback to retrieve the currently (type specific) idle peers that can be assigned tasks
  1329  //   - setIdle:     network callback to set a peer back to idle and update its estimated capacity (traffic shaping)
  1330  //   - kind:        textual label of the type being downloaded to display in log messages
  1331  func (d *Downloader) fetchParts(deliveryCh chan dataPack, deliver func(dataPack) (int, error), wakeCh chan bool,
  1332  	expire func() map[string]int, pending func() int, inFlight func() bool, reserve func(*peerConnection, int) (*fetchRequest, bool, bool),
  1333  	fetchHook func([]*types.Header), fetch func(*peerConnection, *fetchRequest) error, cancel func(*fetchRequest), capacity func(*peerConnection) int,
  1334  	idle func() ([]*peerConnection, int), setIdle func(*peerConnection, int, time.Time), kind string) error {
  1335  	// Create a ticker to detect expired retrieval tasks
  1336  	ticker := time.NewTicker(100 * time.Millisecond)
  1337  	defer ticker.Stop()
  1338  
  1339  	update := make(chan struct{}, 1)
  1340  
  1341  	// Prepare the queue and fetch block parts until the block header fetcher's done
  1342  	finished := false
  1343  	for {
  1344  		select {
  1345  		case <-d.cancelCh:
  1346  			return errCanceled
  1347  
  1348  		case packet := <-deliveryCh:
  1349  			deliveryTime := time.Now()
  1350  			// If the peer was previously banned and failed to deliver its pack
  1351  			// in a reasonable time frame, ignore its message.
  1352  			if peer := d.peers.Peer(packet.PeerId()); peer != nil {
  1353  				// Deliver the received chunk of data and check chain validity
  1354  				accepted, err := deliver(packet)
  1355  				if errors.Is(err, errInvalidChain) {
  1356  					return err
  1357  				}
  1358  				// Unless a peer delivered something completely else than requested (usually
  1359  				// caused by a timed out request which came through in the end), set it to
  1360  				// idle. If the delivery's stale, the peer should have already been idled.
  1361  				if !errors.Is(err, errStaleDelivery) {
  1362  					setIdle(peer, accepted, deliveryTime)
  1363  				}
  1364  				// Issue a log to the user to see what's going on
  1365  				switch {
  1366  				case err == nil && packet.Items() == 0:
  1367  					peer.log.Trace("Requested data not delivered", "type", kind)
  1368  				case err == nil:
  1369  					peer.log.Trace("Delivered new batch of data", "type", kind, "count", packet.Stats())
  1370  				default:
  1371  					peer.log.Debug("Failed to deliver retrieved data", "type", kind, "err", err)
  1372  				}
  1373  			}
  1374  			// Blocks assembled, try to update the progress
  1375  			select {
  1376  			case update <- struct{}{}:
  1377  			default:
  1378  			}
  1379  
  1380  		case cont := <-wakeCh:
  1381  			// The header fetcher sent a continuation flag, check if it's done
  1382  			if !cont {
  1383  				finished = true
  1384  			}
  1385  			// Headers arrive, try to update the progress
  1386  			select {
  1387  			case update <- struct{}{}:
  1388  			default:
  1389  			}
  1390  
  1391  		case <-ticker.C:
  1392  			// Sanity check update the progress
  1393  			select {
  1394  			case update <- struct{}{}:
  1395  			default:
  1396  			}
  1397  
  1398  		case <-update:
  1399  			// Short circuit if we lost all our peers
  1400  			if d.peers.Len() == 0 {
  1401  				return errNoPeers
  1402  			}
  1403  			// Check for fetch request timeouts and demote the responsible peers
  1404  			for pid, fails := range expire() {
  1405  				if peer := d.peers.Peer(pid); peer != nil {
  1406  					// If a lot of retrieval elements expired, we might have overestimated the remote peer or perhaps
  1407  					// ourselves. Only reset to minimal throughput but don't drop just yet. If even the minimal times
  1408  					// out that sync wise we need to get rid of the peer.
  1409  					//
  1410  					// The reason the minimum threshold is 2 is because the downloader tries to estimate the bandwidth
  1411  					// and latency of a peer separately, which requires pushing the measures capacity a bit and seeing
  1412  					// how response times reacts, to it always requests one more than the minimum (i.e. min 2).
  1413  					if fails > 2 {
  1414  						peer.log.Trace("Data delivery timed out", "type", kind)
  1415  						setIdle(peer, 0, time.Now())
  1416  					} else {
  1417  						peer.log.Debug("Stalling delivery, dropping", "type", kind)
  1418  
  1419  						if d.dropPeer == nil {
  1420  							// The dropPeer method is nil when `--copydb` is used for a local copy.
  1421  							// Timeouts can occur if e.g. compaction hits at the wrong time, and can be ignored
  1422  							peer.log.Warn("Downloader wants to drop peer, but peerdrop-function is not set", "peer", pid)
  1423  						} else {
  1424  							d.dropPeer(pid)
  1425  
  1426  							// If this peer was the master peer, abort sync immediately
  1427  							d.cancelLock.RLock()
  1428  							master := pid == d.cancelPeer
  1429  							d.cancelLock.RUnlock()
  1430  
  1431  							if master {
  1432  								d.cancel()
  1433  								return errTimeout
  1434  							}
  1435  						}
  1436  					}
  1437  				}
  1438  			}
  1439  			// If there's nothing more to fetch, wait or terminate
  1440  			if pending() == 0 {
  1441  				if !inFlight() && finished {
  1442  					log.Debug("Data fetching completed", "type", kind)
  1443  					return nil
  1444  				}
  1445  				break
  1446  			}
  1447  			// Send a download request to all idle peers, until throttled
  1448  			progressed, throttled, running := false, false, inFlight()
  1449  			idles, total := idle()
  1450  			pendCount := pending()
  1451  			for _, peer := range idles {
  1452  				// Short circuit if throttling activated
  1453  				if throttled {
  1454  					break
  1455  				}
  1456  				// Short circuit if there is no more available task.
  1457  				if pendCount = pending(); pendCount == 0 {
  1458  					break
  1459  				}
  1460  				// Reserve a chunk of fetches for a peer. A nil can mean either that
  1461  				// no more headers are available, or that the peer is known not to
  1462  				// have them.
  1463  				request, progress, throttle := reserve(peer, capacity(peer))
  1464  				if progress {
  1465  					progressed = true
  1466  				}
  1467  				if throttle {
  1468  					throttled = true
  1469  					throttleCounter.Inc(1)
  1470  				}
  1471  				if request == nil {
  1472  					continue
  1473  				}
  1474  				if request.From > 0 {
  1475  					peer.log.Trace("Requesting new batch of data", "type", kind, "from", request.From)
  1476  				} else {
  1477  					peer.log.Trace("Requesting new batch of data", "type", kind, "count", len(request.Headers), "from", request.Headers[0].Number)
  1478  				}
  1479  				// Fetch the chunk and make sure any errors return the hashes to the queue
  1480  				if fetchHook != nil {
  1481  					fetchHook(request.Headers)
  1482  				}
  1483  				if err := fetch(peer, request); err != nil {
  1484  					// Although we could try and make an attempt to fix this, this error really
  1485  					// means that we've double allocated a fetch task to a peer. If that is the
  1486  					// case, the internal state of the downloader and the queue is very wrong so
  1487  					// better hard crash and note the error instead of silently accumulating into
  1488  					// a much bigger issue.
  1489  					panic(fmt.Sprintf("%v: %s fetch assignment failed", peer, kind))
  1490  				}
  1491  				running = true
  1492  			}
  1493  			// Make sure that we have peers available for fetching. If all peers have been tried
  1494  			// and all failed throw an error
  1495  			if !progressed && !throttled && !running && len(idles) == total && pendCount > 0 {
  1496  				return errPeersUnavailable
  1497  			}
  1498  		}
  1499  	}
  1500  }
  1501  
  1502  // processHeaders takes batches of retrieved headers from an input channel and
  1503  // keeps processing and scheduling them into the header chain and downloader's
  1504  // queue until the stream ends or a failure occurs.
  1505  func (d *Downloader) processHeaders(origin uint64, td *big.Int) error {
  1506  	// Keep a count of uncertain headers to roll back
  1507  	var (
  1508  		rollback    uint64 // Zero means no rollback (fine as you can't unroll the genesis)
  1509  		rollbackErr error
  1510  		mode        = d.getMode()
  1511  	)
  1512  	defer func() {
  1513  		if rollback > 0 {
  1514  			lastHeader, lastFastBlock, lastBlock := d.lightchain.CurrentHeader().Number, common.Big0, common.Big0
  1515  			if mode != LightSync {
  1516  				lastFastBlock = d.blockchain.CurrentFastBlock().Number()
  1517  				lastBlock = d.blockchain.CurrentBlock().Number()
  1518  			}
  1519  			if err := d.lightchain.SetHead(rollback - 1); err != nil { // -1 to target the parent of the first uncertain block
  1520  				// We're already unwinding the stack, only print the error to make it more visible
  1521  				log.Error("Failed to roll back chain segment", "head", rollback-1, "err", err)
  1522  			}
  1523  			curFastBlock, curBlock := common.Big0, common.Big0
  1524  			if mode != LightSync {
  1525  				curFastBlock = d.blockchain.CurrentFastBlock().Number()
  1526  				curBlock = d.blockchain.CurrentBlock().Number()
  1527  			}
  1528  			log.Warn("Rolled back chain segment",
  1529  				"header", fmt.Sprintf("%d->%d", lastHeader, d.lightchain.CurrentHeader().Number),
  1530  				"fast", fmt.Sprintf("%d->%d", lastFastBlock, curFastBlock),
  1531  				"block", fmt.Sprintf("%d->%d", lastBlock, curBlock), "reason", rollbackErr)
  1532  		}
  1533  	}()
  1534  	// Wait for batches of headers to process
  1535  	gotHeaders := false
  1536  
  1537  	for {
  1538  		select {
  1539  		case <-d.cancelCh:
  1540  			rollbackErr = errCanceled
  1541  			return errCanceled
  1542  
  1543  		case headers := <-d.headerProcCh:
  1544  			// Terminate header processing if we synced up
  1545  			if len(headers) == 0 {
  1546  				// Notify everyone that headers are fully processed
  1547  				for _, ch := range []chan bool{d.bodyWakeCh, d.receiptWakeCh} {
  1548  					select {
  1549  					case ch <- false:
  1550  					case <-d.cancelCh:
  1551  					}
  1552  				}
  1553  				// If no headers were retrieved at all, the peer violated its TD promise that it had a
  1554  				// better chain compared to ours. The only exception is if its promised blocks were
  1555  				// already imported by other means (e.g. fetcher):
  1556  				//
  1557  				// R <remote peer>, L <local node>: Both at block 10
  1558  				// R: Mine block 11, and propagate it to L
  1559  				// L: Queue block 11 for import
  1560  				// L: Notice that R's head and TD increased compared to ours, start sync
  1561  				// L: Import of block 11 finishes
  1562  				// L: Sync begins, and finds common ancestor at 11
  1563  				// L: Request new headers up from 11 (R's TD was higher, it must have something)
  1564  				// R: Nothing to give
  1565  				if mode != LightSync {
  1566  					head := d.blockchain.CurrentBlock()
  1567  					if !gotHeaders && td.Cmp(d.blockchain.GetTd(head.Hash(), head.NumberU64())) > 0 {
  1568  						return errStallingPeer
  1569  					}
  1570  				}
  1571  				// If fast or light syncing, ensure promised headers are indeed delivered. This is
  1572  				// needed to detect scenarios where an attacker feeds a bad pivot and then bails out
  1573  				// of delivering the post-pivot blocks that would flag the invalid content.
  1574  				//
  1575  				// This check cannot be executed "as is" for full imports, since blocks may still be
  1576  				// queued for processing when the header download completes. However, as long as the
  1577  				// peer gave us something useful, we're already happy/progressed (above check).
  1578  				if mode == FastSync || mode == LightSync {
  1579  					head := d.lightchain.CurrentHeader()
  1580  					if td.Cmp(d.lightchain.GetTd(head.Hash(), head.Number.Uint64())) > 0 {
  1581  						return errStallingPeer
  1582  					}
  1583  				}
  1584  				// Disable any rollback and return
  1585  				rollback = 0
  1586  				return nil
  1587  			}
  1588  			// Otherwise split the chunk of headers into batches and process them
  1589  			gotHeaders = true
  1590  			for len(headers) > 0 {
  1591  				// Terminate if something failed in between processing chunks
  1592  				select {
  1593  				case <-d.cancelCh:
  1594  					rollbackErr = errCanceled
  1595  					return errCanceled
  1596  				default:
  1597  				}
  1598  				// Select the next chunk of headers to import
  1599  				limit := maxHeadersProcess
  1600  				if limit > len(headers) {
  1601  					limit = len(headers)
  1602  				}
  1603  				chunk := headers[:limit]
  1604  
  1605  				// In case of header only syncing, validate the chunk immediately
  1606  				if mode == FastSync || mode == LightSync {
  1607  					// If we're importing pure headers, verify based on their recentness
  1608  					var pivot uint64
  1609  
  1610  					d.pivotLock.RLock()
  1611  					if d.pivotHeader != nil {
  1612  						pivot = d.pivotHeader.Number.Uint64()
  1613  					}
  1614  					d.pivotLock.RUnlock()
  1615  
  1616  					frequency := fsHeaderCheckFrequency
  1617  					if chunk[len(chunk)-1].Number.Uint64()+uint64(fsHeaderForceVerify) > pivot {
  1618  						frequency = 1
  1619  					}
  1620  					if n, err := d.lightchain.InsertHeaderChain(chunk, frequency); err != nil {
  1621  						rollbackErr = err
  1622  
  1623  						// If some headers were inserted, track them as uncertain
  1624  						if (mode == FastSync || frequency > 1) && n > 0 && rollback == 0 {
  1625  							rollback = chunk[0].Number.Uint64()
  1626  						}
  1627  						log.Warn("Invalid header encountered", "number", chunk[n].Number, "hash", chunk[n].Hash(), "parent", chunk[n].ParentHash, "err", err)
  1628  						return fmt.Errorf("%w: %v", errInvalidChain, err)
  1629  					}
  1630  					// All verifications passed, track all headers within the allotted limits
  1631  					if mode == FastSync {
  1632  						head := chunk[len(chunk)-1].Number.Uint64()
  1633  						if head-rollback > uint64(fsHeaderSafetyNet) {
  1634  							rollback = head - uint64(fsHeaderSafetyNet)
  1635  						} else {
  1636  							rollback = 1
  1637  						}
  1638  					}
  1639  				}
  1640  				// Unless we're doing light chains, schedule the headers for associated content retrieval
  1641  				if mode == FullSync || mode == FastSync {
  1642  					// If we've reached the allowed number of pending headers, stall a bit
  1643  					for d.queue.PendingBlocks() >= maxQueuedHeaders || d.queue.PendingReceipts() >= maxQueuedHeaders {
  1644  						select {
  1645  						case <-d.cancelCh:
  1646  							rollbackErr = errCanceled
  1647  							return errCanceled
  1648  						case <-time.After(time.Second):
  1649  						}
  1650  					}
  1651  					// Otherwise insert the headers for content retrieval
  1652  					inserts := d.queue.Schedule(chunk, origin)
  1653  					if len(inserts) != len(chunk) {
  1654  						rollbackErr = fmt.Errorf("stale headers: len inserts %v len(chunk) %v", len(inserts), len(chunk))
  1655  						return fmt.Errorf("%w: stale headers", errBadPeer)
  1656  					}
  1657  				}
  1658  				headers = headers[limit:]
  1659  				origin += uint64(limit)
  1660  			}
  1661  			// Update the highest block number we know if a higher one is found.
  1662  			d.syncStatsLock.Lock()
  1663  			if d.syncStatsChainHeight < origin {
  1664  				d.syncStatsChainHeight = origin - 1
  1665  			}
  1666  			d.syncStatsLock.Unlock()
  1667  
  1668  			// Signal the content downloaders of the availability of new tasks
  1669  			for _, ch := range []chan bool{d.bodyWakeCh, d.receiptWakeCh} {
  1670  				select {
  1671  				case ch <- true:
  1672  				default:
  1673  				}
  1674  			}
  1675  		}
  1676  	}
  1677  }
  1678  
  1679  // processFullSyncContent takes fetch results from the queue and imports them into the chain.
  1680  func (d *Downloader) processFullSyncContent() error {
  1681  	for {
  1682  		results := d.queue.Results(true)
  1683  		if len(results) == 0 {
  1684  			return nil
  1685  		}
  1686  		if d.chainInsertHook != nil {
  1687  			d.chainInsertHook(results)
  1688  		}
  1689  		if err := d.importBlockResults(results); err != nil {
  1690  			return err
  1691  		}
  1692  	}
  1693  }
  1694  
  1695  func (d *Downloader) importBlockResults(results []*fetchResult) error {
  1696  	// Check for any early termination requests
  1697  	if len(results) == 0 {
  1698  		return nil
  1699  	}
  1700  	select {
  1701  	case <-d.quitCh:
  1702  		return errCancelContentProcessing
  1703  	default:
  1704  	}
  1705  	// Retrieve the a batch of results to import
  1706  	first, last := results[0].Header, results[len(results)-1].Header
  1707  	log.Debug("Inserting downloaded chain", "items", len(results),
  1708  		"firstnum", first.Number, "firsthash", first.Hash(),
  1709  		"lastnum", last.Number, "lasthash", last.Hash(),
  1710  	)
  1711  	blocks := make([]*types.Block, len(results))
  1712  	for i, result := range results {
  1713  		blocks[i] = types.NewBlockWithHeader(result.Header).WithBody(result.Transactions, result.Uncles)
  1714  	}
  1715  	if index, err := d.blockchain.InsertChain(blocks); err != nil {
  1716  		if index < len(results) {
  1717  			log.Debug("Downloaded item processing failed", "number", results[index].Header.Number, "hash", results[index].Header.Hash(), "err", err)
  1718  		} else {
  1719  			// The InsertChain method in blockchain.go will sometimes return an out-of-bounds index,
  1720  			// when it needs to preprocess blocks to import a sidechain.
  1721  			// The importer will put together a new list of blocks to import, which is a superset
  1722  			// of the blocks delivered from the downloader, and the indexing will be off.
  1723  			log.Debug("Downloaded item processing failed on sidechain import", "index", index, "err", err)
  1724  		}
  1725  		return fmt.Errorf("%w: %v", errInvalidChain, err)
  1726  	}
  1727  	return nil
  1728  }
  1729  
  1730  // processFastSyncContent takes fetch results from the queue and writes them to the
  1731  // database. It also controls the synchronisation of state nodes of the pivot block.
  1732  func (d *Downloader) processFastSyncContent() error {
  1733  	// Start syncing state of the reported head block. This should get us most of
  1734  	// the state of the pivot block.
  1735  	d.pivotLock.RLock()
  1736  	sync := d.syncState(d.pivotHeader.Root)
  1737  	d.pivotLock.RUnlock()
  1738  
  1739  	defer func() {
  1740  		// The `sync` object is replaced every time the pivot moves. We need to
  1741  		// defer close the very last active one, hence the lazy evaluation vs.
  1742  		// calling defer sync.Cancel() !!!
  1743  		sync.Cancel()
  1744  	}()
  1745  
  1746  	closeOnErr := func(s *stateSync) {
  1747  		if err := s.Wait(); err != nil && err != errCancelStateFetch && err != errCanceled && err != snap.ErrCancelled {
  1748  			d.queue.Close() // wake up Results
  1749  		}
  1750  	}
  1751  	go closeOnErr(sync)
  1752  
  1753  	// To cater for moving pivot points, track the pivot block and subsequently
  1754  	// accumulated download results separately.
  1755  	var (
  1756  		oldPivot *fetchResult   // Locked in pivot block, might change eventually
  1757  		oldTail  []*fetchResult // Downloaded content after the pivot
  1758  	)
  1759  	for {
  1760  		// Wait for the next batch of downloaded data to be available, and if the pivot
  1761  		// block became stale, move the goalpost
  1762  		results := d.queue.Results(oldPivot == nil) // Block if we're not monitoring pivot staleness
  1763  		if len(results) == 0 {
  1764  			// If pivot sync is done, stop
  1765  			if oldPivot == nil {
  1766  				return sync.Cancel()
  1767  			}
  1768  			// If sync failed, stop
  1769  			select {
  1770  			case <-d.cancelCh:
  1771  				sync.Cancel()
  1772  				return errCanceled
  1773  			default:
  1774  			}
  1775  		}
  1776  		if d.chainInsertHook != nil {
  1777  			d.chainInsertHook(results)
  1778  		}
  1779  		// If we haven't downloaded the pivot block yet, check pivot staleness
  1780  		// notifications from the header downloader
  1781  		d.pivotLock.RLock()
  1782  		pivot := d.pivotHeader
  1783  		d.pivotLock.RUnlock()
  1784  
  1785  		if oldPivot == nil {
  1786  			if pivot.Root != sync.root {
  1787  				sync.Cancel()
  1788  				sync = d.syncState(pivot.Root)
  1789  
  1790  				go closeOnErr(sync)
  1791  			}
  1792  		} else {
  1793  			results = append(append([]*fetchResult{oldPivot}, oldTail...), results...)
  1794  		}
  1795  		// Split around the pivot block and process the two sides via fast/full sync
  1796  		if atomic.LoadInt32(&d.committed) == 0 {
  1797  			latest := results[len(results)-1].Header
  1798  			// If the height is above the pivot block by 2 sets, it means the pivot
  1799  			// become stale in the network and it was garbage collected, move to a
  1800  			// new pivot.
  1801  			//
  1802  			// Note, we have `reorgProtHeaderDelay` number of blocks withheld, Those
  1803  			// need to be taken into account, otherwise we're detecting the pivot move
  1804  			// late and will drop peers due to unavailable state!!!
  1805  			if height := latest.Number.Uint64(); height >= pivot.Number.Uint64()+2*uint64(fsMinFullBlocks)-uint64(reorgProtHeaderDelay) {
  1806  				log.Warn("Pivot became stale, moving", "old", pivot.Number.Uint64(), "new", height-uint64(fsMinFullBlocks)+uint64(reorgProtHeaderDelay))
  1807  				pivot = results[len(results)-1-fsMinFullBlocks+reorgProtHeaderDelay].Header // must exist as lower old pivot is uncommitted
  1808  
  1809  				d.pivotLock.Lock()
  1810  				d.pivotHeader = pivot
  1811  				d.pivotLock.Unlock()
  1812  
  1813  				// Write out the pivot into the database so a rollback beyond it will
  1814  				// reenable fast sync
  1815  				rawdb.WriteLastPivotNumber(d.stateDB, pivot.Number.Uint64())
  1816  			}
  1817  		}
  1818  		P, beforeP, afterP := splitAroundPivot(pivot.Number.Uint64(), results)
  1819  		if err := d.commitFastSyncData(beforeP, sync); err != nil {
  1820  			return err
  1821  		}
  1822  		if P != nil {
  1823  			// If new pivot block found, cancel old state retrieval and restart
  1824  			if oldPivot != P {
  1825  				sync.Cancel()
  1826  				sync = d.syncState(P.Header.Root)
  1827  
  1828  				go closeOnErr(sync)
  1829  				oldPivot = P
  1830  			}
  1831  			// Wait for completion, occasionally checking for pivot staleness
  1832  			select {
  1833  			case <-sync.done:
  1834  				if sync.err != nil {
  1835  					return sync.err
  1836  				}
  1837  				if err := d.commitPivotBlock(P); err != nil {
  1838  					return err
  1839  				}
  1840  				oldPivot = nil
  1841  
  1842  			case <-time.After(time.Second):
  1843  				oldTail = afterP
  1844  				continue
  1845  			}
  1846  		}
  1847  		// Fast sync done, pivot commit done, full import
  1848  		if err := d.importBlockResults(afterP); err != nil {
  1849  			return err
  1850  		}
  1851  	}
  1852  }
  1853  
  1854  func splitAroundPivot(pivot uint64, results []*fetchResult) (p *fetchResult, before, after []*fetchResult) {
  1855  	if len(results) == 0 {
  1856  		return nil, nil, nil
  1857  	}
  1858  	if lastNum := results[len(results)-1].Header.Number.Uint64(); lastNum < pivot {
  1859  		// the pivot is somewhere in the future
  1860  		return nil, results, nil
  1861  	}
  1862  	// This can also be optimized, but only happens very seldom
  1863  	for _, result := range results {
  1864  		num := result.Header.Number.Uint64()
  1865  		switch {
  1866  		case num < pivot:
  1867  			before = append(before, result)
  1868  		case num == pivot:
  1869  			p = result
  1870  		default:
  1871  			after = append(after, result)
  1872  		}
  1873  	}
  1874  	return p, before, after
  1875  }
  1876  
  1877  func (d *Downloader) commitFastSyncData(results []*fetchResult, stateSync *stateSync) error {
  1878  	// Check for any early termination requests
  1879  	if len(results) == 0 {
  1880  		return nil
  1881  	}
  1882  	select {
  1883  	case <-d.quitCh:
  1884  		return errCancelContentProcessing
  1885  	case <-stateSync.done:
  1886  		if err := stateSync.Wait(); err != nil {
  1887  			return err
  1888  		}
  1889  	default:
  1890  	}
  1891  	// Retrieve the a batch of results to import
  1892  	first, last := results[0].Header, results[len(results)-1].Header
  1893  	log.Debug("Inserting fast-sync blocks", "items", len(results),
  1894  		"firstnum", first.Number, "firsthash", first.Hash(),
  1895  		"lastnumn", last.Number, "lasthash", last.Hash(),
  1896  	)
  1897  	blocks := make([]*types.Block, len(results))
  1898  	receipts := make([]types.Receipts, len(results))
  1899  	for i, result := range results {
  1900  		blocks[i] = types.NewBlockWithHeader(result.Header).WithBody(result.Transactions, result.Uncles)
  1901  		receipts[i] = result.Receipts
  1902  	}
  1903  	if index, err := d.blockchain.InsertReceiptChain(blocks, receipts, d.ancientLimit); err != nil {
  1904  		log.Debug("Downloaded item processing failed", "number", results[index].Header.Number, "hash", results[index].Header.Hash(), "err", err)
  1905  		return fmt.Errorf("%w: %v", errInvalidChain, err)
  1906  	}
  1907  	return nil
  1908  }
  1909  
  1910  func (d *Downloader) commitPivotBlock(result *fetchResult) error {
  1911  	block := types.NewBlockWithHeader(result.Header).WithBody(result.Transactions, result.Uncles)
  1912  	log.Debug("Committing fast sync pivot as new head", "number", block.Number(), "hash", block.Hash())
  1913  
  1914  	// Commit the pivot block as the new head, will require full sync from here on
  1915  	if _, err := d.blockchain.InsertReceiptChain([]*types.Block{block}, []types.Receipts{result.Receipts}, d.ancientLimit); err != nil {
  1916  		return err
  1917  	}
  1918  	if err := d.blockchain.FastSyncCommitHead(block.Hash()); err != nil {
  1919  		return err
  1920  	}
  1921  	atomic.StoreInt32(&d.committed, 1)
  1922  	return nil
  1923  }
  1924  
  1925  // DeliverHeaders injects a new batch of block headers received from a remote
  1926  // node into the download schedule.
  1927  func (d *Downloader) DeliverHeaders(id string, headers []*types.Header) error {
  1928  	return d.deliver(d.headerCh, &headerPack{id, headers}, headerInMeter, headerDropMeter)
  1929  }
  1930  
  1931  // DeliverBodies injects a new batch of block bodies received from a remote node.
  1932  func (d *Downloader) DeliverBodies(id string, transactions [][]*types.Transaction, uncles [][]*types.Header) error {
  1933  	return d.deliver(d.bodyCh, &bodyPack{id, transactions, uncles}, bodyInMeter, bodyDropMeter)
  1934  }
  1935  
  1936  // DeliverReceipts injects a new batch of receipts received from a remote node.
  1937  func (d *Downloader) DeliverReceipts(id string, receipts [][]*types.Receipt) error {
  1938  	return d.deliver(d.receiptCh, &receiptPack{id, receipts}, receiptInMeter, receiptDropMeter)
  1939  }
  1940  
  1941  // DeliverNodeData injects a new batch of node state data received from a remote node.
  1942  func (d *Downloader) DeliverNodeData(id string, data [][]byte) error {
  1943  	return d.deliver(d.stateCh, &statePack{id, data}, stateInMeter, stateDropMeter)
  1944  }
  1945  
  1946  // DeliverSnapPacket is invoked from a peer's message handler when it transmits a
  1947  // data packet for the local node to consume.
  1948  func (d *Downloader) DeliverSnapPacket(peer *snap.Peer, packet snap.Packet) error {
  1949  	switch packet := packet.(type) {
  1950  	case *snap.AccountRangePacket:
  1951  		hashes, accounts, err := packet.Unpack()
  1952  		if err != nil {
  1953  			return err
  1954  		}
  1955  		return d.SnapSyncer.OnAccounts(peer, packet.ID, hashes, accounts, packet.Proof)
  1956  
  1957  	case *snap.StorageRangesPacket:
  1958  		hashset, slotset := packet.Unpack()
  1959  		return d.SnapSyncer.OnStorage(peer, packet.ID, hashset, slotset, packet.Proof)
  1960  
  1961  	case *snap.ByteCodesPacket:
  1962  		return d.SnapSyncer.OnByteCodes(peer, packet.ID, packet.Codes)
  1963  
  1964  	case *snap.TrieNodesPacket:
  1965  		return d.SnapSyncer.OnTrieNodes(peer, packet.ID, packet.Nodes)
  1966  
  1967  	default:
  1968  		return fmt.Errorf("unexpected snap packet type: %T", packet)
  1969  	}
  1970  }
  1971  
  1972  // deliver injects a new batch of data received from a remote node.
  1973  func (d *Downloader) deliver(destCh chan dataPack, packet dataPack, inMeter, dropMeter metrics.Meter) (err error) {
  1974  	// Update the delivery metrics for both good and failed deliveries
  1975  	inMeter.Mark(int64(packet.Items()))
  1976  	defer func() {
  1977  		if err != nil {
  1978  			dropMeter.Mark(int64(packet.Items()))
  1979  		}
  1980  	}()
  1981  	// Deliver or abort if the sync is canceled while queuing
  1982  	d.cancelLock.RLock()
  1983  	cancel := d.cancelCh
  1984  	d.cancelLock.RUnlock()
  1985  	if cancel == nil {
  1986  		return errNoSyncActive
  1987  	}
  1988  	select {
  1989  	case destCh <- packet:
  1990  		return nil
  1991  	case <-cancel:
  1992  		return errNoSyncActive
  1993  	}
  1994  }