|
| 1 | +/* |
| 2 | + This file is part of solidity. |
| 3 | +
|
| 4 | + solidity is free software: you can redistribute it and/or modify |
| 5 | + it under the terms of the GNU General Public License as published by |
| 6 | + the Free Software Foundation, either version 3 of the License, or |
| 7 | + (at your option) any later version. |
| 8 | +
|
| 9 | + solidity is distributed in the hope that it will be useful, |
| 10 | + but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | + GNU General Public License for more details. |
| 13 | +
|
| 14 | + You should have received a copy of the GNU General Public License |
| 15 | + along with solidity. If not, see <http://www.gnu.org/licenses/>. |
| 16 | +*/ |
| 17 | + |
| 18 | +#include <test/libevmasm/EVMAssemblyTest.h> |
| 19 | + |
| 20 | +#include <test/libevmasm/PlainAssemblyParser.h> |
| 21 | + |
| 22 | +#include <test/Common.h> |
| 23 | + |
| 24 | +#include <libevmasm/Disassemble.h> |
| 25 | +#include <libevmasm/EVMAssemblyStack.h> |
| 26 | + |
| 27 | +#include <boost/algorithm/string/predicate.hpp> |
| 28 | +#include <boost/algorithm/string/split.hpp> |
| 29 | +#include <boost/algorithm/string/trim.hpp> |
| 30 | + |
| 31 | +#include <range/v3/view/map.hpp> |
| 32 | + |
| 33 | +using namespace std::string_literals; |
| 34 | +using namespace solidity; |
| 35 | +using namespace solidity::test; |
| 36 | +using namespace solidity::evmasm; |
| 37 | +using namespace solidity::evmasm::test; |
| 38 | +using namespace solidity::frontend; |
| 39 | +using namespace solidity::frontend::test; |
| 40 | +using namespace solidity::langutil; |
| 41 | +using namespace solidity::util; |
| 42 | + |
| 43 | +std::vector<std::string> const EVMAssemblyTest::c_outputLabels = { |
| 44 | + "InputAssemblyJSON", |
| 45 | + "Assembly", |
| 46 | + "Bytecode", |
| 47 | + "Opcodes", |
| 48 | + "SourceMappings", |
| 49 | +}; |
| 50 | + |
| 51 | +std::unique_ptr<TestCase> EVMAssemblyTest::create(Config const& _config) |
| 52 | +{ |
| 53 | + return std::make_unique<EVMAssemblyTest>(_config.filename); |
| 54 | +} |
| 55 | + |
| 56 | +EVMAssemblyTest::EVMAssemblyTest(std::string const& _filename): |
| 57 | + EVMVersionRestrictedTestCase(_filename) |
| 58 | +{ |
| 59 | + m_source = m_reader.source(); |
| 60 | + m_expectation = m_reader.simpleExpectations(); |
| 61 | + |
| 62 | + if (_filename.ends_with(".asmjson")) |
| 63 | + m_assemblyFormat = AssemblyFormat::JSON; |
| 64 | + else if (_filename.ends_with(".asm")) |
| 65 | + m_assemblyFormat = AssemblyFormat::Plain; |
| 66 | + else |
| 67 | + BOOST_THROW_EXCEPTION(std::runtime_error("Not an assembly test: \"" + _filename + "\". Allowed extensions: .asm, .asmjson.")); |
| 68 | + |
| 69 | + m_selectedOutputs = m_reader.stringSetting("outputs", "Assembly,Bytecode,Opcodes,SourceMappings"); |
| 70 | + OptimisationPreset optimizationPreset = m_reader.enumSetting<OptimisationPreset>( |
| 71 | + "optimizationPreset", |
| 72 | + { |
| 73 | + {"none", OptimisationPreset::None}, |
| 74 | + {"minimal", OptimisationPreset::Minimal}, |
| 75 | + {"standard", OptimisationPreset::Standard}, |
| 76 | + {"full", OptimisationPreset::Full}, |
| 77 | + }, |
| 78 | + "none" |
| 79 | + ); |
| 80 | + m_optimizerSettings = Assembly::OptimiserSettings::translateSettings(OptimiserSettings::preset(optimizationPreset)); |
| 81 | + m_optimizerSettings.expectedExecutionsPerDeployment = m_reader.sizetSetting( |
| 82 | + "optimizer.expectedExecutionsPerDeployment", |
| 83 | + m_optimizerSettings.expectedExecutionsPerDeployment |
| 84 | + ); |
| 85 | + |
| 86 | + auto const optimizerComponentSetting = [&](std::string const& _component, bool& _setting) { |
| 87 | + _setting = m_reader.boolSetting("optimizer." + _component, _setting); |
| 88 | + }; |
| 89 | + optimizerComponentSetting("inliner", m_optimizerSettings.runInliner); |
| 90 | + optimizerComponentSetting("jumpdestRemover", m_optimizerSettings.runJumpdestRemover); |
| 91 | + optimizerComponentSetting("peephole", m_optimizerSettings.runPeephole); |
| 92 | + optimizerComponentSetting("deduplicate", m_optimizerSettings.runDeduplicate); |
| 93 | + optimizerComponentSetting("cse", m_optimizerSettings.runCSE); |
| 94 | + optimizerComponentSetting("constantOptimizer", m_optimizerSettings.runConstantOptimiser); |
| 95 | + |
| 96 | + // TODO: Enable when assembly import for EOF is implemented. |
| 97 | + if (CommonOptions::get().eofVersion().has_value()) |
| 98 | + m_shouldRun = false; |
| 99 | +} |
| 100 | + |
| 101 | +TestCase::TestResult EVMAssemblyTest::run(std::ostream& _stream, std::string const& _linePrefix, bool const _formatted) |
| 102 | +{ |
| 103 | + EVMAssemblyStack evmAssemblyStack( |
| 104 | + CommonOptions::get().evmVersion(), |
| 105 | + CommonOptions::get().eofVersion(), |
| 106 | + m_optimizerSettings |
| 107 | + ); |
| 108 | + |
| 109 | + evmAssemblyStack.selectDebugInfo(DebugInfoSelection::AllExceptExperimental()); |
| 110 | + |
| 111 | + std::string assemblyJSON; |
| 112 | + switch (m_assemblyFormat) |
| 113 | + { |
| 114 | + case AssemblyFormat::JSON: |
| 115 | + assemblyJSON = m_source; |
| 116 | + break; |
| 117 | + case AssemblyFormat::Plain: |
| 118 | + assemblyJSON = jsonPrint( |
| 119 | + PlainAssemblyParser{}.parse(m_reader.fileName().filename().string(), m_source), |
| 120 | + {JsonFormat::Pretty, 4} |
| 121 | + ); |
| 122 | + break; |
| 123 | + } |
| 124 | + |
| 125 | + try |
| 126 | + { |
| 127 | + evmAssemblyStack.parseAndAnalyze(m_reader.fileName().filename().string(), assemblyJSON); |
| 128 | + } |
| 129 | + catch (AssemblyImportException const& _exception) |
| 130 | + { |
| 131 | + m_obtainedResult = "AssemblyImportException: "s + _exception.what() + "\n"; |
| 132 | + return checkResult(_stream, _linePrefix, _formatted); |
| 133 | + } |
| 134 | + |
| 135 | + try |
| 136 | + { |
| 137 | + evmAssemblyStack.assemble(); |
| 138 | + } |
| 139 | + catch (Error const& _error) |
| 140 | + { |
| 141 | + // TODO: EVMAssemblyStack should catch these on its own and provide an error reporter. |
| 142 | + soltestAssert(_error.comment(), "Errors must include a message for the user."); |
| 143 | + m_obtainedResult = Error::formatErrorType(_error.type()) + ": " + *_error.comment() + "\n"; |
| 144 | + return checkResult(_stream, _linePrefix, _formatted); |
| 145 | + } |
| 146 | + soltestAssert(evmAssemblyStack.compilationSuccessful()); |
| 147 | + |
| 148 | + auto const produceOutput = [&](std::string const& _output) { |
| 149 | + if (_output == "InputAssemblyJSON") |
| 150 | + return assemblyJSON; |
| 151 | + if (_output == "Assembly") |
| 152 | + return evmAssemblyStack.assemblyString({{m_reader.fileName().filename().string(), m_source}}); |
| 153 | + if (_output == "Bytecode") |
| 154 | + return util::toHex(evmAssemblyStack.object().bytecode); |
| 155 | + if (_output == "Opcodes") |
| 156 | + return disassemble(evmAssemblyStack.object().bytecode, CommonOptions::get().evmVersion()); |
| 157 | + if (_output == "SourceMappings") |
| 158 | + return evmAssemblyStack.sourceMapping(); |
| 159 | + soltestAssert(false); |
| 160 | + unreachable(); |
| 161 | + }; |
| 162 | + |
| 163 | + std::set<std::string> selectedOutputSet; |
| 164 | + boost::split(selectedOutputSet, m_selectedOutputs, boost::is_any_of(",")); |
| 165 | + for (std::string const& output: c_outputLabels) |
| 166 | + if (selectedOutputSet.contains(output)) |
| 167 | + { |
| 168 | + if (!m_obtainedResult.empty() && m_obtainedResult.back() != '\n') |
| 169 | + m_obtainedResult += "\n"; |
| 170 | + |
| 171 | + // Don't trim on the left to avoid stripping indentation. |
| 172 | + std::string content = produceOutput(output); |
| 173 | + boost::trim_right(content); |
| 174 | + std::string separator = (content.empty() ? "" : (output == "Assembly" ? "\n" : " ")); |
| 175 | + m_obtainedResult += output + ":" + separator + content; |
| 176 | + } |
| 177 | + if (!m_obtainedResult.empty() && m_obtainedResult.back() != '\n') |
| 178 | + m_obtainedResult += "\n"; |
| 179 | + |
| 180 | + return checkResult(_stream, _linePrefix, _formatted); |
| 181 | +} |
0 commit comments