2017-05-26 11:06:48 +02:00
|
|
|
// Copyright 2015-2017 Parity Technologies (UK) Ltd.
|
|
|
|
// This file is part of Parity.
|
|
|
|
|
|
|
|
// Parity 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.
|
|
|
|
|
|
|
|
// Parity 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 Parity. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
//! VM runner.
|
|
|
|
|
|
|
|
use std::time::{Instant, Duration};
|
2018-01-10 13:35:18 +01:00
|
|
|
use ethereum_types::{H256, U256};
|
2017-08-28 14:25:16 +02:00
|
|
|
use ethcore::client::{self, EvmTestClient, EvmTestError, TransactResult};
|
2018-01-11 17:49:10 +01:00
|
|
|
use ethcore::{trace, spec, pod_state};
|
2017-08-28 14:25:16 +02:00
|
|
|
use ethjson;
|
2018-01-11 17:49:10 +01:00
|
|
|
use transaction;
|
2017-10-20 15:40:25 +02:00
|
|
|
use vm::ActionParams;
|
2017-05-26 11:06:48 +02:00
|
|
|
|
|
|
|
/// VM execution informant
|
|
|
|
pub trait Informant: trace::VMTracer {
|
2017-08-28 14:25:16 +02:00
|
|
|
/// Display a single run init message
|
2018-01-18 10:32:22 +01:00
|
|
|
fn before_test(&mut self, test: &str, action: &str);
|
2017-06-09 12:31:03 +02:00
|
|
|
/// Set initial gas.
|
|
|
|
fn set_gas(&mut self, _gas: U256) {}
|
2017-05-26 11:06:48 +02:00
|
|
|
/// Display final result.
|
2017-10-20 15:40:25 +02:00
|
|
|
fn finish(result: RunResult<Self::Output>);
|
2017-05-26 11:06:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Execution finished correctly
|
2017-10-20 15:40:25 +02:00
|
|
|
#[derive(Debug)]
|
|
|
|
pub struct Success<T> {
|
2018-01-18 10:32:22 +01:00
|
|
|
/// State root
|
|
|
|
pub state_root: H256,
|
2017-05-26 11:06:48 +02:00
|
|
|
/// Used gas
|
|
|
|
pub gas_used: U256,
|
|
|
|
/// Output as bytes
|
|
|
|
pub output: Vec<u8>,
|
|
|
|
/// Time Taken
|
|
|
|
pub time: Duration,
|
2017-10-20 15:40:25 +02:00
|
|
|
/// Traces
|
|
|
|
pub traces: Option<T>,
|
2017-05-26 11:06:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Execution failed
|
2017-10-20 15:40:25 +02:00
|
|
|
#[derive(Debug)]
|
|
|
|
pub struct Failure<T> {
|
2017-06-09 12:31:03 +02:00
|
|
|
/// Used gas
|
|
|
|
pub gas_used: U256,
|
2017-05-26 11:06:48 +02:00
|
|
|
/// Internal error
|
|
|
|
pub error: EvmTestError,
|
|
|
|
/// Duration
|
|
|
|
pub time: Duration,
|
2017-10-20 15:40:25 +02:00
|
|
|
/// Traces
|
|
|
|
pub traces: Option<T>,
|
|
|
|
}
|
|
|
|
|
|
|
|
/// EVM Execution result
|
|
|
|
pub type RunResult<T> = Result<Success<T>, Failure<T>>;
|
|
|
|
|
|
|
|
/// Execute given `ActionParams` and return the result.
|
|
|
|
pub fn run_action<T: Informant>(
|
|
|
|
spec: &spec::Spec,
|
|
|
|
params: ActionParams,
|
|
|
|
mut informant: T,
|
|
|
|
) -> RunResult<T::Output> {
|
|
|
|
informant.set_gas(params.gas);
|
|
|
|
run(spec, params.gas, None, |mut client| {
|
|
|
|
let result = client
|
|
|
|
.call(params, &mut informant)
|
2018-01-18 10:32:22 +01:00
|
|
|
.map(|r| (0.into(), r.gas_left, r.return_data.to_vec()));
|
2017-10-20 15:40:25 +02:00
|
|
|
(result, informant.drain())
|
|
|
|
})
|
2017-05-26 11:06:48 +02:00
|
|
|
}
|
|
|
|
|
2017-08-28 14:25:16 +02:00
|
|
|
/// Execute given Transaction and verify resulting state root.
|
|
|
|
pub fn run_transaction<T: Informant>(
|
|
|
|
name: &str,
|
|
|
|
idx: usize,
|
|
|
|
spec: ðjson::state::test::ForkSpec,
|
|
|
|
pre_state: &pod_state::PodState,
|
|
|
|
post_root: H256,
|
|
|
|
env_info: &client::EnvInfo,
|
|
|
|
transaction: transaction::SignedTransaction,
|
|
|
|
mut informant: T,
|
|
|
|
) {
|
|
|
|
let spec_name = format!("{:?}", spec).to_lowercase();
|
|
|
|
let spec = match EvmTestClient::spec_from_json(spec) {
|
|
|
|
Some(spec) => {
|
|
|
|
informant.before_test(&format!("{}:{}:{}", name, spec_name, idx), "starting");
|
|
|
|
spec
|
|
|
|
},
|
|
|
|
None => {
|
|
|
|
informant.before_test(&format!("{}:{}:{}", name, spec_name, idx), "skipping because of missing spec");
|
|
|
|
return;
|
|
|
|
},
|
|
|
|
};
|
|
|
|
|
|
|
|
informant.set_gas(env_info.gas_limit);
|
|
|
|
|
|
|
|
let result = run(spec, env_info.gas_limit, pre_state, |mut client| {
|
|
|
|
let result = client.transact(env_info, transaction, informant);
|
|
|
|
match result {
|
|
|
|
TransactResult::Ok { state_root, .. } if state_root != post_root => {
|
2017-10-20 15:40:25 +02:00
|
|
|
(Err(EvmTestError::PostCondition(format!(
|
2017-08-28 14:25:16 +02:00
|
|
|
"State root mismatch (got: {}, expected: {})",
|
|
|
|
state_root,
|
|
|
|
post_root,
|
2017-10-20 15:40:25 +02:00
|
|
|
))), None)
|
2017-08-28 14:25:16 +02:00
|
|
|
},
|
2018-01-18 10:32:22 +01:00
|
|
|
TransactResult::Ok { state_root, gas_left, output, vm_trace, .. } => {
|
|
|
|
(Ok((state_root, gas_left, output)), vm_trace)
|
2017-08-28 14:25:16 +02:00
|
|
|
},
|
|
|
|
TransactResult::Err { error, .. } => {
|
2017-10-20 15:40:25 +02:00
|
|
|
(Err(EvmTestError::PostCondition(format!(
|
2017-08-28 14:25:16 +02:00
|
|
|
"Unexpected execution error: {:?}", error
|
2017-10-20 15:40:25 +02:00
|
|
|
))), None)
|
2017-08-28 14:25:16 +02:00
|
|
|
},
|
|
|
|
}
|
|
|
|
});
|
|
|
|
|
|
|
|
T::finish(result)
|
|
|
|
}
|
|
|
|
|
2017-05-26 11:06:48 +02:00
|
|
|
/// Execute VM with given `ActionParams`
|
2017-10-20 15:40:25 +02:00
|
|
|
pub fn run<'a, F, T, X>(
|
|
|
|
spec: &'a spec::Spec,
|
|
|
|
initial_gas: U256,
|
|
|
|
pre_state: T,
|
|
|
|
run: F,
|
|
|
|
) -> RunResult<X> where
|
2018-01-18 10:32:22 +01:00
|
|
|
F: FnOnce(EvmTestClient) -> (Result<(H256, U256, Vec<u8>), EvmTestError>, Option<X>),
|
2017-08-28 14:25:16 +02:00
|
|
|
T: Into<Option<&'a pod_state::PodState>>,
|
|
|
|
{
|
|
|
|
let test_client = match pre_state.into() {
|
|
|
|
Some(pre_state) => EvmTestClient::from_pod_state(spec, pre_state.clone()),
|
|
|
|
None => EvmTestClient::new(spec),
|
|
|
|
}.map_err(|error| Failure {
|
2017-06-09 12:31:03 +02:00
|
|
|
gas_used: 0.into(),
|
2017-05-26 11:06:48 +02:00
|
|
|
error,
|
2017-10-20 15:40:25 +02:00
|
|
|
time: Duration::from_secs(0),
|
|
|
|
traces: None,
|
2017-05-26 11:06:48 +02:00
|
|
|
})?;
|
|
|
|
|
|
|
|
let start = Instant::now();
|
2017-08-28 14:25:16 +02:00
|
|
|
let result = run(test_client);
|
2017-10-20 15:40:25 +02:00
|
|
|
let time = start.elapsed();
|
2017-05-26 11:06:48 +02:00
|
|
|
|
|
|
|
match result {
|
2018-01-18 10:32:22 +01:00
|
|
|
(Ok((state_root, gas_left, output)), traces) => Ok(Success {
|
|
|
|
state_root,
|
2017-05-26 11:06:48 +02:00
|
|
|
gas_used: initial_gas - gas_left,
|
2017-10-20 15:40:25 +02:00
|
|
|
output,
|
|
|
|
time,
|
|
|
|
traces,
|
2017-05-26 11:06:48 +02:00
|
|
|
}),
|
2017-10-20 15:40:25 +02:00
|
|
|
(Err(error), traces) => Err(Failure {
|
2017-06-09 12:31:03 +02:00
|
|
|
gas_used: initial_gas,
|
2017-10-20 15:40:25 +02:00
|
|
|
error,
|
|
|
|
time,
|
|
|
|
traces,
|
2017-05-26 11:06:48 +02:00
|
|
|
}),
|
|
|
|
}
|
|
|
|
}
|
2017-10-20 15:40:25 +02:00
|
|
|
|
|
|
|
#[cfg(test)]
|
2018-01-18 10:32:22 +01:00
|
|
|
pub mod tests {
|
2017-10-20 15:40:25 +02:00
|
|
|
use std::sync::Arc;
|
|
|
|
use rustc_hex::FromHex;
|
|
|
|
use super::*;
|
|
|
|
|
2018-01-18 10:32:22 +01:00
|
|
|
pub fn run_test<T, I, F>(
|
|
|
|
informant: I,
|
|
|
|
compare: F,
|
2017-10-20 15:40:25 +02:00
|
|
|
code: &str,
|
|
|
|
gas: T,
|
|
|
|
expected: &str,
|
2018-01-18 10:32:22 +01:00
|
|
|
) where
|
|
|
|
T: Into<U256>,
|
|
|
|
I: Informant,
|
|
|
|
F: FnOnce(Option<I::Output>, &str),
|
|
|
|
{
|
2017-10-20 15:40:25 +02:00
|
|
|
let mut params = ActionParams::default();
|
|
|
|
params.code = Some(Arc::new(code.from_hex().unwrap()));
|
|
|
|
params.gas = gas.into();
|
|
|
|
|
|
|
|
let spec = ::ethcore::ethereum::new_foundation(&::std::env::temp_dir());
|
|
|
|
let result = run_action(&spec, params, informant);
|
|
|
|
match result {
|
|
|
|
Ok(Success { traces, .. }) => {
|
2018-01-18 10:32:22 +01:00
|
|
|
compare(traces, expected)
|
2017-10-20 15:40:25 +02:00
|
|
|
},
|
|
|
|
Err(Failure { traces, .. }) => {
|
2018-01-18 10:32:22 +01:00
|
|
|
compare(traces, expected)
|
2017-10-20 15:40:25 +02:00
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|