AssemblyItem.cpp

/*
	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/>.
*/
// SPDX-License-Identifier: GPL-3.0

#include <libevmasm/AssemblyItem.h>

#include <libevmasm/Assembly.h>
#include <libevmasm/SemanticInformation.h>

#include <libsolutil/CommonData.h>
#include <libsolutil/CommonIO.h>
#include <libsolutil/Numeric.h>
#include <libsolutil/StringUtils.h>
#include <libsolutil/FixedHash.h>
#include <liblangutil/SourceLocation.h>

#include <fstream>
#include <limits>

using namespace std::literals;
using namespace solidity;
using namespace solidity::evmasm;
using namespace solidity::langutil;

static_assert(sizeof(size_t) <= 8, "size_t must be at most 64-bits wide");

namespace
{

std::string toStringInHex(u256 _value)
{
	std::stringstream hexStr;
	hexStr << std::uppercase << std::hex << _value;
	return hexStr.str();
}

}

AssemblyItem AssemblyItem::toSubAssemblyTag(SubAssemblyID _subId) const
{
	assertThrow(data() < (u256(1) << 64), util::Exception, "Tag already has subassembly set.");
	assertThrow(m_type == PushTag || m_type == Tag, util::Exception, "");
	auto tag = static_cast<size_t>(u256(data()) & 0xffffffffffffffffULL);
	AssemblyItem r = *this;
	r.m_type = PushTag;
	r.setPushTagSubIdAndTag(_subId, tag);
	return r;
}

std::pair<SubAssemblyID, size_t> AssemblyItem::splitForeignPushTag() const
{
	solAssert(m_type == PushTag || m_type == Tag || m_type == RelativeJump || m_type == ConditionalRelativeJump);
	u256 combined = u256(data());
	// the combined u256 is 'dirty', so we can't use the conversion constructor of SubAssemblyID here
	SubAssemblyID subID {static_cast<SubAssemblyID::value_type>((combined >> 64) - 1)};
	size_t tag = static_cast<size_t>(combined & 0xffffffffffffffffULL);
	return std::make_pair(subID, tag);
}

size_t AssemblyItem::relativeJumpTagID() const
{
	solAssert(m_type == RelativeJump || m_type == ConditionalRelativeJump);
	auto const [subId, tagId] = splitForeignPushTag();
	solAssert(subId.empty(), "Relative jump to sub");
	return tagId;
}

std::pair<std::string, std::string> AssemblyItem::nameAndData(langutil::EVMVersion _evmVersion) const
{
	switch (type())
	{
	case Operation:
	case EOFCreate:
	case ReturnContract:
	case RelativeJump:
	case ConditionalRelativeJump:
	case CallF:
	case JumpF:
	case RetF:
		return {instructionInfo(instruction(), _evmVersion).name, ""};
	case SwapN:
	case DupN:
		return {instructionInfo(instruction(), _evmVersion).name, util::toString(static_cast<size_t>(data())) };
	case Push:
		return {"PUSH", toStringInHex(data())};
	case PushTag:
		if (data() == 0)
			return {"PUSH [ErrorTag]", ""};
		else
			return {"PUSH [tag]", util::toString(data())};
	case PushSub:
		return {"PUSH [$]", toString(util::h256(data()))};
	case PushSubSize:
		return {"PUSH #[$]", toString(util::h256(data()))};
	case PushProgramSize:
		return {"PUSHSIZE", ""};
	case PushLibraryAddress:
		return {"PUSHLIB", toString(util::h256(data()))};
	case PushDeployTimeAddress:
		return {"PUSHDEPLOYADDRESS", ""};
	case PushImmutable:
		return {"PUSHIMMUTABLE", toString(util::h256(data()))};
	case AssignImmutable:
		return {"ASSIGNIMMUTABLE", toString(util::h256(data()))};
	case Tag:
		return {"tag", util::toString(data())};
	case PushData:
		return {"PUSH data", toStringInHex(data())};
	case VerbatimBytecode:
		return {"VERBATIM", util::toHex(verbatimData())};
	case AuxDataLoadN:
		return {"AUXDATALOADN", util::toString(data())};
	case UndefinedItem:
		solAssert(false);
	}

	util::unreachable();
}

