revmc/bytecode/info.rs
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
use revm_interpreter::{gas, opcode as op};
use revm_primitives::{spec_to_generic, SpecId};
/// Opcode information.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct OpcodeInfo(u16);
impl OpcodeInfo {
/// The unknown flag.
pub const UNKNOWN: u16 = 0b1000_0000_0000_0000;
/// The dynamic flag.
pub const DYNAMIC: u16 = 0b0100_0000_0000_0000;
/// The disabled flag.
pub const DISABLED: u16 = 0b0010_0000_0000_0000;
/// The EOF flag.
pub const EOF: u16 = 0b0001_0000_0000_0000;
/// The mask for the gas cost.
pub const MASK: u16 = 0b0000_1111_1111_1111;
/// Creates a new gas info with the given gas cost.
#[inline]
pub const fn new(gas: u16) -> Self {
Self(gas)
}
/// Returns `true` if the opcode is unknown.
#[inline]
pub const fn is_unknown(self) -> bool {
self.0 == Self::UNKNOWN
}
/// Returns `true` if the gas cost is dynamic.
#[inline]
pub const fn is_dynamic(self) -> bool {
self.0 & Self::DYNAMIC != 0
}
/// Returns `true` if the opcode is known, but disabled in the current EVM
/// version.
#[inline]
pub const fn is_disabled(self) -> bool {
self.0 & Self::DISABLED != 0
}
/// Returns `true` if the opcode is an EOF opcode, meaning it is disallowed in
/// legacy bytecode.
#[inline]
pub const fn is_eof_only(self) -> bool {
self.0 & Self::EOF != 0
}
/// Returns the base gas cost of the opcode.
///
/// This may not be the final/full gas cost of the opcode as it may also have a dynamic cost.
#[inline]
pub const fn base_gas(self) -> u16 {
self.0 & Self::MASK
}
/// Sets the unknown flag.
#[inline]
pub fn set_unknown(&mut self) {
self.0 = Self::UNKNOWN;
}
/// Sets the dynamic flag.
#[inline]
pub fn set_dynamic(&mut self) {
self.0 |= Self::DYNAMIC;
}
/// Sets the disabled flag.
#[inline]
pub fn set_disabled(&mut self) {
self.0 |= Self::DISABLED;
}
/// Sets the EOF flag.
#[inline]
pub fn set_eof(&mut self) {
self.0 |= Self::EOF;
}
/// Sets the gas cost.
///
/// # Panics
///
/// Panics if the gas cost is greater than [`Self::MASK`].
#[inline]
#[track_caller]
pub fn set_gas(&mut self, gas: u16) {
assert!(gas <= Self::MASK);
self.0 = (self.0 & !Self::MASK) | (gas & Self::MASK);
}
}
/// Returns the static info map for the given `SpecId`.
#[allow(unused_parens)]
pub const fn op_info_map(spec_id: SpecId) -> &'static [OpcodeInfo; 256] {
spec_to_generic!(spec_id, (const { &make_map(<SPEC as revm_primitives::Spec>::SPEC_ID) }))
}
#[allow(unused_mut)]
const fn make_map(spec_id: SpecId) -> [OpcodeInfo; 256] {
const DYNAMIC: u16 = OpcodeInfo::DYNAMIC;
const EOF: u16 = OpcodeInfo::EOF;
let mut map = [OpcodeInfo(OpcodeInfo::UNKNOWN); 256];
macro_rules! set {
($($op:ident = $gas:expr $(, if $spec_id:ident)? ;)*) => {
$(
let mut g = $gas;
$(
if (spec_id as u8) < SpecId::$spec_id as u8 {
g |= OpcodeInfo::DISABLED;
}
)?
map[op::$op as usize] = OpcodeInfo::new(g);
)*
};
}
// [1]: Not dynamic in all `SpecId`s, but gas is calculated dynamically in a builtin.
// TODO: Could be converted into [2] with a base cost.
// [2]: Dynamic with a base cost. Only the dynamic part is paid in builtins.
set! {
STOP = 0;
ADD = 3;
MUL = 5;
SUB = 3;
DIV = 5;
SDIV = 5;
MOD = 5;
SMOD = 5;
ADDMOD = 8;
MULMOD = 8;
EXP = 10 | DYNAMIC; // [2]
SIGNEXTEND = 5;
// 0x0C
// 0x0D
// 0x0E
// 0x0F
LT = 3;
GT = 3;
SLT = 3;
SGT = 3;
EQ = 3;
ISZERO = 3;
AND = 3;
OR = 3;
XOR = 3;
NOT = 3;
BYTE = 3;
SHL = 3, if CONSTANTINOPLE;
SHR = 3, if CONSTANTINOPLE;
SAR = 3, if CONSTANTINOPLE;
// 0x1E
// 0x1F
KECCAK256 = 30 | DYNAMIC; // [2]
// 0x21
// 0x22
// 0x23
// 0x24
// 0x25
// 0x26
// 0x27
// 0x28
// 0x29
// 0x2A
// 0x2B
// 0x2C
// 0x2D
// 0x2E
// 0x2F
ADDRESS = 2;
BALANCE = DYNAMIC; // [1]
ORIGIN = 2;
CALLER = 2;
CALLVALUE = 2;
CALLDATALOAD = 3;
CALLDATASIZE = 2;
CALLDATACOPY = 3 | DYNAMIC; // [2]
CODESIZE = 2;
CODECOPY = 3 | DYNAMIC; // [2]
GASPRICE = 2;
EXTCODESIZE = DYNAMIC; // [1]
EXTCODECOPY = DYNAMIC;
RETURNDATASIZE = 2, if BYZANTIUM;
RETURNDATACOPY = 3 | DYNAMIC, if BYZANTIUM; // [2]
EXTCODEHASH = DYNAMIC, if CONSTANTINOPLE; // [1]
BLOCKHASH = 20;
COINBASE = 2;
TIMESTAMP = 2;
NUMBER = 2;
DIFFICULTY = 2;
GASLIMIT = 2;
CHAINID = 2, if ISTANBUL;
SELFBALANCE = 5, if ISTANBUL;
BASEFEE = 2, if LONDON;
BLOBHASH = 3, if CANCUN;
BLOBBASEFEE = 2, if CANCUN;
// 0x4B
// 0x4C
// 0x4D
// 0x4E
// 0x4F
POP = 2;
MLOAD = 3 | DYNAMIC; // [2]
MSTORE = 3 | DYNAMIC; // [2]
MSTORE8 = 3 | DYNAMIC; // [2]
SLOAD = DYNAMIC; // [1]
SSTORE = DYNAMIC;
JUMP = 8;
JUMPI = 10;
PC = 2;
MSIZE = 2;
GAS = 2;
JUMPDEST = 1;
TLOAD = 100, if CANCUN;
TSTORE = 100, if CANCUN;
MCOPY = 3 | DYNAMIC, if CANCUN; // [2]
PUSH0 = 2, if SHANGHAI;
PUSH1 = 3;
PUSH2 = 3;
PUSH3 = 3;
PUSH4 = 3;
PUSH5 = 3;
PUSH6 = 3;
PUSH7 = 3;
PUSH8 = 3;
PUSH9 = 3;
PUSH10 = 3;
PUSH11 = 3;
PUSH12 = 3;
PUSH13 = 3;
PUSH14 = 3;
PUSH15 = 3;
PUSH16 = 3;
PUSH17 = 3;
PUSH18 = 3;
PUSH19 = 3;
PUSH20 = 3;
PUSH21 = 3;
PUSH22 = 3;
PUSH23 = 3;
PUSH24 = 3;
PUSH25 = 3;
PUSH26 = 3;
PUSH27 = 3;
PUSH28 = 3;
PUSH29 = 3;
PUSH30 = 3;
PUSH31 = 3;
PUSH32 = 3;
DUP1 = 3;
DUP2 = 3;
DUP3 = 3;
DUP4 = 3;
DUP5 = 3;
DUP6 = 3;
DUP7 = 3;
DUP8 = 3;
DUP9 = 3;
DUP10 = 3;
DUP11 = 3;
DUP12 = 3;
DUP13 = 3;
DUP14 = 3;
DUP15 = 3;
DUP16 = 3;
SWAP1 = 3;
SWAP2 = 3;
SWAP3 = 3;
SWAP4 = 3;
SWAP5 = 3;
SWAP6 = 3;
SWAP7 = 3;
SWAP8 = 3;
SWAP9 = 3;
SWAP10 = 3;
SWAP11 = 3;
SWAP12 = 3;
SWAP13 = 3;
SWAP14 = 3;
SWAP15 = 3;
SWAP16 = 3;
LOG0 = log_cost(0) | DYNAMIC; // [2]
LOG1 = log_cost(1) | DYNAMIC; // [2]
LOG2 = log_cost(2) | DYNAMIC; // [2]
LOG3 = log_cost(3) | DYNAMIC; // [2]
LOG4 = log_cost(4) | DYNAMIC; // [2]
// 0xA5
// 0xA6
// 0xA7
// 0xA8
// 0xA9
// 0xAA
// 0xAB
// 0xAC
// 0xAD
// 0xAE
// 0xAF
// 0xB0
// 0xB1
// 0xB2
// 0xB3
// 0xB4
// 0xB5
// 0xB6
// 0xB7
// 0xB8
// 0xB9
// 0xBA
// 0xBB
// 0xBC
// 0xBD
// 0xBE
// 0xBF
// 0xC0
// 0xC1
// 0xC2
// 0xC3
// 0xC4
// 0xC5
// 0xC6
// 0xC7
// 0xC8
// 0xC9
// 0xCA
// 0xCB
// 0xCC
// 0xCD
// 0xCE
// 0xCF
DATALOAD = 4 | EOF, if OSAKA;
DATALOADN = 3 | EOF, if OSAKA;
DATASIZE = 2 | EOF, if OSAKA;
DATACOPY = 3 | DYNAMIC | EOF, if OSAKA; // [2]
// 0xD4
// 0xD5
// 0xD6
// 0xD7
// 0xD8
// 0xD9
// 0xDA
// 0xDB
// 0xDC
// 0xDD
// 0xDE
// 0xDF
RJUMP = 2 | EOF, if OSAKA;
RJUMPI = 4 | EOF, if OSAKA;
RJUMPV = 4 | EOF, if OSAKA;
CALLF = 5 | EOF, if OSAKA;
RETF = 3 | EOF, if OSAKA;
JUMPF = 5 | EOF, if OSAKA;
DUPN = 3 | EOF, if OSAKA;
SWAPN = 3 | EOF, if OSAKA;
EXCHANGE = 3 | EOF, if OSAKA;
// 0xE9
// 0xEA
// 0xEB
EOFCREATE = DYNAMIC | EOF, if OSAKA; // TODO: EOF_CREATE_GAS | DYNAMIC is too big
// 0xED
RETURNCONTRACT = DYNAMIC | EOF, if OSAKA;
// 0xEF
CREATE = DYNAMIC;
CALL = DYNAMIC;
CALLCODE = DYNAMIC;
RETURN = DYNAMIC;
DELEGATECALL = DYNAMIC, if HOMESTEAD;
CREATE2 = DYNAMIC, if PETERSBURG;
// 0xF6
RETURNDATALOAD = 3 | EOF, if OSAKA;
EXTCALL = DYNAMIC | EOF, if OSAKA;
EXTDELEGATECALL = DYNAMIC | EOF, if OSAKA;
STATICCALL = DYNAMIC, if BYZANTIUM;
EXTSTATICCALL = DYNAMIC | EOF, if OSAKA;
// 0xFC
REVERT = DYNAMIC, if BYZANTIUM;
INVALID = 0;
SELFDESTRUCT = DYNAMIC;
}
map
}
const fn log_cost(n: u8) -> u16 {
match gas::log_cost(n, 0) {
Some(gas) => {
assert!(gas <= u16::MAX as u64);
gas as u16
}
None => unreachable!(),
}
}