/* This file is part of cpp-ethereum. cpp-ethereum is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. cpp-ethereum is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with cpp-ethereum. If not, see . */ /** * @author Christian * @date 2014 * Solidity data types */ #include #include #include #include #include #include #include #include using namespace std; using namespace dev; using namespace dev::solidity; void StorageOffsets::computeOffsets(TypePointers const& _types) { bigint slotOffset = 0; unsigned byteOffset = 0; map> offsets; for (size_t i = 0; i < _types.size(); ++i) { TypePointer const& type = _types[i]; if (!type->canBeStored()) continue; if (byteOffset + type->storageBytes() > 32) { // would overflow, go to next slot ++slotOffset; byteOffset = 0; } if (slotOffset >= bigint(1) << 256) BOOST_THROW_EXCEPTION(TypeError() << errinfo_comment("Object too large for storage.")); offsets[i] = make_pair(u256(slotOffset), byteOffset); solAssert(type->storageSize() >= 1, "Invalid storage size."); if (type->storageSize() == 1 && byteOffset + type->storageBytes() <= 32) byteOffset += type->storageBytes(); else { slotOffset += type->storageSize(); byteOffset = 0; } } if (byteOffset > 0) ++slotOffset; if (slotOffset >= bigint(1) << 256) BOOST_THROW_EXCEPTION(TypeError() << errinfo_comment("Object too large for storage.")); m_storageSize = u256(slotOffset); swap(m_offsets, offsets); } pair const* StorageOffsets::offset(size_t _index) const { if (m_offsets.count(_index)) return &m_offsets.at(_index); else return nullptr; } MemberList& MemberList::operator=(MemberList&& _other) { assert(&_other != this); m_memberTypes = std::move(_other.m_memberTypes); m_storageOffsets = std::move(_other.m_storageOffsets); return *this; } std::pair const* MemberList::memberStorageOffset(string const& _name) const { if (!m_storageOffsets) { TypePointers memberTypes; memberTypes.reserve(m_memberTypes.size()); for (auto const& member: m_memberTypes) memberTypes.push_back(member.type); m_storageOffsets.reset(new StorageOffsets()); m_storageOffsets->computeOffsets(memberTypes); } for (size_t index = 0; index < m_memberTypes.size(); ++index) if (m_memberTypes[index].name == _name) return m_storageOffsets->offset(index); return nullptr; } u256 const& MemberList::storageSize() const { // trigger lazy computation memberStorageOffset(""); return m_storageOffsets->storageSize(); } TypePointer Type::fromElementaryTypeName(Token::Value _typeToken) { char const* tokenCstr = Token::toString(_typeToken); solAssert(Token::isElementaryTypeName(_typeToken), "Expected an elementary type name but got " + ((tokenCstr) ? std::string(Token::toString(_typeToken)) : "")); if (Token::Int <= _typeToken && _typeToken <= Token::Bytes32) { int offset = _typeToken - Token::Int; int bytes = offset % 33; if (bytes == 0 && _typeToken != Token::Bytes1) bytes = 32; int modifier = offset / 33; switch(modifier) { case 0: return make_shared(bytes * 8, IntegerType::Modifier::Signed); case 1: return make_shared(bytes * 8, IntegerType::Modifier::Unsigned); case 2: return make_shared(bytes + 1); default: solAssert(false, "Unexpected modifier value. Should never happen"); return TypePointer(); } } else if (_typeToken == Token::Byte) return make_shared(1); else if (_typeToken == Token::Address) return make_shared(0, IntegerType::Modifier::Address); else if (_typeToken == Token::Bool) return make_shared(); else if (_typeToken == Token::Bytes) return make_shared(DataLocation::Storage); else if (_typeToken == Token::String) return make_shared(DataLocation::Storage, true); else BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment( "Unable to convert elementary typename " + std::string(Token::toString(_typeToken)) + " to type." )); } TypePointer Type::fromElementaryTypeName(string const& _name) { return fromElementaryTypeName(Token::fromIdentifierOrKeyword(_name)); } TypePointer Type::fromUserDefinedTypeName(UserDefinedTypeName const& _typeName) { Declaration const* declaration = _typeName.referencedDeclaration(); if (StructDefinition const* structDef = dynamic_cast(declaration)) return make_shared(*structDef); else if (EnumDefinition const* enumDef = dynamic_cast(declaration)) return make_shared(*enumDef); else if (FunctionDefinition const* function = dynamic_cast(declaration)) return make_shared(*function); else if (ContractDefinition const* contract = dynamic_cast(declaration)) return make_shared(*contract); return TypePointer(); } TypePointer Type::fromMapping(ElementaryTypeName& _keyType, TypeName& _valueType) { TypePointer keyType = _keyType.toType(); if (!keyType) BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Error resolving type name.")); TypePointer valueType = _valueType.toType(); if (!valueType) BOOST_THROW_EXCEPTION(_valueType.createTypeError("Invalid type name.")); // Convert value type to storage reference. valueType = ReferenceType::copyForLocationIfReference(DataLocation::Storage, valueType); // Convert key type to memory. keyType = ReferenceType::copyForLocationIfReference(DataLocation::Memory, keyType); return make_shared(keyType, valueType); } TypePointer Type::fromArrayTypeName(TypeName& _baseTypeName, Expression* _length) { TypePointer baseType = _baseTypeName.toType(); if (!baseType) BOOST_THROW_EXCEPTION(_baseTypeName.createTypeError("Invalid type name.")); if (baseType->storageBytes() == 0) BOOST_THROW_EXCEPTION(_baseTypeName.createTypeError("Illegal base type of storage size zero for array.")); if (_length) { if (!_length->type()) _length->checkTypeRequirements(nullptr); auto const* length = dynamic_cast(_length->type().get()); if (!length) BOOST_THROW_EXCEPTION(_length->createTypeError("Invalid array length.")); return make_shared(DataLocation::Storage, baseType, length->literalValue(nullptr)); } else return make_shared(DataLocation::Storage, baseType); } TypePointer Type::forLiteral(Literal const& _literal) { switch (_literal.token()) { case Token::TrueLiteral: case Token::FalseLiteral: return make_shared(); case Token::Number: if (!IntegerConstantType::isValidLiteral(_literal)) return TypePointer(); return make_shared(_literal); case Token::StringLiteral: return make_shared(_literal); default: return shared_ptr(); } } TypePointer Type::commonType(TypePointer const& _a, TypePointer const& _b) { if (_b->isImplicitlyConvertibleTo(*_a)) return _a; else if (_a->isImplicitlyConvertibleTo(*_b)) return _b; else return TypePointer(); } const MemberList Type::EmptyMemberList; IntegerType::IntegerType(int _bits, IntegerType::Modifier _modifier): m_bits(_bits), m_modifier(_modifier) { if (isAddress()) m_bits = 160; solAssert(m_bits > 0 && m_bits <= 256 && m_bits % 8 == 0, "Invalid bit number for integer type: " + dev::toString(_bits)); } bool IntegerType::isImplicitlyConvertibleTo(Type const& _convertTo) const { if (_convertTo.category() != category()) return false; IntegerType const& convertTo = dynamic_cast(_convertTo); if (convertTo.m_bits < m_bits) return false; if (isAddress()) return convertTo.isAddress(); else if (isSigned()) return convertTo.isSigned(); else return !convertTo.isSigned() || convertTo.m_bits > m_bits; } bool IntegerType::isExplicitlyConvertibleTo(Type const& _convertTo) const { return _convertTo.category() == category() || _convertTo.category() == Category::Contract || _convertTo.category() == Category::Enum || _convertTo.category() == Category::FixedBytes; } TypePointer IntegerType::unaryOperatorResult(Token::Value _operator) const { // "delete" is ok for all integer types if (_operator == Token::Delete) return make_shared(); // no further unary operators for addresses else if (isAddress()) return TypePointer(); // for non-address integers, we allow +, -, ++ and -- else if (_operator == Token::Add || _operator == Token::Sub || _operator == Token::Inc || _operator == Token::Dec || _operator == Token::After || _operator == Token::BitNot) return shared_from_this(); else return TypePointer(); } bool IntegerType::operator==(Type const& _other) const { if (_other.category() != category()) return false; IntegerType const& other = dynamic_cast(_other); return other.m_bits == m_bits && other.m_modifier == m_modifier; } string IntegerType::toString(bool) const { if (isAddress()) return "address"; string prefix = isSigned() ? "int" : "uint"; return prefix + dev::toString(m_bits); } TypePointer IntegerType::binaryOperatorResult(Token::Value _operator, TypePointer const& _other) const { if (_other->category() != Category::IntegerConstant && _other->category() != category()) return TypePointer(); auto commonType = dynamic_pointer_cast(Type::commonType(shared_from_this(), _other)); if (!commonType) return TypePointer(); // All integer types can be compared if (Token::isCompareOp(_operator)) return commonType; if (Token::isBooleanOp(_operator)) return TypePointer(); // Nothing else can be done with addresses if (commonType->isAddress()) return TypePointer(); return commonType; } const MemberList IntegerType::AddressMemberList({ {"balance", make_shared(256)}, {"call", make_shared(strings(), strings{"bool"}, FunctionType::Location::Bare, true)}, {"callcode", make_shared(strings(), strings{"bool"}, FunctionType::Location::BareCallCode, true)}, {"send", make_shared(strings{"uint"}, strings{"bool"}, FunctionType::Location::Send)} }); bool IntegerConstantType::isValidLiteral(const Literal& _literal) { try { bigint x(_literal.value()); } catch (...) { return false; } return true; } IntegerConstantType::IntegerConstantType(Literal const& _literal) { m_value = bigint(_literal.value()); switch (_literal.subDenomination()) { case Literal::SubDenomination::Wei: case Literal::SubDenomination::Second: case Literal::SubDenomination::None: break; case Literal::SubDenomination::Szabo: m_value *= bigint("1000000000000"); break; case Literal::SubDenomination::Finney: m_value *= bigint("1000000000000000"); break; case Literal::SubDenomination::Ether: m_value *= bigint("1000000000000000000"); break; case Literal::SubDenomination::Minute: m_value *= bigint("60"); break; case Literal::SubDenomination::Hour: m_value *= bigint("3600"); break; case Literal::SubDenomination::Day: m_value *= bigint("86400"); break; case Literal::SubDenomination::Week: m_value *= bigint("604800"); break; case Literal::SubDenomination::Year: m_value *= bigint("31536000"); break; } } bool IntegerConstantType::isImplicitlyConvertibleTo(Type const& _convertTo) const { if (auto targetType = dynamic_cast(&_convertTo)) { if (m_value == 0) return true; int forSignBit = (targetType->isSigned() ? 1 : 0); if (m_value > 0) { if (m_value <= (u256(-1) >> (256 - targetType->numBits() + forSignBit))) return true; } else if (targetType->isSigned() && -m_value <= (u256(1) << (targetType->numBits() - forSignBit))) return true; return false; } else if (_convertTo.category() == Category::FixedBytes) { FixedBytesType const& fixedBytes = dynamic_cast(_convertTo); return fixedBytes.numBytes() * 8 >= integerType()->numBits(); } else return false; } bool IntegerConstantType::isExplicitlyConvertibleTo(Type const& _convertTo) const { TypePointer intType = integerType(); return intType && intType->isExplicitlyConvertibleTo(_convertTo); } TypePointer IntegerConstantType::unaryOperatorResult(Token::Value _operator) const { bigint value; switch (_operator) { case Token::BitNot: value = ~m_value; break; case Token::Add: value = m_value; break; case Token::Sub: value = -m_value; break; case Token::After: return shared_from_this(); default: return TypePointer(); } return make_shared(value); } TypePointer IntegerConstantType::binaryOperatorResult(Token::Value _operator, TypePointer const& _other) const { if (_other->category() == Category::Integer) { shared_ptr intType = integerType(); if (!intType) return TypePointer(); return intType->binaryOperatorResult(_operator, _other); } else if (_other->category() != category()) return TypePointer(); IntegerConstantType const& other = dynamic_cast(*_other); if (Token::isCompareOp(_operator)) { shared_ptr thisIntegerType = integerType(); shared_ptr otherIntegerType = other.integerType(); if (!thisIntegerType || !otherIntegerType) return TypePointer(); return thisIntegerType->binaryOperatorResult(_operator, otherIntegerType); } else { bigint value; switch (_operator) { case Token::BitOr: value = m_value | other.m_value; break; case Token::BitXor: value = m_value ^ other.m_value; break; case Token::BitAnd: value = m_value & other.m_value; break; case Token::Add: value = m_value + other.m_value; break; case Token::Sub: value = m_value - other.m_value; break; case Token::Mul: value = m_value * other.m_value; break; case Token::Div: if (other.m_value == 0) return TypePointer(); value = m_value / other.m_value; break; case Token::Mod: if (other.m_value == 0) return TypePointer(); value = m_value % other.m_value; break; case Token::Exp: if (other.m_value < 0) return TypePointer(); else if (other.m_value > std::numeric_limits::max()) return TypePointer(); else value = boost::multiprecision::pow(m_value, other.m_value.convert_to()); break; default: return TypePointer(); } return make_shared(value); } } bool IntegerConstantType::operator==(Type const& _other) const { if (_other.category() != category()) return false; return m_value == dynamic_cast(_other).m_value; } string IntegerConstantType::toString(bool) const { return "int_const " + m_value.str(); } u256 IntegerConstantType::literalValue(Literal const*) const { u256 value; // we ignore the literal and hope that the type was correctly determined solAssert(m_value <= u256(-1), "Integer constant too large."); solAssert(m_value >= -(bigint(1) << 255), "Integer constant too small."); if (m_value >= 0) value = u256(m_value); else value = s2u(s256(m_value)); return value; } TypePointer IntegerConstantType::mobileType() const { auto intType = integerType(); solAssert(!!intType, "mobileType called with invalid integer constant " + toString(false)); return intType; } shared_ptr IntegerConstantType::integerType() const { bigint value = m_value; bool negative = (value < 0); if (negative) // convert to positive number of same bit requirements value = ((-value) - 1) << 1; if (value > u256(-1)) return shared_ptr(); else return make_shared( max(bytesRequired(value), 1u) * 8, negative ? IntegerType::Modifier::Signed : IntegerType::Modifier::Unsigned ); } StringLiteralType::StringLiteralType(Literal const& _literal): m_value(_literal.value()) { } bool StringLiteralType::isImplicitlyConvertibleTo(Type const& _convertTo) const { if (auto fixedBytes = dynamic_cast(&_convertTo)) return size_t(fixedBytes->numBytes()) >= m_value.size(); else if (auto arrayType = dynamic_cast(&_convertTo)) return arrayType->isByteArray(); else return false; } bool StringLiteralType::operator==(const Type& _other) const { if (_other.category() != category()) return false; return m_value == dynamic_cast(_other).m_value; } TypePointer StringLiteralType::mobileType() const { return make_shared(DataLocation::Memory, true); } shared_ptr FixedBytesType::smallestTypeForLiteral(string const& _literal) { if (_literal.length() <= 32) return make_shared(_literal.length()); return shared_ptr(); } FixedBytesType::FixedBytesType(int _bytes): m_bytes(_bytes) { solAssert(m_bytes >= 0 && m_bytes <= 32, "Invalid byte number for fixed bytes type: " + dev::toString(m_bytes)); } bool FixedBytesType::isImplicitlyConvertibleTo(Type const& _convertTo) const { if (_convertTo.category() != category()) return false; FixedBytesType const& convertTo = dynamic_cast(_convertTo); return convertTo.m_bytes >= m_bytes; } bool FixedBytesType::isExplicitlyConvertibleTo(Type const& _convertTo) const { return _convertTo.category() == Category::Integer || _convertTo.category() == Category::Contract || _convertTo.category() == category(); } TypePointer FixedBytesType::unaryOperatorResult(Token::Value _operator) const { // "delete" and "~" is okay for FixedBytesType if (_operator == Token::Delete) return make_shared(); else if (_operator == Token::BitNot) return shared_from_this(); return TypePointer(); } TypePointer FixedBytesType::binaryOperatorResult(Token::Value _operator, TypePointer const& _other) const { auto commonType = dynamic_pointer_cast(Type::commonType(shared_from_this(), _other)); if (!commonType) return TypePointer(); // FixedBytes can be compared and have bitwise operators applied to them if (Token::isCompareOp(_operator) || Token::isBitOp(_operator)) return commonType; return TypePointer(); } bool FixedBytesType::operator==(Type const& _other) const { if (_other.category() != category()) return false; FixedBytesType const& other = dynamic_cast(_other); return other.m_bytes == m_bytes; } bool BoolType::isExplicitlyConvertibleTo(Type const& _convertTo) const { // conversion to integer is fine, but not to address // this is an example of explicit conversions being not transitive (though implicit should be) if (_convertTo.category() == category()) { IntegerType const& convertTo = dynamic_cast(_convertTo); if (!convertTo.isAddress()) return true; } return isImplicitlyConvertibleTo(_convertTo); } u256 BoolType::literalValue(Literal const* _literal) const { solAssert(_literal, ""); if (_literal->token() == Token::TrueLiteral) return u256(1); else if (_literal->token() == Token::FalseLiteral) return u256(0); else BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Bool type constructed from non-boolean literal.")); } TypePointer BoolType::unaryOperatorResult(Token::Value _operator) const { if (_operator == Token::Delete) return make_shared(); return (_operator == Token::Not) ? shared_from_this() : TypePointer(); } TypePointer BoolType::binaryOperatorResult(Token::Value _operator, TypePointer const& _other) const { if (category() != _other->category()) return TypePointer(); if (Token::isCompareOp(_operator) || _operator == Token::And || _operator == Token::Or) return _other; else return TypePointer(); } bool ContractType::isImplicitlyConvertibleTo(Type const& _convertTo) const { if (*this == _convertTo) return true; if (_convertTo.category() == Category::Integer) return dynamic_cast(_convertTo).isAddress(); if (_convertTo.category() == Category::Contract) { auto const& bases = contractDefinition().linearizedBaseContracts(); if (m_super && bases.size() <= 1) return false; return find(m_super ? ++bases.begin() : bases.begin(), bases.end(), &dynamic_cast(_convertTo).contractDefinition()) != bases.end(); } return false; } bool ContractType::isExplicitlyConvertibleTo(Type const& _convertTo) const { return isImplicitlyConvertibleTo(_convertTo) || _convertTo.category() == Category::Integer || _convertTo.category() == Category::Contract; } TypePointer ContractType::unaryOperatorResult(Token::Value _operator) const { return _operator == Token::Delete ? make_shared() : TypePointer(); } TypePointer ReferenceType::unaryOperatorResult(Token::Value _operator) const { if (_operator != Token::Delete) return TypePointer(); // delete can be used on everything except calldata references or storage pointers // (storage references are ok) switch (location()) { case DataLocation::CallData: return TypePointer(); case DataLocation::Memory: return make_shared(); case DataLocation::Storage: return m_isPointer ? TypePointer() : make_shared(); default: solAssert(false, ""); } return TypePointer(); } TypePointer ReferenceType::copyForLocationIfReference(DataLocation _location, TypePointer const& _type) { if (auto type = dynamic_cast(_type.get())) return type->copyForLocation(_location, false); return _type; } TypePointer ReferenceType::copyForLocationIfReference(TypePointer const& _type) const { return copyForLocationIfReference(m_location, _type); } string ReferenceType::stringForReferencePart() const { switch (m_location) { case DataLocation::Storage: return string("storage ") + (m_isPointer ? "pointer" : "ref"); case DataLocation::CallData: return "calldata"; case DataLocation::Memory: return "memory"; } solAssert(false, ""); return ""; } bool ArrayType::isImplicitlyConvertibleTo(const Type& _convertTo) const { if (_convertTo.category() != category()) return false; auto& convertTo = dynamic_cast(_convertTo); if (convertTo.isByteArray() != isByteArray() || convertTo.isString() != isString()) return false; // memory/calldata to storage can be converted, but only to a direct storage reference if (convertTo.location() == DataLocation::Storage && location() != DataLocation::Storage && convertTo.isPointer()) return false; if (convertTo.location() == DataLocation::CallData && location() != convertTo.location()) return false; if (convertTo.location() == DataLocation::Storage && !convertTo.isPointer()) { // Less restrictive conversion, since we need to copy anyway. if (!baseType()->isImplicitlyConvertibleTo(*convertTo.baseType())) return false; if (convertTo.isDynamicallySized()) return true; return !isDynamicallySized() && convertTo.length() >= length(); } else { // 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 ( *copyForLocationIfReference(location(), baseType()) != *copyForLocationIfReference(location(), convertTo.baseType()) ) return false; if (isDynamicallySized() != convertTo.isDynamicallySized()) return false; // We also require that the size is the same. if (!isDynamicallySized() && length() != convertTo.length()) return false; return true; } } bool ArrayType::isExplicitlyConvertibleTo(const Type& _convertTo) const { if (isImplicitlyConvertibleTo(_convertTo)) return true; // allow conversion bytes <-> string if (_convertTo.category() != category()) return false; auto& convertTo = dynamic_cast(_convertTo); if (convertTo.location() != location()) return false; if (!isByteArray() || !convertTo.isByteArray()) return false; return true; } bool ArrayType::operator==(Type const& _other) const { if (_other.category() != category()) return false; ArrayType const& other = dynamic_cast(_other); if ( !ReferenceType::operator==(other) || other.isByteArray() != isByteArray() || other.isString() != isString() || other.isDynamicallySized() != isDynamicallySized() ) return false; return isDynamicallySized() || length() == other.length(); } unsigned ArrayType::calldataEncodedSize(bool _padded) const { if (isDynamicallySized()) return 0; bigint size = bigint(length()) * (isByteArray() ? 1 : baseType()->calldataEncodedSize(_padded)); size = ((size + 31) / 32) * 32; solAssert(size <= numeric_limits::max(), "Array size does not fit unsigned."); return unsigned(size); } u256 ArrayType::storageSize() const { if (isDynamicallySized()) return 1; bigint size; unsigned baseBytes = baseType()->storageBytes(); if (baseBytes == 0) size = 1; else if (baseBytes < 32) { unsigned itemsPerSlot = 32 / baseBytes; size = (bigint(length()) + (itemsPerSlot - 1)) / itemsPerSlot; } else size = bigint(length()) * baseType()->storageSize(); if (size >= bigint(1) << 256) BOOST_THROW_EXCEPTION(TypeError() << errinfo_comment("Array too large for storage.")); return max(1, u256(size)); } unsigned ArrayType::sizeOnStack() const { if (m_location == DataLocation::CallData) // offset [length] (stack top) return 1 + (isDynamicallySized() ? 1 : 0); else // storage slot or memory offset // byte offset inside storage value is omitted return 1; } string ArrayType::toString(bool _short) const { string ret; if (isString()) ret = "string"; else if (isByteArray()) ret = "bytes"; else { ret = baseType()->toString(_short) + "["; if (!isDynamicallySized()) ret += length().str(); ret += "]"; } if (!_short) ret += " " + stringForReferencePart(); return ret; } TypePointer ArrayType::externalType() const { if (m_arrayKind != ArrayKind::Ordinary) return this->copyForLocation(DataLocation::Memory, true); TypePointer baseExt = m_baseType->externalType(); if (!baseExt) return TypePointer(); if (m_baseType->category() == Category::Array && m_baseType->isDynamicallySized()) return TypePointer(); if (isDynamicallySized()) return std::make_shared(DataLocation::Memory, baseExt); else return std::make_shared(DataLocation::Memory, baseExt, m_length); } TypePointer ArrayType::copyForLocation(DataLocation _location, bool _isPointer) const { auto copy = make_shared(_location); copy->m_isPointer = _isPointer; copy->m_arrayKind = m_arrayKind; copy->m_baseType = copy->copyForLocationIfReference(m_baseType); copy->m_hasDynamicLength = m_hasDynamicLength; copy->m_length = m_length; return copy; } const MemberList ArrayType::s_arrayTypeMemberList({{"length", make_shared(256)}}); bool ContractType::operator==(Type const& _other) const { if (_other.category() != category()) return false; ContractType const& other = dynamic_cast(_other); return other.m_contract == m_contract && other.m_super == m_super; } string ContractType::toString(bool) const { return "contract " + string(m_super ? "super " : "") + m_contract.name(); } MemberList const& ContractType::members() const { // We need to lazy-initialize it because of recursive references. if (!m_members) { // All address members and all interface functions MemberList::MemberMap members( IntegerType::AddressMemberList.begin(), IntegerType::AddressMemberList.end() ); if (m_super) { // add the most derived of all functions which are visible in derived contracts for (ContractDefinition const* base: m_contract.linearizedBaseContracts()) for (ASTPointer const& function: base->definedFunctions()) { if (!function->isVisibleInDerivedContracts()) continue; auto functionType = make_shared(*function, true); bool functionWithEqualArgumentsFound = false; for (auto const& member: members) { if (member.name != function->name()) continue; auto memberType = dynamic_cast(member.type.get()); solAssert(!!memberType, "Override changes type."); if (!memberType->hasEqualArgumentTypes(*functionType)) continue; functionWithEqualArgumentsFound = true; break; } if (!functionWithEqualArgumentsFound) members.push_back(MemberList::Member( function->name(), functionType, function.get() )); } } else for (auto const& it: m_contract.interfaceFunctions()) members.push_back(MemberList::Member( it.second->declaration().name(), it.second->asMemberFunction(), &it.second->declaration() )); m_members.reset(new MemberList(members)); } return *m_members; } shared_ptr const& ContractType::constructorType() const { if (!m_constructorType) { FunctionDefinition const* constructor = m_contract.constructor(); if (constructor) m_constructorType = make_shared(*constructor); else m_constructorType = make_shared(TypePointers(), TypePointers()); } return m_constructorType; } vector> ContractType::stateVariables() const { vector variables; for (ContractDefinition const* contract: boost::adaptors::reverse(m_contract.linearizedBaseContracts())) for (ASTPointer const& variable: contract->stateVariables()) if (!variable->isConstant()) variables.push_back(variable.get()); TypePointers types; for (auto variable: variables) types.push_back(variable->type()); StorageOffsets offsets; offsets.computeOffsets(types); vector> variablesAndOffsets; for (size_t index = 0; index < variables.size(); ++index) if (auto const* offset = offsets.offset(index)) variablesAndOffsets.push_back(make_tuple(variables[index], offset->first, offset->second)); return variablesAndOffsets; } bool StructType::isImplicitlyConvertibleTo(const Type& _convertTo) const { if (_convertTo.category() != category()) return false; auto& convertTo = dynamic_cast(_convertTo); // memory/calldata to storage can be converted, but only to a direct storage reference if (convertTo.location() == DataLocation::Storage && location() != DataLocation::Storage && convertTo.isPointer()) return false; if (convertTo.location() == DataLocation::CallData && location() != convertTo.location()) return false; return this->m_struct == convertTo.m_struct; } bool StructType::operator==(Type const& _other) const { if (_other.category() != category()) return false; StructType const& other = dynamic_cast(_other); return ReferenceType::operator==(other) && other.m_struct == m_struct; } unsigned StructType::calldataEncodedSize(bool _padded) const { unsigned size = 0; for (auto const& member: members()) if (!member.type->canLiveOutsideStorage()) return 0; else { unsigned memberSize = member.type->calldataEncodedSize(_padded); if (memberSize == 0) return 0; size += memberSize; } return size; } u256 StructType::memorySize() const { u256 size; for (auto const& member: members()) if (member.type->canLiveOutsideStorage()) size += member.type->memoryHeadSize(); return size; } u256 StructType::storageSize() const { return max(1, members().storageSize()); } string StructType::toString(bool _short) const { string ret = "struct " + m_struct.name(); if (!_short) ret += " " + stringForReferencePart(); return ret; } MemberList const& StructType::members() const { // We need to lazy-initialize it because of recursive references. if (!m_members) { MemberList::MemberMap members; for (ASTPointer const& variable: m_struct.members()) { TypePointer type = variable->type(); // Skip all mapping members if we are not in storage. if (location() != DataLocation::Storage && !type->canLiveOutsideStorage()) continue; members.push_back(MemberList::Member( variable->name(), copyForLocationIfReference(type), variable.get()) ); } m_members.reset(new MemberList(members)); } return *m_members; } TypePointer StructType::copyForLocation(DataLocation _location, bool _isPointer) const { auto copy = make_shared(m_struct, _location); copy->m_isPointer = _isPointer; return copy; } FunctionTypePointer StructType::constructorType() const { TypePointers paramTypes; strings paramNames; for (auto const& member: members()) { if (!member.type->canLiveOutsideStorage()) continue; paramNames.push_back(member.name); paramTypes.push_back(copyForLocationIfReference(DataLocation::Memory, member.type)); } return make_shared( paramTypes, TypePointers{copyForLocation(DataLocation::Memory, false)}, paramNames, strings(), FunctionType::Location::Internal ); } pair const& StructType::storageOffsetsOfMember(string const& _name) const { auto const* offsets = members().memberStorageOffset(_name); solAssert(offsets, "Storage offset of non-existing member requested."); return *offsets; } u256 StructType::memoryOffsetOfMember(string const& _name) const { u256 offset; for (auto const& member: members()) if (member.name == _name) return offset; else offset += member.type->memoryHeadSize(); solAssert(false, "Member not found in struct."); return 0; } set StructType::membersMissingInMemory() const { set missing; for (ASTPointer const& variable: m_struct.members()) if (!variable->type()->canLiveOutsideStorage()) missing.insert(variable->name()); return missing; } TypePointer EnumType::unaryOperatorResult(Token::Value _operator) const { return _operator == Token::Delete ? make_shared() : TypePointer(); } bool EnumType::operator==(Type const& _other) const { if (_other.category() != category()) return false; EnumType const& other = dynamic_cast(_other); return other.m_enum == m_enum; } unsigned EnumType::storageBytes() const { size_t elements = m_enum.members().size(); if (elements <= 1) return 1; else return dev::bytesRequired(elements - 1); } string EnumType::toString(bool) const { return string("enum ") + m_enum.name(); } bool EnumType::isExplicitlyConvertibleTo(Type const& _convertTo) const { return _convertTo.category() == category() || _convertTo.category() == Category::Integer; } unsigned int EnumType::memberValue(ASTString const& _member) const { unsigned int index = 0; for (ASTPointer const& decl: m_enum.members()) { if (decl->name() == _member) return index; ++index; } BOOST_THROW_EXCEPTION(m_enum.createTypeError("Requested unknown enum value ." + _member)); } FunctionType::FunctionType(FunctionDefinition const& _function, bool _isInternal): m_location(_isInternal ? Location::Internal : Location::External), m_isConstant(_function.isDeclaredConst()), m_declaration(&_function) { TypePointers params; vector paramNames; TypePointers retParams; vector retParamNames; params.reserve(_function.parameters().size()); paramNames.reserve(_function.parameters().size()); for (ASTPointer const& var: _function.parameters()) { paramNames.push_back(var->name()); params.push_back(var->type()); } retParams.reserve(_function.returnParameters().size()); retParamNames.reserve(_function.returnParameters().size()); for (ASTPointer const& var: _function.returnParameters()) { retParamNames.push_back(var->name()); retParams.push_back(var->type()); } swap(params, m_parameterTypes); swap(paramNames, m_parameterNames); swap(retParams, m_returnParameterTypes); swap(retParamNames, m_returnParameterNames); } FunctionType::FunctionType(VariableDeclaration const& _varDecl): m_location(Location::External), m_isConstant(true), m_declaration(&_varDecl) { TypePointers paramTypes; vector paramNames; auto returnType = _varDecl.type(); while (true) { if (auto mappingType = dynamic_cast(returnType.get())) { paramTypes.push_back(mappingType->keyType()); paramNames.push_back(""); returnType = mappingType->valueType(); } else if (auto arrayType = dynamic_cast(returnType.get())) { if (arrayType->isByteArray()) // Return byte arrays as as whole. break; returnType = arrayType->baseType(); paramNames.push_back(""); paramTypes.push_back(make_shared(256)); } else break; } TypePointers retParams; vector retParamNames; if (auto structType = dynamic_cast(returnType.get())) { for (auto const& member: structType->members()) if (member.type->category() != Category::Mapping) { if (auto arrayType = dynamic_cast(member.type.get())) if (!arrayType->isByteArray()) continue; retParams.push_back(member.type); retParamNames.push_back(member.name); } } else { retParams.push_back(ReferenceType::copyForLocationIfReference( DataLocation::Memory, returnType )); retParamNames.push_back(""); } swap(paramTypes, m_parameterTypes); swap(paramNames, m_parameterNames); swap(retParams, m_returnParameterTypes); swap(retParamNames, m_returnParameterNames); } FunctionType::FunctionType(const EventDefinition& _event): m_location(Location::Event), m_isConstant(true), m_declaration(&_event) { TypePointers params; vector paramNames; params.reserve(_event.parameters().size()); paramNames.reserve(_event.parameters().size()); for (ASTPointer const& var: _event.parameters()) { paramNames.push_back(var->name()); params.push_back(var->type()); } swap(params, m_parameterTypes); swap(paramNames, m_parameterNames); } bool FunctionType::operator==(Type const& _other) const { if (_other.category() != category()) return false; FunctionType const& other = dynamic_cast(_other); if (m_location != other.m_location) return false; if (m_isConstant != other.isConstant()) return false; if (m_parameterTypes.size() != other.m_parameterTypes.size() || m_returnParameterTypes.size() != other.m_returnParameterTypes.size()) return false; auto typeCompare = [](TypePointer const& _a, TypePointer const& _b) -> bool { return *_a == *_b; }; if (!equal(m_parameterTypes.cbegin(), m_parameterTypes.cend(), other.m_parameterTypes.cbegin(), typeCompare)) return false; if (!equal(m_returnParameterTypes.cbegin(), m_returnParameterTypes.cend(), other.m_returnParameterTypes.cbegin(), typeCompare)) return false; //@todo this is ugly, but cannot be prevented right now if (m_gasSet != other.m_gasSet || m_valueSet != other.m_valueSet) return false; return true; } string FunctionType::toString(bool _short) const { string name = "function ("; for (auto it = m_parameterTypes.begin(); it != m_parameterTypes.end(); ++it) name += (*it)->toString(_short) + (it + 1 == m_parameterTypes.end() ? "" : ","); name += ") returns ("; for (auto it = m_returnParameterTypes.begin(); it != m_returnParameterTypes.end(); ++it) name += (*it)->toString(_short) + (it + 1 == m_returnParameterTypes.end() ? "" : ","); return name + ")"; } u256 FunctionType::storageSize() const { BOOST_THROW_EXCEPTION( InternalCompilerError() << errinfo_comment("Storage size of non-storable function type requested.")); } unsigned FunctionType::sizeOnStack() const { Location location = m_location; if (m_location == Location::SetGas || m_location == Location::SetValue) { solAssert(m_returnParameterTypes.size() == 1, ""); location = dynamic_cast(*m_returnParameterTypes.front()).m_location; } unsigned size = 0; if (location == Location::External || location == Location::CallCode) size = 2; else if (location == Location::Bare || location == Location::BareCallCode) size = 1; else if (location == Location::Internal) size = 1; if (m_gasSet) size++; if (m_valueSet) size++; return size; } FunctionTypePointer FunctionType::externalFunctionType() const { TypePointers paramTypes; TypePointers retParamTypes; for (auto type: m_parameterTypes) { if (auto ext = type->externalType()) paramTypes.push_back(ext); else return FunctionTypePointer(); } for (auto type: m_returnParameterTypes) { if (auto ext = type->externalType()) retParamTypes.push_back(ext); else return FunctionTypePointer(); } return make_shared(paramTypes, retParamTypes, m_parameterNames, m_returnParameterNames, m_location, m_arbitraryParameters); } MemberList const& FunctionType::members() const { switch (m_location) { case Location::External: case Location::Creation: case Location::ECRecover: case Location::SHA256: case Location::RIPEMD160: case Location::Bare: case Location::BareCallCode: if (!m_members) { MemberList::MemberMap members{ { "value", make_shared( parseElementaryTypeVector({"uint"}), TypePointers{copyAndSetGasOrValue(false, true)}, strings(), strings(), Location::SetValue, false, nullptr, m_gasSet, m_valueSet ) } }; if (m_location != Location::Creation) members.push_back( MemberList::Member( "gas", make_shared( parseElementaryTypeVector({"uint"}), TypePointers{copyAndSetGasOrValue(true, false)}, strings(), strings(), Location::SetGas, false, nullptr, m_gasSet, m_valueSet ) ) ); m_members.reset(new MemberList(members)); } return *m_members; default: return EmptyMemberList; } } bool FunctionType::canTakeArguments(TypePointers const& _argumentTypes) const { TypePointers const& paramTypes = parameterTypes(); if (takesArbitraryParameters()) return true; else if (_argumentTypes.size() != paramTypes.size()) return false; else return std::equal( _argumentTypes.cbegin(), _argumentTypes.cend(), paramTypes.cbegin(), [](TypePointer const& argumentType, TypePointer const& parameterType) { return argumentType->isImplicitlyConvertibleTo(*parameterType); } ); } bool FunctionType::hasEqualArgumentTypes(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(), [](TypePointer const& _a, TypePointer const& _b) -> bool { return *_a == *_b; } ); } bool FunctionType::isBareCall() const { switch (m_location) { case Location::Bare: case Location::BareCallCode: case Location::ECRecover: case Location::SHA256: case Location::RIPEMD160: return true; default: return false; } } string FunctionType::externalSignature(std::string const& _name) const { std::string funcName = _name; if (_name == "") { solAssert(m_declaration != nullptr, "Function type without name needs a declaration"); funcName = m_declaration->name(); } string ret = funcName + "("; FunctionTypePointer external = externalFunctionType(); solAssert(!!external, "External function type requested."); TypePointers externalParameterTypes = external->parameterTypes(); for (auto it = externalParameterTypes.cbegin(); it != externalParameterTypes.cend(); ++it) { solAssert(!!(*it), "Parameter should have external type"); ret += (*it)->toString(true) + (it + 1 == externalParameterTypes.cend() ? "" : ","); } return ret + ")"; } u256 FunctionType::externalIdentifier() const { return FixedHash<4>::Arith(FixedHash<4>(dev::sha3(externalSignature()))); } TypePointers FunctionType::parseElementaryTypeVector(strings const& _types) { TypePointers pointers; pointers.reserve(_types.size()); for (string const& type: _types) pointers.push_back(Type::fromElementaryTypeName(type)); return pointers; } TypePointer FunctionType::copyAndSetGasOrValue(bool _setGas, bool _setValue) const { return make_shared( m_parameterTypes, m_returnParameterTypes, m_parameterNames, m_returnParameterNames, m_location, m_arbitraryParameters, m_declaration, m_gasSet || _setGas, m_valueSet || _setValue ); } FunctionTypePointer FunctionType::asMemberFunction() const { TypePointers parameterTypes; for (auto const& t: m_parameterTypes) { auto refType = dynamic_cast(t.get()); if (refType && refType->location() == DataLocation::CallData) parameterTypes.push_back(refType->copyForLocation(DataLocation::Memory, false)); else parameterTypes.push_back(t); } //@todo make this more intelligent once we support destructuring assignments TypePointers returnParameterTypes; vector returnParameterNames; if (!m_returnParameterTypes.empty() && m_returnParameterTypes.front()->calldataEncodedSize() > 0) { returnParameterTypes.push_back(m_returnParameterTypes.front()); returnParameterNames.push_back(m_returnParameterNames.front()); } return make_shared( parameterTypes, returnParameterTypes, m_parameterNames, returnParameterNames, m_location, m_arbitraryParameters, m_declaration, m_gasSet, m_valueSet ); } vector const FunctionType::parameterTypeNames() const { vector names; for (TypePointer const& t: m_parameterTypes) names.push_back(t->toString(true)); return names; } vector const FunctionType::returnParameterTypeNames() const { vector names; for (TypePointer const& t: m_returnParameterTypes) names.push_back(t->toString(true)); return names; } ASTPointer FunctionType::documentation() const { auto function = dynamic_cast(m_declaration); if (function) return function->documentation(); return ASTPointer(); } bool MappingType::operator==(Type const& _other) const { if (_other.category() != category()) return false; MappingType const& other = dynamic_cast(_other); return *other.m_keyType == *m_keyType && *other.m_valueType == *m_valueType; } string MappingType::toString(bool _short) const { return "mapping(" + keyType()->toString(_short) + " => " + valueType()->toString(_short) + ")"; } u256 VoidType::storageSize() const { BOOST_THROW_EXCEPTION( InternalCompilerError() << errinfo_comment("Storage size of non-storable void type requested.")); } bool TypeType::operator==(Type const& _other) const { if (_other.category() != category()) return false; TypeType const& other = dynamic_cast(_other); return *actualType() == *other.actualType(); } u256 TypeType::storageSize() const { BOOST_THROW_EXCEPTION( InternalCompilerError() << errinfo_comment("Storage size of non-storable type type requested.")); } MemberList const& TypeType::members() const { // We need to lazy-initialize it because of recursive references. if (!m_members) { MemberList::MemberMap members; if (m_actualType->category() == Category::Contract && m_currentContract != nullptr) { ContractDefinition const& contract = dynamic_cast(*m_actualType).contractDefinition(); vector currentBases = m_currentContract->linearizedBaseContracts(); if (find(currentBases.begin(), currentBases.end(), &contract) != currentBases.end()) // We are accessing the type of a base contract, so add all public and protected // members. Note that this does not add inherited functions on purpose. for (Declaration const* decl: contract.inheritableMembers()) members.push_back(MemberList::Member(decl->name(), decl->type(), decl)); } else if (m_actualType->category() == Category::Enum) { EnumDefinition const& enumDef = dynamic_cast(*m_actualType).enumDefinition(); auto enumType = make_shared(enumDef); for (ASTPointer const& enumValue: enumDef.members()) members.push_back(MemberList::Member(enumValue->name(), enumType)); } m_members.reset(new MemberList(members)); } return *m_members; } ModifierType::ModifierType(const ModifierDefinition& _modifier) { TypePointers params; params.reserve(_modifier.parameters().size()); for (ASTPointer const& var: _modifier.parameters()) params.push_back(var->type()); swap(params, m_parameterTypes); } u256 ModifierType::storageSize() const { BOOST_THROW_EXCEPTION( InternalCompilerError() << errinfo_comment("Storage size of non-storable type type requested.")); } bool ModifierType::operator==(Type const& _other) const { if (_other.category() != category()) return false; ModifierType const& other = dynamic_cast(_other); if (m_parameterTypes.size() != other.m_parameterTypes.size()) return false; auto typeCompare = [](TypePointer const& _a, TypePointer const& _b) -> bool { return *_a == *_b; }; 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 + ")"; } MagicType::MagicType(MagicType::Kind _kind): m_kind(_kind) { switch (m_kind) { case Kind::Block: m_members = MemberList({ {"coinbase", make_shared(0, IntegerType::Modifier::Address)}, {"timestamp", make_shared(256)}, {"blockhash", make_shared(strings{"uint"}, strings{"bytes32"}, FunctionType::Location::BlockHash)}, {"difficulty", make_shared(256)}, {"number", make_shared(256)}, {"gaslimit", make_shared(256)} }); break; case Kind::Message: m_members = MemberList({ {"sender", make_shared(0, IntegerType::Modifier::Address)}, {"gas", make_shared(256)}, {"value", make_shared(256)}, {"data", make_shared(DataLocation::CallData)}, {"sig", make_shared(4)} }); break; case Kind::Transaction: m_members = MemberList({ {"origin", make_shared(0, IntegerType::Modifier::Address)}, {"gasprice", make_shared(256)} }); break; default: BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Unknown kind of magic.")); } } bool MagicType::operator==(Type const& _other) const { if (_other.category() != category()) return false; MagicType const& other = dynamic_cast(_other); return other.m_kind == m_kind; } string MagicType::toString(bool) const { switch (m_kind) { case Kind::Block: return "block"; case Kind::Message: return "msg"; case Kind::Transaction: return "tx"; default: BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Unknown kind of magic.")); } }