/
work.go
311 lines (266 loc) · 10.7 KB
/
work.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
// Modifications Copyright 2018 The klaytn Authors
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
//
// This file is derived from miner/miner.go (2018/06/04).
// Modified and improved for the klaytn development.
package work
import (
"fmt"
"io"
"math/big"
"sync/atomic"
"github.com/klaytn/klaytn/accounts"
"github.com/klaytn/klaytn/blockchain"
"github.com/klaytn/klaytn/blockchain/state"
"github.com/klaytn/klaytn/blockchain/types"
"github.com/klaytn/klaytn/blockchain/vm"
"github.com/klaytn/klaytn/common"
"github.com/klaytn/klaytn/consensus"
"github.com/klaytn/klaytn/datasync/downloader"
"github.com/klaytn/klaytn/event"
"github.com/klaytn/klaytn/log"
"github.com/klaytn/klaytn/params"
"github.com/klaytn/klaytn/rlp"
"github.com/klaytn/klaytn/storage/database"
)
var logger = log.NewModuleLogger(log.Work)
//go:generate mockgen -destination=work/mocks/txpool_mock.go -package=mocks github.com/klaytn/klaytn/work TxPool
// TxPool is an interface of blockchain.TxPool used by ProtocolManager and Backend.
type TxPool interface {
// HandleTxMsg should add the given transactions to the pool.
HandleTxMsg(types.Transactions)
// Pending should return pending transactions.
// The slice should be modifiable by the caller.
Pending() (map[common.Address]types.Transactions, error)
CachedPendingTxsByCount(count int) types.Transactions
// SubscribeNewTxsEvent should return an event subscription of
// NewTxsEvent and send events to the given channel.
SubscribeNewTxsEvent(chan<- blockchain.NewTxsEvent) event.Subscription
GetPendingNonce(addr common.Address) uint64
AddLocal(tx *types.Transaction) error
GasPrice() *big.Int
SetGasPrice(price *big.Int)
Stop()
Get(hash common.Hash) *types.Transaction
Stats() (int, int)
Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
}
// Backend wraps all methods required for mining.
type Backend interface {
AccountManager() accounts.AccountManager
BlockChain() BlockChain
TxPool() TxPool
ChainDB() database.DBManager
ReBroadcastTxs(transactions types.Transactions)
}
// Miner creates blocks and searches for proof-of-work values.
type Miner struct {
mux *event.TypeMux
worker *worker
rewardbase common.Address
mining int32
backend Backend
engine consensus.Engine
canStart int32 // can start indicates whether we can start the mining operation
shouldStart int32 // should start indicates whether we should start after sync
}
func New(backend Backend, config *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, nodetype common.ConnType, rewardbase common.Address, TxResendUseLegacy bool) *Miner {
miner := &Miner{
backend: backend,
mux: mux,
engine: engine,
worker: newWorker(config, engine, rewardbase, backend, mux, nodetype, TxResendUseLegacy),
canStart: 1,
}
// TODO-Klaytn drop or missing tx
miner.Register(NewCpuAgent(backend.BlockChain(), engine, nodetype))
go miner.update()
return miner
}
// update keeps track of the downloader events. Please be aware that this is a one shot type of update loop.
// It's entered once and as soon as `Done` or `Failed` has been broadcasted the events are unregistered and
// the loop is exited. This to prevent a major security vuln where external parties can DOS you with blocks
// and halt your mining operation for as long as the DOS continues.
func (self *Miner) update() {
events := self.mux.Subscribe(downloader.StartEvent{}, downloader.DoneEvent{}, downloader.FailedEvent{})
out:
for ev := range events.Chan() {
switch ev.Data.(type) {
case downloader.StartEvent:
atomic.StoreInt32(&self.canStart, 0)
if self.Mining() {
self.Stop()
atomic.StoreInt32(&self.shouldStart, 1)
logger.Info("Mining aborted due to sync")
}
case downloader.DoneEvent, downloader.FailedEvent:
shouldStart := atomic.LoadInt32(&self.shouldStart) == 1
atomic.StoreInt32(&self.canStart, 1)
atomic.StoreInt32(&self.shouldStart, 0)
if shouldStart {
self.Start()
}
// unsubscribe. we're only interested in this event once
events.Unsubscribe()
// stop immediately and ignore all further pending events
break out
}
}
}
func (self *Miner) Start() {
atomic.StoreInt32(&self.shouldStart, 1)
if atomic.LoadInt32(&self.canStart) == 0 {
logger.Info("Network syncing, will start work afterwards")
return
}
atomic.StoreInt32(&self.mining, 1)
if self.worker.nodetype == common.CONSENSUSNODE {
logger.Info("Starting mining operation")
}
self.worker.start()
self.worker.commitNewWork()
}
func (self *Miner) Stop() {
self.worker.stop()
atomic.StoreInt32(&self.mining, 0)
atomic.StoreInt32(&self.shouldStart, 0)
}
func (self *Miner) Register(agent Agent) {
if self.Mining() {
agent.Start()
}
self.worker.register(agent)
}
func (self *Miner) Unregister(agent Agent) {
self.worker.unregister(agent)
}
func (self *Miner) Mining() bool {
return atomic.LoadInt32(&self.mining) > 0
}
func (self *Miner) HashRate() (tot int64) {
if pow, ok := self.engine.(consensus.PoW); ok {
tot += int64(pow.Hashrate())
}
// do we care this might race? is it worth we're rewriting some
// aspects of the worker/locking up agents so we can get an accurate
// hashrate?
for agent := range self.worker.agents {
if _, ok := agent.(*CpuAgent); !ok {
tot += agent.GetHashRate()
}
}
return
}
func (self *Miner) SetExtra(extra []byte) error {
// istanbul BFT
maximumExtraDataSize := params.GetMaximumExtraDataSize()
if uint64(len(extra)) > maximumExtraDataSize {
return fmt.Errorf("Extra exceeds max length. %d > %v", len(extra), maximumExtraDataSize)
}
self.worker.setExtra(extra)
return nil
}
// Pending returns the currently pending block and associated state.
func (self *Miner) Pending() (*types.Block, *state.StateDB) {
return self.worker.pending()
}
// PendingBlock returns the currently pending block.
//
// Note, to access both the pending block and the pending state
// simultaneously, please use Pending(), as the pending state can
// change between multiple method calls
func (self *Miner) PendingBlock() *types.Block {
return self.worker.pendingBlock()
}
//go:generate mockgen -destination=mocks/blockchain_mock.go -package=mocks github.com/klaytn/klaytn/work BlockChain
// BlockChain is an interface of blockchain.BlockChain used by ProtocolManager.
type BlockChain interface {
Genesis() *types.Block
CurrentBlock() *types.Block
CurrentFastBlock() *types.Block
HasBlock(hash common.Hash, number uint64) bool
GetBlock(hash common.Hash, number uint64) *types.Block
GetBlockByHash(hash common.Hash) *types.Block
GetBlockByNumber(number uint64) *types.Block
GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash
CurrentHeader() *types.Header
HasHeader(hash common.Hash, number uint64) bool
GetHeader(hash common.Hash, number uint64) *types.Header
GetHeaderByHash(hash common.Hash) *types.Header
GetHeaderByNumber(number uint64) *types.Header
GetTd(hash common.Hash, number uint64) *big.Int
GetTdByHash(hash common.Hash) *big.Int
GetBodyRLP(hash common.Hash) rlp.RawValue
GetReceiptsByBlockHash(blockHash common.Hash) types.Receipts
InsertChain(chain types.Blocks) (int, error)
TrieNode(hash common.Hash) ([]byte, error)
Config() *params.ChainConfig
State() (*state.StateDB, error)
Rollback(chain []common.Hash)
InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts) (int, error)
InsertHeaderChain(chain []*types.Header, checkFreq int) (int, error)
FastSyncCommitHead(hash common.Hash) error
StateCache() state.Database
SubscribeChainEvent(ch chan<- blockchain.ChainEvent) event.Subscription
SetHead(head uint64) error
Stop()
SubscribeRemovedLogsEvent(ch chan<- blockchain.RemovedLogsEvent) event.Subscription
SubscribeChainHeadEvent(ch chan<- blockchain.ChainHeadEvent) event.Subscription
SubscribeChainSideEvent(ch chan<- blockchain.ChainSideEvent) event.Subscription
SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
IsParallelDBWrite() bool
IsSenderTxHashIndexingEnabled() bool
// Used in governance pkg
SetProposerPolicy(val uint64)
SetUseGiniCoeff(val bool)
Processor() blockchain.Processor
BadBlocks() ([]blockchain.BadBlockArgs, error)
StateAt(root common.Hash) (*state.StateDB, error)
StateAtWithPersistent(root common.Hash) (*state.StateDB, error)
StateAtWithGCLock(root common.Hash) (*state.StateDB, error)
Export(w io.Writer) error
Engine() consensus.Engine
GetTxLookupInfoAndReceipt(txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, *types.Receipt)
GetTxAndLookupInfoInCache(hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
GetBlockReceiptsInCache(blockHash common.Hash) types.Receipts
GetTxLookupInfoAndReceiptInCache(txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, *types.Receipt)
GetTxAndLookupInfo(txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
GetLogsByHash(hash common.Hash) [][]*types.Log
ResetWithGenesisBlock(gb *types.Block) error
Validator() blockchain.Validator
HasBadBlock(hash common.Hash) bool
WriteBlockWithState(block *types.Block, receipts []*types.Receipt, stateDB *state.StateDB) (blockchain.WriteResult, error)
PostChainEvents(events []interface{}, logs []*types.Log)
ApplyTransaction(config *params.ChainConfig, author *common.Address, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *uint64, cfg *vm.Config) (*types.Receipt, uint64, *vm.InternalTxTrace, error)
// State Migration
PrepareStateMigration() error
StartStateMigration(uint64, common.Hash) error
StopStateMigration() error
StateMigrationStatus() (bool, uint64, int, int, int, float64, error)
// Warm up
StartWarmUp() error
StartContractWarmUp(contractAddr common.Address) error
StopWarmUp() error
// Collect state/storage trie statistics
StartCollectingTrieStats(contractAddr common.Address) error
GetContractStorageRoot(block *types.Block, db state.Database, contractAddr common.Address) (common.Hash, error)
// Save trie node cache to this
SaveTrieNodeCacheToDisk() error
// KES
BlockSubscriptionLoop(pool *blockchain.TxPool)
CloseBlockSubscriptionLoop()
}