downloader.go 79 KB

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