void AssemblyItem::setPushTagSubIdAndTag(SubAssemblyID _subId, size_t _tag)
{
	solAssert(m_type == PushTag || m_type == Tag || m_type == RelativeJump || m_type == ConditionalRelativeJump);
	solAssert(!(m_type == RelativeJump || m_type == ConditionalRelativeJump) || _subId.empty());
	u256 data = _tag;
	if (!_subId.empty())
		data |= (u256(_subId.value) + 1) << 64;
	setData(data);
}

size_t AssemblyItem::bytesRequired(size_t _addressLength, langutil::EVMVersion _evmVersion, Precision _precision) const
{
	switch (m_type)
	{
	case Operation:
	case Tag: // 1 byte for the JUMPDEST
	case RetF:
		return 1;
	case Push:
		return
			1 +
			std::max<size_t>((_evmVersion.hasPush0() ? 0 : 1), numberEncodingSize(data()));
	case PushSubSize:
	case PushProgramSize:
		return 1 + 4; // worst case: a 16MB program
	case PushTag:
	case PushData:
	case PushSub:
		return 1 + _addressLength;
	case PushLibraryAddress:
	case PushDeployTimeAddress:
		return 1 + 20;
	case PushImmutable:
		return 1 + 32;
	case AssignImmutable:
	{
		unsigned long immutableOccurrences = 0;

		// Skip exact immutables count if no precise count was requested
		if (_precision == Precision::Approximate)
			immutableOccurrences = 1; // Assume one immut. ref.
		else
		{
			solAssert(m_immutableOccurrences, "No immutable references. `bytesRequired()` called before assembly()?");
			immutableOccurrences = m_immutableOccurrences.value();
		}

		if (immutableOccurrences != 0)
			// (DUP DUP PUSH <n> ADD MSTORE)* (PUSH <n> ADD MSTORE)
			return (immutableOccurrences - 1) * (5 + 32) + (3 + 32);
		else
			// POP POP
			return 2;
	}
	case VerbatimBytecode:
		return std::get<2>(*m_verbatimBytecode).size();
	case RelativeJump:
	case ConditionalRelativeJump:
	case AuxDataLoadN:
	case JumpF:
	case CallF:
		return 1 + 2;
	case EOFCreate:
		return 2;
	case ReturnContract:
		return 2;
	case SwapN:
		return 2;
	case DupN:
		return 2;
	case UndefinedItem:
		solAssert(false);
	}

	util::unreachable();
}

size_t AssemblyItem::arguments() const
{
	if (type() == CallF || type() == JumpF)
		return functionSignature().argsNum;
	else if (type() == SwapN)
		return static_cast<size_t>(data()) + 1;
	else if (type() == DupN)
		return static_cast<size_t>(data());
	else if (hasInstruction())
	{
		solAssert(instruction() != Instruction::CALLF && instruction() != Instruction::JUMPF);
		// The latest EVMVersion is used here, since the InstructionInfo is assumed to be
		// the same across all EVM versions except for the instruction name.
		return static_cast<size_t>(instructionInfo(instruction(), EVMVersion()).args);
	}
	else if (type() == VerbatimBytecode)
		return std::get<0>(*m_verbatimBytecode);
	else if (type() == AssignImmutable)
		return 2;
	else
		return 0;
}

