aboutsummaryrefslogtreecommitdiffstats
path: root/solidityCompiler.cpp
blob: ba2db67e6c58b88b9b9c88ef8d28ebbff9251b24 (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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/*
    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
 * Unit tests for the solidity compiler.
 */

#include <string>
#include <iostream>
#include <boost/test/unit_test.hpp>
#include <libdevcore/Log.h>
#include <libsolidity/Scanner.h>
#include <libsolidity/Parser.h>
#include <libsolidity/NameAndTypeResolver.h>
#include <libsolidity/Compiler.h>
#include <libsolidity/AST.h>

using namespace std;
using namespace dev::eth;

namespace dev
{
namespace solidity
{
namespace test
{

namespace
{

bytes compileContract(const string& _sourceCode)
{
    Parser parser;
    ASTPointer<ContractDefinition> contract;
    BOOST_REQUIRE_NO_THROW(contract = parser.parse(make_shared<Scanner>(CharStream(_sourceCode))));
    NameAndTypeResolver resolver;
    BOOST_REQUIRE_NO_THROW(resolver.resolveNamesAndTypes(*contract));

    Compiler compiler;
    compiler.compileContract(*contract);
    // debug
    //compiler.streamAssembly(cout);
    return compiler.getAssembledBytecode();
}

/// Checks that @a _compiledCode is present starting from offset @a _offset in @a _expectation.
/// This is necessary since the compiler will add boilerplate add the beginning that is not
/// tested here.
void checkCodePresentAt(bytes const& _compiledCode, bytes const& _expectation, unsigned _offset)
{
    BOOST_REQUIRE(_compiledCode.size() >= _offset + _expectation.size());
    auto checkStart = _compiledCode.begin() + _offset;
    BOOST_CHECK_EQUAL_COLLECTIONS(checkStart, checkStart + _expectation.size(),
                                  _expectation.begin(), _expectation.end());
}

} // end anonymous namespace

BOOST_AUTO_TEST_SUITE(SolidityCompiler)

BOOST_AUTO_TEST_CASE(smoke_test)
{
    char const* sourceCode = "contract test {\n"
                             "  function f() { var x = 2; }\n"
                             "}\n";
    bytes code = compileContract(sourceCode);

    unsigned boilerplateSize = 51;
    bytes expectation({byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), 0x0, // initialize local variable x
                       byte(Instruction::PUSH1), 0x2,
                       byte(Instruction::SWAP1),
                       byte(Instruction::POP),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::POP),
                       byte(Instruction::JUMP)});
    checkCodePresentAt(code, expectation, boilerplateSize);
}

BOOST_AUTO_TEST_CASE(different_argument_numbers)
{
    char const* sourceCode = "contract test {\n"
                             "  function f(uint a, uint b, uint c) returns(uint d) { return b; }\n"
                             "  function g() returns (uint e, uint h) { h = f(1, 2, 3); }\n"
                             "}\n";
    bytes code = compileContract(sourceCode);

    unsigned shift = 75;
    unsigned boilerplateSize = 88;
    bytes expectation({byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), 0x0, // initialize return variable d
                       byte(Instruction::DUP3),
                       byte(Instruction::SWAP1), // assign b to d
                       byte(Instruction::POP),
                       byte(Instruction::PUSH1), byte(0xa + shift), // jump to return
                       byte(Instruction::JUMP),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::SWAP4), // store d and fetch return address
                       byte(Instruction::SWAP3), // store return address
                       byte(Instruction::POP),
                       byte(Instruction::POP),
                       byte(Instruction::POP),
                       byte(Instruction::JUMP), // end of f
                       byte(Instruction::JUMPDEST), // beginning of g
                       byte(Instruction::PUSH1), 0x0,
                       byte(Instruction::DUP1), // initialized e and h
                       byte(Instruction::PUSH1), byte(0x29 + shift), // ret address
                       byte(Instruction::PUSH1), 0x1, byte(Instruction::PUSH1), 0xff, byte(Instruction::AND),
                       byte(Instruction::PUSH1), 0x2, byte(Instruction::PUSH1), 0xff, byte(Instruction::AND),
                       byte(Instruction::PUSH1), 0x3, byte(Instruction::PUSH1), 0xff, byte(Instruction::AND),
                       byte(Instruction::PUSH1), byte(0x1 + shift),
                       // stack here: ret e h 0x20 1 2 3 0x1
                       byte(Instruction::JUMP),
                       byte(Instruction::JUMPDEST),
                       // stack here: ret e h f(1,2,3)
                       byte(Instruction::DUP2),
                       byte(Instruction::POP),
                       byte(Instruction::SWAP1),
                       // stack here: ret e f(1,2,3) h
                       byte(Instruction::POP),
                       byte(Instruction::DUP1), // retrieve it again as "value of expression"
                       byte(Instruction::POP), // end of assignment
                       // stack here: ret e f(1,2,3)
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::SWAP1),
                       // ret e f(1,2,3)
                       byte(Instruction::SWAP2),
                       // f(1,2,3) e ret
                       byte(Instruction::JUMP) // end of g
                       });
    checkCodePresentAt(code, expectation, boilerplateSize);
}

