2018-11-04 08:34:21 +00:00
|
|
|
/*
|
|
|
|
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/>.
|
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2018-11-04 08:34:21 +00:00
|
|
|
/**
|
|
|
|
* Yul code and data object container.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <libyul/Object.h>
|
|
|
|
|
|
|
|
#include <libyul/AsmPrinter.h>
|
2023-05-02 13:34:12 +00:00
|
|
|
#include <libyul/AsmJsonConverter.h>
|
|
|
|
#include <libyul/AST.h>
|
2018-11-04 08:34:21 +00:00
|
|
|
#include <libyul/Exceptions.h>
|
|
|
|
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/CommonData.h>
|
2021-07-13 14:06:07 +00:00
|
|
|
#include <libsolutil/StringUtils.h>
|
2018-11-04 08:34:21 +00:00
|
|
|
|
2020-06-17 09:17:35 +00:00
|
|
|
#include <boost/algorithm/string.hpp>
|
2018-11-04 08:34:21 +00:00
|
|
|
|
2021-07-13 14:06:07 +00:00
|
|
|
#include <range/v3/view/transform.hpp>
|
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
using namespace solidity;
|
2021-08-31 13:10:40 +00:00
|
|
|
using namespace solidity::langutil;
|
2019-12-11 16:31:36 +00:00
|
|
|
using namespace solidity::util;
|
2021-08-31 13:10:40 +00:00
|
|
|
using namespace solidity::yul;
|
2018-11-04 08:34:21 +00:00
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::string Data::toString(Dialect const*, DebugInfoSelection const&, CharStreamProvider const*) const
|
2018-11-04 08:34:21 +00:00
|
|
|
{
|
2019-12-11 16:31:36 +00:00
|
|
|
return "data \"" + name.str() + "\" hex\"" + util::toHex(data) + "\"";
|
2018-11-04 08:34:21 +00:00
|
|
|
}
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::string Object::toString(
|
2021-08-31 13:10:40 +00:00
|
|
|
Dialect const* _dialect,
|
2021-09-17 18:15:19 +00:00
|
|
|
DebugInfoSelection const& _debugInfoSelection,
|
2021-08-31 13:10:40 +00:00
|
|
|
CharStreamProvider const* _soliditySourceProvider
|
|
|
|
) const
|
2021-07-13 14:06:07 +00:00
|
|
|
{
|
2021-08-31 15:22:13 +00:00
|
|
|
yulAssert(code, "No code");
|
|
|
|
yulAssert(debugData, "No debug data");
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::string useSrcComment;
|
2021-07-13 14:06:07 +00:00
|
|
|
|
2021-08-31 15:22:13 +00:00
|
|
|
if (debugData->sourceNames)
|
2021-07-13 14:06:07 +00:00
|
|
|
useSrcComment =
|
|
|
|
"/// @use-src " +
|
|
|
|
joinHumanReadable(ranges::views::transform(*debugData->sourceNames, [](auto&& _pair) {
|
2023-08-28 08:22:05 +00:00
|
|
|
return std::to_string(_pair.first) + ":" + util::escapeAndQuoteString(*_pair.second);
|
2021-07-13 14:06:07 +00:00
|
|
|
})) +
|
|
|
|
"\n";
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::string inner = "code " + AsmPrinter(
|
2021-09-17 18:15:19 +00:00
|
|
|
_dialect,
|
|
|
|
debugData->sourceNames,
|
|
|
|
_debugInfoSelection,
|
|
|
|
_soliditySourceProvider
|
|
|
|
)(*code);
|
2018-11-04 08:34:21 +00:00
|
|
|
|
|
|
|
for (auto const& obj: subObjects)
|
2021-09-17 18:15:19 +00:00
|
|
|
inner += "\n" + obj->toString(_dialect, _debugInfoSelection, _soliditySourceProvider);
|
2018-11-04 08:34:21 +00:00
|
|
|
|
2023-08-01 11:46:58 +00:00
|
|
|
return useSrcComment + "object \"" + name.str() + "\" {\n" + indent(inner, true /* _indentEmptyLines */) + "\n}";
|
2018-11-04 08:34:21 +00:00
|
|
|
}
|
2019-07-09 15:23:14 +00:00
|
|
|
|
2023-05-02 13:34:12 +00:00
|
|
|
Json::Value Data::toJson() const
|
|
|
|
{
|
|
|
|
Json::Value ret{Json::objectValue};
|
|
|
|
ret["nodeType"] = "YulData";
|
|
|
|
ret["value"] = util::toHex(data);
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
Json::Value Object::toJson() const
|
|
|
|
{
|
|
|
|
yulAssert(code, "No code");
|
|
|
|
|
|
|
|
Json::Value codeJson{Json::objectValue};
|
|
|
|
codeJson["nodeType"] = "YulCode";
|
|
|
|
codeJson["block"] = AsmJsonConverter(0 /* sourceIndex */)(*code);
|
|
|
|
|
|
|
|
Json::Value subObjectsJson{Json::arrayValue};
|
2023-08-28 08:22:05 +00:00
|
|
|
for (std::shared_ptr<ObjectNode> const& subObject: subObjects)
|
2023-05-02 13:34:12 +00:00
|
|
|
subObjectsJson.append(subObject->toJson());
|
|
|
|
|
|
|
|
Json::Value ret{Json::objectValue};
|
|
|
|
ret["nodeType"] = "YulObject";
|
|
|
|
ret["name"] = name.str();
|
|
|
|
ret["code"] = codeJson;
|
|
|
|
ret["subObjects"] = subObjectsJson;
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::set<YulString> Object::qualifiedDataNames() const
|
2019-07-09 15:23:14 +00:00
|
|
|
{
|
2023-08-28 08:22:05 +00:00
|
|
|
std::set<YulString> qualifiedNames =
|
2022-03-07 04:25:35 +00:00
|
|
|
name.empty() || util::contains(name.str(), '.') ?
|
2023-08-28 08:22:05 +00:00
|
|
|
std::set<YulString>{} :
|
|
|
|
std::set<YulString>{name};
|
|
|
|
for (std::shared_ptr<ObjectNode> const& subObjectNode: subObjects)
|
2020-06-17 09:17:35 +00:00
|
|
|
{
|
|
|
|
yulAssert(qualifiedNames.count(subObjectNode->name) == 0, "");
|
2022-03-07 04:25:35 +00:00
|
|
|
if (util::contains(subObjectNode->name.str(), '.'))
|
2021-06-08 14:35:37 +00:00
|
|
|
continue;
|
2020-06-17 09:17:35 +00:00
|
|
|
qualifiedNames.insert(subObjectNode->name);
|
|
|
|
if (auto const* subObject = dynamic_cast<Object const*>(subObjectNode.get()))
|
|
|
|
for (YulString const& subSubObj: subObject->qualifiedDataNames())
|
|
|
|
if (subObject->name != subSubObj)
|
|
|
|
{
|
|
|
|
yulAssert(qualifiedNames.count(YulString{subObject->name.str() + "." + subSubObj.str()}) == 0, "");
|
|
|
|
qualifiedNames.insert(YulString{subObject->name.str() + "." + subSubObj.str()});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
yulAssert(qualifiedNames.count(YulString{}) == 0, "");
|
|
|
|
qualifiedNames.erase(YulString{});
|
|
|
|
return qualifiedNames;
|
|
|
|
}
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::vector<size_t> Object::pathToSubObject(YulString _qualifiedName) const
|
2020-06-17 09:17:35 +00:00
|
|
|
{
|
|
|
|
yulAssert(_qualifiedName != name, "");
|
|
|
|
yulAssert(subIndexByName.count(name) == 0, "");
|
|
|
|
|
|
|
|
if (boost::algorithm::starts_with(_qualifiedName.str(), name.str() + "."))
|
|
|
|
_qualifiedName = YulString{_qualifiedName.str().substr(name.str().length() + 1)};
|
|
|
|
yulAssert(!_qualifiedName.empty(), "");
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::vector<std::string> subObjectPathComponents;
|
2020-06-17 09:17:35 +00:00
|
|
|
boost::algorithm::split(subObjectPathComponents, _qualifiedName.str(), boost::is_any_of("."));
|
|
|
|
|
2023-08-28 08:22:05 +00:00
|
|
|
std::vector<size_t> path;
|
2020-06-17 09:17:35 +00:00
|
|
|
Object const* object = this;
|
2023-08-28 08:22:05 +00:00
|
|
|
for (std::string const& currentSubObjectName: subObjectPathComponents)
|
2020-06-17 09:17:35 +00:00
|
|
|
{
|
|
|
|
yulAssert(!currentSubObjectName.empty(), "");
|
|
|
|
auto subIndexIt = object->subIndexByName.find(YulString{currentSubObjectName});
|
|
|
|
yulAssert(
|
|
|
|
subIndexIt != object->subIndexByName.end(),
|
|
|
|
"Assembly object <" + _qualifiedName.str() + "> not found or does not contain code."
|
|
|
|
);
|
|
|
|
object = dynamic_cast<Object const*>(object->subObjects[subIndexIt->second].get());
|
|
|
|
yulAssert(object, "Assembly object <" + _qualifiedName.str() + "> not found or does not contain code.");
|
2023-08-28 08:22:05 +00:00
|
|
|
yulAssert(object->subId != std::numeric_limits<size_t>::max(), "");
|
2020-06-17 09:17:35 +00:00
|
|
|
path.push_back({object->subId});
|
|
|
|
}
|
|
|
|
|
|
|
|
return path;
|
2019-07-09 15:23:14 +00:00
|
|
|
}
|