mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
113 lines
3.8 KiB
C++
113 lines
3.8 KiB
C++
/*
|
|
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 dialects for EVM.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <libyul/Dialect.h>
|
|
|
|
#include <libyul/backends/evm/AbstractAssembly.h>
|
|
#include <liblangutil/EVMVersion.h>
|
|
|
|
#include <map>
|
|
|
|
namespace solidity::yul
|
|
{
|
|
|
|
class YulString;
|
|
using Type = YulString;
|
|
struct FunctionCall;
|
|
struct Object;
|
|
|
|
/**
|
|
* Context used during code generation.
|
|
*/
|
|
struct BuiltinContext
|
|
{
|
|
Object const* currentObject = nullptr;
|
|
/// Mapping from named objects to abstract assembly sub IDs.
|
|
std::map<YulString, AbstractAssembly::SubID> subIDs;
|
|
};
|
|
|
|
struct BuiltinFunctionForEVM: BuiltinFunction
|
|
{
|
|
std::optional<evmasm::Instruction> instruction;
|
|
/// Function to generate code for the given function call and append it to the abstract
|
|
/// assembly. The fourth parameter is called to visit (and generate code for) the arguments
|
|
/// from right to left.
|
|
std::function<void(FunctionCall const&, AbstractAssembly&, BuiltinContext&, std::function<void()>)> generateCode;
|
|
};
|
|
|
|
|
|
/**
|
|
* Yul dialect for EVM as a backend.
|
|
* The main difference is that the builtin functions take an AbstractAssembly for the
|
|
* code generation.
|
|
*/
|
|
struct EVMDialect: public Dialect
|
|
{
|
|
/// Constructor, should only be used internally. Use the factory functions below.
|
|
EVMDialect(langutil::EVMVersion _evmVersion, bool _objectAccess);
|
|
|
|
/// @returns the builtin function of the given name or a nullptr if it is not a builtin function.
|
|
BuiltinFunctionForEVM const* builtin(YulString _name) const override;
|
|
|
|
BuiltinFunctionForEVM const* discardFunction(YulString /*_type*/) const override { return builtin("pop"_yulstring); }
|
|
BuiltinFunctionForEVM const* equalityFunction(YulString /*_type*/) const override { return builtin("eq"_yulstring); }
|
|
BuiltinFunctionForEVM const* booleanNegationFunction() const override { return builtin("iszero"_yulstring); }
|
|
|
|
static EVMDialect const& strictAssemblyForEVM(langutil::EVMVersion _version);
|
|
static EVMDialect const& strictAssemblyForEVMObjects(langutil::EVMVersion _version);
|
|
|
|
langutil::EVMVersion evmVersion() const { return m_evmVersion; }
|
|
|
|
bool providesObjectAccess() const { return m_objectAccess; }
|
|
|
|
static SideEffects sideEffectsOfInstruction(evmasm::Instruction _instruction);
|
|
|
|
protected:
|
|
bool const m_objectAccess;
|
|
langutil::EVMVersion const m_evmVersion;
|
|
std::map<YulString, BuiltinFunctionForEVM> m_functions;
|
|
};
|
|
|
|
/**
|
|
* EVM dialect with types u256 (default) and bool.
|
|
* Difference to EVMDialect:
|
|
* - All comparison functions return type bool
|
|
* - bitwise operations are called bitor, bitand, bitxor and bitnot
|
|
* - and, or, xor take bool and return bool
|
|
* - iszero is replaced by not, which takes bool and returns bool
|
|
* - there are conversion functions bool_to_u256 and u256_to_bool.
|
|
* - there is popbool
|
|
*/
|
|
struct EVMDialectTyped: public EVMDialect
|
|
{
|
|
/// Constructor, should only be used internally. Use the factory function below.
|
|
EVMDialectTyped(langutil::EVMVersion _evmVersion, bool _objectAccess);
|
|
|
|
BuiltinFunctionForEVM const* discardFunction(YulString _type) const override;
|
|
BuiltinFunctionForEVM const* equalityFunction(YulString _type) const override;
|
|
BuiltinFunctionForEVM const* booleanNegationFunction() const override { return builtin("not"_yulstring); }
|
|
|
|
static EVMDialectTyped const& instance(langutil::EVMVersion _version);
|
|
};
|
|
|
|
}
|