solidity/CompilerUtils.h

133 lines
4.9 KiB
C
Raw Normal View History

/*
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
* Routines used by both the compiler and the expression compiler.
*/
#pragma once
#include <libsolidity/CompilerContext.h>
#include <libsolidity/ASTForward.h>
namespace dev {
namespace solidity {
class Type; // forward
class CompilerUtils
{
public:
CompilerUtils(CompilerContext& _context): m_context(_context) {}
2015-06-05 15:32:13 +00:00
/// Stores the initial value of the free-memory-pointer at its position;
void initialiseFreeMemoryPointer();
/// Copies the free memory pointer to the stack.
void fetchFreeMemoryPointer();
/// Stores the free memory pointer from the stack.
void storeFreeMemoryPointer();
/// Appends code that transforms memptr to (memptr - free_memptr) memptr
void toSizeAfterFreeMemoryPointer();
2015-06-05 15:32:13 +00:00
2014-12-10 16:15:17 +00:00
/// Loads data from memory to the stack.
/// @param _offset offset in memory (or calldata)
2015-02-14 23:11:51 +00:00
/// @param _type data type to load
2014-12-10 16:15:17 +00:00
/// @param _fromCalldata if true, load from calldata, not from memory
2015-01-08 23:58:32 +00:00
/// @param _padToWordBoundaries if true, assume the data is padded to word (32 byte) boundaries
2015-02-15 00:02:38 +00:00
/// @returns the number of bytes consumed in memory.
2015-03-05 14:41:39 +00:00
unsigned loadFromMemory(
unsigned _offset,
Type const& _type = IntegerType(256),
bool _fromCalldata = false,
bool _padToWordBoundaries = false
);
2015-02-15 00:02:38 +00:00
/// Dynamic version of @see loadFromMemory, expects the memory offset on the stack.
/// Stack pre: memory_offset
/// Stack post: value... (memory_offset+length)
2015-03-05 14:41:39 +00:00
void loadFromMemoryDynamic(
Type const& _type,
bool _fromCalldata = false,
bool _padToWordBoundaries = true,
bool _keepUpdatedMemoryOffset = true
);
2014-12-10 16:15:17 +00:00
/// Stores data from stack in memory.
/// @param _offset offset in memory
2015-02-10 16:53:43 +00:00
/// @param _type type of the data on the stack
2015-01-08 23:58:32 +00:00
/// @param _padToWordBoundaries if true, pad the data to word (32 byte) boundaries
/// @returns the number of bytes written to memory (can be different from _bytes if
/// _padToWordBoundaries is true)
2015-03-05 14:41:39 +00:00
unsigned storeInMemory(unsigned _offset,
Type const& _type = IntegerType(256),
bool _padToWordBoundaries = false
);
2015-02-10 16:53:43 +00:00
/// Dynamic version of @see storeInMemory, expects the memory offset below the value on the stack
/// and also updates that. For arrays, only copies the data part.
2015-02-12 10:40:14 +00:00
/// Stack pre: memory_offset value...
/// Stack post: (memory_offset+length)
2015-02-10 16:53:43 +00:00
void storeInMemoryDynamic(Type const& _type, bool _padToWordBoundaries = true);
2014-12-10 16:15:17 +00:00
/// Moves the value that is at the top of the stack to a stack variable.
void moveToStackVariable(VariableDeclaration const& _variable);
2015-03-03 16:55:28 +00:00
/// Copies an item that occupies @a _itemSize stack slots from a stack depth of @a _stackDepth
/// to the top of the stack.
void copyToStackTop(unsigned _stackDepth, unsigned _itemSize);
2015-04-21 08:59:48 +00:00
/// Moves a single stack element (with _stackDepth items on top of it) to the top of the stack.
void moveToStackTop(unsigned _stackDepth);
/// Removes the current value from the top of the stack.
void popStackElement(Type const& _type);
/// Removes element from the top of the stack _amount times.
void popStackSlots(size_t _amount);
template <class T>
static unsigned getSizeOnStack(std::vector<T> const& _variables);
static unsigned getSizeOnStack(std::vector<std::shared_ptr<Type const>> const& _variableTypes);
2015-02-11 13:24:34 +00:00
/// Appends code that computes tha SHA3 hash of the topmost stack element of type @a _type.
/// If @a _pad is set, padds the type to muliples of 32 bytes.
/// @note Only works for types of fixed size.
void computeHashStatic(Type const& _type = IntegerType(256), bool _padToWordBoundaries = false);
/// Bytes we need to the start of call data.
/// - The size in bytes of the function (hash) identifier.
2015-06-05 15:32:13 +00:00
static const unsigned dataStartOffset;
/// Position of the free-memory-pointer in memory;
static const size_t freeMemoryPointer;
2015-02-10 16:53:43 +00:00
private:
2015-02-12 10:40:14 +00:00
/// Prepares the given type for storing in memory by shifting it if necessary.
2015-02-11 13:32:46 +00:00
unsigned prepareMemoryStore(Type const& _type, bool _padToWordBoundaries) const;
2015-02-15 00:02:38 +00:00
/// Loads type from memory assuming memory offset is on stack top.
unsigned loadFromMemoryHelper(Type const& _type, bool _fromCalldata, bool _padToWordBoundaries);
2015-02-10 16:53:43 +00:00
CompilerContext& m_context;
};
template <class T>
unsigned CompilerUtils::getSizeOnStack(std::vector<T> const& _variables)
{
unsigned size = 0;
for (T const& variable: _variables)
size += variable->getType()->getSizeOnStack();
return size;
}
}
}