openethereum/ethcore/src/externalities.rs

471 lines
14 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +01:00
// Copyright 2015, 2016 Ethcore (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/>.
2016-01-15 14:22:46 +01:00
//! Transaction Execution environment.
use common::*;
use state::*;
use engine::*;
use executive::*;
use evm::{self, Schedule, Ext, ContractCreateResult, MessageCallResult, Factory};
2016-01-15 14:22:46 +01:00
use substate::*;
use types::executed::CallType;
use trace::{Tracer, VMTracer};
2016-01-15 14:22:46 +01:00
/// Policy for handling output data on `RETURN` opcode.
2016-03-19 18:37:55 +01:00
pub enum OutputPolicy<'a, 'b> {
2016-01-15 14:22:46 +01:00
/// Return reference to fixed sized output.
/// Used for message calls.
2016-03-19 18:37:55 +01:00
Return(BytesRef<'a>, Option<&'b mut Bytes>),
2016-01-15 14:22:46 +01:00
/// Init new contract as soon as `RETURN` is called.
2016-03-19 18:46:41 +01:00
InitContract(Option<&'b mut Bytes>),
2016-01-15 14:22:46 +01:00
}
2016-01-16 20:11:12 +01:00
/// Transaction properties that externalities need to know about.
pub struct OriginInfo {
address: Address,
origin: Address,
2016-01-23 10:41:13 +01:00
gas_price: U256,
value: U256
2016-01-16 20:11:12 +01:00
}
impl OriginInfo {
/// Populates origin info from action params.
pub fn from(params: &ActionParams) -> Self {
OriginInfo {
address: params.address.clone(),
origin: params.origin.clone(),
2016-02-14 12:54:27 +01:00
gas_price: params.gas_price,
2016-01-20 17:27:33 +01:00
value: match params.value {
2016-02-14 12:54:27 +01:00
ActionValue::Transfer(val) | ActionValue::Apparent(val) => val
2016-01-20 17:27:33 +01:00
}
2016-01-16 20:11:12 +01:00
}
}
}
2016-01-15 14:22:46 +01:00
/// Implementation of evm Externalities.
pub struct Externalities<'a, T, V> where T: 'a + Tracer, V: 'a + VMTracer {
2016-01-15 14:22:46 +01:00
state: &'a mut State,
2016-01-16 20:11:12 +01:00
env_info: &'a EnvInfo,
2016-01-15 14:22:46 +01:00
engine: &'a Engine,
vm_factory: &'a Factory,
2016-01-15 14:22:46 +01:00
depth: usize,
2016-01-16 20:11:12 +01:00
origin_info: OriginInfo,
2016-01-15 14:22:46 +01:00
substate: &'a mut Substate,
schedule: Schedule,
output: OutputPolicy<'a, 'a>,
tracer: &'a mut T,
vm_tracer: &'a mut V,
2016-01-15 14:22:46 +01:00
}
impl<'a, T, V> Externalities<'a, T, V> where T: 'a + Tracer, V: 'a + VMTracer {
2016-04-12 13:54:34 +02:00
#[cfg_attr(feature="dev", allow(too_many_arguments))]
2016-01-15 14:22:46 +01:00
/// Basic `Externalities` constructor.
2016-02-09 15:28:27 +01:00
pub fn new(state: &'a mut State,
2016-03-19 18:37:55 +01:00
env_info: &'a EnvInfo,
engine: &'a Engine,
vm_factory: &'a Factory,
2016-03-19 18:37:55 +01:00
depth: usize,
origin_info: OriginInfo,
substate: &'a mut Substate,
output: OutputPolicy<'a, 'a>,
tracer: &'a mut T,
vm_tracer: &'a mut V,
2016-03-19 18:37:55 +01:00
) -> Self {
2016-01-15 14:22:46 +01:00
Externalities {
state: state,
2016-01-16 20:11:12 +01:00
env_info: env_info,
2016-01-15 14:22:46 +01:00
engine: engine,
vm_factory: vm_factory,
2016-01-15 14:22:46 +01:00
depth: depth,
2016-01-16 20:11:12 +01:00
origin_info: origin_info,
2016-01-15 14:22:46 +01:00
substate: substate,
2016-01-16 20:11:12 +01:00
schedule: engine.schedule(env_info),
output: output,
tracer: tracer,
vm_tracer: vm_tracer,
2016-01-15 14:22:46 +01:00
}
}
}
impl<'a, T, V> Ext for Externalities<'a, T, V> where T: 'a + Tracer, V: 'a + VMTracer {
2016-01-15 18:56:28 +01:00
fn storage_at(&self, key: &H256) -> H256 {
2016-01-16 20:11:12 +01:00
self.state.storage_at(&self.origin_info.address, key)
2016-01-15 14:22:46 +01:00
}
2016-01-16 20:11:12 +01:00
fn set_storage(&mut self, key: H256, value: H256) {
self.state.set_storage(&self.origin_info.address, key, value)
}
fn exists(&self, address: &Address) -> bool {
self.state.exists(address)
2016-01-15 14:22:46 +01:00
}
fn balance(&self, address: &Address) -> U256 {
self.state.balance(address)
}
fn blockhash(&self, number: &U256) -> H256 {
2016-02-09 16:54:58 +01:00
// TODO: comment out what this function expects from env_info, since it will produce panics if the latter is inconsistent
2016-01-16 20:11:12 +01:00
match *number < U256::from(self.env_info.number) && number.low_u64() >= cmp::max(256, self.env_info.number) - 256 {
2016-01-15 14:22:46 +01:00
true => {
2016-01-16 20:11:12 +01:00
let index = self.env_info.number - number.low_u64() - 1;
2016-02-09 16:54:58 +01:00
assert!(index < self.env_info.last_hashes.len() as u64, format!("Inconsistent env_info, should contain at least {:?} last hashes", index+1));
2016-01-16 20:11:12 +01:00
let r = self.env_info.last_hashes[index as usize].clone();
trace!("ext: blockhash({}) -> {} self.env_info.number={}\n", number, r, self.env_info.number);
2016-01-15 22:55:04 +01:00
r
},
false => {
2016-01-16 20:11:12 +01:00
trace!("ext: blockhash({}) -> null self.env_info.number={}\n", number, self.env_info.number);
2016-02-09 16:54:58 +01:00
H256::zero()
2016-01-15 14:22:46 +01:00
},
}
}
2016-01-16 20:11:12 +01:00
fn create(&mut self, gas: &U256, value: &U256, code: &[u8]) -> ContractCreateResult {
2016-01-15 14:22:46 +01:00
// create new contract address
2016-01-16 20:11:12 +01:00
let address = contract_address(&self.origin_info.address, &self.state.nonce(&self.origin_info.address));
2016-01-15 14:22:46 +01:00
// prepare the params
let params = ActionParams {
code_address: address.clone(),
2016-01-15 14:22:46 +01:00
address: address.clone(),
2016-01-16 20:11:12 +01:00
sender: self.origin_info.address.clone(),
origin: self.origin_info.origin.clone(),
2016-01-15 14:22:46 +01:00
gas: *gas,
2016-02-14 12:54:27 +01:00
gas_price: self.origin_info.gas_price,
value: ActionValue::Transfer(*value),
code: Some(code.to_vec()),
data: None,
call_type: CallType::None,
2016-01-15 14:22:46 +01:00
};
2016-01-16 20:11:12 +01:00
self.state.inc_nonce(&self.origin_info.address);
let mut ex = Executive::from_parent(self.state, self.env_info, self.engine, self.vm_factory, self.depth);
2016-02-09 15:28:27 +01:00
2016-01-16 20:11:12 +01:00
// TODO: handle internal error separately
match ex.create(params, self.substate, self.tracer, self.vm_tracer) {
2016-01-16 20:11:12 +01:00
Ok(gas_left) => {
self.substate.contracts_created.push(address.clone());
ContractCreateResult::Created(address, gas_left)
},
_ => ContractCreateResult::Failed
2016-01-15 14:22:46 +01:00
}
}
2016-02-09 15:28:27 +01:00
fn call(&mut self,
2016-03-20 16:24:19 +01:00
gas: &U256,
sender_address: &Address,
receive_address: &Address,
value: Option<U256>,
data: &[u8],
code_address: &Address,
output: &mut [u8],
call_type: CallType
2016-03-20 16:24:19 +01:00
) -> MessageCallResult {
trace!(target: "externalities", "call");
2016-01-20 16:52:22 +01:00
2016-01-23 10:41:13 +01:00
let mut params = ActionParams {
sender: sender_address.clone(),
2016-02-09 15:28:27 +01:00
address: receive_address.clone(),
2016-02-14 12:54:27 +01:00
value: ActionValue::Apparent(self.origin_info.value),
2016-01-20 16:52:22 +01:00
code_address: code_address.clone(),
origin: self.origin_info.origin.clone(),
gas: *gas,
2016-02-14 12:54:27 +01:00
gas_price: self.origin_info.gas_price,
2016-01-20 16:52:22 +01:00
code: self.state.code(code_address),
data: Some(data.to_vec()),
call_type: call_type,
2016-01-20 16:52:22 +01:00
};
2016-01-23 10:41:13 +01:00
if let Some(value) = value {
2016-01-25 23:59:50 +01:00
params.value = ActionValue::Transfer(value);
2016-01-20 16:52:22 +01:00
}
2016-01-15 14:22:46 +01:00
let mut ex = Executive::from_parent(self.state, self.env_info, self.engine, self.vm_factory, self.depth);
2016-01-15 22:55:04 +01:00
match ex.call(params, self.substate, BytesRef::Fixed(output), self.tracer, self.vm_tracer) {
2016-01-16 20:11:12 +01:00
Ok(gas_left) => MessageCallResult::Success(gas_left),
_ => MessageCallResult::Failed
2016-01-15 14:22:46 +01:00
}
}
2016-01-16 17:17:43 +01:00
fn extcode(&self, address: &Address) -> Bytes {
2016-01-19 13:47:30 +01:00
self.state.code(address).unwrap_or_else(|| vec![])
2016-01-15 14:22:46 +01:00
}
2016-03-11 11:16:49 +01:00
#[cfg_attr(feature="dev", allow(match_ref_pats))]
fn ret(mut self, gas: &U256, data: &[u8]) -> evm::Result<U256>
where Self: Sized {
2016-03-19 18:37:55 +01:00
let handle_copy = |to: &mut Option<&mut Bytes>| {
to.as_mut().map(|b| **b = data.to_owned());
};
match self.output {
OutputPolicy::Return(BytesRef::Fixed(ref mut slice), ref mut copy) => {
handle_copy(copy);
2016-03-19 21:02:44 +01:00
2016-01-15 14:22:46 +01:00
let len = cmp::min(slice.len(), data.len());
(&mut slice[..len]).copy_from_slice(&data[..len]);
2016-01-15 14:22:46 +01:00
Ok(*gas)
},
2016-03-19 18:37:55 +01:00
OutputPolicy::Return(BytesRef::Flexible(ref mut vec), ref mut copy) => {
handle_copy(copy);
2016-01-15 14:22:46 +01:00
vec.clear();
vec.extend_from_slice(data);
2016-01-15 14:22:46 +01:00
Ok(*gas)
},
2016-03-19 18:46:41 +01:00
OutputPolicy::InitContract(ref mut copy) => {
2016-01-15 14:22:46 +01:00
let return_cost = U256::from(data.len()) * U256::from(self.schedule.create_data_gas);
if return_cost > *gas {
return match self.schedule.exceptional_failed_code_deposit {
true => Err(evm::Error::OutOfGas),
false => Ok(*gas)
}
}
2016-03-19 18:46:41 +01:00
handle_copy(copy);
2016-01-15 14:22:46 +01:00
let mut code = vec![];
code.extend_from_slice(data);
2016-03-19 21:02:44 +01:00
self.state.init_code(&self.origin_info.address, code);
2016-01-15 14:22:46 +01:00
Ok(*gas - return_cost)
}
}
}
2016-01-16 17:17:43 +01:00
fn log(&mut self, topics: Vec<H256>, data: &[u8]) {
2016-01-16 20:11:12 +01:00
let address = self.origin_info.address.clone();
self.substate.logs.push(LogEntry {
address: address,
topics: topics,
data: data.to_vec()
});
2016-01-15 14:22:46 +01:00
}
fn suicide(&mut self, refund_address: &Address) {
2016-01-16 20:11:12 +01:00
let address = self.origin_info.address.clone();
2016-01-15 14:22:46 +01:00
let balance = self.balance(&address);
if &address == refund_address {
// TODO [todr] To be consisted with CPP client we set balance to 0 in that case.
self.state.sub_balance(&address, &balance);
} else {
trace!("Suiciding {} -> {} (xfer: {})", address, refund_address, balance);
self.state.transfer_balance(&address, refund_address, &balance);
}
2016-07-21 16:26:49 +02:00
self.tracer.trace_suicide(address, balance, refund_address.clone());
2016-07-21 16:50:24 +02:00
self.substate.suicides.insert(address);
2016-01-15 14:22:46 +01:00
}
fn schedule(&self) -> &Schedule {
&self.schedule
}
fn env_info(&self) -> &EnvInfo {
self.env_info
2016-01-16 20:11:12 +01:00
}
fn depth(&self) -> usize {
self.depth
}
fn inc_sstore_clears(&mut self) {
self.substate.sstore_clears_count = self.substate.sstore_clears_count + U256::one();
2016-01-15 14:22:46 +01:00
}
fn trace_prepare_execute(&mut self, pc: usize, instruction: u8, gas_cost: &U256) -> bool {
self.vm_tracer.trace_prepare_execute(pc, instruction, gas_cost)
}
fn trace_executed(&mut self, gas_used: U256, stack_push: &[U256], mem_diff: Option<(usize, &[u8])>, store_diff: Option<(U256, U256)>) {
self.vm_tracer.trace_executed(gas_used, stack_push, mem_diff, store_diff)
}
2016-01-15 14:22:46 +01:00
}
2016-02-09 15:28:27 +01:00
#[cfg(test)]
mod tests {
use common::*;
use state::*;
use engine::*;
2016-02-09 23:11:22 +01:00
use evm::{Ext};
2016-02-09 15:28:27 +01:00
use substate::*;
use tests::helpers::*;
use devtools::GuardedTempResult;
2016-02-09 15:28:27 +01:00
use super::*;
use trace::{NoopTracer, NoopVMTracer};
use types::executed::CallType;
2016-02-09 15:28:27 +01:00
fn get_test_origin() -> OriginInfo {
OriginInfo {
address: Address::zero(),
origin: Address::zero(),
gas_price: U256::zero(),
value: U256::zero()
}
}
fn get_test_env_info() -> EnvInfo {
EnvInfo {
number: 100,
2016-05-31 16:59:01 +02:00
author: 0.into(),
2016-02-09 15:28:27 +01:00
timestamp: 0,
2016-05-31 16:59:01 +02:00
difficulty: 0.into(),
2016-02-09 15:28:27 +01:00
last_hashes: vec![],
2016-05-31 16:59:01 +02:00
gas_used: 0.into(),
gas_limit: 0.into(),
2016-02-09 15:28:27 +01:00
}
}
2016-02-09 17:29:52 +01:00
struct TestSetup {
state: GuardedTempResult<State>,
engine: Box<Engine>,
sub_state: Substate,
env_info: EnvInfo
}
2016-03-12 10:07:55 +01:00
impl Default for TestSetup {
fn default() -> Self {
TestSetup::new()
}
}
2016-02-09 17:29:52 +01:00
impl TestSetup {
2016-03-12 10:07:55 +01:00
fn new() -> Self {
2016-02-09 17:29:52 +01:00
TestSetup {
state: get_temp_state(),
engine: get_test_spec().engine,
sub_state: Substate::new(),
2016-02-09 17:29:52 +01:00
env_info: get_test_env_info()
}
}
}
2016-02-09 15:28:27 +01:00
#[test]
fn can_be_created() {
2016-02-09 17:29:52 +01:00
let mut setup = TestSetup::new();
let state = setup.state.reference_mut();
let mut tracer = NoopTracer;
let mut vm_tracer = NoopVMTracer;
2016-02-09 15:28:27 +01:00
let vm_factory = Default::default();
let ext = Externalities::new(state, &setup.env_info, &*setup.engine, &vm_factory, 0, get_test_origin(), &mut setup.sub_state, OutputPolicy::InitContract(None), &mut tracer, &mut vm_tracer);
2016-02-09 16:31:57 +01:00
assert_eq!(ext.env_info().number, 100);
}
#[test]
2016-02-09 16:54:58 +01:00
fn can_return_block_hash_no_env() {
2016-02-09 17:29:52 +01:00
let mut setup = TestSetup::new();
let state = setup.state.reference_mut();
let mut tracer = NoopTracer;
let mut vm_tracer = NoopVMTracer;
let vm_factory = Default::default();
let ext = Externalities::new(state, &setup.env_info, &*setup.engine, &vm_factory, 0, get_test_origin(), &mut setup.sub_state, OutputPolicy::InitContract(None), &mut tracer, &mut vm_tracer);
2016-02-09 16:31:57 +01:00
let hash = ext.blockhash(&U256::from_str("0000000000000000000000000000000000000000000000000000000000120000").unwrap());
2016-02-09 17:29:52 +01:00
2016-02-09 16:31:57 +01:00
assert_eq!(hash, H256::zero());
2016-02-09 15:28:27 +01:00
}
2016-02-09 16:54:58 +01:00
#[test]
fn can_return_block_hash() {
let test_hash = H256::from("afafafafafafafafafafafbcbcbcbcbcbcbcbcbcbeeeeeeeeeeeeedddddddddd");
2016-02-09 17:29:52 +01:00
let test_env_number = 0x120001;
2016-02-09 16:54:58 +01:00
2016-02-09 17:29:52 +01:00
let mut setup = TestSetup::new();
{
let env_info = &mut setup.env_info;
env_info.number = test_env_number;
env_info.last_hashes.push(test_hash.clone());
}
let state = setup.state.reference_mut();
let mut tracer = NoopTracer;
let mut vm_tracer = NoopVMTracer;
let vm_factory = Default::default();
let ext = Externalities::new(state, &setup.env_info, &*setup.engine, &vm_factory, 0, get_test_origin(), &mut setup.sub_state, OutputPolicy::InitContract(None), &mut tracer, &mut vm_tracer);
2016-02-09 16:54:58 +01:00
let hash = ext.blockhash(&U256::from_str("0000000000000000000000000000000000000000000000000000000000120000").unwrap());
2016-02-09 17:29:52 +01:00
2016-02-09 16:54:58 +01:00
assert_eq!(test_hash, hash);
}
2016-02-09 17:29:52 +01:00
#[test]
2016-02-09 22:32:47 +01:00
#[should_panic]
2016-02-09 20:30:35 +01:00
fn can_call_fail_empty() {
let mut setup = TestSetup::new();
2016-02-09 17:47:14 +01:00
let state = setup.state.reference_mut();
let mut tracer = NoopTracer;
let mut vm_tracer = NoopVMTracer;
let vm_factory = Default::default();
let mut ext = Externalities::new(state, &setup.env_info, &*setup.engine, &vm_factory, 0, get_test_origin(), &mut setup.sub_state, OutputPolicy::InitContract(None), &mut tracer, &mut vm_tracer);
2016-02-09 20:30:35 +01:00
let mut output = vec![];
2016-02-09 17:29:52 +01:00
2016-02-09 23:02:31 +01:00
// this should panic because we have no balance on any account
ext.call(
2016-02-09 20:30:35 +01:00
&U256::from_str("0000000000000000000000000000000000000000000000000000000000120000").unwrap(),
&Address::new(),
&Address::new(),
2016-02-09 23:02:31 +01:00
Some(U256::from_str("0000000000000000000000000000000000000000000000000000000000150000").unwrap()),
2016-02-15 00:51:50 +01:00
&[],
2016-02-09 20:30:35 +01:00
&Address::new(),
&mut output,
CallType::Call
);
2016-02-09 20:30:35 +01:00
}
2016-02-09 22:41:45 +01:00
#[test]
fn can_log() {
let log_data = vec![120u8, 110u8];
2016-02-09 23:02:31 +01:00
let log_topics = vec![H256::from("af0fa234a6af46afa23faf23bcbc1c1cb4bcb7bcbe7e7e7ee3ee2edddddddddd")];
2016-02-09 22:41:45 +01:00
let mut setup = TestSetup::new();
let state = setup.state.reference_mut();
let mut tracer = NoopTracer;
let mut vm_tracer = NoopVMTracer;
2016-02-09 22:41:45 +01:00
{
let vm_factory = Default::default();
let mut ext = Externalities::new(state, &setup.env_info, &*setup.engine, &vm_factory, 0, get_test_origin(), &mut setup.sub_state, OutputPolicy::InitContract(None), &mut tracer, &mut vm_tracer);
2016-02-09 22:41:45 +01:00
ext.log(log_topics, &log_data);
}
assert_eq!(setup.sub_state.logs.len(), 1);
}
2016-02-09 23:02:31 +01:00
#[test]
fn can_suicide() {
let refund_account = &Address::new();
let mut setup = TestSetup::new();
let state = setup.state.reference_mut();
let mut tracer = NoopTracer;
let mut vm_tracer = NoopVMTracer;
2016-02-09 23:02:31 +01:00
{
let vm_factory = Default::default();
let mut ext = Externalities::new(state, &setup.env_info, &*setup.engine, &vm_factory, 0, get_test_origin(), &mut setup.sub_state, OutputPolicy::InitContract(None), &mut tracer, &mut vm_tracer);
ext.suicide(refund_account);
2016-02-09 23:02:31 +01:00
}
assert_eq!(setup.sub_state.suicides.len(), 1);
}
2016-02-09 15:28:27 +01:00
}