• Felix Lange's avatar
    consensus/ethash: improve cache/dataset handling (#15864) · 924065e1
    Felix Lange authored
    * consensus/ethash: add maxEpoch constant
    
    * consensus/ethash: improve cache/dataset handling
    
    There are two fixes in this commit:
    
    Unmap the memory through a finalizer like the libethash wrapper did. The
    release logic was incorrect and freed the memory while it was being
    used, leading to crashes like in #14495 or #14943.
    
    Track caches and datasets using simplelru instead of reinventing LRU
    logic. This should make it easier to see whether it's correct.
    
    * consensus/ethash: restore 'future item' logic in lru
    
    * consensus/ethash: use mmap even in test mode
    
    This makes it possible to shorten the time taken for TestCacheFileEvict.
    
    * consensus/ethash: shuffle func calc*Size comments around
    
    * consensus/ethash: ensure future cache/dataset is in the lru cache
    
    * consensus/ethash: add issue link to the new test
    
    * consensus/ethash: fix vet
    
    * consensus/ethash: fix test
    
    * consensus: tiny issue + nitpick fixes
    924065e1
algorithm_go1.8.go 2.33 KB
// 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/>.

// +build go1.8

package ethash

import "math/big"

// cacheSize returns the size of the ethash verification cache that belongs to a certain
// block number.
func cacheSize(block uint64) uint64 {
	epoch := int(block / epochLength)
	if epoch < maxEpoch {
		return cacheSizes[epoch]
	}
	return calcCacheSize(epoch)
}

// calcCacheSize calculates the cache size for epoch. The cache size grows linearly,
// however, we always take the highest prime below the linearly growing threshold in order
// to reduce the risk of accidental regularities leading to cyclic behavior.
func calcCacheSize(epoch int) uint64 {
	size := cacheInitBytes + cacheGrowthBytes*uint64(epoch) - hashBytes
	for !new(big.Int).SetUint64(size / hashBytes).ProbablyPrime(1) { // Always accurate for n < 2^64
		size -= 2 * hashBytes
	}
	return size
}

// datasetSize returns the size of the ethash mining dataset that belongs to a certain
// block number.
func datasetSize(block uint64) uint64 {
	epoch := int(block / epochLength)
	if epoch < maxEpoch {
		return datasetSizes[epoch]
	}
	return calcDatasetSize(epoch)
}

// calcDatasetSize calculates the dataset size for epoch. The dataset size grows linearly,
// however, we always take the highest prime below the linearly growing threshold in order
// to reduce the risk of accidental regularities leading to cyclic behavior.
func calcDatasetSize(epoch int) uint64 {
	size := datasetInitBytes + datasetGrowthBytes*uint64(epoch) - mixBytes
	for !new(big.Int).SetUint64(size / mixBytes).ProbablyPrime(1) { // Always accurate for n < 2^64
		size -= 2 * mixBytes
	}
	return size
}