1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
// 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/>.

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

#[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.
#[derive(Clone)]
pub struct Factory {
	evm: VMType,
	evm_cache: Arc<SharedCache>,
}

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>::new(self.evm_cache.clone()))
			} else {
				Box::new(super::interpreter::Interpreter::<U256>::new(self.evm_cache.clone()))
			}
		}
	}

	/// 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>::new(self.evm_cache.clone()))
			} else {
				Box::new(super::interpreter::Interpreter::<U256>::new(self.evm_cache.clone()))
			}
		}
	}

	/// Create new instance of specific `VMType` factory, with a size in bytes
	/// for caching jump destinations.
	pub fn new(evm: VMType, cache_size: usize) -> Self {
		Factory {
			evm: evm,
			evm_cache: Arc::new(SharedCache::new(cache_size)),
		}
	}

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

impl Default for Factory {
	/// Returns jitvm factory
	#[cfg(all(feature = "jit", not(test)))]
	fn default() -> Factory {
		Factory {
			evm: VMType::Jit,
			evm_cache: Arc::new(SharedCache::default()),
		}
	}

	/// Returns native rust evm factory
	#[cfg(any(not(feature = "jit"), test))]
	fn default() -> Factory {
		Factory {
			evm: VMType::Interpreter,
			evm_cache: Arc::new(SharedCache::default()),
		}
	}
}

#[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, 1024 * 32));
		}
		#[test]
		fn $name_int() {
			$name_test(Factory::new(VMType::Interpreter, 1024 * 32));
		}
	};
	($name_test: ident: $name_jit: ident, $name_int: ident) => {
		#[test]
		#[cfg(feature = "jit")]
		fn $name_jit() {
			$name_test(Factory::new(VMType::Jit, 1024 * 32));
		}
		#[test]
		fn $name_int() {
			$name_test(Factory::new(VMType::Interpreter, 1024 * 32));
		}
	}
);

/// 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, 1024 * 32));
		}
		#[test]
		#[ignore]
		#[cfg(feature = "ignored-tests")]
		fn $name_int() {
			$name_test(Factory::new(VMType::Interpreter, 1024 * 32));
		}
	}
);