solidity/test/tools/yulInterpreter/EVMInstructionInterpreter.h

102 lines
3.4 KiB
C
Raw Normal View History

2018-02-06 09:57:16 +00:00
/*
This file is part of solidity.
solidity 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.
solidity 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 solidity. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Yul interpreter module that evaluates EVM instructions.
*/
#pragma once
#include <libyul/AsmDataForward.h>
#include <libdevcore/CommonData.h>
#include <vector>
namespace dev
{
namespace eth
2018-02-06 09:57:16 +00:00
{
enum class Instruction: uint8_t;
}
}
namespace yul
{
class YulString;
2019-05-20 12:30:32 +00:00
struct BuiltinFunctionForEVM;
2018-02-06 09:57:16 +00:00
namespace test
{
struct InterpreterState;
/**
* Interprets EVM instructions based on the current state and logs instructions with
* side-effects.
*
2019-02-18 14:16:14 +00:00
* Since this is mainly meant to be used for differential fuzz testing, it is focused
* on a single contract only, does not do any gas counting and differs from the correct
* implementation in many ways:
2018-02-06 09:57:16 +00:00
*
* - If memory access to a "large" memory position is performed, a deterministic
2019-02-18 14:16:14 +00:00
* value is returned. Data that is stored in a "large" memory position is not
* retained.
2018-02-06 09:57:16 +00:00
* - The blockhash instruction returns a fixed value if the argument is in range.
* - Extcodesize returns a deterministic value depending on the address.
* - Extcodecopy copies a deterministic value depending on the address.
* - And many other things
*
2019-02-18 14:16:14 +00:00
* The main focus is that the generated execution trace is the same for equivalent executions
2019-02-25 10:46:53 +00:00
* and likely to be different for non-equivalent executions.
2018-02-06 09:57:16 +00:00
*/
class EVMInstructionInterpreter
{
public:
explicit EVMInstructionInterpreter(InterpreterState& _state):
m_state(_state)
{}
/// Evaluate instruction
dev::u256 eval(dev::eth::Instruction _instruction, std::vector<dev::u256> const& _arguments);
/// Evaluate builtin function
2019-05-20 12:30:32 +00:00
dev::u256 evalBuiltin(BuiltinFunctionForEVM const& _fun, std::vector<dev::u256> const& _arguments);
2018-02-06 09:57:16 +00:00
private:
/// Checks if the memory access is not too large for the interpreter and adjusts
/// msize accordingly.
/// @returns false if the amount of bytes read is lager than 0xffff
2019-05-23 09:35:12 +00:00
bool accessMemory(dev::u256 const& _offset, dev::u256 const& _size = 32);
/// @returns the memory contents at the provided address.
/// Does not adjust msize, use @a accessMemory for that
dev::bytes readMemory(dev::u256 const& _offset, dev::u256 const& _size = 32);
/// @returns the memory contents at the provided address.
/// Does not adjust msize, use @a accessMemory for that
dev::u256 readMemoryWord(dev::u256 const& _offset);
/// @returns writes a word to memory
/// Does not adjust msize, use @a accessMemory for that
void writeMemoryWord(dev::u256 const& _offset, dev::u256 const& _value);
2018-02-06 09:57:16 +00:00
void logTrace(dev::eth::Instruction _instruction, std::vector<dev::u256> const& _arguments = {}, dev::bytes const& _data = {});
2018-02-06 09:57:16 +00:00
/// Appends a log to the trace representing an instruction or similar operation by string,
/// with arguments and auxiliary data (if nonempty).
void logTrace(std::string const& _pseudoInstruction, std::vector<dev::u256> const& _arguments = {}, dev::bytes const& _data = {});
InterpreterState& m_state;
};
}
}