tx_pool.go 23.8 KB
Newer Older
F
Felix Lange 已提交
1
// Copyright 2014 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
F
Felix Lange 已提交
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
F
Felix Lange 已提交
5 6 7 8
// 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.
//
9
// The go-ethereum library is distributed in the hope that it will be useful,
F
Felix Lange 已提交
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
F
Felix Lange 已提交
12 13 14
// GNU Lesser General Public License for more details.
//
// 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/>.
F
Felix Lange 已提交
16

O
obscuren 已提交
17
package core
O
obscuren 已提交
18 19

import (
20
	"errors"
O
obscuren 已提交
21
	"fmt"
O
obscuren 已提交
22
	"math/big"
23
	"sort"
24
	"sync"
25
	"time"
26

O
obscuren 已提交
27
	"github.com/ethereum/go-ethereum/common"
O
obscuren 已提交
28
	"github.com/ethereum/go-ethereum/core/state"
29
	"github.com/ethereum/go-ethereum/core/types"
O
obscuren 已提交
30
	"github.com/ethereum/go-ethereum/event"
O
obscuren 已提交
31
	"github.com/ethereum/go-ethereum/logger"
O
obscuren 已提交
32
	"github.com/ethereum/go-ethereum/logger/glog"
33
	"github.com/ethereum/go-ethereum/metrics"
34
	"gopkg.in/karalabe/cookiejar.v2/collections/prque"
O
obscuren 已提交
35 36
)

37
var (
38
	// Transaction Pool Errors
O
obscuren 已提交
39
	ErrInvalidSender      = errors.New("Invalid sender")
40
	ErrNonce              = errors.New("Nonce too low")
41
	ErrCheap              = errors.New("Gas price too low for acceptance")
42
	ErrBalance            = errors.New("Insufficient balance")
43
	ErrNonExistentAccount = errors.New("Account does not exist or account balance too low")
44
	ErrInsufficientFunds  = errors.New("Insufficient funds for gas * price + value")
O
obscuren 已提交
45
	ErrIntrinsicGas       = errors.New("Intrinsic gas too low")
46
	ErrGasLimit           = errors.New("Exceeds block gas limit")
47
	ErrNegativeValue      = errors.New("Negative value")
48
)
Z
zelig 已提交
49

50
var (
51 52 53 54 55 56
	minPendingPerAccount = uint64(16)    // Min number of guaranteed transaction slots per address
	maxPendingTotal      = uint64(4096)  // Max limit of pending transactions from all accounts (soft)
	maxQueuedPerAccount  = uint64(64)    // Max limit of queued transactions per address
	maxQueuedInTotal     = uint64(1024)  // Max limit of queued transactions from all accounts
	maxQueuedLifetime    = 3 * time.Hour // Max amount of time transactions from idle accounts are queued
	evictionInterval     = time.Minute   // Time interval to check for evictable transactions
57 58
)

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
var (
	// Metrics for the pending pool
	pendingDiscardCounter = metrics.NewCounter("txpool/pending/discard")
	pendingReplaceCounter = metrics.NewCounter("txpool/pending/replace")
	pendingRLCounter      = metrics.NewCounter("txpool/pending/ratelimit") // Dropped due to rate limiting
	pendingNofundsCounter = metrics.NewCounter("txpool/pending/nofunds")   // Dropped due to out-of-funds

	// Metrics for the queued pool
	queuedDiscardCounter = metrics.NewCounter("txpool/queued/discard")
	queuedReplaceCounter = metrics.NewCounter("txpool/queued/replace")
	queuedRLCounter      = metrics.NewCounter("txpool/queued/ratelimit") // Dropped due to rate limiting
	queuedNofundsCounter = metrics.NewCounter("txpool/queued/nofunds")   // Dropped due to out-of-funds

	// General tx metrics
	invalidTxCounter = metrics.NewCounter("txpool/invalid")
)

76
type stateFn func() (*state.StateDB, error)
77

