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

// OpenEthereum 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.

// OpenEthereum 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 OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

//! benchmarking for EVM

#[macro_use]
extern crate criterion;
extern crate bit_set;
extern crate ethereum_types;
extern crate evm;
extern crate keccak_hash as hash;
extern crate memory_cache;
extern crate parity_bytes as bytes;
extern crate parking_lot;
extern crate rustc_hex;
extern crate vm;

use bytes::Bytes;
use criterion::{black_box, Bencher, Criterion};
use ethereum_types::{Address, U256};
use evm::Factory;
use rustc_hex::FromHex;
use std::{collections::BTreeMap, str::FromStr, sync::Arc};
use vm::{tests::FakeExt, ActionParams, Ext, GasLeft, Result};

criterion_group!(
    basic,
    mul500,
    mul1000,
    div500,
    div1000,
    sdiv500,
    sdiv1000,
    mod500,
    mod1000,
    smod500,
    smod1000,
    addmod500,
    addmod1000,
    mulmod500,
    mulmod1000,
    mulmod1_500,
    mulmod1_1000,
    mulmod5_500,
    mulmod5_1000,
    mulmod11_500,
    mulmod11_1000,
    mulmod_big_500,
    mulmod_big_1000,
    simple_loop_log0_usize,
    simple_loop_log0_u256,
    mem_gas_calculation_same_usize,
    mem_gas_calculation_same_u256,
    mem_gas_calculation_increasing_usize,
    mem_gas_calculation_increasing_u256,
    blockhash_mulmod_small,
    blockhash_mulmod_large,
);
criterion_main!(basic);

fn simple_loop_log0_usize(b: &mut Criterion) {
    b.bench_function("simple_loop_log0_usize", |b| {
        simple_loop_log0(U256::from(::std::usize::MAX), b);
    });
}

fn simple_loop_log0_u256(b: &mut Criterion) {
    b.bench_function("simple_loop_log0_u256", |b| {
        simple_loop_log0(!U256::zero(), b);
    });
}

fn simple_loop_log0(gas: U256, b: &mut Bencher) {
    let factory = Factory::default();
    let mut ext = FakeExt::new();

    let address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();
    let code = black_box("62ffffff5b600190036000600fa0600357".from_hex().unwrap());

    b.iter(|| {
        let mut params = ActionParams::default();
        params.address = address.clone();
        params.gas = gas;
        params.code = Some(Arc::new(code.clone()));

        let vm = factory.create(params, ext.schedule(), 0);

        result(vm.exec(&mut ext).ok().unwrap())
    });
}

fn mem_gas_calculation_same_usize(b: &mut Criterion) {
    b.bench_function("mem_gas_calculation_same_usize", |b| {
        mem_gas_calculation_same(U256::from(::std::usize::MAX), b);
    });
}

fn mem_gas_calculation_same_u256(b: &mut Criterion) {
    b.bench_function("mem_gas_calculation_same_u256", |b| {
        mem_gas_calculation_same(!U256::zero(), b);
    });
}

fn mem_gas_calculation_same(gas: U256, b: &mut Bencher) {
    let factory = Factory::default();
    let mut ext = FakeExt::new();

    let address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();

    b.iter(|| {
        let code = black_box(
            "6110006001556001546000555b610fff805560016000540380600055600c57"
                .from_hex()
                .unwrap(),
        );

        let mut params = ActionParams::default();
        params.address = address.clone();
        params.gas = gas;
        params.code = Some(Arc::new(code.clone()));

        let vm = factory.create(params, ext.schedule(), 0);

        result(vm.exec(&mut ext).ok().unwrap())
    });
}

fn mem_gas_calculation_increasing_usize(b: &mut Criterion) {
    b.bench_function("mem_gas_calculation_increasing_usize", |b| {
        mem_gas_calculation_increasing(U256::from(::std::usize::MAX), b);
    });
}

fn mem_gas_calculation_increasing_u256(b: &mut Criterion) {
    b.bench_function("mem_gas_calculation_increasing_u256", |b| {
        mem_gas_calculation_increasing(!U256::zero(), b);
    });
}

fn mem_gas_calculation_increasing(gas: U256, b: &mut Bencher) {
    let factory = Factory::default();
    let mut ext = FakeExt::new();

    let address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();

    b.iter(|| {
        let code = black_box(
            "6110006001556001546000555b610fff60005401805560016000540380600055600c57"
                .from_hex()
                .unwrap(),
        );

        let mut params = ActionParams::default();
        params.address = address.clone();
        params.gas = gas;
        params.code = Some(Arc::new(code.clone()));

        let vm = factory.create(params, ext.schedule(), 0);

        result(vm.exec(&mut ext).ok().unwrap())
    });
}