BOOST_AUTO_TEST_CASE(ifStatement)
{
    char const* sourceCode = "contract test {\n"
                             "  function f() { bool x; if (x) 77; else if (!x) 78; else 79; }"
                             "}\n";
    bytes code = compileContract(sourceCode);

    unsigned shift = 38;
    unsigned boilerplateSize = 51;
    bytes expectation({byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), 0x0,
                       byte(Instruction::DUP1),
                       byte(Instruction::PUSH1), byte(0x1b + shift), // "true" target
                       byte(Instruction::JUMPI),
                       // new check "else if" condition
                       byte(Instruction::DUP1),
                       byte(Instruction::ISZERO),
                       byte(Instruction::PUSH1), byte(0x13 + shift),
                       byte(Instruction::JUMPI),
                       // "else" body
                       byte(Instruction::PUSH1), 0x4f,
                       byte(Instruction::POP),
                       byte(Instruction::PUSH1), byte(0x17 + shift), // exit path of second part
                       byte(Instruction::JUMP),
                       // "else if" body
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), 0x4e,
                       byte(Instruction::POP),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), byte(0x1f + shift),
                       byte(Instruction::JUMP),
                       // "if" body
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), 0x4d,
                       byte(Instruction::POP),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::POP),
                       byte(Instruction::JUMP)});
    checkCodePresentAt(code, expectation, boilerplateSize);
}

BOOST_AUTO_TEST_CASE(loops)
{
    char const* sourceCode = "contract test {\n"
                             "  function f() { while(true){1;break;2;continue;3;return;4;} }"
                             "}\n";
    bytes code = compileContract(sourceCode);

    unsigned shift = 38;
    unsigned boilerplateSize = 51;
    bytes expectation({byte(Instruction::JUMPDEST),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::PUSH1), 0x1,
                       byte(Instruction::ISZERO),
                       byte(Instruction::PUSH1), byte(0x21 + shift),
                       byte(Instruction::JUMPI),
                       byte(Instruction::PUSH1), 0x1,
                       byte(Instruction::POP),
                       byte(Instruction::PUSH1), byte(0x21 + shift),
                       byte(Instruction::JUMP), // break
                       byte(Instruction::PUSH1), 0x2,
                       byte(Instruction::POP),
                       byte(Instruction::PUSH1), byte(0x2 + shift),
                       byte(Instruction::JUMP), // continue
                       byte(Instruction::PUSH1), 0x3,
                       byte(Instruction::POP),
                       byte(Instruction::PUSH1), byte(0x22 + shift),
                       byte(Instruction::JUMP), // return
                       byte(Instruction::PUSH1), 0x4,
                       byte(Instruction::POP),
                       byte(Instruction::PUSH1), byte(0x2 + shift),
                       byte(Instruction::JUMP),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::JUMPDEST),
                       byte(Instruction::JUMP)});

    checkCodePresentAt(code, expectation, boilerplateSize);
}

BOOST_AUTO_TEST_SUITE_END()

}
}
} // end namespaces