worker.go 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998
  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 miner
  17. import (
  18. "bytes"
  19. "errors"
  20. "math/big"
  21. "sync"
  22. "sync/atomic"
  23. "time"
  24. mapset "github.com/deckarep/golang-set"
  25. "github.com/ethereum/go-ethereum/common"
  26. "github.com/ethereum/go-ethereum/consensus"
  27. "github.com/ethereum/go-ethereum/consensus/misc"
  28. "github.com/ethereum/go-ethereum/core"
  29. "github.com/ethereum/go-ethereum/core/state"
  30. "github.com/ethereum/go-ethereum/core/types"
  31. "github.com/ethereum/go-ethereum/event"
  32. "github.com/ethereum/go-ethereum/log"
  33. "github.com/ethereum/go-ethereum/params"
  34. )
  35. const (
  36. // resultQueueSize is the size of channel listening to sealing result.
  37. resultQueueSize = 10
  38. // txChanSize is the size of channel listening to NewTxsEvent.
  39. // The number is referenced from the size of tx pool.
  40. txChanSize = 4096
  41. // chainHeadChanSize is the size of channel listening to ChainHeadEvent.
  42. chainHeadChanSize = 10
  43. // chainSideChanSize is the size of channel listening to ChainSideEvent.
  44. chainSideChanSize = 10
  45. // resubmitAdjustChanSize is the size of resubmitting interval adjustment channel.
  46. resubmitAdjustChanSize = 10
  47. // miningLogAtDepth is the number of confirmations before logging successful mining.
  48. miningLogAtDepth = 7
  49. // minRecommitInterval is the minimal time interval to recreate the mining block with
  50. // any newly arrived transactions.
  51. minRecommitInterval = 1 * time.Second
  52. // maxRecommitInterval is the maximum time interval to recreate the mining block with
  53. // any newly arrived transactions.
  54. maxRecommitInterval = 15 * time.Second
  55. // intervalAdjustRatio is the impact a single interval adjustment has on sealing work
  56. // resubmitting interval.
  57. intervalAdjustRatio = 0.1
  58. // intervalAdjustBias is applied during the new resubmit interval calculation in favor of
  59. // increasing upper limit or decreasing lower limit so that the limit can be reachable.
  60. intervalAdjustBias = 200 * 1000.0 * 1000.0
  61. // staleThreshold is the maximum depth of the acceptable stale block.
  62. staleThreshold = 7
  63. )
  64. // environment is the worker's current environment and holds all of the current state information.
  65. type environment struct {
  66. signer types.Signer
  67. state *state.StateDB // apply state changes here
  68. ancestors mapset.Set // ancestor set (used for checking uncle parent validity)
  69. family mapset.Set // family set (used for checking uncle invalidity)
  70. uncles mapset.Set // uncle set
  71. tcount int // tx count in cycle
  72. gasPool *core.GasPool // available gas used to pack transactions
  73. header *types.Header
  74. txs []*types.Transaction
  75. receipts []*types.Receipt
  76. }
  77. // task contains all information for consensus engine sealing and result submitting.
  78. type task struct {
  79. receipts []*types.Receipt
  80. state *state.StateDB
  81. block *types.Block
  82. createdAt time.Time
  83. }
  84. const (
  85. commitInterruptNone int32 = iota
  86. commitInterruptNewHead
  87. commitInterruptResubmit
  88. )
  89. // newWorkReq represents a request for new sealing work submitting with relative interrupt notifier.
  90. type newWorkReq struct {
  91. interrupt *int32
  92. noempty bool
  93. timestamp int64
  94. }
  95. // intervalAdjust represents a resubmitting interval adjustment.
  96. type intervalAdjust struct {
  97. ratio float64
  98. inc bool
  99. }
  100. // worker is the main object which takes care of submitting new work to consensus engine
  101. // and gathering the sealing result.
  102. type worker struct {
  103. config *Config
  104. chainConfig *params.ChainConfig
  105. engine consensus.Engine
  106. eth Backend
  107. chain *core.BlockChain
  108. // Subscriptions
  109. mux *event.TypeMux
  110. txsCh chan core.NewTxsEvent
  111. txsSub event.Subscription
  112. chainHeadCh chan core.ChainHeadEvent
  113. chainHeadSub event.Subscription
  114. chainSideCh chan core.ChainSideEvent
  115. chainSideSub event.Subscription
  116. // Channels
  117. newWorkCh chan *newWorkReq
  118. taskCh chan *task
  119. resultCh chan *types.Block
  120. startCh chan struct{}
  121. exitCh chan struct{}
  122. resubmitIntervalCh chan time.Duration
  123. resubmitAdjustCh chan *intervalAdjust
  124. current *environment // An environment for current running cycle.
  125. localUncles map[common.Hash]*types.Block // A set of side blocks generated locally as the possible uncle blocks.
  126. remoteUncles map[common.Hash]*types.Block // A set of side blocks as the possible uncle blocks.
  127. unconfirmed *unconfirmedBlocks // A set of locally mined blocks pending canonicalness confirmations.
  128. mu sync.RWMutex // The lock used to protect the coinbase and extra fields
  129. coinbase common.Address
  130. extra []byte
  131. pendingMu sync.RWMutex
  132. pendingTasks map[common.Hash]*task
  133. snapshotMu sync.RWMutex // The lock used to protect the block snapshot and state snapshot
  134. snapshotBlock *types.Block
  135. snapshotState *state.StateDB
  136. // atomic status counters
  137. running int32 // The indicator whether the consensus engine is running or not.
  138. newTxs int32 // New arrival transaction count since last sealing work submitting.
  139. // External functions
  140. isLocalBlock func(block *types.Block) bool // Function used to determine whether the specified block is mined by local miner.
  141. // Test hooks
  142. newTaskHook func(*task) // Method to call upon receiving a new sealing task.
  143. skipSealHook func(*task) bool // Method to decide whether skipping the sealing.
  144. fullTaskHook func() // Method to call before pushing the full sealing task.
  145. resubmitHook func(time.Duration, time.Duration) // Method to call upon updating resubmitting interval.
  146. }
  147. func newWorker(config *Config, chainConfig *params.ChainConfig, engine consensus.Engine, eth Backend, mux *event.TypeMux, isLocalBlock func(*types.Block) bool, init bool) *worker {
  148. worker := &worker{
  149. config: config,
  150. chainConfig: chainConfig,
  151. engine: engine,
  152. eth: eth,
  153. mux: mux,
  154. chain: eth.BlockChain(),
  155. isLocalBlock: isLocalBlock,
  156. localUncles: make(map[common.Hash]*types.Block),
  157. remoteUncles: make(map[common.Hash]*types.Block),
  158. unconfirmed: newUnconfirmedBlocks(eth.BlockChain(), miningLogAtDepth),
  159. pendingTasks: make(map[common.Hash]*task),
  160. txsCh: make(chan core.NewTxsEvent, txChanSize),
  161. chainHeadCh: make(chan core.ChainHeadEvent, chainHeadChanSize),
  162. chainSideCh: make(chan core.ChainSideEvent, chainSideChanSize),
  163. newWorkCh: make(chan *newWorkReq),
  164. taskCh: make(chan *task),
  165. resultCh: make(chan *types.Block, resultQueueSize),
  166. exitCh: make(chan struct{}),
  167. startCh: make(chan struct{}, 1),
  168. resubmitIntervalCh: make(chan time.Duration),
  169. resubmitAdjustCh: make(chan *intervalAdjust, resubmitAdjustChanSize),
  170. }
  171. // Subscribe NewTxsEvent for tx pool
  172. worker.txsSub = eth.TxPool().SubscribeNewTxsEvent(worker.txsCh)
  173. // Subscribe events for blockchain
  174. worker.chainHeadSub = eth.BlockChain().SubscribeChainHeadEvent(worker.chainHeadCh)
  175. worker.chainSideSub = eth.BlockChain().SubscribeChainSideEvent(worker.chainSideCh)
  176. // Sanitize recommit interval if the user-specified one is too short.
  177. recommit := worker.config.Recommit
  178. if recommit < minRecommitInterval {
  179. log.Warn("Sanitizing miner recommit interval", "provided", recommit, "updated", minRecommitInterval)
  180. recommit = minRecommitInterval
  181. }
  182. go worker.mainLoop()
  183. go worker.newWorkLoop(recommit)
  184. go worker.resultLoop()
  185. go worker.taskLoop()
  186. // Submit first work to initialize pending state.
  187. if init {
  188. worker.startCh <- struct{}{}
  189. }
  190. return worker
  191. }
  192. // setEtherbase sets the etherbase used to initialize the block coinbase field.
  193. func (w *worker) setEtherbase(addr common.Address) {
  194. w.mu.Lock()
  195. defer w.mu.Unlock()
  196. w.coinbase = addr
  197. }
  198. // setExtra sets the content used to initialize the block extra field.
  199. func (w *worker) setExtra(extra []byte) {
  200. w.mu.Lock()
  201. defer w.mu.Unlock()
  202. w.extra = extra
  203. }
  204. // setRecommitInterval updates the interval for miner sealing work recommitting.
  205. func (w *worker) setRecommitInterval(interval time.Duration) {
  206. w.resubmitIntervalCh <- interval
  207. }
  208. // pending returns the pending state and corresponding block.
  209. func (w *worker) pending() (*types.Block, *state.StateDB) {
  210. // return a snapshot to avoid contention on currentMu mutex
  211. w.snapshotMu.RLock()
  212. defer w.snapshotMu.RUnlock()
  213. if w.snapshotState == nil {
  214. return nil, nil
  215. }
  216. return w.snapshotBlock, w.snapshotState.Copy()
  217. }
  218. // pendingBlock returns pending block.
  219. func (w *worker) pendingBlock() *types.Block {
  220. // return a snapshot to avoid contention on currentMu mutex
  221. w.snapshotMu.RLock()
  222. defer w.snapshotMu.RUnlock()
  223. return w.snapshotBlock
  224. }
  225. // start sets the running status as 1 and triggers new work submitting.
  226. func (w *worker) start() {
  227. atomic.StoreInt32(&w.running, 1)
  228. w.startCh <- struct{}{}
  229. }
  230. // stop sets the running status as 0.
  231. func (w *worker) stop() {
  232. atomic.StoreInt32(&w.running, 0)
  233. }
  234. // isRunning returns an indicator whether worker is running or not.
  235. func (w *worker) isRunning() bool {
  236. return atomic.LoadInt32(&w.running) == 1
  237. }
  238. // close terminates all background threads maintained by the worker.
  239. // Note the worker does not support being closed multiple times.
  240. func (w *worker) close() {
  241. close(w.exitCh)
  242. }
  243. // newWorkLoop is a standalone goroutine to submit new mining work upon received events.
  244. func (w *worker) newWorkLoop(recommit time.Duration) {
  245. var (
  246. interrupt *int32
  247. minRecommit = recommit // minimal resubmit interval specified by user.
  248. timestamp int64 // timestamp for each round of mining.
  249. )
  250. timer := time.NewTimer(0)
  251. <-timer.C // discard the initial tick
  252. // commit aborts in-flight transaction execution with given signal and resubmits a new one.
  253. commit := func(noempty bool, s int32) {
  254. if interrupt != nil {
  255. atomic.StoreInt32(interrupt, s)
  256. }
  257. interrupt = new(int32)
  258. w.newWorkCh <- &newWorkReq{interrupt: interrupt, noempty: noempty, timestamp: timestamp}
  259. timer.Reset(recommit)
  260. atomic.StoreInt32(&w.newTxs, 0)
  261. }
  262. // recalcRecommit recalculates the resubmitting interval upon feedback.
  263. recalcRecommit := func(target float64, inc bool) {
  264. var (
  265. prev = float64(recommit.Nanoseconds())
  266. next float64
  267. )
  268. if inc {
  269. next = prev*(1-intervalAdjustRatio) + intervalAdjustRatio*(target+intervalAdjustBias)
  270. // Recap if interval is larger than the maximum time interval
  271. if next > float64(maxRecommitInterval.Nanoseconds()) {
  272. next = float64(maxRecommitInterval.Nanoseconds())
  273. }
  274. } else {
  275. next = prev*(1-intervalAdjustRatio) + intervalAdjustRatio*(target-intervalAdjustBias)
  276. // Recap if interval is less than the user specified minimum
  277. if next < float64(minRecommit.Nanoseconds()) {
  278. next = float64(minRecommit.Nanoseconds())
  279. }
  280. }
  281. recommit = time.Duration(int64(next))
  282. }
  283. // clearPending cleans the stale pending tasks.
  284. clearPending := func(number uint64) {
  285. w.pendingMu.Lock()
  286. for h, t := range w.pendingTasks {
  287. if t.block.NumberU64()+staleThreshold <= number {
  288. delete(w.pendingTasks, h)
  289. }
  290. }
  291. w.pendingMu.Unlock()
  292. }
  293. for {
  294. select {
  295. case <-w.startCh:
  296. clearPending(w.chain.CurrentBlock().NumberU64())
  297. timestamp = time.Now().Unix()
  298. commit(false, commitInterruptNewHead)
  299. case head := <-w.chainHeadCh:
  300. clearPending(head.Block.NumberU64())
  301. timestamp = time.Now().Unix()
  302. commit(false, commitInterruptNewHead)
  303. case <-timer.C:
  304. // If mining is running resubmit a new work cycle periodically to pull in
  305. // higher priced transactions. Disable this overhead for pending blocks.
  306. if w.isRunning() && (w.chainConfig.Clique == nil || w.chainConfig.Clique.Period > 0) {
  307. // Short circuit if no new transaction arrives.
  308. if atomic.LoadInt32(&w.newTxs) == 0 {
  309. timer.Reset(recommit)
  310. continue
  311. }
  312. commit(true, commitInterruptResubmit)
  313. }
  314. case interval := <-w.resubmitIntervalCh:
  315. // Adjust resubmit interval explicitly by user.
  316. if interval < minRecommitInterval {
  317. log.Warn("Sanitizing miner recommit interval", "provided", interval, "updated", minRecommitInterval)
  318. interval = minRecommitInterval
  319. }
  320. log.Info("Miner recommit interval update", "from", minRecommit, "to", interval)
  321. minRecommit, recommit = interval, interval
  322. if w.resubmitHook != nil {
  323. w.resubmitHook(minRecommit, recommit)
  324. }
  325. case adjust := <-w.resubmitAdjustCh:
  326. // Adjust resubmit interval by feedback.
  327. if adjust.inc {
  328. before := recommit
  329. recalcRecommit(float64(recommit.Nanoseconds())/adjust.ratio, true)
  330. log.Trace("Increase miner recommit interval", "from", before, "to", recommit)
  331. } else {
  332. before := recommit
  333. recalcRecommit(float64(minRecommit.Nanoseconds()), false)
  334. log.Trace("Decrease miner recommit interval", "from", before, "to", recommit)
  335. }
  336. if w.resubmitHook != nil {
  337. w.resubmitHook(minRecommit, recommit)
  338. }
  339. case <-w.exitCh:
  340. return
  341. }
  342. }
  343. }
  344. // mainLoop is a standalone goroutine to regenerate the sealing task based on the received event.
  345. func (w *worker) mainLoop() {
  346. defer w.txsSub.Unsubscribe()
  347. defer w.chainHeadSub.Unsubscribe()
  348. defer w.chainSideSub.Unsubscribe()
  349. for {
  350. select {
  351. case req := <-w.newWorkCh:
  352. w.commitNewWork(req.interrupt, req.noempty, req.timestamp)
  353. case ev := <-w.chainSideCh:
  354. // Short circuit for duplicate side blocks
  355. if _, exist := w.localUncles[ev.Block.Hash()]; exist {
  356. continue
  357. }
  358. if _, exist := w.remoteUncles[ev.Block.Hash()]; exist {
  359. continue
  360. }
  361. // Add side block to possible uncle block set depending on the author.
  362. if w.isLocalBlock != nil && w.isLocalBlock(ev.Block) {
  363. w.localUncles[ev.Block.Hash()] = ev.Block
  364. } else {
  365. w.remoteUncles[ev.Block.Hash()] = ev.Block
  366. }
  367. // If our mining block contains less than 2 uncle blocks,
  368. // add the new uncle block if valid and regenerate a mining block.
  369. if w.isRunning() && w.current != nil && w.current.uncles.Cardinality() < 2 {
  370. start := time.Now()
  371. if err := w.commitUncle(w.current, ev.Block.Header()); err == nil {
  372. var uncles []*types.Header
  373. w.current.uncles.Each(func(item interface{}) bool {
  374. hash, ok := item.(common.Hash)
  375. if !ok {
  376. return false
  377. }
  378. uncle, exist := w.localUncles[hash]
  379. if !exist {
  380. uncle, exist = w.remoteUncles[hash]
  381. }
  382. if !exist {
  383. return false
  384. }
  385. uncles = append(uncles, uncle.Header())
  386. return false
  387. })
  388. w.commit(uncles, nil, true, start)
  389. }
  390. }
  391. case ev := <-w.txsCh:
  392. // Apply transactions to the pending state if we're not mining.
  393. //
  394. // Note all transactions received may not be continuous with transactions
  395. // already included in the current mining block. These transactions will
  396. // be automatically eliminated.
  397. if !w.isRunning() && w.current != nil {
  398. // If block is already full, abort
  399. if gp := w.current.gasPool; gp != nil && gp.Gas() < params.TxGas {
  400. continue
  401. }
  402. w.mu.RLock()
  403. coinbase := w.coinbase
  404. w.mu.RUnlock()
  405. txs := make(map[common.Address]types.Transactions)
  406. for _, tx := range ev.Txs {
  407. acc, _ := types.Sender(w.current.signer, tx)
  408. txs[acc] = append(txs[acc], tx)
  409. }
  410. txset := types.NewTransactionsByPriceAndNonce(w.current.signer, txs)
  411. tcount := w.current.tcount
  412. w.commitTransactions(txset, coinbase, nil)
  413. // Only update the snapshot if any new transactons were added
  414. // to the pending block
  415. if tcount != w.current.tcount {
  416. w.updateSnapshot()
  417. }
  418. } else {
  419. // If clique is running in dev mode(period is 0), disable
  420. // advance sealing here.
  421. if w.chainConfig.Clique != nil && w.chainConfig.Clique.Period == 0 {
  422. w.commitNewWork(nil, true, time.Now().Unix())
  423. }
  424. }
  425. atomic.AddInt32(&w.newTxs, int32(len(ev.Txs)))
  426. // System stopped
  427. case <-w.exitCh:
  428. return
  429. case <-w.txsSub.Err():
  430. return
  431. case <-w.chainHeadSub.Err():
  432. return
  433. case <-w.chainSideSub.Err():
  434. return
  435. }
  436. }
  437. }
  438. // taskLoop is a standalone goroutine to fetch sealing task from the generator and
  439. // push them to consensus engine.
  440. func (w *worker) taskLoop() {
  441. var (
  442. stopCh chan struct{}
  443. prev common.Hash
  444. )
  445. // interrupt aborts the in-flight sealing task.
  446. interrupt := func() {
  447. if stopCh != nil {
  448. close(stopCh)
  449. stopCh = nil
  450. }
  451. }
  452. for {
  453. select {
  454. case task := <-w.taskCh:
  455. if w.newTaskHook != nil {
  456. w.newTaskHook(task)
  457. }
  458. // Reject duplicate sealing work due to resubmitting.
  459. sealHash := w.engine.SealHash(task.block.Header())
  460. if sealHash == prev {
  461. continue
  462. }
  463. // Interrupt previous sealing operation
  464. interrupt()
  465. stopCh, prev = make(chan struct{}), sealHash
  466. if w.skipSealHook != nil && w.skipSealHook(task) {
  467. continue
  468. }
  469. w.pendingMu.Lock()
  470. w.pendingTasks[w.engine.SealHash(task.block.Header())] = task
  471. w.pendingMu.Unlock()
  472. if err := w.engine.Seal(w.chain, task.block, w.resultCh, stopCh); err != nil {
  473. log.Warn("Block sealing failed", "err", err)
  474. }
  475. case <-w.exitCh:
  476. interrupt()
  477. return
  478. }
  479. }
  480. }
  481. // resultLoop is a standalone goroutine to handle sealing result submitting
  482. // and flush relative data to the database.
  483. func (w *worker) resultLoop() {
  484. for {
  485. select {
  486. case block := <-w.resultCh:
  487. // Short circuit when receiving empty result.
  488. if block == nil {
  489. continue
  490. }
  491. // Short circuit when receiving duplicate result caused by resubmitting.
  492. if w.chain.HasBlock(block.Hash(), block.NumberU64()) {
  493. continue
  494. }
  495. var (
  496. sealhash = w.engine.SealHash(block.Header())
  497. hash = block.Hash()
  498. )
  499. w.pendingMu.RLock()
  500. task, exist := w.pendingTasks[sealhash]
  501. w.pendingMu.RUnlock()
  502. if !exist {
  503. log.Error("Block found but no relative pending task", "number", block.Number(), "sealhash", sealhash, "hash", hash)
  504. continue
  505. }
  506. // Different block could share same sealhash, deep copy here to prevent write-write conflict.
  507. var (
  508. receipts = make([]*types.Receipt, len(task.receipts))
  509. logs []*types.Log
  510. )
  511. for i, receipt := range task.receipts {
  512. // add block location fields
  513. receipt.BlockHash = hash
  514. receipt.BlockNumber = block.Number()
  515. receipt.TransactionIndex = uint(i)
  516. receipts[i] = new(types.Receipt)
  517. *receipts[i] = *receipt
  518. // Update the block hash in all logs since it is now available and not when the
  519. // receipt/log of individual transactions were created.
  520. for _, log := range receipt.Logs {
  521. log.BlockHash = hash
  522. }
  523. logs = append(logs, receipt.Logs...)
  524. }
  525. // Commit block and state to database.
  526. stat, err := w.chain.WriteBlockWithState(block, receipts, task.state)
  527. if err != nil {
  528. log.Error("Failed writing block to chain", "err", err)
  529. continue
  530. }
  531. log.Info("Successfully sealed new block", "number", block.Number(), "sealhash", sealhash, "hash", hash,
  532. "elapsed", common.PrettyDuration(time.Since(task.createdAt)))
  533. // Broadcast the block and announce chain insertion event
  534. w.mux.Post(core.NewMinedBlockEvent{Block: block})
  535. var events []interface{}
  536. switch stat {
  537. case core.CanonStatTy:
  538. events = append(events, core.ChainEvent{Block: block, Hash: block.Hash(), Logs: logs})
  539. events = append(events, core.ChainHeadEvent{Block: block})
  540. case core.SideStatTy:
  541. events = append(events, core.ChainSideEvent{Block: block})
  542. }
  543. w.chain.PostChainEvents(events, logs)
  544. // Insert the block into the set of pending ones to resultLoop for confirmations
  545. w.unconfirmed.Insert(block.NumberU64(), block.Hash())
  546. case <-w.exitCh:
  547. return
  548. }
  549. }
  550. }
  551. // makeCurrent creates a new environment for the current cycle.
  552. func (w *worker) makeCurrent(parent *types.Block, header *types.Header) error {
  553. state, err := w.chain.StateAt(parent.Root())
  554. if err != nil {
  555. return err
  556. }
  557. env := &environment{
  558. signer: types.NewEIP155Signer(w.chainConfig.ChainID),
  559. state: state,
  560. ancestors: mapset.NewSet(),
  561. family: mapset.NewSet(),
  562. uncles: mapset.NewSet(),
  563. header: header,
  564. }
  565. // when 08 is processed ancestors contain 07 (quick block)
  566. for _, ancestor := range w.chain.GetBlocksFromHash(parent.Hash(), 7) {
  567. for _, uncle := range ancestor.Uncles() {
  568. env.family.Add(uncle.Hash())
  569. }
  570. env.family.Add(ancestor.Hash())
  571. env.ancestors.Add(ancestor.Hash())
  572. }
  573. // Keep track of transactions which return errors so they can be removed
  574. env.tcount = 0
  575. w.current = env
  576. return nil
  577. }
  578. // commitUncle adds the given block to uncle block set, returns error if failed to add.
  579. func (w *worker) commitUncle(env *environment, uncle *types.Header) error {
  580. hash := uncle.Hash()
  581. if env.uncles.Contains(hash) {
  582. return errors.New("uncle not unique")
  583. }
  584. if env.header.ParentHash == uncle.ParentHash {
  585. return errors.New("uncle is sibling")
  586. }
  587. if !env.ancestors.Contains(uncle.ParentHash) {
  588. return errors.New("uncle's parent unknown")
  589. }
  590. if env.family.Contains(hash) {
  591. return errors.New("uncle already included")
  592. }
  593. env.uncles.Add(uncle.Hash())
  594. return nil
  595. }
  596. // updateSnapshot updates pending snapshot block and state.
  597. // Note this function assumes the current variable is thread safe.
  598. func (w *worker) updateSnapshot() {
  599. w.snapshotMu.Lock()
  600. defer w.snapshotMu.Unlock()
  601. var uncles []*types.Header
  602. w.current.uncles.Each(func(item interface{}) bool {
  603. hash, ok := item.(common.Hash)
  604. if !ok {
  605. return false
  606. }
  607. uncle, exist := w.localUncles[hash]
  608. if !exist {
  609. uncle, exist = w.remoteUncles[hash]
  610. }
  611. if !exist {
  612. return false
  613. }
  614. uncles = append(uncles, uncle.Header())
  615. return false
  616. })
  617. w.snapshotBlock = types.NewBlock(
  618. w.current.header,
  619. w.current.txs,
  620. uncles,
  621. w.current.receipts,
  622. )
  623. w.snapshotState = w.current.state.Copy()
  624. }
  625. func (w *worker) commitTransaction(tx *types.Transaction, coinbase common.Address) ([]*types.Log, error) {
  626. snap := w.current.state.Snapshot()
  627. receipt, err := core.ApplyTransaction(w.chainConfig, w.chain, &coinbase, w.current.gasPool, w.current.state, w.current.header, tx, &w.current.header.GasUsed, *w.chain.GetVMConfig())
  628. if err != nil {
  629. w.current.state.RevertToSnapshot(snap)
  630. return nil, err
  631. }
  632. w.current.txs = append(w.current.txs, tx)
  633. w.current.receipts = append(w.current.receipts, receipt)
  634. return receipt.Logs, nil
  635. }
  636. func (w *worker) commitTransactions(txs *types.TransactionsByPriceAndNonce, coinbase common.Address, interrupt *int32) bool {
  637. // Short circuit if current is nil
  638. if w.current == nil {
  639. return true
  640. }
  641. if w.current.gasPool == nil {
  642. w.current.gasPool = new(core.GasPool).AddGas(w.current.header.GasLimit)
  643. }
  644. var coalescedLogs []*types.Log
  645. for {
  646. // In the following three cases, we will interrupt the execution of the transaction.
  647. // (1) new head block event arrival, the interrupt signal is 1
  648. // (2) worker start or restart, the interrupt signal is 1
  649. // (3) worker recreate the mining block with any newly arrived transactions, the interrupt signal is 2.
  650. // For the first two cases, the semi-finished work will be discarded.
  651. // For the third case, the semi-finished work will be submitted to the consensus engine.
  652. if interrupt != nil && atomic.LoadInt32(interrupt) != commitInterruptNone {
  653. // Notify resubmit loop to increase resubmitting interval due to too frequent commits.
  654. if atomic.LoadInt32(interrupt) == commitInterruptResubmit {
  655. ratio := float64(w.current.header.GasLimit-w.current.gasPool.Gas()) / float64(w.current.header.GasLimit)
  656. if ratio < 0.1 {
  657. ratio = 0.1
  658. }
  659. w.resubmitAdjustCh <- &intervalAdjust{
  660. ratio: ratio,
  661. inc: true,
  662. }
  663. }
  664. return atomic.LoadInt32(interrupt) == commitInterruptNewHead
  665. }
  666. // If we don't have enough gas for any further transactions then we're done
  667. if w.current.gasPool.Gas() < params.TxGas {
  668. log.Trace("Not enough gas for further transactions", "have", w.current.gasPool, "want", params.TxGas)
  669. break
  670. }
  671. // Retrieve the next transaction and abort if all done
  672. tx := txs.Peek()
  673. if tx == nil {
  674. break
  675. }
  676. // Error may be ignored here. The error has already been checked
  677. // during transaction acceptance is the transaction pool.
  678. //
  679. // We use the eip155 signer regardless of the current hf.
  680. from, _ := types.Sender(w.current.signer, tx)
  681. // Check whether the tx is replay protected. If we're not in the EIP155 hf
  682. // phase, start ignoring the sender until we do.
  683. if tx.Protected() && !w.chainConfig.IsEIP155(w.current.header.Number) {
  684. log.Trace("Ignoring reply protected transaction", "hash", tx.Hash(), "eip155", w.chainConfig.EIP155Block)
  685. txs.Pop()
  686. continue
  687. }
  688. // Start executing the transaction
  689. w.current.state.Prepare(tx.Hash(), common.Hash{}, w.current.tcount)
  690. logs, err := w.commitTransaction(tx, coinbase)
  691. switch err {
  692. case core.ErrGasLimitReached:
  693. // Pop the current out-of-gas transaction without shifting in the next from the account
  694. log.Trace("Gas limit exceeded for current block", "sender", from)
  695. txs.Pop()
  696. case core.ErrNonceTooLow:
  697. // New head notification data race between the transaction pool and miner, shift
  698. log.Trace("Skipping transaction with low nonce", "sender", from, "nonce", tx.Nonce())
  699. txs.Shift()
  700. case core.ErrNonceTooHigh:
  701. // Reorg notification data race between the transaction pool and miner, skip account =
  702. log.Trace("Skipping account with hight nonce", "sender", from, "nonce", tx.Nonce())
  703. txs.Pop()
  704. case nil:
  705. // Everything ok, collect the logs and shift in the next transaction from the same account
  706. coalescedLogs = append(coalescedLogs, logs...)
  707. w.current.tcount++
  708. txs.Shift()
  709. default:
  710. // Strange error, discard the transaction and get the next in line (note, the
  711. // nonce-too-high clause will prevent us from executing in vain).
  712. log.Debug("Transaction failed, account skipped", "hash", tx.Hash(), "err", err)
  713. txs.Shift()
  714. }
  715. }
  716. if !w.isRunning() && len(coalescedLogs) > 0 {
  717. // We don't push the pendingLogsEvent while we are mining. The reason is that
  718. // when we are mining, the worker will regenerate a mining block every 3 seconds.
  719. // In order to avoid pushing the repeated pendingLog, we disable the pending log pushing.
  720. // make a copy, the state caches the logs and these logs get "upgraded" from pending to mined
  721. // logs by filling in the block hash when the block was mined by the local miner. This can
  722. // cause a race condition if a log was "upgraded" before the PendingLogsEvent is processed.
  723. cpy := make([]*types.Log, len(coalescedLogs))
  724. for i, l := range coalescedLogs {
  725. cpy[i] = new(types.Log)
  726. *cpy[i] = *l
  727. }
  728. go w.mux.Post(core.PendingLogsEvent{Logs: cpy})
  729. }
  730. // Notify resubmit loop to decrease resubmitting interval if current interval is larger
  731. // than the user-specified one.
  732. if interrupt != nil {
  733. w.resubmitAdjustCh <- &intervalAdjust{inc: false}
  734. }
  735. return false
  736. }
  737. // commitNewWork generates several new sealing tasks based on the parent block.
  738. func (w *worker) commitNewWork(interrupt *int32, noempty bool, timestamp int64) {
  739. w.mu.RLock()
  740. defer w.mu.RUnlock()
  741. tstart := time.Now()
  742. parent := w.chain.CurrentBlock()
  743. if parent.Time() >= uint64(timestamp) {
  744. timestamp = int64(parent.Time() + 1)
  745. }
  746. // this will ensure we're not going off too far in the future
  747. if now := time.Now().Unix(); timestamp > now+1 {
  748. wait := time.Duration(timestamp-now) * time.Second
  749. log.Info("Mining too far in the future", "wait", common.PrettyDuration(wait))
  750. time.Sleep(wait)
  751. }
  752. num := parent.Number()
  753. header := &types.Header{
  754. ParentHash: parent.Hash(),
  755. Number: num.Add(num, common.Big1),
  756. GasLimit: core.CalcGasLimit(parent, w.config.GasFloor, w.config.GasCeil),
  757. Extra: w.extra,
  758. Time: uint64(timestamp),
  759. }
  760. // Only set the coinbase if our consensus engine is running (avoid spurious block rewards)
  761. if w.isRunning() {
  762. if w.coinbase == (common.Address{}) {
  763. log.Error("Refusing to mine without etherbase")
  764. return
  765. }
  766. header.Coinbase = w.coinbase
  767. }
  768. if err := w.engine.Prepare(w.chain, header); err != nil {
  769. log.Error("Failed to prepare header for mining", "err", err)
  770. return
  771. }
  772. // If we are care about TheDAO hard-fork check whether to override the extra-data or not
  773. if daoBlock := w.chainConfig.DAOForkBlock; daoBlock != nil {
  774. // Check whether the block is among the fork extra-override range
  775. limit := new(big.Int).Add(daoBlock, params.DAOForkExtraRange)
  776. if header.Number.Cmp(daoBlock) >= 0 && header.Number.Cmp(limit) < 0 {
  777. // Depending whether we support or oppose the fork, override differently
  778. if w.chainConfig.DAOForkSupport {
  779. header.Extra = common.CopyBytes(params.DAOForkBlockExtra)
  780. } else if bytes.Equal(header.Extra, params.DAOForkBlockExtra) {
  781. header.Extra = []byte{} // If miner opposes, don't let it use the reserved extra-data
  782. }
  783. }
  784. }
  785. // Could potentially happen if starting to mine in an odd state.
  786. err := w.makeCurrent(parent, header)
  787. if err != nil {
  788. log.Error("Failed to create mining context", "err", err)
  789. return
  790. }
  791. // Create the current work task and check any fork transitions needed
  792. env := w.current
  793. if w.chainConfig.DAOForkSupport && w.chainConfig.DAOForkBlock != nil && w.chainConfig.DAOForkBlock.Cmp(header.Number) == 0 {
  794. misc.ApplyDAOHardFork(env.state)
  795. }
  796. // Accumulate the uncles for the current block
  797. uncles := make([]*types.Header, 0, 2)
  798. commitUncles := func(blocks map[common.Hash]*types.Block) {
  799. // Clean up stale uncle blocks first
  800. for hash, uncle := range blocks {
  801. if uncle.NumberU64()+staleThreshold <= header.Number.Uint64() {
  802. delete(blocks, hash)
  803. }
  804. }
  805. for hash, uncle := range blocks {
  806. if len(uncles) == 2 {
  807. break
  808. }
  809. if err := w.commitUncle(env, uncle.Header()); err != nil {
  810. log.Trace("Possible uncle rejected", "hash", hash, "reason", err)
  811. } else {
  812. log.Debug("Committing new uncle to block", "hash", hash)
  813. uncles = append(uncles, uncle.Header())
  814. }
  815. }
  816. }
  817. // Prefer to locally generated uncle
  818. commitUncles(w.localUncles)
  819. commitUncles(w.remoteUncles)
  820. if !noempty {
  821. // Create an empty block based on temporary copied state for sealing in advance without waiting block
  822. // execution finished.
  823. w.commit(uncles, nil, false, tstart)
  824. }
  825. // Fill the block with all available pending transactions.
  826. pending, err := w.eth.TxPool().Pending()
  827. if err != nil {
  828. log.Error("Failed to fetch pending transactions", "err", err)
  829. return
  830. }
  831. // Short circuit if there is no available pending transactions
  832. if len(pending) == 0 {
  833. w.updateSnapshot()
  834. return
  835. }
  836. // Split the pending transactions into locals and remotes
  837. localTxs, remoteTxs := make(map[common.Address]types.Transactions), pending
  838. for _, account := range w.eth.TxPool().Locals() {
  839. if txs := remoteTxs[account]; len(txs) > 0 {
  840. delete(remoteTxs, account)
  841. localTxs[account] = txs
  842. }
  843. }
  844. if len(localTxs) > 0 {
  845. txs := types.NewTransactionsByPriceAndNonce(w.current.signer, localTxs)
  846. if w.commitTransactions(txs, w.coinbase, interrupt) {
  847. return
  848. }
  849. }
  850. if len(remoteTxs) > 0 {
  851. txs := types.NewTransactionsByPriceAndNonce(w.current.signer, remoteTxs)
  852. if w.commitTransactions(txs, w.coinbase, interrupt) {
  853. return
  854. }
  855. }
  856. w.commit(uncles, w.fullTaskHook, true, tstart)
  857. }
  858. // commit runs any post-transaction state modifications, assembles the final block
  859. // and commits new work if consensus engine is running.
  860. func (w *worker) commit(uncles []*types.Header, interval func(), update bool, start time.Time) error {
  861. // Deep copy receipts here to avoid interaction between different tasks.
  862. receipts := make([]*types.Receipt, len(w.current.receipts))
  863. for i, l := range w.current.receipts {
  864. receipts[i] = new(types.Receipt)
  865. *receipts[i] = *l
  866. }
  867. s := w.current.state.Copy()
  868. block, err := w.engine.FinalizeAndAssemble(w.chain, w.current.header, s, w.current.txs, uncles, w.current.receipts)
  869. if err != nil {
  870. return err
  871. }
  872. if w.isRunning() {
  873. if interval != nil {
  874. interval()
  875. }
  876. select {
  877. case w.taskCh <- &task{receipts: receipts, state: s, block: block, createdAt: time.Now()}:
  878. w.unconfirmed.Shift(block.NumberU64() - 1)
  879. feesWei := new(big.Int)
  880. for i, tx := range block.Transactions() {
  881. feesWei.Add(feesWei, new(big.Int).Mul(new(big.Int).SetUint64(receipts[i].GasUsed), tx.GasPrice()))
  882. }
  883. feesEth := new(big.Float).Quo(new(big.Float).SetInt(feesWei), new(big.Float).SetInt(big.NewInt(params.Ether)))
  884. log.Info("Commit new mining work", "number", block.Number(), "sealhash", w.engine.SealHash(block.Header()),
  885. "uncles", len(uncles), "txs", w.current.tcount, "gas", block.GasUsed(), "fees", feesEth, "elapsed", common.PrettyDuration(time.Since(start)))
  886. case <-w.exitCh:
  887. log.Info("Worker has exited")
  888. }
  889. }
  890. if update {
  891. w.updateSnapshot()
  892. }
  893. return nil
  894. }