78 79 80 81 82 83 84
// TxPool contains all currently known transactions. Transactions
// enter the pool when they are received from the network or submitted
// locally. They exit the pool when they are included in the blockchain.
//
// The pool separates processable transactions (which can be applied to the
// current state) and future transactions. Transactions move between those
// two states over time as they are received and processed.
O
obscuren 已提交
85
type TxPool struct {
86
	config       *ChainConfig
87
	currentState stateFn // The state function which will allow us to do some pre checks
88
	pendingState *state.ManagedState
89
	gasLimit     func() *big.Int // The current gas limit function callback
90
	minGasPrice  *big.Int
91
	eventMux     *event.TypeMux
92
	events       event.Subscription
93 94
	localTx      *txSet
	mu           sync.RWMutex
95

96 97
	pending map[common.Address]*txList         // All currently processable transactions
	queue   map[common.Address]*txList         // Queued but non-processable transactions
98
	all     map[common.Hash]*types.Transaction // All transactions to allow lookups
99
	beats   map[common.Address]time.Time       // Last heartbeat from each known account
100

101 102
	wg   sync.WaitGroup // for shutdown sync
	quit chan struct{}
103

104
	homestead bool
O
obscuren 已提交
105 106
}

107
func NewTxPool(config *ChainConfig, eventMux *event.TypeMux, currentStateFn stateFn, gasLimitFn func() *big.Int) *TxPool {
108
	pool := &TxPool{
109
		config:       config,
110 111
		pending:      make(map[common.Address]*txList),
		queue:        make(map[common.Address]*txList),
112
		all:          make(map[common.Hash]*types.Transaction),
113
		beats:        make(map[common.Address]time.Time),
114 115 116
		eventMux:     eventMux,
		currentState: currentStateFn,
		gasLimit:     gasLimitFn,
117
		minGasPrice:  new(big.Int),
118
		pendingState: nil,
119
		localTx:      newTxSet(),
120
		events:       eventMux.Subscribe(ChainHeadEvent{}, GasPriceChanged{}, RemovedTransactionEvent{}),
121
		quit:         make(chan struct{}),
O
obscuren 已提交
122
	}
123

124
	pool.wg.Add(2)
125
	go pool.eventLoop()
126
	go pool.expirationLoop()
127 128

	return pool
129 130
}

131
func (pool *TxPool) eventLoop() {
132 133
	defer pool.wg.Done()

O
obscuren 已提交
134 135 136
	// Track chain events. When a chain events occurs (new chain canon block)
	// we need to know the new state. The new state will help us determine
	// the nonces in the managed state
137
	for ev := range pool.events.Chan() {
138
		switch ev := ev.Data.(type) {
139
		case ChainHeadEvent:
140
			pool.mu.Lock()
141
			if ev.Block != nil && pool.config.IsHomestead(ev.Block.Number()) {
142 143 144
				pool.homestead = true
			}

145
			pool.resetState()
146
			pool.mu.Unlock()
147
		case GasPriceChanged:
148
			pool.mu.Lock()
149
			pool.minGasPrice = ev.Price
150 151
			pool.mu.Unlock()
		case RemovedTransactionEvent:
152
			pool.AddBatch(ev.Txs)
153
		}
154
	}
O
obscuren 已提交
155 156
}

157
func (pool *TxPool) resetState() {
158 159
	currentState, err := pool.currentState()
	if err != nil {
160
		glog.V(logger.Error).Infof("Failed to get current state: %v", err)
161 162 163 164
		return
	}
	managedState := state.ManageState(currentState)
	if err != nil {
165
		glog.V(logger.Error).Infof("Failed to get managed state: %v", err)
166 167 168
		return
	}
	pool.pendingState = managedState
169 170 171 172 173

	// validate the pool of pending transactions, this will remove
	// any transactions that have been included in the block or
	// have been invalidated because of another transaction (e.g.
	// higher gas price)
174 175 176 177
	pool.demoteUnexecutables()

	// Update all accounts to the latest known pending nonce
	for addr, list := range pool.pending {
178 179
		txs := list.Flatten() // Heavy but will be cached and is needed by the miner anyway
		pool.pendingState.SetNonce(addr, txs[len(txs)-1].Nonce()+1)
180 181 182
	}
	// Check the queue and move transactions over to the pending if possible
	// or remove those that have become invalid
183
	pool.promoteExecutables()
184 185
}

186 187
func (pool *TxPool) Stop() {
	pool.events.Unsubscribe()
188
	close(pool.quit)
189
	pool.wg.Wait()
190
	glog.V(logger.Info).Infoln("Transaction pool stopped")
191 192 193 194 195 196
}