size_t AssemblyItem::returnValues() const
{
	switch (m_type)
	{
	case Operation:
	case EOFCreate:
	case ReturnContract:
	case RelativeJump:
	case ConditionalRelativeJump:
	case RetF:
		// The latest EVMVersion is used here, since the InstructionInfo is assumed to be
		// the same across all EVM versions except for the instruction name.
		return static_cast<size_t>(instructionInfo(instruction(), EVMVersion()).ret);
	case SwapN:
	case DupN:
		return static_cast<size_t>(data()) + 1;
	case Push:
	case PushTag:
	case PushData:
	case PushSub:
	case PushSubSize:
	case PushProgramSize:
	case PushLibraryAddress:
	case PushImmutable:
	case PushDeployTimeAddress:
		return 1;
	case Tag:
		return 0;
	case VerbatimBytecode:
		return std::get<1>(*m_verbatimBytecode);
	case AuxDataLoadN:
		return 1;
	case JumpF:
	case CallF:
		return functionSignature().retsNum;
	case AssignImmutable:
	case UndefinedItem:
		break;
	}
	return 0;
}

bool AssemblyItem::canBeFunctional() const
{
	if (m_jumpType != JumpType::Ordinary)
		return false;
	switch (m_type)
	{
	case Operation:
	case EOFCreate:
	case ReturnContract:
	case RelativeJump:
	case ConditionalRelativeJump:
	case CallF:
	case JumpF:
	case SwapN:
	case DupN:
	case RetF:
		return !SemanticInformation::isDupInstruction(*this) && !SemanticInformation::isSwapInstruction(*this);
	case Push:
	case PushTag:
	case PushData:
	case PushSub:
	case PushSubSize:
	case PushProgramSize:
	case PushLibraryAddress:
	case PushDeployTimeAddress:
	case PushImmutable:
	case AuxDataLoadN:
		return true;
	case Tag:
		return false;
	case AssignImmutable:
	case VerbatimBytecode:
	case UndefinedItem:
		break;
	}
	return false;
}

std::string AssemblyItem::getJumpTypeAsString() const
{
	switch (m_jumpType)
	{
	case JumpType::IntoFunction:
		return "[in]";
	case JumpType::OutOfFunction:
		return "[out]";
	case JumpType::Ordinary:
	default:
		return "";
	}
}

std::optional<AssemblyItem::JumpType> AssemblyItem::parseJumpType(std::string const& _jumpType)
{
	if (_jumpType == "[in]")
		return JumpType::IntoFunction;
	else if (_jumpType == "[out]")
		return JumpType::OutOfFunction;
	else if (_jumpType.empty())
		return JumpType::Ordinary;

	return std::nullopt;
}

