openethereum/ethash/benches/basic.rs

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of Open Ethereum.

// Open Ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Open Ethereum 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 General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Open Ethereum.  If not, see <http://www.gnu.org/licenses/>.

#[macro_use]
extern crate criterion;
extern crate ethash;
extern crate common_types;

use criterion::Criterion;
use ethash::{NodeCacheBuilder, keccak};
use common_types::engines::OptimizeFor;

const HASH: [u8; 32] = [
	0xf5, 0x7e, 0x6f, 0x3a, 0xcf, 0xc0, 0xdd, 0x4b,
	0x5b, 0xf2, 0xbe, 0xe4, 0x0a, 0xb3, 0x35, 0x8a,
	0xa6, 0x87, 0x73, 0xa8, 0xd0, 0x9f, 0x5e, 0x59,
	0x5e, 0xab, 0x55, 0x94, 0x05, 0x52, 0x7d, 0x72,
];
const MIX_HASH: [u8; 32] = [
	0x1f, 0xff, 0x04, 0xce, 0xc9, 0x41, 0x73, 0xfd,
	0x59, 0x1e, 0x3d, 0x89, 0x60, 0xce, 0x6b, 0xdf,
	0x8b, 0x19, 0x71, 0x04, 0x8c, 0x71, 0xff, 0x93,
	0x7b, 0xb2, 0xd3, 0x2a, 0x64, 0x31, 0xab, 0x6d,
];
const NONCE: u64 = 0xd7b3ac70a301a249;

criterion_group! {
	name = basic;
	config = dont_take_an_eternity_to_run();
	targets = bench_keccak_512_inplace,
		bench_light_compute_memmap,
		bench_light_compute_memory,
		bench_light_new_round_trip_memmap,
		bench_light_new_round_trip_memory,
		bench_light_from_file_round_trip_memory,
		bench_light_from_file_round_trip_memmap,
		bench_quick_get_difficulty,
}
criterion_main!(basic);

fn dont_take_an_eternity_to_run() -> Criterion {
	Criterion::default().nresamples(1_000)
		.without_plots()
		.sample_size(10)
}

fn bench_keccak_512_inplace(b: &mut Criterion) {
	b.bench_function("bench_keccak_512_inplace", move |b| b.iter(|| {
		let mut data = [4u8; 64];
		keccak::keccak_512::inplace(&mut data);
	}));
}

fn bench_light_compute_memmap(b: &mut Criterion) {
	use std::env;

	let builder = NodeCacheBuilder::new(OptimizeFor::Memory, u64::max_value());
	let light = builder.light(&env::temp_dir(), 486382);

	b.bench_function("bench_light_compute_memmap", move |b| b.iter(|| light.compute(&HASH, NONCE, u64::max_value())));
}

fn bench_light_compute_memory(b: &mut Criterion) {
	use std::env;

	let builder = NodeCacheBuilder::new(OptimizeFor::Cpu, u64::max_value());
	let light = builder.light(&env::temp_dir(), 486382);

	b.bench_function("bench_light_compute_memory", move |b| b.iter(|| light.compute(&HASH, NONCE, u64::max_value())));
}

fn bench_light_new_round_trip_memmap(b: &mut Criterion) {
	use std::env;

	b.bench_function("bench_light_new_round_trip_memmap", move |b| b.iter(|| {
		let builder = NodeCacheBuilder::new(OptimizeFor::Memory, u64::max_value());
		let light = builder.light(&env::temp_dir(), 486382);
		light.compute(&HASH, NONCE, u64::max_value());
	}));
}

fn bench_light_new_round_trip_memory(b: &mut Criterion) {
	use std::env;

	b.bench_function("bench_light_new_round_trip_memory", move |b| b.iter(|| {
		let builder = NodeCacheBuilder::new(OptimizeFor::Cpu, u64::max_value());
		let light = builder.light(&env::temp_dir(), 486382);
		light.compute(&HASH, NONCE, u64::max_value());
	}));
}

fn bench_light_from_file_round_trip_memory(b: &mut Criterion) {
	use std::env;

	let dir = env::temp_dir();
	let height = 486382;
	{
		let builder = NodeCacheBuilder::new(OptimizeFor::Cpu, u64::max_value());
		let mut dummy = builder.light(&dir, height);
		dummy.to_file().unwrap();
	}

	b.bench_function("bench_light_from_file_round_trip_memory", move |b| b.iter(|| {
		let builder = NodeCacheBuilder::new(OptimizeFor::Cpu, u64::max_value());
		let light = builder.light_from_file(&dir, 486382).unwrap();
		light.compute(&HASH, NONCE, u64::max_value());
	}));
}

fn bench_light_from_file_round_trip_memmap(b: &mut Criterion) {
	use std::env;

	let dir = env::temp_dir();
	let height = 486382;

	{
		let builder = NodeCacheBuilder::new(OptimizeFor::Memory, u64::max_value());
		let mut dummy = builder.light(&dir, height);
		dummy.to_file().unwrap();
	}

	b.bench_function("bench_light_from_file_round_trip_memmap", move |b| b.iter(|| {
		let builder = NodeCacheBuilder::new(OptimizeFor::Memory, u64::max_value());
		let light = builder.light_from_file(&dir, 486382).unwrap();
		light.compute(&HASH, NONCE, u64::max_value());
	}));
}

fn bench_quick_get_difficulty(b: &mut Criterion) {
	b.bench_function("bench_quick_get_difficulty", move |b| b.iter(|| {
		let d = ethash::quick_get_difficulty(&HASH, NONCE, &MIX_HASH, false);
		let boundary_good = [
			0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x3e, 0x9b, 0x6c, 0x69, 0xbc, 0x2c, 0xe2, 0xa2,
			0x4a, 0x8e, 0x95, 0x69, 0xef, 0xc7, 0xd7, 0x1b, 0x33, 0x35, 0xdf, 0x36, 0x8c, 0x9a,
			0xe9, 0x7e, 0x53, 0x84,
		];
		assert_eq!(d[..], boundary_good[..]);
	}));
}