2014-12-11 15:37:17 +00:00
|
|
|
/*
|
2016-11-18 23:13:20 +00:00
|
|
|
This file is part of solidity.
|
2014-12-11 15:37:17 +00:00
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is free software: you can redistribute it and/or modify
|
2014-12-11 15:37:17 +00:00
|
|
|
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.
|
|
|
|
|
2016-11-18 23:13:20 +00:00
|
|
|
solidity is distributed in the hope that it will be useful,
|
2014-12-11 15:37:17 +00:00
|
|
|
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
|
2016-11-18 23:13:20 +00:00
|
|
|
along with solidity. If not, see <http://www.gnu.org/licenses/>.
|
2014-12-11 15:37:17 +00:00
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2014-12-11 15:37:17 +00:00
|
|
|
/**
|
|
|
|
* @author Christian <c@ethdev.com>
|
|
|
|
* @date 2014
|
|
|
|
* Tests for the Solidity optimizer.
|
|
|
|
*/
|
|
|
|
|
2019-02-05 22:37:02 +00:00
|
|
|
#include <test/Metadata.h>
|
2016-06-09 16:54:29 +00:00
|
|
|
#include <test/libsolidity/SolidityExecutionFramework.h>
|
2016-11-22 14:43:51 +00:00
|
|
|
|
2017-07-26 15:21:24 +00:00
|
|
|
#include <libevmasm/Instruction.h>
|
2014-12-11 15:37:17 +00:00
|
|
|
|
2016-11-22 14:43:51 +00:00
|
|
|
#include <boost/test/unit_test.hpp>
|
|
|
|
|
2017-03-03 15:17:00 +00:00
|
|
|
#include <chrono>
|
2016-11-22 14:43:51 +00:00
|
|
|
#include <string>
|
|
|
|
#include <tuple>
|
|
|
|
#include <memory>
|
|
|
|
|
2014-12-11 15:37:17 +00:00
|
|
|
using namespace std;
|
2019-12-23 15:50:30 +00:00
|
|
|
using namespace solidity::util;
|
|
|
|
using namespace solidity::evmasm;
|
|
|
|
using namespace solidity::test;
|
2014-12-11 15:37:17 +00:00
|
|
|
|
2019-12-23 15:50:30 +00:00
|
|
|
namespace solidity::frontend::test
|
2014-12-11 15:37:17 +00:00
|
|
|
{
|
|
|
|
|
2016-11-28 00:21:01 +00:00
|
|
|
class OptimizerTestFramework: public SolidityExecutionFramework
|
2014-12-11 15:37:17 +00:00
|
|
|
{
|
|
|
|
public:
|
2016-11-30 13:05:19 +00:00
|
|
|
bytes const& compileAndRunWithOptimizer(
|
|
|
|
std::string const& _sourceCode,
|
|
|
|
u256 const& _value = 0,
|
|
|
|
std::string const& _contractName = "",
|
|
|
|
bool const _optimize = true,
|
|
|
|
unsigned const _optimizeRuns = 200
|
|
|
|
)
|
|
|
|
{
|
2019-03-12 14:14:12 +00:00
|
|
|
OptimiserSettings previousSettings = std::move(m_optimiserSettings);
|
|
|
|
// This uses "none" / "full" while most other test frameworks use
|
2019-03-20 15:15:07 +00:00
|
|
|
// "minimal" / "standard".
|
2019-03-12 14:14:12 +00:00
|
|
|
m_optimiserSettings = _optimize ? OptimiserSettings::full() : OptimiserSettings::none();
|
|
|
|
m_optimiserSettings.expectedExecutionsPerDeployment = _optimizeRuns;
|
2016-11-30 13:05:19 +00:00
|
|
|
bytes const& ret = compileAndRun(_sourceCode, _value, _contractName);
|
2019-03-12 14:14:12 +00:00
|
|
|
m_optimiserSettings = std::move(previousSettings);
|
2016-11-30 13:05:19 +00:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2014-12-11 15:37:17 +00:00
|
|
|
/// Compiles the source code with and without optimizing.
|
2015-03-19 17:11:58 +00:00
|
|
|
void compileBothVersions(
|
|
|
|
std::string const& _sourceCode,
|
|
|
|
u256 const& _value = 0,
|
2017-04-03 12:41:09 +00:00
|
|
|
std::string const& _contractName = "",
|
|
|
|
unsigned const _optimizeRuns = 200
|
2015-03-19 17:11:58 +00:00
|
|
|
)
|
|
|
|
{
|
2018-07-28 11:55:50 +00:00
|
|
|
m_nonOptimizedBytecode = compileAndRunWithOptimizer("pragma solidity >=0.0;\n" + _sourceCode, _value, _contractName, false, _optimizeRuns);
|
2014-12-11 15:37:17 +00:00
|
|
|
m_nonOptimizedContract = m_contractAddress;
|
2018-07-28 11:55:50 +00:00
|
|
|
m_optimizedBytecode = compileAndRunWithOptimizer("pragma solidity >=0.0;\n" + _sourceCode, _value, _contractName, true, _optimizeRuns);
|
2018-03-13 12:00:16 +00:00
|
|
|
size_t nonOptimizedSize = numInstructions(m_nonOptimizedBytecode);
|
|
|
|
size_t optimizedSize = numInstructions(m_optimizedBytecode);
|
2015-03-19 17:11:58 +00:00
|
|
|
BOOST_CHECK_MESSAGE(
|
2017-04-03 12:41:09 +00:00
|
|
|
_optimizeRuns < 50 || optimizedSize < nonOptimizedSize,
|
2016-12-01 15:02:54 +00:00
|
|
|
string("Optimizer did not reduce bytecode size. Non-optimized size: ") +
|
2018-08-08 14:26:30 +00:00
|
|
|
to_string(nonOptimizedSize) + " - optimized size: " +
|
|
|
|
to_string(optimizedSize)
|
2015-03-19 17:11:58 +00:00
|
|
|
);
|
2014-12-11 15:37:17 +00:00
|
|
|
m_optimizedContract = m_contractAddress;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class... Args>
|
2015-01-08 16:18:31 +00:00
|
|
|
void compareVersions(std::string _sig, Args const&... _arguments)
|
2014-12-11 15:37:17 +00:00
|
|
|
{
|
|
|
|
m_contractAddress = m_nonOptimizedContract;
|
2015-01-08 16:18:31 +00:00
|
|
|
bytes nonOptimizedOutput = callContractFunction(_sig, _arguments...);
|
2018-03-13 14:21:38 +00:00
|
|
|
m_gasUsedNonOptimized = m_gasUsed;
|
2014-12-11 15:37:17 +00:00
|
|
|
m_contractAddress = m_optimizedContract;
|
2015-01-08 16:18:31 +00:00
|
|
|
bytes optimizedOutput = callContractFunction(_sig, _arguments...);
|
2018-03-13 14:21:38 +00:00
|
|
|
m_gasUsedOptimized = m_gasUsed;
|
2016-07-29 14:57:08 +00:00
|
|
|
BOOST_CHECK_MESSAGE(!optimizedOutput.empty(), "No optimized output for " + _sig);
|
|
|
|
BOOST_CHECK_MESSAGE(!nonOptimizedOutput.empty(), "No un-optimized output for " + _sig);
|
2014-12-11 15:37:17 +00:00
|
|
|
BOOST_CHECK_MESSAGE(nonOptimizedOutput == optimizedOutput, "Computed values do not match."
|
|
|
|
"\nNon-Optimized: " + toHex(nonOptimizedOutput) +
|
|
|
|
"\nOptimized: " + toHex(optimizedOutput));
|
|
|
|
}
|
|
|
|
|
2018-07-16 10:23:06 +00:00
|
|
|
/// @returns the number of instructions in the given bytecode, not taking the metadata hash
|
2016-12-01 15:02:54 +00:00
|
|
|
/// into account.
|
2019-10-28 10:39:30 +00:00
|
|
|
size_t numInstructions(bytes const& _bytecode, std::optional<Instruction> _which = std::optional<Instruction>{})
|
2016-12-01 15:02:54 +00:00
|
|
|
{
|
2019-02-05 22:37:02 +00:00
|
|
|
bytes realCode = bytecodeSansMetadata(_bytecode);
|
|
|
|
BOOST_REQUIRE_MESSAGE(!realCode.empty(), "Invalid or missing metadata in bytecode.");
|
2016-12-01 15:02:54 +00:00
|
|
|
size_t instructions = 0;
|
2019-12-11 16:31:36 +00:00
|
|
|
evmasm::eachInstruction(realCode, [&](Instruction _instr, u256 const&) {
|
2018-03-13 12:00:16 +00:00
|
|
|
if (!_which || *_which == _instr)
|
|
|
|
instructions++;
|
2016-12-01 15:02:54 +00:00
|
|
|
});
|
|
|
|
return instructions;
|
|
|
|
}
|
|
|
|
|
2017-07-26 15:21:24 +00:00
|
|
|
protected:
|
2018-03-13 14:21:38 +00:00
|
|
|
u256 m_gasUsedOptimized;
|
|
|
|
u256 m_gasUsedNonOptimized;
|
2018-03-13 12:00:16 +00:00
|
|
|
bytes m_nonOptimizedBytecode;
|
|
|
|
bytes m_optimizedBytecode;
|
2020-11-13 16:03:49 +00:00
|
|
|
h160 m_optimizedContract;
|
|
|
|
h160 m_nonOptimizedContract;
|
2014-12-11 15:37:17 +00:00
|
|
|
};
|
|
|
|
|
2014-12-18 14:21:03 +00:00
|
|
|
BOOST_FIXTURE_TEST_SUITE(SolidityOptimizer, OptimizerTestFramework)
|
2014-12-11 15:37:17 +00:00
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(smoke_test)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(uint a) public returns (uint b) {
|
2014-12-11 15:37:17 +00:00
|
|
|
return a;
|
|
|
|
}
|
2018-05-16 13:52:24 +00:00
|
|
|
}
|
|
|
|
)";
|
2015-03-19 17:11:58 +00:00
|
|
|
compileBothVersions(sourceCode);
|
2015-01-08 16:18:31 +00:00
|
|
|
compareVersions("f(uint256)", u256(7));
|
2014-12-11 15:37:17 +00:00
|
|
|
}
|
|
|
|
|
2015-03-19 17:11:58 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(identities)
|
2014-12-11 15:37:17 +00:00
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(int a) public returns (int b) {
|
2015-01-07 14:41:11 +00:00
|
|
|
return int(0) | (int(1) * (int(0) ^ (0 + a)));
|
2014-12-11 15:37:17 +00:00
|
|
|
}
|
2018-05-16 13:52:24 +00:00
|
|
|
}
|
|
|
|
)";
|
2015-03-19 17:11:58 +00:00
|
|
|
compileBothVersions(sourceCode);
|
2016-07-29 14:57:08 +00:00
|
|
|
compareVersions("f(int256)", u256(0x12334664));
|
2014-12-11 15:37:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(unused_expressions)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
|
|
|
uint data;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f() public returns (uint a, uint b) {
|
2014-12-11 16:04:26 +00:00
|
|
|
10 + 20;
|
2014-12-11 15:37:17 +00:00
|
|
|
data;
|
|
|
|
}
|
2018-05-16 13:52:24 +00:00
|
|
|
}
|
|
|
|
)";
|
2015-03-19 17:11:58 +00:00
|
|
|
compileBothVersions(sourceCode);
|
2015-01-08 16:18:31 +00:00
|
|
|
compareVersions("f()");
|
2014-12-11 15:37:17 +00:00
|
|
|
}
|
|
|
|
|
2014-12-11 16:35:23 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(constant_folding_both_sides)
|
|
|
|
{
|
|
|
|
// if constants involving the same associative and commutative operator are applied from both
|
2015-01-07 14:41:11 +00:00
|
|
|
// sides, the operator should be applied only once, because the expression compiler pushes
|
|
|
|
// literals as late as possible
|
2014-12-11 16:35:23 +00:00
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(uint x) public returns (uint y) {
|
2014-12-11 16:35:23 +00:00
|
|
|
return 98 ^ (7 * ((1 | (x | 1000)) * 40) ^ 102);
|
|
|
|
}
|
2018-05-16 13:52:24 +00:00
|
|
|
}
|
|
|
|
)";
|
2015-03-19 17:11:58 +00:00
|
|
|
compileBothVersions(sourceCode);
|
2018-02-20 17:03:39 +00:00
|
|
|
compareVersions("f(uint256)", 7);
|
2015-03-19 17:11:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(storage_access)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
|
|
|
uint8[40] data;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(uint x) public returns (uint y) {
|
2015-03-19 17:11:58 +00:00
|
|
|
data[2] = data[7] = uint8(x);
|
|
|
|
data[4] = data[2] * 10 + data[3];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
2018-02-20 17:03:39 +00:00
|
|
|
compareVersions("f(uint256)", 7);
|
2014-12-11 16:35:23 +00:00
|
|
|
}
|
|
|
|
|
2015-03-19 17:11:58 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(array_copy)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
|
|
|
bytes2[] data1;
|
|
|
|
bytes5[] data2;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(uint x) public returns (uint l, uint y) {
|
2019-09-18 13:39:23 +00:00
|
|
|
for (uint i = 0; i < msg.data.length; i++)
|
|
|
|
data1.push();
|
2015-03-19 17:11:58 +00:00
|
|
|
for (uint i = 0; i < msg.data.length; ++i)
|
|
|
|
data1[i] = msg.data[i];
|
|
|
|
data2 = data1;
|
|
|
|
l = data2.length;
|
2018-05-11 12:06:31 +00:00
|
|
|
y = uint(uint40(data2[x]));
|
2015-03-19 17:11:58 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f(uint256)", 0);
|
|
|
|
compareVersions("f(uint256)", 10);
|
2016-07-29 14:57:08 +00:00
|
|
|
compareVersions("f(uint256)", 35);
|
2015-03-19 17:11:58 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(function_calls)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
2018-06-29 14:52:41 +00:00
|
|
|
function f1(uint x) public returns (uint) { return x*x; }
|
|
|
|
function f(uint x) public returns (uint) { return f1(7+x) - this.f1(x**9); }
|
2015-03-19 17:11:58 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f(uint256)", 0);
|
|
|
|
compareVersions("f(uint256)", 10);
|
|
|
|
compareVersions("f(uint256)", 36);
|
|
|
|
}
|
|
|
|
|
2015-05-08 10:40:11 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(storage_write_in_loops)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
|
|
|
uint d;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(uint a) public returns (uint r) {
|
2018-06-28 13:19:53 +00:00
|
|
|
uint x = d;
|
2015-05-08 10:40:11 +00:00
|
|
|
for (uint i = 1; i < a * a; i++) {
|
|
|
|
r = d;
|
|
|
|
d = i;
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f(uint256)", 0);
|
|
|
|
compareVersions("f(uint256)", 10);
|
|
|
|
compareVersions("f(uint256)", 36);
|
|
|
|
}
|
|
|
|
|
2016-08-01 21:13:56 +00:00
|
|
|
// Test disabled with https://github.com/ethereum/solidity/pull/762
|
|
|
|
// Information in joining branches is not retained anymore.
|
2015-05-11 14:40:28 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(retain_information_in_branches)
|
|
|
|
{
|
2018-05-23 13:39:26 +00:00
|
|
|
// This tests that the optimizer knows that we already have "z == keccak256(abi.encodePacked(y))" inside both branches.
|
2015-05-11 14:40:28 +00:00
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract c {
|
|
|
|
bytes32 d;
|
|
|
|
uint a;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f(uint x, bytes32 y) public returns (uint r_a, bytes32 r_d) {
|
2018-05-23 13:39:26 +00:00
|
|
|
bytes32 z = keccak256(abi.encodePacked(y));
|
2015-05-11 14:40:28 +00:00
|
|
|
if (x > 8) {
|
2018-05-23 13:39:26 +00:00
|
|
|
z = keccak256(abi.encodePacked(y));
|
2015-05-11 14:40:28 +00:00
|
|
|
a = x;
|
|
|
|
} else {
|
2018-05-23 13:39:26 +00:00
|
|
|
z = keccak256(abi.encodePacked(y));
|
2015-05-11 14:40:28 +00:00
|
|
|
a = x;
|
|
|
|
}
|
|
|
|
r_a = a;
|
|
|
|
r_d = d;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f(uint256,bytes32)", 0, "abc");
|
|
|
|
compareVersions("f(uint256,bytes32)", 8, "def");
|
|
|
|
compareVersions("f(uint256,bytes32)", 10, "ghi");
|
|
|
|
|
2016-11-30 13:05:19 +00:00
|
|
|
bytes optimizedBytecode = compileAndRunWithOptimizer(sourceCode, 0, "c", true);
|
2015-05-11 14:40:28 +00:00
|
|
|
size_t numSHA3s = 0;
|
2016-04-04 11:18:24 +00:00
|
|
|
eachInstruction(optimizedBytecode, [&](Instruction _instr, u256 const&) {
|
2017-05-10 07:48:00 +00:00
|
|
|
if (_instr == Instruction::KECCAK256)
|
2015-05-11 14:40:28 +00:00
|
|
|
numSHA3s++;
|
|
|
|
});
|
2016-08-01 21:13:56 +00:00
|
|
|
// TEST DISABLED - OPTIMIZER IS NOT EFFECTIVE ON THIS ONE ANYMORE
|
|
|
|
// BOOST_CHECK_EQUAL(1, numSHA3s);
|
2015-05-11 14:40:28 +00:00
|
|
|
}
|
|
|
|
|
2015-05-12 19:27:04 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(store_tags_as_unions)
|
|
|
|
{
|
2017-05-11 12:43:29 +00:00
|
|
|
// This calls the same function from two sources and both calls have a certain Keccak-256 on
|
2015-05-12 19:27:04 +00:00
|
|
|
// the stack at the same position.
|
|
|
|
// Without storing tags as unions, the return from the shared function would not know where to
|
|
|
|
// jump and thus all jumpdests are forced to clear their state and we do not know about the
|
|
|
|
// sha3 anymore.
|
|
|
|
// Note that, for now, this only works if the functions have the same number of return
|
|
|
|
// parameters since otherwise, the return jump addresses are at different stack positions
|
|
|
|
// which triggers the "unknown jump target" situation.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
|
|
|
bytes32 data;
|
|
|
|
function f(uint x, bytes32 y) external returns (uint r_a, bytes32 r_d) {
|
2018-05-23 13:39:26 +00:00
|
|
|
r_d = keccak256(abi.encodePacked(y));
|
2015-05-12 19:27:04 +00:00
|
|
|
shared(y);
|
2018-05-23 13:39:26 +00:00
|
|
|
r_d = keccak256(abi.encodePacked(y));
|
2015-05-12 19:27:04 +00:00
|
|
|
r_a = 5;
|
|
|
|
}
|
|
|
|
function g(uint x, bytes32 y) external returns (uint r_a, bytes32 r_d) {
|
2018-05-23 13:39:26 +00:00
|
|
|
r_d = keccak256(abi.encodePacked(y));
|
2015-05-12 19:27:04 +00:00
|
|
|
shared(y);
|
2018-05-23 13:39:26 +00:00
|
|
|
r_d = bytes32(uint(keccak256(abi.encodePacked(y))) + 2);
|
2015-05-12 19:27:04 +00:00
|
|
|
r_a = 7;
|
|
|
|
}
|
|
|
|
function shared(bytes32 y) internal {
|
2018-05-23 13:39:26 +00:00
|
|
|
data = keccak256(abi.encodePacked(y));
|
2015-05-12 19:27:04 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
2016-07-29 14:57:08 +00:00
|
|
|
compareVersions("f(uint256,bytes32)", 7, "abc");
|
2015-05-12 19:27:04 +00:00
|
|
|
|
2016-11-30 13:05:19 +00:00
|
|
|
bytes optimizedBytecode = compileAndRunWithOptimizer(sourceCode, 0, "test", true);
|
2015-05-12 19:27:04 +00:00
|
|
|
size_t numSHA3s = 0;
|
2016-04-04 11:18:24 +00:00
|
|
|
eachInstruction(optimizedBytecode, [&](Instruction _instr, u256 const&) {
|
2017-05-10 07:48:00 +00:00
|
|
|
if (_instr == Instruction::KECCAK256)
|
2015-05-12 19:27:04 +00:00
|
|
|
numSHA3s++;
|
|
|
|
});
|
2015-06-06 13:31:22 +00:00
|
|
|
// TEST DISABLED UNTIL 93693404 IS IMPLEMENTED
|
|
|
|
// BOOST_CHECK_EQUAL(2, numSHA3s);
|
2015-05-12 19:27:04 +00:00
|
|
|
}
|
|
|
|
|
2016-01-15 15:23:49 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(incorrect_storage_access_bug)
|
|
|
|
{
|
2017-05-11 12:43:29 +00:00
|
|
|
// This bug appeared because a Keccak-256 operation with too low sequence number was used,
|
|
|
|
// resulting in memory not being rewritten before the Keccak-256. The fix was to
|
2016-01-15 15:23:49 +00:00
|
|
|
// take the max of the min sequence numbers when merging the states.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract C
|
|
|
|
{
|
|
|
|
mapping(uint => uint) data;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f() public returns (uint)
|
2016-01-15 15:23:49 +00:00
|
|
|
{
|
2020-05-05 11:33:28 +00:00
|
|
|
if (data[block.timestamp] == 0)
|
2016-01-15 15:23:49 +00:00
|
|
|
data[uint(-7)] = 5;
|
2020-05-05 11:33:28 +00:00
|
|
|
return data[block.timestamp];
|
2016-01-15 15:23:49 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f()");
|
|
|
|
}
|
|
|
|
|
2016-03-11 15:14:21 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(sequence_number_for_calls)
|
|
|
|
{
|
|
|
|
// This is a test for a bug that was present because we did not increment the sequence
|
|
|
|
// number for CALLs - CALLs can read and write from memory (and DELEGATECALLs can do the same
|
|
|
|
// to storage), so the sequence number should be incremented.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract test {
|
2018-07-12 04:18:50 +00:00
|
|
|
function f(string memory a, string memory b) public returns (bool) { return sha256(bytes(a)) == sha256(bytes(b)); }
|
2016-03-11 15:14:21 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f(string,string)", 0x40, 0x80, 3, "abc", 3, "def");
|
|
|
|
}
|
|
|
|
|
2015-06-01 10:32:59 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(computing_constants)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
2017-04-03 12:41:09 +00:00
|
|
|
contract C {
|
|
|
|
uint m_a;
|
|
|
|
uint m_b;
|
|
|
|
uint m_c;
|
|
|
|
uint m_d;
|
2020-06-23 12:14:24 +00:00
|
|
|
constructor() {
|
2017-04-03 12:41:09 +00:00
|
|
|
set();
|
|
|
|
}
|
2018-06-29 14:52:41 +00:00
|
|
|
function set() public returns (uint) {
|
2017-04-03 12:41:09 +00:00
|
|
|
m_a = 0x77abc0000000000000000000000000000000000000000000000000000000001;
|
|
|
|
m_b = 0x817416927846239487123469187231298734162934871263941234127518276;
|
2015-06-01 10:32:59 +00:00
|
|
|
g();
|
2017-04-03 12:41:09 +00:00
|
|
|
return 1;
|
2015-06-01 10:32:59 +00:00
|
|
|
}
|
2018-07-11 13:57:07 +00:00
|
|
|
function g() public {
|
2017-04-03 12:41:09 +00:00
|
|
|
m_b = 0x817416927846239487123469187231298734162934871263941234127518276;
|
|
|
|
m_c = 0x817416927846239487123469187231298734162934871263941234127518276;
|
|
|
|
h();
|
|
|
|
}
|
2018-07-11 13:57:07 +00:00
|
|
|
function h() public {
|
2017-04-03 12:41:09 +00:00
|
|
|
m_d = 0xff05694900000000000000000000000000000000000000000000000000000000;
|
2015-06-01 10:32:59 +00:00
|
|
|
}
|
2018-06-29 14:52:41 +00:00
|
|
|
function get() public returns (uint ra, uint rb, uint rc, uint rd) {
|
2017-04-03 12:41:09 +00:00
|
|
|
ra = m_a;
|
|
|
|
rb = m_b;
|
|
|
|
rc = m_c;
|
|
|
|
rd = m_d;
|
2015-06-01 10:32:59 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
2017-04-03 12:41:09 +00:00
|
|
|
compileBothVersions(sourceCode, 0, "C", 1);
|
|
|
|
compareVersions("get()");
|
2015-06-01 10:32:59 +00:00
|
|
|
compareVersions("set()");
|
|
|
|
compareVersions("get()");
|
|
|
|
|
2017-04-03 12:41:09 +00:00
|
|
|
bytes optimizedBytecode = compileAndRunWithOptimizer(sourceCode, 0, "C", true, 1);
|
2015-06-01 10:32:59 +00:00
|
|
|
bytes complicatedConstant = toBigEndian(u256("0x817416927846239487123469187231298734162934871263941234127518276"));
|
|
|
|
unsigned occurrences = 0;
|
|
|
|
for (auto iter = optimizedBytecode.cbegin(); iter < optimizedBytecode.cend(); ++occurrences)
|
2015-11-16 15:39:27 +00:00
|
|
|
{
|
|
|
|
iter = search(iter, optimizedBytecode.cend(), complicatedConstant.cbegin(), complicatedConstant.cend());
|
|
|
|
if (iter < optimizedBytecode.cend())
|
|
|
|
++iter;
|
|
|
|
}
|
2015-06-01 10:32:59 +00:00
|
|
|
BOOST_CHECK_EQUAL(2, occurrences);
|
|
|
|
|
|
|
|
bytes constantWithZeros = toBigEndian(u256("0x77abc0000000000000000000000000000000000000000000000000000000001"));
|
|
|
|
BOOST_CHECK(search(
|
|
|
|
optimizedBytecode.cbegin(),
|
|
|
|
optimizedBytecode.cend(),
|
|
|
|
constantWithZeros.cbegin(),
|
|
|
|
constantWithZeros.cend()
|
|
|
|
) == optimizedBytecode.cend());
|
|
|
|
}
|
|
|
|
|
2017-03-03 15:17:00 +00:00
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(constant_optimization_early_exit)
|
|
|
|
{
|
|
|
|
// This tests that the constant optimizer does not try to find the best representation
|
|
|
|
// indefinitely but instead stops after some number of iterations.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract HexEncoding {
|
2018-06-29 14:52:41 +00:00
|
|
|
function hexEncodeTest(address addr) public returns (bytes32 ret) {
|
2017-03-03 15:17:00 +00:00
|
|
|
uint x = uint(addr) / 2**32;
|
|
|
|
|
|
|
|
// Nibble interleave
|
|
|
|
x = x & 0x00000000000000000000000000000000ffffffffffffffffffffffffffffffff;
|
|
|
|
x = (x | (x * 2**64)) & 0x0000000000000000ffffffffffffffff0000000000000000ffffffffffffffff;
|
|
|
|
x = (x | (x * 2**32)) & 0x00000000ffffffff00000000ffffffff00000000ffffffff00000000ffffffff;
|
|
|
|
x = (x | (x * 2**16)) & 0x0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff;
|
|
|
|
x = (x | (x * 2** 8)) & 0x00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff;
|
|
|
|
x = (x | (x * 2** 4)) & 0x0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f;
|
|
|
|
|
|
|
|
// Hex encode
|
|
|
|
uint h = (x & 0x0808080808080808080808080808080808080808080808080808080808080808) / 8;
|
|
|
|
uint i = (x & 0x0404040404040404040404040404040404040404040404040404040404040404) / 4;
|
|
|
|
uint j = (x & 0x0202020202020202020202020202020202020202020202020202020202020202) / 2;
|
|
|
|
x = x + (h & (i | j)) * 0x27 + 0x3030303030303030303030303030303030303030303030303030303030303030;
|
|
|
|
|
|
|
|
// Store and load next batch
|
|
|
|
assembly {
|
|
|
|
mstore(0, x)
|
|
|
|
}
|
|
|
|
x = uint(addr) * 2**96;
|
|
|
|
|
|
|
|
// Nibble interleave
|
|
|
|
x = x & 0x00000000000000000000000000000000ffffffffffffffffffffffffffffffff;
|
|
|
|
x = (x | (x * 2**64)) & 0x0000000000000000ffffffffffffffff0000000000000000ffffffffffffffff;
|
|
|
|
x = (x | (x * 2**32)) & 0x00000000ffffffff00000000ffffffff00000000ffffffff00000000ffffffff;
|
|
|
|
x = (x | (x * 2**16)) & 0x0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff0000ffff;
|
|
|
|
x = (x | (x * 2** 8)) & 0x00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff00ff;
|
|
|
|
x = (x | (x * 2** 4)) & 0x0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f;
|
|
|
|
|
|
|
|
// Hex encode
|
|
|
|
h = (x & 0x0808080808080808080808080808080808080808080808080808080808080808) / 8;
|
|
|
|
i = (x & 0x0404040404040404040404040404040404040404040404040404040404040404) / 4;
|
|
|
|
j = (x & 0x0202020202020202020202020202020202020202020202020202020202020202) / 2;
|
|
|
|
x = x + (h & (i | j)) * 0x27 + 0x3030303030303030303030303030303030303030303030303030303030303030;
|
|
|
|
|
|
|
|
// Store and hash
|
|
|
|
assembly {
|
|
|
|
mstore(32, x)
|
2017-05-11 12:43:29 +00:00
|
|
|
ret := keccak256(0, 40)
|
2017-03-03 15:17:00 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
auto start = std::chrono::steady_clock::now();
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
double duration = std::chrono::duration<double>(std::chrono::steady_clock::now() - start).count();
|
2019-08-06 08:34:25 +00:00
|
|
|
// Since run time on an ASan build is not really realistic, we disable this test for those builds.
|
|
|
|
size_t maxDuration = 20;
|
2019-08-09 13:55:32 +00:00
|
|
|
#if !defined(__SANITIZE_ADDRESS__) && defined(__has_feature)
|
2019-08-06 08:34:25 +00:00
|
|
|
#if __has_feature(address_sanitizer)
|
2019-08-09 13:55:32 +00:00
|
|
|
#define __SANITIZE_ADDRESS__ 1
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#if __SANITIZE_ADDRESS__
|
2020-06-02 13:42:46 +00:00
|
|
|
maxDuration = numeric_limits<size_t>::max();
|
2019-08-06 08:34:25 +00:00
|
|
|
BOOST_TEST_MESSAGE("Disabled constant optimizer run time check for address sanitizer build.");
|
|
|
|
#endif
|
2019-12-12 23:39:29 +00:00
|
|
|
BOOST_CHECK_MESSAGE(duration <= double(maxDuration), "Compilation of constants took longer than 20 seconds.");
|
2017-03-03 15:17:00 +00:00
|
|
|
compareVersions("hexEncodeTest(address)", u256(0x123456789));
|
|
|
|
}
|
|
|
|
|
2016-07-29 09:46:57 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(inconsistency)
|
|
|
|
{
|
|
|
|
// This is a test of a bug in the optimizer.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract Inconsistency {
|
|
|
|
struct Value {
|
|
|
|
uint badnum;
|
|
|
|
uint number;
|
|
|
|
}
|
|
|
|
|
|
|
|
struct Container {
|
|
|
|
uint[] valueIndices;
|
|
|
|
Value[] values;
|
|
|
|
}
|
|
|
|
|
|
|
|
Container[] containers;
|
|
|
|
uint[] valueIndices;
|
|
|
|
uint INDEX_ZERO = 0;
|
|
|
|
uint debug;
|
|
|
|
|
|
|
|
// Called with params: containerIndex=0, valueIndex=0
|
|
|
|
function levelIII(uint containerIndex, uint valueIndex) private {
|
2018-07-11 11:23:33 +00:00
|
|
|
Container storage container = containers[containerIndex];
|
|
|
|
Value storage value = container.values[valueIndex];
|
2016-07-29 09:46:57 +00:00
|
|
|
debug = container.valueIndices[value.number];
|
|
|
|
}
|
|
|
|
function levelII() private {
|
|
|
|
for (uint i = 0; i < valueIndices.length; i++) {
|
|
|
|
levelIII(INDEX_ZERO, valueIndices[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function trigger() public returns (uint) {
|
2019-09-18 13:39:23 +00:00
|
|
|
Container storage container = containers.push();
|
2016-07-29 09:46:57 +00:00
|
|
|
|
|
|
|
container.values.push(Value({
|
|
|
|
badnum: 9000,
|
|
|
|
number: 0
|
|
|
|
}));
|
|
|
|
|
2019-09-18 13:39:23 +00:00
|
|
|
container.valueIndices.push();
|
|
|
|
valueIndices.push();
|
2016-07-29 09:46:57 +00:00
|
|
|
|
|
|
|
levelII();
|
|
|
|
return debug;
|
|
|
|
}
|
|
|
|
|
|
|
|
function DoNotCallButDoNotDelete() public {
|
|
|
|
levelII();
|
|
|
|
levelIII(1, 2);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("trigger()");
|
|
|
|
}
|
|
|
|
|
2016-11-11 10:41:50 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(dead_code_elimination_across_assemblies)
|
|
|
|
{
|
|
|
|
// This tests that a runtime-function that is stored in storage in the constructor
|
|
|
|
// is not removed as part of dead code elimination.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract DCE {
|
|
|
|
function () internal returns (uint) stored;
|
2020-06-23 12:14:24 +00:00
|
|
|
constructor() {
|
2016-11-11 10:41:50 +00:00
|
|
|
stored = f;
|
|
|
|
}
|
|
|
|
function f() internal returns (uint) { return 7; }
|
2018-06-29 14:52:41 +00:00
|
|
|
function test() public returns (uint) { return stored(); }
|
2016-11-11 10:41:50 +00:00
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("test()");
|
|
|
|
}
|
|
|
|
|
2016-11-22 13:55:09 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(invalid_state_at_control_flow_join)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract Test {
|
|
|
|
uint256 public totalSupply = 100;
|
2018-06-29 14:52:41 +00:00
|
|
|
function f() public returns (uint r) {
|
2016-11-22 13:55:09 +00:00
|
|
|
if (false)
|
|
|
|
r = totalSupply;
|
|
|
|
totalSupply -= 10;
|
|
|
|
}
|
2018-06-29 14:52:41 +00:00
|
|
|
function test() public returns (uint) {
|
2016-11-22 13:55:09 +00:00
|
|
|
f();
|
|
|
|
return this.totalSupply();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("test()");
|
|
|
|
}
|
|
|
|
|
2018-03-13 14:21:38 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(init_empty_dynamic_arrays)
|
|
|
|
{
|
|
|
|
// This is not so much an optimizer test, but rather a test
|
|
|
|
// that allocating empty arrays is implemented efficiently.
|
|
|
|
// In particular, initializing a dynamic memory array does
|
|
|
|
// not use any memory.
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract Test {
|
2018-07-11 13:57:07 +00:00
|
|
|
function f() public pure returns (uint r) {
|
2018-03-13 14:21:38 +00:00
|
|
|
uint[][] memory x = new uint[][](20000);
|
|
|
|
return x.length;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f()");
|
|
|
|
BOOST_CHECK_LE(m_gasUsedNonOptimized, 1900000);
|
|
|
|
BOOST_CHECK_LE(1600000, m_gasUsedNonOptimized);
|
|
|
|
}
|
|
|
|
|
2018-03-13 12:00:16 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(optimise_multi_stores)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract Test {
|
|
|
|
struct S { uint16 a; uint16 b; uint16[3] c; uint[] dyn; }
|
|
|
|
uint padding;
|
|
|
|
S[] s;
|
2018-07-12 04:18:50 +00:00
|
|
|
function f() public returns (uint16, uint16, uint16[3] memory, uint) {
|
2018-03-13 12:00:16 +00:00
|
|
|
uint16[3] memory c;
|
|
|
|
c[0] = 7;
|
|
|
|
c[1] = 8;
|
|
|
|
c[2] = 9;
|
|
|
|
s.push(S(1, 2, c, new uint[](4)));
|
|
|
|
return (s[0].a, s[0].b, s[0].c, s[0].dyn[2]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f()");
|
2020-10-01 17:07:56 +00:00
|
|
|
BOOST_CHECK_EQUAL(numInstructions(m_nonOptimizedBytecode, Instruction::SSTORE), 8);
|
|
|
|
BOOST_CHECK_EQUAL(numInstructions(m_optimizedBytecode, Instruction::SSTORE), 7);
|
2018-03-13 12:00:16 +00:00
|
|
|
}
|
|
|
|
|
2019-02-05 16:46:13 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(optimise_constant_to_codecopy)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract C {
|
|
|
|
// We use the state variable so that the functions won't be deemed identical
|
|
|
|
// and be optimised out to the same implementation.
|
|
|
|
uint a;
|
|
|
|
function f() public returns (uint) {
|
|
|
|
a = 1;
|
|
|
|
// This cannot be represented well with the `CalculateMethod`,
|
|
|
|
// hence the decision will be between `LiteralMethod` and `CopyMethod`.
|
|
|
|
return 0x1234123412431234123412412342112341234124312341234124;
|
|
|
|
}
|
|
|
|
function g() public returns (uint) {
|
|
|
|
a = 2;
|
|
|
|
return 0x1234123412431234123412412342112341234124312341234124;
|
|
|
|
}
|
|
|
|
function h() public returns (uint) {
|
|
|
|
a = 3;
|
|
|
|
return 0x1234123412431234123412412342112341234124312341234124;
|
|
|
|
}
|
|
|
|
function i() public returns (uint) {
|
|
|
|
a = 4;
|
|
|
|
return 0x1234123412431234123412412342112341234124312341234124;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode, 0, "C", 50);
|
|
|
|
compareVersions("f()");
|
|
|
|
compareVersions("g()");
|
|
|
|
compareVersions("h()");
|
|
|
|
compareVersions("i()");
|
|
|
|
// This is counting in the deployed code.
|
|
|
|
BOOST_CHECK_EQUAL(numInstructions(m_nonOptimizedBytecode, Instruction::CODECOPY), 0);
|
|
|
|
BOOST_CHECK_EQUAL(numInstructions(m_optimizedBytecode, Instruction::CODECOPY), 4);
|
|
|
|
}
|
|
|
|
|
2019-03-12 14:07:39 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(byte_access)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract C
|
|
|
|
{
|
|
|
|
function f(bytes32 x) public returns (byte r)
|
|
|
|
{
|
|
|
|
assembly { r := and(byte(x, 31), 0xff) }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
|
|
|
compareVersions("f(bytes32)", u256("0x1223344556677889900112233445566778899001122334455667788990011223"));
|
|
|
|
}
|
|
|
|
|
|
|
|
BOOST_AUTO_TEST_CASE(shift_optimizer_bug)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract C
|
|
|
|
{
|
2019-03-12 14:14:12 +00:00
|
|
|
function f(uint x) public returns (uint)
|
2019-03-12 14:07:39 +00:00
|
|
|
{
|
2019-03-12 14:14:12 +00:00
|
|
|
return (x << 1) << uint(-1);
|
2019-03-12 14:07:39 +00:00
|
|
|
}
|
2019-03-12 14:14:12 +00:00
|
|
|
function g(uint x) public returns (uint)
|
2019-03-12 14:07:39 +00:00
|
|
|
{
|
2019-03-12 14:14:12 +00:00
|
|
|
return (x >> 1) >> uint(-1);
|
2019-03-12 14:07:39 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode);
|
2019-03-12 14:14:12 +00:00
|
|
|
compareVersions("f(uint256)", 7);
|
|
|
|
compareVersions("g(uint256)", u256(-1));
|
2019-03-12 14:07:39 +00:00
|
|
|
}
|
|
|
|
|
2020-06-08 15:50:55 +00:00
|
|
|
BOOST_AUTO_TEST_CASE(avoid_double_cleanup)
|
|
|
|
{
|
|
|
|
char const* sourceCode = R"(
|
|
|
|
contract C {
|
|
|
|
receive() external payable {
|
|
|
|
abi.encodePacked(uint200(0));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
)";
|
|
|
|
compileBothVersions(sourceCode, 0, "C", 50);
|
2020-06-08 15:52:40 +00:00
|
|
|
// Check that there is no double AND instruction in the resulting code
|
|
|
|
BOOST_CHECK_EQUAL(numInstructions(m_nonOptimizedBytecode, Instruction::AND), 1);
|
2020-06-08 15:50:55 +00:00
|
|
|
}
|
2019-03-12 14:07:39 +00:00
|
|
|
|
2014-12-11 15:37:17 +00:00
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|
|
|
|
|
|
|
|
} // end namespaces
|