aboutsummaryrefslogtreecommitdiffstats
path: root/CompilerContext.h
blob: 562c2932176fc2182e64485db913a290a6bf8caa (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
/*
    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
 * Utilities for the solidity compiler.
 */

#pragma once

#include <ostream>
#include <libevmcore/Instruction.h>
#include <libevmcore/Assembly.h>
#include <libsolidity/Types.h>

namespace dev {
namespace solidity {


/**
 * Context to be shared by all units that compile the same contract.
 * It stores the generated bytecode and the position of identifiers in memory and on the stack.
 */
class CompilerContext
{
public:
    CompilerContext(): m_stateVariablesSize(0) {}

    void addStateVariable(VariableDeclaration const& _declaration);
    void startNewFunction() { m_localVariables.clear(); m_asm.setDeposit(0); }
    void initializeLocalVariables(unsigned _numVariables);
    void addVariable(VariableDeclaration const& _declaration) { m_localVariables.push_back(&_declaration); }
    void addFunction(FunctionDefinition const& _function) { m_functionEntryLabels.insert(std::make_pair(&_function, m_asm.newTag())); }

    void adjustStackOffset(int _adjustment) { m_asm.adjustDeposit(_adjustment); }

    bool isFunctionDefinition(Declaration const* _declaration) const { return m_functionEntryLabels.count(_declaration); }
    bool isLocalVariable(Declaration const* _declaration) const;
    bool isStateVariable(Declaration const* _declaration) const { return m_stateVariables.count(_declaration); }

    eth::AssemblyItem getFunctionEntryLabel(FunctionDefinition const& _function) const;
    /// Returns the distance of the given local variable from the top of the local variable stack.
    unsigned getBaseStackOffsetOfVariable(Declaration const& _declaration) const;
    /// If supplied by a value returned by @ref getBaseStackOffsetOfVariable(variable), returns
    /// the distance of that variable from the current top of the stack.
    unsigned baseToCurrentStackOffset(unsigned _baseOffset) const;
    u256 getStorageLocationOfVariable(Declaration const& _declaration) const;

    /// Appends a JUMPI instruction to a new tag and @returns the tag
    eth::AssemblyItem appendConditionalJump() { return m_asm.appendJumpI().tag(); }
    /// Appends a JUMPI instruction to @a _tag
    CompilerContext& appendConditionalJumpTo(eth::AssemblyItem const& _tag) { m_asm.appendJumpI(_tag); return *this; }
    /// Appends a JUMP to a new tag and @returns the tag
    eth::AssemblyItem appendJump() { return m_asm.appendJump().tag(); }
    /// Appends a JUMP to a specific tag
    CompilerContext& appendJumpTo(eth::AssemblyItem const& _tag) { m_asm.appendJump(_tag); return *this; }
    /// Appends pushing of a new tag and @returns the new tag.
    eth::AssemblyItem pushNewTag() { return m_asm.append(m_asm.newPushTag()).tag(); }
    /// @returns a new tag without pushing any opcodes or data
    eth::AssemblyItem newTag() { return m_asm.newTag(); }
    /// Adds a subroutine to the code (in the data section) and pushes its size (via a tag)
    /// on the stack. @returns the assembly item corresponding to the pushed subroutine, i.e. its offset.
    eth::AssemblyItem addSubroutine(eth::Assembly const& _assembly) { return m_asm.appendSubSize(_assembly); }

    /// Append elements to the current instruction list and adjust @a m_stackOffset.
    CompilerContext& operator<<(eth::AssemblyItem const& _item) { m_asm.append(_item); return *this; }
    CompilerContext& operator<<(eth::Instruction _instruction) { m_asm.append(_instruction); return *this; }
    CompilerContext& operator<<(u256 const& _value) { m_asm.append(_value); return *this; }
    CompilerContext& operator<<(bytes const& _data) { m_asm.append(_data); return *this; }

    eth::Assembly const& getAssembly() const { return m_asm; }
    void streamAssembly(std::ostream& _stream) const { _stream << m_asm; }
    bytes getAssembledBytecode(bool _optimize = false) { return m_asm.optimise(_optimize).assemble(); }
private:
    eth::Assembly m_asm;

    /// Size of the state variables, offset of next variable to be added.
    u256 m_stateVariablesSize;
    /// Storage offsets of state variables
    std::map<Declaration const*, u256> m_stateVariables;
    /// Offsets of local variables on the stack.
    std::vector<Declaration const*> m_localVariables;
    /// Labels pointing to the entry points of funcitons.
    std::map<Declaration const*, eth::AssemblyItem> m_functionEntryLabels;
};

}
}