├── .gitignore ├── README.md ├── dev-docs └── Ethereum Virtual Machine Opcodes.pdf ├── src ├── lib │ ├── mod.rs │ ├── statuscode.rs │ ├── state.rs │ ├── stack.rs │ ├── memory.rs │ ├── opcode.rs │ ├── custom_type.rs │ └── execution.rs └── main.rs ├── Cargo.toml ├── Cargo.lock └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # xevm 2 | xylene evm is a WIP Ethereum Virtual Machine implementation prioritizing speed and simplicity. 3 | -------------------------------------------------------------------------------- /dev-docs/Ethereum Virtual Machine Opcodes.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/03ladr/xevm/HEAD/dev-docs/Ethereum Virtual Machine Opcodes.pdf -------------------------------------------------------------------------------- /src/lib/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod custom_type; 2 | pub mod execution; 3 | pub mod memory; 4 | pub mod opcode; 5 | pub mod stack; 6 | pub mod state; 7 | pub mod statuscode; 8 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "xevm" 3 | version = "0.1.0" 4 | edition = "2021" 5 | 6 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 7 | 8 | [dependencies] 9 | ethnum = "1.1.1" 10 | hex = "0.4.3" 11 | sha3 = "0.10.1" 12 | -------------------------------------------------------------------------------- /src/lib/statuscode.rs: -------------------------------------------------------------------------------- 1 | #[derive(Debug)] 2 | // EVM(C) Status Codes 3 | pub enum StatusCode { 4 | Completion, 5 | Failure, 6 | Revert, 7 | OutOfGas, 8 | InvalidInstruction, 9 | UndefinedInstruction, 10 | StackOverflow, 11 | StackUnderflow, 12 | BadJumpDest, 13 | InvalidMemoryAccess, 14 | CallDepthExceeded, 15 | StaticModeViolation, 16 | PrecompileFailure, 17 | ContractValidationFailure, 18 | ArgOutOfRange, 19 | WASMUnreachableInstruction, 20 | WASMTrap, 21 | InsufficientBalance, 22 | InternalError, 23 | Rejected, 24 | OutOfMemory, 25 | } 26 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | pub mod lib; 2 | use hex; 3 | use lib::execution::ExecutionContext; 4 | use lib::memory::Memory; 5 | use lib::stack::Stack; 6 | use lib::statuscode::StatusCode; 7 | use std::env; 8 | 9 | // cargo run {gas_limit} {bytecode} 10 | fn main() -> Result<(), StatusCode> { 11 | let args: Vec = env::args().collect(); 12 | let stack = Stack::init(); 13 | let memory = Memory::init(); 14 | let mut executor = ExecutionContext::init( 15 | hex::decode(&args[2]).unwrap(), 16 | stack, 17 | memory, 18 | str::parse::(&args[1]).unwrap(), 19 | ); 20 | executor.run() 21 | } 22 | -------------------------------------------------------------------------------- /src/lib/state.rs: -------------------------------------------------------------------------------- 1 | use super::custom_type::{U160, U256BE}; 2 | 3 | // Block Object 4 | pub struct Block { 5 | pub blocknumber: usize, 6 | pub basegas: usize, 7 | pub gaslimit: usize, 8 | pub difficulty: usize, 9 | // pub nonce: usize, 10 | pub coinbase: U160, 11 | pub timestamp: U256BE, 12 | /*pub mixhash: U256BE, 13 | pub parenthash: U256BE, 14 | pub transactions: U256BE, 15 | pub stateroot: U256BE,*/ 16 | } 17 | impl Block { 18 | // Initialize block with arbitrary values for testing 19 | pub fn default() -> Self { 20 | Block { 21 | blocknumber: 1, 22 | basegas: 21000, 23 | gaslimit: 8000000, 24 | difficulty: 6, 25 | timestamp: U256BE::from_u8(8), 26 | // nonce: 7, 27 | coinbase: U256BE::from_u8(4).to_u160(), 28 | /*mixhash: U256BE::from_u8(2), 29 | parenthash: U256BE::from_u8(3), 30 | transactions: U256BE::from_u8(9), 31 | stateroot: U256BE::from_u8(5)*/ 32 | } 33 | } 34 | } 35 | 36 | /*// Transaction Object 37 | pub struct Transaction { 38 | recipient: U160, 39 | signature: U256BE, 40 | value: usize, 41 | data: U256BE, 42 | gaslimit: usize, 43 | maxprioritygas: usize, 44 | maxgas: usize 45 | } 46 | 47 | // Log Object 48 | pub struct Log { 49 | address: U160, 50 | blockhash: U256BE, 51 | blocknumber: usize, 52 | data: Vec, 53 | logindex: usize, 54 | topics: Vec, 55 | txhash: U256BE, 56 | txindex: usize, 57 | } 58 | 59 | // Account Object 60 | pub struct Account { 61 | nonce: usize, 62 | balance: usize, 63 | codehash: U256BE, 64 | storageroot: U256BE 65 | }*/ 66 | -------------------------------------------------------------------------------- /src/lib/stack.rs: -------------------------------------------------------------------------------- 1 | use super::custom_type::U256BE; 2 | use super::statuscode::StatusCode; 3 | 4 | pub struct Stack { 5 | // Vector of big endian u256 words to represent EVM stack 6 | storage: Vec, 7 | } 8 | impl Stack { 9 | // Initialize stack with length 1024 10 | pub fn init() -> Self { 11 | Stack { 12 | storage: Vec::with_capacity(1024), 13 | } 14 | } 15 | 16 | // Push U256BE value onto stack 17 | pub fn push(&mut self, value: U256BE) -> Result<(), StatusCode> { 18 | if self.storage.len() > 1024 { 19 | return Err(StatusCode::StackOverflow); 20 | }; 21 | self.storage.push(value); 22 | Ok(()) 23 | } 24 | 25 | // Pop U256BE value off stack 26 | pub fn pop(&mut self) -> Result { 27 | match self.storage.pop() { 28 | Some(n) => Ok(n), 29 | None => Err(StatusCode::StackUnderflow), 30 | } 31 | } 32 | 33 | // Push U256BE value onto stack at index 34 | pub fn push_to(&mut self, idx: usize, value: U256BE) -> Result<(), StatusCode> { 35 | if self.storage.len() > 1024 { 36 | return Err(StatusCode::StackOverflow); 37 | } else if idx >= self.storage.len() { 38 | return Err(StatusCode::ArgOutOfRange); 39 | }; 40 | self.storage.push(value); 41 | Ok(()) 42 | } 43 | 44 | // Return U256BE value from stack at index 45 | pub fn peek(&self, idx: usize) -> Result { 46 | if idx >= self.storage.len() { 47 | return Err(StatusCode::ArgOutOfRange); 48 | }; 49 | Ok(self.storage[idx]) 50 | } 51 | 52 | // Return length of stack 53 | pub fn len(&self) -> usize { 54 | self.storage.len() 55 | } 56 | 57 | // Return reference to stack vector 58 | pub fn peek_full(&mut self) -> &Vec { 59 | &self.storage 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /src/lib/memory.rs: -------------------------------------------------------------------------------- 1 | use super::custom_type::U256BE; 2 | use super::statuscode::StatusCode; 3 | 4 | pub struct Memory { 5 | // Vector of unsigned 8-bit integers to represent EVM memory 6 | storage: Vec, 7 | } 8 | impl Memory { 9 | // Initialize memory with length 4096 10 | pub fn init() -> Self { 11 | Memory { 12 | storage: Vec::with_capacity(4096), 13 | } 14 | } 15 | 16 | // Load 32-byte word from memory at offset 17 | pub fn load(&mut self, offset: usize) -> Result, StatusCode> { 18 | let len_original = self.storage.len(); 19 | if offset + 31 >= len_original { 20 | self.storage.resize((offset + len_original | 31) + 1, 0); 21 | }; 22 | let ret = self.storage[offset..offset + 32].to_vec(); 23 | self.storage.truncate(len_original); 24 | Ok(ret) 25 | } 26 | 27 | // Load bytes from memory within range 28 | pub fn load_range(&mut self, offset: usize, length: usize) -> Result, StatusCode> { 29 | let len_original = self.storage.len(); 30 | if offset + length >= len_original { 31 | self.storage.resize((offset + length + len_original | 31) + 1, 0); 32 | }; 33 | let ret = self.storage[offset..offset + length].to_vec(); 34 | self.storage.truncate(len_original); 35 | Ok(ret) 36 | } 37 | 38 | // Store 32-byte word in memory at offset 39 | pub fn store(&mut self, offset: usize, value: U256BE) -> Result<(), StatusCode> { 40 | if offset >= self.storage.len() { self.storage.resize(offset + 32, 0); }; 41 | self.storage[offset..offset + 32].clone_from_slice(&value.as_slice()); 42 | if self.storage.len() % 32 != 0 { 43 | self.storage.resize((self.storage.len() | 31) + 1, 0); 44 | }; 45 | Ok(()) 46 | } 47 | 48 | // Return reference to memory vector 49 | pub fn load_full(&mut self) -> &Vec { 50 | &self.storage 51 | } 52 | 53 | // Return length of memory 54 | pub fn len(&mut self) -> usize { 55 | self.storage.len() 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "block-buffer" 7 | version = "0.10.2" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "0bf7fe51849ea569fd452f37822f606a5cabb684dc918707a0193fd4664ff324" 10 | dependencies = [ 11 | "generic-array", 12 | ] 13 | 14 | [[package]] 15 | name = "crypto-common" 16 | version = "0.1.3" 17 | source = "registry+https://github.com/rust-lang/crates.io-index" 18 | checksum = "57952ca27b5e3606ff4dd79b0020231aaf9d6aa76dc05fd30137538c50bd3ce8" 19 | dependencies = [ 20 | "generic-array", 21 | "typenum", 22 | ] 23 | 24 | [[package]] 25 | name = "digest" 26 | version = "0.10.3" 27 | source = "registry+https://github.com/rust-lang/crates.io-index" 28 | checksum = "f2fb860ca6fafa5552fb6d0e816a69c8e49f0908bf524e30a90d97c85892d506" 29 | dependencies = [ 30 | "block-buffer", 31 | "crypto-common", 32 | ] 33 | 34 | [[package]] 35 | name = "ethnum" 36 | version = "1.1.1" 37 | source = "registry+https://github.com/rust-lang/crates.io-index" 38 | checksum = "63b40347dcad92b4dfeb9765c41c48503416daddf6dba55b74614dc035a43ed2" 39 | 40 | [[package]] 41 | name = "generic-array" 42 | version = "0.14.5" 43 | source = "registry+https://github.com/rust-lang/crates.io-index" 44 | checksum = "fd48d33ec7f05fbfa152300fdad764757cbded343c1aa1cff2fbaf4134851803" 45 | dependencies = [ 46 | "typenum", 47 | "version_check", 48 | ] 49 | 50 | [[package]] 51 | name = "hex" 52 | version = "0.4.3" 53 | source = "registry+https://github.com/rust-lang/crates.io-index" 54 | checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" 55 | 56 | [[package]] 57 | name = "keccak" 58 | version = "0.1.0" 59 | source = "registry+https://github.com/rust-lang/crates.io-index" 60 | checksum = "67c21572b4949434e4fc1e1978b99c5f77064153c59d998bf13ecd96fb5ecba7" 61 | 62 | [[package]] 63 | name = "levm" 64 | version = "0.1.0" 65 | dependencies = [ 66 | "ethnum", 67 | "hex", 68 | "sha3", 69 | ] 70 | 71 | [[package]] 72 | name = "sha3" 73 | version = "0.10.1" 74 | source = "registry+https://github.com/rust-lang/crates.io-index" 75 | checksum = "881bf8156c87b6301fc5ca6b27f11eeb2761224c7081e69b409d5a1951a70c86" 76 | dependencies = [ 77 | "digest", 78 | "keccak", 79 | ] 80 | 81 | [[package]] 82 | name = "typenum" 83 | version = "1.15.0" 84 | source = "registry+https://github.com/rust-lang/crates.io-index" 85 | checksum = "dcf81ac59edc17cc8697ff311e8f5ef2d99fcbd9817b34cec66f90b6c3dfd987" 86 | 87 | [[package]] 88 | name = "version_check" 89 | version = "0.9.4" 90 | source = "registry+https://github.com/rust-lang/crates.io-index" 91 | checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" 92 | -------------------------------------------------------------------------------- /src/lib/opcode.rs: -------------------------------------------------------------------------------- 1 | // Will reorder by value. Sometime soon. 2 | 3 | // Stack-oriented opcodes 4 | pub const PUSH1: u8 = 0x60; 5 | pub const PUSH2: u8 = 0x61; 6 | pub const PUSH3: u8 = 0x62; 7 | pub const PUSH4: u8 = 0x63; 8 | pub const PUSH5: u8 = 0x64; 9 | pub const PUSH6: u8 = 0x65; 10 | pub const PUSH7: u8 = 0x66; 11 | pub const PUSH8: u8 = 0x67; 12 | pub const PUSH9: u8 = 0x68; 13 | pub const PUSH10: u8 = 0x69; 14 | pub const PUSH11: u8 = 0x6A; 15 | pub const PUSH12: u8 = 0x6B; 16 | pub const PUSH13: u8 = 0x6C; 17 | pub const PUSH14: u8 = 0x6D; 18 | pub const PUSH15: u8 = 0x6E; 19 | pub const PUSH16: u8 = 0x6F; 20 | pub const POP: u8 = 0x50; 21 | pub const DUP1: u8 = 0x80; 22 | pub const DUP2: u8 = 0x81; 23 | pub const DUP3: u8 = 0x82; 24 | pub const DUP4: u8 = 0x83; 25 | pub const DUP5: u8 = 0x84; 26 | pub const DUP6: u8 = 0x85; 27 | pub const DUP7: u8 = 0x86; 28 | pub const DUP8: u8 = 0x87; 29 | pub const DUP9: u8 = 0x88; 30 | pub const DUP10: u8 = 0x89; 31 | pub const DUP11: u8 = 0x8A; 32 | pub const DUP12: u8 = 0x8B; 33 | pub const DUP13: u8 = 0x8C; 34 | pub const DUP14: u8 = 0x8D; 35 | pub const DUP15: u8 = 0x8E; 36 | pub const DUP16: u8 = 0x8F; 37 | pub const SWAP1: u8 = 0x90; 38 | pub const SWAP2: u8 = 0x91; 39 | pub const SWAP3: u8 = 0x92; 40 | pub const SWAP4: u8 = 0x93; 41 | pub const SWAP5: u8 = 0x94; 42 | pub const SWAP6: u8 = 0x95; 43 | pub const SWAP7: u8 = 0x96; 44 | pub const SWAP8: u8 = 0x97; 45 | pub const SWAP9: u8 = 0x98; 46 | pub const SWAP10: u8 = 0x99; 47 | pub const SWAP11: u8 = 0x9A; 48 | pub const SWAP12: u8 = 0x9B; 49 | pub const SWAP13: u8 = 0x9C; 50 | pub const SWAP14: u8 = 0x9D; 51 | pub const SWAP15: u8 = 0x9E; 52 | pub const SWAP16: u8 = 0x9F; 53 | pub const BYTE: u8 = 0x1A; 54 | pub const MUL: u8 = 0x02; 55 | pub const ADD: u8 = 0x01; 56 | pub const SUB: u8 = 0x03; 57 | pub const DIV: u8 = 0x04; 58 | pub const EXP: u8 = 0x0A; 59 | pub const SDIV: u8 = 0x05; 60 | pub const MOD: u8 = 0x06; 61 | pub const SMOD: u8 = 0x07; 62 | pub const ADDMOD: u8 = 0x08; 63 | pub const MULMOD: u8 = 0x09; 64 | pub const EQ: u8 = 0x14; 65 | pub const ISZERO: u8 = 0x15; 66 | pub const AND: u8 = 0x16; 67 | pub const OR: u8 = 0x17; 68 | pub const XOR: u8 = 0x18; 69 | pub const NOT: u8 = 0x19; 70 | pub const GT: u8 = 0x11; 71 | pub const LT: u8 = 0x10; 72 | pub const SLT: u8 = 0x12; 73 | pub const SGT: u8 = 0x13; 74 | pub const SHL: u8 = 0x1B; 75 | pub const SHR: u8 = 0x1C; 76 | pub const SAR: u8 = 0x1D; 77 | // Memory-oriented opcodes 78 | pub const MLOAD: u8 = 0x51; 79 | pub const MSTORE: u8 = 0x52; 80 | pub const MSTORE8: u8 = 0x53; 81 | pub const MSIZE: u8 = 0x59; 82 | // Bytecode-oriented opcodes 83 | pub const JUMP: u8 = 0x56; 84 | pub const JUMPI: u8 = 0x57; 85 | pub const JUMPDEST: u8 = 0x5B; 86 | // Calldata-oriented opcodes 87 | pub const CALLDATALOAD: u8 = 0x35; 88 | pub const CALLDATASIZE: u8 = 0x36; 89 | pub const CALLDATACOPY: u8 = 0x37; 90 | // State-oriented opcodes 91 | pub const COINBASE: u8 = 0x41; 92 | pub const TIMESTAMP: u8 = 0x42; 93 | pub const NUMBER: u8 = 0x43; 94 | pub const DIFFICULTY: u8 = 0x44; 95 | pub const GASLIMIT: u8 = 0x45; 96 | pub const BASEFEE: u8 = 0x48; 97 | // Other opcodes 98 | pub const RETURN: u8 = 0xF3; 99 | pub const STOP: u8 = 0x00; 100 | pub const PC: u8 = 0x58; 101 | pub const GAS: u8 = 0x5A; 102 | pub const SHA3: u8 = 0x20; 103 | 104 | // Gas fetcher 105 | pub fn gas_fetch(key: u8) -> usize { 106 | // Linter makes this mess. Must configure. 107 | match key { 108 | JUMPDEST => 1, 109 | POP | PC | GAS | CALLDATASIZE | MSIZE | COINBASE | TIMESTAMP | NUMBER | DIFFICULTY | GASLIMIT | BASEFEE => 2, 110 | PUSH1 | PUSH2 | PUSH3 | PUSH4 | PUSH5 | PUSH6 | PUSH7 | PUSH8 | PUSH9 | PUSH10 | PUSH11 111 | | PUSH12 | PUSH13 | PUSH14 | PUSH15 | PUSH16 | DUP1 | DUP2 | DUP3 | DUP4 | DUP5 | DUP6 112 | | DUP7 | DUP8 | DUP9 | DUP10 | DUP11 | DUP12 | DUP13 | DUP14 | DUP15 | DUP16 | SWAP1 113 | | SWAP2 | SWAP3 | SWAP4 | SWAP5 | SWAP6 | SWAP7 | SWAP8 | SWAP9 | SWAP10 | SWAP11 | XOR 114 | | SWAP12 | SWAP13 | SWAP14 | SWAP15 | SWAP16 | ADD | SUB | EQ | ISZERO | AND | OR | NOT 115 | | GT | LT | SGT | SLT | SHL | SHR | SAR | CALLDATALOAD | BYTE => 3, 116 | MUL | DIV | SDIV | MOD | SMOD => 5, 117 | JUMP | ADDMOD | MULMOD => 8, 118 | JUMPI => 10, 119 | _ => 0, 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /src/lib/custom_type.rs: -------------------------------------------------------------------------------- 1 | use ethnum::{u256, i256}; 2 | 3 | #[derive(Debug, Clone, Copy)] 4 | // Big endian u256 type 5 | pub struct U256BE([u8; 32]); 6 | impl U256BE { 7 | // Return self as slice 8 | pub fn as_slice(self) -> [u8; 32] { 9 | self.0 10 | } 11 | 12 | // Convert self to usize 13 | pub fn to_usize(self) -> usize { 14 | let ret: [u8; 8] = self.0[24..=31].try_into().unwrap(); 15 | usize::from_be_bytes(ret) 16 | } 17 | 18 | // Convert self to u160 19 | pub fn to_u160(self) -> U160 { 20 | U160(self.0[12..].try_into().unwrap()) 21 | } 22 | 23 | // Convert self to u256 24 | pub fn to_u256(self) -> u256 { 25 | u256::from_be_bytes(self.0) 26 | } 27 | 28 | // Convert self to i256 29 | pub fn to_i256(self) -> i256 { 30 | i256::from_be_bytes(self.0) 31 | } 32 | 33 | // Convert self to u32 34 | pub fn to_u32(self) -> u32 { 35 | let ret: [u8; 4] = self.0[28..=31].try_into().unwrap(); 36 | u32::from_be_bytes(ret) 37 | } 38 | 39 | // NOT bitwise operator: !self 40 | pub fn not(self) -> Self { 41 | let mut ret = [0u8; 32]; 42 | self.0 43 | .into_iter() 44 | .enumerate() 45 | .for_each(|(idx, x)| ret[idx] = !x); 46 | U256BE(ret) 47 | } 48 | 49 | // AND bitwise operator: self & value 50 | pub fn and(self, value: U256BE) -> Self { 51 | let mut ret = [0u8; 32]; 52 | self.0 53 | .into_iter() 54 | .enumerate() 55 | .for_each(|(idx, x)| ret[idx] = x & value.0[idx]); 56 | U256BE(ret) 57 | } 58 | 59 | // OR bitwise operator: self | value 60 | pub fn or(self, value: U256BE) -> Self { 61 | let mut ret = [0u8; 32]; 62 | self.0 63 | .into_iter() 64 | .enumerate() 65 | .for_each(|(idx, x)| ret[idx] = x | value.0[idx]); 66 | U256BE(ret) 67 | } 68 | 69 | // XOR bitwise operator: self ^ value 70 | pub fn xor(self, value: U256BE) -> Self { 71 | let mut ret = [0u8; 32]; 72 | self.0 73 | .into_iter() 74 | .enumerate() 75 | .for_each(|(idx, x)| ret[idx] = x ^ value.0[idx]); 76 | U256BE(ret) 77 | } 78 | 79 | // GT operator: self > value 80 | pub fn gt(self, value: U256BE) -> Self { 81 | if self.0 > value.0 { U256BE::from_u8(1) } 82 | else { U256BE([0;32]) } 83 | } 84 | 85 | // LT operator: self < value 86 | pub fn lt(self, value: U256BE) -> Self { 87 | if self.0 < value.0 { U256BE::from_u8(1) } 88 | else { U256BE([0;32]) } 89 | } 90 | 91 | // SGT operator: int256 > int256 92 | pub fn sgt(self, value: U256BE) -> Self { 93 | if i256::from_be_bytes(self.0) > i256::from_be_bytes(value.0) { 94 | U256BE::from_u8(1) 95 | } else { U256BE([0;32]) } 96 | } 97 | 98 | // SLT operator: int256 < 99 | pub fn slt(self, value: U256BE) -> Self { 100 | if i256::from_be_bytes(self.0) < i256::from_be_bytes(value.0) { 101 | U256BE::from_u8(1) 102 | } else { U256BE([0;32]) } 103 | } 104 | 105 | // SHL operator: int256 << int256 106 | pub fn shl(self, value: U256BE) -> Self { // Limited by u256 methods. Investigte alternative method(s) 107 | let result = u256::from_be_bytes(self.0).overflowing_shl(u32::from_be_bytes(value.0[28..=31].try_into().unwrap())); 108 | if result.1 { return U256BE::zero(); }; 109 | U256BE::from_u256(result.0) 110 | } 111 | 112 | // SHR operator: int256 << int256 113 | pub fn shr(self, value: U256BE) -> Self { // Limited by u256 methods. Investigte alternative method(s) 114 | let result = u256::from_be_bytes(self.0).overflowing_shr(u32::from_be_bytes(value.0[28..=31].try_into().unwrap())); 115 | if result.1 { return U256BE::zero(); }; 116 | U256BE::from_u256(result.0) 117 | } 118 | 119 | // SAR operator: int256 >> int256 120 | pub fn sar(self, value: U256BE) -> Self { // Limited by i256 methods. Investigte alternative method(s) 121 | let result = i256::from_be_bytes(self.0).overflowing_shr(u32::from_be_bytes(value.0[28..=31].try_into().unwrap())); 122 | if result.1 { return U256BE::zero(); }; 123 | U256BE::from_i256(result.0) 124 | } 125 | 126 | // Equivalence operator: self == value 127 | pub fn eq(self, value: U256BE) -> bool { 128 | if self.0 == value.0 { true } 129 | else { false } 130 | } 131 | 132 | // Equivalence operator: self == value, return U256BE 1/0 133 | pub fn uint_eq(self, value: U256BE) -> Self { 134 | if self.0 == value.0 { U256BE::from_u8(1) } 135 | else { U256BE::zero() } 136 | } 137 | 138 | // Returns whether self is equal to [0;32] 139 | pub fn is_zero(self) -> bool { 140 | if self.0 == [0; 32] { true } 141 | else { false } 142 | } 143 | 144 | // Returns whether self is equal to [0;32], return U256BE 1/0 145 | pub fn uint_is_zero(self) -> Self { 146 | if self.0 == [0; 32] { U256BE::from_u8(1) } 147 | else { U256BE::zero() } 148 | } 149 | 150 | // Initialize U256BE from slice 151 | pub fn from_slice(slice: &[u8]) -> Self { 152 | let mut ret: [u8; 32] = [0; 32]; 153 | ret[32 - slice.len()..].clone_from_slice(slice); 154 | U256BE(ret) 155 | } 156 | 157 | // Initialize U256BE from u8 158 | pub fn from_u8(value: u8) -> Self { 159 | let mut ret: [u8; 32] = [0; 32]; 160 | ret[31] = value; 161 | U256BE(ret) 162 | } 163 | 164 | // Initialize U256BE from usize 165 | pub fn from_usize(value: usize) -> Self { 166 | let mut ret: [u8; 32] = [0; 32]; 167 | ret[24..=31].clone_from_slice(&value.to_be_bytes()); 168 | U256BE(ret) 169 | } 170 | 171 | // Initialize U256BE from u256 172 | pub fn from_u256(value: u256) -> Self { 173 | let mut ret: [u8; 32] = [0; 32]; 174 | ret[..].clone_from_slice(&value.to_be_bytes()); 175 | U256BE(ret) 176 | } 177 | 178 | // Initialize U256BE from i256 179 | pub fn from_i256(value: i256) -> Self { 180 | let mut ret: [u8; 32] = [0; 32]; 181 | ret[..].clone_from_slice(&value.to_be_bytes()); 182 | U256BE(ret) 183 | } 184 | 185 | // Return self as zero 186 | pub fn zero() -> Self { 187 | U256BE([0; 32]) 188 | } 189 | } 190 | 191 | #[derive(Clone, Copy)] 192 | // Big endian u160 type 193 | pub struct U160([u8; 20]); 194 | impl U160 { 195 | // Convert self to U256BE 196 | pub fn to_u256_be(self) -> U256BE { 197 | U256BE::from_slice(&self.0) 198 | } 199 | } 200 | -------------------------------------------------------------------------------- /src/lib/execution.rs: -------------------------------------------------------------------------------- 1 | use super::custom_type::U256BE; 2 | use super::memory::Memory; 3 | use super::opcode::*; 4 | use super::stack::Stack; 5 | use super::statuscode::StatusCode; 6 | use super::state::Block; 7 | use sha3::{Digest, Keccak256}; 8 | 9 | // EVM Execution Context 10 | pub struct ExecutionContext { 11 | code: Vec, 12 | stack: Stack, 13 | memory: Memory, 14 | pc: usize, 15 | gas_limit: usize, 16 | stopped: bool, 17 | calldata: Vec, 18 | returndata: Vec, 19 | block: Block 20 | } 21 | impl ExecutionContext { 22 | // Initialize execution context 23 | pub fn init(code: Vec, stack: Stack, memory: Memory, gas_limit: usize) -> Self { 24 | ExecutionContext { 25 | code: code, 26 | stack: stack, 27 | memory: memory, 28 | pc: 0, 29 | gas_limit: gas_limit, 30 | stopped: false, 31 | calldata: Vec::with_capacity(1024), 32 | returndata: Vec::with_capacity(1024), 33 | block: Block::default() 34 | } 35 | } 36 | 37 | // Load 32-byte word from calldata at offset 38 | pub fn calldata_load(&mut self, offset: usize) -> Result, StatusCode> { 39 | let len_original = self.calldata.len(); 40 | if len_original <= offset + 31 { self.calldata.resize(offset + 32, 0); }; 41 | let ret = self.calldata[offset..offset + 32].to_vec(); 42 | self.calldata.truncate(len_original); 43 | Ok(ret) 44 | } 45 | 46 | // Deduct gas from limit 47 | pub fn sub_gas(&mut self, by: usize) -> Result<(), StatusCode> { 48 | if by > self.gas_limit { 49 | return Err(StatusCode::OutOfGas); 50 | }; 51 | self.gas_limit -= by; 52 | Ok(()) 53 | } 54 | 55 | // Halt execution 56 | pub fn stop(&mut self) -> () { 57 | self.stopped = true 58 | } 59 | 60 | // Set program counter to destination 61 | pub fn pc_jump(&mut self, dest: usize) -> Result<(), StatusCode> { 62 | if dest >= self.code.len() { return Err(StatusCode::BadJumpDest); }; 63 | self.pc = dest; 64 | Ok(()) 65 | } 66 | 67 | // Increment program counter by value 68 | pub fn pc_increment(&mut self, val: usize) -> () { 69 | self.pc = self.pc + val 70 | } 71 | 72 | // Push value onto stack then increment program counter by 1 73 | pub fn stack_step_push(&mut self, val: U256BE) -> Result<(), StatusCode> { 74 | self.stack.push(val)?; 75 | self.pc_increment(1); 76 | Ok(()) 77 | } 78 | 79 | // Read code at (program counter + offset) 80 | pub fn read_code(&mut self, offset: usize) -> Result { 81 | if self.pc + offset >= self.code.len() { return Err(StatusCode::Completion); }; 82 | let value = self.code[self.pc + offset]; 83 | Ok(value) 84 | } 85 | 86 | // Begin code execution 87 | pub fn run(&mut self) -> Result<(), StatusCode> { 88 | while !self.stopped { 89 | let opcode: u8 = self.read_code(0)?; 90 | println!( 91 | "[ Opcode: {} | PC: {} | Gas: {} ]", 92 | opcode, self.pc, self.gas_limit 93 | ); 94 | match self.exec(opcode) { 95 | Err(e) => return Err(e), 96 | Ok(_) => (), 97 | }; 98 | self.sub_gas(gas_fetch(opcode))?; 99 | println!( 100 | "Stack: {:?}\nMemory: {:?}", 101 | self.stack.peek_full(), 102 | self.memory.load_full() 103 | ); 104 | } 105 | Ok(()) 106 | } 107 | 108 | // Execute opcode 109 | pub fn exec(&mut self, opcode: u8) -> Result<(), StatusCode> { 110 | // Push n values onto stack 111 | macro_rules! pushn { 112 | ( $n:expr ) => {{ 113 | let slice = &self.code[self.pc + 1..=self.pc + $n]; 114 | let ret = U256BE::from_slice(slice); 115 | self.stack.push(ret)?; 116 | self.pc_increment($n + 1); 117 | Ok(()) 118 | }}; 119 | } 120 | // Duplicate value onto stack at index (len-n) 121 | macro_rules! dupn { 122 | ( $n:expr ) => {{ 123 | let ret = self.stack.peek(self.stack.len() - $n)?; 124 | self.stack_step_push(ret) 125 | }}; 126 | } 127 | // Swap 1st and nth stack items 128 | macro_rules! swapn { 129 | ( $n:expr ) => {{ 130 | let top = self.stack.peek(0)?; 131 | let swp = self.stack.peek($n)?; 132 | self.stack.push_to(0, swp)?; 133 | self.stack.push_to($n, top)?; 134 | self.pc_increment(1); 135 | Ok(()) 136 | }}; 137 | } 138 | // Evaluate: stack[0].$operator(stack[1]) 139 | macro_rules! term_eval { 140 | ( $op:tt ) => {{ 141 | let val1 = self.stack.pop()?.to_u256(); 142 | let val2 = self.stack.pop()?.to_u256(); 143 | let ret = val1.$op(val2).0; 144 | self.stack_step_push(U256BE::from_u256(ret)) 145 | }}; 146 | } 147 | // Evaluate: i256.$operator(i256) 148 | macro_rules! signed_term_eval { 149 | ( $op:tt ) => {{ 150 | let val1 = self.stack.pop()?.to_i256(); 151 | let val2 = self.stack.pop()?.to_i256(); 152 | let ret = val1.$op(val2).0; 153 | self.stack_step_push(U256BE::from_i256(ret)) 154 | }}; 155 | } 156 | // Evaluate: stack[0].$operator1(stack[1]).$operator2(stack[2]) 157 | macro_rules! mod_term_eval { 158 | ( $op1:tt ) => {{ 159 | let val1 = self.stack.pop()?.to_u256(); 160 | let val2 = self.stack.pop()?.to_u256(); 161 | let val3 = self.stack.pop()?.to_u256(); 162 | let ret = val1.$op1(val2).0.overflowing_rem(val3).0; 163 | self.stack_step_push(U256BE::from_u256(ret)) 164 | }}; 165 | } 166 | match opcode { 167 | PUSH1 => pushn!(1), 168 | PUSH2 => pushn!(2), 169 | PUSH3 => pushn!(3), 170 | PUSH4 => pushn!(4), 171 | PUSH5 => pushn!(5), 172 | PUSH6 => pushn!(6), 173 | PUSH7 => pushn!(7), 174 | PUSH8 => pushn!(8), 175 | PUSH9 => pushn!(9), 176 | PUSH10 => pushn!(10), 177 | PUSH11 => pushn!(11), 178 | PUSH12 => pushn!(12), 179 | PUSH13 => pushn!(13), 180 | PUSH14 => pushn!(14), 181 | PUSH15 => pushn!(15), 182 | PUSH16 => pushn!(16), 183 | POP => { self.stack.pop()?; self.pc_increment(1); Ok(()) }, 184 | DUP1 => dupn!(1), 185 | DUP2 => dupn!(2), 186 | DUP3 => dupn!(3), 187 | DUP4 => dupn!(4), 188 | DUP5 => dupn!(5), 189 | DUP6 => dupn!(6), 190 | DUP7 => dupn!(7), 191 | DUP8 => dupn!(8), 192 | DUP9 => dupn!(9), 193 | DUP10 => dupn!(10), 194 | DUP11 => dupn!(11), 195 | DUP12 => dupn!(12), 196 | DUP13 => dupn!(13), 197 | DUP14 => dupn!(14), 198 | DUP15 => dupn!(15), 199 | DUP16 => dupn!(16), 200 | SWAP1 => swapn!(1), 201 | SWAP2 => swapn!(2), 202 | SWAP3 => swapn!(3), 203 | SWAP4 => swapn!(4), 204 | SWAP5 => swapn!(5), 205 | SWAP6 => swapn!(6), 206 | SWAP7 => swapn!(7), 207 | SWAP8 => swapn!(8), 208 | SWAP9 => swapn!(9), 209 | SWAP10 => swapn!(10), 210 | SWAP11 => swapn!(11), 211 | SWAP12 => swapn!(12), 212 | SWAP13 => swapn!(13), 213 | SWAP14 => swapn!(14), 214 | SWAP15 => swapn!(15), 215 | SWAP16 => swapn!(16), 216 | MUL => term_eval!(overflowing_mul), 217 | ADD => term_eval!(overflowing_add), 218 | SUB => term_eval!(overflowing_sub), 219 | DIV => term_eval!(overflowing_div), 220 | MOD => term_eval!(overflowing_rem), 221 | EXP => { 222 | let val1 = self.stack.pop()?.to_u256(); 223 | let val2 = self.stack.pop()?.to_u32(); 224 | self.stack_step_push(U256BE::from_u256(val1.overflowing_pow(val2).0)) 225 | }, 226 | SDIV => signed_term_eval!(overflowing_div), 227 | SMOD => signed_term_eval!(overflowing_rem), 228 | ADDMOD => mod_term_eval!(overflowing_add), 229 | MULMOD => mod_term_eval!(overflowing_mul), 230 | GT => { 231 | let val1 = self.stack.pop()?; 232 | let val2 = self.stack.pop()?; 233 | self.stack_step_push(val1.gt(val2)) 234 | }, 235 | SGT => { 236 | let val1 = self.stack.pop()?; 237 | let val2 = self.stack.pop()?; 238 | self.stack_step_push(val1.sgt(val2)) 239 | }, 240 | LT => { 241 | let val1 = self.stack.pop()?; 242 | let val2 = self.stack.pop()?; 243 | self.stack_step_push(val1.lt(val2)) 244 | }, 245 | SLT => { 246 | let val1 = self.stack.pop()?; 247 | let val2 = self.stack.pop()?; 248 | self.stack_step_push(val1.slt(val2)) 249 | }, 250 | SHL => { 251 | let val1 = self.stack.pop()?; 252 | let val2 = self.stack.pop()?; 253 | self.stack_step_push(val1.shl(val2)) 254 | }, 255 | SHR => { 256 | let val1 = self.stack.pop()?; 257 | let val2 = self.stack.pop()?; 258 | self.stack_step_push(val1.shr(val2)) 259 | }, 260 | SAR => { 261 | let val1 = self.stack.pop()?; 262 | let val2 = self.stack.pop()?; 263 | self.stack_step_push(val1.sar(val2)) 264 | }, 265 | EQ => { 266 | let val1 = self.stack.pop()?; 267 | let val2 = self.stack.pop()?; 268 | self.stack_step_push(val1.uint_eq(val2)) 269 | }, 270 | ISZERO => { 271 | let val = self.stack.pop()?; 272 | self.stack_step_push(val.uint_is_zero()) 273 | }, 274 | AND => { 275 | let val1 = self.stack.pop()?; 276 | let val2 = self.stack.pop()?; 277 | self.stack_step_push(val1.and(val2)) 278 | }, 279 | OR => { 280 | let val1 = self.stack.pop()?; 281 | let val2 = self.stack.pop()?; 282 | self.stack_step_push(val1.or(val2)) 283 | }, 284 | XOR => { 285 | let val1 = self.stack.pop()?; 286 | let val2 = self.stack.pop()?; 287 | self.stack_step_push(val1.xor(val2)) 288 | }, 289 | NOT => { 290 | let val = self.stack.pop()?; 291 | self.stack_step_push(val.not()) 292 | }, 293 | BYTE => { 294 | let nth = self.stack.pop()?.to_usize(); 295 | let val = self.stack.pop()?.as_slice(); 296 | if nth >= val.len() { return self.stack_step_push(U256BE::zero()); }; 297 | self.stack_step_push(U256BE::from_u8(val[nth])) 298 | }, 299 | MLOAD => { 300 | let offset = self.stack.pop()?.to_usize(); 301 | let loaded = self.memory.load(offset)?; 302 | self.stack_step_push(U256BE::from_slice(loaded.as_slice())) 303 | }, 304 | MSTORE => { 305 | let offset = self.stack.pop()?.to_usize(); 306 | let value = self.stack.pop()?; 307 | self.memory.store(offset, value)?; 308 | self.pc_increment(1); 309 | Ok(()) 310 | }, 311 | MSTORE8 => { 312 | let offset = self.stack.pop()?.to_usize(); 313 | let value = self.stack.pop()?; 314 | self.memory.store(offset, value.and(U256BE::from_u8(0xFFu8)))?; 315 | self.pc_increment(1); 316 | Ok(()) 317 | }, 318 | SHA3 => { 319 | let offset = self.stack.pop()?.to_usize(); 320 | let length = self.stack.pop()?.to_usize(); 321 | let value = self.memory.load_range(offset, length)?; 322 | let mut hasher = Keccak256::default(); 323 | hasher.update(value.as_slice()); 324 | let ret = U256BE::from_slice(hasher.finalize().to_vec().as_slice()); 325 | self.stack_step_push(ret) 326 | }, 327 | MSIZE => { 328 | let memlen = self.memory.len(); 329 | self.stack_step_push(U256BE::from_usize(memlen)) 330 | }, 331 | CALLDATALOAD => { 332 | let offset = self.stack.pop()?.to_usize(); 333 | let loaded = self.calldata_load(offset)?; 334 | self.stack_step_push(U256BE::from_slice(loaded.as_slice())) 335 | }, 336 | CALLDATASIZE => { 337 | self.stack_step_push(U256BE::from_usize(self.calldata.len())) 338 | }, 339 | JUMPDEST => { 340 | let dest = self.stack.pop()?.to_usize(); 341 | if dest >= self.code.len() { return Err(StatusCode::BadJumpDest); }; 342 | self.pc_increment(1); 343 | Ok(()) 344 | }, 345 | JUMPI => { 346 | let dest = self.stack.pop()?; 347 | let cond = self.stack.pop()?; 348 | if cond.is_zero() { self.pc_increment(1); Ok(()) } 349 | else { self.pc_jump(dest.to_usize()) } 350 | }, 351 | JUMP => { let dest = self.stack.pop()?; self.pc_jump(dest.to_usize()) }, 352 | PC => self.stack_step_push(U256BE::from_usize(self.pc)), 353 | GAS => self.stack_step_push(U256BE::from_usize(self.gas_limit)), 354 | GASLIMIT => self.stack_step_push(U256BE::from_usize(self.block.gaslimit)), 355 | BASEFEE => self.stack_step_push(U256BE::from_usize(self.block.basegas)), 356 | COINBASE => self.stack_step_push(self.block.coinbase.to_u256_be()), 357 | TIMESTAMP => self.stack_step_push(self.block.timestamp), 358 | NUMBER => self.stack_step_push(U256BE::from_usize(self.block.blocknumber)), 359 | DIFFICULTY => self.stack_step_push(U256BE::from_usize(self.block.difficulty)), 360 | STOP => { self.stop(); Err(StatusCode::Completion) }, 361 | RETURN => { 362 | let offset = self.stack.pop()?.to_usize(); 363 | let length = self.stack.pop()?.to_usize(); 364 | self.returndata = self.memory.load_range(offset, length)?; 365 | self.stop(); 366 | println!("Return Data: {:?}", self.returndata); 367 | Err(StatusCode::Completion) 368 | }, 369 | _ => Err(StatusCode::UndefinedInstruction), 370 | } 371 | } 372 | } 373 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.]https://github.com/03ladr/revm/community/license/new?branch=main 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | --------------------------------------------------------------------------------