openethereum/ethcore/src/evm/factory.rs

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

//! Evm factory.
//!
//! TODO: consider spliting it into two separate files.
use std::fmt;
use evm::Evm;
use util::{U256, Uint};

#[derive(Debug, PartialEq, Clone)]
/// Type of EVM to use.
pub enum VMType {
	/// JIT EVM
	#[cfg(feature = "jit")]
	Jit,
	/// RUST EVM
	Interpreter
}

impl fmt::Display for VMType {
	#[cfg(feature="jit")]
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		write!(f, "{}", match *self {
			VMType::Jit => "JIT",
			VMType::Interpreter => "INT"
		})
	}
	#[cfg(not(feature="jit"))]
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		write!(f, "{}", match *self {
			VMType::Interpreter => "INT"
		})
	}
}

impl Default for VMType {
	fn default() -> Self {
		VMType::Interpreter
	}
}

impl VMType {
	/// Return all possible VMs (JIT, Interpreter)
	#[cfg(feature = "jit")]
	pub fn all() -> Vec<VMType> {
		vec![VMType::Jit, VMType::Interpreter]
	}

	/// Return all possible VMs (Interpreter)
	#[cfg(not(feature = "jit"))]
	pub fn all() -> Vec<VMType> {
		vec![VMType::Interpreter]
	}

	/// Return new jit if it's possible
	#[cfg(not(feature = "jit"))]
	pub fn jit() -> Option<Self> {
		None
	}

	/// Return new jit if it's possible
	#[cfg(feature = "jit")]
	pub fn jit() -> Option<Self> {
		Some(VMType::Jit)
	}
}

/// Evm factory. Creates appropriate Evm.
pub struct Factory {
	evm: VMType
}

impl Factory {
	/// Create fresh instance of VM
	/// Might choose implementation depending on supplied gas.
	#[cfg(feature = "jit")]
	pub fn create(&self, gas: U256) -> Box<Evm> {
		match self.evm {
			VMType::Jit => {
				Box::new(super::jit::JitEvm::default())
			},
			VMType::Interpreter => if Self::can_fit_in_usize(gas) {
				Box::new(super::interpreter::Interpreter::<usize>::default())
			} else {
				Box::new(super::interpreter::Interpreter::<U256>::default())
			}
		}
	}

	/// Create fresh instance of VM
	/// Might choose implementation depending on supplied gas.
	#[cfg(not(feature = "jit"))]
	pub fn create(&self, gas: U256) -> Box<Evm> {
		match self.evm {
			VMType::Interpreter => if Self::can_fit_in_usize(gas) {
				Box::new(super::interpreter::Interpreter::<usize>::default())
			} else {
				Box::new(super::interpreter::Interpreter::<U256>::default())
			}
		}
	}

	/// Create new instance of specific `VMType` factory
	pub fn new(evm: VMType) -> Self {
		Factory {
			evm: evm
		}
	}

	fn can_fit_in_usize(gas: U256) -> bool {
		gas == U256::from(gas.low_u64() as usize)
	}
}

impl Default for Factory {
	/// Returns jitvm factory
	#[cfg(feature = "jit")]
	fn default() -> Factory {
		Factory {
			evm: VMType::Jit
		}
	}

	/// Returns native rust evm factory
	#[cfg(not(feature = "jit"))]
	fn default() -> Factory {
		Factory {
			evm: VMType::Interpreter
		}
	}
}

#[test]
fn test_create_vm() {
	let _vm = Factory::default().create(U256::zero());
}

/// Create tests by injecting different VM factories
#[macro_export]
macro_rules! evm_test(
	(ignorejit => $name_test: ident: $name_jit: ident, $name_int: ident) => {
		#[test]
		#[ignore]
		#[cfg(feature = "jit")]
		fn $name_jit() {
			$name_test(Factory::new(VMType::Jit));
		}
		#[test]
		fn $name_int() {
			$name_test(Factory::new(VMType::Interpreter));
		}
	};
	($name_test: ident: $name_jit: ident, $name_int: ident) => {
		#[test]
		#[cfg(feature = "jit")]
		fn $name_jit() {
			$name_test(Factory::new(VMType::Jit));
		}
		#[test]
		fn $name_int() {
			$name_test(Factory::new(VMType::Interpreter));
		}
	}
);

/// Create ignored tests by injecting different VM factories
#[macro_export]
macro_rules! evm_test_ignore(
	($name_test: ident: $name_jit: ident, $name_int: ident) => {
		#[test]
		#[ignore]
		#[cfg(feature = "jit")]
		#[cfg(feature = "ignored-tests")]
		fn $name_jit() {
			$name_test(Factory::new(VMType::Jit));
		}
		#[test]
		#[ignore]
		#[cfg(feature = "ignored-tests")]
		fn $name_int() {
			$name_test(Factory::new(VMType::Interpreter));
		}
	}
);