cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Implement subroutines for yul functions.

Browse Source
This commit is contained in:
chriseth 2020-04-30 16:17:24 +02:00 committed by Alex Beregszaszi
parent dca85a286d
commit cc04085b9e
22 changed files with 105 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
libevmasm/Assembly.cpp
View File

@ -110,7 +110,11 @@ public:
))
{
flush();
m_out << m_prefix << (_item.type() == Tag ? "" : " ") << _item.toAssemblyText() << endl;
m_out <<
m_prefix <<
((_item.type() == Tag || _item.type() == Subtag) ? "" : " ") <<
_item.toAssemblyText() <<
endl;
return;
}
string expression = _item.toAssemblyText();
@ -173,7 +177,7 @@ void Assembly::assemblyStream(ostream& _out, string const& _prefix, StringMap co
if (!m_data.empty() || !m_subs.empty())
{
_out << _prefix << "stop" << endl;
_out << _prefix << "beginsub" << endl;
for (auto const& i: m_data)
if (u256(i.first) >= m_subs.size())
_out << _prefix << "data_" << toHex(u256(i.first)) << " " << toHex(i.second) << endl;
@ -302,10 +306,13 @@ Json::Value Assembly::assemblyJSON(map<string, unsigned> const& _sourceIndices)
));
break;
case Tag:
case Subtag:
collection.append(
createJsonValue("tag", sourceIndex, i.location().start, i.location().end, toString(i.data())));
createJsonValue("tag", sourceIndex, i.location().start, i.location().end, toString(i.data()))
);
collection.append(
createJsonValue("JUMPDEST", sourceIndex, i.location().start, i.location().end));
createJsonValue(i.type() == Tag ? "JUMPDEST" : "BEGINSUB", sourceIndex, i.location().start, i.location().end)
);
break;
case PushData:
collection.append(createJsonValue("PUSH data", sourceIndex, i.location().start, i.location().end, toStringInHex(i.data())));
@ -682,12 +689,16 @@ LinkerObject const& Assembly::assemble() const
ret.bytecode.resize(ret.bytecode.size() + 20);
break;
case Tag:
case Subtag:
assertThrow(i.data() != 0, AssemblyException, "Invalid tag position.");
assertThrow(i.splitForeignPushTag().first == numeric_limits<size_t>::max(), AssemblyException, "Foreign tag.");
assertThrow(ret.bytecode.size() < 0xffffffffL, AssemblyException, "Tag too large.");
assertThrow(m_tagPositionsInBytecode[static_cast<size_t>(i.data())] == numeric_limits<size_t>::max(), AssemblyException, "Duplicate tag position.");
m_tagPositionsInBytecode[static_cast<size_t>(i.data())] = ret.bytecode.size();
if (i.type() == Tag)
ret.bytecode.push_back((uint8_t)Instruction::JUMPDEST);
else
ret.bytecode.push_back((uint8_t)Instruction::BEGINSUB);
break;
default:
assertThrow(false, InvalidOpcode, "Unexpected opcode while assembling.");
@ -702,8 +713,8 @@ LinkerObject const& Assembly::assemble() const
if (!m_subs.empty() || !m_data.empty() || !m_auxiliaryData.empty())
// Append an INVALID here to help tests find miscompilation.
ret.bytecode.push_back(uint8_t(Instruction::INVALID));
// Append a BEGINSUB here to help tests find miscompilation.
ret.bytecode.push_back(uint8_t(Instruction::BEGINSUB));
for (size_t i = 0; i < m_subs.size(); ++i)
{
@ -729,8 +740,8 @@ LinkerObject const& Assembly::assemble() const
m_subs[subId]->m_tagPositionsInBytecode;
assertThrow(tagId < tagPositions.size(), AssemblyException, "Reference to non-existing tag.");
size_t pos = tagPositions[tagId];
assertThrow(pos != numeric_limits<size_t>::max(), AssemblyException, "Reference to tag without position.");
assertThrow(util::bytesRequired(pos) <= bytesPerTag, AssemblyException, "Tag too large for reserved space.");
//assertThrow(pos != numeric_limits<size_t>::max(), AssemblyException, "Reference to tag without position.");
//assertThrow(util::bytesRequired(pos) <= bytesPerTag, AssemblyException, "Tag too large for reserved space.");
bytesRef r(ret.bytecode.data() + i.first, bytesPerTag);
toBigEndian(pos, r);
}

