2015-04-24 15:35:16 +00:00
|
|
|
/*
|
2016-11-18 23:13:20 +00:00
|
|
|
This file is part of solidity.
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is free software: you can redistribute it and/or modify
|
2015-04-24 15:35:16 +00:00
|
|
|
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.
|
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is distributed in the hope that it will be useful,
|
2015-04-24 15:35:16 +00:00
|
|
|
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
|
2016-11-18 23:13:20 +00:00
|
|
|
along with solidity. If not, see <http://www.gnu.org/licenses/>.
|
2015-04-24 15:35:16 +00:00
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2016-11-24 11:17:29 +00:00
|
|
|
/** @file AssemblyItem.h
|
2015-04-24 15:35:16 +00:00
|
|
|
* @author Gav Wood <i@gavwood.com>
|
|
|
|
* @date 2014
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2016-04-01 20:11:01 +00:00
|
|
|
#include <libevmasm/Instruction.h>
|
2019-03-28 11:47:21 +00:00
|
|
|
#include <libevmasm/Exceptions.h>
|
2018-11-14 13:59:30 +00:00
|
|
|
#include <liblangutil/SourceLocation.h>
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/Common.h>
|
2022-03-02 12:47:04 +00:00
|
|
|
#include <libsolutil/Numeric.h>
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/Assertions.h>
|
2021-09-22 13:14:31 +00:00
|
|
|
#include <optional>
|
2019-03-28 11:47:21 +00:00
|
|
|
#include <iostream>
|
|
|
|
#include <sstream>
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
namespace solidity::evmasm
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
|
|
|
|
2021-03-17 18:37:39 +00:00
|
|
|
enum AssemblyItemType
|
|
|
|
{
|
2015-09-10 10:02:18 +00:00
|
|
|
UndefinedItem,
|
|
|
|
Operation,
|
|
|
|
Push,
|
|
|
|
PushTag,
|
|
|
|
PushSub,
|
|
|
|
PushSubSize,
|
|
|
|
PushProgramSize,
|
|
|
|
Tag,
|
|
|
|
PushData,
|
2017-11-14 11:58:04 +00:00
|
|
|
PushLibraryAddress, ///< Push a currently unknown address of another (library) contract.
|
2020-03-10 13:30:04 +00:00
|
|
|
PushDeployTimeAddress, ///< Push an address to be filled at deploy time. Should not be touched by the optimizer.
|
|
|
|
PushImmutable, ///< Push the currently unknown value of an immutable variable. The actual value will be filled in by the constructor.
|
2021-03-17 18:37:39 +00:00
|
|
|
AssignImmutable, ///< Assigns the current value on the stack to an immutable variable. Only valid during creation code.
|
|
|
|
VerbatimBytecode ///< Contains data that is inserted into the bytecode code section without modification.
|
2015-09-10 10:02:18 +00:00
|
|
|
};
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2021-09-22 13:14:31 +00:00
|
|
|
enum class Precision { Precise , Approximate };
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
class Assembly;
|
2020-02-24 17:11:20 +00:00
|
|
|
class AssemblyItem;
|
|
|
|
using AssemblyItems = std::vector<AssemblyItem>;
|
2015-04-24 15:35:16 +00:00
|
|
|
|
|
|
|
class AssemblyItem
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
enum class JumpType { Ordinary, IntoFunction, OutOfFunction };
|
|
|
|
|
2018-12-18 12:09:31 +00:00
|
|
|
AssemblyItem(u256 _push, langutil::SourceLocation _location = langutil::SourceLocation()):
|
|
|
|
AssemblyItem(Push, std::move(_push), std::move(_location)) { }
|
2019-03-28 11:47:21 +00:00
|
|
|
AssemblyItem(Instruction _i, langutil::SourceLocation _location = langutil::SourceLocation()):
|
2017-01-06 10:33:08 +00:00
|
|
|
m_type(Operation),
|
|
|
|
m_instruction(_i),
|
2018-12-18 12:09:31 +00:00
|
|
|
m_location(std::move(_location))
|
2017-01-06 10:33:08 +00:00
|
|
|
{}
|
2018-12-18 12:09:31 +00:00
|
|
|
AssemblyItem(AssemblyItemType _type, u256 _data = 0, langutil::SourceLocation _location = langutil::SourceLocation()):
|
2015-04-24 15:35:16 +00:00
|
|
|
m_type(_type),
|
2018-12-18 12:09:31 +00:00
|
|
|
m_location(std::move(_location))
|
2015-04-24 15:35:16 +00:00
|
|
|
{
|
2017-01-06 10:33:08 +00:00
|
|
|
if (m_type == Operation)
|
2018-11-07 11:04:46 +00:00
|
|
|
m_instruction = Instruction(uint8_t(_data));
|
2017-01-06 10:33:08 +00:00
|
|
|
else
|
2018-12-18 12:09:31 +00:00
|
|
|
m_data = std::make_shared<u256>(std::move(_data));
|
2015-04-24 15:35:16 +00:00
|
|
|
}
|
2021-04-20 11:20:26 +00:00
|
|
|
explicit AssemblyItem(bytes _verbatimData, size_t _arguments, size_t _returnVariables):
|
2021-03-17 18:37:39 +00:00
|
|
|
m_type(VerbatimBytecode),
|
|
|
|
m_instruction{},
|
2021-04-20 11:20:26 +00:00
|
|
|
m_verbatimBytecode{{_arguments, _returnVariables, std::move(_verbatimData)}}
|
2021-03-17 18:37:39 +00:00
|
|
|
{}
|
|
|
|
|
2018-12-18 12:09:31 +00:00
|
|
|
AssemblyItem(AssemblyItem const&) = default;
|
|
|
|
AssemblyItem(AssemblyItem&&) = default;
|
|
|
|
AssemblyItem& operator=(AssemblyItem const&) = default;
|
|
|
|
AssemblyItem& operator=(AssemblyItem&&) = default;
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
AssemblyItem tag() const { assertThrow(m_type == PushTag || m_type == Tag, util::Exception, ""); return AssemblyItem(Tag, data()); }
|
|
|
|
AssemblyItem pushTag() const { assertThrow(m_type == PushTag || m_type == Tag, util::Exception, ""); return AssemblyItem(PushTag, data()); }
|
2016-11-10 17:16:21 +00:00
|
|
|
/// Converts the tag to a subassembly tag. This has to be called in order to move a tag across assemblies.
|
|
|
|
/// @param _subId the identifier of the subassembly the tag is taken from.
|
|
|
|
AssemblyItem toSubAssemblyTag(size_t _subId) const;
|
|
|
|
/// @returns splits the data of the push tag into sub assembly id and actual tag id.
|
|
|
|
/// The sub assembly id of non-foreign push tags is -1.
|
|
|
|
std::pair<size_t, size_t> splitForeignPushTag() const;
|
|
|
|
/// Sets sub-assembly part and tag for a push tag.
|
|
|
|
void setPushTagSubIdAndTag(size_t _subId, size_t _tag);
|
2015-04-24 15:35:16 +00:00
|
|
|
|
|
|
|
AssemblyItemType type() const { return m_type; }
|
2019-12-11 16:31:36 +00:00
|
|
|
u256 const& data() const { assertThrow(m_type != Operation, util::Exception, ""); return *m_data; }
|
|
|
|
void setData(u256 const& _data) { assertThrow(m_type != Operation, util::Exception, ""); m_data = std::make_shared<u256>(_data); }
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2022-03-15 20:25:51 +00:00
|
|
|
/// This function is used in `Assembly::assemblyJSON`.
|
|
|
|
/// It returns the name & data of the current assembly item.
|
2022-11-23 10:51:34 +00:00
|
|
|
/// @param _evmVersion the EVM version.
|
2022-03-15 20:25:51 +00:00
|
|
|
/// @returns a pair, where the first element is the json-assembly
|
|
|
|
/// item name, where second element is the string representation
|
|
|
|
/// of it's data.
|
2022-11-23 10:51:34 +00:00
|
|
|
std::pair<std::string, std::string> nameAndData(langutil::EVMVersion _evmVersion) const;
|
2022-03-15 20:25:51 +00:00
|
|
|
|
2021-04-20 11:20:26 +00:00
|
|
|
bytes const& verbatimData() const { assertThrow(m_type == VerbatimBytecode, util::Exception, ""); return std::get<2>(*m_verbatimBytecode); }
|
2021-03-17 18:37:39 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
/// @returns the instruction of this item (only valid if type() == Operation)
|
2019-12-11 16:31:36 +00:00
|
|
|
Instruction instruction() const { assertThrow(m_type == Operation, util::Exception, ""); return m_instruction; }
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2015-05-15 10:23:13 +00:00
|
|
|
/// @returns true if the type and data of the items are equal.
|
2017-01-06 10:33:08 +00:00
|
|
|
bool operator==(AssemblyItem const& _other) const
|
|
|
|
{
|
|
|
|
if (type() != _other.type())
|
|
|
|
return false;
|
|
|
|
if (type() == Operation)
|
|
|
|
return instruction() == _other.instruction();
|
2021-03-17 18:37:39 +00:00
|
|
|
else if (type() == VerbatimBytecode)
|
|
|
|
return *m_verbatimBytecode == *_other.m_verbatimBytecode;
|
2017-01-06 10:33:08 +00:00
|
|
|
else
|
|
|
|
return data() == _other.data();
|
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
bool operator!=(AssemblyItem const& _other) const { return !operator==(_other); }
|
2015-05-12 14:16:44 +00:00
|
|
|
/// Less-than operator compatible with operator==.
|
2017-01-06 10:33:08 +00:00
|
|
|
bool operator<(AssemblyItem const& _other) const
|
|
|
|
{
|
|
|
|
if (type() != _other.type())
|
|
|
|
return type() < _other.type();
|
|
|
|
else if (type() == Operation)
|
|
|
|
return instruction() < _other.instruction();
|
2021-03-17 18:37:39 +00:00
|
|
|
else if (type() == VerbatimBytecode)
|
|
|
|
return *m_verbatimBytecode == *_other.m_verbatimBytecode;
|
2017-01-06 10:33:08 +00:00
|
|
|
else
|
|
|
|
return data() < _other.data();
|
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2018-12-18 12:14:12 +00:00
|
|
|
/// Shortcut that avoids constructing an AssemblyItem just to perform the comparison.
|
|
|
|
bool operator==(Instruction _instr) const
|
|
|
|
{
|
|
|
|
return type() == Operation && instruction() == _instr;
|
|
|
|
}
|
|
|
|
bool operator!=(Instruction _instr) const { return !operator==(_instr); }
|
|
|
|
|
2020-02-24 17:11:20 +00:00
|
|
|
static std::string computeSourceMapping(
|
|
|
|
AssemblyItems const& _items,
|
|
|
|
std::map<std::string, unsigned> const& _sourceIndicesMap
|
|
|
|
);
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
/// @returns an upper bound for the number of bytes required by this item, assuming that
|
|
|
|
/// the value of a jump tag takes @a _addressLength bytes.
|
2023-06-19 03:56:04 +00:00
|
|
|
/// @param _evmVersion the EVM version
|
2021-09-22 13:14:31 +00:00
|
|
|
/// @param _precision Whether to return a precise count (which involves
|
|
|
|
/// counting immutable references which are only set after
|
|
|
|
/// a call to `assemble()`) or an approx. count.
|
2023-06-19 03:56:04 +00:00
|
|
|
size_t bytesRequired(size_t _addressLength, langutil::EVMVersion _evmVersion, Precision _precision = Precision::Precise) const;
|
2020-06-02 13:10:14 +00:00
|
|
|
size_t arguments() const;
|
|
|
|
size_t returnValues() const;
|
2021-04-20 11:20:26 +00:00
|
|
|
size_t deposit() const { return returnValues() - arguments(); }
|
2015-04-24 15:35:16 +00:00
|
|
|
|
2016-11-15 13:01:11 +00:00
|
|
|
/// @returns true if the assembly item can be used in a functional context.
|
|
|
|
bool canBeFunctional() const;
|
|
|
|
|
2018-11-14 16:11:55 +00:00
|
|
|
void setLocation(langutil::SourceLocation const& _location) { m_location = _location; }
|
|
|
|
langutil::SourceLocation const& location() const { return m_location; }
|
2015-04-24 15:35:16 +00:00
|
|
|
|
|
|
|
void setJumpType(JumpType _jumpType) { m_jumpType = _jumpType; }
|
|
|
|
JumpType getJumpType() const { return m_jumpType; }
|
|
|
|
std::string getJumpTypeAsString() const;
|
|
|
|
|
2015-05-19 22:27:07 +00:00
|
|
|
void setPushedValue(u256 const& _value) const { m_pushedValue = std::make_shared<u256>(_value); }
|
|
|
|
u256 const* pushedValue() const { return m_pushedValue.get(); }
|
|
|
|
|
2020-06-17 09:17:35 +00:00
|
|
|
std::string toAssemblyText(Assembly const& _assembly) const;
|
2016-11-15 13:01:11 +00:00
|
|
|
|
2019-10-08 09:00:40 +00:00
|
|
|
size_t m_modifierDepth = 0;
|
|
|
|
|
2021-09-22 13:14:31 +00:00
|
|
|
void setImmutableOccurrences(size_t _n) const { m_immutableOccurrences = _n; }
|
2020-03-10 13:30:04 +00:00
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
private:
|
2021-09-22 13:14:31 +00:00
|
|
|
size_t opcodeCount() const noexcept;
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
AssemblyItemType m_type;
|
2017-01-06 10:33:08 +00:00
|
|
|
Instruction m_instruction; ///< Only valid if m_type == Operation
|
|
|
|
std::shared_ptr<u256> m_data; ///< Only valid if m_type != Operation
|
2021-04-20 11:20:26 +00:00
|
|
|
/// If m_type == VerbatimBytecode, this holds number of arguments, number of
|
|
|
|
/// return variables and verbatim bytecode.
|
|
|
|
std::optional<std::tuple<size_t, size_t, bytes>> m_verbatimBytecode;
|
2018-11-14 16:11:55 +00:00
|
|
|
langutil::SourceLocation m_location;
|
2015-04-24 15:35:16 +00:00
|
|
|
JumpType m_jumpType = JumpType::Ordinary;
|
2015-05-19 22:27:07 +00:00
|
|
|
/// Pushed value for operations with data to be determined during assembly stage,
|
|
|
|
/// e.g. PushSubSize, PushTag, PushSub, etc.
|
|
|
|
mutable std::shared_ptr<u256> m_pushedValue;
|
2020-03-10 13:30:04 +00:00
|
|
|
/// Number of PushImmutable's with the same hash. Only used for AssignImmutable.
|
2021-09-22 13:14:31 +00:00
|
|
|
mutable std::optional<size_t> m_immutableOccurrences;
|
2015-04-24 15:35:16 +00:00
|
|
|
};
|
|
|
|
|
2023-06-19 03:56:04 +00:00
|
|
|
inline size_t bytesRequired(AssemblyItems const& _items, size_t _addressLength, langutil::EVMVersion _evmVersion, Precision _precision = Precision::Precise)
|
2017-06-14 17:40:53 +00:00
|
|
|
{
|
|
|
|
size_t size = 0;
|
|
|
|
for (AssemblyItem const& item: _items)
|
2023-06-19 03:56:04 +00:00
|
|
|
size += item.bytesRequired(_addressLength, _evmVersion, _precision);
|
2017-06-14 17:40:53 +00:00
|
|
|
return size;
|
|
|
|
}
|
|
|
|
|
2015-04-24 15:35:16 +00:00
|
|
|
std::ostream& operator<<(std::ostream& _out, AssemblyItem const& _item);
|
2015-06-16 14:08:40 +00:00
|
|
|
inline std::ostream& operator<<(std::ostream& _out, AssemblyItems const& _items)
|
|
|
|
{
|
|
|
|
for (AssemblyItem const& item: _items)
|
|
|
|
_out << item;
|
|
|
|
return _out;
|
|
|
|
}
|
2015-04-24 15:35:16 +00:00
|
|
|
|
|
|
|
}
|