revm_inspector/
gas.rs

1//! GasIspector. Helper Inspector to calculate gas for others.
2use interpreter::{CallOutcome, CreateOutcome, Gas};
3
4/// Helper that keeps track of gas.
5#[allow(dead_code)]
6#[derive(Clone, Copy, Debug)]
7pub struct GasInspector {
8    gas_remaining: u64,
9    last_gas_cost: u64,
10}
11
12impl Default for GasInspector {
13    fn default() -> Self {
14        Self::new()
15    }
16}
17
18impl GasInspector {
19    /// Returns the remaining gas.
20    #[inline]
21    pub fn gas_remaining(&self) -> u64 {
22        self.gas_remaining
23    }
24
25    /// Returns the last gas cost.
26    #[inline]
27    pub fn last_gas_cost(&self) -> u64 {
28        self.last_gas_cost
29    }
30
31    /// Create a new gas inspector.
32    pub fn new() -> Self {
33        Self {
34            gas_remaining: 0,
35            last_gas_cost: 0,
36        }
37    }
38
39    /// Sets remaining gas to gas limit.
40    #[inline]
41    pub fn initialize_interp(&mut self, gas: &Gas) {
42        self.gas_remaining = gas.limit();
43    }
44
45    /// Sets the remaining gas.
46    #[inline]
47    pub fn step(&mut self, gas: &Gas) {
48        self.gas_remaining = gas.remaining();
49    }
50
51    /// calculate last gas cost and remaining gas.
52    #[inline]
53    pub fn step_end(&mut self, gas: &mut Gas) {
54        let remaining = gas.remaining();
55        self.last_gas_cost = self.gas_remaining.saturating_sub(remaining);
56        self.gas_remaining = remaining;
57    }
58
59    /// Spend all gas if call failed.
60    #[inline]
61    pub fn call_end(&mut self, outcome: &mut CallOutcome) {
62        if outcome.result.result.is_error() {
63            outcome.result.gas.spend_all();
64            self.gas_remaining = 0;
65        }
66    }
67
68    /// Spend all gas if create failed.
69    #[inline]
70    pub fn create_end(&mut self, outcome: &mut CreateOutcome) {
71        if outcome.result.result.is_error() {
72            outcome.result.gas.spend_all();
73            self.gas_remaining = 0;
74        }
75    }
76}
77
78#[cfg(test)]
79mod tests {
80    use super::*;
81    use crate::{InspectEvm, Inspector};
82    use context::{Context, TxEnv};
83    use database::{BenchmarkDB, BENCH_CALLER, BENCH_TARGET};
84    use handler::{MainBuilder, MainContext};
85    use interpreter::{
86        interpreter_types::{Jumps, ReturnData},
87        CallInputs, CreateInputs, Interpreter, InterpreterResult, InterpreterTypes,
88    };
89    use primitives::{Address, Bytes, TxKind};
90    use state::bytecode::{opcode, Bytecode};
91
92    #[derive(Default, Debug)]
93    struct StackInspector {
94        pc: usize,
95        gas_inspector: GasInspector,
96        gas_remaining_steps: Vec<(usize, u64)>,
97    }
98
99    impl<CTX, INTR: InterpreterTypes> Inspector<CTX, INTR> for StackInspector {
100        fn initialize_interp(&mut self, interp: &mut Interpreter<INTR>, _context: &mut CTX) {
101            self.gas_inspector.initialize_interp(&interp.gas);
102        }
103
104        fn step(&mut self, interp: &mut Interpreter<INTR>, _context: &mut CTX) {
105            self.pc = interp.bytecode.pc();
106            self.gas_inspector.step(&interp.gas);
107        }
108
109        fn step_end(&mut self, interp: &mut Interpreter<INTR>, _context: &mut CTX) {
110            self.gas_inspector.step_end(&mut interp.gas);
111            self.gas_remaining_steps
112                .push((self.pc, self.gas_inspector.gas_remaining()));
113        }
114
115        fn call_end(&mut self, _c: &mut CTX, _i: &CallInputs, outcome: &mut CallOutcome) {
116            self.gas_inspector.call_end(outcome)
117        }
118
119        fn create_end(&mut self, _c: &mut CTX, _i: &CreateInputs, outcome: &mut CreateOutcome) {
120            self.gas_inspector.create_end(outcome)
121        }
122    }
123
124    #[test]
125    fn test_gas_inspector() {
126        let contract_data: Bytes = Bytes::from(vec![
127            opcode::PUSH1,
128            0x1,
129            opcode::PUSH1,
130            0xb,
131            opcode::JUMPI,
132            opcode::PUSH1,
133            0x1,
134            opcode::PUSH1,
135            0x1,
136            opcode::PUSH1,
137            0x1,
138            opcode::JUMPDEST,
139            opcode::STOP,
140        ]);
141        let bytecode = Bytecode::new_raw(contract_data);
142
143        let ctx = Context::mainnet().with_db(BenchmarkDB::new_bytecode(bytecode.clone()));
144
145        let mut evm = ctx.build_mainnet_with_inspector(StackInspector::default());
146
147        // Run evm.
148        evm.inspect_one_tx(
149            TxEnv::builder()
150                .caller(BENCH_CALLER)
151                .kind(TxKind::Call(BENCH_TARGET))
152                .gas_limit(21100)
153                .build()
154                .unwrap(),
155        )
156        .unwrap();
157
158        let inspector = &evm.inspector;
159
160        // Starting from 100gas
161        let steps = vec![
162            // push1 -3
163            (0, 97),
164            // push1 -3
165            (2, 94),
166            // jumpi -10
167            (4, 84),
168            // jumpdest 1
169            (11, 83),
170            // stop 0
171            (12, 83),
172        ];
173
174        assert_eq!(inspector.gas_remaining_steps, steps);
175    }
176
177    #[derive(Default, Debug)]
178    struct CallOverrideInspector {
179        call_override: Vec<Option<CallOutcome>>,
180        create_override: Vec<Option<CreateOutcome>>,
181        return_buffer: Vec<Bytes>,
182    }
183
184    impl<CTX, INTR: InterpreterTypes> Inspector<CTX, INTR> for CallOverrideInspector {
185        fn call(&mut self, _context: &mut CTX, _inputs: &mut CallInputs) -> Option<CallOutcome> {
186            self.call_override.pop().unwrap_or_default()
187        }
188
189        fn step(&mut self, interpreter: &mut Interpreter<INTR>, _context: &mut CTX) {
190            let this_buffer = interpreter.return_data.buffer();
191            let Some(buffer) = self.return_buffer.last() else {
192                self.return_buffer.push(this_buffer.clone());
193                return;
194            };
195            if this_buffer != buffer {
196                self.return_buffer.push(this_buffer.clone());
197            }
198        }
199
200        fn create(
201            &mut self,
202            _context: &mut CTX,
203            _inputs: &mut CreateInputs,
204        ) -> Option<CreateOutcome> {
205            self.create_override.pop().unwrap_or_default()
206        }
207    }
208
209    #[test]
210    fn test_call_override_inspector() {
211        use interpreter::{CallOutcome, CreateOutcome, InstructionResult};
212
213        let mut inspector = CallOverrideInspector::default();
214        inspector.call_override.push(Some(CallOutcome::new(
215            InterpreterResult::new(InstructionResult::Return, [0x01].into(), Gas::new(100_000)),
216            0..1,
217        )));
218        inspector.call_override.push(None);
219        inspector.create_override.push(Some(CreateOutcome::new(
220            InterpreterResult::new(InstructionResult::Revert, [0x02].into(), Gas::new(100_000)),
221            Some(Address::ZERO),
222        )));
223
224        let contract_data: Bytes = Bytes::from(vec![
225            opcode::PUSH1,
226            0x01,
227            opcode::PUSH1,
228            0x0,
229            opcode::DUP1,
230            opcode::DUP1,
231            opcode::DUP1,
232            opcode::DUP1,
233            opcode::ADDRESS,
234            opcode::CALL,
235            opcode::PUSH1,
236            0x01,
237            opcode::PUSH1,
238            0x0,
239            opcode::DUP1,
240            opcode::DUP1,
241            opcode::DUP1,
242            opcode::DUP1,
243            opcode::DUP1,
244            opcode::ADDRESS,
245            opcode::CREATE,
246            opcode::STOP,
247        ]);
248
249        let bytecode = Bytecode::new_raw(contract_data);
250
251        let mut evm = Context::mainnet()
252            .with_db(BenchmarkDB::new_bytecode(bytecode.clone()))
253            .build_mainnet_with_inspector(inspector);
254
255        let _ = evm
256            .inspect_one_tx(TxEnv::builder_for_bench().build().unwrap())
257            .unwrap();
258        assert_eq!(evm.inspector.return_buffer.len(), 3);
259        assert_eq!(
260            evm.inspector.return_buffer,
261            [Bytes::new(), Bytes::from([0x01]), Bytes::from([0x02])].to_vec()
262        );
263    }
264}
revm_inspector/gas.rs

revm_inspector/
gas.rs
