1// Copyright 2018 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
17package core
18
19import (
20	"time"
21
22	"github.com/ethereum/go-ethereum/common"
23	"github.com/ethereum/go-ethereum/common/mclock"
24	"github.com/ethereum/go-ethereum/core/types"
25	"github.com/ethereum/go-ethereum/log"
26)
27
28// insertStats tracks and reports on block insertion.
29type insertStats struct {
30	queued, processed, ignored int
31	usedGas                    uint64
32	lastIndex                  int
33	startTime                  mclock.AbsTime
34}
35
36// statsReportLimit is the time limit during import and export after which we
37// always print out progress. This avoids the user wondering what's going on.
38const statsReportLimit = 8 * time.Second
39
40// report prints statistics if some number of blocks have been processed
41// or more than a few seconds have passed since the last message.
42func (st *insertStats) report(chain []*types.Block, index int, dirty common.StorageSize) {
43	// Fetch the timings for the batch
44	var (
45		now     = mclock.Now()
46		elapsed = now.Sub(st.startTime)
47	)
48	// If we're at the last block of the batch or report period reached, log
49	if index == len(chain)-1 || elapsed >= statsReportLimit {
50		// Count the number of transactions in this segment
51		var txs int
52		for _, block := range chain[st.lastIndex : index+1] {
53			txs += len(block.Transactions())
54		}
55		end := chain[index]
56
57		// Assemble the log context and send it to the logger
58		context := []interface{}{
59			"blocks", st.processed, "txs", txs, "mgas", float64(st.usedGas) / 1000000,
60			"elapsed", common.PrettyDuration(elapsed), "mgasps", float64(st.usedGas) * 1000 / float64(elapsed),
61			"number", end.Number(), "hash", end.Hash(),
62		}
63		if timestamp := time.Unix(int64(end.Time()), 0); time.Since(timestamp) > time.Minute {
64			context = append(context, []interface{}{"age", common.PrettyAge(timestamp)}...)
65		}
66		context = append(context, []interface{}{"dirty", dirty}...)
67
68		if st.queued > 0 {
69			context = append(context, []interface{}{"queued", st.queued}...)
70		}
71		if st.ignored > 0 {
72			context = append(context, []interface{}{"ignored", st.ignored}...)
73		}
74		log.Info("Imported new chain segment", context...)
75
76		// Bump the stats reported to the next section
77		*st = insertStats{startTime: now, lastIndex: index + 1}
78	}
79}
80
81// insertIterator is a helper to assist during chain import.
82type insertIterator struct {
83	chain types.Blocks // Chain of blocks being iterated over
84
85	results <-chan error // Verification result sink from the consensus engine
86	errors  []error      // Header verification errors for the blocks
87
88	index     int       // Current offset of the iterator
89	validator Validator // Validator to run if verification succeeds
90}
91
92// newInsertIterator creates a new iterator based on the given blocks, which are
93// assumed to be a contiguous chain.
94func newInsertIterator(chain types.Blocks, results <-chan error, validator Validator) *insertIterator {
95	return &insertIterator{
96		chain:     chain,
97		results:   results,
98		errors:    make([]error, 0, len(chain)),
99		index:     -1,
100		validator: validator,
101	}
102}
103
104// next returns the next block in the iterator, along with any potential validation
105// error for that block. When the end is reached, it will return (nil, nil).
106func (it *insertIterator) next() (*types.Block, error) {
107	// If we reached the end of the chain, abort
108	if it.index+1 >= len(it.chain) {
109		it.index = len(it.chain)
110		return nil, nil
111	}
112	// Advance the iterator and wait for verification result if not yet done
113	it.index++
114	if len(it.errors) <= it.index {
115		it.errors = append(it.errors, <-it.results)
116	}
117	if it.errors[it.index] != nil {
118		return it.chain[it.index], it.errors[it.index]
119	}
120	// Block header valid, run body validation and return
121	return it.chain[it.index], it.validator.ValidateBody(it.chain[it.index])
122}
123
124// peek returns the next block in the iterator, along with any potential validation
125// error for that block, but does **not** advance the iterator.
126//
127// Both header and body validation errors (nil too) is cached into the iterator
128// to avoid duplicating work on the following next() call.
129func (it *insertIterator) peek() (*types.Block, error) {
130	// If we reached the end of the chain, abort
131	if it.index+1 >= len(it.chain) {
132		return nil, nil
133	}
134	// Wait for verification result if not yet done
135	if len(it.errors) <= it.index+1 {
136		it.errors = append(it.errors, <-it.results)
137	}
138	if it.errors[it.index+1] != nil {
139		return it.chain[it.index+1], it.errors[it.index+1]
140	}
141	// Block header valid, ignore body validation since we don't have a parent anyway
142	return it.chain[it.index+1], nil
143}
144
145// previous returns the previous header that was being processed, or nil.
146func (it *insertIterator) previous() *types.Header {
147	if it.index < 1 {
148		return nil
149	}
150	return it.chain[it.index-1].Header()
151}
152
153// current returns the current header that is being processed, or nil.
154func (it *insertIterator) current() *types.Header {
155	if it.index == -1 || it.index >= len(it.chain) {
156		return nil
157	}
158	return it.chain[it.index].Header()
159}
160
161// first returns the first block in the it.
162func (it *insertIterator) first() *types.Block {
163	return it.chain[0]
164}
165
166// remaining returns the number of remaining blocks.
167func (it *insertIterator) remaining() int {
168	return len(it.chain) - it.index
169}
170
171// processed returns the number of processed blocks.
172func (it *insertIterator) processed() int {
173	return it.index + 1
174}
175