fn blockhash_mulmod_small(b: &mut Criterion) {
    b.bench_function("blockhash_mulmod_small", |b| {
		let factory = Factory::default();
		let mut ext = FakeExt::new();

		let address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();

		b.iter(|| {
			let code = black_box(
				"6080604052348015600f57600080fd5b5060005a90505b60c881111560de5760017effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095060017effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095060017effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095060017effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095060017effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff8009505a90506016565b506035806100ed6000396000f3fe6080604052600080fdfea165627a7a72305820bde4a0ac6d0fac28fc879244baf8a6a0eda514bc95fb7ecbcaaebf2556e2687c0029".from_hex().unwrap()
			);

			let mut params = ActionParams::default();
			params.address = address.clone();
			params.gas = U256::from(4_000u64);
			params.code = Some(Arc::new(code.clone()));

			let vm = factory.create(params, ext.schedule(), 0);

			result(vm.exec(&mut ext).ok().unwrap())
		});
	});
}

fn blockhash_mulmod_large(b: &mut Criterion) {
    b.bench_function("blockhash_mulmod_large", |b| {
		let factory = Factory::default();
		let mut ext = FakeExt::new();

		let address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();

		b.iter(|| {
			let code = black_box(
				"608060405234801561001057600080fd5b5060005a90505b60c8811115610177577efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff17efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff08009507efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff17efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff08009507efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff17efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff08009507efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff17efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff08009507efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff17efffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff08009505a9050610017565b506035806101866000396000f3fe6080604052600080fdfea165627a7a72305820dcaec306f67bb96f3044fff25c9af2ec66f01d0954d0656964f046f42f2780670029".from_hex().unwrap()
			);

			let mut params = ActionParams::default();
			params.address = address.clone();
			params.gas = U256::from(4_000u64);
			params.code = Some(Arc::new(code.clone()));

			let vm = factory.create(params, ext.schedule(), 0);

			result(vm.exec(&mut ext).ok().unwrap())
		});
	});
}

fn result(r: Result<evm::GasLeft>) -> U256 {
    match r {
        Ok(GasLeft::Known(gas_left)) => gas_left,
        Ok(GasLeft::NeedsReturn { gas_left, .. }) => gas_left,
        _ => U256::zero(),
    }
}

/// Runs a given EVM bytecode.
fn run_code(b: &mut Bencher, code: Bytes) {
    let factory = Factory::default();
    let mut ext = FakeExt::new();
    b.iter(|| {
        let mut params = ActionParams::default();
        params.address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();
        params.gas = U256::MAX;
        params.code = Some(Arc::new(black_box(code.clone())));
        let vm = factory.create(params, ext.schedule(), 0);
        result(vm.exec(&mut ext).ok().unwrap())
    });
}

