solidity/libsolidity/ast/Types.cpp

3873 lines
109 KiB
C++
Raw Normal View History

2014-10-13 16:22:15 +00:00
/*
2019-02-13 15:56:46 +00:00
This file is part of solidity.
2014-10-13 16:22:15 +00:00
2019-02-13 15:56:46 +00:00
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.
2014-10-13 16:22:15 +00:00
2019-02-13 15:56:46 +00:00
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.
2014-10-13 16:22:15 +00:00
2019-02-13 15:56:46 +00:00
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
2014-10-13 16:22:15 +00:00
*/
/**
* @author Christian <c@ethdev.com>
* @date 2014
* Solidity data types
*/
2015-10-20 22:21:52 +00:00
#include <libsolidity/ast/Types.h>
#include <libsolidity/ast/AST.h>
#include <libsolidity/ast/TypeProvider.h>
#include <libsolutil/Algorithms.h>
#include <libsolutil/CommonData.h>
#include <libsolutil/CommonIO.h>
#include <libsolutil/Keccak256.h>
#include <libsolutil/UTF8.h>
2018-12-17 14:33:15 +00:00
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/classification.hpp>
#include <boost/algorithm/string/join.hpp>
#include <boost/algorithm/string/predicate.hpp>
2018-12-17 14:33:15 +00:00
#include <boost/algorithm/string/replace.hpp>
#include <boost/algorithm/string/split.hpp>
#include <boost/range/adaptor/reversed.hpp>
#include <boost/range/adaptor/sliced.hpp>
#include <boost/range/adaptor/transformed.hpp>
2018-12-17 14:33:15 +00:00
#include <boost/range/algorithm/copy.hpp>
#include <limits>
2020-04-01 03:04:29 +00:00
#include <utility>
2014-10-13 16:22:15 +00:00
using namespace std;
2019-12-11 16:31:36 +00:00
using namespace solidity;
using namespace solidity::langutil;
using namespace solidity::frontend;
2014-10-13 16:22:15 +00:00
2018-03-26 17:48:20 +00:00
namespace
{
/// Check whether (_base ** _exp) fits into 4096 bits.
bool fitsPrecisionExp(bigint const& _base, bigint const& _exp)
{
if (_base == 0)
return true;
solAssert(_base > 0, "");
size_t const bitsMax = 4096;
unsigned mostSignificantBaseBit = boost::multiprecision::msb(_base);
2018-03-26 17:48:20 +00:00
if (mostSignificantBaseBit == 0) // _base == 1
return true;
if (mostSignificantBaseBit > bitsMax) // _base >= 2 ^ 4096
return false;
bigint bitsNeeded = _exp * (mostSignificantBaseBit + 1);
return bitsNeeded <= bitsMax;
}
/// Checks whether _mantissa * (X ** _exp) fits into 4096 bits,
/// where X is given indirectly via _log2OfBase = log2(X).
bool fitsPrecisionBaseX(
bigint const& _mantissa,
double _log2OfBase,
uint32_t _exp
)
{
if (_mantissa == 0)
return true;
solAssert(_mantissa > 0, "");
size_t const bitsMax = 4096;
unsigned mostSignificantMantissaBit = boost::multiprecision::msb(_mantissa);
2018-03-26 17:48:20 +00:00
if (mostSignificantMantissaBit > bitsMax) // _mantissa >= 2 ^ 4096
return false;
bigint bitsNeeded = mostSignificantMantissaBit + bigint(floor(double(_exp) * _log2OfBase)) + 1;
return bitsNeeded <= bitsMax;
}
/// Checks whether _mantissa * (10 ** _expBase10) fits into 4096 bits.
bool fitsPrecisionBase10(bigint const& _mantissa, uint32_t _expBase10)
{
double const log2Of10AwayFromZero = 3.3219280948873624;
return fitsPrecisionBaseX(_mantissa, log2Of10AwayFromZero, _expBase10);
}
/// Checks whether _mantissa * (2 ** _expBase10) fits into 4096 bits.
bool fitsPrecisionBase2(bigint const& _mantissa, uint32_t _expBase2)
{
return fitsPrecisionBaseX(_mantissa, 1.0, _expBase2);
}
/// Checks whether _value fits into IntegerType _type.
BoolResult fitsIntegerType(bigint const& _value, IntegerType const& _type)
{
if (_value < 0 && !_type.isSigned())
return BoolResult::err("Cannot implicitly convert signed literal to unsigned type.");
if (_type.minValue() > _value || _value > _type.maxValue())
return BoolResult::err("Literal is too large to fit in " + _type.toString(false) + ".");
return true;
}
/// Checks whether _value fits into _bits bits when having 1 bit as the sign bit
/// if _signed is true.
bool fitsIntoBits(bigint const& _value, unsigned _bits, bool _signed)
{
return fitsIntegerType(_value, *TypeProvider::integer(
_bits,
_signed ? IntegerType::Modifier::Signed : IntegerType::Modifier::Unsigned
));
}
2019-12-11 16:31:36 +00:00
util::Result<TypePointers> transformParametersToExternal(TypePointers const& _parameters, bool _inLibrary)
{
TypePointers transformed;
for (auto const& type: _parameters)
{
if (TypePointer ext = type->interfaceType(_inLibrary).get())
transformed.push_back(ext);
else
2019-12-11 16:31:36 +00:00
return util::Result<TypePointers>::err("Parameter should have external type.");
}
return transformed;
}
2018-03-26 17:48:20 +00:00
}
void Type::clearCache() const
{
m_members.clear();
m_stackItems.reset();
2020-02-04 16:08:55 +00:00
m_stackSize.reset();
}
2015-03-13 18:48:24 +00:00
void StorageOffsets::computeOffsets(TypePointers const& _types)
2015-03-13 09:52:34 +00:00
{
2015-03-13 18:48:24 +00:00
bigint slotOffset = 0;
unsigned byteOffset = 0;
map<size_t, pair<u256, unsigned>> offsets;
for (size_t i = 0; i < _types.size(); ++i)
2015-03-13 09:52:34 +00:00
{
Type const* type = _types[i];
2015-03-13 18:48:24 +00:00
if (!type->canBeStored())
continue;
2015-08-31 16:44:29 +00:00
if (byteOffset + type->storageBytes() > 32)
2015-03-13 09:52:34 +00:00
{
2015-03-13 18:48:24 +00:00
// would overflow, go to next slot
2015-03-13 09:52:34 +00:00
++slotOffset;
2015-03-13 18:48:24 +00:00
byteOffset = 0;
}
2015-03-13 09:52:34 +00:00
if (slotOffset >= bigint(1) << 256)
2019-12-11 16:31:36 +00:00
BOOST_THROW_EXCEPTION(Error(Error::Type::TypeError) << util::errinfo_comment("Object too large for storage."));
2015-03-13 18:48:24 +00:00
offsets[i] = make_pair(u256(slotOffset), byteOffset);
2015-08-31 16:44:29 +00:00
solAssert(type->storageSize() >= 1, "Invalid storage size.");
if (type->storageSize() == 1 && byteOffset + type->storageBytes() <= 32)
byteOffset += type->storageBytes();
2015-03-13 18:48:24 +00:00
else
{
2015-08-31 16:44:29 +00:00
slotOffset += type->storageSize();
2015-03-13 18:48:24 +00:00
byteOffset = 0;
}
2015-03-13 09:52:34 +00:00
}
2015-03-13 18:48:24 +00:00
if (byteOffset > 0)
++slotOffset;
if (slotOffset >= bigint(1) << 256)
2019-12-11 16:31:36 +00:00
BOOST_THROW_EXCEPTION(Error(Error::Type::TypeError) << util::errinfo_comment("Object too large for storage."));
2015-03-13 18:48:24 +00:00
m_storageSize = u256(slotOffset);
swap(m_offsets, offsets);
}
2015-08-31 16:44:29 +00:00
pair<u256, unsigned> const* StorageOffsets::offset(size_t _index) const
2015-03-13 18:48:24 +00:00
{
if (m_offsets.count(_index))
return &m_offsets.at(_index);
2015-03-13 09:52:34 +00:00
else
return nullptr;
}
2015-11-25 13:23:35 +00:00
void MemberList::combine(MemberList const & _other)
{
m_memberTypes += _other.m_memberTypes;
}
2016-02-18 12:29:02 +00:00
pair<u256, unsigned> const* MemberList::memberStorageOffset(string const& _name) const
2015-03-13 18:48:24 +00:00
{
StorageOffsets const& offsets = storageOffsets();
2015-03-13 18:48:24 +00:00
for (size_t index = 0; index < m_memberTypes.size(); ++index)
if (m_memberTypes[index].name == _name)
return offsets.offset(index);
2015-03-13 18:48:24 +00:00
return nullptr;
}
2015-08-31 16:44:29 +00:00
u256 const& MemberList::storageSize() const
2015-03-13 09:52:34 +00:00
{
return storageOffsets().storageSize();
}
StorageOffsets const& MemberList::storageOffsets() const {
return m_storageOffsets.init([&]{
TypePointers memberTypes;
memberTypes.reserve(m_memberTypes.size());
for (auto const& member: m_memberTypes)
memberTypes.push_back(member.type);
StorageOffsets storageOffsets;
storageOffsets.computeOffsets(memberTypes);
return storageOffsets;
});
2015-03-13 09:52:34 +00:00
}
/// Helper functions for type identifier
namespace
{
string parenthesizeIdentifier(string const& _internal)
{
return "(" + _internal + ")";
}
template <class Range>
string identifierList(Range const&& _list)
{
return parenthesizeIdentifier(boost::algorithm::join(_list, ","));
}
string richIdentifier(Type const* _type)
{
return _type ? _type->richIdentifier() : "";
}
string identifierList(vector<TypePointer> const& _list)
{
return identifierList(_list | boost::adaptors::transformed(richIdentifier));
}
string identifierList(Type const* _type)
{
return parenthesizeIdentifier(richIdentifier(_type));
}
string identifierList(Type const* _type1, Type const* _type2)
{
TypePointers list;
list.push_back(_type1);
list.push_back(_type2);
return identifierList(list);
}
string parenthesizeUserIdentifier(string const& _internal)
{
return parenthesizeIdentifier(_internal);
}
}
2018-02-23 17:27:27 +00:00
string Type::escapeIdentifier(string const& _identifier)
{
string ret = _identifier;
// FIXME: should be _$$$_
boost::algorithm::replace_all(ret, "$", "$$$");
2018-02-23 17:27:27 +00:00
boost::algorithm::replace_all(ret, ",", "_$_");
boost::algorithm::replace_all(ret, "(", "$_");
boost::algorithm::replace_all(ret, ")", "_$");
return ret;
}
string Type::identifier() const
{
string ret = escapeIdentifier(richIdentifier());
solAssert(ret.find_first_of("0123456789") != 0, "Identifier cannot start with a number.");
solAssert(
ret.find_first_not_of("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMONPQRSTUVWXYZ_$") == string::npos,
"Identifier contains invalid characters."
);
return ret;
}
TypePointer Type::commonType(Type const* _a, Type const* _b)
{
2016-10-21 10:30:58 +00:00
if (!_a || !_b)
return nullptr;
else if (_a->mobileType() && _b->isImplicitlyConvertibleTo(*_a->mobileType()))
return _a->mobileType();
else if (_b->mobileType() && _a->isImplicitlyConvertibleTo(*_b->mobileType()))
return _b->mobileType();
else
return nullptr;
}
2015-11-25 13:23:35 +00:00
MemberList const& Type::members(ContractDefinition const* _currentScope) const
{
if (!m_members[_currentScope])
{
MemberList::MemberMap members = nativeMembers(_currentScope);
if (_currentScope)
members += boundFunctions(*this, *_currentScope);
2019-11-27 16:24:21 +00:00
m_members[_currentScope] = make_unique<MemberList>(move(members));
2015-11-25 13:23:35 +00:00
}
return *m_members[_currentScope];
}
2019-01-24 12:52:06 +00:00
TypePointer Type::fullEncodingType(bool _inLibraryCall, bool _encoderV2, bool) const
{
TypePointer encodingType = mobileType();
if (encodingType)
encodingType = encodingType->interfaceType(_inLibraryCall);
if (encodingType)
encodingType = encodingType->encodingType();
// Structs are fine in the following circumstances:
2019-01-24 12:52:06 +00:00
// - ABIv2 or,
// - storage struct for a library
if (_inLibraryCall && encodingType && encodingType->dataStoredIn(DataLocation::Storage))
return encodingType;
TypePointer baseType = encodingType;
while (auto const* arrayType = dynamic_cast<ArrayType const*>(baseType))
baseType = arrayType->baseType();
if (dynamic_cast<StructType const*>(baseType))
2019-01-24 12:52:06 +00:00
if (!_encoderV2)
return nullptr;
return encodingType;
}
2015-11-25 13:23:35 +00:00
MemberList::MemberMap Type::boundFunctions(Type const& _type, ContractDefinition const& _scope)
{
// Normalise data location of type.
TypePointer type = TypeProvider::withLocationIfReference(DataLocation::Storage, &_type);
2015-11-25 13:23:35 +00:00
set<Declaration const*> seenFunctions;
MemberList::MemberMap members;
for (ContractDefinition const* contract: _scope.annotation().linearizedBaseContracts)
for (UsingForDirective const* ufd: contract->usingForDirectives())
{
if (ufd->typeName() && *type != *TypeProvider::withLocationIfReference(
2015-11-25 13:23:35 +00:00
DataLocation::Storage,
ufd->typeName()->annotation().type
))
continue;
auto const& library = dynamic_cast<ContractDefinition const&>(
*ufd->libraryName().annotation().referencedDeclaration
);
for (FunctionDefinition const* function: library.definedFunctions())
2015-11-25 13:23:35 +00:00
{
if (!function->isVisibleAsLibraryMember() || seenFunctions.count(function))
2015-11-25 13:23:35 +00:00
continue;
seenFunctions.insert(function);
if (function->parameters().empty())
continue;
FunctionTypePointer fun = FunctionType(*function, FunctionType::Kind::External).asCallableFunction(true, true);
if (_type.isImplicitlyConvertibleTo(*fun->selfType()))
members.emplace_back(function->name(), fun, function);
2015-11-25 13:23:35 +00:00
}
}
return members;
}
2014-11-20 09:19:43 +00:00
AddressType::AddressType(StateMutability _stateMutability):
m_stateMutability(_stateMutability)
{
solAssert(m_stateMutability == StateMutability::Payable || m_stateMutability == StateMutability::NonPayable, "");
}
string AddressType::richIdentifier() const
{
if (m_stateMutability == StateMutability::Payable)
return "t_address_payable";
else
return "t_address";
}
BoolResult AddressType::isImplicitlyConvertibleTo(Type const& _other) const
{
if (_other.category() != category())
return false;
AddressType const& other = dynamic_cast<AddressType const&>(_other);
return other.m_stateMutability <= m_stateMutability;
}
BoolResult AddressType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
if (_convertTo.category() == category())
return true;
else if (auto const* contractType = dynamic_cast<ContractType const*>(&_convertTo))
return (m_stateMutability >= StateMutability::Payable) || !contractType->isPayable();
return isImplicitlyConvertibleTo(_convertTo) ||
2019-02-13 15:56:46 +00:00
_convertTo.category() == Category::Integer ||
(_convertTo.category() == Category::FixedBytes && 160 == dynamic_cast<FixedBytesType const&>(_convertTo).numBytes() * 8);
}
string AddressType::toString(bool) const
{
if (m_stateMutability == StateMutability::Payable)
return "address payable";
else
return "address";
}
string AddressType::canonicalName() const
{
return "address";
}
u256 AddressType::literalValue(Literal const* _literal) const
{
solAssert(_literal, "");
solAssert(_literal->value().substr(0, 2) == "0x", "");
return u256(_literal->valueWithoutUnderscores());
}
TypeResult AddressType::unaryOperatorResult(Token _operator) const
{
return _operator == Token::Delete ? TypeProvider::emptyTuple() : nullptr;
}
TypeResult AddressType::binaryOperatorResult(Token _operator, Type const* _other) const
{
if (!TokenTraits::isCompareOp(_operator))
return TypeResult::err("Arithmetic operations on addresses are not supported. Convert to integer first before using them.");
return Type::commonType(this, _other);
}
bool AddressType::operator==(Type const& _other) const
{
if (_other.category() != category())
return false;
AddressType const& other = dynamic_cast<AddressType const&>(_other);
return other.m_stateMutability == m_stateMutability;
}
MemberList::MemberMap AddressType::nativeMembers(ContractDefinition const*) const
{
MemberList::MemberMap members = {
{"balance", TypeProvider::uint256()},
{"call", TypeProvider::function(strings{"bytes memory"}, strings{"bool", "bytes memory"}, FunctionType::Kind::BareCall, false, StateMutability::Payable)},
{"callcode", TypeProvider::function(strings{"bytes memory"}, strings{"bool", "bytes memory"}, FunctionType::Kind::BareCallCode, false, StateMutability::Payable)},
{"delegatecall", TypeProvider::function(strings{"bytes memory"}, strings{"bool", "bytes memory"}, FunctionType::Kind::BareDelegateCall, false, StateMutability::NonPayable)},
{"staticcall", TypeProvider::function(strings{"bytes memory"}, strings{"bool", "bytes memory"}, FunctionType::Kind::BareStaticCall, false, StateMutability::View)}
};
if (m_stateMutability == StateMutability::Payable)
{
members.emplace_back(MemberList::Member{"send", TypeProvider::function(strings{"uint"}, strings{"bool"}, FunctionType::Kind::Send, false, StateMutability::NonPayable)});
members.emplace_back(MemberList::Member{"transfer", TypeProvider::function(strings{"uint"}, strings(), FunctionType::Kind::Transfer, false, StateMutability::NonPayable)});
}
return members;
}
namespace
{
bool isValidShiftAndAmountType(Token _operator, Type const& _shiftAmountType)
{
// Disable >>> here.
if (_operator == Token::SHR)
return false;
else if (IntegerType const* otherInt = dynamic_cast<decltype(otherInt)>(&_shiftAmountType))
return true;
else if (RationalNumberType const* otherRat = dynamic_cast<decltype(otherRat)>(&_shiftAmountType))
return !otherRat->isFractional() && otherRat->integerType() && !otherRat->integerType()->isSigned();
else
return false;
}
}
2018-04-30 21:56:30 +00:00
IntegerType::IntegerType(unsigned _bits, IntegerType::Modifier _modifier):
2014-10-22 22:24:07 +00:00
m_bits(_bits), m_modifier(_modifier)
2014-10-13 16:22:15 +00:00
{
2016-02-18 12:29:02 +00:00
solAssert(
m_bits > 0 && m_bits <= 256 && m_bits % 8 == 0,
2019-12-11 16:31:36 +00:00
"Invalid bit number for integer type: " + util::toString(m_bits)
);
2017-01-17 09:47:44 +00:00
}
string IntegerType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_" + string(isSigned() ? "" : "u") + "int" + to_string(numBits());
2014-10-13 16:22:15 +00:00
}
BoolResult IntegerType::isImplicitlyConvertibleTo(Type const& _convertTo) const
2014-10-13 16:22:15 +00:00
{
if (_convertTo.category() == category())
2016-05-10 10:42:38 +00:00
{
IntegerType const& convertTo = dynamic_cast<IntegerType const&>(_convertTo);
if (convertTo.m_bits < m_bits)
return false;
else if (isSigned())
return convertTo.isSigned();
else
return !convertTo.isSigned() || convertTo.m_bits > m_bits;
}
else if (_convertTo.category() == Category::FixedPoint)
{
FixedPointType const& convertTo = dynamic_cast<FixedPointType const&>(_convertTo);
return maxValue() <= convertTo.maxIntegerValue() && minValue() >= convertTo.minIntegerValue();
}
2014-10-13 16:22:15 +00:00
else
return false;
2014-10-13 16:22:15 +00:00
}
BoolResult IntegerType::isExplicitlyConvertibleTo(Type const& _convertTo) const
2014-10-13 16:22:15 +00:00
{
2015-08-31 16:44:29 +00:00
return _convertTo.category() == category() ||
_convertTo.category() == Category::Address ||
2015-08-31 16:44:29 +00:00
_convertTo.category() == Category::Contract ||
_convertTo.category() == Category::Enum ||
(_convertTo.category() == Category::FixedBytes && numBits() == dynamic_cast<FixedBytesType const&>(_convertTo).numBytes() * 8) ||
_convertTo.category() == Category::FixedPoint;
2014-10-13 16:22:15 +00:00
}
TypeResult IntegerType::unaryOperatorResult(Token _operator) const
2014-10-13 16:22:15 +00:00
{
// "delete" is ok for all integer types
if (_operator == Token::Delete)
return TypeResult{TypeProvider::emptyTuple()};
// we allow -, ++ and --
else if (_operator == Token::Sub || _operator == Token::Inc ||
_operator == Token::Dec || _operator == Token::BitNot)
return TypeResult{this};
else
return TypeResult::err("");
2014-10-20 10:41:56 +00:00
}
2014-10-29 18:28:30 +00:00
bool IntegerType::operator==(Type const& _other) const
2014-10-20 10:41:56 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-10-20 10:41:56 +00:00
return false;
IntegerType const& other = dynamic_cast<IntegerType const&>(_other);
return other.m_bits == m_bits && other.m_modifier == m_modifier;
2014-10-13 16:22:15 +00:00
}
string IntegerType::toString(bool) const
2014-10-16 15:57:27 +00:00
{
string prefix = isSigned() ? "int" : "uint";
2019-12-11 16:31:36 +00:00
return prefix + util::toString(m_bits);
2014-10-16 15:57:27 +00:00
}
u256 IntegerType::min() const
{
if (isSigned())
return s2u(s256(minValue()));
else
return u256(minValue());
}
u256 IntegerType::max() const
{
if (isSigned())
return s2u(s256(maxValue()));
else
return u256(maxValue());
}
2017-07-06 09:05:05 +00:00
bigint IntegerType::minValue() const
{
if (isSigned())
return -(bigint(1) << (m_bits - 1));
else
return bigint(0);
}
bigint IntegerType::maxValue() const
{
if (isSigned())
return (bigint(1) << (m_bits - 1)) - 1;
else
return (bigint(1) << m_bits) - 1;
}
TypeResult IntegerType::binaryOperatorResult(Token _operator, Type const* _other) const
{
2016-05-13 03:10:49 +00:00
if (
_other->category() != Category::RationalNumber &&
_other->category() != Category::FixedPoint &&
_other->category() != category()
)
return nullptr;
if (TokenTraits::isShiftOp(_operator))
{
// Shifts are not symmetric with respect to the type
if (isValidShiftAndAmountType(_operator, *_other))
return this;
else
return nullptr;
}
else if (Token::Exp == _operator)
{
if (auto otherIntType = dynamic_cast<IntegerType const*>(_other))
{
if (otherIntType->isSigned())
return TypeResult::err("Exponentiation power is not allowed to be a signed integer type.");
}
else if (dynamic_cast<FixedPointType const*>(_other))
return nullptr;
2020-05-12 07:06:21 +00:00
else if (auto rationalNumberType = dynamic_cast<RationalNumberType const*>(_other))
{
if (rationalNumberType->isFractional())
return TypeResult::err("Exponent is fractional.");
if (!rationalNumberType->integerType())
return TypeResult::err("Exponent too large.");
}
return this;
}
auto commonType = Type::commonType(this, _other); //might be an integer or fixed point
if (!commonType)
return nullptr;
// All integer types can be compared
if (TokenTraits::isCompareOp(_operator))
return commonType;
if (TokenTraits::isBooleanOp(_operator))
return nullptr;
return commonType;
}
FixedPointType::FixedPointType(unsigned _totalBits, unsigned _fractionalDigits, FixedPointType::Modifier _modifier):
m_totalBits(_totalBits), m_fractionalDigits(_fractionalDigits), m_modifier(_modifier)
{
solAssert(
8 <= m_totalBits && m_totalBits <= 256 && m_totalBits % 8 == 0 && m_fractionalDigits <= 80,
"Invalid bit number(s) for fixed type: " +
2019-12-11 16:31:36 +00:00
util::toString(_totalBits) + "x" + util::toString(_fractionalDigits)
);
2017-01-17 09:47:44 +00:00
}
string FixedPointType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_" + string(isSigned() ? "" : "u") + "fixed" + to_string(m_totalBits) + "x" + to_string(m_fractionalDigits);
}
BoolResult FixedPointType::isImplicitlyConvertibleTo(Type const& _convertTo) const
{
if (_convertTo.category() == category())
{
FixedPointType const& convertTo = dynamic_cast<FixedPointType const&>(_convertTo);
if (convertTo.fractionalDigits() < m_fractionalDigits)
return BoolResult::err("Too many fractional digits.");
if (convertTo.numBits() < m_totalBits)
return false;
else
2017-07-12 13:44:27 +00:00
return convertTo.maxIntegerValue() >= maxIntegerValue() && convertTo.minIntegerValue() <= minIntegerValue();
}
return false;
}
BoolResult FixedPointType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
return _convertTo.category() == category() || _convertTo.category() == Category::Integer;
}
TypeResult FixedPointType::unaryOperatorResult(Token _operator) const
{
2019-11-11 16:09:59 +00:00
switch (_operator)
2017-08-09 22:16:58 +00:00
{
case Token::Delete:
// "delete" is ok for all fixed types
return TypeResult{TypeProvider::emptyTuple()};
2017-08-09 22:16:58 +00:00
case Token::Add:
case Token::Sub:
case Token::Inc:
case Token::Dec:
// for fixed, we allow +, -, ++ and --
return this;
2017-08-09 22:16:58 +00:00
default:
return nullptr;
2017-08-09 22:16:58 +00:00
}
}
bool FixedPointType::operator==(Type const& _other) const
{
if (_other.category() != category())
return false;
FixedPointType const& other = dynamic_cast<FixedPointType const&>(_other);
return other.m_totalBits == m_totalBits && other.m_fractionalDigits == m_fractionalDigits && other.m_modifier == m_modifier;
}
string FixedPointType::toString(bool) const
{
string prefix = isSigned() ? "fixed" : "ufixed";
2019-12-11 16:31:36 +00:00
return prefix + util::toString(m_totalBits) + "x" + util::toString(m_fractionalDigits);
}
2017-07-12 13:44:27 +00:00
bigint FixedPointType::maxIntegerValue() const
{
bigint maxValue = (bigint(1) << (m_totalBits - (isSigned() ? 1 : 0))) - 1;
return maxValue / boost::multiprecision::pow(bigint(10), m_fractionalDigits);
2017-07-12 13:44:27 +00:00
}
bigint FixedPointType::minIntegerValue() const
{
if (isSigned())
{
bigint minValue = -(bigint(1) << (m_totalBits - (isSigned() ? 1 : 0)));
return minValue / boost::multiprecision::pow(bigint(10), m_fractionalDigits);
2017-07-12 13:44:27 +00:00
}
else
return bigint(0);
}
TypeResult FixedPointType::binaryOperatorResult(Token _operator, Type const* _other) const
{
auto commonType = Type::commonType(this, _other);
if (!commonType)
return nullptr;
// All fixed types can be compared
if (TokenTraits::isCompareOp(_operator))
return commonType;
if (TokenTraits::isBitOp(_operator) || TokenTraits::isBooleanOp(_operator) || _operator == Token::Exp)
return nullptr;
return commonType;
}
IntegerType const* FixedPointType::asIntegerType() const
2018-04-19 23:00:05 +00:00
{
return TypeProvider::integer(numBits(), isSigned() ? IntegerType::Modifier::Signed : IntegerType::Modifier::Unsigned);
2018-04-19 23:00:05 +00:00
}
tuple<bool, rational> RationalNumberType::parseRational(string const& _value)
{
rational value;
try
{
auto radixPoint = find(_value.begin(), _value.end(), '.');
if (radixPoint != _value.end())
{
if (
!all_of(radixPoint + 1, _value.end(), ::isdigit) ||
!all_of(_value.begin(), radixPoint, ::isdigit)
)
2016-10-20 09:33:17 +00:00
return make_tuple(false, rational(0));
// Only decimal notation allowed here, leading zeros would switch to octal.
2016-05-10 10:42:38 +00:00
auto fractionalBegin = find_if_not(
radixPoint + 1,
_value.end(),
[](char const& a) { return a == '0'; }
);
rational numerator;
rational denominator(1);
denominator = bigint(string(fractionalBegin, _value.end()));
denominator /= boost::multiprecision::pow(
bigint(10),
distance(radixPoint + 1, _value.end())
);
numerator = bigint(string(_value.begin(), radixPoint));
value = numerator + denominator;
}
else
value = bigint(_value);
return make_tuple(true, value);
}
catch (...)
{
return make_tuple(false, rational(0));
}
}
tuple<bool, rational> RationalNumberType::isValidLiteral(Literal const& _literal)
{
2017-03-15 12:50:34 +00:00
rational value;
try
{
ASTString valueString = _literal.valueWithoutUnderscores();
auto expPoint = find(valueString.begin(), valueString.end(), 'e');
if (expPoint == valueString.end())
expPoint = find(valueString.begin(), valueString.end(), 'E');
if (boost::starts_with(valueString, "0x"))
2017-03-15 11:16:44 +00:00
{
// process as hex
2017-10-25 08:12:07 +00:00
value = bigint(valueString);
2017-03-15 11:16:44 +00:00
}
else if (expPoint != valueString.end())
{
// Parse mantissa and exponent. Checks numeric limit.
tuple<bool, rational> mantissa = parseRational(string(valueString.begin(), expPoint));
if (!get<0>(mantissa))
return make_tuple(false, rational(0));
value = get<1>(mantissa);
// 0E... is always zero.
if (value == 0)
return make_tuple(true, rational(0));
2018-03-26 17:48:20 +00:00
bigint exp = bigint(string(expPoint + 1, valueString.end()));
2018-03-26 17:48:20 +00:00
if (exp > numeric_limits<int32_t>::max() || exp < numeric_limits<int32_t>::min())
return make_tuple(false, rational(0));
uint32_t expAbs = bigint(abs(exp)).convert_to<uint32_t>();
2017-03-15 12:50:34 +00:00
2017-02-14 16:36:22 +00:00
if (exp < 0)
2017-02-14 17:25:04 +00:00
{
2018-03-26 17:48:20 +00:00
if (!fitsPrecisionBase10(abs(value.denominator()), expAbs))
return make_tuple(false, rational(0));
2017-03-15 12:50:34 +00:00
value /= boost::multiprecision::pow(
2017-02-14 16:36:22 +00:00
bigint(10),
2018-03-26 17:48:20 +00:00
expAbs
2017-02-14 16:36:22 +00:00
);
2017-02-14 17:25:04 +00:00
}
2018-03-26 17:48:20 +00:00
else if (exp > 0)
{
if (!fitsPrecisionBase10(abs(value.numerator()), expAbs))
return make_tuple(false, rational(0));
2017-03-15 12:50:34 +00:00
value *= boost::multiprecision::pow(
2017-02-14 16:36:22 +00:00
bigint(10),
2018-03-26 17:48:20 +00:00
expAbs
2017-02-14 16:36:22 +00:00
);
2018-03-26 17:48:20 +00:00
}
}
else
{
// parse as rational number
tuple<bool, rational> tmp = parseRational(valueString);
if (!get<0>(tmp))
return tmp;
value = get<1>(tmp);
}
}
catch (...)
2015-02-06 12:38:10 +00:00
{
return make_tuple(false, rational(0));
2015-02-06 12:38:10 +00:00
}
switch (_literal.subDenomination())
{
case Literal::SubDenomination::None:
case Literal::SubDenomination::Wei:
case Literal::SubDenomination::Second:
break;
case Literal::SubDenomination::Szabo:
2017-03-15 12:50:34 +00:00
value *= bigint("1000000000000");
break;
case Literal::SubDenomination::Finney:
2017-03-15 12:50:34 +00:00
value *= bigint("1000000000000000");
break;
case Literal::SubDenomination::Ether:
2017-03-15 12:50:34 +00:00
value *= bigint("1000000000000000000");
break;
case Literal::SubDenomination::Minute:
2017-03-15 12:50:34 +00:00
value *= bigint("60");
break;
case Literal::SubDenomination::Hour:
2017-03-15 12:50:34 +00:00
value *= bigint("3600");
break;
case Literal::SubDenomination::Day:
2017-03-15 12:50:34 +00:00
value *= bigint("86400");
break;
case Literal::SubDenomination::Week:
2017-03-15 12:50:34 +00:00
value *= bigint("604800");
break;
case Literal::SubDenomination::Year:
2017-03-15 12:50:34 +00:00
value *= bigint("31536000");
break;
}
2017-03-15 12:50:34 +00:00
return make_tuple(true, value);
2014-12-19 10:31:17 +00:00
}
BoolResult RationalNumberType::isImplicitlyConvertibleTo(Type const& _convertTo) const
2014-12-19 10:31:17 +00:00
{
switch (_convertTo.category())
{
case Category::Integer:
{
2016-05-10 12:30:24 +00:00
if (isFractional())
return false;
IntegerType const& targetType = dynamic_cast<IntegerType const&>(_convertTo);
return fitsIntegerType(m_value.numerator(), targetType);
}
case Category::FixedPoint:
{
FixedPointType const& targetType = dynamic_cast<FixedPointType const&>(_convertTo);
// Store a negative number into an unsigned.
if (isNegative() && !targetType.isSigned())
return false;
if (!isFractional())
return (targetType.minIntegerValue() <= m_value) && (m_value <= targetType.maxIntegerValue());
rational value = m_value * pow(bigint(10), targetType.fractionalDigits());
// Need explicit conversion since truncation will occur.
if (value.denominator() != 1)
return false;
return fitsIntoBits(value.numerator(), targetType.numBits(), targetType.isSigned());
}
case Category::FixedBytes:
return (m_value == rational(0)) || (m_compatibleBytesType && *m_compatibleBytesType == _convertTo);
default:
return false;
2015-06-04 16:06:06 +00:00
}
2014-12-19 10:31:17 +00:00
}
BoolResult RationalNumberType::isExplicitlyConvertibleTo(Type const& _convertTo) const
2014-12-19 10:31:17 +00:00
{
if (isImplicitlyConvertibleTo(_convertTo))
return true;
else if (_convertTo.category() != Category::FixedBytes)
{
TypePointer mobType = mobileType();
return (mobType && mobType->isExplicitlyConvertibleTo(_convertTo));
}
else
return false;
2014-12-19 10:31:17 +00:00
}
TypeResult RationalNumberType::unaryOperatorResult(Token _operator) const
2014-12-19 10:31:17 +00:00
{
rational value;
2014-12-19 10:31:17 +00:00
switch (_operator)
{
case Token::BitNot:
2016-05-10 12:30:24 +00:00
if (isFractional())
return nullptr;
value = ~m_value.numerator();
2014-12-19 10:31:17 +00:00
break;
case Token::Add:
value = +(m_value);
2014-12-19 10:31:17 +00:00
break;
case Token::Sub:
value = -(m_value);
2014-12-19 10:31:17 +00:00
break;
2015-03-04 18:55:52 +00:00
case Token::After:
return this;
2014-12-19 10:31:17 +00:00
default:
return nullptr;
2014-12-19 10:31:17 +00:00
}
return TypeResult{TypeProvider::rationalNumber(value)};
2014-12-19 10:31:17 +00:00
}
TypeResult RationalNumberType::binaryOperatorResult(Token _operator, Type const* _other) const
2014-12-19 10:31:17 +00:00
{
2016-05-10 10:42:38 +00:00
if (_other->category() == Category::Integer || _other->category() == Category::FixedPoint)
{
auto commonType = Type::commonType(this, _other);
if (!commonType)
return nullptr;
return commonType->binaryOperatorResult(_operator, _other);
}
2015-08-31 16:44:29 +00:00
else if (_other->category() != category())
return nullptr;
2014-12-19 10:31:17 +00:00
RationalNumberType const& other = dynamic_cast<RationalNumberType const&>(*_other);
if (TokenTraits::isCompareOp(_operator))
2014-12-19 10:31:17 +00:00
{
// Since we do not have a "BoolConstantType", we have to do the actual comparison
2016-05-10 10:42:38 +00:00
// at runtime and convert to mobile typse first. Such a comparison is not a very common
// use-case and will be optimized away.
TypePointer thisMobile = mobileType();
TypePointer otherMobile = other.mobileType();
if (!thisMobile || !otherMobile)
return nullptr;
2016-05-10 10:42:38 +00:00
return thisMobile->binaryOperatorResult(_operator, otherMobile);
2014-12-19 10:31:17 +00:00
}
else
{
rational value;
2016-05-10 12:30:24 +00:00
bool fractional = isFractional() || other.isFractional();
2014-12-19 10:31:17 +00:00
switch (_operator)
{
//bit operations will only be enabled for integers and fixed types that resemble integers
case Token::BitOr:
if (fractional)
return nullptr;
value = m_value.numerator() | other.m_value.numerator();
2014-12-19 10:31:17 +00:00
break;
case Token::BitXor:
if (fractional)
return nullptr;
value = m_value.numerator() ^ other.m_value.numerator();
2014-12-19 10:31:17 +00:00
break;
case Token::BitAnd:
if (fractional)
return nullptr;
value = m_value.numerator() & other.m_value.numerator();
2014-12-19 10:31:17 +00:00
break;
case Token::Add:
value = m_value + other.m_value;
2014-12-19 10:31:17 +00:00
break;
case Token::Sub:
value = m_value - other.m_value;
2014-12-19 10:31:17 +00:00
break;
case Token::Mul:
2014-12-19 10:31:17 +00:00
value = m_value * other.m_value;
break;
case Token::Div:
if (other.m_value == rational(0))
return nullptr;
else
value = m_value / other.m_value;
2014-12-19 10:31:17 +00:00
break;
case Token::Mod:
if (other.m_value == rational(0))
return nullptr;
else if (fractional)
{
2016-04-11 21:35:17 +00:00
rational tempValue = m_value / other.m_value;
value = m_value - (tempValue.numerator() / tempValue.denominator()) * other.m_value;
}
else
value = m_value.numerator() % other.m_value.numerator();
break;
case Token::Exp:
{
2016-05-10 12:30:24 +00:00
if (other.isFractional())
return nullptr;
2018-03-26 17:48:20 +00:00
solAssert(other.m_value.denominator() == 1, "");
bigint const& exp = other.m_value.numerator();
// x ** 0 = 1
// for 0, 1 and -1 the size of the exponent doesn't have to be restricted
if (exp == 0)
value = 1;
else if (m_value.numerator() == 0 || m_value == 1)
value = m_value;
else if (m_value == -1)
{
bigint isOdd = abs(exp) & bigint(1);
value = 1 - 2 * isOdd.convert_to<int>();
}
else
2018-03-26 17:48:20 +00:00
{
if (abs(exp) > numeric_limits<uint32_t>::max())
return nullptr; // This will need too much memory to represent.
2018-03-26 17:48:20 +00:00
uint32_t absExp = bigint(abs(exp)).convert_to<uint32_t>();
if (!fitsPrecisionExp(abs(m_value.numerator()), absExp) || !fitsPrecisionExp(abs(m_value.denominator()), absExp))
return TypeResult::err("Precision of rational constants is limited to 4096 bits.");
2018-03-26 17:48:20 +00:00
static auto const optimizedPow = [](bigint const& _base, uint32_t _exponent) -> bigint {
if (_base == 1)
return 1;
else if (_base == -1)
return 1 - 2 * int(_exponent & 1);
else
return boost::multiprecision::pow(_base, _exponent);
2018-03-26 17:48:20 +00:00
};
bigint numerator = optimizedPow(m_value.numerator(), absExp);
bigint denominator = optimizedPow(m_value.denominator(), absExp);
if (exp >= 0)
value = makeRational(numerator, denominator);
2018-03-26 17:48:20 +00:00
else
// invert
value = makeRational(denominator, numerator);
2018-03-26 17:48:20 +00:00
}
break;
}
2016-05-17 15:04:10 +00:00
case Token::SHL:
{
if (fractional)
return nullptr;
else if (other.m_value < 0)
return nullptr;
else if (other.m_value > numeric_limits<uint32_t>::max())
return nullptr;
2018-03-26 17:48:20 +00:00
if (m_value.numerator() == 0)
value = 0;
else
{
uint32_t exponent = other.m_value.numerator().convert_to<uint32_t>();
if (!fitsPrecisionBase2(abs(m_value.numerator()), exponent))
return nullptr;
value = m_value.numerator() * boost::multiprecision::pow(bigint(2), exponent);
2018-03-26 17:48:20 +00:00
}
2016-05-17 15:04:10 +00:00
break;
}
2016-09-07 23:26:14 +00:00
// NOTE: we're using >> (SAR) to denote right shifting. The type of the LValue
// determines the resulting type and the type of shift (SAR or SHR).
case Token::SAR:
2016-05-17 15:04:10 +00:00
{
if (fractional)
return nullptr;
else if (other.m_value < 0)
return nullptr;
else if (other.m_value > numeric_limits<uint32_t>::max())
return nullptr;
2018-03-26 17:48:20 +00:00
if (m_value.numerator() == 0)
value = 0;
else
{
uint32_t exponent = other.m_value.numerator().convert_to<uint32_t>();
if (exponent > boost::multiprecision::msb(boost::multiprecision::abs(m_value.numerator())))
value = m_value.numerator() < 0 ? -1 : 0;
2018-03-26 17:48:20 +00:00
else
{
if (m_value.numerator() < 0)
2018-06-12 13:53:15 +00:00
// Add 1 to the negative value before dividing to get a result that is strictly too large,
// then subtract 1 afterwards to round towards negative infinity.
// This is the same algorithm as used in ExpressionCompiler::appendShiftOperatorCode(...).
// To see this note that for negative x, xor(x,all_ones) = (-x-1) and
// therefore xor(div(xor(x,all_ones), exp(2, shift_amount)), all_ones) is
// -(-x - 1) / 2^shift_amount - 1, which is the same as
// (x + 1) / 2^shift_amount - 1.
value = rational((m_value.numerator() + 1) / boost::multiprecision::pow(bigint(2), exponent) - bigint(1), 1);
else
value = rational(m_value.numerator() / boost::multiprecision::pow(bigint(2), exponent), 1);
}
2018-03-26 17:48:20 +00:00
}
2016-05-17 15:04:10 +00:00
break;
}
2014-12-19 10:31:17 +00:00
default:
return nullptr;
2014-12-19 10:31:17 +00:00
}
2018-03-26 17:48:20 +00:00
// verify that numerator and denominator fit into 4096 bit after every operation
if (value.numerator() != 0 && max(boost::multiprecision::msb(abs(value.numerator())), boost::multiprecision::msb(abs(value.denominator()))) > 4096)
return TypeResult::err("Precision of rational constants is limited to 4096 bits.");
2018-03-26 17:48:20 +00:00
return TypeResult{TypeProvider::rationalNumber(value)};
2014-12-19 10:31:17 +00:00
}
}
string RationalNumberType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
// rational seemingly will put the sign always on the numerator,
// but let just make it deterministic here.
bigint numerator = abs(m_value.numerator());
bigint denominator = abs(m_value.denominator());
if (m_value < 0)
return "t_rational_minus_" + numerator.str() + "_by_" + denominator.str();
else
return "t_rational_" + numerator.str() + "_by_" + denominator.str();
2017-01-17 09:47:44 +00:00
}
bool RationalNumberType::operator==(Type const& _other) const
2014-12-19 10:31:17 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-12-19 10:31:17 +00:00
return false;
RationalNumberType const& other = dynamic_cast<RationalNumberType const&>(_other);
return m_value == other.m_value;
2014-12-19 10:31:17 +00:00
}
2019-12-11 16:31:36 +00:00
string RationalNumberType::bigintToReadableString(bigint const& _num)
{
string str = _num.str();
if (str.size() > 32)
{
int omitted = str.size() - 8;
str = str.substr(0, 4) + "...(" + to_string(omitted) + " digits omitted)..." + str.substr(str.size() - 4, 4);
}
return str;
}
string RationalNumberType::toString(bool) const
2014-12-19 10:31:17 +00:00
{
2016-05-10 12:30:24 +00:00
if (!isFractional())
return "int_const " + bigintToReadableString(m_value.numerator());
string numerator = bigintToReadableString(m_value.numerator());
string denominator = bigintToReadableString(m_value.denominator());
return "rational_const " + numerator + " / " + denominator;
2014-12-19 10:31:17 +00:00
}
u256 RationalNumberType::literalValue(Literal const*) const
2014-12-19 10:31:17 +00:00
{
2016-05-10 11:31:10 +00:00
// We ignore the literal and hope that the type was correctly determined to represent
// its value.
u256 value;
bigint shiftedValue;
2016-05-10 12:30:24 +00:00
if (!isFractional())
2016-05-10 11:31:10 +00:00
shiftedValue = m_value.numerator();
else
{
auto fixed = fixedPointType();
solAssert(fixed, "Rational number cannot be represented as fixed point type.");
2017-07-12 13:44:27 +00:00
int fractionalDigits = fixed->fractionalDigits();
shiftedValue = m_value.numerator() * boost::multiprecision::pow(bigint(10), fractionalDigits) / m_value.denominator();
}
2016-05-10 11:31:10 +00:00
2014-12-19 10:31:17 +00:00
// we ignore the literal and hope that the type was correctly determined
solAssert(shiftedValue <= u256(-1), "Number constant too large.");
solAssert(shiftedValue >= -(bigint(1) << 255), "Number constant too small.");
if (m_value >= rational(0))
value = u256(shiftedValue);
2014-12-19 10:31:17 +00:00
else
value = s2u(s256(shiftedValue));
return value;
2014-12-19 10:31:17 +00:00
}
TypePointer RationalNumberType::mobileType() const
2015-02-06 12:42:51 +00:00
{
2016-05-10 12:30:24 +00:00
if (!isFractional())
return integerType();
else
return fixedPointType();
2015-02-06 12:42:51 +00:00
}
IntegerType const* RationalNumberType::integerType() const
2014-12-19 10:31:17 +00:00
{
2016-05-10 12:30:24 +00:00
solAssert(!isFractional(), "integerType() called for fractional number.");
bigint value = m_value.numerator();
2014-12-19 10:31:17 +00:00
bool negative = (value < 0);
if (negative) // convert to positive number of same bit requirements
value = ((0 - value) - 1) << 1;
2014-12-19 10:31:17 +00:00
if (value > u256(-1))
return nullptr;
2014-12-19 10:31:17 +00:00
else
return TypeProvider::integer(
2019-12-11 16:31:36 +00:00
max(util::bytesRequired(value), 1u) * 8,
negative ? IntegerType::Modifier::Signed : IntegerType::Modifier::Unsigned
);
2014-12-19 10:31:17 +00:00
}
FixedPointType const* RationalNumberType::fixedPointType() const
{
bool negative = (m_value < 0);
unsigned fractionalDigits = 0;
2016-05-10 11:31:10 +00:00
rational value = abs(m_value); // We care about the sign later.
rational maxValue = negative ?
rational(bigint(1) << 255, 1):
rational((bigint(1) << 256) - 1, 1);
while (value * 10 <= maxValue && value.denominator() != 1 && fractionalDigits < 80)
{
value *= 10;
fractionalDigits++;
}
2016-04-11 23:12:11 +00:00
if (value > maxValue)
return nullptr;
2017-07-12 13:44:27 +00:00
// This means we round towards zero for positive and negative values.
bigint v = value.numerator() / value.denominator();
if (negative && v != 0)
2016-05-10 11:31:10 +00:00
// modify value to satisfy bit requirements for negative numbers:
// add one bit for sign and decrement because negative numbers can be larger
v = (v - 1) << 1;
if (v > u256(-1))
return nullptr;
2019-12-11 16:31:36 +00:00
unsigned totalBits = max(util::bytesRequired(v), 1u) * 8;
solAssert(totalBits <= 256, "");
return TypeProvider::fixedPoint(
totalBits, fractionalDigits,
2016-04-11 23:12:11 +00:00
negative ? FixedPointType::Modifier::Signed : FixedPointType::Modifier::Unsigned
);
}
StringLiteralType::StringLiteralType(Literal const& _literal):
2015-08-31 16:44:29 +00:00
m_value(_literal.value())
{
}
2020-04-01 03:04:29 +00:00
StringLiteralType::StringLiteralType(string _value):
m_value{std::move(_value)}
{
}
BoolResult StringLiteralType::isImplicitlyConvertibleTo(Type const& _convertTo) const
{
if (auto fixedBytes = dynamic_cast<FixedBytesType const*>(&_convertTo))
return size_t(fixedBytes->numBytes()) >= m_value.size();
else if (auto arrayType = dynamic_cast<ArrayType const*>(&_convertTo))
return
arrayType->isByteArray() &&
!(arrayType->dataStoredIn(DataLocation::Storage) && arrayType->isPointer()) &&
2016-11-25 13:36:44 +00:00
!(arrayType->isString() && !isValidUTF8());
else
return false;
}
string StringLiteralType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
// Since we have to return a valid identifier and the string itself may contain
// anything, we hash it.
2019-12-11 16:31:36 +00:00
return "t_stringliteral_" + util::toHex(util::keccak256(m_value).asBytes());
2017-01-17 09:47:44 +00:00
}
2019-02-13 15:22:42 +00:00
bool StringLiteralType::operator==(Type const& _other) const
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
return false;
return m_value == dynamic_cast<StringLiteralType const&>(_other).m_value;
}
std::string StringLiteralType::toString(bool) const
{
2016-08-08 18:12:52 +00:00
size_t invalidSequence;
2019-12-11 16:31:36 +00:00
if (!util::validateUTF8(m_value, invalidSequence))
return "literal_string (contains invalid UTF-8 sequence at position " + util::toString(invalidSequence) + ")";
return "literal_string \"" + m_value + "\"";
}
TypePointer StringLiteralType::mobileType() const
{
return TypeProvider::stringMemory();
}
bool StringLiteralType::isValidUTF8() const
{
2019-12-11 16:31:36 +00:00
return util::validateUTF8(m_value);
}
FixedBytesType::FixedBytesType(unsigned _bytes): m_bytes(_bytes)
2014-12-09 17:46:18 +00:00
{
2018-04-30 11:23:30 +00:00
solAssert(
m_bytes > 0 && m_bytes <= 32,
2019-12-11 16:31:36 +00:00
"Invalid byte number for fixed bytes type: " + util::toString(m_bytes)
2018-04-30 11:23:30 +00:00
);
2014-12-09 17:46:18 +00:00
}
BoolResult FixedBytesType::isImplicitlyConvertibleTo(Type const& _convertTo) const
2014-12-09 17:46:18 +00:00
{
2015-08-31 16:44:29 +00:00
if (_convertTo.category() != category())
2014-12-09 17:46:18 +00:00
return false;
FixedBytesType const& convertTo = dynamic_cast<FixedBytesType const&>(_convertTo);
2014-12-09 17:46:18 +00:00
return convertTo.m_bytes >= m_bytes;
}
BoolResult FixedBytesType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
return (_convertTo.category() == Category::Integer && numBytes() * 8 == dynamic_cast<IntegerType const&>(_convertTo).numBits()) ||
(_convertTo.category() == Category::Address && numBytes() == 20) ||
_convertTo.category() == Category::FixedPoint ||
2015-08-31 16:44:29 +00:00
_convertTo.category() == category();
}
TypeResult FixedBytesType::unaryOperatorResult(Token _operator) const
{
// "delete" and "~" is okay for FixedBytesType
if (_operator == Token::Delete)
return TypeResult{TypeProvider::emptyTuple()};
else if (_operator == Token::BitNot)
return this;
return nullptr;
}
TypeResult FixedBytesType::binaryOperatorResult(Token _operator, Type const* _other) const
{
if (TokenTraits::isShiftOp(_operator))
{
if (isValidShiftAndAmountType(_operator, *_other))
return this;
else
return nullptr;
}
auto commonType = dynamic_cast<FixedBytesType const*>(Type::commonType(this, _other));
if (!commonType)
return nullptr;
// FixedBytes can be compared and have bitwise operators applied to them
if (TokenTraits::isCompareOp(_operator) || TokenTraits::isBitOp(_operator))
return TypeResult(commonType);
return nullptr;
}
2019-02-13 15:22:42 +00:00
MemberList::MemberMap FixedBytesType::nativeMembers(ContractDefinition const*) const
2016-02-03 20:34:24 +00:00
{
return MemberList::MemberMap{MemberList::Member{"length", TypeProvider::uint(8)}};
2016-02-03 20:34:24 +00:00
}
string FixedBytesType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_bytes" + to_string(m_bytes);
2017-01-17 09:47:44 +00:00
}
bool FixedBytesType::operator==(Type const& _other) const
2014-12-09 17:46:18 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-12-09 17:46:18 +00:00
return false;
FixedBytesType const& other = dynamic_cast<FixedBytesType const&>(_other);
2014-12-09 17:46:18 +00:00
return other.m_bytes == m_bytes;
}
2014-12-19 10:31:17 +00:00
u256 BoolType::literalValue(Literal const* _literal) const
2014-10-13 16:22:15 +00:00
{
2014-12-19 10:31:17 +00:00
solAssert(_literal, "");
2015-08-31 16:44:29 +00:00
if (_literal->token() == Token::TrueLiteral)
return u256(1);
2015-08-31 16:44:29 +00:00
else if (_literal->token() == Token::FalseLiteral)
return u256(0);
2014-10-20 10:41:56 +00:00
else
solAssert(false, "Bool type constructed from non-boolean literal.");
2014-10-20 10:41:56 +00:00
}
TypeResult BoolType::unaryOperatorResult(Token _operator) const
{
if (_operator == Token::Delete)
return TypeProvider::emptyTuple();
else if (_operator == Token::Not)
return this;
else
return nullptr;
}
TypeResult BoolType::binaryOperatorResult(Token _operator, Type const* _other) const
{
2015-08-31 16:44:29 +00:00
if (category() != _other->category())
return nullptr;
if (_operator == Token::Equal || _operator == Token::NotEqual || _operator == Token::And || _operator == Token::Or)
return _other;
else
return nullptr;
}
Type const* ContractType::encodingType() const
{
if (isSuper())
return nullptr;
if (isPayable())
return TypeProvider::payableAddress();
else
return TypeProvider::address();
}
BoolResult ContractType::isImplicitlyConvertibleTo(Type const& _convertTo) const
{
2019-11-19 12:07:32 +00:00
if (m_super)
return false;
2015-01-07 21:54:56 +00:00
if (*this == _convertTo)
return true;
2015-08-31 16:44:29 +00:00
if (_convertTo.category() == Category::Contract)
{
auto const& bases = contractDefinition().annotation().linearizedBaseContracts;
2015-01-27 13:32:59 +00:00
if (m_super && bases.size() <= 1)
return false;
return find(
m_super ? ++bases.begin() : bases.begin(), bases.end(),
&dynamic_cast<ContractType const&>(_convertTo).contractDefinition()
) != bases.end();
}
return false;
}
BoolResult ContractType::isExplicitlyConvertibleTo(Type const& _convertTo) const
2015-01-07 21:54:56 +00:00
{
2019-11-19 12:07:32 +00:00
if (m_super)
return false;
if (auto const* addressType = dynamic_cast<AddressType const*>(&_convertTo))
return isPayable() || (addressType->stateMutability() < StateMutability::Payable);
2019-11-19 12:07:32 +00:00
return isImplicitlyConvertibleTo(_convertTo);
2015-01-07 21:54:56 +00:00
}
bool ContractType::isPayable() const
{
auto receiveFunction = m_contract.receiveFunction();
auto fallbackFunction = m_contract.fallbackFunction();
return receiveFunction || (fallbackFunction && fallbackFunction->isPayable());
}
TypeResult ContractType::unaryOperatorResult(Token _operator) const
{
if (isSuper())
return nullptr;
else if (_operator == Token::Delete)
return TypeProvider::emptyTuple();
else
return nullptr;
}
Type const* ReferenceType::withLocation(DataLocation _location, bool _isPointer) const
{
return TypeProvider::withLocation(this, _location, _isPointer);
}
TypeResult ReferenceType::unaryOperatorResult(Token _operator) const
2015-06-26 17:14:26 +00:00
{
if (_operator != Token::Delete)
return nullptr;
2015-06-26 17:14:26 +00:00
// delete can be used on everything except calldata references or storage pointers
// (storage references are ok)
switch (location())
{
case DataLocation::CallData:
return nullptr;
2015-06-26 17:14:26 +00:00
case DataLocation::Memory:
return TypeProvider::emptyTuple();
2015-06-26 17:14:26 +00:00
case DataLocation::Storage:
return isPointer() ? nullptr : TypeProvider::emptyTuple();
2015-06-26 17:14:26 +00:00
}
return nullptr;
2015-06-26 17:14:26 +00:00
}
bool ReferenceType::isPointer() const
{
if (m_location == DataLocation::Storage)
return m_isPointer;
else
return true;
}
TypePointer ReferenceType::copyForLocationIfReference(Type const* _type) const
{
return TypeProvider::withLocationIfReference(m_location, _type);
}
string ReferenceType::stringForReferencePart() const
{
switch (m_location)
{
2015-06-17 10:01:39 +00:00
case DataLocation::Storage:
return string("storage ") + (isPointer() ? "pointer" : "ref");
2015-06-17 10:01:39 +00:00
case DataLocation::CallData:
return "calldata";
2015-06-17 10:01:39 +00:00
case DataLocation::Memory:
return "memory";
}
2015-06-12 08:48:47 +00:00
solAssert(false, "");
return "";
}
2017-01-17 09:47:44 +00:00
string ReferenceType::identifierLocationSuffix() const
{
string id;
switch (location())
{
case DataLocation::Storage:
2017-01-17 09:47:44 +00:00
id += "_storage";
break;
case DataLocation::Memory:
2017-01-17 09:47:44 +00:00
id += "_memory";
break;
case DataLocation::CallData:
2017-01-17 09:47:44 +00:00
id += "_calldata";
break;
}
2017-01-17 09:47:44 +00:00
if (isPointer())
id += "_ptr";
return id;
}
ArrayType::ArrayType(DataLocation _location, bool _isString):
ReferenceType(_location),
m_arrayKind(_isString ? ArrayKind::String : ArrayKind::Bytes),
m_baseType{TypeProvider::byte()}
{
}
void ArrayType::clearCache() const
{
Type::clearCache();
m_interfaceType.reset();
m_interfaceType_library.reset();
}
2019-02-13 15:22:42 +00:00
BoolResult ArrayType::isImplicitlyConvertibleTo(Type const& _convertTo) const
2015-02-10 08:00:50 +00:00
{
2015-08-31 16:44:29 +00:00
if (_convertTo.category() != category())
2015-02-27 13:50:06 +00:00
return false;
auto& convertTo = dynamic_cast<ArrayType const&>(_convertTo);
2015-05-28 14:20:50 +00:00
if (convertTo.isByteArray() != isByteArray() || convertTo.isString() != isString())
2015-02-27 13:50:06 +00:00
return false;
// memory/calldata to storage can be converted, but only to a direct storage reference
2015-06-17 10:01:39 +00:00
if (convertTo.location() == DataLocation::Storage && location() != DataLocation::Storage && convertTo.isPointer())
2015-02-27 13:50:06 +00:00
return false;
2015-06-17 10:01:39 +00:00
if (convertTo.location() == DataLocation::CallData && location() != convertTo.location())
return false;
2015-06-17 10:01:39 +00:00
if (convertTo.location() == DataLocation::Storage && !convertTo.isPointer())
{
// Less restrictive conversion, since we need to copy anyway.
2015-08-31 16:44:29 +00:00
if (!baseType()->isImplicitlyConvertibleTo(*convertTo.baseType()))
return false;
if (convertTo.isDynamicallySized())
return true;
2015-08-31 16:44:29 +00:00
return !isDynamicallySized() && convertTo.length() >= length();
}
else
{
2015-06-23 12:55:33 +00:00
// Conversion to storage pointer or to memory, we de not copy element-for-element here, so
// require that the base type is the same, not only convertible.
// This disallows assignment of nested dynamic arrays from storage to memory for now.
if (
*TypeProvider::withLocationIfReference(location(), baseType()) !=
*TypeProvider::withLocationIfReference(location(), convertTo.baseType())
2015-06-23 12:55:33 +00:00
)
return false;
if (isDynamicallySized() != convertTo.isDynamicallySized())
return false;
// We also require that the size is the same.
2015-08-31 16:44:29 +00:00
if (!isDynamicallySized() && length() != convertTo.length())
return false;
2015-02-27 13:50:06 +00:00
return true;
}
2015-02-10 08:00:50 +00:00
}
2019-02-13 15:22:42 +00:00
BoolResult ArrayType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
if (isImplicitlyConvertibleTo(_convertTo))
return true;
// allow conversion bytes <-> string
2015-08-31 16:44:29 +00:00
if (_convertTo.category() != category())
return false;
auto& convertTo = dynamic_cast<ArrayType const&>(_convertTo);
if (convertTo.location() != location())
return false;
if (!isByteArray() || !convertTo.isByteArray())
return false;
return true;
}
string ArrayType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
string id;
if (isString())
id = "t_string";
2017-01-17 09:47:44 +00:00
else if (isByteArray())
id = "t_bytes";
2017-01-17 09:47:44 +00:00
else
{
id = "t_array";
id += identifierList(baseType());
2017-01-17 09:47:44 +00:00
if (isDynamicallySized())
id += "dyn";
2017-01-17 09:47:44 +00:00
else
id += length().str();
2017-01-17 09:47:44 +00:00
}
id += identifierLocationSuffix();
return id;
}
bool ArrayType::operator==(Type const& _other) const
2015-02-09 17:45:00 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2015-02-09 17:45:00 +00:00
return false;
ArrayType const& other = dynamic_cast<ArrayType const&>(_other);
2015-05-28 14:20:50 +00:00
if (
!ReferenceType::operator==(other) ||
2015-05-28 14:20:50 +00:00
other.isByteArray() != isByteArray() ||
other.isString() != isString() ||
other.isDynamicallySized() != isDynamicallySized()
)
2015-02-27 13:50:06 +00:00
return false;
if (*other.baseType() != *baseType())
return false;
2017-01-17 09:47:44 +00:00
return isDynamicallySized() || length() == other.length();
2015-02-09 17:45:00 +00:00
}
BoolResult ArrayType::validForLocation(DataLocation _loc) const
{
if (auto arrayBaseType = dynamic_cast<ArrayType const*>(baseType()))
{
BoolResult result = arrayBaseType->validForLocation(_loc);
if (!result)
return result;
}
if (isDynamicallySized())
return true;
switch (_loc)
{
case DataLocation::Memory:
{
2020-04-16 15:51:18 +00:00
bigint size = bigint(length());
auto type = m_baseType;
while (auto arrayType = dynamic_cast<ArrayType const*>(type))
{
if (arrayType->isDynamicallySized())
break;
else
{
size *= arrayType->length();
type = arrayType->baseType();
}
}
if (type->isDynamicallySized())
size *= type->memoryHeadSize();
else
size *= type->memoryDataSize();
if (size >= numeric_limits<unsigned>::max())
return BoolResult::err("Type too large for memory.");
break;
}
case DataLocation::CallData:
{
if (unlimitedStaticCalldataSize(true) >= numeric_limits<unsigned>::max())
return BoolResult::err("Type too large for calldata.");
break;
}
case DataLocation::Storage:
break;
}
return true;
}
bigint ArrayType::unlimitedStaticCalldataSize(bool _padded) const
2015-03-03 10:28:56 +00:00
{
solAssert(!isDynamicallySized(), "");
bigint size = bigint(length()) * calldataStride();
if (_padded)
size = ((size + 31) / 32) * 32;
return size;
}
unsigned ArrayType::calldataEncodedSize(bool _padded) const
{
solAssert(!isDynamicallyEncoded(), "");
bigint size = unlimitedStaticCalldataSize(_padded);
solAssert(size <= numeric_limits<unsigned>::max(), "Array size does not fit unsigned.");
return unsigned(size);
}
unsigned ArrayType::calldataEncodedTailSize() const
{
solAssert(isDynamicallyEncoded(), "");
if (isDynamicallySized())
// We do not know the dynamic length itself, but at least the uint256 containing the
// length must still be present.
return 32;
bigint size = unlimitedStaticCalldataSize(false);
2015-03-03 10:28:56 +00:00
solAssert(size <= numeric_limits<unsigned>::max(), "Array size does not fit unsigned.");
return unsigned(size);
}
bool ArrayType::isDynamicallyEncoded() const
{
return isDynamicallySized() || baseType()->isDynamicallyEncoded();
}
2015-08-31 16:44:29 +00:00
u256 ArrayType::storageSize() const
2015-02-22 18:15:41 +00:00
{
if (isDynamicallySized())
return 1;
2015-03-16 16:52:19 +00:00
bigint size;
2015-08-31 16:44:29 +00:00
unsigned baseBytes = baseType()->storageBytes();
2015-03-16 16:52:19 +00:00
if (baseBytes == 0)
size = 1;
else if (baseBytes < 32)
2015-02-22 18:15:41 +00:00
{
2015-03-16 16:52:19 +00:00
unsigned itemsPerSlot = 32 / baseBytes;
2015-08-31 16:44:29 +00:00
size = (bigint(length()) + (itemsPerSlot - 1)) / itemsPerSlot;
2015-02-22 18:15:41 +00:00
}
2015-03-16 16:52:19 +00:00
else
2015-08-31 16:44:29 +00:00
size = bigint(length()) * baseType()->storageSize();
2015-03-16 16:52:19 +00:00
if (size >= bigint(1) << 256)
2019-12-11 16:31:36 +00:00
BOOST_THROW_EXCEPTION(Error(Error::Type::TypeError) << util::errinfo_comment("Array too large for storage."));
2015-03-16 16:52:19 +00:00
return max<u256>(1, u256(size));
2015-02-22 18:15:41 +00:00
}
vector<tuple<string, TypePointer>> ArrayType::makeStackItems() const
2015-02-10 13:57:01 +00:00
{
switch (m_location)
{
case DataLocation::CallData:
if (isDynamicallySized())
return {std::make_tuple("offset", TypeProvider::uint256()), std::make_tuple("length", TypeProvider::uint256())};
else
return {std::make_tuple("offset", TypeProvider::uint256())};
case DataLocation::Memory:
return {std::make_tuple("mpos", TypeProvider::uint256())};
case DataLocation::Storage:
// byte offset inside storage value is omitted
return {std::make_tuple("slot", TypeProvider::uint256())};
}
solAssert(false, "");
2015-02-10 13:57:01 +00:00
}
string ArrayType::toString(bool _short) const
{
string ret;
2015-05-28 14:20:50 +00:00
if (isString())
ret = "string";
2015-05-28 14:20:50 +00:00
else if (isByteArray())
ret = "bytes";
else
{
2015-08-31 16:44:29 +00:00
ret = baseType()->toString(_short) + "[";
if (!isDynamicallySized())
2015-08-31 16:44:29 +00:00
ret += length().str();
ret += "]";
}
if (!_short)
ret += " " + stringForReferencePart();
return ret;
}
string ArrayType::canonicalName() const
{
string ret;
if (isString())
ret = "string";
else if (isByteArray())
ret = "bytes";
else
{
ret = baseType()->canonicalName() + "[";
if (!isDynamicallySized())
ret += length().str();
ret += "]";
}
return ret;
}
string ArrayType::signatureInExternalFunction(bool _structsByName) const
{
if (isByteArray())
return canonicalName();
else
{
solAssert(baseType(), "");
return
baseType()->signatureInExternalFunction(_structsByName) +
"[" +
(isDynamicallySized() ? "" : length().str()) +
"]";
}
}
2015-11-25 13:23:35 +00:00
MemberList::MemberMap ArrayType::nativeMembers(ContractDefinition const*) const
{
2015-11-25 13:23:35 +00:00
MemberList::MemberMap members;
if (!isString())
{
members.emplace_back("length", TypeProvider::uint256());
2015-11-25 13:23:35 +00:00
if (isDynamicallySized() && location() == DataLocation::Storage)
{
members.emplace_back("push", TypeProvider::function(
2019-09-13 22:54:51 +00:00
TypePointers{},
2015-11-25 13:23:35 +00:00
TypePointers{baseType()},
2019-09-13 22:54:51 +00:00
strings{},
2015-11-25 13:23:35 +00:00
strings{string()},
2019-09-13 22:54:51 +00:00
isByteArray() ? FunctionType::Kind::ByteArrayPush : FunctionType::Kind::ArrayPush
));
members.emplace_back("push", TypeProvider::function(
TypePointers{baseType()},
TypePointers{},
2015-11-25 13:23:35 +00:00
strings{string()},
2019-09-13 22:54:51 +00:00
strings{},
isByteArray() ? FunctionType::Kind::ByteArrayPush : FunctionType::Kind::ArrayPush
));
members.emplace_back("pop", TypeProvider::function(
TypePointers{},
TypePointers{},
strings{},
strings{},
2018-04-04 16:21:06 +00:00
FunctionType::Kind::ArrayPop
));
}
}
2015-11-25 13:23:35 +00:00
return members;
}
TypePointer ArrayType::encodingType() const
2015-03-19 15:48:54 +00:00
{
if (location() == DataLocation::Storage)
return TypeProvider::uint256();
else
return TypeProvider::withLocation(this, DataLocation::Memory, true);
}
2015-10-02 20:34:47 +00:00
TypePointer ArrayType::decodingType() const
{
if (location() == DataLocation::Storage)
return TypeProvider::uint256();
2015-10-02 20:34:47 +00:00
else
return this;
2015-10-02 20:34:47 +00:00
}
TypeResult ArrayType::interfaceType(bool _inLibrary) const
{
if (_inLibrary && m_interfaceType_library.has_value())
return *m_interfaceType_library;
if (!_inLibrary && m_interfaceType.has_value())
return *m_interfaceType;
2015-03-19 15:48:54 +00:00
TypeResult result{TypePointer{}};
TypeResult baseInterfaceType = m_baseType->interfaceType(_inLibrary);
2015-03-19 15:48:54 +00:00
if (!baseInterfaceType.get())
{
solAssert(!baseInterfaceType.message().empty(), "Expected detailed error message!");
result = baseInterfaceType;
}
else if (_inLibrary && location() == DataLocation::Storage)
result = this;
else if (m_arrayKind != ArrayKind::Ordinary)
result = TypeProvider::withLocation(this, DataLocation::Memory, true);
else if (isDynamicallySized())
result = TypeProvider::array(DataLocation::Memory, baseInterfaceType);
else
result = TypeProvider::array(DataLocation::Memory, baseInterfaceType, m_length);
if (_inLibrary)
m_interfaceType_library = result;
else
m_interfaceType = result;
return result;
}
u256 ArrayType::memoryDataSize() const
{
solAssert(!isDynamicallySized(), "");
solAssert(m_location == DataLocation::Memory, "");
solAssert(!isByteArray(), "");
bigint size = bigint(m_length) * m_baseType->memoryHeadSize();
2019-10-21 13:14:20 +00:00
solAssert(size <= numeric_limits<u256>::max(), "Array size does not fit u256.");
return u256(size);
}
std::unique_ptr<ReferenceType> ArrayType::copyForLocation(DataLocation _location, bool _isPointer) const
{
auto copy = make_unique<ArrayType>(_location);
if (_location == DataLocation::Storage)
copy->m_isPointer = _isPointer;
2015-05-28 14:20:50 +00:00
copy->m_arrayKind = m_arrayKind;
copy->m_baseType = copy->copyForLocationIfReference(m_baseType);
copy->m_hasDynamicLength = m_hasDynamicLength;
copy->m_length = m_length;
return copy;
}
BoolResult ArraySliceType::isImplicitlyConvertibleTo(Type const& _other) const
{
if (m_arrayType.location() == DataLocation::CallData && m_arrayType.isDynamicallySized() && m_arrayType == _other)
return true;
return (*this) == _other;
}
string ArraySliceType::richIdentifier() const
{
return m_arrayType.richIdentifier() + "_slice";
}
bool ArraySliceType::operator==(Type const& _other) const
{
if (auto const* other = dynamic_cast<ArraySliceType const*>(&_other))
return m_arrayType == other->m_arrayType;
return false;
}
string ArraySliceType::toString(bool _short) const
{
return m_arrayType.toString(_short) + " slice";
}
TypePointer ArraySliceType::mobileType() const
{
if (
m_arrayType.dataStoredIn(DataLocation::CallData) &&
m_arrayType.isDynamicallySized() &&
!m_arrayType.baseType()->isDynamicallyEncoded()
)
return &m_arrayType;
else
return this;
}
std::vector<std::tuple<std::string, TypePointer>> ArraySliceType::makeStackItems() const
2020-02-04 16:08:55 +00:00
{
return {{"offset", TypeProvider::uint256()}, {"length", TypeProvider::uint256()}};
}
string ContractType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return (m_super ? "t_super" : "t_contract") + parenthesizeUserIdentifier(m_contract.name()) + to_string(m_contract.id());
2017-01-17 09:47:44 +00:00
}
2014-10-29 18:28:30 +00:00
bool ContractType::operator==(Type const& _other) const
2014-10-20 10:41:56 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-10-13 16:22:15 +00:00
return false;
2014-10-20 10:41:56 +00:00
ContractType const& other = dynamic_cast<ContractType const&>(_other);
2015-01-27 13:32:59 +00:00
return other.m_contract == m_contract && other.m_super == m_super;
2014-10-13 16:22:15 +00:00
}
string ContractType::toString(bool) const
{
return
string(m_contract.isLibrary() ? "library " : "contract ") +
string(m_super ? "super " : "") +
m_contract.name();
}
string ContractType::canonicalName() const
{
return m_contract.annotation().canonicalName;
}
MemberList::MemberMap ContractType::nativeMembers(ContractDefinition const* _contract) const
2014-12-04 18:38:24 +00:00
{
2017-09-25 11:58:32 +00:00
MemberList::MemberMap members;
solAssert(_contract, "");
2015-11-25 13:23:35 +00:00
if (m_super)
2014-12-04 18:38:24 +00:00
{
2015-11-25 13:23:35 +00:00
// add the most derived of all functions which are visible in derived contracts
auto bases = m_contract.annotation().linearizedBaseContracts;
solAssert(bases.size() >= 1, "linearizedBaseContracts should at least contain the most derived contract.");
// `sliced(1, ...)` ignores the most derived contract, which should not be searchable from `super`.
for (ContractDefinition const* base: bases | boost::adaptors::sliced(1, bases.size()))
2015-11-25 13:23:35 +00:00
for (FunctionDefinition const* function: base->definedFunctions())
{
if (!function->isVisibleInDerivedContracts() || !function->isImplemented())
2015-11-25 13:23:35 +00:00
continue;
auto functionType = TypeProvider::function(*function, FunctionType::Kind::Internal);
2015-11-25 13:23:35 +00:00
bool functionWithEqualArgumentsFound = false;
for (auto const& member: members)
{
2015-11-25 13:23:35 +00:00
if (member.name != function->name())
continue;
auto memberType = dynamic_cast<FunctionType const*>(member.type);
2015-11-25 13:23:35 +00:00
solAssert(!!memberType, "Override changes type.");
if (!memberType->hasEqualParameterTypes(*functionType))
2015-11-25 13:23:35 +00:00
continue;
functionWithEqualArgumentsFound = true;
break;
}
2015-11-25 13:23:35 +00:00
if (!functionWithEqualArgumentsFound)
members.emplace_back(function->name(), functionType, function);
2015-11-25 13:23:35 +00:00
}
2014-12-04 18:38:24 +00:00
}
else if (!m_contract.isLibrary())
{
2015-11-25 13:23:35 +00:00
for (auto const& it: m_contract.interfaceFunctions())
members.emplace_back(
2015-11-25 13:23:35 +00:00
it.second->declaration().name(),
it.second->asCallableFunction(m_contract.isLibrary()),
2015-11-25 13:23:35 +00:00
&it.second->declaration()
);
}
return members;
}
FunctionType const* ContractType::newExpressionType() const
2014-12-12 15:49:26 +00:00
{
if (!m_constructorType)
m_constructorType = FunctionType::newExpressionType(m_contract);
2014-12-12 15:49:26 +00:00
return m_constructorType;
}
2015-08-31 16:44:29 +00:00
vector<tuple<VariableDeclaration const*, u256, unsigned>> ContractType::stateVariables() const
{
vector<VariableDeclaration const*> variables;
for (ContractDefinition const* contract: boost::adaptors::reverse(m_contract.annotation().linearizedBaseContracts))
for (VariableDeclaration const* variable: contract->stateVariables())
2020-02-27 15:13:55 +00:00
if (!(variable->isConstant() || variable->immutable()))
variables.push_back(variable);
TypePointers types;
for (auto variable: variables)
types.push_back(variable->annotation().type);
StorageOffsets offsets;
offsets.computeOffsets(types);
vector<tuple<VariableDeclaration const*, u256, unsigned>> variablesAndOffsets;
for (size_t index = 0; index < variables.size(); ++index)
2015-08-31 16:44:29 +00:00
if (auto const* offset = offsets.offset(index))
variablesAndOffsets.emplace_back(variables[index], offset->first, offset->second);
return variablesAndOffsets;
}
vector<VariableDeclaration const*> ContractType::immutableVariables() const
{
vector<VariableDeclaration const*> variables;
for (ContractDefinition const* contract: boost::adaptors::reverse(m_contract.annotation().linearizedBaseContracts))
for (VariableDeclaration const* variable: contract->stateVariables())
if (variable->immutable())
variables.push_back(variable);
return variables;
}
vector<tuple<string, TypePointer>> ContractType::makeStackItems() const
2020-02-04 16:08:55 +00:00
{
if (m_super)
return {};
else
return {make_tuple("address", isPayable() ? TypeProvider::payableAddress() : TypeProvider::address())};
2020-02-04 16:08:55 +00:00
}
void StructType::clearCache() const
{
Type::clearCache();
m_interfaceType.reset();
m_interfaceType_library.reset();
}
Type const* StructType::encodingType() const
{
if (location() != DataLocation::Storage)
return this;
return TypeProvider::uint256();
}
2019-02-13 15:22:42 +00:00
BoolResult StructType::isImplicitlyConvertibleTo(Type const& _convertTo) const
{
2015-08-31 16:44:29 +00:00
if (_convertTo.category() != category())
return false;
auto& convertTo = dynamic_cast<StructType const&>(_convertTo);
// memory/calldata to storage can be converted, but only to a direct storage reference
2015-06-17 10:01:39 +00:00
if (convertTo.location() == DataLocation::Storage && location() != DataLocation::Storage && convertTo.isPointer())
return false;
2015-06-17 10:01:39 +00:00
if (convertTo.location() == DataLocation::CallData && location() != convertTo.location())
return false;
return this->m_struct == convertTo.m_struct;
}
string StructType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_struct" + parenthesizeUserIdentifier(m_struct.name()) + to_string(m_struct.id()) + identifierLocationSuffix();
2017-01-17 09:47:44 +00:00
}
2014-10-29 18:28:30 +00:00
bool StructType::operator==(Type const& _other) const
2014-10-13 16:22:15 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-10-13 16:22:15 +00:00
return false;
2014-10-20 10:41:56 +00:00
StructType const& other = dynamic_cast<StructType const&>(_other);
return ReferenceType::operator==(other) && other.m_struct == m_struct;
2014-10-13 16:22:15 +00:00
}
unsigned StructType::calldataEncodedSize(bool) const
2015-06-24 15:25:36 +00:00
{
solAssert(!isDynamicallyEncoded(), "");
2015-06-24 15:25:36 +00:00
unsigned size = 0;
2015-11-19 17:02:04 +00:00
for (auto const& member: members(nullptr))
{
solAssert(member.type->canLiveOutsideStorage(), "");
// Struct members are always padded.
size += member.type->calldataEncodedSize();
}
return size;
}
unsigned StructType::calldataEncodedTailSize() const
{
solAssert(isDynamicallyEncoded(), "");
unsigned size = 0;
for (auto const& member: members(nullptr))
{
solAssert(member.type->canLiveOutsideStorage(), "");
// Struct members are always padded.
size += member.type->calldataHeadSize();
}
2015-06-24 15:25:36 +00:00
return size;
}
unsigned StructType::calldataOffsetOfMember(std::string const& _member) const
{
unsigned offset = 0;
for (auto const& member: members(nullptr))
{
solAssert(member.type->canLiveOutsideStorage(), "");
if (member.name == _member)
return offset;
// Struct members are always padded.
offset += member.type->calldataHeadSize();
}
solAssert(false, "Struct member not found.");
}
bool StructType::isDynamicallyEncoded() const
{
if (recursive())
return true;
solAssert(interfaceType(false).get(), "");
2017-08-24 13:20:49 +00:00
for (auto t: memoryMemberTypes())
{
solAssert(t, "Parameter should have external type.");
t = t->interfaceType(false);
if (t->isDynamicallyEncoded())
return true;
}
return false;
}
u256 StructType::memoryDataSize() const
2015-06-30 09:54:51 +00:00
{
u256 size;
for (auto const& t: memoryMemberTypes())
size += t->memoryHeadSize();
2015-06-30 09:54:51 +00:00
return size;
}
2015-08-31 16:44:29 +00:00
u256 StructType::storageSize() const
2014-11-07 01:06:37 +00:00
{
2015-11-19 17:02:04 +00:00
return max<u256>(1, members(nullptr).storageSize());
2014-11-07 01:06:37 +00:00
}
string StructType::toString(bool _short) const
2014-11-13 00:12:57 +00:00
{
string ret = "struct " + m_struct.annotation().canonicalName;
if (!_short)
ret += " " + stringForReferencePart();
return ret;
2014-11-13 00:12:57 +00:00
}
2015-11-25 13:23:35 +00:00
MemberList::MemberMap StructType::nativeMembers(ContractDefinition const*) const
2014-11-13 00:12:57 +00:00
{
2015-11-25 13:23:35 +00:00
MemberList::MemberMap members;
for (ASTPointer<VariableDeclaration> const& variable: m_struct.members())
2014-11-20 09:19:43 +00:00
{
2015-11-25 13:23:35 +00:00
TypePointer type = variable->annotation().type;
2017-02-16 11:36:43 +00:00
solAssert(type, "");
// If we are not in storage, skip all members that cannot live outside of storage,
// ex. mappings and array of mappings
2015-11-25 13:23:35 +00:00
if (location() != DataLocation::Storage && !type->canLiveOutsideStorage())
continue;
members.emplace_back(
2015-11-25 13:23:35 +00:00
variable->name(),
copyForLocationIfReference(type),
variable.get()
2015-11-25 13:23:35 +00:00
);
2014-11-20 09:19:43 +00:00
}
2015-11-25 13:23:35 +00:00
return members;
2014-11-13 00:12:57 +00:00
}
TypeResult StructType::interfaceType(bool _inLibrary) const
{
if (!_inLibrary)
{
if (!m_interfaceType.has_value())
{
if (recursive())
m_interfaceType = TypeResult::err("Recursive type not allowed for public or external contract functions.");
else
{
TypeResult result{TypePointer{}};
for (ASTPointer<VariableDeclaration> const& member: m_struct.members())
{
if (!member->annotation().type)
{
result = TypeResult::err("Invalid type!");
break;
}
auto interfaceType = member->annotation().type->interfaceType(false);
if (!interfaceType.get())
{
solAssert(!interfaceType.message().empty(), "Expected detailed error message!");
result = interfaceType;
break;
}
}
if (result.message().empty())
m_interfaceType = TypeProvider::withLocation(this, DataLocation::Memory, true);
else
m_interfaceType = result;
}
}
return *m_interfaceType;
}
else if (m_interfaceType_library.has_value())
return *m_interfaceType_library;
TypeResult result{TypePointer{}};
util::BreadthFirstSearch<StructDefinition const*> breadthFirstSearch{{&m_struct}};
breadthFirstSearch.run(
[&](StructDefinition const* _struct, auto&& _addChild) {
// Check that all members have interface types.
// Return an error if at least one struct member does not have a type.
// This might happen, for example, if the type of the member does not exist.
for (ASTPointer<VariableDeclaration> const& variable: _struct->members())
{
// If the struct member does not have a type return false.
// A TypeError is expected in this case.
if (!variable->annotation().type)
{
result = TypeResult::err("Invalid type!");
breadthFirstSearch.abort();
return;
}
Type const* memberType = variable->annotation().type;
while (dynamic_cast<ArrayType const*>(memberType))
memberType = dynamic_cast<ArrayType const*>(memberType)->baseType();
if (StructType const* innerStruct = dynamic_cast<StructType const*>(memberType))
{
if (innerStruct->recursive() && !(_inLibrary && location() == DataLocation::Storage))
{
result = TypeResult::err(
"Recursive structs can only be passed as storage pointers to libraries, not as memory objects to contract functions."
);
breadthFirstSearch.abort();
return;
}
else
_addChild(&innerStruct->structDefinition());
}
else
{
auto iType = memberType->interfaceType(_inLibrary);
if (!iType.get())
{
solAssert(!iType.message().empty(), "Expected detailed error message!");
result = iType;
breadthFirstSearch.abort();
return;
}
}
}
}
);
if (!result.message().empty())
return result;
if (location() == DataLocation::Storage)
m_interfaceType_library = this;
else
m_interfaceType_library = TypeProvider::withLocation(this, DataLocation::Memory, true);
return *m_interfaceType_library;
}
BoolResult StructType::validForLocation(DataLocation _loc) const
{
for (auto const& member: m_struct.members())
if (auto referenceType = dynamic_cast<ReferenceType const*>(member->annotation().type))
{
BoolResult result = referenceType->validForLocation(_loc);
if (!result)
return result;
}
return true;
}
bool StructType::recursive() const
{
solAssert(m_struct.annotation().recursive.has_value(), "Called StructType::recursive() before DeclarationTypeChecker.");
return *m_struct.annotation().recursive;
}
std::unique_ptr<ReferenceType> StructType::copyForLocation(DataLocation _location, bool _isPointer) const
{
auto copy = make_unique<StructType>(m_struct, _location);
if (_location == DataLocation::Storage)
copy->m_isPointer = _isPointer;
return copy;
}
string StructType::signatureInExternalFunction(bool _structsByName) const
{
if (_structsByName)
return canonicalName();
else
{
TypePointers memberTypes = memoryMemberTypes();
auto memberTypeStrings = memberTypes | boost::adaptors::transformed([&](TypePointer _t) -> string
{
solAssert(_t, "Parameter should have external type.");
auto t = _t->interfaceType(_structsByName);
solAssert(t.get(), "");
return t.get()->signatureInExternalFunction(_structsByName);
});
return "(" + boost::algorithm::join(memberTypeStrings, ",") + ")";
}
}
string StructType::canonicalName() const
{
return m_struct.annotation().canonicalName;
}
2015-06-30 19:08:34 +00:00
FunctionTypePointer StructType::constructorType() const
{
TypePointers paramTypes;
strings paramNames;
2015-11-19 17:02:04 +00:00
for (auto const& member: members(nullptr))
2015-06-30 19:08:34 +00:00
{
if (!member.type->canLiveOutsideStorage())
continue;
paramNames.push_back(member.name);
paramTypes.push_back(TypeProvider::withLocationIfReference(DataLocation::Memory, member.type));
2015-06-30 19:08:34 +00:00
}
return TypeProvider::function(
2015-06-30 19:08:34 +00:00
paramTypes,
TypePointers{TypeProvider::withLocation(this, DataLocation::Memory, false)},
2015-06-30 19:08:34 +00:00
paramNames,
strings(1, ""),
FunctionType::Kind::Internal
2015-06-30 19:08:34 +00:00
);
}
2015-08-31 16:44:29 +00:00
pair<u256, unsigned> const& StructType::storageOffsetsOfMember(string const& _name) const
2014-11-13 00:12:57 +00:00
{
2015-11-19 17:02:04 +00:00
auto const* offsets = members(nullptr).memberStorageOffset(_name);
2015-03-13 18:48:24 +00:00
solAssert(offsets, "Storage offset of non-existing member requested.");
return *offsets;
2014-11-13 00:12:57 +00:00
}
2015-06-30 09:54:51 +00:00
u256 StructType::memoryOffsetOfMember(string const& _name) const
{
u256 offset;
2015-11-19 17:02:04 +00:00
for (auto const& member: members(nullptr))
2015-06-30 09:54:51 +00:00
if (member.name == _name)
return offset;
else
offset += member.type->memoryHeadSize();
solAssert(false, "Member not found in struct.");
return 0;
}
TypePointers StructType::memoryMemberTypes() const
{
TypePointers types;
for (ASTPointer<VariableDeclaration> const& variable: m_struct.members())
if (variable->annotation().type->canLiveOutsideStorage())
2020-03-02 20:42:46 +00:00
types.push_back(TypeProvider::withLocationIfReference(DataLocation::Memory, variable->annotation().type));
return types;
}
set<string> StructType::membersMissingInMemory() const
{
set<string> missing;
2015-08-31 16:44:29 +00:00
for (ASTPointer<VariableDeclaration> const& variable: m_struct.members())
if (!variable->annotation().type->canLiveOutsideStorage())
2015-08-31 16:44:29 +00:00
missing.insert(variable->name());
return missing;
}
TypePointer EnumType::encodingType() const
{
return TypeProvider::uint(8 * storageBytes());
}
TypeResult EnumType::unaryOperatorResult(Token _operator) const
{
return _operator == Token::Delete ? TypeProvider::emptyTuple() : nullptr;
}
string EnumType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_enum" + parenthesizeUserIdentifier(m_enum.name()) + to_string(m_enum.id());
2017-01-17 09:47:44 +00:00
}
bool EnumType::operator==(Type const& _other) const
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
return false;
EnumType const& other = dynamic_cast<EnumType const&>(_other);
return other.m_enum == m_enum;
}
2015-08-31 16:44:29 +00:00
unsigned EnumType::storageBytes() const
2015-03-13 09:52:34 +00:00
{
2016-11-07 17:15:59 +00:00
size_t elements = numberOfMembers();
2015-03-13 09:52:34 +00:00
if (elements <= 1)
return 1;
else
2019-12-11 16:31:36 +00:00
return util::bytesRequired(elements - 1);
2015-03-13 09:52:34 +00:00
}
string EnumType::toString(bool) const
{
return string("enum ") + m_enum.annotation().canonicalName;
}
string EnumType::canonicalName() const
{
return m_enum.annotation().canonicalName;
}
2016-11-07 17:15:59 +00:00
size_t EnumType::numberOfMembers() const
{
return m_enum.members().size();
}
2016-11-07 17:15:59 +00:00
BoolResult EnumType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
return _convertTo == *this || _convertTo.category() == Category::Integer;
}
2016-05-10 09:15:41 +00:00
unsigned EnumType::memberValue(ASTString const& _member) const
{
2016-05-10 09:15:41 +00:00
unsigned index = 0;
2015-08-31 16:44:29 +00:00
for (ASTPointer<EnumValue> const& decl: m_enum.members())
{
2015-08-31 16:44:29 +00:00
if (decl->name() == _member)
return index;
++index;
}
2017-10-05 19:18:46 +00:00
solAssert(false, "Requested unknown enum value " + _member);
}
BoolResult TupleType::isImplicitlyConvertibleTo(Type const& _other) const
2015-10-14 13:19:50 +00:00
{
if (auto tupleType = dynamic_cast<TupleType const*>(&_other))
{
TypePointers const& targets = tupleType->components();
if (targets.empty())
return components().empty();
if (components().size() != targets.size())
2015-10-14 13:19:50 +00:00
return false;
for (size_t i = 0; i < targets.size(); ++i)
if (!components()[i] && targets[i])
2015-10-14 13:19:50 +00:00
return false;
else if (components()[i] && targets[i] && !components()[i]->isImplicitlyConvertibleTo(*targets[i]))
2015-10-14 13:19:50 +00:00
return false;
return true;
}
else
return false;
}
string TupleType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_tuple" + identifierList(components());
2017-01-17 09:47:44 +00:00
}
bool TupleType::operator==(Type const& _other) const
{
if (auto tupleType = dynamic_cast<TupleType const*>(&_other))
return components() == tupleType->components();
else
return false;
}
string TupleType::toString(bool _short) const
{
2015-10-14 13:19:50 +00:00
if (components().empty())
return "tuple()";
string str = "tuple(";
2015-10-14 13:19:50 +00:00
for (auto const& t: components())
2015-10-12 21:02:35 +00:00
str += (t ? t->toString(_short) : "") + ",";
str.pop_back();
return str + ")";
}
u256 TupleType::storageSize() const
{
solAssert(false, "Storage size of non-storable tuple type requested.");
}
vector<tuple<string, TypePointer>> TupleType::makeStackItems() const
{
2020-02-04 16:08:55 +00:00
vector<tuple<string, TypePointer>> slots;
unsigned i = 1;
2015-10-14 13:19:50 +00:00
for (auto const& t: components())
2020-02-04 16:08:55 +00:00
{
if (t)
slots.emplace_back("component_" + std::to_string(i), t);
++i;
}
return slots;
}
2015-10-14 13:19:50 +00:00
TypePointer TupleType::mobileType() const
2015-10-12 21:02:35 +00:00
{
2015-10-14 13:19:50 +00:00
TypePointers mobiles;
for (auto const& c: components())
2016-10-21 10:30:58 +00:00
{
if (c)
{
auto mt = c->mobileType();
if (!mt)
return nullptr;
2016-10-21 10:30:58 +00:00
mobiles.push_back(mt);
}
else
mobiles.push_back(nullptr);
2016-10-21 10:30:58 +00:00
}
return TypeProvider::tuple(move(mobiles));
2015-10-14 13:19:50 +00:00
}
TypePointer TupleType::closestTemporaryType(Type const* _targetType) const
2015-10-14 13:19:50 +00:00
{
solAssert(!!_targetType, "");
TypePointers const& targetComponents = dynamic_cast<TupleType const&>(*_targetType).components();
solAssert(components().size() == targetComponents.size(), "");
2015-10-14 13:19:50 +00:00
TypePointers tempComponents(targetComponents.size());
for (size_t i = 0; i < targetComponents.size(); ++i)
2015-10-12 21:02:35 +00:00
{
if (components()[i] && targetComponents[i])
{
tempComponents[i] = components()[i]->closestTemporaryType(targetComponents[i]);
solAssert(tempComponents[i], "");
}
2015-10-12 21:02:35 +00:00
}
return TypeProvider::tuple(move(tempComponents));
2015-10-12 21:02:35 +00:00
}
FunctionType::FunctionType(FunctionDefinition const& _function, Kind _kind):
m_kind(_kind),
m_stateMutability(_function.stateMutability()),
2015-01-29 16:28:14 +00:00
m_declaration(&_function)
{
solAssert(
_kind == Kind::Internal || _kind == Kind::External || _kind == Kind::Declaration,
"Only internal or external function types or function declaration types can be created from function definitions."
);
if (_kind == Kind::Internal && m_stateMutability == StateMutability::Payable)
m_stateMutability = StateMutability::NonPayable;
2015-08-31 16:44:29 +00:00
for (ASTPointer<VariableDeclaration> const& var: _function.parameters())
{
2018-02-20 18:38:51 +00:00
m_parameterNames.push_back(var->name());
m_parameterTypes.push_back(var->annotation().type);
}
2015-08-31 16:44:29 +00:00
for (ASTPointer<VariableDeclaration> const& var: _function.returnParameters())
{
2018-02-20 18:38:51 +00:00
m_returnParameterNames.push_back(var->name());
m_returnParameterTypes.push_back(var->annotation().type);
}
solAssert(
m_parameterNames.size() == m_parameterTypes.size(),
"Parameter names list must match parameter types list!"
);
solAssert(
m_returnParameterNames.size() == m_returnParameterTypes.size(),
"Return parameter names list must match return parameter types list!"
);
}
FunctionType::FunctionType(VariableDeclaration const& _varDecl):
2017-08-28 15:31:26 +00:00
m_kind(Kind::External),
m_stateMutability(StateMutability::View),
m_declaration(&_varDecl)
{
auto returnType = _varDecl.annotation().type;
while (true)
{
if (auto mappingType = dynamic_cast<MappingType const*>(returnType))
{
2018-02-20 18:38:51 +00:00
m_parameterTypes.push_back(mappingType->keyType());
m_parameterNames.emplace_back("");
2015-08-31 16:44:29 +00:00
returnType = mappingType->valueType();
}
else if (auto arrayType = dynamic_cast<ArrayType const*>(returnType))
{
2015-06-17 10:01:39 +00:00
if (arrayType->isByteArray())
2018-09-20 14:54:57 +00:00
// Return byte arrays as whole.
2015-06-17 10:01:39 +00:00
break;
2015-08-31 16:44:29 +00:00
returnType = arrayType->baseType();
m_parameterNames.emplace_back("");
m_parameterTypes.push_back(TypeProvider::uint256());
}
else
break;
}
if (auto structType = dynamic_cast<StructType const*>(returnType))
2015-02-06 18:57:08 +00:00
{
2015-11-19 17:02:04 +00:00
for (auto const& member: structType->members(nullptr))
2017-02-16 11:36:43 +00:00
{
solAssert(member.type, "");
2015-08-31 16:44:29 +00:00
if (member.type->category() != Category::Mapping)
2015-02-06 18:57:08 +00:00
{
if (auto arrayType = dynamic_cast<ArrayType const*>(member.type))
2015-06-17 10:01:39 +00:00
if (!arrayType->isByteArray())
continue;
m_returnParameterTypes.push_back(TypeProvider::withLocationIfReference(
DataLocation::Memory,
member.type
));
2018-02-20 18:38:51 +00:00
m_returnParameterNames.push_back(member.name);
2015-02-06 18:57:08 +00:00
}
2017-02-16 11:36:43 +00:00
}
2015-02-06 18:57:08 +00:00
}
else
{
m_returnParameterTypes.push_back(TypeProvider::withLocationIfReference(
2015-06-17 10:01:39 +00:00
DataLocation::Memory,
returnType
));
m_returnParameterNames.emplace_back("");
2015-02-06 18:57:08 +00:00
}
solAssert(
m_parameterNames.size() == m_parameterTypes.size(),
"Parameter names list must match parameter types list!"
);
solAssert(
m_returnParameterNames.size() == m_returnParameterTypes.size(),
"Return parameter names list must match return parameter types list!"
);
}
FunctionType::FunctionType(EventDefinition const& _event):
2017-08-28 15:31:26 +00:00
m_kind(Kind::Event),
m_stateMutability(StateMutability::NonPayable),
m_declaration(&_event)
2015-01-29 13:35:28 +00:00
{
2015-08-31 16:44:29 +00:00
for (ASTPointer<VariableDeclaration> const& var: _event.parameters())
2015-01-29 13:35:28 +00:00
{
2018-02-20 18:38:51 +00:00
m_parameterNames.push_back(var->name());
m_parameterTypes.push_back(var->annotation().type);
2015-01-29 13:35:28 +00:00
}
solAssert(
m_parameterNames.size() == m_parameterTypes.size(),
"Parameter names list must match parameter types list!"
);
solAssert(
m_returnParameterNames.size() == m_returnParameterTypes.size(),
"Return parameter names list must match return parameter types list!"
);
2015-01-29 13:35:28 +00:00
}
2016-09-27 19:37:32 +00:00
FunctionType::FunctionType(FunctionTypeName const& _typeName):
m_parameterNames(_typeName.parameterTypes().size(), ""),
m_returnParameterNames(_typeName.returnParameterTypes().size(), ""),
2019-12-10 14:54:09 +00:00
m_kind(_typeName.visibility() == Visibility::External ? Kind::External : Kind::Internal),
m_stateMutability(_typeName.stateMutability())
2016-09-27 19:37:32 +00:00
{
2016-11-09 14:14:16 +00:00
if (_typeName.isPayable())
solAssert(m_kind == Kind::External, "Internal payable function type used.");
2016-09-27 19:37:32 +00:00
for (auto const& t: _typeName.parameterTypes())
{
solAssert(t->annotation().type, "Type not set for parameter.");
m_parameterTypes.push_back(t->annotation().type);
}
for (auto const& t: _typeName.returnParameterTypes())
{
solAssert(t->annotation().type, "Type not set for return parameter.");
m_returnParameterTypes.push_back(t->annotation().type);
}
solAssert(
m_parameterNames.size() == m_parameterTypes.size(),
"Parameter names list must match parameter types list!"
);
solAssert(
m_returnParameterNames.size() == m_returnParameterTypes.size(),
"Return parameter names list must match return parameter types list!"
);
2016-09-27 19:37:32 +00:00
}
FunctionTypePointer FunctionType::newExpressionType(ContractDefinition const& _contract)
{
FunctionDefinition const* constructor = _contract.constructor();
TypePointers parameters;
strings parameterNames;
StateMutability stateMutability = StateMutability::NonPayable;
2019-01-17 11:59:11 +00:00
solAssert(!_contract.isInterface(), "");
if (constructor)
{
for (ASTPointer<VariableDeclaration> const& var: constructor->parameters())
{
parameterNames.push_back(var->name());
parameters.push_back(var->annotation().type);
}
if (constructor->isPayable())
stateMutability = StateMutability::Payable;
}
return TypeProvider::function(
parameters,
TypePointers{TypeProvider::contract(_contract)},
parameterNames,
strings{""},
Kind::Creation,
false,
stateMutability
);
}
2016-02-18 12:29:02 +00:00
vector<string> FunctionType::parameterNames() const
2015-11-25 13:23:35 +00:00
{
if (!bound())
return m_parameterNames;
return vector<string>(m_parameterNames.cbegin() + 1, m_parameterNames.cend());
}
TypePointers FunctionType::returnParameterTypesWithoutDynamicTypes() const
{
TypePointers returnParameterTypes = m_returnParameterTypes;
2018-08-15 21:30:09 +00:00
if (
m_kind == Kind::External ||
m_kind == Kind::DelegateCall ||
m_kind == Kind::BareCall ||
m_kind == Kind::BareCallCode ||
m_kind == Kind::BareDelegateCall ||
m_kind == Kind::BareStaticCall
)
for (auto& param: returnParameterTypes)
if (param->isDynamicallySized() && !param->dataStoredIn(DataLocation::Storage))
param = TypeProvider::inaccessibleDynamic();
return returnParameterTypes;
}
2015-11-25 13:23:35 +00:00
TypePointers FunctionType::parameterTypes() const
{
if (!bound())
return m_parameterTypes;
return TypePointers(m_parameterTypes.cbegin() + 1, m_parameterTypes.cend());
}
string FunctionType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
string id = "t_function_";
switch (m_kind)
{
case Kind::Declaration: id += "declaration"; break;
case Kind::Internal: id += "internal"; break;
case Kind::External: id += "external"; break;
case Kind::DelegateCall: id += "delegatecall"; break;
2017-08-01 09:32:23 +00:00
case Kind::BareCall: id += "barecall"; break;
case Kind::BareCallCode: id += "barecallcode"; break;
case Kind::BareDelegateCall: id += "baredelegatecall"; break;
2018-08-15 12:40:20 +00:00
case Kind::BareStaticCall: id += "barestaticcall"; break;
case Kind::Creation: id += "creation"; break;
case Kind::Send: id += "send"; break;
case Kind::Transfer: id += "transfer"; break;
case Kind::KECCAK256: id += "keccak256"; break;
case Kind::Selfdestruct: id += "selfdestruct"; break;
case Kind::Revert: id += "revert"; break;
case Kind::ECRecover: id += "ecrecover"; break;
case Kind::SHA256: id += "sha256"; break;
case Kind::RIPEMD160: id += "ripemd160"; break;
case Kind::Log0: id += "log0"; break;
case Kind::Log1: id += "log1"; break;
case Kind::Log2: id += "log2"; break;
case Kind::Log3: id += "log3"; break;
case Kind::Log4: id += "log4"; break;
case Kind::GasLeft: id += "gasleft"; break;
case Kind::Event: id += "event"; break;
case Kind::SetGas: id += "setgas"; break;
case Kind::SetValue: id += "setvalue"; break;
case Kind::BlockHash: id += "blockhash"; break;
case Kind::AddMod: id += "addmod"; break;
case Kind::MulMod: id += "mulmod"; break;
case Kind::ArrayPush: id += "arraypush"; break;
2018-05-31 12:53:33 +00:00
case Kind::ArrayPop: id += "arraypop"; break;
case Kind::ByteArrayPush: id += "bytearraypush"; break;
case Kind::ObjectCreation: id += "objectcreation"; break;
case Kind::Assert: id += "assert"; break;
case Kind::Require: id += "require"; break;
case Kind::ABIEncode: id += "abiencode"; break;
case Kind::ABIEncodePacked: id += "abiencodepacked"; break;
case Kind::ABIEncodeWithSelector: id += "abiencodewithselector"; break;
case Kind::ABIEncodeWithSignature: id += "abiencodewithsignature"; break;
2018-06-30 16:09:13 +00:00
case Kind::ABIDecode: id += "abidecode"; break;
2019-01-10 15:28:39 +00:00
case Kind::MetaType: id += "metatype"; break;
2017-01-17 09:47:44 +00:00
}
id += "_" + stateMutabilityToString(m_stateMutability);
id += identifierList(m_parameterTypes) + "returns" + identifierList(m_returnParameterTypes);
2017-01-17 09:47:44 +00:00
if (m_gasSet)
id += "gas";
2017-01-17 09:47:44 +00:00
if (m_valueSet)
id += "value";
if (m_saltSet)
id += "salt";
2017-01-17 09:47:44 +00:00
if (bound())
id += "bound_to" + identifierList(selfType());
2017-01-17 09:47:44 +00:00
return id;
}
2014-10-29 18:28:30 +00:00
bool FunctionType::operator==(Type const& _other) const
2014-10-20 10:41:56 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-10-20 10:41:56 +00:00
return false;
FunctionType const& other = dynamic_cast<FunctionType const&>(_other);
if (!equalExcludingStateMutability(other))
return false;
if (m_stateMutability != other.stateMutability())
return false;
return true;
2014-10-20 10:41:56 +00:00
}
BoolResult FunctionType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
if (_convertTo.category() == category())
{
auto const& convertToType = dynamic_cast<FunctionType const&>(_convertTo);
return (m_kind == FunctionType::Kind::Declaration) == (convertToType.kind() == FunctionType::Kind::Declaration);
}
return false;
}
BoolResult FunctionType::isImplicitlyConvertibleTo(Type const& _convertTo) const
{
if (_convertTo.category() != category())
return false;
FunctionType const& convertTo = dynamic_cast<FunctionType const&>(_convertTo);
if (!equalExcludingStateMutability(convertTo))
return false;
// non-payable should not be convertible to payable
if (m_stateMutability != StateMutability::Payable && convertTo.stateMutability() == StateMutability::Payable)
return false;
// payable should be convertible to non-payable, because you are free to pay 0 ether
if (m_stateMutability == StateMutability::Payable && convertTo.stateMutability() == StateMutability::NonPayable)
return true;
// e.g. pure should be convertible to view, but not the other way around.
if (m_stateMutability > convertTo.stateMutability())
return false;
return true;
}
TypeResult FunctionType::unaryOperatorResult(Token _operator) const
2016-11-09 08:36:38 +00:00
{
if (_operator == Token::Delete)
return TypeResult(TypeProvider::emptyTuple());
return nullptr;
2016-11-09 08:36:38 +00:00
}
TypeResult FunctionType::binaryOperatorResult(Token _operator, Type const* _other) const
{
if (_other->category() != category() || !(_operator == Token::Equal || _operator == Token::NotEqual))
return nullptr;
FunctionType const& other = dynamic_cast<FunctionType const&>(*_other);
if (kind() == Kind::Internal && other.kind() == Kind::Internal && sizeOnStack() == 1 && other.sizeOnStack() == 1)
return commonType(this, _other);
return nullptr;
}
string FunctionType::canonicalName() const
{
solAssert(m_kind == Kind::External, "");
return "function";
}
string FunctionType::toString(bool _short) const
2014-11-13 00:12:57 +00:00
{
string name = "function ";
if (m_kind == Kind::Declaration)
{
auto const* functionDefinition = dynamic_cast<FunctionDefinition const*>(m_declaration);
solAssert(functionDefinition, "");
auto const* contract = dynamic_cast<ContractDefinition const*>(functionDefinition->scope());
solAssert(contract, "");
name += contract->annotation().canonicalName;
name += '.';
name += functionDefinition->name();
}
name += '(';
for (auto it = m_parameterTypes.begin(); it != m_parameterTypes.end(); ++it)
name += (*it)->toString(_short) + (it + 1 == m_parameterTypes.end() ? "" : ",");
name += ")";
if (m_stateMutability != StateMutability::NonPayable)
name += " " + stateMutabilityToString(m_stateMutability);
if (m_kind == Kind::External)
name += " external";
if (!m_returnParameterTypes.empty())
{
name += " returns (";
for (auto it = m_returnParameterTypes.begin(); it != m_returnParameterTypes.end(); ++it)
name += (*it)->toString(_short) + (it + 1 == m_returnParameterTypes.end() ? "" : ",");
name += ")";
}
return name;
2014-11-13 00:12:57 +00:00
}
2016-09-27 19:37:32 +00:00
unsigned FunctionType::calldataEncodedSize(bool _padded) const
{
unsigned size = storageBytes();
if (_padded)
size = ((size + 31) / 32) * 32;
return size;
}
2015-08-31 16:44:29 +00:00
u256 FunctionType::storageSize() const
2015-03-13 09:52:34 +00:00
{
if (m_kind == Kind::External || m_kind == Kind::Internal)
2016-09-27 19:37:32 +00:00
return 1;
else
solAssert(false, "Storage size of non-storable function type requested.");
2016-09-27 19:37:32 +00:00
}
2019-03-19 15:13:16 +00:00
bool FunctionType::leftAligned() const
{
if (m_kind == Kind::External)
return true;
else
solAssert(false, "Alignment property of non-exportable function type requested.");
}
2016-09-27 19:37:32 +00:00
unsigned FunctionType::storageBytes() const
{
if (m_kind == Kind::External)
2016-09-27 19:37:32 +00:00
return 20 + 4;
else if (m_kind == Kind::Internal)
2016-09-27 19:37:32 +00:00
return 8; // it should really not be possible to create larger programs
else
solAssert(false, "Storage size of non-storable function type requested.");
2015-03-13 09:52:34 +00:00
}
vector<tuple<string, TypePointer>> FunctionType::makeStackItems() const
{
2020-02-04 16:08:55 +00:00
vector<tuple<string, TypePointer>> slots;
Kind kind = m_kind;
if (m_kind == Kind::SetGas || m_kind == Kind::SetValue)
2015-02-22 17:38:32 +00:00
{
solAssert(m_returnParameterTypes.size() == 1, "");
kind = dynamic_cast<FunctionType const&>(*m_returnParameterTypes.front()).m_kind;
2015-02-22 17:38:32 +00:00
}
2019-11-11 16:09:59 +00:00
switch (kind)
2017-08-09 22:16:58 +00:00
{
case Kind::External:
case Kind::DelegateCall:
slots = {
make_tuple("address", TypeProvider::address()),
make_tuple("functionIdentifier", TypeProvider::uint(32))
};
2017-08-09 22:16:58 +00:00
break;
case Kind::BareCall:
case Kind::BareCallCode:
case Kind::BareDelegateCall:
2018-08-15 12:40:20 +00:00
case Kind::BareStaticCall:
2020-02-04 16:08:55 +00:00
case Kind::Transfer:
case Kind::Send:
slots = {make_tuple("address", TypeProvider::address())};
break;
2017-08-09 22:16:58 +00:00
case Kind::Internal:
slots = {make_tuple("functionIdentifier", TypeProvider::uint256())};
2020-02-04 16:08:55 +00:00
break;
2017-08-09 22:16:58 +00:00
case Kind::ArrayPush:
2018-05-31 12:53:33 +00:00
case Kind::ArrayPop:
2017-08-09 22:16:58 +00:00
case Kind::ByteArrayPush:
slots = {make_tuple("slot", TypeProvider::uint256())};
2017-08-09 22:16:58 +00:00
break;
default:
break;
}
if (m_gasSet)
2020-02-04 16:08:55 +00:00
slots.emplace_back("gas", TypeProvider::uint256());
if (m_valueSet)
2020-02-04 16:08:55 +00:00
slots.emplace_back("value", TypeProvider::uint256());
if (m_saltSet)
2020-02-25 16:57:28 +00:00
slots.emplace_back("salt", TypeProvider::fixedBytes(32));
2015-11-25 13:23:35 +00:00
if (bound())
for (auto const& [boundName, boundType]: m_parameterTypes.front()->stackItems())
2020-02-04 16:08:55 +00:00
slots.emplace_back("self_" + boundName, boundType);
return slots;
}
FunctionTypePointer FunctionType::interfaceFunctionType() const
{
// Note that m_declaration might also be a state variable!
solAssert(m_declaration, "Declaration needed to determine interface function type.");
bool isLibraryFunction = kind() != Kind::Event && dynamic_cast<ContractDefinition const&>(*m_declaration->scope()).isLibrary();
2019-12-11 16:31:36 +00:00
util::Result<TypePointers> paramTypes =
transformParametersToExternal(m_parameterTypes, isLibraryFunction);
if (!paramTypes.message().empty())
return FunctionTypePointer();
2019-12-11 16:31:36 +00:00
util::Result<TypePointers> retParamTypes =
transformParametersToExternal(m_returnParameterTypes, isLibraryFunction);
if (!retParamTypes.message().empty())
return FunctionTypePointer();
auto variable = dynamic_cast<VariableDeclaration const*>(m_declaration);
if (variable && retParamTypes.get().empty())
return FunctionTypePointer();
return TypeProvider::function(
paramTypes,
retParamTypes,
m_parameterNames,
m_returnParameterNames,
m_kind,
m_arbitraryParameters,
m_stateMutability,
m_declaration
);
}
MemberList::MemberMap FunctionType::nativeMembers(ContractDefinition const* _scope) const
2014-11-25 17:23:39 +00:00
{
switch (m_kind)
2014-11-25 17:23:39 +00:00
{
case Kind::Declaration:
if (declaration().isPartOfExternalInterface())
return {{"selector", TypeProvider::fixedBytes(4)}};
else
return MemberList::MemberMap();
case Kind::Internal:
if (
auto const* functionDefinition = dynamic_cast<FunctionDefinition const*>(m_declaration);
functionDefinition &&
_scope &&
functionDefinition->annotation().contract &&
_scope != functionDefinition->annotation().contract &&
functionDefinition->isPartOfExternalInterface()
)
{
solAssert(_scope->derivesFrom(*functionDefinition->annotation().contract), "");
return {{"selector", TypeProvider::fixedBytes(4)}};
}
else
return MemberList::MemberMap();
case Kind::External:
case Kind::Creation:
2017-08-01 09:32:23 +00:00
case Kind::BareCall:
case Kind::BareCallCode:
case Kind::BareDelegateCall:
2018-08-15 12:40:20 +00:00
case Kind::BareStaticCall:
2015-11-25 13:23:35 +00:00
{
MemberList::MemberMap members;
2017-06-27 09:25:36 +00:00
if (m_kind == Kind::External)
{
members.emplace_back("selector", TypeProvider::fixedBytes(4));
members.emplace_back("address", TypeProvider::address());
}
if (m_kind != Kind::BareDelegateCall)
{
if (isPayable())
members.emplace_back(
"value",
TypeProvider::function(
parseElementaryTypeVector({"uint"}),
TypePointers{copyAndSetCallOptions(false, true, false)},
strings(1, ""),
strings(1, ""),
Kind::SetValue,
false,
StateMutability::Pure,
nullptr,
m_gasSet,
m_valueSet,
m_saltSet
)
);
}
if (m_kind != Kind::Creation)
members.emplace_back(
"gas",
TypeProvider::function(
parseElementaryTypeVector({"uint"}),
TypePointers{copyAndSetCallOptions(true, false, false)},
strings(1, ""),
strings(1, ""),
Kind::SetGas,
false,
StateMutability::Pure,
nullptr,
m_gasSet,
m_valueSet,
m_saltSet
2015-11-25 13:23:35 +00:00
)
);
2015-11-25 13:23:35 +00:00
return members;
}
case Kind::DelegateCall:
{
auto const* functionDefinition = dynamic_cast<FunctionDefinition const*>(m_declaration);
solAssert(functionDefinition, "");
2019-12-10 14:54:09 +00:00
solAssert(functionDefinition->visibility() != Visibility::Private, "");
if (functionDefinition->visibility() != Visibility::Internal)
{
auto const* contract = dynamic_cast<ContractDefinition const*>(m_declaration->scope());
solAssert(contract, "");
solAssert(contract->isLibrary(), "");
return {{"selector", TypeProvider::fixedBytes(4)}};
}
return {};
}
2014-11-25 17:23:39 +00:00
default:
2015-11-25 13:23:35 +00:00
return MemberList::MemberMap();
2014-11-25 17:23:39 +00:00
}
}
2016-09-28 17:22:23 +00:00
TypePointer FunctionType::encodingType() const
{
if (m_gasSet || m_valueSet)
return nullptr;
2016-09-28 17:22:23 +00:00
// Only external functions can be encoded, internal functions cannot leave code boundaries.
if (m_kind == Kind::External)
return this;
2016-09-28 17:22:23 +00:00
else
return nullptr;
2016-09-28 17:22:23 +00:00
}
TypeResult FunctionType::interfaceType(bool /*_inLibrary*/) const
2016-09-27 19:37:32 +00:00
{
if (m_kind == Kind::External)
return this;
2016-10-19 14:39:16 +00:00
else
return TypeResult::err("Internal type is not allowed for public or external functions.");
2016-09-27 19:37:32 +00:00
}
bool FunctionType::canTakeArguments(
FuncCallArguments const& _arguments,
Type const* _selfType
) const
{
solAssert(!bound() || _selfType, "");
if (bound() && !_selfType->isImplicitlyConvertibleTo(*selfType()))
return false;
2015-11-25 13:23:35 +00:00
TypePointers paramTypes = parameterTypes();
std::vector<std::string> const paramNames = parameterNames();
if (takesArbitraryParameters())
return true;
else if (_arguments.numArguments() != paramTypes.size())
return false;
else if (!_arguments.hasNamedArguments())
2016-02-18 12:29:02 +00:00
return equal(
_arguments.types.cbegin(),
_arguments.types.cend(),
2015-08-31 16:44:29 +00:00
paramTypes.cbegin(),
[](Type const* argumentType, Type const* parameterType)
{
return argumentType->isImplicitlyConvertibleTo(*parameterType);
}
);
else if (paramNames.size() != _arguments.numNames())
return false;
else
{
solAssert(_arguments.numArguments() == _arguments.numNames(), "Expected equal sized type & name vectors");
size_t matchedNames = 0;
for (auto const& argName: _arguments.names)
for (size_t i = 0; i < paramNames.size(); i++)
if (*argName == paramNames[i])
{
matchedNames++;
if (!_arguments.types[i]->isImplicitlyConvertibleTo(*paramTypes[i]))
return false;
}
if (matchedNames == _arguments.numNames())
return true;
return false;
}
}
bool FunctionType::hasEqualParameterTypes(FunctionType const& _other) const
{
if (m_parameterTypes.size() != _other.m_parameterTypes.size())
return false;
return equal(
m_parameterTypes.cbegin(),
m_parameterTypes.cend(),
_other.m_parameterTypes.cbegin(),
[](Type const* _a, Type const* _b) -> bool { return *_a == *_b; }
);
}
bool FunctionType::hasEqualReturnTypes(FunctionType const& _other) const
{
if (m_returnParameterTypes.size() != _other.m_returnParameterTypes.size())
return false;
return equal(
m_returnParameterTypes.cbegin(),
m_returnParameterTypes.cend(),
_other.m_returnParameterTypes.cbegin(),
[](Type const* _a, Type const* _b) -> bool { return *_a == *_b; }
);
}
bool FunctionType::equalExcludingStateMutability(FunctionType const& _other) const
{
if (m_kind != _other.m_kind)
return false;
if (!hasEqualParameterTypes(_other) || !hasEqualReturnTypes(_other))
return false;
//@todo this is ugly, but cannot be prevented right now
if (m_gasSet != _other.m_gasSet || m_valueSet != _other.m_valueSet || m_saltSet != _other.m_saltSet)
return false;
if (bound() != _other.bound())
return false;
solAssert(!bound() || *selfType() == *_other.selfType(), "");
return true;
}
bool FunctionType::isBareCall() const
{
switch (m_kind)
{
2017-08-01 09:32:23 +00:00
case Kind::BareCall:
case Kind::BareCallCode:
case Kind::BareDelegateCall:
2018-08-15 12:40:20 +00:00
case Kind::BareStaticCall:
case Kind::ECRecover:
case Kind::SHA256:
case Kind::RIPEMD160:
return true;
default:
return false;
}
}
string FunctionType::externalSignature() const
{
solAssert(m_declaration != nullptr, "External signature of function needs declaration");
solAssert(!m_declaration->name().empty(), "Fallback function has no signature.");
switch (kind())
{
case Kind::Internal:
case Kind::External:
case Kind::DelegateCall:
case Kind::Event:
case Kind::Declaration:
break;
default:
solAssert(false, "Invalid function type for requesting external signature.");
}
// "inLibrary" is only relevant if this is not an event.
bool const inLibrary = kind() != Kind::Event && dynamic_cast<ContractDefinition const&>(*m_declaration->scope()).isLibrary();
auto extParams = transformParametersToExternal(m_parameterTypes, inLibrary);
solAssert(extParams.message().empty(), extParams.message());
auto typeStrings = extParams.get() | boost::adaptors::transformed([&](TypePointer _t) -> string
{
string typeName = _t->signatureInExternalFunction(inLibrary);
if (inLibrary && _t->dataStoredIn(DataLocation::Storage))
typeName += " storage";
return typeName;
});
return m_declaration->name() + "(" + boost::algorithm::join(typeStrings, ",") + ")";
}
u256 FunctionType::externalIdentifier() const
{
2019-12-11 16:31:36 +00:00
return util::FixedHash<4>::Arith(util::FixedHash<4>(util::keccak256(externalSignature())));
}
string FunctionType::externalIdentifierHex() const
{
2019-12-11 16:31:36 +00:00
return util::FixedHash<4>(util::keccak256(externalSignature())).hex();
}
2017-03-01 18:12:40 +00:00
bool FunctionType::isPure() const
{
// TODO: replace this with m_stateMutability == StateMutability::Pure once
// the callgraph analyzer is in place
2017-03-01 18:12:40 +00:00
return
m_kind == Kind::KECCAK256 ||
m_kind == Kind::ECRecover ||
m_kind == Kind::SHA256 ||
m_kind == Kind::RIPEMD160 ||
m_kind == Kind::AddMod ||
m_kind == Kind::MulMod ||
m_kind == Kind::ObjectCreation ||
m_kind == Kind::ABIEncode ||
m_kind == Kind::ABIEncodePacked ||
m_kind == Kind::ABIEncodeWithSelector ||
2018-06-30 16:09:13 +00:00
m_kind == Kind::ABIEncodeWithSignature ||
2019-01-10 15:28:39 +00:00
m_kind == Kind::ABIDecode ||
m_kind == Kind::MetaType;
2017-03-01 18:12:40 +00:00
}
2015-01-12 12:29:16 +00:00
TypePointers FunctionType::parseElementaryTypeVector(strings const& _types)
{
TypePointers pointers;
pointers.reserve(_types.size());
for (string const& type: _types)
pointers.push_back(TypeProvider::fromElementaryTypeName(type));
return pointers;
}
TypePointer FunctionType::copyAndSetCallOptions(bool _setGas, bool _setValue, bool _setSalt) const
{
solAssert(m_kind != Kind::Declaration, "");
return TypeProvider::function(
m_parameterTypes,
m_returnParameterTypes,
m_parameterNames,
m_returnParameterNames,
m_kind,
m_arbitraryParameters,
m_stateMutability,
m_declaration,
m_gasSet || _setGas,
2015-11-25 13:23:35 +00:00
m_valueSet || _setValue,
m_saltSet || _setSalt,
2015-11-25 13:23:35 +00:00
m_bound
);
}
FunctionTypePointer FunctionType::asCallableFunction(bool _inLibrary, bool _bound) const
2015-06-22 16:05:13 +00:00
{
if (_bound)
solAssert(!m_parameterTypes.empty(), "");
2015-06-22 18:50:29 +00:00
TypePointers parameterTypes;
for (auto const& t: m_parameterTypes)
{
auto refType = dynamic_cast<ReferenceType const*>(t);
2015-06-22 18:50:29 +00:00
if (refType && refType->location() == DataLocation::CallData)
parameterTypes.push_back(TypeProvider::withLocation(refType, DataLocation::Memory, true));
2015-06-22 18:50:29 +00:00
else
parameterTypes.push_back(t);
}
Kind kind = m_kind;
if (_inLibrary)
{
solAssert(!!m_declaration, "Declaration has to be available.");
if (!m_declaration->isPublic())
kind = Kind::Internal; // will be inlined
else
kind = Kind::DelegateCall;
}
return TypeProvider::function(
2015-06-22 18:50:29 +00:00
parameterTypes,
m_returnParameterTypes,
2015-06-22 16:05:13 +00:00
m_parameterNames,
2016-06-01 21:39:19 +00:00
m_returnParameterNames,
kind,
2015-06-22 16:05:13 +00:00
m_arbitraryParameters,
m_stateMutability,
m_declaration,
2015-06-22 16:05:13 +00:00
m_gasSet,
2015-11-25 13:23:35 +00:00
m_valueSet,
m_saltSet,
2015-11-25 13:23:35 +00:00
_bound
2015-06-22 16:05:13 +00:00
);
}
Type const* FunctionType::selfType() const
2015-11-25 13:23:35 +00:00
{
solAssert(bound(), "Function is not bound.");
solAssert(m_parameterTypes.size() > 0, "Function has no self type.");
2015-11-25 13:23:35 +00:00
return m_parameterTypes.at(0);
}
ASTPointer<StructuredDocumentation> FunctionType::documentation() const
{
auto function = dynamic_cast<StructurallyDocumented const*>(m_declaration);
if (function)
2015-08-31 16:44:29 +00:00
return function->documentation();
return ASTPointer<StructuredDocumentation>();
}
bool FunctionType::padArguments() const
{
// No padding only for hash functions, low-level calls and the packed encoding function.
switch (m_kind)
{
case Kind::BareCall:
case Kind::BareCallCode:
case Kind::BareDelegateCall:
2018-08-15 12:40:20 +00:00
case Kind::BareStaticCall:
case Kind::SHA256:
case Kind::RIPEMD160:
case Kind::KECCAK256:
case Kind::ABIEncodePacked:
return false;
default:
return true;
}
return true;
}
Type const* MappingType::encodingType() const
{
return TypeProvider::integer(256, IntegerType::Modifier::Unsigned);
}
string MappingType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_mapping" + identifierList(m_keyType, m_valueType);
2017-01-17 09:47:44 +00:00
}
2014-10-29 18:28:30 +00:00
bool MappingType::operator==(Type const& _other) const
2014-10-20 10:41:56 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-10-20 10:41:56 +00:00
return false;
MappingType const& other = dynamic_cast<MappingType const&>(_other);
return *other.m_keyType == *m_keyType && *other.m_valueType == *m_valueType;
}
string MappingType::toString(bool _short) const
2014-11-13 00:12:57 +00:00
{
2015-08-31 16:44:29 +00:00
return "mapping(" + keyType()->toString(_short) + " => " + valueType()->toString(_short) + ")";
2014-11-13 00:12:57 +00:00
}
string MappingType::canonicalName() const
{
return "mapping(" + keyType()->canonicalName() + " => " + valueType()->canonicalName() + ")";
}
TypeResult MappingType::interfaceType(bool _inLibrary) const
{
solAssert(keyType()->interfaceType(_inLibrary).get(), "Must be an elementary type!");
if (_inLibrary)
{
auto iType = valueType()->interfaceType(_inLibrary);
if (!iType.get())
{
solAssert(!iType.message().empty(), "Expected detailed error message!");
return iType;
}
}
else
return TypeResult::err("Only libraries are allowed to use the mapping type in public or external functions.");
return this;
}
string TypeType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_type" + identifierList(actualType());
2017-01-17 09:47:44 +00:00
}
2014-10-29 18:28:30 +00:00
bool TypeType::operator==(Type const& _other) const
2014-10-20 10:41:56 +00:00
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
2014-10-20 10:41:56 +00:00
return false;
TypeType const& other = dynamic_cast<TypeType const&>(_other);
2015-08-31 16:44:29 +00:00
return *actualType() == *other.actualType();
2014-10-20 10:41:56 +00:00
}
2014-10-13 16:22:15 +00:00
2015-08-31 16:44:29 +00:00
u256 TypeType::storageSize() const
2015-03-13 09:52:34 +00:00
{
solAssert(false, "Storage size of non-storable type type requested.");
2015-03-13 09:52:34 +00:00
}
vector<tuple<string, TypePointer>> TypeType::makeStackItems() const
2015-09-10 17:40:07 +00:00
{
if (auto contractType = dynamic_cast<ContractType const*>(m_actualType))
2015-09-10 17:40:07 +00:00
if (contractType->contractDefinition().isLibrary())
2020-02-04 16:08:55 +00:00
return {make_tuple("address", TypeProvider::address())};
return {};
2015-09-10 17:40:07 +00:00
}
2015-11-25 13:23:35 +00:00
MemberList::MemberMap TypeType::nativeMembers(ContractDefinition const* _currentScope) const
2015-01-19 18:18:34 +00:00
{
2015-11-25 13:23:35 +00:00
MemberList::MemberMap members;
if (m_actualType->category() == Category::Contract)
2015-01-19 18:18:34 +00:00
{
2015-11-25 13:23:35 +00:00
ContractDefinition const& contract = dynamic_cast<ContractType const&>(*m_actualType).contractDefinition();
bool inDerivingScope = _currentScope && _currentScope->derivesFrom(contract);
for (auto const* declaration: contract.declarations())
{
if (dynamic_cast<ModifierDefinition const*>(declaration))
continue;
if (!contract.isLibrary() && inDerivingScope && declaration->isVisibleInDerivedContracts())
{
if (
auto const* functionDefinition = dynamic_cast<FunctionDefinition const*>(declaration);
functionDefinition && !functionDefinition->isImplemented()
)
members.emplace_back(declaration->name(), declaration->typeViaContractName(), declaration);
else
members.emplace_back(declaration->name(), declaration->type(), declaration);
}
else if (
(contract.isLibrary() && declaration->isVisibleAsLibraryMember()) ||
declaration->isVisibleViaContractTypeAccess()
)
members.emplace_back(declaration->name(), declaration->typeViaContractName(), declaration);
}
2015-01-19 18:18:34 +00:00
}
2015-11-25 13:23:35 +00:00
else if (m_actualType->category() == Category::Enum)
{
EnumDefinition const& enumDef = dynamic_cast<EnumType const&>(*m_actualType).enumDefinition();
auto enumType = TypeProvider::enumType(enumDef);
2015-11-25 13:23:35 +00:00
for (ASTPointer<EnumValue> const& enumValue: enumDef.members())
members.emplace_back(enumValue->name(), enumType);
2015-11-25 13:23:35 +00:00
}
return members;
2015-01-19 18:18:34 +00:00
}
BoolResult TypeType::isExplicitlyConvertibleTo(Type const& _convertTo) const
{
if (auto const* address = dynamic_cast<AddressType const*>(&_convertTo))
if (address->stateMutability() == StateMutability::NonPayable)
if (auto const* contractType = dynamic_cast<ContractType const*>(m_actualType))
return contractType->contractDefinition().isLibrary();
return isImplicitlyConvertibleTo(_convertTo);
}
2019-02-13 15:22:42 +00:00
ModifierType::ModifierType(ModifierDefinition const& _modifier)
{
TypePointers params;
2015-08-31 16:44:29 +00:00
params.reserve(_modifier.parameters().size());
for (ASTPointer<VariableDeclaration> const& var: _modifier.parameters())
params.push_back(var->annotation().type);
swap(params, m_parameterTypes);
}
2015-08-31 16:44:29 +00:00
u256 ModifierType::storageSize() const
2015-03-13 09:52:34 +00:00
{
solAssert(false, "Storage size of non-storable type type requested.");
2015-03-13 09:52:34 +00:00
}
string ModifierType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_modifier" + identifierList(m_parameterTypes);
2017-01-17 09:47:44 +00:00
}
bool ModifierType::operator==(Type const& _other) const
{
2015-08-31 16:44:29 +00:00
if (_other.category() != category())
return false;
ModifierType const& other = dynamic_cast<ModifierType const&>(_other);
if (m_parameterTypes.size() != other.m_parameterTypes.size())
return false;
auto typeCompare = [](Type const* _a, Type const* _b) -> bool { return *_a == *_b; };
2019-02-13 15:56:46 +00:00
if (!equal(
m_parameterTypes.cbegin(),
m_parameterTypes.cend(),
other.m_parameterTypes.cbegin(),
typeCompare
))
return false;
return true;
}
string ModifierType::toString(bool _short) const
{
string name = "modifier (";
for (auto it = m_parameterTypes.begin(); it != m_parameterTypes.end(); ++it)
name += (*it)->toString(_short) + (it + 1 == m_parameterTypes.end() ? "" : ",");
return name + ")";
}
2015-01-19 18:18:34 +00:00
string ModuleType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
return "t_module_" + to_string(m_sourceUnit.id());
2017-01-17 09:47:44 +00:00
}
2015-12-15 14:46:03 +00:00
bool ModuleType::operator==(Type const& _other) const
2015-11-25 13:23:35 +00:00
{
2015-12-15 14:46:03 +00:00
if (_other.category() != category())
return false;
return &m_sourceUnit == &dynamic_cast<ModuleType const&>(_other).m_sourceUnit;
}
MemberList::MemberMap ModuleType::nativeMembers(ContractDefinition const*) const
{
MemberList::MemberMap symbols;
for (auto const& symbolName: m_sourceUnit.annotation().exportedSymbols)
for (Declaration const* symbol: symbolName.second)
symbols.emplace_back(symbolName.first, symbol->type(), symbol);
2015-12-15 14:46:03 +00:00
return symbols;
}
string ModuleType::toString(bool) const
{
return string("module \"") + m_sourceUnit.annotation().path + string("\"");
2015-11-25 13:23:35 +00:00
}
string MagicType::richIdentifier() const
2017-01-17 09:47:44 +00:00
{
switch (m_kind)
{
case Kind::Block:
return "t_magic_block";
case Kind::Message:
return "t_magic_message";
case Kind::Transaction:
return "t_magic_transaction";
case Kind::ABI:
return "t_magic_abi";
2019-01-10 15:28:39 +00:00
case Kind::MetaType:
solAssert(m_typeArgument, "");
return "t_magic_meta_type_" + m_typeArgument->richIdentifier();
2017-01-17 09:47:44 +00:00
}
return "";
}
2015-11-25 13:23:35 +00:00
bool MagicType::operator==(Type const& _other) const
{
if (_other.category() != category())
return false;
MagicType const& other = dynamic_cast<MagicType const&>(_other);
return other.m_kind == m_kind;
}
MemberList::MemberMap MagicType::nativeMembers(ContractDefinition const*) const
2014-11-24 12:23:58 +00:00
{
switch (m_kind)
{
2015-02-09 13:08:48 +00:00
case Kind::Block:
2015-11-25 13:23:35 +00:00
return MemberList::MemberMap({
{"coinbase", TypeProvider::payableAddress()},
{"timestamp", TypeProvider::uint256()},
{"blockhash", TypeProvider::function(strings{"uint"}, strings{"bytes32"}, FunctionType::Kind::BlockHash, false, StateMutability::View)},
{"difficulty", TypeProvider::uint256()},
{"number", TypeProvider::uint256()},
{"gaslimit", TypeProvider::uint256()}
2015-06-08 10:09:24 +00:00
});
2015-02-09 13:08:48 +00:00
case Kind::Message:
2015-11-25 13:23:35 +00:00
return MemberList::MemberMap({
{"sender", TypeProvider::payableAddress()},
{"gas", TypeProvider::uint256()},
{"value", TypeProvider::uint256()},
{"data", TypeProvider::array(DataLocation::CallData)},
{"sig", TypeProvider::fixedBytes(4)}
2015-06-08 10:09:24 +00:00
});
2015-02-09 13:08:48 +00:00
case Kind::Transaction:
2015-11-25 13:23:35 +00:00
return MemberList::MemberMap({
{"origin", TypeProvider::payableAddress()},
{"gasprice", TypeProvider::uint256()}
2015-06-08 10:09:24 +00:00
});
case Kind::ABI:
return MemberList::MemberMap({
{"encode", TypeProvider::function(
TypePointers{},
TypePointers{TypeProvider::array(DataLocation::Memory)},
strings{},
strings{1, ""},
FunctionType::Kind::ABIEncode,
true,
StateMutability::Pure
)},
{"encodePacked", TypeProvider::function(
TypePointers{},
TypePointers{TypeProvider::array(DataLocation::Memory)},
strings{},
strings{1, ""},
FunctionType::Kind::ABIEncodePacked,
true,
StateMutability::Pure
)},
{"encodeWithSelector", TypeProvider::function(
TypePointers{TypeProvider::fixedBytes(4)},
TypePointers{TypeProvider::array(DataLocation::Memory)},
strings{1, ""},
strings{1, ""},
FunctionType::Kind::ABIEncodeWithSelector,
true,
StateMutability::Pure
)},
{"encodeWithSignature", TypeProvider::function(
TypePointers{TypeProvider::array(DataLocation::Memory, true)},
TypePointers{TypeProvider::array(DataLocation::Memory)},
strings{1, ""},
strings{1, ""},
FunctionType::Kind::ABIEncodeWithSignature,
true,
StateMutability::Pure
2018-06-30 16:09:13 +00:00
)},
{"decode", TypeProvider::function(
2018-06-30 16:09:13 +00:00
TypePointers(),
TypePointers(),
strings{},
strings{},
FunctionType::Kind::ABIDecode,
true,
StateMutability::Pure
)}
});
2019-01-10 15:28:39 +00:00
case Kind::MetaType:
{
solAssert(
m_typeArgument && (
m_typeArgument->category() == Type::Category::Contract ||
m_typeArgument->category() == Type::Category::Integer
),
"Only contracts or integer types supported for now"
2019-01-10 15:28:39 +00:00
);
if (m_typeArgument->category() == Type::Category::Contract)
{
ContractDefinition const& contract = dynamic_cast<ContractType const&>(*m_typeArgument).contractDefinition();
if (contract.canBeDeployed())
return MemberList::MemberMap({
{"creationCode", TypeProvider::array(DataLocation::Memory)},
{"runtimeCode", TypeProvider::array(DataLocation::Memory)},
{"name", TypeProvider::stringMemory()},
});
else
return MemberList::MemberMap({
{"interfaceId", TypeProvider::fixedBytes(4)},
});
}
else if (m_typeArgument->category() == Type::Category::Integer)
{
IntegerType const* integerTypePointer = dynamic_cast<IntegerType const*>(m_typeArgument);
2020-04-08 22:08:49 +00:00
return MemberList::MemberMap({
{"min", integerTypePointer},
{"max", integerTypePointer},
2020-04-08 22:08:49 +00:00
});
}
2014-11-24 12:23:58 +00:00
}
2019-01-10 15:28:39 +00:00
}
solAssert(false, "Unknown kind of magic.");
return {};
2014-11-24 12:23:58 +00:00
}
2019-01-10 15:28:39 +00:00
string MagicType::toString(bool _short) const
2014-11-24 12:23:58 +00:00
{
switch (m_kind)
{
2015-02-09 13:08:48 +00:00
case Kind::Block:
2014-11-24 12:23:58 +00:00
return "block";
2015-02-09 13:08:48 +00:00
case Kind::Message:
2014-11-24 12:23:58 +00:00
return "msg";
2015-02-09 13:08:48 +00:00
case Kind::Transaction:
2014-11-24 12:23:58 +00:00
return "tx";
case Kind::ABI:
return "abi";
2019-01-10 15:28:39 +00:00
case Kind::MetaType:
solAssert(m_typeArgument, "");
return "type(" + m_typeArgument->toString(_short) + ")";
2014-11-24 12:23:58 +00:00
}
2019-01-10 15:28:39 +00:00
solAssert(false, "Unknown kind of magic.");
return {};
2014-11-24 12:23:58 +00:00
}
TypePointer MagicType::typeArgument() const
{
solAssert(m_kind == Kind::MetaType, "");
solAssert(m_typeArgument, "");
return m_typeArgument;
}
TypePointer InaccessibleDynamicType::decodingType() const
{
return TypeProvider::integer(256, IntegerType::Modifier::Unsigned);
}