openethereum/src/evm/executive.rs

421 lines
13 KiB
Rust
Raw Normal View History

2016-01-09 21:39:38 +01:00
use std::collections::HashSet;
2016-01-09 22:54:16 +01:00
use std::cmp;
2016-01-07 21:29:36 +01:00
use util::hash::*;
use util::uint::*;
2016-01-07 23:33:54 +01:00
use util::rlp::*;
use util::sha3::*;
2016-01-09 00:51:09 +01:00
use util::bytes::*;
2016-01-07 19:05:44 +01:00
use state::*;
use env_info::*;
use engine::*;
use transaction::*;
2016-01-09 18:25:18 +01:00
use evm::{VmFactory, Ext, LogEntry, EvmParams, EvmResult};
2016-01-07 23:33:54 +01:00
2016-01-09 00:51:09 +01:00
/// Returns new address created from address and given nonce.
2016-01-08 00:16:15 +01:00
pub fn contract_address(address: &Address, nonce: &U256) -> Address {
2016-01-07 23:33:54 +01:00
let mut stream = RlpStream::new_list(2);
stream.append(address);
stream.append(nonce);
From::from(stream.out().sha3())
}
2016-01-07 19:05:44 +01:00
2016-01-09 21:39:38 +01:00
/// State changes which should be applied in finalize,
/// after transaction is fully executed.
pub struct Substate {
/// Any accounts that have suicided.
suicides: HashSet<Address>,
/// Any logs.
logs: Vec<LogEntry>,
/// Refund counter of SSTORE nonzero->zero.
2016-01-09 22:54:16 +01:00
refunds_count: U256,
2016-01-09 21:39:38 +01:00
}
impl Substate {
/// Creates new substate.
pub fn new() -> Self {
Substate {
suicides: HashSet::new(),
logs: vec![],
2016-01-09 22:54:16 +01:00
refunds_count: U256::zero(),
2016-01-09 21:39:38 +01:00
}
}
/// Appends another substate to this substate.
fn accrue(&mut self, s: Substate) {
self.suicides.extend(s.suicides.into_iter());
self.logs.extend(s.logs.into_iter());
2016-01-09 22:54:16 +01:00
self.refunds_count = self.refunds_count + s.refunds_count;
2016-01-09 21:39:38 +01:00
}
}
2016-01-09 13:51:59 +01:00
#[derive(PartialEq, Debug)]
2016-01-07 19:05:44 +01:00
pub enum ExecutiveResult {
2016-01-09 13:51:59 +01:00
Ok,
OutOfGas,
InternalError
2016-01-07 19:05:44 +01:00
}
2016-01-09 22:54:16 +01:00
/// Message-call/contract-creation executor; useful for executing transactions.
2016-01-07 19:05:44 +01:00
pub struct Executive<'a> {
state: &'a mut State,
info: &'a EnvInfo,
engine: &'a Engine,
2016-01-09 00:51:09 +01:00
depth: usize,
2016-01-07 19:05:44 +01:00
}
impl<'a> Executive<'a> {
2016-01-09 21:39:38 +01:00
/// Creates new executive with depth equal 0.
2016-01-09 17:55:47 +01:00
pub fn new(state: &'a mut State, info: &'a EnvInfo, engine: &'a Engine) -> Self {
Executive::new_with_depth(state, info, engine, 0)
}
2016-01-09 00:51:09 +01:00
2016-01-09 21:39:38 +01:00
/// Populates executive from parent externalities. Increments executive depth.
2016-01-09 17:55:47 +01:00
fn from_parent(e: &'a mut Externalities) -> Self {
Executive::new_with_depth(e.state, e.info, e.engine, e.depth + 1)
2016-01-09 00:51:09 +01:00
}
2016-01-09 21:39:38 +01:00
/// Helper constructor. Should be used to create `Executive` with desired depth.
/// Private.
2016-01-09 17:55:47 +01:00
fn new_with_depth(state: &'a mut State, info: &'a EnvInfo, engine: &'a Engine, depth: usize) -> Self {
2016-01-07 19:05:44 +01:00
Executive {
state: state,
info: info,
engine: engine,
2016-01-09 17:55:47 +01:00
depth: depth,
2016-01-07 19:05:44 +01:00
}
}
2016-01-09 21:39:38 +01:00
/// This funtion should be used to execute transaction.
2016-01-09 17:55:47 +01:00
pub fn transact(e: &mut Executive<'a>, t: &Transaction) -> ExecutiveResult {
2016-01-09 00:51:09 +01:00
// TODO: validate that we have enough funds
2016-01-09 17:55:47 +01:00
// TODO: validate nonce ?
let sender = t.sender();
2016-01-07 21:29:36 +01:00
2016-01-09 21:39:38 +01:00
let mut substate = Substate::new();
let res = match t.kind() {
2016-01-09 17:55:47 +01:00
TransactionKind::ContractCreation => {
let params = EvmParams {
address: contract_address(&sender, &t.nonce),
sender: sender.clone(),
origin: sender.clone(),
gas: t.gas,
gas_price: t.gas_price,
value: t.value,
code: t.data.clone(),
data: vec![],
};
e.state.inc_nonce(&params.address);
unimplemented!()
2016-01-09 21:39:38 +01:00
//Executive::call(e, &params, &substate)
2016-01-09 00:51:09 +01:00
},
2016-01-09 17:55:47 +01:00
TransactionKind::MessageCall => {
let params = EvmParams {
address: t.to.clone().unwrap(),
sender: sender.clone(),
origin: sender.clone(),
gas: t.gas,
gas_price: t.gas_price,
value: t.value,
code: e.state.code(&t.to.clone().unwrap()).unwrap_or(vec![]),
data: t.data.clone(),
};
e.state.inc_nonce(&params.address);
2016-01-09 21:39:38 +01:00
Executive::create(e, &params, &mut substate)
2016-01-09 17:55:47 +01:00
}
2016-01-09 21:39:38 +01:00
};
// finalize here!
2016-01-09 22:54:16 +01:00
e.finalize(substate, U256::zero(), U256::zero());
2016-01-09 21:39:38 +01:00
res
2016-01-07 19:05:44 +01:00
}
2016-01-09 21:39:38 +01:00
/// Calls contract function with given contract params.
2016-01-09 22:54:16 +01:00
/// *Note. It does not finalize the transaction (doesn't do refunds, nor suicides).
fn call(e: &mut Executive<'a>, params: &EvmParams, substate: &mut Substate) -> ExecutiveResult {
// at first, transfer value to destination
e.state.transfer_balance(&params.sender, &params.address, &params.value);
// if destination is builtin, try to execute it, or quickly return
if e.engine.is_builtin(&params.address) {
return match e.engine.cost_of_builtin(&params.address, &params.data) > params.gas {
true => ExecutiveResult::OutOfGas,
false => {
// TODO: substract gas for execution
let mut out = vec![];
e.engine.execute_builtin(&params.address, &params.data, &mut out);
ExecutiveResult::Ok
}
}
}
// otherwise do `normal` execution if destination is a contract
// TODO: is executing contract with no code different from not executing contract at all?
// if yes, there is a logic issue here. mk
if params.code.len() > 0 {
return match {
let mut ext = Externalities::new(e.state, e.info, e.engine, e.depth, params, substate);
let evm = VmFactory::create();
evm.exec(&params, &mut ext)
} {
EvmResult::Stop => ExecutiveResult::Ok,
EvmResult::Return(_) => ExecutiveResult::Ok,
EvmResult::Suicide => {
substate.suicides.insert(params.address.clone());
ExecutiveResult::Ok
},
EvmResult::OutOfGas => ExecutiveResult::OutOfGas,
_err => ExecutiveResult::InternalError
}
}
2016-01-07 19:05:44 +01:00
ExecutiveResult::Ok
}
2016-01-09 02:12:17 +01:00
2016-01-09 21:39:38 +01:00
/// Creates contract with given contract params.
2016-01-09 22:54:16 +01:00
/// *Note. It does not finalize the transaction (doesn't do refunds, nor suicides).
2016-01-09 21:39:38 +01:00
fn create(e: &mut Executive<'a>, params: &EvmParams, substate: &mut Substate) -> ExecutiveResult {
2016-01-09 22:54:16 +01:00
// at first create new contract
e.state.new_contract(&params.address);
2016-01-09 22:54:16 +01:00
// then transfer value to it
2016-01-09 17:55:47 +01:00
e.state.transfer_balance(&params.sender, &params.address, &params.value);
2016-01-09 21:39:38 +01:00
match {
let mut ext = Externalities::new(e.state, e.info, e.engine, e.depth, params, substate);
2016-01-08 12:50:06 +01:00
let evm = VmFactory::create();
2016-01-09 17:55:47 +01:00
evm.exec(&params, &mut ext)
2016-01-09 21:39:38 +01:00
} {
2016-01-09 18:25:18 +01:00
EvmResult::Stop => {
2016-01-09 13:51:59 +01:00
ExecutiveResult::Ok
},
2016-01-09 18:25:18 +01:00
EvmResult::Return(output) => {
e.state.init_code(&params.address, output);
2016-01-09 13:51:59 +01:00
ExecutiveResult::Ok
},
2016-01-09 21:39:38 +01:00
EvmResult::Suicide => {
2016-01-09 22:54:16 +01:00
substate.suicides.insert(params.address.clone());
2016-01-09 21:39:38 +01:00
ExecutiveResult::Ok
2016-01-09 13:51:59 +01:00
},
2016-01-09 21:39:38 +01:00
EvmResult::OutOfGas => ExecutiveResult::OutOfGas,
_err => ExecutiveResult::InternalError
2016-01-09 13:51:59 +01:00
}
2016-01-07 19:05:44 +01:00
}
2016-01-09 21:39:38 +01:00
2016-01-09 22:54:16 +01:00
/// Finalizes the transaction (does refunds and suicides).
fn finalize(&self, substate: Substate, gas: U256, gas_used: U256) {
let schedule = self.engine.evm_schedule(self.info);
// refunds from SSTORE nonzero -> zero
let sstore_refunds = U256::from(schedule.sstore_refund_gas) * substate.refunds_count;
// refunds from contract suicides
let suicide_refunds = U256::from(schedule.suicide_refund_gas) * U256::from(substate.suicides.len());
// real ammount to refund
let refund = cmp::min(sstore_refunds + suicide_refunds, (gas - gas_used) / U256::from(2));
// perform suicides
//self.state.
2016-01-09 21:39:38 +01:00
}
2016-01-09 17:55:47 +01:00
}
2016-01-09 21:39:38 +01:00
/// Implementation of evm Externalities.
2016-01-09 17:55:47 +01:00
pub struct Externalities<'a> {
state: &'a mut State,
info: &'a EnvInfo,
engine: &'a Engine,
depth: usize,
params: &'a EvmParams,
2016-01-09 21:39:38 +01:00
substate: &'a mut Substate
2016-01-09 17:55:47 +01:00
}
impl<'a> Externalities<'a> {
2016-01-09 21:39:38 +01:00
/// Basic `Externalities` constructor.
pub fn new(state: &'a mut State, info: &'a EnvInfo, engine: &'a Engine, depth: usize, params: &'a EvmParams, substate: &'a mut Substate) -> Self {
2016-01-09 17:55:47 +01:00
Externalities {
state: state,
info: info,
engine: engine,
depth: depth,
params: params,
2016-01-09 21:39:38 +01:00
substate: substate
2016-01-09 17:55:47 +01:00
}
}
2016-01-09 00:51:09 +01:00
}
2016-01-09 17:55:47 +01:00
impl<'a> Ext for Externalities<'a> {
2016-01-09 00:51:09 +01:00
fn sload(&self, key: &H256) -> H256 {
self.state.storage_at(&self.params.address, key)
}
fn sstore(&mut self, key: H256, value: H256) {
if value == H256::new() && self.state.storage_at(&self.params.address, &key) != H256::new() {
2016-01-09 22:54:16 +01:00
//self.substate.refunds_count = self.substate.refunds_count + U256::from(self.engine.evm_schedule(self.info).sstore_refund_gas);
self.substate.refunds_count = self.substate.refunds_count + U256::one();
2016-01-09 00:51:09 +01:00
}
self.state.set_storage(&self.params.address, key, value)
}
fn balance(&self, address: &Address) -> U256 {
self.state.balance(address)
}
fn blockhash(&self, number: &U256) -> H256 {
match *number < self.info.number {
false => H256::from(&U256::zero()),
true => {
let index = self.info.number - *number - U256::one();
self.info.last_hashes[index.low_u32() as usize].clone()
}
}
}
fn create(&mut self, gas: u64, endowment: &U256, code: &[u8]) -> (Address, u64) {
2016-01-09 13:51:59 +01:00
match self.state.balance(&self.params.address) >= *endowment && self.depth < 1024 {
2016-01-09 00:51:09 +01:00
false => (Address::new(), gas),
true => {
2016-01-09 13:51:59 +01:00
let address = contract_address(&self.params.address, &self.state.nonce(&self.params.address));
2016-01-09 00:51:09 +01:00
let params = EvmParams {
2016-01-09 13:51:59 +01:00
address: address.clone(),
2016-01-09 00:51:09 +01:00
sender: self.params.address.clone(),
origin: self.params.origin.clone(),
gas: U256::from(gas),
gas_price: self.params.gas_price.clone(),
value: endowment.clone(),
code: code.to_vec(),
data: vec![],
};
2016-01-09 21:39:38 +01:00
let mut substate = Substate::new();
{
let mut ex = Executive::from_parent(self);
ex.state.inc_nonce(&address);
let res = Executive::create(&mut ex, &params, &mut substate);
println!("res: {:?}", res);
}
self.substate.accrue(substate);
2016-01-09 13:51:59 +01:00
(address, gas)
2016-01-09 00:51:09 +01:00
}
}
}
fn call(&mut self, gas: u64, call_gas: u64, receive_address: &Address, value: &U256, data: &[u8], code_address: &Address) -> Option<(Vec<u8>, u64)>{
// TODO: validation of the call
let params = EvmParams {
address: code_address.clone(),
sender: receive_address.clone(),
origin: self.params.origin.clone(),
gas: U256::from(call_gas), // TODO:
gas_price: self.params.gas_price.clone(),
value: value.clone(),
code: self.state.code(code_address).unwrap_or(vec![]),
data: data.to_vec(),
};
2016-01-09 21:39:38 +01:00
let mut substate = Substate::new();
2016-01-09 00:51:09 +01:00
{
2016-01-09 17:55:47 +01:00
let mut ex = Executive::from_parent(self);
2016-01-09 21:39:38 +01:00
Executive::call(&mut ex, &params, &mut substate);
2016-01-09 00:51:09 +01:00
unimplemented!();
}
}
fn extcode(&self, address: &Address) -> Vec<u8> {
self.state.code(address).unwrap_or(vec![])
}
fn log(&mut self, topics: Vec<H256>, data: Bytes) {
let address = self.params.address.clone();
2016-01-09 21:39:38 +01:00
self.substate.logs.push(LogEntry::new(address, topics, data));
2016-01-09 00:51:09 +01:00
}
2016-01-07 19:05:44 +01:00
}
2016-01-07 23:33:54 +01:00
#[cfg(test)]
mod tests {
2016-01-09 01:33:50 +01:00
use rustc_serialize::hex::FromHex;
2016-01-07 23:33:54 +01:00
use std::str::FromStr;
use util::hash::*;
use util::uint::*;
2016-01-09 01:33:50 +01:00
use evm::*;
use transaction::*;
use env_info::*;
use state::*;
use spec::*;
use engine::*;
use evm_schedule::*;
2016-01-09 02:12:17 +01:00
use super::contract_address;
2016-01-09 01:33:50 +01:00
struct TestEngine;
2016-01-09 01:33:50 +01:00
impl TestEngine {
fn new() -> Self {
TestEngine
2016-01-09 01:33:50 +01:00
}
}
impl Engine for TestEngine {
fn name(&self) -> &str { "TestEngine" }
fn spec(&self) -> &Spec { unimplemented!() }
2016-01-09 01:33:50 +01:00
fn evm_schedule(&self, _env_info: &EnvInfo) -> EvmSchedule { EvmSchedule::new_frontier() }
}
2016-01-07 23:33:54 +01:00
#[test]
fn test_contract_address() {
let address = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();
2016-01-09 02:12:17 +01:00
let expected_address = Address::from_str("3f09c73a5ed19289fb9bdc72f1742566df146f56").unwrap();
assert_eq!(expected_address, contract_address(&address, &U256::from(88)));
2016-01-07 23:33:54 +01:00
}
2016-01-09 01:33:50 +01:00
#[test]
2016-01-09 13:51:59 +01:00
// TODO: replace params with transactions!
2016-01-09 01:33:50 +01:00
fn test_executive() {
2016-01-09 02:12:17 +01:00
let sender = Address::from_str("0f572e5295c57f15886f9b263e2f6d2d6c7b5ec6").unwrap();
let address = contract_address(&sender, &U256::zero());
2016-01-09 17:55:47 +01:00
let mut params = EvmParams::new();
2016-01-09 02:12:17 +01:00
params.address = address.clone();
params.sender = sender.clone();
params.gas = U256::from(0x174876e800u64);
params.code = "3331600055".from_hex().unwrap();
params.value = U256::from(0x7);
let mut state = State::new_temp();
state.add_balance(&sender, &U256::from(0x100u64));
let info = EnvInfo::new();
let engine = TestEngine::new();
2016-01-09 21:39:38 +01:00
let mut substate = Substate::new();
2016-01-09 02:12:17 +01:00
{
2016-01-09 17:55:47 +01:00
let mut ex = Executive::new(&mut state, &info, &engine);
2016-01-09 21:39:38 +01:00
assert_eq!(Executive::create(&mut ex, &params, &mut substate), ExecutiveResult::Ok);
2016-01-09 02:12:17 +01:00
}
2016-01-09 13:51:59 +01:00
assert_eq!(state.storage_at(&address, &H256::new()), H256::from(&U256::from(0xf9u64)));
2016-01-09 02:12:17 +01:00
assert_eq!(state.balance(&sender), U256::from(0xf9));
assert_eq!(state.balance(&address), U256::from(0x7));
2016-01-09 01:33:50 +01:00
}
2016-01-09 13:51:59 +01:00
#[test]
fn test_create_contract() {
let sender = Address::from_str("cd1722f3947def4cf144679da39c4c32bdc35681").unwrap();
let address = contract_address(&sender, &U256::zero());
let next_address = contract_address(&address, &U256::zero());
2016-01-09 17:55:47 +01:00
let mut params = EvmParams::new();
2016-01-09 13:51:59 +01:00
params.address = address.clone();
params.sender = sender.clone();
params.origin = sender.clone();
params.gas = U256::from(0x174876e800u64);
params.code = "7c601080600c6000396000f3006000355415600957005b60203560003555600052601d60036000f0600055".from_hex().unwrap();
let mut state = State::new_temp();
state.add_balance(&sender, &U256::from(0x100u64));
let info = EnvInfo::new();
let engine = TestEngine::new();
2016-01-09 21:39:38 +01:00
let mut substate = Substate::new();
2016-01-09 13:51:59 +01:00
{
2016-01-09 17:55:47 +01:00
let mut ex = Executive::new(&mut state, &info, &engine);
2016-01-09 21:39:38 +01:00
assert_eq!(Executive::create(&mut ex, &params, &mut substate), ExecutiveResult::Ok);
2016-01-09 13:51:59 +01:00
}
assert_eq!(state.storage_at(&address, &H256::new()), H256::from(next_address.clone()));
assert_eq!(state.code(&next_address).unwrap(), "6000355415600957005b602035600035".from_hex().unwrap());
2016-01-09 13:51:59 +01:00
}
2016-01-07 23:33:54 +01:00
}