std::string AssemblyItem::toAssemblyText(Assembly const& _assembly) const
{
	std::string text;
	switch (type())
	{
	case Operation:
	{
		assertThrow(isValidInstruction(instruction()), AssemblyException, "Invalid instruction.");
		text = util::toLower(instructionInfo(instruction(), _assembly.evmVersion()).name);
		break;
	}
	case Push:
		text = toHex(toCompactBigEndian(data(), 1), util::HexPrefix::Add);
		break;
	case PushTag:
	{
		auto [sub, tag] = splitForeignPushTag();
		if (sub.empty())
			text = std::string("tag_") + std::to_string(tag);
		else
			text = std::string("tag_") + std::to_string(sub.value) + "_" + std::to_string(tag);
		break;
	}
	case Tag:
		assertThrow(data() < 0x10000, AssemblyException, "Declaration of sub-assembly tag.");
		text = std::string("tag_") + std::to_string(static_cast<size_t>(data())) + ":";
		break;
	case PushData:
		text = std::string("data_") + toHex(data());
		break;
	case PushSub:
	case PushSubSize:
	{
		std::vector<std::string> subPathComponents;
		for (SubAssemblyID subPathComponentId: _assembly.decodeSubPath(SubAssemblyID{data()}))
			subPathComponents.emplace_back("sub_" + std::to_string(subPathComponentId.value));
		text =
			(type() == PushSub ? "dataOffset"s : "dataSize"s) +
			"(" +
			solidity::util::joinHumanReadable(subPathComponents, ".") +
			")";
		break;
	}
	case PushProgramSize:
		text = std::string("bytecodeSize");
		break;
	case PushLibraryAddress:
		text = std::string("linkerSymbol(\"") + toHex(data()) + std::string("\")");
		break;
	case PushDeployTimeAddress:
		text = std::string("deployTimeAddress()");
		break;
	case PushImmutable:
		text = std::string("immutable(\"") + "0x" + util::toHex(toCompactBigEndian(data(), 1)) + "\")";
		break;
	case AssignImmutable:
		text = std::string("assignImmutable(\"") + "0x" + util::toHex(toCompactBigEndian(data(), 1)) + "\")";
		break;
	case UndefinedItem:
		assertThrow(false, AssemblyException, "Invalid assembly item.");
		break;
	case VerbatimBytecode:
		text = std::string("verbatimbytecode_") + util::toHex(std::get<2>(*m_verbatimBytecode));
		break;
	case AuxDataLoadN:
		assertThrow(data() <= std::numeric_limits<size_t>::max(), AssemblyException, "Invalid auxdataloadn argument.");
		text = "auxdataloadn{" +  std::to_string(static_cast<size_t>(data())) + "}";
		break;
	case EOFCreate:
		text = "eofcreate{" +  std::to_string(static_cast<size_t>(data())) + "}";
		break;
	case ReturnContract:
		text = "returncontract{" +  std::to_string(static_cast<size_t>(data())) + "}";
		break;
	case RelativeJump:
		text = "rjump{" + std::string("tag_") + std::to_string(relativeJumpTagID()) + "}";
		break;
	case ConditionalRelativeJump:
		text = "rjumpi{" + std::string("tag_") + std::to_string(relativeJumpTagID()) + "}";
		break;
	case CallF:
		text = "callf{" + std::string("code_section_") +  std::to_string(static_cast<size_t>(data())) + "}";
		break;
	case JumpF:
		text = "jumpf{" + std::string("code_section_") +  std::to_string(static_cast<size_t>(data())) + "}";
		break;
	case RetF:
		text = "retf";
		break;
	case SwapN:
		text = "swapn{" + std::to_string(static_cast<size_t>(data())) + "}";
		break;
	case DupN:
		text = "dupn{" + std::to_string(static_cast<size_t>(data())) + "}";
		break;
	}
	if (m_jumpType == JumpType::IntoFunction || m_jumpType == JumpType::OutOfFunction)
	{
		text += "\t//";
		if (m_jumpType == JumpType::IntoFunction)
			text += " in";
		else
			text += " out";
	}
	return text;
}

// Note: This method is exclusively used for debugging.
std::ostream& solidity::evmasm::operator<<(std::ostream& _out, AssemblyItem const& _item)
{
	switch (_item.type())
	{
	case Operation:
	case EOFCreate:
	case ReturnContract:
	case RelativeJump:
	case ConditionalRelativeJump:
	case CallF:
	case JumpF:
	case RetF:
	case SwapN:
	case DupN:
		_out << " " << instructionInfo(_item.instruction(), EVMVersion()).name;
		if (_item.instruction() == Instruction::JUMP || _item.instruction() == Instruction::JUMPI)
			_out << "\t" << _item.getJumpTypeAsString();
		break;
	case Push:
		_out << " PUSH " << std::hex << _item.data() <<  std::dec;
		break;
	case PushTag:
	{
		SubAssemblyID subId = _item.splitForeignPushTag().first;
		if (subId.empty())
			_out << " PushTag " << _item.splitForeignPushTag().second;
		else
			_out << " PushTag " << subId.value << ":" << _item.splitForeignPushTag().second;
		break;
	}
	case Tag:
		_out << " Tag " << _item.data();
		break;
	case PushData:
		_out << " PushData " << std::hex << static_cast<unsigned>(_item.data()) <<  std::dec;
		break;
	case PushSub:
		_out << " PushSub " << std::hex << static_cast<size_t>(_item.data()) <<  std::dec;
		break;
	case PushSubSize:
		_out << " PushSubSize " << std::hex << static_cast<size_t>(_item.data()) <<  std::dec;
		break;
	case PushProgramSize:
		_out << " PushProgramSize";
		break;
	case PushLibraryAddress:
	{
		std::string hash(util::h256((_item.data())).hex());
		_out << " PushLibraryAddress " << hash.substr(0, 8) + "..." + hash.substr(hash.length() - 8);
		break;
	}
	case PushDeployTimeAddress:
		_out << " PushDeployTimeAddress";
		break;
	case PushImmutable:
		_out << " PushImmutable";
		break;
	case AssignImmutable:
		_out << " AssignImmutable";
		break;
	case VerbatimBytecode:
		_out << " Verbatim " << util::toHex(_item.verbatimData());
		break;
	case AuxDataLoadN:
		_out << " AuxDataLoadN " << util::toString(_item.data());
		break;
	case UndefinedItem:
		_out << " ???";
		break;
	}
	return _out;
}