func (pool *TxPool) State() *state.ManagedState {
	pool.mu.RLock()
	defer pool.mu.RUnlock()

197
	return pool.pendingState
198 199
}

200 201
// Stats retrieves the current pool stats, namely the number of pending and the
// number of queued (non-executable) transactions.
202 203 204 205
func (pool *TxPool) Stats() (pending int, queued int) {
	pool.mu.RLock()
	defer pool.mu.RUnlock()

206 207
	for _, list := range pool.pending {
		pending += list.Len()
208
	}
209 210
	for _, list := range pool.queue {
		queued += list.Len()
211 212 213 214
	}
	return
}

215
// Content retrieves the data content of the transaction pool, returning all the
216 217
// pending as well as queued transactions, grouped by account and sorted by nonce.
func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions) {
218 219 220
	pool.mu.RLock()
	defer pool.mu.RUnlock()

221 222 223 224 225 226 227
	pending := make(map[common.Address]types.Transactions)
	for addr, list := range pool.pending {
		pending[addr] = list.Flatten()
	}
	queued := make(map[common.Address]types.Transactions)
	for addr, list := range pool.queue {
		queued[addr] = list.Flatten()
228 229 230 231
	}
	return pending, queued
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
// Pending retrieves all currently processable transactions, groupped by origin
// account and sorted by nonce. The returned transaction set is a copy and can be
// freely modified by calling code.
func (pool *TxPool) Pending() map[common.Address]types.Transactions {
	pool.mu.Lock()
	defer pool.mu.Unlock()

	// check queue first
	pool.promoteExecutables()

	// invalidate any txs
	pool.demoteUnexecutables()

	pending := make(map[common.Address]types.Transactions)
	for addr, list := range pool.pending {
		pending[addr] = list.Flatten()
	}
	return pending
}

252 253 254 255 256 257 258 259
// SetLocal marks a transaction as local, skipping gas price
//  check against local miner minimum in the future
func (pool *TxPool) SetLocal(tx *types.Transaction) {
	pool.mu.Lock()
	defer pool.mu.Unlock()
	pool.localTx.add(tx.Hash())
}

260 261 262
// validateTx checks whether a transaction is valid according
// to the consensus rules.
func (pool *TxPool) validateTx(tx *types.Transaction) error {
263
	local := pool.localTx.contains(tx.Hash())
264
	// Drop transactions under our own minimal accepted gas price
265
	if !local && pool.minGasPrice.Cmp(tx.GasPrice()) > 0 {
266 267 268
		return ErrCheap
	}

269 270 271 272 273
	currentState, err := pool.currentState()
	if err != nil {
		return err
	}

274
	from, err := tx.From()
275
	if err != nil {
F
Felix Lange 已提交
276
		return ErrInvalidSender
O
obscuren 已提交
277
	}
O
obscuren 已提交
278

279
	// Make sure the account exist. Non existent accounts
O
obscuren 已提交
280
	// haven't got funds and well therefor never pass.
281
	if !currentState.Exist(from) {
O
obscuren 已提交
282
		return ErrNonExistentAccount
283
	}
O
obscuren 已提交
284

285
	// Last but not least check for nonce errors
286
	if currentState.GetNonce(from) > tx.Nonce() {
287 288 289
		return ErrNonce
	}

O
obscuren 已提交
290 291
	// Check the transaction doesn't exceed the current
	// block limit gas.
292
	if pool.gasLimit().Cmp(tx.Gas()) < 0 {
293 294 295
		return ErrGasLimit
	}

O
obscuren 已提交
296 297 298
	// Transactions can't be negative. This may never happen
	// using RLP decoded transactions but may occur if you create
	// a transaction using the RPC for example.
299
	if tx.Value().Cmp(common.Big0) < 0 {
300 301 302
		return ErrNegativeValue
	}

O
obscuren 已提交
303 304
	// Transactor should have enough funds to cover the costs
	// cost == V + GP * GL
305
	if currentState.GetBalance(from).Cmp(tx.Cost()) < 0 {
O
obscuren 已提交
306 307 308
		return ErrInsufficientFunds
	}

309
	intrGas := IntrinsicGas(tx.Data(), MessageCreatesContract(tx), pool.homestead)
310
	if tx.Gas().Cmp(intrGas) < 0 {
O
obscuren 已提交
311 312 313 314
		return ErrIntrinsicGas
	}

	return nil
O
obscuren 已提交
315 316
}

317 318 319 320
// add validates a transaction and inserts it into the non-executable queue for
// later pending promotion and execution.
func (pool *TxPool) add(tx *types.Transaction) error {
	// If the transaction is alreayd known, discard it
321
	hash := tx.Hash()
322 323
	if pool.all[hash] != nil {
		return fmt.Errorf("Known transaction: %x", hash[:4])
324
	}
325
	// Otherwise ensure basic validation passes and queue it up
326
	if err := pool.validateTx(tx); err != nil {
327
		invalidTxCounter.Inc(1)
328 329
		return err
	}
330
	pool.enqueueTx(hash, tx)
O
obscuren 已提交
331

332
	// Print a log message if low enough level is set
O
obscuren 已提交
333
	if glog.V(logger.Debug) {
334
		rcpt := "[NEW_CONTRACT]"
335
		if to := tx.To(); to != nil {
336
			rcpt = common.Bytes2Hex(to[:4])
337
		}
338 339
		from, _ := tx.From() // from already verified during tx validation
		glog.Infof("(t) 0x%x => %s (%v) %x\n", from[:4], rcpt, tx.Value, hash)
O
obscuren 已提交
340
	}
341 342 343
	return nil
}

344
// enqueueTx inserts a new transaction into the non-executable transaction queue.
345 346 347 348 349 350 351
//
// Note, this method assumes the pool lock is held!
func (pool *TxPool) enqueueTx(hash common.Hash, tx *types.Transaction) {
	// Try to insert the transaction into the future queue
	from, _ := tx.From() // already validated
	if pool.queue[from] == nil {
		pool.queue[from] = newTxList(false)
352
	}
353 354
	inserted, old := pool.queue[from].Add(tx)
	if !inserted {
355
		queuedDiscardCounter.Inc(1)
356 357 358 359 360
		return // An older transaction was better, discard this
	}
	// Discard any previous transaction and mark this
	if old != nil {
		delete(pool.all, old.Hash())
361
		queuedReplaceCounter.Inc(1)
362
	}
363
	pool.all[hash] = tx
364 365
}

366 367 368 369
// promoteTx adds a transaction to the pending (processable) list of transactions.
//
// Note, this method assumes the pool lock is held!
func (pool *TxPool) promoteTx(addr common.Address, hash common.Hash, tx *types.Transaction) {
370
	// Init delayed since tx pool could have been started before any state sync
371 372 373
	if pool.pendingState == nil {
		pool.resetState()
	}
374 375 376 377 378
	// Try to insert the transaction into the pending queue
	if pool.pending[addr] == nil {
		pool.pending[addr] = newTxList(true)
	}
	list := pool.pending[addr]
379

380 381 382 383
	inserted, old := list.Add(tx)
	if !inserted {
		// An older transaction was better, discard this
		delete(pool.all, hash)
384
		pendingDiscardCounter.Inc(1)
385
		return
386
	}
387 388 389
	// Otherwise discard any previous transaction and mark this
	if old != nil {
		delete(pool.all, old.Hash())
390
		pendingReplaceCounter.Inc(1)
391
	}
392
	pool.all[hash] = tx // Failsafe to work around direct pending inserts (tests)
393

394
	// Set the potentially new pending nonce and notify any subsystems of the new tx
395
	pool.beats[addr] = time.Now()
396
	pool.pendingState.SetNonce(addr, tx.Nonce()+1)
397
	go pool.eventMux.Post(TxPreEvent{tx})
398 399
}

400
// Add queues a single transaction in the pool if it is valid.
401 402 403
func (pool *TxPool) Add(tx *types.Transaction) error {
	pool.mu.Lock()
	defer pool.mu.Unlock()
404

405
	if err := pool.add(tx); err != nil {
406
		return err
407
	}
408 409
	pool.promoteExecutables()

410
	return nil
411
}
412

413 414 415 416
// AddBatch attempts to queue a batch of transactions.
func (pool *TxPool) AddBatch(txs []*types.Transaction) {
	pool.mu.Lock()
	defer pool.mu.Unlock()
417

Z
zelig 已提交
418
	for _, tx := range txs {
419
		if err := pool.add(tx); err != nil {
420
			glog.V(logger.Debug).Infoln("tx error:", err)
Z
zelig 已提交
421 422
		}
	}
423
	pool.promoteExecutables()
Z
zelig 已提交
424 425
}

426
// Get returns a transaction if it is contained in the pool
427
// and nil otherwise.
428 429 430
func (pool *TxPool) Get(hash common.Hash) *types.Transaction {
	pool.mu.RLock()
	defer pool.mu.RUnlock()
431

432
	return pool.all[hash]
433 434
}

435 436 437 438
// Remove removes the transaction with the given hash from the pool.
func (pool *TxPool) Remove(hash common.Hash) {
	pool.mu.Lock()
	defer pool.mu.Unlock()
439

440
	pool.removeTx(hash)
441 442
}

443 444
// RemoveBatch removes all given transactions from the pool.
func (pool *TxPool) RemoveBatch(txs types.Transactions) {
445 446
	pool.mu.Lock()
	defer pool.mu.Unlock()
447

448 449 450
	for _, tx := range txs {
		pool.removeTx(tx.Hash())
	}
451 452
}

453 454
// removeTx removes a single transaction from the queue, moving all subsequent
// transactions back to the future queue.
455
func (pool *TxPool) removeTx(hash common.Hash) {
456 457 458 459 460
	// Fetch the transaction we wish to delete
	tx, ok := pool.all[hash]
	if !ok {
		return
	}
461
	addr, _ := tx.From() // already validated during insertion
462

463
	// Remove it from the list of known transactions
464 465
	delete(pool.all, hash)

466 467 468
	// Remove the transaction from the pending lists and reset the account nonce
	if pending := pool.pending[addr]; pending != nil {
		if removed, invalids := pending.Remove(tx); removed {
469
			// If no more transactions are left, remove the list
470 471
			if pending.Empty() {
				delete(pool.pending, addr)
472
				delete(pool.beats, addr)
473
			} else {
474
				// Otherwise postpone any invalidated transactions
475 476 477 478
				for _, tx := range invalids {
					pool.enqueueTx(tx.Hash(), tx)
				}
			}
479 480 481 482
			// Update the account nonce if needed
			if nonce := tx.Nonce(); pool.pendingState.GetNonce(addr) > nonce {
				pool.pendingState.SetNonce(addr, tx.Nonce())
			}
483
		}
484
	}
485 486 487 488 489 490
	// Transaction is in the future queue
	if future := pool.queue[addr]; future != nil {
		future.Remove(tx)
		if future.Empty() {
			delete(pool.queue, addr)
		}
491 492 493
	}
}

494 495 496 497
// promoteExecutables moves transactions that have become processable from the
// future queue to the set of pending transactions. During this process, all
// invalidated transactions (low nonce, low balance) are deleted.
func (pool *TxPool) promoteExecutables() {
498
	// Init delayed since tx pool could have been started before any state sync
499 500 501
	if pool.pendingState == nil {
		pool.resetState()
	}
502 503 504 505 506 507 508
	// Retrieve the current state to allow nonce and balance checking
	state, err := pool.currentState()
	if err != nil {
		glog.Errorf("Could not get current state: %v", err)
		return
	}
	// Iterate over all accounts and promote any executable transactions
509
	queued := uint64(0)
510 511 512 513 514 515 516
	for addr, list := range pool.queue {
		// Drop all transactions that are deemed too old (low nonce)
		for _, tx := range list.Forward(state.GetNonce(addr)) {
			if glog.V(logger.Core) {
				glog.Infof("Removed old queued transaction: %v", tx)
			}
			delete(pool.all, tx.Hash())
517
		}
518 519 520 521 522
		// Drop all transactions that are too costly (low balance)
		drops, _ := list.Filter(state.GetBalance(addr))
		for _, tx := range drops {
			if glog.V(logger.Core) {
				glog.Infof("Removed unpayable queued transaction: %v", tx)
523
			}
524
			delete(pool.all, tx.Hash())
525
			queuedNofundsCounter.Inc(1)
526
		}
527 528 529 530
		// Gather all executable transactions and promote them
		for _, tx := range list.Ready(pool.pendingState.GetNonce(addr)) {
			if glog.V(logger.Core) {
				glog.Infof("Promoting queued transaction: %v", tx)
531
			}
532 533 534
			pool.promoteTx(addr, tx.Hash(), tx)
		}
		// Drop all transactions over the allowed limit
535
		for _, tx := range list.Cap(int(maxQueuedPerAccount)) {
536 537
			if glog.V(logger.Core) {
				glog.Infof("Removed cap-exceeding queued transaction: %v", tx)
538
			}
539
			delete(pool.all, tx.Hash())
540
			queuedRLCounter.Inc(1)
541
		}
542 543
		queued += uint64(list.Len())

544
		// Delete the entire queue entry if it became empty.
545 546
		if list.Empty() {
			delete(pool.queue, addr)
547 548
		}
	}
549 550 551 552 553 554
	// If the pending limit is overflown, start equalizing allowances
	pending := uint64(0)
	for _, list := range pool.pending {
		pending += uint64(list.Len())
	}
	if pending > maxPendingTotal {
555
		pendingBeforeCap := pending
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
		// Assemble a spam order to penalize large transactors first
		spammers := prque.New()
		for addr, list := range pool.pending {
			// Only evict transactions from high rollers
			if uint64(list.Len()) > minPendingPerAccount {
				// Skip local accounts as pools should maintain backlogs for themselves
				for _, tx := range list.txs.items {
					if !pool.localTx.contains(tx.Hash()) {
						spammers.Push(addr, float32(list.Len()))
					}
					break // Checking on transaction for locality is enough
				}
			}
		}
		// Gradually drop transactions from offenders
		offenders := []common.Address{}
		for pending > maxPendingTotal && !spammers.Empty() {
			// Retrieve the next offender if not local address
			offender, _ := spammers.Pop()
			offenders = append(offenders, offender.(common.Address))

			// Equalize balances until all the same or below threshold
			if len(offenders) > 1 {
				// Calculate the equalization threshold for all current offenders
				threshold := pool.pending[offender.(common.Address)].Len()

				// Iteratively reduce all offenders until below limit or threshold reached
				for pending > maxPendingTotal && pool.pending[offenders[len(offenders)-2]].Len() > threshold {
					for i := 0; i < len(offenders)-1; i++ {
						list := pool.pending[offenders[i]]
						list.Cap(list.Len() - 1)
						pending--
					}
				}
			}
		}
		// If still above threshold, reduce to limit or min allowance
		if pending > maxPendingTotal && len(offenders) > 0 {
			for pending > maxPendingTotal && uint64(pool.pending[offenders[len(offenders)-1]].Len()) > minPendingPerAccount {
				for _, addr := range offenders {
					list := pool.pending[addr]
					list.Cap(list.Len() - 1)
					pending--
				}
			}
		}
602
		pendingRLCounter.Inc(int64(pendingBeforeCap - pending))
603
	}
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
	// If we've queued more transactions than the hard limit, drop oldest ones
	if queued > maxQueuedInTotal {
		// Sort all accounts with queued transactions by heartbeat
		addresses := make(addresssByHeartbeat, 0, len(pool.queue))
		for addr, _ := range pool.queue {
			addresses = append(addresses, addressByHeartbeat{addr, pool.beats[addr]})
		}
		sort.Sort(addresses)

		// Drop transactions until the total is below the limit
		for drop := queued - maxQueuedInTotal; drop > 0; {
			addr := addresses[len(addresses)-1]
			list := pool.queue[addr.address]

			addresses = addresses[:len(addresses)-1]

			// Drop all transactions if they are less than the overflow
			if size := uint64(list.Len()); size <= drop {
				for _, tx := range list.Flatten() {
					pool.removeTx(tx.Hash())
				}
				drop -= size
626
				queuedRLCounter.Inc(int64(size))
627 628 629 630 631 632 633
				continue
			}
			// Otherwise drop only last few transactions
			txs := list.Flatten()
			for i := len(txs) - 1; i >= 0 && drop > 0; i-- {
				pool.removeTx(txs[i].Hash())
				drop--
634
				queuedRLCounter.Inc(1)
635 636 637
			}
		}
	}
638
}
639

640 641 642 643 644
// demoteUnexecutables removes invalid and processed transactions from the pools
// executable/pending queue and any subsequent transactions that become unexecutable
// are moved back into the future queue.
func (pool *TxPool) demoteUnexecutables() {
	// Retrieve the current state to allow nonce and balance checking
645 646 647 648 649
	state, err := pool.currentState()
	if err != nil {
		glog.V(logger.Info).Infoln("failed to get current state: %v", err)
		return
	}
650 651 652
	// Iterate over all accounts and demote any non-executable transactions
	for addr, list := range pool.pending {
		nonce := state.GetNonce(addr)
653

654 655 656 657
		// Drop all transactions that are deemed too old (low nonce)
		for _, tx := range list.Forward(nonce) {
			if glog.V(logger.Core) {
				glog.Infof("Removed old pending transaction: %v", tx)
658
			}
659 660 661 662 663 664 665
			delete(pool.all, tx.Hash())
		}
		// Drop all transactions that are too costly (low balance), and queue any invalids back for later
		drops, invalids := list.Filter(state.GetBalance(addr))
		for _, tx := range drops {
			if glog.V(logger.Core) {
				glog.Infof("Removed unpayable pending transaction: %v", tx)
666
			}
667
			delete(pool.all, tx.Hash())
668
			pendingNofundsCounter.Inc(1)
669
		}
670 671 672
		for _, tx := range invalids {
			if glog.V(logger.Core) {
				glog.Infof("Demoting pending transaction: %v", tx)
673
			}
674 675 676 677 678
			pool.enqueueTx(tx.Hash(), tx)
		}
		// Delete the entire queue entry if it became empty.
		if list.Empty() {
			delete(pool.pending, addr)
679
			delete(pool.beats, addr)
680 681 682
		}
	}
}
683

684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
// expirationLoop is a loop that periodically iterates over all accounts with
// queued transactions and drop all that have been inactive for a prolonged amount
// of time.
func (pool *TxPool) expirationLoop() {
	defer pool.wg.Done()

	evict := time.NewTicker(evictionInterval)
	defer evict.Stop()

	for {
		select {
		case <-evict.C:
			pool.mu.Lock()
			for addr := range pool.queue {
				if time.Since(pool.beats[addr]) > maxQueuedLifetime {
					for _, tx := range pool.queue[addr].Flatten() {
						pool.removeTx(tx.Hash())
					}
				}
			}
			pool.mu.Unlock()

		case <-pool.quit:
			return
		}
	}
}

// addressByHeartbeat is an account address tagged with its last activity timestamp.
type addressByHeartbeat struct {
	address   common.Address
	heartbeat time.Time
}

type addresssByHeartbeat []addressByHeartbeat

func (a addresssByHeartbeat) Len() int           { return len(a) }
func (a addresssByHeartbeat) Less(i, j int) bool { return a[i].heartbeat.Before(a[j].heartbeat) }
func (a addresssByHeartbeat) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
// txSet represents a set of transaction hashes in which entries
//  are automatically dropped after txSetDuration time
type txSet struct {
	txMap          map[common.Hash]struct{}
	txOrd          map[uint64]txOrdType
	addPtr, delPtr uint64
}

const txSetDuration = time.Hour * 2

// txOrdType represents an entry in the time-ordered list of transaction hashes
type txOrdType struct {
	hash common.Hash
	time time.Time
}

// newTxSet creates a new transaction set
func newTxSet() *txSet {
	return &txSet{
		txMap: make(map[common.Hash]struct{}),
		txOrd: make(map[uint64]txOrdType),
	}
}

// contains returns true if the set contains the given transaction hash
// (not thread safe, should be called from a locked environment)
func (self *txSet) contains(hash common.Hash) bool {
	_, ok := self.txMap[hash]
	return ok
}

// add adds a transaction hash to the set, then removes entries older than txSetDuration
// (not thread safe, should be called from a locked environment)
func (self *txSet) add(hash common.Hash) {
	self.txMap[hash] = struct{}{}
	now := time.Now()
	self.txOrd[self.addPtr] = txOrdType{hash: hash, time: now}
	self.addPtr++
	delBefore := now.Add(-txSetDuration)
	for self.delPtr < self.addPtr && self.txOrd[self.delPtr].time.Before(delBefore) {
		delete(self.txMap, self.txOrd[self.delPtr].hash)
		delete(self.txOrd, self.delPtr)
		self.delPtr++
	}
}