solidity/libsolidity/interface/StandardCompiler.cpp

1607 lines
55 KiB
C++
Raw Normal View History

2017-02-09 21:56:49 +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/>.
*/
// SPDX-License-Identifier: GPL-3.0
2017-02-09 21:56:49 +00:00
/**
* @author Alex Beregszaszi
* @date 2016
* Standard JSON compiler interface.
*/
#include <libsolidity/interface/StandardCompiler.h>
#include <libsolidity/interface/ImportRemapper.h>
2018-12-17 18:24:42 +00:00
#include <libsolidity/ast/ASTJsonExporter.h>
#include <libyul/YulStack.h>
#include <libyul/Exceptions.h>
#include <libyul/optimiser/Suite.h>
#include <libevmasm/Disassemble.h>
2020-05-20 10:55:12 +00:00
#include <libsmtutil/Exceptions.h>
#include <liblangutil/SourceReferenceFormatter.h>
#include <libsolutil/JSON.h>
#include <libsolutil/Keccak256.h>
2020-05-12 14:33:05 +00:00
#include <libsolutil/CommonData.h>
2017-02-09 21:56:49 +00:00
#include <boost/algorithm/string/predicate.hpp>
2018-12-17 18:24:42 +00:00
#include <algorithm>
#include <optional>
2017-02-09 21:56:49 +00:00
using namespace std;
2019-12-11 16:31:36 +00:00
using namespace solidity;
using namespace solidity::yul;
using namespace solidity::frontend;
using namespace solidity::langutil;
2017-02-09 21:56:49 +00:00
namespace
{
2017-04-19 13:11:31 +00:00
2017-03-29 14:40:15 +00:00
Json::Value formatError(
2022-06-17 03:25:52 +00:00
Error::Type _type,
2017-03-29 14:40:15 +00:00
string const& _component,
string const& _message,
string const& _formattedMessage = "",
Json::Value const& _sourceLocation = Json::Value(),
Json::Value const& _secondarySourceLocation = Json::Value()
2017-03-29 14:40:15 +00:00
)
{
Json::Value error{Json::objectValue};
2022-06-17 03:25:52 +00:00
error["type"] = Error::formatErrorType(_type);
2017-03-29 14:40:15 +00:00
error["component"] = _component;
2022-06-17 03:25:52 +00:00
error["severity"] = Error::formatErrorSeverityLowercase(Error::errorSeverity(_type));
2017-03-29 14:40:15 +00:00
error["message"] = _message;
error["formattedMessage"] = (_formattedMessage.length() > 0) ? _formattedMessage : _message;
if (_sourceLocation.isObject())
error["sourceLocation"] = _sourceLocation;
if (_secondarySourceLocation.isArray())
error["secondarySourceLocations"] = _secondarySourceLocation;
2017-03-29 14:40:15 +00:00
return error;
}
2022-06-17 03:25:52 +00:00
Json::Value formatFatalError(Error::Type _type, string const& _message)
2017-03-29 14:40:15 +00:00
{
Json::Value output{Json::objectValue};
output["errors"] = Json::arrayValue;
2022-06-17 03:25:52 +00:00
output["errors"].append(formatError(_type, "general", _message));
return output;
}
Json::Value formatSourceLocation(SourceLocation const* location)
{
if (!location || !location->sourceName)
return Json::nullValue;
Json::Value sourceLocation{Json::objectValue};
sourceLocation["file"] = *location->sourceName;
sourceLocation["start"] = location->start;
sourceLocation["end"] = location->end;
return sourceLocation;
}
Json::Value formatSecondarySourceLocation(SecondarySourceLocation const* _secondaryLocation)
{
if (!_secondaryLocation)
return Json::nullValue;
Json::Value secondarySourceLocation{Json::arrayValue};
for (auto const& location: _secondaryLocation->infos)
{
Json::Value msg = formatSourceLocation(&location.second);
msg["message"] = location.first;
secondarySourceLocation.append(msg);
}
return secondarySourceLocation;
}
Json::Value formatErrorWithException(
2021-06-29 12:38:59 +00:00
CharStreamProvider const& _charStreamProvider,
2019-12-11 16:31:36 +00:00
util::Exception const& _exception,
2022-06-17 03:25:52 +00:00
Error::Type _type,
string const& _component,
2020-05-29 23:42:36 +00:00
string const& _message,
optional<ErrorId> _errorId = nullopt
)
{
string message;
2020-11-02 14:29:33 +00:00
// TODO: consider enabling color
2021-06-29 12:38:59 +00:00
string formattedMessage = SourceReferenceFormatter::formatExceptionInformation(
_exception,
_type,
2022-06-17 03:25:52 +00:00
_charStreamProvider,
false, // colored
false // _withErrorIds
2021-06-29 12:38:59 +00:00
);
2021-12-01 11:30:36 +00:00
if (string const* description = _exception.comment())
message = ((_message.length() > 0) ? (_message + ":") : "") + *description;
else
message = _message;
2020-05-29 23:42:36 +00:00
Json::Value error = formatError(
_type,
_component,
message,
formattedMessage,
formatSourceLocation(boost::get_error_info<errinfo_sourceLocation>(_exception)),
formatSecondarySourceLocation(boost::get_error_info<errinfo_secondarySourceLocation>(_exception))
);
2020-05-29 23:42:36 +00:00
if (_errorId)
error["errorCode"] = to_string(_errorId.value().error);
return error;
}
map<string, set<string>> requestedContractNames(Json::Value const& _outputSelection)
{
map<string, set<string>> contracts;
for (auto const& sourceName: _outputSelection.getMemberNames())
{
string key = (sourceName == "*") ? "" : sourceName;
for (auto const& contractName: _outputSelection[sourceName].getMemberNames())
{
string value = (contractName == "*") ? "" : contractName;
contracts[key].insert(value);
}
}
return contracts;
}
2017-04-22 13:43:10 +00:00
/// Returns true iff @a _hash (hex with 0x prefix) is the Keccak256 hash of the binary data in @a _content.
bool hashMatchesContent(string const& _hash, string const& _content)
{
try
{
2019-12-11 16:31:36 +00:00
return util::h256(_hash) == util::keccak256(_content);
2017-04-22 13:43:10 +00:00
}
2019-12-11 16:31:36 +00:00
catch (util::BadHexCharacter const&)
2017-04-22 13:43:10 +00:00
{
return false;
}
}
2019-06-18 16:11:04 +00:00
bool isArtifactRequested(Json::Value const& _outputSelection, string const& _artifact, bool _wildcardMatchesExperimental)
{
2019-06-18 16:11:04 +00:00
static set<string> experimental{"ir", "irOptimized", "wast", "ewasm", "ewasm.wast"};
for (auto const& selectedArtifactJson: _outputSelection)
{
string const& selectedArtifact = selectedArtifactJson.asString();
if (
_artifact == selectedArtifact ||
boost::algorithm::starts_with(_artifact, selectedArtifact + ".")
)
return true;
else if (selectedArtifact == "*")
2019-03-04 22:26:46 +00:00
{
2019-06-18 16:11:04 +00:00
// "ir", "irOptimized", "wast" and "ewasm.wast" can only be matched by "*" if activated.
if (experimental.count(_artifact) == 0 || _wildcardMatchesExperimental)
2019-03-04 22:26:46 +00:00
return true;
}
}
return false;
}
///
2020-05-24 17:41:15 +00:00
/// @a _outputSelection is a JSON object containing a two-level hashmap, where the first level is the filename,
/// the second level is the contract name and the value is an array of artifact names to be requested for that contract.
/// @a _file is the current file
/// @a _contract is the current contract
/// @a _artifact is the current artifact name
///
/// @returns true if the @a _outputSelection has a match for the requested target in the specific file / contract.
///
/// In @a _outputSelection the use of '*' as a wildcard is permitted.
///
/// @TODO optimise this. Perhaps flatten the structure upfront.
///
2019-06-18 16:11:04 +00:00
bool isArtifactRequested(Json::Value const& _outputSelection, string const& _file, string const& _contract, string const& _artifact, bool _wildcardMatchesExperimental)
{
if (!_outputSelection.isObject())
return false;
for (auto const& file: { _file, string("*") })
if (_outputSelection.isMember(file) && _outputSelection[file].isObject())
{
2017-11-22 13:35:01 +00:00
/// For SourceUnit-level targets (such as AST) only allow empty name, otherwise
/// for Contract-level targets try both contract name and wildcard
vector<string> contracts{ _contract };
if (!_contract.empty())
2020-04-01 02:39:38 +00:00
contracts.emplace_back("*");
2017-11-22 13:35:01 +00:00
for (auto const& contract: contracts)
if (
2017-11-22 13:35:01 +00:00
_outputSelection[file].isMember(contract) &&
_outputSelection[file][contract].isArray() &&
2019-06-18 16:11:04 +00:00
isArtifactRequested(_outputSelection[file][contract], _artifact, _wildcardMatchesExperimental)
)
return true;
}
return false;
}
2019-06-18 16:11:04 +00:00
bool isArtifactRequested(Json::Value const& _outputSelection, string const& _file, string const& _contract, vector<string> const& _artifacts, bool _wildcardMatchesExperimental)
{
for (auto const& artifact: _artifacts)
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_outputSelection, _file, _contract, artifact, _wildcardMatchesExperimental))
return true;
return false;
}
2020-09-15 09:21:13 +00:00
/// @returns all artifact names of the EVM object, either for creation or deploy time.
vector<string> evmObjectComponents(string const& _objectKind)
{
solAssert(_objectKind == "bytecode" || _objectKind == "deployedBytecode", "");
2020-05-07 12:46:47 +00:00
vector<string> components{"", ".object", ".opcodes", ".sourceMap", ".functionDebugData", ".generatedSources", ".linkReferences"};
2020-09-15 09:21:13 +00:00
if (_objectKind == "deployedBytecode")
components.push_back(".immutableReferences");
return util::applyMap(components, [&](auto const& _s) { return "evm." + _objectKind + _s; });
}
/// @returns true if any binary was requested, i.e. we actually have to perform compilation.
bool isBinaryRequested(Json::Value const& _outputSelection)
{
if (!_outputSelection.isObject())
return false;
2020-05-24 17:41:15 +00:00
// This does not include "evm.methodIdentifiers" on purpose!
2020-09-15 09:21:13 +00:00
static vector<string> const outputsThatRequireBinaries = vector<string>{
"*",
2019-03-04 22:26:46 +00:00
"ir", "irOptimized",
2019-06-18 16:11:04 +00:00
"wast", "wasm", "ewasm.wast", "ewasm.wasm",
"evm.gasEstimates", "evm.legacyAssembly", "evm.assembly"
2020-09-15 09:21:13 +00:00
} + evmObjectComponents("bytecode") + evmObjectComponents("deployedBytecode");
for (auto const& fileRequests: _outputSelection)
for (auto const& requests: fileRequests)
for (auto const& output: outputsThatRequireBinaries)
2019-03-04 22:26:46 +00:00
if (isArtifactRequested(requests, output, false))
return true;
return false;
}
/// @returns true if EVM bytecode was requested, i.e. we have to run the old code generator.
bool isEvmBytecodeRequested(Json::Value const& _outputSelection)
{
if (!_outputSelection.isObject())
return false;
2020-09-15 09:21:13 +00:00
static vector<string> const outputsThatRequireEvmBinaries = vector<string>{
"*",
"evm.gasEstimates", "evm.legacyAssembly", "evm.assembly"
2020-09-15 09:21:13 +00:00
} + evmObjectComponents("bytecode") + evmObjectComponents("deployedBytecode");
for (auto const& fileRequests: _outputSelection)
for (auto const& requests: fileRequests)
for (auto const& output: outputsThatRequireEvmBinaries)
if (isArtifactRequested(requests, output, false))
return true;
return false;
}
2019-12-09 16:36:12 +00:00
/// @returns true if any Ewasm code was requested. Note that as an exception, '*' does not
2019-06-18 16:11:04 +00:00
/// yet match "ewasm.wast" or "ewasm"
2019-12-09 16:36:12 +00:00
bool isEwasmRequested(Json::Value const& _outputSelection)
2019-06-18 16:11:04 +00:00
{
if (!_outputSelection.isObject())
return false;
for (auto const& fileRequests: _outputSelection)
for (auto const& requests: fileRequests)
for (auto const& request: requests)
if (request == "ewasm" || request == "ewasm.wast")
return true;
return false;
}
2019-03-04 22:26:46 +00:00
/// @returns true if any Yul IR was requested. Note that as an exception, '*' does not
/// yet match "ir" or "irOptimized"
bool isIRRequested(Json::Value const& _outputSelection)
{
2019-12-09 16:36:12 +00:00
if (isEwasmRequested(_outputSelection))
2019-06-18 16:11:04 +00:00
return true;
2019-03-04 22:26:46 +00:00
if (!_outputSelection.isObject())
return false;
for (auto const& fileRequests: _outputSelection)
for (auto const& requests: fileRequests)
for (auto const& request: requests)
if (request == "ir" || request == "irOptimized")
return true;
2019-03-04 22:26:46 +00:00
return false;
}
2017-03-30 01:09:42 +00:00
Json::Value formatLinkReferences(std::map<size_t, std::string> const& linkReferences)
{
Json::Value ret{Json::objectValue};
2017-03-30 01:09:42 +00:00
for (auto const& ref: linkReferences)
{
string const& fullname = ref.second;
// If the link reference does not contain a colon, assume that the file name is missing and
// the whole string represents the library name.
size_t colon = fullname.rfind(':');
string file = (colon != string::npos ? fullname.substr(0, colon) : "");
string name = (colon != string::npos ? fullname.substr(colon + 1) : fullname);
2017-03-30 01:09:42 +00:00
Json::Value fileObject = ret.get(file, Json::objectValue);
Json::Value libraryArray = fileObject.get(name, Json::arrayValue);
Json::Value entry{Json::objectValue};
2017-03-30 01:09:42 +00:00
entry["start"] = Json::UInt(ref.first);
entry["length"] = 20;
libraryArray.append(entry);
fileObject[name] = libraryArray;
ret[file] = fileObject;
}
return ret;
}
Json::Value formatImmutableReferences(map<u256, pair<string, vector<size_t>>> const& _immutableReferences)
{
Json::Value ret{Json::objectValue};
for (auto const& immutableReference: _immutableReferences)
{
auto const& [identifier, byteOffsets] = immutableReference.second;
Json::Value array(Json::arrayValue);
for (size_t byteOffset: byteOffsets)
{
Json::Value byteRange{Json::objectValue};
byteRange["start"] = Json::UInt(byteOffset);
byteRange["length"] = Json::UInt(32); // immutable references are currently always 32 bytes wide
array.append(byteRange);
}
ret[identifier] = array;
}
return ret;
}
Json::Value collectEVMObject(
langutil::EVMVersion _evmVersion,
evmasm::LinkerObject const& _object,
string const* _sourceMap,
Json::Value _generatedSources,
bool _runtimeObject,
function<bool(string)> const& _artifactRequested
)
2017-04-19 14:52:54 +00:00
{
Json::Value output{Json::objectValue};
if (_artifactRequested("object"))
output["object"] = _object.toHex();
if (_artifactRequested("opcodes"))
output["opcodes"] = evmasm::disassemble(_object.bytecode, _evmVersion);
if (_artifactRequested("sourceMap"))
output["sourceMap"] = _sourceMap ? *_sourceMap : "";
2020-05-07 12:46:47 +00:00
if (_artifactRequested("functionDebugData"))
output["functionDebugData"] = StandardCompiler::formatFunctionDebugData(_object.functionDebugData);
if (_artifactRequested("linkReferences"))
output["linkReferences"] = formatLinkReferences(_object.linkReferences);
if (_runtimeObject && _artifactRequested("immutableReferences"))
output["immutableReferences"] = formatImmutableReferences(_object.immutableReferences);
if (_artifactRequested("generatedSources"))
2022-08-23 17:28:45 +00:00
output["generatedSources"] = std::move(_generatedSources);
2017-04-19 14:52:54 +00:00
return output;
}
std::optional<Json::Value> checkKeys(Json::Value const& _input, set<string> const& _keys, string const& _name)
{
if (!!_input && !_input.isObject())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"" + _name + "\" must be an object");
for (auto const& member: _input.getMemberNames())
if (!_keys.count(member))
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Unknown key \"" + member + "\"");
return std::nullopt;
}
std::optional<Json::Value> checkRootKeys(Json::Value const& _input)
{
static set<string> keys{"auxiliaryInput", "language", "settings", "sources"};
return checkKeys(_input, keys, "root");
}
std::optional<Json::Value> checkSourceKeys(Json::Value const& _input, string const& _name)
{
static set<string> keys{"content", "keccak256", "urls"};
return checkKeys(_input, keys, "sources." + _name);
}
std::optional<Json::Value> checkAuxiliaryInputKeys(Json::Value const& _input)
{
static set<string> keys{"smtlib2responses"};
return checkKeys(_input, keys, "auxiliaryInput");
}
std::optional<Json::Value> checkSettingsKeys(Json::Value const& _input)
{
static set<string> keys{"parserErrorRecovery", "debug", "evmVersion", "libraries", "metadata", "modelChecker", "optimizer", "outputSelection", "remappings", "stopAfter", "viaIR"};
return checkKeys(_input, keys, "settings");
}
std::optional<Json::Value> checkModelCheckerSettingsKeys(Json::Value const& _input)
{
2021-10-06 09:51:22 +00:00
static set<string> keys{"contracts", "divModNoSlacks", "engine", "invariants", "showUnproved", "solvers", "targets", "timeout"};
return checkKeys(_input, keys, "modelChecker");
}
std::optional<Json::Value> checkOptimizerKeys(Json::Value const& _input)
{
static set<string> keys{"details", "enabled", "runs"};
return checkKeys(_input, keys, "settings.optimizer");
}
std::optional<Json::Value> checkOptimizerDetailsKeys(Json::Value const& _input)
{
static set<string> keys{"peephole", "inliner", "jumpdestRemover", "orderLiterals", "deduplicate", "cse", "constantOptimizer", "yul", "yulDetails"};
return checkKeys(_input, keys, "settings.optimizer.details");
}
std::optional<Json::Value> checkOptimizerDetail(Json::Value const& _details, std::string const& _name, bool& _setting)
{
if (_details.isMember(_name))
{
if (!_details[_name].isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.optimizer.details." + _name + "\" must be Boolean");
_setting = _details[_name].asBool();
}
return {};
}
std::optional<Json::Value> checkOptimizerDetailSteps(Json::Value const& _details, std::string const& _name, string& _optimiserSetting, string& _cleanupSetting)
{
if (_details.isMember(_name))
{
if (_details[_name].isString())
{
try
{
yul::OptimiserSuite::validateSequence(_details[_name].asString());
}
catch (yul::OptimizerException const& _exception)
{
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"Invalid optimizer step sequence in \"settings.optimizer.details." + _name + "\": " + _exception.what()
);
}
2022-08-23 09:58:12 +00:00
string const fullSequence = _details[_name].asString();
auto const delimiterPos = fullSequence.find(":");
_optimiserSetting = fullSequence.substr(0, delimiterPos);
if (delimiterPos != string::npos)
_cleanupSetting = fullSequence.substr(delimiterPos + 1);
2022-09-12 08:57:02 +00:00
else
solAssert(_cleanupSetting == OptimiserSettings::DefaultYulOptimiserCleanupSteps);
}
else
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.optimizer.details." + _name + "\" must be a string");
}
return {};
}
std::optional<Json::Value> checkMetadataKeys(Json::Value const& _input)
{
2019-09-06 17:11:07 +00:00
if (_input.isObject())
{
if (_input.isMember("appendCBOR") && !_input["appendCBOR"].isBool())
return formatFatalError(Error::Type::JSONError, "\"settings.metadata.appendCBOR\" must be Boolean");
2019-09-06 17:11:07 +00:00
if (_input.isMember("useLiteralContent") && !_input["useLiteralContent"].isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.metadata.useLiteralContent\" must be Boolean");
2019-09-06 17:11:07 +00:00
static set<string> hashes{"ipfs", "bzzr1", "none"};
if (_input.isMember("bytecodeHash") && !hashes.count(_input["bytecodeHash"].asString()))
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.metadata.bytecodeHash\" must be \"ipfs\", \"bzzr1\" or \"none\"");
2019-09-06 17:11:07 +00:00
}
static set<string> keys{"appendCBOR", "useLiteralContent", "bytecodeHash"};
return checkKeys(_input, keys, "settings.metadata");
}
std::optional<Json::Value> checkOutputSelection(Json::Value const& _outputSelection)
{
if (!!_outputSelection && !_outputSelection.isObject())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.outputSelection\" must be an object");
for (auto const& sourceName: _outputSelection.getMemberNames())
{
auto const& sourceVal = _outputSelection[sourceName];
if (!sourceVal.isObject())
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"\"settings.outputSelection." + sourceName + "\" must be an object"
);
for (auto const& contractName: sourceVal.getMemberNames())
{
auto const& contractVal = sourceVal[contractName];
if (!contractVal.isArray())
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"\"settings.outputSelection." +
sourceName +
"." +
contractName +
"\" must be a string array"
);
for (auto const& output: contractVal)
if (!output.isString())
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"\"settings.outputSelection." +
sourceName +
"." +
contractName +
"\" must be a string array"
);
}
}
return std::nullopt;
}
/// Validates the optimizer settings and returns them in a parsed object.
/// On error returns the json-formatted error message.
std::variant<OptimiserSettings, Json::Value> parseOptimizerSettings(Json::Value const& _jsonInput)
{
if (auto result = checkOptimizerKeys(_jsonInput))
return *result;
OptimiserSettings settings = OptimiserSettings::minimal();
if (_jsonInput.isMember("enabled"))
{
if (!_jsonInput["enabled"].isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "The \"enabled\" setting must be a Boolean.");
if (_jsonInput["enabled"].asBool())
settings = OptimiserSettings::standard();
}
if (_jsonInput.isMember("runs"))
{
if (!_jsonInput["runs"].isUInt())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "The \"runs\" setting must be an unsigned number.");
settings.expectedExecutionsPerDeployment = _jsonInput["runs"].asUInt();
}
if (_jsonInput.isMember("details"))
{
Json::Value const& details = _jsonInput["details"];
if (auto result = checkOptimizerDetailsKeys(details))
return *result;
if (auto error = checkOptimizerDetail(details, "peephole", settings.runPeephole))
return *error;
2021-01-14 12:02:14 +00:00
if (auto error = checkOptimizerDetail(details, "inliner", settings.runInliner))
return *error;
if (auto error = checkOptimizerDetail(details, "jumpdestRemover", settings.runJumpdestRemover))
return *error;
if (auto error = checkOptimizerDetail(details, "orderLiterals", settings.runOrderLiterals))
return *error;
if (auto error = checkOptimizerDetail(details, "deduplicate", settings.runDeduplicate))
return *error;
if (auto error = checkOptimizerDetail(details, "cse", settings.runCSE))
return *error;
if (auto error = checkOptimizerDetail(details, "constantOptimizer", settings.runConstantOptimiser))
return *error;
if (auto error = checkOptimizerDetail(details, "yul", settings.runYulOptimiser))
return *error;
2019-11-26 15:41:58 +00:00
settings.optimizeStackAllocation = settings.runYulOptimiser;
if (details.isMember("yulDetails"))
{
2019-02-26 18:55:13 +00:00
if (!settings.runYulOptimiser)
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"Providing yulDetails requires Yul optimizer to be enabled.");
2019-02-26 18:55:13 +00:00
if (auto result = checkKeys(details["yulDetails"], {"stackAllocation", "optimizerSteps"}, "settings.optimizer.details.yulDetails"))
2019-02-26 18:55:13 +00:00
return *result;
if (auto error = checkOptimizerDetail(details["yulDetails"], "stackAllocation", settings.optimizeStackAllocation))
return *error;
if (auto error = checkOptimizerDetailSteps(details["yulDetails"], "optimizerSteps", settings.yulOptimiserSteps, settings.yulOptimiserCleanupSteps))
return *error;
}
}
return { std::move(settings) };
}
}
2020-05-07 12:46:47 +00:00
std::variant<StandardCompiler::InputsAndSettings, Json::Value> StandardCompiler::parseInput(Json::Value const& _input)
{
InputsAndSettings ret;
if (!_input.isObject())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Input is not a JSON object.");
if (auto result = checkRootKeys(_input))
return *result;
ret.language = _input["language"].asString();
Json::Value const& sources = _input["sources"];
if (!sources.isObject() && !sources.isNull())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"sources\" is not a JSON object.");
if (sources.empty())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "No input sources specified.");
ret.errors = Json::arrayValue;
for (auto const& sourceName: sources.getMemberNames())
2017-04-22 13:43:10 +00:00
{
string hash;
2017-04-24 21:38:03 +00:00
if (auto result = checkSourceKeys(sources[sourceName], sourceName))
return *result;
2017-04-22 13:43:10 +00:00
if (sources[sourceName]["keccak256"].isString())
hash = sources[sourceName]["keccak256"].asString();
2017-03-30 02:17:17 +00:00
if (sources[sourceName]["content"].isString())
2017-04-22 13:43:10 +00:00
{
string content = sources[sourceName]["content"].asString();
if (!hash.empty() && !hashMatchesContent(hash, content))
ret.errors.append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::IOError,
2017-04-22 13:43:10 +00:00
"general",
"Mismatch between content and supplied hash for \"" + sourceName + "\""
));
else
ret.sources[sourceName] = content;
2017-04-22 13:43:10 +00:00
}
2017-03-30 02:17:17 +00:00
else if (sources[sourceName]["urls"].isArray())
{
if (!m_readFile)
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "No import callback supplied, but URL is requested.");
vector<string> failures;
2022-06-17 03:25:52 +00:00
bool found = false;
for (auto const& url: sources[sourceName]["urls"])
{
if (!url.isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "URL must be a string.");
ReadCallback::Result result = m_readFile(ReadCallback::kindString(ReadCallback::Kind::ReadFile), url.asString());
if (result.success)
{
2017-07-13 19:06:04 +00:00
if (!hash.empty() && !hashMatchesContent(hash, result.responseOrErrorMessage))
ret.errors.append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::IOError,
2017-04-22 13:43:10 +00:00
"general",
"Mismatch between content and supplied hash for \"" + sourceName + "\" at \"" + url.asString() + "\""
));
else
{
2020-04-01 03:04:29 +00:00
ret.sources[sourceName] = result.responseOrErrorMessage;
2017-04-22 13:43:10 +00:00
found = true;
break;
}
}
else
2017-07-13 19:06:04 +00:00
failures.push_back("Cannot import url (\"" + url.asString() + "\"): " + result.responseOrErrorMessage);
}
for (auto const& failure: failures)
{
/// If the import succeeded, let mark all the others as warnings, otherwise all of them are errors.
ret.errors.append(formatError(
2022-06-17 03:25:52 +00:00
found ? Error::Type::Warning : Error::Type::IOError,
"general",
failure
));
}
}
2017-03-30 02:17:17 +00:00
else
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid input source specified.");
2017-04-22 13:43:10 +00:00
}
Json::Value const& auxInputs = _input["auxiliaryInput"];
if (auto result = checkAuxiliaryInputKeys(auxInputs))
return *result;
if (!!auxInputs)
{
Json::Value const& smtlib2Responses = auxInputs["smtlib2responses"];
if (!!smtlib2Responses)
{
if (!smtlib2Responses.isObject())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"auxiliaryInput.smtlib2responses\" must be an object.");
for (auto const& hashString: smtlib2Responses.getMemberNames())
{
2019-12-11 16:31:36 +00:00
util::h256 hash;
try
{
2019-12-11 16:31:36 +00:00
hash = util::h256(hashString);
}
2019-12-11 16:31:36 +00:00
catch (util::BadHexCharacter const&)
{
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid hex encoding of SMTLib2 auxiliary input.");
}
if (!smtlib2Responses[hashString].isString())
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"\"smtlib2Responses." + hashString + "\" must be a string."
);
ret.smtLib2Responses[hash] = smtlib2Responses[hashString].asString();
}
}
}
Json::Value const& settings = _input.get("settings", Json::Value());
if (auto result = checkSettingsKeys(settings))
return *result;
2020-07-08 20:08:50 +00:00
if (settings.isMember("stopAfter"))
{
if (!settings["stopAfter"].isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.stopAfter\" must be a string.");
2020-07-08 20:08:50 +00:00
if (settings["stopAfter"].asString() != "parsing")
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid value for \"settings.stopAfter\". Only valid value is \"parsing\".");
2020-07-08 20:08:50 +00:00
ret.stopAfter = CompilerStack::State::Parsed;
}
if (settings.isMember("parserErrorRecovery"))
{
if (!settings["parserErrorRecovery"].isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.parserErrorRecovery\" must be a Boolean.");
ret.parserErrorRecovery = settings["parserErrorRecovery"].asBool();
}
2020-11-12 01:31:06 +00:00
if (settings.isMember("viaIR"))
{
if (!settings["viaIR"].isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.viaIR\" must be a Boolean.");
2020-11-12 01:31:06 +00:00
ret.viaIR = settings["viaIR"].asBool();
}
if (settings.isMember("evmVersion"))
{
if (!settings["evmVersion"].isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "evmVersion must be a string.");
std::optional<langutil::EVMVersion> version = langutil::EVMVersion::fromString(settings["evmVersion"].asString());
if (!version)
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid EVM version requested.");
ret.evmVersion = *version;
}
if (settings.isMember("eofVersion"))
{
if (!settings["eofVersion"].isUInt())
return formatFatalError(Error::Type::JSONError, "eofVersion must be an unsigned integer.");
auto eofVersion = settings["evmVersion"].asUInt();
if (eofVersion != 1)
return formatFatalError(Error::Type::JSONError, "Invalid EOF version requested.");
ret.eofVersion = 1;
}
if (settings.isMember("debug"))
{
if (auto result = checkKeys(settings["debug"], {"revertStrings", "debugInfo"}, "settings.debug"))
return *result;
if (settings["debug"].isMember("revertStrings"))
{
if (!settings["debug"]["revertStrings"].isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.debug.revertStrings must be a string.");
std::optional<RevertStrings> revertStrings = revertStringsFromString(settings["debug"]["revertStrings"].asString());
if (!revertStrings)
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid value for settings.debug.revertStrings.");
2020-01-22 14:48:56 +00:00
if (*revertStrings == RevertStrings::VerboseDebug)
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::UnimplementedFeatureError,
2020-01-22 14:48:56 +00:00
"Only \"default\", \"strip\" and \"debug\" are implemented for settings.debug.revertStrings for now."
);
ret.revertStrings = *revertStrings;
}
if (settings["debug"].isMember("debugInfo"))
{
if (!settings["debug"]["debugInfo"].isArray())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.debug.debugInfo must be an array.");
vector<string> components;
for (Json::Value const& arrayValue: settings["debug"]["debugInfo"])
components.push_back(arrayValue.asString());
optional<DebugInfoSelection> debugInfoSelection = DebugInfoSelection::fromComponents(
components,
true /* _acceptWildcards */
);
if (!debugInfoSelection.has_value())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid value in settings.debug.debugInfo.");
if (debugInfoSelection->snippet && !debugInfoSelection->location)
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"To use 'snippet' with settings.debug.debugInfo you must select also 'location'."
);
ret.debugInfoSelection = debugInfoSelection.value();
}
}
if (settings.isMember("remappings") && !settings["remappings"].isArray())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.remappings\" must be an array of strings.");
2017-03-17 12:30:50 +00:00
for (auto const& remapping: settings.get("remappings", Json::Value()))
2018-08-09 18:37:49 +00:00
{
if (!remapping.isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"settings.remappings\" must be an array of strings");
if (auto r = ImportRemapper::parseRemapping(remapping.asString()))
ret.remappings.emplace_back(std::move(*r));
2018-08-09 18:37:49 +00:00
else
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid remapping: \"" + remapping.asString() + "\"");
2018-08-09 18:37:49 +00:00
}
2017-03-17 12:30:50 +00:00
if (settings.isMember("optimizer"))
{
auto optimiserSettings = parseOptimizerSettings(settings["optimizer"]);
if (std::holds_alternative<Json::Value>(optimiserSettings))
return std::get<Json::Value>(std::move(optimiserSettings)); // was an error
else
ret.optimiserSettings = std::get<OptimiserSettings>(std::move(optimiserSettings));
}
Json::Value jsonLibraries = settings.get("libraries", Json::Value(Json::objectValue));
if (!jsonLibraries.isObject())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "\"libraries\" is not a JSON object.");
2017-03-17 12:30:29 +00:00
for (auto const& sourceName: jsonLibraries.getMemberNames())
{
auto const& jsonSourceName = jsonLibraries[sourceName];
if (!jsonSourceName.isObject())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Library entry is not a JSON object.");
2017-03-17 12:30:29 +00:00
for (auto const& library: jsonSourceName.getMemberNames())
{
if (!jsonSourceName[library].isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Library address must be a string.");
string address = jsonSourceName[library].asString();
if (!boost::starts_with(address, "0x"))
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"Library address is not prefixed with \"0x\"."
);
if (address.length() != 42)
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"Library address is of invalid length."
);
try
{
ret.libraries[sourceName + ":" + library] = util::h160(address);
}
2019-12-11 16:31:36 +00:00
catch (util::BadHexCharacter const&)
{
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"Invalid library address (\"" + address + "\") supplied."
);
}
}
2017-03-17 12:30:29 +00:00
}
Json::Value metadataSettings = settings.get("metadata", Json::Value());
if (auto result = checkMetadataKeys(metadataSettings))
return *result;
solAssert(CompilerStack::defaultMetadataFormat() != CompilerStack::MetadataFormat::NoMetadata, "");
ret.metadataFormat =
metadataSettings.get("appendCBOR", Json::Value(true)).asBool() ?
CompilerStack::defaultMetadataFormat() :
CompilerStack::MetadataFormat::NoMetadata;
ret.metadataLiteralSources = metadataSettings.get("useLiteralContent", Json::Value(false)).asBool();
2019-09-06 17:11:07 +00:00
if (metadataSettings.isMember("bytecodeHash"))
{
auto metadataHash = metadataSettings["bytecodeHash"].asString();
ret.metadataHash =
metadataHash == "ipfs" ?
CompilerStack::MetadataHash::IPFS :
metadataHash == "bzzr1" ?
CompilerStack::MetadataHash::Bzzr1 :
CompilerStack::MetadataHash::None;
if (ret.metadataFormat == CompilerStack::MetadataFormat::NoMetadata && ret.metadataHash != CompilerStack::MetadataHash::None)
return formatFatalError(
Error::Type::JSONError,
"When the parameter \"appendCBOR\" is set to false, the parameter \"bytecodeHash\" cannot be set to \"" +
metadataHash +
"\". The parameter \"bytecodeHash\" should either be skipped, or set to \"none\"."
);
2019-09-06 17:11:07 +00:00
}
Json::Value outputSelection = settings.get("outputSelection", Json::Value());
if (auto jsonError = checkOutputSelection(outputSelection))
return *jsonError;
ret.outputSelection = std::move(outputSelection);
2020-07-08 20:08:50 +00:00
if (ret.stopAfter != CompilerStack::State::CompilationSuccessful && isBinaryRequested(ret.outputSelection))
return formatFatalError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
2020-07-08 20:08:50 +00:00
"Requested output selection conflicts with \"settings.stopAfter\"."
);
Json::Value const& modelCheckerSettings = settings.get("modelChecker", Json::Value());
if (auto result = checkModelCheckerSettingsKeys(modelCheckerSettings))
return *result;
if (modelCheckerSettings.isMember("contracts"))
{
auto const& sources = modelCheckerSettings["contracts"];
if (!sources.isObject() && !sources.isNull())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.contracts is not a JSON object.");
map<string, set<string>> sourceContracts;
for (auto const& source: sources.getMemberNames())
{
if (source.empty())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Source name cannot be empty.");
auto const& contracts = sources[source];
if (!contracts.isArray())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Source contracts must be an array.");
for (auto const& contract: contracts)
{
if (!contract.isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Every contract in settings.modelChecker.contracts must be a string.");
if (contract.asString().empty())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Contract name cannot be empty.");
sourceContracts[source].insert(contract.asString());
}
if (sourceContracts[source].empty())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Source contracts must be a non-empty array.");
}
2022-08-23 17:28:45 +00:00
ret.modelCheckerSettings.contracts = {std::move(sourceContracts)};
}
2021-07-15 15:39:01 +00:00
if (modelCheckerSettings.isMember("divModNoSlacks"))
{
auto const& divModNoSlacks = modelCheckerSettings["divModNoSlacks"];
if (!divModNoSlacks.isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.divModNoSlacks must be a Boolean.");
2021-07-15 15:39:01 +00:00
ret.modelCheckerSettings.divModNoSlacks = divModNoSlacks.asBool();
}
if (modelCheckerSettings.isMember("engine"))
{
if (!modelCheckerSettings["engine"].isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.engine must be a string.");
std::optional<ModelCheckerEngine> engine = ModelCheckerEngine::fromString(modelCheckerSettings["engine"].asString());
if (!engine)
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid model checker engine requested.");
2020-11-02 20:20:20 +00:00
ret.modelCheckerSettings.engine = *engine;
}
2021-10-06 09:51:22 +00:00
if (modelCheckerSettings.isMember("invariants"))
{
auto const& invariantsArray = modelCheckerSettings["invariants"];
if (!invariantsArray.isArray())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.invariants must be an array.");
2021-10-06 09:51:22 +00:00
ModelCheckerInvariants invariants;
for (auto const& i: invariantsArray)
{
if (!i.isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Every invariant type in settings.modelChecker.invariants must be a string.");
2021-10-06 09:51:22 +00:00
if (!invariants.setFromString(i.asString()))
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid model checker invariants requested.");
2021-10-06 09:51:22 +00:00
}
if (invariants.invariants.empty())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.invariants must be a non-empty array.");
2021-10-06 09:51:22 +00:00
ret.modelCheckerSettings.invariants = invariants;
}
if (modelCheckerSettings.isMember("showUnproved"))
{
auto const& showUnproved = modelCheckerSettings["showUnproved"];
if (!showUnproved.isBool())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.showUnproved must be a Boolean value.");
ret.modelCheckerSettings.showUnproved = showUnproved.asBool();
}
2021-07-02 13:05:24 +00:00
2021-05-19 15:35:19 +00:00
if (modelCheckerSettings.isMember("solvers"))
{
auto const& solversArray = modelCheckerSettings["solvers"];
if (!solversArray.isArray())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.solvers must be an array.");
2021-05-19 15:35:19 +00:00
smtutil::SMTSolverChoice solvers;
for (auto const& s: solversArray)
{
if (!s.isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Every target in settings.modelChecker.solvers must be a string.");
2021-05-19 15:35:19 +00:00
if (!solvers.setSolver(s.asString()))
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid model checker solvers requested.");
2021-05-19 15:35:19 +00:00
}
ret.modelCheckerSettings.solvers = solvers;
}
if (modelCheckerSettings.isMember("targets"))
{
auto const& targetsArray = modelCheckerSettings["targets"];
if (!targetsArray.isArray())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.targets must be an array.");
ModelCheckerTargets targets;
for (auto const& t: targetsArray)
{
if (!t.isString())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Every target in settings.modelChecker.targets must be a string.");
if (!targets.setFromString(t.asString()))
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Invalid model checker targets requested.");
}
if (targets.targets.empty())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.targets must be a non-empty array.");
ret.modelCheckerSettings.targets = targets;
}
2020-11-02 20:20:20 +00:00
if (modelCheckerSettings.isMember("timeout"))
{
if (!modelCheckerSettings["timeout"].isUInt())
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "settings.modelChecker.timeout must be an unsigned integer.");
2020-11-02 20:20:20 +00:00
ret.modelCheckerSettings.timeout = modelCheckerSettings["timeout"].asUInt();
}
return { std::move(ret) };
}
Json::Value StandardCompiler::compileSolidity(StandardCompiler::InputsAndSettings _inputsAndSettings)
{
CompilerStack compilerStack(m_readFile);
StringMap sourceList = std::move(_inputsAndSettings.sources);
2019-03-20 17:57:46 +00:00
compilerStack.setSources(sourceList);
for (auto const& smtLib2Response: _inputsAndSettings.smtLib2Responses)
compilerStack.addSMTLib2Response(smtLib2Response.first, smtLib2Response.second);
2020-11-12 01:31:06 +00:00
compilerStack.setViaIR(_inputsAndSettings.viaIR);
compilerStack.setEVMVersion(_inputsAndSettings.evmVersion);
compilerStack.setParserErrorRecovery(_inputsAndSettings.parserErrorRecovery);
2022-08-23 17:28:45 +00:00
compilerStack.setRemappings(std::move(_inputsAndSettings.remappings));
compilerStack.setOptimiserSettings(std::move(_inputsAndSettings.optimiserSettings));
compilerStack.setRevertStringBehaviour(_inputsAndSettings.revertStrings);
if (_inputsAndSettings.debugInfoSelection.has_value())
compilerStack.selectDebugInfo(_inputsAndSettings.debugInfoSelection.value());
compilerStack.setLibraries(_inputsAndSettings.libraries);
compilerStack.useMetadataLiteralSources(_inputsAndSettings.metadataLiteralSources);
compilerStack.setMetadataFormat(_inputsAndSettings.metadataFormat);
2019-09-06 17:11:07 +00:00
compilerStack.setMetadataHash(_inputsAndSettings.metadataHash);
compilerStack.setRequestedContractNames(requestedContractNames(_inputsAndSettings.outputSelection));
2020-11-02 20:20:20 +00:00
compilerStack.setModelCheckerSettings(_inputsAndSettings.modelCheckerSettings);
compilerStack.enableEvmBytecodeGeneration(isEvmBytecodeRequested(_inputsAndSettings.outputSelection));
2019-06-18 16:11:04 +00:00
compilerStack.enableIRGeneration(isIRRequested(_inputsAndSettings.outputSelection));
2019-12-09 16:36:12 +00:00
compilerStack.enableEwasmGeneration(isEwasmRequested(_inputsAndSettings.outputSelection));
2019-03-04 22:26:46 +00:00
Json::Value errors = std::move(_inputsAndSettings.errors);
bool const binariesRequested = isBinaryRequested(_inputsAndSettings.outputSelection);
try
{
if (binariesRequested)
compilerStack.compile();
else
2020-07-08 20:08:50 +00:00
compilerStack.parseAndAnalyze(_inputsAndSettings.stopAfter);
for (auto const& error: compilerStack.errors())
{
2017-07-05 15:02:02 +00:00
Error const& err = dynamic_cast<Error const&>(*error);
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
*error,
2022-06-17 03:25:52 +00:00
err.type(),
"general",
2020-05-29 23:42:36 +00:00
"",
err.errorId()
));
}
}
2017-07-26 21:52:11 +00:00
/// This is only thrown in a very few locations.
catch (Error const& _error)
{
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
_error,
2022-06-17 03:25:52 +00:00
_error.type(),
"general",
"Uncaught error: "
));
}
2017-07-26 21:52:11 +00:00
/// This should not be leaked from compile().
catch (FatalError const& _exception)
{
errors.append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::FatalError,
2017-07-26 21:52:11 +00:00
"general",
"Uncaught fatal error: " + boost::diagnostic_information(_exception)
));
}
catch (CompilerError const& _exception)
{
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
_exception,
2022-06-17 03:25:52 +00:00
Error::Type::CompilerError,
"general",
"Compiler error (" + _exception.lineInfo() + ")"
));
}
catch (InternalCompilerError const& _exception)
{
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
_exception,
2022-06-17 03:25:52 +00:00
Error::Type::InternalCompilerError,
"general",
"Internal compiler error (" + _exception.lineInfo() + ")"
));
}
catch (UnimplementedFeatureError const& _exception)
{
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
_exception,
2022-06-17 03:25:52 +00:00
Error::Type::UnimplementedFeatureError,
"general",
"Unimplemented feature (" + _exception.lineInfo() + ")"
2017-07-26 21:52:11 +00:00
));
}
catch (yul::YulException const& _exception)
{
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
_exception,
2022-06-17 03:25:52 +00:00
Error::Type::YulException,
"general",
"Yul exception"
));
}
2020-05-20 10:55:12 +00:00
catch (smtutil::SMTLogicError const& _exception)
{
errors.append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
compilerStack,
2020-05-20 10:55:12 +00:00
_exception,
2022-06-17 03:25:52 +00:00
Error::Type::SMTLogicException,
2020-05-20 10:55:12 +00:00
"general",
"SMT logic exception"
));
}
2019-12-11 16:31:36 +00:00
catch (util::Exception const& _exception)
{
errors.append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::Exception,
"general",
"Exception during compilation: " + boost::diagnostic_information(_exception)
));
}
catch (std::exception const& _exception)
2019-05-29 20:26:18 +00:00
{
errors.append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::Exception,
2019-05-29 20:26:18 +00:00
"general",
"Unknown exception during compilation: " + boost::diagnostic_information(_exception)
2019-05-29 20:26:18 +00:00
));
}
catch (...)
{
errors.append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::Exception,
"general",
"Unknown exception during compilation: " + boost::current_exception_diagnostic_information()
));
}
bool analysisPerformed = compilerStack.state() >= CompilerStack::State::AnalysisPerformed;
bool const compilationSuccess = compilerStack.state() == CompilerStack::State::CompilationSuccessful;
if (compilerStack.hasError() && !_inputsAndSettings.parserErrorRecovery)
analysisPerformed = false;
/// Inconsistent state - stop here to receive error reports from users
2020-07-08 20:08:50 +00:00
if (
((binariesRequested && !compilationSuccess) || !analysisPerformed) &&
(errors.empty() && _inputsAndSettings.stopAfter >= CompilerStack::State::AnalysisPerformed)
)
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::InternalCompilerError, "No error reported, but compilation failed.");
2017-07-18 13:43:10 +00:00
Json::Value output = Json::objectValue;
if (errors.size() > 0)
output["errors"] = std::move(errors);
2017-07-18 13:43:10 +00:00
if (!compilerStack.unhandledSMTLib2Queries().empty())
for (string const& query: compilerStack.unhandledSMTLib2Queries())
2019-12-11 16:31:36 +00:00
output["auxiliaryInputRequested"]["smtlib2queries"]["0x" + util::keccak256(query).hex()] = query;
2019-06-18 16:11:04 +00:00
bool const wildcardMatchesExperimental = false;
2019-03-04 22:26:46 +00:00
2017-03-29 13:54:34 +00:00
output["sources"] = Json::objectValue;
unsigned sourceIndex = 0;
2020-07-08 20:08:50 +00:00
if (compilerStack.state() >= CompilerStack::State::Parsed && (!compilerStack.hasError() || _inputsAndSettings.parserErrorRecovery))
for (string const& sourceName: compilerStack.sourceNames())
{
Json::Value sourceResult = Json::objectValue;
sourceResult["id"] = sourceIndex++;
if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, "", "ast", wildcardMatchesExperimental))
sourceResult["ast"] = ASTJsonExporter(compilerStack.state(), compilerStack.sourceIndices()).toJson(compilerStack.ast(sourceName));
2020-07-08 20:08:50 +00:00
output["sources"][sourceName] = sourceResult;
}
2017-03-29 13:54:34 +00:00
Json::Value contractsOutput = Json::objectValue;
for (string const& contractName: analysisPerformed ? compilerStack.contractNames() : vector<string>())
{
size_t colon = contractName.rfind(':');
solAssert(colon != string::npos, "");
string file = contractName.substr(0, colon);
string name = contractName.substr(colon + 1);
// ABI, storage layout, documentation and metadata
Json::Value contractData(Json::objectValue);
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "abi", wildcardMatchesExperimental))
contractData["abi"] = compilerStack.contractABI(contractName);
if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "storageLayout", false))
contractData["storageLayout"] = compilerStack.storageLayout(contractName);
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "metadata", wildcardMatchesExperimental))
contractData["metadata"] = compilerStack.metadata(contractName);
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "userdoc", wildcardMatchesExperimental))
contractData["userdoc"] = compilerStack.natspecUser(contractName);
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "devdoc", wildcardMatchesExperimental))
contractData["devdoc"] = compilerStack.natspecDev(contractName);
2019-03-04 22:26:46 +00:00
// IR
2019-06-18 16:11:04 +00:00
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "ir", wildcardMatchesExperimental))
2019-03-04 22:26:46 +00:00
contractData["ir"] = compilerStack.yulIR(contractName);
2019-06-18 16:11:04 +00:00
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "irOptimized", wildcardMatchesExperimental))
2019-03-04 22:26:46 +00:00
contractData["irOptimized"] = compilerStack.yulIROptimized(contractName);
2019-12-09 16:36:12 +00:00
// Ewasm
2019-06-18 16:11:04 +00:00
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "ewasm.wast", wildcardMatchesExperimental))
2019-12-09 16:36:12 +00:00
contractData["ewasm"]["wast"] = compilerStack.ewasm(contractName);
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "ewasm.wasm", wildcardMatchesExperimental))
2019-12-09 16:36:12 +00:00
contractData["ewasm"]["wasm"] = compilerStack.ewasmObject(contractName).toHex();
2019-06-18 16:11:04 +00:00
// EVM
Json::Value evmData(Json::objectValue);
2019-06-18 16:11:04 +00:00
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.assembly", wildcardMatchesExperimental))
evmData["assembly"] = compilerStack.assemblyString(contractName, sourceList);
2019-06-18 16:11:04 +00:00
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.legacyAssembly", wildcardMatchesExperimental))
evmData["legacyAssembly"] = compilerStack.assemblyJSON(contractName);
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.methodIdentifiers", wildcardMatchesExperimental))
evmData["methodIdentifiers"] = compilerStack.interfaceSymbols(contractName)["methods"];
2019-06-18 16:11:04 +00:00
if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.gasEstimates", wildcardMatchesExperimental))
evmData["gasEstimates"] = compilerStack.gasEstimates(contractName);
if (compilationSuccess && isArtifactRequested(
_inputsAndSettings.outputSelection,
file,
name,
2020-09-15 09:21:13 +00:00
evmObjectComponents("bytecode"),
2019-06-18 16:11:04 +00:00
wildcardMatchesExperimental
))
evmData["bytecode"] = collectEVMObject(
_inputsAndSettings.evmVersion,
compilerStack.object(contractName),
compilerStack.sourceMapping(contractName),
compilerStack.generatedSources(contractName),
false,
[&](string const& _element) { return isArtifactRequested(
_inputsAndSettings.outputSelection,
file,
name,
"evm.bytecode." + _element,
wildcardMatchesExperimental
); }
);
if (compilationSuccess && isArtifactRequested(
_inputsAndSettings.outputSelection,
file,
name,
2020-09-15 09:21:13 +00:00
evmObjectComponents("deployedBytecode"),
2019-06-18 16:11:04 +00:00
wildcardMatchesExperimental
))
evmData["deployedBytecode"] = collectEVMObject(
_inputsAndSettings.evmVersion,
compilerStack.runtimeObject(contractName),
compilerStack.runtimeSourceMapping(contractName),
compilerStack.generatedSources(contractName, true),
true,
[&](string const& _element) { return isArtifactRequested(
_inputsAndSettings.outputSelection,
file,
name,
"evm.deployedBytecode." + _element,
wildcardMatchesExperimental
); }
);
if (!evmData.empty())
contractData["evm"] = evmData;
if (!contractData.empty())
{
if (!contractsOutput.isMember(file))
contractsOutput[file] = Json::objectValue;
contractsOutput[file][name] = contractData;
}
}
if (!contractsOutput.empty())
output["contracts"] = contractsOutput;
return output;
}
Json::Value StandardCompiler::compileYul(InputsAndSettings _inputsAndSettings)
{
Json::Value output = Json::objectValue;
output["errors"] = std::move(_inputsAndSettings.errors);
if (_inputsAndSettings.sources.size() != 1)
{
output["errors"].append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"general",
"Yul mode only supports exactly one input file."
));
return output;
}
if (!_inputsAndSettings.smtLib2Responses.empty())
{
output["errors"].append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"general",
"Yul mode does not support smtlib2responses."
));
return output;
}
if (!_inputsAndSettings.remappings.empty())
{
output["errors"].append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"general",
"Field \"settings.remappings\" cannot be used for Yul."
));
return output;
}
if (_inputsAndSettings.revertStrings != RevertStrings::Default)
{
output["errors"].append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::JSONError,
"general",
"Field \"settings.debug.revertStrings\" cannot be used for Yul."
));
return output;
}
YulStack stack(
_inputsAndSettings.evmVersion,
_inputsAndSettings.eofVersion,
YulStack::Language::StrictAssembly,
_inputsAndSettings.optimiserSettings,
_inputsAndSettings.debugInfoSelection.has_value() ?
_inputsAndSettings.debugInfoSelection.value() :
DebugInfoSelection::Default()
);
string const& sourceName = _inputsAndSettings.sources.begin()->first;
string const& sourceContents = _inputsAndSettings.sources.begin()->second;
// Inconsistent state - stop here to receive error reports from users
if (!stack.parseAndAnalyze(sourceName, sourceContents) && stack.errors().empty())
{
output["errors"].append(formatError(
2022-06-17 03:25:52 +00:00
Error::Type::InternalCompilerError,
"general",
"No error reported, but compilation failed."
));
return output;
}
if (!stack.errors().empty())
{
for (auto const& error: stack.errors())
{
auto err = dynamic_pointer_cast<Error const>(error);
output["errors"].append(formatErrorWithException(
2021-06-29 12:38:59 +00:00
stack,
*error,
2022-06-17 03:25:52 +00:00
err->type(),
"general",
""
));
}
return output;
}
string contractName = stack.parserResult()->name.str();
2019-06-18 16:11:04 +00:00
bool const wildcardMatchesExperimental = true;
if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, contractName, "ir", wildcardMatchesExperimental))
output["contracts"][sourceName][contractName]["ir"] = stack.print();
stack.optimize();
2020-05-12 14:33:05 +00:00
MachineAssemblyObject object;
MachineAssemblyObject deployedObject;
tie(object, deployedObject) = stack.assembleWithDeployed();
if (object.bytecode)
object.bytecode->link(_inputsAndSettings.libraries);
if (deployedObject.bytecode)
deployedObject.bytecode->link(_inputsAndSettings.libraries);
for (auto&& [kind, isDeployed]: {make_pair("bytecode"s, false), make_pair("deployedBytecode"s, true)})
2020-05-12 14:33:05 +00:00
if (isArtifactRequested(
_inputsAndSettings.outputSelection,
sourceName,
contractName,
evmObjectComponents(kind),
2020-05-12 14:33:05 +00:00
wildcardMatchesExperimental
))
{
MachineAssemblyObject const& o = isDeployed ? deployedObject : object;
2020-05-12 14:33:05 +00:00
if (o.bytecode)
output["contracts"][sourceName][contractName]["evm"][kind] =
collectEVMObject(
_inputsAndSettings.evmVersion,
*o.bytecode,
o.sourceMappings.get(),
Json::arrayValue,
isDeployed,
[&, kind = kind](string const& _element) { return isArtifactRequested(
_inputsAndSettings.outputSelection,
sourceName,
contractName,
"evm." + kind + "." + _element,
wildcardMatchesExperimental
); }
);
2020-05-12 14:33:05 +00:00
}
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, contractName, "irOptimized", wildcardMatchesExperimental))
output["contracts"][sourceName][contractName]["irOptimized"] = stack.print();
2019-06-18 16:11:04 +00:00
if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, contractName, "evm.assembly", wildcardMatchesExperimental))
output["contracts"][sourceName][contractName]["evm"]["assembly"] = object.assembly;
return output;
}
Json::Value StandardCompiler::compile(Json::Value const& _input) noexcept
2017-03-17 12:08:12 +00:00
{
YulStringRepository::reset();
2017-03-17 12:08:12 +00:00
try
{
auto parsed = parseInput(_input);
if (std::holds_alternative<Json::Value>(parsed))
return std::get<Json::Value>(std::move(parsed));
InputsAndSettings settings = std::get<InputsAndSettings>(std::move(parsed));
if (settings.language == "Solidity")
return compileSolidity(std::move(settings));
else if (settings.language == "Yul")
return compileYul(std::move(settings));
else
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::JSONError, "Only \"Solidity\" or \"Yul\" is supported as a language.");
2017-03-17 12:08:12 +00:00
}
2017-04-24 21:49:50 +00:00
catch (Json::LogicError const& _exception)
{
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::InternalCompilerError, string("JSON logic exception: ") + _exception.what());
2017-04-24 21:49:50 +00:00
}
catch (Json::RuntimeError const& _exception)
{
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::InternalCompilerError, string("JSON runtime exception: ") + _exception.what());
2017-04-24 21:49:50 +00:00
}
2019-12-11 16:31:36 +00:00
catch (util::Exception const& _exception)
{
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::InternalCompilerError, "Internal exception in StandardCompiler::compile: " + boost::diagnostic_information(_exception));
}
2017-03-17 12:08:12 +00:00
catch (...)
{
2022-06-17 03:25:52 +00:00
return formatFatalError(Error::Type::InternalCompilerError, "Internal exception in StandardCompiler::compile: " + boost::current_exception_diagnostic_information());
2017-03-17 12:08:12 +00:00
}
}
string StandardCompiler::compile(string const& _input) noexcept
2017-02-09 21:56:49 +00:00
{
Json::Value input;
string errors;
try
{
2019-12-11 16:31:36 +00:00
if (!util::jsonParseStrict(_input, input, &errors))
2022-06-17 03:25:52 +00:00
return util::jsonPrint(formatFatalError(Error::Type::JSONError, errors), m_jsonPrintingFormat);
}
catch (...)
{
return "{\"errors\":[{\"type\":\"JSONError\",\"component\":\"general\",\"severity\":\"error\",\"message\":\"Error parsing input JSON.\"}]}";
}
// cout << "Input: " << input.toStyledString() << endl;
Json::Value output = compile(input);
// cout << "Output: " << output.toStyledString() << endl;
try
{
return util::jsonPrint(output, m_jsonPrintingFormat);
}
catch (...)
{
return "{\"errors\":[{\"type\":\"JSONError\",\"component\":\"general\",\"severity\":\"error\",\"message\":\"Error writing output JSON.\"}]}";
}
2017-02-09 21:56:49 +00:00
}
2020-05-07 12:46:47 +00:00
Json::Value StandardCompiler::formatFunctionDebugData(
map<string, evmasm::LinkerObject::FunctionDebugData> const& _debugInfo
)
{
Json::Value ret(Json::objectValue);
for (auto const& [name, info]: _debugInfo)
{
Json::Value fun;
if (info.sourceID)
fun["id"] = Json::UInt64(*info.sourceID);
else
fun["id"] = Json::nullValue;
if (info.bytecodeOffset)
fun["entryPoint"] = Json::UInt64(*info.bytecodeOffset);
else
fun["entryPoint"] = Json::nullValue;
fun["parameterSlots"] = Json::UInt64(info.params);
fun["returnSlots"] = Json::UInt64(info.returns);
2022-08-23 17:28:45 +00:00
ret[name] = std::move(fun);
2020-05-07 12:46:47 +00:00
}
return ret;
}