aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/inlineasm/AsmParser.cpp
blob: 0fc0a34f8cd91d262391d4973a64423f3e8ad762 (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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
/*
    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/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2016
 * Solidity inline assembly parser.
 */

#include <libsolidity/inlineasm/AsmParser.h>
#include <ctype.h>
#include <algorithm>
#include <libsolidity/parsing/Scanner.h>

using namespace std;
using namespace dev;
using namespace dev::solidity;
using namespace dev::solidity::assembly;

shared_ptr<assembly::Block> Parser::parse(std::shared_ptr<Scanner> const& _scanner)
{
    try
    {
        m_scanner = _scanner;
        return make_shared<Block>(parseBlock());
    }
    catch (FatalError const&)
    {
        if (m_errors.empty())
            throw; // Something is weird here, rather throw again.
    }
    return nullptr;
}

assembly::Block Parser::parseBlock()
{
    assembly::Block block = createWithLocation<Block>();
    expectToken(Token::LBrace);
    while (m_scanner->currentToken() != Token::RBrace)
        block.statements.emplace_back(parseStatement());
    block.location.end = endPosition();
    m_scanner->next();
    return block;
}

assembly::Statement Parser::parseStatement()
{
    switch (m_scanner->currentToken())
    {
    case Token::Let:
        return parseVariableDeclaration();
    case Token::Function:
        return parseFunctionDefinition();
    case Token::LBrace:
        return parseBlock();
    case Token::Assign:
    {
        assembly::Assignment assignment = createWithLocation<assembly::Assignment>();
        m_scanner->next();
        expectToken(Token::Colon);
        assignment.variableName.location = location();
        assignment.variableName.name = m_scanner->currentLiteral();
        if (instructions().count(assignment.variableName.name))
            fatalParserError("Identifier expected, got instruction name.");
        assignment.location.end = endPosition();
        expectToken(Token::Identifier);
        return assignment;
    }
    case Token::Return: // opcode
    case Token::Byte: // opcode
    default:
        break;
    }
    // Options left:
    // Simple instruction (might turn into functional),
    // literal,
    // identifier (might turn into label or functional assignment)
    Statement statement(parseElementaryOperation());
    switch (m_scanner->currentToken())
    {
    case Token::LParen:
        return parseFunctionalInstruction(std::move(statement));
    case Token::Colon:
    {
        if (statement.type() != typeid(assembly::Identifier))
            fatalParserError("Label name / variable name must precede \":\".");
        assembly::Identifier const& identifier = boost::get<assembly::Identifier>(statement);
        m_scanner->next();
        // identifier:=: should be parsed as identifier: =: (i.e. a label),
        // while identifier:= (being followed by a non-colon) as identifier := (assignment).
        if (m_scanner->currentToken() == Token::Assign && m_scanner->peekNextToken() != Token::Colon)
        {
            // functional assignment
            FunctionalAssignment funAss = createWithLocation<FunctionalAssignment>(identifier.location);
            if (instructions().count(identifier.name))
                fatalParserError("Cannot use instruction names for identifier names.");
            m_scanner->next();
            funAss.variableName = identifier;
            funAss.value.reset(new Statement(parseExpression()));
            funAss.location.end = locationOf(*funAss.value).end;
            return funAss;
        }
        else
        {
            // label
            Label label = createWithLocation<Label>(identifier.location);
            label.name = identifier.name;
            return label;
        }
    }
    default:
        break;
    }
    return statement;
}

assembly::Statement Parser::parseExpression()
{
    Statement operation = parseElementaryOperation(true);
    if (m_scanner->currentToken() == Token::LParen)
        return parseFunctionalInstruction(std::move(operation));
    else
        return operation;
}

std::map<string, dev::solidity::Instruction> const& Parser::instructions()
{
    // Allowed instructions, lowercase names.
    static map<string, dev::solidity::Instruction> s_instructions;
    if (s_instructions.empty())
    {
        for (auto const& instruction: solidity::c_instructions)
        {
            if (
                instruction.second == solidity::Instruction::JUMPDEST ||
                (solidity::Instruction::PUSH1 <= instruction.second && instruction.second <= solidity::Instruction::PUSH32)
            )
                continue;
            string name = instruction.first;
            transform(name.begin(), name.end(), name.begin(), [](unsigned char _c) { return tolower(_c); });
            s_instructions[name] = instruction.second;
        }

        // add alias for suicide
        s_instructions["suicide"] = solidity::Instruction::SELFDESTRUCT;
    }
    return s_instructions;
}

assembly::Statement Parser::parseElementaryOperation(bool _onlySinglePusher)
{
    Statement ret;
    switch (m_scanner->currentToken())
    {
    case Token::Identifier:
    case Token::Return:
    case Token::Byte:
    case Token::Address:
    {
        string literal;
        if (m_scanner->currentToken() == Token::Return)
            literal = "return";
        else if (m_scanner->currentToken() == Token::Byte)
            literal = "byte";
        else if (m_scanner->currentToken() == Token::Address)
            literal = "address";
        else
            literal = m_scanner->currentLiteral();
        // first search the set of instructions.
        if (instructions().count(literal))
        {
            dev::solidity::Instruction const& instr = instructions().at(literal);
            if (_onlySinglePusher)
            {
                InstructionInfo info = dev::solidity::instructionInfo(instr);
                if (info.ret != 1)
                    fatalParserError("Instruction " + info.name + " not allowed in this context.");
            }
            ret = Instruction{location(), instr};
        }
        else
            ret = Identifier{location(), literal};
        break;
    }
    case Token::StringLiteral:
    case Token::Number:
    {
        ret = Literal{
            location(),
            m_scanner->currentToken() == Token::Number,
            m_scanner->currentLiteral()
        };
        break;
    }
    default:
        fatalParserError("Expected elementary inline assembly operation.");
    }
    m_scanner->next();
    return ret;
}

assembly::VariableDeclaration Parser::parseVariableDeclaration()
{
    VariableDeclaration varDecl = createWithLocation<VariableDeclaration>();
    expectToken(Token::Let);
    varDecl.name = expectAsmIdentifier();
    expectToken(Token::Colon);
    expectToken(Token::Assign);
    varDecl.value.reset(new Statement(parseExpression()));
    varDecl.location.end = locationOf(*varDecl.value).end;
    return varDecl;
}

assembly::FunctionDefinition Parser::parseFunctionDefinition()
{
    FunctionDefinition funDef = createWithLocation<FunctionDefinition>();
    expectToken(Token::Function);
    funDef.name = expectAsmIdentifier();
    expectToken(Token::LParen);
    while (m_scanner->currentToken() != Token::RParen)
    {
        funDef.arguments.push_back(expectAsmIdentifier());
        if (m_scanner->currentToken() == Token::RParen)
            break;
        expectToken(Token::Comma);
    }
    expectToken(Token::RParen);
    if (m_scanner->currentToken() == Token::Sub)
    {
        expectToken(Token::Sub);
        expectToken(Token::GreaterThan);
        expectToken(Token::LParen);
        while (true)
        {
            funDef.returns.push_back(expectAsmIdentifier());
            if (m_scanner->currentToken() == Token::RParen)
                break;
            expectToken(Token::Comma);
        }
        expectToken(Token::RParen);
    }
    funDef.body = parseBlock();
    funDef.location.end = funDef.body.location.end;
    return funDef;
}

assembly::Statement Parser::parseFunctionalInstruction(assembly::Statement&& _instruction)
{
    if (_instruction.type() == typeid(Instruction))
    {
        FunctionalInstruction ret;
        ret.instruction = std::move(boost::get<Instruction>(_instruction));
        ret.location = ret.instruction.location;
        solidity::Instruction instr = ret.instruction.instruction;
        InstructionInfo instrInfo = instructionInfo(instr);
        if (solidity::Instruction::DUP1 <= instr && instr <= solidity::Instruction::DUP16)
            fatalParserError("DUPi instructions not allowed for functional notation");
        if (solidity::Instruction::SWAP1 <= instr && instr <= solidity::Instruction::SWAP16)
            fatalParserError("SWAPi instructions not allowed for functional notation");
        expectToken(Token::LParen);
        unsigned args = unsigned(instrInfo.args);
        for (unsigned i = 0; i < args; ++i)
        {
            ret.arguments.emplace_back(parseExpression());
            if (i != args - 1)
            {
                if (m_scanner->currentToken() != Token::Comma)
                    fatalParserError(string(
                        "Expected comma (" +
                        instrInfo.name +
                        " expects " +
                        boost::lexical_cast<string>(args) +
                        " arguments)"
                    ));
                else
                    m_scanner->next();
            }
        }
        ret.location.end = endPosition();
        if (m_scanner->currentToken() == Token::Comma)
            fatalParserError(
                string("Expected ')' (" + instrInfo.name + " expects " + boost::lexical_cast<string>(args) + " arguments)")
            );
        expectToken(Token::RParen);
        return ret;
    }
    else if (_instruction.type() == typeid(Identifier))
    {
        FunctionCall ret;
        ret.functionName = std::move(boost::get<Identifier>(_instruction));
        ret.location = ret.functionName.location;
        expectToken(Token::LParen);
        while (m_scanner->currentToken() != Token::RParen)
        {
            ret.arguments.emplace_back(parseExpression());
            if (m_scanner->currentToken() == Token::RParen)
                break;
            expectToken(Token::Comma);
        }
        ret.location.end = endPosition();
        expectToken(Token::RParen);
        return ret;
    }
    else
        fatalParserError("Assembly instruction or function name required in front of \"(\")");

    return {};
}

string Parser::expectAsmIdentifier()
{
    string name = m_scanner->currentLiteral();
    if (instructions().count(name))
        fatalParserError("Cannot use instruction names for identifier names.");
    expectToken(Token::Identifier);
    return name;
}