size_t AssemblyItem::opcodeCount() const noexcept
{
	switch (m_type)
	{
		case AssemblyItemType::AssignImmutable:
			// Append empty items if this AssignImmutable was referenced more than once.
			// For n immutable occurrences the first (n - 1) occurrences will
			// generate 5 opcodes and the last will generate 3 opcodes,
			// because it is reusing the 2 top-most elements on the stack.
			solAssert(m_immutableOccurrences, "");

			if (m_immutableOccurrences.value() != 0)
				return (*m_immutableOccurrences - 1) * 5 + 3;
			else
				return 2; // two POP's
		default:
			return 1;
	}
}

std::string AssemblyItem::computeSourceMapping(
	AssemblyItems const& _items,
	std::map<std::string, unsigned> const& _sourceIndicesMap
)
{
	std::string ret;

	int prevStart = -1;
	int prevLength = -1;
	int prevSourceIndex = -1;
	int prevModifierDepth = -1;
	char prevJump = 0;

	for (auto const& item: _items)
	{
		if (!ret.empty())
			ret += ";";

		SourceLocation const& location = item.location();
		int length = location.start != -1 && location.end != -1 ? location.end - location.start : -1;
		int sourceIndex =
			(location.sourceName && _sourceIndicesMap.count(*location.sourceName)) ?
			static_cast<int>(_sourceIndicesMap.at(*location.sourceName)) :
			-1;
		char jump = '-';
		if (item.getJumpType() == evmasm::AssemblyItem::JumpType::IntoFunction || item.type() == CallF || item.type() == JumpF)
			jump = 'i';
		else if (item.getJumpType() == evmasm::AssemblyItem::JumpType::OutOfFunction || item.type() == RetF)
			jump = 'o';
		int modifierDepth = static_cast<int>(item.m_modifierDepth);

		unsigned components = 5;
		if (modifierDepth == prevModifierDepth)
		{
			components--;
			if (jump == prevJump)
			{
				components--;
				if (sourceIndex == prevSourceIndex)
				{
					components--;
					if (length == prevLength)
					{
						components--;
						if (location.start == prevStart)
							components--;
					}
				}
			}
		}

		if (components-- > 0)
		{
			if (location.start != prevStart)
				ret += std::to_string(location.start);
			if (components-- > 0)
			{
				ret += ':';
				if (length != prevLength)
					ret += std::to_string(length);
				if (components-- > 0)
				{
					ret += ':';
					if (sourceIndex != prevSourceIndex)
						ret += std::to_string(sourceIndex);
					if (components-- > 0)
					{
						ret += ':';
						if (jump != prevJump)
							ret += jump;
						if (components-- > 0)
						{
							ret += ':';
							if (modifierDepth != prevModifierDepth)
								ret += std::to_string(modifierDepth);
						}
					}
				}
			}
		}

		if (item.opcodeCount() > 1)
			ret += std::string(item.opcodeCount() - 1, ';');

		prevStart = location.start;
		prevLength = length;
		prevSourceIndex = sourceIndex;
		prevJump = jump;
		prevModifierDepth = modifierDepth;
	}
	return ret;
}