diff --git a/test/libyul/ControlFlowGraphTest.cpp b/test/libyul/ControlFlowGraphTest.cpp index e691d159f..ef6b548f3 100644 --- a/test/libyul/ControlFlowGraphTest.cpp +++ b/test/libyul/ControlFlowGraphTest.cpp @@ -28,6 +28,10 @@ #include #include +#ifdef ISOLTEST +#include +#endif + using namespace solidity; using namespace solidity::util; using namespace solidity::langutil; @@ -81,9 +85,13 @@ public: m_stream(_stream) { } - void operator()(CFG::BasicBlock const& _block) + void operator()(CFG::BasicBlock const& _block, bool _isMainEntry = true) { - getBlockId(_block); + if (_isMainEntry) + { + m_stream << "Entry [label=\"Entry\"];\n"; + m_stream << "Entry -> Block" << getBlockId(_block) << ";\n"; + } while (!m_blocksToPrint.empty()) { CFG::BasicBlock const* block = *m_blocksToPrint.begin(); @@ -96,7 +104,8 @@ public: CFG::FunctionInfo const& _info ) { - m_stream << m_indent << "function " << _info.function.name.str() << "("; + m_stream << "FunctionEntry_" << _info.function.name.str() << " [label=\""; + m_stream << "function " << _info.function.name.str() << "("; m_stream << joinHumanReadable(_info.parameters | ranges::views::transform(variableSlotToString)); m_stream << ")"; if (!_info.returnVariables.empty()) @@ -104,28 +113,38 @@ public: m_stream << " -> "; m_stream << joinHumanReadable(_info.returnVariables | ranges::views::transform(variableSlotToString)); } - m_stream << ":\n"; - ScopedSaveAndRestore linePrefixRestore(m_indent, m_indent + " "); - (*this)(*_info.entry); + m_stream << "\"];\n"; + m_stream << "FunctionEntry_" << _info.function.name.str() << " -> Block" << getBlockId(*_info.entry) << ";\n"; + (*this)(*_info.entry, false); } private: void printBlock(CFG::BasicBlock const& _block) { - m_stream << m_indent << "Block " << getBlockId(_block) << ":\n"; - ScopedSaveAndRestore linePrefixRestore(m_indent, m_indent + " "); + m_stream << "Block" << getBlockId(_block) << " [label=\"\\\n"; - m_stream << m_indent << "Entries: "; - if (_block.entries.empty()) - m_stream << "None\n"; - else - m_stream << joinHumanReadable(_block.entries | ranges::views::transform([&](auto const* _entry) { - return to_string(getBlockId(*_entry)); - })) << "\n"; + // Verify that the entries of this block exit into this block. + for (auto const& entry: _block.entries) + std::visit(util::GenericVisitor{ + [&](CFG::BasicBlock::Jump const& _jump) + { + soltestAssert(_jump.target == &_block, "Invalid control flow graph."); + }, + [&](CFG::BasicBlock::ConditionalJump const& _conditionalJump) + { + soltestAssert( + _conditionalJump.zero == &_block || _conditionalJump.nonZero == &_block, + "Invalid control flow graph." + ); + }, + [&](auto const&) + { + soltestAssert(false, "Invalid control flow graph."); + } + }, entry->exit); for (auto const& operation: _block.operations) { - m_stream << m_indent; std::visit(util::GenericVisitor{ [&](CFG::FunctionCall const& _call) { m_stream << _call.function.get().name.str() << ": "; @@ -140,32 +159,47 @@ private: m_stream << "): "; } }, operation.operation); - m_stream << stackToString(operation.input) << " => " << stackToString(operation.output) << "\n"; + m_stream << stackToString(operation.input) << " => " << stackToString(operation.output) << "\\l\\\n"; } + m_stream << "\"];\n"; std::visit(util::GenericVisitor{ [&](CFG::BasicBlock::MainExit const&) { - m_stream << m_indent << "MainExit\n"; + m_stream << "Block" << getBlockId(_block) << "Exit [label=\"MainExit\"];\n"; + m_stream << "Block" << getBlockId(_block) << " -> Block" << getBlockId(_block) << "Exit;\n"; }, [&](CFG::BasicBlock::Jump const& _jump) { - m_stream << m_indent << "Jump" << (_jump.backwards ? " (backwards): " : ": ") << getBlockId(*_jump.target) << "\n"; + m_stream << "Block" << getBlockId(_block) << " -> Block" << getBlockId(_block) << "Exit [arrowhead=none];\n"; + m_stream << "Block" << getBlockId(_block) << "Exit [label=\""; + if (_jump.backwards) + m_stream << "Backwards"; + m_stream << "Jump\" shape=oval];\n"; + m_stream << "Block" << getBlockId(_block) << "Exit -> Block" << getBlockId(*_jump.target) << ";\n"; }, [&](CFG::BasicBlock::ConditionalJump const& _conditionalJump) { - m_stream << m_indent << "ConditionalJump " << stackSlotToString(_conditionalJump.condition) << ":\n"; - m_stream << m_indent << " NonZero: " << getBlockId(*_conditionalJump.nonZero) << "\n"; - m_stream << m_indent << " Zero: " << getBlockId(*_conditionalJump.zero) << "\n"; + m_stream << "Block" << getBlockId(_block) << " -> Block" << getBlockId(_block) << "Exit;\n"; + m_stream << "Block" << getBlockId(_block) << "Exit [label=\"{ "; + m_stream << stackSlotToString(_conditionalJump.condition); + m_stream << "| { <0> Zero | <1> NonZero }}\" shape=Mrecord];\n"; + m_stream << "Block" << getBlockId(_block); + m_stream << "Exit:0 -> Block" << getBlockId(*_conditionalJump.zero) << ";\n"; + m_stream << "Block" << getBlockId(_block); + m_stream << "Exit:1 -> Block" << getBlockId(*_conditionalJump.nonZero) << ";\n"; }, [&](CFG::BasicBlock::FunctionReturn const& _return) { - m_stream << m_indent << "FunctionReturn of " << _return.info->function.name.str() << "\n"; + m_stream << "Block" << getBlockId(_block) << "Exit [label=\"FunctionReturn[" << _return.info->function.name.str() << "]\"];\n"; + m_stream << "Block" << getBlockId(_block) << " -> Block" << getBlockId(_block) << "Exit;\n"; }, [&](CFG::BasicBlock::Terminated const&) { - m_stream << m_indent << "Terminated\n"; + m_stream << "Block" << getBlockId(_block) << "Exit [label=\"Terminated\"];\n"; + m_stream << "Block" << getBlockId(_block) << " -> Block" << getBlockId(_block) << "Exit;\n"; } }, _block.exit); + m_stream << "\n"; } size_t getBlockId(CFG::BasicBlock const& _block) { @@ -176,7 +210,6 @@ private: return id; } std::ostream& m_stream; - std::string m_indent; std::map m_blockIds; size_t m_blockCount = 0; std::list m_blocksToPrint; @@ -197,11 +230,41 @@ TestCase::TestResult ControlFlowGraphTest::run(ostream& _stream, string const& _ std::unique_ptr cfg = ControlFlowGraphBuilder::build(*analysisInfo, *m_dialect, *object->code); - ControlFlowGraphPrinter{output}(*cfg->entry); + output << "digraph CFG {\nnodesep=0.7;\nnode[shape=box];\n\n"; + ControlFlowGraphPrinter printer{output}; + printer(*cfg->entry); for (auto function: cfg->functions) - ControlFlowGraphPrinter{output}(cfg->functionInfo.at(function)); + printer(cfg->functionInfo.at(function)); + output << "}\n"; m_obtainedResult = output.str(); - return checkResult(_stream, _linePrefix, _formatted); + auto result = checkResult(_stream, _linePrefix, _formatted); + +#ifdef ISOLTEST + char* graphDisplayer = nullptr; + if (result == TestResult::Failure) + graphDisplayer = getenv("ISOLTEST_DISPLAY_GRAPHS_FAILURE"); + else if (result == TestResult::Success) + graphDisplayer = getenv("ISOLTEST_DISPLAY_GRAPHS_SUCCESS"); + + if (graphDisplayer) + { + if (result == TestResult::Success) + std::cout << std::endl << m_source << std::endl; + boost::process::opstream pipe; + boost::process::child child(graphDisplayer, boost::process::std_in < pipe); + + pipe << output.str(); + pipe.flush(); + pipe.pipe().close(); + if (result == TestResult::Success) + child.wait(); + else + child.detach(); + } +#endif + + return result; + } diff --git a/test/libyul/yulControlFlowGraph/break.yul b/test/libyul/yulControlFlowGraph/break.yul new file mode 100644 index 000000000..ceca7cce0 --- /dev/null +++ b/test/libyul/yulControlFlowGraph/break.yul @@ -0,0 +1,87 @@ +{ + sstore(0x01, 0x0101) + for { sstore(0x02, 0x0202) } sload(0x03) { sstore(0x04, 0x0404) } { + sstore(0x05, 0x0505) + if sload(0x06) { sstore(0x07,0x0707) break } + sstore(0x08, 0x0808) + if sload(0x09) { sstore(0x0A,0x0A0A) continue } + sstore(0x0B, 0x0B0B) + } + sstore(0x0C, 0x0C0C) +} +// ---- +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// sstore: [ 0x0101 0x01 ] => [ ]\l\ +// sstore: [ 0x0202 0x02 ] => [ ]\l\ +// "]; +// Block0 -> Block0Exit [arrowhead=none]; +// Block0Exit [label="Jump" shape=oval]; +// Block0Exit -> Block1; +// +// Block1 [label="\ +// sload: [ 0x03 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block1 -> Block1Exit; +// Block1Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block1Exit:0 -> Block2; +// Block1Exit:1 -> Block3; +// +// Block2 [label="\ +// sstore: [ 0x0c0c 0x0c ] => [ ]\l\ +// "]; +// Block2Exit [label="MainExit"]; +// Block2 -> Block2Exit; +// +// Block3 [label="\ +// sstore: [ 0x0505 0x05 ] => [ ]\l\ +// sload: [ 0x06 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block3 -> Block3Exit; +// Block3Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block3Exit:0 -> Block4; +// Block3Exit:1 -> Block5; +// +// Block4 [label="\ +// sstore: [ 0x0808 0x08 ] => [ ]\l\ +// sload: [ 0x09 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block4 -> Block4Exit; +// Block4Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block4Exit:0 -> Block6; +// Block4Exit:1 -> Block7; +// +// Block5 [label="\ +// sstore: [ 0x0707 0x07 ] => [ ]\l\ +// "]; +// Block5 -> Block5Exit [arrowhead=none]; +// Block5Exit [label="Jump" shape=oval]; +// Block5Exit -> Block2; +// +// Block6 [label="\ +// sstore: [ 0x0b0b 0x0b ] => [ ]\l\ +// "]; +// Block6 -> Block6Exit [arrowhead=none]; +// Block6Exit [label="Jump" shape=oval]; +// Block6Exit -> Block8; +// +// Block7 [label="\ +// sstore: [ 0x0a0a 0x0a ] => [ ]\l\ +// "]; +// Block7 -> Block7Exit [arrowhead=none]; +// Block7Exit [label="Jump" shape=oval]; +// Block7Exit -> Block8; +// +// Block8 [label="\ +// sstore: [ 0x0404 0x04 ] => [ ]\l\ +// "]; +// Block8 -> Block8Exit [arrowhead=none]; +// Block8Exit [label="BackwardsJump" shape=oval]; +// Block8Exit -> Block1; +// +// } diff --git a/test/libyul/yulControlFlowGraph/complex.yul b/test/libyul/yulControlFlowGraph/complex.yul new file mode 100644 index 000000000..74e7e4805 --- /dev/null +++ b/test/libyul/yulControlFlowGraph/complex.yul @@ -0,0 +1,195 @@ +{ + function f(a, b) -> c { + for { let x := 42 } lt(x, a) { + x := add(x, 1) + if calldataload(x) + { + sstore(0, x) + leave + sstore(0x01, 0x0101) + } + sstore(0xFF, 0xFFFF) + } + { + switch mload(x) + case 0 { + sstore(0x02, 0x0202) + break + sstore(0x03, 0x0303) + } + case 1 { + sstore(0x04, 0x0404) + leave + sstore(0x05, 0x0505) + } + case 2 { + sstore(0x06, 0x0606) + revert(0, 0) + sstore(0x07, 0x0707) + } + case 3 { + sstore(0x08, 0x0808) + } + default { + if mload(b) { + return(0, 0) + sstore(0x09, 0x0909) + } + sstore(0x0A, 0x0A0A) + } + sstore(0x0B, 0x0B0B) + } + sstore(0x0C, 0x0C0C) + } + pop(f(1,2)) +} +// ---- +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// f: [ RET[f] 0x02 0x01 ] => [ TMP[f, 0] ]\l\ +// pop: [ TMP[f, 0] ] => [ ]\l\ +// "]; +// Block0Exit [label="MainExit"]; +// Block0 -> Block0Exit; +// +// FunctionEntry_f [label="function f(a, b) -> c"]; +// FunctionEntry_f -> Block1; +// Block1 [label="\ +// Assignment(x): [ 0x2a ] => [ x ]\l\ +// "]; +// Block1 -> Block1Exit [arrowhead=none]; +// Block1Exit [label="Jump" shape=oval]; +// Block1Exit -> Block2; +// +// Block2 [label="\ +// lt: [ a x ] => [ TMP[lt, 0] ]\l\ +// "]; +// Block2 -> Block2Exit; +// Block2Exit [label="{ TMP[lt, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block2Exit:0 -> Block3; +// Block2Exit:1 -> Block4; +// +// Block3 [label="\ +// sstore: [ 0x0c0c 0x0c ] => [ ]\l\ +// "]; +// Block3Exit [label="FunctionReturn[f]"]; +// Block3 -> Block3Exit; +// +// Block4 [label="\ +// mload: [ x ] => [ TMP[mload, 0] ]\l\ +// Assignment(GHOST[0]): [ TMP[mload, 0] ] => [ GHOST[0] ]\l\ +// eq: [ GHOST[0] 0x00 ] => [ TMP[eq, 0] ]\l\ +// "]; +// Block4 -> Block4Exit; +// Block4Exit [label="{ TMP[eq, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block4Exit:0 -> Block5; +// Block4Exit:1 -> Block6; +// +// Block5 [label="\ +// eq: [ GHOST[0] 0x01 ] => [ TMP[eq, 0] ]\l\ +// "]; +// Block5 -> Block5Exit; +// Block5Exit [label="{ TMP[eq, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block5Exit:0 -> Block7; +// Block5Exit:1 -> Block8; +// +// Block6 [label="\ +// sstore: [ 0x0202 0x02 ] => [ ]\l\ +// "]; +// Block6 -> Block6Exit [arrowhead=none]; +// Block6Exit [label="Jump" shape=oval]; +// Block6Exit -> Block3; +// +// Block7 [label="\ +// eq: [ GHOST[0] 0x02 ] => [ TMP[eq, 0] ]\l\ +// "]; +// Block7 -> Block7Exit; +// Block7Exit [label="{ TMP[eq, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block7Exit:0 -> Block9; +// Block7Exit:1 -> Block10; +// +// Block8 [label="\ +// sstore: [ 0x0404 0x04 ] => [ ]\l\ +// "]; +// Block8Exit [label="FunctionReturn[f]"]; +// Block8 -> Block8Exit; +// +// Block9 [label="\ +// eq: [ GHOST[0] 0x03 ] => [ TMP[eq, 0] ]\l\ +// "]; +// Block9 -> Block9Exit; +// Block9Exit [label="{ TMP[eq, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block9Exit:0 -> Block11; +// Block9Exit:1 -> Block12; +// +// Block10 [label="\ +// sstore: [ 0x0606 0x06 ] => [ ]\l\ +// revert: [ 0x00 0x00 ] => [ ]\l\ +// "]; +// Block10Exit [label="Terminated"]; +// Block10 -> Block10Exit; +// +// Block11 [label="\ +// mload: [ b ] => [ TMP[mload, 0] ]\l\ +// "]; +// Block11 -> Block11Exit; +// Block11Exit [label="{ TMP[mload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block11Exit:0 -> Block13; +// Block11Exit:1 -> Block14; +// +// Block12 [label="\ +// sstore: [ 0x0808 0x08 ] => [ ]\l\ +// "]; +// Block12 -> Block12Exit [arrowhead=none]; +// Block12Exit [label="Jump" shape=oval]; +// Block12Exit -> Block15; +// +// Block13 [label="\ +// sstore: [ 0x0a0a 0x0a ] => [ ]\l\ +// "]; +// Block13 -> Block13Exit [arrowhead=none]; +// Block13Exit [label="Jump" shape=oval]; +// Block13Exit -> Block15; +// +// Block14 [label="\ +// return: [ 0x00 0x00 ] => [ ]\l\ +// "]; +// Block14Exit [label="Terminated"]; +// Block14 -> Block14Exit; +// +// Block15 [label="\ +// sstore: [ 0x0b0b 0x0b ] => [ ]\l\ +// "]; +// Block15 -> Block15Exit [arrowhead=none]; +// Block15Exit [label="Jump" shape=oval]; +// Block15Exit -> Block16; +// +// Block16 [label="\ +// add: [ 0x01 x ] => [ TMP[add, 0] ]\l\ +// Assignment(x): [ TMP[add, 0] ] => [ x ]\l\ +// calldataload: [ x ] => [ TMP[calldataload, 0] ]\l\ +// "]; +// Block16 -> Block16Exit; +// Block16Exit [label="{ TMP[calldataload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block16Exit:0 -> Block17; +// Block16Exit:1 -> Block18; +// +// Block17 [label="\ +// sstore: [ 0xffff 0xff ] => [ ]\l\ +// "]; +// Block17 -> Block17Exit [arrowhead=none]; +// Block17Exit [label="BackwardsJump" shape=oval]; +// Block17Exit -> Block2; +// +// Block18 [label="\ +// sstore: [ x 0x00 ] => [ ]\l\ +// "]; +// Block18Exit [label="FunctionReturn[f]"]; +// Block18 -> Block18Exit; +// +// } diff --git a/test/libyul/yulControlFlowGraph/for.yul b/test/libyul/yulControlFlowGraph/for.yul index 1259cf5ac..52658a128 100644 --- a/test/libyul/yulControlFlowGraph/for.yul +++ b/test/libyul/yulControlFlowGraph/for.yul @@ -6,26 +6,46 @@ sstore(0x06, 0x0506) } // ---- -// Block 0: -// Entries: None -// sstore: [ 0x0101 0x01 ] => [ ] -// sstore: [ 0x0202 0x02 ] => [ ] -// Jump: 1 -// Block 1: -// Entries: 0, 2 -// sload: [ 0x03 ] => [ TMP[sload, 0] ] -// ConditionalJump TMP[sload, 0]: -// NonZero: 3 -// Zero: 4 -// Block 2: -// Entries: 3 -// sstore: [ 0x0404 0x04 ] => [ ] -// Jump (backwards): 1 -// Block 3: -// Entries: 1 -// sstore: [ 0x0505 0x05 ] => [ ] -// Jump: 2 -// Block 4: -// Entries: 1 -// sstore: [ 0x0506 0x06 ] => [ ] -// MainExit +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// sstore: [ 0x0101 0x01 ] => [ ]\l\ +// sstore: [ 0x0202 0x02 ] => [ ]\l\ +// "]; +// Block0 -> Block0Exit [arrowhead=none]; +// Block0Exit [label="Jump" shape=oval]; +// Block0Exit -> Block1; +// +// Block1 [label="\ +// sload: [ 0x03 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block1 -> Block1Exit; +// Block1Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block1Exit:0 -> Block2; +// Block1Exit:1 -> Block3; +// +// Block2 [label="\ +// sstore: [ 0x0506 0x06 ] => [ ]\l\ +// "]; +// Block2Exit [label="MainExit"]; +// Block2 -> Block2Exit; +// +// Block3 [label="\ +// sstore: [ 0x0505 0x05 ] => [ ]\l\ +// "]; +// Block3 -> Block3Exit [arrowhead=none]; +// Block3Exit [label="Jump" shape=oval]; +// Block3Exit -> Block4; +// +// Block4 [label="\ +// sstore: [ 0x0404 0x04 ] => [ ]\l\ +// "]; +// Block4 -> Block4Exit [arrowhead=none]; +// Block4Exit [label="BackwardsJump" shape=oval]; +// Block4Exit -> Block1; +// +// } diff --git a/test/libyul/yulControlFlowGraph/function.yul b/test/libyul/yulControlFlowGraph/function.yul index ccc77de94..744f65a78 100644 --- a/test/libyul/yulControlFlowGraph/function.yul +++ b/test/libyul/yulControlFlowGraph/function.yul @@ -19,36 +19,57 @@ h(y) } // ---- -// Block 0: -// Entries: None -// i: [ RET[i] ] => [ TMP[i, 0] TMP[i, 1] ] -// Assignment(x, y): [ TMP[i, 0] TMP[i, 1] ] => [ x y ] -// h: [ RET[h] x ] => [ ] -// h: [ RET[h] y ] => [ ] -// MainExit -// function f(a, b) -> r: -// Block 0: -// Entries: None -// add: [ b a ] => [ TMP[add, 0] ] -// Assignment(x): [ TMP[add, 0] ] => [ x ] -// sub: [ a x ] => [ TMP[sub, 0] ] -// Assignment(r): [ TMP[sub, 0] ] => [ r ] -// FunctionReturn of f -// function g(): -// Block 0: -// Entries: None -// sstore: [ 0x0101 0x01 ] => [ ] -// FunctionReturn of g -// function h(x): -// Block 0: -// Entries: None -// f: [ RET[f] 0x00 x ] => [ TMP[f, 0] ] -// h: [ RET[h] TMP[f, 0] ] => [ ] -// g: [ RET[g] ] => [ ] -// FunctionReturn of h -// function i() -> v, w: -// Block 0: -// Entries: None -// Assignment(v): [ 0x0202 ] => [ v ] -// Assignment(w): [ 0x0303 ] => [ w ] -// FunctionReturn of i +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// i: [ RET[i] ] => [ TMP[i, 0] TMP[i, 1] ]\l\ +// Assignment(x, y): [ TMP[i, 0] TMP[i, 1] ] => [ x y ]\l\ +// h: [ RET[h] x ] => [ ]\l\ +// h: [ RET[h] y ] => [ ]\l\ +// "]; +// Block0Exit [label="MainExit"]; +// Block0 -> Block0Exit; +// +// FunctionEntry_f [label="function f(a, b) -> r"]; +// FunctionEntry_f -> Block1; +// Block1 [label="\ +// add: [ b a ] => [ TMP[add, 0] ]\l\ +// Assignment(x): [ TMP[add, 0] ] => [ x ]\l\ +// sub: [ a x ] => [ TMP[sub, 0] ]\l\ +// Assignment(r): [ TMP[sub, 0] ] => [ r ]\l\ +// "]; +// Block1Exit [label="FunctionReturn[f]"]; +// Block1 -> Block1Exit; +// +// FunctionEntry_g [label="function g()"]; +// FunctionEntry_g -> Block2; +// Block2 [label="\ +// sstore: [ 0x0101 0x01 ] => [ ]\l\ +// "]; +// Block2Exit [label="FunctionReturn[g]"]; +// Block2 -> Block2Exit; +// +// FunctionEntry_h [label="function h(x)"]; +// FunctionEntry_h -> Block3; +// Block3 [label="\ +// f: [ RET[f] 0x00 x ] => [ TMP[f, 0] ]\l\ +// h: [ RET[h] TMP[f, 0] ] => [ ]\l\ +// g: [ RET[g] ] => [ ]\l\ +// "]; +// Block3Exit [label="FunctionReturn[h]"]; +// Block3 -> Block3Exit; +// +// FunctionEntry_i [label="function i() -> v, w"]; +// FunctionEntry_i -> Block4; +// Block4 [label="\ +// Assignment(v): [ 0x0202 ] => [ v ]\l\ +// Assignment(w): [ 0x0303 ] => [ w ]\l\ +// "]; +// Block4Exit [label="FunctionReturn[i]"]; +// Block4 -> Block4Exit; +// +// } diff --git a/test/libyul/yulControlFlowGraph/if.yul b/test/libyul/yulControlFlowGraph/if.yul index d3e15d550..a313c53ee 100644 --- a/test/libyul/yulControlFlowGraph/if.yul +++ b/test/libyul/yulControlFlowGraph/if.yul @@ -6,18 +6,32 @@ sstore(0x03, 0x003) } // ---- -// Block 0: -// Entries: None -// sstore: [ 0x0101 0x01 ] => [ ] -// calldataload: [ 0x00 ] => [ TMP[calldataload, 0] ] -// ConditionalJump TMP[calldataload, 0]: -// NonZero: 1 -// Zero: 2 -// Block 1: -// Entries: 0 -// sstore: [ 0x0202 0x02 ] => [ ] -// Jump: 2 -// Block 2: -// Entries: 0, 1 -// sstore: [ 0x03 0x03 ] => [ ] -// MainExit +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// sstore: [ 0x0101 0x01 ] => [ ]\l\ +// calldataload: [ 0x00 ] => [ TMP[calldataload, 0] ]\l\ +// "]; +// Block0 -> Block0Exit; +// Block0Exit [label="{ TMP[calldataload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block0Exit:0 -> Block1; +// Block0Exit:1 -> Block2; +// +// Block1 [label="\ +// sstore: [ 0x03 0x03 ] => [ ]\l\ +// "]; +// Block1Exit [label="MainExit"]; +// Block1 -> Block1Exit; +// +// Block2 [label="\ +// sstore: [ 0x0202 0x02 ] => [ ]\l\ +// "]; +// Block2 -> Block2Exit [arrowhead=none]; +// Block2Exit [label="Jump" shape=oval]; +// Block2Exit -> Block1; +// +// } diff --git a/test/libyul/yulControlFlowGraph/leave.yul b/test/libyul/yulControlFlowGraph/leave.yul new file mode 100644 index 000000000..d966dfa16 --- /dev/null +++ b/test/libyul/yulControlFlowGraph/leave.yul @@ -0,0 +1,51 @@ +{ + function f(a, b) -> c { + sstore(0x01, 0x0101) + if lt(a,b) { + sstore(0x02, 0x0202) + leave + sstore(0x03, 0x0303) + } + sstore(0x04, 0x0404) + } + + pop(f(0,1)) +} +// ---- +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// f: [ RET[f] 0x01 0x00 ] => [ TMP[f, 0] ]\l\ +// pop: [ TMP[f, 0] ] => [ ]\l\ +// "]; +// Block0Exit [label="MainExit"]; +// Block0 -> Block0Exit; +// +// FunctionEntry_f [label="function f(a, b) -> c"]; +// FunctionEntry_f -> Block1; +// Block1 [label="\ +// sstore: [ 0x0101 0x01 ] => [ ]\l\ +// lt: [ b a ] => [ TMP[lt, 0] ]\l\ +// "]; +// Block1 -> Block1Exit; +// Block1Exit [label="{ TMP[lt, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block1Exit:0 -> Block2; +// Block1Exit:1 -> Block3; +// +// Block2 [label="\ +// sstore: [ 0x0404 0x04 ] => [ ]\l\ +// "]; +// Block2Exit [label="FunctionReturn[f]"]; +// Block2 -> Block2Exit; +// +// Block3 [label="\ +// sstore: [ 0x0202 0x02 ] => [ ]\l\ +// "]; +// Block3Exit [label="FunctionReturn[f]"]; +// Block3 -> Block3Exit; +// +// } diff --git a/test/libyul/yulControlFlowGraph/nested_loop_complex.yul b/test/libyul/yulControlFlowGraph/nested_loop_complex.yul new file mode 100644 index 000000000..ea9aedf76 --- /dev/null +++ b/test/libyul/yulControlFlowGraph/nested_loop_complex.yul @@ -0,0 +1,193 @@ +{ + for { let x := 0 } lt(x, 0x0101) { + sstore(x, 0x0202) + for { let y := 0 } lt(y, 0x0303) { y := add(y, 0x0404) } { + sstore(y, 0x0505) + } + x := add(x, 0x0202) + } + { + sstore(0x0606, 0x0606) + if sload(0x0707) { continue } + sstore(0x0808, 0x0808) + if sload(0x0909) { break } + sstore(0x0A0A, 0x0B0B) + for { let z := 0 } lt(z, 0x0C0C) { z := add(z, 1) } { + sstore(0x0D0D, 0x0D0D) + if sload(0x0E0E) { + continue + } + sstore(0x0F0F, 0x0F0F) + if sload(0x1010) { + break + } + sstore(0x1111, 0x1111) + } + sstore(0x1212, 0x1212) + } +} +// ---- +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// Assignment(x): [ 0x00 ] => [ x ]\l\ +// "]; +// Block0 -> Block0Exit [arrowhead=none]; +// Block0Exit [label="Jump" shape=oval]; +// Block0Exit -> Block1; +// +// Block1 [label="\ +// lt: [ 0x0101 x ] => [ TMP[lt, 0] ]\l\ +// "]; +// Block1 -> Block1Exit; +// Block1Exit [label="{ TMP[lt, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block1Exit:0 -> Block2; +// Block1Exit:1 -> Block3; +// +// Block2 [label="\ +// "]; +// Block2Exit [label="MainExit"]; +// Block2 -> Block2Exit; +// +// Block3 [label="\ +// sstore: [ 0x0606 0x0606 ] => [ ]\l\ +// sload: [ 0x0707 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block3 -> Block3Exit; +// Block3Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block3Exit:0 -> Block4; +// Block3Exit:1 -> Block5; +// +// Block4 [label="\ +// sstore: [ 0x0808 0x0808 ] => [ ]\l\ +// sload: [ 0x0909 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block4 -> Block4Exit; +// Block4Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block4Exit:0 -> Block6; +// Block4Exit:1 -> Block7; +// +// Block5 [label="\ +// "]; +// Block5 -> Block5Exit [arrowhead=none]; +// Block5Exit [label="Jump" shape=oval]; +// Block5Exit -> Block8; +// +// Block6 [label="\ +// sstore: [ 0x0b0b 0x0a0a ] => [ ]\l\ +// Assignment(z): [ 0x00 ] => [ z ]\l\ +// "]; +// Block6 -> Block6Exit [arrowhead=none]; +// Block6Exit [label="Jump" shape=oval]; +// Block6Exit -> Block9; +// +// Block7 [label="\ +// "]; +// Block7 -> Block7Exit [arrowhead=none]; +// Block7Exit [label="Jump" shape=oval]; +// Block7Exit -> Block2; +// +// Block8 [label="\ +// sstore: [ 0x0202 x ] => [ ]\l\ +// Assignment(y): [ 0x00 ] => [ y ]\l\ +// "]; +// Block8 -> Block8Exit [arrowhead=none]; +// Block8Exit [label="Jump" shape=oval]; +// Block8Exit -> Block10; +// +// Block9 [label="\ +// lt: [ 0x0c0c z ] => [ TMP[lt, 0] ]\l\ +// "]; +// Block9 -> Block9Exit; +// Block9Exit [label="{ TMP[lt, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block9Exit:0 -> Block11; +// Block9Exit:1 -> Block12; +// +// Block10 [label="\ +// lt: [ 0x0303 y ] => [ TMP[lt, 0] ]\l\ +// "]; +// Block10 -> Block10Exit; +// Block10Exit [label="{ TMP[lt, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block10Exit:0 -> Block13; +// Block10Exit:1 -> Block14; +// +// Block11 [label="\ +// sstore: [ 0x1212 0x1212 ] => [ ]\l\ +// "]; +// Block11 -> Block11Exit [arrowhead=none]; +// Block11Exit [label="Jump" shape=oval]; +// Block11Exit -> Block8; +// +// Block12 [label="\ +// sstore: [ 0x0d0d 0x0d0d ] => [ ]\l\ +// sload: [ 0x0e0e ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block12 -> Block12Exit; +// Block12Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block12Exit:0 -> Block15; +// Block12Exit:1 -> Block16; +// +// Block13 [label="\ +// add: [ 0x0202 x ] => [ TMP[add, 0] ]\l\ +// Assignment(x): [ TMP[add, 0] ] => [ x ]\l\ +// "]; +// Block13 -> Block13Exit [arrowhead=none]; +// Block13Exit [label="BackwardsJump" shape=oval]; +// Block13Exit -> Block1; +// +// Block14 [label="\ +// sstore: [ 0x0505 y ] => [ ]\l\ +// "]; +// Block14 -> Block14Exit [arrowhead=none]; +// Block14Exit [label="Jump" shape=oval]; +// Block14Exit -> Block17; +// +// Block15 [label="\ +// sstore: [ 0x0f0f 0x0f0f ] => [ ]\l\ +// sload: [ 0x1010 ] => [ TMP[sload, 0] ]\l\ +// "]; +// Block15 -> Block15Exit; +// Block15Exit [label="{ TMP[sload, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block15Exit:0 -> Block18; +// Block15Exit:1 -> Block19; +// +// Block16 [label="\ +// "]; +// Block16 -> Block16Exit [arrowhead=none]; +// Block16Exit [label="Jump" shape=oval]; +// Block16Exit -> Block20; +// +// Block17 [label="\ +// add: [ 0x0404 y ] => [ TMP[add, 0] ]\l\ +// Assignment(y): [ TMP[add, 0] ] => [ y ]\l\ +// "]; +// Block17 -> Block17Exit [arrowhead=none]; +// Block17Exit [label="BackwardsJump" shape=oval]; +// Block17Exit -> Block10; +// +// Block18 [label="\ +// sstore: [ 0x1111 0x1111 ] => [ ]\l\ +// "]; +// Block18 -> Block18Exit [arrowhead=none]; +// Block18Exit [label="Jump" shape=oval]; +// Block18Exit -> Block20; +// +// Block19 [label="\ +// "]; +// Block19 -> Block19Exit [arrowhead=none]; +// Block19Exit [label="Jump" shape=oval]; +// Block19Exit -> Block11; +// +// Block20 [label="\ +// add: [ 0x01 z ] => [ TMP[add, 0] ]\l\ +// Assignment(z): [ TMP[add, 0] ] => [ z ]\l\ +// "]; +// Block20 -> Block20Exit [arrowhead=none]; +// Block20Exit [label="BackwardsJump" shape=oval]; +// Block20Exit -> Block9; +// +// } diff --git a/test/libyul/yulControlFlowGraph/stub.yul b/test/libyul/yulControlFlowGraph/stub.yul index 6364a6bea..4ec901619 100644 --- a/test/libyul/yulControlFlowGraph/stub.yul +++ b/test/libyul/yulControlFlowGraph/stub.yul @@ -1,6 +1,15 @@ { } // ---- -// Block 0: -// Entries: None -// MainExit +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// "]; +// Block0Exit [label="MainExit"]; +// Block0 -> Block0Exit; +// +// } diff --git a/test/libyul/yulControlFlowGraph/switch.yul b/test/libyul/yulControlFlowGraph/switch.yul index 2ebef90a2..2d6751d8a 100644 --- a/test/libyul/yulControlFlowGraph/switch.yul +++ b/test/libyul/yulControlFlowGraph/switch.yul @@ -13,34 +13,56 @@ sstore(0x04, 0x0101) } // ---- -// Block 0: -// Entries: None -// sstore: [ 0x00 0x00 ] => [ ] -// sload: [ 0x00 ] => [ TMP[sload, 0] ] -// Assignment(GHOST[0]): [ TMP[sload, 0] ] => [ GHOST[0] ] -// eq: [ GHOST[0] 0x00 ] => [ TMP[eq, 0] ] -// ConditionalJump TMP[eq, 0]: -// NonZero: 1 -// Zero: 2 -// Block 1: -// Entries: 0 -// sstore: [ 0x0101 0x01 ] => [ ] -// Jump: 3 -// Block 2: -// Entries: 0 -// eq: [ GHOST[0] 0x01 ] => [ TMP[eq, 0] ] -// ConditionalJump TMP[eq, 0]: -// NonZero: 4 -// Zero: 5 -// Block 3: -// Entries: 1, 4, 5 -// sstore: [ 0x0101 0x04 ] => [ ] -// MainExit -// Block 4: -// Entries: 2 -// sstore: [ 0x0101 0x02 ] => [ ] -// Jump: 3 -// Block 5: -// Entries: 2 -// sstore: [ 0x0101 0x03 ] => [ ] -// Jump: 3 +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// sstore: [ 0x00 0x00 ] => [ ]\l\ +// sload: [ 0x00 ] => [ TMP[sload, 0] ]\l\ +// Assignment(GHOST[0]): [ TMP[sload, 0] ] => [ GHOST[0] ]\l\ +// eq: [ GHOST[0] 0x00 ] => [ TMP[eq, 0] ]\l\ +// "]; +// Block0 -> Block0Exit; +// Block0Exit [label="{ TMP[eq, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block0Exit:0 -> Block1; +// Block0Exit:1 -> Block2; +// +// Block1 [label="\ +// eq: [ GHOST[0] 0x01 ] => [ TMP[eq, 0] ]\l\ +// "]; +// Block1 -> Block1Exit; +// Block1Exit [label="{ TMP[eq, 0]| { <0> Zero | <1> NonZero }}" shape=Mrecord]; +// Block1Exit:0 -> Block3; +// Block1Exit:1 -> Block4; +// +// Block2 [label="\ +// sstore: [ 0x0101 0x01 ] => [ ]\l\ +// "]; +// Block2 -> Block2Exit [arrowhead=none]; +// Block2Exit [label="Jump" shape=oval]; +// Block2Exit -> Block5; +// +// Block3 [label="\ +// sstore: [ 0x0101 0x03 ] => [ ]\l\ +// "]; +// Block3 -> Block3Exit [arrowhead=none]; +// Block3Exit [label="Jump" shape=oval]; +// Block3Exit -> Block5; +// +// Block4 [label="\ +// sstore: [ 0x0101 0x02 ] => [ ]\l\ +// "]; +// Block4 -> Block4Exit [arrowhead=none]; +// Block4Exit [label="Jump" shape=oval]; +// Block4Exit -> Block5; +// +// Block5 [label="\ +// sstore: [ 0x0101 0x04 ] => [ ]\l\ +// "]; +// Block5Exit [label="MainExit"]; +// Block5 -> Block5Exit; +// +// } diff --git a/test/libyul/yulControlFlowGraph/variables.yul b/test/libyul/yulControlFlowGraph/variables.yul index 717a7975e..ecd274054 100644 --- a/test/libyul/yulControlFlowGraph/variables.yul +++ b/test/libyul/yulControlFlowGraph/variables.yul @@ -8,15 +8,24 @@ sstore(x,y) } // ---- -// Block 0: -// Entries: None -// calldataload: [ 0x00 ] => [ TMP[calldataload, 0] ] -// Assignment(x): [ TMP[calldataload, 0] ] => [ x ] -// calldataload: [ 0x02 ] => [ TMP[calldataload, 0] ] -// Assignment(y): [ TMP[calldataload, 0] ] => [ y ] -// calldataload: [ 0x03 ] => [ TMP[calldataload, 0] ] -// Assignment(x): [ TMP[calldataload, 0] ] => [ x ] -// calldataload: [ 0x04 ] => [ TMP[calldataload, 0] ] -// Assignment(y): [ TMP[calldataload, 0] ] => [ y ] -// sstore: [ y x ] => [ ] -// MainExit +// digraph CFG { +// nodesep=0.7; +// node[shape=box]; +// +// Entry [label="Entry"]; +// Entry -> Block0; +// Block0 [label="\ +// calldataload: [ 0x00 ] => [ TMP[calldataload, 0] ]\l\ +// Assignment(x): [ TMP[calldataload, 0] ] => [ x ]\l\ +// calldataload: [ 0x02 ] => [ TMP[calldataload, 0] ]\l\ +// Assignment(y): [ TMP[calldataload, 0] ] => [ y ]\l\ +// calldataload: [ 0x03 ] => [ TMP[calldataload, 0] ]\l\ +// Assignment(x): [ TMP[calldataload, 0] ] => [ x ]\l\ +// calldataload: [ 0x04 ] => [ TMP[calldataload, 0] ]\l\ +// Assignment(y): [ TMP[calldataload, 0] ] => [ y ]\l\ +// sstore: [ y x ] => [ ]\l\ +// "]; +// Block0Exit [label="MainExit"]; +// Block0 -> Block0Exit; +// +// } diff --git a/test/tools/CMakeLists.txt b/test/tools/CMakeLists.txt index 73f04e097..1f62b57fc 100644 --- a/test/tools/CMakeLists.txt +++ b/test/tools/CMakeLists.txt @@ -42,4 +42,5 @@ add_executable(isoltest ../libyul/YulOptimizerTestCommon.cpp ../libyul/YulInterpreterTest.cpp ) -target_link_libraries(isoltest PRIVATE evmc libsolc solidity yulInterpreter evmasm Boost::boost Boost::program_options Boost::unit_test_framework) +target_compile_definitions(isoltest PRIVATE ISOLTEST) +target_link_libraries(isoltest PRIVATE evmc libsolc solidity yulInterpreter evmasm Boost::boost Boost::program_options Boost::unit_test_framework Threads::Threads)