/// Compute mulmod(U256::MAX, U256::MAX, 1) 500 times.
fn mulmod1_500(b: &mut Criterion) {
    b.bench_function("mulmod modulo 1, 500 times", |b| {
		run_code(b, "6101f45b6001900360017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 1) 1000 times.
fn mulmod1_1000(b: &mut Criterion) {
    b.bench_function("mulmod modulo 1, 1000 times", |b| {
		run_code(b, "6103e85b6001900360017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 5) 500 times.
fn mulmod5_500(b: &mut Criterion) {
    b.bench_function("mulmod modulo 5, 500 times", |b| {
		run_code(b, "6101f45b6001900360057fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 5) 1000 times.
fn mulmod5_1000(b: &mut Criterion) {
    b.bench_function("mulmod modulo 5, 1000 times", |b| {
		run_code(b, "6103e85b6001900360057fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 11) 500 times.
fn mulmod11_500(b: &mut Criterion) {
    b.bench_function("mulmod modulo 11, 500 times", |b| {
		run_code(b, "6101f45b60019003600b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 11) 1000 times.
fn mulmod11_1000(b: &mut Criterion) {
    b.bench_function("mulmod modulo 11, 1000 times", |b| {
		run_code(b, "6103e85b60019003600b7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 0x58bca9711298bc76cd73f173352c8bc1d1640f977c1ec9a849dfde6fdbfbd591) 500 times.
fn mulmod_big_500(b: &mut Criterion) {
    b.bench_function("mulmod modulo random 256-bit number, 500 times", |b| {
		run_code(b, "6101f45b600190037f58bca9711298bc76cd73f173352c8bc1d1640f977c1ec9a849dfde6fdbfbd5917fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(U256::MAX, U256::MAX, 0x58bca9711298bc76cd73f173352c8bc1d1640f977c1ec9a849dfde6fdbfbd591) 1000 times.
fn mulmod_big_1000(b: &mut Criterion) {
    b.bench_function("mulmod modulo random 256-bit number, 1000 times", |b| {
		run_code(b, "6103e85b600190037f58bca9711298bc76cd73f173352c8bc1d1640f977c1ec9a849dfde6fdbfbd5917fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(a, b, c) for random 256-bit a, b and c. Iterate 500 times.
///
/// Source:
/// ```
/// PUSH2 0x01F4
/// JUMPDEST
/// PUSH1 0x01
/// SWAP1
/// SUB
/// PUSH32 0x5ed6db9489224124a1a4110ec8bec8b01369c8b549a4b8c4388a1796dc35a937
/// PUSH32 0xb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db
/// PUSH32 0xcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca
/// MULMOD
/// POP
/// DUP1
/// PUSH1 0x03
/// JUMPI
/// ```
fn mulmod500(b: &mut Criterion) {
    b.bench_function("mulmod randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037f5ed6db9489224124a1a4110ec8bec8b01369c8b549a4b8c4388a1796dc35a9377fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca095080600357".from_hex().unwrap());
	});
}

/// Compute mulmod(a, b, c) for random 256-bit a, b and c. Iterate 1000 times.
fn mulmod1000(b: &mut Criterion) {
    b.bench_function("mulmod randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037f5ed6db9489224124a1a4110ec8bec8b01369c8b549a4b8c4388a1796dc35a9377fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca095080600357".from_hex().unwrap());
	});
}

/// Compute addmod(a, b, c) for random 256-bit a, b and c. Iterate 500 times.
fn addmod500(b: &mut Criterion) {
    b.bench_function("addmod randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037f5ed6db9489224124a1a4110ec8bec8b01369c8b549a4b8c4388a1796dc35a9377fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca085080600357".from_hex().unwrap());
	});
}

/// Compute addmod(a, b, c) for random 256-bit a, b and c. Iterate 1000 times.
fn addmod1000(b: &mut Criterion) {
    b.bench_function("addmod randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037f5ed6db9489224124a1a4110ec8bec8b01369c8b549a4b8c4388a1796dc35a9377fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca085080600357".from_hex().unwrap());
	});
}

/// Compute mul(a, b) for random 256-bit a and b. Iterate 500 times.
fn mul500(b: &mut Criterion) {
    b.bench_function("mul randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca025080600357".from_hex().unwrap());
	});
}

/// Compute mul(a, b) for random 256-bit a and b. Iterate 1000 times.
fn mul1000(b: &mut Criterion) {
    b.bench_function("mul randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca025080600357".from_hex().unwrap());
	});
}

/// Compute div(a, b) for random 256-bit a and b. Iterate 500 times.
fn div500(b: &mut Criterion) {
    b.bench_function("div randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca045080600357".from_hex().unwrap());
	});
}

/// Compute div(a, b) for random 256-bit a and b. Iterate 1000 times.
fn div1000(b: &mut Criterion) {
    b.bench_function("div randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca045080600357".from_hex().unwrap());
	});
}

/// Compute sdiv(a, b) for random 256-bit a and b. Iterate 500 times.
fn sdiv500(b: &mut Criterion) {
    b.bench_function("sdiv randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca055080600357".from_hex().unwrap());
	});
}

/// Compute sdiv(a, b) for random 256-bit a and b. Iterate 1000 times.
fn sdiv1000(b: &mut Criterion) {
    b.bench_function("sdiv randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca055080600357".from_hex().unwrap());
	});
}

/// Compute mod(a, b) for random 256-bit a and b. Iterate 500 times.
fn mod500(b: &mut Criterion) {
    b.bench_function("mod randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca065080600357".from_hex().unwrap());
	});
}

/// Compute mod(a, b) for random 256-bit a and b. Iterate 1000 times.
fn mod1000(b: &mut Criterion) {
    b.bench_function("mod randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca065080600357".from_hex().unwrap());
	});
}

/// Compute smod(a, b) for random 256-bit a and b. Iterate 500 times.
fn smod500(b: &mut Criterion) {
    b.bench_function("smod randomly generated ints, 500 times", |b| {
		run_code(b, "6101f45b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca075080600357".from_hex().unwrap());
	});
}

/// Compute smod(a, b) for random 256-bit a and b. Iterate 1000 times.
fn smod1000(b: &mut Criterion) {
    b.bench_function("smod randomly generated ints, 1000 times", |b| {
		run_code(b, "6103e85b600190037fb8e0a2b6b1587398c28bf9e9d34ea24ba34df308eec2acedca363b2fce2c25db7fcc2de1f8ec6cc9a24ed2c48b856637f9e45f0a5feee21a196aa42a290ef454ca075080600357".from_hex().unwrap());
	});
}