blockchain.go 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358
  1. // Copyright 2014 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 core implements the Ethereum consensus protocol.
  17. package core
  18. import (
  19. "errors"
  20. "fmt"
  21. "io"
  22. "math/big"
  23. mrand "math/rand"
  24. "runtime"
  25. "sync"
  26. "sync/atomic"
  27. "time"
  28. "github.com/ethereum/go-ethereum/common"
  29. "github.com/ethereum/go-ethereum/common/mclock"
  30. "github.com/ethereum/go-ethereum/core/state"
  31. "github.com/ethereum/go-ethereum/core/types"
  32. "github.com/ethereum/go-ethereum/core/vm"
  33. "github.com/ethereum/go-ethereum/crypto"
  34. "github.com/ethereum/go-ethereum/ethdb"
  35. "github.com/ethereum/go-ethereum/event"
  36. "github.com/ethereum/go-ethereum/logger"
  37. "github.com/ethereum/go-ethereum/logger/glog"
  38. "github.com/ethereum/go-ethereum/metrics"
  39. "github.com/ethereum/go-ethereum/params"
  40. "github.com/ethereum/go-ethereum/pow"
  41. "github.com/ethereum/go-ethereum/rlp"
  42. "github.com/ethereum/go-ethereum/trie"
  43. "github.com/hashicorp/golang-lru"
  44. )
  45. var (
  46. blockInsertTimer = metrics.NewTimer("chain/inserts")
  47. ErrNoGenesis = errors.New("Genesis not found in chain")
  48. )
  49. const (
  50. bodyCacheLimit = 256
  51. blockCacheLimit = 256
  52. maxFutureBlocks = 256
  53. maxTimeFutureBlocks = 30
  54. // must be bumped when consensus algorithm is changed, this forces the upgradedb
  55. // command to be run (forces the blocks to be imported again using the new algorithm)
  56. BlockChainVersion = 3
  57. )
  58. // BlockChain represents the canonical chain given a database with a genesis
  59. // block. The Blockchain manages chain imports, reverts, chain reorganisations.
  60. //
  61. // Importing blocks in to the block chain happens according to the set of rules
  62. // defined by the two stage Validator. Processing of blocks is done using the
  63. // Processor which processes the included transaction. The validation of the state
  64. // is done in the second part of the Validator. Failing results in aborting of
  65. // the import.
  66. //
  67. // The BlockChain also helps in returning blocks from **any** chain included
  68. // in the database as well as blocks that represents the canonical chain. It's
  69. // important to note that GetBlock can return any block and does not need to be
  70. // included in the canonical one where as GetBlockByNumber always represents the
  71. // canonical chain.
  72. type BlockChain struct {
  73. config *params.ChainConfig // chain & network configuration
  74. hc *HeaderChain
  75. chainDb ethdb.Database
  76. eventMux *event.TypeMux
  77. genesisBlock *types.Block
  78. mu sync.RWMutex // global mutex for locking chain operations
  79. chainmu sync.RWMutex // blockchain insertion lock
  80. procmu sync.RWMutex // block processor lock
  81. checkpoint int // checkpoint counts towards the new checkpoint
  82. currentBlock *types.Block // Current head of the block chain
  83. currentFastBlock *types.Block // Current head of the fast-sync chain (may be above the block chain!)
  84. stateCache *state.StateDB // State database to reuse between imports (contains state cache)
  85. bodyCache *lru.Cache // Cache for the most recent block bodies
  86. bodyRLPCache *lru.Cache // Cache for the most recent block bodies in RLP encoded format
  87. blockCache *lru.Cache // Cache for the most recent entire blocks
  88. futureBlocks *lru.Cache // future blocks are blocks added for later processing
  89. quit chan struct{} // blockchain quit channel
  90. running int32 // running must be called atomically
  91. // procInterrupt must be atomically called
  92. procInterrupt int32 // interrupt signaler for block processing
  93. wg sync.WaitGroup // chain processing wait group for shutting down
  94. pow pow.PoW
  95. processor Processor // block processor interface
  96. validator Validator // block and state validator interface
  97. vmConfig vm.Config
  98. }
  99. // NewBlockChain returns a fully initialised block chain using information
  100. // available in the database. It initialiser the default Ethereum Validator and
  101. // Processor.
  102. func NewBlockChain(chainDb ethdb.Database, config *params.ChainConfig, pow pow.PoW, mux *event.TypeMux, vmConfig vm.Config) (*BlockChain, error) {
  103. bodyCache, _ := lru.New(bodyCacheLimit)
  104. bodyRLPCache, _ := lru.New(bodyCacheLimit)
  105. blockCache, _ := lru.New(blockCacheLimit)
  106. futureBlocks, _ := lru.New(maxFutureBlocks)
  107. bc := &BlockChain{
  108. config: config,
  109. chainDb: chainDb,
  110. eventMux: mux,
  111. quit: make(chan struct{}),
  112. bodyCache: bodyCache,
  113. bodyRLPCache: bodyRLPCache,
  114. blockCache: blockCache,
  115. futureBlocks: futureBlocks,
  116. pow: pow,
  117. vmConfig: vmConfig,
  118. }
  119. bc.SetValidator(NewBlockValidator(config, bc, pow))
  120. bc.SetProcessor(NewStateProcessor(config, bc))
  121. gv := func() HeaderValidator { return bc.Validator() }
  122. var err error
  123. bc.hc, err = NewHeaderChain(chainDb, config, gv, bc.getProcInterrupt)
  124. if err != nil {
  125. return nil, err
  126. }
  127. bc.genesisBlock = bc.GetBlockByNumber(0)
  128. if bc.genesisBlock == nil {
  129. return nil, ErrNoGenesis
  130. }
  131. if err := bc.loadLastState(); err != nil {
  132. return nil, err
  133. }
  134. // Check the current state of the block hashes and make sure that we do not have any of the bad blocks in our chain
  135. for hash := range BadHashes {
  136. if header := bc.GetHeaderByHash(hash); header != nil {
  137. // get the canonical block corresponding to the offending header's number
  138. headerByNumber := bc.GetHeaderByNumber(header.Number.Uint64())
  139. // make sure the headerByNumber (if present) is in our current canonical chain
  140. if headerByNumber != nil && headerByNumber.Hash() == header.Hash() {
  141. glog.V(logger.Error).Infof("Found bad hash, rewinding chain to block #%d [%x…]", header.Number, header.ParentHash[:4])
  142. bc.SetHead(header.Number.Uint64() - 1)
  143. glog.V(logger.Error).Infoln("Chain rewind was successful, resuming normal operation")
  144. }
  145. }
  146. }
  147. // Take ownership of this particular state
  148. go bc.update()
  149. return bc, nil
  150. }
  151. func (self *BlockChain) getProcInterrupt() bool {
  152. return atomic.LoadInt32(&self.procInterrupt) == 1
  153. }
  154. // loadLastState loads the last known chain state from the database. This method
  155. // assumes that the chain manager mutex is held.
  156. func (self *BlockChain) loadLastState() error {
  157. // Restore the last known head block
  158. head := GetHeadBlockHash(self.chainDb)
  159. if head == (common.Hash{}) {
  160. // Corrupt or empty database, init from scratch
  161. self.Reset()
  162. } else {
  163. if block := self.GetBlockByHash(head); block != nil {
  164. // Block found, set as the current head
  165. self.currentBlock = block
  166. } else {
  167. // Corrupt or empty database, init from scratch
  168. self.Reset()
  169. }
  170. }
  171. // Restore the last known head header
  172. currentHeader := self.currentBlock.Header()
  173. if head := GetHeadHeaderHash(self.chainDb); head != (common.Hash{}) {
  174. if header := self.GetHeaderByHash(head); header != nil {
  175. currentHeader = header
  176. }
  177. }
  178. self.hc.SetCurrentHeader(currentHeader)
  179. // Restore the last known head fast block
  180. self.currentFastBlock = self.currentBlock
  181. if head := GetHeadFastBlockHash(self.chainDb); head != (common.Hash{}) {
  182. if block := self.GetBlockByHash(head); block != nil {
  183. self.currentFastBlock = block
  184. }
  185. }
  186. // Initialize a statedb cache to ensure singleton account bloom filter generation
  187. statedb, err := state.New(self.currentBlock.Root(), self.chainDb)
  188. if err != nil {
  189. return err
  190. }
  191. self.stateCache = statedb
  192. self.stateCache.GetAccount(common.Address{})
  193. // Issue a status log for the user
  194. headerTd := self.GetTd(currentHeader.Hash(), currentHeader.Number.Uint64())
  195. blockTd := self.GetTd(self.currentBlock.Hash(), self.currentBlock.NumberU64())
  196. fastTd := self.GetTd(self.currentFastBlock.Hash(), self.currentFastBlock.NumberU64())
  197. glog.V(logger.Info).Infof("Last header: #%d [%x…] TD=%v", currentHeader.Number, currentHeader.Hash().Bytes()[:4], headerTd)
  198. glog.V(logger.Info).Infof("Last block: #%d [%x…] TD=%v", self.currentBlock.Number(), self.currentBlock.Hash().Bytes()[:4], blockTd)
  199. glog.V(logger.Info).Infof("Fast block: #%d [%x…] TD=%v", self.currentFastBlock.Number(), self.currentFastBlock.Hash().Bytes()[:4], fastTd)
  200. return nil
  201. }
  202. // SetHead rewinds the local chain to a new head. In the case of headers, everything
  203. // above the new head will be deleted and the new one set. In the case of blocks
  204. // though, the head may be further rewound if block bodies are missing (non-archive
  205. // nodes after a fast sync).
  206. func (bc *BlockChain) SetHead(head uint64) {
  207. bc.mu.Lock()
  208. defer bc.mu.Unlock()
  209. delFn := func(hash common.Hash, num uint64) {
  210. DeleteBody(bc.chainDb, hash, num)
  211. }
  212. bc.hc.SetHead(head, delFn)
  213. // Clear out any stale content from the caches
  214. bc.bodyCache.Purge()
  215. bc.bodyRLPCache.Purge()
  216. bc.blockCache.Purge()
  217. bc.futureBlocks.Purge()
  218. // Update all computed fields to the new head
  219. currentHeader := bc.hc.CurrentHeader()
  220. if bc.currentBlock != nil && currentHeader.Number.Uint64() < bc.currentBlock.NumberU64() {
  221. bc.currentBlock = bc.GetBlock(currentHeader.Hash(), currentHeader.Number.Uint64())
  222. }
  223. if bc.currentFastBlock != nil && currentHeader.Number.Uint64() < bc.currentFastBlock.NumberU64() {
  224. bc.currentFastBlock = bc.GetBlock(currentHeader.Hash(), currentHeader.Number.Uint64())
  225. }
  226. if bc.currentBlock == nil {
  227. bc.currentBlock = bc.genesisBlock
  228. }
  229. if bc.currentFastBlock == nil {
  230. bc.currentFastBlock = bc.genesisBlock
  231. }
  232. if err := WriteHeadBlockHash(bc.chainDb, bc.currentBlock.Hash()); err != nil {
  233. glog.Fatalf("failed to reset head block hash: %v", err)
  234. }
  235. if err := WriteHeadFastBlockHash(bc.chainDb, bc.currentFastBlock.Hash()); err != nil {
  236. glog.Fatalf("failed to reset head fast block hash: %v", err)
  237. }
  238. bc.loadLastState()
  239. }
  240. // FastSyncCommitHead sets the current head block to the one defined by the hash
  241. // irrelevant what the chain contents were prior.
  242. func (self *BlockChain) FastSyncCommitHead(hash common.Hash) error {
  243. // Make sure that both the block as well at its state trie exists
  244. block := self.GetBlockByHash(hash)
  245. if block == nil {
  246. return fmt.Errorf("non existent block [%x…]", hash[:4])
  247. }
  248. if _, err := trie.NewSecure(block.Root(), self.chainDb, 0); err != nil {
  249. return err
  250. }
  251. // If all checks out, manually set the head block
  252. self.mu.Lock()
  253. self.currentBlock = block
  254. self.mu.Unlock()
  255. glog.V(logger.Info).Infof("committed block #%d [%x…] as new head", block.Number(), hash[:4])
  256. return nil
  257. }
  258. // GasLimit returns the gas limit of the current HEAD block.
  259. func (self *BlockChain) GasLimit() *big.Int {
  260. self.mu.RLock()
  261. defer self.mu.RUnlock()
  262. return self.currentBlock.GasLimit()
  263. }
  264. // LastBlockHash return the hash of the HEAD block.
  265. func (self *BlockChain) LastBlockHash() common.Hash {
  266. self.mu.RLock()
  267. defer self.mu.RUnlock()
  268. return self.currentBlock.Hash()
  269. }
  270. // CurrentBlock retrieves the current head block of the canonical chain. The
  271. // block is retrieved from the blockchain's internal cache.
  272. func (self *BlockChain) CurrentBlock() *types.Block {
  273. self.mu.RLock()
  274. defer self.mu.RUnlock()
  275. return self.currentBlock
  276. }
  277. // CurrentFastBlock retrieves the current fast-sync head block of the canonical
  278. // chain. The block is retrieved from the blockchain's internal cache.
  279. func (self *BlockChain) CurrentFastBlock() *types.Block {
  280. self.mu.RLock()
  281. defer self.mu.RUnlock()
  282. return self.currentFastBlock
  283. }
  284. // Status returns status information about the current chain such as the HEAD Td,
  285. // the HEAD hash and the hash of the genesis block.
  286. func (self *BlockChain) Status() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash) {
  287. self.mu.RLock()
  288. defer self.mu.RUnlock()
  289. return self.GetTd(self.currentBlock.Hash(), self.currentBlock.NumberU64()), self.currentBlock.Hash(), self.genesisBlock.Hash()
  290. }
  291. // SetProcessor sets the processor required for making state modifications.
  292. func (self *BlockChain) SetProcessor(processor Processor) {
  293. self.procmu.Lock()
  294. defer self.procmu.Unlock()
  295. self.processor = processor
  296. }
  297. // SetValidator sets the validator which is used to validate incoming blocks.
  298. func (self *BlockChain) SetValidator(validator Validator) {
  299. self.procmu.Lock()
  300. defer self.procmu.Unlock()
  301. self.validator = validator
  302. }
  303. // Validator returns the current validator.
  304. func (self *BlockChain) Validator() Validator {
  305. self.procmu.RLock()
  306. defer self.procmu.RUnlock()
  307. return self.validator
  308. }
  309. // Processor returns the current processor.
  310. func (self *BlockChain) Processor() Processor {
  311. self.procmu.RLock()
  312. defer self.procmu.RUnlock()
  313. return self.processor
  314. }
  315. // AuxValidator returns the auxiliary validator (Proof of work atm)
  316. func (self *BlockChain) AuxValidator() pow.PoW { return self.pow }
  317. // State returns a new mutable state based on the current HEAD block.
  318. func (self *BlockChain) State() (*state.StateDB, error) {
  319. return self.StateAt(self.CurrentBlock().Root())
  320. }
  321. // StateAt returns a new mutable state based on a particular point in time.
  322. func (self *BlockChain) StateAt(root common.Hash) (*state.StateDB, error) {
  323. return self.stateCache.New(root)
  324. }
  325. // Reset purges the entire blockchain, restoring it to its genesis state.
  326. func (bc *BlockChain) Reset() {
  327. bc.ResetWithGenesisBlock(bc.genesisBlock)
  328. }
  329. // ResetWithGenesisBlock purges the entire blockchain, restoring it to the
  330. // specified genesis state.
  331. func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block) {
  332. // Dump the entire block chain and purge the caches
  333. bc.SetHead(0)
  334. bc.mu.Lock()
  335. defer bc.mu.Unlock()
  336. // Prepare the genesis block and reinitialise the chain
  337. if err := bc.hc.WriteTd(genesis.Hash(), genesis.NumberU64(), genesis.Difficulty()); err != nil {
  338. glog.Fatalf("failed to write genesis block TD: %v", err)
  339. }
  340. if err := WriteBlock(bc.chainDb, genesis); err != nil {
  341. glog.Fatalf("failed to write genesis block: %v", err)
  342. }
  343. bc.genesisBlock = genesis
  344. bc.insert(bc.genesisBlock)
  345. bc.currentBlock = bc.genesisBlock
  346. bc.hc.SetGenesis(bc.genesisBlock.Header())
  347. bc.hc.SetCurrentHeader(bc.genesisBlock.Header())
  348. bc.currentFastBlock = bc.genesisBlock
  349. }
  350. // Export writes the active chain to the given writer.
  351. func (self *BlockChain) Export(w io.Writer) error {
  352. return self.ExportN(w, uint64(0), self.currentBlock.NumberU64())
  353. }
  354. // ExportN writes a subset of the active chain to the given writer.
  355. func (self *BlockChain) ExportN(w io.Writer, first uint64, last uint64) error {
  356. self.mu.RLock()
  357. defer self.mu.RUnlock()
  358. if first > last {
  359. return fmt.Errorf("export failed: first (%d) is greater than last (%d)", first, last)
  360. }
  361. glog.V(logger.Info).Infof("exporting %d blocks...\n", last-first+1)
  362. for nr := first; nr <= last; nr++ {
  363. block := self.GetBlockByNumber(nr)
  364. if block == nil {
  365. return fmt.Errorf("export failed on #%d: not found", nr)
  366. }
  367. if err := block.EncodeRLP(w); err != nil {
  368. return err
  369. }
  370. }
  371. return nil
  372. }
  373. // insert injects a new head block into the current block chain. This method
  374. // assumes that the block is indeed a true head. It will also reset the head
  375. // header and the head fast sync block to this very same block if they are older
  376. // or if they are on a different side chain.
  377. //
  378. // Note, this function assumes that the `mu` mutex is held!
  379. func (bc *BlockChain) insert(block *types.Block) {
  380. // If the block is on a side chain or an unknown one, force other heads onto it too
  381. updateHeads := GetCanonicalHash(bc.chainDb, block.NumberU64()) != block.Hash()
  382. // Add the block to the canonical chain number scheme and mark as the head
  383. if err := WriteCanonicalHash(bc.chainDb, block.Hash(), block.NumberU64()); err != nil {
  384. glog.Fatalf("failed to insert block number: %v", err)
  385. }
  386. if err := WriteHeadBlockHash(bc.chainDb, block.Hash()); err != nil {
  387. glog.Fatalf("failed to insert head block hash: %v", err)
  388. }
  389. bc.currentBlock = block
  390. // If the block is better than out head or is on a different chain, force update heads
  391. if updateHeads {
  392. bc.hc.SetCurrentHeader(block.Header())
  393. if err := WriteHeadFastBlockHash(bc.chainDb, block.Hash()); err != nil {
  394. glog.Fatalf("failed to insert head fast block hash: %v", err)
  395. }
  396. bc.currentFastBlock = block
  397. }
  398. }
  399. // Accessors
  400. func (bc *BlockChain) Genesis() *types.Block {
  401. return bc.genesisBlock
  402. }
  403. // GetBody retrieves a block body (transactions and uncles) from the database by
  404. // hash, caching it if found.
  405. func (self *BlockChain) GetBody(hash common.Hash) *types.Body {
  406. // Short circuit if the body's already in the cache, retrieve otherwise
  407. if cached, ok := self.bodyCache.Get(hash); ok {
  408. body := cached.(*types.Body)
  409. return body
  410. }
  411. body := GetBody(self.chainDb, hash, self.hc.GetBlockNumber(hash))
  412. if body == nil {
  413. return nil
  414. }
  415. // Cache the found body for next time and return
  416. self.bodyCache.Add(hash, body)
  417. return body
  418. }
  419. // GetBodyRLP retrieves a block body in RLP encoding from the database by hash,
  420. // caching it if found.
  421. func (self *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue {
  422. // Short circuit if the body's already in the cache, retrieve otherwise
  423. if cached, ok := self.bodyRLPCache.Get(hash); ok {
  424. return cached.(rlp.RawValue)
  425. }
  426. body := GetBodyRLP(self.chainDb, hash, self.hc.GetBlockNumber(hash))
  427. if len(body) == 0 {
  428. return nil
  429. }
  430. // Cache the found body for next time and return
  431. self.bodyRLPCache.Add(hash, body)
  432. return body
  433. }
  434. // HasBlock checks if a block is fully present in the database or not, caching
  435. // it if present.
  436. func (bc *BlockChain) HasBlock(hash common.Hash) bool {
  437. return bc.GetBlockByHash(hash) != nil
  438. }
  439. // HasBlockAndState checks if a block and associated state trie is fully present
  440. // in the database or not, caching it if present.
  441. func (bc *BlockChain) HasBlockAndState(hash common.Hash) bool {
  442. // Check first that the block itself is known
  443. block := bc.GetBlockByHash(hash)
  444. if block == nil {
  445. return false
  446. }
  447. // Ensure the associated state is also present
  448. _, err := state.New(block.Root(), bc.chainDb)
  449. return err == nil
  450. }
  451. // GetBlock retrieves a block from the database by hash and number,
  452. // caching it if found.
  453. func (self *BlockChain) GetBlock(hash common.Hash, number uint64) *types.Block {
  454. // Short circuit if the block's already in the cache, retrieve otherwise
  455. if block, ok := self.blockCache.Get(hash); ok {
  456. return block.(*types.Block)
  457. }
  458. block := GetBlock(self.chainDb, hash, number)
  459. if block == nil {
  460. return nil
  461. }
  462. // Cache the found block for next time and return
  463. self.blockCache.Add(block.Hash(), block)
  464. return block
  465. }
  466. // GetBlockByHash retrieves a block from the database by hash, caching it if found.
  467. func (self *BlockChain) GetBlockByHash(hash common.Hash) *types.Block {
  468. return self.GetBlock(hash, self.hc.GetBlockNumber(hash))
  469. }
  470. // GetBlockByNumber retrieves a block from the database by number, caching it
  471. // (associated with its hash) if found.
  472. func (self *BlockChain) GetBlockByNumber(number uint64) *types.Block {
  473. hash := GetCanonicalHash(self.chainDb, number)
  474. if hash == (common.Hash{}) {
  475. return nil
  476. }
  477. return self.GetBlock(hash, number)
  478. }
  479. // [deprecated by eth/62]
  480. // GetBlocksFromHash returns the block corresponding to hash and up to n-1 ancestors.
  481. func (self *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block) {
  482. number := self.hc.GetBlockNumber(hash)
  483. for i := 0; i < n; i++ {
  484. block := self.GetBlock(hash, number)
  485. if block == nil {
  486. break
  487. }
  488. blocks = append(blocks, block)
  489. hash = block.ParentHash()
  490. number--
  491. }
  492. return
  493. }
  494. // GetUnclesInChain retrieves all the uncles from a given block backwards until
  495. // a specific distance is reached.
  496. func (self *BlockChain) GetUnclesInChain(block *types.Block, length int) []*types.Header {
  497. uncles := []*types.Header{}
  498. for i := 0; block != nil && i < length; i++ {
  499. uncles = append(uncles, block.Uncles()...)
  500. block = self.GetBlock(block.ParentHash(), block.NumberU64()-1)
  501. }
  502. return uncles
  503. }
  504. // Stop stops the blockchain service. If any imports are currently in progress
  505. // it will abort them using the procInterrupt.
  506. func (bc *BlockChain) Stop() {
  507. if !atomic.CompareAndSwapInt32(&bc.running, 0, 1) {
  508. return
  509. }
  510. close(bc.quit)
  511. atomic.StoreInt32(&bc.procInterrupt, 1)
  512. bc.wg.Wait()
  513. glog.V(logger.Info).Infoln("Chain manager stopped")
  514. }
  515. func (self *BlockChain) procFutureBlocks() {
  516. blocks := make([]*types.Block, 0, self.futureBlocks.Len())
  517. for _, hash := range self.futureBlocks.Keys() {
  518. if block, exist := self.futureBlocks.Get(hash); exist {
  519. blocks = append(blocks, block.(*types.Block))
  520. }
  521. }
  522. if len(blocks) > 0 {
  523. types.BlockBy(types.Number).Sort(blocks)
  524. // Insert one by one as chain insertion needs contiguous ancestry between blocks
  525. for i := range blocks {
  526. self.InsertChain(blocks[i : i+1])
  527. }
  528. }
  529. }
  530. type WriteStatus byte
  531. const (
  532. NonStatTy WriteStatus = iota
  533. CanonStatTy
  534. SplitStatTy
  535. SideStatTy
  536. )
  537. // Rollback is designed to remove a chain of links from the database that aren't
  538. // certain enough to be valid.
  539. func (self *BlockChain) Rollback(chain []common.Hash) {
  540. self.mu.Lock()
  541. defer self.mu.Unlock()
  542. for i := len(chain) - 1; i >= 0; i-- {
  543. hash := chain[i]
  544. currentHeader := self.hc.CurrentHeader()
  545. if currentHeader.Hash() == hash {
  546. self.hc.SetCurrentHeader(self.GetHeader(currentHeader.ParentHash, currentHeader.Number.Uint64()-1))
  547. }
  548. if self.currentFastBlock.Hash() == hash {
  549. self.currentFastBlock = self.GetBlock(self.currentFastBlock.ParentHash(), self.currentFastBlock.NumberU64()-1)
  550. WriteHeadFastBlockHash(self.chainDb, self.currentFastBlock.Hash())
  551. }
  552. if self.currentBlock.Hash() == hash {
  553. self.currentBlock = self.GetBlock(self.currentBlock.ParentHash(), self.currentBlock.NumberU64()-1)
  554. WriteHeadBlockHash(self.chainDb, self.currentBlock.Hash())
  555. }
  556. }
  557. }
  558. // SetReceiptsData computes all the non-consensus fields of the receipts
  559. func SetReceiptsData(config *params.ChainConfig, block *types.Block, receipts types.Receipts) {
  560. signer := types.MakeSigner(config, block.Number())
  561. transactions, logIndex := block.Transactions(), uint(0)
  562. for j := 0; j < len(receipts); j++ {
  563. // The transaction hash can be retrieved from the transaction itself
  564. receipts[j].TxHash = transactions[j].Hash()
  565. tx, _ := transactions[j].AsMessage(signer)
  566. // The contract address can be derived from the transaction itself
  567. if MessageCreatesContract(tx) {
  568. receipts[j].ContractAddress = crypto.CreateAddress(tx.From(), tx.Nonce())
  569. }
  570. // The used gas can be calculated based on previous receipts
  571. if j == 0 {
  572. receipts[j].GasUsed = new(big.Int).Set(receipts[j].CumulativeGasUsed)
  573. } else {
  574. receipts[j].GasUsed = new(big.Int).Sub(receipts[j].CumulativeGasUsed, receipts[j-1].CumulativeGasUsed)
  575. }
  576. // The derived log fields can simply be set from the block and transaction
  577. for k := 0; k < len(receipts[j].Logs); k++ {
  578. receipts[j].Logs[k].BlockNumber = block.NumberU64()
  579. receipts[j].Logs[k].BlockHash = block.Hash()
  580. receipts[j].Logs[k].TxHash = receipts[j].TxHash
  581. receipts[j].Logs[k].TxIndex = uint(j)
  582. receipts[j].Logs[k].Index = logIndex
  583. logIndex++
  584. }
  585. }
  586. }
  587. // InsertReceiptChain attempts to complete an already existing header chain with
  588. // transaction and receipt data.
  589. // XXX should this be moved to the test?
  590. func (self *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts) (int, error) {
  591. // Do a sanity check that the provided chain is actually ordered and linked
  592. for i := 1; i < len(blockChain); i++ {
  593. if blockChain[i].NumberU64() != blockChain[i-1].NumberU64()+1 || blockChain[i].ParentHash() != blockChain[i-1].Hash() {
  594. // Chain broke ancestry, log a messge (programming error) and skip insertion
  595. failure := fmt.Errorf("non contiguous insert: item %d is #%d [%x…], item %d is #%d [%x…] (parent [%x…])", i-1, blockChain[i-1].NumberU64(),
  596. blockChain[i-1].Hash().Bytes()[:4], i, blockChain[i].NumberU64(), blockChain[i].Hash().Bytes()[:4], blockChain[i].ParentHash().Bytes()[:4])
  597. glog.V(logger.Error).Info(failure.Error())
  598. return 0, failure
  599. }
  600. }
  601. // Pre-checks passed, start the block body and receipt imports
  602. self.wg.Add(1)
  603. defer self.wg.Done()
  604. // Collect some import statistics to report on
  605. stats := struct{ processed, ignored int32 }{}
  606. start := time.Now()
  607. // Create the block importing task queue and worker functions
  608. tasks := make(chan int, len(blockChain))
  609. for i := 0; i < len(blockChain) && i < len(receiptChain); i++ {
  610. tasks <- i
  611. }
  612. close(tasks)
  613. errs, failed := make([]error, len(tasks)), int32(0)
  614. process := func(worker int) {
  615. for index := range tasks {
  616. block, receipts := blockChain[index], receiptChain[index]
  617. // Short circuit insertion if shutting down or processing failed
  618. if atomic.LoadInt32(&self.procInterrupt) == 1 {
  619. return
  620. }
  621. if atomic.LoadInt32(&failed) > 0 {
  622. return
  623. }
  624. // Short circuit if the owner header is unknown
  625. if !self.HasHeader(block.Hash()) {
  626. errs[index] = fmt.Errorf("containing header #%d [%x…] unknown", block.Number(), block.Hash().Bytes()[:4])
  627. atomic.AddInt32(&failed, 1)
  628. return
  629. }
  630. // Skip if the entire data is already known
  631. if self.HasBlock(block.Hash()) {
  632. atomic.AddInt32(&stats.ignored, 1)
  633. continue
  634. }
  635. // Compute all the non-consensus fields of the receipts
  636. SetReceiptsData(self.config, block, receipts)
  637. // Write all the data out into the database
  638. if err := WriteBody(self.chainDb, block.Hash(), block.NumberU64(), block.Body()); err != nil {
  639. errs[index] = fmt.Errorf("failed to write block body: %v", err)
  640. atomic.AddInt32(&failed, 1)
  641. glog.Fatal(errs[index])
  642. return
  643. }
  644. if err := WriteBlockReceipts(self.chainDb, block.Hash(), block.NumberU64(), receipts); err != nil {
  645. errs[index] = fmt.Errorf("failed to write block receipts: %v", err)
  646. atomic.AddInt32(&failed, 1)
  647. glog.Fatal(errs[index])
  648. return
  649. }
  650. if err := WriteMipmapBloom(self.chainDb, block.NumberU64(), receipts); err != nil {
  651. errs[index] = fmt.Errorf("failed to write log blooms: %v", err)
  652. atomic.AddInt32(&failed, 1)
  653. glog.Fatal(errs[index])
  654. return
  655. }
  656. if err := WriteTransactions(self.chainDb, block); err != nil {
  657. errs[index] = fmt.Errorf("failed to write individual transactions: %v", err)
  658. atomic.AddInt32(&failed, 1)
  659. glog.Fatal(errs[index])
  660. return
  661. }
  662. if err := WriteReceipts(self.chainDb, receipts); err != nil {
  663. errs[index] = fmt.Errorf("failed to write individual receipts: %v", err)
  664. atomic.AddInt32(&failed, 1)
  665. glog.Fatal(errs[index])
  666. return
  667. }
  668. atomic.AddInt32(&stats.processed, 1)
  669. }
  670. }
  671. // Start as many worker threads as goroutines allowed
  672. pending := new(sync.WaitGroup)
  673. for i := 0; i < runtime.GOMAXPROCS(0); i++ {
  674. pending.Add(1)
  675. go func(id int) {
  676. defer pending.Done()
  677. process(id)
  678. }(i)
  679. }
  680. pending.Wait()
  681. // If anything failed, report
  682. if failed > 0 {
  683. for i, err := range errs {
  684. if err != nil {
  685. return i, err
  686. }
  687. }
  688. }
  689. if atomic.LoadInt32(&self.procInterrupt) == 1 {
  690. glog.V(logger.Debug).Infoln("premature abort during receipt chain processing")
  691. return 0, nil
  692. }
  693. // Update the head fast sync block if better
  694. self.mu.Lock()
  695. head := blockChain[len(errs)-1]
  696. if self.GetTd(self.currentFastBlock.Hash(), self.currentFastBlock.NumberU64()).Cmp(self.GetTd(head.Hash(), head.NumberU64())) < 0 {
  697. if err := WriteHeadFastBlockHash(self.chainDb, head.Hash()); err != nil {
  698. glog.Fatalf("failed to update head fast block hash: %v", err)
  699. }
  700. self.currentFastBlock = head
  701. }
  702. self.mu.Unlock()
  703. // Report some public statistics so the user has a clue what's going on
  704. first, last := blockChain[0], blockChain[len(blockChain)-1]
  705. ignored := ""
  706. if stats.ignored > 0 {
  707. ignored = fmt.Sprintf(" (%d ignored)", stats.ignored)
  708. }
  709. glog.V(logger.Info).Infof("imported %4d receipts in %9v. #%d [%x… / %x…]%s", stats.processed, common.PrettyDuration(time.Since(start)), last.Number(), first.Hash().Bytes()[:4], last.Hash().Bytes()[:4], ignored)
  710. return 0, nil
  711. }
  712. // WriteBlock writes the block to the chain.
  713. func (self *BlockChain) WriteBlock(block *types.Block) (status WriteStatus, err error) {
  714. self.wg.Add(1)
  715. defer self.wg.Done()
  716. // Calculate the total difficulty of the block
  717. ptd := self.GetTd(block.ParentHash(), block.NumberU64()-1)
  718. if ptd == nil {
  719. return NonStatTy, ParentError(block.ParentHash())
  720. }
  721. // Make sure no inconsistent state is leaked during insertion
  722. self.mu.Lock()
  723. defer self.mu.Unlock()
  724. localTd := self.GetTd(self.currentBlock.Hash(), self.currentBlock.NumberU64())
  725. externTd := new(big.Int).Add(block.Difficulty(), ptd)
  726. // Irrelevant of the canonical status, write the block itself to the database
  727. if err := self.hc.WriteTd(block.Hash(), block.NumberU64(), externTd); err != nil {
  728. glog.Fatalf("failed to write block total difficulty: %v", err)
  729. }
  730. if err := WriteBlock(self.chainDb, block); err != nil {
  731. glog.Fatalf("failed to write block contents: %v", err)
  732. }
  733. // If the total difficulty is higher than our known, add it to the canonical chain
  734. // Second clause in the if statement reduces the vulnerability to selfish mining.
  735. // Please refer to http://www.cs.cornell.edu/~ie53/publications/btcProcFC.pdf
  736. if externTd.Cmp(localTd) > 0 || (externTd.Cmp(localTd) == 0 && mrand.Float64() < 0.5) {
  737. // Reorganise the chain if the parent is not the head block
  738. if block.ParentHash() != self.currentBlock.Hash() {
  739. if err := self.reorg(self.currentBlock, block); err != nil {
  740. return NonStatTy, err
  741. }
  742. }
  743. self.insert(block) // Insert the block as the new head of the chain
  744. status = CanonStatTy
  745. } else {
  746. status = SideStatTy
  747. }
  748. self.futureBlocks.Remove(block.Hash())
  749. return
  750. }
  751. // InsertChain will attempt to insert the given chain in to the canonical chain or, otherwise, create a fork. It an error is returned
  752. // it will return the index number of the failing block as well an error describing what went wrong (for possible errors see core/errors.go).
  753. func (self *BlockChain) InsertChain(chain types.Blocks) (int, error) {
  754. // Do a sanity check that the provided chain is actually ordered and linked
  755. for i := 1; i < len(chain); i++ {
  756. if chain[i].NumberU64() != chain[i-1].NumberU64()+1 || chain[i].ParentHash() != chain[i-1].Hash() {
  757. // Chain broke ancestry, log a messge (programming error) and skip insertion
  758. failure := fmt.Errorf("non contiguous insert: item %d is #%d [%x…], item %d is #%d [%x…] (parent [%x…])",
  759. i-1, chain[i-1].NumberU64(), chain[i-1].Hash().Bytes()[:4], i, chain[i].NumberU64(), chain[i].Hash().Bytes()[:4], chain[i].ParentHash().Bytes()[:4])
  760. glog.V(logger.Error).Info(failure.Error())
  761. return 0, failure
  762. }
  763. }
  764. // Pre-checks passed, start the full block imports
  765. self.wg.Add(1)
  766. defer self.wg.Done()
  767. self.chainmu.Lock()
  768. defer self.chainmu.Unlock()
  769. // A queued approach to delivering events. This is generally
  770. // faster than direct delivery and requires much less mutex
  771. // acquiring.
  772. var (
  773. stats = insertStats{startTime: mclock.Now()}
  774. events = make([]interface{}, 0, len(chain))
  775. coalescedLogs []*types.Log
  776. nonceChecked = make([]bool, len(chain))
  777. )
  778. // Start the parallel nonce verifier.
  779. nonceAbort, nonceResults := verifyNoncesFromBlocks(self.pow, chain)
  780. defer close(nonceAbort)
  781. for i, block := range chain {
  782. if atomic.LoadInt32(&self.procInterrupt) == 1 {
  783. glog.V(logger.Debug).Infoln("Premature abort during block chain processing")
  784. break
  785. }
  786. bstart := time.Now()
  787. // Wait for block i's nonce to be verified before processing
  788. // its state transition.
  789. for !nonceChecked[i] {
  790. r := <-nonceResults
  791. nonceChecked[r.index] = true
  792. if !r.valid {
  793. block := chain[r.index]
  794. return r.index, &BlockNonceErr{Hash: block.Hash(), Number: block.Number(), Nonce: block.Nonce()}
  795. }
  796. }
  797. if BadHashes[block.Hash()] {
  798. err := BadHashError(block.Hash())
  799. self.reportBlock(block, nil, err)
  800. return i, err
  801. }
  802. // Stage 1 validation of the block using the chain's validator
  803. // interface.
  804. err := self.Validator().ValidateBlock(block)
  805. if err != nil {
  806. if IsKnownBlockErr(err) {
  807. stats.ignored++
  808. continue
  809. }
  810. if err == BlockFutureErr {
  811. // Allow up to MaxFuture second in the future blocks. If this limit
  812. // is exceeded the chain is discarded and processed at a later time
  813. // if given.
  814. max := big.NewInt(time.Now().Unix() + maxTimeFutureBlocks)
  815. if block.Time().Cmp(max) == 1 {
  816. return i, fmt.Errorf("%v: BlockFutureErr, %v > %v", BlockFutureErr, block.Time(), max)
  817. }
  818. self.futureBlocks.Add(block.Hash(), block)
  819. stats.queued++
  820. continue
  821. }
  822. if IsParentErr(err) && self.futureBlocks.Contains(block.ParentHash()) {
  823. self.futureBlocks.Add(block.Hash(), block)
  824. stats.queued++
  825. continue
  826. }
  827. self.reportBlock(block, nil, err)
  828. return i, err
  829. }
  830. // Create a new statedb using the parent block and report an
  831. // error if it fails.
  832. switch {
  833. case i == 0:
  834. err = self.stateCache.Reset(self.GetBlock(block.ParentHash(), block.NumberU64()-1).Root())
  835. default:
  836. err = self.stateCache.Reset(chain[i-1].Root())
  837. }
  838. if err != nil {
  839. self.reportBlock(block, nil, err)
  840. return i, err
  841. }
  842. // Process block using the parent state as reference point.
  843. receipts, logs, usedGas, err := self.processor.Process(block, self.stateCache, self.vmConfig)
  844. if err != nil {
  845. self.reportBlock(block, receipts, err)
  846. return i, err
  847. }
  848. // Validate the state using the default validator
  849. err = self.Validator().ValidateState(block, self.GetBlock(block.ParentHash(), block.NumberU64()-1), self.stateCache, receipts, usedGas)
  850. if err != nil {
  851. self.reportBlock(block, receipts, err)
  852. return i, err
  853. }
  854. // Write state changes to database
  855. _, err = self.stateCache.Commit(self.config.IsEIP158(block.Number()))
  856. if err != nil {
  857. return i, err
  858. }
  859. // coalesce logs for later processing
  860. coalescedLogs = append(coalescedLogs, logs...)
  861. if err := WriteBlockReceipts(self.chainDb, block.Hash(), block.NumberU64(), receipts); err != nil {
  862. return i, err
  863. }
  864. // write the block to the chain and get the status
  865. status, err := self.WriteBlock(block)
  866. if err != nil {
  867. return i, err
  868. }
  869. switch status {
  870. case CanonStatTy:
  871. if glog.V(logger.Debug) {
  872. glog.Infof("inserted block #%d [%x…] in %9v: %3d txs %7v gas %d uncles.", block.Number(), block.Hash().Bytes()[0:4], common.PrettyDuration(time.Since(bstart)), len(block.Transactions()), block.GasUsed(), len(block.Uncles()))
  873. }
  874. blockInsertTimer.UpdateSince(bstart)
  875. events = append(events, ChainEvent{block, block.Hash(), logs})
  876. // This puts transactions in a extra db for rpc
  877. if err := WriteTransactions(self.chainDb, block); err != nil {
  878. return i, err
  879. }
  880. // store the receipts
  881. if err := WriteReceipts(self.chainDb, receipts); err != nil {
  882. return i, err
  883. }
  884. // Write map map bloom filters
  885. if err := WriteMipmapBloom(self.chainDb, block.NumberU64(), receipts); err != nil {
  886. return i, err
  887. }
  888. // Write hash preimages
  889. if err := WritePreimages(self.chainDb, block.NumberU64(), self.stateCache.Preimages()); err != nil {
  890. return i, err
  891. }
  892. case SideStatTy:
  893. if glog.V(logger.Detail) {
  894. glog.Infof("inserted forked block #%d [%x…] (TD=%v) in %9v: %3d txs %d uncles.", block.Number(), block.Hash().Bytes()[0:4], block.Difficulty(), common.PrettyDuration(time.Since(bstart)), len(block.Transactions()), len(block.Uncles()))
  895. }
  896. blockInsertTimer.UpdateSince(bstart)
  897. events = append(events, ChainSideEvent{block})
  898. case SplitStatTy:
  899. events = append(events, ChainSplitEvent{block, logs})
  900. }
  901. stats.processed++
  902. if glog.V(logger.Info) {
  903. stats.usedGas += usedGas.Uint64()
  904. stats.report(chain, i)
  905. }
  906. }
  907. go self.postChainEvents(events, coalescedLogs)
  908. return 0, nil
  909. }
  910. // insertStats tracks and reports on block insertion.
  911. type insertStats struct {
  912. queued, processed, ignored int
  913. usedGas uint64
  914. lastIndex int
  915. startTime mclock.AbsTime
  916. }
  917. // statsReportLimit is the time limit during import after which we always print
  918. // out progress. This avoids the user wondering what's going on.
  919. const statsReportLimit = 8 * time.Second
  920. // report prints statistics if some number of blocks have been processed
  921. // or more than a few seconds have passed since the last message.
  922. func (st *insertStats) report(chain []*types.Block, index int) {
  923. // Fetch the timings for the batch
  924. var (
  925. now = mclock.Now()
  926. elapsed = time.Duration(now) - time.Duration(st.startTime)
  927. )
  928. // If we're at the last block of the batch or report period reached, log
  929. if index == len(chain)-1 || elapsed >= statsReportLimit {
  930. start, end := chain[st.lastIndex], chain[index]
  931. txcount := countTransactions(chain[st.lastIndex : index+1])
  932. var hashes, extra string
  933. if st.queued > 0 || st.ignored > 0 {
  934. extra = fmt.Sprintf(" (%d queued %d ignored)", st.queued, st.ignored)
  935. }
  936. if st.processed > 1 {
  937. hashes = fmt.Sprintf("%x… / %x…", start.Hash().Bytes()[:4], end.Hash().Bytes()[:4])
  938. } else {
  939. hashes = fmt.Sprintf("%x…", end.Hash().Bytes()[:4])
  940. }
  941. glog.Infof("imported %4d blocks, %5d txs (%7.3f Mg) in %9v (%6.3f Mg/s). #%v [%s]%s", st.processed, txcount, float64(st.usedGas)/1000000, common.PrettyDuration(elapsed), float64(st.usedGas)*1000/float64(elapsed), end.Number(), hashes, extra)
  942. *st = insertStats{startTime: now, lastIndex: index}
  943. }
  944. }
  945. func countTransactions(chain []*types.Block) (c int) {
  946. for _, b := range chain {
  947. c += len(b.Transactions())
  948. }
  949. return c
  950. }
  951. // reorgs takes two blocks, an old chain and a new chain and will reconstruct the blocks and inserts them
  952. // to be part of the new canonical chain and accumulates potential missing transactions and post an
  953. // event about them
  954. func (self *BlockChain) reorg(oldBlock, newBlock *types.Block) error {
  955. var (
  956. newChain types.Blocks
  957. oldChain types.Blocks
  958. commonBlock *types.Block
  959. oldStart = oldBlock
  960. newStart = newBlock
  961. deletedTxs types.Transactions
  962. deletedLogs []*types.Log
  963. // collectLogs collects the logs that were generated during the
  964. // processing of the block that corresponds with the given hash.
  965. // These logs are later announced as deleted.
  966. collectLogs = func(h common.Hash) {
  967. // Coalesce logs and set 'Removed'.
  968. receipts := GetBlockReceipts(self.chainDb, h, self.hc.GetBlockNumber(h))
  969. for _, receipt := range receipts {
  970. for _, log := range receipt.Logs {
  971. del := *log
  972. del.Removed = true
  973. deletedLogs = append(deletedLogs, &del)
  974. }
  975. }
  976. }
  977. )
  978. // first reduce whoever is higher bound
  979. if oldBlock.NumberU64() > newBlock.NumberU64() {
  980. // reduce old chain
  981. for ; oldBlock != nil && oldBlock.NumberU64() != newBlock.NumberU64(); oldBlock = self.GetBlock(oldBlock.ParentHash(), oldBlock.NumberU64()-1) {
  982. oldChain = append(oldChain, oldBlock)
  983. deletedTxs = append(deletedTxs, oldBlock.Transactions()...)
  984. collectLogs(oldBlock.Hash())
  985. }
  986. } else {
  987. // reduce new chain and append new chain blocks for inserting later on
  988. for ; newBlock != nil && newBlock.NumberU64() != oldBlock.NumberU64(); newBlock = self.GetBlock(newBlock.ParentHash(), newBlock.NumberU64()-1) {
  989. newChain = append(newChain, newBlock)
  990. }
  991. }
  992. if oldBlock == nil {
  993. return fmt.Errorf("Invalid old chain")
  994. }
  995. if newBlock == nil {
  996. return fmt.Errorf("Invalid new chain")
  997. }
  998. numSplit := newBlock.Number()
  999. for {
  1000. if oldBlock.Hash() == newBlock.Hash() {
  1001. commonBlock = oldBlock
  1002. break
  1003. }
  1004. oldChain = append(oldChain, oldBlock)
  1005. newChain = append(newChain, newBlock)
  1006. deletedTxs = append(deletedTxs, oldBlock.Transactions()...)
  1007. collectLogs(oldBlock.Hash())
  1008. oldBlock, newBlock = self.GetBlock(oldBlock.ParentHash(), oldBlock.NumberU64()-1), self.GetBlock(newBlock.ParentHash(), newBlock.NumberU64()-1)
  1009. if oldBlock == nil {
  1010. return fmt.Errorf("Invalid old chain")
  1011. }
  1012. if newBlock == nil {
  1013. return fmt.Errorf("Invalid new chain")
  1014. }
  1015. }
  1016. if glog.V(logger.Debug) {
  1017. commonHash := commonBlock.Hash()
  1018. glog.Infof("Chain split detected @ %x. Reorganising chain from #%v %x to %x", commonHash[:4], numSplit, oldStart.Hash().Bytes()[:4], newStart.Hash().Bytes()[:4])
  1019. }
  1020. var addedTxs types.Transactions
  1021. // insert blocks. Order does not matter. Last block will be written in ImportChain itself which creates the new head properly
  1022. for _, block := range newChain {
  1023. // insert the block in the canonical way, re-writing history
  1024. self.insert(block)
  1025. // write canonical receipts and transactions
  1026. if err := WriteTransactions(self.chainDb, block); err != nil {
  1027. return err
  1028. }
  1029. receipts := GetBlockReceipts(self.chainDb, block.Hash(), block.NumberU64())
  1030. // write receipts
  1031. if err := WriteReceipts(self.chainDb, receipts); err != nil {
  1032. return err
  1033. }
  1034. // Write map map bloom filters
  1035. if err := WriteMipmapBloom(self.chainDb, block.NumberU64(), receipts); err != nil {
  1036. return err
  1037. }
  1038. addedTxs = append(addedTxs, block.Transactions()...)
  1039. }
  1040. // calculate the difference between deleted and added transactions
  1041. diff := types.TxDifference(deletedTxs, addedTxs)
  1042. // When transactions get deleted from the database that means the
  1043. // receipts that were created in the fork must also be deleted
  1044. for _, tx := range diff {
  1045. DeleteReceipt(self.chainDb, tx.Hash())
  1046. DeleteTransaction(self.chainDb, tx.Hash())
  1047. }
  1048. // Must be posted in a goroutine because of the transaction pool trying
  1049. // to acquire the chain manager lock
  1050. if len(diff) > 0 {
  1051. go self.eventMux.Post(RemovedTransactionEvent{diff})
  1052. }
  1053. if len(deletedLogs) > 0 {
  1054. go self.eventMux.Post(RemovedLogsEvent{deletedLogs})
  1055. }
  1056. if len(oldChain) > 0 {
  1057. go func() {
  1058. for _, block := range oldChain {
  1059. self.eventMux.Post(ChainSideEvent{Block: block})
  1060. }
  1061. }()
  1062. }
  1063. return nil
  1064. }
  1065. // postChainEvents iterates over the events generated by a chain insertion and
  1066. // posts them into the event mux.
  1067. func (self *BlockChain) postChainEvents(events []interface{}, logs []*types.Log) {
  1068. // post event logs for further processing
  1069. self.eventMux.Post(logs)
  1070. for _, event := range events {
  1071. if event, ok := event.(ChainEvent); ok {
  1072. // We need some control over the mining operation. Acquiring locks and waiting for the miner to create new block takes too long
  1073. // and in most cases isn't even necessary.
  1074. if self.LastBlockHash() == event.Hash {
  1075. self.eventMux.Post(ChainHeadEvent{event.Block})
  1076. }
  1077. }
  1078. // Fire the insertion events individually too
  1079. self.eventMux.Post(event)
  1080. }
  1081. }
  1082. func (self *BlockChain) update() {
  1083. futureTimer := time.Tick(5 * time.Second)
  1084. for {
  1085. select {
  1086. case <-futureTimer:
  1087. self.procFutureBlocks()
  1088. case <-self.quit:
  1089. return
  1090. }
  1091. }
  1092. }
  1093. // reportBlock logs a bad block error.
  1094. func (bc *BlockChain) reportBlock(block *types.Block, receipts types.Receipts, err error) {
  1095. if glog.V(logger.Error) {
  1096. var receiptString string
  1097. for _, receipt := range receipts {
  1098. receiptString += fmt.Sprintf("\t%v\n", receipt)
  1099. }
  1100. glog.Errorf(`
  1101. ########## BAD BLOCK #########
  1102. Chain config: %v
  1103. Number: %v
  1104. Hash: 0x%x
  1105. %v
  1106. Error: %v
  1107. ##############################
  1108. `, bc.config, block.Number(), block.Hash(), receiptString, err)
  1109. }
  1110. }
  1111. // InsertHeaderChain attempts to insert the given header chain in to the local
  1112. // chain, possibly creating a reorg. If an error is returned, it will return the
  1113. // index number of the failing header as well an error describing what went wrong.
  1114. //
  1115. // The verify parameter can be used to fine tune whether nonce verification
  1116. // should be done or not. The reason behind the optional check is because some
  1117. // of the header retrieval mechanisms already need to verify nonces, as well as
  1118. // because nonces can be verified sparsely, not needing to check each.
  1119. func (self *BlockChain) InsertHeaderChain(chain []*types.Header, checkFreq int) (int, error) {
  1120. // Make sure only one thread manipulates the chain at once
  1121. self.chainmu.Lock()
  1122. defer self.chainmu.Unlock()
  1123. self.wg.Add(1)
  1124. defer self.wg.Done()
  1125. whFunc := func(header *types.Header) error {
  1126. self.mu.Lock()
  1127. defer self.mu.Unlock()
  1128. _, err := self.hc.WriteHeader(header)
  1129. return err
  1130. }
  1131. return self.hc.InsertHeaderChain(chain, checkFreq, whFunc)
  1132. }
  1133. // writeHeader writes a header into the local chain, given that its parent is
  1134. // already known. If the total difficulty of the newly inserted header becomes
  1135. // greater than the current known TD, the canonical chain is re-routed.
  1136. //
  1137. // Note: This method is not concurrent-safe with inserting blocks simultaneously
  1138. // into the chain, as side effects caused by reorganisations cannot be emulated
  1139. // without the real blocks. Hence, writing headers directly should only be done
  1140. // in two scenarios: pure-header mode of operation (light clients), or properly
  1141. // separated header/block phases (non-archive clients).
  1142. func (self *BlockChain) writeHeader(header *types.Header) error {
  1143. self.wg.Add(1)
  1144. defer self.wg.Done()
  1145. self.mu.Lock()
  1146. defer self.mu.Unlock()
  1147. _, err := self.hc.WriteHeader(header)
  1148. return err
  1149. }
  1150. // CurrentHeader retrieves the current head header of the canonical chain. The
  1151. // header is retrieved from the HeaderChain's internal cache.
  1152. func (self *BlockChain) CurrentHeader() *types.Header {
  1153. self.mu.RLock()
  1154. defer self.mu.RUnlock()
  1155. return self.hc.CurrentHeader()
  1156. }
  1157. // GetTd retrieves a block's total difficulty in the canonical chain from the
  1158. // database by hash and number, caching it if found.
  1159. func (self *BlockChain) GetTd(hash common.Hash, number uint64) *big.Int {
  1160. return self.hc.GetTd(hash, number)
  1161. }
  1162. // GetTdByHash retrieves a block's total difficulty in the canonical chain from the
  1163. // database by hash, caching it if found.
  1164. func (self *BlockChain) GetTdByHash(hash common.Hash) *big.Int {
  1165. return self.hc.GetTdByHash(hash)
  1166. }
  1167. // GetHeader retrieves a block header from the database by hash and number,
  1168. // caching it if found.
  1169. func (self *BlockChain) GetHeader(hash common.Hash, number uint64) *types.Header {
  1170. return self.hc.GetHeader(hash, number)
  1171. }
  1172. // GetHeaderByHash retrieves a block header from the database by hash, caching it if
  1173. // found.
  1174. func (self *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header {
  1175. return self.hc.GetHeaderByHash(hash)
  1176. }
  1177. // HasHeader checks if a block header is present in the database or not, caching
  1178. // it if present.
  1179. func (bc *BlockChain) HasHeader(hash common.Hash) bool {
  1180. return bc.hc.HasHeader(hash)
  1181. }
  1182. // GetBlockHashesFromHash retrieves a number of block hashes starting at a given
  1183. // hash, fetching towards the genesis block.
  1184. func (self *BlockChain) GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash {
  1185. return self.hc.GetBlockHashesFromHash(hash, max)
  1186. }
  1187. // GetHeaderByNumber retrieves a block header from the database by number,
  1188. // caching it (associated with its hash) if found.
  1189. func (self *BlockChain) GetHeaderByNumber(number uint64) *types.Header {
  1190. return self.hc.GetHeaderByNumber(number)
  1191. }
  1192. // Config retrieves the blockchain's chain configuration.
  1193. func (self *BlockChain) Config() *params.ChainConfig { return self.config }