Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export liveness information of Yul SSA CFG #15608

Merged
merged 3 commits into from
Dec 4, 2024
Merged

Export liveness information of Yul SSA CFG #15608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4745803
Export SSA CFG liveness data
r0qs Nov 13, 2024
51ad5d1
Update test expectations
r0qs Dec 2, 2024
cb5ad43
Make liveness optional in the Yul CFG exporter
r0qs Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions libyul/YulControlFlowGraphExporter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ using namespace solidity::langutil;
using namespace solidity::util;
using namespace solidity::yul;

YulControlFlowGraphExporter::YulControlFlowGraphExporter(ControlFlow const& _controlFlow): m_controlFlow(_controlFlow)
YulControlFlowGraphExporter::YulControlFlowGraphExporter(ControlFlow const& _controlFlow, ControlFlowLiveness const* _liveness): m_controlFlow(_controlFlow), m_liveness(_liveness)
{
}

Expand All @@ -58,37 +58,41 @@ std::string YulControlFlowGraphExporter::varToString(SSACFG const& _cfg, SSACFG:

Json YulControlFlowGraphExporter::run()
{
if (m_liveness)
yulAssert(&m_liveness->controlFlow.get() == &m_controlFlow);

Json yulObjectJson = Json::object();
yulObjectJson["blocks"] = exportBlock(*m_controlFlow.mainGraph, SSACFG::BlockId{0});
yulObjectJson["blocks"] = exportBlock(*m_controlFlow.mainGraph, SSACFG::BlockId{0}, m_liveness ? m_liveness->mainLiveness.get() : nullptr);

Json functionsJson = Json::object();
size_t index = 0;
for (auto const& [function, functionGraph]: m_controlFlow.functionGraphMapping)
functionsJson[function->name.str()] = exportFunction(*functionGraph);
functionsJson[function->name.str()] = exportFunction(*functionGraph, m_liveness ? m_liveness->functionLiveness[index++].get() : nullptr);
yulObjectJson["functions"] = functionsJson;

return yulObjectJson;
}

Json YulControlFlowGraphExporter::exportFunction(SSACFG const& _cfg)
Json YulControlFlowGraphExporter::exportFunction(SSACFG const& _cfg, SSACFGLiveness const* _liveness)
{
Json functionJson = Json::object();
functionJson["type"] = "Function";
functionJson["entry"] = "Block" + std::to_string(_cfg.entry.value);
static auto constexpr argsTransform = [](auto const& _arg) { return fmt::format("v{}", std::get<1>(_arg).value); };
functionJson["arguments"] = _cfg.arguments | ranges::views::transform(argsTransform) | ranges::to<std::vector>;
functionJson["numReturns"] = _cfg.returns.size();
functionJson["blocks"] = exportBlock(_cfg, _cfg.entry);
functionJson["blocks"] = exportBlock(_cfg, _cfg.entry, _liveness);
return functionJson;
}

Json YulControlFlowGraphExporter::exportBlock(SSACFG const& _cfg, SSACFG::BlockId _entryId)
Json YulControlFlowGraphExporter::exportBlock(SSACFG const& _cfg, SSACFG::BlockId _entryId, SSACFGLiveness const* _liveness)
{
Json blocksJson = Json::array();
util::BreadthFirstSearch<SSACFG::BlockId> bfs{{{_entryId}}};
bfs.run([&](SSACFG::BlockId _blockId, auto _addChild) {
auto const& block = _cfg.block(_blockId);
// Convert current block to JSON
Json blockJson = toJson(_cfg, _blockId);
Json blockJson = toJson(_cfg, _blockId, _liveness);

Json exitBlockJson = Json::object();
std::visit(util::GenericVisitor{
Expand Down Expand Up @@ -128,12 +132,25 @@ Json YulControlFlowGraphExporter::exportBlock(SSACFG const& _cfg, SSACFG::BlockI
return blocksJson;
}

Json YulControlFlowGraphExporter::toJson(SSACFG const& _cfg, SSACFG::BlockId _blockId)
Json YulControlFlowGraphExporter::toJson(SSACFG const& _cfg, SSACFG::BlockId _blockId, SSACFGLiveness const* _liveness)
{
auto const valueToString = [&](SSACFG::ValueId const& valueId) { return varToString(_cfg, valueId); };
Copy link
Member Author

@r0qs r0qs Dec 3, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we could generalize the SSACFGPrinter and reuse it in the exporter, so the cfg and the dot exporter could be an instance that implements its own writeBlock and "writeFunction" for different output formats.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, there's a lot of duplication here :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will address that in a follow-up PR :)


Json blockJson = Json::object();
auto const& block = _cfg.block(_blockId);

blockJson["id"] = "Block" + std::to_string(_blockId.value);
if (_liveness)
{
Json livenessJson = Json::object();
livenessJson["in"] = _liveness->liveIn(_blockId)
| ranges::views::transform(valueToString)
| ranges::to<Json::array_t>();
livenessJson["out"] = _liveness->liveOut(_blockId)
| ranges::views::transform(valueToString)
| ranges::to<Json::array_t>();
blockJson["liveness"] = livenessJson;
}
blockJson["instructions"] = Json::array();
if (!block.phis.empty())
{
Expand Down
9 changes: 5 additions & 4 deletions libyul/YulControlFlowGraphExporter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,16 @@ using namespace yul;
class YulControlFlowGraphExporter
{
public:
YulControlFlowGraphExporter(ControlFlow const& _controlFlow);
YulControlFlowGraphExporter(ControlFlow const& _controlFlow, ControlFlowLiveness const* _liveness=nullptr);
Json run();
Json exportBlock(SSACFG const& _cfg, SSACFG::BlockId _blockId);
Json exportFunction(SSACFG const& _cfg);
Json exportBlock(SSACFG const& _cfg, SSACFG::BlockId _blockId, SSACFGLiveness const* _liveness);
Json exportFunction(SSACFG const& _cfg, SSACFGLiveness const* _liveness);
std::string varToString(SSACFG const& _cfg, SSACFG::ValueId _var);

private:
ControlFlow const& m_controlFlow;
Json toJson(SSACFG const& _cfg, SSACFG::BlockId _blockId);
ControlFlowLiveness const* m_liveness;
Json toJson(SSACFG const& _cfg, SSACFG::BlockId _blockId, SSACFGLiveness const* _liveness);
Json toJson(Json& _ret, SSACFG const& _cfg, SSACFG::Operation const& _operation);
Json toJson(SSACFG const& _cfg, std::vector<SSACFG::ValueId> const& _values);
};
3 changes: 2 additions & 1 deletion libyul/YulStack.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,8 @@ Json YulStack::cfgJson() const
languageToDialect(m_language, m_evmVersion, m_eofVersion),
_object.code()->root()
);
YulControlFlowGraphExporter exporter(*controlFlow);
std::unique_ptr<ControlFlowLiveness> liveness = std::make_unique<ControlFlowLiveness>(*controlFlow);
YulControlFlowGraphExporter exporter(*controlFlow, liveness.get());
return exporter.run();
};

Expand Down
Loading