18
libevmasm/AssemblyItem.cpp
View File

@ -33,7 +33,7 @@ static_assert(sizeof(size_t) <= 8, "size_t must be at most 64-bits wide");
AssemblyItem AssemblyItem::toSubAssemblyTag(size_t _subId) const
{
assertThrow(data() < (u256(1) << 64), util::Exception, "Tag already has subassembly set.");
assertThrow(m_type == PushTag || m_type == Tag, util::Exception, "");
assertThrow(m_type == PushTag || m_type == Tag || m_type == Subtag, util::Exception, "");
auto tag = static_cast<size_t>(u256(data()) & 0xffffffffffffffffULL);
AssemblyItem r = *this;
r.m_type = PushTag;
@ -43,7 +43,7 @@ AssemblyItem AssemblyItem::toSubAssemblyTag(size_t _subId) const
pair<size_t, size_t> AssemblyItem::splitForeignPushTag() const
{
assertThrow(m_type == PushTag || m_type == Tag, util::Exception, "");
assertThrow(m_type == PushTag || m_type == Tag || m_type == Subtag, util::Exception, "");
u256 combined = u256(data());
size_t subId = static_cast<size_t>((combined >> 64) - 1);
size_t tag = static_cast<size_t>(combined & 0xffffffffffffffffULL);
@ -52,7 +52,7 @@ pair<size_t, size_t> AssemblyItem::splitForeignPushTag() const
void AssemblyItem::setPushTagSubIdAndTag(size_t _subId, size_t _tag)
{
assertThrow(m_type == PushTag || m_type == Tag, util::Exception, "");
assertThrow(m_type == PushTag || m_type == Tag || m_type == Subtag, util::Exception, "");
u256 data = _tag;
if (_subId != numeric_limits<size_t>::max())
data |= (u256(_subId) + 1) << 64;
@ -64,7 +64,8 @@ size_t AssemblyItem::bytesRequired(size_t _addressLength) const
switch (m_type)
{
case Operation:
case Tag: // 1 byte for the JUMPDEST
case Subtag:
case Tag: // 1 byte for the JUMPDEST / BEGINSUB
return 1;
case PushString:
return 1 + 32;
@ -121,6 +122,7 @@ size_t AssemblyItem::returnValues() const
case PushDeployTimeAddress:
return 1;
case Tag:
case Subtag:
return 0;
default:
break;
@ -148,6 +150,7 @@ bool AssemblyItem::canBeFunctional() const
case PushImmutable:
return true;
case Tag:
case Subtag:
return false;
default:
break;
@ -203,6 +206,10 @@ string AssemblyItem::toAssemblyText() const
assertThrow(data() < 0x10000, AssemblyException, "Declaration of sub-assembly tag.");
text = string("tag_") + to_string(static_cast<size_t>(data())) + ":";
break;
case Subtag:
assertThrow(data() < 0x10000, AssemblyException, "Declaration of sub-assembly tag.");
text = string("beginsubtag_") + to_string(size_t(data())) + ":";
break;
case PushData:
text = string("data_") + util::toHex(data());
break;
@ -271,6 +278,9 @@ ostream& solidity::evmasm::operator<<(ostream& _out, AssemblyItem const& _item)
case Tag:
_out << " Tag " << _item.data();
break;
case Subtag:
_out << " Beginsub " << _item.data();
break;
case PushData:
_out << " PushData " << hex << static_cast<unsigned>(_item.data()) << dec;
break;

1
libevmasm/AssemblyItem.h
View File

@ -42,6 +42,7 @@ enum AssemblyItemType {
PushSubSize,
PushProgramSize,
Tag,
Subtag,
PushData,
PushLibraryAddress, ///< Push a currently unknown address of another (library) contract.
PushDeployTimeAddress, ///< Push an address to be filled at deploy time. Should not be touched by the optimizer.

1
libevmasm/BlockDeduplicator.cpp
View File

@ -104,6 +104,7 @@ bool BlockDeduplicator::applyTagReplacement(
size_t _subId
)
{
// TODO this might be problematic for jumpsub
bool changed = false;
for (AssemblyItem& item: _items)
if (item.type() == PushTag)

1
libevmasm/GasMeter.cpp
View File

@ -55,6 +55,7 @@ GasMeter::GasConsumption GasMeter::estimateMax(AssemblyItem const& _item, bool _
gas = runGas(Instruction::PUSH1);
break;
case Tag:
// TODO Subtag
gas = runGas(Instruction::JUMPDEST);
break;
case Operation:

6
libevmasm/Instruction.cpp
View File

@ -165,6 +165,9 @@ std::map<std::string, Instruction> const solidity::evmasm::c_instructions =
{ "LOG2", Instruction::LOG2 },
{ "LOG3", Instruction::LOG3 },
{ "LOG4", Instruction::LOG4 },
{ "JUMPSUB", Instruction::JUMPSUB },
{ "BEGINSUB", Instruction::BEGINSUB },
{ "RETURNSUB", Instruction::RETURNSUB },
{ "CREATE", Instruction::CREATE },
{ "CALL", Instruction::CALL },
{ "CALLCODE", Instruction::CALLCODE },
@ -311,6 +314,9 @@ static std::map<Instruction, InstructionInfo> const c_instructionInfo =
{ Instruction::LOG2, { "LOG2", 0, 4, 0, true, Tier::Special } },
{ Instruction::LOG3, { "LOG3", 0, 5, 0, true, Tier::Special } },
{ Instruction::LOG4, { "LOG4", 0, 6, 0, true, Tier::Special } },
{ Instruction::JUMPSUB, { "JUMPSUB", 0, 1, 0, true, Tier::Special } },
{ Instruction::BEGINSUB, { "BEGINSUB", 0, 0, 0, true, Tier::Special } },
{ Instruction::RETURNSUB, { "RETURNSUB", 0, 0, 0, true, Tier::Special } },
{ Instruction::CREATE, { "CREATE", 0, 3, 1, true, Tier::Special } },
{ Instruction::CALL, { "CALL", 0, 7, 1, true, Tier::Special } },
{ Instruction::CALLCODE, { "CALLCODE", 0, 7, 1, true, Tier::Special } },

4
libevmasm/Instruction.h
View File

@ -185,6 +185,10 @@ enum class Instruction: uint8_t
EIP615_PUTLOCAL, ///< pop top of stack to local variable -- not part of Instructions.cpp
EIP615_GETLOCAL, ///< push local variable to top of stack -- not part of Instructions.cpp
BEGINSUB = 0x5c, ///< set a potential jumpsub destination
RETURNSUB = 0x5d, ///< return to subroutine jumped from
JUMPSUB = 0x5e, ///< alter the program counter to a beginsub
CREATE = 0xf0, ///< create a new account with associated code
CALL, ///< message-call into an account
CALLCODE, ///< message-call with another account's code only

2
libevmasm/JumpdestRemover.cpp
View File

@ -40,7 +40,7 @@ bool JumpdestRemover::optimise(set<size_t> const& _tagsReferencedFromOutside)
m_items.end(),
[&](AssemblyItem const& _item)
{
if (_item.type() != Tag)
if (_item.type() != Tag && _item.type() != Subtag)
return false;
auto asmIdAndTag = _item.splitForeignPushTag();
assertThrow(asmIdAndTag.first == numeric_limits<size_t>::max(), OptimizerException, "Sub-assembly tag used as label.");

2
libevmasm/KnownState.cpp
View File

@ -87,7 +87,7 @@ ostream& KnownState::stream(ostream& _out) const
KnownState::StoreOperation KnownState::feedItem(AssemblyItem const& _item, bool _copyItem)
{
StoreOperation op;
if (_item.type() == Tag)
if (_item.type() == Tag || _item.type() == Subtag)
{
// can be ignored
}

10
libevmasm/SemanticInformation.cpp
View File

@ -35,6 +35,7 @@ bool SemanticInformation::breaksCSEAnalysisBlock(AssemblyItem const& _item, bool
default:
case UndefinedItem:
case Tag:
case Subtag:
case PushDeployTimeAddress:
case AssignImmutable:
return true;
@ -110,7 +111,12 @@ bool SemanticInformation::isSwapInstruction(AssemblyItem const& _item)
bool SemanticInformation::isJumpInstruction(AssemblyItem const& _item)
{
return _item == Instruction::JUMP || _item == Instruction::JUMPI;
// TODO check the usages of this function
return
_item == Instruction::JUMP ||
_item == Instruction::JUMPI ||
_item == Instruction::JUMPSUB ||
_item == Instruction::RETURNSUB;
}
bool SemanticInformation::altersControlFlow(AssemblyItem const& _item)
@ -124,6 +130,8 @@ bool SemanticInformation::altersControlFlow(AssemblyItem const& _item)
case Instruction::JUMP:
case Instruction::JUMPI:
case Instruction::RETURN:
case Instruction::JUMPSUB:
case Instruction::RETURNSUB:
case Instruction::SELFDESTRUCT:
case Instruction::STOP:
case Instruction::INVALID:

4
liblangutil/EVMVersion.cpp
View File

@ -45,6 +45,10 @@ bool EVMVersion::hasOpcode(Instruction _opcode) const
return hasChainID();
case Instruction::SELFBALANCE:
return hasSelfBalance();
case Instruction::JUMPSUB:
case Instruction::BEGINSUB:
case Instruction::RETURNSUB:
return supportsSubroutines();
default:
return true;
}

1
liblangutil/EVMVersion.h
View File

@ -86,6 +86,7 @@ public:
bool hasExtCodeHash() const { return *this >= constantinople(); }
bool hasChainID() const { return *this >= istanbul(); }
bool hasSelfBalance() const { return *this >= istanbul(); }
bool supportsSubroutines() const { return *this >= berlin(); }
bool hasOpcode(evmasm::Instruction _opcode) const;

1
libsolidity/codegen/CompilerContext.cpp
View File

@ -132,6 +132,7 @@ void CompilerContext::callLowLevelFunction(
*this << lowLevelFunctionTag(_name, _inArgs, _outArgs, _generator);
// TODO could use jumpsub?
appendJump(evmasm::AssemblyItem::JumpType::IntoFunction);
adjustStackOffset(static_cast<int>(_outArgs) - 1 - static_cast<int>(_inArgs));
*this << retTag.tag();

1
libsolidity/codegen/ContractCompiler.cpp
View File

@ -505,6 +505,7 @@ void ContractCompiler::appendFunctionSelector(ContractDefinition const& _contrac
m_context << Instruction::DUP1 << Instruction::CALLDATASIZE << Instruction::SUB;
CompilerUtils(m_context).abiDecode(functionType->parameterTypes());
}
// TODO could use JUMPSUB?
m_context.appendJumpTo(
m_context.functionEntryLabel(functionType->declaration()),
evmasm::AssemblyItem::JumpType::IntoFunction

1
libsolidity/codegen/ExpressionCompiler.cpp
View File

@ -614,6 +614,7 @@ bool ExpressionCompiler::visit(FunctionCall const& _functionCall)
// Extract the runtime part.
m_context << ((u256(1) << 32) - 1) << Instruction::AND;
// TODO could use jumpsub
m_context.appendJump(evmasm::AssemblyItem::JumpType::IntoFunction);
m_context << returnLabel;

28
libsolidity/interface/CompilerStack.cpp
View File

@ -1060,25 +1060,25 @@ void CompilerStack::compileContract(
solAssert(false, "Optimizer exception during compilation");
}
try
{
// try
// {
// Assemble deployment (incl. runtime) object.
compiledContract.object = compiler->assembledObject();
}
catch(evmasm::AssemblyException const&)
{
solAssert(false, "Assembly exception for bytecode");
}
// }
// catch(evmasm::AssemblyException const&)
// {
// solAssert(false, "Assembly exception for bytecode");
// }
try
{
// try
// {
// Assemble runtime object.
compiledContract.runtimeObject = compiler->runtimeObject();
}
catch(evmasm::AssemblyException const&)
{
solAssert(false, "Assembly exception for deployed bytecode");
}
// }
// catch(evmasm::AssemblyException const&)
// {
// solAssert(false, "Assembly exception for deployed bytecode");
// }
// Throw a warning if EIP-170 limits are exceeded:
// If contract creation initialization returns data with length of more than 0x6000 (214 + 213) bytes,

5
libyul/AsmAnalysis.cpp
View File

@ -573,7 +573,10 @@ bool AsmAnalyzer::validateInstructions(evmasm::Instruction _instr, SourceLocatio
yulAssert(
_instr != evmasm::Instruction::JUMP &&
_instr != evmasm::Instruction::JUMPI &&
_instr != evmasm::Instruction::JUMPDEST,
_instr != evmasm::Instruction::JUMPDEST &&
_instr != evmasm::Instruction::JUMPSUB &&
_instr != evmasm::Instruction::RETURNSUB &&
_instr != evmasm::Instruction::BEGINSUB
"");
auto errorForVM = [&](ErrorId _errorId, string const& vmKindMessage) {

3
libyul/AsmParser.cpp
View File

@ -70,6 +70,9 @@ std::map<string, evmasm::Instruction> const& Parser::instructions()
{
if (
instruction.second == evmasm::Instruction::JUMPDEST ||
instruction.second == evmasm::Instruction::BEGINSUB ||
instruction.second == evmasm::Instruction::JUMPSUB ||
instruction.second == evmasm::Instruction::RETURNSUB ||
evmasm::isPushInstruction(instruction.second)
)
continue;

18
libyul/backends/evm/AsmCodeGen.cpp
View File

@ -116,22 +116,22 @@ void EthAssemblyAdapter::appendJumpToIf(LabelID _labelId, JumpType _jumpType)
appendJumpInstruction(evmasm::Instruction::JUMPI, _jumpType);
}
void EthAssemblyAdapter::appendBeginsub(LabelID, int)
void EthAssemblyAdapter::appendBeginsub(LabelID _labelId, int)
{
// TODO we could emulate that, though
yulAssert(false, "BEGINSUB not implemented for EVM 1.0");
m_assembly.append(evmasm::AssemblyItem(evmasm::Subtag, _labelId));
}
void EthAssemblyAdapter::appendJumpsub(LabelID, int, int)
void EthAssemblyAdapter::appendJumpsub(LabelID _labelId, int _args, int _returns)
{
// TODO we could emulate that, though
yulAssert(false, "JUMPSUB not implemented for EVM 1.0");
appendLabelReference(_labelId);
appendInstruction(evmasm::Instruction::JUMPSUB);
m_assembly.adjustDeposit(-_args + _returns);
}
void EthAssemblyAdapter::appendReturnsub(int, int)
void EthAssemblyAdapter::appendReturnsub(int _returns, int _stackDiffAfter)
{
// TODO we could emulate that, though
yulAssert(false, "RETURNSUB not implemented for EVM 1.0");
appendInstruction(evmasm::Instruction::RETURNSUB);
m_assembly.adjustDeposit(_stackDiffAfter - _returns);
}
void EthAssemblyAdapter::appendAssemblySize()

4
libyul/backends/evm/AsmCodeGen.h
View File

@ -53,8 +53,8 @@ public:
void appendJumpTo(LabelID _labelId, int _stackDiffAfter, JumpType _jumpType) override;
void appendJumpToIf(LabelID _labelId, JumpType _jumpType) override;
void appendBeginsub(LabelID, int) override;
void appendJumpsub(LabelID, int, int) override;
void appendReturnsub(int, int) override;
void appendJumpsub(LabelID, int _args, int _returns) override;
void appendReturnsub(int _returns, int _stackDiffAfter) override;
void appendAssemblySize() override;
std::pair<std::shared_ptr<AbstractAssembly>, SubID> createSubAssembly() override;
void appendDataOffset(SubID _sub) override;

12
libyul/backends/evm/EVMCodeTransform.cpp
View File

@ -267,7 +267,7 @@ void CodeTransform::operator()(FunctionCall const& _call)
{
m_assembly.setSourceLocation(_call.location);
EVMAssembly::LabelID returnLabel(numeric_limits<EVMAssembly::LabelID>::max()); // only used for evm 1.0
if (!m_evm15)
if (!m_evm15 && !m_dialect.evmVersion().supportsSubroutines())
{
returnLabel = m_assembly.newLabelId();
m_assembly.appendLabelReference(returnLabel);
@ -283,7 +283,7 @@ void CodeTransform::operator()(FunctionCall const& _call)
for (auto const& arg: _call.arguments | boost::adaptors::reversed)
visitExpression(arg);
m_assembly.setSourceLocation(_call.location);
if (m_evm15)
if (m_evm15 || m_dialect.evmVersion().supportsSubroutines())
m_assembly.appendJumpsub(
functionEntryID(_call.functionName.name, *function),
static_cast<int>(function->arguments.size()),
@ -417,7 +417,7 @@ void CodeTransform::operator()(FunctionDefinition const& _function)
m_assembly.setSourceLocation(_function.location);
int const stackHeightBefore = m_assembly.stackHeight();
if (m_evm15)
if (m_evm15 || m_dialect.evmVersion().supportsSubroutines())
m_assembly.appendBeginsub(functionEntryID(_function.name, function), static_cast<int>(_function.parameters.size()));
else
m_assembly.appendLabel(functionEntryID(_function.name, function));
@ -475,7 +475,7 @@ void CodeTransform::operator()(FunctionDefinition const& _function)
// This vector holds the desired target positions of all stack slots and is
// modified parallel to the actual stack.
vector<int> stackLayout;
if (!m_evm15)
if (!m_evm15 && !m_dialect.evmVersion().supportsSubroutines())
stackLayout.push_back(static_cast<int>(_function.returnVariables.size())); // Move return label to the top
stackLayout += vector<int>(_function.parameters.size(), -1); // discard all arguments
@ -511,7 +511,7 @@ void CodeTransform::operator()(FunctionDefinition const& _function)
yulAssert(i == static_cast<size_t>(stackLayout[i]), "Error reshuffling stack.");
}
}
if (m_evm15)
if (m_evm15 || m_dialect.evmVersion().supportsSubroutines())
m_assembly.appendReturnsub(static_cast<int>(_function.returnVariables.size()), stackHeightBefore);
else
m_assembly.appendJump(
@ -519,6 +519,8 @@ void CodeTransform::operator()(FunctionDefinition const& _function)
AbstractAssembly::JumpType::OutOfFunction
);
m_assembly.setStackHeight(stackHeightBefore);
// TODO add BEGINSUB?
// We need to make sure that we did function hoister and move the "main code" to the beginning.
}
void CodeTransform::operator()(ForLoop const& _forLoop)

4
libyul/backends/evm/NoOutputAssembly.cpp
View File

@ -101,21 +101,17 @@ void NoOutputAssembly::appendJumpToIf(LabelID _labelId, JumpType)
void NoOutputAssembly::appendBeginsub(LabelID, int _arguments)
{
yulAssert(m_evm15, "BEGINSUB used for EVM 1.0");
yulAssert(_arguments >= 0, "");
m_stackHeight += _arguments;
}
void NoOutputAssembly::appendJumpsub(LabelID, int _arguments, int _returns)
{
yulAssert(m_evm15, "JUMPSUB used for EVM 1.0");
yulAssert(_arguments >= 0 && _returns >= 0, "");
m_stackHeight += _returns - _arguments;
}
void NoOutputAssembly::appendReturnsub(int _returns, int _stackDiffAfter)
{
yulAssert(m_evm15, "RETURNSUB used for EVM 1.0");
yulAssert(_returns >= 0, "");
m_stackHeight += _stackDiffAfter - _returns;
}