2017-03-05 09:38:34 -06:00
|
|
|
// Copyright 2017 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/>.
|
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// Package ethash implements the ethash proof-of-work consensus engine.
|
|
|
|
package ethash
|
2017-03-05 09:38:34 -06:00
|
|
|
|
|
|
|
import (
|
2017-03-05 12:00:01 -06:00
|
|
|
"errors"
|
2017-03-06 03:37:32 -06:00
|
|
|
"fmt"
|
2017-03-06 09:20:25 -06:00
|
|
|
"math"
|
2017-03-05 09:38:34 -06:00
|
|
|
"math/big"
|
2017-03-06 09:20:25 -06:00
|
|
|
"math/rand"
|
2017-03-06 03:37:32 -06:00
|
|
|
"os"
|
|
|
|
"path/filepath"
|
2017-03-07 12:05:54 -06:00
|
|
|
"reflect"
|
2018-01-23 04:05:30 -06:00
|
|
|
"runtime"
|
2017-03-07 12:05:54 -06:00
|
|
|
"strconv"
|
2017-03-05 09:38:34 -06:00
|
|
|
"sync"
|
2018-08-15 05:50:16 -05:00
|
|
|
"sync/atomic"
|
2017-03-05 09:38:34 -06:00
|
|
|
"time"
|
2017-03-07 12:05:54 -06:00
|
|
|
"unsafe"
|
2017-03-05 09:38:34 -06:00
|
|
|
|
2020-11-25 14:00:23 -06:00
|
|
|
"github.com/edsrzf/mmap-go"
|
2017-04-04 17:16:29 -05:00
|
|
|
"github.com/ethereum/go-ethereum/consensus"
|
2017-03-05 09:38:34 -06:00
|
|
|
"github.com/ethereum/go-ethereum/log"
|
2018-02-23 03:56:08 -06:00
|
|
|
"github.com/ethereum/go-ethereum/metrics"
|
2017-04-04 17:16:29 -05:00
|
|
|
"github.com/ethereum/go-ethereum/rpc"
|
2018-01-23 04:05:30 -06:00
|
|
|
"github.com/hashicorp/golang-lru/simplelru"
|
2017-03-05 09:38:34 -06:00
|
|
|
)
|
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
var ErrInvalidDumpMagic = errors.New("invalid dump magic")
|
2017-03-05 09:38:34 -06:00
|
|
|
|
|
|
|
var (
|
2018-08-08 04:15:08 -05:00
|
|
|
// two256 is a big integer representing 2^256
|
|
|
|
two256 = new(big.Int).Exp(big.NewInt(2), big.NewInt(256), big.NewInt(0))
|
2017-03-06 03:37:32 -06:00
|
|
|
|
|
|
|
// sharedEthash is a full instance that can be shared between multiple users.
|
2021-03-26 12:30:10 -05:00
|
|
|
sharedEthash *Ethash
|
2017-03-06 03:37:32 -06:00
|
|
|
|
|
|
|
// algorithmRevision is the data structure version used for file naming.
|
|
|
|
algorithmRevision = 23
|
|
|
|
|
|
|
|
// dumpMagic is a dataset dump header to sanity check a data dump.
|
2017-03-09 08:09:43 -06:00
|
|
|
dumpMagic = []uint32{0xbaddcafe, 0xfee1dead}
|
2017-03-05 09:38:34 -06:00
|
|
|
)
|
|
|
|
|
2021-03-26 12:30:10 -05:00
|
|
|
func init() {
|
|
|
|
sharedConfig := Config{
|
|
|
|
PowMode: ModeNormal,
|
|
|
|
CachesInMem: 3,
|
|
|
|
DatasetsInMem: 1,
|
|
|
|
}
|
|
|
|
sharedEthash = New(sharedConfig, nil, false)
|
|
|
|
}
|
|
|
|
|
2017-03-07 12:05:54 -06:00
|
|
|
// isLittleEndian returns whether the local system is running in little or big
|
|
|
|
// endian byte order.
|
|
|
|
func isLittleEndian() bool {
|
|
|
|
n := uint32(0x01020304)
|
|
|
|
return *(*byte)(unsafe.Pointer(&n)) == 0x04
|
|
|
|
}
|
|
|
|
|
|
|
|
// memoryMap tries to memory map a file of uint32s for read only access.
|
2020-03-31 03:44:04 -05:00
|
|
|
func memoryMap(path string, lock bool) (*os.File, mmap.MMap, []uint32, error) {
|
2017-03-07 12:05:54 -06:00
|
|
|
file, err := os.OpenFile(path, os.O_RDONLY, 0644)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
mem, buffer, err := memoryMapFile(file, false)
|
|
|
|
if err != nil {
|
|
|
|
file.Close()
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
2017-03-09 08:09:43 -06:00
|
|
|
for i, magic := range dumpMagic {
|
|
|
|
if buffer[i] != magic {
|
|
|
|
mem.Unmap()
|
|
|
|
file.Close()
|
|
|
|
return nil, nil, nil, ErrInvalidDumpMagic
|
|
|
|
}
|
|
|
|
}
|
2020-03-31 03:44:04 -05:00
|
|
|
if lock {
|
|
|
|
if err := mem.Lock(); err != nil {
|
|
|
|
mem.Unmap()
|
|
|
|
file.Close()
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
}
|
2017-03-09 08:09:43 -06:00
|
|
|
return file, mem, buffer[len(dumpMagic):], err
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// memoryMapFile tries to memory map an already opened file descriptor.
|
|
|
|
func memoryMapFile(file *os.File, write bool) (mmap.MMap, []uint32, error) {
|
|
|
|
// Try to memory map the file
|
|
|
|
flag := mmap.RDONLY
|
|
|
|
if write {
|
|
|
|
flag = mmap.RDWR
|
|
|
|
}
|
|
|
|
mem, err := mmap.Map(file, flag, 0)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
2021-04-27 03:49:06 -05:00
|
|
|
// The file is now memory-mapped. Create a []uint32 view of the file.
|
|
|
|
var view []uint32
|
|
|
|
header := (*reflect.SliceHeader)(unsafe.Pointer(&view))
|
|
|
|
header.Data = (*reflect.SliceHeader)(unsafe.Pointer(&mem)).Data
|
|
|
|
header.Cap = len(mem) / 4
|
|
|
|
header.Len = header.Cap
|
|
|
|
return mem, view, nil
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// memoryMapAndGenerate tries to memory map a temporary file of uint32s for write
|
|
|
|
// access, fill it with the data from a generator and then move it into the final
|
|
|
|
// path requested.
|
2020-03-31 03:44:04 -05:00
|
|
|
func memoryMapAndGenerate(path string, size uint64, lock bool, generator func(buffer []uint32)) (*os.File, mmap.MMap, []uint32, error) {
|
2017-03-07 12:05:54 -06:00
|
|
|
// Ensure the data folder exists
|
|
|
|
if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
// Create a huge temporary empty file to fill with data
|
|
|
|
temp := path + "." + strconv.Itoa(rand.Int())
|
|
|
|
|
|
|
|
dump, err := os.Create(temp)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
2021-11-02 05:33:54 -05:00
|
|
|
if err = ensureSize(dump, int64(len(dumpMagic))*4+int64(size)); err != nil {
|
|
|
|
dump.Close()
|
|
|
|
os.Remove(temp)
|
2017-03-07 12:05:54 -06:00
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
// Memory map the file for writing and fill it with the generator
|
|
|
|
mem, buffer, err := memoryMapFile(dump, true)
|
|
|
|
if err != nil {
|
|
|
|
dump.Close()
|
2021-11-02 05:33:54 -05:00
|
|
|
os.Remove(temp)
|
2017-03-07 12:05:54 -06:00
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
2017-03-09 08:09:43 -06:00
|
|
|
copy(buffer, dumpMagic)
|
|
|
|
|
|
|
|
data := buffer[len(dumpMagic):]
|
|
|
|
generator(data)
|
2017-03-07 12:05:54 -06:00
|
|
|
|
2017-04-14 03:32:47 -05:00
|
|
|
if err := mem.Unmap(); err != nil {
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
if err := dump.Close(); err != nil {
|
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
|
|
|
if err := os.Rename(temp, path); err != nil {
|
2017-03-07 12:05:54 -06:00
|
|
|
return nil, nil, nil, err
|
|
|
|
}
|
2020-03-31 03:44:04 -05:00
|
|
|
return memoryMap(path, lock)
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// lru tracks caches or datasets by their last use time, keeping at most N of them.
|
|
|
|
type lru struct {
|
|
|
|
what string
|
|
|
|
new func(epoch uint64) interface{}
|
|
|
|
mu sync.Mutex
|
|
|
|
// Items are kept in a LRU cache, but there is a special case:
|
|
|
|
// We always keep an item for (highest seen epoch) + 1 as the 'future item'.
|
|
|
|
cache *simplelru.LRU
|
|
|
|
future uint64
|
|
|
|
futureItem interface{}
|
|
|
|
}
|
|
|
|
|
2018-05-03 04:44:47 -05:00
|
|
|
// newlru create a new least-recently-used cache for either the verification caches
|
2018-01-23 04:05:30 -06:00
|
|
|
// or the mining datasets.
|
|
|
|
func newlru(what string, maxItems int, new func(epoch uint64) interface{}) *lru {
|
|
|
|
if maxItems <= 0 {
|
|
|
|
maxItems = 1
|
|
|
|
}
|
|
|
|
cache, _ := simplelru.NewLRU(maxItems, func(key, value interface{}) {
|
|
|
|
log.Trace("Evicted ethash "+what, "epoch", key)
|
|
|
|
})
|
|
|
|
return &lru{what: what, new: new, cache: cache}
|
|
|
|
}
|
|
|
|
|
|
|
|
// get retrieves or creates an item for the given epoch. The first return value is always
|
|
|
|
// non-nil. The second return value is non-nil if lru thinks that an item will be useful in
|
|
|
|
// the near future.
|
|
|
|
func (lru *lru) get(epoch uint64) (item, future interface{}) {
|
|
|
|
lru.mu.Lock()
|
|
|
|
defer lru.mu.Unlock()
|
|
|
|
|
|
|
|
// Get or create the item for the requested epoch.
|
|
|
|
item, ok := lru.cache.Get(epoch)
|
|
|
|
if !ok {
|
|
|
|
if lru.future > 0 && lru.future == epoch {
|
|
|
|
item = lru.futureItem
|
|
|
|
} else {
|
|
|
|
log.Trace("Requiring new ethash "+lru.what, "epoch", epoch)
|
|
|
|
item = lru.new(epoch)
|
|
|
|
}
|
|
|
|
lru.cache.Add(epoch, item)
|
|
|
|
}
|
|
|
|
// Update the 'future item' if epoch is larger than previously seen.
|
|
|
|
if epoch < maxEpoch-1 && lru.future < epoch+1 {
|
|
|
|
log.Trace("Requiring new future ethash "+lru.what, "epoch", epoch+1)
|
|
|
|
future = lru.new(epoch + 1)
|
|
|
|
lru.future = epoch + 1
|
|
|
|
lru.futureItem = future
|
|
|
|
}
|
|
|
|
return item, future
|
|
|
|
}
|
|
|
|
|
2017-03-05 12:00:01 -06:00
|
|
|
// cache wraps an ethash cache with some metadata to allow easier concurrent use.
|
|
|
|
type cache struct {
|
2018-01-23 04:05:30 -06:00
|
|
|
epoch uint64 // Epoch for which this cache is relevant
|
|
|
|
dump *os.File // File descriptor of the memory mapped cache
|
|
|
|
mmap mmap.MMap // Memory map itself to unmap before releasing
|
|
|
|
cache []uint32 // The actual cache data content (may be memory mapped)
|
|
|
|
once sync.Once // Ensures the cache is generated only once
|
|
|
|
}
|
2017-03-07 12:05:54 -06:00
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// newCache creates a new ethash verification cache and returns it as a plain Go
|
|
|
|
// interface to be usable in an LRU cache.
|
|
|
|
func newCache(epoch uint64) interface{} {
|
|
|
|
return &cache{epoch: epoch}
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2017-03-06 09:20:25 -06:00
|
|
|
// generate ensures that the cache content is generated before use.
|
2020-03-31 03:44:04 -05:00
|
|
|
func (c *cache) generate(dir string, limit int, lock bool, test bool) {
|
2017-03-05 12:00:01 -06:00
|
|
|
c.once.Do(func() {
|
2017-03-06 03:37:32 -06:00
|
|
|
size := cacheSize(c.epoch*epochLength + 1)
|
|
|
|
seed := seedHash(c.epoch*epochLength + 1)
|
2018-01-23 04:05:30 -06:00
|
|
|
if test {
|
|
|
|
size = 1024
|
|
|
|
}
|
|
|
|
// If we don't store anything on disk, generate and return.
|
2017-03-07 12:05:54 -06:00
|
|
|
if dir == "" {
|
|
|
|
c.cache = make([]uint32, size/4)
|
|
|
|
generateCache(c.cache, c.epoch, seed)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
// Disk storage is needed, this will get fancy
|
2017-03-09 08:09:43 -06:00
|
|
|
var endian string
|
2017-03-07 12:05:54 -06:00
|
|
|
if !isLittleEndian() {
|
2017-03-09 08:09:43 -06:00
|
|
|
endian = ".be"
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
2017-03-09 08:09:43 -06:00
|
|
|
path := filepath.Join(dir, fmt.Sprintf("cache-R%d-%x%s", algorithmRevision, seed[:8], endian))
|
2017-03-07 12:05:54 -06:00
|
|
|
logger := log.New("epoch", c.epoch)
|
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// We're about to mmap the file, ensure that the mapping is cleaned up when the
|
|
|
|
// cache becomes unused.
|
|
|
|
runtime.SetFinalizer(c, (*cache).finalizer)
|
|
|
|
|
2017-03-07 12:05:54 -06:00
|
|
|
// Try to load the file from disk and memory map it
|
|
|
|
var err error
|
2020-03-31 03:44:04 -05:00
|
|
|
c.dump, c.mmap, c.cache, err = memoryMap(path, lock)
|
2017-03-07 12:05:54 -06:00
|
|
|
if err == nil {
|
|
|
|
logger.Debug("Loaded old ethash cache from disk")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
logger.Debug("Failed to load old ethash cache", "err", err)
|
2017-03-06 03:37:32 -06:00
|
|
|
|
2017-03-07 12:05:54 -06:00
|
|
|
// No previous cache available, create a new cache file to fill
|
2020-03-31 03:44:04 -05:00
|
|
|
c.dump, c.mmap, c.cache, err = memoryMapAndGenerate(path, size, lock, func(buffer []uint32) { generateCache(buffer, c.epoch, seed) })
|
2017-03-07 12:05:54 -06:00
|
|
|
if err != nil {
|
|
|
|
logger.Error("Failed to generate mapped ethash cache", "err", err)
|
2017-03-06 03:37:32 -06:00
|
|
|
|
2017-03-07 12:05:54 -06:00
|
|
|
c.cache = make([]uint32, size/4)
|
|
|
|
generateCache(c.cache, c.epoch, seed)
|
2017-03-06 03:37:32 -06:00
|
|
|
}
|
2017-03-07 12:05:54 -06:00
|
|
|
// Iterate over all previous instances and delete old ones
|
|
|
|
for ep := int(c.epoch) - limit; ep >= 0; ep-- {
|
|
|
|
seed := seedHash(uint64(ep)*epochLength + 1)
|
2017-03-09 08:09:43 -06:00
|
|
|
path := filepath.Join(dir, fmt.Sprintf("cache-R%d-%x%s", algorithmRevision, seed[:8], endian))
|
2017-03-07 12:05:54 -06:00
|
|
|
os.Remove(path)
|
2017-03-05 12:00:01 -06:00
|
|
|
}
|
|
|
|
})
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// finalizer unmaps the memory and closes the file.
|
|
|
|
func (c *cache) finalizer() {
|
2017-03-07 12:05:54 -06:00
|
|
|
if c.mmap != nil {
|
|
|
|
c.mmap.Unmap()
|
|
|
|
c.dump.Close()
|
2018-01-23 04:05:30 -06:00
|
|
|
c.mmap, c.dump = nil, nil
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-06 09:20:25 -06:00
|
|
|
// dataset wraps an ethash dataset with some metadata to allow easier concurrent use.
|
|
|
|
type dataset struct {
|
2018-01-23 04:05:30 -06:00
|
|
|
epoch uint64 // Epoch for which this cache is relevant
|
|
|
|
dump *os.File // File descriptor of the memory mapped cache
|
|
|
|
mmap mmap.MMap // Memory map itself to unmap before releasing
|
|
|
|
dataset []uint32 // The actual cache data content
|
|
|
|
once sync.Once // Ensures the cache is generated only once
|
2018-08-15 05:50:16 -05:00
|
|
|
done uint32 // Atomic flag to determine generation status
|
2018-01-23 04:05:30 -06:00
|
|
|
}
|
2017-03-07 12:05:54 -06:00
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// newDataset creates a new ethash mining dataset and returns it as a plain Go
|
|
|
|
// interface to be usable in an LRU cache.
|
|
|
|
func newDataset(epoch uint64) interface{} {
|
|
|
|
return &dataset{epoch: epoch}
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// generate ensures that the dataset content is generated before use.
|
2020-03-31 03:44:04 -05:00
|
|
|
func (d *dataset) generate(dir string, limit int, lock bool, test bool) {
|
2017-03-06 09:20:25 -06:00
|
|
|
d.once.Do(func() {
|
2018-08-15 05:50:16 -05:00
|
|
|
// Mark the dataset generated after we're done. This is needed for remote
|
|
|
|
defer atomic.StoreUint32(&d.done, 1)
|
|
|
|
|
2017-03-06 09:20:25 -06:00
|
|
|
csize := cacheSize(d.epoch*epochLength + 1)
|
|
|
|
dsize := datasetSize(d.epoch*epochLength + 1)
|
|
|
|
seed := seedHash(d.epoch*epochLength + 1)
|
2018-01-23 04:05:30 -06:00
|
|
|
if test {
|
|
|
|
csize = 1024
|
|
|
|
dsize = 32 * 1024
|
|
|
|
}
|
|
|
|
// If we don't store anything on disk, generate and return
|
2017-03-07 12:05:54 -06:00
|
|
|
if dir == "" {
|
|
|
|
cache := make([]uint32, csize/4)
|
|
|
|
generateCache(cache, d.epoch, seed)
|
|
|
|
|
|
|
|
d.dataset = make([]uint32, dsize/4)
|
|
|
|
generateDataset(d.dataset, d.epoch, cache)
|
2018-08-15 05:50:16 -05:00
|
|
|
|
|
|
|
return
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
2017-03-07 12:05:54 -06:00
|
|
|
// Disk storage is needed, this will get fancy
|
2017-03-09 08:09:43 -06:00
|
|
|
var endian string
|
2017-03-07 12:05:54 -06:00
|
|
|
if !isLittleEndian() {
|
2017-03-09 08:09:43 -06:00
|
|
|
endian = ".be"
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
2017-03-09 08:09:43 -06:00
|
|
|
path := filepath.Join(dir, fmt.Sprintf("full-R%d-%x%s", algorithmRevision, seed[:8], endian))
|
2017-03-07 12:05:54 -06:00
|
|
|
logger := log.New("epoch", d.epoch)
|
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// We're about to mmap the file, ensure that the mapping is cleaned up when the
|
|
|
|
// cache becomes unused.
|
|
|
|
runtime.SetFinalizer(d, (*dataset).finalizer)
|
|
|
|
|
2017-03-07 12:05:54 -06:00
|
|
|
// Try to load the file from disk and memory map it
|
|
|
|
var err error
|
2020-03-31 03:44:04 -05:00
|
|
|
d.dump, d.mmap, d.dataset, err = memoryMap(path, lock)
|
2017-03-07 12:05:54 -06:00
|
|
|
if err == nil {
|
|
|
|
logger.Debug("Loaded old ethash dataset from disk")
|
|
|
|
return
|
|
|
|
}
|
|
|
|
logger.Debug("Failed to load old ethash dataset", "err", err)
|
|
|
|
|
|
|
|
// No previous dataset available, create a new dataset file to fill
|
|
|
|
cache := make([]uint32, csize/4)
|
|
|
|
generateCache(cache, d.epoch, seed)
|
2017-03-06 09:20:25 -06:00
|
|
|
|
2020-03-31 03:44:04 -05:00
|
|
|
d.dump, d.mmap, d.dataset, err = memoryMapAndGenerate(path, dsize, lock, func(buffer []uint32) { generateDataset(buffer, d.epoch, cache) })
|
2017-03-07 12:05:54 -06:00
|
|
|
if err != nil {
|
|
|
|
logger.Error("Failed to generate mapped ethash dataset", "err", err)
|
|
|
|
|
2021-11-02 05:33:54 -05:00
|
|
|
d.dataset = make([]uint32, dsize/4)
|
2017-03-07 12:05:54 -06:00
|
|
|
generateDataset(d.dataset, d.epoch, cache)
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
2017-03-07 12:05:54 -06:00
|
|
|
// Iterate over all previous instances and delete old ones
|
|
|
|
for ep := int(d.epoch) - limit; ep >= 0; ep-- {
|
|
|
|
seed := seedHash(uint64(ep)*epochLength + 1)
|
2017-03-09 08:09:43 -06:00
|
|
|
path := filepath.Join(dir, fmt.Sprintf("full-R%d-%x%s", algorithmRevision, seed[:8], endian))
|
2017-03-07 12:05:54 -06:00
|
|
|
os.Remove(path)
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2018-08-15 05:50:16 -05:00
|
|
|
// generated returns whether this particular dataset finished generating already
|
|
|
|
// or not (it may not have been started at all). This is useful for remote miners
|
|
|
|
// to default to verification caches instead of blocking on DAG generations.
|
|
|
|
func (d *dataset) generated() bool {
|
|
|
|
return atomic.LoadUint32(&d.done) == 1
|
|
|
|
}
|
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// finalizer closes any file handlers and memory maps open.
|
|
|
|
func (d *dataset) finalizer() {
|
2017-03-07 12:05:54 -06:00
|
|
|
if d.mmap != nil {
|
|
|
|
d.mmap.Unmap()
|
|
|
|
d.dump.Close()
|
2018-01-23 04:05:30 -06:00
|
|
|
d.mmap, d.dump = nil, nil
|
2017-03-07 12:05:54 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-06 09:20:25 -06:00
|
|
|
// MakeCache generates a new ethash cache and optionally stores it to disk.
|
|
|
|
func MakeCache(block uint64, dir string) {
|
2017-06-08 03:38:36 -05:00
|
|
|
c := cache{epoch: block / epochLength}
|
2020-03-31 03:44:04 -05:00
|
|
|
c.generate(dir, math.MaxInt32, false, false)
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// MakeDataset generates a new ethash dataset and optionally stores it to disk.
|
|
|
|
func MakeDataset(block uint64, dir string) {
|
2017-06-08 03:38:36 -05:00
|
|
|
d := dataset{epoch: block / epochLength}
|
2020-03-31 03:44:04 -05:00
|
|
|
d.generate(dir, math.MaxInt32, false, false)
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
|
|
|
|
2017-11-24 08:10:27 -06:00
|
|
|
// Mode defines the type and amount of PoW verification an ethash engine makes.
|
|
|
|
type Mode uint
|
|
|
|
|
|
|
|
const (
|
|
|
|
ModeNormal Mode = iota
|
|
|
|
ModeShared
|
|
|
|
ModeTest
|
|
|
|
ModeFake
|
|
|
|
ModeFullFake
|
|
|
|
)
|
|
|
|
|
|
|
|
// Config are the configuration parameters of the ethash.
|
|
|
|
type Config struct {
|
2020-03-31 03:44:04 -05:00
|
|
|
CacheDir string
|
|
|
|
CachesInMem int
|
|
|
|
CachesOnDisk int
|
|
|
|
CachesLockMmap bool
|
|
|
|
DatasetDir string
|
|
|
|
DatasetsInMem int
|
|
|
|
DatasetsOnDisk int
|
|
|
|
DatasetsLockMmap bool
|
|
|
|
PowMode Mode
|
2018-08-03 03:33:37 -05:00
|
|
|
|
2021-03-26 12:30:10 -05:00
|
|
|
// When set, notifications sent by the remote sealer will
|
|
|
|
// be block header JSON objects instead of work package arrays.
|
|
|
|
NotifyFull bool
|
|
|
|
|
2019-11-28 03:51:57 -06:00
|
|
|
Log log.Logger `toml:"-"`
|
2018-08-03 03:33:37 -05:00
|
|
|
}
|
|
|
|
|
2018-07-04 03:20:58 -05:00
|
|
|
// Ethash is a consensus engine based on proof-of-work implementing the ethash
|
2017-04-04 17:16:29 -05:00
|
|
|
// algorithm.
|
2017-03-05 12:00:01 -06:00
|
|
|
type Ethash struct {
|
2017-11-24 08:10:27 -06:00
|
|
|
config Config
|
2017-03-05 09:38:34 -06:00
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
caches *lru // In memory caches to avoid regenerating too often
|
|
|
|
datasets *lru // In memory datasets to avoid regenerating too often
|
2017-03-05 09:38:34 -06:00
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// Mining related fields
|
|
|
|
rand *rand.Rand // Properly seeded random source for nonces
|
|
|
|
threads int // Number of threads to mine on if mining
|
|
|
|
update chan struct{} // Notification channel to update mining parameters
|
2017-03-06 09:20:25 -06:00
|
|
|
hashrate metrics.Meter // Meter tracking the average hashrate
|
2019-11-28 03:51:57 -06:00
|
|
|
remote *remoteSealer
|
2018-08-03 03:33:37 -05:00
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// The fields below are hooks for testing
|
|
|
|
shared *Ethash // Shared PoW verifier to avoid cache regeneration
|
|
|
|
fakeFail uint64 // Block number which fails PoW check even in fake mode
|
|
|
|
fakeDelay time.Duration // Time delay to sleep for before returning from verify
|
|
|
|
|
2019-11-28 03:51:57 -06:00
|
|
|
lock sync.Mutex // Ensures thread safety for the in-memory caches and mining fields
|
|
|
|
closeOnce sync.Once // Ensures exit channel will not be closed twice.
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2018-08-08 04:15:08 -05:00
|
|
|
// New creates a full sized ethash PoW scheme and starts a background thread for
|
|
|
|
// remote mining, also optionally notifying a batch of remote services of new work
|
|
|
|
// packages.
|
2018-08-28 08:59:05 -05:00
|
|
|
func New(config Config, notify []string, noverify bool) *Ethash {
|
2019-11-28 03:51:57 -06:00
|
|
|
if config.Log == nil {
|
|
|
|
config.Log = log.Root()
|
|
|
|
}
|
2017-11-24 08:10:27 -06:00
|
|
|
if config.CachesInMem <= 0 {
|
2019-11-28 03:51:57 -06:00
|
|
|
config.Log.Warn("One ethash cache must always be in memory", "requested", config.CachesInMem)
|
2017-11-24 08:10:27 -06:00
|
|
|
config.CachesInMem = 1
|
2017-03-06 03:37:32 -06:00
|
|
|
}
|
2017-11-24 08:10:27 -06:00
|
|
|
if config.CacheDir != "" && config.CachesOnDisk > 0 {
|
2019-11-28 03:51:57 -06:00
|
|
|
config.Log.Info("Disk storage enabled for ethash caches", "dir", config.CacheDir, "count", config.CachesOnDisk)
|
2017-03-06 03:37:32 -06:00
|
|
|
}
|
2017-11-24 08:10:27 -06:00
|
|
|
if config.DatasetDir != "" && config.DatasetsOnDisk > 0 {
|
2019-11-28 03:51:57 -06:00
|
|
|
config.Log.Info("Disk storage enabled for ethash DAGs", "dir", config.DatasetDir, "count", config.DatasetsOnDisk)
|
2017-03-06 03:37:32 -06:00
|
|
|
}
|
2018-08-03 03:33:37 -05:00
|
|
|
ethash := &Ethash{
|
2019-11-28 03:51:57 -06:00
|
|
|
config: config,
|
|
|
|
caches: newlru("cache", config.CachesInMem, newCache),
|
|
|
|
datasets: newlru("dataset", config.DatasetsInMem, newDataset),
|
|
|
|
update: make(chan struct{}),
|
|
|
|
hashrate: metrics.NewMeterForced(),
|
|
|
|
}
|
2021-03-26 12:30:10 -05:00
|
|
|
if config.PowMode == ModeShared {
|
|
|
|
ethash.shared = sharedEthash
|
|
|
|
}
|
2019-11-28 03:51:57 -06:00
|
|
|
ethash.remote = startRemoteSealer(ethash, notify, noverify)
|
2018-08-03 03:33:37 -05:00
|
|
|
return ethash
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// NewTester creates a small sized ethash PoW scheme useful only for testing
|
2017-03-05 12:00:01 -06:00
|
|
|
// purposes.
|
2018-08-28 08:59:05 -05:00
|
|
|
func NewTester(notify []string, noverify bool) *Ethash {
|
2021-03-26 12:30:10 -05:00
|
|
|
return New(Config{PowMode: ModeTest}, notify, noverify)
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// NewFaker creates a ethash consensus engine with a fake PoW scheme that accepts
|
|
|
|
// all blocks' seal as valid, though they still have to conform to the Ethereum
|
|
|
|
// consensus rules.
|
|
|
|
func NewFaker() *Ethash {
|
2017-11-24 08:10:27 -06:00
|
|
|
return &Ethash{
|
|
|
|
config: Config{
|
|
|
|
PowMode: ModeFake,
|
2019-11-28 03:51:57 -06:00
|
|
|
Log: log.Root(),
|
2017-11-24 08:10:27 -06:00
|
|
|
},
|
|
|
|
}
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// NewFakeFailer creates a ethash consensus engine with a fake PoW scheme that
|
|
|
|
// accepts all blocks as valid apart from the single one specified, though they
|
|
|
|
// still have to conform to the Ethereum consensus rules.
|
|
|
|
func NewFakeFailer(fail uint64) *Ethash {
|
2017-11-24 08:10:27 -06:00
|
|
|
return &Ethash{
|
|
|
|
config: Config{
|
|
|
|
PowMode: ModeFake,
|
2019-11-28 03:51:57 -06:00
|
|
|
Log: log.Root(),
|
2017-11-24 08:10:27 -06:00
|
|
|
},
|
|
|
|
fakeFail: fail,
|
|
|
|
}
|
2017-04-04 17:16:29 -05:00
|
|
|
}
|
2017-03-05 09:38:34 -06:00
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// NewFakeDelayer creates a ethash consensus engine with a fake PoW scheme that
|
|
|
|
// accepts all blocks as valid, but delays verifications by some time, though
|
|
|
|
// they still have to conform to the Ethereum consensus rules.
|
|
|
|
func NewFakeDelayer(delay time.Duration) *Ethash {
|
2017-11-24 08:10:27 -06:00
|
|
|
return &Ethash{
|
|
|
|
config: Config{
|
|
|
|
PowMode: ModeFake,
|
2019-11-28 03:51:57 -06:00
|
|
|
Log: log.Root(),
|
2017-11-24 08:10:27 -06:00
|
|
|
},
|
|
|
|
fakeDelay: delay,
|
|
|
|
}
|
2017-04-04 17:16:29 -05:00
|
|
|
}
|
|
|
|
|
2017-06-12 07:45:17 -05:00
|
|
|
// NewFullFaker creates an ethash consensus engine with a full fake scheme that
|
2017-04-04 17:16:29 -05:00
|
|
|
// accepts all blocks as valid, without checking any consensus rules whatsoever.
|
|
|
|
func NewFullFaker() *Ethash {
|
2017-11-24 08:10:27 -06:00
|
|
|
return &Ethash{
|
|
|
|
config: Config{
|
|
|
|
PowMode: ModeFullFake,
|
2019-11-28 03:51:57 -06:00
|
|
|
Log: log.Root(),
|
2017-11-24 08:10:27 -06:00
|
|
|
},
|
|
|
|
}
|
2017-04-04 17:16:29 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewShared creates a full sized ethash PoW shared between all requesters running
|
|
|
|
// in the same process.
|
|
|
|
func NewShared() *Ethash {
|
|
|
|
return &Ethash{shared: sharedEthash}
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2018-08-03 03:33:37 -05:00
|
|
|
// Close closes the exit channel to notify all backend threads exiting.
|
|
|
|
func (ethash *Ethash) Close() error {
|
2022-03-17 10:20:03 -05:00
|
|
|
return ethash.StopRemoteSealer()
|
|
|
|
}
|
|
|
|
|
|
|
|
// StopRemoteSealer stops the remote sealer
|
|
|
|
func (ethash *Ethash) StopRemoteSealer() error {
|
2018-08-03 03:33:37 -05:00
|
|
|
ethash.closeOnce.Do(func() {
|
|
|
|
// Short circuit if the exit channel is not allocated.
|
2019-11-28 03:51:57 -06:00
|
|
|
if ethash.remote == nil {
|
2018-08-03 03:33:37 -05:00
|
|
|
return
|
|
|
|
}
|
2019-11-28 03:51:57 -06:00
|
|
|
close(ethash.remote.requestExit)
|
|
|
|
<-ethash.remote.exitCh
|
2018-08-03 03:33:37 -05:00
|
|
|
})
|
2021-03-19 06:04:15 -05:00
|
|
|
return nil
|
2018-08-03 03:33:37 -05:00
|
|
|
}
|
|
|
|
|
2017-03-05 12:00:01 -06:00
|
|
|
// cache tries to retrieve a verification cache for the specified block number
|
|
|
|
// by first checking against a list of in-memory caches, then against caches
|
|
|
|
// stored on disk, and finally generating one if none can be found.
|
2018-01-23 04:05:30 -06:00
|
|
|
func (ethash *Ethash) cache(block uint64) *cache {
|
2017-03-05 12:00:01 -06:00
|
|
|
epoch := block / epochLength
|
2018-01-23 04:05:30 -06:00
|
|
|
currentI, futureI := ethash.caches.get(epoch)
|
|
|
|
current := currentI.(*cache)
|
2017-03-05 12:00:01 -06:00
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// Wait for generation finish.
|
2020-03-31 03:44:04 -05:00
|
|
|
current.generate(ethash.config.CacheDir, ethash.config.CachesOnDisk, ethash.config.CachesLockMmap, ethash.config.PowMode == ModeTest)
|
2017-03-06 03:37:32 -06:00
|
|
|
|
2018-01-23 04:05:30 -06:00
|
|
|
// If we need a new future cache, now's a good time to regenerate it.
|
|
|
|
if futureI != nil {
|
|
|
|
future := futureI.(*cache)
|
2020-03-31 03:44:04 -05:00
|
|
|
go future.generate(ethash.config.CacheDir, ethash.config.CachesOnDisk, ethash.config.CachesLockMmap, ethash.config.PowMode == ModeTest)
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
2018-01-23 04:05:30 -06:00
|
|
|
return current
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2017-03-06 09:20:25 -06:00
|
|
|
// dataset tries to retrieve a mining dataset for the specified block number
|
|
|
|
// by first checking against a list of in-memory datasets, then against DAGs
|
|
|
|
// stored on disk, and finally generating one if none can be found.
|
2018-08-15 05:50:16 -05:00
|
|
|
//
|
|
|
|
// If async is specified, not only the future but the current DAG is also
|
|
|
|
// generates on a background thread.
|
|
|
|
func (ethash *Ethash) dataset(block uint64, async bool) *dataset {
|
|
|
|
// Retrieve the requested ethash dataset
|
2017-03-06 09:20:25 -06:00
|
|
|
epoch := block / epochLength
|
2018-01-23 04:05:30 -06:00
|
|
|
currentI, futureI := ethash.datasets.get(epoch)
|
|
|
|
current := currentI.(*dataset)
|
2017-03-06 09:20:25 -06:00
|
|
|
|
2018-08-15 05:50:16 -05:00
|
|
|
// If async is specified, generate everything in a background thread
|
|
|
|
if async && !current.generated() {
|
|
|
|
go func() {
|
2020-03-31 03:44:04 -05:00
|
|
|
current.generate(ethash.config.DatasetDir, ethash.config.DatasetsOnDisk, ethash.config.DatasetsLockMmap, ethash.config.PowMode == ModeTest)
|
2018-08-15 05:50:16 -05:00
|
|
|
|
|
|
|
if futureI != nil {
|
|
|
|
future := futureI.(*dataset)
|
2020-03-31 03:44:04 -05:00
|
|
|
future.generate(ethash.config.DatasetDir, ethash.config.DatasetsOnDisk, ethash.config.DatasetsLockMmap, ethash.config.PowMode == ModeTest)
|
2018-08-15 05:50:16 -05:00
|
|
|
}
|
|
|
|
}()
|
|
|
|
} else {
|
|
|
|
// Either blocking generation was requested, or already done
|
2020-03-31 03:44:04 -05:00
|
|
|
current.generate(ethash.config.DatasetDir, ethash.config.DatasetsOnDisk, ethash.config.DatasetsLockMmap, ethash.config.PowMode == ModeTest)
|
2018-08-15 05:50:16 -05:00
|
|
|
|
|
|
|
if futureI != nil {
|
|
|
|
future := futureI.(*dataset)
|
2020-03-31 03:44:04 -05:00
|
|
|
go future.generate(ethash.config.DatasetDir, ethash.config.DatasetsOnDisk, ethash.config.DatasetsLockMmap, ethash.config.PowMode == ModeTest)
|
2018-08-15 05:50:16 -05:00
|
|
|
}
|
2017-03-06 09:20:25 -06:00
|
|
|
}
|
2018-01-23 04:05:30 -06:00
|
|
|
return current
|
2017-03-05 09:38:34 -06:00
|
|
|
}
|
|
|
|
|
2017-04-04 17:16:29 -05:00
|
|
|
// Threads returns the number of mining threads currently enabled. This doesn't
|
|
|
|
// necessarily mean that mining is running!
|
|
|
|
func (ethash *Ethash) Threads() int {
|
|
|
|
ethash.lock.Lock()
|
|
|
|
defer ethash.lock.Unlock()
|
|
|
|
|
|
|
|
return ethash.threads
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetThreads updates the number of mining threads currently enabled. Calling
|
|
|
|
// this method does not start mining, only sets the thread count. If zero is
|
2017-04-07 09:22:06 -05:00
|
|
|
// specified, the miner will use all cores of the machine. Setting a thread
|
|
|
|
// count below zero is allowed and will cause the miner to idle, without any
|
|
|
|
// work being done.
|
2017-04-04 17:16:29 -05:00
|
|
|
func (ethash *Ethash) SetThreads(threads int) {
|
|
|
|
ethash.lock.Lock()
|
|
|
|
defer ethash.lock.Unlock()
|
|
|
|
|
2017-04-07 09:22:06 -05:00
|
|
|
// If we're running a shared PoW, set the thread count on that instead
|
|
|
|
if ethash.shared != nil {
|
|
|
|
ethash.shared.SetThreads(threads)
|
|
|
|
return
|
|
|
|
}
|
2017-04-04 17:16:29 -05:00
|
|
|
// Update the threads and ping any running seal to pull in any changes
|
|
|
|
ethash.threads = threads
|
|
|
|
select {
|
|
|
|
case ethash.update <- struct{}{}:
|
|
|
|
default:
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-05 12:00:01 -06:00
|
|
|
// Hashrate implements PoW, returning the measured rate of the search invocations
|
|
|
|
// per second over the last minute.
|
2018-08-03 03:33:37 -05:00
|
|
|
// Note the returned hashrate includes local hashrate, but also includes the total
|
|
|
|
// hashrate of all remote miner.
|
2017-03-05 12:00:01 -06:00
|
|
|
func (ethash *Ethash) Hashrate() float64 {
|
2018-08-03 03:33:37 -05:00
|
|
|
// Short circuit if we are run the ethash in normal/test mode.
|
|
|
|
if ethash.config.PowMode != ModeNormal && ethash.config.PowMode != ModeTest {
|
|
|
|
return ethash.hashrate.Rate1()
|
|
|
|
}
|
|
|
|
var res = make(chan uint64, 1)
|
|
|
|
|
|
|
|
select {
|
2019-11-28 03:51:57 -06:00
|
|
|
case ethash.remote.fetchRateCh <- res:
|
|
|
|
case <-ethash.remote.exitCh:
|
2018-08-03 03:33:37 -05:00
|
|
|
// Return local hashrate only if ethash is stopped.
|
|
|
|
return ethash.hashrate.Rate1()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Gather total submitted hash rate of remote sealers.
|
|
|
|
return ethash.hashrate.Rate1() + float64(<-res)
|
2017-03-05 12:00:01 -06:00
|
|
|
}
|
2017-03-05 09:38:34 -06:00
|
|
|
|
2018-08-03 03:33:37 -05:00
|
|
|
// APIs implements consensus.Engine, returning the user facing RPC APIs.
|
2020-07-28 10:02:35 -05:00
|
|
|
func (ethash *Ethash) APIs(chain consensus.ChainHeaderReader) []rpc.API {
|
2018-08-03 03:33:37 -05:00
|
|
|
// In order to ensure backward compatibility, we exposes ethash RPC APIs
|
|
|
|
// to both eth and ethash namespaces.
|
|
|
|
return []rpc.API{
|
|
|
|
{
|
|
|
|
Namespace: "eth",
|
|
|
|
Service: &API{ethash},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Namespace: "ethash",
|
|
|
|
Service: &API{ethash},
|
|
|
|
},
|
|
|
|
}
|
2017-04-04 17:16:29 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// SeedHash is the seed to use for generating a verification cache and the mining
|
|
|
|
// dataset.
|
|
|
|
func SeedHash(block uint64) []byte {
|
2017-03-05 12:00:01 -06:00
|
|
|
return seedHash(block)
|
|
|
|
}
|