|
| 1 | +//! Substrate EVM tracer. |
| 2 | +//! |
| 3 | +//! Enables tracing the EVM opcode execution and proxies EVM messages to the host functions. |
| 4 | +
|
| 5 | +#![cfg_attr(not(feature = "std"), no_std)] |
| 6 | + |
| 7 | +use codec::Encode; |
| 8 | +use evm::tracing::{using as evm_using, EventListener as EvmListener}; |
| 9 | +use evm_gasometer::tracing::{using as gasometer_using, EventListener as GasometerListener}; |
| 10 | +use evm_runtime::tracing::{using as runtime_using, EventListener as RuntimeListener}; |
| 11 | +use primitives_evm_tracing_events::{EvmEvent, GasometerEvent, RuntimeEvent, StepEventFilter}; |
| 12 | +use sp_std::{cell::RefCell, rc::Rc}; |
| 13 | + |
| 14 | +/// Listener proxy. |
| 15 | +struct ListenerProxy<T>(pub Rc<RefCell<T>>); |
| 16 | + |
| 17 | +impl<T: GasometerListener> GasometerListener for ListenerProxy<T> { |
| 18 | + fn event(&mut self, event: evm_gasometer::tracing::Event) { |
| 19 | + self.0.borrow_mut().event(event); |
| 20 | + } |
| 21 | +} |
| 22 | + |
| 23 | +impl<T: RuntimeListener> RuntimeListener for ListenerProxy<T> { |
| 24 | + fn event(&mut self, event: evm_runtime::tracing::Event) { |
| 25 | + self.0.borrow_mut().event(event); |
| 26 | + } |
| 27 | +} |
| 28 | + |
| 29 | +impl<T: EvmListener> EvmListener for ListenerProxy<T> { |
| 30 | + fn event(&mut self, event: evm::tracing::Event) { |
| 31 | + self.0.borrow_mut().event(event); |
| 32 | + } |
| 33 | +} |
| 34 | + |
| 35 | +/// EVM tracer. |
| 36 | +pub struct EvmTracer { |
| 37 | + /// Step event filter. |
| 38 | + step_event_filter: StepEventFilter, |
| 39 | +} |
| 40 | + |
| 41 | +impl Default for EvmTracer { |
| 42 | + fn default() -> Self { |
| 43 | + Self { |
| 44 | + step_event_filter: primitives_evm_tracing_ext::evm_tracing_ext::step_event_filter(), |
| 45 | + } |
| 46 | + } |
| 47 | +} |
| 48 | + |
| 49 | +impl EvmTracer { |
| 50 | + /// Setup event listeners and execute provided closure. |
| 51 | + /// |
| 52 | + /// Consume the tracer and return it alongside the return value of |
| 53 | + /// the closure. |
| 54 | + pub fn trace<R, F: FnOnce() -> R>(self, f: F) { |
| 55 | + let wrapped = Rc::new(RefCell::new(self)); |
| 56 | + |
| 57 | + let mut gasometer = ListenerProxy(Rc::clone(&wrapped)); |
| 58 | + let mut runtime = ListenerProxy(Rc::clone(&wrapped)); |
| 59 | + let mut evm = ListenerProxy(Rc::clone(&wrapped)); |
| 60 | + |
| 61 | + // Each line wraps the previous `f` into a `using` call. |
| 62 | + // Listening to new events results in adding one new line. |
| 63 | + // Order is irrelevant when registering listeners. |
| 64 | + let f = || runtime_using(&mut runtime, f); |
| 65 | + let f = || gasometer_using(&mut gasometer, f); |
| 66 | + let f = || evm_using(&mut evm, f); |
| 67 | + f(); |
| 68 | + } |
| 69 | + |
| 70 | + /// Emit new call stack. |
| 71 | + pub fn emit_new() { |
| 72 | + primitives_evm_tracing_ext::evm_tracing_ext::call_list_new(); |
| 73 | + } |
| 74 | +} |
| 75 | + |
| 76 | +impl EvmListener for EvmTracer { |
| 77 | + fn event(&mut self, event: evm::tracing::Event) { |
| 78 | + let event: EvmEvent = event.into(); |
| 79 | + let message = event.encode(); |
| 80 | + primitives_evm_tracing_ext::evm_tracing_ext::evm_event(message); |
| 81 | + } |
| 82 | +} |
| 83 | + |
| 84 | +impl GasometerListener for EvmTracer { |
| 85 | + fn event(&mut self, event: evm_gasometer::tracing::Event) { |
| 86 | + let event: GasometerEvent = event.into(); |
| 87 | + let message = event.encode(); |
| 88 | + primitives_evm_tracing_ext::evm_tracing_ext::gasometer_event(message); |
| 89 | + } |
| 90 | +} |
| 91 | + |
| 92 | +impl RuntimeListener for EvmTracer { |
| 93 | + fn event(&mut self, event: evm_runtime::tracing::Event) { |
| 94 | + let event = RuntimeEvent::from_evm_event(event, self.step_event_filter); |
| 95 | + let message = event.encode(); |
| 96 | + primitives_evm_tracing_ext::evm_tracing_ext::runtime_event(message); |
| 97 | + } |
| 98 | +} |
0 commit comments