aboutsummaryrefslogtreecommitdiffstats
path: root/SolidityOptimizer.cpp
blob: ef5c6f9b5e89d724a8ba52475043d86f53c18d2d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Tests for the Solidity optimizer.
 */

#include <string>
#include <tuple>
#include <boost/test/unit_test.hpp>
#include <boost/lexical_cast.hpp>
#include <test/solidityExecutionFramework.h>

using namespace std;

namespace dev
{
namespace solidity
{
namespace test
{

class OptimizerTestFramework: public ExecutionFramework
{
public:
    OptimizerTestFramework() { }
    /// Compiles the source code with and without optimizing.
    void compileBothVersions(unsigned _expectedSizeDecrease, std::string const& _sourceCode, u256 const& _value = 0, std::string const& _contractName = "") {
        m_optimize = false;
        bytes nonOptimizedBytecode = compileAndRun(_sourceCode, _value, _contractName);
        m_nonOptimizedContract = m_contractAddress;
        m_optimize = true;
        bytes optimizedBytecode = compileAndRun(_sourceCode, _value, _contractName);
        int sizeDiff = nonOptimizedBytecode.size() - optimizedBytecode.size();
        BOOST_CHECK_MESSAGE(sizeDiff == int(_expectedSizeDecrease), "Bytecode did only shrink by "
                            + boost::lexical_cast<string>(sizeDiff) + " bytes, expected: "
                            + boost::lexical_cast<string>(_expectedSizeDecrease));
        m_optimizedContract = m_contractAddress;
    }

    template <class... Args>
    void compareVersions(byte _index, Args const&... _arguments)
    {
        m_contractAddress = m_nonOptimizedContract;
        bytes nonOptimizedOutput = callContractFunction(_index, _arguments...);
        m_contractAddress = m_optimizedContract;
        bytes optimizedOutput = callContractFunction(_index, _arguments...);
        BOOST_CHECK_MESSAGE(nonOptimizedOutput == optimizedOutput, "Computed values do not match."
                            "\nNon-Optimized: " + toHex(nonOptimizedOutput) +
                            "\nOptimized:     " + toHex(optimizedOutput));
    }

protected:
    Address m_optimizedContract;
    Address m_nonOptimizedContract;
};

BOOST_FIXTURE_TEST_SUITE(SolidityOptimizer, OptimizerTestFramework)

BOOST_AUTO_TEST_CASE(smoke_test)
{
    char const* sourceCode = R"(
        contract test {
            function f(uint a) returns (uint b) {
                return a;
            }
        })";
    compileBothVersions(4, sourceCode);
    compareVersions(0, u256(7));
}

BOOST_AUTO_TEST_CASE(large_integers)
{
    char const* sourceCode = R"(
        contract test {
            function f() returns (uint a, uint b) {
                a = 0x234234872642837426347000000;
                b = 0x110000000000000000000000002;
            }
        })";
    compileBothVersions(28, sourceCode);
    compareVersions(0);
}

BOOST_AUTO_TEST_CASE(invariants)
{
    char const* sourceCode = R"(
        contract test {
            function f(uint a) returns (uint b) {
                return (((a + (1 - 1)) ^ 0) | 0) & (uint(0) - 1);
            }
        })";
    compileBothVersions(28, sourceCode);
    compareVersions(0, u256(0x12334664));
}

BOOST_AUTO_TEST_CASE(unused_expressions)
{
    char const* sourceCode = R"(
        contract test {
            uint data;
            function f() returns (uint a, uint b) {
                10 + 20;
                data;
            }
        })";
    compileBothVersions(11, sourceCode);
    compareVersions(0);
}

BOOST_AUTO_TEST_CASE(constant_folding_both_sides)
{
    // if constants involving the same associative and commutative operator are applied from both
    // sides, the operator should be applied only once, because the expression compiler
    // (even in non-optimized mode) pushes literals as late as possible
    char const* sourceCode = R"(
        contract test {
            function f(uint x) returns (uint y) {
                return 98 ^ (7 * ((1 | (x | 1000)) * 40) ^ 102);
            }
        })";
    compileBothVersions(31, sourceCode);
    compareVersions(0);
}

BOOST_AUTO_TEST_SUITE_END()

}
}
} // end namespaces